-/* Copyright (C) 2011-2015 by Jacob Alexander
+/* Copyright (C) 2011-2016 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
#include "arm/usb_dev.h"
#include "arm/usb_keyboard.h"
#include "arm/usb_serial.h"
+#include "arm/usb_mouse.h"
#endif
+// KLL
+#include <kll_defs.h>
+
// Local Includes
#include "output_com.h"
// ----- Macros -----
// Used to build a bitmap lookup table from a byte addressable array
-#define byteLookup( byte ) case (( byte ) * ( 8 )): bytePosition = byte; byteShift = 0; break; \
- case (( byte ) * ( 8 ) + ( 1 )): bytePosition = byte; byteShift = 1; break; \
- case (( byte ) * ( 8 ) + ( 2 )): bytePosition = byte; byteShift = 2; break; \
- case (( byte ) * ( 8 ) + ( 3 )): bytePosition = byte; byteShift = 3; break; \
- case (( byte ) * ( 8 ) + ( 4 )): bytePosition = byte; byteShift = 4; break; \
- case (( byte ) * ( 8 ) + ( 5 )): bytePosition = byte; byteShift = 5; break; \
- case (( byte ) * ( 8 ) + ( 6 )): bytePosition = byte; byteShift = 6; break; \
- case (( byte ) * ( 8 ) + ( 7 )): bytePosition = byte; byteShift = 7; break
+#define byteLookup( byte ) \
+ case (( byte ) * ( 8 )): bytePosition = byte; byteShift = 0; break; \
+ case (( byte ) * ( 8 ) + ( 1 )): bytePosition = byte; byteShift = 1; break; \
+ case (( byte ) * ( 8 ) + ( 2 )): bytePosition = byte; byteShift = 2; break; \
+ case (( byte ) * ( 8 ) + ( 3 )): bytePosition = byte; byteShift = 3; break; \
+ case (( byte ) * ( 8 ) + ( 4 )): bytePosition = byte; byteShift = 4; break; \
+ case (( byte ) * ( 8 ) + ( 5 )): bytePosition = byte; byteShift = 5; break; \
+ case (( byte ) * ( 8 ) + ( 6 )): bytePosition = byte; byteShift = 6; break; \
+ case (( byte ) * ( 8 ) + ( 7 )): bytePosition = byte; byteShift = 7; break
// ----- 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 );
// 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." );
CLIDict_Def( outputCLIDict, "USB Module Commands" ) = {
CLIDict_Item( kbdProtocol ),
+ CLIDict_Item( outputDebug ),
CLIDict_Item( readLEDs ),
CLIDict_Item( sendKeys ),
CLIDict_Item( setKeys ),
// 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;
+// Currently pressed mouse buttons, bitmask, 0 represents no buttons pressed
+volatile uint16_t USBMouse_Buttons = 0;
+
// Protocol setting from the host.
// 0 - Boot Mode
// 1 - NKRO Mode (Default, unless set by a BIOS or boot interface)
-volatile uint8_t USBKeys_Protocol = 1;
+volatile uint8_t USBKeys_Protocol = USBProtocol_define;
// Indicate if USB should send update
// OS only needs update if there has been a change in state
USBKeyChangeState USBKeys_Changed = USBKeyChangeState_None;
+// Indicate if USB should send update
+uint8_t USBMouse_Changed = 0;
+
// 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;
+volatile uint8_t Output_Available = 0;
+
+// Debug control variable for Output modules
+// 0 - Debug disabled (default)
+// 1 - Debug enabled
+uint8_t Output_DebugMode = 0;
+
+// mA - Set by outside module if not using USB (i.e. Interconnect)
+// Generally set to 100 mA (low power) or 500 mA (high power)
+uint16_t Output_ExtCurrent_Available = 0;
+
+// mA - Set by USB module (if exists)
+// Initially 100 mA, but may be negotiated higher (e.g. 500 mA)
+uint16_t Output_USBCurrent_Available = 0;
// 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 )
{
// 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];
}
}
+void Output_flashMode_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+ // Display capability name
+ if ( stateType == 0xFF && state == 0xFF )
+ {
+ print("Output_flashMode()");
+ return;
+ }
+
+ // Start flash mode
+ Output_firmwareReload();
+}
+
+// Sends a mouse command over the USB Output buffer
+// XXX This function *will* be changing in the future
+// If you use it, be prepared that your .kll files will break in the future (post KLL 0.5)
+// Argument #1: USB Mouse Button #
+void Output_usbMouse_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+ // Display capability name
+ if ( stateType == 0xFF && state == 0xFF )
+ {
+ print("Output_usbMouse(mouseButton)");
+ return;
+ }
+
+ // Determine which mouse button was sent
+ // The USB spec defines up to a max of 0xFFFF buttons
+ // The usual are:
+ // 1 - Button 1 - (Primary)
+ // 2 - Button 2 - (Secondary)
+ // 3 - Button 3 - (Tertiary)
+ uint16_t mouse_button = *(uint16_t*)(&args[0]);
+
+ // If set to zero, ignore
+ if ( mouse_button == 0 )
+ return;
+
+ // Adjust for bit shift
+ mouse_button -= 1;
+
+ // Only send mouse button if in press or hold state
+ if ( stateType == 0x00 && state == 0x03 ) // Release state
+ {
+ USBMouse_Buttons &= ~(1 << mouse_button);
+ }
+ else
+ {
+ USBMouse_Buttons |= (1 << mouse_button);
+ }
+
+ // TODO Add more states when adding full support
+ USBMouse_Changed = 1;
+}
+
// ----- Functions -----
// 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
- // If no USB cable is attached, does not try and initialize USB
- if ( usb_init() )
- {
- while ( !usb_configured() );
- }
+ // 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();
// Register USB Output CLI dictionary
CLI_registerDictionary( outputCLIDict, outputCLIDictName );
// USB Data Send
inline void Output_send()
{
+ // USB status checks
+ // Non-standard USB state manipulation, usually does nothing
+ usb_device_check();
+
// Boot Mode Only, unset stale keys
if ( USBKeys_Protocol == 0 )
for ( uint8_t c = USBKeys_Sent; c < USB_BOOT_MAX_KEYS; c++ )
USBKeys_Keys[c] = 0;
+ // Process mouse actions
+ while ( USBMouse_Changed )
+ usb_mouse_send();
+
// Send keypresses while there are pending changes
while ( USBKeys_Changed )
usb_keyboard_send();
}
+// Update USB current (mA)
+// Triggers power change event
+void Output_update_usb_current( unsigned int current )
+{
+ // Only signal if changed
+ if ( current == Output_USBCurrent_Available )
+ return;
+
+ // Update USB current
+ Output_USBCurrent_Available = current;
+
+ unsigned int total_current = Output_current_available();
+ info_msg("USB Available Current Changed. Total Available: ");
+ printInt32( total_current );
+ print(" mA" NL);
+
+ // Send new total current to the Scan Modules
+ Scan_currentChange( Output_current_available() );
+}
+
+
+// Update external current (mA)
+// Triggers power change event
+void Output_update_external_current( unsigned int current )
+{
+ // Only signal if changed
+ if ( current == Output_ExtCurrent_Available )
+ return;
+
+ // Update external current
+ Output_ExtCurrent_Available = current;
+
+ unsigned int total_current = Output_current_available();
+ info_msg("External Available Current Changed. Total Available: ");
+ printInt32( total_current );
+ print(" mA" NL);
+
+ // Send new total current to the Scan Modules
+ Scan_currentChange( Output_current_available() );
+}
+
+
+// Power/Current Available
+unsigned int Output_current_available()
+{
+ unsigned int total_current = 0;
+
+ // Check for USB current source
+ total_current += Output_USBCurrent_Available;
+
+ // Check for external current source
+ total_current += Output_ExtCurrent_Available;
+
+ // XXX If the total available current is still 0
+ // Set to 100 mA, which is generally a safe assumption at startup
+ // before we've been able to determine actual available current
+ if ( total_current == 0 )
+ {
+ total_current = 100;
+ }
+
+ return total_current;
+}
+
+
+
// ----- CLI Command Functions -----
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 );
projects / kiibohd-controller.git / blobdiff