Add new layer actions.

1 files changed, 91 insertions, 61 deletions

diff --git a/common/action.h b/common/action.h
index 08f8c5608c..942ce191a2 100644
--- a/common/action.h
+++ b/common/action.h
@@ -15,10 +15,6 @@ ACT_LMODS(0000)
   0  0  0  0|  mods(4)  | 0  0  0  0  0  0| 1  0    (reserved)
   0  0  0  0|  mods(4)  | 0  0  0  0  0  0| 1  1    (reserved)
   0  0  0  0|  mods(4)  |     keycode(8)            Key+Lmods
-???
-  0  0  0  0|  mods(4)  | 1  1  1  1  0| tap(3)     Lmods+tap Switch(enable/disable)
-  0  0  0  0|  mods(4)  | 1  1  1  1  1| tap(3)     Lmods+tap Toggle(on/off)
-???
 
 ACT_RMODS(0001)
   0  0  0  1| 0  0  0  0| 0  0  0  0  0  0  0  0    No action(not used)
@@ -28,10 +24,6 @@ ACT_RMODS(0001)
   0  0  0  1|  mods(4)  | 0  0  0  0  0  0| 1  0    (reserved)
   0  0  0  1|  mods(4)  | 0  0  0  0  0  0| 1  1    (reserved)
   0  0  0  1|  mods(4)  |     keycode(8)            Key+Rmod
-???
-  0  0  0  1|  mods(4)  | 1  1  1  1  0| tap(3)     Rmods+tap Switch(enable/disable)
-  0  0  0  1|  mods(4)  | 1  1  1  1  1| tap(3)     Rmods+tap Toggle(on/off)
-???
 
 ACT_LMODS_TAP(0010)
   0  0  1  0| 0  0  0  0| X  X  X  X  X  X  X  X    (reserved)[00-FF]
@@ -45,36 +37,47 @@ ACT_RMODS_TAP(0011)
   0  0  1  1|  mods(4)  |     keycode(8)            Rmods+tap Key
   0  0  1  1|  mods(4)  | 1  1  1  1| X  X  X  X    (reserved)[F0-FF]
  
-ACT_LAYER(0100)
-  0  1  0  0|  layer(4) | 0  0  0  0  0  0| 0  0    Momentary
-  0  1  0  0|  layer(4) | 0  0  0  0  0  0| 0  1    Oneshot
-  0  1  0  0|  layer(4) | 0  0  0  0  0  0| 1  0    (reserved)
-  0  1  0  0|  layer(4) | 0  0  0  0  0  0| 1  1    (reserved)
-  0  1  0  0|  layer(4) |     keycode(8)            Fn momentary + tap Key
-  0  1  0  0|  layer(4) | 1  1  1  1  0| tap(3)     Fn+tap Switch(enable/disable)
-  0  1  0  0|  layer(4) | 1  1  1  1  1| tap(3)     Fn+tap Toggle(on/off)
-
-ACT_USAGE(0101)
-  0  1  0  1| 0  0|         usage(10)               System usage
-  0  1  0  1| 0  1|         usage(10)               Consumer usage
-  0  1  0  1| 1  0|         usage(10)               (reserved)
-  0  1  0  1| 1  1|         usage(10)               (reserved)
+ACT_USAGE - other HID usage than keyboard
+  0  1  0  0| 0  0|         usage(10)               System usage
+  0  1  0  0| 0  1|         usage(10)               Consumer usage
+  0  1  0  0| 1  0|         usage(10)               (reserved)
+  0  1  0  0| 1  1|         usage(10)               (reserved)
 
 ACT_MOUSEKEY(0110)
-  0  1  1  0| X  X  X  X|        keycode(8)         Mouse key
+  0  1  0  1| X  X  X  X|        keycode(8)         Mouse key
 ??? TODO: refactor
-  0  1  1  0| 0  0  X  X|  accel(5)    |cursor(3)   Mouse key
-  0  1  1  0| 0  1  X  X|  accel(5)    |wheel(3)    Mouse key
-  0  1  1  0| 1  0  X  X|        button(8)          Mouse key
-  0  1  1  0| 1  1  X  X|        button(8)          Mouse key
+  0  1  0  1| 0  0  X  X|  accel(5)    |cursor(3)   Mouse key
+  0  1  0  1| 0  1  X  X|  accel(5)    |wheel(3)    Mouse key
+  0  1  0  1| 1  0  X  X|        button(8)          Mouse key
+  0  1  0  1| 1  1  X  X|        button(8)          Mouse key
 ???
 
