Output/usbMuxUart/output_com.c

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