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