X-Git-Url: https://git.donarmstrong.com/?a=blobdiff_plain;f=Macro%2FPartialMap%2Fmacro.c;h=bc2d7d68643078ae25f04d55869398e0948c2baa;hb=216b1513026e45e44794f15cfa4d02ff1c9d49f4;hp=73e643a41ef3b7d32b62e6f18ef1fd14e049690b;hpb=9b1e19017f65c359a33f074e66e0d96c068eb2d5;p=kiibohd-controller.git diff --git a/Macro/PartialMap/macro.c b/Macro/PartialMap/macro.c index 73e643a..bc2d7d6 100644 --- a/Macro/PartialMap/macro.c +++ b/Macro/PartialMap/macro.c @@ -1,4 +1,4 @@ -/* Copyright (C) 2014 by Jacob Alexander +/* Copyright (C) 2014-2015 by Jacob Alexander * * This file is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -41,6 +41,7 @@ void cliFunc_capSelect ( char* args ); void cliFunc_keyHold ( char* args ); void cliFunc_keyPress ( char* args ); void cliFunc_keyRelease( char* args ); +void cliFunc_layerDebug( char* args ); void cliFunc_layerList ( char* args ); void cliFunc_layerState( char* args ); void cliFunc_macroDebug( char* args ); @@ -81,24 +82,41 @@ typedef enum ResultMacroEval { // ----- Variables ----- // Macro Module command dictionary -const char macroCLIDictName[] = "Macro Module Commands"; -const CLIDictItem macroCLIDict[] = { - { "capList", "Prints an indexed list of all non USB keycode capabilities.", cliFunc_capList }, - { "capSelect", "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B", cliFunc_capSelect }, - { "keyHold", "Send key-hold events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyHold }, - { "keyPress", "Send key-press events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyPress }, - { "keyRelease", "Send key-release event to macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_keyRelease }, - { "layerList", "List available layers.", cliFunc_layerList }, - { "layerState", "Modify specified indexed layer state ." 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." 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 }, +CLIDict_Entry( capList, "Prints an indexed list of all non USB keycode capabilities." ); +CLIDict_Entry( capSelect, "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B" ); +CLIDict_Entry( keyHold, "Send key-hold events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" ); +CLIDict_Entry( keyPress, "Send key-press events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" ); +CLIDict_Entry( keyRelease, "Send key-release event to macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" ); +CLIDict_Entry( layerDebug, "Layer debug mode. Shows layer stack and any changes." ); +CLIDict_Entry( layerList, "List available layers." ); +CLIDict_Entry( layerState, "Modify specified indexed layer state ." NL "\t\t\033[35mL2\033[0m Indexed Layer 0x02" NL "\t\t0 Off, 1 Shift, 2 Latch, 4 Lock States" ); +CLIDict_Entry( macroDebug, "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes." ); +CLIDict_Entry( macroList, "List the defined trigger and result macros." ); +CLIDict_Entry( macroProc, "Pause/Resume macro processing." ); +CLIDict_Entry( 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" ); +CLIDict_Entry( macroStep, "Do N macro processing steps. Defaults to 1." ); + +CLIDict_Def( macroCLIDict, "Macro Module Commands" ) = { + CLIDict_Item( capList ), + CLIDict_Item( capSelect ), + CLIDict_Item( keyHold ), + CLIDict_Item( keyPress ), + CLIDict_Item( keyRelease ), + CLIDict_Item( layerDebug ), + CLIDict_Item( layerList ), + CLIDict_Item( layerState ), + CLIDict_Item( macroDebug ), + CLIDict_Item( macroList ), + CLIDict_Item( macroProc ), + CLIDict_Item( macroShow ), + CLIDict_Item( macroStep ), { 0, 0, 0 } // Null entry for dictionary end }; +// Layer debug flag - If set, displays any changes to layers and the full layer stack on change +uint8_t layerDebugMode = 0; + // Macro debug flag - If set, clears the USB Buffers after signalling processing completion uint8_t macroDebugMode = 0; @@ -109,9 +127,11 @@ uint8_t macroPauseMode = 0; uint16_t macroStepCounter = 0; -// Key Trigger List Buffer +// Key Trigger List Buffer and Layer Cache +// The layer cache is set on press only, hold and release events refer to the value set on press TriggerGuide macroTriggerListBuffer[ MaxScanCode ]; uint8_t macroTriggerListBufferSize = 0; +var_uint_t macroTriggerListLayerCache[ MaxScanCode ]; // Pending Trigger Macro Index List // * Any trigger macros that need processing from a previous macro processing loop @@ -138,6 +158,10 @@ uint16_t macroResultMacroPendingListSize = 0; // Sets the given layer with the specified layerState void Macro_layerState( uint8_t state, uint8_t stateType, uint16_t layer, uint8_t layerState ) { + // Ignore if layer does not exist + if ( layer >= LayerNum ) + return; + // Is layer in the LayerIndexStack? uint8_t inLayerIndexStack = 0; uint16_t stackItem = 0; @@ -186,6 +210,30 @@ void Macro_layerState( uint8_t state, uint8_t stateType, uint16_t layer, uint8_t // Reduce LayerIndexStack size macroLayerIndexStackSize--; } + + // Layer Debug Mode + if ( layerDebugMode ) + { + dbug_msg("Layer "); + + // Iterate over each of the layers displaying the state as a hex value + for ( uint16_t index = 0; index < LayerNum; index++ ) + { + printHex_op( LayerState[ index ], 0 ); + } + + // Always show the default layer (it's always 0) + print(" 0"); + + // Iterate over the layer stack starting from the bottom of the stack + for ( uint16_t index = macroLayerIndexStackSize; index > 0; index-- ) + { + print(":"); + printHex_op( macroLayerIndexStack[ index - 1 ], 0 ); + } + + print( NL ); + } } // Modifies the specified Layer control byte @@ -230,8 +278,7 @@ void Macro_layerLatch_capability( uint8_t state, uint8_t stateType, uint8_t *arg // Only use capability on press // TODO Analog - // XXX To make sense, this code be on press or release. Or it could even be a sticky shift (why? dunno) -HaaTa - if ( stateType == 0x00 && state != 0x01 ) // All normal key conditions except press + if ( stateType == 0x00 && state != 0x03 ) // Only on release return; // Get layer index from arguments @@ -296,8 +343,24 @@ void Macro_layerShift_capability( uint8_t state, uint8_t stateType, uint8_t *arg // Looks up the trigger list for the given scan code (from the active layer) // NOTE: Calling function must handle the NULL pointer case -nat_ptr_t *Macro_layerLookup( uint8_t scanCode ) +nat_ptr_t *Macro_layerLookup( TriggerGuide *guide, uint8_t latch_expire ) { + uint8_t scanCode = guide->scanCode; + + // TODO Analog + // If a normal key, and not pressed, do a layer cache lookup + if ( guide->type == 0x00 && guide->state != 0x01 ) + { + // Cached layer + var_uint_t cachedLayer = macroTriggerListLayerCache[ scanCode ]; + + // Lookup map, then layer + nat_ptr_t **map = (nat_ptr_t**)LayerIndex[ cachedLayer ].triggerMap; + const Layer *layer = &LayerIndex[ cachedLayer ]; + + return map[ scanCode - layer->first ]; + } + // If no trigger macro is defined at the given layer, fallthrough to the next layer for ( uint16_t layerIndex = 0; layerIndex < macroLayerIndexStackSize; layerIndex++ ) { @@ -306,10 +369,10 @@ nat_ptr_t *Macro_layerLookup( uint8_t scanCode ) // Check if latch has been pressed for this layer // XXX Regardless of whether a key is found, the latch is removed on first lookup - uint8_t latch = LayerState[ layerIndex ] & 0x02; - if ( latch ) + uint8_t latch = LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x02; + if ( latch && latch_expire ) { - LayerState[ layerIndex ] &= ~0x02; + Macro_layerState( 0, 0, macroLayerIndexStack[ layerIndex ], 0x02 ); } // Only use layer, if state is valid @@ -327,6 +390,9 @@ nat_ptr_t *Macro_layerLookup( uint8_t scanCode ) && scanCode >= layer->first && *map[ scanCode - layer->first ] != 0 ) { + // Set the layer cache + macroTriggerListLayerCache[ scanCode ] = macroLayerIndexStack[ layerIndex ]; + return map[ scanCode - layer->first ]; } } @@ -344,6 +410,9 @@ nat_ptr_t *Macro_layerLookup( uint8_t scanCode ) && scanCode >= layer->first && *map[ scanCode - layer->first ] != 0 ) { + // Set the layer cache to default map + macroTriggerListLayerCache[ scanCode ] = 0; + return map[ scanCode - layer->first ]; } @@ -354,6 +423,16 @@ nat_ptr_t *Macro_layerLookup( uint8_t scanCode ) } +// Update the scancode using a list of TriggerGuides +// TODO Handle led state and analog +inline void Macro_triggerState( void *triggers, uint8_t num ) +{ + // Copy each of the TriggerGuides to the TriggerListBuffer + for ( uint8_t c = 0; c < num; c++ ) + macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = ((TriggerGuide*)triggers)[ c ]; +} + + // Update the scancode key state // States: // * 0x00 - Off @@ -601,7 +680,7 @@ inline TriggerMacroVote Macro_evalLongTriggerMacroVote( TriggerGuide *key, Trigg // Evaluate/Update TriggerMacro -inline TriggerMacroEval Macro_evalTriggerMacro( var_uint_t triggerMacroIndex ) +TriggerMacroEval Macro_evalTriggerMacro( var_uint_t triggerMacroIndex ) { // Lookup TriggerMacro const TriggerMacro *macro = &TriggerMacroList[ triggerMacroIndex ]; @@ -816,8 +895,12 @@ inline void Macro_updateTriggerMacroPendingList() if ( macroTriggerListBuffer[ key ].state == 0x00 && macroTriggerListBuffer[ key ].state != 0x01 ) continue; + // TODO Analog + // If this is a release case, indicate to layer lookup for possible latch expiry + uint8_t latch_expire = macroTriggerListBuffer[ key ].state == 0x03; + // Lookup Trigger List - nat_ptr_t *triggerList = Macro_layerLookup( macroTriggerListBuffer[ key ].scanCode ); + nat_ptr_t *triggerList = Macro_layerLookup( ¯oTriggerListBuffer[ key ], latch_expire ); // Number of Triggers in list nat_ptr_t triggerListSize = triggerList[0]; @@ -987,7 +1070,7 @@ inline void Macro_setup() void cliFunc_capList( char* args ) { print( NL ); - info_msg("Capabilities List"); + info_msg("Capabilities List "); printHex( CapabilitiesNum ); // Iterate through all of the capabilities and display them @@ -1151,6 +1234,16 @@ void cliFunc_keyRelease( char* args ) } } +void cliFunc_layerDebug( char *args ) +{ + // Toggle layer debug mode + layerDebugMode = layerDebugMode ? 0 : 1; + + print( NL ); + info_msg("Layer Debug Mode: "); + printInt8( layerDebugMode ); +} + void cliFunc_layerList( char* args ) { print( NL );