common/action.h

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