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_)
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 const char outputCLIDictName[] = "USB Module Commands";
75 const CLIDictItem outputCLIDict[] = {
76 { "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
77 { "readLEDs", "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_readLEDs },
78 { "sendKeys", "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
79 { "setKeys", "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
80 { "setMod", "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI", cliFunc_setMod },
81 { 0, 0, 0 } // Null entry for dictionary end
85 // Which modifier keys are currently pressed
86 // 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
87 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
88 uint8_t USBKeys_Modifiers = 0;
89 uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
91 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
92 uint8_t USBKeys_Keys [USB_NKRO_BITFIELD_SIZE_KEYS];
93 uint8_t USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
95 // System Control and Consumer Control 1KRO containers
96 uint8_t USBKeys_SysCtrl;
97 uint16_t USBKeys_ConsCtrl;
99 // The number of keys sent to the usb in the array
100 uint8_t USBKeys_Sent = 0;
101 uint8_t USBKeys_SentCLI = 0;
103 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
104 volatile uint8_t USBKeys_LEDs = 0;
106 // Protocol setting from the host.
108 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
109 volatile uint8_t USBKeys_Protocol = 1;
111 // Indicate if USB should send update
112 // OS only needs update if there has been a change in state
113 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
115 // the idle configuration, how often we send the report to the
116 // host (ms * 4) even when it hasn't changed
117 uint8_t USBKeys_Idle_Config = 125;
119 // count until idle timeout
120 uint8_t USBKeys_Idle_Count = 0;
124 // ----- Capabilities -----
126 // Set Boot Keyboard Protocol
127 void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args )
129 // Display capability name
130 if ( stateType == 0xFF && state == 0xFF )
132 print("Output_kbdProtocolBoot()");
136 // Only set if necessary
137 if ( USBKeys_Protocol == 0 )
140 // TODO Analog inputs
141 // Only set on key press
142 if ( stateType != 0x01 )
145 // Flush the key buffers
146 Output_flushBuffers();
148 // Set the keyboard protocol to Boot Mode
149 USBKeys_Protocol = 0;
153 // Set NKRO Keyboard Protocol
154 void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args )
156 // Display capability name
157 if ( stateType == 0xFF && state == 0xFF )
159 print("Output_kbdProtocolNKRO()");
163 // Only set if necessary
164 if ( USBKeys_Protocol == 1 )
167 // TODO Analog inputs
168 // Only set on key press
169 if ( stateType != 0x01 )
172 // Flush the key buffers
173 Output_flushBuffers();
175 // Set the keyboard protocol to NKRO Mode
176 USBKeys_Protocol = 1;
180 // Sends a Consumer Control code to the USB Output buffer
181 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
183 // Display capability name
184 if ( stateType == 0xFF && state == 0xFF )
186 print("Output_consCtrlSend(consCode)");
190 // Not implemented in Boot Mode
191 if ( USBKeys_Protocol == 0 )
193 warn_print("Consumer Control is not implemented for Boot Mode");
197 // TODO Analog inputs
198 // Only indicate USB has changed if either a press or release has occured
199 if ( state == 0x01 || state == 0x03 )
200 USBKeys_Changed |= USBKeyChangeState_Consumer;
202 // Only send keypresses if press or hold state
203 if ( stateType == 0x00 && state == 0x03 ) // Release state
206 // Set consumer control code
207 USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
211 // Sends a System Control code to the USB Output buffer
212 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
214 // Display capability name
215 if ( stateType == 0xFF && state == 0xFF )
217 print("Output_sysCtrlSend(sysCode)");
221 // Not implemented in Boot Mode
222 if ( USBKeys_Protocol == 0 )
224 warn_print("System Control is not implemented for Boot Mode");
228 // TODO Analog inputs
229 // Only indicate USB has changed if either a press or release has occured
230 if ( state == 0x01 || state == 0x03 )
231 USBKeys_Changed |= USBKeyChangeState_System;
233 // Only send keypresses if press or hold state
234 if ( stateType == 0x00 && state == 0x03 ) // Release state
237 // Set system control code
238 USBKeys_SysCtrl = args[0];
242 // Adds a single USB Code to the USB Output buffer
243 // Argument #1: USB Code
244 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
246 // Display capability name
247 if ( stateType == 0xFF && state == 0xFF )
249 print("Output_usbCodeSend(usbCode)");
253 // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
254 uint8_t keyPress = 0; // Default to key release, only used for NKRO
255 switch ( USBKeys_Protocol )
258 // TODO Analog inputs
259 // Only indicate USB has changed if either a press or release has occured
260 if ( state == 0x01 || state == 0x03 )
261 USBKeys_Changed = USBKeyChangeState_MainKeys;
263 // Only send keypresses if press or hold state
264 if ( stateType == 0x00 && state == 0x03 ) // Release state
268 // Only send press and release events
269 if ( stateType == 0x00 && state == 0x02 ) // Hold state
272 // Determine if setting or unsetting the bitfield (press == set)
273 if ( stateType == 0x00 && state == 0x01 ) // Press state
278 // Get the keycode from arguments
279 uint8_t key = args[0];
281 // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
282 // Boot mode - Maximum of 6 byte codes
283 // NKRO mode - Each bit of the 26 byte corresponds to a key
284 // Bits 0 - 160 (first 20 bytes) correspond to USB Codes 4 - 164
285 // Bits 161 - 205 (last 6 bytes) correspond to USB Codes 176 - 221
286 // Bits 206 - 208 (last byte) correspond to the 3 padded bits in USB (unused)
287 uint8_t bytePosition = 0;
288 uint8_t byteShift = 0;
289 switch ( USBKeys_Protocol )
292 // Set the modifier bit if this key is a modifier
293 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
295 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
300 // USB Key limit reached
301 if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
303 warn_print("USB Key limit reached");
307 // Make sure key is within the USB HID range
310 USBKeys_Keys[USBKeys_Sent++] = key;
315 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
323 // Set the modifier bit if this key is a modifier
324 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
328 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
332 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
335 USBKeys_Changed |= USBKeyChangeState_Modifiers;
339 else if ( key >= 4 && key <= 164 )
341 // Lookup (otherwise division or multiple checks are needed to do alignment)
342 uint8_t keyPos = key - 4; // Starting position in array
367 USBKeys_Changed |= USBKeyChangeState_MainKeys;
370 else if ( key >= 176 && key <= 221 )
372 // Lookup (otherwise division or multiple checks are needed to do alignment)
373 uint8_t keyPos = key - 176; // Starting position in array
384 USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
389 warn_msg("USB Code not within 4-164 (0x4-0xA4) or 176-221 (0xB0-0xDD) NKRO Mode: ");
398 USBKeys_Keys[bytePosition] |= (1 << byteShift);
403 USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
413 // ----- Functions -----
416 void Output_flushBuffers()
418 // Zero out USBKeys_Keys array
419 for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
420 USBKeys_Keys[ c ] = 0;
422 // Zero out other key buffers
423 USBKeys_ConsCtrl = 0;
424 USBKeys_Modifiers = 0;
430 inline void Output_setup()
432 // Initialize the USB, and then wait for the host to set configuration.
433 // This will hang forever if USB does not initialize
436 while ( !usb_configured() );
438 // Register USB Output CLI dictionary
439 CLI_registerDictionary( outputCLIDict, outputCLIDictName );
442 Output_flushBuffers();
447 inline void Output_send()
449 // Boot Mode Only, unset stale keys
450 if ( USBKeys_Protocol == 0 )
451 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
454 // Send keypresses while there are pending changes
455 while ( USBKeys_Changed )
458 // Clear modifiers and keys
459 USBKeys_Modifiers = 0;
462 // Signal Scan Module we are finished
463 switch ( USBKeys_Protocol )
466 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
469 Scan_finishedWithOutput( USBKeys_Sent );
475 // Sets the device into firmware reload mode
476 inline void Output_firmwareReload()
482 // USB Input buffer available
483 inline unsigned int Output_availablechar()
485 return usb_serial_available();
489 // USB Get Character from input buffer
490 inline int Output_getchar()
492 // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
493 return (int)usb_serial_getchar();
497 // USB Send Character to output buffer
498 inline int Output_putchar( char c )
500 return usb_serial_putchar( c );
504 // USB Send String to output buffer, null terminated
505 inline int Output_putstr( char* str )
507 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
509 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
512 // Count characters until NULL character, then send the amount counted
513 while ( str[count] != '\0' )
516 return usb_serial_write( str, count );
521 inline void Output_softReset()
523 usb_device_software_reset();
527 // ----- CLI Command Functions -----
529 void cliFunc_kbdProtocol( char* args )
532 info_msg("Keyboard Protocol: ");
533 printInt8( USBKeys_Protocol );
537 void cliFunc_readLEDs( char* args )
540 info_msg("LED State: ");
541 printInt8( USBKeys_LEDs );
545 void cliFunc_sendKeys( char* args )
547 // Copy USBKeys_KeysCLI to USBKeys_Keys
548 for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
551 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
553 USBKeys_Sent = USBKeys_SentCLI;
556 USBKeys_Modifiers = USBKeys_ModifiersCLI;
560 void cliFunc_setKeys( char* args )
564 char* arg2Ptr = args;
566 // Parse up to USBKeys_MaxSize args (whichever is least)
567 for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
570 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
572 // Stop processing args if no more are found
573 if ( *arg1Ptr == '\0' )
576 // Add the USB code to be sent
578 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
583 void cliFunc_setMod( char* args )
585 // Parse number from argument
586 // NOTE: Only first argument is used
589 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
591 USBKeys_ModifiersCLI = numToInt( arg1Ptr );