1 /* Copyright (C) 2011-2015 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;
127 // Indicates whether the Output module is fully functional
128 // 0 - Not fully functional, 1 - Fully functional
129 // 0 is often used to show that a USB cable is not plugged in (but has power)
130 uint8_t Output_Available = 0;
134 // ----- Capabilities -----
136 // Set Boot Keyboard Protocol
137 void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args )
139 // Display capability name
140 if ( stateType == 0xFF && state == 0xFF )
142 print("Output_kbdProtocolBoot()");
146 // Only set if necessary
147 if ( USBKeys_Protocol == 0 )
150 // TODO Analog inputs
151 // Only set on key press
152 if ( stateType != 0x01 )
155 // Flush the key buffers
156 Output_flushBuffers();
158 // Set the keyboard protocol to Boot Mode
159 USBKeys_Protocol = 0;
163 // Set NKRO Keyboard Protocol
164 void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args )
166 // Display capability name
167 if ( stateType == 0xFF && state == 0xFF )
169 print("Output_kbdProtocolNKRO()");
173 // Only set if necessary
174 if ( USBKeys_Protocol == 1 )
177 // TODO Analog inputs
178 // Only set on key press
179 if ( stateType != 0x01 )
182 // Flush the key buffers
183 Output_flushBuffers();
185 // Set the keyboard protocol to NKRO Mode
186 USBKeys_Protocol = 1;
190 // Sends a Consumer Control code to the USB Output buffer
191 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
193 // Display capability name
194 if ( stateType == 0xFF && state == 0xFF )
196 print("Output_consCtrlSend(consCode)");
200 // Not implemented in Boot Mode
201 if ( USBKeys_Protocol == 0 )
203 warn_print("Consumer Control is not implemented for Boot Mode");
207 // TODO Analog inputs
208 // Only indicate USB has changed if either a press or release has occured
209 if ( state == 0x01 || state == 0x03 )
210 USBKeys_Changed |= USBKeyChangeState_Consumer;
212 // Only send keypresses if press or hold state
213 if ( stateType == 0x00 && state == 0x03 ) // Release state
216 // Set consumer control code
217 USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
221 // Sends a System Control code to the USB Output buffer
222 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
224 // Display capability name
225 if ( stateType == 0xFF && state == 0xFF )
227 print("Output_sysCtrlSend(sysCode)");
231 // Not implemented in Boot Mode
232 if ( USBKeys_Protocol == 0 )
234 warn_print("System Control is not implemented for Boot Mode");
238 // TODO Analog inputs
239 // Only indicate USB has changed if either a press or release has occured
240 if ( state == 0x01 || state == 0x03 )
241 USBKeys_Changed |= USBKeyChangeState_System;
243 // Only send keypresses if press or hold state
244 if ( stateType == 0x00 && state == 0x03 ) // Release state
247 // Set system control code
248 USBKeys_SysCtrl = args[0];
252 // Adds a single USB Code to the USB Output buffer
253 // Argument #1: USB Code
254 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
256 // Display capability name
257 if ( stateType == 0xFF && state == 0xFF )
259 print("Output_usbCodeSend(usbCode)");
263 // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
264 uint8_t keyPress = 0; // Default to key release, only used for NKRO
265 switch ( USBKeys_Protocol )
268 // TODO Analog inputs
269 // Only indicate USB has changed if either a press or release has occured
270 if ( state == 0x01 || state == 0x03 )
271 USBKeys_Changed = USBKeyChangeState_MainKeys;
273 // Only send keypresses if press or hold state
274 if ( stateType == 0x00 && state == 0x03 ) // Release state
278 // Only send press and release events
279 if ( stateType == 0x00 && state == 0x02 ) // Hold state
282 // Determine if setting or unsetting the bitfield (press == set)
283 if ( stateType == 0x00 && state == 0x01 ) // Press state
288 // Get the keycode from arguments
289 uint8_t key = args[0];
291 // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
292 // Boot mode - Maximum of 6 byte codes
293 // NKRO mode - Each bit of the 26 byte corresponds to a key
294 // Bits 0 - 45 (bytes 0 - 5) correspond to USB Codes 4 - 49 (Main)
295 // Bits 48 - 161 (bytes 6 - 20) correspond to USB Codes 51 - 164 (Secondary)
296 // Bits 168 - 213 (bytes 21 - 26) correspond to USB Codes 176 - 221 (Tertiary)
297 // Bits 214 - 216 unused
298 uint8_t bytePosition = 0;
299 uint8_t byteShift = 0;
300 switch ( USBKeys_Protocol )
303 // Set the modifier bit if this key is a modifier
304 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
306 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
311 // USB Key limit reached
312 if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
314 warn_print("USB Key limit reached");
318 // Make sure key is within the USB HID range
321 USBKeys_Keys[USBKeys_Sent++] = key;
326 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
334 // Set the modifier bit if this key is a modifier
335 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
339 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
343 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
346 USBKeys_Changed |= USBKeyChangeState_Modifiers;
350 else if ( key >= 4 && key <= 49 )
352 // Lookup (otherwise division or multiple checks are needed to do alignment)
353 // Starting at 0th position, each byte has 8 bits, starting at 4th bit
354 uint8_t keyPos = key + (0 * 8 - 4); // Starting position in array, Ignoring 4 keys
365 USBKeys_Changed |= USBKeyChangeState_MainKeys;
368 else if ( key >= 51 && key <= 155 )
370 // Lookup (otherwise division or multiple checks are needed to do alignment)
371 // Starting at 6th byte position, each byte has 8 bits, starting at 51st bit
372 uint8_t keyPos = key + (6 * 8 - 51); // Starting position in array
391 USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
394 else if ( key >= 157 && key <= 164 )
396 // Lookup (otherwise division or multiple checks are needed to do alignment)
397 uint8_t keyPos = key + (20 * 8 - 157); // Starting position in array, Ignoring 6 keys
403 USBKeys_Changed |= USBKeyChangeState_TertiaryKeys;
406 else if ( key >= 176 && key <= 221 )
408 // Lookup (otherwise division or multiple checks are needed to do alignment)
409 uint8_t keyPos = key + (21 * 8 - 176); // Starting position in array
420 USBKeys_Changed |= USBKeyChangeState_QuartiaryKeys;
423 // This is a special USB Code that internally indicates a "break"
424 // It is used to send "nothing" in order to break up sequences of USB Codes
425 else if ( key == 0x00 )
427 USBKeys_Changed |= USBKeyChangeState_MainKeys;
429 // Also flush out buffers just in case
430 Output_flushBuffers();
436 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: ");
445 USBKeys_Keys[bytePosition] |= (1 << byteShift);
450 USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
460 // ----- Functions -----
463 void Output_flushBuffers()
465 // Zero out USBKeys_Keys array
466 for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
467 USBKeys_Keys[ c ] = 0;
469 // Zero out other key buffers
470 USBKeys_ConsCtrl = 0;
471 USBKeys_Modifiers = 0;
477 inline void Output_setup()
479 // Initialize the USB, and then wait for the host to set configuration.
480 // This will hang forever if USB does not initialize
481 // If no USB cable is attached, does not try and initialize USB
484 while ( !usb_configured() );
487 // Register USB Output CLI dictionary
488 CLI_registerDictionary( outputCLIDict, outputCLIDictName );
491 Output_flushBuffers();
496 inline void Output_send()
498 // Boot Mode Only, unset stale keys
499 if ( USBKeys_Protocol == 0 )
500 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
503 // Send keypresses while there are pending changes
504 while ( USBKeys_Changed )
510 // Signal Scan Module we are finished
511 switch ( USBKeys_Protocol )
514 // Clear modifiers only in boot mode
515 USBKeys_Modifiers = 0;
516 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
519 Scan_finishedWithOutput( USBKeys_Sent );
525 // Sets the device into firmware reload mode
526 inline void Output_firmwareReload()
532 // USB Input buffer available
533 inline unsigned int Output_availablechar()
535 return usb_serial_available();
539 // USB Get Character from input buffer
540 inline int Output_getchar()
542 // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
543 return (int)usb_serial_getchar();
547 // USB Send Character to output buffer
548 inline int Output_putchar( char c )
550 return usb_serial_putchar( c );
554 // USB Send String to output buffer, null terminated
555 inline int Output_putstr( char* str )
557 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
559 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
562 // Count characters until NULL character, then send the amount counted
563 while ( str[count] != '\0' )
566 return usb_serial_write( str, count );
571 inline void Output_softReset()
573 usb_device_software_reset();
577 // ----- CLI Command Functions -----
579 void cliFunc_kbdProtocol( char* args )
582 info_msg("Keyboard Protocol: ");
583 printInt8( USBKeys_Protocol );
587 void cliFunc_readLEDs( char* args )
590 info_msg("LED State: ");
591 printInt8( USBKeys_LEDs );
595 void cliFunc_sendKeys( char* args )
597 // Copy USBKeys_KeysCLI to USBKeys_Keys
598 for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
601 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
603 USBKeys_Sent = USBKeys_SentCLI;
606 USBKeys_Modifiers = USBKeys_ModifiersCLI;
610 void cliFunc_setKeys( char* args )
614 char* arg2Ptr = args;
616 // Parse up to USBKeys_MaxSize args (whichever is least)
617 for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
620 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
622 // Stop processing args if no more are found
623 if ( *arg1Ptr == '\0' )
626 // Add the USB code to be sent
628 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
633 void cliFunc_setMod( char* args )
635 // Parse number from argument
636 // NOTE: Only first argument is used
639 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
641 USBKeys_ModifiersCLI = numToInt( arg1Ptr );