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

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