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(STR(DESCRIPTION) "\n");
 255             print(STR(MANUFACTURER) "(" STR(VENDOR_ID) ")/");
 256             print(STR(PRODUCT) "(" STR(PRODUCT_ID) ") ");
 257             print("VERSION: " STR(DEVICE_VER) "\n");
 258             break;
 259         case KC_T: // print timer
 260             print_val_hex32(timer_count);
 261             break;
 262         case KC_S:
 263             print("\n\n----- Status -----\n");
 264             print_val_hex8(host_keyboard_leds());
 265 #ifdef PROTOCOL_PJRC
 266             print_val_hex8(UDCON);
 267             print_val_hex8(UDIEN);
 268             print_val_hex8(UDINT);
 269             print_val_hex8(usb_keyboard_leds);
 270             print_val_hex8(usb_keyboard_protocol);
 271             print_val_hex8(usb_keyboard_idle_config);
 272             print_val_hex8(usb_keyboard_idle_count);
 273 #endif
 274
 275 #ifdef PROTOCOL_PJRC
 276 #   if USB_COUNT_SOF
 277             print_val_hex8(usbSofCount);
 278 #   endif
 279 #endif
 280             break;
 281 #ifdef NKRO_ENABLE
 282         case KC_N:
 283             clear_keyboard(); //Prevents stuck keys.
 284             keyboard_nkro = !keyboard_nkro;
 285             if (keyboard_nkro)
 286                 print("NKRO: enabled\n");
 287             else
 288                 print("NKRO: disabled\n");
 289             break;
 290 #endif
 291 #ifdef EXTRAKEY_ENABLE
 292         case KC_PSCREEN:
 293             // TODO: Power key should take this feature? otherwise any key during suspend.
 294 #ifdef PROTOCOL_PJRC
 295             if (suspend && remote_wakeup) {
 296                 usb_remote_wakeup();
 297             } else {
 298                 host_system_send(SYSTEM_POWER_DOWN);
 299                 host_system_send(0);
 300                 _delay_ms(500);
 301             }
 302 #else
 303             host_system_send(SYSTEM_POWER_DOWN);
 304             _delay_ms(100);
 305             host_system_send(0);
 306             _delay_ms(500);
 307 #endif
 308             break;
 309 #endif
 310         case KC_ESC:
 311         case KC_GRV:
 312         case KC_0:
 313             switch_default_layer(0);
 314             break;
 315         case KC_1 ... KC_9:
 316             switch_default_layer((code - KC_1) + 1);
 317             break;
 318         case KC_F1 ... KC_F12:
 319             switch_default_layer((code - KC_F1) + 1);
 320             break;
 321         default:
 322             print("?");
 323             return false;
 324     }
 325     return true;
 326 }
 327
 328
 329 /***********************************************************
 330  * Command console
 331  ***********************************************************/
 332 static void command_console_help(void)
 333 {
 334     print("\n\n----- Console Help -----\n");
 335     print("ESC/q:       quit\n");
 336 #ifdef MOUSEKEY_ENABLE
 337     print("m:   mousekey\n");
 338 #endif
 339 }
 340
 341 static bool command_console(uint8_t code)
 342 {
 343     switch (code) {
 344         case KC_H:
 345         case KC_SLASH: /* ? */
 346             command_console_help();
 347             break;
 348         case KC_Q:
 349         case KC_ESC:
 350             print("\nQuit Console Mode\n");
 351             state = ONESHOT;
 352             return false;
 353 #ifdef MOUSEKEY_ENABLE
 354         case KC_M:
 355             mousekey_console_help();
 356             print("\nEnter Mousekey Console\n");
 357             print("M0>");
 358             state = MOUSEKEY;
 359             return true;
 360 #endif
 361         default:
 362             print("?");
 363             return false;
 364     }
 365     print("C> ");
 366     return true;
 367 }
 368
 369
 370 #ifdef MOUSEKEY_ENABLE
 371 /***********************************************************
 372  * Mousekey console
 373  ***********************************************************/
 374 static uint8_t mousekey_param = 0;
 375
 376 static void mousekey_param_print(void)
 377 {
 378     print("\n\n----- Mousekey Parameters -----\n");
 379     print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
 380     print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
 381     print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
 382     print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
 383     print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
 384     print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
 385 }
 386
 387 #define PRINT_SET_VAL(v)  print(#v " = "); print_dec(v); print("\n");
 388 static void mousekey_param_inc(uint8_t param, uint8_t inc)
 389 {
 390     switch (param) {
 391         case 1:
 392             if (mk_delay + inc < UINT8_MAX)
 393                 mk_delay += inc;
 394             else
 395                 mk_delay = UINT8_MAX;
 396             PRINT_SET_VAL(mk_delay);
 397             break;
 398         case 2:
 399             if (mk_interval + inc < UINT8_MAX)
 400                 mk_interval += inc;
 401             else
 402                 mk_interval = UINT8_MAX;
 403             PRINT_SET_VAL(mk_interval);
 404             break;
 405         case 3:
 406             if (mk_max_speed + inc < UINT8_MAX)
 407                 mk_max_speed += inc;
 408             else
 409                 mk_max_speed = UINT8_MAX;
 410             PRINT_SET_VAL(mk_max_speed);
 411             break;
 412         case 4:
 413             if (mk_time_to_max + inc < UINT8_MAX)
 414                 mk_time_to_max += inc;
 415             else
 416                 mk_time_to_max = UINT8_MAX;
 417             PRINT_SET_VAL(mk_time_to_max);
 418             break;
 419         case 5:
 420             if (mk_wheel_max_speed + inc < UINT8_MAX)
 421                 mk_wheel_max_speed += inc;
 422             else
 423                 mk_wheel_max_speed = UINT8_MAX;
 424             PRINT_SET_VAL(mk_wheel_max_speed);
 425             break;
 426         case 6:
 427             if (mk_wheel_time_to_max + inc < UINT8_MAX)
 428                 mk_wheel_time_to_max += inc;
 429             else
 430                 mk_wheel_time_to_max = UINT8_MAX;
 431             PRINT_SET_VAL(mk_wheel_time_to_max);
 432             break;
 433     }
 434 }
 435
 436 static void mousekey_param_dec(uint8_t param, uint8_t dec)
 437 {
 438     switch (param) {
 439         case 1:
 440             if (mk_delay > dec)
 441                 mk_delay -= dec;
 442             else
 443                 mk_delay = 0;
 444             PRINT_SET_VAL(mk_delay);
 445             break;
 446         case 2:
 447             if (mk_interval > dec)
 448                 mk_interval -= dec;
 449             else
 450                 mk_interval = 0;
 451             PRINT_SET_VAL(mk_interval);
 452             break;
 453         case 3:
 454             if (mk_max_speed > dec)
 455                 mk_max_speed -= dec;
 456             else
 457                 mk_max_speed = 0;
 458             PRINT_SET_VAL(mk_max_speed);
 459             break;
 460         case 4:
 461             if (mk_time_to_max > dec)
 462                 mk_time_to_max -= dec;
 463             else
 464                 mk_time_to_max = 0;
 465             PRINT_SET_VAL(mk_time_to_max);
 466             break;
 467         case 5:
 468             if (mk_wheel_max_speed > dec)
 469                 mk_wheel_max_speed -= dec;
 470             else
 471                 mk_wheel_max_speed = 0;
 472             PRINT_SET_VAL(mk_wheel_max_speed);
 473             break;
 474         case 6:
 475             if (mk_wheel_time_to_max > dec)
 476                 mk_wheel_time_to_max -= dec;
 477             else
 478                 mk_wheel_time_to_max = 0;
 479             PRINT_SET_VAL(mk_wheel_time_to_max);
 480             break;
 481     }
 482 }
 483
 484 static void mousekey_console_help(void)
 485 {
 486     print("\n\n----- Mousekey Parameters Help -----\n");
 487     print("ESC/q:       quit\n");
 488     print("1:   select mk_delay(*10ms)\n");
 489     print("2:   select mk_interval(ms)\n");
 490     print("3:   select mk_max_speed\n");
 491     print("4:   select mk_time_to_max\n");
 492     print("5:   select mk_wheel_max_speed\n");
 493     print("6:   select mk_wheel_time_to_max\n");
 494     print("p:   print prameters\n");
 495     print("d:   set default values\n");
 496     print("up:  increase prameters(+1)\n");
 497     print("down:        decrease prameters(-1)\n");
 498     print("pgup:        increase prameters(+10)\n");
 499     print("pgdown:      decrease prameters(-10)\n");
 500     print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
 501     print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
 502     print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
 503     print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
 504 }
 505
 506 static bool mousekey_console(uint8_t code)
 507 {
 508     switch (code) {
 509         case KC_H:
 510         case KC_SLASH: /* ? */
 511             mousekey_console_help();
 512             break;
 513         case KC_Q:
 514         case KC_ESC:
 515             mousekey_param = 0;
 516             print("\nQuit Mousekey Console\n");
 517             print("C> ");
 518             state = CONSOLE;
 519             return false;
 520         case KC_P:
 521             mousekey_param_print();
 522             break;
 523         case KC_1:
 524         case KC_2:
 525         case KC_3:
 526         case KC_4:
 527         case KC_5:
 528         case KC_6:
 529         case KC_7:
 530         case KC_8:
 531         case KC_9:
 532         case KC_0:
 533             mousekey_param = numkey2num(code);
 534             print("selected parameter: "); pdec(mousekey_param); print("\n");
 535             break;
 536         case KC_UP:
 537             mousekey_param_inc(mousekey_param, 1);
 538             break;
 539         case KC_DOWN:
 540             mousekey_param_dec(mousekey_param, 1);
 541             break;
 542         case KC_PGUP:
 543             mousekey_param_inc(mousekey_param, 10);
 544             break;
 545         case KC_PGDN:
 546             mousekey_param_dec(mousekey_param, 10);
 547             break;
 548         case KC_D:
 549             mk_delay = MOUSEKEY_DELAY/10;
 550             mk_interval = MOUSEKEY_INTERVAL;
 551             mk_max_speed = MOUSEKEY_MAX_SPEED;
 552             mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
 553             mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
 554             mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
 555             print("set default values.\n");
 556             break;
 557         default:
 558             print("?");
 559             return false;
 560     }
 561     print("M"); pdec(mousekey_param); print("> ");
 562     return true;
 563 }
 564 #endif
 565
 566
 567 /***********************************************************
 568  * Utilities
 569  ***********************************************************/
 570 static uint8_t numkey2num(uint8_t code)
 571 {
 572     switch (code) {
 573         case KC_1: return 1;
 574         case KC_2: return 2;
 575         case KC_3: return 3;
 576         case KC_4: return 4;
 577         case KC_5: return 5;
 578         case KC_6: return 6;
 579         case KC_7: return 7;
 580         case KC_8: return 8;
 581         case KC_9: return 9;
 582         case KC_0: return 0;
 583     }
 584     return 0;
 585 }
 586
 587 static void switch_default_layer(uint8_t layer)
 588 {
 589     print("switch_default_layer: "); print_dec(biton32(default_layer_state));
 590     print(" to "); print_dec(layer); print("\n");
 591     default_layer_set(1UL<<layer);
 592     clear_keyboard();
 593 }