123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284 |
- /* Copyright (C) 2014 by Jacob Alexander
- *
- * 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.
- *
- * 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.
- *
- * You should have received a copy of the GNU General Public License
- * along with this file. If not, see <http://www.gnu.org/licenses/>.
- */
-
- #ifndef __kll_h
- #define __kll_h
-
- // ----- Includes -----
-
- // KLL Generated Defines
- #include <kll_defs.h>
-
- // Project Includes
- #include <print.h>
- #include <scan_loop.h>
- #include <macro.h>
- #include <output_com.h>
-
- // USB HID Keymap list
- #include <usb_hid.h>
-
-
-
- // ----- Types -----
-
- // - NOTE -
- // It is possible to change the maximum state and indexing positions of the state machine.
- // This usually affects the SRAM usage quite a bit, so it can be used to fit the code on smaller uCs
- // Or to allow for nearly infinite states.
- #if StateWordSize_define == 32
- typedef uint32_t var_uint_t;
- #elif StateWordSize_define == 16
- typedef uint16_t var_uint_t;
- #elif StateWordSize_define == 8
- typedef uint8_t var_uint_t;
- #else
- #error "Invalid StateWordSize, possible values: 32, 16 and 8."
- #endif
-
- // - NOTE -
- // Native pointer length
- // This needs to be defined per microcontroller
- // e.g. mk20s -> 32 bit
- // atmega -> 16 bit
- #if defined(_mk20dx128_) || defined(_mk20dx128vlf5_) || defined(_mk20dx256_) || defined(_mk20dx256vlh7_) // ARM
- typedef uint32_t nat_ptr_t;
- #elif defined(_at90usb162_) || defined(_atmega32u4_) || defined(_at90usb646_) || defined(_at90usb1286_) // AVR
- typedef uint16_t nat_ptr_t;
- #endif
-
-
-
- // ----- Structs -----
-
- // -- Macro Type
- // Defines what type of Macro the struct defines
- // Always the first field
- typedef enum MacroType {
- MacroType_Normal, // Sequence of Combos
- MacroType_Simple, // Single combination (no state required)
- } MacroType;
-
-
- // -- Result Macro
- // Defines the sequence of combinations to as the Result of Trigger Macro
- // For RAM optimization reasons, ResultMacro has been split into ResultMacro and ResultMacroRecord structures
- //
- // Capability + args per USB send
- // Default Args (always sent): key state/analog of last key
- // Combo Length of 0 signifies end of sequence
- //
- // ResultMacro.type -> <Type of macro>
- // ResultMacro.guide -> [<combo length>|<capability index>|<arg1>|<argn>|<capability index>|...|<combo length>|...|0]
- //
- // ResultMacroRecord.pos -> <current combo position>
- // ResultMacroRecord.state -> <last key state>
- // ResultMacroRecord.stateType -> <last key state type>
-
- // ResultMacroRecord struct, one is created per ResultMacro, no duplicates, if a MacroType_Normal
- typedef struct ResultMacroRecord {
- var_uint_t pos;
- uint8_t state;
- uint8_t stateType;
- } ResultMacroRecord;
-
- // ResultMacro struct, one is created per ResultMacro, no duplicates
- typedef const struct ResultMacro {
- const MacroType type;
- const uint8_t *guide;
- ResultMacroRecord *record;
- } ResultMacro;
-
- // Guide, key element
- #define ResultGuideSize( guidePtr ) sizeof( ResultGuide ) - 1 + CapabilitiesList[ (guidePtr)->index ].argCount
- typedef struct ResultGuide {
- uint8_t index;
- uint8_t args; // This is used as an array pointer (but for packing purposes, must be 8 bit)
- } ResultGuide;
-
-
-
- // -- Trigger Macro
- // Defines the sequence of combinations to Trigger a Result Macro
- // For RAM optimization reasons TriggerMacro has been split into TriggerMacro and TriggerMacroRecord
- // Key Types:
- // * 0x00 Normal (Press/Hold/Release)
- // * 0x01 LED State (On/Off)
- // * 0x02 Analog (Threshold)
- // * 0x03-0xFE Reserved
- // * 0xFF Debug State
- //
- // Key State:
- // * Off - 0x00 (all flag states)
- // * On - 0x01
- // * Press/Hold/Release - 0x01/0x02/0x03
- // * Threshold (Range) - 0x01 (Released), 0x10 (Light press), 0xFF (Max press)
- // * Debug - 0xFF (Print capability name)
- //
- // Combo Length of 0 signifies end of sequence
- //
- // TriggerMacro.type -> <Type of macro>
- // TriggerMacro.guide -> [<combo length>|<key1 type>|<key1 state>|<key1>...<keyn type>|<keyn state>|<keyn>|<combo length>...|0]
- // TriggerMacro.result -> <index to result macro>
- //
- // TriggerMacroRecord.pos -> <current combo position>
- // TriggerMacroRecord.state -> <status of the macro pos>
-
- // TriggerMacro states
- typedef enum TriggerMacroState {
- TriggerMacro_Press, // Combo in sequence is passing
- TriggerMacro_Release, // Move to next combo in sequence (or finish if at end of sequence)
- TriggerMacro_Waiting, // Awaiting user input
- } TriggerMacroState;
-
- // TriggerMacroRecord struct, one is created per TriggerMacro, no duplicates, if a MacroType_Normal
- typedef struct TriggerMacroRecord {
- var_uint_t pos;
- TriggerMacroState state;
- } TriggerMacroRecord;
-
- // TriggerMacro struct, one is created per TriggerMacro, no duplicates
- typedef const struct TriggerMacro {
- const MacroType type;
- const uint8_t *guide;
- const var_uint_t result;
- TriggerMacroRecord *record;
- } TriggerMacro;
-
- // Guide, key element
- #define TriggerGuideSize sizeof( TriggerGuide )
- typedef struct TriggerGuide {
- uint8_t type;
- uint8_t state;
- uint8_t scanCode;
- } TriggerGuide;
-
-
-
- // ----- Capabilities -----
-
- // Capability
- typedef struct Capability {
- const void *func;
- const uint8_t argCount;
- } Capability;
-
- // Total Number of Capabilities
- #define CapabilitiesNum sizeof( CapabilitiesList ) / sizeof( Capability )
-
-
- // -- Result Macros
-
- // Guide_RM / Record_RM / Define_RM
- // Guide_RM( index ) = result;
- // * index - Result Macro index number
- // * result - Result Macro guide (see ResultMacro)
- // Record_RM( index );
- // * index - Result Macro index number
- // Define_RM( index );
- // * index - Result Macro index number
- // Simple macros do not have a record
- // Must be used after Guide_RM and Record_RM
- #define Guide_RM( index ) const uint8_t rm##index##_guide[]
- #define Record_RM( index ) ResultMacroRecord rm##index##_record
- #define Define_RM_Normal( index ) { MacroType_Normal, rm##index##_guide, &rm##index##_record }
- #define Define_RM_Simple( index ) { MacroType_Simple, rm##index##_guide, 0 }
-
-
- // -- Result Macro List
-
- // Total number of result macros (rm's)
- // Used to create pending rm's table
- #define ResultMacroNum sizeof( ResultMacroList ) / sizeof( ResultMacro )
-
-
- // -- Trigger Macros
-
- // Guide_TM / Record_TM / Define_TM Trigger Setup
- // Guide_TM( index ) = trigger;
- // * index - Trigger Macro index number
- // * trigger - Trigger Macro guide (see TriggerMacro)
- // Record_TM( index );
- // * index - Trigger Macro index number
- // Define_TM( index, result );
- // * index - Trigger Macro index number
- // * result - Result Macro index number which is triggered by this Trigger Macro
- #define Guide_TM( index ) const uint8_t tm##index##_guide[]
- #define Record_TM( index ) TriggerMacroRecord tm##index##_record
- #define Define_TM_Normal( index, result ) { MacroType_Normal, tm##index##_guide, result, &tm##index##_record }
- #define Define_TM_Simple( index, result ) { MacroType_Simple, tm##index##_guide, result, 0 }
-
-
- // -- Trigger Macro List
-
- // Total number of trigger macros (tm's)
- // Used to create pending tm's table
- #define TriggerMacroNum sizeof( TriggerMacroList ) / sizeof( TriggerMacro )
-
-
-
- // ----- 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 ) const nat_ptr_t layer##_tl_##scanCode[]
-
-
-
- // ----- Layer Index -----
-
- // Defines each map of trigger macro lists
- // Layer 0 is always the default map
- // Layer States:
- // * Off - 0x00
- // * Shift - 0x01
- // * Latch - 0x02
- // * Lock - 0x04
- // Layer states are stored in the LayerState array
- //
- // Except for Off, all states an exist simultaneously for each layer
- // For example:
- // state -> 0x04 + 0x01 = 0x05 (Shift + Lock), which is effectively Off (0x00)
- //
- // First defines the first used scan code (most keyboards start at 0, some start higher e.g. 0x40)
- // - Compiler calculates this
- //
- // Last defines the last scan code used (helps reduce RAM usage)
- //
- // The name is defined for cli debugging purposes (Null terminated string)
-
- typedef struct Layer {
- const nat_ptr_t **triggerMap;
- const char *name;
- const uint8_t first;
- const uint8_t last;
- } Layer;
-
- // Layer_IN( map, name, first );
- // * map - Trigger map
- // * name - Name of the trigger map
- // * first - First scan code used (most keyboards start at 0, some start higher e.g. 0x40)
- #define Layer_IN( map, name, first ) { map, name, first, sizeof( map ) / sizeof( nat_ptr_t ) - 1 + first }
-
- // Total number of layers
- #define LayerNum sizeof( LayerIndex ) / sizeof( Layer )
-
-
-
- #endif // __kll_h
|