Output/pjrcUSB/output_com.c

   1 /* Copyright (C) 2011-2016 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_) || defined(_mk20dx256vlh7_)
  37 #include "arm/usb_dev.h"
  38 #include "arm/usb_keyboard.h"
  39 #include "arm/usb_serial.h"
  40 #include "arm/usb_mouse.h"
  41 #endif
  42
  43 // KLL
  44 #include <kll_defs.h>
  45
  46 // Local Includes
  47 #include "output_com.h"
  48
  49
  50
  51 // ----- Macros -----
  52
  53 // Used to build a bitmap lookup table from a byte addressable array
  54 #define byteLookup( byte ) \
  55         case (( byte ) * ( 8 )):         bytePosition = byte; byteShift = 0; break; \
  56         case (( byte ) * ( 8 ) + ( 1 )): bytePosition = byte; byteShift = 1; break; \
  57         case (( byte ) * ( 8 ) + ( 2 )): bytePosition = byte; byteShift = 2; break; \
  58         case (( byte ) * ( 8 ) + ( 3 )): bytePosition = byte; byteShift = 3; break; \
  59         case (( byte ) * ( 8 ) + ( 4 )): bytePosition = byte; byteShift = 4; break; \
  60         case (( byte ) * ( 8 ) + ( 5 )): bytePosition = byte; byteShift = 5; break; \
  61         case (( byte ) * ( 8 ) + ( 6 )): bytePosition = byte; byteShift = 6; break; \
  62         case (( byte ) * ( 8 ) + ( 7 )): bytePosition = byte; byteShift = 7; break
  63
  64
  65
  66 // ----- Function Declarations -----
  67
  68 void cliFunc_kbdProtocol( char* args );
  69 void cliFunc_outputDebug( char* args );
  70 void cliFunc_readLEDs   ( char* args );
  71 void cliFunc_sendKeys   ( char* args );
  72 void cliFunc_setKeys    ( char* args );
  73 void cliFunc_setMod     ( char* args );
  74
  75
  76
  77 // ----- Variables -----
  78
  79 // Output Module command dictionary
  80 CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode" );
  81 CLIDict_Entry( outputDebug, "Toggle Output Debug mode." );
  82 CLIDict_Entry( readLEDs,    "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc." );
  83 CLIDict_Entry( sendKeys,    "Send the prepared list of USB codes and modifier byte." );
  84 CLIDict_Entry( setKeys,     "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m." );
  85 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" );
  86
  87 CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
  88         CLIDict_Item( kbdProtocol ),
  89         CLIDict_Item( outputDebug ),
  90         CLIDict_Item( readLEDs ),
  91         CLIDict_Item( sendKeys ),
  92         CLIDict_Item( setKeys ),
  93         CLIDict_Item( setMod ),
  94         { 0, 0, 0 } // Null entry for dictionary end
  95 };
  96
  97
  98 // Which modifier keys are currently pressed
  99 // 1=left ctrl,    2=left shift,   4=left alt,    8=left gui
 100 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
 101 uint8_t  USBKeys_Modifiers    = 0;
 102 uint8_t  USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
 103
 104 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
 105 uint8_t  USBKeys_Keys   [USB_NKRO_BITFIELD_SIZE_KEYS];
 106 uint8_t  USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
 107
 108 // System Control and Consumer Control 1KRO containers
 109 uint8_t  USBKeys_SysCtrl;
 110 uint16_t USBKeys_ConsCtrl;
 111
 112 // The number of keys sent to the usb in the array
 113 uint8_t  USBKeys_Sent    = 0;
 114 uint8_t  USBKeys_SentCLI = 0;
 115
 116 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
 117 volatile uint8_t  USBKeys_LEDs = 0;
 118
 119 // Currently pressed mouse buttons, bitmask, 0 represents no buttons pressed
 120 volatile uint16_t USBMouse_Buttons = 0;
 121
 122 // Relative mouse axis movement, stores pending movement
 123 volatile uint16_t USBMouse_Relative_x = 0;
 124 volatile uint16_t USBMouse_Relative_y = 0;
 125
 126 // Protocol setting from the host.
 127 // 0 - Boot Mode
 128 // 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
 129 volatile uint8_t  USBKeys_Protocol = USBProtocol_define;
 130
 131 // Indicate if USB should send update
 132 // OS only needs update if there has been a change in state
 133 USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
 134
 135 // Indicate if USB should send update
 136 USBMouseChangeState USBMouse_Changed = 0;
 137
 138 // the idle configuration, how often we send the report to the
 139 // host (ms * 4) even when it hasn't changed
 140 uint8_t  USBKeys_Idle_Config = 125;
 141
 142 // count until idle timeout
 143 uint8_t  USBKeys_Idle_Count = 0;
 144
 145 // Indicates whether the Output module is fully functional
 146 // 0 - Not fully functional, 1 - Fully functional
 147 // 0 is often used to show that a USB cable is not plugged in (but has power)
 148 volatile uint8_t  Output_Available = 0;
 149
 150 // Debug control variable for Output modules
 151 // 0 - Debug disabled (default)
 152 // 1 - Debug enabled
 153 uint8_t  Output_DebugMode = 0;
 154
 155 // mA - Set by outside module if not using USB (i.e. Interconnect)
 156 // Generally set to 100 mA (low power) or 500 mA (high power)
 157 uint16_t Output_ExtCurrent_Available = 0;
 158
 159 // mA - Set by USB module (if exists)
 160 // Initially 100 mA, but may be negotiated higher (e.g. 500 mA)
 161 uint16_t Output_USBCurrent_Available = 0;
 162
 163
 164
 165 // ----- Capabilities -----
 166
 167 // Set Boot Keyboard Protocol
 168 void Output_kbdProtocolBoot_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 169 {
 170         // Display capability name
 171         if ( stateType == 0xFF && state == 0xFF )
 172         {
 173                 print("Output_kbdProtocolBoot()");
 174                 return;
 175         }
 176
 177         // Only set if necessary
 178         if ( USBKeys_Protocol == 0 )
 179                 return;
 180
 181         // TODO Analog inputs
 182         // Only set on key press
 183         if ( stateType != 0x01 )
 184                 return;
 185
 186         // Flush the key buffers
 187         Output_flushBuffers();
 188
 189         // Set the keyboard protocol to Boot Mode
 190         USBKeys_Protocol = 0;
 191 }
 192
 193
 194 // Set NKRO Keyboard Protocol
 195 void Output_kbdProtocolNKRO_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 196 {
 197         // Display capability name
 198         if ( stateType == 0xFF && state == 0xFF )
 199         {
 200                 print("Output_kbdProtocolNKRO()");
 201                 return;
 202         }
 203
 204         // Only set if necessary
 205         if ( USBKeys_Protocol == 1 )
 206                 return;
 207
 208         // TODO Analog inputs
 209         // Only set on key press
 210         if ( stateType != 0x01 )
 211                 return;
 212
 213         // Flush the key buffers
 214         Output_flushBuffers();
 215
 216         // Set the keyboard protocol to NKRO Mode
 217         USBKeys_Protocol = 1;
 218 }
 219
 220
 221 // Sends a Consumer Control code to the USB Output buffer
 222 void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 223 {
 224         // Display capability name
 225         if ( stateType == 0xFF && state == 0xFF )
 226         {
 227                 print("Output_consCtrlSend(consCode)");
 228                 return;
 229         }
 230
 231         // Not implemented in Boot Mode
 232         if ( USBKeys_Protocol == 0 )
 233         {
 234                 warn_print("Consumer Control is not implemented for Boot Mode");
 235                 return;
 236         }
 237
 238         // TODO Analog inputs
 239         // Only indicate USB has changed if either a press or release has occured
 240         if ( state == 0x01 || state == 0x03 )
 241                 USBKeys_Changed |= USBKeyChangeState_Consumer;
 242
 243         // Only send keypresses if press or hold state
 244         if ( stateType == 0x00 && state == 0x03 ) // Release state
 245         {
 246                 USBKeys_ConsCtrl = 0;
 247                 return;
 248         }
 249
 250         // Set consumer control code
 251         USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
 252 }
 253
 254
 255 // Ignores the given key status update
 256 // Used to prevent fall-through, this is the None keyword in KLL
 257 void Output_noneSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 258 {
 259         // Display capability name
 260         if ( stateType == 0xFF && state == 0xFF )
 261         {
 262                 print("Output_noneSend()");
 263                 return;
 264         }
 265
 266         // Nothing to do, because that's the point :P
 267 }
 268
 269
 270 // Sends a System Control code to the USB Output buffer
 271 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 272 {
 273         // Display capability name
 274         if ( stateType == 0xFF && state == 0xFF )
 275         {
 276                 print("Output_sysCtrlSend(sysCode)");
 277                 return;
 278         }
 279
 280         // Not implemented in Boot Mode
 281         if ( USBKeys_Protocol == 0 )
 282         {
 283                 warn_print("System Control is not implemented for Boot Mode");
 284                 return;
 285         }
 286
 287         // TODO Analog inputs
 288         // Only indicate USB has changed if either a press or release has occured
 289         if ( state == 0x01 || state == 0x03 )
 290                 USBKeys_Changed |= USBKeyChangeState_System;
 291
 292         // Only send keypresses if press or hold state
 293         if ( stateType == 0x00 && state == 0x03 ) // Release state
 294         {
 295                 USBKeys_SysCtrl = 0;
 296                 return;
 297         }
 298
 299         // Set system control code
 300         USBKeys_SysCtrl = args[0];
 301 }
 302
 303
 304 // Adds a single USB Code to the USB Output buffer
 305 // Argument #1: USB Code
 306 void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 307 {
 308         // Display capability name
 309         if ( stateType == 0xFF && state == 0xFF )
 310         {
 311                 print("Output_usbCodeSend(usbCode)");
 312                 return;
 313         }
 314
 315         // Depending on which mode the keyboard is in the USB needs Press/Hold/Release events
 316         uint8_t keyPress = 0; // Default to key release, only used for NKRO
 317         switch ( USBKeys_Protocol )
 318         {
 319         case 0: // Boot Mode
 320                 // TODO Analog inputs
 321                 // Only indicate USB has changed if either a press or release has occured
 322                 if ( state == 0x01 || state == 0x03 )
 323                         USBKeys_Changed = USBKeyChangeState_MainKeys;
 324
 325                 // Only send keypresses if press or hold state
 326                 if ( stateType == 0x00 && state == 0x03 ) // Release state
 327                         return;
 328                 break;
 329         case 1: // NKRO Mode
 330                 // Only send press and release events
 331                 if ( stateType == 0x00 && state == 0x02 ) // Hold state
 332                         return;
 333
 334                 // Determine if setting or unsetting the bitfield (press == set)
 335                 if ( stateType == 0x00 && state == 0x01 ) // Press state
 336                         keyPress = 1;
 337                 break;
 338         }
 339
 340         // Get the keycode from arguments
 341         uint8_t key = args[0];
 342
 343         // Depending on which mode the keyboard is in, USBKeys_Keys array is used differently
 344         // Boot mode - Maximum of 6 byte codes
 345         // NKRO mode - Each bit of the 26 byte corresponds to a key
 346         //  Bits   0 -  45 (bytes  0 -  5) correspond to USB Codes   4 -  49 (Main)
 347         //  Bits  48 - 161 (bytes  6 - 20) correspond to USB Codes  51 - 164 (Secondary)
 348         //  Bits 168 - 213 (bytes 21 - 26) correspond to USB Codes 176 - 221 (Tertiary)
 349         //  Bits 214 - 216                 unused
 350         uint8_t bytePosition = 0;
 351         uint8_t byteShift = 0;
 352         switch ( USBKeys_Protocol )
 353         {
 354         case 0: // Boot Mode
 355                 // Set the modifier bit if this key is a modifier
 356                 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
 357                 {
 358                         USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
 359                 }
 360                 // Normal USB Code
 361                 else
 362                 {
 363                         // USB Key limit reached
 364                         if ( USBKeys_Sent >= USB_BOOT_MAX_KEYS )
 365                         {
 366                                 warn_print("USB Key limit reached");
 367                                 return;
 368                         }
 369
 370                         // Make sure key is within the USB HID range
 371                         if ( key <= 104 )
 372                         {
 373                                 USBKeys_Keys[USBKeys_Sent++] = key;
 374                         }
 375                         // Invalid key
 376                         else
 377                         {
 378                                 warn_msg("USB Code above 104/0x68 in Boot Mode: ");
 379                                 printHex( key );
 380                                 print( NL );
 381                         }
 382                 }
 383                 break;
 384
 385         case 1: // NKRO Mode
 386                 // Set the modifier bit if this key is a modifier
 387                 if ( (key & 0xE0) == 0xE0 ) // AND with 0xE0 (Left Ctrl, first modifier)
 388                 {
 389                         if ( keyPress )
 390                         {
 391                                 USBKeys_Modifiers |= 1 << (key ^ 0xE0); // Left shift 1 by key XOR 0xE0
 392                         }
 393                         else // Release
 394                         {
 395                                 USBKeys_Modifiers &= ~(1 << (key ^ 0xE0)); // Left shift 1 by key XOR 0xE0
 396                         }
 397
 398                         USBKeys_Changed |= USBKeyChangeState_Modifiers;
 399                         break;
 400                 }
 401                 // First 6 bytes
 402                 else if ( key >= 4 && key <= 49 )
 403                 {
 404                         // Lookup (otherwise division or multiple checks are needed to do alignment)
 405                         // Starting at 0th position, each byte has 8 bits, starting at 4th bit
 406                         uint8_t keyPos = key + (0 * 8 - 4); // Starting position in array, Ignoring 4 keys
 407                         switch ( keyPos )
 408                         {
 409                                 byteLookup( 0 );
 410                                 byteLookup( 1 );
 411                                 byteLookup( 2 );
 412                                 byteLookup( 3 );
 413                                 byteLookup( 4 );
 414                                 byteLookup( 5 );
 415                         }
 416
 417                         USBKeys_Changed |= USBKeyChangeState_MainKeys;
 418                 }
 419                 // Next 14 bytes
 420                 else if ( key >= 51 && key <= 155 )
 421                 {
 422                         // Lookup (otherwise division or multiple checks are needed to do alignment)
 423                         // Starting at 6th byte position, each byte has 8 bits, starting at 51st bit
 424                         uint8_t keyPos = key + (6 * 8 - 51); // Starting position in array
 425                         switch ( keyPos )
 426                         {
 427                                 byteLookup( 6 );
 428                                 byteLookup( 7 );
 429                                 byteLookup( 8 );
 430                                 byteLookup( 9 );
 431                                 byteLookup( 10 );
 432                                 byteLookup( 11 );
 433                                 byteLookup( 12 );
 434                                 byteLookup( 13 );
 435                                 byteLookup( 14 );
 436                                 byteLookup( 15 );
 437                                 byteLookup( 16 );
 438                                 byteLookup( 17 );
 439                                 byteLookup( 18 );
 440                                 byteLookup( 19 );
 441                         }
 442
 443                         USBKeys_Changed |= USBKeyChangeState_SecondaryKeys;
 444                 }
 445                 // Next byte
 446                 else if ( key >= 157 && key <= 164 )
 447                 {
 448                         // Lookup (otherwise division or multiple checks are needed to do alignment)
 449                         uint8_t keyPos = key + (20 * 8 - 157); // Starting position in array, Ignoring 6 keys
 450                         switch ( keyPos )
 451                         {
 452                                 byteLookup( 20 );
 453                         }
 454
 455                         USBKeys_Changed |= USBKeyChangeState_TertiaryKeys;
 456                 }
 457                 // Last 6 bytes
 458                 else if ( key >= 176 && key <= 221 )
 459                 {
 460                         // Lookup (otherwise division or multiple checks are needed to do alignment)
 461                         uint8_t keyPos = key + (21 * 8 - 176); // Starting position in array
 462                         switch ( keyPos )
 463                         {
 464                                 byteLookup( 21 );
 465                                 byteLookup( 22 );
 466                                 byteLookup( 23 );
 467                                 byteLookup( 24 );
 468                                 byteLookup( 25 );
 469                                 byteLookup( 26 );
 470                         }
 471
 472                         USBKeys_Changed |= USBKeyChangeState_QuartiaryKeys;
 473                 }
 474                 // Received 0x00
 475                 // This is a special USB Code that internally indicates a "break"
 476                 // It is used to send "nothing" in order to break up sequences of USB Codes
 477                 else if ( key == 0x00 )
 478                 {
 479                         USBKeys_Changed |= USBKeyChangeState_MainKeys;
 480
 481                         // Also flush out buffers just in case
 482                         Output_flushBuffers();
 483                         break;
 484                 }
 485                 // Invalid key
 486                 else
 487                 {
 488                         warn_msg("USB Code not within 4-49 (0x4-0x31), 51-155 (0x33-0x9B), 157-164 (0x9D-0xA4), 176-221 (0xB0-0xDD) or 224-231 (0xE0-0xE7) NKRO Mode: ");
 489                         printHex( key );
 490                         print( NL );
 491                         break;
 492                 }
 493
 494                 // Set/Unset
 495                 if ( keyPress )
 496                 {
 497                         USBKeys_Keys[bytePosition] |= (1 << byteShift);
 498                         USBKeys_Sent++;
 499                 }
 500                 else // Release
 501                 {
 502                         USBKeys_Keys[bytePosition] &= ~(1 << byteShift);
 503                         USBKeys_Sent++;
 504                 }
 505
 506                 break;
 507         }
 508 }
 509
 510 void Output_flashMode_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 511 {
 512         // Display capability name
 513         if ( stateType == 0xFF && state == 0xFF )
 514         {
 515                 print("Output_flashMode()");
 516                 return;
 517         }
 518
 519         // Start flash mode
 520         Output_firmwareReload();
 521 }
 522
 523 // Sends a mouse command over the USB Output buffer
 524 // XXX This function *will* be changing in the future
 525 //     If you use it, be prepared that your .kll files will break in the future (post KLL 0.5)
 526 // Argument #1: USB Mouse Button (16 bit)
 527 // Argument #2: USB X Axis (16 bit) relative
 528 // Argument #3: USB Y Axis (16 bit) relative
 529 void Output_usbMouse_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 530 {
 531         // Display capability name
 532         if ( stateType == 0xFF && state == 0xFF )
 533         {
 534                 print("Output_usbMouse(mouseButton,relX,relY)");
 535                 return;
 536         }
 537
 538         // Determine which mouse button was sent
 539         // The USB spec defines up to a max of 0xFFFF buttons
 540         // The usual are:
 541         // 1 - Button 1 - (Primary)
 542         // 2 - Button 2 - (Secondary)
 543         // 3 - Button 3 - (Tertiary)
 544         uint16_t mouse_button = *(uint16_t*)(&args[0]);
 545
 546         // X/Y Relative Axis
 547         uint16_t mouse_x = *(uint16_t*)(&args[2]);
 548         uint16_t mouse_y = *(uint16_t*)(&args[4]);
 549
 550         // Adjust for bit shift
 551         uint16_t mouse_button_shift = mouse_button - 1;
 552
 553         // Only send mouse button if in press or hold state
 554         if ( stateType == 0x00 && state == 0x03 ) // Release state
 555         {
 556                 // Release
 557                 if ( mouse_button )
 558                         USBMouse_Buttons &= ~(1 << mouse_button_shift);
 559         }
 560         else
 561         {
 562                 // Press or hold
 563                 if ( mouse_button )
 564                         USBMouse_Buttons |= (1 << mouse_button_shift);
 565
 566                 if ( mouse_x )
 567                         USBMouse_Relative_x = mouse_x;
 568                 if ( mouse_y )
 569                         USBMouse_Relative_y = mouse_y;
 570         }
 571
 572         // Trigger updates
 573         if ( mouse_button )
 574                 USBMouse_Changed |= USBMouseChangeState_Buttons;
 575
 576         if ( mouse_x || mouse_y )
 577                 USBMouse_Changed |= USBMouseChangeState_Relative;
 578 }
 579
 580
 581
 582 // ----- Functions -----
 583
 584 // Flush Key buffers
 585 void Output_flushBuffers()
 586 {
 587         // Zero out USBKeys_Keys array
 588         for ( uint8_t c = 0; c < USB_NKRO_BITFIELD_SIZE_KEYS; c++ )
 589                 USBKeys_Keys[ c ] = 0;
 590
 591         // Zero out other key buffers
 592         USBKeys_ConsCtrl = 0;
 593         USBKeys_Modifiers = 0;
 594         USBKeys_SysCtrl = 0;
 595 }
 596
 597
 598 // USB Module Setup
 599 inline void Output_setup()
 600 {
 601         // Initialize the USB
 602         // If a USB connection does not exist, just ignore it
 603         // All usb related functions will non-fatally fail if called
 604         // If the USB initialization is delayed, then functionality will just be delayed
 605         usb_init();
 606
 607         // Register USB Output CLI dictionary
 608         CLI_registerDictionary( outputCLIDict, outputCLIDictName );
 609
 610         // Flush key buffers
 611         Output_flushBuffers();
 612 }
 613
 614
 615 // USB Data Send
 616 inline void Output_send()
 617 {
 618         // USB status checks
 619         // Non-standard USB state manipulation, usually does nothing
 620         usb_device_check();
 621
 622         // Boot Mode Only, unset stale keys
 623         if ( USBKeys_Protocol == 0 )
 624                 for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
 625                         USBKeys_Keys[c] = 0;
 626
 627         // Process mouse actions
 628         while ( USBMouse_Changed )
 629                 usb_mouse_send();
 630
 631         // Send keypresses while there are pending changes
 632         while ( USBKeys_Changed )
 633                 usb_keyboard_send();
 634
 635         // Clear keys sent
 636         USBKeys_Sent = 0;
 637
 638         // Signal Scan Module we are finished
 639         switch ( USBKeys_Protocol )
 640         {
 641         case 0: // Boot Mode
 642                 // Clear modifiers only in boot mode
 643                 USBKeys_Modifiers = 0;
 644                 Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
 645                 break;
 646         case 1: // NKRO Mode
 647                 Scan_finishedWithOutput( USBKeys_Sent );
 648                 break;
 649         }
 650 }
 651
 652
 653 // Sets the device into firmware reload mode
 654 inline void Output_firmwareReload()
 655 {
 656         usb_device_reload();
 657 }
 658
 659
 660 // USB Input buffer available
 661 inline unsigned int Output_availablechar()
 662 {
 663         return usb_serial_available();
 664 }
 665
 666
 667 // USB Get Character from input buffer
 668 inline int Output_getchar()
 669 {
 670         // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes) (AVR)
 671         return (int)usb_serial_getchar();
 672 }
 673
 674
 675 // USB Send Character to output buffer
 676 inline int Output_putchar( char c )
 677 {
 678         return usb_serial_putchar( c );
 679 }
 680
 681
 682 // USB Send String to output buffer, null terminated
 683 inline int Output_putstr( char* str )
 684 {
 685 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
 686         uint16_t count = 0;
 687 #elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
 688         uint32_t count = 0;
 689 #endif
 690         // Count characters until NULL character, then send the amount counted
 691         while ( str[count] != '\0' )
 692                 count++;
 693
 694         return usb_serial_write( str, count );
 695 }
 696
 697
 698 // Soft Chip Reset
 699 inline void Output_softReset()
 700 {
 701         usb_device_software_reset();
 702 }
 703
 704
 705 // Update USB current (mA)
 706 // Triggers power change event
 707 void Output_update_usb_current( unsigned int current )
 708 {
 709         // Only signal if changed
 710         if ( current == Output_USBCurrent_Available )
 711                 return;
 712
 713         // Update USB current
 714         Output_USBCurrent_Available = current;
 715
 716         unsigned int total_current = Output_current_available();
 717         info_msg("USB Available Current Changed. Total Available: ");
 718         printInt32( total_current );
 719         print(" mA" NL);
 720
 721         // Send new total current to the Scan Modules
 722         Scan_currentChange( Output_current_available() );
 723 }
 724
 725
 726 // Update external current (mA)
 727 // Triggers power change event
 728 void Output_update_external_current( unsigned int current )
 729 {
 730         // Only signal if changed
 731         if ( current == Output_ExtCurrent_Available )
 732                 return;
 733
 734         // Update external current
 735         Output_ExtCurrent_Available = current;
 736
 737         unsigned int total_current = Output_current_available();
 738         info_msg("External Available Current Changed. Total Available: ");
 739         printInt32( total_current );
 740         print(" mA" NL);
 741
 742         // Send new total current to the Scan Modules
 743         Scan_currentChange( Output_current_available() );
 744 }
 745
 746
 747 // Power/Current Available
 748 unsigned int Output_current_available()
 749 {
 750         unsigned int total_current = 0;
 751
 752         // Check for USB current source
 753         total_current += Output_USBCurrent_Available;
 754
 755         // Check for external current source
 756         total_current += Output_ExtCurrent_Available;
 757
 758         // XXX If the total available current is still 0
 759         // Set to 100 mA, which is generally a safe assumption at startup
 760         // before we've been able to determine actual available current
 761         if ( total_current == 0 )
 762         {
 763                 total_current = 100;
 764         }
 765
 766         return total_current;
 767 }
 768
 769
 770
 771 // ----- CLI Command Functions -----
 772
 773 void cliFunc_kbdProtocol( char* args )
 774 {
 775         print( NL );
 776         info_msg("Keyboard Protocol: ");
 777         printInt8( USBKeys_Protocol );
 778 }
 779
 780
 781 void cliFunc_outputDebug( char* args )
 782 {
 783         // Parse number from argument
 784         //  NOTE: Only first argument is used
 785         char* arg1Ptr;
 786         char* arg2Ptr;
 787         CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 788
 789         // Default to 1 if no argument is given
 790         Output_DebugMode = 1;
 791
 792         if ( arg1Ptr[0] != '\0' )
 793         {
 794                 Output_DebugMode = (uint16_t)numToInt( arg1Ptr );
 795         }
 796 }
 797
 798
 799 void cliFunc_readLEDs( char* args )
 800 {
 801         print( NL );
 802         info_msg("LED State: ");
 803         printInt8( USBKeys_LEDs );
 804 }
 805
 806
 807 void cliFunc_sendKeys( char* args )
 808 {
 809         // Copy USBKeys_KeysCLI to USBKeys_Keys
 810         for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
 811         {
 812                 // TODO
 813                 //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
 814         }
 815         USBKeys_Sent = USBKeys_SentCLI;
 816
 817         // Set modifier byte
 818         USBKeys_Modifiers = USBKeys_ModifiersCLI;
 819 }
 820
 821
 822 void cliFunc_setKeys( char* args )
 823 {
 824         char* curArgs;
 825         char* arg1Ptr;
 826         char* arg2Ptr = args;
 827
 828         // Parse up to USBKeys_MaxSize args (whichever is least)
 829         for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
 830         {
 831                 curArgs = arg2Ptr;
 832                 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
 833
 834                 // Stop processing args if no more are found
 835                 if ( *arg1Ptr == '\0' )
 836                         break;
 837
 838                 // Add the USB code to be sent
 839                 // TODO
 840                 //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
 841         }
 842 }
 843
 844
 845 void cliFunc_setMod( char* args )
 846 {
 847         // Parse number from argument
 848         //  NOTE: Only first argument is used
 849         char* arg1Ptr;
 850         char* arg2Ptr;
 851         CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 852
 853         USBKeys_ModifiersCLI = numToInt( arg1Ptr );
 854 }
 855