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