Output/pjrcUSB/output_com.c

   1 /* Copyright (C) 2011-2014 by Jacob Alexander
   2  *
   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:
   9  *
  10  * The above copyright notice and this permission notice shall be included in
  11  * all copies or substantial portions of the Software.
  12  *
  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
  19  * THE SOFTWARE.
  20  */
  21
  22 // ----- Includes -----
  23
  24 // Compiler Includes
  25 #include <Lib/OutputLib.h>
  26
  27 // Project Includes
  28 #include <cli.h>
  29 #include <led.h>
  30 #include <print.h>
  31 #include <scan_loop.h>
  32
  33 // USB Includes
  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"
  40 #endif
  41
  42 // Local Includes
  43 #include "output_com.h"
  44
  45
  46
  47 // ----- Function Declarations -----
  48
  49 void cliFunc_kbdProtocol( char* args );
  50 void cliFunc_readLEDs   ( char* args );
  51 void cliFunc_sendKeys   ( char* args );
  52 void cliFunc_setKeys    ( char* args );
  53 void cliFunc_setMod     ( char* args );
  54
  55
  56 // ----- Variables -----
  57
  58 // Output Module command dictionary
  59 char*       outputCLIDictName = "USB Module Commands";
  60 CLIDictItem outputCLIDict[] = {
  61         { "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
  62         { "readLEDs",    "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_readLEDs },
  63         { "sendKeys",    "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
  64         { "setKeys",     "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
  65         { "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 },
  66         { 0, 0, 0 } // Null entry for dictionary end
  67 };
  68
  69
  70 // Which modifier keys are currently pressed
  71 // 1=left ctrl,    2=left shift,   4=left alt,    8=left gui
  72 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
  73          uint8_t USBKeys_Modifiers    = 0;
  74          uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
  75
  76 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
  77          uint8_t USBKeys_Array   [USB_MAX_KEY_SEND];
  78          uint8_t USBKeys_ArrayCLI[USB_MAX_KEY_SEND]; // Separate CLI send buffer
  79
  80 // The number of keys sent to the usb in the array
  81          uint8_t USBKeys_Sent    = 0;
  82          uint8_t USBKeys_SentCLI = 0;
  83
  84 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
  85 volatile uint8_t USBKeys_LEDs = 0;
  86
  87 // Protocol setting from the host.
  88 // 0 - Boot Mode (Default, until set by the host)
  89 // 1 - NKRO Mode
  90 volatile uint8_t USBKeys_Protocol = 1;
  91
  92 // the idle configuration, how often we send the report to the
  93 // host (ms * 4) even when it hasn't changed
  94          uint8_t USBKeys_Idle_Config = 125;
  95
  96 // count until idle timeout
  97          uint8_t USBKeys_Idle_Count = 0;
  98
  99
 100 // ----- Capabilities -----
 101
 102 // Adds a single USB Code to the USB Output buffer
 103 // Argument #1: USB Code
 104 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 105 {
 106         // Display capability name
 107         if ( stateType == 0xFF && state == 0xFF )
 108         {
 109                 print("Output_usbCodeSend(usbCode)");
 110                 return;
 111         }
 112
 113         // Get the keycode from arguments
 114         uint8_t key = args[0];
 115
 116         // Set the modifier bit if this key is a modifier
 117         if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
 118         {
 119                 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
 120         }
 121         // Normal USB Code
 122         else
 123         {
 124                 // USB Key limit reached (important for Boot Mode)
 125                 if ( USBKeys_Sent >= USBKeys_MaxSize )
 126                 {
 127                         warn_msg("USB Key limit reached");
 128                         errorLED( 1 );
 129                         return;
 130                 }
 131
 132                 USBKeys_Array[USBKeys_Sent++] = key;
 133         }
 134 }
 135
 136
 137
 138 // ----- Functions -----
 139
 140 // USB Module Setup
 141 inline void Output_setup()
 142 {
 143         // Initialize the USB, and then wait for the host to set configuration.
 144         // If the Teensy is powered without a PC connected to the USB port,
 145         // this will wait forever.
 146         usb_init();
 147
 148         while ( !usb_configured() ) /* wait */ ;
 149
 150         // Register USB Output CLI dictionary
 151         CLI_registerDictionary( outputCLIDict, outputCLIDictName );
 152
 153         // Wait an extra second for the PC's operating system to load drivers
 154         // and do whatever it does to actually be ready for input
 155         //_delay_ms(1000); // TODO (is this actually necessary?)
 156 }
 157
 158
 159 // USB Data Send
 160 inline void Output_send(void)
 161 {
 162         // TODO undo potentially old keys
 163         for ( uint8_t c = USBKeys_Sent; c < USBKeys_MaxSize; c++ )
 164                 USBKeys_Array[c] = 0;
 165
 166         // Send keypresses
 167         usb_keyboard_send();
 168
 169         // Clear modifiers and keys
 170         USBKeys_Modifiers = 0;
 171         USBKeys_Sent      = 0;
 172
 173         // Signal Scan Module we are finished
 174         Scan_finishedWithOutput( USBKeys_Sent <= USBKeys_MaxSize ? USBKeys_Sent : USBKeys_MaxSize );
 175 }
 176
 177
 178 // Sets the device into firmware reload mode
 179 inline void Output_firmwareReload()
 180 {
 181         usb_device_reload();
 182 }
 183
 184
 185 // USB Input buffer available
 186 inline unsigned int Output_availablechar()
 187 {
 188         return usb_serial_available();
 189 }
 190
 191
 192 // USB Get Character from input buffer
 193 inline int Output_getchar()
 194 {
 195         // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
 196         return (int)usb_serial_getchar();
 197 }
 198
 199
 200 // USB Send Character to output buffer
 201 inline int Output_putchar( char c )
 202 {
 203         return usb_serial_putchar( c );
 204 }
 205
 206
 207 // USB Send String to output buffer, null terminated
 208 inline int Output_putstr( char* str )
 209 {
 210 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
 211         uint16_t count = 0;
 212 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
 213         uint32_t count = 0;
 214 #endif
 215         // Count characters until NULL character, then send the amount counted
 216         while ( str[count] != '\0' )
 217                 count++;
 218
 219         return usb_serial_write( str, count );
 220 }
 221
 222
 223 // Soft Chip Reset
 224 inline void Output_softReset()
 225 {
 226         usb_device_software_reset();
 227 }
 228
 229
 230 // ----- CLI Command Functions -----
 231
 232 void cliFunc_kbdProtocol( char* args )
 233 {
 234         print( NL );
 235         info_msg("Keyboard Protocol: ");
 236         printInt8( USBKeys_Protocol );
 237 }
 238
 239
 240 void cliFunc_readLEDs( char* args )
 241 {
 242         print( NL );
 243         info_msg("LED State (This doesn't work yet...): ");
 244         printInt8( USBKeys_LEDs );
 245 }
 246
 247
 248 void cliFunc_sendKeys( char* args )
 249 {
 250         // Copy USBKeys_ArrayCLI to USBKeys_Array
 251         for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
 252         {
 253                 USBKeys_Array[key] = USBKeys_ArrayCLI[key];
 254         }
 255         USBKeys_Sent = USBKeys_SentCLI;
 256
 257         // Set modifier byte
 258         USBKeys_Modifiers = USBKeys_ModifiersCLI;
 259 }
 260
 261
 262 void cliFunc_setKeys( char* args )
 263 {
 264         char* curArgs;
 265         char* arg1Ptr;
 266         char* arg2Ptr = args;
 267
 268         // Parse up to USBKeys_MaxSize args (whichever is least)
 269         for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USBKeys_MaxSize; ++USBKeys_SentCLI )
 270         {
 271                 curArgs = arg2Ptr;
 272                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 273
 274                 // Stop processing args if no more are found
 275                 if ( *arg1Ptr == '\0' )
 276                         break;
 277
 278                 // Add the USB code to be sent
 279                 USBKeys_ArrayCLI[USBKeys_SentCLI] = decToInt( arg1Ptr );
 280         }
 281 }
 282
 283
 284 void cliFunc_setMod( char* args )
 285 {
 286         // Parse number from argument
 287         //  NOTE: Only first argument is used
 288         char* arg1Ptr;
 289         char* arg2Ptr;
 290         CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 291
 292         USBKeys_ModifiersCLI = decToInt( arg1Ptr );
 293 }
 294