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 Key and Modifiers
33 * r: Left/Right flag(Left:0, Right:1)
36 * 001r|mods|0000 0000 Modifiers with OneShot
37 * 001r|mods|0000 00xx (reserved)
38 * 001r|mods| keycode Modifiers with Tap Key
43 * ACT_USAGE(0100): TODO: Not needed?
44 * 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
45 * 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
46 * 0100|10| usage(10) (reserved)
47 * 0100|11| usage(10) (reserved)
49 * ACT_MOUSEKEY(0110): TODO: Not needed?
50 * 0101|xxxx| keycode Mouse key
52 * 011x|xxxx xxxx xxxx (reseved)
58 * 1000|oo00|pppE BBBB Default Layer Bitwise operation
59 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
60 * ppp: 4-bit chunk part(0-7)
61 * EBBBB: bits and extra bit
62 * 1000|ooee|pppE BBBB Layer Bitwise Operation
63 * oo: operation(00:AND, 01:OR, 10:XOR, 11:SET)
64 * ppp: 4-bit chunk part(0-7)
65 * EBBBB: bits and extra bit
66 * ee: on event(01:press, 10:release, 11:both)
68 * 1001|xxxx|xxxx xxxx (reserved)
69 * 1001|oopp|BBBB BBBB 8-bit Bitwise Operation???
71 * ACT_LAYER_TAP(101x):
72 * 101E|LLLL| keycode Invert with tap key
73 * 101E|LLLL|1110 xxxx Reserved(0xE0-EF)
74 * 101E|LLLL|1111 0000 Invert with tap toggle(0xF0)
75 * 101E|LLLL|1111 0001 On/Off
76 * 101E|LLLL|1111 0010 Off/On
77 * 101E|LLLL|1111 0011 Set/Clear
78 * 101E|LLLL|1111 xxxx Reserved(0xF4-FF)
79 * 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|xxxx| id(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,
111 ACT_LAYER_TAP = 0b1010, /* Layer 0-15 */
112 ACT_LAYER_TAP_EXT = 0b1011, /* Layer 16-31 */
115 ACT_BACKLIGHT = 0b1101,
116 ACT_COMMAND = 0b1110,
117 ACT_FUNCTION = 0b1111
121 /* Action Code Struct
124 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
125 * AVR looks like a little endian in avr-gcc.
126 * Not portable across compiler/endianness?
128 * Byte order and bit order of 0x1234:
129 * Big endian: Little endian:
130 * -------------------- --------------------
131 * FEDC BA98 7654 3210 0123 4567 89AB CDEF
132 * 0001 0010 0011 0100 0010 1100 0100 1000
133 * 0x12 0x34 0x34 0x12
146 struct action_layer_bitop {
154 struct action_layer_tap {
159 struct action_usage {
164 struct action_backlight {
167 struct action_command {
172 struct action_function {
182 #define ACTION_TRANSPARENT 1
183 #define ACTION(kind, param) ((kind)<<12 | (param))
190 * bit 0 ||||+- Control
194 * bit 4 +----- LR flag(Left:0, Right:1)
209 #define ACTION_KEY(key) ACTION(ACT_MODS, (key))
210 #define ACTION_MODS(mods) ACTION(ACT_MODS, (mods&0x1f)<<8 | 0)
211 #define ACTION_MODS_KEY(mods, key) ACTION(ACT_MODS, (mods&0x1f)<<8 | (key))
212 #define ACTION_MODS_TAP_KEY(mods, key) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | (key))
213 #define ACTION_MODS_ONESHOT(mods) ACTION(ACT_MODS_TAP, (mods&0x1f)<<8 | MODS_ONESHOT)
223 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, PAGE_SYSTEM<<10 | (id))
224 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, PAGE_CONSUMER<<10 | (id))
225 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
232 enum layer_param_on {
237 enum layer_param_bit_op {
243 enum layer_pram_tap_op {
244 OP_TAP_TOGGLE = 0xF0,
249 #define ACTION_LAYER_BITOP(op, part, bits, on) (ACT_LAYER<<12 | (op)<<10 | (on)<<8 | (part)<<5 | ((bits)&0x1f))
250 #define ACTION_LAYER_TAP(layer, key) (ACT_LAYER_TAP<<12 | (layer)<<8 | (key))
252 #define ACTION_DEFAULT_LAYER_SET(layer) ACTION_DEFAULT_LAYER_BIT_SET((layer)/4, 1<<((layer)%4))
253 /* Layer Operation */
254 #define ACTION_LAYER_CLEAR(on) ACTION_LAYER_BIT_AND(0, 0, (on))
255 #define ACTION_LAYER_MOMENTARY(layer) ACTION_LAYER_ON_OFF(layer)
256 #define ACTION_LAYER_TOGGLE(layer) ACTION_LAYER_INVERT(layer, ON_RELEASE)
257 #define ACTION_LAYER_INVERT(layer, on) ACTION_LAYER_BIT_XOR((layer)/4, 1<<((layer)%4), (on))
258 #define ACTION_LAYER_ON(layer, on) ACTION_LAYER_BIT_OR( (layer)/4, 1<<((layer)%4), (on))
259 #define ACTION_LAYER_OFF(layer, on) ACTION_LAYER_BIT_AND((layer)/4, ~(1<<((layer)%4)), (on))
260 #define ACTION_LAYER_SET(layer, on) ACTION_LAYER_BIT_SET((layer)/4, 1<<((layer)%4), (on))
261 #define ACTION_LAYER_ON_OFF(layer) ACTION_LAYER_TAP((layer), OP_ON_OFF)
262 #define ACTION_LAYER_OFF_ON(layer) ACTION_LAYER_TAP((layer), OP_OFF_ON)
263 #define ACTION_LAYER_SET_CLEAR(layer) ACTION_LAYER_TAP((layer), OP_SET_CLEAR)
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)
267 /* Bitwise Operation */
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))
272 /* Default Layer Bitwise Operation */
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)
283 BACKLIGHT_INCREASE = 0,
284 BACKLIGHT_DECREASE = 1,
285 BACKLIGHT_TOGGLE = 2,
289 #define ACTION_MACRO(id) ACTION(ACT_MACRO, (id))
290 #define ACTION_MACRO_TAP(id) ACTION(ACT_MACRO, FUNC_TAP<<8 | (id))
291 #define ACTION_MACRO_OPT(id, opt) ACTION(ACT_MACRO, (opt)<<8 | (id))
293 #define ACTION_BACKLIGHT_INCREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_INCREASE)
294 #define ACTION_BACKLIGHT_DECREASE() ACTION(ACT_BACKLIGHT, BACKLIGHT_DECREASE)
295 #define ACTION_BACKLIGHT_TOGGLE() ACTION(ACT_BACKLIGHT, BACKLIGHT_TOGGLE)
296 #define ACTION_BACKLIGHT_STEP() ACTION(ACT_BACKLIGHT, BACKLIGHT_STEP)
298 #define ACTION_COMMAND(id, opt) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
301 FUNC_TAP = 0x8, /* indciates function is tappable */
303 #define ACTION_FUNCTION(id) ACTION(ACT_FUNCTION, (id))
304 #define ACTION_FUNCTION_TAP(id) ACTION(ACT_FUNCTION, FUNC_TAP<<8 | (id))
305 #define ACTION_FUNCTION_OPT(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | (id))
307 #endif /* ACTION_CODE_H */