Fix bit shift which is beyond int size(16bit)
[tmk_keyboard.git] / common / action.h
1 /*
2 Copyright 2012,2013 Jun Wako <wakojun@gmail.com>
3
4 This program is free software: you can redistribute it and/or modify
5 it under the terms of the GNU General Public License as published by
6 the Free Software Foundation, either version 2 of the License, or
7 (at your option) any later version.
8
9 This program is distributed in the hope that it will be useful,
10 but WITHOUT ANY WARRANTY; without even the implied warranty of
11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 GNU General Public License for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program. If not, see <http://www.gnu.org/licenses/>.
16 */
17 #ifndef ACTION_H
18 #define ACTION_H
19
20 #include "keyboard.h"
21 #include "keycode.h"
22
23
24 /* Struct to record event and tap count */
25 typedef struct {
26 keyevent_t event;
27 uint8_t tap_count;
28 } keyrecord_t;
29
30 /* Action struct.
31 *
32 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
33 * AVR looks like a little endian in avr-gcc.
34 *
35 * NOTE: not portable across compiler/endianness?
36 * Byte order and bit order of 0x1234:
37 * Big endian: 15 ... 8 7 ... 210
38 * | 0x12 | 0x34 |
39 * 0001 0010 0011 0100
40 * Little endian: 012 ... 7 8 ... 15
41 * | 0x34 | 0x12 |
42 * 0010 1100 0100 1000
43 */
44 typedef union {
45 uint16_t code;
46 struct action_kind {
47 uint16_t param :12;
48 uint8_t id :4;
49 } kind;
50 struct action_key {
51 uint8_t code :8;
52 uint8_t mods :4;
53 uint8_t kind :4;
54 } key;
55 struct action_layer {
56 uint8_t code :8;
57 uint8_t val :4;
58 uint8_t kind :4;
59 } layer;
60 struct action_usage {
61 uint16_t code :10;
62 uint8_t page :2;
63 uint8_t kind :4;
64 } usage;
65 struct action_command {
66 uint8_t id :8;
67 uint8_t opt :4;
68 uint8_t kind :4;
69 } command;
70 struct action_function {
71 uint8_t id :8;
72 uint8_t opt :4;
73 uint8_t kind :4;
74 } func;
75 } action_t;
76
77
78
79 /* layer used currently */
80 extern uint8_t current_layer;
81 /* layer to return or start with */
82 extern uint8_t default_layer;
83
84 /* Execute action per keyevent */
85 void action_exec(keyevent_t event);
86
87 /* action for key */
88 action_t action_for_key(uint8_t layer, key_t key);
89
90 /* user defined special function */
91 void action_function(keyrecord_t *record, uint8_t id, uint8_t opt);
92
93 /*
94 * Utilities for actions.
95 */
96 void register_code(uint8_t code);
97 void unregister_code(uint8_t code);
98 void add_mods(uint8_t mods);
99 void del_mods(uint8_t mods);
100 void set_mods(uint8_t mods);
101 void clear_keyboard(void);
102 void clear_keyboard_but_mods(void);
103 bool sending_anykey(void);
104 void layer_switch(uint8_t new_layer);
105 bool is_tap_key(key_t key);
106 bool waiting_buffer_has_anykey_pressed(void);
107
108
109
110 /*
111 * Action codes
112 * ============
113 * 16bit code: action_kind(4bit) + action_parameter(12bit)
114 *
115 * Keyboard Keys
116 * -------------
117 * ACT_LMODS(0000):
118 * 0000|0000|000000|00 No action
119 * 0000|0000|000000|01 Transparent
120 * 0000|0000| keycode Key
121 * 0000|mods|000000|00 Left mods
122 * 0000|mods| keycode Key & Left mods
123 *
124 * ACT_RMODS(0001):
125 * 0001|0000|000000|00 No action(not used)
126 * 0001|0000|000000|01 Transparent(not used)
127 * 0001|0000| keycode Key(no used)
128 * 0001|mods|000000|00 Right mods
129 * 0001|mods| keycode Key & Right mods
130 *
131 * ACT_LMODS_TAP(0010):
132 * 0010|mods|000000|00 Left mods OneShot
133 * 0010|mods|000000|01 (reserved)
134 * 0010|mods|000000|10 (reserved)
135 * 0010|mods|000000|11 (reserved)
136 * 0010|mods| keycode Left mods + tap Key
137 *
138 * ACT_RMODS_TAP(0011):
139 * 0011|mods|000000|00 Right mods OneShot
140 * 0011|mods|000000|01 (reserved)
141 * 0011|mods|000000|10 (reserved)
142 * 0011|mods|000000|11 (reserved)
143 * 0011|mods| keycode Right mods + tap Key
144 *
145 *
146 * Other HID Usage
147 * ---------------
148 * This action handles other usages than keyboard.
149 * ACT_USAGE(0100):
150 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
151 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
152 * 0100|10| usage(10) (reserved)
153 * 0100|11| usage(10) (reserved)
154 *
155 *
156 * Mouse Keys
157 * ----------
158 * TODO: can be combined with 'Other HID Usage'? to save action kind id.
159 * ACT_MOUSEKEY(0110):
160 * 0101|XXXX| keycode Mouse key
161 *
162 *
163 * Layer Actions
164 * -------------
165 * ACT_LAYER(1000): Set layer
166 * ACT_LAYER_BIT(1001): Bit-op layer
167 *
168 * 1000|LLLL|0000 0000 set L to layer on press and set default on release(momentary)
169 * 1000|LLLL|0000 0001 set L to layer on press
170 * 1000|LLLL|0000 0010 set L to layer on release
171 * 1000|----|0000 0011 set default to layer on both(return to default layer)
172 * 1000|LLLL| keycode set L to layer while hold and send key on tap
173 * 1000|LLLL|1111 0000 set L to layer while hold and toggle on several taps
174 * 1000|LLLL|1111 1111 set L to default and layer(on press)
175 *
176 * 1001|BBBB|0000 0000 (not used)
177 * 1001|BBBB|0000 0001 bit-xor layer with B on press
178 * 1001|BBBB|0000 0010 bit-xor layer with B on release
179 * 1001|BBBB|0000 0011 bit-xor layer with B on both(momentary)
180 * 1001|BBBB| keycode bit-xor layer with B while hold and send key on tap
181 * 1001|BBBB|1111 0000 bit-xor layer with B while hold and toggle on several taps
182 * 1001|BBBB|1111 1111 bit-xor default with B and set layer(on press)
183 *
184 *
185 *
186 * Extensions(11XX)
187 * ----------------
188 * NOTE: NOT FIXED
189 *
190 * ACT_MACRO(1100):
191 * 1100|opt | id(8) Macro play?
192 * 1100|1111| id(8) Macro record?
193 *
194 * ACT_COMMAND(1110):
195 * 1110|opt | id(8) Built-in Command exec
196 *
197 * ACT_FUNCTION(1111):
198 * 1111| address(12) Function?
199 * 1111|opt | id(8) Function?
200 *
201 */
202 enum action_kind_id {
203 ACT_LMODS = 0b0000,
204 ACT_RMODS = 0b0001,
205 ACT_LMODS_TAP = 0b0010,
206 ACT_RMODS_TAP = 0b0011,
207
208 ACT_USAGE = 0b0100,
209 ACT_MOUSEKEY = 0b0101,
210
211 ACT_LAYER = 0b1000,
212 ACT_LAYER_BIT = 0b1001,
213
214 ACT_MACRO = 0b1100,
215 ACT_COMMAND = 0b1110,
216 ACT_FUNCTION = 0b1111
217 };
218
219
220 /* action utility */
221 #define ACTION_NO 0
222 #define ACTION_TRANSPARENT 1
223 #define ACTION(kind, param) ((kind)<<12 | (param))
224 #define MODS4(mods) (((mods)>>4 | (mods)) & 0x0F)
225
226 /* Key */
227 #define ACTION_KEY(key) ACTION(ACT_LMODS, key)
228 /* Mods & key */
229 #define ACTION_LMODS(mods) ACTION(ACT_LMODS, MODS4(mods)<<8 | 0x00)
230 #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, MODS4(mods)<<8 | (key))
231 #define ACTION_RMODS(mods) ACTION(ACT_RMODS, MODS4(mods)<<8 | 0x00)
232 #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, MODS4(mods)<<8 | (key))
233 /* Mod & key */
234 #define ACTION_LMOD(mod) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | 0x00)
235 #define ACTION_LMOD_KEY(mod, key) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | (key))
236 #define ACTION_RMOD(mod) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | 0x00)
237 #define ACTION_RMOD_KEY(mod, key) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | (key))
238
239 /* Mods + Tap key */
240 enum mods_codes {
241 MODS_ONESHOT = 0x00,
242 };
243 #define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key))
244 #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
245 #define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key))
246 #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
247 /* Mod + Tap key */
248 #define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
249 #define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
250 #define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
251 #define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
252
253
254 /*
255 * Switch layer
256 */
257 enum layer_codes {
258 LAYER_MOMENTARY = 0,
259 LAYER_ON_PRESS = 1,
260 LAYER_ON_RELEASE = 2,
261 LAYER_DEFAULT =3,
262 LAYER_TAP_TOGGLE = 0xF0,
263 LAYER_CHANGE_DEFAULT = 0xFF
264 };
265 enum layer_vals_default {
266 DEFAULT_ON_PRESS = 1,
267 DEFAULT_ON_RELEASE = 2,
268 DEFAULT_ON_BOTH = 3,
269 };
270
271 /*
272 * return to default layer
273 */
274 #define ACTION_LAYER_DEFAULT ACTION_LAYER_DEFAULT_R
275 /* set default layer on press */
276 #define ACTION_LAYER_DEFAULT_P ACTION(ACT_LAYER, DEFAULT_ON_PRESS<<8 | LAYER_DEFAULT)
277 /* set default layer on release */
278 #define ACTION_LAYER_DEFAULT_R ACTION(ACT_LAYER, DEFAULT_ON_RELEASE<<8 | LAYER_DEFAULT)
279 /* change default layer and set layer */
280
281 /*
282 * Set layer
283 */
284 /* set layer on press and none on release */
285 #define ACTION_LAYER_SET(layer) ACTION_LAYER_SET_P(layer)
286 /* set layer on press and set default on release (This is needed by legacy keymap support.) */
287 #define ACTION_LAYER_SET_MOMENTARY(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_MOMENTARY)
288 /* set layer on press and none on release */
289 #define ACTION_LAYER_SET_TOGGLE(layer) ACTION_LAYER_SET_R(layer)
290 /* set layer while hold and send key on tap */
291 #define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER, (layer)<<8 | (key))
292 /* set layer on press */
293 #define ACTION_LAYER_SET_P(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_ON_PRESS)
294 /* set layer on release */
295 #define ACTION_LAYER_SET_R(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_ON_RELEASE)
296 /* set layer on hold and toggle on several taps */
297 #define ACTION_LAYER_SET_TAP_TOGGLE(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_TAP_TOGGLE)
298 /* set default layer on both press and release */
299 #define ACTION_LAYER_SET_DEFAULT(layer) ACTION(ACT_LAYER, (layer)<<8 | LAYER_CHANGE_DEFAULT)
300
301 /*
302 * Bit-op layer
303 */
304 /* bit-xor on both press and release */
305 #define ACTION_LAYER_BIT(bits) ACTION_LAYER_BIT_MOMENTARY(bits)
306 #define ACTION_LAYER_BIT_MOMENTARY(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_MOMENTARY)
307 /* bit-xor on press */
308 #define ACTION_LAYER_BIT_TOGGLE(bits) ACTION_LAYER_BIT_R(bits)
309 /* bit-xor while hold and send key on tap */
310 #define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (bits)<<8 | (key))
311 /* bit-xor on press */
312 #define ACTION_LAYER_BIT_P(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_ON_PRESS)
313 /* bit-xor on release */
314 #define ACTION_LAYER_BIT_R(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_ON_RELEASE)
315 /* bit-xor while hold and toggle on several taps */
316 #define ACTION_LAYER_BIT_TAP_TOGGLE(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | LAYER_TAP_TOGGLE)
317 /* bit-xor default layer and set layer */
318 #define ACTION_LAYER_BIT_DEFAULT(bits) ACTION(ACT_LAYER, (bits)<<8 | LAYER_CHANGE_DEFAULT)
319
320
321 /* HID Usage */
322 enum usage_pages {
323 PAGE_SYSTEM,
324 PAGE_CONSUMER
325 };
326 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
327 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
328
329 /* Mousekey */
330 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
331
332 /* Macro */
333 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
334
335 /* Command */
336 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
337
338 /* Function */
339 enum function_opts {
340 FUNC_TAP = 0x8, /* indciates function is tappable */
341 };
342 #define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id)
343 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | id)
344
345 #endif /* ACTION_H */
Imprint / Impressum