7 /* Key Action(16bit code)
8 15 14 13 12 11 10 9 8 7 6 5 4 3 2 1 0
9 ------------------------------------------------
11 0 0 0 0| 0 0 0 0| 0 0 0 0 0 0| 0 0 No action
12 0 0 0 0| 0 0 0 0| keycode(8) Key
13 0 0 0 0| mods(4) | 0 0 0 0 0 0| 0 0 Lmods Momentary
14 0 0 0 0| mods(4) | 0 0 0 0 0 0| 0 1 Lmods OneShot
15 0 0 0 0| mods(4) | 0 0 0 0 0 0| 1 0 (reserved)
16 0 0 0 0| mods(4) | 0 0 0 0 0 0| 1 1 (reserved)
17 0 0 0 0| mods(4) | keycode(8) Key+Lmods
20 0 0 0 1| 0 0 0 0| 0 0 0 0 0 0 0 0 No action(not used)
21 0 0 0 1| 0 0 0 0| keycode(8) Key(not used)
22 0 0 0 1| mods(4) | 0 0 0 0 0 0| 0 0 Rmods Momentary
23 0 0 0 1| mods(4) | 0 0 0 0 0 0| 0 1 Rmods OneShot
24 0 0 0 1| mods(4) | 0 0 0 0 0 0| 1 0 (reserved)
25 0 0 0 1| mods(4) | 0 0 0 0 0 0| 1 1 (reserved)
26 0 0 0 1| mods(4) | keycode(8) Key+Rmod
29 0 0 1 0| 0 0 0 0| X X X X X X X X (reserved)[00-FF]
30 0 0 1 0| mods(4) | 0 0 0 0 0 0| X X (reserved)
31 0 0 1 0| mods(4) | keycode(8) Lmods+tap Key
32 0 0 1 0| mods(4) | 1 1 1 1| X X X X (reserved)[F0-FF]
35 0 0 1 1| 0 0 0 0| X X X X X X X X (reserved)[00-FF]
36 0 0 1 1| mods(4) | 0 0 0 0 0 0| X X (reserved)
37 0 0 1 1| mods(4) | keycode(8) Rmods+tap Key
38 0 0 1 1| mods(4) | 1 1 1 1| X X X X (reserved)[F0-FF]
40 ACT_USAGE - other HID usage than keyboard
41 0 1 0 0| 0 0| usage(10) System usage
42 0 1 0 0| 0 1| usage(10) Consumer usage
43 0 1 0 0| 1 0| usage(10) (reserved)
44 0 1 0 0| 1 1| usage(10) (reserved)
47 0 1 0 1| X X X X| keycode(8) Mouse key
49 0 1 0 1| 0 0 X X| accel(5) |cursor(3) Mouse key
50 0 1 0 1| 0 1 X X| accel(5) |wheel(3) Mouse key
51 0 1 0 1| 1 0 X X| button(8) Mouse key
52 0 1 0 1| 1 1 X X| button(8) Mouse key
57 1000|LLLL|0000 0000 set layer L when pressed
58 1001|LLLL|0000 0000 set layer L when released
59 1010|BBBB|0000 0000 on/off bit B when pressed/released
60 1011|0000|0000 0000 set default layer when pressed
61 1011|0001|0000 0000 set default layer when released
63 1000|LLLL|1111 0000 set layer L when pressed + tap toggle
64 1001|LLLL|1111 0000 set layer L when released[tap is ignored/not used]
65 1010|BBBB|1111 0000 on/off bit B when pressed/released + tap toggle
66 1011|0000|1111 0000 set default layer when pressed + tap toggle
67 1011|0001|1111 0000 set default layer when released[tap is ignored/not used]
69 1000|LLLL|1111 1111 set L to default layer when pressed
70 1001|LLLL|1111 1111 set L to default layer when released
71 1010|BBBB|1111 1111 on/off bit B of default layer when pressed/released
72 1011|0000|1111 1111 set current to default layer when pressed
73 1011|0001|1111 1111 set current to default layer when released
75 1000|LLLL| keycode set layer L when pressed + tap key
76 1001|LLLL| keyocde set layer L when released[tap is ignored/not used]
77 1010|BBBB| keyocde on/off bit B when pressed/released + tap key
78 1011|0000| keyocde set default layer when pressed + tap key
79 1011|0001| keyocde set default layer when released[tap is ignored/not used]
83 1 1 0 0| option(4) | macro-table id(8) Macro play(Flash)
84 1 1 0 0| option(4) | macro-table id(8) Macro play(EEPROM)
85 1 1 0 0| 1 1 1 1| macro-table id(8) Macro record
88 1 1 1 0| option(4) | comamnd id(8) Built-in Command exec
91 1 1 1 1| function address(4K range) Function
92 Macro record(dynamicly)
94 TODO: modifier + [tap key /w mod]
95 : layerkey + [tap key /w mod]
96 for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
97 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
103 ACT_LMOD_TAP = 0b0010,
104 ACT_RMOD_TAP = 0b0011,
106 ACT_MOUSEKEY = 0b0101,
107 ACT_LAYER_PRESSED = 0b1000,
108 ACT_LAYER_RELEASED = 0b1001,
109 ACT_LAYER_BIT = 0b1010,
110 ACT_LAYER_EXT = 0b1011,
112 ACT_COMMAND = 0b1110,
113 ACT_FUNCTION = 0b1111
116 // TODO: not portable across compiler/endianness?
118 In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15).
119 AVR looks like a little endian in avr-gcc.
121 Byte order and bit order of 0x1234:
122 Big endian: 15 ... 8 7 ... 210
125 Little endian: 012 ... 7 8 ... 15
140 struct action_layer {
145 struct action_usage {
150 struct action_command {
161 STROKE_ALLUP, /* release all keys in reverse order */
171 void action_exec(keyevent_t event);
173 void key_action(uint8_t code, keyevent_t event);
174 void mod_action(uint8_t code, keyevent_t event);
175 void fn_action(uint8_t code, keyevent_t event);
179 /* action_t utility */
181 #define ACTION_NO { .code = 0 }
182 #define ACTION(kind, param) { .code = ((kind)<<12 | (param)) }
185 #define ACTION(kind, param) ((kind)<<12 | (param))
188 #define ACTION_KEY(key) ACTION(ACT_LMODS, key)
189 #define ACTION_LMODS(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x00)
190 #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, (mods)<<8 | (key))
191 #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x01)
192 #define ACTION_LMODS_SWITCH(mods, tap) ACTION(ACT_LMODS, (mods)<<8 | 0xF0 | (tap))
193 #define ACTION_LMODS_TOGGLE(mods, tap) ACTION(ACT_LMODS, (mods)<<8 | 0xF1 | (tap))
194 #define ACTION_RMODS(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x00)
195 #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, (mods)<<8 | (key))
196 #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x01)
197 #define ACTION_RMODS_SWITCH(mods, tap) ACTION(ACT_RMODS, (mods)<<8 | 0xF0 | (tap))
198 #define ACTION_RMODS_TOGGLE(mods, tap) ACTION(ACT_RMODS, (mods)<<8 | 0xF1 | (tap))
200 #define ACTION_LMODS_TAP(mods, key) ACTION(ACT_LMODS_TAP,(mods)<<8 | (key))
201 #define ACTION_RMODS_TAP(mods, key) ACTION(ACT_RMODS_TAP,(mods)<<8 | (key))
204 #define ACTION_LAYER_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0x00)
205 #define ACTION_LAYER_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
206 #define ACTION_LAYER_BIT(bits) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0x00)
207 #define ACTION_LAYER_TO_DEFAULT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
208 #define ACTION_LAYER_TO_DEFAULT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
210 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
211 #define ACTION_LAYER_BIT_TAP_TOGGLE(layer) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0xF0)
212 #define ACTION_LAYER_DEFAULT_TAP_TOGGLE ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xF0)
214 #define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
215 #define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
216 #define ACTION_LAYER_DEFAULT_BIT(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
217 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xFF)
218 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0xFF)
220 #define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
221 #define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (layer)<<8 | (key))
222 #define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT, 0x0<<8 | (key))
225 #define ACTION_USAGE_PAGE_SYSTEM 0
226 #define ACTION_USAGE_PAGE_CONSUMER 1
227 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
228 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
230 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
232 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
234 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
236 #define ACTION_FUNCTION(addr) ACTION(ACT_FUNCTION, addr)
239 /* helpers for readability */
240 #define LAYER(layer) (layer)
241 #define TAP(tap) (tap)
244 #define QUADRUPLE_TAP 4
245 #define QUINTUPLE_TAP 5
246 #define DOWN(key) (key)
247 #define UP(key) STROKE_UP, (key)
249 #endif /* ACTION_H */