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
19 0 0 0 0| mods(4) | 1 1 1 1 0| tap(3) Lmods+tap Switch(enable/disable)
20 0 0 0 0| mods(4) | 1 1 1 1 1| tap(3) Lmods+tap Toggle(on/off)
24 0 0 0 1| 0 0 0 0| 0 0 0 0 0 0 0 0 No action(not used)
25 0 0 0 1| 0 0 0 0| keycode(8) Key(not used)
26 0 0 0 1| mods(4) | 0 0 0 0 0 0| 0 0 Rmods Momentary
27 0 0 0 1| mods(4) | 0 0 0 0 0 0| 0 1 Rmods OneShot
28 0 0 0 1| mods(4) | 0 0 0 0 0 0| 1 0 (reserved)
29 0 0 0 1| mods(4) | 0 0 0 0 0 0| 1 1 (reserved)
30 0 0 0 1| mods(4) | keycode(8) Key+Rmod
32 0 0 0 1| mods(4) | 1 1 1 1 0| tap(3) Rmods+tap Switch(enable/disable)
33 0 0 0 1| mods(4) | 1 1 1 1 1| tap(3) Rmods+tap Toggle(on/off)
37 0 0 1 0| 0 0 0 0| X X X X X X X X (reserved)[00-FF]
38 0 0 1 0| mods(4) | 0 0 0 0 0 0| X X (reserved)
39 0 0 1 0| mods(4) | keycode(8) Lmods+tap Key
40 0 0 1 0| mods(4) | 1 1 1 1| X X X X (reserved)[F0-FF]
43 0 0 1 1| 0 0 0 0| X X X X X X X X (reserved)[00-FF]
44 0 0 1 1| mods(4) | 0 0 0 0 0 0| X X (reserved)
45 0 0 1 1| mods(4) | keycode(8) Rmods+tap Key
46 0 0 1 1| mods(4) | 1 1 1 1| X X X X (reserved)[F0-FF]
49 0 1 0 0| layer(4) | 0 0 0 0 0 0| 0 0 Momentary
50 0 1 0 0| layer(4) | 0 0 0 0 0 0| 0 1 Oneshot
51 0 1 0 0| layer(4) | 0 0 0 0 0 0| 1 0 (reserved)
52 0 1 0 0| layer(4) | 0 0 0 0 0 0| 1 1 (reserved)
53 0 1 0 0| layer(4) | keycode(8) Fn momentary + tap Key
54 0 1 0 0| layer(4) | 1 1 1 1 0| tap(3) Fn+tap Switch(enable/disable)
55 0 1 0 0| layer(4) | 1 1 1 1 1| tap(3) Fn+tap Toggle(on/off)
58 0 1 0 1| 0 0| usage(10) System usage
59 0 1 0 1| 0 1| usage(10) Consumer usage
60 0 1 0 1| 1 0| usage(10) (reserved)
61 0 1 0 1| 1 1| usage(10) (reserved)
64 0 1 1 0| X X X X| keycode(8) Mouse key
66 0 1 1 0| 0 0 X X| accel(5) |cursor(3) Mouse key
67 0 1 1 0| 0 1 X X| accel(5) |wheel(3) Mouse key
68 0 1 1 0| 1 0 X X| button(8) Mouse key
69 0 1 1 0| 1 1 X X| button(8) Mouse key
80 1 1 0 0| option(4) | macro-table id(8) Macro play(Flash)
81 1 1 0 0| option(4) | macro-table id(8) Macro play(EEPROM)
82 1 1 0 0| 1 1 1 1| macro-table id(8) Macro record
85 1 1 1 0| option(4) | comamnd id(8) Built-in Command exec
88 1 1 1 1| function address(4K range) Function
89 Macro record(dynamicly)
106 // TODO: not portable across compiler/endianness?
108 In avr-gcc bit fields seems to be assigned from LSB(bit0) to MSB(bit15).
109 AVR seems like little endian in avr-gcc.
111 Byte order and bit order of 0x1234:
112 Big endian: 15 ... 8 7 ... 210
115 Little endian: 012 ... 7 8 ... 15
130 struct action_layer_key {
135 struct action_layer_tap {
141 struct action_usage {
146 struct action_command {
157 STROKE_ALLUP, /* release all keys in reverse order */
160 void action_exec(action_t act, keyevent_t event);
162 void key_action(uint8_t code, keyevent_t event);
163 void mod_action(uint8_t code, keyevent_t event);
164 void fn_action(uint8_t code, keyevent_t event);
168 /* action_t utility */
169 #define ACTION(kind, param) { .code = ((kind)<<12 | (param)) }
170 #define NO_ACTION ACTION(0, 0)
171 #define LAYER_PARAM(layer, key) ((layer)<<8|(key))
174 #define ACTION_KEY(key) ACTION(ACT_LMODS, key)
175 #define ACTION_LMODS(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x00)
176 #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, (mods)<<8 | (key))
177 #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x01)
178 #define ACTION_LMODS_SWITCH(mods, tap) ACTION(ACT_LMODS, (mods)<<8 | 0xF0 | (tap))
179 #define ACTION_LMODS_TOGGLE(mods, tap) ACTION(ACT_LMODS, (mods)<<8 | 0xF1 | (tap))
180 #define ACTION_RMODS(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x00)
181 #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, (mods)<<8 | (key))
182 #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x01)
183 #define ACTION_RMODS_SWITCH(mods, tap) ACTION(ACT_RMODS, (mods)<<8 | 0xF0 | (tap))
184 #define ACTION_RMODS_TOGGLE(mods, tap) ACTION(ACT_RMODS, (mods)<<8 | 0xF1 | (tap))
186 #define ACTION_LMODS_TAP(mods, key) ACTION(ACT_LMODS_TAP,(mods)<<8 | (key))
187 #define ACTION_RMODS_TAP(mods, key) ACTION(ACT_RMODS_TAP,(mods)<<8 | (key))
189 #define ACTION_LAYER(layer) ACTION(ACT_LAYER, (layer)<<8 | 0x00)
190 #define ACTION_LAYER_ONESHOT(layer) ACTION(ACT_LAYER, (layer)<<8 | 0x01)
191 #define ACTION_LAYER_KEY(layer, key) ACTION(ACT_LAYER, (layer)<<8 | (key))
192 #define ACTION_LAYER_SWITCH(layer, tap) ACTION(ACT_LAYER, (layer)<<8 | 0xF0 | (tap))
193 #define ACTION_LAYER_TOGGLE(layer, tap) ACTION(ACT_LAYER, (layer)<<8 | 0xF1 | (tap))
195 #define ACTION_USAGE_PAGE_SYSTEM 0
196 #define ACTION_USAGE_PAGE_CONSUMER 1
197 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
198 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
200 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
202 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
204 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
206 #define ACTION_FUNCTION(addr) ACTION(ACT_FUNCTION, addr)
209 /* helpers for readability */
210 #define LAYER(layer) (layer)
211 #define TAP(tap) (tap)
214 #define QUADRUPLE_TAP 4
215 #define QUINTUPLE_TAP 5
216 #define DOWN(key) (key)
217 #define UP(key) STROKE_UP, (key)
219 #endif /* ACTION_H */