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 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583
  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 "layer_switch.h"
  27. #include "eeconfig.h"
  28. #include "command.h"
  29. #ifdef MOUSEKEY_ENABLE
  30. #include "mousekey.h"
  31. #endif
  32. #ifdef PROTOCOL_PJRC
  33. # include "usb_keyboard.h"
  34. # ifdef EXTRAKEY_ENABLE
  35. # include "usb_extra.h"
  36. # endif
  37. #endif
  38. #ifdef PROTOCOL_VUSB
  39. # include "usbdrv.h"
  40. #endif
  41. static bool command_common(uint8_t code);
  42. static void command_common_help(void);
  43. static bool command_console(uint8_t code);
  44. static void command_console_help(void);
  45. #ifdef MOUSEKEY_ENABLE
  46. static bool mousekey_console(uint8_t code);
  47. static void mousekey_console_help(void);
  48. #endif
  49. static uint8_t numkey2num(uint8_t code);
  50. static void switch_default_layer(uint8_t layer);
  51. typedef enum { ONESHOT, CONSOLE, MOUSEKEY } cmdstate_t;
  52. static cmdstate_t state = ONESHOT;
  53. bool command_proc(uint8_t code)
  54. {
  55. switch (state) {
  56. case ONESHOT:
  57. if (!IS_COMMAND())
  58. return false;
  59. return (command_extra(code) || command_common(code));
  60. case CONSOLE:
  61. command_console(code);
  62. break;
  63. #ifdef MOUSEKEY_ENABLE
  64. case MOUSEKEY:
  65. mousekey_console(code);
  66. break;
  67. #endif
  68. default:
  69. state = ONESHOT;
  70. return false;
  71. }
  72. return true;
  73. }
  74. /* This allows to define extra commands. return false when not processed. */
  75. bool command_extra(uint8_t code) __attribute__ ((weak));
  76. bool command_extra(uint8_t code)
  77. {
  78. return false;
  79. }
  80. /***********************************************************
  81. * Command common
  82. ***********************************************************/
  83. static void command_common_help(void)
  84. {
  85. print_enable = true;
  86. print("\n\n----- Command Help -----\n");
  87. print("c: enter console mode\n");
  88. print("d: toggle debug enable\n");
  89. print("x: toggle matrix debug\n");
  90. print("k: toggle keyboard debug\n");
  91. print("m: toggle mouse debug\n");
  92. print("p: toggle print enable\n");
  93. print("v: print device version & info\n");
  94. print("t: print timer count\n");
  95. print("s: print status\n");
  96. print("e: print eeprom boot config\n");
  97. #ifdef NKRO_ENABLE
  98. print("n: toggle NKRO\n");
  99. #endif
  100. print("0/F10: switch to Layer0 \n");
  101. print("1/F1: switch to Layer1 \n");
  102. print("2/F2: switch to Layer2 \n");
  103. print("3/F3: switch to Layer3 \n");
  104. print("4/F4: switch to Layer4 \n");
  105. print("PScr: power down/remote wake-up\n");
  106. print("Caps: Lock Keyboard(Child Proof)\n");
  107. print("Paus: jump to bootloader\n");
  108. }
  109. #ifdef BOOTMAGIC_ENABLE
  110. static void print_eeprom_config(void)
  111. {
  112. uint8_t eebyte;
  113. eebyte = eeconfig_read_debug();
  114. print("debug: "); print_hex8(eebyte); print("\n");
  115. eebyte = eeconfig_read_defalt_layer();
  116. print("defalt_layer: "); print_hex8(eebyte); print("\n");
  117. eebyte = eeconfig_read_keyconf();
  118. print("keyconf: "); print_hex8(eebyte); print("\n");
  119. keyconf kc = (keyconf){ .raw = eebyte };
  120. print("keyconf.swap_control_capslock: "); print_hex8(kc.swap_control_capslock); print("\n");
  121. print("keyconf.capslock_to_control: "); print_hex8(kc.capslock_to_control); print("\n");
  122. print("keyconf.swap_lalt_lgui: "); print_hex8(kc.swap_lalt_lgui); print("\n");
  123. print("keyconf.swap_ralt_rgui: "); print_hex8(kc.swap_ralt_rgui); print("\n");
  124. print("keyconf.no_gui: "); print_hex8(kc.no_gui); print("\n");
  125. print("keyconf.swap_grave_esc: "); print_hex8(kc.swap_grave_esc); print("\n");
  126. print("keyconf.swap_backslash_backspace: "); print_hex8(kc.swap_backslash_backspace); print("\n");
  127. }
  128. #endif
  129. static bool command_common(uint8_t code)
  130. {
  131. static host_driver_t *host_driver = 0;
  132. switch (code) {
  133. #ifdef BOOTMAGIC_ENABLE
  134. case KC_E:
  135. print("eeprom config\n");
  136. print_eeprom_config();
  137. break;
  138. #endif
  139. case KC_CAPSLOCK:
  140. if (host_get_driver()) {
  141. host_driver = host_get_driver();
  142. host_set_driver(0);
  143. print("Locked.\n");
  144. } else {
  145. host_set_driver(host_driver);
  146. print("Unlocked.\n");
  147. }
  148. break;
  149. case KC_H:
  150. case KC_SLASH: /* ? */
  151. command_common_help();
  152. break;
  153. case KC_C:
  154. print_enable = true;
  155. debug_matrix = false;
  156. debug_keyboard = false;
  157. debug_mouse = false;
  158. debug_enable = false;
  159. command_console_help();
  160. print("\nEnter Console Mode\n");
  161. print("C> ");
  162. state = CONSOLE;
  163. break;
  164. case KC_PAUSE:
  165. clear_keyboard();
  166. print("\n\nJump to bootloader... ");
  167. _delay_ms(1000);
  168. bootloader_jump(); // not return
  169. print("not supported.\n");
  170. break;
  171. case KC_D:
  172. if (debug_enable) {
  173. print("\nDEBUG: disabled.\n");
  174. debug_matrix = false;
  175. debug_keyboard = false;
  176. debug_mouse = false;
  177. debug_enable = false;
  178. } else {
  179. print("\nDEBUG: enabled.\n");
  180. debug_enable = true;
  181. }
  182. break;
  183. case KC_X: // debug matrix toggle
  184. debug_matrix = !debug_matrix;
  185. if (debug_matrix) {
  186. print("\nDEBUG: matrix enabled.\n");
  187. debug_enable = true;
  188. } else {
  189. print("\nDEBUG: matrix disabled.\n");
  190. }
  191. break;
  192. case KC_K: // debug keyboard toggle
  193. debug_keyboard = !debug_keyboard;
  194. if (debug_keyboard) {
  195. print("\nDEBUG: keyboard enabled.\n");
  196. debug_enable = true;
  197. } else {
  198. print("\nDEBUG: keyboard disabled.\n");
  199. }
  200. break;
  201. case KC_M: // debug mouse toggle
  202. debug_mouse = !debug_mouse;
  203. if (debug_mouse) {
  204. print("\nDEBUG: mouse enabled.\n");
  205. debug_enable = true;
  206. } else {
  207. print("\nDEBUG: mouse disabled.\n");
  208. }
  209. break;
  210. case KC_V: // print version & information
  211. print("\n\n----- Version -----\n");
  212. print(STR(DESCRIPTION) "\n");
  213. print(STR(MANUFACTURER) "(" STR(VENDOR_ID) ")/");
  214. print(STR(PRODUCT) "(" STR(PRODUCT_ID) ") ");
  215. print("VERSION: " STR(DEVICE_VER) "\n");
  216. break;
  217. case KC_T: // print timer
  218. print_val_hex32(timer_count);
  219. break;
  220. case KC_P: // print toggle
  221. if (print_enable) {
  222. print("print disabled.\n");
  223. print_enable = false;
  224. } else {
  225. print_enable = true;
  226. print("print enabled.\n");
  227. }
  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_enable = true;
  299. print("\n\n----- Console Help -----\n");
  300. print("ESC/q: quit\n");
  301. #ifdef MOUSEKEY_ENABLE
  302. print("m: mousekey\n");
  303. #endif
  304. }
  305. static bool command_console(uint8_t code)
  306. {
  307. switch (code) {
  308. case KC_H:
  309. case KC_SLASH: /* ? */
  310. command_console_help();
  311. break;
  312. case KC_Q:
  313. case KC_ESC:
  314. print("\nQuit Console Mode\n");
  315. state = ONESHOT;
  316. return false;
  317. #ifdef MOUSEKEY_ENABLE
  318. case KC_M:
  319. mousekey_console_help();
  320. print("\nEnter Mousekey Console\n");
  321. print("M0>");
  322. state = MOUSEKEY;
  323. return true;
  324. #endif
  325. default:
  326. print("?");
  327. return false;
  328. }
  329. print("C> ");
  330. return true;
  331. }
  332. #ifdef MOUSEKEY_ENABLE
  333. /***********************************************************
  334. * Mousekey console
  335. ***********************************************************/
  336. static uint8_t mousekey_param = 0;
  337. static void mousekey_param_print(void)
  338. {
  339. print("\n\n----- Mousekey Parameters -----\n");
  340. print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
  341. print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
  342. print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
  343. print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
  344. print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
  345. print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
  346. }
  347. #define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
  348. static void mousekey_param_inc(uint8_t param, uint8_t inc)
  349. {
  350. switch (param) {
  351. case 1:
  352. if (mk_delay + inc < UINT8_MAX)
  353. mk_delay += inc;
  354. else
  355. mk_delay = UINT8_MAX;
  356. PRINT_SET_VAL(mk_delay);
  357. break;
  358. case 2:
  359. if (mk_interval + inc < UINT8_MAX)
  360. mk_interval += inc;
  361. else
  362. mk_interval = UINT8_MAX;
  363. PRINT_SET_VAL(mk_interval);
  364. break;
  365. case 3:
  366. if (mk_max_speed + inc < UINT8_MAX)
  367. mk_max_speed += inc;
  368. else
  369. mk_max_speed = UINT8_MAX;
  370. PRINT_SET_VAL(mk_max_speed);
  371. break;
  372. case 4:
  373. if (mk_time_to_max + inc < UINT8_MAX)
  374. mk_time_to_max += inc;
  375. else
  376. mk_time_to_max = UINT8_MAX;
  377. PRINT_SET_VAL(mk_time_to_max);
  378. break;
  379. case 5:
  380. if (mk_wheel_max_speed + inc < UINT8_MAX)
  381. mk_wheel_max_speed += inc;
  382. else
  383. mk_wheel_max_speed = UINT8_MAX;
  384. PRINT_SET_VAL(mk_wheel_max_speed);
  385. break;
  386. case 6:
  387. if (mk_wheel_time_to_max + inc < UINT8_MAX)
  388. mk_wheel_time_to_max += inc;
  389. else
  390. mk_wheel_time_to_max = UINT8_MAX;
  391. PRINT_SET_VAL(mk_wheel_time_to_max);
  392. break;
  393. }
  394. }
  395. static void mousekey_param_dec(uint8_t param, uint8_t dec)
  396. {
  397. switch (param) {
  398. case 1:
  399. if (mk_delay > dec)
  400. mk_delay -= dec;
  401. else
  402. mk_delay = 0;
  403. PRINT_SET_VAL(mk_delay);
  404. break;
  405. case 2:
  406. if (mk_interval > dec)
  407. mk_interval -= dec;
  408. else
  409. mk_interval = 0;
  410. PRINT_SET_VAL(mk_interval);
  411. break;
  412. case 3:
  413. if (mk_max_speed > dec)
  414. mk_max_speed -= dec;
  415. else
  416. mk_max_speed = 0;
  417. PRINT_SET_VAL(mk_max_speed);
  418. break;
  419. case 4:
  420. if (mk_time_to_max > dec)
  421. mk_time_to_max -= dec;
  422. else
  423. mk_time_to_max = 0;
  424. PRINT_SET_VAL(mk_time_to_max);
  425. break;
  426. case 5:
  427. if (mk_wheel_max_speed > dec)
  428. mk_wheel_max_speed -= dec;
  429. else
  430. mk_wheel_max_speed = 0;
  431. PRINT_SET_VAL(mk_wheel_max_speed);
  432. break;
  433. case 6:
  434. if (mk_wheel_time_to_max > dec)
  435. mk_wheel_time_to_max -= dec;
  436. else
  437. mk_wheel_time_to_max = 0;
  438. PRINT_SET_VAL(mk_wheel_time_to_max);
  439. break;
  440. }
  441. }
  442. static void mousekey_console_help(void)
  443. {
  444. print("\n\n----- Mousekey Parameters Help -----\n");
  445. print("ESC/q: quit\n");
  446. print("1: select mk_delay(*10ms)\n");
  447. print("2: select mk_interval(ms)\n");
  448. print("3: select mk_max_speed\n");
  449. print("4: select mk_time_to_max\n");
  450. print("5: select mk_wheel_max_speed\n");
  451. print("6: select mk_wheel_time_to_max\n");
  452. print("p: print prameters\n");
  453. print("d: set default values\n");
  454. print("up: increase prameters(+1)\n");
  455. print("down: decrease prameters(-1)\n");
  456. print("pgup: increase prameters(+10)\n");
  457. print("pgdown: decrease prameters(-10)\n");
  458. print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
  459. print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
  460. print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
  461. print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
  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. * Utilities
  524. ***********************************************************/
  525. static uint8_t numkey2num(uint8_t code)
  526. {
  527. switch (code) {
  528. case KC_1: return 1;
  529. case KC_2: return 2;
  530. case KC_3: return 3;
  531. case KC_4: return 4;
  532. case KC_5: return 5;
  533. case KC_6: return 6;
  534. case KC_7: return 7;
  535. case KC_8: return 8;
  536. case KC_9: return 9;
  537. case KC_0: return 0;
  538. }
  539. return 0;
  540. }
  541. static void switch_default_layer(uint8_t layer)
  542. {
  543. print("switch_default_layer: "); print_dec(default_layer); print(" to "); print_dec(layer); print("\n");
  544. default_layer_set(layer);
  545. overlay_clear();
  546. clear_keyboard();
  547. }