Output/usbMuxUart/output_com.c

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