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
55 #if F_CPU == 168000000
56 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 1100)
57 #elif F_CPU == 144000000
58 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 932)
59 #elif F_CPU == 120000000
60 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 764)
61 #elif F_CPU == 96000000
62 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 596)
63 #elif F_CPU == 72000000
64 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 512)
65 #elif F_CPU == 48000000
66 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 428)
67 #elif F_CPU == 24000000
68 #define TX_TIMEOUT (TX_TIMEOUT_MSEC * 262)
73 // ----- Variables -----
75 static uint8_t transmit_previous_timeout = 0;
79 // ----- Functions -----
81 // send the contents of keyboard_keys and keyboard_modifier_keys
82 void usb_keyboard_send()
84 uint32_t wait_count = 0;
85 usb_packet_t *tx_packet;
90 if ( !usb_configuration )
92 erro_print("USB not configured...");
96 if ( USBKeys_Protocol == 0 ) // Boot Mode
98 if ( usb_tx_packet_count( KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
100 tx_packet = usb_malloc();
105 else if ( USBKeys_Protocol == 1 ) // NKRO Mode
107 if ( usb_tx_packet_count( NKRO_KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
109 tx_packet = usb_malloc();
114 else if ( USBKeys_Changed &
115 ( USBKeyChangeState_System | USBKeyChangeState_Consumer )
118 if ( usb_tx_packet_count( SYS_CTRL_ENDPOINT ) < TX_PACKET_LIMIT )
120 tx_packet = usb_malloc();
126 if ( ++wait_count > TX_TIMEOUT || transmit_previous_timeout )
128 transmit_previous_timeout = 1;
129 warn_print("USB Transmit Timeout...");
135 // Pointer to USB tx packet buffer
136 uint8_t *tx_buf = tx_packet->buf;
138 // Check system control keys
139 if ( USBKeys_Changed & USBKeyChangeState_System )
141 if ( Output_DebugMode )
144 printHex_op( USBKeys_SysCtrl, 2 );
148 *tx_buf++ = 0x02; // ID
149 *tx_buf = USBKeys_SysCtrl;
153 usb_tx( SYS_CTRL_ENDPOINT, tx_packet );
154 USBKeys_Changed &= ~USBKeyChangeState_System; // Mark sent
158 // Check consumer control keys
159 if ( USBKeys_Changed & USBKeyChangeState_Consumer )
161 if ( Output_DebugMode )
164 printHex_op( USBKeys_ConsCtrl, 2 );
168 *tx_buf++ = 0x03; // ID
169 *tx_buf++ = (uint8_t)(USBKeys_ConsCtrl & 0x00FF);
170 *tx_buf = (uint8_t)(USBKeys_ConsCtrl >> 8);
174 usb_tx( SYS_CTRL_ENDPOINT, tx_packet );
175 USBKeys_Changed &= ~USBKeyChangeState_Consumer; // Mark sent
179 switch ( USBKeys_Protocol )
181 // Send boot keyboard interrupt packet(s)
183 // USB Boot Mode debug output
184 if ( Output_DebugMode )
186 dbug_msg("Boot USB: ");
187 printHex_op( USBKeys_Modifiers, 2 );
191 printHex_op( USBKeys_Keys[0], 2 );
192 printHex_op( USBKeys_Keys[1], 2 );
193 printHex_op( USBKeys_Keys[2], 2 );
194 printHex_op( USBKeys_Keys[3], 2 );
195 printHex_op( USBKeys_Keys[4], 2 );
196 printHex_op( USBKeys_Keys[5], 2 );
201 *tx_buf++ = USBKeys_Modifiers;
203 memcpy( tx_buf, USBKeys_Keys, USB_BOOT_MAX_KEYS );
207 usb_tx( KEYBOARD_ENDPOINT, tx_packet );
208 USBKeys_Changed = USBKeyChangeState_None;
211 // Send NKRO keyboard interrupts packet(s)
213 if ( Output_DebugMode )
215 dbug_msg("NKRO USB: ");
218 // Standard HID Keyboard
219 if ( USBKeys_Changed )
221 // USB NKRO Debug output
222 if ( Output_DebugMode )
224 printHex_op( USBKeys_Modifiers, 2 );
226 for ( uint8_t c = 0; c < 6; c++ )
227 printHex_op( USBKeys_Keys[ c ], 2 );
229 for ( uint8_t c = 6; c < 20; c++ )
230 printHex_op( USBKeys_Keys[ c ], 2 );
232 printHex_op( USBKeys_Keys[20], 2 );
234 for ( uint8_t c = 21; c < 27; c++ )
235 printHex_op( USBKeys_Keys[ c ], 2 );
242 *tx_buf++ = 0x01; // ID
243 *tx_buf++ = USBKeys_Modifiers;
246 // 4-49 (first 6 bytes)
247 memcpy( tx_buf, USBKeys_Keys, 6 );
251 // 51-155 (Middle 14 bytes)
252 memcpy( tx_buf, USBKeys_Keys + 6, 14 );
254 tx_packet->len += 14;
256 // 157-164 (Next byte)
257 memcpy( tx_buf, USBKeys_Keys + 20, 1 );
261 // 176-221 (last 6 bytes)
262 memcpy( tx_buf, USBKeys_Keys + 21, 6 );
266 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
267 USBKeys_Changed = USBKeyChangeState_None; // Mark sent