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.
12 * TODO: not portable across compiler/endianness?
13 * Byte order and bit order of 0x1234:
14 * Big endian: 15 ... 8 7 ... 210
17 * Little endian: 012 ... 7 8 ... 15
42 struct action_command {
47 struct action_function {
54 /* Action record. For internal use. */
61 /* Tap count: Tap is comprised of press and release within TAP_TERM.
65 extern uint8_t tap_count;
67 /* current tap key event */
68 extern keyevent_t tapping_event;
72 typedef void (*action_func_t)(keyevent_t event, uint8_t opt);
74 // TODO: legacy keymap support
75 void action_exec(keyevent_t event);
76 void action_call_function(keyevent_t event, uint8_t id);
80 * Utilities for actions.
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);
99 * 16bit code: action_kind(4bit) + action_parameter(12bit)
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
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
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
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
132 This action handles other usages than keyboard.
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)
143 0101|XXXX| keycode Mouse key
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
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
159 1000|LLLL|1111 0000 set layer L when pressed + tap toggle
160 1001|LLLL|1111 0000 set layer L when released[tap is ignored/not used]
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 is ignored/not used]
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
171 1000|LLLL| keycode set layer L when pressed + tap key
172 1001|LLLL| keyocde set layer L when released[tap is ignored/not used]
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 is ignored/not used]
183 1100|opt | id(8) Macro play?
184 1100|1111| id(8) Macro record?
187 1110|opt | id(8) Built-in Command exec
190 1111| address(12) Function?
191 1111|opt | id(8) Function?
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
198 enum action_kind_id {
201 ACT_LMODS_TAP = 0b0010,
202 ACT_RMODS_TAP = 0b0011,
205 ACT_MOUSEKEY = 0b0101,
207 ACT_LAYER_PRESSED = 0b1000,
208 ACT_LAYER_RELEASED = 0b1001,
209 ACT_LAYER_BIT = 0b1010,
210 ACT_LAYER_EXT = 0b1011,
213 ACT_COMMAND = 0b1110,
214 ACT_FUNCTION = 0b1111
222 /* action_t utility */
224 #define ACTION(kind, param) ((kind)<<12 | (param))
225 #define MOD_BITS(mods) (((mods)>>4 | (mods)) & 0x0F)
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))
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))
240 #define ACTION_LAYER_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0x00)
241 #define ACTION_LAYER_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
242 #define ACTION_LAYER_BIT(bits) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0x00)
243 #define ACTION_LAYER_TO_DEFAULT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
244 #define ACTION_LAYER_TO_DEFAULT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
246 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
247 #define ACTION_LAYER_BIT_TAP_TOGGLE(layer) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0xF0)
248 #define ACTION_LAYER_DEFAULT_TAP_TOGGLE ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xF0)
250 #define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
251 #define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
252 #define ACTION_LAYER_DEFAULT_BIT(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
253 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xFF)
254 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0xFF)
256 #define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
257 #define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (layer)<<8 | (key))
258 #define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT, 0x0<<8 | (key))
261 #define ACTION_USAGE_PAGE_SYSTEM 0
262 #define ACTION_USAGE_PAGE_CONSUMER 1
263 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
264 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
266 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
268 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
270 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
272 #define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id)
274 #endif /* ACTION_H */