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 print_val_hex8(keyboard_protocol);
239 print_val_hex8(keyboard_idle);
241 print_val_hex8(keymap_config.nkro);
243 print_val_hex32(timer_read32());
246 print_val_hex8(UDCON);
247 print_val_hex8(UDIEN);
248 print_val_hex8(UDINT);
249 print_val_hex8(usb_keyboard_leds);
250 print_val_hex8(usb_keyboard_idle_count);
255 print_val_hex8(usbSofCount);
261 #ifdef BOOTMAGIC_ENABLE
262 static void print_eeconfig(void)
265 print("default_layer: "); print_dec(eeconfig_read_default_layer()); print("\n");
268 dc.raw = eeconfig_read_debug();
269 print("debug_config.raw: "); print_hex8(dc.raw); print("\n");
270 print(".enable: "); print_dec(dc.enable); print("\n");
271 print(".matrix: "); print_dec(dc.matrix); print("\n");
272 print(".keyboard: "); print_dec(dc.keyboard); print("\n");
273 print(".mouse: "); print_dec(dc.mouse); print("\n");
276 kc.raw = eeconfig_read_keymap();
277 print("keymap_config.raw: "); print_hex8(kc.raw); print("\n");
278 print(".swap_control_capslock: "); print_dec(kc.swap_control_capslock); print("\n");
279 print(".capslock_to_control: "); print_dec(kc.capslock_to_control); print("\n");
280 print(".swap_lalt_lgui: "); print_dec(kc.swap_lalt_lgui); print("\n");
281 print(".swap_ralt_rgui: "); print_dec(kc.swap_ralt_rgui); print("\n");
282 print(".no_gui: "); print_dec(kc.no_gui); print("\n");
283 print(".swap_grave_esc: "); print_dec(kc.swap_grave_esc); print("\n");
284 print(".swap_backslash_backspace: "); print_dec(kc.swap_backslash_backspace); print("\n");
285 print(".nkro: "); print_dec(kc.nkro); print("\n");
287 #ifdef BACKLIGHT_ENABLE
288 backlight_config_t bc;
289 bc.raw = eeconfig_read_backlight();
290 print("backlight_config.raw: "); print_hex8(bc.raw); print("\n");
291 print(".enable: "); print_dec(bc.enable); print("\n");
292 print(".level: "); print_dec(bc.level); print("\n");
293 #endif /* BACKLIGHT_ENABLE */
295 #endif /* !NO_PRINT */
298 #endif /* BOOTMAGIC_ENABLE */
300 static bool command_common(uint8_t code)
303 #ifdef KEYBOARD_LOCK_ENABLE
304 static host_driver_t *host_driver = 0;
309 #ifdef SLEEP_LED_ENABLE
311 // test breathing sleep LED
312 case MAGIC_KC(MAGIC_KEY_SLEEP_LED):
313 print("Sleep LED Test\n");
315 led_set(host_keyboard_leds());
319 #ifdef BOOTMAGIC_ENABLE
321 // print stored eeprom config
322 case MAGIC_KC(MAGIC_KEY_EEPROM):
323 print("eeconfig:\n");
328 #ifdef KEYBOARD_LOCK_ENABLE
330 // lock/unlock keyboard
331 case MAGIC_KC(MAGIC_KEY_LOCK):
332 if (host_get_driver()) {
333 host_driver = host_get_driver();
338 host_set_driver(host_driver);
339 print("Unlocked.\n");
345 case MAGIC_KC(MAGIC_KEY_HELP1):
346 case MAGIC_KC(MAGIC_KEY_HELP2):
347 command_common_help();
351 case MAGIC_KC(MAGIC_KEY_CONSOLE):
352 debug_matrix = false;
353 debug_keyboard = false;
355 debug_enable = false;
356 command_console_help();
358 command_state = CONSOLE;
361 // jump to bootloader
362 case MAGIC_KC(MAGIC_KEY_BOOTLOADER):
363 clear_keyboard(); // clear to prevent stuck keys
364 print("\n\nJumping to bootloader... ");
371 bootloader_jump(); // not return
375 case MAGIC_KC(MAGIC_KEY_DEBUG):
376 debug_enable = !debug_enable;
378 print("\ndebug: on\n");
380 debug_keyboard = true;
383 print("\ndebug: off\n");
384 debug_matrix = false;
385 debug_keyboard = false;
390 // debug matrix toggle
391 case MAGIC_KC(MAGIC_KEY_DEBUG_MATRIX):
392 debug_matrix = !debug_matrix;
394 print("\nmatrix: on\n");
397 print("\nmatrix: off\n");
401 // debug keyboard toggle
402 case MAGIC_KC(MAGIC_KEY_DEBUG_KBD):
403 debug_keyboard = !debug_keyboard;
404 if (debug_keyboard) {
405 print("\nkeyboard: on\n");
408 print("\nkeyboard: off\n");
412 // debug mouse toggle
413 case MAGIC_KC(MAGIC_KEY_DEBUG_MOUSE):
414 debug_mouse = !debug_mouse;
416 print("\nmouse: on\n");
419 print("\nmouse: off\n");
424 case MAGIC_KC(MAGIC_KEY_VERSION):
429 case MAGIC_KC(MAGIC_KEY_STATUS):
436 case MAGIC_KC(MAGIC_KEY_NKRO):
437 clear_keyboard(); // clear to prevent stuck keys
438 keymap_config.nkro = !keymap_config.nkro;
439 if (keymap_config.nkro) {
442 print("NKRO: off\n");
449 case MAGIC_KC(MAGIC_KEY_LAYER0_ALT1):
450 case MAGIC_KC(MAGIC_KEY_LAYER0_ALT2):
451 switch_default_layer(0);
454 #if MAGIC_KEY_SWITCH_LAYER_WITH_CUSTOM
456 case MAGIC_KC(MAGIC_KEY_LAYER0):
457 switch_default_layer(0);
460 case MAGIC_KC(MAGIC_KEY_LAYER1):
461 switch_default_layer(1);
464 case MAGIC_KC(MAGIC_KEY_LAYER2):
465 switch_default_layer(2);
468 case MAGIC_KC(MAGIC_KEY_LAYER3):
469 switch_default_layer(3);
472 case MAGIC_KC(MAGIC_KEY_LAYER4):
473 switch_default_layer(4);
476 case MAGIC_KC(MAGIC_KEY_LAYER5):
477 switch_default_layer(5);
480 case MAGIC_KC(MAGIC_KEY_LAYER6):
481 switch_default_layer(6);
484 case MAGIC_KC(MAGIC_KEY_LAYER7):
485 switch_default_layer(7);
488 case MAGIC_KC(MAGIC_KEY_LAYER8):
489 switch_default_layer(8);
492 case MAGIC_KC(MAGIC_KEY_LAYER9):
493 switch_default_layer(9);
498 #if MAGIC_KEY_SWITCH_LAYER_WITH_FKEYS
500 case KC_F1 ... KC_F9:
501 switch_default_layer((code - KC_F1) + 1);
504 switch_default_layer(0);
508 #if MAGIC_KEY_SWITCH_LAYER_WITH_NKEYS
511 switch_default_layer((code - KC_1) + 1);
514 switch_default_layer(0);
526 /***********************************************************
528 ***********************************************************/
529 static void command_console_help(void)
531 print("\n\t- Console -\n"
533 #ifdef MOUSEKEY_ENABLE
539 static bool command_console(uint8_t code)
543 case KC_SLASH: /* ? */
544 command_console_help();
548 command_state = ONESHOT;
550 #ifdef MOUSEKEY_ENABLE
552 mousekey_console_help();
554 command_state = MOUSEKEY;
566 #ifdef MOUSEKEY_ENABLE
567 /***********************************************************
569 ***********************************************************/
570 static uint8_t mousekey_param = 0;
572 static void mousekey_param_print(void)
575 print("\n\t- Values -\n");
576 print("1: delay(*10ms): "); pdec(mk_delay); print("\n");
577 print("2: interval(ms): "); pdec(mk_interval); print("\n");
578 print("3: max_speed: "); pdec(mk_max_speed); print("\n");
579 print("4: time_to_max: "); pdec(mk_time_to_max); print("\n");
580 print("5: wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
581 print("6: wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
582 #endif /* !NO_PRINT */
586 //#define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
587 #define PRINT_SET_VAL(v) xprintf(#v " = %d\n", (v))
588 static void mousekey_param_inc(uint8_t param, uint8_t inc)
592 if (mk_delay + inc < UINT8_MAX)
595 mk_delay = UINT8_MAX;
596 PRINT_SET_VAL(mk_delay);
599 if (mk_interval + inc < UINT8_MAX)
602 mk_interval = UINT8_MAX;
603 PRINT_SET_VAL(mk_interval);
606 if (mk_max_speed + inc < UINT8_MAX)
609 mk_max_speed = UINT8_MAX;
610 PRINT_SET_VAL(mk_max_speed);
613 if (mk_time_to_max + inc < UINT8_MAX)
614 mk_time_to_max += inc;
616 mk_time_to_max = UINT8_MAX;
617 PRINT_SET_VAL(mk_time_to_max);
620 if (mk_wheel_max_speed + inc < UINT8_MAX)
621 mk_wheel_max_speed += inc;
623 mk_wheel_max_speed = UINT8_MAX;
624 PRINT_SET_VAL(mk_wheel_max_speed);
627 if (mk_wheel_time_to_max + inc < UINT8_MAX)
628 mk_wheel_time_to_max += inc;
630 mk_wheel_time_to_max = UINT8_MAX;
631 PRINT_SET_VAL(mk_wheel_time_to_max);
636 static void mousekey_param_dec(uint8_t param, uint8_t dec)
644 PRINT_SET_VAL(mk_delay);
647 if (mk_interval > dec)
651 PRINT_SET_VAL(mk_interval);
654 if (mk_max_speed > dec)
658 PRINT_SET_VAL(mk_max_speed);
661 if (mk_time_to_max > dec)
662 mk_time_to_max -= dec;
665 PRINT_SET_VAL(mk_time_to_max);
668 if (mk_wheel_max_speed > dec)
669 mk_wheel_max_speed -= dec;
671 mk_wheel_max_speed = 0;
672 PRINT_SET_VAL(mk_wheel_max_speed);
675 if (mk_wheel_time_to_max > dec)
676 mk_wheel_time_to_max -= dec;
678 mk_wheel_time_to_max = 0;
679 PRINT_SET_VAL(mk_wheel_time_to_max);
684 static void mousekey_console_help(void)
686 print("\n\t- Mousekey -\n"
692 "5: wheel_max_speed\n"
693 "6: wheel_time_to_max\n"
702 "speed = delta * max_speed * (repeat / time_to_max)\n");
703 xprintf("where delta: cursor=%d, wheel=%d\n"
704 "See http://en.wikipedia.org/wiki/Mouse_keys\n", MOUSEKEY_MOVE_DELTA, MOUSEKEY_WHEEL_DELTA);
707 static bool mousekey_console(uint8_t code)
711 case KC_SLASH: /* ? */
712 mousekey_console_help();
716 if (mousekey_param) {
720 command_state = CONSOLE;
725 mousekey_param_print();
733 mousekey_param = numkey2num(code);
736 mousekey_param_inc(mousekey_param, 1);
739 mousekey_param_dec(mousekey_param, 1);
742 mousekey_param_inc(mousekey_param, 10);
745 mousekey_param_dec(mousekey_param, 10);
748 mk_delay = MOUSEKEY_DELAY/10;
749 mk_interval = MOUSEKEY_INTERVAL;
750 mk_max_speed = MOUSEKEY_MAX_SPEED;
751 mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
752 mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
753 mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
754 print("set default\n");
760 if (mousekey_param) {
761 xprintf("M%d> ", mousekey_param);
770 /***********************************************************
772 ***********************************************************/
773 uint8_t numkey2num(uint8_t code)
790 static void switch_default_layer(uint8_t layer)
792 xprintf("L%d\n", layer);
793 default_layer_set(1UL<<layer);