Keyboard firmwares for Atmel AVR and Cortex-M
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.

command.c 18KB

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