1 /* Copyright (C) 2011-2014 by Jacob Alexander
3 * Permission is hereby granted, free of charge, to any person obtaining a copy
4 * of this software and associated documentation files (the "Software"), to deal
5 * in the Software without restriction, including without limitation the rights
6 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
7 * copies of the Software, and to permit persons to whom the Software is
8 * furnished to do so, subject to the following conditions:
10 * The above copyright notice and this permission notice shall be included in
11 * all copies or substantial portions of the Software.
13 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
14 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
15 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
16 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
17 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
18 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
22 // ----- Includes -----
25 #include <Lib/OutputLib.h>
31 #include <scan_loop.h>
34 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
35 #include "avr/usb_keyboard_serial.h"
36 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
37 #include "arm/usb_dev.h"
38 #include "arm/usb_keyboard.h"
39 #include "arm/usb_serial.h"
43 #include "output_com.h"
49 // Used to build a bitmap lookup table from a byte addressable array
50 #define byteLookup( byte ) case (( byte ) * ( 8 )): bytePosition = byte; byteShift = 0; break; \
51 case (( byte ) * ( 8 ) + ( 1 )): bytePosition = byte; byteShift = 1; break; \
52 case (( byte ) * ( 8 ) + ( 2 )): bytePosition = byte; byteShift = 2; break; \
53 case (( byte ) * ( 8 ) + ( 3 )): bytePosition = byte; byteShift = 3; break; \
54 case (( byte ) * ( 8 ) + ( 4 )): bytePosition = byte; byteShift = 4; break; \
55 case (( byte ) * ( 8 ) + ( 5 )): bytePosition = byte; byteShift = 5; break; \
56 case (( byte ) * ( 8 ) + ( 6 )): bytePosition = byte; byteShift = 6; break; \
57 case (( byte ) * ( 8 ) + ( 7 )): bytePosition = byte; byteShift = 7; break
61 // ----- Function Declarations -----
63 void cliFunc_kbdProtocol( char* args );
64 void cliFunc_readLEDs ( char* args );
65 void cliFunc_sendKeys ( char* args );
66 void cliFunc_setKeys ( char* args );
67 void cliFunc_setMod ( char* args );
71 // ----- Variables -----
73 // Output Module command dictionary
74 CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode" );
75 CLIDict_Entry( readLEDs, "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc." );
76 CLIDict_Entry( sendKeys, "Send the prepared list of USB codes and modifier byte." );
77 CLIDict_Entry( setKeys, "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m." );
78 CLIDict_Entry( setMod, "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI" );
80 CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
81 CLIDict_Item( kbdProtocol ),
82 CLIDict_Item( readLEDs ),
83 CLIDict_Item( sendKeys ),
84 CLIDict_Item( setKeys ),
85 CLIDict_Item( setMod ),
86 { 0, 0, 0 } // Null entry for dictionary end
90 // Which modifier keys are currently pressed
91 // 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
92 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
93 uint8_t USBKeys_Modifiers = 0;
94 uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
96 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
97 uint8_t USBKeys_Keys [USB_NKRO_BITFIELD_SIZE_KEYS];
98 uint8_t USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
100 // System Control and Consumer Control 1KRO containers
101 uint8_t USBKeys_SysCtrl;
102 uint16_t USBKeys_ConsCtrl;
104 // The number of keys sent to the usb in the array
105 uint8_t USBKeys_Sent = 0;
106 uint8_t USBKeys_SentCLI = 0;
108 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
109 volatile uint8_t USBKeys_LEDs = 0;
111 // Protocol setting from the host.
113 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
114 volatile uint8_t USBKeys_Protocol = 1;
116 // Indicate if USB should send update
117 // OS only needs update if there has been a change in state
118 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
120 // the idle configuration, how often we send the report to the
121 // host (ms * 4) even when it hasn't changed
122 uint8_t USBKeys_Idle_Config = 125;
124 // count until idle timeout
125 uint8_t USBKeys_Idle_Count = 0;
129 // ----- Capabilities -----
131 // Set Boot Keyboard Protocol
132 void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args )
134 // Display capability name
135 if ( stateType == 0xFF && state == 0xFF )
137 print("Output_kbdProtocolBoot()");
141 // Only set if necessary
142 if ( USBKeys_Protocol == 0 )
145 // TODO Analog inputs
146 // Only set on key press
147 if ( stateType != 0x01 )
150 // Flush the key buffers
151 Output_flushBuffers();
153 // Set the keyboard protocol to Boot Mode
154 USBKeys_Protocol = 0;
158 // Set NKRO Keyboard Protocol
159 void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args )
161 // Display capability name
162 if ( stateType == 0xFF && state == 0xFF )
164 print("Output_kbdProtocolNKRO()");
168 // Only set if necessary
169 if ( USBKeys_Protocol == 1 )
172 // TODO Analog inputs
173 // Only set on key press
174 if ( stateType != 0x01 )
177 // Flush the key buffers
178 Output_flushBuffers();
180 // Set the keyboard protocol to NKRO Mode
181 USBKeys_Protocol = 1;
185 // Sends a Consumer Control code to the USB Output buffer
186 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
188 // Display capability name
189 if ( stateType == 0xFF && state == 0xFF )
191 print("Output_consCtrlSend(consCode)");
195 // Not implemented in Boot Mode
196 if ( USBKeys_Protocol == 0 )
198 warn_print("Consumer Control is not implemented for Boot Mode");
202 // TODO Analog inputs
203 // Only indicate USB has changed if either a press or release has occured
204 if ( state == 0x01 || state == 0x03 )
205 USBKeys_Changed |= USBKeyChangeState_Consumer;
207 // Only send keypresses if press or hold state
208 if ( stateType == 0x00 && state == 0x03 ) // Release state
211 // Set consumer control code
212 USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
216 // Sends a System Control code to the USB Output buffer
217 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
219 // Display capability name
220 if ( stateType == 0xFF && state == 0xFF )
222 print("Output_sysCtrlSend(sysCode)");
226 // Not implemented in Boot Mode
227 if ( USBKeys_Protocol == 0 )
229 warn_print("System Control is not implemented for Boot Mode");
233 // TODO Analog inputs
234 // Only indicate USB has changed if either a press or release has occured
235 if ( state == 0x01 || state == 0x03 )
236 USBKeys_Changed |= USBKeyChangeState_System;
238 // Only send keypresses if press or hold state
239 if ( stateType == 0x00 && state == 0x03 ) // Release state
242 // Set system control code
243 USBKeys_SysCtrl = args[0];
247 // Adds a single USB Code to the USB Output buffer
248 // Argument #1: USB Code
249 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
251 // Display capability name
252 if ( stateType == 0xFF && state == 0xFF )
254 print("Output_usbCodeSend(usbCode)");
258 // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
259 uint8_t keyPress = 0; // Default to key release, only used for NKRO
260 switch ( USBKeys_Protocol )
263 // TODO Analog inputs
264 // Only indicate USB has changed if either a press or release has occured
265 if ( state == 0x01 || state == 0x03 )
266 USBKeys_Changed = USBKeyChangeState_MainKeys;
268 // Only send keypresses if press or hold state
269 if ( stateType == 0x00 && state == 0x03 ) // Release state
273 // Only send press and release events
274 if ( stateType == 0x00 && state == 0x02 ) // Hold state
277 // Determine if setting or unsetting the bitfield (press == set)
278 if ( stateType == 0x00 && state == 0x01 ) // Press state
283 // Get the keycode from arguments
284 uint8_t key = args[0];
286 // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
287 // Boot mode - Maximum of 6 byte codes
288 // NKRO mode - Each bit of the 26 byte corresponds to a key
289 // Bits 0 - 45 (bytes 0 - 5) correspond to USB Codes 4 - 49 (Main)
290 // Bits 48 - 161 (bytes 6 - 20) correspond to USB Codes 51 - 164 (Secondary)
291 // Bits 168 - 213 (bytes 21 - 26) correspond to USB Codes 176 - 221 (Tertiary)
292 // Bits 214 - 216 unused
293 uint8_t bytePosition = 0;
294 uint8_t byteShift = 0;
295 switch ( USBKeys_Protocol )
298 // Set the modifier bit if this key is a modifier
299 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
301 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
306 // USB Key limit reached
307 if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
309 warn_print("USB Key limit reached");
313 // Make sure key is within the USB HID range
316 USBKeys_Keys[USBKeys_Sent++] = key;
321 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
329 // Set the modifier bit if this key is a modifier
330 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
334 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
338 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
341 USBKeys_Changed |= USBKeyChangeState_Modifiers;
345 else if ( key >= 4 && key <= 49 )
347 // Lookup (otherwise division or multiple checks are needed to do alignment)
348 // Starting at 0th position, each byte has 8 bits, starting at 4th bit
349 uint8_t keyPos = key + (0 * 8 - 4); // Starting position in array, Ignoring 4 keys
360 USBKeys_Changed |= USBKeyChangeState_MainKeys;
363 else if ( key >= 51 && key <= 155 )
365 // Lookup (otherwise division or multiple checks are needed to do alignment)
366 // Starting at 6th byte position, each byte has 8 bits, starting at 51st bit
367 uint8_t keyPos = key + (6 * 8 - 51); // Starting position in array
386 USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
389 else if ( key >= 157 && key <= 164 )
391 // Lookup (otherwise division or multiple checks are needed to do alignment)
392 uint8_t keyPos = key + (20 * 8 - 157); // Starting position in array, Ignoring 6 keys
398 USBKeys_Changed |= USBKeyChangeState_TertiaryKeys;
401 else if ( key >= 176 && key <= 221 )
403 // Lookup (otherwise division or multiple checks are needed to do alignment)
404 uint8_t keyPos = key + (21 * 8 - 176); // Starting position in array
415 USBKeys_Changed |= USBKeyChangeState_QuartiaryKeys;
418 // This is a special USB Code that internally indicates a "break"
419 // It is used to send "nothing" in order to break up sequences of USB Codes
420 else if ( key == 0x00 )
422 USBKeys_Changed |= USBKeyChangeState_MainKeys;
424 // Also flush out buffers just in case
425 Output_flushBuffers();
431 warn_msg("USB Code not within 4-49 (0x4-0x31), 51-155 (0x33-0x9B), 157-164 (0x9D-0xA4), 176-221 (0xB0-0xDD) or 224-231 (0xE0-0xE7) NKRO Mode: ");
440 USBKeys_Keys[bytePosition] |= (1 << byteShift);
445 USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
455 // ----- Functions -----
458 void Output_flushBuffers()
460 // Zero out USBKeys_Keys array
461 for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
462 USBKeys_Keys[ c ] = 0;
464 // Zero out other key buffers
465 USBKeys_ConsCtrl = 0;
466 USBKeys_Modifiers = 0;
472 inline void Output_setup()
474 // Initialize the USB, and then wait for the host to set configuration.
475 // This will hang forever if USB does not initialize
478 while ( !usb_configured() );
480 // Register USB Output CLI dictionary
481 CLI_registerDictionary( outputCLIDict, outputCLIDictName );
484 Output_flushBuffers();
489 inline void Output_send()
491 // Boot Mode Only, unset stale keys
492 if ( USBKeys_Protocol == 0 )
493 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
496 // Send keypresses while there are pending changes
497 while ( USBKeys_Changed )
503 // Signal Scan Module we are finished
504 switch ( USBKeys_Protocol )
507 // Clear modifiers only in boot mode
508 USBKeys_Modifiers = 0;
509 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
512 Scan_finishedWithOutput( USBKeys_Sent );
518 // Sets the device into firmware reload mode
519 inline void Output_firmwareReload()
525 // USB Input buffer available
526 inline unsigned int Output_availablechar()
528 return usb_serial_available();
532 // USB Get Character from input buffer
533 inline int Output_getchar()
535 // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
536 return (int)usb_serial_getchar();
540 // USB Send Character to output buffer
541 inline int Output_putchar( char c )
543 return usb_serial_putchar( c );
547 // USB Send String to output buffer, null terminated
548 inline int Output_putstr( char* str )
550 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
552 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
555 // Count characters until NULL character, then send the amount counted
556 while ( str[count] != '\0' )
559 return usb_serial_write( str, count );
564 inline void Output_softReset()
566 usb_device_software_reset();
570 // ----- CLI Command Functions -----
572 void cliFunc_kbdProtocol( char* args )
575 info_msg("Keyboard Protocol: ");
576 printInt8( USBKeys_Protocol );
580 void cliFunc_readLEDs( char* args )
583 info_msg("LED State: ");
584 printInt8( USBKeys_LEDs );
588 void cliFunc_sendKeys( char* args )
590 // Copy USBKeys_KeysCLI to USBKeys_Keys
591 for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
594 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
596 USBKeys_Sent = USBKeys_SentCLI;
599 USBKeys_Modifiers = USBKeys_ModifiersCLI;
603 void cliFunc_setKeys( char* args )
607 char* arg2Ptr = args;
609 // Parse up to USBKeys_MaxSize args (whichever is least)
610 for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
613 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
615 // Stop processing args if no more are found
616 if ( *arg1Ptr == '\0' )
619 // Add the USB code to be sent
621 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
626 void cliFunc_setMod( char* args )
628 // Parse number from argument
629 // NOTE: Only first argument is used
632 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
634 USBKeys_ModifiersCLI = numToInt( arg1Ptr );