]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Output/pjrcUSB/output_com.c
Major code cleanup and preparation for PartialMap Macro Module
[kiibohd-controller.git] / Output / pjrcUSB / output_com.c
index 78c797e93558a8e5a03e4fb446bfc026a11fe7fa..58999b3c30efd345c66c74d35850a1d627a88141 100644 (file)
@@ -1,15 +1,15 @@
-/* Copyright (C) 2011-2013 by Jacob Alexander
- * 
+/* Copyright (C) 2011-2014 by Jacob Alexander
+ *
  * Permission is hereby granted, free of charge, to any person obtaining a copy
  * of this software and associated documentation files (the "Software"), to deal
  * in the Software without restriction, including without limitation the rights
  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  * copies of the Software, and to permit persons to whom the Software is
  * furnished to do so, subject to the following conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be included in
  * all copies or substantial portions of the Software.
- * 
+ *
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 #include <Lib/OutputLib.h>
 
 // Project Includes
+#include <cli.h>
+#include <print.h>
 #include <scan_loop.h>
 
 // USB Includes
 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
-#include "avr/usb_keyboard_debug.h"
-#elif defined(_mk20dx128_)
+#include "avr/usb_keyboard_serial.h"
+#elif defined(_mk20dx128_) || defined(_mk20dx256_)
 #include "arm/usb_keyboard.h"
 #include "arm/usb_dev.h"
 #endif
 
 
 
+// ----- Function Declarations -----
+
+void cliFunc_readLEDs  ( char* args );
+void cliFunc_sendKeys  ( char* args );
+void cliFunc_setKeys   ( char* args );
+void cliFunc_setLEDs   ( char* args );
+void cliFunc_setMod    ( char* args );
+
+
 // ----- Variables -----
 
-// which modifier keys are currently pressed
+// Output Module command dictionary
+char*       outputCLIDictName = "USB Module Commands";
+CLIDictItem outputCLIDict[] = {
+       { "readLEDs", "Read LED byte. See \033[35msetLEDs\033[0m.", cliFunc_readLEDs },
+       { "sendKeys", "Send the prepared list of USB codes and modifier byte.", cliFunc_sendKeys },
+       { "setKeys",  "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m.", cliFunc_setKeys },
+       { "setLEDs",  "Set LED byte: 1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", cliFunc_setLEDs },
+       { "setMod",   "Set the modfier byte: 1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI", cliFunc_setMod },
+       { 0, 0, 0 } // Null entry for dictionary end
+};
+
+
+// Which modifier keys are currently pressed
 // 1=left ctrl,    2=left shift,   4=left alt,    8=left gui
 // 16=right ctrl, 32=right shift, 64=right alt, 128=right gui
-         uint8_t USBKeys_Modifiers = 0;
+         uint8_t USBKeys_Modifiers    = 0;
+         uint8_t USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
 
-// which keys are currently pressed, up to 6 keys may be down at once
-         uint8_t USBKeys_Array[USB_MAX_KEY_SEND] = {0,0,0,0,0,0};
+// Currently pressed keys, max is defined by USB_MAX_KEY_SEND
+         uint8_t USBKeys_Array   [USB_MAX_KEY_SEND];
+         uint8_t USBKeys_ArrayCLI[USB_MAX_KEY_SEND]; // Separate CLI send buffer
 
 // The number of keys sent to the usb in the array
-         uint8_t USBKeys_Sent;
+         uint8_t USBKeys_Sent    = 0;
+         uint8_t USBKeys_SentCLI = 0;
 
 // 1=num lock, 2=caps lock, 4=scroll lock, 8=compose, 16=kana
 volatile uint8_t USBKeys_LEDs = 0;
@@ -69,11 +95,10 @@ volatile uint8_t USBKeys_LEDs = 0;
          uint8_t USBKeys_Idle_Count = 0;
 
 
-
 // ----- Functions -----
 
 // USB Module Setup
-inline void output_setup()
+inline void Output_setup()
 {
        // Initialize the USB, and then wait for the host to set configuration.
        // If the Teensy is powered without a PC connected to the USB port,
@@ -81,14 +106,17 @@ inline void output_setup()
        usb_init();
        while ( !usb_configured() ) /* wait */ ;
 
+       // Register USB Output CLI dictionary
+       CLI_registerDictionary( outputCLIDict, outputCLIDictName );
+
        // Wait an extra second for the PC's operating system to load drivers
        // and do whatever it does to actually be ready for input