-  0  1  1  1|                                       (reserved)
-  1  0  0  0|                                       (reserved)
-  1  0  0  1|                                       (reserved)
-  1  0  1  0|                                       (reserved)
-  1  0  1  1|                                       (reserved)
-  1  1  0  0|                                       (reserved)
+Layer Action
+------------
+1000|LLLL|0000 0000   set layer L when pressed
+1001|LLLL|0000 0000   set layer L when released
+1010|BBBB|0000 0000   on/off bit B when pressed/released
+1011|0000|0000 0000   set default layer when pressed
+1011|0001|0000 0000   set default layer when released
+
+1000|LLLL|1111 0000   set layer L when pressed + tap toggle
+1001|LLLL|1111 0000   set layer L when released[tap is ignored/not used]
+1010|BBBB|1111 0000   on/off bit B when pressed/released + tap toggle
+1011|0000|1111 0000   set default layer when pressed + tap toggle
+1011|0001|1111 0000   set default layer when released[tap is ignored/not used]
+
+1000|LLLL|1111 1111   set L to default layer when pressed
+1001|LLLL|1111 1111   set L to default layer when released
+1010|BBBB|1111 1111   on/off bit B of default layer when pressed/released
+1011|0000|1111 1111   set current to default layer when pressed
+1011|0001|1111 1111   set current to default layer when released
+
+1000|LLLL| keycode    set layer L when pressed + tap key
+1001|LLLL| keyocde    set layer L when released[tap is ignored/not used]
+1010|BBBB| keyocde    on/off bit B when pressed/released + tap key
+1011|0000| keyocde    set default layer when pressed + tap key
+1011|0001| keyocde    set default layer when released[tap is ignored/not used]
+ 
 
 ACT_MACRO(1100)
   1  1  0  0| option(4) |     macro-table id(8)     Macro play(Flash)
@@ -88,25 +91,32 @@ ACT_FUNCTION(1111)
   1  1  1  1|   function address(4K range)          Function
                                                     Macro record(dynamicly)
                                                     Macro play(dynamicly)
+TODO: modifier + [tap key /w mod]
+    : layerkey + [tap key /w mod]
+    for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
+    http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
 */
 
 enum action_id {
-    ACT_LMODS = 0,
-    ACT_RMODS,
-    ACT_LMOD_TAP,
-    ACT_RMOD_TAP,
-    ACT_LAYER,
-    ACT_USAGE,
-    ACT_MOUSEKEY,
-    ACT_MACRO = 14,
-    ACT_COMMAND = 15,
-    ACT_FUNCTION = 16
+    ACT_LMODS    = 0b0000,
+    ACT_RMODS    = 0b0001,
+    ACT_LMOD_TAP = 0b0010,
+    ACT_RMOD_TAP = 0b0011,
+    ACT_USAGE    = 0b0100,
+    ACT_MOUSEKEY = 0b0101,
+    ACT_LAYER_PRESSED  = 0b1000,
+    ACT_LAYER_RELEASED = 0b1001,
+    ACT_LAYER_BIT      = 0b1010,
+    ACT_LAYER_EXT      = 0b1011,
+    ACT_MACRO    = 0b1100,
+    ACT_COMMAND  = 0b1110,
+    ACT_FUNCTION = 0b1111
 };
 
 // TODO: not portable across compiler/endianness?
 /*
 In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15). 
-AVR seems like little endian in avr-gcc.
+AVR looks like a little endian in avr-gcc.
 
 Byte order and bit order of 0x1234:
 Big endian:     15 ...  8 7 ... 210
@@ -127,17 +137,11 @@ typedef union {
         uint16_t mods   :4;
         uint16_t kind   :4;
     } key;
-    struct action_layer_key {
+    struct action_layer {
         uint16_t code   :8;
-        uint16_t layer  :4;
-        uint16_t kind   :4;
-    } layer_key;
-    struct action_layer_tap {
-        uint16_t count  :3;
-        uint16_t rest   :5;
-        uint16_t layer  :4;
+        uint16_t opt    :4;
         uint16_t kind   :4;
-    } layer_tap;
+    } layer;
     struct action_usage {
         uint16_t code   :10;
         uint16_t page   :2;
@@ -157,7 +161,14 @@ enum stroke_cmd {
     STROKE_ALLUP, /* release all keys in reverse order */
 };
 
