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