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     backlight_config_t bc;
 155     bc.raw = eeconfig_read_backlight();
 156     print("backlight_config.raw: "); print_hex8(bc.raw); print("\n");
 157     print(".enable: "); print_dec(bc.enable); print("\n");
 158     print(".level: "); print_dec(bc.level); print("\n");
 159 }
 160 #endif
 161
 162 static bool command_common(uint8_t code)
 163 {
 164     static host_driver_t *host_driver = 0;
 165     switch (code) {
 166 #ifdef SLEEP_LED_ENABLE
 167         case KC_Z:
 168             // test breathing sleep LED
 169             print("Sleep LED test\n");
 170             sleep_led_toggle();
 171             led_set(host_keyboard_leds());
 172             break;
 173 #endif
 174 #ifdef BOOTMAGIC_ENABLE
 175         case KC_E:
 176             print("eeconfig:\n");
 177             print_eeconfig();
 178             break;
 179 #endif
 180         case KC_CAPSLOCK:
 181             if (host_get_driver()) {
 182                 host_driver = host_get_driver();
 183                 host_set_driver(0);
 184                 print("Locked.\n");
 185             } else {
 186                 host_set_driver(host_driver);
 187                 print("Unlocked.\n");
 188             }
 189             break;
 190         case KC_H:
 191         case KC_SLASH: /* ? */
 192             command_common_help();
 193             break;
 194         case KC_C:
 195             debug_matrix   = false;
 196             debug_keyboard = false;
 197             debug_mouse    = false;
 198             debug_enable   = false;
 199             command_console_help();
 200             print("\nEnter Console Mode\n");
 201             print("C> ");
 202             state = CONSOLE;
 203             break;
 204         case KC_PAUSE:
 205             clear_keyboard();
 206             print("\n\nJump to bootloader... ");
 207             _delay_ms(1000);
 208             bootloader_jump(); // not return
 209             print("not supported.\n");
 210             break;
 211         case KC_D:
 212             if (debug_enable) {
 213                 print("\nDEBUG: disabled.\n");
 214                 debug_matrix   = false;
 215                 debug_keyboard = false;
 216                 debug_mouse    = false;
 217                 debug_enable   = false;
 218             } else {
 219                 print("\nDEBUG: enabled.\n");
 220                 debug_enable   = true;
 221             }
 222             break;
 223         case KC_X: // debug matrix toggle
 224             debug_matrix = !debug_matrix;
 225             if (debug_matrix) {
 226                 print("\nDEBUG: matrix enabled.\n");
 227                 debug_enable = true;
 228             } else {
 229                 print("\nDEBUG: matrix disabled.\n");
 230             }
 231             break;
 232         case KC_K: // debug keyboard toggle
 233             debug_keyboard = !debug_keyboard;
 234             if (debug_keyboard) {
 235                 print("\nDEBUG: keyboard enabled.\n");
 236                 debug_enable = true;
 237             } else {
 238                 print("\nDEBUG: keyboard disabled.\n");
 239             }
 240             break;
 241         case KC_M: // debug mouse toggle
 242             debug_mouse = !debug_mouse;
 243             if (debug_mouse) {
 244                 print("\nDEBUG: mouse enabled.\n");
 245                 debug_enable = true;
 246             } else {
 247                 print("\nDEBUG: mouse disabled.\n");
 248             }
 249             break;
 250         case KC_V: // print version & information
 251             print("\n\n----- Version -----\n");
 252             print(STR(DESCRIPTION) "\n");
 253             print(STR(MANUFACTURER) "(" STR(VENDOR_ID) ")/");
 254             print(STR(PRODUCT) "(" STR(PRODUCT_ID) ") ");
 255             print("VERSION: " STR(DEVICE_VER) "\n");
 256             break;
 257         case KC_T: // print timer
 258             print_val_hex32(timer_count);
 259             break;
 260         case KC_S:
 261             print("\n\n----- Status -----\n");
 262             print_val_hex8(host_keyboard_leds());
 263 #ifdef PROTOCOL_PJRC
 264             print_val_hex8(UDCON);
 265             print_val_hex8(UDIEN);
 266             print_val_hex8(UDINT);
 267             print_val_hex8(usb_keyboard_leds);
 268             print_val_hex8(usb_keyboard_protocol);
 269             print_val_hex8(usb_keyboard_idle_config);
 270             print_val_hex8(usb_keyboard_idle_count);
 271 #endif
 272
 273 #ifdef PROTOCOL_PJRC
 274 #   if USB_COUNT_SOF
 275             print_val_hex8(usbSofCount);
 276 #   endif
 277 #endif
 278             break;
 279 #ifdef NKRO_ENABLE
 280         case KC_N:
 281             clear_keyboard(); //Prevents stuck keys.
 282             keyboard_nkro = !keyboard_nkro;
 283             if (keyboard_nkro)
 284                 print("NKRO: enabled\n");
 285             else
 286                 print("NKRO: disabled\n");
 287             break;
 288 #endif
 289 #ifdef EXTRAKEY_ENABLE
 290         case KC_PSCREEN:
 291             // TODO: Power key should take this feature? otherwise any key during suspend.
 292 #ifdef PROTOCOL_PJRC
 293             if (suspend && remote_wakeup) {
 294                 usb_remote_wakeup();
 295             } else {
 296                 host_system_send(SYSTEM_POWER_DOWN);
 297                 host_system_send(0);
 298                 _delay_ms(500);
 299             }
 300 #else
 301             host_system_send(SYSTEM_POWER_DOWN);
 302             _delay_ms(100);
 303             host_system_send(0);
 304             _delay_ms(500);
 305 #endif
 306             break;
 307 #endif
 308         case KC_ESC:
 309         case KC_GRV:
 310         case KC_0:
 311             switch_default_layer(0);
 312             break;
 313         case KC_1 ... KC_9:
 314             switch_default_layer((code - KC_1) + 1);
 315             break;
 316         case KC_F1 ... KC_F12:
 317             switch_default_layer((code - KC_F1) + 1);
 318             break;
 319         default:
 320             print("?");
 321             return false;
 322     }
 323     return true;
 324 }
 325
 326
 327 /***********************************************************
 328  * Command console
 329  ***********************************************************/
 330 static void command_console_help(void)
 331 {
 332     print("\n\n----- Console Help -----\n");
 333     print("ESC/q:       quit\n");
 334 #ifdef MOUSEKEY_ENABLE
 335     print("m:   mousekey\n");
 336 #endif
 337 }
 338
 339 static bool command_console(uint8_t code)
 340 {
 341     switch (code) {
 342         case KC_H:
 343         case KC_SLASH: /* ? */
 344             command_console_help();
 345             break;
 346         case KC_Q:
 347         case KC_ESC:
 348             print("\nQuit Console Mode\n");
 349             state = ONESHOT;
 350             return false;
 351 #ifdef MOUSEKEY_ENABLE
 352         case KC_M:
 353             mousekey_console_help();
 354             print("\nEnter Mousekey Console\n");
 355             print("M0>");
 356             state = MOUSEKEY;
 357             return true;
 358 #endif
 359         default:
 360             print("?");
 361             return false;
 362     }
 363     print("C> ");
 364     return true;
 365 }
 366
 367
 368 #ifdef MOUSEKEY_ENABLE
 369 /***********************************************************
 370  * Mousekey console
 371  ***********************************************************/
 372 static uint8_t mousekey_param = 0;
 373
 374 static void mousekey_param_print(void)
 375 {
 376     print("\n\n----- Mousekey Parameters -----\n");
 377     print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
 378     print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
 379     print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
 380     print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
 381     print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
 382     print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
 383 }
 384
 385 #define PRINT_SET_VAL(v)  print(#v " = "); print_dec(v); print("\n");
 386 static void mousekey_param_inc(uint8_t param, uint8_t inc)
 387 {
 388     switch (param) {
 389         case 1:
 390             if (mk_delay + inc < UINT8_MAX)
 391                 mk_delay += inc;
 392             else
 393                 mk_delay = UINT8_MAX;
 394             PRINT_SET_VAL(mk_delay);
 395             break;
 396         case 2:
 397             if (mk_interval + inc < UINT8_MAX)
 398                 mk_interval += inc;
 399             else
 400                 mk_interval = UINT8_MAX;
 401             PRINT_SET_VAL(mk_interval);
 402             break;
 403         case 3:
 404             if (mk_max_speed + inc < UINT8_MAX)
 405                 mk_max_speed += inc;
 406             else
 407                 mk_max_speed = UINT8_MAX;
 408             PRINT_SET_VAL(mk_max_speed);
 409             break;
 410         case 4:
 411             if (mk_time_to_max + inc < UINT8_MAX)
 412                 mk_time_to_max += inc;
 413             else
 414                 mk_time_to_max = UINT8_MAX;
 415             PRINT_SET_VAL(mk_time_to_max);
 416             break;
 417         case 5:
 418             if (mk_wheel_max_speed + inc < UINT8_MAX)
 419                 mk_wheel_max_speed += inc;
 420             else
 421                 mk_wheel_max_speed = UINT8_MAX;
 422             PRINT_SET_VAL(mk_wheel_max_speed);
 423             break;
 424         case 6:
 425             if (mk_wheel_time_to_max + inc < UINT8_MAX)
 426                 mk_wheel_time_to_max += inc;
 427             else
 428                 mk_wheel_time_to_max = UINT8_MAX;
 429             PRINT_SET_VAL(mk_wheel_time_to_max);
 430             break;
 431     }
 432 }
 433
 434 static void mousekey_param_dec(uint8_t param, uint8_t dec)
 435 {
 436     switch (param) {
 437         case 1:
 438             if (mk_delay > dec)
 439                 mk_delay -= dec;
 440             else
 441                 mk_delay = 0;
 442             PRINT_SET_VAL(mk_delay);
 443             break;
 444         case 2:
 445             if (mk_interval > dec)
 446                 mk_interval -= dec;
 447             else
 448                 mk_interval = 0;
 449             PRINT_SET_VAL(mk_interval);
 450             break;
 451         case 3:
 452             if (mk_max_speed > dec)
 453                 mk_max_speed -= dec;
 454             else
 455                 mk_max_speed = 0;
 456             PRINT_SET_VAL(mk_max_speed);
 457             break;
 458         case 4:
 459             if (mk_time_to_max > dec)
 460                 mk_time_to_max -= dec;
 461             else
 462                 mk_time_to_max = 0;
 463             PRINT_SET_VAL(mk_time_to_max);
 464             break;
 465         case 5:
 466             if (mk_wheel_max_speed > dec)
 467                 mk_wheel_max_speed -= dec;
 468             else
 469                 mk_wheel_max_speed = 0;
 470             PRINT_SET_VAL(mk_wheel_max_speed);
 471             break;
 472         case 6:
 473             if (mk_wheel_time_to_max > dec)
 474                 mk_wheel_time_to_max -= dec;
 475             else
 476                 mk_wheel_time_to_max = 0;
 477             PRINT_SET_VAL(mk_wheel_time_to_max);
 478             break;
 479     }
 480 }
 481
 482 static void mousekey_console_help(void)
 483 {
 484     print("\n\n----- Mousekey Parameters Help -----\n");
 485     print("ESC/q:       quit\n");
 486     print("1:   select mk_delay(*10ms)\n");
 487     print("2:   select mk_interval(ms)\n");
 488     print("3:   select mk_max_speed\n");
 489     print("4:   select mk_time_to_max\n");
 490     print("5:   select mk_wheel_max_speed\n");
 491     print("6:   select mk_wheel_time_to_max\n");
 492     print("p:   print prameters\n");
 493     print("d:   set default values\n");
 494     print("up:  increase prameters(+1)\n");
 495     print("down:        decrease prameters(-1)\n");
 496     print("pgup:        increase prameters(+10)\n");
 497     print("pgdown:      decrease prameters(-10)\n");
 498     print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
 499     print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
 500     print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
 501     print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
 502 }
 503
 504 static bool mousekey_console(uint8_t code)
 505 {
 506     switch (code) {
 507         case KC_H:
 508         case KC_SLASH: /* ? */
 509             mousekey_console_help();
 510             break;
 511         case KC_Q:
 512         case KC_ESC:
 513             mousekey_param = 0;
 514             print("\nQuit Mousekey Console\n");
 515             print("C> ");
 516             state = CONSOLE;
 517             return false;
 518         case KC_P:
 519             mousekey_param_print();
 520             break;
 521         case KC_1:
 522         case KC_2:
 523         case KC_3:
 524         case KC_4:
 525         case KC_5:
 526         case KC_6:
 527         case KC_7:
 528         case KC_8:
 529         case KC_9:
 530         case KC_0:
 531             mousekey_param = numkey2num(code);
 532             print("selected parameter: "); pdec(mousekey_param); print("\n");
 533             break;
 534         case KC_UP:
 535             mousekey_param_inc(mousekey_param, 1);
 536             break;
 537         case KC_DOWN:
 538             mousekey_param_dec(mousekey_param, 1);
 539             break;
 540         case KC_PGUP:
 541             mousekey_param_inc(mousekey_param, 10);
 542             break;
 543         case KC_PGDN:
 544             mousekey_param_dec(mousekey_param, 10);
 545             break;
 546         case KC_D:
 547             mk_delay = MOUSEKEY_DELAY/10;
 548             mk_interval = MOUSEKEY_INTERVAL;
 549             mk_max_speed = MOUSEKEY_MAX_SPEED;
 550             mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
 551             mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
 552             mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
 553             print("set default values.\n");
 554             break;
 555         default:
 556             print("?");
 557             return false;
 558     }
 559     print("M"); pdec(mousekey_param); print("> ");
 560     return true;
 561 }
 562 #endif
 563
 564
 565 /***********************************************************
 566  * Utilities
 567  ***********************************************************/
 568 static uint8_t numkey2num(uint8_t code)
 569 {
 570     switch (code) {
 571         case KC_1: return 1;
 572         case KC_2: return 2;
 573         case KC_3: return 3;
 574         case KC_4: return 4;
 575         case KC_5: return 5;
 576         case KC_6: return 6;
 577         case KC_7: return 7;
 578         case KC_8: return 8;
 579         case KC_9: return 9;
 580         case KC_0: return 0;
 581     }
 582     return 0;
 583 }
 584
 585 static void switch_default_layer(uint8_t layer)
 586 {
 587     print("switch_default_layer: "); print_dec(biton32(default_layer_state));
 588     print(" to "); print_dec(layer); print("\n");
 589     default_layer_set(1UL<<layer);
 590     clear_keyboard();
 591 }