1 /* Copyright (C) 2014-2015 by Jacob Alexander
3 * This file is free software: you can redistribute it and/or modify
4 * it under the terms of the GNU General Public License as published by
5 * the Free Software Foundation, either version 3 of the License, or
6 * (at your option) any later version.
8 * This file is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
13 * You should have received a copy of the GNU General Public License
14 * along with this file. If not, see <http://www.gnu.org/licenses/>.
17 // ----- Includes -----
20 #include <Lib/MacroLib.h>
26 #include <scan_loop.h>
30 #include <generatedKeymap.h> // Generated using kll at compile time, in build directory
33 #if defined(ConnectEnabled_define)
34 #include <connect_scan.h>
42 // ----- Function Declarations -----
44 void cliFunc_capList ( char* args );
45 void cliFunc_capSelect ( char* args );
46 void cliFunc_keyHold ( char* args );
47 void cliFunc_keyPress ( char* args );
48 void cliFunc_keyRelease( char* args );
49 void cliFunc_layerDebug( char* args );
50 void cliFunc_layerList ( char* args );
51 void cliFunc_layerState( char* args );
52 void cliFunc_macroDebug( char* args );
53 void cliFunc_macroList ( char* args );
54 void cliFunc_macroProc ( char* args );
55 void cliFunc_macroShow ( char* args );
56 void cliFunc_macroStep ( char* args );
62 // Bit positions are important, passes (correct key) always trump incorrect key votes
63 typedef enum TriggerMacroVote {
64 TriggerMacroVote_Release = 0x10, // Correct key
65 TriggerMacroVote_PassRelease = 0x18, // Correct key (both pass and release)
66 TriggerMacroVote_Pass = 0x8, // Correct key
67 TriggerMacroVote_DoNothingRelease = 0x4, // Incorrect key
68 TriggerMacroVote_DoNothing = 0x2, // Incorrect key
69 TriggerMacroVote_Fail = 0x1, // Incorrect key
70 TriggerMacroVote_Invalid = 0x0, // Invalid state
73 typedef enum TriggerMacroEval {
74 TriggerMacroEval_DoNothing,
75 TriggerMacroEval_DoResult,
76 TriggerMacroEval_DoResultAndRemove,
77 TriggerMacroEval_Remove,
80 typedef enum ResultMacroEval {
81 ResultMacroEval_DoNothing,
82 ResultMacroEval_Remove,
87 // ----- Variables -----
89 // Macro Module command dictionary
90 CLIDict_Entry( capList, "Prints an indexed list of all non USB keycode capabilities." );
91 CLIDict_Entry( capSelect, "Triggers the specified capabilities. First two args are state and stateType." NL "\t\t\033[35mK11\033[0m Keyboard Capability 0x0B" );
92 CLIDict_Entry( keyHold, "Send key-hold events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" );
93 CLIDict_Entry( keyPress, "Send key-press events to the macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" );
94 CLIDict_Entry( keyRelease, "Send key-release event to macro module. Duplicates have undefined behaviour." NL "\t\t\033[35mS10\033[0m Scancode 0x0A" );
95 CLIDict_Entry( layerDebug, "Layer debug mode. Shows layer stack and any changes." );
96 CLIDict_Entry( layerList, "List available layers." );
97 CLIDict_Entry( 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" );
98 CLIDict_Entry( macroDebug, "Disables/Enables sending USB keycodes to the Output Module and prints U/K codes." );
99 CLIDict_Entry( macroList, "List the defined trigger and result macros." );
100 CLIDict_Entry( macroProc, "Pause/Resume macro processing." );
101 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" );
102 CLIDict_Entry( macroStep, "Do N macro processing steps. Defaults to 1." );
104 CLIDict_Def( macroCLIDict, "Macro Module Commands" ) = {
105 CLIDict_Item( capList ),
106 CLIDict_Item( capSelect ),
107 CLIDict_Item( keyHold ),
108 CLIDict_Item( keyPress ),
109 CLIDict_Item( keyRelease ),
110 CLIDict_Item( layerDebug ),
111 CLIDict_Item( layerList ),
112 CLIDict_Item( layerState ),
113 CLIDict_Item( macroDebug ),
114 CLIDict_Item( macroList ),
115 CLIDict_Item( macroProc ),
116 CLIDict_Item( macroShow ),
117 CLIDict_Item( macroStep ),
118 { 0, 0, 0 } // Null entry for dictionary end
122 // Layer debug flag - If set, displays any changes to layers and the full layer stack on change
123 uint8_t layerDebugMode = 0;
125 // Macro debug flag - If set, clears the USB Buffers after signalling processing completion
126 uint8_t macroDebugMode = 0;
128 // Macro pause flag - If set, the macro module pauses processing, unless unset, or the step counter is non-zero
129 uint8_t macroPauseMode = 0;
131 // Macro step counter - If non-zero, the step counter counts down every time the macro module does one processing loop
132 uint16_t macroStepCounter = 0;
135 // Key Trigger List Buffer and Layer Cache
136 // The layer cache is set on press only, hold and release events refer to the value set on press
137 TriggerGuide macroTriggerListBuffer[ MaxScanCode ];
138 uint8_t macroTriggerListBufferSize = 0;
139 var_uint_t macroTriggerListLayerCache[ MaxScanCode ];
141 // Pending Trigger Macro Index List
142 // * Any trigger macros that need processing from a previous macro processing loop
143 // TODO, figure out a good way to scale this array size without wasting too much memory, but not rejecting macros
144 // Possibly could be calculated by the KLL compiler
145 // XXX It may be possible to calculate the worst case using the KLL compiler
146 uint16_t macroTriggerMacroPendingList[ TriggerMacroNum ] = { 0 };
147 uint16_t macroTriggerMacroPendingListSize = 0;
150 // * When modifying layer state and the state is non-0x0, the stack must be adjusted
151 uint16_t macroLayerIndexStack[ LayerNum + 1 ] = { 0 };
152 uint16_t macroLayerIndexStackSize = 0;
154 // Pending Result Macro Index List
155 // * Any result macro that needs processing from a previous macro processing loop
156 uint16_t macroResultMacroPendingList[ ResultMacroNum ] = { 0 };
157 uint16_t macroResultMacroPendingListSize = 0;
161 // ----- Capabilities -----
163 // Sets the given layer with the specified layerState
164 void Macro_layerState( uint8_t state, uint8_t stateType, uint16_t layer, uint8_t layerState )
166 // Ignore if layer does not exist
167 if ( layer >= LayerNum )
170 // Is layer in the LayerIndexStack?
171 uint8_t inLayerIndexStack = 0;
172 uint16_t stackItem = 0;
173 while ( stackItem < macroLayerIndexStackSize )
175 // Flag if layer is already in the LayerIndexStack
176 if ( macroLayerIndexStack[ stackItem ] == layer )
178 inLayerIndexStack = 1;
182 // Increment to next item
186 // Toggle Layer State Byte
187 if ( LayerState[ layer ] & layerState )
190 LayerState[ layer ] &= ~layerState;
195 LayerState[ layer ] |= layerState;
198 // If the layer was not in the LayerIndexStack add it
199 if ( !inLayerIndexStack )
201 macroLayerIndexStack[ macroLayerIndexStackSize++ ] = layer;
204 // If the layer is in the LayerIndexStack and the state is 0x00, remove
205 if ( LayerState[ layer ] == 0x00 && inLayerIndexStack )
207 // Remove the layer from the LayerIndexStack
208 // Using the already positioned stackItem variable from the loop above
209 while ( stackItem < macroLayerIndexStackSize )
211 macroLayerIndexStack[ stackItem ] = macroLayerIndexStack[ stackItem + 1 ];
215 // Reduce LayerIndexStack size
216 macroLayerIndexStackSize--;
220 if ( layerDebugMode )
224 // Iterate over each of the layers displaying the state as a hex value
225 for ( uint16_t index = 0; index < LayerNum; index++ )
227 printHex_op( LayerState[ index ], 0 );
230 // Always show the default layer (it's always 0)
233 // Iterate over the layer stack starting from the bottom of the stack
234 for ( uint16_t index = macroLayerIndexStackSize; index > 0; index-- )
237 printHex_op( macroLayerIndexStack[ index - 1 ], 0 );
244 // Modifies the specified Layer control byte
245 // Argument #1: Layer Index -> uint16_t
246 // Argument #2: Layer State -> uint8_t
247 void Macro_layerState_capability( uint8_t state, uint8_t stateType, uint8_t *args )
249 // Display capability name
250 if ( stateType == 0xFF && state == 0xFF )
252 print("Macro_layerState(layerIndex,layerState)");
256 // Only use capability on press or release
258 // XXX This may cause issues, might be better to implement state table here to decide -HaaTa
259 if ( stateType == 0x00 && state == 0x02 ) // Hold condition
262 // Get layer index from arguments
263 // Cast pointer to uint8_t to uint16_t then access that memory location
264 uint16_t layer = *(uint16_t*)(&args[0]);
266 // Get layer toggle byte
267 uint8_t layerState = args[ sizeof(uint16_t) ];
269 Macro_layerState( state, stateType, layer, layerState );
273 // Latches given layer
274 // Argument #1: Layer Index -> uint16_t
275 void Macro_layerLatch_capability( uint8_t state, uint8_t stateType, uint8_t *args )
277 // Display capability name
278 if ( stateType == 0xFF && state == 0xFF )
280 print("Macro_layerLatch(layerIndex)");
284 // Only use capability on press
286 if ( stateType == 0x00 && state != 0x03 ) // Only on release
289 // Get layer index from arguments
290 // Cast pointer to uint8_t to uint16_t then access that memory location
291 uint16_t layer = *(uint16_t*)(&args[0]);
293 Macro_layerState( state, stateType, layer, 0x02 );
298 // Argument #1: Layer Index -> uint16_t
299 void Macro_layerLock_capability( uint8_t state, uint8_t stateType, uint8_t *args )
301 // Display capability name
302 if ( stateType == 0xFF && state == 0xFF )
304 print("Macro_layerLock(layerIndex)");
308 // Only use capability on press
310 // XXX Could also be on release, but that's sorta dumb -HaaTa
311 if ( stateType == 0x00 && state != 0x01 ) // All normal key conditions except press
314 // Get layer index from arguments
315 // Cast pointer to uint8_t to uint16_t then access that memory location
316 uint16_t layer = *(uint16_t*)(&args[0]);
318 Macro_layerState( state, stateType, layer, 0x04 );
322 // Shifts given layer
323 // Argument #1: Layer Index -> uint16_t
324 void Macro_layerShift_capability( uint8_t state, uint8_t stateType, uint8_t *args )
326 // Display capability name
327 if ( stateType == 0xFF && state == 0xFF )
329 print("Macro_layerShift(layerIndex)");
333 // Only use capability on press or release
335 if ( stateType == 0x00 && ( state == 0x00 || state == 0x02 ) ) // Only pass press or release conditions
338 // Get layer index from arguments
339 // Cast pointer to uint8_t to uint16_t then access that memory location
340 uint16_t layer = *(uint16_t*)(&args[0]);
342 Macro_layerState( state, stateType, layer, 0x01 );
347 // ----- Functions -----
349 // Looks up the trigger list for the given scan code (from the active layer)
350 // NOTE: Calling function must handle the NULL pointer case
351 nat_ptr_t *Macro_layerLookup( TriggerGuide *guide, uint8_t latch_expire )
353 uint8_t scanCode = guide->scanCode;
356 // If a normal key, and not pressed, do a layer cache lookup
357 if ( guide->type == 0x00 && guide->state != 0x01 )
360 var_uint_t cachedLayer = macroTriggerListLayerCache[ scanCode ];
362 // Lookup map, then layer
363 nat_ptr_t **map = (nat_ptr_t**)LayerIndex[ cachedLayer ].triggerMap;
364 const Layer *layer = &LayerIndex[ cachedLayer ];
366 return map[ scanCode - layer->first ];
369 // If no trigger macro is defined at the given layer, fallthrough to the next layer
370 for ( uint16_t layerIndex = 0; layerIndex < macroLayerIndexStackSize; layerIndex++ )
373 const Layer *layer = &LayerIndex[ macroLayerIndexStack[ layerIndex ] ];
375 // Check if latch has been pressed for this layer
376 // XXX Regardless of whether a key is found, the latch is removed on first lookup
377 uint8_t latch = LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x02;
378 if ( latch && latch_expire )
380 Macro_layerState( 0, 0, macroLayerIndexStack[ layerIndex ], 0x02 );
383 // Only use layer, if state is valid
384 // XOR each of the state bits
385 // If only two are enabled, do not use this state
386 if ( (LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x01) ^ (latch>>1) ^ ((LayerState[ macroLayerIndexStack[ layerIndex ] ] & 0x04)>>2) )
389 nat_ptr_t **map = (nat_ptr_t**)layer->triggerMap;
391 // Determine if layer has key defined
392 // Make sure scanCode is between layer first and last scancodes
394 && scanCode <= layer->last
395 && scanCode >= layer->first
396 && *map[ scanCode - layer->first ] != 0 )
398 // Set the layer cache
399 macroTriggerListLayerCache[ scanCode ] = macroLayerIndexStack[ layerIndex ];
401 return map[ scanCode - layer->first ];
406 // Do lookup on default layer
407 nat_ptr_t **map = (nat_ptr_t**)LayerIndex[0].triggerMap;
409 // Lookup default layer
410 const Layer *layer = &LayerIndex[0];
412 // Make sure scanCode is between layer first and last scancodes
414 && scanCode <= layer->last
415 && scanCode >= layer->first
416 && *map[ scanCode - layer->first ] != 0 )
418 // Set the layer cache to default map
419 macroTriggerListLayerCache[ scanCode ] = 0;
421 return map[ scanCode - layer->first ];
424 // Otherwise no defined Trigger Macro
425 erro_msg("Scan Code has no defined Trigger Macro: ");
426 printHex( scanCode );
431 // Update the scancode using a list of TriggerGuides
432 // TODO Handle led state and analog
433 inline void Macro_triggerState( void *triggers, uint8_t num )
435 // Copy each of the TriggerGuides to the TriggerListBuffer
436 for ( uint8_t c = 0; c < num; c++ )
437 macroTriggerListBuffer[ macroTriggerListBufferSize++ ] = ((TriggerGuide*)triggers)[ c ];
441 // Update the scancode key state
447 // * 0x04 - Unpressed (this is currently ignored)
448 inline void Macro_keyState( uint8_t scanCode, uint8_t state )
450 // Only add to macro trigger list if one of three states
453 case 0x01: // Pressed
455 case 0x03: // Released
456 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
457 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
458 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x00; // Normal key
459 macroTriggerListBufferSize++;
465 // Update the scancode analog state
469 // * 0x02-0xFF - Analog value (low to high)
470 inline void Macro_analogState( uint8_t scanCode, uint8_t state )
472 // Only add to macro trigger list if non-off
475 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = scanCode;
476 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
477 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x02; // Analog key
478 macroTriggerListBufferSize++;
487 inline void Macro_ledState( uint8_t ledCode, uint8_t state )
489 // Only add to macro trigger list if non-off
492 macroTriggerListBuffer[ macroTriggerListBufferSize ].scanCode = ledCode;
493 macroTriggerListBuffer[ macroTriggerListBufferSize ].state = state;
494 macroTriggerListBuffer[ macroTriggerListBufferSize ].type = 0x01; // LED key
495 macroTriggerListBufferSize++;
500 // Append result macro to pending list, checking for duplicates
501 // Do nothing if duplicate
502 inline void Macro_appendResultMacroToPendingList( const TriggerMacro *triggerMacro )
504 // Lookup result macro index
505 var_uint_t resultMacroIndex = triggerMacro->result;
507 // Iterate through result macro pending list, making sure this macro hasn't been added yet
508 for ( var_uint_t macro = 0; macro < macroResultMacroPendingListSize; macro++ )
510 // If duplicate found, do nothing
511 if ( macroResultMacroPendingList[ macro ] == resultMacroIndex )
515 // No duplicates found, add to pending list
516 macroResultMacroPendingList[ macroResultMacroPendingListSize++ ] = resultMacroIndex;
518 // Lookup scanCode of the last key in the last combo
520 for ( uint8_t comboLength = triggerMacro->guide[0]; comboLength > 0; )
522 pos += TriggerGuideSize * comboLength + 1;
523 comboLength = triggerMacro->guide[ pos ];
526 uint8_t scanCode = ((TriggerGuide*)&triggerMacro->guide[ pos - TriggerGuideSize ])->scanCode;
528 // Lookup scanCode in buffer list for the current state and stateType
529 for ( uint8_t keyIndex = 0; keyIndex < macroTriggerListBufferSize; keyIndex++ )
531 if ( macroTriggerListBuffer[ keyIndex ].scanCode == scanCode )
533 ResultMacroRecordList[ resultMacroIndex ].state = macroTriggerListBuffer[ keyIndex ].state;
534 ResultMacroRecordList[ resultMacroIndex ].stateType = macroTriggerListBuffer[ keyIndex ].type;
538 // Reset the macro position
539 ResultMacroRecordList[ resultMacroIndex ].pos = 0;
543 // Determine if long ResultMacro (more than 1 seqence element)
544 inline uint8_t Macro_isLongResultMacro( const ResultMacro *macro )
546 // Check the second sequence combo length
547 // If non-zero return non-zero (long sequence)
548 // 0 otherwise (short sequence)
549 var_uint_t position = 1;
550 for ( var_uint_t result = 0; result < macro->guide[0]; result++ )
551 position += ResultGuideSize( (ResultGuide*)¯o->guide[ position ] );
552 return macro->guide[ position ];
556 // Determine if long TriggerMacro (more than 1 sequence element)
557 inline uint8_t Macro_isLongTriggerMacro( const TriggerMacro *macro )
559 // Check the second sequence combo length
560 // If non-zero return non-zero (long sequence)
561 // 0 otherwise (short sequence)
562 return macro->guide[ macro->guide[0] * TriggerGuideSize + 1 ];
566 // Votes on the given key vs. guide, short macros
567 inline TriggerMacroVote Macro_evalShortTriggerMacroVote( TriggerGuide *key, TriggerGuide *guide )
569 // Depending on key type
570 switch ( guide->type )
574 // For short TriggerMacros completely ignore incorrect keys
575 if ( guide->scanCode == key->scanCode )
577 switch ( key->state )
579 // Correct key, pressed, possible passing
581 return TriggerMacroVote_Pass;
583 // Correct key, held, possible passing or release
585 return TriggerMacroVote_PassRelease;
587 // Correct key, released, possible release
589 return TriggerMacroVote_Release;
593 return TriggerMacroVote_DoNothing;
597 erro_print("LED State Type - Not implemented...");
602 erro_print("Analog State Type - Not implemented...");
605 // Invalid State Type
607 erro_print("Invalid State Type. This is a bug.");
611 // XXX Shouldn't reach here
612 return TriggerMacroVote_Invalid;
616 // Votes on the given key vs. guide, long macros
617 // A long macro is defined as a guide with more than 1 combo
618 inline TriggerMacroVote Macro_evalLongTriggerMacroVote( TriggerGuide *key, TriggerGuide *guide )
620 // Depending on key type
621 switch ( guide->type )
625 // Depending on the state of the buffered key, make voting decision
627 if ( guide->scanCode != key->scanCode )
629 switch ( key->state )
631 // Wrong key, pressed, fail
633 return TriggerMacroVote_Fail;
635 // Wrong key, held, do not pass (no effect)
637 return TriggerMacroVote_DoNothing;
639 // Wrong key released, fail out if pos == 0
641 return TriggerMacroVote_DoNothing | TriggerMacroVote_DoNothingRelease;
648 switch ( key->state )
650 // Correct key, pressed, possible passing
652 return TriggerMacroVote_Pass;
654 // Correct key, held, possible passing or release
656 return TriggerMacroVote_PassRelease;
658 // Correct key, released, possible release
660 return TriggerMacroVote_Release;
668 erro_print("LED State Type - Not implemented...");
673 erro_print("Analog State Type - Not implemented...");
676 // Invalid State Type
678 erro_print("Invalid State Type. This is a bug.");
682 // XXX Shouldn't reach here
683 return TriggerMacroVote_Invalid;
687 // Evaluate/Update TriggerMacro
688 TriggerMacroEval Macro_evalTriggerMacro( var_uint_t triggerMacroIndex )
690 // Lookup TriggerMacro
691 const TriggerMacro *macro = &TriggerMacroList[ triggerMacroIndex ];
692 TriggerMacroRecord *record = &TriggerMacroRecordList[ triggerMacroIndex ];
694 // Check if macro has finished and should be incremented sequence elements
695 if ( record->state == TriggerMacro_Release )
697 record->state = TriggerMacro_Waiting;
698 record->pos = record->pos + macro->guide[ record->pos ] * TriggerGuideSize + 1;
701 // Current Macro position
702 var_uint_t pos = record->pos;
704 // Length of the combo being processed
705 uint8_t comboLength = macro->guide[ pos ] * TriggerGuideSize;
707 // If no combo items are left, remove the TriggerMacro from the pending list
708 if ( comboLength == 0 )
710 return TriggerMacroEval_Remove;
713 // Check if this is a long Trigger Macro
714 uint8_t longMacro = Macro_isLongTriggerMacro( macro );
716 // Iterate through the items in the combo, voting the on the key state
717 // If any of the pressed keys do not match, fail the macro
719 // The macro is waiting for input when in the TriggerMacro_Waiting state
720 // Once all keys have been pressed/held (only those keys), entered TriggerMacro_Press state (passing)
721 // Transition to the next combo (if it exists) when a single key is released (TriggerMacro_Release state)
722 // On scan after position increment, change to TriggerMacro_Waiting state
723 // TODO Add support for system LED states (NumLock, CapsLock, etc.)
724 // TODO Add support for analog key states
725 // TODO Add support for 0x00 Key state (not pressing a key, not all that useful in general)
726 // TODO Add support for Press/Hold/Release differentiation when evaluating (not sure if useful)
727 TriggerMacroVote overallVote = TriggerMacroVote_Invalid;
728 for ( uint8_t comboItem = pos + 1; comboItem < pos + comboLength + 1; comboItem += TriggerGuideSize )
730 // Assign TriggerGuide element (key type, state and scancode)
731 TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ comboItem ]);
733 TriggerMacroVote vote = TriggerMacroVote_Invalid;
734 // Iterate through the key buffer, comparing to each key in the combo
735 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
737 // Lookup key information
738 TriggerGuide *keyInfo = ¯oTriggerListBuffer[ key ];
740 // If vote is a pass (>= 0x08, no more keys in the combo need to be looked at)
741 // Also mask all of the non-passing votes
743 ? Macro_evalLongTriggerMacroVote( keyInfo, guide )
744 : Macro_evalShortTriggerMacroVote( keyInfo, guide );
745 if ( vote >= TriggerMacroVote_Pass )
747 vote &= TriggerMacroVote_Release | TriggerMacroVote_PassRelease | TriggerMacroVote_Pass;
752 // If no pass vote was found after scanning all of the keys
753 // Fail the combo, if this is a short macro (long macros already will have a fail vote)
754 if ( !longMacro && vote < TriggerMacroVote_Pass )
755 vote |= TriggerMacroVote_Fail;
757 // After voting, append to overall vote
761 // If no pass vote was found after scanning the entire combo
762 // And this is the first position in the combo, just remove it (nothing important happened)
763 if ( longMacro && overallVote & TriggerMacroVote_DoNothingRelease && pos == 0 )
764 overallVote |= TriggerMacroVote_Fail;
766 // Decide new state of macro after voting
767 // Fail macro, remove from pending list
768 if ( overallVote & TriggerMacroVote_Fail )
770 return TriggerMacroEval_Remove;
772 // Do nothing, incorrect key is being held or released
773 else if ( overallVote & TriggerMacroVote_DoNothing && longMacro )
775 // Just doing nothing :)
777 // If ready for transition and in Press state, set to Waiting and increment combo position
778 // Position is incremented (and possibly remove the macro from the pending list) on the next iteration
779 else if ( overallVote & TriggerMacroVote_Release && record->state == TriggerMacro_Press )
781 record->state = TriggerMacro_Release;
783 // If this is the last combo in the sequence, remove from the pending list
784 if ( macro->guide[ record->pos + macro->guide[ record->pos ] * TriggerGuideSize + 1 ] == 0 )
785 return TriggerMacroEval_DoResultAndRemove;
787 // If passing and in Waiting state, set macro state to Press
788 else if ( overallVote & TriggerMacroVote_Pass
789 && ( record->state == TriggerMacro_Waiting || record->state == TriggerMacro_Press ) )
791 record->state = TriggerMacro_Press;
793 // If in press state, and this is the final combo, send request for ResultMacro
794 // Check to see if the result macro only has a single element
795 // If this result macro has more than 1 key, only send once
796 // TODO Add option to have long macro repeat rate
797 if ( macro->guide[ pos + comboLength + 1 ] == 0 )
799 // Long result macro (more than 1 combo)
800 if ( Macro_isLongResultMacro( &ResultMacroList[ macro->result ] ) )
802 // Only ever trigger result once, on press
803 if ( overallVote == TriggerMacroVote_Pass )
805 return TriggerMacroEval_DoResultAndRemove;
808 // Short result macro
811 // Only trigger result once, on press, if long trigger (more than 1 combo)
812 if ( Macro_isLongTriggerMacro( macro ) )
814 return TriggerMacroEval_DoResultAndRemove;
816 // Otherwise, trigger result continuously
819 return TriggerMacroEval_DoResult;
824 // Otherwise, just remove the macro on key release
825 // One more result has to be called to indicate to the ResultMacro that the key transitioned to the release state
826 else if ( overallVote & TriggerMacroVote_Release )
828 return TriggerMacroEval_DoResultAndRemove;
831 // If this is a short macro, just remove it
832 // The state can be rebuilt on the next iteration
834 return TriggerMacroEval_Remove;
836 return TriggerMacroEval_DoNothing;
840 // Evaluate/Update ResultMacro
841 inline ResultMacroEval Macro_evalResultMacro( var_uint_t resultMacroIndex )
843 // Lookup ResultMacro
844 const ResultMacro *macro = &ResultMacroList[ resultMacroIndex ];
845 ResultMacroRecord *record = &ResultMacroRecordList[ resultMacroIndex ];
847 // Current Macro position
848 var_uint_t pos = record->pos;
850 // Length of combo being processed
851 uint8_t comboLength = macro->guide[ pos ];
853 // Function Counter, used to keep track of the combo items processed
854 var_uint_t funcCount = 0;
856 // Combo Item Position within the guide
857 var_uint_t comboItem = pos + 1;
859 // Iterate through the Result Combo
860 while ( funcCount < comboLength )
862 // Assign TriggerGuide element (key type, state and scancode)
863 ResultGuide *guide = (ResultGuide*)(¯o->guide[ comboItem ]);
865 // Do lookup on capability function
866 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
869 capability( record->state, record->stateType, &guide->args );
871 // Increment counters
873 comboItem += ResultGuideSize( (ResultGuide*)(¯o->guide[ comboItem ]) );
876 // Move to next item in the sequence
877 record->pos = comboItem;
879 // If the ResultMacro is finished, remove
880 if ( macro->guide[ comboItem ] == 0 )
883 return ResultMacroEval_Remove;
886 // Otherwise leave the macro in the list
887 return ResultMacroEval_DoNothing;
891 // Update pending trigger list
892 inline void Macro_updateTriggerMacroPendingList()
894 // Iterate over the macroTriggerListBuffer to add any new Trigger Macros to the pending list
895 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
898 // TODO Analog Switches
899 // Only add TriggerMacro to pending list if key was pressed (not held, released or off)
900 if ( macroTriggerListBuffer[ key ].state == 0x00 && macroTriggerListBuffer[ key ].state != 0x01 )
904 // If this is a release case, indicate to layer lookup for possible latch expiry
905 uint8_t latch_expire = macroTriggerListBuffer[ key ].state == 0x03;
907 // Lookup Trigger List
908 nat_ptr_t *triggerList = Macro_layerLookup( ¯oTriggerListBuffer[ key ], latch_expire );
910 // Number of Triggers in list
911 nat_ptr_t triggerListSize = triggerList[0];
913 // Iterate over triggerList to see if any TriggerMacros need to be added
914 // First item is the number of items in the TriggerList
915 for ( var_uint_t macro = 1; macro < triggerListSize + 1; macro++ )
917 // Lookup trigger macro index
918 var_uint_t triggerMacroIndex = triggerList[ macro ];
920 // Iterate over macroTriggerMacroPendingList to see if any macro in the scancode's
921 // triggerList needs to be added
922 var_uint_t pending = 0;
923 for ( ; pending < macroTriggerMacroPendingListSize; pending++ )
925 // Stop scanning if the trigger macro index is found in the pending list
926 if ( macroTriggerMacroPendingList[ pending ] == triggerMacroIndex )
930 // If the triggerMacroIndex (macro) was not found in the macroTriggerMacroPendingList
931 // Add it to the list
932 if ( pending == macroTriggerMacroPendingListSize )
934 macroTriggerMacroPendingList[ macroTriggerMacroPendingListSize++ ] = triggerMacroIndex;
936 // Reset macro position
937 TriggerMacroRecordList[ triggerMacroIndex ].pos = 0;
938 TriggerMacroRecordList[ triggerMacroIndex ].state = TriggerMacro_Waiting;
945 // Macro Procesing Loop
946 // Called once per USB buffer send
947 inline void Macro_process()
949 #if defined(ConnectEnabled_define)
950 // Only compile in if a Connect node module is available
951 // If this is a interconnect slave node, send all scancodes to master node
952 if ( !Connect_master )
954 if ( macroTriggerListBufferSize > 0 )
957 printHex( macroTriggerListBufferSize );
959 //Connect_send_ScanCode( Connect_id, macroTriggerListBuffer, macroTriggerListBufferSize );
960 macroTriggerListBufferSize = 0;
966 // Only do one round of macro processing between Output Module timer sends
967 if ( USBKeys_Sent != 0 )
970 // If the pause flag is set, only process if the step counter is non-zero
971 if ( macroPauseMode )
973 if ( macroStepCounter == 0 )
976 // Proceed, decrementing the step counter
978 dbug_print("Macro Step");
981 // Update pending trigger list, before processing TriggerMacros
982 Macro_updateTriggerMacroPendingList();
984 // Tail pointer for macroTriggerMacroPendingList
985 // Macros must be explicitly re-added
986 var_uint_t macroTriggerMacroPendingListTail = 0;
988 // Iterate through the pending TriggerMacros, processing each of them
989 for ( var_uint_t macro = 0; macro < macroTriggerMacroPendingListSize; macro++ )
991 switch ( Macro_evalTriggerMacro( macroTriggerMacroPendingList[ macro ] ) )
993 // Trigger Result Macro (purposely falling through)
994 case TriggerMacroEval_DoResult:
995 // Append ResultMacro to PendingList
996 Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
999 macroTriggerMacroPendingList[ macroTriggerMacroPendingListTail++ ] = macroTriggerMacroPendingList[ macro ];
1002 // Trigger Result Macro and Remove (purposely falling through)
1003 case TriggerMacroEval_DoResultAndRemove:
1004 // Append ResultMacro to PendingList
1005 Macro_appendResultMacroToPendingList( &TriggerMacroList[ macroTriggerMacroPendingList[ macro ] ] );
1007 // Remove Macro from Pending List, nothing to do, removing by default
1008 case TriggerMacroEval_Remove:
1013 // Update the macroTriggerMacroPendingListSize with the tail pointer
1014 macroTriggerMacroPendingListSize = macroTriggerMacroPendingListTail;
1017 // Tail pointer for macroResultMacroPendingList
1018 // Macros must be explicitly re-added
1019 var_uint_t macroResultMacroPendingListTail = 0;
1021 // Iterate through the pending ResultMacros, processing each of them
1022 for ( var_uint_t macro = 0; macro < macroResultMacroPendingListSize; macro++ )
1024 switch ( Macro_evalResultMacro( macroResultMacroPendingList[ macro ] ) )
1026 // Re-add macros to pending list
1027 case ResultMacroEval_DoNothing:
1029 macroResultMacroPendingList[ macroResultMacroPendingListTail++ ] = macroResultMacroPendingList[ macro ];
1032 // Remove Macro from Pending List, nothing to do, removing by default
1033 case ResultMacroEval_Remove:
1038 // Update the macroResultMacroPendingListSize with the tail pointer
1039 macroResultMacroPendingListSize = macroResultMacroPendingListTail;
1041 // Signal buffer that we've used it
1042 Scan_finishedWithMacro( macroTriggerListBufferSize );
1044 // Reset TriggerList buffer
1045 macroTriggerListBufferSize = 0;
1047 // If Macro debug mode is set, clear the USB Buffer
1048 if ( macroDebugMode )
1050 USBKeys_Modifiers = 0;
1056 inline void Macro_setup()
1058 // Register Macro CLI dictionary
1059 CLI_registerDictionary( macroCLIDict, macroCLIDictName );
1061 // Disable Macro debug mode
1064 // Disable Macro pause flag
1067 // Set Macro step counter to zero
1068 macroStepCounter = 0;
1070 // Make sure macro trigger buffer is empty
1071 macroTriggerListBufferSize = 0;
1073 // Initialize TriggerMacro states
1074 for ( var_uint_t macro = 0; macro < TriggerMacroNum; macro++ )
1076 TriggerMacroRecordList[ macro ].pos = 0;
1077 TriggerMacroRecordList[ macro ].state = TriggerMacro_Waiting;
1080 // Initialize ResultMacro states
1081 for ( var_uint_t macro = 0; macro < ResultMacroNum; macro++ )
1083 ResultMacroRecordList[ macro ].pos = 0;
1084 ResultMacroRecordList[ macro ].state = 0;
1085 ResultMacroRecordList[ macro ].stateType = 0;
1090 // ----- CLI Command Functions -----
1092 void cliFunc_capList( char* args )
1095 info_msg("Capabilities List ");
1096 printHex( CapabilitiesNum );
1098 // Iterate through all of the capabilities and display them
1099 for ( var_uint_t cap = 0; cap < CapabilitiesNum; cap++ )
1105 // Display/Lookup Capability Name (utilize debug mode of capability)
1106 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
1107 capability( 0xFF, 0xFF, 0 );
1111 void cliFunc_capSelect( char* args )
1113 // Parse code from argument
1116 char* arg2Ptr = args;
1118 // Total number of args to scan (must do a lookup if a keyboard capability is selected)
1119 var_uint_t totalArgs = 2; // Always at least two args
1122 // Arguments used for keyboard capability function
1123 var_uint_t argSetCount = 0;
1124 uint8_t *argSet = (uint8_t*)args;
1127 for ( var_uint_t c = 0; argSetCount < totalArgs; c++ )
1130 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1132 // Stop processing args if no more are found
1133 // Extra arguments are ignored
1134 if ( *arg1Ptr == '\0' )
1137 // For the first argument, choose the capability
1138 if ( c == 0 ) switch ( arg1Ptr[0] )
1140 // Keyboard Capability
1142 // Determine capability index
1143 cap = numToInt( &arg1Ptr[1] );
1145 // Lookup the number of args
1146 totalArgs += CapabilitiesList[ cap ].argCount;
1150 // Because allocating memory isn't doable, and the argument count is arbitrary
1151 // The argument pointer is repurposed as the argument list (much smaller anyways)
1152 argSet[ argSetCount++ ] = (uint8_t)numToInt( arg1Ptr );
1154 // Once all the arguments are prepared, call the keyboard capability function
1155 if ( argSetCount == totalArgs )
1157 // Indicate that the capability was called
1162 printHex( argSet[0] );
1164 printHex( argSet[1] );
1166 printHex( argSet[2] );
1169 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ cap ].func);
1170 capability( argSet[0], argSet[1], &argSet[2] );
1175 void cliFunc_keyHold( char* args )
1177 // Parse codes from arguments
1180 char* arg2Ptr = args;
1186 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1188 // Stop processing args if no more are found
1189 if ( *arg1Ptr == '\0' )
1192 // Ignore non-Scancode numbers
1193 switch ( arg1Ptr[0] )
1197 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x02 ); // Hold scancode
1203 void cliFunc_keyPress( char* args )
1205 // Parse codes from arguments
1208 char* arg2Ptr = args;
1214 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1216 // Stop processing args if no more are found
1217 if ( *arg1Ptr == '\0' )
1220 // Ignore non-Scancode numbers
1221 switch ( arg1Ptr[0] )
1225 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x01 ); // Press scancode
1231 void cliFunc_keyRelease( char* args )
1233 // Parse codes from arguments
1236 char* arg2Ptr = args;
1242 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1244 // Stop processing args if no more are found
1245 if ( *arg1Ptr == '\0' )
1248 // Ignore non-Scancode numbers
1249 switch ( arg1Ptr[0] )
1253 Macro_keyState( (uint8_t)numToInt( &arg1Ptr[1] ), 0x03 ); // Release scancode
1259 void cliFunc_layerDebug( char *args )
1261 // Toggle layer debug mode
1262 layerDebugMode = layerDebugMode ? 0 : 1;
1265 info_msg("Layer Debug Mode: ");
1266 printInt8( layerDebugMode );
1269 void cliFunc_layerList( char* args )
1272 info_msg("Layer List");
1274 // Iterate through all of the layers and display them
1275 for ( uint16_t layer = 0; layer < LayerNum; layer++ )
1281 // Display layer name
1282 dPrint( (char*)LayerIndex[ layer ].name );
1286 print(" \033[1m(default)\033[0m");
1289 print( NL "\t\t Layer State: " );
1290 printHex( LayerState[ layer ] );
1292 // First -> Last Indices
1293 print(" First -> Last Indices: ");
1294 printHex( LayerIndex[ layer ].first );
1296 printHex( LayerIndex[ layer ].last );
1300 void cliFunc_layerState( char* args )
1302 // Parse codes from arguments
1305 char* arg2Ptr = args;
1310 // Process first two args
1311 for ( uint8_t c = 0; c < 2; c++ )
1314 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1316 // Stop processing args if no more are found
1317 if ( *arg1Ptr == '\0' )
1322 // First argument (e.g. L1)
1324 if ( arg1Ptr[0] != 'L' )
1327 arg1 = (uint8_t)numToInt( &arg1Ptr[1] );
1329 // Second argument (e.g. 4)
1331 arg2 = (uint8_t)numToInt( arg1Ptr );
1333 // Display operation (to indicate that it worked)
1335 info_msg("Setting Layer L");
1340 // Set the layer state
1341 LayerState[ arg1 ] = arg2;
1347 void cliFunc_macroDebug( char* args )
1349 // Toggle macro debug mode
1350 macroDebugMode = macroDebugMode ? 0 : 1;
1353 info_msg("Macro Debug Mode: ");
1354 printInt8( macroDebugMode );
1357 void cliFunc_macroList( char* args )
1359 // Show pending key events
1361 info_msg("Pending Key Events: ");
1362 printInt16( (uint16_t)macroTriggerListBufferSize );
1364 for ( uint8_t key = 0; key < macroTriggerListBufferSize; key++ )
1366 printHex( macroTriggerListBuffer[ key ].scanCode );
1370 // Show pending trigger macros
1372 info_msg("Pending Trigger Macros: ");
1373 printInt16( (uint16_t)macroTriggerMacroPendingListSize );
1375 for ( var_uint_t macro = 0; macro < macroTriggerMacroPendingListSize; macro++ )
1377 printHex( macroTriggerMacroPendingList[ macro ] );
1381 // Show pending result macros
1383 info_msg("Pending Result Macros: ");
1384 printInt16( (uint16_t)macroResultMacroPendingListSize );
1386 for ( var_uint_t macro = 0; macro < macroResultMacroPendingListSize; macro++ )
1388 printHex( macroResultMacroPendingList[ macro ] );
1392 // Show available trigger macro indices
1394 info_msg("Trigger Macros Range: T0 -> T");
1395 printInt16( (uint16_t)TriggerMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
1397 // Show available result macro indices
1399 info_msg("Result Macros Range: R0 -> R");
1400 printInt16( (uint16_t)ResultMacroNum - 1 ); // Hopefully large enough :P (can't assume 32-bit)
1402 // Show Trigger to Result Macro Links
1404 info_msg("Trigger : Result Macro Pairs");
1405 for ( var_uint_t macro = 0; macro < TriggerMacroNum; macro++ )
1409 printInt16( (uint16_t)macro ); // Hopefully large enough :P (can't assume 32-bit)
1411 printInt16( (uint16_t)TriggerMacroList[ macro ].result ); // Hopefully large enough :P (can't assume 32-bit)
1415 void cliFunc_macroProc( char* args )
1417 // Toggle macro pause mode
1418 macroPauseMode = macroPauseMode ? 0 : 1;
1421 info_msg("Macro Processing Mode: ");
1422 printInt8( macroPauseMode );
1425 void macroDebugShowTrigger( var_uint_t index )
1427 // Only proceed if the macro exists
1428 if ( index >= TriggerMacroNum )
1431 // Trigger Macro Show
1432 const TriggerMacro *macro = &TriggerMacroList[ index ];
1433 TriggerMacroRecord *record = &TriggerMacroRecordList[ index ];
1436 info_msg("Trigger Macro Index: ");
1437 printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
1440 // Read the comboLength for combo in the sequence (sequence of combos)
1442 uint8_t comboLength = macro->guide[ pos ];
1444 // Iterate through and interpret the guide
1445 while ( comboLength != 0 )
1447 // Initial position of the combo
1448 var_uint_t comboPos = ++pos;
1450 // Iterate through the combo
1451 while ( pos < comboLength * TriggerGuideSize + comboPos )
1453 // Assign TriggerGuide element (key type, state and scancode)
1454 TriggerGuide *guide = (TriggerGuide*)(¯o->guide[ pos ]);
1456 // Display guide information about trigger key
1457 printHex( guide->scanCode );
1459 printHex( guide->type );
1461 printHex( guide->state );
1463 // Increment position
1464 pos += TriggerGuideSize;
1466 // Only show combo separator if there are combos left in the sequence element
1467 if ( pos < comboLength * TriggerGuideSize + comboPos )
1471 // Read the next comboLength
1472 comboLength = macro->guide[ pos ];
1474 // Only show sequence separator if there is another combo to process
1475 if ( comboLength != 0 )
1479 // Display current position
1480 print( NL "Position: " );
1481 printInt16( (uint16_t)record->pos ); // Hopefully large enough :P (can't assume 32-bit)
1483 // Display result macro index
1484 print( NL "Result Macro Index: " );
1485 printInt16( (uint16_t)macro->result ); // Hopefully large enough :P (can't assume 32-bit)
1487 // Display trigger macro state
1488 print( NL "Trigger Macro State: " );
1489 switch ( record->state )
1491 case TriggerMacro_Press: print("Press"); break;
1492 case TriggerMacro_Release: print("Release"); break;
1493 case TriggerMacro_Waiting: print("Waiting"); break;
1497 void macroDebugShowResult( var_uint_t index )
1499 // Only proceed if the macro exists
1500 if ( index >= ResultMacroNum )
1503 // Trigger Macro Show
1504 const ResultMacro *macro = &ResultMacroList[ index ];
1505 ResultMacroRecord *record = &ResultMacroRecordList[ index ];
1508 info_msg("Result Macro Index: ");
1509 printInt16( (uint16_t)index ); // Hopefully large enough :P (can't assume 32-bit)
1512 // Read the comboLength for combo in the sequence (sequence of combos)
1514 uint8_t comboLength = macro->guide[ pos++ ];
1516 // Iterate through and interpret the guide
1517 while ( comboLength != 0 )
1519 // Function Counter, used to keep track of the combos processed
1520 var_uint_t funcCount = 0;
1522 // Iterate through the combo
1523 while ( funcCount < comboLength )
1525 // Assign TriggerGuide element (key type, state and scancode)
1526 ResultGuide *guide = (ResultGuide*)(¯o->guide[ pos ]);
1528 // Display Function Index
1529 printHex( guide->index );
1532 // Display Function Ptr Address
1533 printHex( (nat_ptr_t)CapabilitiesList[ guide->index ].func );
1536 // Display/Lookup Capability Name (utilize debug mode of capability)
1537 void (*capability)(uint8_t, uint8_t, uint8_t*) = (void(*)(uint8_t, uint8_t, uint8_t*))(CapabilitiesList[ guide->index ].func);
1538 capability( 0xFF, 0xFF, 0 );
1540 // Display Argument(s)
1542 for ( var_uint_t arg = 0; arg < CapabilitiesList[ guide->index ].argCount; arg++ )
1544 // Arguments are only 8 bit values
1545 printHex( (&guide->args)[ arg ] );
1547 // Only show arg separator if there are args left
1548 if ( arg + 1 < CapabilitiesList[ guide->index ].argCount )
1553 // Increment position
1554 pos += ResultGuideSize( guide );
1556 // Increment function count
1559 // Only show combo separator if there are combos left in the sequence element
1560 if ( funcCount < comboLength )
1564 // Read the next comboLength
1565 comboLength = macro->guide[ pos++ ];
1567 // Only show sequence separator if there is another combo to process
1568 if ( comboLength != 0 )
1572 // Display current position
1573 print( NL "Position: " );
1574 printInt16( (uint16_t)record->pos ); // Hopefully large enough :P (can't assume 32-bit)
1576 // Display final trigger state/type
1577 print( NL "Final Trigger State (State/Type): " );
1578 printHex( record->state );
1580 printHex( record->stateType );
1583 void cliFunc_macroShow( char* args )
1585 // Parse codes from arguments
1588 char* arg2Ptr = args;
1594 CLI_argumentIsolation( curArgs, &arg1Ptr, &arg2Ptr );
1596 // Stop processing args if no more are found
1597 if ( *arg1Ptr == '\0' )
1600 // Ignore invalid codes
1601 switch ( arg1Ptr[0] )
1603 // Indexed Trigger Macro
1605 macroDebugShowTrigger( numToInt( &arg1Ptr[1] ) );
1607 // Indexed Result Macro
1609 macroDebugShowResult( numToInt( &arg1Ptr[1] ) );
1615 void cliFunc_macroStep( char* args )
1617 // Parse number from argument
1618 // NOTE: Only first argument is used
1621 CLI_argumentIsolation( args, &arg1Ptr, &arg2Ptr );
1623 // Default to 1, if no argument given
1624 var_uint_t count = (var_uint_t)numToInt( arg1Ptr );
1629 // Set the macro step counter, negative int's are cast to uint
1630 macroStepCounter = count;