f77: Add jackhill's layout
[jackhill/qmk/firmware.git] / tmk_core / common / action_code.h
CommitLineData
a074364c 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
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 *
26eef35f 89 * 1101|xxxx xxxx xxxx (reserved)
e967471c 90 * 1110|xxxx xxxx xxxx (reserved)
a074364c 91 *
92 * ACT_FUNCTION(1111):
93 * 1111| address(12) Function?
94 * 1111|opt | id(8) Function?
95 */
96enum action_kind_id {
97 /* Key Actions */
b624f32f 98 ACT_MODS = 0b0000,
99 ACT_LMODS = 0b0000,
100 ACT_RMODS = 0b0001,
101 ACT_MODS_TAP = 0b0010,
102 ACT_LMODS_TAP = 0b0010,
103 ACT_RMODS_TAP = 0b0011,
a074364c 104 /* Other Keys */
b624f32f 105 ACT_USAGE = 0b0100,
106 ACT_MOUSEKEY = 0b0101,
8090f6b4 107 /* One-hand Support */
b624f32f 108 ACT_SWAP_HANDS = 0b0110,
a074364c 109 /* Layer Actions */
b624f32f 110 ACT_LAYER = 0b1000,
111 ACT_LAYER_MODS = 0b1001,
112 ACT_LAYER_TAP = 0b1010, /* Layer 0-15 */
113 ACT_LAYER_TAP_EXT = 0b1011, /* Layer 16-31 */
a074364c 114 /* Extensions */
26eef35f 115 ACT_MACRO = 0b1100,
26eef35f 116 ACT_FUNCTION = 0b1111
a074364c 117};
118
7c9d5ace 119/** \brief Action Code Struct
a074364c 120 *
121 * NOTE:
122 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
123 * AVR looks like a little endian in avr-gcc.
124 * Not portable across compiler/endianness?
125 *
126 * Byte order and bit order of 0x1234:
127 * Big endian: Little endian:
128 * -------------------- --------------------
129 * FEDC BA98 7654 3210 0123 4567 89AB CDEF
130 * 0001 0010 0011 0100 0010 1100 0100 1000
131 * 0x12 0x34 0x34 0x12
132 */
133typedef union {
134 uint16_t code;
135 struct action_kind {
b624f32f 136 uint16_t param : 12;
137 uint8_t id : 4;
a074364c 138 } kind;
139 struct action_key {
b624f32f 140 uint8_t code : 8;
141 uint8_t mods : 4;
142 uint8_t kind : 4;
a074364c 143 } key;
144 struct action_layer_bitop {
b624f32f 145 uint8_t bits : 4;
146 uint8_t xbit : 1;
147 uint8_t part : 3;
148 uint8_t on : 2;
149 uint8_t op : 2;
150 uint8_t kind : 4;
a074364c 151 } layer_bitop;
b624f32f 152 struct action_layer_mods {
153 uint8_t mods : 8;
154 uint8_t layer : 4;
155 uint8_t kind : 4;
2f6c068e 156 } layer_mods;
a074364c 157 struct action_layer_tap {
b624f32f 158 uint8_t code : 8;
159 uint8_t val : 5;
160 uint8_t kind : 3;
a074364c 161 } layer_tap;
162 struct action_usage {
b624f32f 163 uint16_t code : 10;
164 uint8_t page : 2;
165 uint8_t kind : 4;
a074364c 166 } usage;
a074364c 167 struct action_function {
b624f32f 168 uint8_t id : 8;
169 uint8_t opt : 4;
170 uint8_t kind : 4;
a074364c 171 } func;
8090f6b4 172 struct action_swap {
b624f32f 173 uint8_t code : 8;
174 uint8_t opt : 4;
175 uint8_t kind : 4;
8090f6b4 176 } swap;
a074364c 177} action_t;
178
a074364c 179/* action utility */
b624f32f 180#define ACTION_NO 0
181#define ACTION_TRANSPARENT 1
182#define ACTION(kind, param) ((kind) << 12 | (param))
a074364c 183
7c9d5ace 184/** \brief Key Actions
185 *
186 * Mod bits: 43210
a074364c 187 * bit 0 ||||+- Control
188 * bit 1 |||+-- Shift
189 * bit 2 ||+--- Alt
190 * bit 3 |+---- Gui
191 * bit 4 +----- LR flag(Left:0, Right:1)
192 */
193enum mods_bit {
194 MOD_LCTL = 0x01,
195 MOD_LSFT = 0x02,
196 MOD_LALT = 0x04,
197 MOD_LGUI = 0x08,
198 MOD_RCTL = 0x11,
199 MOD_RSFT = 0x12,
200 MOD_RALT = 0x14,
201 MOD_RGUI = 0x18,
202};
203enum mods_codes {
b624f32f 204 MODS_ONESHOT = 0x00,
a074364c 205 MODS_TAP_TOGGLE = 0x01,
206};
b624f32f 207#define ACTION_KEY(key) ACTION(ACT_MODS, (key))
208#define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f) << 8 | 0)
209#define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f) << 8 | (key))
210#define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f) << 8 | (key))
211#define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f) << 8 | MODS_ONESHOT)
212#define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f) << 8 | MODS_TAP_TOGGLE)
a074364c 213
7c9d5ace 214/** \brief Other Keys
a074364c 215 */
b624f32f 216enum usage_pages { PAGE_SYSTEM, PAGE_CONSUMER };
217#define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM << 10 | (id))
218#define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER << 10 | (id))
219#define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
a074364c 220
7c9d5ace 221/** \brief Layer Actions
a074364c 222 */
223enum layer_param_on {
b624f32f 224 ON_PRESS = 1,
225 ON_RELEASE = 2,
226 ON_BOTH = 3,
a074364c 227};
7c9d5ace 228
229/** \brief Layer Actions
230 */
a074364c 231enum layer_param_bit_op {
232 OP_BIT_AND = 0,
233 OP_BIT_OR = 1,
234 OP_BIT_XOR = 2,
235 OP_BIT_SET = 3,
236};
7c9d5ace 237
238/** \brief Layer Actions
239 */
5d771039 240enum layer_param_tap_op {
a074364c 241 OP_TAP_TOGGLE = 0xF0,
242 OP_ON_OFF,
243 OP_OFF_ON,
244 OP_SET_CLEAR,
74e97eef 245 OP_ONESHOT,
a074364c 246};
b624f32f 247#define ACTION_LAYER_BITOP(op, part, bits, on) ACTION(ACT_LAYER, (op) << 10 | (on) << 8 | (part) << 5 | ((bits)&0x1f))
248#define ACTION_LAYER_TAP(layer, key) ACTION(ACT_LAYER_TAP, (layer) << 8 | (key))
a074364c 249/* Default Layer */
b624f32f 250#define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer) / 4, 1 << ((layer) % 4))
a074364c 251/* Layer Operation */
b624f32f 252#define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
253#define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
254#define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
255#define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer) / 4, 1 << ((layer) % 4), (on))
256#define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR((layer) / 4, 1 << ((layer) % 4), (on))
257#define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer) / 4, ~(1 << ((layer) % 4)), (on))
258#define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer) / 4, 1 << ((layer) % 4), (on))
259#define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
260#define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
261#define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
262#define ACTION_LAYER_ONESHOT(layer) ACTION_LAYER_TAP((layer), OP_ONESHOT)
263#define ACTION_LAYER_MODS(layer, mods) ACTION(ACT_LAYER_MODS, (layer) << 8 | (mods))
a074364c 264/* With Tapping */
b624f32f 265#define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
266#define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
a074364c 267/* Bitwise Operation */
b624f32f 268#define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
269#define ACTION_LAYER_BIT_OR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
270#define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
271#define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
a074364c 272/* Default Layer Bitwise Operation */
b624f32f 273#define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
274#define ACTION_DEFAULT_LAYER_BIT_OR(part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
275#define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
276#define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
a074364c 277
a074364c 278/* Macro */
b624f32f 279#define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
280#define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP << 8 | (id))
281#define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt) << 8 | (id))
a074364c 282/* Function */
283enum function_opts {
b624f32f 284 FUNC_TAP = 0x8, /* indciates function is tappable */
a074364c 285};
b624f32f 286#define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
287#define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP << 8 | (id))
288#define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt) << 8 | (id))
dd378601 289/* OneHand Support */
5d771039 290enum swap_hands_param_tap_op {
8090f6b4
JW
291 OP_SH_TOGGLE = 0xF0,
292 OP_SH_TAP_TOGGLE,
293 OP_SH_ON_OFF,
294 OP_SH_OFF_ON,
295 OP_SH_OFF,
296 OP_SH_ON,
297};
298
b624f32f 299#define ACTION_SWAP_HANDS() ACTION_SWAP_HANDS_ON_OFF()
300#define ACTION_SWAP_HANDS_TOGGLE() ACTION(ACT_SWAP_HANDS, OP_SH_TOGGLE)
301#define ACTION_SWAP_HANDS_TAP_TOGGLE() ACTION(ACT_SWAP_HANDS, OP_SH_TAP_TOGGLE)
302#define ACTION_SWAP_HANDS_TAP_KEY(key) ACTION(ACT_SWAP_HANDS, key)
303#define ACTION_SWAP_HANDS_ON_OFF() ACTION(ACT_SWAP_HANDS, OP_SH_ON_OFF)
304#define ACTION_SWAP_HANDS_OFF_ON() ACTION(ACT_SWAP_HANDS, OP_SH_OFF_ON)
305#define ACTION_SWAP_HANDS_ON() ACTION(ACT_SWAP_HANDS, OP_SH_ON)
306#define ACTION_SWAP_HANDS_OFF() ACTION(ACT_SWAP_HANDS, OP_SH_OFF)
a074364c 307
308#endif /* ACTION_CODE_H */