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 clear_keyboard(void)
88 host_send_keyboard_report();
91 host_consumer_send(0);
97 static void clear_keyboard_but_mods(void)
100 host_send_keyboard_report();
103 host_consumer_send(0);
109 static void layer_switch_on(uint8_t code)
111 if (!IS_FN(code)) return;
112 fn_state_bits |= FN_BIT(code);
113 if (current_layer != keymap_fn_layer(FN_INDEX(code))) {
114 clear_keyboard_but_mods();
116 debug("Layer Switch(on): "); debug_hex(current_layer);
117 current_layer = keymap_fn_layer(FN_INDEX(code));
118 debug(" -> "); debug_hex(current_layer); debug("\n");
122 static void layer_switch_off(uint8_t code)
124 if (!IS_FN(code)) return;
125 fn_state_bits &= ~FN_BIT(code);
126 if (current_layer != keymap_fn_layer(biton(fn_state_bits))) {
127 clear_keyboard_but_mods();
129 debug("Layer Switch(off): "); debug_hex(current_layer);
130 current_layer = keymap_fn_layer(biton(fn_state_bits));
131 debug(" -> "); debug_hex(current_layer); debug("\n");
135 // whether any key except modifier is down or not
136 static inline bool is_anykey_down(void)
138 for (int r = 0; r < MATRIX_ROWS; r++) {
139 matrix_row_t matrix_row = matrix_get_row(r);
140 for (int c = 0; c < MATRIX_COLS; c++) {
141 if (matrix_row && (1<<c)) {
142 if (IS_KEY(keymap_get_keycode(current_layer, r, c))) {
151 static void register_code(uint8_t code)
155 host_send_keyboard_report();
157 else if IS_MOD(code) {
158 host_add_mod_bit(MOD_BIT(code));
159 host_send_keyboard_report();
161 else if IS_MOUSEKEY(code) {
165 else if IS_CONSUMER(code) {
171 case KC_AUDIO_VOL_UP:
172 usage = AUDIO_VOL_UP;
174 case KC_AUDIO_VOL_DOWN:
175 usage = AUDIO_VOL_DOWN;
177 case KC_MEDIA_NEXT_TRACK:
178 usage = TRANSPORT_NEXT_TRACK;
180 case KC_MEDIA_PREV_TRACK:
181 usage = TRANSPORT_PREV_TRACK;
184 usage = TRANSPORT_STOP;
186 case KC_MEDIA_PLAY_PAUSE:
187 usage = TRANSPORT_PLAY_PAUSE;
189 case KC_MEDIA_SELECT:
190 usage = AL_CC_CONFIG;
196 usage = AL_CALCULATOR;
199 usage = AL_LOCAL_BROWSER;
219 case KC_WWW_FAVORITES:
220 usage = AC_BOOKMARKS;
223 host_consumer_send(usage);
225 else if IS_SYSTEM(code) {
228 case KC_SYSTEM_POWER:
229 usage = SYSTEM_POWER_DOWN;
231 case KC_SYSTEM_SLEEP:
232 usage = SYSTEM_SLEEP;
235 usage = SYSTEM_WAKE_UP;
238 host_system_send(usage);
243 static void unregister_code(uint8_t code)
247 host_send_keyboard_report();
249 else if IS_MOD(code) {
250 host_del_mod_bit(MOD_BIT(code));
251 host_send_keyboard_report();
253 else if IS_MOUSEKEY(code) {
257 else if IS_CONSUMER(code) {
258 host_consumer_send(0x0000);
260 else if IS_SYSTEM(code) {
261 host_system_send(0x0000);
267 * Event/State|IDLE DELAYING[f] WAITING[f,k] PRESSING
268 * -----------+------------------------------------------------------------------
269 * Fn Down |IDLE(L+) WAITING(Sk) WAITING(Sk) -
270 * Up |IDLE(L-) IDLE(L-) IDLE(L-) IDLE(L-)
271 * Fnk Down |DELAYING(Sf) WAITING(Sk) WAINTING(Sk) PRESSING(Rf)
272 * Up |IDLE(L-) IDLE(Rf,Uf) IDLE(Rf,Ps,Uf)*3 PRESSING(Uf)
273 * Key Down |PRESSING(Rk) WAITING(Sk) WAITING(Sk) PRESSING(Rk)
274 * Up |IDLE(Uk) DELAYING(Uk) IDLE(L+,Ps,Uk) IDLE(Uk)*4
275 * Delay |- IDLE(L+) IDLE(L+,Ps) -
277 * No key Down|IDLE(Ld) IDLE(Ld) IDLE(Ld) IDLE(Ld)
279 * *2: register Fnk if any key is pressing
280 * *3: when Fnk == Stored Fnk, if not ignore.
281 * *4: when no registered key any more
285 * DELAYING: delay layer switch after pressing Fn with alt keycode
286 * WAITING: key is pressed during DELAYING
289 * Fn: Fn key without alternative keycode
290 * Fnk: Fn key with alternative keycode
296 * Rf: register stored Fn(alt keycode)
297 * Uf: unregister stored Fn(alt keycode)
298 * Rs: register stored key
299 * Us: unregister stored key
302 * Ps: play stored key(Interpret stored key and transit state)
303 * L+: Switch to new layer(*unregister* all keys but modifiers)
304 * L-: Switch back to last layer(*unregister* all keys but modifiers)
305 * Ld: Switch back to default layer(*unregister* all keys but modifiers)
307 #define NEXT(state) do { \
308 debug("NEXT: "); print_P(state_str(kbdstate)); \
310 debug(" -> "); print_P(state_str(kbdstate)); debug("\n"); \
313 static inline void process_key(keyevent_t event)
315 uint8_t code = keymap_get_keycode(current_layer, event.key.row, event.key.col);
316 keykind_t kind = get_keykind(code, event.pressed);
320 debug("state: "); print_P(state_str(kbdstate));
321 debug(" kind: "); debug_hex(kind);
322 debug(" code: "); debug_hex(code);
323 if (event.pressed) { debug("d"); } else { debug("u"); }
330 layer_switch_on(code);
333 layer_switch_off(code);
336 // repeat Fn alt key when press Fn key down, up then down again quickly
337 if (KEYEQ(delayed_fn.event.key, event.key) &&
338 timer_elapsed(delayed_fn.time) < LAYER_DELAY) {
339 register_code(keymap_fn_keycode(FN_INDEX(code)));
342 delayed_fn = (keyrecord_t) {
345 .mods = keyboard_report->mods,
352 layer_switch_off(code);
363 unregister_code(code);
372 // ignored when any key is pressed
375 layer_switch_off(code);
379 register_code(keymap_fn_keycode(FN_INDEX(code)));
382 // can't know whether layer switched or not
383 layer_switch_off(code);
384 unregister_code(keymap_fn_keycode(FN_INDEX(code)));
392 unregister_code(code);
393 // no key registered? mousekey, mediakey, systemkey
394 if (!host_has_anykey())
406 waiting_key = (keyrecord_t) {
409 .mods = keyboard_report->mods,
418 layer_switch_off(code);
422 if (code == delayed_fn.code) {
423 // type Fn with alt keycode
424 // restore the mod status at the time of pressing Fn key
425 tmp_mods = keyboard_report->mods;
426 host_set_mods(delayed_fn.mods);
427 register_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
428 unregister_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
429 host_set_mods(tmp_mods);
432 layer_switch_off(code);
437 unregister_code(code);
441 unregister_code(code);
452 tmp_mods = keyboard_report->mods;
453 host_set_mods(delayed_fn.mods);
454 register_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
455 host_set_mods(waiting_key.mods);
456 register_code(waiting_key.code);
457 host_set_mods(tmp_mods);
465 layer_switch_off(code);
469 if (code == delayed_fn.code) {
470 // alt down, key down, alt up
471 tmp_mods = keyboard_report->mods;
472 host_set_mods(delayed_fn.mods);
473 register_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
474 host_set_mods(waiting_key.mods);
475 register_code(waiting_key.code);
476 unregister_code(keymap_fn_keycode(FN_INDEX(delayed_fn.code)));
477 host_set_mods(tmp_mods);
480 layer_switch_off(code);
485 if (code == waiting_key.code) {
486 layer_switch_on(delayed_fn.code);
488 // process waiting_key
489 tmp_mods = keyboard_report->mods;
490 host_set_mods(waiting_key.mods);
491 process_key(waiting_key.event);
492 host_set_mods(tmp_mods);
495 unregister_code(code);
499 unregister_code(code);
508 void keyboard_init(void)
510 debug_keyboard = true;
514 #ifdef PS2_MOUSE_ENABLE
519 void keyboard_task(void)
521 static matrix_row_t matrix_prev[MATRIX_ROWS];
522 matrix_row_t matrix_row = 0;
523 matrix_row_t matrix_change = 0;
526 if (command_proc()) {
528 // TODO: COMMAND state?
533 for (int r = 0; r < MATRIX_ROWS; r++) {
534 matrix_row = matrix_get_row(r);
535 matrix_change = matrix_row ^ matrix_prev[r];
537 if (debug_matrix) matrix_print();
539 for (int c = 0; c < MATRIX_COLS; c++) {
540 if (matrix_change & (1<<c)) {
541 process_key((keyevent_t){
542 .key = (key_t){ .row = r, .col = c },
543 .pressed = (matrix_row & (1<<c))
545 // record a processed key
546 matrix_prev[r] ^= (1<<c);
547 // process a key per task call
548 goto MATRIX_LOOP_END;
555 // layer switch when delay term elapses
556 if (kbdstate == DELAYING || kbdstate == WAITING) {
557 if (timer_elapsed(delayed_fn.time) > LAYER_DELAY) {
558 if (kbdstate == DELAYING) {
559 layer_switch_on(delayed_fn.code);
562 if (kbdstate == WAITING) {
563 layer_switch_on(delayed_fn.code);
565 uint8_t tmp_mods = keyboard_report->mods;
566 host_set_mods(waiting_key.mods);
567 process_key(waiting_key.event);
568 host_set_mods(tmp_mods);
573 // mousekey repeat & acceleration
576 // FAIL SAFE: clear all key if no key down
578 matrix_row_t is_matrix_on = 0;
579 for (int r = 0; r < MATRIX_ROWS; r++) {
580 is_matrix_on |= matrix_get_row(r);
583 debug("FAIL SAFE: clear all keys.\n");
591 void keyboard_set_leds(uint8_t leds)