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(0x04-A4, E0-E7)[TAP]
40 * (reserved) (0xA5-DF, E8-FF)
45 * ACT_USAGE(0100): TODO: Not needed?
46 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
47 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
48 * 0100|10| usage(10) (reserved)
49 * 0100|11| usage(10) (reserved)
51 * ACT_MOUSEKEY(0110): TODO: Not needed?
52 * 0101|xxxx| keycode Mouse key
54 * 011x|xxxx xxxx xxxx (reseved)
60 * 1000|oo00|pppE BBBB Default Layer Bitwise operation
61 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
62 * ppp: 4-bit chunk part(0-7)
63 * EBBBB: bits and extra bit
64 * 1000|ooee|pppE BBBB Layer Bitwise Operation
65 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
66 * ppp: 4-bit chunk part(0-7)
67 * EBBBB: bits and extra bit
68 * ee: on event(01:press, 10:release, 11:both)
70 * 1001|xxxx|xxxx xxxx (reserved)
71 * 1001|oopp|BBBB BBBB 8-bit Bitwise Operation???
73 * ACT_LAYER_TAP(101x):
74 * 101E|LLLL| keycode On/Off with tap key (0x04-A4, E0-E7)[TAP]
75 * 101E|LLLL|110r mods On/Off with modifiers (0xC0-DF)[NOT TAP]
76 * r: Left/Right flag(Left:0, Right:1)
77 * (reserved) (0xA5-BF, E8-EF)
78 * 101E|LLLL|1111 0000 Invert with tap toggle (0xF0) [TAP]
79 * 101E|LLLL|1111 0001 On/Off (0xF1) [NOT TAP]
80 * 101E|LLLL|1111 0010 Off/On (0xF2) [NOT TAP]
81 * 101E|LLLL|1111 0011 Set/Clear (0xF3) [NOT TAP]
82 * 101E|LLLL|1111 xxxx (reserved) (0xF4-FF)
83 * ELLLL: layer 0-31(E: extra bit for layer 16-31)
89 * 1100|opt | id(8) Macro play?
90 * 1100|1111| id(8) Macro record?
92 * ACT_BACKLIGHT(1101):
93 * 1101|opt |level(8) Backlight commands
96 * 1110|opt | id(8) Built-in Command exec
99 * 1111| address(12) Function?
100 * 1111|opt | id(8) Function?
102 enum action_kind_id {
107 ACT_MODS_TAP = 0b0010,
108 ACT_LMODS_TAP = 0b0010,
109 ACT_RMODS_TAP = 0b0011,
112 ACT_MOUSEKEY = 0b0101,
115 ACT_LAYER_TAP = 0b1010, /* Layer 0-15 */
116 ACT_LAYER_TAP_EXT = 0b1011, /* Layer 16-31 */
119 ACT_BACKLIGHT = 0b1101,
120 ACT_COMMAND = 0b1110,
121 ACT_FUNCTION = 0b1111
125 /* Action Code Struct
128 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
129 * AVR looks like a little endian in avr-gcc.
130 * Not portable across compiler/endianness?
132 * Byte order and bit order of 0x1234:
133 * Big endian: Little endian:
134 * -------------------- --------------------
135 * FEDC BA98 7654 3210 0123 4567 89AB CDEF
136 * 0001 0010 0011 0100 0010 1100 0100 1000
137 * 0x12 0x34 0x34 0x12
150 struct action_layer_bitop {
158 struct action_layer_tap {
163 struct action_usage {
168 struct action_backlight {
173 struct action_command {
178 struct action_function {
187 #define ACTION_NO { .code = 0 }
188 #define ACTION_TRANSPARENT { .code = 1 }
189 #define ACTION(kind, param) { .code = ((kind)<<12 | (param)) }
196 * bit 0 ||||+- Control
200 * bit 4 +----- LR flag(Left:0, Right:1)
215 MODS_TAP_TOGGLE = 0x01,
217 #define ACTION_KEY(key) ACTION(ACT_MODS, (key))
218 #define ACTION_MODS(mods) ACTION(ACT_MODS, ((mods)&0x1f)<<8 | 0)
219 #define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, ((mods)&0x1f)<<8 | (key))
220 #define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | (key))
221 #define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_ONESHOT)
222 #define ACTION_MODS_TAP_TOGGLE(mods) ACTION(ACT_MODS_TAP, ((mods)&0x1f)<<8 | MODS_TAP_TOGGLE)
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)
241 enum layer_param_on {
246 enum layer_param_bit_op {
252 enum layer_pram_tap_op {
253 OP_TAP_TOGGLE = 0xF0,
258 #define ACTION_LAYER_BITOP(op, part, bits, on) ACTION(ACT_LAYER, (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
259 #define ACTION_LAYER_TAP(layer, key) ACTION(ACT_LAYER_TAP, (layer)<<8 | (key))
261 #define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
262 #define ACTION_DEFAULT_LAYER_TOGGLE(layer) ACTION_DEFAULT_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4))
263 /* Layer Operation */
264 #define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
265 #define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
266 #define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
267 #define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
268 #define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
269 #define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
270 #define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
271 #define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
272 #define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
273 #define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
274 #define ACTION_LAYER_MODS(layer, mods) ACTION_LAYER_TAP((layer), 0xc0 | ((mods)&0x1f))
276 #define ACTION_LAYER_TAP_KEY(layer, key) ACTION_LAYER_TAP((layer), (key))
277 #define ACTION_LAYER_TAP_TOGGLE(layer) ACTION_LAYER_TAP((layer), OP_TAP_TOGGLE)
278 /* Bitwise Operation */
279 #define ACTION_LAYER_BIT_AND(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), (on))
280 #define ACTION_LAYER_BIT_OR( part, bits, on) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), (on))
281 #define ACTION_LAYER_BIT_XOR(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), (on))
282 #define ACTION_LAYER_BIT_SET(part, bits, on) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), (on))
283 /* Default Layer Bitwise Operation */
284 #define ACTION_DEFAULT_LAYER_BIT_AND(part, bits) ACTION_LAYER_BITOP(OP_BIT_AND, (part), (bits), 0)
285 #define ACTION_DEFAULT_LAYER_BIT_OR( part, bits) ACTION_LAYER_BITOP(OP_BIT_OR, (part), (bits), 0)
286 #define ACTION_DEFAULT_LAYER_BIT_XOR(part, bits) ACTION_LAYER_BITOP(OP_BIT_XOR, (part), (bits), 0)
287 #define ACTION_DEFAULT_LAYER_BIT_SET(part, bits) ACTION_LAYER_BITOP(OP_BIT_SET, (part), (bits), 0)
294 BACKLIGHT_INCREASE = 0,
295 BACKLIGHT_DECREASE = 1,
296 BACKLIGHT_TOGGLE = 2,
301 #define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
302 #define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
303 #define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
305 #define ACTION_BACKLIGHT_INCREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE << 8)
306 #define ACTION_BACKLIGHT_DECREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE << 8)
307 #define ACTION_BACKLIGHT_TOGGLE() ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE << 8)
308 #define ACTION_BACKLIGHT_STEP() ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP << 8)
309 #define ACTION_BACKLIGHT_LEVEL(level) ACTION(ACT_BACKLIGHT, BACKLIGHT_LEVEL << 8 | level)
311 #define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
314 FUNC_TAP = 0x8, /* indciates function is tappable */
316 #define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
317 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
318 #define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
320 #endif /* ACTION_CODE_H */