Code cleanup

[kiibohd-controller.git] / Macro / PartialMap / kll.h

diff --git a/Macro/PartialMap/kll.h b/Macro/PartialMap/kll.h
index e9e6c3d6f4a198a78cff2d3a36ee2e8c9fcb008f..e5e964f0e2460f14720f54901a984c328875b522 100644 (file)
--- a/Macro/PartialMap/kll.h
+++ b/Macro/PartialMap/kll.h
@@ -1,4 +1,4 @@
-/* Copyright (C) 2014 by Jacob Alexander
+/* Copyright (C) 2014-2015 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
@@ -14,11 +14,13 @@
  * along with this file.  If not, see <http://www.gnu.org/licenses/>.
  */
 
-#ifndef __kll_h
-#define __kll_h
+#pragma once
 
 // ----- Includes -----
 
+// KLL Generated Defines
+#include <kll_defs.h>
+
 // Project Includes
 #include <print.h>
 #include <scan_loop.h>
@@ -36,17 +38,22 @@
 // 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.
-// TODO Make selectable from layout variable
-//typedef uint32_t var_uint_t;
-//typedef uint16_t var_uint_t;
+#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_) // ARM
+#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;
@@ -58,23 +65,28 @@ typedef uint16_t nat_ptr_t;
 
 // -- 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.guide     -> [<combo length>|<capability index>|<arg1>|<argn>|<capability index>|...|<combo length>|...|0]
-// ResultMacro.pos       -> <current combo position>
-// ResultMacro.state     -> <last key state>
-// ResultMacro.stateType -> <last key state type>
+// 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>
 
 // ResultMacro struct, one is created per ResultMacro, no duplicates
 typedef struct ResultMacro {
        const uint8_t *guide;
+} ResultMacro;
+
+typedef struct ResultMacroRecord {
        var_uint_t pos;
        uint8_t  state;
        uint8_t  stateType;
-} ResultMacro;
+} ResultMacroRecord;
 
 // Guide, key element
 #define ResultGuideSize( guidePtr ) sizeof( ResultGuide ) - 1 + CapabilitiesList[ (guidePtr)->index ].argCount
@@ -87,6 +99,7 @@ typedef struct 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)
@@ -105,8 +118,9 @@ typedef struct ResultGuide {
 //
 // TriggerMacro.guide  -> [<combo length>|<key1 type>|<key1 state>|<key1>...<keyn type>|<keyn state>|<keyn>|<combo length>...|0]
 // TriggerMacro.result -> <index to result macro>
-// TriggerMacro.pos    -> <current combo position>
-// TriggerMacro.state  -> <status of the macro pos>
+//
+// TriggerMacroRecord.pos   -> <current combo position>
+// TriggerMacroRecord.state -> <status of the macro pos>
 
 // TriggerMacro states
 typedef enum TriggerMacroState {
@@ -119,9 +133,12 @@ typedef enum TriggerMacroState {
 typedef struct TriggerMacro {
        const uint8_t *guide;
        const var_uint_t result;
+} TriggerMacro;
+
+typedef struct TriggerMacroRecord {
        var_uint_t pos;
        TriggerMacroState state;
-} TriggerMacro;
+} TriggerMacroRecord;
 
 // Guide, key element
 #define TriggerGuideSize sizeof( TriggerGuide )
@@ -155,7 +172,7 @@ typedef struct Capability {
 //  * index  - Result Macro index number
 //  Must be used after Guide_RM
 #define Guide_RM( index ) const uint8_t rm##index##_guide[]
-#define Define_RM( index ) { rm##index##_guide, 0, 0, 0 }
+#define Define_RM( index ) { rm##index##_guide }
 
 
 // -- Result Macro List
@@ -175,7 +192,7 @@ typedef struct Capability {
 //  * 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 Define_TM( index, result ) { tm##index##_guide, result, 0, TriggerMacro_Waiting }
+#define Define_TM( index, result ) { tm##index##_guide, result }
 
 
 // -- Trigger Macro List
@@ -234,7 +251,3 @@ typedef struct Layer {
 // Total number of layers
 #define LayerNum sizeof( LayerIndex ) / sizeof( Layer )
 
-
-
-#endif // __kll_h
-