2 Copyright 2012,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/>.
25 * In avr-gcc bit field seems to be assigned from LSB(bit0) to MSB(bit15).
26 * AVR looks like a little endian in avr-gcc.
28 * NOTE: not portable across compiler/endianness?
29 * Byte order and bit order of 0x1234:
30 * Big endian: 15 ... 8 7 ... 210
33 * Little endian: 012 ... 7 8 ... 15
58 struct action_command {
63 struct action_function {
70 /* Struct to record action and tap count */
77 /* execute action per keyevent */
78 void action_exec(keyevent_t event);
79 typedef void (*action_func_t)(keyevent_t event, uint8_t opt); // TODO:no need?
80 void action_call_function(keyevent_t event, uint8_t id); // TODO: action function
84 * Utilities for actions.
86 void register_code(uint8_t code);
87 void unregister_code(uint8_t code);
88 void add_mods(uint8_t mods);
89 void del_mods(uint8_t mods);
90 void set_mods(uint8_t mods);
91 void clear_keyboard(void);
92 void clear_keyboard_but_mods(void);
93 bool sending_anykey(void);
94 void layer_switch(uint8_t new_layer);
95 bool is_tap_key(key_t key);
103 * 16bit code: action_kind(4bit) + action_parameter(12bit)
108 0000|0000|000000|00 No action
109 0000|0000| keycode Key
110 0010|mods|000000|00 Left mods Momentary
111 0000|mods| keycode Key+Left mods
114 0001|0000|000000|00 No action
115 0001|0000| keycode Key(no used)
116 0001|mods|000000|00 Right mods Momentary
117 0001|mods| keycode Key+Right mods
120 0010|mods|000000|00 Left mods OneShot
121 0010|mods|000000|01 (reserved)
122 0010|mods|000000|10 (reserved)
123 0010|mods|000000|11 (reserved)
124 0010|mods| keycode Left mods+tap Key
127 0011|mods|000000|00 Right mods OneShot
128 0011|mods|000000|01 (reserved)
129 0011|mods|000000|10 (reserved)
130 0011|mods|000000|11 (reserved)
131 0011|mods| keycode Right mods+tap Key
136 This action handles other usages than keyboard.
138 0100|00| usage(10) System control(0x80) - General Desktop page(0x01)
139 0100|01| usage(10) Consumer control(0x01) - Consumer page(0x0C)
140 0100|10| usage(10) (reserved)
141 0100|11| usage(10) (reserved)
147 0101|XXXX| keycode Mouse key
152 ACT_LAYER_PRESSED(1000): Set layer on key pressed
153 ACT_LAYER_RELEASED(1001): Set layer on key released
154 ACT_LAYER_BIT(1010): On/Off layer bit
155 ACT_LAYER_EXT(1011): Extentions
157 1000|LLLL|0000 0000 set layer L when pressed
158 1001|LLLL|0000 0000 set layer L when released
159 1010|BBBB|0000 0000 on/off bit B when pressed/released
160 1011|0000|0000 0000 set default layer when pressed
161 1011|0001|0000 0000 set default layer when released
163 1000|LLLL|1111 0000 set layer L when pressed + tap toggle
164 1001|LLLL|1111 0000 set layer L when released + tap toggle
165 1010|BBBB|1111 0000 on/off bit B when pressed/released + tap toggle
166 1011|0000|1111 0000 set default layer when pressed + tap toggle
167 1011|0001|1111 0000 set default layer when released + tap toggle
169 1000|LLLL|1111 1111 set L to default layer when pressed
170 1001|LLLL|1111 1111 set L to default layer when released
171 1010|BBBB|1111 1111 on/off bit B of default layer when pressed/released
172 1011|0000|1111 1111 set current to default layer when pressed
173 1011|0001|1111 1111 set current to default layer when released
175 1000|LLLL| keycode set layer L when pressed + tap key
176 1001|LLLL| keyocde set layer L when released + tap key
177 1010|BBBB| keyocde on/off bit B when pressed/released + tap key
178 1011|0000| keyocde set default layer when pressed + tap key
179 1011|0001| keyocde set default layer when released + tap key
187 1100|opt | id(8) Macro play?
188 1100|1111| id(8) Macro record?
191 1110|opt | id(8) Built-in Command exec
194 1111| address(12) Function?
195 1111|opt | id(8) Function?
197 TODO: modifier + function by tap?
198 for example: LShift + '('[Shift+9] and RShift + ')'[Shift+0]
199 http://deskthority.net/workshop-f7/tmk-keyboard-firmware-collection-t4478.html#p90052
201 enum action_kind_id {
204 ACT_LMODS_TAP = 0b0010,
205 ACT_RMODS_TAP = 0b0011,
208 ACT_MOUSEKEY = 0b0101,
210 ACT_LAYER_PRESSED = 0b1000,
211 ACT_LAYER_RELEASED = 0b1001,
212 ACT_LAYER_BIT = 0b1010,
213 ACT_LAYER_EXT = 0b1011,
216 ACT_COMMAND = 0b1110,
217 ACT_FUNCTION = 0b1111
225 /* action_t utility */
227 #define ACTION(kind, param) ((kind)<<12 | (param))
230 #define ACTION_KEY(key) ACTION(ACT_LMODS, key)
231 #define ACTION_LMODS(mods) ACTION(ACT_LMODS, (mods)<<8 | 0x00)
232 #define ACTION_LMODS_KEY(mods, key) ACTION(ACT_LMODS, (mods)<<8 | (key))
233 #define ACTION_RMODS(mods) ACTION(ACT_RMODS, (mods)<<8 | 0x00)
234 #define ACTION_RMODS_KEY(mods, key) ACTION(ACT_RMODS, (mods)<<8 | (key))
237 #define MODS4(mods) (((mods)>>4 | (mods)) & 0x0F)
238 #define ACTION_LMODS_TAP(mods, key) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | (key))
239 #define ACTION_LMODS_ONESHOT(mods) ACTION(ACT_LMODS_TAP, MODS4(mods)<<8 | ONE_SHOT)
240 #define ACTION_RMODS_TAP(mods, key) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | (key))
241 #define ACTION_RMODS_ONESHOT(mods) ACTION(ACT_RMODS_TAP, MODS4(mods)<<8 | ONE_SHOT)
243 /* Switch current layer */
244 #define ACTION_LAYER_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0x00)
245 #define ACTION_LAYER_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0x00)
246 #define ACTION_LAYER_BIT(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | 0x00)
247 #define ACTION_LAYER_TO_DEFAULT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0x00)
248 #define ACTION_LAYER_TO_DEFAULT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0x00)
249 /* Switch default layer */
250 #define ACTION_LAYER_DEFAULT_SET_ON_PRESSED(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xFF)
251 #define ACTION_LAYER_DEFAULT_SET_ON_RELEASED(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xFF)
252 #define ACTION_LAYER_DEFAULT_BIT(bits) ACTION(ACT_LAYER_BIT, (bits)<<8 | 0xFF)
253 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_PRESSED ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xFF)
254 #define ACTION_LAYER_DEFAULT_SET_CURRENT_ON_RELEASED ACTION(ACT_LAYER_EXT, 0x1<<8 | 0xFF)
255 /* Layer switch with tap key */
256 #define ACTION_LAYER_SET_TAP_KEY(layer, key) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | (key))
257 #define ACTION_LAYER_BIT_TAP_KEY(bits, key) ACTION(ACT_LAYER_BIT, (bits)<<8 | (key))
258 #define ACTION_LAYER_DEFAULT_SET_TAP_KEY(key) ACTION(ACT_LAYER_EXT, 0x0<<8 | (key))
259 /* with tap toggle */
260 #define ACTION_LAYER_SET_ON_PRESSED_TAP_TOGGLE(layer) ACTION(ACT_LAYER_PRESSED, (layer)<<8 | 0xF0)
261 #define ACTION_LAYER_SET_ON_RELEASED_TAP_TOGGLE(layer) ACTION(ACT_LAYER_RELEASED, (layer)<<8 | 0xF0)
262 #define ACTION_LAYER_BIT_TAP_TOGGLE(layer) ACTION(ACT_LAYER_BIT, (layer)<<8 | 0xF0)
263 #define ACTION_LAYER_DEFAULT_TAP_TOGGLE ACTION(ACT_LAYER_EXT, 0x0<<8 | 0xF0)
266 #define ACTION_USAGE_PAGE_SYSTEM 0
267 #define ACTION_USAGE_PAGE_CONSUMER 1
268 #define ACTION_USAGE_SYSTEM(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_SYSTEM<<10 | (id))
269 #define ACTION_USAGE_CONSUMER(id) ACTION(ACT_USAGE, ACTION_USAGE_PAGE_CONSUMER<<10 | (id))
271 #define ACTION_MOUSEKEY(key) ACTION(ACT_MOUSEKEY, key)
273 #define ACTION_MACRO(opt, id) ACTION(ACT_FUNCTION, (opt)<<8 | (addr))
275 #define ACTION_COMMAND(opt, id) ACTION(ACT_COMMAND, (opt)<<8 | (addr))
277 #define ACTION_FUNCTION(id, opt) ACTION(ACT_FUNCTION, (opt)<<8 | id)
279 #endif /* ACTION_H */