aboutsummaryrefslogtreecommitdiff
path: root/common
diff options
context:
space:
mode:
authortmk <nobody@nowhere>2013-04-04 15:16:03 +0900
committertmk <nobody@nowhere>2013-04-04 15:16:03 +0900
commitebe798f081ce018826dc882a40fc77ec8a0ad023 (patch)
treee3470eeaf5eade63521a9d11e08ccc579ba7e7a7 /common
parent6b155432ddcc613ecb1e1c1decf46d61faf09e77 (diff)
downloadqmk_firmware-ebe798f081ce018826dc882a40fc77ec8a0ad023.tar.gz
qmk_firmware-ebe798f081ce018826dc882a40fc77ec8a0ad023.zip
Add file action_code.h
Diffstat (limited to 'common')
-rw-r--r--common/action.h288
-rw-r--r--common/action_code.h288
2 files changed, 290 insertions, 286 deletions
diff --git a/common/action.h b/common/action.h
index 49c7879e6..5f659337f 100644
--- a/common/action.h
+++ b/common/action.h
@@ -21,9 +21,11 @@ along with this program. If not, see <http://www.gnu.org/licenses/>.
21#include <stdbool.h> 21#include <stdbool.h>
22#include "keyboard.h" 22#include "keyboard.h"
23#include "keycode.h" 23#include "keycode.h"
24#include "action_code.h"
24#include "action_macro.h" 25#include "action_macro.h"
25 26
26 27
28/* Key event container for recording */
27typedef struct { 29typedef struct {
28 keyevent_t event; 30 keyevent_t event;
29#ifndef NO_ACTION_TAPPING 31#ifndef NO_ACTION_TAPPING
@@ -38,62 +40,6 @@ typedef struct {
38#endif 40#endif
39} keyrecord_t; 41} keyrecord_t;
40 42
41/* Action struct.
42 *
43 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
44 * AVR looks like a little endian in avr-gcc.
45 *
46 * NOTE: not portable across compiler/endianness?
47 * Byte order and bit order of 0x1234:
48 * Big endian: 15 ... 8 7 ... 210
49 * | 0x12 | 0x34 |
50 * 0001 0010 0011 0100
51 * Little endian: 012 ... 7 8 ... 15
52 * | 0x34 | 0x12 |
53 * 0010 1100 0100 1000
54 */
55typedef union {
56 uint16_t code;
57 struct action_kind {
58 uint16_t param :12;
59 uint8_t id :4;
60 } kind;
61 struct action_key {
62 uint8_t code :8;
63 uint8_t mods :4;
64 uint8_t kind :4;
65 } key;
66 struct action_layer_bitop {
67 uint8_t bits :4;
68 uint8_t xbit :1;
69 uint8_t part :3;
70 uint8_t on :2;
71 uint8_t op :2;
72 uint8_t kind :4;
73 } layer_bitop;
74 struct action_layer_tap {
75 uint8_t code :8;
76 uint8_t val :5;
77 uint8_t kind :3;
78 } layer_tap;
79 struct action_usage {
80 uint16_t code :10;
81 uint8_t page :2;
82 uint8_t kind :4;
83 } usage;
84 struct action_command {
85 uint8_t id :8;
86 uint8_t opt :4;
87 uint8_t kind :4;
88 } command;
89 struct action_function {
90 uint8_t id :8;
91 uint8_t opt :4;
92 uint8_t kind :4;
93 } func;
94} action_t;
95
96
97 43
98/* Execute action per keyevent */ 44/* Execute action per keyevent */
99void action_exec(keyevent_t event); 45void action_exec(keyevent_t event);
@@ -125,234 +71,4 @@ void debug_event(keyevent_t event);
125void debug_record(keyrecord_t record); 71void debug_record(keyrecord_t record);
126void debug_action(action_t action); 72void debug_action(action_t action);
127 73
128
129
130/*
131 * Action codes
132 * ============
133 * 16bit code: action_kind(4bit) + action_parameter(12bit)
134 *
135 * Keyboard Keys(00XX)
136 * -------------------
137 * ACT_LMODS(0000):
138 * 0000|0000|000000|00 No action
139 * 0000|0000|000000|01 Transparent
140 * 0000|0000| keycode Key
141 * 0000|mods|000000|00 Left mods
142 * 0000|mods| keycode Key & Left mods
143 *
144 * ACT_RMODS(0001):
145 * 0001|0000|000000|00 No action(not used)
146 * 0001|0000|000000|01 Transparent(not used)
147 * 0001|0000| keycode Key(no used)
148 * 0001|mods|000000|00 Right mods
149 * 0001|mods| keycode Key & Right mods
150 *
151 * ACT_LMODS_TAP(0010):
152 * 0010|mods|000000|00 Left mods OneShot
153 * 0010|mods|000000|01 (reserved)
154 * 0010|mods|000000|10 (reserved)
155 * 0010|mods|000000|11 (reserved)
156 * 0010|mods| keycode Left mods + tap Key
157 *
158 * ACT_RMODS_TAP(0011):
159 * 0011|mods|000000|00 Right mods OneShot
160 * 0011|mods|000000|01 (reserved)
161 * 0011|mods|000000|10 (reserved)
162 * 0011|mods|000000|11 (reserved)
163 * 0011|mods| keycode Right mods + tap Key
164 *
165 *
166 * Other keys(01XX)
167 * --------------------
168 * This action handles other usages than keyboard.
169 * ACT_USAGE(0100):
170 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
171 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
172 * 0100|10| usage(10) (reserved)
173 * 0100|11| usage(10) (reserved)
174 *
175 * ACT_MOUSEKEY(0110):
176 * 0101|XXXX| keycode Mouse key
177 *
178 *
179 * Layer Actions(10XX)
180 * -------------------
181 * ACT_LAYER:
182 * 1000|oo00|pppx BBBB Default Layer Bitwise operation
183 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
184 * ppp: 4-bit chunk part(0-7)
185 * xBBBB: bits and extra bit
186 * 1000|ooee|pppx BBBB Layer Bitwise Operation
187 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
188 * ppp: 4-bit chunk part(0-7)
189 * xBBBB: bits and extra bit
190 * ee: on event(00:default layer, 01:press, 10:release, 11:both)
191 *
192 * ACT_LAYER_TAP:
193 * 101x|LLLL| keycode Invert with tap key
194 * 101x|LLLL|1110 xxxx Reserved(0xE0-EF)
195 * 101x|LLLL|1111 0000 Invert with tap toggle(0xF0)
196 * 101x|LLLL|1111 0001 On Off
197 * 101x|LLLL|1111 0010 Off On
198 * 101x|LLLL|1111 0011 Set Clear
199 * 101x|LLLL|1111 xxxx Reserved(0xF4-FF)
200 * xLLLL: layer(0-31)
201 *
202 *
203 *
204 *
205 *
206 * Extensions(11XX)
207 * ----------------
208 * ACT_MACRO(1100):
209 * 1100|opt | id(8) Macro play?
210 * 1100|1111| id(8) Macro record?
211 *
212 * ACT_COMMAND(1110):
213 * 1110|opt | id(8) Built-in Command exec
214 *
215 * ACT_FUNCTION(1111):
216 * 1111| address(12) Function?
217 * 1111|opt | id(8) Function?
218 *
219 */
220enum action_kind_id {
221 ACT_MODS = 0b0000,
222 ACT_LMODS = 0b0000,
223 ACT_RMODS = 0b0001,
224 ACT_MODS_TAP = 0b0010,
225 ACT_LMODS_TAP = 0b0010,
226 ACT_RMODS_TAP = 0b0011,
227
228 ACT_USAGE = 0b0100,
229 ACT_MOUSEKEY = 0b0101,
230
231 ACT_LAYER = 0b1000,
232 ACT_LAYER_TAP = 0b1010,
233 ACT_LAYER_TAP1 = 0b1011,
234
235 ACT_MACRO = 0b1100,
236 ACT_COMMAND = 0b1110,
237 ACT_FUNCTION = 0b1111
238};
239
240
241/* action utility */
242#define ACTION_NO 0
243#define ACTION_TRANSPARENT 1
244#define ACTION(kind, param) ((kind)<<12 | (param))
245#define MODS4(mods) (((mods)>>4 | (mods)) & 0x0F)
246
247/*
248 * Key
249 */
250#define ACTION_KEY(key) ACTION(ACT_LMODS, key)
251/* Mods & key */
252#define ACTION_LMODS(mods) ACTION(ACT_LMODS, MODS4(mods)<<8 | 0x00)
253#define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, MODS4(mods)<<8 | (key))
254#define ACTION_RMODS(mods) ACTION(ACT_RMODS, MODS4(mods)<<8 | 0x00)
255#define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, MODS4(mods)<<8 | (key))
256#define ACTION_LMOD(mod) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | 0x00)
257#define ACTION_LMOD_KEY(mod, key) ACTION(ACT_LMODS, MODS4(MOD_BIT(mod))<<8 | (key))
258#define ACTION_RMOD(mod) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | 0x00)
259#define ACTION_RMOD_KEY(mod, key) ACTION(ACT_RMODS, MODS4(MOD_BIT(mod))<<8 | (key))
260/* Tap key */
261enum mods_codes {
262 MODS_ONESHOT = 0x00,
263};
264#define ACTION_LMODS_TAP_KEY(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key))
265#define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
266#define ACTION_RMODS_TAP_KEY(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key))
267#define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | MODS_ONESHOT)
268#define ACTION_LMOD_TAP_KEY(mod, key) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
269#define ACTION_LMOD_ONESHOT(mod) ACTION(ACT_LMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
270#define ACTION_RMOD_TAP_KEY(mod, key) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | (key))
271#define ACTION_RMOD_ONESHOT(mod) ACTION(ACT_RMODS_TAP, MODS4(MOD_BIT(mod))<<8 | MODS_ONESHOT)
272
273/* HID Usage */
274enum usage_pages {
275 PAGE_SYSTEM,
276 PAGE_CONSUMER
277};
278#define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
279#define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
280
281/* Mousekey */
282#define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
283
284
285
286/* Layer Actions */
287enum layer_param_on {
288 ON_PRESS = 1,
289 ON_RELEASE = 2,
290 ON_BOTH = 3,
291};
292
293enum layer_param_bit_op {
294 OP_BIT_AND = 0,
295 OP_BIT_OR,
296 OP_BIT_XOR,
297 OP_BIT_SET,
298};
299
300enum layer_pram_tap_op {
301 OP_TAP_TOGGLE = 0xF0,
302 OP_ON_OFF,
303 OP_OFF_ON,
304 OP_SET_CLEAR,
305};
306
307/* Layer Bitwise Operation 1000|ooee|pppx BBBB */
308#define ACTION_LAYER_BITOP(op, part, bits, on) (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
309/* Layer with Tapping 101x|LLLL| keycode */
310#define ACTION_LAYER_TAP(layer, key) (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
311
312/* Default Layer Operation */
313#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
314/* Layer Operation */
315#define ACTION_LAYER_CLEAR(on) ACTION_LAYER_AND(0x1f, (on))
316#define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
317#define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
318#define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
319#define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
320#define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
321#define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
322#define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
323#define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
324#define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
325/* Bitwise Operation */
326#define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
327#define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
328#define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
329#define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
330#define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
331#define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
332#define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
333#define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
334/* with Tapping */
335#define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
336#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
337
338
339/*
340 * Extensions
341 */
342/* Macro */
343#define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
344#define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
345#define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
346
347/* Command */
348#define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
349
350/* Function */
351enum function_opts {
352 FUNC_TAP = 0x8, /* indciates function is tappable */
353};
354#define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
355#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
356#define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
357
358#endif /* ACTION_H */ 74#endif /* ACTION_H */
diff --git a/common/action_code.h b/common/action_code.h
new file mode 100644
index 000000000..8ebcc833d
--- /dev/null
+++ b/common/action_code.h
@@ -0,0 +1,288 @@
1/*
2Copyright 2013 Jun Wako <wakojun@gmail.com>
3
4This program is free software: you can redistribute it and/or modify
5it under the terms of the GNU General Public License as published by
6the Free Software Foundation, either version 2 of the License, or
7(at your option) any later version.
8
9This program is distributed in the hope that it will be useful,
10but WITHOUT ANY WARRANTY; without even the implied warranty of
11MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12GNU General Public License for more details.
13
14You should have received a copy of the GNU General Public License
15along 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 Key and Modifiers
33 * r: Left/Right flag(Left:0, Right:1)
34 *
35 * ACT_MODS_TAP(001r):
36 * 0010|mods|0000 0000 Modifiers with OneShot
37 * 0010|mods|0000 00xx (reserved)
38 * 0010|mods| keycode Modifiers with Tap Key
39 *
40 *
41 * Other Keys(01xx)
42 * ----------------
43 * ACT_USAGE(0100):
44 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
45 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
46 * 0100|10| usage(10) (reserved)
47 * 0100|11| usage(10) (reserved)
48 *
49 * ACT_MOUSEKEY(0110): TODO: Not needed?
50 * 0101|xxxx| keycode Mouse key
51 *
52 * 011x|xxxx xxxx xxxx (reseved)
53 *
54 *
55 * Layer Actions(10xx)
56 * -------------------
57 * ACT_LAYER(1000):
58 * 1000|oo00|pppE BBBB Default Layer Bitwise operation
59 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
60 * ppp: 4-bit chunk part(0-7)
61 * EBBBB: bits and extra bit
62 * 1000|ooee|pppE BBBB Layer Bitwise Operation
63 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
64 * ppp: 4-bit chunk part(0-7)
65 * eBBBB: bits and extra bit
66 * ee: on event(00:default layer, 01:press, 10:release, 11:both)
67 *
68 * 1001|xxxx|xxxx xxxx (reserved)
69 *
70 * ACT_LAYER_TAP(101x):
71 * 101E|LLLL| keycode Invert with tap key
72 * 101E|LLLL|1110 xxxx Reserved(0xE0-EF)
73 * 101E|LLLL|1111 0000 Invert with tap toggle(0xF0)
74 * 101E|LLLL|1111 0001 On/Off
75 * 101E|LLLL|1111 0010 Off/On
76 * 101E|LLLL|1111 0011 Set/Clear
77 * 101E|LLLL|1111 xxxx Reserved(0xF4-FF)
78 * ELLLL: layer(0-31)
79 *
80 *
81 * Extensions(11xx)
82 * ----------------
83 * ACT_MACRO(1100):
84 * 1100|opt | id(8) Macro play?
85 * 1100|1111| id(8) Macro record?
86 *
87 * ACT_COMMAND(1110):
88 * 1110|opt | id(8) Built-in Command exec
89 *
90 * ACT_FUNCTION(1111):
91 * 1111| address(12) Function?
92 * 1111|opt | id(8) Function?
93 */
94enum action_kind_id {
95 /* Key Actions */
96 ACT_MODS = 0b0000,
97 ACT_LMODS = 0b0000,
98 ACT_RMODS = 0b0001,
99 ACT_MODS_TAP = 0b0010,
100 ACT_LMODS_TAP = 0b0010,
101 ACT_RMODS_TAP = 0b0011,
102 /* Other Keys */
103 ACT_USAGE = 0b0100,
104 ACT_MOUSEKEY = 0b0101,
105 /* Layer Actions */
106 ACT_LAYER = 0b1000,
107 ACT_LAYER_TAP = 0b1010,
108 ACT_LAYER_TAP1 = 0b1011,
109 /* Extensions */
110 ACT_MACRO = 0b1100,
111 ACT_COMMAND = 0b1110,
112 ACT_FUNCTION = 0b1111
113};
114
115
116/* Action Code Struct
117 *
118 * NOTE:
119 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
120 * AVR looks like a little endian in avr-gcc.
121 * Not portable across compiler/endianness?
122 *
123 * Byte order and bit order of 0x1234:
124 * Big endian: Little endian:
125 * -------------------- --------------------
126 * FEDC BA98 7654 3210 0123 4567 89AB CDEF
127 * 0001 0010 0011 0100 0010 1100 0100 1000
128 * 0x12 0x34 0x34 0x12
129 */
130typedef union {
131 uint16_t code;
132 struct action_kind {
133 uint16_t param :12;
134 uint8_t id :4;
135 } kind;
136 struct action_key {
137 uint8_t code :8;
138 uint8_t mods :4;
139 uint8_t kind :4;
140 } key;
141 struct action_layer_bitop {
142 uint8_t bits :4;
143 uint8_t xbit :1;
144 uint8_t part :3;
145 uint8_t on :2;
146 uint8_t op :2;
147 uint8_t kind :4;
148 } layer_bitop;
149 struct action_layer_tap {
150 uint8_t code :8;
151 uint8_t val :5;
152 uint8_t kind :3;
153 } layer_tap;
154 struct action_usage {
155 uint16_t code :10;
156 uint8_t page :2;
157 uint8_t kind :4;
158 } usage;
159 struct action_command {
160 uint8_t id :8;
161 uint8_t opt :4;
162 uint8_t kind :4;
163 } command;
164 struct action_function {
165 uint8_t id :8;
166 uint8_t opt :4;
167 uint8_t kind :4;
168 } func;
169} action_t;
170
171
172/* action utility */
173#define ACTION_NO 0
174#define ACTION_TRANSPARENT 1
175#define ACTION(kind, param) ((kind)<<12 | (param))
176
177
178/*
179 * Key Actions
180 */
181/* Mod bits: 43210
182 * bit 0 ||||+- Control
183 * bit 1 |||+-- Shift
184 * bit 2 ||+--- Alt
185 * bit 3 |+---- Gui
186 * bit 4 +----- LR flag(Left:0, Right:1)
187 */
188enum mods_bit {
189 MOD_LCTL = 0x01,
190 MOD_LSFT = 0x02,
191 MOD_LALT = 0x04,
192 MOD_LGUI = 0x08,
193 MOD_RCTL = 0x11,
194 MOD_RSFT = 0x12,
195 MOD_RALT = 0x14,
196 MOD_RGUI = 0x18,
197};
198enum mods_codes {
199 MODS_ONESHOT = 0x00,
200};
201#define ACTION_KEY(key) ACTION(ACT_MODS, (key))
202#define ACTION_MODS(mods) ACTION(ACT_MODS, (mods)<<8 | 0)
203#define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, (mods)<<8 | (key))
204#define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, (mods)<<8 | (key))
205#define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, (mods)<<8 | MODS_ONESHOT)
206
207
208/*
209 * Other Keys
210 */
211enum usage_pages {
212 PAGE_SYSTEM,
213 PAGE_CONSUMER
214};
215#define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
216#define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
217#define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
218
219
220
221/*
222 * Layer Actions
223 */
224enum layer_param_on {
225 ON_PRESS = 1,
226 ON_RELEASE = 2,
227 ON_BOTH = 3,
228};
229enum layer_param_bit_op {
230 OP_BIT_AND = 0,
231 OP_BIT_OR = 1,
232 OP_BIT_XOR = 2,
233 OP_BIT_SET = 3,
234};
235enum layer_pram_tap_op {
236 OP_TAP_TOGGLE = 0xF0,
237 OP_ON_OFF,
238 OP_OFF_ON,
239 OP_SET_CLEAR,
240};
241#define ACTION_LAYER_BITOP(op, part, bits, on) (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
242#define ACTION_LAYER_TAP(layer, key) (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
243/* Layer Operation */
244#define ACTION_LAYER_CLEAR(on) ACTION_LAYER_AND(0x1f, (on))
245#define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
246#define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
247#define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
248#define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
249#define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
250#define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
251#define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
252#define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
253#define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
254/* Bitwise Operation */
255#define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
256#define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
257#define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
258#define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
259/* Default Layer */
260#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
261/* Default Layer Bitwise Operation */
262#define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
263#define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
264#define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
265#define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
266/* With Tapping */
267#define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
268#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
269
270
271/*
272 * Extensions
273 */
274/* Macro */
275#define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
276#define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
277#define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
278/* Command */
279#define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
280/* Function */
281enum function_opts {
282 FUNC_TAP = 0x8, /* indciates function is tappable */
283};
284#define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
285#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
286#define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
287
288#endif /* ACTION_CODE_H */
generated by cgit v1.2.3 (git 2.25.1) at 2025-11-27 00:30:15 +0000