/* Copyright (C) 2014 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
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
+ * 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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
*
- * The above copyright notice and this permission notice shall be included in
- * all copies or substantial portions of the Software.
+ * This file is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
*
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
- * THE SOFTWARE.
+ * You should have received a copy of the GNU General Public License
+ * along with this file. If not, see <http://www.gnu.org/licenses/>.
*/
// ----- Includes -----
// Keymaps
#include "usb_hid.h"
#include <defaultMap.h>
+#include "generatedKeymap.h" // TODO Use actual generated version
// Local Includes
#include "macro.h"
// ----- Function Declarations -----
-void cliFunc_capList ( char* args );
-void cliFunc_capSelect ( char* args );
-void cliFunc_lookComb ( char* args );
-void cliFunc_lookDefault( char* args );
-void cliFunc_lookPartial( char* args );
-void cliFunc_macroDebug ( char* args );
+void cliFunc_capList ( char* args );
+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_macroDebug( char* args );
+void cliFunc_macroList ( char* args );
+void cliFunc_macroProc ( char* args );
+void cliFunc_macroShow ( char* args );
+void cliFunc_macroStep ( char* args );
// ----- Variables -----
// Macro Module command dictionary
-char* macroCLIDictName = "Macro Module Commands (Not all commands fully work yet...)";
+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, \033[35mS12\033[0m Scancode 0x0C", cliFunc_capSelect },
- { "lookComb", "Do a lookup on the Combined map." NL "\t\t\033[35mS10\033[0m Scancode 0x0A, \033[35mU11\033[0m USB Code 0x0B", cliFunc_lookComb },
- { "lookDefault", "Do a lookup on the Default map." NL "\t\t\033[35mS10\033[0m Scancode 0x0A", cliFunc_lookDefault },
- { "lookPartial", "Do a lookup on the layered Partial maps." NL "\t\t\033[35mS10\033[0m Scancode 0x0A, \033[35mU11\033[0m USB Code 0x0B", cliFunc_lookPartial },
+ { "capSelect", "Triggers the specified capability." NL "\t\t\033[35mU10\033[0m USB Code 0x0A, \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 },
{ "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 },
{ 0, 0, 0 } // Null entry for dictionary end
};
// Macro debug flag - If set, clears the USB Buffers after signalling processing completion
uint8_t macroDebugMode = 0;
+// Macro pause flag - If set, the macro module pauses processing, unless unset, or the step counter is non-zero
+uint8_t macroPauseMode = 0;
-
-// ----- Functions -----
-
-// Looks up the start of the function ptr list for the active layer, by scan code
-inline void *Macro_layerLookup( uint8_t scanCode )
-{
- // TODO
- return 0;
-}
+// Macro step counter - If non-zero, the step counter counts down every time the macro module does one processing loop
+unsigned int macroStepCounter = 0;
-// Called for each key from the Scan Module for one of three cases:
-// 1. Key is pressed (PRESSED)
-// 2. Key is being held down (HELD)
-// 3. Key is released (RELEASED)
-// If Scan Module is for an analog sense keyboard, do not use the defined keystates
-// This function should not be called if not pressed (depressed) or at 0%
-inline void Macro_keyUpdate( uint8_t scanCode, uint8_t state )
-{
- // Do layer lookup to find which capabilities to map
- void *capabilities = Macro_layerLookup( scanCode );
-}
+// 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
+uint8_t macroTriggerListBufferSize = 0;
+// 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];
+// ----- Functions -----
+// Looks up the trigger list for the given scan code (from the active layer)
+unsigned int *Macro_layerLookup( uint8_t scanCode )
+{
+ // TODO - No layer fallthrough lookup
+ return default_scanMap[ scanCode ];
+}
+// Update the scancode key state
+// States:
+// * 0x00 - Reserved
+// * 0x01 - Pressed
+// * 0x02 - Held
+// * 0x03 - Released
+// * 0x04 - Unpressed (this is currently ignored)
+inline void Macro_keyState( uint8_t scanCode, uint8_t state )
+{
+ // Only add to macro trigger list if one of three states
+ switch ( state )
+ {
+ case 0x01: // Pressed
+ case 0x02: // Held
+ case 0x03: // Released
+ macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = scanCode;
+ macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = state;
+ break;
+ }
+}
+// Update the scancode analog state
+// States:
+// * 0x00 - Reserved
+// * 0x01 - Released
+// * 0x02-0xFF - Analog value (low to high)
+inline void Macro_analogState( uint8_t scanCode, uint8_t state )
+{
+ // TODO
+}
+// Update led state
+// States:
+// * 0x00 - Reserved
+// * 0x01 - On
+// * 0x02 - Off
+inline void Macro_ledState( uint8_t ledCode, uint8_t state )
+{
+ // TODO
+}
+// Evaluate/Update the TriggerMacro
+void Macro_evalTriggerMacro( TriggerMacro *triggerMacro )
+{
+ // Which combo in the sequence is being evaluated
+ unsigned int comboPos = triggerMacro->pos;
+ // If combo length is more than 1, cancel trigger macro if an incorrect key is found
+ uint8_t comboLength = triggerMacro->guide[ comboPos ];
+ // Iterate over list of keys currently pressed
+ for ( uint8_t keyPressed = 0; keyPressed < macroTriggerListBufferSize; keyPressed += 2 )
+ {
+ // Compare with keys in combo
+ for ( unsigned int comboKey = 0; comboKey < comboLength; comboKey++ )
+ {
+ // Lookup key in combo
+ uint8_t guideKey = triggerMacro->guide[ comboPos + comboKey + 2 ]; // TODO Only Press/Hold/Release atm
+
+ // Sequence Case
+ if ( comboLength == 1 )
+ {
+ // If key matches and only 1 key pressed, increment the TriggerMacro combo position
+ if ( guideKey == macroTriggerListBuffer[ keyPressed ] && macroTriggerListBufferSize == 1 )
+ {
+ triggerMacro->pos += comboLength * 2 + 1;
+ // TODO check if TriggerMacro is finished, register ResultMacro
+ return;
+ }
+
+ // If key does not match or more than 1 key pressed, reset the TriggerMacro combo position
+ triggerMacro->pos = 0;
+ return;
+ }
+ // Combo Case
+ else
+ {
+ // TODO
+ }
+ }
+ }
+}
+/*
inline void Macro_bufferAdd( uint8_t byte )
{
// Make sure we haven't overflowed the key buffer
erro_msg("Could not find key to release: ");
printHex( key );
}
+*/
inline void Macro_finishWithUSBBuffer( uint8_t sentKeys )
{
if ( USBKeys_Sent != 0 )
return;
+ // If the pause flag is set, only process if the step counter is non-zero
+ if ( macroPauseMode && macroStepCounter == 0 )
+ {
+ return;
+ }
+ // Proceed, decrementing the step counter
+ else
+ {
+ macroStepCounter--;
+ }
+
+ // Loop through macro trigger buffer
+ for ( uint8_t index = 0; index < macroTriggerListBufferSize; index += 2 )
+ {
+ // Get scanCode, first item of macroTriggerListBuffer pairs
+ uint8_t scanCode = macroTriggerListBuffer[ index ];
+
+ // Lookup trigger list for this key
+ unsigned int *triggerList = Macro_layerLookup( scanCode );
+
+ // The first element is the length of the trigger list
+ unsigned int triggerListSize = triggerList[0];
+
+ // Loop through the trigger list
+ for ( unsigned int trigger = 0; trigger < triggerListSize; trigger++ )
+ {
+ // Lookup TriggerMacro
+ TriggerMacro *triggerMacro = (TriggerMacro*)triggerList[ trigger + 1 ];
+
+ // Get triggered state of scan code, second item of macroTriggerListBuffer pairs
+ uint8_t state = macroTriggerListBuffer[ index + 1 ];
+
+ // Evaluate Macro
+ Macro_evalTriggerMacro( triggerMacro );
+ }
+ }
+
+
+
+
+
+ /* TODO
// Loop through input buffer
for ( uint8_t index = 0; index < KeyIndex_BufferUsed && !macroDebugMode; index++ )
{
errorLED( 1 );
}
}
+ */
// Signal buffer that we've used it
Scan_finishedWithBuffer( KeyIndex_BufferUsed );
// Disable Macro debug mode
macroDebugMode = 0;
+
+ // Disable Macro pause flag
+ macroPauseMode = 0;
+
+ // Set Macro step counter to zero
+ macroStepCounter = 0;
+
+ // Make sure macro trigger buffer is empty
+ macroTriggerListBufferSize = 0;
}
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 ]);
+ capability( 0xFF, 0xFF, 0 );
+ }
}
void cliFunc_capSelect( char* args )
// TODO
break;
- // Scancode
- case 'S':
- // Add to the USB Buffer using the DefaultMap lookup
- Macro_bufferAdd( decToInt( &arg1Ptr[1] ) );
- break;
-
// USB Code
case 'U':
// Just add the key to the USB Buffer
}
}
-void cliFunc_lookComb( char* args )
+void cliFunc_keyPress( char* args )
{
- // Parse code from argument
- // NOTE: Only first argument is used
+ // Parse codes from arguments
+ char* curArgs;
char* arg1Ptr;
- char* arg2Ptr;
- CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+ char* arg2Ptr = args;
- // Depending on the first character, the lookup changes
- switch ( arg1Ptr[0] )
+ // Process all args
+ for ( ;; )
{
- // Scancode
- case 'S':
- // TODO
- break;
+ curArgs = arg2Ptr;
+ CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
- // USB Code
- case 'U':
- // TODO
- break;
+ // Stop processing args if no more are found
+ if ( *arg1Ptr == '\0' )
+ break;
+
+ // Ignore non-Scancode numbers
+ switch ( arg1Ptr[0] )
+ {
+ // Scancode
+ case 'S':
+ Macro_keyState( (uint8_t)decToInt( &arg1Ptr[1] ), 0x01 ); // Press scancode
+ break;
+ }
}
}
-void cliFunc_lookDefault( char* args )
+void cliFunc_keyRelease( char* args )
{
- // Parse code from argument
- // NOTE: Only first argument is used
+ // Parse codes from arguments
+ char* curArgs;
char* arg1Ptr;
- char* arg2Ptr;
- CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+ char* arg2Ptr = args;
- // Depending on the first character, the lookup changes
- switch ( arg1Ptr[0] )
+ // Process all args
+ for ( ;; )
{
- // Scancode
- case 'S':
- print( NL );
- printInt8( DefaultMap_Lookup[decToInt( &arg1Ptr[1] )] );
- print(" ");
- printHex( DefaultMap_Lookup[decToInt( &arg1Ptr[1] )] );
- break;
+ curArgs = arg2Ptr;
+ CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+
+ // Stop processing args if no more are found
+ if ( *arg1Ptr == '\0' )
+ break;
+
+ // Ignore non-Scancode numbers
+ switch ( arg1Ptr[0] )
+ {
+ // Scancode
+ case 'S':
+ Macro_keyState( (uint8_t)decToInt( &arg1Ptr[1] ), 0x03 ); // Release scancode
+ break;
+ }
}
}
-void cliFunc_lookPartial( char* args )
+void cliFunc_layerLatch( char* args )
{
- // Parse code from argument
- // NOTE: Only first argument is used
- char* arg1Ptr;
- char* arg2Ptr;
- CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+ // TODO
+}
- // Depending on the first character, the lookup changes
- switch ( arg1Ptr[0] )
- {
- // Scancode
- case 'S':
- // TODO
- break;
+void cliFunc_layerList( char* args )
+{
+ // TODO
+}
- // USB Code
- case 'U':
- // TODO
- break;
- }
+void cliFunc_layerLock( char* args )
+{
+ // TODO
}
void cliFunc_macroDebug( char* args )
printInt8( macroDebugMode );
}
+void cliFunc_macroList( char* args )
+{
+ // 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 )
+{
+ // Toggle macro pause mode
+ macroPauseMode = macroPauseMode ? 0 : 1;
+
+ print( NL );
+ info_msg("Macro Processing Mode: ");
+ printInt8( macroPauseMode );
+}
+
+void macroDebugShowTrigger( unsigned int index )
+{
+ // Only proceed if the macro exists
+ if ( index >= TriggerMacroNum )
+ return;
+
+ // Trigger Macro Show
+ TriggerMacro *macro = &TriggerMacroList[ index ];
+
+ print( NL );
+ info_msg("Trigger Macro Index: ");
+ printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
+ print( NL );
+
+ // Read the comboLength for combo in the sequence (sequence of combos)
+ unsigned int pos = 0;
+ uint8_t comboLength = macro->guide[ pos ];
+
+ // Iterate through and interpret the guide
+ while ( comboLength != 0 )
+ {
+ // Initial position of the combo
+ unsigned int comboPos = ++pos;
+
+ // Iterate through the combo
+ while ( pos < comboLength * TriggerGuideSize + comboPos )
+ {
+ // Assign TriggerGuide element (key type, state and scancode)
+ TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ pos ]);
+
+ // Display guide information about trigger key
+ printHex( guide->scancode );
+ print("|");
+ printHex( guide->type );
+ print("|");
+ printHex( guide->state );
+
+ // Increment position
+ pos += TriggerGuideSize;
+
+ // Only show combo separator if there are combos left in the sequence element
+ if ( pos < comboLength * TriggerGuideSize + comboPos )
+ print("+");
+ }
+
+ // Read the next comboLength
+ comboLength = macro->guide[ pos ];
+
+ // Only show sequence separator if there is another combo to process
+ if ( comboLength != 0 )
+ print(";");
+ }
+
+ // Display current position
+ print( NL "Position: " );
+ printInt16( (uint16_t)macro->pos ); // Hopefully large enough :P (can't assume 32-bit)
+
+ // Display result macro index
+ print( NL "Result Macro Index: " );
+ printInt16( (uint16_t)macro->result ); // Hopefully large enough :P (can't assume 32-bit)
+}
+
+void macroDebugShowResult( unsigned int index )
+{
+ // Only proceed if the macro exists
+ if ( index >= ResultMacroNum )
+ return;
+
+ // Trigger Macro Show
+ ResultMacro *macro = &ResultMacroList[ index ];
+
+ print( NL );
+ info_msg("Result Macro Index: ");
+ printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
+ print( NL );
+
+ // Read the comboLength for combo in the sequence (sequence of combos)
+ unsigned int pos = 0;
+ uint8_t comboLength = macro->guide[ pos++ ];
+
+ // Iterate through and interpret the guide
+ while ( comboLength != 0 )
+ {
+ // Function Counter, used to keep track of the combos processed
+ unsigned int funcCount = 0;
+
+ // Iterate through the combo
+ while ( funcCount < comboLength )
+ {
+ // 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)CapabilitiesList[ guide->index ] );
+ 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[ guide->index ]);
+ capability( 0xFF, 0xFF, 0 );
+
+ // Display Argument(s)
+ print("(");
+ for ( unsigned int arg = 0; arg < guide->argCount; 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 )
+ print(",");
+ }
+ print(")");
+
+ // Increment position
+ pos += ResultGuideSize( guide );
+
+ // Increment function count
+ funcCount++;
+
+ // Only show combo separator if there are combos left in the sequence element
+ if ( funcCount < comboLength )
+ print("+");
+ }
+
+ // Read the next comboLength
+ comboLength = macro->guide[ pos++ ];
+
+ // Only show sequence separator if there is another combo to process
+ if ( comboLength != 0 )
+ print(";");
+ }
+
+ // Display current position
+ print( NL "Position: " );
+ printInt16( (uint16_t)macro->pos ); // Hopefully large enough :P (can't assume 32-bit)
+
+ // Display final trigger state/type
+ print( NL "Final Trigger State (State/Type): " );
+ printHex( macro->state );
+ print("/");
+ printHex( macro->stateType );
+}
+
+void cliFunc_macroShow( char* args )
+{
+ // Parse codes from arguments
+ char* curArgs;
+ char* arg1Ptr;
+ char* arg2Ptr = args;
+
+ // Process all args
+ for ( ;; )
+ {
+ curArgs = arg2Ptr;
+ CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
+
+ // Stop processing args if no more are found
+ if ( *arg1Ptr == '\0' )
+ break;
+
+ // Ignore invalid codes
+ switch ( arg1Ptr[0] )
+ {
+ // Indexed Trigger Macro
+ case 'T':
+ macroDebugShowTrigger( decToInt( &arg1Ptr[1] ) );
+ break;
+ // Indexed Result Macro
+ case 'R':
+ macroDebugShowResult( decToInt( &arg1Ptr[1] ) );
+ break;
+ }
+ }
+}
+
+void cliFunc_macroStep( char* args )
+{
+ // Parse number from argument
+ // NOTE: Only first argument is used
+ char* arg1Ptr;
+ char* arg2Ptr;
+ CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
+
+ // Set the macro step counter, negative int's are cast to uint
+ macroStepCounter = (unsigned int)decToInt( arg1Ptr );
+}
+
projects / kiibohd-controller.git / blobdiff