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 "command.h"
  30 #ifdef MOUSEKEY_ENABLE
  31 #include "mousekey.h"
  32 #endif
  33
  34 #ifdef HOST_PJRC
  35 #   include "usb_keyboard.h"
  36 #   ifdef EXTRAKEY_ENABLE
  37 #       include "usb_extra.h"
  38 #   endif
  39 #endif
  40
  41 #ifdef HOST_VUSB
  42 #   include "usbdrv.h"
  43 #endif
  44
  45
  46 static bool command_common(uint8_t code);
  47 static void command_common_help(void);
  48 static bool command_console(uint8_t code);
  49 static void command_console_help(void);
  50 #ifdef MOUSEKEY_ENABLE
  51 static bool mousekey_console(uint8_t code);
  52 static void mousekey_console_help(void);
  53 #endif
  54
  55 static uint8_t numkey2num(uint8_t code);
  56 static void switch_layer(uint8_t layer);
  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_ESC:
 265         case KC_GRV:
 266         case KC_0:
 267             clear_keyboard();
 268             switch_layer(0);
 269             break;
 270         case KC_1 ... KC_9:
 271             clear_keyboard();
 272             switch_layer((code - KC_1) + 1);
 273             break;
 274         case KC_F1 ... KC_F12:
 275             clear_keyboard();
 276             switch_layer((code - KC_F1) + 1);
 277             break;
 278         default:
 279             print("?");
 280             return false;
 281     }
 282     return true;
 283 }
 284
 285
 286 /***********************************************************
 287  * Command console
 288  ***********************************************************/
 289 static void command_console_help(void)
 290 {
 291     print_enable = true;
 292     print("\n\n----- Console Help -----\n");
 293     print("ESC/q:       quit\n");
 294 #ifdef MOUSEKEY_ENABLE
 295     print("m:   mousekey\n");
 296 #endif
 297 }
 298
 299 static bool command_console(uint8_t code)
 300 {
 301     switch (code) {
 302         case KC_H:
 303         case KC_SLASH: /* ? */
 304             command_console_help();
 305             break;
 306         case KC_Q:
 307         case KC_ESC:
 308             print("\nQuit Console Mode\n");
 309             state = ONESHOT;
 310             return false;
 311 #ifdef MOUSEKEY_ENABLE
 312         case KC_M:
 313             mousekey_console_help();
 314             print("\nEnter Mousekey Console\n");
 315             print("M0>");
 316             state = MOUSEKEY;
 317             return true;
 318 #endif
 319         default:
 320             print("?");
 321             return false;
 322     }
 323     print("C> ");
 324     return true;
 325 }
 326
 327
 328 #ifdef MOUSEKEY_ENABLE
 329 /***********************************************************
 330  * Mousekey console
 331  ***********************************************************/
 332 static uint8_t mousekey_param = 0;
 333
 334 static void mousekey_param_print(void)
 335 {
 336     print("\n\n----- Mousekey Parameters -----\n");
 337     print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
 338     print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
 339     print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
 340     print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
 341     print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
 342     print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
 343 }
 344
 345 #define PRINT_SET_VAL(v)  print(#v " = "); print_dec(v); print("\n");
 346 static void mousekey_param_inc(uint8_t param, uint8_t inc)
 347 {
 348     switch (param) {
 349         case 1:
 350             if (mk_delay + inc < UINT8_MAX)
 351                 mk_delay += inc;
 352             else
 353                 mk_delay = UINT8_MAX;
 354             PRINT_SET_VAL(mk_delay);
 355             break;
 356         case 2:
 357             if (mk_interval + inc < UINT8_MAX)
 358                 mk_interval += inc;
 359             else
 360                 mk_interval = UINT8_MAX;
 361             PRINT_SET_VAL(mk_interval);
 362             break;
 363         case 3:
 364             if (mk_max_speed + inc < UINT8_MAX)
 365                 mk_max_speed += inc;
 366             else
 367                 mk_max_speed = UINT8_MAX;
 368             PRINT_SET_VAL(mk_max_speed);
 369             break;
 370         case 4:
 371             if (mk_time_to_max + inc < UINT8_MAX)
 372                 mk_time_to_max += inc;
 373             else
 374                 mk_time_to_max = UINT8_MAX;
 375             PRINT_SET_VAL(mk_time_to_max);
 376             break;
 377         case 5:
 378             if (mk_wheel_max_speed + inc < UINT8_MAX)
 379                 mk_wheel_max_speed += inc;
 380             else
 381                 mk_wheel_max_speed = UINT8_MAX;
 382             PRINT_SET_VAL(mk_wheel_max_speed);
 383             break;
 384         case 6:
 385             if (mk_wheel_time_to_max + inc < UINT8_MAX)
 386                 mk_wheel_time_to_max += inc;
 387             else
 388                 mk_wheel_time_to_max = UINT8_MAX;
 389             PRINT_SET_VAL(mk_wheel_time_to_max);
 390             break;
 391     }
 392 }
 393
 394 static void mousekey_param_dec(uint8_t param, uint8_t dec)
 395 {
 396     switch (param) {
 397         case 1:
 398             if (mk_delay > dec)
 399                 mk_delay -= dec;
 400             else
 401                 mk_delay = 0;
 402             PRINT_SET_VAL(mk_delay);
 403             break;
 404         case 2:
 405             if (mk_interval > dec)
 406                 mk_interval -= dec;
 407             else
 408                 mk_interval = 0;
 409             PRINT_SET_VAL(mk_interval);
 410             break;
 411         case 3:
 412             if (mk_max_speed > dec)
 413                 mk_max_speed -= dec;
 414             else
 415                 mk_max_speed = 0;
 416             PRINT_SET_VAL(mk_max_speed);
 417             break;
 418         case 4:
 419             if (mk_time_to_max > dec)
 420                 mk_time_to_max -= dec;
 421             else
 422                 mk_time_to_max = 0;
 423             PRINT_SET_VAL(mk_time_to_max);
 424             break;
 425         case 5:
 426             if (mk_wheel_max_speed > dec)
 427                 mk_wheel_max_speed -= dec;
 428             else
 429                 mk_wheel_max_speed = 0;
 430             PRINT_SET_VAL(mk_wheel_max_speed);
 431             break;
 432         case 6:
 433             if (mk_wheel_time_to_max > dec)
 434                 mk_wheel_time_to_max -= dec;
 435             else
 436                 mk_wheel_time_to_max = 0;
 437             PRINT_SET_VAL(mk_wheel_time_to_max);
 438             break;
 439     }
 440 }
 441
 442 static void mousekey_console_help(void)
 443 {
 444     print("\n\n----- Mousekey Parameters Help -----\n");
 445     print("ESC/q:       quit\n");
 446     print("1:   select mk_delay(*10ms)\n");
 447     print("2:   select mk_interval(ms)\n");
 448     print("3:   select mk_max_speed\n");
 449     print("4:   select mk_time_to_max\n");
 450     print("5:   select mk_wheel_max_speed\n");
 451     print("6:   select mk_wheel_time_to_max\n");
 452     print("p:   print prameters\n");
 453     print("d:   set default values\n");
 454     print("up:  increase prameters(+1)\n");
 455     print("down:        decrease prameters(-1)\n");
 456     print("pgup:        increase prameters(+10)\n");
 457     print("pgdown:      decrease prameters(-10)\n");
 458     print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
 459     print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
 460     print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
 461     print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
 462 }
 463
 464 static bool mousekey_console(uint8_t code)
 465 {
 466     switch (code) {
 467         case KC_H:
 468         case KC_SLASH: /* ? */
 469             mousekey_console_help();
 470             break;
 471         case KC_Q:
 472         case KC_ESC:
 473             mousekey_param = 0;
 474             print("\nQuit Mousekey Console\n");
 475             print("C> ");
 476             state = CONSOLE;
 477             return false;
 478         case KC_P:
 479             mousekey_param_print();
 480             break;
 481         case KC_1:
 482         case KC_2:
 483         case KC_3:
 484         case KC_4:
 485         case KC_5:
 486         case KC_6:
 487         case KC_7:
 488         case KC_8:
 489         case KC_9:
 490         case KC_0:
 491             mousekey_param = numkey2num(code);
 492             print("selected parameter: "); pdec(mousekey_param); print("\n");
 493             break;
 494         case KC_UP:
 495             mousekey_param_inc(mousekey_param, 1);
 496             break;
 497         case KC_DOWN:
 498             mousekey_param_dec(mousekey_param, 1);
 499             break;
 500         case KC_PGUP:
 501             mousekey_param_inc(mousekey_param, 10);
 502             break;
 503         case KC_PGDN:
 504             mousekey_param_dec(mousekey_param, 10);
 505             break;
 506         case KC_D:
 507             mk_delay = MOUSEKEY_DELAY/10;
 508             mk_interval = MOUSEKEY_INTERVAL;
 509             mk_max_speed = MOUSEKEY_MAX_SPEED;
 510             mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
 511             mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
 512             mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
 513             print("set default values.\n");
 514             break;
 515         default:
 516             print("?");
 517             return false;
 518     }
 519     print("M"); pdec(mousekey_param); print("> ");
 520     return true;
 521 }
 522 #endif
 523
 524
 525 /***********************************************************
 526  * Utilities
 527  ***********************************************************/
 528 static uint8_t numkey2num(uint8_t code)
 529 {
 530     switch (code) {
 531         case KC_1: return 1;
 532         case KC_2: return 2;
 533         case KC_3: return 3;
 534         case KC_4: return 4;
 535         case KC_5: return 5;
 536         case KC_6: return 6;
 537         case KC_7: return 7;
 538         case KC_8: return 8;
 539         case KC_9: return 9;
 540         case KC_0: return 0;
 541     }
 542     return 0;
 543 }
 544
 545 static void switch_layer(uint8_t layer)
 546 {
 547     print_val_hex8(current_layer);
 548     print_val_hex8(default_layer);
 549     default_layer = layer;
 550     current_layer = 0;
 551     print("switch to "); print_val_hex8(layer);
 552 }