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 #include "bootloader.h"
29 #include "action_layer.h"
30 #include "action_util.h"
32 #include "sleep_led.h"
35 #include "backlight.h"
39 #ifdef MOUSEKEY_ENABLE
44 #include "usb_keyboard.h"
45 #ifdef EXTRAKEY_ENABLE
46 #include "usb_extra.h"
56 #endif /* AUDIO_ENABLE */
59 static bool command_common(uint8_t code);
60 static void command_common_help(void);
61 static void print_version(void);
62 static void print_status(void);
63 static bool command_console(uint8_t code);
64 static void command_console_help(void);
65 #ifdef MOUSEKEY_ENABLE
66 static bool mousekey_console(uint8_t code);
67 static void mousekey_console_help(void);
70 static void switch_default_layer(uint8_t layer);
73 command_state_t command_state = ONESHOT;
76 bool command_proc(uint8_t code)
78 switch (command_state) {
82 return (command_extra(code) || command_common(code));
86 return (command_extra(code) || command_common(code));
88 return (command_console_extra(code) || command_console(code));
90 #ifdef MOUSEKEY_ENABLE
92 mousekey_console(code);
96 command_state = ONESHOT;
102 /* TODO: Refactoring is needed. */
103 /* This allows to define extra commands. return false when not processed. */
104 bool command_extra(uint8_t code) __attribute__ ((weak));
105 bool command_extra(uint8_t code)
111 bool command_console_extra(uint8_t code) __attribute__ ((weak));
112 bool command_console_extra(uint8_t code)
119 /***********************************************************
121 ***********************************************************/
122 static void command_common_help(void)
124 print( "\n\t- Magic -\n"
125 STR(MAGIC_KEY_DEBUG ) ": Debug Message Toggle\n"
126 STR(MAGIC_KEY_DEBUG_MATRIX) ": Matrix Debug Mode Toggle - Show keypresses in matrix grid\n"
127 STR(MAGIC_KEY_DEBUG_KBD ) ": Keyboard Debug Toggle - Show keypress report\n"
128 STR(MAGIC_KEY_DEBUG_MOUSE ) ": Debug Mouse Toggle\n"
129 STR(MAGIC_KEY_VERSION ) ": Version\n"
130 STR(MAGIC_KEY_STATUS ) ": Status\n"
131 STR(MAGIC_KEY_CONSOLE ) ": Activate Console Mode\n"
133 #if MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
134 STR(MAGIC_KEY_LAYER0 ) ": Switch to Layer 0\n"
135 STR(MAGIC_KEY_LAYER1 ) ": Switch to Layer 1\n"
136 STR(MAGIC_KEY_LAYER2 ) ": Switch to Layer 2\n"
137 STR(MAGIC_KEY_LAYER3 ) ": Switch to Layer 3\n"
138 STR(MAGIC_KEY_LAYER4 ) ": Switch to Layer 4\n"
139 STR(MAGIC_KEY_LAYER5 ) ": Switch to Layer 5\n"
140 STR(MAGIC_KEY_LAYER6 ) ": Switch to Layer 6\n"
141 STR(MAGIC_KEY_LAYER7 ) ": Switch to Layer 7\n"
142 STR(MAGIC_KEY_LAYER8 ) ": Switch to Layer 8\n"
143 STR(MAGIC_KEY_LAYER9 ) ": Switch to Layer 9\n"
146 #if MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
147 "F1-F10: Switch to Layer 0-9 (F10 = L0)\n"
150 #if MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
151 "0-9: Switch to Layer 0-9\n"
154 STR(MAGIC_KEY_LAYER0_ALT1 ) ": Switch to Layer 0 (alternate key 1)\n"
155 STR(MAGIC_KEY_LAYER0_ALT2 ) ": Switch to Layer 0 (alternate key 2)\n"
156 STR(MAGIC_KEY_BOOTLOADER ) ": Jump to Bootloader (Reset)\n"
158 #ifdef KEYBOARD_LOCK_ENABLE
159 STR(MAGIC_KEY_LOCK ) ": Lock\n"
162 #ifdef BOOTMAGIC_ENABLE
163 STR(MAGIC_KEY_EEPROM ) ": Print EEPROM Settings\n"
167 STR(MAGIC_KEY_NKRO ) ": NKRO Toggle\n"
170 #ifdef SLEEP_LED_ENABLE
171 STR(MAGIC_KEY_SLEEP_LED ) ": Sleep LED Test\n"
176 static void print_version(void)
178 // print version & information
179 print("\n\t- Version -\n");
180 print("DESC: " STR(DESCRIPTION) "\n");
181 print("VID: " STR(VENDOR_ID) "(" STR(MANUFACTURER) ") "
182 "PID: " STR(PRODUCT_ID) "(" STR(PRODUCT) ") "
183 "VER: " STR(DEVICE_VER) "\n");
184 print("BUILD: " STR(QMK_VERSION) " (" __TIME__ " " __DATE__ ")\n");
198 #ifdef BOOTMAGIC_ENABLE
201 #ifdef MOUSEKEY_ENABLE
204 #ifdef EXTRAKEY_ENABLE
207 #ifdef CONSOLE_ENABLE
210 #ifdef COMMAND_ENABLE
216 #ifdef KEYMAP_SECTION_ENABLE
220 " " STR(BOOTLOADER_SIZE) "\n");
222 print("GCC: " STR(__GNUC__) "." STR(__GNUC_MINOR__) "." STR(__GNUC_PATCHLEVEL__)
224 " AVR-LIBC: " __AVR_LIBC_VERSION_STRING__
225 " AVR_ARCH: avr" STR(__AVR_ARCH__)
232 static void print_status(void)
235 print("\n\t- Status -\n");
237 print_val_hex8(host_keyboard_leds());
238 #ifndef PROTOCOL_VUSB
239 // these aren't set on the V-USB protocol, so we just ignore them for now
240 print_val_hex8(keyboard_protocol);
241 print_val_hex8(keyboard_idle);
244 print_val_hex8(keymap_config.nkro);
246 print_val_hex32(timer_read32());
249 print_val_hex8(UDCON);
250 print_val_hex8(UDIEN);
251 print_val_hex8(UDINT);
252 print_val_hex8(usb_keyboard_leds);
253 print_val_hex8(usb_keyboard_idle_count);
258 print_val_hex8(usbSofCount);
264 #ifdef BOOTMAGIC_ENABLE
265 static void print_eeconfig(void)
268 // Print these variables if NO_PRINT or USER_PRINT are not defined.
269 #if !defined(NO_PRINT) && !defined(USER_PRINT)
271 print("default_layer: "); print_dec(eeconfig_read_default_layer()); print("\n");
274 dc.raw = eeconfig_read_debug();
275 print("debug_config.raw: "); print_hex8(dc.raw); print("\n");
276 print(".enable: "); print_dec(dc.enable); print("\n");
277 print(".matrix: "); print_dec(dc.matrix); print("\n");
278 print(".keyboard: "); print_dec(dc.keyboard); print("\n");
279 print(".mouse: "); print_dec(dc.mouse); print("\n");
282 kc.raw = eeconfig_read_keymap();
283 print("keymap_config.raw: "); print_hex8(kc.raw); print("\n");
284 print(".swap_control_capslock: "); print_dec(kc.swap_control_capslock); print("\n");
285 print(".capslock_to_control: "); print_dec(kc.capslock_to_control); print("\n");
286 print(".swap_lalt_lgui: "); print_dec(kc.swap_lalt_lgui); print("\n");
287 print(".swap_ralt_rgui: "); print_dec(kc.swap_ralt_rgui); print("\n");
288 print(".no_gui: "); print_dec(kc.no_gui); print("\n");
289 print(".swap_grave_esc: "); print_dec(kc.swap_grave_esc); print("\n");
290 print(".swap_backslash_backspace: "); print_dec(kc.swap_backslash_backspace); print("\n");
291 print(".nkro: "); print_dec(kc.nkro); print("\n");
293 #ifdef BACKLIGHT_ENABLE
294 backlight_config_t bc;
295 bc.raw = eeconfig_read_backlight();
296 print("backlight_config.raw: "); print_hex8(bc.raw); print("\n");
297 print(".enable: "); print_dec(bc.enable); print("\n");
298 print(".level: "); print_dec(bc.level); print("\n");
299 #endif /* BACKLIGHT_ENABLE */
301 #endif /* !NO_PRINT */
304 #endif /* BOOTMAGIC_ENABLE */
306 static bool command_common(uint8_t code)
309 #ifdef KEYBOARD_LOCK_ENABLE
310 static host_driver_t *host_driver = 0;
315 #ifdef SLEEP_LED_ENABLE
317 // test breathing sleep LED
318 case MAGIC_KC(MAGIC_KEY_SLEEP_LED):
319 print("Sleep LED Test\n");
321 led_set(host_keyboard_leds());
325 #ifdef BOOTMAGIC_ENABLE
327 // print stored eeprom config
328 case MAGIC_KC(MAGIC_KEY_EEPROM):
329 print("eeconfig:\n");
334 #ifdef KEYBOARD_LOCK_ENABLE
336 // lock/unlock keyboard
337 case MAGIC_KC(MAGIC_KEY_LOCK):
338 if (host_get_driver()) {
339 host_driver = host_get_driver();
344 host_set_driver(host_driver);
345 print("Unlocked.\n");
351 case MAGIC_KC(MAGIC_KEY_HELP1):
352 case MAGIC_KC(MAGIC_KEY_HELP2):
353 command_common_help();
357 case MAGIC_KC(MAGIC_KEY_CONSOLE):
358 debug_matrix = false;
359 debug_keyboard = false;
361 debug_enable = false;
362 command_console_help();
364 command_state = CONSOLE;
367 // jump to bootloader
368 case MAGIC_KC(MAGIC_KEY_BOOTLOADER):
369 clear_keyboard(); // clear to prevent stuck keys
370 print("\n\nJumping to bootloader... ");
377 bootloader_jump(); // not return
381 case MAGIC_KC(MAGIC_KEY_DEBUG):
382 debug_enable = !debug_enable;
384 print("\ndebug: on\n");
386 print("\ndebug: off\n");
387 debug_matrix = false;
388 debug_keyboard = false;
393 // debug matrix toggle
394 case MAGIC_KC(MAGIC_KEY_DEBUG_MATRIX):
395 debug_matrix = !debug_matrix;
397 print("\nmatrix: on\n");
400 print("\nmatrix: off\n");
404 // debug keyboard toggle
405 case MAGIC_KC(MAGIC_KEY_DEBUG_KBD):
406 debug_keyboard = !debug_keyboard;
407 if (debug_keyboard) {
408 print("\nkeyboard: on\n");
411 print("\nkeyboard: off\n");
415 // debug mouse toggle
416 case MAGIC_KC(MAGIC_KEY_DEBUG_MOUSE):
417 debug_mouse = !debug_mouse;
419 print("\nmouse: on\n");
422 print("\nmouse: off\n");
427 case MAGIC_KC(MAGIC_KEY_VERSION):
432 case MAGIC_KC(MAGIC_KEY_STATUS):
439 case MAGIC_KC(MAGIC_KEY_NKRO):
440 clear_keyboard(); // clear to prevent stuck keys
441 keymap_config.nkro = !keymap_config.nkro;
442 if (keymap_config.nkro) {
445 print("NKRO: off\n");
452 case MAGIC_KC(MAGIC_KEY_LAYER0_ALT1):
453 case MAGIC_KC(MAGIC_KEY_LAYER0_ALT2):
454 switch_default_layer(0);
457 #if MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
459 case MAGIC_KC(MAGIC_KEY_LAYER0):
460 switch_default_layer(0);
463 case MAGIC_KC(MAGIC_KEY_LAYER1):
464 switch_default_layer(1);
467 case MAGIC_KC(MAGIC_KEY_LAYER2):
468 switch_default_layer(2);
471 case MAGIC_KC(MAGIC_KEY_LAYER3):
472 switch_default_layer(3);
475 case MAGIC_KC(MAGIC_KEY_LAYER4):
476 switch_default_layer(4);
479 case MAGIC_KC(MAGIC_KEY_LAYER5):
480 switch_default_layer(5);
483 case MAGIC_KC(MAGIC_KEY_LAYER6):
484 switch_default_layer(6);
487 case MAGIC_KC(MAGIC_KEY_LAYER7):
488 switch_default_layer(7);
491 case MAGIC_KC(MAGIC_KEY_LAYER8):
492 switch_default_layer(8);
495 case MAGIC_KC(MAGIC_KEY_LAYER9):
496 switch_default_layer(9);
501 #if MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
503 case KC_F1 ... KC_F9:
504 switch_default_layer((code - KC_F1) + 1);
507 switch_default_layer(0);
511 #if MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
514 switch_default_layer((code - KC_1) + 1);
517 switch_default_layer(0);
529 /***********************************************************
531 ***********************************************************/
532 static void command_console_help(void)
534 print("\n\t- Console -\n"
536 #ifdef MOUSEKEY_ENABLE
542 static bool command_console(uint8_t code)
546 case KC_SLASH: /* ? */
547 command_console_help();
551 command_state = ONESHOT;
553 #ifdef MOUSEKEY_ENABLE
555 mousekey_console_help();
557 command_state = MOUSEKEY;
569 #ifdef MOUSEKEY_ENABLE
570 /***********************************************************
572 ***********************************************************/
573 static uint8_t mousekey_param = 0;
575 static void mousekey_param_print(void)
577 // Print these variables if NO_PRINT or USER_PRINT are not defined.
578 #if !defined(NO_PRINT) && !defined(USER_PRINT)
579 print("\n\t- Values -\n");
580 print("1: delay(*10ms): "); pdec(mk_delay); print("\n");
581 print("2: interval(ms): "); pdec(mk_interval); print("\n");
582 print("3: max_speed: "); pdec(mk_max_speed); print("\n");
583 print("4: time_to_max: "); pdec(mk_time_to_max); print("\n");
584 print("5: wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
585 print("6: wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
586 #endif /* !NO_PRINT */
590 //#define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
591 #define PRINT_SET_VAL(v) xprintf(#v " = %d\n", (v))
592 static void mousekey_param_inc(uint8_t param, uint8_t inc)
596 if (mk_delay + inc < UINT8_MAX)
599 mk_delay = UINT8_MAX;
600 PRINT_SET_VAL(mk_delay);
603 if (mk_interval + inc < UINT8_MAX)
606 mk_interval = UINT8_MAX;
607 PRINT_SET_VAL(mk_interval);
610 if (mk_max_speed + inc < UINT8_MAX)
613 mk_max_speed = UINT8_MAX;
614 PRINT_SET_VAL(mk_max_speed);
617 if (mk_time_to_max + inc < UINT8_MAX)
618 mk_time_to_max += inc;
620 mk_time_to_max = UINT8_MAX;
621 PRINT_SET_VAL(mk_time_to_max);
624 if (mk_wheel_max_speed + inc < UINT8_MAX)
625 mk_wheel_max_speed += inc;
627 mk_wheel_max_speed = UINT8_MAX;
628 PRINT_SET_VAL(mk_wheel_max_speed);
631 if (mk_wheel_time_to_max + inc < UINT8_MAX)
632 mk_wheel_time_to_max += inc;
634 mk_wheel_time_to_max = UINT8_MAX;
635 PRINT_SET_VAL(mk_wheel_time_to_max);
640 static void mousekey_param_dec(uint8_t param, uint8_t dec)
648 PRINT_SET_VAL(mk_delay);
651 if (mk_interval > dec)
655 PRINT_SET_VAL(mk_interval);
658 if (mk_max_speed > dec)
662 PRINT_SET_VAL(mk_max_speed);
665 if (mk_time_to_max > dec)
666 mk_time_to_max -= dec;
669 PRINT_SET_VAL(mk_time_to_max);
672 if (mk_wheel_max_speed > dec)
673 mk_wheel_max_speed -= dec;
675 mk_wheel_max_speed = 0;
676 PRINT_SET_VAL(mk_wheel_max_speed);
679 if (mk_wheel_time_to_max > dec)
680 mk_wheel_time_to_max -= dec;
682 mk_wheel_time_to_max = 0;
683 PRINT_SET_VAL(mk_wheel_time_to_max);
688 static void mousekey_console_help(void)
690 print("\n\t- Mousekey -\n"
696 "5: wheel_max_speed\n"
697 "6: wheel_time_to_max\n"
706 "speed = delta * max_speed * (repeat / time_to_max)\n");
707 xprintf("where delta: cursor=%d, wheel=%d\n"
708 "See http://en.wikipedia.org/wiki/Mouse_keys\n", MOUSEKEY_MOVE_DELTA, MOUSEKEY_WHEEL_DELTA);
711 static bool mousekey_console(uint8_t code)
715 case KC_SLASH: /* ? */
716 mousekey_console_help();
720 if (mousekey_param) {
724 command_state = CONSOLE;
729 mousekey_param_print();
737 mousekey_param = numkey2num(code);
740 mousekey_param_inc(mousekey_param, 1);
743 mousekey_param_dec(mousekey_param, 1);
746 mousekey_param_inc(mousekey_param, 10);
749 mousekey_param_dec(mousekey_param, 10);
752 mk_delay = MOUSEKEY_DELAY/10;
753 mk_interval = MOUSEKEY_INTERVAL;
754 mk_max_speed = MOUSEKEY_MAX_SPEED;
755 mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
756 mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
757 mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
758 print("set default\n");
764 if (mousekey_param) {
765 xprintf("M%d> ", mousekey_param);
774 /***********************************************************
776 ***********************************************************/
777 uint8_t numkey2num(uint8_t code)
794 static void switch_default_layer(uint8_t layer)
796 xprintf("L%d\n", layer);
797 default_layer_set(1UL<<layer);