-       //_delay_ms(1000); // TODO
+       //_delay_ms(1000); // TODO (is this actually necessary?)
 }
 
 
 // USB Data Send
-inline void usb_send(void)
+inline void Output_send(void)
 {
                // TODO undo potentially old keys
                for ( uint8_t c = USBKeys_Sent; c < USBKeys_MaxSize; c++ )
@@ -102,16 +130,140 @@ inline void usb_send(void)
                USBKeys_Sent      = 0;
 
                // Signal Scan Module we are finishedA
-               scan_finishedWithUSBBuffer( USBKeys_Sent <= USBKeys_MaxSize ? USBKeys_Sent : USBKeys_MaxSize );
+               Scan_finishedWithUSBBuffer( USBKeys_Sent <= USBKeys_MaxSize ? USBKeys_Sent : USBKeys_MaxSize );
 }
 
 
 // Sets the device into firmware reload mode
-inline void output_firmwareReload()
+inline void Output_firmwareReload()
 {
 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
-#elif defined(_mk20dx128_)
+       usb_debug_reload();
+#elif defined(_mk20dx128_) || defined(_mk20dx256_)
        usb_device_reload();
 #endif
 }
 
+
+// USB Input buffer available
+inline unsigned int Output_availablechar()
+{
+       return usb_serial_available();
+}
+
+
+// USB Get Character from input buffer
+inline int Output_getchar()
+{
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
+       // XXX Make sure to check output_availablechar() first! Information is lost with the cast (error codes)
+       return (int)usb_serial_getchar();
+#elif defined(_mk20dx128_) || defined(_mk20dx256_)
+       return usb_serial_getchar();
+#endif
+}
+
+
+// USB Send Character to output buffer
+inline int Output_putchar( char c )
+{
+       return usb_serial_putchar( c );
+}
+
+
+// USB Send String to output buffer, null terminated
+inline int Output_putstr( char* str )
+{
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
+       uint16_t count = 0;
+#elif defined(_mk20dx128_) || defined(_mk20dx256_) // ARM
+       uint32_t count = 0;
+#endif
+       // Count characters until NULL character, then send the amount counted
+       while ( str[count] != '\0' )
+               count++;
+
+       return usb_serial_write( str, count );
+}
+
+
+// Soft Chip Reset
+inline void Output_softReset()
+{
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
+       usb_debug_software_reset();
+#elif defined(_mk20dx128_) || defined(_mk20dx256_)
+       SOFTWARE_RESET();
+#endif
+}
+
+
+// ----- CLI Command Functions -----
+
+void cliFunc_readLEDs( char* args )
+{
+       print( NL );
+       info_msg("LED State: ");
+       printInt8( USBKeys_LEDs );
+}
+
+
+void cliFunc_sendKeys( char* args )
+{
+       // Copy USBKeys_ArrayCLI to USBKeys_Array
+       for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
+       {
+               USBKeys_Array[key] = USBKeys_ArrayCLI[key];
+       }
+       USBKeys_Sent = USBKeys_SentCLI;
+
+       // Set modifier byte
+       USBKeys_Modifiers = USBKeys_ModifiersCLI;
+}
+
+
+void cliFunc_setKeys( char* args )
+{
+       char* curArgs;
+       char* arg1Ptr;
+       char* arg2Ptr = args;
+
+       // Parse up to USBKeys_MaxSize args (whichever is least)
+       for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USBKeys_MaxSize; ++USBKeys_SentCLI )
+       {
+               curArgs = arg2Ptr;
+               CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+
+               // Stop processing args if no more are found
+               if ( *arg1Ptr == '\0' )
+                       break;
+
+               // Add the USB code to be sent
+               USBKeys_ArrayCLI[USBKeys_SentCLI] = decToInt( arg1Ptr );
+       }
+}
+
+
+void cliFunc_setLEDs( char* args )
+{
+       // Parse number from argument
+       //  NOTE: Only first argument is used
+       char* arg1Ptr;
+       char* arg2Ptr;
+       CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+
+       USBKeys_LEDs = decToInt( arg1Ptr );
+}
+
+
+void cliFunc_setMod( char* args )
+{
+       // Parse number from argument
+       //  NOTE: Only first argument is used
+       char* arg1Ptr;
+       char* arg2Ptr;
+       CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+
+       USBKeys_ModifiersCLI = decToInt( arg1Ptr );
+}
+