1 /* Copyright (C) 2014 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/>.
20 // ----- Includes -----
24 #include <scan_loop.h>
26 #include <output_com.h>
28 // USB HID Keymap list
36 // It is possible to change the maximum state and indexing positions of the state machine.
37 // This usually affects the SRAM usage quite a bit, so it can be used to fit the code on smaller uCs
38 // Or to allow for nearly infinite states.
39 // TODO Make selectable from layout variable
40 //typedef uint32_t var_uint_t;
41 //typedef uint16_t var_uint_t;
42 typedef uint8_t var_uint_t;
45 // Native pointer length
46 // This needs to be defined per microcontroller
47 // e.g. mk20s -> 32 bit
49 #if defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) // ARM
50 typedef uint32_t nat_ptr_t;
51 #elif defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
52 typedef uint16_t nat_ptr_t;
57 // ----- Structs -----
60 // Defines the sequence of combinations to as the Result of Trigger Macro
61 // For RAM optimization reasons, ResultMacro has been split into ResultMacro and ResultMacroRecord structures
63 // Capability + args per USB send
64 // Default Args (always sent): key state/analog of last key
65 // Combo Length of 0 signifies end of sequence
67 // ResultMacro.guide -> [<combo length>|<capability index>|<arg1>|<argn>|<capability index>|...|<combo length>|...|0]
69 // ResultMacroRecord.pos -> <current combo position>
70 // ResultMacroRecord.state -> <last key state>
71 // ResultMacroRecord.stateType -> <last key state type>
73 // ResultMacro struct, one is created per ResultMacro, no duplicates
74 typedef struct ResultMacro {
78 typedef struct ResultMacroRecord {
85 #define ResultGuideSize( guidePtr ) sizeof( ResultGuide ) - 1 + CapabilitiesList[ (guidePtr)->index ].argCount
86 typedef struct ResultGuide {
88 uint8_t args; // This is used as an array pointer (but for packing purposes, must be 8 bit)
94 // Defines the sequence of combinations to Trigger a Result Macro
95 // For RAM optimization reasons TriggerMacro has been split into TriggerMacro and TriggerMacroRecord
97 // * 0x00 Normal (Press/Hold/Release)
98 // * 0x01 LED State (On/Off)
99 // * 0x02 Analog (Threshold)
100 // * 0x03-0xFE Reserved
101 // * 0xFF Debug State
104 // * Off - 0x00 (all flag states)
106 // * Press/Hold/Release - 0x01/0x02/0x03
107 // * Threshold (Range) - 0x01 (Released), 0x10 (Light press), 0xFF (Max press)
108 // * Debug - 0xFF (Print capability name)
110 // Combo Length of 0 signifies end of sequence
112 // TriggerMacro.guide -> [<combo length>|<key1 type>|<key1 state>|<key1>...<keyn type>|<keyn state>|<keyn>|<combo length>...|0]
113 // TriggerMacro.result -> <index to result macro>
115 // TriggerMacroRecord.pos -> <current combo position>
116 // TriggerMacroRecord.state -> <status of the macro pos>
118 // TriggerMacro states
119 typedef enum TriggerMacroState {
120 TriggerMacro_Press, // Combo in sequence is passing
121 TriggerMacro_Release, // Move to next combo in sequence (or finish if at end of sequence)
122 TriggerMacro_Waiting, // Awaiting user input
125 // TriggerMacro struct, one is created per TriggerMacro, no duplicates
126 typedef struct TriggerMacro {
127 const uint8_t *guide;
128 const var_uint_t result;
131 typedef struct TriggerMacroRecord {
133 TriggerMacroState state;
134 } TriggerMacroRecord;
136 // Guide, key element
137 #define TriggerGuideSize sizeof( TriggerGuide )
138 typedef struct TriggerGuide {
146 // ----- Capabilities -----
149 typedef struct Capability {
151 const uint8_t argCount;
154 // Total Number of Capabilities
155 #define CapabilitiesNum sizeof( CapabilitiesList ) / sizeof( Capability )
160 // Guide_RM / Define_RM Pair
161 // Guide_RM( index ) = result;
162 // * index - Result Macro index number
163 // * result - Result Macro guide (see ResultMacro)
164 // Define_RM( index );
165 // * index - Result Macro index number
166 // Must be used after Guide_RM
167 #define Guide_RM( index ) const uint8_t rm##index##_guide[]
168 #define Define_RM( index ) { rm##index##_guide }
171 // -- Result Macro List
173 // Total number of result macros (rm's)
174 // Used to create pending rm's table
175 #define ResultMacroNum sizeof( ResultMacroList ) / sizeof( ResultMacro )
180 // Guide_TM / Define_TM Trigger Setup
181 // Guide_TM( index ) = trigger;
182 // * index - Trigger Macro index number
183 // * trigger - Trigger Macro guide (see TriggerMacro)
184 // Define_TM( index, result );
185 // * index - Trigger Macro index number
186 // * result - Result Macro index number which is triggered by this Trigger Macro
187 #define Guide_TM( index ) const uint8_t tm##index##_guide[]
188 #define Define_TM( index, result ) { tm##index##_guide, result }
191 // -- Trigger Macro List
193 // Total number of trigger macros (tm's)
194 // Used to create pending tm's table
195 #define TriggerMacroNum sizeof( TriggerMacroList ) / sizeof( TriggerMacro )
199 // ----- Trigger Maps -----
201 // Define_TL( layer, scanCode ) = triggerList;
202 // * layer - basename of the layer
203 // * scanCode - Hex value of the scanCode
204 // * triggerList - Trigger List (see Trigger Lists)
205 #define Define_TL( layer, scanCode ) const nat_ptr_t layer##_tl_##scanCode[]
209 // ----- Layer Index -----
211 // Defines each map of trigger macro lists
212 // Layer 0 is always the default map
218 // Layer states are stored in the LayerState array
220 // Except for Off, all states an exist simultaneously for each layer
222 // state -> 0x04 + 0x01 = 0x05 (Shift + Lock), which is effectively Off (0x00)
224 // First defines the first used scan code (most keyboards start at 0, some start higher e.g. 0x40)
225 // - Compiler calculates this
227 // Last defines the last scan code used (helps reduce RAM usage)
229 // The name is defined for cli debugging purposes (Null terminated string)
231 typedef struct Layer {
232 const nat_ptr_t **triggerMap;
238 // Layer_IN( map, name, first );
239 // * map - Trigger map
240 // * name - Name of the trigger map
241 // * first - First scan code used (most keyboards start at 0, some start higher e.g. 0x40)
242 #define Layer_IN( map, name, first ) { map, name, first, sizeof( map ) / sizeof( nat_ptr_t ) - 1 + first }
244 // Total number of layers
245 #define LayerNum sizeof( LayerIndex ) / sizeof( Layer )