Macro/PartialMap/kll.h

   1 /* Copyright (C) 2014 by Jacob Alexander
   2  *
   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.
   7  *
   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.
  12  *
  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/>.
  15  */
  16
  17 #ifndef __kll_h
  18 #define __kll_h
  19
  20 // ----- Includes -----
  21
  22 // Project Includes
  23 #include <print.h>
  24 #include <scan_loop.h>
  25 #include <macro.h>
  26 #include <output_com.h>
  27
  28 // USB HID Keymap list
  29 #include <usb_hid.h>
  30
  31
  32
  33 // ----- Types -----
  34
  35 // - NOTE -
  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;
  43
  44 // - NOTE -
  45 // Native pointer length
  46 // This needs to be defined per microcontroller
  47 // e.g. mk20s  -> 32 bit
  48 //      atmega -> 16 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;
  53 #endif
  54
  55
  56
  57 // ----- Structs -----
  58
  59 // -- Result Macro
  60 // Defines the sequence of combinations to as the Result of Trigger Macro
  61 //
  62 // Capability + args per USB send
  63 // Default Args (always sent): key state/analog of last key
  64 // Combo Length of 0 signifies end of sequence
  65 //
  66 // ResultMacro.guide     -> [<combo length>|<capability index>|<arg1>|<argn>|<capability index>|...|<combo length>|...|0]
  67 // ResultMacro.pos       -> <current combo position>
  68 // ResultMacro.state     -> <last key state>
  69 // ResultMacro.stateType -> <last key state type>
  70
  71 // ResultMacro struct, one is created per ResultMacro, no duplicates
  72 typedef struct ResultMacro {
  73         const uint8_t *guide;
  74         var_uint_t pos;
  75         uint8_t  state;
  76         uint8_t  stateType;
  77 } ResultMacro;
  78
  79 // Guide, key element
  80 #define ResultGuideSize( guidePtr ) sizeof( ResultGuide ) - 1 + CapabilitiesList[ (guidePtr)->index ].argCount
  81 typedef struct ResultGuide {
  82         uint8_t index;
  83         uint8_t args; // This is used as an array pointer (but for packing purposes, must be 8 bit)
  84 } ResultGuide;
  85
  86
  87
  88 // -- Trigger Macro
  89 // Defines the sequence of combinations to Trigger a Result Macro
  90 // Key Types:
  91 //   * 0x00 Normal (Press/Hold/Release)
  92 //   * 0x01 LED State (On/Off)
  93 //   * 0x02 Analog (Threshold)
  94 //   * 0x03-0xFE Reserved
  95 //   * 0xFF Debug State
  96 //
  97 // Key State:
  98 //   * Off                - 0x00 (all flag states)
  99 //   * On                 - 0x01
 100 //   * Press/Hold/Release - 0x01/0x02/0x03
 101 //   * Threshold (Range)  - 0x01 (Released), 0x10 (Light press), 0xFF (Max press)
 102 //   * Debug              - 0xFF (Print capability name)
 103 //
 104 // Combo Length of 0 signifies end of sequence
 105 //
 106 // TriggerMacro.guide  -> [<combo length>|<key1 type>|<key1 state>|<key1>...<keyn type>|<keyn state>|<keyn>|<combo length>...|0]
 107 // TriggerMacro.result -> <index to result macro>
 108 // TriggerMacro.pos    -> <current combo position>
 109 // TriggerMacro.state  -> <status of the macro pos>
 110
 111 // TriggerMacro states
 112 typedef enum TriggerMacroState {
 113         TriggerMacro_Press,   // Combo in sequence is passing
 114         TriggerMacro_Release, // Move to next combo in sequence (or finish if at end of sequence)
 115         TriggerMacro_Waiting, // Awaiting user input
 116 } TriggerMacroState;
 117
 118 // TriggerMacro struct, one is created per TriggerMacro, no duplicates
 119 typedef struct TriggerMacro {
 120         const uint8_t *guide;
 121         var_uint_t result;
 122         var_uint_t pos;
 123         TriggerMacroState state;
 124 } TriggerMacro;
 125
 126 // Guide, key element
 127 #define TriggerGuideSize sizeof( TriggerGuide )
 128 typedef struct TriggerGuide {
 129         uint8_t type;
 130         uint8_t state;
 131         uint8_t scanCode;
 132 } TriggerGuide;
 133
 134
 135
 136 // ----- Capabilities -----
 137
 138 // Capability
 139 typedef struct Capability {
 140         void *func;
 141         uint8_t argCount;
 142 } Capability;
 143
 144 // Total Number of Capabilities
 145 #define CapabilitiesNum sizeof( CapabilitiesList ) / sizeof( Capability )
 146
 147
 148 // -- Result Macros
 149
 150 // Guide_RM / Define_RM Pair
 151 // Guide_RM( index ) = result;
 152 //  * index  - Result Macro index number
 153 //  * result - Result Macro guide (see ResultMacro)
 154 // Define_RM( index );
 155 //  * index  - Result Macro index number
 156 //  Must be used after Guide_RM
 157 #define Guide_RM( index ) const uint8_t rm##index##_guide[]
 158 #define Define_RM( index ) { rm##index##_guide, 0, 0, 0 }
 159
 160
 161 // -- Result Macro List
 162
 163 // Total number of result macros (rm's)
 164 // Used to create pending rm's table
 165 #define ResultMacroNum sizeof( ResultMacroList ) / sizeof( ResultMacro )
 166
 167
 168 // -- Trigger Macros
 169
 170 // Guide_TM / Define_TM Trigger Setup
 171 // Guide_TM( index ) = trigger;
 172 //  * index   - Trigger Macro index number
 173 //  * trigger - Trigger Macro guide (see TriggerMacro)
 174 // Define_TM( index, result );
 175 //  * index   - Trigger Macro index number
 176 //  * result  - Result Macro index number which is triggered by this Trigger Macro
 177 #define Guide_TM( index ) const uint8_t tm##index##_guide[]
 178 #define Define_TM( index, result ) { tm##index##_guide, result, 0, TriggerMacro_Waiting }
 179
 180
 181 // -- Trigger Macro List
 182
 183 // Total number of trigger macros (tm's)
 184 // Used to create pending tm's table
 185 #define TriggerMacroNum sizeof( TriggerMacroList ) / sizeof( TriggerMacro )
 186
 187
 188
 189 // ----- Trigger Maps -----
 190
 191 // Define_TL( layer, scanCode ) = triggerList;
 192 //  * layer       - basename of the layer
 193 //  * scanCode    - Hex value of the scanCode
 194 //  * triggerList - Trigger List (see Trigger Lists)
 195 #define Define_TL( layer, scanCode ) const nat_ptr_t layer##_tl_##scanCode[]
 196
 197
 198
 199 // ----- Layer Index -----
 200
 201 // Defines each map of trigger macro lists
 202 // Layer 0 is always the default map
 203 // Layer States:
 204 //   * Off   - 0x00
 205 //   * Shift - 0x01
 206 //   * Latch - 0x02
 207 //   * Lock  - 0x04
 208 //
 209 // Except for Off, all states an exist simultaneously for each layer
 210 // For example:
 211 // state -> 0x04 + 0x01 = 0x05 (Shift + Lock), which is effectively Off (0x00)
 212 //
 213 // Max defines the maximum number of keys in the map, maximum of 0xFF
 214 //  - Compiler calculates this
 215 //
 216 // The name is defined for cli debugging purposes (Null terminated string)
 217
 218 typedef struct Layer {
 219         const nat_ptr_t **triggerMap;
 220         const char *name;
 221         const uint8_t max;
 222         uint8_t state;
 223 } Layer;
 224
 225
 226 // Layer_IN( map, name );
 227 //  * map  - Trigger map
 228 //  * name - Name of the trigger map
 229 #define Layer_IN( map, name ) { map, name, sizeof( map ) / sizeof( nat_ptr_t ) - 1, 0 }
 230
 231 // Total number of layers
 232 #define LayerNum sizeof( LayerIndex ) / sizeof( Layer )
 233
 234
 235
 236 #endif // __kll_h
 237