2 Copyright 2011 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/>.
28 #ifdef MOUSEKEY_ENABLE
31 #ifdef EXTRAKEY_ENABLE
32 #include <util/delay.h>
36 #define LAYER_DELAY 250
38 typedef enum keykind {
46 typedef enum { IDLE, DELAYING, WAITING, PRESSING } kbdstate_t;
49 uint8_t current_layer = 0;
50 uint8_t default_layer = 0;
52 /* keyboard internal states */
53 static kbdstate_t kbdstate = IDLE;
54 static uint8_t fn_state_bits = 0;
55 static keyrecord_t delayed_fn;
56 static keyrecord_t waiting_key;
59 static const char *state_str(kbdstate_t state)
61 if (state == IDLE) return PSTR("IDLE");
62 if (state == DELAYING) return PSTR("DELAYING");
63 if (state == WAITING) return PSTR("WAITING");
64 if (state == PRESSING) return PSTR("PRESSING");
65 return PSTR("UNKNOWN");
68 static inline keykind_t get_keykind(uint8_t code, bool pressed)
70 if IS_KEY(code) return (pressed ? KEY_DOWN : KEY_UP);
71 if IS_MOD(code) return (pressed ? MOD_DOWN : MOD_UP);
73 if (keymap_fn_keycode(FN_INDEX(code)))
74 return (pressed ? FNK_DOWN : FNK_UP);
76 return (pressed ? FN_DOWN : FN_UP);
78 if IS_MOUSEKEY(code) return (pressed ? KEY_DOWN : KEY_UP);
79 if IS_SYSTEM(code) return (pressed ? KEY_DOWN : KEY_UP);
80 if IS_CONSUMER(code) return (pressed ? KEY_DOWN : KEY_UP);
84 static void layer_switch_on(uint8_t code)
86 if (!IS_FN(code)) return;
87 fn_state_bits |= FN_BIT(code);
88 if (current_layer != keymap_fn_layer(FN_INDEX(code))) {
89 // clear all key execpt Mod key
90 host_clear_all_keys_but_mods();
92 host_consumer_send(0);
96 debug("Layer Switch(on): "); debug_hex(current_layer);
97 current_layer = keymap_fn_layer(FN_INDEX(code));
98 debug(" -> "); debug_hex(current_layer); debug("\n");
102 static void layer_switch_off(uint8_t code)
104 if (!IS_FN(code)) return;
105 fn_state_bits &= ~FN_BIT(code);
106 if (current_layer != keymap_fn_layer(biton(fn_state_bits))) {
107 // clear all key execpt Mod key
108 host_clear_all_keys_but_mods();
110 host_consumer_send(0);
114 debug("Layer Switch(off): "); debug_hex(current_layer);
115 current_layer = keymap_fn_layer(biton(fn_state_bits));
116 debug(" -> "); debug_hex(current_layer); debug("\n");
120 static inline uint8_t get_keycode(key_t key)
122 return keymap_get_keycode(current_layer, key.row, key.col);
125 // whether any key except modifier is down or not
126 static inline bool is_anykey_down(void)
128 for (int r = 0; r < MATRIX_ROWS; r++) {
129 matrix_row_t matrix_row = matrix_get_row(r);
130 for (int c = 0; c < MATRIX_COLS; c++) {
131 if (matrix_row && (1<<c)) {
132 if (IS_KEY(get_keycode((key_t){ .row = r, .col = c }))) {
141 static void register_code(uint8_t code)
143 debug("register_code\n");
146 host_send_keyboard_report();
148 else if IS_MOD(code) {
149 host_add_mod_bit(MOD_BIT(code));
150 host_send_keyboard_report();
152 else if IS_MOUSEKEY(code) {
156 else if IS_CONSUMER(code) {
163 case KC_AUDIO_VOL_UP:
164 usage = AUDIO_VOL_UP;
166 case KC_AUDIO_VOL_DOWN:
167 usage = AUDIO_VOL_DOWN;
169 case KC_MEDIA_NEXT_TRACK:
170 usage = TRANSPORT_NEXT_TRACK;
172 case KC_MEDIA_PREV_TRACK:
173 usage = TRANSPORT_PREV_TRACK;
176 usage = TRANSPORT_STOP;
178 case KC_MEDIA_PLAY_PAUSE:
179 usage = TRANSPORT_PLAY_PAUSE;
181 case KC_MEDIA_SELECT:
182 usage = AL_CC_CONFIG;
188 usage = AL_CALCULATOR;
191 usage = AL_LOCAL_BROWSER;
211 case KC_WWW_FAVORITES:
212 usage = AC_BOOKMARKS;
215 debug("usage: "); phex16(usage); debug("\n");
216 host_consumer_send(usage);
218 else if IS_SYSTEM(code) {
221 case KC_SYSTEM_POWER:
222 usage = SYSTEM_POWER_DOWN;
224 case KC_SYSTEM_SLEEP:
225 usage = SYSTEM_SLEEP;
228 usage = SYSTEM_WAKE_UP;
231 host_system_send(usage);
236 static void unregister_code(uint8_t code)
240 host_send_keyboard_report();
242 else if IS_MOD(code) {
243 host_del_mod_bit(MOD_BIT(code));
244 host_send_keyboard_report();
246 else if IS_MOUSEKEY(code) {
250 else if IS_CONSUMER(code) {
251 host_consumer_send(0x0000);
253 else if IS_SYSTEM(code) {
254 host_system_send(0x0000);
260 * Event/State|IDLE DELAYING[f] WAITING[f,k] PRESSING
261 * -----------+------------------------------------------------------------------
262 * Fn Down |IDLE(L+) WAITING(Sk) WAITING(Sk) -
263 * Up |IDLE(L-) IDLE(L-) IDLE(L-) IDLE(L-)
264 * Fnk Down |DELAYING(Sf) WAITING(Sk) WAINTING(Sk) PRESSING(Rf)
265 * Up |IDLE(L-) IDLE(Rf,Uf) IDLE(Rf,Ps,Uf)*3 PRESSING(Uf)
266 * Key Down |PRESSING(Rk) WAITING(Sk) WAITING(Sk) PRESSING(Rk)
267 * Up |IDLE(Uk) DELAYING(Uk) IDLE(L+,Ps,Uk) IDLE(Uk)*4
268 * Delay |- IDLE(L+) IDLE(L+,Ps) -
270 * No key Down|IDLE(Ld) IDLE(Ld) IDLE(Ld) IDLE(Ld)
272 * *2: register Fnk if any key is pressing
273 * *3: when Fnk == Stored Fnk, if not ignore.
274 * *4: when no registered key any more
278 * DELAYING: delay layer switch after pressing Fn with alt keycode
279 * WAITING: key is pressed during DELAYING
282 * Fn: Fn key without alternative keycode
283 * Fnk: Fn key with alternative keycode
289 * Rf: register stored Fn(alt keycode)
290 * Uf: unregister stored Fn(alt keycode)
291 * Rs: register stored key
292 * Us: unregister stored key
295 * Ps: play stored key(Interpret stored key and transit state)
296 * L+: Switch to new layer(*retain* Modifiers only)
297 * L-: Switch back to last layer(*clear* stored key/Fn, *unregister* all Modifier/key)
298 * Ld: Switch back to default layer(*clear* stored key/Fn, *unregister* all Modifier/key)
300 #define NEXT(state) do { \
301 debug("NEXT: "); print_P(state_str(kbdstate)); \
303 debug(" -> "); print_P(state_str(kbdstate)); debug("\n"); \
306 static inline void process_key(keyevent_t event)
309 static keyrecord_t waiting_keys[5];
310 static uint8_t waiting_keys_head = 0;
311 static uint8_t waiting_keys_tail = 0;
314 uint8_t code = get_keycode(event.key);
315 keykind_t kind = get_keykind(code, event.pressed);
319 debug("state: "); print_P(state_str(kbdstate));
320 debug(" kind: "); debug_hex(kind);
321 debug(" code: "); debug_hex(code);
322 if (event.pressed) { debug("d"); } else { debug("u"); }
329 layer_switch_on(code);
332 layer_switch_off(code);
335 // repeat Fn alt key when press Fn key down, up then down again quickly
336 if (KEYEQ(delayed_fn.event.key, event.key) &&
337 timer_elapsed(delayed_fn.time) < LAYER_DELAY) {
338 register_code(keymap_fn_keycode(FN_INDEX(code)));
341 delayed_fn = (keyrecord_t) {
344 .mods = keyboard_report->mods,
351 layer_switch_off(code);
362 unregister_code(code);
371 // ignored when any key is pressed
374 layer_switch_off(code);
378 register_code(keymap_fn_keycode(FN_INDEX(code)));
381 // can't know whether layer switched or not
382 layer_switch_off(code);
383 unregister_code(keymap_fn_keycode(FN_INDEX(code)));
391 unregister_code(code);
392 // no key registered? mousekey, mediakey, systemkey
393 if (!host_has_anykey())
405 waiting_key = (keyrecord_t) {
408 .mods = keyboard_report->mods,
417 layer_switch_off(code);
421 if (code == delayed_fn.code) {
422 // type Fn with alt keycode
423 // restore the mod status at the time of pressing Fn key
424 tmp_mods = keyboard_report->mods;
425 host_set_mods(delayed_fn.mods);
426 register_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
427 unregister_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
428 host_set_mods(tmp_mods);
431 layer_switch_off(code);
436 unregister_code(code);
440 unregister_code(code);
451 tmp_mods = keyboard_report->mods;
452 host_set_mods(delayed_fn.mods);
453 register_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
454 host_set_mods(waiting_key.mods);
455 register_code(waiting_key.code);
456 host_set_mods(tmp_mods);
464 layer_switch_off(code);
468 if (code == delayed_fn.code) {
469 // alt down, key down, alt up
470 tmp_mods = keyboard_report->mods;
471 host_set_mods(delayed_fn.mods);
472 register_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
473 host_set_mods(waiting_key.mods);
474 register_code(waiting_key.code);
475 unregister_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
476 host_set_mods(tmp_mods);
479 layer_switch_off(code);
484 if (code == waiting_key.code) {
485 layer_switch_on(delayed_fn.code);
487 // process waiting_key
488 tmp_mods = keyboard_report->mods;
489 host_set_mods(waiting_key.mods);
490 process_key(waiting_key.event);
491 host_set_mods(tmp_mods);
494 unregister_code(code);
498 unregister_code(code);
506 // TODO: FAIL SAFE: unregister all keys when no key down
509 void keyboard_init(void)
511 debug_keyboard = true;
515 #ifdef PS2_MOUSE_ENABLE
520 void keyboard_task(void)
522 static matrix_row_t matrix_prev[MATRIX_ROWS];
523 matrix_row_t matrix_row = 0;
524 matrix_row_t matrix_change = 0;
527 if (command_proc()) {
529 // TODO: clear all keys
530 host_clear_keyboard_report();
531 host_send_keyboard_report();
534 for (int r = 0; r < MATRIX_ROWS; r++) {
535 matrix_row = matrix_get_row(r);
536 matrix_change = matrix_row ^ matrix_prev[r];
538 if (debug_matrix) matrix_print();
540 for (int c = 0; c < MATRIX_COLS; c++) {
541 if (matrix_change & (1<<c)) {
542 process_key((keyevent_t){
543 .key = (key_t){ .row = r, .col = c },
544 .pressed = (matrix_row & (1<<c))
546 // record a processed key
547 matrix_prev[r] ^= (1<<c);
548 // process a key per task call
549 goto MATRIX_LOOP_END;
555 // TODO: FAIL SAFE: clear all key if no key down
557 // layer switch when delay term elapses
558 if (kbdstate == DELAYING || kbdstate == WAITING) {
559 if (timer_elapsed(delayed_fn.time) > LAYER_DELAY) {
560 if (kbdstate == DELAYING) {
561 layer_switch_on(delayed_fn.code);
564 if (kbdstate == WAITING) {
565 layer_switch_on(delayed_fn.code);
567 uint8_t tmp_mods = keyboard_report->mods;
568 host_set_mods(waiting_key.mods);
569 process_key(waiting_key.event);
570 host_set_mods(tmp_mods);
575 // mousekey repeat & acceleration
581 void keyboard_set_leds(uint8_t leds)