1 /* Teensyduino Core Library
2 * http://www.pjrc.com/teensy/
3 * Copyright (c) 2013 PJRC.COM, LLC.
4 * Modifications by Jacob Alexander 2013-2015
6 * Permission is hereby granted, free of charge, to any person obtaining
7 * a copy of this software and associated documentation files (the
8 * "Software"), to deal in the Software without restriction, including
9 * without limitation the rights to use, copy, modify, merge, publish,
10 * distribute, sublicense, and/or sell copies of the Software, and to
11 * permit persons to whom the Software is furnished to do so, subject to
12 * the following conditions:
14 * 1. The above copyright notice and this permission notice shall be
15 * included in all copies or substantial portions of the Software.
17 * 2. If the Software is incorporated into a build system that allows
18 * selection among a list of target devices, then similar target
19 * devices manufactured by PJRC.COM must be included in the list of
20 * target devices and selectable in the same manner.
22 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
23 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
24 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
25 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
26 * BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
27 * ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
28 * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
32 // ----- Includes -----
35 #include <string.h> // for memcpy()
38 #include <Lib/OutputLib.h>
43 #include "usb_keyboard.h"
47 // ----- Defines -----
49 // Maximum number of transmit packets to queue so we don't starve other endpoints for memory
50 #define TX_PACKET_LIMIT 4
52 // When the PC isn't listening, how long do we wait before discarding data?
53 #define TX_TIMEOUT_MSEC 50
56 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 596)
57 #elif F_CPU == 48000000
58 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 428)
59 #elif F_CPU == 24000000
60 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 262)
65 // ----- Variables -----
67 static uint8_t transmit_previous_timeout = 0;
71 // ----- Functions -----
73 // send the contents of keyboard_keys and keyboard_modifier_keys
74 void usb_keyboard_send()
76 uint32_t wait_count = 0;
77 usb_packet_t *tx_packet;
82 if ( !usb_configuration )
84 erro_print("USB not configured...");
88 if ( USBKeys_Protocol == 0 ) // Boot Mode
90 if ( usb_tx_packet_count( NKRO_KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
92 tx_packet = usb_malloc();
97 else if ( USBKeys_Protocol == 1 ) // NKRO Mode
99 if ( usb_tx_packet_count( KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
101 tx_packet = usb_malloc();
107 if ( ++wait_count > TX_TIMEOUT || transmit_previous_timeout )
109 transmit_previous_timeout = 1;
110 warn_print("USB Transmit Timeout...");
116 // Pointer to USB tx packet buffer
117 uint8_t *tx_buf = tx_packet->buf;
119 switch ( USBKeys_Protocol )
121 // Send boot keyboard interrupt packet(s)
123 // USB Boot Mode debug output
124 if ( Output_DebugMode )
126 dbug_msg("Boot USB: ");
127 printHex_op( USBKeys_Modifiers, 2 );
131 printHex_op( USBKeys_Keys[0], 2 );
132 printHex_op( USBKeys_Keys[1], 2 );
133 printHex_op( USBKeys_Keys[2], 2 );
134 printHex_op( USBKeys_Keys[3], 2 );
135 printHex_op( USBKeys_Keys[4], 2 );
136 printHex_op( USBKeys_Keys[5], 2 );
141 *tx_buf++ = USBKeys_Modifiers;
143 memcpy( tx_buf, USBKeys_Keys, USB_BOOT_MAX_KEYS );
147 usb_tx( KEYBOARD_ENDPOINT, tx_packet );
148 USBKeys_Changed = USBKeyChangeState_None;
151 // Send NKRO keyboard interrupts packet(s)
153 if ( Output_DebugMode )
155 dbug_msg("NKRO USB: ");
158 // Check system control keys
159 if ( USBKeys_Changed & USBKeyChangeState_System )
161 if ( Output_DebugMode )
164 printHex_op( USBKeys_SysCtrl, 2 );
168 *tx_buf++ = 0x02; // ID
169 *tx_buf = USBKeys_SysCtrl;
173 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
174 USBKeys_Changed &= ~USBKeyChangeState_System; // Mark sent
177 // Check consumer control keys
178 if ( USBKeys_Changed & USBKeyChangeState_Consumer )
180 if ( Output_DebugMode )
183 printHex_op( USBKeys_ConsCtrl, 2 );
187 *tx_buf++ = 0x03; // ID
188 *tx_buf++ = (uint8_t)(USBKeys_ConsCtrl & 0x00FF);
189 *tx_buf = (uint8_t)(USBKeys_ConsCtrl >> 8);
193 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
194 USBKeys_Changed &= ~USBKeyChangeState_Consumer; // Mark sent
197 // Standard HID Keyboard
198 if ( USBKeys_Changed )
200 // USB NKRO Debug output
201 if ( Output_DebugMode )
203 printHex_op( USBKeys_Modifiers, 2 );
205 for ( uint8_t c = 0; c < 6; c++ )
206 printHex_op( USBKeys_Keys[ c ], 2 );
208 for ( uint8_t c = 6; c < 20; c++ )
209 printHex_op( USBKeys_Keys[ c ], 2 );
211 printHex_op( USBKeys_Keys[20], 2 );
213 for ( uint8_t c = 21; c < 27; c++ )
214 printHex_op( USBKeys_Keys[ c ], 2 );
221 *tx_buf++ = 0x01; // ID
222 *tx_buf++ = USBKeys_Modifiers;
225 // 4-49 (first 6 bytes)
226 memcpy( tx_buf, USBKeys_Keys, 6 );
230 // 51-155 (Middle 14 bytes)
231 memcpy( tx_buf, USBKeys_Keys + 6, 14 );
233 tx_packet->len += 14;
235 // 157-164 (Next byte)
236 memcpy( tx_buf, USBKeys_Keys + 20, 1 );
240 // 176-221 (last 6 bytes)
241 memcpy( tx_buf, USBKeys_Keys + 21, 6 );
245 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
246 USBKeys_Changed = USBKeyChangeState_None; // Mark sent