// ----- Includes -----
-#include <print.h>
+// KLL Include
+#include <kll.h>
-// USB HID Keymap list
-#include <usb_hid.h>
+// ----- Capabilities -----
-// ----- Structs -----
-
-// -- Result Macro
-// Defines the sequence of combinations to as the Result of Trigger Macro
-//
-// Capability + args per USB send
-// Default Args (always sent): key state/analog of last key
-// Combo Length of 0 signifies end of sequence
-//
-// ResultMacro.guide -> [<combo length>|<function pointer>|<arg count>|<arg1>|<argn>|<function pointer>|...|<combo length>|...|0]
-// ResultMacro.pos -> <current combo position>
-// ResultMacro.state -> <last key state>
-// ResultMacro.stateType -> <last key state type>
-
-typedef struct ResultMacro {
- unsigned int *guide;
- unsigned int pos;
- uint8_t state;
- uint8_t stateType;
-} ResultMacro;
-
-
-// -- Trigger Macro
-// Defines the sequence of combinations to Trigger a Result Macro
-// Key Types:
-// * 0x00 Normal (Press/Hold/Release)
-// * 0x01 LED State (On/Off)
-// * 0x02 Analog (Threshold)
-// * 0x03-0xFF Reserved
-//
-// Flag State:
-// * Not processed - 0x00 (all flag states)
-// * On/Off - 0x01/0x02
-// * Press/Hold/Release - 0x01/0x02/0x03
-// * Threshold (Range) - 0x01 (Released), 0x10 (Light press), 0xFF (Max press)
-//
-// Combo Length of 0 signifies end of sequence
-//
-// TriggerMacro.guide -> [<combo length>|<key1 type>|<key1>...<keyn type>|<keyn>|<combo length>...|0]
-// TriggerMacro.state -> [<key1 flag>...<keyn flag>...]
-// TriggerMacro.result -> <pointer to result macro>
-// TriggerMacro.pos -> <current combo position>
-
-typedef struct TriggerMacro {
- uint8_t *guide;
- uint8_t *state;
- ResultMacro *result;
- unsigned int pos;
-} TriggerMacro;
-
-
+void debugPrint_capability( uint8_t state, uint8_t stateType, uint8_t *args )
+{
+ // Display capability name
+ if ( stateType == 0xFF && state == 0xFF )
+ {
+ print("debugPrint(arg)");
+ return;
+ }
-// ----- Macros -----
+ dbug_msg("Capability Print: ");
+ print(" statetype( ");
+ printHex( stateType );
+ print(" ) state ( ");
+ printHex( state );
+ print(" ) arg ( ");
+ printHex( args[0] );
+ print(" )");
+}
-#define debugPrint_cap( arg ) (unsigned int) debugPrint_capability, 1, arg
-void debugPrint_capability( uint8_t state, uint8_t stateType, uint8_t arg )
+void debugPrint2_capability( uint8_t state, uint8_t stateType, uint8_t *args )
{
+ // Display capability name
+ if ( stateType == 0xFF && state == 0xFF )
+ {
+ print("debugPrint2(arg1,arg2)");
+ return;
+ }
+
dbug_msg("Capability Print: ");
print(" statetype( ");
printHex( stateType );
print(" ) state ( ");
printHex( state );
- print(" ) arg ( ");
- printHex( arg );
- print( " )" NL );
+ print(" ) arg1 ( ");
+ printHex( args[0] );
+ print(" ) arg2 ( ");
+ printHex( args[1] );
+ print(" )");
}
+// Indexed Capabilities Table
+// TODO Generated from .kll files in each module
+const Capability CapabilitiesList[] = {
+ { debugPrint_capability, 1 },
+ { debugPrint2_capability, 2 },
+ { Macro_layerStateToggle_capability, sizeof(unsigned int) + 1 },
+ { Output_usbCodeSend_capability, 1 },
+};
+
// -- Result Macros
-// Guide_RM / Define_RM Pair
-// Guide_RM( name ) = result;
-// * name - Result Macro name
-// * result - Result Macro guide (see ResultMacro)
-// Define_RM( name );
-// * name - Result Macro name
-// Must be used after Guide_RM
-#define Guide_RM( name ) \
- static unsigned int name##_guide[]
-#define Define_RM( name ) \
- ResultMacro name = { name##_guide, 0, 0, 0 }
+Guide_RM( 0 ) = { 1, 0, 0xDA, 0 };
+Guide_RM( 1 ) = { 1, 0, 0xBE, 1, 0, 0xEF, 0 };
+Guide_RM( 2 ) = { 2, 0, 0xFA, 0, 0xAD, 0 };
+Guide_RM( 3 ) = { 1, 1, 0xCA, 0xFE, 0 };
+Guide_RM( 4 ) = { 1, 0, 0xDA, 0 };
-Guide_RM( rm1 ) = { 1, debugPrint_cap( 0xBA ), 0 };
-Define_RM( rm1 );
+// -- Result Macro List
-// -- Trigger Macros
+// Indexed Table of Result Macros
+ResultMacro ResultMacroList[] = {
+ Define_RM( 0 ),
+ Define_RM( 1 ),
+ Define_RM( 2 ),
+ Define_RM( 3 ),
+ Define_RM( 4 ),
+};
-// NOTES:
-// Compiler must calculate number of combos per macro to define the size of the state array
-// ( sizeof( macro_guide ) - ( <number of combos> + 1 ) ) / 2 = <length of guide array>
-#define GuideSize( name, combos ) ( sizeof( name##_guide ) - ( combos + 1 ) ) / 2
-// Guide_TM / Define_TM Pair
-// Guide_TM( name ) = trigger;
-// * name - Trigger Macro name
-// * trigger - Trigger Macro guide (see TriggerMacro)
-// Define_TM( name, result );
-// * name - Trigger Macro name
-// * result - Result Macro which is triggered by this Trigger Macro
-#define Guide_TM( name ) static uint8_t name##_guide[]
-#define Define_TM( name, result ) \
- uint8_t name##_state[ GuideSize( name, 1 ) ] = { 0 }; \
- TriggerMacro name = { name##_guide, name##_state, &result, 0 }
-#define tm( number ) (unsigned int)&tm##number
+// -- Trigger Macros
-Guide_TM( tm1 ) = { 1, 0x00, 0x73, 0 };
-Define_TM( tm1, rm1 );
+Guide_TM( 0 ) = { 1, 0x00, 0x01, 0x73, 0 };
+Guide_TM( 1 ) = { 1, 0x00, 0x01, 0x73, 1, 0x00, 0x01, 0x75, 0 };
+Guide_TM( 2 ) = { 2, 0x00, 0x01, 0x73, 0x00, 0x01, 0x74, 0 };
+Guide_TM( 3 ) = { 1, 0x00, 0x01, 0x76, 0 };
+Guide_TM( 4 ) = { 1, 0x00, 0x01, 0x77, 0 };
+Guide_TM( 5 ) = { 1, 0x00, 0x01, 0x2E, 0 };
+Guide_TM( 6 ) = { 1, 0x00, 0x01, 0x2D, 0 };
+Guide_TM( 7 ) = { 1, 0x00, 0x01, 0x2C, 0 };
+Guide_TM( 8 ) = { 2, 0x00, 0x01, 0x20, 0x00, 0x01, 0x21, 0 };
+Guide_TM( 9 ) = { 1, 0x00, 0x01, 0x20, 1, 0x00, 0x01, 0x22, 0 };
+Guide_TM( 10 ) = { 1, 0x00, 0x01, 0x2B, 0 };
+
+
+// -- Trigger Macro List
+
+// Indexed Table of Trigger Macros
+TriggerMacro TriggerMacroList[] = {
+ Define_TM( 0, 0 ),
+ Define_TM( 1, 1 ),
+ Define_TM( 2, 2 ),
+ Define_TM( 3, 3 ),
+ Define_TM( 4, 0 ),
+ Define_TM( 5, 0 ),
+ Define_TM( 6, 1 ),
+ Define_TM( 7, 2 ),
+ Define_TM( 8, 0 ),
+ Define_TM( 9, 0 ),
+ Define_TM( 10, 4 ),
+};
// ----- Trigger Maps -----
-// Define_TL( layer, scanCode ) = triggerList;
-// * layer - basename of the layer
-// * scanCode - Hex value of the scanCode
-// * triggerList - Trigger List (see Trigger Lists)
-#define Define_TL( layer, scanCode ) static unsigned int layer##_tl_##scanCode[]
+// MaxScanCode
+// - This is retrieved from the KLL configuration
+// - Should be corollated with the max scan code in the scan module
+// - Maximum value is 0x100 (0x0 to 0xFF)
+// - Increasing it beyond the keyboard's capabilities is just a waste of ram...
+#define MaxScanCode 0x100
// -- Trigger Lists
//
Define_TL( default, 0x1D ) = { 0 };
Define_TL( default, 0x1E ) = { 0 };
Define_TL( default, 0x1F ) = { 0 };
-Define_TL( default, 0x20 ) = { 0 };
-Define_TL( default, 0x21 ) = { 0 };
-Define_TL( default, 0x22 ) = { 0 };
+Define_TL( default, 0x20 ) = { 2, 8, 9 };
+Define_TL( default, 0x21 ) = { 1, 8 };
+Define_TL( default, 0x22 ) = { 1, 9 };
Define_TL( default, 0x23 ) = { 0 };
Define_TL( default, 0x24 ) = { 0 };
Define_TL( default, 0x25 ) = { 0 };
Define_TL( default, 0x28 ) = { 0 };
Define_TL( default, 0x29 ) = { 0 };
Define_TL( default, 0x2A ) = { 0 };
-Define_TL( default, 0x2B ) = { 0 };
-Define_TL( default, 0x2C ) = { 0 };
-Define_TL( default, 0x2D ) = { 0 };
-Define_TL( default, 0x2E ) = { 0 };
+Define_TL( default, 0x2B ) = { 1, 10 };
+Define_TL( default, 0x2C ) = { 1, 7 };
+Define_TL( default, 0x2D ) = { 1, 6 };
+Define_TL( default, 0x2E ) = { 1, 5 };
Define_TL( default, 0x2F ) = { 0 };
Define_TL( default, 0x30 ) = { 0 };
Define_TL( default, 0x31 ) = { 0 };
Define_TL( default, 0x70 ) = { 0 };
Define_TL( default, 0x71 ) = { 0 };
Define_TL( default, 0x72 ) = { 0 };
-Define_TL( default, 0x73 ) = { 1, tm(1) };
-Define_TL( default, 0x74 ) = { 0 };
-Define_TL( default, 0x75 ) = { 0 };
-Define_TL( default, 0x76 ) = { 0 };
-Define_TL( default, 0x77 ) = { 0 };
+Define_TL( default, 0x73 ) = { 3, 0, 1, 2 };
+Define_TL( default, 0x74 ) = { 1, 2 };
+Define_TL( default, 0x75 ) = { 1, 1 };
+Define_TL( default, 0x76 ) = { 1, 3 };
+Define_TL( default, 0x77 ) = { 1, 4 };
Define_TL( default, 0x78 ) = { 0 };
Define_TL( default, 0x79 ) = { 0 };
Define_TL( default, 0x7A ) = { 0 };
// myname Layer
-// TODO
+Define_TL( myname, 0x05 ) = { 0 };
+Define_TL( myname, 0x06 ) = { 0 };
+Define_TL( myname, 0x07 ) = { 0 };
// myname2 Layer
-// TODO
+Define_TL( myname2, 0x04 ) = { 0 };
+Define_TL( myname2, 0x05 ) = { 0 };
+Define_TL( myname2, 0x06 ) = { 0 };
// -- ScanCode Indexed Maps
// -
// Default Map for ScanCode Lookup
-static unsigned int *default_scanMap[] = {
+const unsigned int *default_scanMap[] = {
default_tl_0x00, default_tl_0x01, default_tl_0x02, default_tl_0x03, default_tl_0x04, default_tl_0x05, default_tl_0x06, default_tl_0x07, default_tl_0x08, default_tl_0x09, default_tl_0x0A, default_tl_0x0B, default_tl_0x0C, default_tl_0x0D, default_tl_0x0E, default_tl_0x0F, default_tl_0x10, default_tl_0x11, default_tl_0x12, default_tl_0x13, default_tl_0x14, default_tl_0x15, default_tl_0x16, default_tl_0x17, default_tl_0x18, default_tl_0x19, default_tl_0x1A, default_tl_0x1B, default_tl_0x1C, default_tl_0x1D, default_tl_0x1E, default_tl_0x1F, default_tl_0x20, default_tl_0x21, default_tl_0x22, default_tl_0x23, default_tl_0x24, default_tl_0x25, default_tl_0x26, default_tl_0x27, default_tl_0x28, default_tl_0x29, default_tl_0x2A, default_tl_0x2B, default_tl_0x2C, default_tl_0x2D, default_tl_0x2E, default_tl_0x2F, default_tl_0x30, default_tl_0x31, default_tl_0x32, default_tl_0x33, default_tl_0x34, default_tl_0x35, default_tl_0x36, default_tl_0x37, default_tl_0x38, default_tl_0x39, default_tl_0x3A, default_tl_0x3B, default_tl_0x3C, default_tl_0x3D, default_tl_0x3E, default_tl_0x3F, default_tl_0x40, default_tl_0x41, default_tl_0x42, default_tl_0x43, default_tl_0x44, default_tl_0x45, default_tl_0x46, default_tl_0x47, default_tl_0x48, default_tl_0x49, default_tl_0x4A, default_tl_0x4B, default_tl_0x4C, default_tl_0x4D, default_tl_0x4E, default_tl_0x4F, default_tl_0x50, default_tl_0x51, default_tl_0x52, default_tl_0x53, default_tl_0x54, default_tl_0x55, default_tl_0x56, default_tl_0x57, default_tl_0x58, default_tl_0x59, default_tl_0x5A, default_tl_0x5B, default_tl_0x5C, default_tl_0x5D, default_tl_0x5E, default_tl_0x5F, default_tl_0x60, default_tl_0x61, default_tl_0x62, default_tl_0x63, default_tl_0x64, default_tl_0x65, default_tl_0x66, default_tl_0x67, default_tl_0x68, default_tl_0x69, default_tl_0x6A, default_tl_0x6B, default_tl_0x6C, default_tl_0x6D, default_tl_0x6E, default_tl_0x6F, default_tl_0x70, default_tl_0x71, default_tl_0x72, default_tl_0x73, default_tl_0x74, default_tl_0x75, default_tl_0x76, default_tl_0x77, default_tl_0x78, default_tl_0x79, default_tl_0x7A, default_tl_0x7B, default_tl_0x7C, default_tl_0x7D, default_tl_0x7E, default_tl_0x7F, default_tl_0x80, default_tl_0x81, default_tl_0x82, default_tl_0x83, default_tl_0x84, default_tl_0x85, default_tl_0x86, default_tl_0x87, default_tl_0x88, default_tl_0x89, default_tl_0x8A, default_tl_0x8B, default_tl_0x8C, default_tl_0x8D, default_tl_0x8E, default_tl_0x8F, default_tl_0x90, default_tl_0x91, default_tl_0x92, default_tl_0x93, default_tl_0x94, default_tl_0x95, default_tl_0x96, default_tl_0x97, default_tl_0x98, default_tl_0x99, default_tl_0x9A, default_tl_0x9B, default_tl_0x9C, default_tl_0x9D, default_tl_0x9E, default_tl_0x9F, default_tl_0xA0, default_tl_0xA1, default_tl_0xA2, default_tl_0xA3, default_tl_0xA4, default_tl_0xA5, default_tl_0xA6, default_tl_0xA7, default_tl_0xA8, default_tl_0xA9, default_tl_0xAA, default_tl_0xAB, default_tl_0xAC, default_tl_0xAD, default_tl_0xAE, default_tl_0xAF, default_tl_0xB0, default_tl_0xB1, default_tl_0xB2, default_tl_0xB3, default_tl_0xB4, default_tl_0xB5, default_tl_0xB6, default_tl_0xB7, default_tl_0xB8, default_tl_0xB9, default_tl_0xBA, default_tl_0xBB, default_tl_0xBC, default_tl_0xBD, default_tl_0xBE, default_tl_0xBF, default_tl_0xC0, default_tl_0xC1, default_tl_0xC2, default_tl_0xC3, default_tl_0xC4, default_tl_0xC5, default_tl_0xC6, default_tl_0xC7, default_tl_0xC8, default_tl_0xC9, default_tl_0xCA, default_tl_0xCB, default_tl_0xCC, default_tl_0xCD, default_tl_0xCE, default_tl_0xCF, default_tl_0xD0, default_tl_0xD1, default_tl_0xD2, default_tl_0xD3, default_tl_0xD4, default_tl_0xD5, default_tl_0xD6, default_tl_0xD7, default_tl_0xD8, default_tl_0xD9, default_tl_0xDA, default_tl_0xDB, default_tl_0xDC, default_tl_0xDD, default_tl_0xDE, default_tl_0xDF, default_tl_0xE0, default_tl_0xE1, default_tl_0xE2, default_tl_0xE3, default_tl_0xE4, default_tl_0xE5, default_tl_0xE6, default_tl_0xE7, default_tl_0xE8, default_tl_0xE9, default_tl_0xEA, default_tl_0xEB, default_tl_0xEC, default_tl_0xED, default_tl_0xEE, default_tl_0xEF, default_tl_0xF0, default_tl_0xF1, default_tl_0xF2, default_tl_0xF3, default_tl_0xF4, default_tl_0xF5, default_tl_0xF6, default_tl_0xF7, default_tl_0xF8, default_tl_0xF9, default_tl_0xFA, default_tl_0xFB, default_tl_0xFC, default_tl_0xFD, default_tl_0xFE, default_tl_0xFF,
};
// Layer <name> for ScanCode Lookup
-static unsigned int myname_scanMap[] = {
+const unsigned int *myname_scanMap[] = {
+0, 0, 0, 0, myname_tl_0x05, myname_tl_0x06, myname_tl_0x07
};
// Layer <name> for ScanCode Lookup
-static unsigned int myname2_scanMap[] = {
+const unsigned int *myname2_scanMap[] = {
+0, 0, 0, myname2_tl_0x04, myname2_tl_0x05, myname2_tl_0x06
};
-// ----- Result Maps -----
+// ----- Layer Index -----
+
+// -- Layer Index List
+//
+// Index 0: Default map
+// Index n: Additional layers
+Layer LayerIndex[] = {
+ Layer_IN( default_scanMap, "DefaultMap" ),
+ Layer_IN( myname_scanMap, "myname" ),
+ Layer_IN( myname2_scanMap, "myname2" ),
+};