]> git.donarmstrong.com Git - kiibohd-controller.git/blobdiff - Output/uartOut/output_com.c
Fixing default ErgoDox layout and adding FlashMode button
[kiibohd-controller.git] / Output / uartOut / output_com.c
index 2f1762f6f42b151967605a36d7deab1c1dd727a9..a45193bc818e436abf5467796df9a3699501fe3d 100644 (file)
@@ -1,4 +1,4 @@
-/* Copyright (C) 2014 by Jacob Alexander
+/* Copyright (C) 2014-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
 
 // Project Includes
 #include <cli.h>
+#include <led.h>
 #include <print.h>
 #include <scan_loop.h>
 
 // USB Includes
 #if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_)
-#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_)
+#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_)
 #include "arm/uart_serial.h"
 #endif
 
@@ -49,16 +50,22 @@ void cliFunc_setKeys    ( char* args );
 void cliFunc_setMod     ( char* args );
 
 
+
 // ----- Variables -----
 
 // Output Module command dictionary
-char*       outputCLIDictName = "USB Module Commands - NOT WORKING";
-CLIDictItem outputCLIDict[] = {
-       { "kbdProtocol", "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO Mode", cliFunc_kbdProtocol },
-       { "readLEDs",    "Read LED byte:" NL "\t\t1 NumLck, 2 CapsLck, 4 ScrlLck, 16 Kana, etc.", 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 },
-       { "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 },
+CLIDict_Entry( kbdProtocol, "Keyboard Protocol Mode: 0 - Boot, 1 - OS/NKRO 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." );
+CLIDict_Entry( setMod,      "Set the modfier byte:" NL "\t\t1 LCtrl, 2 LShft, 4 LAlt, 8 LGUI, 16 RCtrl, 32 RShft, 64 RAlt, 128 RGUI" );
+
+CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
+       CLIDict_Item( kbdProtocol ),
+       CLIDict_Item( readLEDs ),
+       CLIDict_Item( sendKeys ),
+       CLIDict_Item( setKeys ),
+       CLIDict_Item( setMod ),
        { 0, 0, 0 } // Null entry for dictionary end
 };
 
@@ -66,31 +73,75 @@ CLIDictItem outputCLIDict[] = {
 // 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_Array   [USB_MAX_KEY_SEND];
-         uint8_t USBKeys_ArrayCLI[USB_MAX_KEY_SEND]; // 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;
 
 // 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;
+volatile uint8_t  USBKeys_LEDs = 0;
 
 // Protocol setting from the host.
-// 0 - Boot Mode (Default, until set by the host)
-// 1 - NKRO Mode
-volatile uint8_t USBKeys_Protocol = 1;
+// 0 - Boot Mode
+// 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
+volatile uint8_t  USBKeys_Protocol = 0;
+
+// Indicate if USB should send update
+// OS only needs update if there has been a change in state
+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)
+       uint8_t  Output_Available = 0;
+
+
+
+// ----- Capabilities -----
+
+// Adds a single USB Code to the USB Output buffer
+// Argument #1: USB Code
+void Output_usbCodeSend_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+       // Display capability name
+       if ( stateType == 0xFF && state == 0xFF )
+       {
+               print("Output_usbCodeSend(usbCode)");
+               print("Not used in uartOut...");
+               return;
+       }
+}
+
+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 -----
@@ -147,7 +198,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
@@ -161,7 +212,10 @@ inline int Output_putstr( char* str )
 // Soft Chip Reset
 inline void Output_softReset()
 {
-       usb_device_software_reset();
+#if defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
+#elif defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
+       SOFTWARE_RESET();
+#endif
 }
 
 
@@ -178,17 +232,18 @@ void cliFunc_kbdProtocol( char* args )
 void cliFunc_readLEDs( char* args )
 {
        print( NL );
-       info_msg("LED State (This doesn't work yet...): ");
+       info_msg("LED State: ");
        printInt8( USBKeys_LEDs );
 }
 
 
 void cliFunc_sendKeys( char* args )
 {
-       // Copy USBKeys_ArrayCLI to USBKeys_Array
+       // Copy USBKeys_KeysCLI to USBKeys_Keys
        for ( uint8_t key = 0; key < USBKeys_SentCLI; ++key )
        {
-               USBKeys_Array[key] = USBKeys_ArrayCLI[key];
+               // TODO
+               //USBKeys_Keys[key] = USBKeys_KeysCLI[key];
        }
        USBKeys_Sent = USBKeys_SentCLI;
 
@@ -204,7 +259,7 @@ void cliFunc_setKeys( char* args )
        char* arg2Ptr = args;
 
        // Parse up to USBKeys_MaxSize args (whichever is least)
-       for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USBKeys_MaxSize; ++USBKeys_SentCLI )
+       for ( USBKeys_SentCLI = 0; USBKeys_SentCLI < USB_BOOT_MAX_KEYS; ++USBKeys_SentCLI )
        {
                curArgs = arg2Ptr;
                CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
@@ -214,7 +269,8 @@ void cliFunc_setKeys( char* args )
                        break;
 
                // Add the USB code to be sent
-               USBKeys_ArrayCLI[USBKeys_SentCLI] = decToInt( arg1Ptr );
+               // TODO
+               //USBKeys_KeysCLI[USBKeys_SentCLI] = numToInt( arg1Ptr );
        }
 }
 
@@ -227,6 +283,6 @@ void cliFunc_setMod( char* args )
        char* arg2Ptr;
        CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
 
-       USBKeys_ModifiersCLI = decToInt( arg1Ptr );
+       USBKeys_ModifiersCLI = numToInt( arg1Ptr );
 }