1 /* Copyright (C) 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 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
36 #include "../uartOut/arm/uart_serial.h"
37 #include "../pjrcUSB/arm/usb_dev.h"
38 #include "../pjrcUSB/arm/usb_keyboard.h"
39 #include "../pjrcUSB/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 const char outputCLIDictName[] = "USB Module Commands";
77 const CLIDictItem outputCLIDict[] = {
78 { "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
79 { "readLEDs", "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_readLEDs },
80 { "readUART", "Read UART buffer until empty.", cliFunc_readUART },
81 { "sendKeys", "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
82 { "sendUART", "Send characters over UART0.", cliFunc_sendUART },
83 { "setKeys", "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
84 { "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 },
85 { 0, 0, 0 } // Null entry for dictionary end
89 // Which modifier keys are currently pressed
90 // 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
91 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
92 uint8_t USBKeys_Modifiers = 0;
93 uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
95 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
96 uint8_t USBKeys_Keys [USB_NKRO_BITFIELD_SIZE_KEYS];
97 uint8_t USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
99 // System Control and Consumer Control 1KRO containers
100 uint8_t USBKeys_SysCtrl;
101 uint16_t USBKeys_ConsCtrl;
103 // The number of keys sent to the usb in the array
104 uint8_t USBKeys_Sent = 0;
105 uint8_t USBKeys_SentCLI = 0;
107 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
108 volatile uint8_t USBKeys_LEDs = 0;
110 // Protocol setting from the host.
112 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
113 volatile uint8_t USBKeys_Protocol = 0;
115 // Indicate if USB should send update
116 // OS only needs update if there has been a change in state
117 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
119 // the idle configuration, how often we send the report to the
120 // host (ms * 4) even when it hasn't changed
121 uint8_t USBKeys_Idle_Config = 125;
123 // count until idle timeout
124 uint8_t USBKeys_Idle_Count = 0;
128 // ----- Capabilities -----
130 // Sends a Consumer Control code to the USB Output buffer
131 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
133 // Display capability name
134 if ( stateType == 0xFF && state == 0xFF )
136 print("Output_consCtrlSend(consCode)");
140 // Not implemented in Boot Mode
141 if ( USBKeys_Protocol == 0 )
143 warn_print("Consumer Control is not implemented for Boot Mode");
147 // TODO Analog inputs
148 // Only indicate USB has changed if either a press or release has occured
149 if ( state == 0x01 || state == 0x03 )
150 USBKeys_Changed |= USBKeyChangeState_Consumer;
152 // Only send keypresses if press or hold state
153 if ( stateType == 0x00 && state == 0x03 ) // Release state
156 // Set consumer control code
157 USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
161 // Sends a System Control code to the USB Output buffer
162 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
164 // Display capability name
165 if ( stateType == 0xFF && state == 0xFF )
167 print("Output_sysCtrlSend(sysCode)");
171 // Not implemented in Boot Mode
172 if ( USBKeys_Protocol == 0 )
174 warn_print("System Control is not implemented for Boot Mode");
178 // TODO Analog inputs
179 // Only indicate USB has changed if either a press or release has occured
180 if ( state == 0x01 || state == 0x03 )
181 USBKeys_Changed |= USBKeyChangeState_System;
183 // Only send keypresses if press or hold state
184 if ( stateType == 0x00 && state == 0x03 ) // Release state
187 // Set system control code
188 USBKeys_SysCtrl = args[0];
192 // Adds a single USB Code to the USB Output buffer
193 // Argument #1: USB Code
194 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
196 // Display capability name
197 if ( stateType == 0xFF && state == 0xFF )
199 print("Output_usbCodeSend(usbCode)");
203 // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
204 uint8_t keyPress = 0; // Default to key release, only used for NKRO
205 switch ( USBKeys_Protocol )
208 // TODO Analog inputs
209 // Only indicate USB has changed if either a press or release has occured
210 if ( state == 0x01 || state == 0x03 )
211 USBKeys_Changed = USBKeyChangeState_MainKeys;
213 // Only send keypresses if press or hold state
214 if ( stateType == 0x00 && state == 0x03 ) // Release state
218 // Only send press and release events
219 if ( stateType == 0x00 && state == 0x02 ) // Hold state
222 // Determine if setting or unsetting the bitfield (press == set)
223 if ( stateType == 0x00 && state == 0x01 ) // Press state
228 // Get the keycode from arguments
229 uint8_t key = args[0];
231 // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
232 // Boot mode - Maximum of 6 byte codes
233 // NKRO mode - Each bit of the 26 byte corresponds to a key
234 // Bits 0 - 160 (first 20 bytes) correspond to USB Codes 4 - 164
235 // Bits 161 - 205 (last 6 bytes) correspond to USB Codes 176 - 221
236 // Bits 206 - 208 (last byte) correspond to the 3 padded bits in USB (unused)
237 uint8_t bytePosition = 0;
238 uint8_t byteShift = 0;
239 switch ( USBKeys_Protocol )
242 // Set the modifier bit if this key is a modifier
243 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
245 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
250 // USB Key limit reached
251 if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
253 warn_print("USB Key limit reached");
257 // Make sure key is within the USB HID range
260 USBKeys_Keys[USBKeys_Sent++] = key;
265 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
273 // Set the modifier bit if this key is a modifier
274 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
278 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
282 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
285 USBKeys_Changed |= USBKeyChangeState_Modifiers;
289 else if ( key >= 4 && key <= 164 )
291 // Lookup (otherwise division or multiple checks are needed to do alignment)
292 uint8_t keyPos = key - 4; // Starting position in array
317 USBKeys_Changed |= USBKeyChangeState_MainKeys;
320 else if ( key >= 176 && key <= 221 )
322 // Lookup (otherwise division or multiple checks are needed to do alignment)
323 uint8_t keyPos = key - 176; // Starting position in array
334 USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
339 warn_msg("USB Code not within 4-164 (0x4-0xA4) or 176-221 (0xB0-0xDD) NKRO Mode: ");
348 USBKeys_Keys[bytePosition] |= (1 << byteShift);
353 USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
363 // ----- Functions -----
366 inline void Output_setup()
368 // Initialize the USB, and then wait for the host to set configuration.
369 // This will hang forever if USB does not initialize
375 while ( !usb_configured() );
377 // Register USB Output CLI dictionary
378 CLI_registerDictionary( outputCLIDict, outputCLIDictName );
380 // Zero out USBKeys_Keys array
381 for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
382 USBKeys_Keys[ c ] = 0;
387 inline void Output_send()
389 // Boot Mode Only, unset stale keys
390 if ( USBKeys_Protocol == 0 )
391 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
394 // Send keypresses while there are pending changes
395 while ( USBKeys_Changed )
398 // Clear modifiers and keys
399 USBKeys_Modifiers = 0;
402 // Signal Scan Module we are finished
403 switch ( USBKeys_Protocol )
406 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
409 Scan_finishedWithOutput( USBKeys_Sent );
415 // Sets the device into firmware reload mode
416 inline void Output_firmwareReload()
418 uart_device_reload();
422 // USB Input buffer available
423 inline unsigned int Output_availablechar()
425 return usb_serial_available() + uart_serial_available();
429 // USB Get Character from input buffer
430 inline int Output_getchar()
432 // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
433 if ( usb_serial_available() > 0 )
435 return (int)usb_serial_getchar();
438 if ( uart_serial_available() > 0 )
440 return (int)uart_serial_getchar();
447 // USB Send Character to output buffer
448 inline int Output_putchar( char c )
450 // First send to UART
451 uart_serial_putchar( c );
454 return usb_serial_putchar( c );
458 // USB Send String to output buffer, null terminated
459 inline int Output_putstr( char* str )
461 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
463 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
466 // Count characters until NULL character, then send the amount counted
467 while ( str[count] != '\0' )
470 // First send to UART
471 uart_serial_write( str, count );
474 return usb_serial_write( str, count );
479 inline void Output_softReset()
481 usb_device_software_reset();
485 // ----- CLI Command Functions -----
487 void cliFunc_kbdProtocol( char* args )
490 info_msg("Keyboard Protocol: ");
491 printInt8( USBKeys_Protocol );
495 void cliFunc_readLEDs( char* args )
498 info_msg("LED State: ");
499 printInt8( USBKeys_LEDs );
503 void cliFunc_readUART( char* args )
507 // Read UART buffer until empty
508 while ( uart_serial_available() > 0 )
510 char out[] = { (char)uart_serial_getchar(), '\0' };
516 void cliFunc_sendKeys( char* args )
518 // Copy USBKeys_KeysCLI to USBKeys_Keys
519 for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
522 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
524 USBKeys_Sent = USBKeys_SentCLI;
527 USBKeys_Modifiers = USBKeys_ModifiersCLI;
531 void cliFunc_sendUART( char* args )
533 // Write all args to UART
534 uart_serial_write( args, lenStr( args ) );
538 void cliFunc_setKeys( char* args )
542 char* arg2Ptr = args;
544 // Parse up to USBKeys_MaxSize args (whichever is least)
545 for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
548 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
550 // Stop processing args if no more are found
551 if ( *arg1Ptr == '\0' )
554 // Add the USB code to be sent
556 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
561 void cliFunc_setMod( char* args )
563 // Parse number from argument
564 // NOTE: Only first argument is used
567 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
569 USBKeys_ModifiersCLI = numToInt( arg1Ptr );