1 /* Copyright (C) 2014-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 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
36 #include <arm/uart_serial.h>
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_readUART ( char* args );
66 void cliFunc_sendKeys ( char* args );
67 void cliFunc_sendUART ( char* args );
68 void cliFunc_setKeys ( char* args );
69 void cliFunc_setMod ( char* args );
73 // ----- Variables -----
75 // Output Module command dictionary
76 CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode" );
77 CLIDict_Entry( readLEDs, "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc." );
78 CLIDict_Entry( readUART, "Read UART buffer until empty." );
79 CLIDict_Entry( sendKeys, "Send the prepared list of USB codes and modifier byte." );
80 CLIDict_Entry( sendUART, "Send characters over UART0." );
81 CLIDict_Entry( setKeys, "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m." );
82 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" );
84 CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
85 CLIDict_Item( kbdProtocol ),
86 CLIDict_Item( readLEDs ),
87 CLIDict_Item( readUART ),
88 CLIDict_Item( sendKeys ),
89 CLIDict_Item( sendUART ),
90 CLIDict_Item( setKeys ),
91 CLIDict_Item( setMod ),
92 { 0, 0, 0 } // Null entry for dictionary end
96 // Which modifier keys are currently pressed
97 // 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
98 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
99 uint8_t USBKeys_Modifiers = 0;
100 uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
102 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
103 uint8_t USBKeys_Keys [USB_NKRO_BITFIELD_SIZE_KEYS];
104 uint8_t USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
106 // System Control and Consumer Control 1KRO containers
107 uint8_t USBKeys_SysCtrl;
108 uint16_t USBKeys_ConsCtrl;
110 // The number of keys sent to the usb in the array
111 uint8_t USBKeys_Sent = 0;
112 uint8_t USBKeys_SentCLI = 0;
114 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
115 volatile uint8_t USBKeys_LEDs = 0;
117 // Protocol setting from the host.
119 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
120 volatile uint8_t USBKeys_Protocol = 0;
122 // Indicate if USB should send update
123 // OS only needs update if there has been a change in state
124 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
126 // the idle configuration, how often we send the report to the
127 // host (ms * 4) even when it hasn't changed
128 uint8_t USBKeys_Idle_Config = 125;
130 // count until idle timeout
131 uint8_t USBKeys_Idle_Count = 0;
133 // Indicates whether the Output module is fully functional
134 // 0 - Not fully functional, 1 - Fully functional
135 // 0 is often used to show that a USB cable is not plugged in (but has power)
136 uint8_t Output_Available = 0;
138 // Debug control variable for Output modules
139 // 0 - Debug disabled (default)
141 uint8_t Output_DebugMode = 0;
145 // ----- Capabilities -----
147 // Set Boot Keyboard Protocol
148 void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args )
150 // Display capability name
151 if ( stateType == 0xFF && state == 0xFF )
153 print("Output_kbdProtocolBoot()");
157 // Only set if necessary
158 if ( USBKeys_Protocol == 0 )
161 // TODO Analog inputs
162 // Only set on key press
163 if ( stateType != 0x01 )
166 // Flush the key buffers
167 Output_flushBuffers();
169 // Set the keyboard protocol to Boot Mode
170 USBKeys_Protocol = 0;
174 // Set NKRO Keyboard Protocol
175 void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args )
177 // Display capability name
178 if ( stateType == 0xFF && state == 0xFF )
180 print("Output_kbdProtocolNKRO()");
184 // Only set if necessary
185 if ( USBKeys_Protocol == 1 )
188 // TODO Analog inputs
189 // Only set on key press
190 if ( stateType != 0x01 )
193 // Flush the key buffers
194 Output_flushBuffers();
196 // Set the keyboard protocol to NKRO Mode
197 USBKeys_Protocol = 1;
201 // Sends a Consumer Control code to the USB Output buffer
202 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
204 // Display capability name
205 if ( stateType == 0xFF && state == 0xFF )
207 print("Output_consCtrlSend(consCode)");
211 // Not implemented in Boot Mode
212 if ( USBKeys_Protocol == 0 )
214 warn_print("Consumer Control is not implemented for Boot Mode");
218 // TODO Analog inputs
219 // Only indicate USB has changed if either a press or release has occured
220 if ( state == 0x01 || state == 0x03 )
221 USBKeys_Changed |= USBKeyChangeState_Consumer;
223 // Only send keypresses if press or hold state
224 if ( stateType == 0x00 && state == 0x03 ) // Release state
227 // Set consumer control code
228 USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
232 // Sends a System Control code to the USB Output buffer
233 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
235 // Display capability name
236 if ( stateType == 0xFF && state == 0xFF )
238 print("Output_sysCtrlSend(sysCode)");
242 // Not implemented in Boot Mode
243 if ( USBKeys_Protocol == 0 )
245 warn_print("System Control is not implemented for Boot Mode");
249 // TODO Analog inputs
250 // Only indicate USB has changed if either a press or release has occured
251 if ( state == 0x01 || state == 0x03 )
252 USBKeys_Changed |= USBKeyChangeState_System;
254 // Only send keypresses if press or hold state
255 if ( stateType == 0x00 && state == 0x03 ) // Release state
258 // Set system control code
259 USBKeys_SysCtrl = args[0];
263 // Adds a single USB Code to the USB Output buffer
264 // Argument #1: USB Code
265 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
267 // Display capability name
268 if ( stateType == 0xFF && state == 0xFF )
270 print("Output_usbCodeSend(usbCode)");
274 // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
275 uint8_t keyPress = 0; // Default to key release, only used for NKRO
276 switch ( USBKeys_Protocol )
279 // TODO Analog inputs
280 // Only indicate USB has changed if either a press or release has occured
281 if ( state == 0x01 || state == 0x03 )
282 USBKeys_Changed = USBKeyChangeState_MainKeys;
284 // Only send keypresses if press or hold state
285 if ( stateType == 0x00 && state == 0x03 ) // Release state
289 // Only send press and release events
290 if ( stateType == 0x00 && state == 0x02 ) // Hold state
293 // Determine if setting or unsetting the bitfield (press == set)
294 if ( stateType == 0x00 && state == 0x01 ) // Press state
299 // Get the keycode from arguments
300 uint8_t key = args[0];
302 // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
303 // Boot mode - Maximum of 6 byte codes
304 // NKRO mode - Each bit of the 26 byte corresponds to a key
305 // Bits 0 - 160 (first 20 bytes) correspond to USB Codes 4 - 164
306 // Bits 161 - 205 (last 6 bytes) correspond to USB Codes 176 - 221
307 // Bits 206 - 208 (last byte) correspond to the 3 padded bits in USB (unused)
308 uint8_t bytePosition = 0;
309 uint8_t byteShift = 0;
310 switch ( USBKeys_Protocol )
313 // Set the modifier bit if this key is a modifier
314 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
316 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
321 // USB Key limit reached
322 if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
324 warn_print("USB Key limit reached");
328 // Make sure key is within the USB HID range
331 USBKeys_Keys[USBKeys_Sent++] = key;
336 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
344 // Set the modifier bit if this key is a modifier
345 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
349 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
353 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
356 USBKeys_Changed |= USBKeyChangeState_Modifiers;
360 else if ( key >= 4 && key <= 164 )
362 // Lookup (otherwise division or multiple checks are needed to do alignment)
363 uint8_t keyPos = key - 4; // Starting position in array
388 USBKeys_Changed |= USBKeyChangeState_MainKeys;
391 else if ( key >= 176 && key <= 221 )
393 // Lookup (otherwise division or multiple checks are needed to do alignment)
394 uint8_t keyPos = key - 176; // Starting position in array
405 USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
410 warn_msg("USB Code not within 4-164 (0x4-0xA4) or 176-221 (0xB0-0xDD) NKRO Mode: ");
419 USBKeys_Keys[bytePosition] |= (1 << byteShift);
424 USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
434 // ----- Functions -----
437 void Output_flushBuffers()
439 // Zero out USBKeys_Keys array
440 for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
441 USBKeys_Keys[ c ] = 0;
443 // Zero out other key buffers
444 USBKeys_ConsCtrl = 0;
445 USBKeys_Modifiers = 0;
451 inline void Output_setup()
455 print("\033[2J"); // Clear screen
457 // Initialize the USB, and then wait for the host to set configuration.
458 // This will hang forever if USB does not initialize
461 while ( !usb_configured() );
463 // Register USB Output CLI dictionary
464 CLI_registerDictionary( outputCLIDict, outputCLIDictName );
466 // Zero out USBKeys_Keys array
467 for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
468 USBKeys_Keys[ c ] = 0;
473 inline void Output_send()
475 // Boot Mode Only, unset stale keys
476 if ( USBKeys_Protocol == 0 )
477 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
480 // Send keypresses while there are pending changes
481 while ( USBKeys_Changed )
484 // Clear modifiers and keys
485 USBKeys_Modifiers = 0;
488 // Signal Scan Module we are finished
489 switch ( USBKeys_Protocol )
492 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
495 Scan_finishedWithOutput( USBKeys_Sent );
501 // Sets the device into firmware reload mode
502 inline void Output_firmwareReload()
504 uart_device_reload();
508 // USB Input buffer available
509 inline unsigned int Output_availablechar()
511 return usb_serial_available() + uart_serial_available();
515 // USB Get Character from input buffer
516 inline int Output_getchar()
518 // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
519 if ( usb_serial_available() > 0 )
521 return (int)usb_serial_getchar();
524 if ( uart_serial_available() > 0 )
526 return (int)uart_serial_getchar();
533 // USB Send Character to output buffer
534 inline int Output_putchar( char c )
536 // First send to UART
537 uart_serial_putchar( c );
540 return usb_serial_putchar( c );
544 // USB Send String to output buffer, null terminated
545 inline int Output_putstr( char* str )
547 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
549 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
552 // Count characters until NULL character, then send the amount counted
553 while ( str[count] != '\0' )
556 // First send to UART
557 uart_serial_write( str, count );
560 return usb_serial_write( str, count );
565 inline void Output_softReset()
567 usb_device_software_reset();
571 // ----- CLI Command Functions -----
573 void cliFunc_kbdProtocol( char* args )
576 info_msg("Keyboard Protocol: ");
577 printInt8( USBKeys_Protocol );
581 void cliFunc_readLEDs( char* args )
584 info_msg("LED State: ");
585 printInt8( USBKeys_LEDs );
589 void cliFunc_readUART( char* args )
593 // Read UART buffer until empty
594 while ( uart_serial_available() > 0 )
596 char out[] = { (char)uart_serial_getchar(), '\0' };
602 void cliFunc_sendKeys( char* args )
604 // Copy USBKeys_KeysCLI to USBKeys_Keys
605 for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
608 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
610 USBKeys_Sent = USBKeys_SentCLI;
613 USBKeys_Modifiers = USBKeys_ModifiersCLI;
617 void cliFunc_sendUART( char* args )
619 // Write all args to UART
620 uart_serial_write( args, lenStr( args ) );
624 void cliFunc_setKeys( char* args )
628 char* arg2Ptr = args;
630 // Parse up to USBKeys_MaxSize args (whichever is least)
631 for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
634 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
636 // Stop processing args if no more are found
637 if ( *arg1Ptr == '\0' )
640 // Add the USB code to be sent
642 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
647 void cliFunc_setMod( char* args )
649 // Parse number from argument
650 // NOTE: Only first argument is used
653 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
655 USBKeys_ModifiersCLI = numToInt( arg1Ptr );