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