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;
79 if (remote_wakeup_enabled) {
80 USB0_CTL |= USB_CTL_RESUME;
81 _delay_ms(5); //wait 1 to 15ms
82 USB0_CTL &= ~USB_CTL_RESUME;
89 if ( !usb_configuration )
91 erro_print("USB not configured...");
95 if ( USBKeys_Protocol == 0 ) // Boot Mode
97 if ( usb_tx_packet_count( NKRO_KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
99 tx_packet = usb_malloc();
104 else if ( USBKeys_Protocol == 1 ) // NKRO Mode
106 if ( usb_tx_packet_count( KEYBOARD_ENDPOINT ) < TX_PACKET_LIMIT )
108 tx_packet = usb_malloc();
114 if ( ++wait_count > TX_TIMEOUT || transmit_previous_timeout )
116 transmit_previous_timeout = 1;
117 warn_print("USB Transmit Timeout...");
123 // Pointer to USB tx packet buffer
124 uint8_t *tx_buf = tx_packet->buf;
126 switch ( USBKeys_Protocol )
128 // Send boot keyboard interrupt packet(s)
130 // USB Boot Mode debug output
131 if ( Output_DebugMode )
133 dbug_msg("Boot USB: ");
134 printHex_op( USBKeys_Modifiers, 2 );
138 printHex_op( USBKeys_Keys[0], 2 );
139 printHex_op( USBKeys_Keys[1], 2 );
140 printHex_op( USBKeys_Keys[2], 2 );
141 printHex_op( USBKeys_Keys[3], 2 );
142 printHex_op( USBKeys_Keys[4], 2 );
143 printHex_op( USBKeys_Keys[5], 2 );
148 *tx_buf++ = USBKeys_Modifiers;
150 memcpy( tx_buf, USBKeys_Keys, USB_BOOT_MAX_KEYS );
154 usb_tx( KEYBOARD_ENDPOINT, tx_packet );
155 USBKeys_Changed = USBKeyChangeState_None;
158 // Send NKRO keyboard interrupts packet(s)
160 if ( Output_DebugMode )
162 dbug_msg("NKRO USB: ");
165 // Check system control keys
166 if ( USBKeys_Changed & USBKeyChangeState_System )
168 if ( Output_DebugMode )
171 printHex_op( USBKeys_SysCtrl, 2 );
175 *tx_buf++ = 0x02; // ID
176 *tx_buf = USBKeys_SysCtrl;
180 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
181 USBKeys_Changed &= ~USBKeyChangeState_System; // Mark sent
184 // Check consumer control keys
185 if ( USBKeys_Changed & USBKeyChangeState_Consumer )
187 if ( Output_DebugMode )
190 printHex_op( USBKeys_ConsCtrl, 2 );
194 *tx_buf++ = 0x03; // ID
195 *tx_buf++ = (uint8_t)(USBKeys_ConsCtrl & 0x00FF);
196 *tx_buf = (uint8_t)(USBKeys_ConsCtrl >> 8);
200 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
201 USBKeys_Changed &= ~USBKeyChangeState_Consumer; // Mark sent
204 // Standard HID Keyboard
205 if ( USBKeys_Changed )
207 // USB NKRO Debug output
208 if ( Output_DebugMode )
210 printHex_op( USBKeys_Modifiers, 2 );
212 for ( uint8_t c = 0; c < 6; c++ )
213 printHex_op( USBKeys_Keys[ c ], 2 );
215 for ( uint8_t c = 6; c < 20; c++ )
216 printHex_op( USBKeys_Keys[ c ], 2 );
218 printHex_op( USBKeys_Keys[20], 2 );
220 for ( uint8_t c = 21; c < 27; c++ )
221 printHex_op( USBKeys_Keys[ c ], 2 );
228 *tx_buf++ = 0x01; // ID
229 *tx_buf++ = USBKeys_Modifiers;
232 // 4-49 (first 6 bytes)
233 memcpy( tx_buf, USBKeys_Keys, 6 );
237 // 51-155 (Middle 14 bytes)
238 memcpy( tx_buf, USBKeys_Keys + 6, 14 );
240 tx_packet->len += 14;
242 // 157-164 (Next byte)
243 memcpy( tx_buf, USBKeys_Keys + 20, 1 );
247 // 176-221 (last 6 bytes)
248 memcpy( tx_buf, USBKeys_Keys + 21, 6 );
252 usb_tx( NKRO_KEYBOARD_ENDPOINT, tx_packet );
253 USBKeys_Changed = USBKeyChangeState_None; // Mark sent