]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Output/pjrcUSB/output_com.c
Fixing default ErgoDox layout and adding FlashMode button
[kiibohd-controller.git] / Output / pjrcUSB / output_com.c
index aa5f5b0249468997e775e5d53d168b05f31cfe3f..d594ac1c32ec0e1be1fbfad1377913949feec143 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 2011-2014 by Jacob Alexander
+/* Copyright (C) 2011-2015 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
@@ -33,7 +33,7 @@
 // USB Includes
 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
 #include "avr/usb_keyboard_serial.h"
-#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
+#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
 #include "arm/usb_dev.h"
 #include "arm/usb_keyboard.h"
 #include "arm/usb_serial.h"
@@ -61,6 +61,7 @@
 // ----- Function Declarations -----
 
 void cliFunc_kbdProtocol( char* args );
+void cliFunc_outputDebug( char* args );
 void cliFunc_readLEDs   ( char* args );
 void cliFunc_sendKeys   ( char* args );
 void cliFunc_setKeys    ( char* args );
@@ -72,6 +73,7 @@ void cliFunc_setMod     ( char* args );
 
 // Output Module command dictionary
 CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode" );
+CLIDict_Entry( outputDebug, "Toggle Output Debug mode." );
 CLIDict_Entry( readLEDs,    "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc." );
 CLIDict_Entry( sendKeys,    "Send the prepared list of USB codes and modifier byte." );
 CLIDict_Entry( setKeys,     "Prepare a space separated list of USB codes (decimal). Waits until \033[35msendKeys\033[0m." );
@@ -79,6 +81,7 @@ CLIDict_Entry( setMod,      "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4
 
 CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
        CLIDict_Item( kbdProtocol ),
+       CLIDict_Item( outputDebug ),
        CLIDict_Item( readLEDs ),
        CLIDict_Item( sendKeys ),
        CLIDict_Item( setKeys ),
@@ -90,20 +93,20 @@ CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
 // 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_ModifiersCLI = 0; // Separate CLI send buffer
+uint8_t  USBKeys_Modifiers    = 0;
+uint8_t  USBKeys_ModifiersCLI = 0; // Separate CLI send buffer
 
 // Currently pressed keys, max is defined by USB_MAX_KEY_SEND
-         uint8_t  USBKeys_Keys   [USB_NKRO_BITFIELD_SIZE_KEYS];
-         uint8_t  USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
+uint8_t  USBKeys_Keys   [USB_NKRO_BITFIELD_SIZE_KEYS];
+uint8_t  USBKeys_KeysCLI[USB_NKRO_BITFIELD_SIZE_KEYS]; // Separate CLI send buffer
 
 // System Control and Consumer Control 1KRO containers
-         uint8_t  USBKeys_SysCtrl;
-         uint16_t USBKeys_ConsCtrl;
+uint8_t  USBKeys_SysCtrl;
+uint16_t USBKeys_ConsCtrl;
 
 // The number of keys sent to the usb in the array
-         uint8_t  USBKeys_Sent    = 0;
-         uint8_t  USBKeys_SentCLI = 0;
+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;
@@ -119,10 +122,20 @@ USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
 
 // the idle configuration, how often we send the report to the
 // host (ms * 4) even when it hasn't changed
-         uint8_t  USBKeys_Idle_Config = 125;
+uint8_t  USBKeys_Idle_Config = 125;
 
 // count until idle timeout
-         uint8_t  USBKeys_Idle_Count = 0;
+uint8_t  USBKeys_Idle_Count = 0;
+
+// Indicates whether the Output module is fully functional
+// 0 - Not fully functional, 1 - Fully functional
+// 0 is often used to show that a USB cable is not plugged in (but has power)
+volatile uint8_t  Output_Available = 0;
+
+// Debug control variable for Output modules
+// 0 - Debug disabled (default)
+// 1 - Debug enabled
+uint8_t  Output_DebugMode = 0;
 
 
 
@@ -206,13 +219,31 @@ void Output_consCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *
 
        // Only send keypresses if press or hold state
        if ( stateType == 0x00 && state == 0x03 ) // Release state
+       {
+               USBKeys_ConsCtrl = 0;
                return;
+       }
 
        // Set consumer control code
        USBKeys_ConsCtrl = *(uint16_t*)(&args[0]);
 }
 
 
+// Ignores the given key status update
+// Used to prevent fall-through, this is the None keyword in KLL
+void Output_noneSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Output_noneSend()");
+               return;
+       }
+
+       // Nothing to do, because that's the point :P
+}
+
+
 // Sends a System Control code to the USB Output buffer
 void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
 {
@@ -237,7 +268,10 @@ void Output_sysCtrlSend_capability( uint8_t state, uint8_t stateType, uint8_t *a
 
        // Only send keypresses if press or hold state
        if ( stateType == 0x00 && state == 0x03 ) // Release state
+       {
+               USBKeys_SysCtrl = 0;
                return;
+       }
 
        // Set system control code
        USBKeys_SysCtrl = args[0];
@@ -419,7 +453,7 @@ void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *a
                // It is used to send "nothing" in order to break up sequences of USB Codes
                else if ( key == 0x00 )
                {
-                       USBKeys_Changed |= USBKeyChangeState_All;
+                       USBKeys_Changed |= USBKeyChangeState_MainKeys;
 
                        // Also flush out buffers just in case
                        Output_flushBuffers();
@@ -450,6 +484,19 @@ void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *a
        }
 }
 
+void Output_flashMode_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Output_flashMode(usbCode)");
+               return;
+       }
+
+       // Start flash mode
+       Output_firmwareReload();
+}
+
 
 
 // ----- Functions -----
@@ -471,12 +518,12 @@ void Output_flushBuffers()
 // USB Module Setup
 inline void Output_setup()
 {
-       // Initialize the USB, and then wait for the host to set configuration.
-       // This will hang forever if USB does not initialize
+       // Initialize the USB
+       // If a USB connection does not exist, just ignore it
+       // All usb related functions will non-fatally fail if called
+       // If the USB initialization is delayed, then functionality will just be delayed
        usb_init();
 
-       while ( !usb_configured() );
-
        // Register USB Output CLI dictionary
        CLI_registerDictionary( outputCLIDict, outputCLIDictName );
 
@@ -497,14 +544,15 @@ inline void Output_send()
        while ( USBKeys_Changed )
                usb_keyboard_send();
 
-       // Clear modifiers and keys
-       USBKeys_Modifiers = 0;
-       USBKeys_Sent      = 0;
+       // Clear keys sent
+       USBKeys_Sent = 0;
 
        // Signal Scan Module we are finished
        switch ( USBKeys_Protocol )
        {
        case 0: // Boot Mode
+               // Clear modifiers only in boot mode
+               USBKeys_Modifiers = 0;
                Scan_finishedWithOutput( USBKeys_Sent <= USB_BOOT_MAX_KEYS ? USBKeys_Sent : USB_BOOT_MAX_KEYS );
                break;
        case 1: // NKRO Mode
@@ -548,7 +596,7 @@ inline int Output_putstr( char* str )
 {
 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
        uint16_t count = 0;
-#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
+#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
        uint32_t count = 0;
 #endif
        // Count characters until NULL character, then send the amount counted
@@ -576,6 +624,24 @@ void cliFunc_kbdProtocol( char* args )
 }
 
 
+void cliFunc_outputDebug( char* args )
+{
+       // Parse number from argument
+       //  NOTE: Only first argument is used
+       char* arg1Ptr;
+       char* arg2Ptr;
+       CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+
+       // Default to 1 if no argument is given
+       Output_DebugMode = 1;
+
+       if ( arg1Ptr[0] != '\0' )
+       {
+               Output_DebugMode = (uint16_t)numToInt( arg1Ptr );
+       }
+}
+
+
 void cliFunc_readLEDs( char* args )
 {
        print( NL );