void cliFunc_capSelect ( char* args );
void cliFunc_keyPress ( char* args );
void cliFunc_keyRelease( char* args );
-void cliFunc_layerLatch( char* args );
void cliFunc_layerList ( char* args );
-void cliFunc_layerLock ( char* args );
+void cliFunc_layerState( char* args );
void cliFunc_macroDebug( char* args );
void cliFunc_macroList ( char* args );
void cliFunc_macroProc ( char* args );
char* macroCLIDictName = "Macro Module Commands";
CLIDictItem macroCLIDict[] = {
{ "capList", "Prints an indexed list of all non USB keycode capabilities.", cliFunc_capList },
- { "capSelect", "Triggers the specified capability." NL "\t\t\033[35mU10\033[0m USB Code 0x0A, \033[35mK11\033[0m Keyboard Capability 0x0B", cliFunc_capSelect },
+ { "capSelect", "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B", cliFunc_capSelect },
{ "keyPress", "Send key-presses to the macro module. Held until released. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyPress },
{ "keyRelease", "Release a key-press from the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyRelease },
- { "layerLatch", "Latch the specified indexed layer." NL "\t\t\033[35mL15\033[0m Indexed Layer 0x0F", cliFunc_layerLatch },
{ "layerList", "List available layers.", cliFunc_layerList },
- { "layerLock", "Lock the specified indexed layer." NL "\t\t\033[35mL2\033[0m Indexed Layer 0x02", cliFunc_layerLock },
+ { "layerState", "Modify specified indexed layer state <layer> <state byte>." NL "\t\t\033[35mL2\033[0m Indexed Layer 0x02" NL "\t\t0 Off, 1 Shift, 2 Latch, 4 Lock States", cliFunc_layerState },
{ "macroDebug", "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes.", cliFunc_macroDebug },
{ "macroList", "List the defined trigger and result macros.", cliFunc_macroList },
{ "macroProc", "Pause/Resume macro processing.", cliFunc_macroProc },
- { "macroShow", "Show the macro corresponding to the given index or scan-code." NL "\t\t\033[35mT16\033[0m Indexed Trigger Macro 0x10, \033[35mR12\033[0m Indexed Result Macro 0x0C", cliFunc_macroShow },
+ { "macroShow", "Show the macro corresponding to the given index." NL "\t\t\033[35mT16\033[0m Indexed Trigger Macro 0x10, \033[35mR12\033[0m Indexed Result Macro 0x0C", cliFunc_macroShow },
{ "macroStep", "Do N macro processing steps. Defaults to 1.", cliFunc_macroStep },
{ 0, 0, 0 } // Null entry for dictionary end
};
// Key Trigger List Buffer
-// * Item 1: scan code
-// * Item 2: state
-// ...
-uint8_t macroTriggerListBuffer[MaxScanCode * 2] = { 0 }; // Each key has a state to be cached
+TriggerGuide macroTriggerListBuffer[ MaxScanCode ];
uint8_t macroTriggerListBufferSize = 0;
+// Pending Trigger Macro Index List
+// * Any trigger macros that need processing from a previous macro processing loop
// TODO, figure out a good way to scale this array size without wasting too much memory, but not rejecting macros
// Possibly could be calculated by the KLL compiler
// XXX It may be possible to calculate the worst case using the KLL compiler
-TriggerMacro *triggerMacroPendingList[TriggerMacroNum];
+unsigned int macroTriggerMacroPendingList[ TriggerMacroNum ] = { 0 };
+unsigned int macroTriggerMacroPendingListSize = 0;
+
+// Layer Index Stack
+// * When modifying layer state and the state is non-0x0, the stack must be adjusted
+unsigned int macroLayerIndexStack[ LayerNum ] = { 0 };
+unsigned int macroLayerIndexStackSize = 0;
+
+// Pending Result Macro Index List
+// * Any result macro that needs processing from a previous macro processing loop
+unsigned int macroResultMacroPendingList[ ResultMacroNum ] = { 0 };
+unsigned int macroResultMacroPendingListSize = 0;
// ----- Functions -----
// Looks up the trigger list for the given scan code (from the active layer)
+// NOTE: Calling function must handle the NULL pointer case
unsigned int *Macro_layerLookup( uint8_t scanCode )
{
- // TODO - No layer fallthrough lookup
- return default_scanMap[ scanCode ];
+ // If no trigger macro is defined at the given layer, fallthrough to the next layer
+ for ( unsigned int layer = 0; layer < macroLayerIndexStackSize; layer++ )
+ {
+ // Lookup layer
+ unsigned int **map = LayerIndex[ macroLayerIndexStack[ layer ] ].triggerMap;
+
+ // Determine if layer has key defined
+ if ( map != 0 && *map[ scanCode ] != 0 )
+ return map[ scanCode ];
+ }
+
+ // Do lookup on default layer
+ unsigned int **map = LayerIndex[0].triggerMap;
+
+ // Determine if layer has key defined
+ if ( map == 0 && *map[ scanCode ] == 0 )
+ {
+ erro_msg("Scan Code has no defined Trigger Macro: ");
+ printHex( scanCode );
+ return 0;
+ }
+
+ // Return lookup result
+ return map[ scanCode ];
}
// Update the scancode key state
// States:
-// * 0x00 - Reserved
+// * 0x00 - Off
// * 0x01 - Pressed
// * 0x02 - Held
// * 0x03 - Released
case 0x01: // Pressed
case 0x02: // Held
case 0x03: // Released
- macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = scanCode;
- macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = state;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x00; // Normal key
+ macroTriggerListBufferSize++;
break;
}
}
// Update the scancode analog state
// States:
-// * 0x00 - Reserved
+// * 0x00 - Off
// * 0x01 - Released
// * 0x02-0xFF - Analog value (low to high)
inline void Macro_analogState( uint8_t scanCode, uint8_t state )
{
- // TODO
+ // Only add to macro trigger list if non-off
+ if ( state != 0x00 )
+ {
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x02; // Analog key
+ macroTriggerListBufferSize++;
+ }
}
// Update led state
// States:
-// * 0x00 - Reserved
+// * 0x00 - Off
// * 0x01 - On
-// * 0x02 - Off
inline void Macro_ledState( uint8_t ledCode, uint8_t state )
{
- // TODO
+ // Only add to macro trigger list if non-off
+ if ( state != 0x00 )
+ {
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = ledCode;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
+ macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x01; // LED key
+ macroTriggerListBufferSize++;
+ }
}
-// Evaluate/Update the TriggerMacro
+// Evaluate/Update TriggerMacro
void Macro_evalTriggerMacro( TriggerMacro *triggerMacro )
{
// Which combo in the sequence is being evaluated
uint8_t comboLength = triggerMacro->guide[ comboPos ];
// Iterate over list of keys currently pressed
- for ( uint8_t keyPressed = 0; keyPressed < macroTriggerListBufferSize; keyPressed += 2 )
+ for ( uint8_t keyPressed = 0; keyPressed < macroTriggerListBufferSize; keyPressed++ )
{
// Compare with keys in combo
for ( unsigned int comboKey = 0; comboKey < comboLength; comboKey++ )
if ( comboLength == 1 )
{
// If key matches and only 1 key pressed, increment the TriggerMacro combo position
- if ( guideKey == macroTriggerListBuffer[ keyPressed ] && macroTriggerListBufferSize == 1 )
+ if ( guideKey == macroTriggerListBuffer[ keyPressed ].scanCode && macroTriggerListBufferSize == 1 )
{
triggerMacro->pos += comboLength * 2 + 1;
// TODO check if TriggerMacro is finished, register ResultMacro
}
-
-
-/*
-inline void Macro_bufferAdd( uint8_t byte )
+// Evaluate/Update ResultMacro
+void Macro_evalResultMacro( ResultMacro *resultMacro )
{
- // Make sure we haven't overflowed the key buffer
- // Default function for adding keys to the KeyIndex_Buffer, does a DefaultMap_Lookup
- if ( KeyIndex_BufferUsed < KEYBOARD_BUFFER )
- {
- uint8_t key = DefaultMap_Lookup[byte];
- for ( uint8_t c = 0; c < KeyIndex_BufferUsed; c++ )
- {
- // Key already in the buffer
- if ( KeyIndex_Buffer[c] == key )
- return;
- }
-
- // Add to the buffer
- KeyIndex_Buffer[KeyIndex_BufferUsed++] = key;
- }
+ // TODO
}
-inline void Macro_bufferRemove( uint8_t byte )
-{
- uint8_t key = DefaultMap_Lookup[byte];
-
- // Check for the released key, and shift the other keys lower on the buffer
- for ( uint8_t c = 0; c < KeyIndex_BufferUsed; c++ )
- {
- // Key to release found
- if ( KeyIndex_Buffer[c] == key )
- {
- // Shift keys from c position
- for ( uint8_t k = c; k < KeyIndex_BufferUsed - 1; k++ )
- KeyIndex_Buffer[k] = KeyIndex_Buffer[k + 1];
-
- // Decrement Buffer
- KeyIndex_BufferUsed--;
-
- return;
- }
- }
-
- // Error case (no key to release)
- erro_msg("Could not find key to release: ");
- printHex( key );
-}
-*/
+// Called immediately after USB has finished sending a buffer
inline void Macro_finishWithUSBBuffer( uint8_t sentKeys )
{
+ // XXX Currently not used to trigger anything (with this particular Macro module)
}
+
+// Macro Procesing Loop
+// Called once per USB buffer send
inline void Macro_process()
{
// Only do one round of macro processing between Output Module timer sends
}
// Loop through macro trigger buffer
- for ( uint8_t index = 0; index < macroTriggerListBufferSize; index += 2 )
+ for ( uint8_t index = 0; index < macroTriggerListBufferSize; index++ )
{
// Get scanCode, first item of macroTriggerListBuffer pairs
- uint8_t scanCode = macroTriggerListBuffer[ index ];
+ uint8_t scanCode = macroTriggerListBuffer[ index ].scanCode;
// Lookup trigger list for this key
unsigned int *triggerList = Macro_layerLookup( scanCode );
+ // Skip, if no trigger list
+ if ( triggerList == 0 )
+ continue;
+
// The first element is the length of the trigger list
unsigned int triggerListSize = triggerList[0];
TriggerMacro *triggerMacro = (TriggerMacro*)triggerList[ trigger + 1 ];
// Get triggered state of scan code, second item of macroTriggerListBuffer pairs
- uint8_t state = macroTriggerListBuffer[ index + 1 ];
+ uint8_t state = macroTriggerListBuffer[ index ].state;
// Evaluate Macro
Macro_evalTriggerMacro( triggerMacro );
}
}
+
inline void Macro_setup()
{
// Register Macro CLI dictionary
void cliFunc_capList( char* args )
{
- // TODO
+ print( NL );
+ info_msg("Capabilities List");
+
+ // Iterate through all of the capabilities and display them
+ for ( unsigned int cap = 0; cap < CapabilitiesNum; cap++ )
+ {
+ print( NL "\t" );
+ printHex( cap );
+ print(" - ");
+
+ // Display/Lookup Capability Name (utilize debug mode of capability)
+ void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
+ capability( 0xFF, 0xFF, 0 );
+ }
}
void cliFunc_capSelect( char* args )
{
// Parse code from argument
- // NOTE: Only first argument is used
+ char* curArgs;
char* arg1Ptr;
- char* arg2Ptr;
- CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+ char* arg2Ptr = args;
+
+ // Total number of args to scan (must do a lookup if a keyboard capability is selected)
+ unsigned int totalArgs = 2; // Always at least two args
+ unsigned int cap = 0;
- // Depending on the first character, the lookup changes
- switch ( arg1Ptr[0] )
+ // Arguments used for keyboard capability function
+ unsigned int argSetCount = 0;
+ uint8_t *argSet = (uint8_t*)args;
+
+ // Process all args
+ for ( unsigned int c = 0; argSetCount < totalArgs; c++ )
{
- // Keyboard Capability
- case 'K':
- // TODO
- break;
+ curArgs = arg2Ptr;
+ CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
- // USB Code
- case 'U':
- // Just add the key to the USB Buffer
- if ( KeyIndex_BufferUsed < KEYBOARD_BUFFER )
+ // Stop processing args if no more are found
+ // Extra arguments are ignored
+ if ( *arg1Ptr == '\0' )
+ break;
+
+ // For the first argument, choose the capability
+ if ( c == 0 ) switch ( arg1Ptr[0] )
{
- KeyIndex_Buffer[KeyIndex_BufferUsed++] = decToInt( &arg1Ptr[1] );
+ // Keyboard Capability
+ case 'K':
+ // Determine capability index
+ cap = decToInt( &arg1Ptr[1] );
+
+ // Lookup the number of args
+ totalArgs += CapabilitiesList[ cap ].argCount;
+ continue;
+ }
+
+ // Because allocating memory isn't doable, and the argument count is arbitrary
+ // The argument pointer is repurposed as the argument list (much smaller anyways)
+ argSet[ argSetCount++ ] = (uint8_t)decToInt( arg1Ptr );
+
+ // Once all the arguments are prepared, call the keyboard capability function
+ if ( argSetCount == totalArgs )
+ {
+ // Indicate that the capability was called
+ print( NL );
+ info_msg("K");
+ printInt8( cap );
+ print(" - ");
+ printHex( argSet[0] );
+ print(" - ");
+ printHex( argSet[1] );
+ print(" - ");
+ printHex( argSet[2] );
+ print( "..." NL );
+
+ void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
+ capability( argSet[0], argSet[1], &argSet[2] );
}
- break;
}
}
}
}
-void cliFunc_layerLatch( char* args )
-{
- // TODO
-}
-
void cliFunc_layerList( char* args )
{
- // TODO
+ print( NL );
+ info_msg("Layer List");
+
+ // Iterate through all of the layers and display them
+ for ( unsigned int layer = 0; layer < LayerNum; layer++ )
+ {
+ print( NL "\t" );
+ printHex( layer );
+ print(" - ");
+
+ // Display layer name
+ dPrint( LayerIndex[ layer ].name );
+
+ // Default map
+ if ( layer == 0 )
+ print(" \033[1m(default)\033[0m");
+
+ // Layer State
+ print( NL "\t\t Layer State: " );
+ printHex( LayerIndex[ layer ].state );
+
+ // Max Index
+ print(" Max Index: ");
+ printHex( LayerIndex[ layer ].max );
+ }
}
-void cliFunc_layerLock( char* args )
+void cliFunc_layerState( char* args )
{
- // TODO
+ // Parse codes from arguments
+ char* curArgs;
+ char* arg1Ptr;
+ char* arg2Ptr = args;
+
+ uint8_t arg1 = 0;
+ uint8_t arg2 = 0;
+
+ // Process first two args
+ for ( uint8_t c = 0; c < 2; c++ )
+ {
+ curArgs = arg2Ptr;
+ CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+
+ // Stop processing args if no more are found
+ if ( *arg1Ptr == '\0' )
+ break;
+
+ switch ( c )
+ {
+ // First argument (e.g. L1)
+ case 0:
+ if ( arg1Ptr[0] != 'L' )
+ return;
+
+ arg1 = (uint8_t)decToInt( &arg1Ptr[1] );
+ break;
+ // Second argument (e.g. 4)
+ case 1:
+ arg2 = (uint8_t)decToInt( arg1Ptr );
+
+ // Display operation (to indicate that it worked)
+ print( NL );
+ info_msg("Setting Layer L");
+ printInt8( arg1 );
+ print(" to - ");
+ printHex( arg2 );
+
+ // Set the layer state
+ LayerIndex[ arg1 ].state = arg2;
+ break;
+ }
+ }
}
void cliFunc_macroDebug( char* args )
void cliFunc_macroList( char* args )
{
- // TODO
+ // Show available trigger macro indices
+ print( NL );
+ info_msg("Trigger Macros Range: T0 -> T");
+ printInt16( (uint16_t)TriggerMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
+
+ // Show available result macro indices
+ print( NL );
+ info_msg("Result Macros Range: R0 -> R");
+ printInt16( (uint16_t)ResultMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
+
+ // Show Trigger to Result Macro Links
+ print( NL );
+ info_msg("Trigger : Result Macro Pairs");
+ for ( unsigned int macro = 0; macro < TriggerMacroNum; macro++ )
+ {
+ print( NL );
+ print("\tT");
+ printInt16( (uint16_t)macro ); // Hopefully large enough :P (can't assume 32-bit)
+ print(" : R");
+ printInt16( (uint16_t)TriggerMacroList[ macro ].result ); // Hopefully large enough :P (can't assume 32-bit)
+ }
}
void cliFunc_macroProc( char* args )
TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ pos ]);
// Display guide information about trigger key
- printHex( guide->scancode );
+ printHex( guide->scanCode );
print("|");
printHex( guide->type );
print("|");
// Assign TriggerGuide element (key type, state and scancode)
ResultGuide *guide = (ResultGuide*)(¯o->guide[ pos ]);
+ // Display Function Index
+ printHex( guide->index );
+ print("|");
+
// Display Function Ptr Address
- printHex( (unsigned int)guide->function );
+ printHex( (unsigned int)CapabilitiesList[ guide->index ].func );
print("|");
// Display/Lookup Capability Name (utilize debug mode of capability)
- void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(guide->function);
+ void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
capability( 0xFF, 0xFF, 0 );
// Display Argument(s)
print("(");
- for ( unsigned int arg = 0; arg < guide->argCount; arg++ )
+ for ( unsigned int arg = 0; arg < CapabilitiesList[ guide->index ].argCount; arg++ )
{
- // Arguments are only 8 bit values (guides are 32 bit for function pointers)
- printHex( (uint8_t)(unsigned int)(&guide->args)[ arg ] );
+ // Arguments are only 8 bit values
+ printHex( (&guide->args)[ arg ] );
// Only show arg separator if there are args left
- if ( arg + 1 < guide->argCount )
+ if ( arg + 1 < CapabilitiesList[ guide->index ].argCount )
print(",");
}
print(")");
projects / kiibohd-controller.git / blobdiff