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