common/command.c

   1 /*
   2 Copyright 2011 Jun Wako <wakojun@gmail.com>
   3
   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.
   8
   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.
  13
  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/>.
  16 */
  17 #include <stdint.h>
  18 #include <stdbool.h>
  19 #include <util/delay.h>
  20 #include "keycode.h"
  21 #include "host.h"
  22 #include "keymap.h"
  23 #include "print.h"
  24 #include "debug.h"
  25 #include "util.h"
  26 #include "timer.h"
  27 #include "keyboard.h"
  28 #include "bootloader.h"
  29 #include "action_layer.h"
  30 #include "eeconfig.h"
  31 #include "sleep_led.h"
  32 #include "led.h"
  33 #include "command.h"
  34 #include "backlight.h"
  35
  36 #ifdef MOUSEKEY_ENABLE
  37 #include "mousekey.h"
  38 #endif
  39
  40 #ifdef PROTOCOL_PJRC
  41 #   include "usb_keyboard.h"
  42 #   ifdef EXTRAKEY_ENABLE
  43 #       include "usb_extra.h"
  44 #   endif
  45 #endif
  46
  47 #ifdef PROTOCOL_VUSB
  48 #   include "usbdrv.h"
  49 #endif
  50
  51
  52 static bool command_common(uint8_t code);
  53 static void command_common_help(void);
  54 static bool command_console(uint8_t code);
  55 static void command_console_help(void);
  56 #ifdef MOUSEKEY_ENABLE
  57 static bool mousekey_console(uint8_t code);
  58 static void mousekey_console_help(void);
  59 #endif
  60
  61 static uint8_t numkey2num(uint8_t code);
  62 static void switch_default_layer(uint8_t layer);
  63
  64
  65 typedef enum { ONESHOT, CONSOLE, MOUSEKEY } cmdstate_t;
  66 static cmdstate_t state = ONESHOT;
  67
  68
  69 bool command_proc(uint8_t code)
  70 {
  71     switch (state) {
  72         case ONESHOT:
  73             if (!IS_COMMAND())
  74                 return false;
  75             return (command_extra(code) || command_common(code));
  76         case CONSOLE:
  77             command_console(code);
  78             break;
  79 #ifdef MOUSEKEY_ENABLE
  80         case MOUSEKEY:
  81             mousekey_console(code);
  82             break;
  83 #endif
  84         default:
  85             state = ONESHOT;
  86             return false;
  87     }
  88     return true;
  89 }
  90
  91 /* This allows to define extra commands. return false when not processed. */
  92 bool command_extra(uint8_t code) __attribute__ ((weak));
  93 bool command_extra(uint8_t code)
  94 {
  95     return false;
  96 }
  97
  98
  99 /***********************************************************
 100  * Command common
 101  ***********************************************************/
 102 static void command_common_help(void)
 103 {
 104     print("\n\n----- Command Help -----\n");
 105     print("c:   enter console mode\n");
 106     print("d:   toggle debug enable\n");
 107     print("x:   toggle matrix debug\n");
 108     print("k:   toggle keyboard debug\n");
 109     print("m:   toggle mouse debug\n");
 110 #ifdef SLEEP_LED_ENABLE
 111     print("z:   toggle sleep LED test\n");
 112 #endif
 113     print("v:   print device version & info\n");
 114     print("t:   print timer count\n");
 115     print("s:   print status\n");
 116     print("e:   print eeprom config\n");
 117 #ifdef NKRO_ENABLE
 118     print("n:   toggle NKRO\n");
 119 #endif
 120     print("0/F10:       switch to Layer0 \n");
 121     print("1/F1:        switch to Layer1 \n");
 122     print("2/F2:        switch to Layer2 \n");
 123     print("3/F3:        switch to Layer3 \n");
 124     print("4/F4:        switch to Layer4 \n");
 125     print("PScr:        power down/remote wake-up\n");
 126     print("Caps:        Lock Keyboard(Child Proof)\n");
 127     print("Paus:        jump to bootloader\n");
 128 }
 129
 130 #ifdef BOOTMAGIC_ENABLE
 131 static void print_eeconfig(void)
 132 {
 133     print("default_layer: "); print_dec(eeconfig_read_default_layer()); print("\n");
 134
 135     debug_config_t dc;
 136     dc.raw = eeconfig_read_debug();
 137     print("debug_config.raw: "); print_hex8(dc.raw); print("\n");
 138     print(".enable: "); print_dec(dc.enable); print("\n");
 139     print(".matrix: "); print_dec(dc.matrix); print("\n");
 140     print(".keyboard: "); print_dec(dc.keyboard); print("\n");
 141     print(".mouse: "); print_dec(dc.mouse); print("\n");
 142
 143     keymap_config_t kc;
 144     kc.raw = eeconfig_read_keymap();
 145     print("keymap_config.raw: "); print_hex8(kc.raw); print("\n");
 146     print(".swap_control_capslock: "); print_dec(kc.swap_control_capslock); print("\n");
 147     print(".capslock_to_control: "); print_dec(kc.capslock_to_control); print("\n");
 148     print(".swap_lalt_lgui: "); print_dec(kc.swap_lalt_lgui); print("\n");
 149     print(".swap_ralt_rgui: "); print_dec(kc.swap_ralt_rgui); print("\n");
 150     print(".no_gui: "); print_dec(kc.no_gui); print("\n");
 151     print(".swap_grave_esc: "); print_dec(kc.swap_grave_esc); print("\n");
 152     print(".swap_backslash_backspace: "); print_dec(kc.swap_backslash_backspace); print("\n");
 153
 154 #ifdef BACKLIGHT_ENABLE
 155     backlight_config_t bc;
 156     bc.raw = eeconfig_read_backlight();
 157     print("backlight_config.raw: "); print_hex8(bc.raw); print("\n");
 158     print(".enable: "); print_dec(bc.enable); print("\n");
 159     print(".level: "); print_dec(bc.level); print("\n");
 160 #endif
 161 }
 162 #endif
 163
 164 static bool command_common(uint8_t code)
 165 {
 166     static host_driver_t *host_driver = 0;
 167     switch (code) {
 168 #ifdef SLEEP_LED_ENABLE
 169         case KC_Z:
 170             // test breathing sleep LED
 171             print("Sleep LED test\n");
 172             sleep_led_toggle();
 173             led_set(host_keyboard_leds());
 174             break;
 175 #endif
 176 #ifdef BOOTMAGIC_ENABLE
 177         case KC_E:
 178             print("eeconfig:\n");
 179             print_eeconfig();
 180             break;
 181 #endif
 182         case KC_CAPSLOCK:
 183             if (host_get_driver()) {
 184                 host_driver = host_get_driver();
 185                 host_set_driver(0);
 186                 print("Locked.\n");
 187             } else {
 188                 host_set_driver(host_driver);
 189                 print("Unlocked.\n");
 190             }
 191             break;
 192         case KC_H:
 193         case KC_SLASH: /* ? */
 194             command_common_help();
 195             break;
 196         case KC_C:
 197             debug_matrix   = false;
 198             debug_keyboard = false;
 199             debug_mouse    = false;
 200             debug_enable   = false;
 201             command_console_help();
 202             print("\nEnter Console Mode\n");
 203             print("C> ");
 204             state = CONSOLE;
 205             break;
 206         case KC_PAUSE:
 207             clear_keyboard();
 208             print("\n\nJump to bootloader... ");
 209             _delay_ms(1000);
 210             bootloader_jump(); // not return
 211             print("not supported.\n");
 212             break;
 213         case KC_D:
 214             if (debug_enable) {
 215                 print("\nDEBUG: disabled.\n");
 216                 debug_matrix   = false;
 217                 debug_keyboard = false;
 218                 debug_mouse    = false;
 219                 debug_enable   = false;
 220             } else {
 221                 print("\nDEBUG: enabled.\n");
 222                 debug_enable   = true;
 223             }
 224             break;
 225         case KC_X: // debug matrix toggle
 226             debug_matrix = !debug_matrix;
 227             if (debug_matrix) {
 228                 print("\nDEBUG: matrix enabled.\n");
 229                 debug_enable = true;
 230             } else {
 231                 print("\nDEBUG: matrix disabled.\n");
 232             }
 233             break;
 234         case KC_K: // debug keyboard toggle
 235             debug_keyboard = !debug_keyboard;
 236             if (debug_keyboard) {
 237                 print("\nDEBUG: keyboard enabled.\n");
 238                 debug_enable = true;
 239             } else {
 240                 print("\nDEBUG: keyboard disabled.\n");
 241             }
 242             break;
 243         case KC_M: // debug mouse toggle
 244             debug_mouse = !debug_mouse;
 245             if (debug_mouse) {
 246                 print("\nDEBUG: mouse enabled.\n");
 247                 debug_enable = true;
 248             } else {
 249                 print("\nDEBUG: mouse disabled.\n");
 250             }
 251             break;
 252         case KC_V: // print version & information
 253             print("\n\n----- Version -----\n");
 254             print("DESC: " STR(DESCRIPTION) "\n");
 255             print("VID: " STR(VENDOR_ID) "(" STR(MANUFACTURER) ") "
 256                   "PID: " STR(PRODUCT_ID) "(" STR(PRODUCT) ") "
 257                   "VER: " STR(DEVICE_VER) "\n");
 258             print("BUILD: " STR(VERSION) " (" __TIME__ " " __DATE__ ")\n");
 259             /* build options */
 260             print("OPTIONS:"
 261 #ifdef PROTOCOL_PJRC
 262             " PJRC"
 263 #endif
 264 #ifdef PROTOCOL_LUFA
 265             " LUFA"
 266 #endif
 267 #ifdef PROTOCOL_VUSB
 268             " VUSB"
 269 #endif
 270 #ifdef BOOTMAGIC_ENABLE
 271             " BOOTMAGIC"
 272 #endif
 273 #ifdef MOUSEKEY_ENABLE
 274             " MOUSEKEY"
 275 #endif
 276 #ifdef EXTRAKEY_ENABLE
 277             " EXTRAKEY"
 278 #endif
 279 #ifdef CONSOLE_ENABLE
 280             " CONSOLE"
 281 #endif
 282 #ifdef COMMAND_ENABLE
 283             " COMMAND"
 284 #endif
 285 #ifdef NKRO_ENABLE
 286             " NKRO"
 287 #endif
 288 #ifdef KEYMAP_SECTION_ENABLE
 289             " KEYMAP_SECTION"
 290 #endif
 291             " " STR(BOOTLOADER_SIZE) "\n");
 292
 293             print("GCC: " STR(__GNUC__) "." STR(__GNUC_MINOR__) "." STR(__GNUC_PATCHLEVEL__)
 294                   " AVR-LIBC: " __AVR_LIBC_VERSION_STRING__
 295                   " AVR_ARCH: avr" STR(__AVR_ARCH__) "\n");
 296             break;
 297         case KC_T: // print timer
 298             print_val_hex32(timer_count);
 299             break;
 300         case KC_S:
 301             print("\n\n----- Status -----\n");
 302             print_val_hex8(host_keyboard_leds());
 303 #ifdef PROTOCOL_PJRC
 304             print_val_hex8(UDCON);
 305             print_val_hex8(UDIEN);
 306             print_val_hex8(UDINT);
 307             print_val_hex8(usb_keyboard_leds);
 308             print_val_hex8(usb_keyboard_protocol);
 309             print_val_hex8(usb_keyboard_idle_config);
 310             print_val_hex8(usb_keyboard_idle_count);
 311 #endif
 312
 313 #ifdef PROTOCOL_PJRC
 314 #   if USB_COUNT_SOF
 315             print_val_hex8(usbSofCount);
 316 #   endif
 317 #endif
 318             break;
 319 #ifdef NKRO_ENABLE
 320         case KC_N:
 321             clear_keyboard(); //Prevents stuck keys.
 322             keyboard_nkro = !keyboard_nkro;
 323             if (keyboard_nkro)
 324                 print("NKRO: enabled\n");
 325             else
 326                 print("NKRO: disabled\n");
 327             break;
 328 #endif
 329 #ifdef EXTRAKEY_ENABLE
 330         case KC_PSCREEN:
 331             // TODO: Power key should take this feature? otherwise any key during suspend.
 332 #ifdef PROTOCOL_PJRC
 333             if (suspend && remote_wakeup) {
 334                 usb_remote_wakeup();
 335             } else {
 336                 host_system_send(SYSTEM_POWER_DOWN);
 337                 host_system_send(0);
 338                 _delay_ms(500);
 339             }
 340 #else
 341             host_system_send(SYSTEM_POWER_DOWN);
 342             _delay_ms(100);
 343             host_system_send(0);
 344             _delay_ms(500);
 345 #endif
 346             break;
 347 #endif
 348         case KC_ESC:
 349         case KC_GRV:
 350         case KC_0:
 351             switch_default_layer(0);
 352             break;
 353         case KC_1 ... KC_9:
 354             switch_default_layer((code - KC_1) + 1);
 355             break;
 356         case KC_F1 ... KC_F12:
 357             switch_default_layer((code - KC_F1) + 1);
 358             break;
 359         default:
 360             print("?");
 361             return false;
 362     }
 363     return true;
 364 }
 365
 366
 367 /***********************************************************
 368  * Command console
 369  ***********************************************************/
 370 static void command_console_help(void)
 371 {
 372     print("\n\n----- Console Help -----\n");
 373     print("ESC/q:       quit\n");
 374 #ifdef MOUSEKEY_ENABLE
 375     print("m:   mousekey\n");
 376 #endif
 377 }
 378
 379 static bool command_console(uint8_t code)
 380 {
 381     switch (code) {
 382         case KC_H:
 383         case KC_SLASH: /* ? */
 384             command_console_help();
 385             break;
 386         case KC_Q:
 387         case KC_ESC:
 388             print("\nQuit Console Mode\n");
 389             state = ONESHOT;
 390             return false;
 391 #ifdef MOUSEKEY_ENABLE
 392         case KC_M:
 393             mousekey_console_help();
 394             print("\nEnter Mousekey Console\n");
 395             print("M0>");
 396             state = MOUSEKEY;
 397             return true;
 398 #endif
 399         default:
 400             print("?");
 401             return false;
 402     }
 403     print("C> ");
 404     return true;
 405 }
 406
 407
 408 #ifdef MOUSEKEY_ENABLE
 409 /***********************************************************
 410  * Mousekey console
 411  ***********************************************************/
 412 static uint8_t mousekey_param = 0;
 413
 414 static void mousekey_param_print(void)
 415 {
 416     print("\n\n----- Mousekey Parameters -----\n");
 417     print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
 418     print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
 419     print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
 420     print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
 421     print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
 422     print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
 423 }
 424
 425 #define PRINT_SET_VAL(v)  print(#v " = "); print_dec(v); print("\n");
 426 static void mousekey_param_inc(uint8_t param, uint8_t inc)
 427 {
 428     switch (param) {
 429         case 1:
 430             if (mk_delay + inc < UINT8_MAX)
 431                 mk_delay += inc;
 432             else
 433                 mk_delay = UINT8_MAX;
 434             PRINT_SET_VAL(mk_delay);
 435             break;
 436         case 2:
 437             if (mk_interval + inc < UINT8_MAX)
 438                 mk_interval += inc;
 439             else
 440                 mk_interval = UINT8_MAX;
 441             PRINT_SET_VAL(mk_interval);
 442             break;
 443         case 3:
 444             if (mk_max_speed + inc < UINT8_MAX)
 445                 mk_max_speed += inc;
 446             else
 447                 mk_max_speed = UINT8_MAX;
 448             PRINT_SET_VAL(mk_max_speed);
 449             break;
 450         case 4:
 451             if (mk_time_to_max + inc < UINT8_MAX)
 452                 mk_time_to_max += inc;
 453             else
 454                 mk_time_to_max = UINT8_MAX;
 455             PRINT_SET_VAL(mk_time_to_max);
 456             break;
 457         case 5:
 458             if (mk_wheel_max_speed + inc < UINT8_MAX)
 459                 mk_wheel_max_speed += inc;
 460             else
 461                 mk_wheel_max_speed = UINT8_MAX;
 462             PRINT_SET_VAL(mk_wheel_max_speed);
 463             break;
 464         case 6:
 465             if (mk_wheel_time_to_max + inc < UINT8_MAX)
 466                 mk_wheel_time_to_max += inc;
 467             else
 468                 mk_wheel_time_to_max = UINT8_MAX;
 469             PRINT_SET_VAL(mk_wheel_time_to_max);
 470             break;
 471     }
 472 }
 473
 474 static void mousekey_param_dec(uint8_t param, uint8_t dec)
 475 {
 476     switch (param) {
 477         case 1:
 478             if (mk_delay > dec)
 479                 mk_delay -= dec;
 480             else
 481                 mk_delay = 0;
 482             PRINT_SET_VAL(mk_delay);
 483             break;
 484         case 2:
 485             if (mk_interval > dec)
 486                 mk_interval -= dec;
 487             else
 488                 mk_interval = 0;
 489             PRINT_SET_VAL(mk_interval);
 490             break;
 491         case 3:
 492             if (mk_max_speed > dec)
 493                 mk_max_speed -= dec;
 494             else
 495                 mk_max_speed = 0;
 496             PRINT_SET_VAL(mk_max_speed);
 497             break;
 498         case 4:
 499             if (mk_time_to_max > dec)
 500                 mk_time_to_max -= dec;
 501             else
 502                 mk_time_to_max = 0;
 503             PRINT_SET_VAL(mk_time_to_max);
 504             break;
 505         case 5:
 506             if (mk_wheel_max_speed > dec)
 507                 mk_wheel_max_speed -= dec;
 508             else
 509                 mk_wheel_max_speed = 0;
 510             PRINT_SET_VAL(mk_wheel_max_speed);
 511             break;
 512         case 6:
 513             if (mk_wheel_time_to_max > dec)
 514                 mk_wheel_time_to_max -= dec;
 515             else
 516                 mk_wheel_time_to_max = 0;
 517             PRINT_SET_VAL(mk_wheel_time_to_max);
 518             break;
 519     }
 520 }
 521
 522 static void mousekey_console_help(void)
 523 {
 524     print("\n\n----- Mousekey Parameters Help -----\n");
 525     print("ESC/q:       quit\n");
 526     print("1:   select mk_delay(*10ms)\n");
 527     print("2:   select mk_interval(ms)\n");
 528     print("3:   select mk_max_speed\n");
 529     print("4:   select mk_time_to_max\n");
 530     print("5:   select mk_wheel_max_speed\n");
 531     print("6:   select mk_wheel_time_to_max\n");
 532     print("p:   print prameters\n");
 533     print("d:   set default values\n");
 534     print("up:  increase prameters(+1)\n");
 535     print("down:        decrease prameters(-1)\n");
 536     print("pgup:        increase prameters(+10)\n");
 537     print("pgdown:      decrease prameters(-10)\n");
 538     print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
 539     print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
 540     print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
 541     print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
 542 }
 543
 544 static bool mousekey_console(uint8_t code)
 545 {
 546     switch (code) {
 547         case KC_H:
 548         case KC_SLASH: /* ? */
 549             mousekey_console_help();
 550             break;
 551         case KC_Q:
 552         case KC_ESC:
 553             mousekey_param = 0;
 554             print("\nQuit Mousekey Console\n");
 555             print("C> ");
 556             state = CONSOLE;
 557             return false;
 558         case KC_P:
 559             mousekey_param_print();
 560             break;
 561         case KC_1:
 562         case KC_2:
 563         case KC_3:
 564         case KC_4:
 565         case KC_5:
 566         case KC_6:
 567         case KC_7:
 568         case KC_8:
 569         case KC_9:
 570         case KC_0:
 571             mousekey_param = numkey2num(code);
 572             print("selected parameter: "); pdec(mousekey_param); print("\n");
 573             break;
 574         case KC_UP:
 575             mousekey_param_inc(mousekey_param, 1);
 576             break;
 577         case KC_DOWN:
 578             mousekey_param_dec(mousekey_param, 1);
 579             break;
 580         case KC_PGUP:
 581             mousekey_param_inc(mousekey_param, 10);
 582             break;
 583         case KC_PGDN:
 584             mousekey_param_dec(mousekey_param, 10);
 585             break;
 586         case KC_D:
 587             mk_delay = MOUSEKEY_DELAY/10;
 588             mk_interval = MOUSEKEY_INTERVAL;
 589             mk_max_speed = MOUSEKEY_MAX_SPEED;
 590             mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
 591             mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
 592             mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
 593             print("set default values.\n");
 594             break;
 595         default:
 596             print("?");
 597             return false;
 598     }
 599     print("M"); pdec(mousekey_param); print("> ");
 600     return true;
 601 }
 602 #endif
 603
 604
 605 /***********************************************************
 606  * Utilities
 607  ***********************************************************/
 608 static uint8_t numkey2num(uint8_t code)
 609 {
 610     switch (code) {
 611         case KC_1: return 1;
 612         case KC_2: return 2;
 613         case KC_3: return 3;
 614         case KC_4: return 4;
 615         case KC_5: return 5;
 616         case KC_6: return 6;
 617         case KC_7: return 7;
 618         case KC_8: return 8;
 619         case KC_9: return 9;
 620         case KC_0: return 0;
 621     }
 622     return 0;
 623 }
 624
 625 static void switch_default_layer(uint8_t layer)
 626 {
 627     print("switch_default_layer: "); print_dec(biton32(default_layer_state));
 628     print(" to "); print_dec(layer); print("\n");
 629     default_layer_set(1UL<<layer);
 630     clear_keyboard();
 631 }