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_ALT ) ": Switch to Layer 0 (alternate)\n"
156 STR(MAGIC_KEY_BOOTLOADER ) ": Jump to Bootloader\n"
157 STR(MAGIC_KEY_BOOTLOADER_ALT) ": Jump to Bootloader (alternate)\n"
159 #ifdef KEYBOARD_LOCK_ENABLE
160 STR(MAGIC_KEY_LOCK ) ": Lock Keyboard\n"
163 STR(MAGIC_KEY_EEPROM ) ": Print EEPROM Settings\n"
164 STR(MAGIC_KEY_EEPROM_CLEAR) ": Clear EEPROM\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");
185 print("BUILD: (" __DATE__ ")\n");
187 print("BUILD: " STR(QMK_VERSION) " (" __TIME__ " " __DATE__ ")\n");
202 #ifdef BOOTMAGIC_ENABLE
205 #ifdef MOUSEKEY_ENABLE
208 #ifdef EXTRAKEY_ENABLE
211 #ifdef CONSOLE_ENABLE
214 #ifdef COMMAND_ENABLE
220 #ifdef KEYMAP_SECTION_ENABLE
224 " " STR(BOOTLOADER_SIZE) "\n");
226 print("GCC: " STR(__GNUC__) "." STR(__GNUC_MINOR__) "." STR(__GNUC_PATCHLEVEL__)
228 " AVR-LIBC: " __AVR_LIBC_VERSION_STRING__
229 " AVR_ARCH: avr" STR(__AVR_ARCH__)
236 static void print_status(void)
239 print("\n\t- Status -\n");
241 print_val_hex8(host_keyboard_leds());
242 #ifndef PROTOCOL_VUSB
243 // these aren't set on the V-USB protocol, so we just ignore them for now
244 print_val_hex8(keyboard_protocol);
245 print_val_hex8(keyboard_idle);
248 print_val_hex8(keymap_config.nkro);
250 print_val_hex32(timer_read32());
253 print_val_hex8(UDCON);
254 print_val_hex8(UDIEN);
255 print_val_hex8(UDINT);
256 print_val_hex8(usb_keyboard_leds);
257 print_val_hex8(usb_keyboard_idle_count);
262 print_val_hex8(usbSofCount);
268 static void print_eeconfig(void)
271 // Print these variables if NO_PRINT or USER_PRINT are not defined.
272 #if !defined(NO_PRINT) && !defined(USER_PRINT)
274 print("default_layer: "); print_dec(eeconfig_read_default_layer()); print("\n");
277 dc.raw = eeconfig_read_debug();
278 print("debug_config.raw: "); print_hex8(dc.raw); print("\n");
279 print(".enable: "); print_dec(dc.enable); print("\n");
280 print(".matrix: "); print_dec(dc.matrix); print("\n");
281 print(".keyboard: "); print_dec(dc.keyboard); print("\n");
282 print(".mouse: "); print_dec(dc.mouse); print("\n");
285 kc.raw = eeconfig_read_keymap();
286 print("keymap_config.raw: "); print_hex8(kc.raw); print("\n");
287 print(".swap_control_capslock: "); print_dec(kc.swap_control_capslock); print("\n");
288 print(".capslock_to_control: "); print_dec(kc.capslock_to_control); print("\n");
289 print(".swap_lalt_lgui: "); print_dec(kc.swap_lalt_lgui); print("\n");
290 print(".swap_ralt_rgui: "); print_dec(kc.swap_ralt_rgui); print("\n");
291 print(".no_gui: "); print_dec(kc.no_gui); print("\n");
292 print(".swap_grave_esc: "); print_dec(kc.swap_grave_esc); print("\n");
293 print(".swap_backslash_backspace: "); print_dec(kc.swap_backslash_backspace); print("\n");
294 print(".nkro: "); print_dec(kc.nkro); print("\n");
296 #ifdef BACKLIGHT_ENABLE
297 backlight_config_t bc;
298 bc.raw = eeconfig_read_backlight();
299 print("backlight_config.raw: "); print_hex8(bc.raw); print("\n");
300 print(".enable: "); print_dec(bc.enable); print("\n");
301 print(".level: "); print_dec(bc.level); print("\n");
302 #endif /* BACKLIGHT_ENABLE */
304 #endif /* !NO_PRINT */
308 static bool command_common(uint8_t code)
311 #ifdef KEYBOARD_LOCK_ENABLE
312 static host_driver_t *host_driver = 0;
317 #ifdef SLEEP_LED_ENABLE
319 // test breathing sleep LED
320 case MAGIC_KC(MAGIC_KEY_SLEEP_LED):
321 print("Sleep LED Test\n");
323 led_set(host_keyboard_leds());
327 // print stored eeprom config
328 case MAGIC_KC(MAGIC_KEY_EEPROM):
329 print("eeconfig:\n");
334 case MAGIC_KC(MAGIC_KEY_EEPROM_CLEAR):
335 print("Clearing EEPROM\n");
339 #ifdef KEYBOARD_LOCK_ENABLE
341 // lock/unlock keyboard
342 case MAGIC_KC(MAGIC_KEY_LOCK):
343 if (host_get_driver()) {
344 host_driver = host_get_driver();
349 host_set_driver(host_driver);
350 print("Unlocked.\n");
356 case MAGIC_KC(MAGIC_KEY_HELP):
357 case MAGIC_KC(MAGIC_KEY_HELP_ALT):
358 command_common_help();
362 case MAGIC_KC(MAGIC_KEY_CONSOLE):
363 debug_matrix = false;
364 debug_keyboard = false;
366 debug_enable = false;
367 command_console_help();
369 command_state = CONSOLE;
372 // jump to bootloader
373 case MAGIC_KC(MAGIC_KEY_BOOTLOADER):
374 case MAGIC_KC(MAGIC_KEY_BOOTLOADER_ALT):
375 clear_keyboard(); // clear to prevent stuck keys
376 print("\n\nJumping to bootloader... ");
383 bootloader_jump(); // not return
387 case MAGIC_KC(MAGIC_KEY_DEBUG):
388 debug_enable = !debug_enable;
390 print("\ndebug: on\n");
392 print("\ndebug: off\n");
393 debug_matrix = false;
394 debug_keyboard = false;
399 // debug matrix toggle
400 case MAGIC_KC(MAGIC_KEY_DEBUG_MATRIX):
401 debug_matrix = !debug_matrix;
403 print("\nmatrix: on\n");
406 print("\nmatrix: off\n");
410 // debug keyboard toggle
411 case MAGIC_KC(MAGIC_KEY_DEBUG_KBD):
412 debug_keyboard = !debug_keyboard;
413 if (debug_keyboard) {
414 print("\nkeyboard: on\n");
417 print("\nkeyboard: off\n");
421 // debug mouse toggle
422 case MAGIC_KC(MAGIC_KEY_DEBUG_MOUSE):
423 debug_mouse = !debug_mouse;
425 print("\nmouse: on\n");
428 print("\nmouse: off\n");
433 case MAGIC_KC(MAGIC_KEY_VERSION):
438 case MAGIC_KC(MAGIC_KEY_STATUS):
445 case MAGIC_KC(MAGIC_KEY_NKRO):
446 clear_keyboard(); // clear to prevent stuck keys
447 keymap_config.nkro = !keymap_config.nkro;
448 if (keymap_config.nkro) {
451 print("NKRO: off\n");
458 case MAGIC_KC(MAGIC_KEY_LAYER0_ALT):
459 switch_default_layer(0);
462 #if MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
464 case MAGIC_KC(MAGIC_KEY_LAYER0):
465 switch_default_layer(0);
468 case MAGIC_KC(MAGIC_KEY_LAYER1):
469 switch_default_layer(1);
472 case MAGIC_KC(MAGIC_KEY_LAYER2):
473 switch_default_layer(2);
476 case MAGIC_KC(MAGIC_KEY_LAYER3):
477 switch_default_layer(3);
480 case MAGIC_KC(MAGIC_KEY_LAYER4):
481 switch_default_layer(4);
484 case MAGIC_KC(MAGIC_KEY_LAYER5):
485 switch_default_layer(5);
488 case MAGIC_KC(MAGIC_KEY_LAYER6):
489 switch_default_layer(6);
492 case MAGIC_KC(MAGIC_KEY_LAYER7):
493 switch_default_layer(7);
496 case MAGIC_KC(MAGIC_KEY_LAYER8):
497 switch_default_layer(8);
500 case MAGIC_KC(MAGIC_KEY_LAYER9):
501 switch_default_layer(9);
506 #if MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
508 case KC_F1 ... KC_F9:
509 switch_default_layer((code - KC_F1) + 1);
512 switch_default_layer(0);
516 #if MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
519 switch_default_layer((code - KC_1) + 1);
522 switch_default_layer(0);
534 /***********************************************************
536 ***********************************************************/
537 static void command_console_help(void)
539 print("\n\t- Console -\n"
541 #ifdef MOUSEKEY_ENABLE
547 static bool command_console(uint8_t code)
551 case KC_SLASH: /* ? */
552 command_console_help();
556 command_state = ONESHOT;
558 #ifdef MOUSEKEY_ENABLE
560 mousekey_console_help();
562 command_state = MOUSEKEY;
574 #ifdef MOUSEKEY_ENABLE
575 /***********************************************************
577 ***********************************************************/
578 static uint8_t mousekey_param = 0;
580 static void mousekey_param_print(void)
582 // Print these variables if NO_PRINT or USER_PRINT are not defined.
583 #if !defined(NO_PRINT) && !defined(USER_PRINT)
584 print("\n\t- Values -\n");
585 print("1: delay(*10ms): "); pdec(mk_delay); print("\n");
586 print("2: interval(ms): "); pdec(mk_interval); print("\n");
587 print("3: max_speed: "); pdec(mk_max_speed); print("\n");
588 print("4: time_to_max: "); pdec(mk_time_to_max); print("\n");
589 print("5: wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
590 print("6: wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
591 #endif /* !NO_PRINT */
595 //#define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
596 #define PRINT_SET_VAL(v) xprintf(#v " = %d\n", (v))
597 static void mousekey_param_inc(uint8_t param, uint8_t inc)
601 if (mk_delay + inc < UINT8_MAX)
604 mk_delay = UINT8_MAX;
605 PRINT_SET_VAL(mk_delay);
608 if (mk_interval + inc < UINT8_MAX)
611 mk_interval = UINT8_MAX;
612 PRINT_SET_VAL(mk_interval);
615 if (mk_max_speed + inc < UINT8_MAX)
618 mk_max_speed = UINT8_MAX;
619 PRINT_SET_VAL(mk_max_speed);
622 if (mk_time_to_max + inc < UINT8_MAX)
623 mk_time_to_max += inc;
625 mk_time_to_max = UINT8_MAX;
626 PRINT_SET_VAL(mk_time_to_max);
629 if (mk_wheel_max_speed + inc < UINT8_MAX)
630 mk_wheel_max_speed += inc;
632 mk_wheel_max_speed = UINT8_MAX;
633 PRINT_SET_VAL(mk_wheel_max_speed);
636 if (mk_wheel_time_to_max + inc < UINT8_MAX)
637 mk_wheel_time_to_max += inc;
639 mk_wheel_time_to_max = UINT8_MAX;
640 PRINT_SET_VAL(mk_wheel_time_to_max);
645 static void mousekey_param_dec(uint8_t param, uint8_t dec)
653 PRINT_SET_VAL(mk_delay);
656 if (mk_interval > dec)
660 PRINT_SET_VAL(mk_interval);
663 if (mk_max_speed > dec)
667 PRINT_SET_VAL(mk_max_speed);
670 if (mk_time_to_max > dec)
671 mk_time_to_max -= dec;
674 PRINT_SET_VAL(mk_time_to_max);
677 if (mk_wheel_max_speed > dec)
678 mk_wheel_max_speed -= dec;
680 mk_wheel_max_speed = 0;
681 PRINT_SET_VAL(mk_wheel_max_speed);
684 if (mk_wheel_time_to_max > dec)
685 mk_wheel_time_to_max -= dec;
687 mk_wheel_time_to_max = 0;
688 PRINT_SET_VAL(mk_wheel_time_to_max);
693 static void mousekey_console_help(void)
695 print("\n\t- Mousekey -\n"
701 "5: wheel_max_speed\n"
702 "6: wheel_time_to_max\n"
711 "speed = delta * max_speed * (repeat / time_to_max)\n");
712 xprintf("where delta: cursor=%d, wheel=%d\n"
713 "See http://en.wikipedia.org/wiki/Mouse_keys\n", MOUSEKEY_MOVE_DELTA, MOUSEKEY_WHEEL_DELTA);
716 static bool mousekey_console(uint8_t code)
720 case KC_SLASH: /* ? */
721 mousekey_console_help();
725 if (mousekey_param) {
729 command_state = CONSOLE;
734 mousekey_param_print();
742 mousekey_param = numkey2num(code);
745 mousekey_param_inc(mousekey_param, 1);
748 mousekey_param_dec(mousekey_param, 1);
751 mousekey_param_inc(mousekey_param, 10);
754 mousekey_param_dec(mousekey_param, 10);
757 mk_delay = MOUSEKEY_DELAY/10;
758 mk_interval = MOUSEKEY_INTERVAL;
759 mk_max_speed = MOUSEKEY_MAX_SPEED;
760 mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
761 mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
762 mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
763 print("set default\n");
769 if (mousekey_param) {
770 xprintf("M%d> ", mousekey_param);
779 /***********************************************************
781 ***********************************************************/
782 uint8_t numkey2num(uint8_t code)
799 static void switch_default_layer(uint8_t layer)
801 xprintf("L%d\n", layer);
802 default_layer_set(1UL<<layer);