common/action.h

   1 #ifndef ACTION_H
   2 #define ACTION_H
   3
   4 #include "keyboard.h"
   5
   6
   7 /* Key Action(16bit code)
   8
   9 Keyboard Keys
  10 -------------
  11 ACT_LMODS(0000):
  12 0000|0000|000000|00    No action
  13 0000|mods|000000|00    Left mods Momentary
  14 0000|mods|000000|01    Left mods OneShot
  15 0000|mods|000000|10    (reserved)
  16 0000|mods|000000|11    (reserved)
  17 0000|0000| keycode     Key
  18 0000|mods| keycode     Key+Left mods
  19
  20 ACT_RMODS(0001):
  21 0001|0000|000000|00    No action
  22 0001|mods|000000|00    Right mods Momentary
  23 0001|mods|000000|01    Right mods OneShot
  24 0001|mods|000000|10    (reserved)
  25 0001|mods|000000|11    (reserved)
  26 0001|0000| keycode     Key
  27 0001|mods| keycode     Key+Right mods
  28
  29 ACT_LMODS_TAP(0010):
  30 0010|mods| keycode     Left mods+tap Key
  31
  32 ACT_RMODS_TAP(0011):
  33 0011|mods| keycode     Right mods+tap Key
  34
  35
  36 Other HID Usage
  37 ---------------
  38 This action handles other usages than keyboard.
  39 ACT_USAGE(0100):
  40 0100|00| usage(10)     System control(0x80) - General Desktop page(0x01)
  41 0100|01| usage(10)     Consumer control(0x01) - Consumer page(0x0C)
  42 0100|10| usage(10)     (reserved)
  43 0100|11| usage(10)     (reserved)
  44
  45
  46 Mouse Keys
  47 ----------
  48 ACT_MOUSEKEY(0110):
  49 0101|XXXX| keycode     Mouse key
  50
  51
  52 Layer Actions
  53 -------------
  54 ACT_LAYER_PRESSED(1000):    Set layer on key pressed
  55 ACT_LAYER_RELEASED(1001):   Set layer on key released
  56 ACT_LAYER_BIT(1010):        On/Off layer bit
  57 ACT_LAYER_EXT(1011):        Extentions
  58
  59 1000|LLLL|0000 0000   set layer L when pressed
  60 1001|LLLL|0000 0000   set layer L when released
  61 1010|BBBB|0000 0000   on/off bit B when pressed/released
  62 1011|0000|0000 0000   set default layer when pressed
  63 1011|0001|0000 0000   set default layer when released
  64
  65 1000|LLLL|1111 0000   set layer L when pressed + tap toggle
  66 1001|LLLL|1111 0000   set layer L when released[tap is ignored/not used]
  67 1010|BBBB|1111 0000   on/off bit B when pressed/released + tap toggle
  68 1011|0000|1111 0000   set default layer when pressed + tap toggle
  69 1011|0001|1111 0000   set default layer when released[tap is ignored/not used]
  70
  71 1000|LLLL|1111 1111   set L to default layer when pressed
  72 1001|LLLL|1111 1111   set L to default layer when released
  73 1010|BBBB|1111 1111   on/off bit B of default layer when pressed/released
  74 1011|0000|1111 1111   set current to default layer when pressed
  75 1011|0001|1111 1111   set current to default layer when released
  76
  77 1000|LLLL| keycode    set layer L when pressed + tap key
  78 1001|LLLL| keyocde    set layer L when released[tap is ignored/not used]
  79 1010|BBBB| keyocde    on/off bit B when pressed/released + tap key
  80 1011|0000| keyocde    set default layer when pressed + tap key
  81 1011|0001| keyocde    set default layer when released[tap is ignored/not used]
  82
  83
  84 Extensions(11XX)
  85 ----------------
  86 NOTE: NOT FIXED
  87
  88 ACT_MACRO(1100):
  89 1100|opt | id(8)      Macro play
  90 1100|1111| id(8)      Macro record
  91
  92 ACT_COMMAND(1110):
  93 1110|opt | id(8)      Built-in Command exec
  94
  95 ACT_FUNCTION(1111):
  96 1111| address(12)     Function
  97                                                     Macro record(dynamicly)
  98                                                     Macro play(dynamicly)
  99 TODO: modifier + [tap key /w mod]
 100     : layerkey + [tap key /w mod]
 101     for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
 102     http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
 103 */
 104
 105 enum action_id {
 106     ACT_LMODS           = 0b0000,
 107     ACT_RMODS           = 0b0001,
 108     ACT_LMODS_TAP       = 0b0010,
 109     ACT_RMODS_TAP       = 0b0011,
 110
 111     ACT_USAGE           = 0b0100,
 112     ACT_MOUSEKEY        = 0b0101,
 113
 114     ACT_LAYER_PRESSED   = 0b1000,
 115     ACT_LAYER_RELEASED  = 0b1001,
 116     ACT_LAYER_BIT       = 0b1010,
 117     ACT_LAYER_EXT       = 0b1011,
 118
 119     ACT_MACRO           = 0b1100,
 120     ACT_COMMAND         = 0b1110,
 121     ACT_FUNCTION        = 0b1111
 122 };
 123
 124 // TODO: not portable across compiler/endianness?
 125 /*
 126 In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15).
 127 AVR looks like a little endian in avr-gcc.
 128
 129 Byte order and bit order of 0x1234:
 130 Big endian:     15 ...  8 7 ... 210
 131                |  0x12   |  0x34   |
 132                 0001 0010 0011 0100
 133 Little endian:  012 ... 7  8 ... 15
 134                |  0x34   |  0x12   |
 135                 0010 1100 0100 1000
 136 */
 137 typedef union {
 138     uint16_t code;
 139     struct action_kind {
 140         uint16_t param  :12;
 141         uint16_t id     :4;
 142     } kind;
 143     struct action_key {
 144         uint16_t code   :8;
 145         uint16_t mods   :4;
 146         uint16_t kind   :4;
 147     } key;
 148     struct action_layer {
 149         uint16_t code   :8;
 150         uint16_t opt    :4;
 151         uint16_t kind   :4;
 152     } layer;
 153     struct action_usage {
 154         uint16_t code   :10;
 155         uint16_t page   :2;
 156         uint16_t kind   :4;
 157     } usage;
 158     struct action_command {
 159         uint16_t id     :8;
 160         uint16_t option :4;
 161         uint16_t kind   :4;
 162     } command;
 163 } action_t;
 164
 165
 166 enum stroke_cmd {
 167     STROKE_DOWN,
 168     STROKE_UP,
 169     STROKE_ALLUP, /* release all keys in reverse order */
 170 };
 171
 172 typedef struct {
 173     keyevent_t  event;
 174     action_t    action;
 175     uint8_t     mods;
 176 } keyrecord_t;
 177
 178
 179 void action_exec(keyevent_t event);
 180
 181
 182 // TODO: proper names
 183 /* action_t utility */
 184 #define ACTION_NO                       0
 185 #define ACTION(kind, param)             ((kind)<<12 | (param))
 186 #define MOD_BITS(mods)                  (((mods)>>4 | (mods)) & 0x0F)
 187
 188 /* Key & Mods */
 189 #define ACTION_KEY(key)                 ACTION(ACT_LMODS,    key)
 190 #define ACTION_LMODS(mods)              ACTION(ACT_LMODS,    (mods)<<8 | 0x00)
 191 #define ACTION_LMODS_KEY(mods, key)     ACTION(ACT_LMODS,    (mods)<<8 | (key))
 192 #define ACTION_LMODS_ONESHOT(mods)      ACTION(ACT_LMODS,    (mods)<<8 | 0x01)
 193 #define ACTION_LMODS_SWITCH(mods, tap)  ACTION(ACT_LMODS,    (mods)<<8 | 0xF0 | (tap))
 194 #define ACTION_LMODS_TOGGLE(mods, tap)  ACTION(ACT_LMODS,    (mods)<<8 | 0xF1 | (tap))
 195 #define ACTION_RMODS(mods)              ACTION(ACT_RMODS,    (mods)<<8 | 0x00)
 196 #define ACTION_RMODS_KEY(mods, key)     ACTION(ACT_RMODS,    (mods)<<8 | (key))
 197 #define ACTION_RMODS_ONESHOT(mods)      ACTION(ACT_RMODS,    (mods)<<8 | 0x01)
 198 #define ACTION_RMODS_SWITCH(mods, tap)  ACTION(ACT_RMODS,    (mods)<<8 | 0xF0 | (tap))
 199 #define ACTION_RMODS_TOGGLE(mods, tap)  ACTION(ACT_RMODS,    (mods)<<8 | 0xF1 | (tap))
 200 /* Mods + Tap key */
 201 #define ACTION_LMODS_TAP(mods, key)     ACTION(ACT_LMODS_TAP, MOD_BITS(mods)<<8 | (key))
 202 #define ACTION_RMODS_TAP(mods, key)     ACTION(ACT_RMODS_TAP, MOD_BITS(mods)<<8 | (key))
 203
 204 /* Layer Switch */
 205 #define ACTION_LAYER_SET_ON_PRESSED(layer)   ACTION(ACT_LAYER_PRESSED,  (layer)<<8 | 0x00)
 206 #define ACTION_LAYER_SET_ON_RELEASED(layer)  ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
 207 #define ACTION_LAYER_BIT(bits)               ACTION(ACT_LAYER_BIT,      (layer)<<8 | 0x00)
 208 #define ACTION_LAYER_TO_DEFAULT_ON_PRESSED   ACTION(ACT_LAYER_EXT,      0x0<<8     | 0x00)
 209 #define ACTION_LAYER_TO_DEFAULT_ON_RELEASED  ACTION(ACT_LAYER_EXT,      0x1<<8     | 0x00)
 210
 211 #define ACTION_LAYER_TAP_TOGGLE(layer)      ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
 212 #define ACTION_LAYER_BIT_TAP_TOGGLE(layer)  ACTION(ACT_LAYER_BIT,     (layer)<<8 | 0xF0)
 213 #define ACTION_LAYER_DEFAULT_TAP_TOGGLE     ACTION(ACT_LAYER_EXT,     0x0<<8     | 0xF0)
 214
 215 #define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer)   ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
 216 #define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer)  ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
 217 #define ACTION_LAYER_DEFAULT_BIT(bits)               ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
 218 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED  ACTION(ACT_LAYER_EXT, 0x0<<8    | 0xFF)
 219 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8    | 0xFF)
 220
 221 #define ACTION_LAYER_SET_TAP_KEY(layer, key)  ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
 222 #define ACTION_LAYER_BIT_TAP_KEY(bits, key)   ACTION(ACT_LAYER_BIT,     (layer)<<8 | (key))
 223 #define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT,     0x0<<8     | (key))
 224
 225 /* HID Usage */
 226 #define ACTION_USAGE_PAGE_SYSTEM        0
 227 #define ACTION_USAGE_PAGE_CONSUMER      1
 228 #define ACTION_USAGE_SYSTEM(id)         ACTION(ACT_USAGE,    ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
 229 #define ACTION_USAGE_CONSUMER(id)       ACTION(ACT_USAGE,    ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
 230 /* Mousekey */
 231 #define ACTION_MOUSEKEY(key)            ACTION(ACT_MOUSEKEY, key)
 232 /* Macro */
 233 #define ACTION_MACRO(opt, id)           ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
 234 /* Command */
 235 #define ACTION_COMMAND(opt, id)         ACTION(ACT_COMMAND,  (opt)<<8 | (addr))
 236 /* Function */
 237 #define ACTION_FUNCTION(addr)           ACTION(ACT_FUNCTION, addr)
 238
 239
 240 /* helpers for readability */
 241 #define LAYER(layer)    (layer)
 242 #define TAP(tap)        (tap)
 243 #define DOUBLE_TAP      2
 244 #define TRIPLE_TAP      3
 245 #define QUADRUPLE_TAP   4
 246 #define QUINTUPLE_TAP   5
 247 #define DOWN(key)       (key)
 248 #define UP(key)         STROKE_UP, (key)
 249
 250 #endif  /* ACTION_H */