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/>.
19 #include <util/delay.h>
28 #include "bootloader.h"
29 #include "action_layer.h"
30 #include "action_util.h"
32 #include "sleep_led.h"
35 #include "backlight.h"
37 #ifdef MOUSEKEY_ENABLE
42 # include "usb_keyboard.h"
43 # ifdef EXTRAKEY_ENABLE
44 # include "usb_extra.h"
53 static bool command_common(uint8_t code);
54 static void command_common_help(void);
55 static bool command_console(uint8_t code);
56 static void command_console_help(void);
57 #ifdef MOUSEKEY_ENABLE
58 static bool mousekey_console(uint8_t code);
59 static void mousekey_console_help(void);
62 static uint8_t numkey2num(uint8_t code);
63 static void switch_default_layer(uint8_t layer);
66 command_state_t command_state = ONESHOT;
69 bool command_proc(uint8_t code)
71 switch (command_state) {
75 return (command_extra(code) || command_common(code));
79 return (command_extra(code) || command_common(code));
81 return (command_console_extra(code) || command_console(code));
83 #ifdef MOUSEKEY_ENABLE
85 mousekey_console(code);
89 command_state = ONESHOT;
95 /* TODO: Refactoring is needed. */
96 /* This allows to define extra commands. return false when not processed. */
97 bool command_extra(uint8_t code) __attribute__ ((weak));
98 bool command_extra(uint8_t code)
103 bool command_console_extra(uint8_t code) __attribute__ ((weak));
104 bool command_console_extra(uint8_t code)
110 /***********************************************************
112 ***********************************************************/
113 static void command_common_help(void)
115 print("\n\n----- Command Help -----\n");
116 print("c: enter console mode\n");
117 print("d: toggle debug enable\n");
118 print("x: toggle matrix debug\n");
119 print("k: toggle keyboard debug\n");
120 print("m: toggle mouse debug\n");
121 #ifdef SLEEP_LED_ENABLE
122 print("z: toggle sleep LED test\n");
124 print("v: print device version & info\n");
125 print("t: print timer count\n");
126 print("s: print status\n");
127 print("e: print eeprom config\n");
129 print("n: toggle NKRO\n");
131 print("0/F10: switch to Layer0 \n");
132 print("1/F1: switch to Layer1 \n");
133 print("2/F2: switch to Layer2 \n");
134 print("3/F3: switch to Layer3 \n");
135 print("4/F4: switch to Layer4 \n");
136 print("PScr: power down/remote wake-up\n");
137 print("Caps: Lock Keyboard(Child Proof)\n");
138 print("Paus: jump to bootloader\n");
141 #ifdef BOOTMAGIC_ENABLE
142 static void print_eeconfig(void)
144 print("default_layer: "); print_dec(eeconfig_read_default_layer()); print("\n");
147 dc.raw = eeconfig_read_debug();
148 print("debug_config.raw: "); print_hex8(dc.raw); print("\n");
149 print(".enable: "); print_dec(dc.enable); print("\n");
150 print(".matrix: "); print_dec(dc.matrix); print("\n");
151 print(".keyboard: "); print_dec(dc.keyboard); print("\n");
152 print(".mouse: "); print_dec(dc.mouse); print("\n");
155 kc.raw = eeconfig_read_keymap();
156 print("keymap_config.raw: "); print_hex8(kc.raw); print("\n");
157 print(".swap_control_capslock: "); print_dec(kc.swap_control_capslock); print("\n");
158 print(".capslock_to_control: "); print_dec(kc.capslock_to_control); print("\n");
159 print(".swap_lalt_lgui: "); print_dec(kc.swap_lalt_lgui); print("\n");
160 print(".swap_ralt_rgui: "); print_dec(kc.swap_ralt_rgui); print("\n");
161 print(".no_gui: "); print_dec(kc.no_gui); print("\n");
162 print(".swap_grave_esc: "); print_dec(kc.swap_grave_esc); print("\n");
163 print(".swap_backslash_backspace: "); print_dec(kc.swap_backslash_backspace); print("\n");
164 print(".nkro: "); print_dec(kc.nkro); print("\n");
166 #ifdef BACKLIGHT_ENABLE
167 backlight_config_t bc;
168 bc.raw = eeconfig_read_backlight();
169 print("backlight_config.raw: "); print_hex8(bc.raw); print("\n");
170 print(".enable: "); print_dec(bc.enable); print("\n");
171 print(".level: "); print_dec(bc.level); print("\n");
176 static bool command_common(uint8_t code)
178 static host_driver_t *host_driver = 0;
180 #ifdef SLEEP_LED_ENABLE
182 // test breathing sleep LED
183 print("Sleep LED test\n");
185 led_set(host_keyboard_leds());
188 #ifdef BOOTMAGIC_ENABLE
190 print("eeconfig:\n");
195 if (host_get_driver()) {
196 host_driver = host_get_driver();
200 host_set_driver(host_driver);
201 print("Unlocked.\n");
205 case KC_SLASH: /* ? */
206 command_common_help();
209 debug_matrix = false;
210 debug_keyboard = false;
212 debug_enable = false;
213 command_console_help();
214 print("\nEnter Console Mode\n");
216 command_state = CONSOLE;
220 print("\n\nJump to bootloader... ");
222 bootloader_jump(); // not return
223 print("not supported.\n");
227 print("\nDEBUG: disabled.\n");
228 debug_matrix = false;
229 debug_keyboard = false;
231 debug_enable = false;
233 print("\nDEBUG: enabled.\n");
237 case KC_X: // debug matrix toggle
238 debug_matrix = !debug_matrix;
240 print("\nDEBUG: matrix enabled.\n");
243 print("\nDEBUG: matrix disabled.\n");
246 case KC_K: // debug keyboard toggle
247 debug_keyboard = !debug_keyboard;
248 if (debug_keyboard) {
249 print("\nDEBUG: keyboard enabled.\n");
252 print("\nDEBUG: keyboard disabled.\n");
255 case KC_M: // debug mouse toggle
256 debug_mouse = !debug_mouse;
258 print("\nDEBUG: mouse enabled.\n");
261 print("\nDEBUG: mouse disabled.\n");
264 case KC_V: // print version & information
265 print("\n\n----- Version -----\n");
266 print("DESC: " STR(DESCRIPTION) "\n");
267 print("VID: " STR(VENDOR_ID) "(" STR(MANUFACTURER) ") "
268 "PID: " STR(PRODUCT_ID) "(" STR(PRODUCT) ") "
269 "VER: " STR(DEVICE_VER) "\n");
270 print("BUILD: " STR(VERSION) " (" __TIME__ " " __DATE__ ")\n");
282 #ifdef BOOTMAGIC_ENABLE
285 #ifdef MOUSEKEY_ENABLE
288 #ifdef EXTRAKEY_ENABLE
291 #ifdef CONSOLE_ENABLE
294 #ifdef COMMAND_ENABLE
300 #ifdef KEYMAP_SECTION_ENABLE
303 " " STR(BOOTLOADER_SIZE) "\n");
305 print("GCC: " STR(__GNUC__) "." STR(__GNUC_MINOR__) "." STR(__GNUC_PATCHLEVEL__)
306 " AVR-LIBC: " __AVR_LIBC_VERSION_STRING__
307 " AVR_ARCH: avr" STR(__AVR_ARCH__) "\n");
309 case KC_T: // print timer
310 print_val_hex32(timer_count);
313 print("\n\n----- Status -----\n");
314 print_val_hex8(host_keyboard_leds());
315 print_val_hex8(keyboard_protocol);
316 print_val_hex8(keyboard_idle);
318 print_val_hex8(UDCON);
319 print_val_hex8(UDIEN);
320 print_val_hex8(UDINT);
321 print_val_hex8(usb_keyboard_leds);
322 print_val_hex8(usb_keyboard_idle_count);
327 print_val_hex8(usbSofCount);
333 clear_keyboard(); //Prevents stuck keys.
334 keyboard_nkro = !keyboard_nkro;
336 print("NKRO: enabled\n");
338 print("NKRO: disabled\n");
341 #ifdef EXTRAKEY_ENABLE
343 // TODO: Power key should take this feature? otherwise any key during suspend.
345 if (suspend && remote_wakeup) {
348 host_system_send(SYSTEM_POWER_DOWN);
353 host_system_send(SYSTEM_POWER_DOWN);
363 switch_default_layer(0);
366 switch_default_layer((code - KC_1) + 1);
368 case KC_F1 ... KC_F12:
369 switch_default_layer((code - KC_F1) + 1);
379 /***********************************************************
381 ***********************************************************/
382 static void command_console_help(void)
384 print("\n\n----- Console Help -----\n");
385 print("ESC/q: quit\n");
386 #ifdef MOUSEKEY_ENABLE
387 print("m: mousekey\n");
391 static bool command_console(uint8_t code)
395 case KC_SLASH: /* ? */
396 command_console_help();
400 print("\nQuit Console Mode\n");
401 command_state = ONESHOT;
403 #ifdef MOUSEKEY_ENABLE
405 mousekey_console_help();
406 print("\nEnter Mousekey Console\n");
408 command_state = MOUSEKEY;
420 #ifdef MOUSEKEY_ENABLE
421 /***********************************************************
423 ***********************************************************/
424 static uint8_t mousekey_param = 0;
426 static void mousekey_param_print(void)
428 print("\n\n----- Mousekey Parameters -----\n");
429 print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
430 print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
431 print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
432 print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
433 print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
434 print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
437 #define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
438 static void mousekey_param_inc(uint8_t param, uint8_t inc)
442 if (mk_delay + inc < UINT8_MAX)
445 mk_delay = UINT8_MAX;
446 PRINT_SET_VAL(mk_delay);
449 if (mk_interval + inc < UINT8_MAX)
452 mk_interval = UINT8_MAX;
453 PRINT_SET_VAL(mk_interval);
456 if (mk_max_speed + inc < UINT8_MAX)
459 mk_max_speed = UINT8_MAX;
460 PRINT_SET_VAL(mk_max_speed);
463 if (mk_time_to_max + inc < UINT8_MAX)
464 mk_time_to_max += inc;
466 mk_time_to_max = UINT8_MAX;
467 PRINT_SET_VAL(mk_time_to_max);
470 if (mk_wheel_max_speed + inc < UINT8_MAX)
471 mk_wheel_max_speed += inc;
473 mk_wheel_max_speed = UINT8_MAX;
474 PRINT_SET_VAL(mk_wheel_max_speed);
477 if (mk_wheel_time_to_max + inc < UINT8_MAX)
478 mk_wheel_time_to_max += inc;
480 mk_wheel_time_to_max = UINT8_MAX;
481 PRINT_SET_VAL(mk_wheel_time_to_max);
486 static void mousekey_param_dec(uint8_t param, uint8_t dec)
494 PRINT_SET_VAL(mk_delay);
497 if (mk_interval > dec)
501 PRINT_SET_VAL(mk_interval);
504 if (mk_max_speed > dec)
508 PRINT_SET_VAL(mk_max_speed);
511 if (mk_time_to_max > dec)
512 mk_time_to_max -= dec;
515 PRINT_SET_VAL(mk_time_to_max);
518 if (mk_wheel_max_speed > dec)
519 mk_wheel_max_speed -= dec;
521 mk_wheel_max_speed = 0;
522 PRINT_SET_VAL(mk_wheel_max_speed);
525 if (mk_wheel_time_to_max > dec)
526 mk_wheel_time_to_max -= dec;
528 mk_wheel_time_to_max = 0;
529 PRINT_SET_VAL(mk_wheel_time_to_max);
534 static void mousekey_console_help(void)
536 print("\n\n----- Mousekey Parameters Help -----\n");
537 print("ESC/q: quit\n");
538 print("1: select mk_delay(*10ms)\n");
539 print("2: select mk_interval(ms)\n");
540 print("3: select mk_max_speed\n");
541 print("4: select mk_time_to_max\n");
542 print("5: select mk_wheel_max_speed\n");
543 print("6: select mk_wheel_time_to_max\n");
544 print("p: print prameters\n");
545 print("d: set default values\n");
546 print("up: increase prameters(+1)\n");
547 print("down: decrease prameters(-1)\n");
548 print("pgup: increase prameters(+10)\n");
549 print("pgdown: decrease prameters(-10)\n");
550 print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
551 print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
552 print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
553 print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
556 static bool mousekey_console(uint8_t code)
560 case KC_SLASH: /* ? */
561 mousekey_console_help();
566 print("\nQuit Mousekey Console\n");
568 command_state = CONSOLE;
571 mousekey_param_print();
583 mousekey_param = numkey2num(code);
584 print("selected parameter: "); pdec(mousekey_param); print("\n");
587 mousekey_param_inc(mousekey_param, 1);
590 mousekey_param_dec(mousekey_param, 1);
593 mousekey_param_inc(mousekey_param, 10);
596 mousekey_param_dec(mousekey_param, 10);
599 mk_delay = MOUSEKEY_DELAY/10;
600 mk_interval = MOUSEKEY_INTERVAL;
601 mk_max_speed = MOUSEKEY_MAX_SPEED;
602 mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
603 mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
604 mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
605 print("set default values.\n");
611 print("M"); pdec(mousekey_param); print("> ");
617 /***********************************************************
619 ***********************************************************/
620 static uint8_t numkey2num(uint8_t code)
637 static void switch_default_layer(uint8_t layer)
639 print("switch_default_layer: "); print_dec(biton32(default_layer_state));
640 print(" to "); print_dec(layer); print("\n");
641 default_layer_set(1UL<<layer);