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