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>
30 #include <scan_loop.h>
33 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
34 #include "avr/usb_keyboard_serial.h"
35 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
36 #include "arm/usb_dev.h"
37 #include "arm/usb_keyboard.h"
38 #include "arm/usb_serial.h"
42 #include "output_com.h"
46 // ----- Function Declarations -----
48 void cliFunc_kbdProtocol( char* args );
49 void cliFunc_readLEDs ( char* args );
50 void cliFunc_sendKeys ( char* args );
51 void cliFunc_setKeys ( char* args );
52 void cliFunc_setMod ( char* args );
55 // ----- Variables -----
57 // Output Module command dictionary
58 char* outputCLIDictName = "USB Module Commands";
59 CLIDictItem outputCLIDict[] = {
60 { "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
61 { "readLEDs", "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_readLEDs },
62 { "sendKeys", "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
63 { "setKeys", "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
64 { "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 },
65 { 0, 0, 0 } // Null entry for dictionary end
69 // Which modifier keys are currently pressed
70 // 1=left ctrl, 2=left shift, 4=left alt, 8=left gui
71 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
72 uint8_t USBKeys_Modifiers = 0;
73 uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
75 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
76 uint8_t USBKeys_Array [USB_MAX_KEY_SEND];
77 uint8_t USBKeys_ArrayCLI[USB_MAX_KEY_SEND]; // Separate CLI send buffer
79 // The number of keys sent to the usb in the array
80 uint8_t USBKeys_Sent = 0;
81 uint8_t USBKeys_SentCLI = 0;
83 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
84 volatile uint8_t USBKeys_LEDs = 0;
86 // Protocol setting from the host.
87 // 0 - Boot Mode (Default, until set by the host)
89 volatile uint8_t USBKeys_Protocol = 1;
91 // the idle configuration, how often we send the report to the
92 // host (ms * 4) even when it hasn't changed
93 uint8_t USBKeys_Idle_Config = 125;
95 // count until idle timeout
96 uint8_t USBKeys_Idle_Count = 0;
99 // ----- Functions -----
102 inline void Output_setup()
104 // Initialize the USB, and then wait for the host to set configuration.
105 // If the Teensy is powered without a PC connected to the USB port,
106 // this will wait forever.
109 while ( !usb_configured() ) /* wait */ ;
111 // Register USB Output CLI dictionary
112 CLI_registerDictionary( outputCLIDict, outputCLIDictName );
114 // Wait an extra second for the PC's operating system to load drivers
115 // and do whatever it does to actually be ready for input
116 //_delay_ms(1000); // TODO (is this actually necessary?)
121 inline void Output_send(void)
123 // TODO undo potentially old keys
124 for ( uint8_t c = USBKeys_Sent; c < USBKeys_MaxSize; c++ )
125 USBKeys_Array[c] = 0;
130 // Clear modifiers and keys
131 USBKeys_Modifiers = 0;
134 // Signal Scan Module we are finishedA
135 Scan_finishedWithUSBBuffer( USBKeys_Sent <= USBKeys_MaxSize ? USBKeys_Sent : USBKeys_MaxSize );
139 // Sets the device into firmware reload mode
140 inline void Output_firmwareReload()
142 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
144 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
150 // USB Input buffer available
151 inline unsigned int Output_availablechar()
153 return usb_serial_available();
157 // USB Get Character from input buffer
158 inline int Output_getchar()
160 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
161 // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes)
162 return (int)usb_serial_getchar();
163 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
164 return usb_serial_getchar();
169 // USB Send Character to output buffer
170 inline int Output_putchar( char c )
172 return usb_serial_putchar( c );
176 // USB Send String to output buffer, null terminated
177 inline int Output_putstr( char* str )
179 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
181 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
184 // Count characters until NULL character, then send the amount counted
185 while ( str[count] != '\0' )
188 return usb_serial_write( str, count );
193 inline void Output_softReset()
195 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
196 usb_debug_software_reset();
197 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
203 // ----- CLI Command Functions -----
205 void cliFunc_kbdProtocol( char* args )
208 info_msg("Keyboard Protocol: ");
209 printInt8( USBKeys_Protocol );
213 void cliFunc_readLEDs( char* args )
216 info_msg("LED State (This doesn't work yet...): ");
217 printInt8( USBKeys_LEDs );
221 void cliFunc_sendKeys( char* args )
223 // Copy USBKeys_ArrayCLI to USBKeys_Array
224 for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
226 USBKeys_Array[key] = USBKeys_ArrayCLI[key];
228 USBKeys_Sent = USBKeys_SentCLI;
231 USBKeys_Modifiers = USBKeys_ModifiersCLI;
235 void cliFunc_setKeys( char* args )
239 char* arg2Ptr = args;
241 // Parse up to USBKeys_MaxSize args (whichever is least)
242 for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USBKeys_MaxSize; ++USBKeys_SentCLI )
245 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
247 // Stop processing args if no more are found
248 if ( *arg1Ptr == '\0' )
251 // Add the USB code to be sent
252 USBKeys_ArrayCLI[USBKeys_SentCLI] = decToInt( arg1Ptr );
257 void cliFunc_setMod( char* args )
259 // Parse number from argument
260 // NOTE: Only first argument is used
263 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
265 USBKeys_ModifiersCLI = decToInt( arg1Ptr );