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 // ----- Macros -----
  48
  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
  58
  59
  60
  61 // ----- Function Declarations -----
  62
  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 );
  68
  69
  70
  71 // ----- Variables -----
  72
  73 // Output Module command dictionary
  74 const char outputCLIDictName[] = "USB Module Commands";
  75 const CLIDictItem outputCLIDict[] = {
  76         { "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
  77         { "readLEDs",    "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_readLEDs },
  78         { "sendKeys",    "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
  79         { "setKeys",     "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
  80         { "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 },
  81         { 0, 0, 0 } // Null entry for dictionary end
  82 };
  83
  84
  85 // Which modifier keys are currently pressed
  86 // 1=left ctrl,    2=left shift,   4=left alt,    8=left gui
  87 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
  88          uint8_t  USBKeys_Modifiers    = 0;
  89          uint8_t  USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
  90
  91 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
  92          uint8_t  USBKeys_Keys   [USB_NKRO_BITFIELD_SIZE_KEYS];
  93          uint8_t  USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
  94
  95 // System Control and Consumer Control 1KRO containers
  96          uint8_t  USBKeys_SysCtrl;
  97          uint16_t USBKeys_ConsCtrl;
  98
  99 // The number of keys sent to the usb in the array
 100          uint8_t  USBKeys_Sent    = 0;
 101          uint8_t  USBKeys_SentCLI = 0;
 102
 103 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
 104 volatile uint8_t  USBKeys_LEDs = 0;
 105
 106 // Protocol setting from the host.
 107 // 0 - Boot Mode
 108 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
 109 volatile uint8_t  USBKeys_Protocol = 0;
 110
 111 // Indicate if USB should send update
 112 // OS only needs update if there has been a change in state
 113 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
 114
 115 // the idle configuration, how often we send the report to the
 116 // host (ms * 4) even when it hasn't changed
 117          uint8_t  USBKeys_Idle_Config = 125;
 118
 119 // count until idle timeout
 120          uint8_t  USBKeys_Idle_Count = 0;
 121
 122
 123
 124 // ----- Capabilities -----
 125
 126 // Sends a Consumer Control code to the USB Output buffer
 127 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 128 {
 129         // Display capability name
 130         if ( stateType == 0xFF && state == 0xFF )
 131         {
 132                 print("Output_consCtrlSend(consCode)");
 133                 return;
 134         }
 135
 136         // Not implemented in Boot Mode
 137         if ( USBKeys_Protocol == 0 )
 138         {
 139                 warn_print("Consumer Control is not implemented for Boot Mode");
 140                 return;
 141         }
 142
 143         // TODO Analog inputs
 144         // Only indicate USB has changed if either a press or release has occured
 145         if ( state == 0x01 || state == 0x03 )
 146                 USBKeys_Changed |= USBKeyChangeState_Consumer;
 147
 148         // Only send keypresses if press or hold state
 149         if ( stateType == 0x00 && state == 0x03 ) // Release state
 150                 return;
 151
 152         // Set consumer control code
 153         USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
 154 }
 155
 156
 157 // Sends a System Control code to the USB Output buffer
 158 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 159 {
 160         // Display capability name
 161         if ( stateType == 0xFF && state == 0xFF )
 162         {
 163                 print("Output_sysCtrlSend(sysCode)");
 164                 return;
 165         }
 166
 167         // Not implemented in Boot Mode
 168         if ( USBKeys_Protocol == 0 )
 169         {
 170                 warn_print("System Control is not implemented for Boot Mode");
 171                 return;
 172         }
 173
 174         // TODO Analog inputs
 175         // Only indicate USB has changed if either a press or release has occured
 176         if ( state == 0x01 || state == 0x03 )
 177                 USBKeys_Changed |= USBKeyChangeState_System;
 178
 179         // Only send keypresses if press or hold state
 180         if ( stateType == 0x00 && state == 0x03 ) // Release state
 181                 return;
 182
 183         // Set system control code
 184         USBKeys_SysCtrl = args[0];
 185 }
 186
 187
 188 // Adds a single USB Code to the USB Output buffer
 189 // Argument #1: USB Code
 190 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 191 {
 192         // Display capability name
 193         if ( stateType == 0xFF && state == 0xFF )
 194         {
 195                 print("Output_usbCodeSend(usbCode)");
 196                 return;
 197         }
 198
 199         // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
 200         uint8_t keyPress = 0; // Default to key release, only used for NKRO
 201         switch ( USBKeys_Protocol )
 202         {
 203         case 0: // Boot Mode
 204                 // TODO Analog inputs
 205                 // Only indicate USB has changed if either a press or release has occured
 206                 if ( state == 0x01 || state == 0x03 )
 207                         USBKeys_Changed = USBKeyChangeState_MainKeys;
 208
 209                 // Only send keypresses if press or hold state
 210                 if ( stateType == 0x00 && state == 0x03 ) // Release state
 211                         return;
 212                 break;
 213         case 1: // NKRO Mode
 214                 // Only send press and release events
 215                 if ( stateType == 0x00 && state == 0x02 ) // Hold state
 216                         return;
 217
 218                 // Determine if setting or unsetting the bitfield (press == set)
 219                 if ( stateType == 0x00 && state == 0x01 ) // Press state
 220                         keyPress = 1;
 221                 break;
 222         }
 223
 224         // Get the keycode from arguments
 225         uint8_t key = args[0];
 226
 227         // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
 228         // Boot mode - Maximum of 6 byte codes
 229         // NKRO mode - Each bit of the 26 byte corresponds to a key
 230         //  Bits   0 - 160 (first 20 bytes) correspond to USB Codes 4   - 164
 231         //  Bits 161 - 205 (last 6 bytes)   correspond to USB Codes 176 - 221
 232         //  Bits 206 - 208 (last byte)      correspond to the 3 padded bits in USB (unused)
 233         uint8_t bytePosition = 0;
 234         uint8_t byteShift = 0;
 235         switch ( USBKeys_Protocol )
 236         {
 237         case 0: // Boot Mode
 238                 // Set the modifier bit if this key is a modifier
 239                 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
 240                 {
 241                         USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
 242                 }
 243                 // Normal USB Code
 244                 else
 245                 {
 246                         // USB Key limit reached
 247                         if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
 248                         {
 249                                 warn_print("USB Key limit reached");
 250                                 return;
 251                         }
 252
 253                         // Make sure key is within the USB HID range
 254                         if ( key <= 104 )
 255                         {
 256                                 USBKeys_Keys[USBKeys_Sent++] = key;
 257                         }
 258                         // Invalid key
 259                         else
 260                         {
 261                                 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
 262                                 printHex( key );
 263                                 print( NL );
 264                         }
 265                 }
 266                 break;
 267
 268         case 1: // NKRO Mode
 269                 // Set the modifier bit if this key is a modifier
 270                 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
 271                 {
 272                         if ( keyPress )
 273                         {
 274                                 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
 275                         }
 276                         else // Release
 277                         {
 278                                 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
 279                         }
 280
 281                         USBKeys_Changed |= USBKeyChangeState_Modifiers;
 282                         break;
 283                 }
 284                 // First 20 bytes
 285                 else if ( key >= 4 && key <= 164 )
 286                 {
 287                         // Lookup (otherwise division or multiple checks are needed to do alignment)
 288                         uint8_t keyPos = key - 4; // Starting position in array
 289                         switch ( keyPos )
 290                         {
 291                                 byteLookup( 0 );
 292                                 byteLookup( 1 );
 293                                 byteLookup( 2 );
 294                                 byteLookup( 3 );
 295                                 byteLookup( 4 );
 296                                 byteLookup( 5 );
 297                                 byteLookup( 6 );
 298                                 byteLookup( 7 );
 299                                 byteLookup( 8 );
 300                                 byteLookup( 9 );
 301                                 byteLookup( 10 );
 302                                 byteLookup( 11 );
 303                                 byteLookup( 12 );
 304                                 byteLookup( 13 );
 305                                 byteLookup( 14 );
 306                                 byteLookup( 15 );
 307                                 byteLookup( 16 );
 308                                 byteLookup( 17 );
 309                                 byteLookup( 18 );
 310                                 byteLookup( 19 );
 311                         }
 312
 313                         USBKeys_Changed |= USBKeyChangeState_MainKeys;
 314                 }
 315                 // Last 6 bytes
 316                 else if ( key >= 176 && key <= 221 )
 317                 {
 318                         // Lookup (otherwise division or multiple checks are needed to do alignment)
 319                         uint8_t keyPos = key - 176; // Starting position in array
 320                         switch ( keyPos )
 321                         {
 322                                 byteLookup( 20 );
 323                                 byteLookup( 21 );
 324                                 byteLookup( 22 );
 325                                 byteLookup( 23 );
 326                                 byteLookup( 24 );
 327                                 byteLookup( 25 );
 328                         }
 329
 330                         USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
 331                 }
 332                 // Invalid key
 333                 else
 334                 {
 335                         warn_msg("USB Code not within 4-164 (0x4-0xA4) or 176-221 (0xB0-0xDD) NKRO Mode: ");
 336                         printHex( key );
 337                         print( NL );
 338                         break;
 339                 }
 340
 341                 // Set/Unset
 342                 if ( keyPress )
 343                 {
 344                         USBKeys_Keys[bytePosition] |= (1 << byteShift);
 345                         USBKeys_Sent++;
 346                 }
 347                 else // Release
 348                 {
 349                         USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
 350                         USBKeys_Sent++;
 351                 }
 352
 353                 break;
 354         }
 355 }
 356
 357
 358
 359 // ----- Functions -----
 360
 361 // USB Module Setup
 362 inline void Output_setup()
 363 {
 364         // Initialize the USB, and then wait for the host to set configuration.
 365         // This will hang forever if USB does not initialize
 366         usb_init();
 367
 368         while ( !usb_configured() );
 369
 370         // Register USB Output CLI dictionary
 371         CLI_registerDictionary( outputCLIDict, outputCLIDictName );
 372
 373         // Zero out USBKeys_Keys array
 374         for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
 375                 USBKeys_Keys[ c ] = 0;
 376 }
 377
 378
 379 // USB Data Send
 380 inline void Output_send()
 381 {
 382         // Boot Mode Only, unset stale keys
 383         if ( USBKeys_Protocol == 0 )
 384                 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
 385                         USBKeys_Keys[c] = 0;
 386
 387         // Send keypresses while there are pending changes
 388         while ( USBKeys_Changed )
 389                 usb_keyboard_send();
 390
 391         // Clear modifiers and keys
 392         USBKeys_Modifiers = 0;
 393         USBKeys_Sent      = 0;
 394
 395         // Signal Scan Module we are finished
 396         switch ( USBKeys_Protocol )
 397         {
 398         case 0: // Boot Mode
 399                 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
 400                 break;
 401         case 1: // NKRO Mode
 402                 Scan_finishedWithOutput( USBKeys_Sent );
 403                 break;
 404         }
 405 }
 406
 407
 408 // Sets the device into firmware reload mode
 409 inline void Output_firmwareReload()
 410 {
 411         usb_device_reload();
 412 }
 413
 414
 415 // USB Input buffer available
 416 inline unsigned int Output_availablechar()
 417 {
 418         return usb_serial_available();
 419 }
 420
 421
 422 // USB Get Character from input buffer
 423 inline int Output_getchar()
 424 {
 425         // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
 426         return (int)usb_serial_getchar();
 427 }
 428
 429
 430 // USB Send Character to output buffer
 431 inline int Output_putchar( char c )
 432 {
 433         return usb_serial_putchar( c );
 434 }
 435
 436
 437 // USB Send String to output buffer, null terminated
 438 inline int Output_putstr( char* str )
 439 {
 440 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
 441         uint16_t count = 0;
 442 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
 443         uint32_t count = 0;
 444 #endif
 445         // Count characters until NULL character, then send the amount counted
 446         while ( str[count] != '\0' )
 447                 count++;
 448
 449         return usb_serial_write( str, count );
 450 }
 451
 452
 453 // Soft Chip Reset
 454 inline void Output_softReset()
 455 {
 456         usb_device_software_reset();
 457 }
 458
 459
 460 // ----- CLI Command Functions -----
 461
 462 void cliFunc_kbdProtocol( char* args )
 463 {
 464         print( NL );
 465         info_msg("Keyboard Protocol: ");
 466         printInt8( USBKeys_Protocol );
 467 }
 468
 469
 470 void cliFunc_readLEDs( char* args )
 471 {
 472         print( NL );
 473         info_msg("LED State: ");
 474         printInt8( USBKeys_LEDs );
 475 }
 476
 477
 478 void cliFunc_sendKeys( char* args )
 479 {
 480         // Copy USBKeys_KeysCLI to USBKeys_Keys
 481         for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
 482         {
 483                 // TODO
 484                 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
 485         }
 486         USBKeys_Sent = USBKeys_SentCLI;
 487
 488         // Set modifier byte
 489         USBKeys_Modifiers = USBKeys_ModifiersCLI;
 490 }
 491
 492
 493 void cliFunc_setKeys( char* args )
 494 {
 495         char* curArgs;
 496         char* arg1Ptr;
 497         char* arg2Ptr = args;
 498
 499         // Parse up to USBKeys_MaxSize args (whichever is least)
 500         for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
 501         {
 502                 curArgs = arg2Ptr;
 503                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 504
 505                 // Stop processing args if no more are found
 506                 if ( *arg1Ptr == '\0' )
 507                         break;
 508
 509                 // Add the USB code to be sent
 510                 // TODO
 511                 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
 512         }
 513 }
 514
 515
 516 void cliFunc_setMod( char* args )
 517 {
 518         // Parse number from argument
 519         //  NOTE: Only first argument is used
 520         char* arg1Ptr;
 521         char* arg2Ptr;
 522         CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 523
 524         USBKeys_ModifiersCLI = numToInt( arg1Ptr );
 525 }
 526