2 Copyright 2013 Jun Wako <wakojun@gmail.com>
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.
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.
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/>.
20 /** \brief Action codes
22 * 16bit code: action_kind(4bit) + action_parameter(12bit)
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)
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)
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)
48 * ACT_MOUSEKEY(0101): TODO: Merge these two actions to conserve space?
49 * 0101|xxxx| keycode Mouse key
51 * ACT_SWAP_HANDS(0110):
52 * 0110|xxxx| keycode Swap hands (keycode on tap, or options)
54 * 0111|xxxx xxxx xxxx (reserved)
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)
69 * 1001|xxxx|xxxx xxxx (reserved)
71 * ACT_LAYER_TAP(101x):
72 * 101E|LLLL| keycode On/Off with tap key (0x00-DF)[TAP]
73 * 101E|LLLL|1110 mods On/Off with modifiers (0xE0-EF)[NOT TAP]
74 * 101E|LLLL|1111 0000 Invert with tap toggle (0xF0) [TAP]
75 * 101E|LLLL|1111 0001 On/Off (0xF1) [NOT TAP]
76 * 101E|LLLL|1111 0010 Off/On (0xF2) [NOT TAP]
77 * 101E|LLLL|1111 0011 Set/Clear (0xF3) [NOT TAP]
78 * 101E|LLLL|1111 0100 One Shot Layer (0xF4) [TAP]
79 * 101E|LLLL|1111 xxxx Reserved (0xF5-FF)
80 * ELLLL: layer 0-31(E: extra bit for layer 16-31)
85 * 1100|opt | id(8) Macro play?
86 * 1100|1111| id(8) Macro record?
88 * ACT_BACKLIGHT(1101):
89 * 1101|opt |level(8) Backlight commands
92 * 1110|opt | id(8) Built-in Command exec
95 * 1111| address(12) Function?
96 * 1111|opt | id(8) Function?
103 ACT_MODS_TAP = 0b0010,
104 ACT_LMODS_TAP = 0b0010,
105 ACT_RMODS_TAP = 0b0011,
108 ACT_MOUSEKEY = 0b0101,
109 /* One-hand Support */
110 ACT_SWAP_HANDS = 0b0110,
113 ACT_LAYER_TAP = 0b1010, /* Layer 0-15 */
114 ACT_LAYER_TAP_EXT = 0b1011, /* Layer 16-31 */
117 ACT_BACKLIGHT = 0b1101,
118 ACT_COMMAND = 0b1110,
119 ACT_FUNCTION = 0b1111
123 /** \brief Action Code Struct
126 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
127 * AVR looks like a little endian in avr-gcc.
128 * Not portable across compiler/endianness?
130 * Byte order and bit order of 0x1234:
131 * Big endian: Little endian:
132 * -------------------- --------------------
133 * FEDC BA98 7654 3210 0123 4567 89AB CDEF
134 * 0001 0010 0011 0100 0010 1100 0100 1000
135 * 0x12 0x34 0x34 0x12
148 struct action_layer_bitop {
156 struct action_layer_tap {
161 struct action_usage {
166 struct action_backlight {
171 struct action_command {
176 struct action_function {
191 #define ACTION_TRANSPARENT 1
192 #define ACTION(kind, param) ((kind)<<12 | (param))
195 /** \brief Key Actions
198 * bit 0 ||||+- Control
202 * bit 4 +----- LR flag(Left:0, Right:1)
216 MODS_TAP_TOGGLE = 0x01,
218 #define ACTION_KEY(key) ACTION(ACT_MODS, (key))
219 #define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f)<<8 | 0)
220 #define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f)<<8 | (key))
221 #define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | (key))
222 #define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_ONESHOT)
223 #define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_TAP_TOGGLE)
226 /** \brief Other Keys
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)
238 /** \brief Layer Actions
240 enum layer_param_on {
246 /** \brief Layer Actions
248 enum layer_param_bit_op {
255 /** \brief Layer Actions
257 enum layer_param_tap_op {
258 OP_TAP_TOGGLE = 0xF0,
264 #define ACTION_LAYER_BITOP(op, part, bits, on) (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
265 #define ACTION_LAYER_TAP(layer, key) (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
267 #define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
268 /* Layer Operation */
269 #define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
270 #define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
271 #define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
272 #define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
273 #define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
274 #define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
275 #define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
276 #define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
277 #define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
278 #define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
279 #define ACTION_LAYER_ONESHOT(layer) ACTION_LAYER_TAP((layer), OP_ONESHOT)
280 #define ACTION_LAYER_MODS(layer, mods) ACTION_LAYER_TAP((layer), 0xe0 | ((mods)&0x0f))
282 #define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
283 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
284 /* Bitwise Operation */
285 #define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
286 #define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
287 #define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
288 #define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
289 /* Default Layer Bitwise Operation */
290 #define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
291 #define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
292 #define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
293 #define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
296 /** \brief Extensions
299 BACKLIGHT_INCREASE = 0,
300 BACKLIGHT_DECREASE = 1,
301 BACKLIGHT_TOGGLE = 2,
308 #define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
309 #define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
310 #define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
312 #define ACTION_BACKLIGHT_INCREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
313 #define ACTION_BACKLIGHT_DECREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
314 #define ACTION_BACKLIGHT_TOGGLE() ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
315 #define ACTION_BACKLIGHT_STEP() ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
316 #define ACTION_BACKLIGHT_ON() ACTION(ACT_BACKLIGHT, BACKLIGHT_ON << 8)
317 #define ACTION_BACKLIGHT_OFF() ACTION(ACT_BACKLIGHT, BACKLIGHT_OFF << 8)
319 #define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (id))
322 FUNC_TAP = 0x8, /* indciates function is tappable */
324 #define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
325 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
326 #define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
327 /* OneHand Support */
328 enum swap_hands_param_tap_op {
337 #define ACTION_SWAP_HANDS() ACTION_SWAP_HANDS_ON_OFF()
338 #define ACTION_SWAP_HANDS_TOGGLE() ACTION(ACT_SWAP_HANDS, OP_SH_TOGGLE)
339 #define ACTION_SWAP_HANDS_TAP_TOGGLE() ACTION(ACT_SWAP_HANDS, OP_SH_TAP_TOGGLE)
340 #define ACTION_SWAP_HANDS_TAP_KEY(key) ACTION(ACT_SWAP_HANDS, key)
341 #define ACTION_SWAP_HANDS_ON_OFF() ACTION(ACT_SWAP_HANDS, OP_SH_ON_OFF)
342 #define ACTION_SWAP_HANDS_OFF_ON() ACTION(ACT_SWAP_HANDS, OP_SH_OFF_ON)
343 #define ACTION_SWAP_HANDS_ON() ACTION(ACT_SWAP_HANDS, OP_SH_ON)
344 #define ACTION_SWAP_HANDS_OFF() ACTION(ACT_SWAP_HANDS, OP_SH_OFF)
346 #endif /* ACTION_CODE_H */