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/>.
22 * 16bit code: action_kind(4bit) + action_parameter(12bit)
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)
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[TAP]
44 * ACT_USAGE(0100): TODO: Not needed?
45 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
46 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
47 * 0100|10| usage(10) (reserved)
48 * 0100|11| usage(10) (reserved)
50 * ACT_MOUSEKEY(0101): TODO: Not needed?
51 * 0101|xxxx| keycode Mouse key
53 * 011x|xxxx xxxx xxxx (reseved)
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)
70 * 1001|oopp|BBBB BBBB 8-bit Bitwise Operation???
72 * ACT_LAYER_TAP(101x):
73 * 101E|LLLL| keycode On/Off with tap key [TAP]
74 * 101E|LLLL|110r mods On/Off with modifiers (0xC0-DF)[NOT TAP]
75 * r: Left/Right flag(Left:0, Right:1)
76 * 101E|LLLL|1111 0000 Invert with tap toggle (0xF0) [TAP]
77 * 101E|LLLL|1111 0001 On/Off (0xF1) [NOT TAP]
78 * 101E|LLLL|1111 0010 Off/On (0xF2) [NOT TAP]
79 * 101E|LLLL|1111 0011 Set/Clear (0xF3) [NOT TAP]
80 * 101E|LLLL|1111 xxxx (reserved) (0xF4-FF)
81 * ELLLL: layer 0-31(E: extra bit for layer 16-31)
87 * 1100|opt | id(8) Macro play?
88 * 1100|1111| id(8) Macro record?
90 * ACT_BACKLIGHT(1101):
91 * 1101|opt |level(8) Backlight commands
94 * 1110|opt | id(8) Built-in Command exec
97 * 1111| address(12) Function?
98 * 1111|opt | id(8) Function?
100 enum action_kind_id {
105 ACT_MODS_TAP = 0b0010,
106 ACT_LMODS_TAP = 0b0010,
107 ACT_RMODS_TAP = 0b0011,
110 ACT_MOUSEKEY = 0b0101,
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 /* 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 {
185 #define ACTION_NO { .code = 0 }
186 #define ACTION_TRANSPARENT { .code = 1 }
187 #define ACTION(kind, param) { .code = ((kind)<<12 | (param)) }
194 * bit 0 ||||+- Control
198 * bit 4 +----- LR flag(Left:0, Right:1)
213 MODS_TAP_TOGGLE = 0x01,
215 #define ACTION_KEY(key) ACTION(ACT_MODS, (key))
216 #define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f00) | 0)
217 #define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f00) | (key))
218 #define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | (key))
219 #define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | MODS_ONESHOT)
220 #define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f00) | MODS_TAP_TOGGLE)
230 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
231 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
232 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
239 enum layer_param_on {
244 enum layer_param_bit_op {
250 enum layer_pram_tap_op {
251 OP_TAP_TOGGLE = 0xF0,
256 #define ACTION_LAYER_BITOP(op, part, bits, on) ACTION(ACT_LAYER, (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
257 #define ACTION_LAYER_TAP(layer, key) ACTION(ACT_LAYER_TAP, (layer)<<8 | (key))
259 #define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
260 #define ACTION_DEFAULT_LAYER_TOGGLE(layer) ACTION_DEFAULT_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4))
261 /* Layer Operation */
262 #define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
263 #define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
264 #define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
265 #define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
266 #define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
267 #define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
268 #define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
269 #define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
270 #define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
271 #define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
272 #define ACTION_LAYER_MODS(layer, mods) ACTION_LAYER_TAP((layer), 0xc0 | ((mods>>8)&0x1f))
274 #define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
275 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
276 /* Bitwise Operation */
277 #define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
278 #define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
279 #define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
280 #define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
281 /* Default Layer Bitwise Operation */
282 #define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
283 #define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
284 #define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
285 #define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
292 #define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
293 #define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
294 #define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
298 BACKLIGHT_INCREASE = 0,
299 BACKLIGHT_DECREASE = 1,
300 BACKLIGHT_TOGGLE = 2,
304 #define ACTION_BACKLIGHT_INCREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
305 #define ACTION_BACKLIGHT_DECREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
306 #define ACTION_BACKLIGHT_TOGGLE() ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
307 #define ACTION_BACKLIGHT_STEP() ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
308 #define ACTION_BACKLIGHT_LEVEL(level) ACTION(ACT_BACKLIGHT, BACKLIGHT_LEVEL << 8 | level)
312 COMMAND_BOOTLOADER, // jump to bootloader
314 #define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (id))
318 FUNC_TAP = 0x8, /* indciates function is tappable */
320 #define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
321 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
322 #define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
324 #endif /* ACTION_CODE_H */