-void action_exec(action_t act, keyevent_t event);
+typedef struct {
+    keyevent_t  event;
+    action_t    action;
+    uint8_t     mods;
+} keyrecord_t;
+
+
+void action_exec(keyevent_t event);
 /*
 void key_action(uint8_t code, keyevent_t event);
 void mod_action(uint8_t code, keyevent_t event);
@@ -166,9 +177,12 @@ void fn_action(uint8_t code, keyevent_t event);
 
 
 /* action_t utility */
+/*
+#define ACTION_NO                       { .code = 0 }
 #define ACTION(kind, param)             { .code = ((kind)<<12 | (param)) }
-#define NO_ACTION                       ACTION(0, 0)
-#define LAYER_PARAM(layer, key)         ((layer)<<8|(key))
+*/
+#define ACTION_NO                       0
+#define ACTION(kind, param)             ((kind)<<12 | (param))
 
 /* Key & Mods */
 #define ACTION_KEY(key)                 ACTION(ACT_LMODS,    key)
@@ -185,12 +199,28 @@ void fn_action(uint8_t code, keyevent_t event);
 /* Mods + Tap key */
 #define ACTION_LMODS_TAP(mods, key)     ACTION(ACT_LMODS_TAP,(mods)<<8 | (key))
 #define ACTION_RMODS_TAP(mods, key)     ACTION(ACT_RMODS_TAP,(mods)<<8 | (key))
+
 /* Layer Switch */
-#define ACTION_LAYER(layer)             ACTION(ACT_LAYER,    (layer)<<8 | 0x00)
-#define ACTION_LAYER_ONESHOT(layer)     ACTION(ACT_LAYER,    (layer)<<8 | 0x01)
-#define ACTION_LAYER_KEY(layer, key)    ACTION(ACT_LAYER,    (layer)<<8 | (key))
-#define ACTION_LAYER_SWITCH(layer, tap) ACTION(ACT_LAYER,    (layer)<<8 | 0xF0 | (tap))
-#define ACTION_LAYER_TOGGLE(layer, tap) ACTION(ACT_LAYER,    (layer)<<8 | 0xF1 | (tap))
+#define ACTION_LAYER_SET_ON_PRESSED(layer)   ACTION(ACT_LAYER_PRESSED,  (layer)<<8 | 0x00)
+#define ACTION_LAYER_SET_ON_RELEASED(layer)  ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
+#define ACTION_LAYER_BIT(bits)               ACTION(ACT_LAYER_BIT,      (layer)<<8 | 0x00)
+#define ACTION_LAYER_TO_DEFAULT_ON_PRESSED   ACTION(ACT_LAYER_EXT,      0x0<<8     | 0x00)
+#define ACTION_LAYER_TO_DEFAULT_ON_RELEASED  ACTION(ACT_LAYER_EXT,      0x1<<8     | 0x00)
+
+#define ACTION_LAYER_TAP_TOGGLE(layer)      ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
+#define ACTION_LAYER_BIT_TAP_TOGGLE(layer)  ACTION(ACT_LAYER_BIT,     (layer)<<8 | 0xF0)
+#define ACTION_LAYER_DEFAULT_TAP_TOGGLE     ACTION(ACT_LAYER_EXT,     0x0<<8     | 0xF0)
+
+#define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer)   ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
+#define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer)  ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
+#define ACTION_LAYER_DEFAULT_BIT(bits)               ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
+#define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED  ACTION(ACT_LAYER_EXT, 0x0<<8    | 0xFF)
+#define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8    | 0xFF)
+
+#define ACTION_LAYER_SET_TAP_KEY(layer, key)  ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
+#define ACTION_LAYER_BIT_TAP_KEY(bits, key)   ACTION(ACT_LAYER_BIT,     (layer)<<8 | (key))
+#define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT,     0x0<<8     | (key))
+
 /* HID Usage */
 #define ACTION_USAGE_PAGE_SYSTEM        0
 #define ACTION_USAGE_PAGE_CONSUMER      1