You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.

command.c 17KB

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