common/action.h

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