core: Change MOD_* definition to make OR(|) usable
[tmk_keyboard.git] / tmk_core / common / action_code.h
1 /*
2 Copyright 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_CODE_H
18 #define ACTION_CODE_H
19
20 /* Action codes
21 * ============
22 * 16bit code: action_kind(4bit) + action_parameter(12bit)
23 *
24 *
25 * Key Actions(00xx)
26 * -----------------
27 * ACT_MODS(000r):
28 * 000r|0000|0000 0000 No action code
29 * 000r|0000|0000 0001 Transparent code
30 * 000r|0000| keycode Key
31 * 000r|mods|0000 0000 Modifiers
32 * 000r|mods| keycode Modifiers+key(Modified key)
33 * r: Left/Right flag(Left:0, Right:1)
34 *
35 * ACT_MODS_TAP(001r):
36 * 001r|mods|0000 0000 Modifiers with OneShot[TAP]
37 * 001r|mods|0000 0001 Modifiers with tap toggle[TAP]
38 * 001r|mods|0000 00xx (reserved) (0x02-03)
39 * 001r|mods| keycode Modifiers with tap key(0x04-A4, E0-E7)[TAP]
40 * (reserved) (0xA5-DF, E8-FF)
41 *
42 *
43 * Other Keys(01xx)
44 * ----------------
45 * ACT_USAGE(0100): TODO: Not needed?
46 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
47 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
48 * 0100|10| usage(10) (reserved)
49 * 0100|11| usage(10) (reserved)
50 *
51 * ACT_MOUSEKEY(0110): TODO: Not needed?
52 * 0101|xxxx| keycode Mouse key
53 *
54 * 011x|xxxx xxxx xxxx (reseved)
55 *
56 *
57 * Layer Actions(10xx)
58 * -------------------
59 * ACT_LAYER(1000):
60 * 1000|oo00|pppE BBBB Default Layer Bitwise operation
61 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
62 * ppp: 4-bit chunk part(0-7)
63 * EBBBB: bits and extra bit
64 * 1000|ooee|pppE BBBB Layer Bitwise Operation
65 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
66 * ppp: 4-bit chunk part(0-7)
67 * EBBBB: bits and extra bit
68 * ee: on event(01:press, 10:release, 11:both)
69 *
70 * 1001|xxxx|xxxx xxxx (reserved)
71 * 1001|oopp|BBBB BBBB 8-bit Bitwise Operation???
72 *
73 * ACT_LAYER_TAP(101x):
74 * 101E|LLLL| keycode On/Off with tap key (0x04-A4, E0-E7)[TAP]
75 * 101E|LLLL|110r mods On/Off with modifiers (0xC0-DF)[NOT TAP]
76 * r: Left/Right flag(Left:0, Right:1)
77 * (reserved) (0xA5-BF, E8-EF)
78 * 101E|LLLL|1111 0000 Invert with tap toggle (0xF0) [TAP]
79 * 101E|LLLL|1111 0001 On/Off (0xF1) [NOT TAP]
80 * 101E|LLLL|1111 0010 Off/On (0xF2) [NOT TAP]
81 * 101E|LLLL|1111 0011 Set/Clear (0xF3) [NOT TAP]
82 * 101E|LLLL|1111 xxxx (reserved) (0xF4-FF)
83 * ELLLL: layer 0-31(E: extra bit for layer 16-31)
84 *
85 *
86 * Extensions(11xx)
87 * ----------------
88 * ACT_MACRO(1100):
89 * 1100|opt | id(8) Macro play?
90 * 1100|1111| id(8) Macro record?
91 *
92 * ACT_BACKLIGHT(1101):
93 * 1101|opt |level(8) Backlight commands
94 *
95 * ACT_COMMAND(1110):
96 * 1110|opt | id(8) Built-in Command exec
97 *
98 * ACT_FUNCTION(1111):
99 * 1111| address(12) Function?
100 * 1111|opt | id(8) Function?
101 */
102 enum action_kind_id {
103 /* Key Actions */
104 ACT_MODS = 0b0000,
105 ACT_LMODS = 0b0000,
106 ACT_RMODS = 0b0001,
107 ACT_MODS_TAP = 0b0010,
108 ACT_LMODS_TAP = 0b0010,
109 ACT_RMODS_TAP = 0b0011,
110 /* Other Keys */
111 ACT_USAGE = 0b0100,
112 ACT_MOUSEKEY = 0b0101,
113 /* Layer Actions */
114 ACT_LAYER = 0b1000,
115 ACT_LAYER_TAP = 0b1010, /* Layer 0-15 */
116 ACT_LAYER_TAP_EXT = 0b1011, /* Layer 16-31 */
117 /* Extensions */
118 ACT_MACRO = 0b1100,
119 ACT_BACKLIGHT = 0b1101,
120 ACT_COMMAND = 0b1110,
121 ACT_FUNCTION = 0b1111
122 };
123
124
125 /* Action Code Struct
126 *
127 * NOTE:
128 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
129 * AVR looks like a little endian in avr-gcc.
130 * Not portable across compiler/endianness?
131 *
132 * Byte order and bit order of 0x1234:
133 * Big endian: Little endian:
134 * -------------------- --------------------
135 * FEDC BA98 7654 3210 0123 4567 89AB CDEF
136 * 0001 0010 0011 0100 0010 1100 0100 1000
137 * 0x12 0x34 0x34 0x12
138 */
139 typedef union {
140 uint16_t code;
141 struct action_kind {
142 uint16_t param :12;
143 uint8_t id :4;
144 } kind;
145 struct action_key {
146 uint8_t code :8;
147 uint8_t mods :4;
148 uint8_t kind :4;
149 } key;
150 struct action_layer_bitop {
151 uint8_t bits :4;
152 uint8_t xbit :1;
153 uint8_t part :3;
154 uint8_t on :2;
155 uint8_t op :2;
156 uint8_t kind :4;
157 } layer_bitop;
158 struct action_layer_tap {
159 uint8_t code :8;
160 uint8_t val :5;
161 uint8_t kind :3;
162 } layer_tap;
163 struct action_usage {
164 uint16_t code :10;
165 uint8_t page :2;
166 uint8_t kind :4;
167 } usage;
168 struct action_backlight {
169 uint8_t level :8;
170 uint8_t opt :4;
171 uint8_t kind :4;
172 } backlight;
173 struct action_command {
174 uint8_t id :8;
175 uint8_t opt :4;
176 uint8_t kind :4;
177 } command;
178 struct action_function {
179 uint8_t id :8;
180 uint8_t opt :4;
181 uint8_t kind :4;
182 } func;
183 } action_t;
184
185
186 /* action utility */
187 #define ACTION_NO { .code = 0 }
188 #define ACTION_TRANSPARENT { .code = 1 }
189 #define ACTION(kind, param) { .code = ((kind)<<12 | (param)) }
190
191
192 /*
193 * Key Actions
194 */
195 /* Mod bits: 43210
196 * bit 0 ||||+- Control
197 * bit 1 |||+-- Shift
198 * bit 2 ||+--- Alt
199 * bit 3 |+---- Gui
200 * bit 4 +----- LR flag(Left:0, Right:1)
201 */
202 enum mods_bit {
203 MOD_NONE = 0x0000,
204 MOD_LCTL = 0x0100,
205 MOD_LSFT = 0x0200,
206 MOD_LALT = 0x0400,
207 MOD_LGUI = 0x0800,
208 MOD_RCTL = 0x1100,
209 MOD_RSFT = 0x1200,
210 MOD_RALT = 0x1400,
211 MOD_RGUI = 0x1800,
212 };
213 enum mods_codes {
214 MODS_ONESHOT = 0x00,
215 MODS_TAP_TOGGLE = 0x01,
216 };
217 #define ACTION_KEY(key) ACTION(ACT_MODS, (key))
218 #define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f00) | 0)
219 #define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f00) | (key))
220 #define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | (key))
221 #define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | MODS_ONESHOT)
222 #define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | MODS_TAP_TOGGLE)
223
224
225 /*
226 * Other Keys
227 */
228 enum usage_pages {
229 PAGE_SYSTEM,
230 PAGE_CONSUMER
231 };
232 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
233 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
234 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
235
236
237
238 /*
239 * Layer Actions
240 */
241 enum layer_param_on {
242 ON_PRESS = 1,
243 ON_RELEASE = 2,
244 ON_BOTH = 3,
245 };
246 enum layer_param_bit_op {
247 OP_BIT_AND = 0,
248 OP_BIT_OR = 1,
249 OP_BIT_XOR = 2,
250 OP_BIT_SET = 3,
251 };
252 enum layer_pram_tap_op {
253 OP_TAP_TOGGLE = 0xF0,
254 OP_ON_OFF,
255 OP_OFF_ON,
256 OP_SET_CLEAR,
257 };
258 #define ACTION_LAYER_BITOP(op, part, bits, on) ACTION(ACT_LAYER, (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
259 #define ACTION_LAYER_TAP(layer, key) ACTION(ACT_LAYER_TAP, (layer)<<8 | (key))
260 /* Default Layer */
261 #define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
262 #define ACTION_DEFAULT_LAYER_TOGGLE(layer) ACTION_DEFAULT_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4))
263 /* Layer Operation */
264 #define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
265 #define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
266 #define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
267 #define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
268 #define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
269 #define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
270 #define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
271 #define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
272 #define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
273 #define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
274 #define ACTION_LAYER_MODS(layer, mods) ACTION_LAYER_TAP((layer), 0xc0 | ((mods>>8)&0x1f))
275 /* With Tapping */
276 #define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
277 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
278 /* Bitwise Operation */
279 #define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
280 #define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
281 #define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
282 #define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
283 /* Default Layer Bitwise Operation */
284 #define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
285 #define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
286 #define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
287 #define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
288
289
290 /*
291 * Extensions
292 */
293 enum backlight_opt {
294 BACKLIGHT_INCREASE = 0,
295 BACKLIGHT_DECREASE = 1,
296 BACKLIGHT_TOGGLE = 2,
297 BACKLIGHT_STEP = 3,
298 BACKLIGHT_LEVEL = 4,
299 };
300 /* Macro */
301 #define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
302 #define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
303 #define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
304 /* Backlight */
305 #define ACTION_BACKLIGHT_INCREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
306 #define ACTION_BACKLIGHT_DECREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
307 #define ACTION_BACKLIGHT_TOGGLE() ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
308 #define ACTION_BACKLIGHT_STEP() ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
309 #define ACTION_BACKLIGHT_LEVEL(level) ACTION(ACT_BACKLIGHT, BACKLIGHT_LEVEL << 8 | level)
310 /* Command */
311 #define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
312 /* Function */
313 enum function_opts {
314 FUNC_TAP = 0x8, /* indciates function is tappable */
315 };
316 #define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
317 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
318 #define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
319
320 #endif /* ACTION_CODE_H */
Imprint / Impressum