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

11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
11 lat temu
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572
  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("\n\n----- Command Help -----\n");
  86. print("c: enter console mode\n");
  87. print("d: toggle debug enable\n");
  88. print("x: toggle matrix debug\n");
  89. print("k: toggle keyboard debug\n");
  90. print("m: toggle mouse debug\n");
  91. print("p: toggle print enable\n");
  92. print("v: print device version & info\n");
  93. print("t: print timer count\n");
  94. print("s: print status\n");
  95. print("e: print eeprom boot config\n");
  96. #ifdef NKRO_ENABLE
  97. print("n: toggle NKRO\n");
  98. #endif
  99. print("0/F10: switch to Layer0 \n");
  100. print("1/F1: switch to Layer1 \n");
  101. print("2/F2: switch to Layer2 \n");
  102. print("3/F3: switch to Layer3 \n");
  103. print("4/F4: switch to Layer4 \n");
  104. print("PScr: power down/remote wake-up\n");
  105. print("Caps: Lock Keyboard(Child Proof)\n");
  106. print("Paus: jump to bootloader\n");
  107. }
  108. #ifdef BOOTMAGIC_ENABLE
  109. static void print_eeprom_config(void)
  110. {
  111. uint8_t eebyte;
  112. eebyte = eeconfig_read_debug();
  113. print("debug: "); print_hex8(eebyte); print("\n");
  114. eebyte = eeconfig_read_defalt_layer();
  115. print("defalt_layer: "); print_hex8(eebyte); print("\n");
  116. eebyte = eeconfig_read_keyconf();
  117. print("keyconf: "); print_hex8(eebyte); print("\n");
  118. keyconf kc;
  119. 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. debug_matrix = false;
  155. debug_keyboard = false;
  156. debug_mouse = false;
  157. debug_enable = false;
  158. command_console_help();
  159. print("\nEnter Console Mode\n");
  160. print("C> ");
  161. state = CONSOLE;
  162. break;
  163. case KC_PAUSE:
  164. clear_keyboard();
  165. print("\n\nJump to bootloader... ");
  166. _delay_ms(1000);
  167. bootloader_jump(); // not return
  168. print("not supported.\n");
  169. break;
  170. case KC_D:
  171. if (debug_enable) {
  172. print("\nDEBUG: disabled.\n");
  173. debug_matrix = false;
  174. debug_keyboard = false;
  175. debug_mouse = false;
  176. debug_enable = false;
  177. } else {
  178. print("\nDEBUG: enabled.\n");
  179. debug_enable = true;
  180. }
  181. break;
  182. case KC_X: // debug matrix toggle
  183. debug_matrix = !debug_matrix;
  184. if (debug_matrix) {
  185. print("\nDEBUG: matrix enabled.\n");
  186. debug_enable = true;
  187. } else {
  188. print("\nDEBUG: matrix disabled.\n");
  189. }
  190. break;
  191. case KC_K: // debug keyboard toggle
  192. debug_keyboard = !debug_keyboard;
  193. if (debug_keyboard) {
  194. print("\nDEBUG: keyboard enabled.\n");
  195. debug_enable = true;
  196. } else {
  197. print("\nDEBUG: keyboard disabled.\n");
  198. }
  199. break;
  200. case KC_M: // debug mouse toggle
  201. debug_mouse = !debug_mouse;
  202. if (debug_mouse) {
  203. print("\nDEBUG: mouse enabled.\n");
  204. debug_enable = true;
  205. } else {
  206. print("\nDEBUG: mouse disabled.\n");
  207. }
  208. break;
  209. case KC_V: // print version & information
  210. print("\n\n----- Version -----\n");
  211. print(STR(DESCRIPTION) "\n");
  212. print(STR(MANUFACTURER) "(" STR(VENDOR_ID) ")/");
  213. print(STR(PRODUCT) "(" STR(PRODUCT_ID) ") ");
  214. print("VERSION: " STR(DEVICE_VER) "\n");
  215. break;
  216. case KC_T: // print timer
  217. print_val_hex32(timer_count);
  218. break;
  219. case KC_S:
  220. print("\n\n----- Status -----\n");
  221. print_val_hex8(host_keyboard_leds());
  222. #ifdef PROTOCOL_PJRC
  223. print_val_hex8(UDCON);
  224. print_val_hex8(UDIEN);
  225. print_val_hex8(UDINT);
  226. print_val_hex8(usb_keyboard_leds);
  227. print_val_hex8(usb_keyboard_protocol);
  228. print_val_hex8(usb_keyboard_idle_config);
  229. print_val_hex8(usb_keyboard_idle_count);
  230. #endif
  231. #ifdef PROTOCOL_PJRC
  232. # if USB_COUNT_SOF
  233. print_val_hex8(usbSofCount);
  234. # endif
  235. #endif
  236. break;
  237. #ifdef NKRO_ENABLE
  238. case KC_N:
  239. clear_keyboard(); //Prevents stuck keys.
  240. keyboard_nkro = !keyboard_nkro;
  241. if (keyboard_nkro)
  242. print("NKRO: enabled\n");
  243. else
  244. print("NKRO: disabled\n");
  245. break;
  246. #endif
  247. #ifdef EXTRAKEY_ENABLE
  248. case KC_PSCREEN:
  249. // TODO: Power key should take this feature? otherwise any key during suspend.
  250. #ifdef PROTOCOL_PJRC
  251. if (suspend && remote_wakeup) {
  252. usb_remote_wakeup();
  253. } else {
  254. host_system_send(SYSTEM_POWER_DOWN);
  255. host_system_send(0);
  256. _delay_ms(500);
  257. }
  258. #else
  259. host_system_send(SYSTEM_POWER_DOWN);
  260. _delay_ms(100);
  261. host_system_send(0);
  262. _delay_ms(500);
  263. #endif
  264. break;
  265. #endif
  266. case KC_ESC:
  267. case KC_GRV:
  268. case KC_0:
  269. switch_default_layer(0);
  270. break;
  271. case KC_1 ... KC_9:
  272. switch_default_layer((code - KC_1) + 1);
  273. break;
  274. case KC_F1 ... KC_F12:
  275. switch_default_layer((code - KC_F1) + 1);
  276. break;
  277. default:
  278. print("?");
  279. return false;
  280. }
  281. return true;
  282. }
  283. /***********************************************************
  284. * Command console
  285. ***********************************************************/
  286. static void command_console_help(void)
  287. {
  288. print("\n\n----- Console Help -----\n");
  289. print("ESC/q: quit\n");
  290. #ifdef MOUSEKEY_ENABLE
  291. print("m: mousekey\n");
  292. #endif
  293. }
  294. static bool command_console(uint8_t code)
  295. {
  296. switch (code) {
  297. case KC_H:
  298. case KC_SLASH: /* ? */
  299. command_console_help();
  300. break;
  301. case KC_Q:
  302. case KC_ESC:
  303. print("\nQuit Console Mode\n");
  304. state = ONESHOT;
  305. return false;
  306. #ifdef MOUSEKEY_ENABLE
  307. case KC_M:
  308. mousekey_console_help();
  309. print("\nEnter Mousekey Console\n");
  310. print("M0>");
  311. state = MOUSEKEY;
  312. return true;
  313. #endif
  314. default:
  315. print("?");
  316. return false;
  317. }
  318. print("C> ");
  319. return true;
  320. }
  321. #ifdef MOUSEKEY_ENABLE
  322. /***********************************************************
  323. * Mousekey console
  324. ***********************************************************/
  325. static uint8_t mousekey_param = 0;
  326. static void mousekey_param_print(void)
  327. {
  328. print("\n\n----- Mousekey Parameters -----\n");
  329. print("1: mk_delay(*10ms): "); pdec(mk_delay); print("\n");
  330. print("2: mk_interval(ms): "); pdec(mk_interval); print("\n");
  331. print("3: mk_max_speed: "); pdec(mk_max_speed); print("\n");
  332. print("4: mk_time_to_max: "); pdec(mk_time_to_max); print("\n");
  333. print("5: mk_wheel_max_speed: "); pdec(mk_wheel_max_speed); print("\n");
  334. print("6: mk_wheel_time_to_max: "); pdec(mk_wheel_time_to_max); print("\n");
  335. }
  336. #define PRINT_SET_VAL(v) print(#v " = "); print_dec(v); print("\n");
  337. static void mousekey_param_inc(uint8_t param, uint8_t inc)
  338. {
  339. switch (param) {
  340. case 1:
  341. if (mk_delay + inc < UINT8_MAX)
  342. mk_delay += inc;
  343. else
  344. mk_delay = UINT8_MAX;
  345. PRINT_SET_VAL(mk_delay);
  346. break;
  347. case 2:
  348. if (mk_interval + inc < UINT8_MAX)
  349. mk_interval += inc;
  350. else
  351. mk_interval = UINT8_MAX;
  352. PRINT_SET_VAL(mk_interval);
  353. break;
  354. case 3:
  355. if (mk_max_speed + inc < UINT8_MAX)
  356. mk_max_speed += inc;
  357. else
  358. mk_max_speed = UINT8_MAX;
  359. PRINT_SET_VAL(mk_max_speed);
  360. break;
  361. case 4:
  362. if (mk_time_to_max + inc < UINT8_MAX)
  363. mk_time_to_max += inc;
  364. else
  365. mk_time_to_max = UINT8_MAX;
  366. PRINT_SET_VAL(mk_time_to_max);
  367. break;
  368. case 5:
  369. if (mk_wheel_max_speed + inc < UINT8_MAX)
  370. mk_wheel_max_speed += inc;
  371. else
  372. mk_wheel_max_speed = UINT8_MAX;
  373. PRINT_SET_VAL(mk_wheel_max_speed);
  374. break;
  375. case 6:
  376. if (mk_wheel_time_to_max + inc < UINT8_MAX)
  377. mk_wheel_time_to_max += inc;
  378. else
  379. mk_wheel_time_to_max = UINT8_MAX;
  380. PRINT_SET_VAL(mk_wheel_time_to_max);
  381. break;
  382. }
  383. }
  384. static void mousekey_param_dec(uint8_t param, uint8_t dec)
  385. {
  386. switch (param) {
  387. case 1:
  388. if (mk_delay > dec)
  389. mk_delay -= dec;
  390. else
  391. mk_delay = 0;
  392. PRINT_SET_VAL(mk_delay);
  393. break;
  394. case 2:
  395. if (mk_interval > dec)
  396. mk_interval -= dec;
  397. else
  398. mk_interval = 0;
  399. PRINT_SET_VAL(mk_interval);
  400. break;
  401. case 3:
  402. if (mk_max_speed > dec)
  403. mk_max_speed -= dec;
  404. else
  405. mk_max_speed = 0;
  406. PRINT_SET_VAL(mk_max_speed);
  407. break;
  408. case 4:
  409. if (mk_time_to_max > dec)
  410. mk_time_to_max -= dec;
  411. else
  412. mk_time_to_max = 0;
  413. PRINT_SET_VAL(mk_time_to_max);
  414. break;
  415. case 5:
  416. if (mk_wheel_max_speed > dec)
  417. mk_wheel_max_speed -= dec;
  418. else
  419. mk_wheel_max_speed = 0;
  420. PRINT_SET_VAL(mk_wheel_max_speed);
  421. break;
  422. case 6:
  423. if (mk_wheel_time_to_max > dec)
  424. mk_wheel_time_to_max -= dec;
  425. else
  426. mk_wheel_time_to_max = 0;
  427. PRINT_SET_VAL(mk_wheel_time_to_max);
  428. break;
  429. }
  430. }
  431. static void mousekey_console_help(void)
  432. {
  433. print("\n\n----- Mousekey Parameters Help -----\n");
  434. print("ESC/q: quit\n");
  435. print("1: select mk_delay(*10ms)\n");
  436. print("2: select mk_interval(ms)\n");
  437. print("3: select mk_max_speed\n");
  438. print("4: select mk_time_to_max\n");
  439. print("5: select mk_wheel_max_speed\n");
  440. print("6: select mk_wheel_time_to_max\n");
  441. print("p: print prameters\n");
  442. print("d: set default values\n");
  443. print("up: increase prameters(+1)\n");
  444. print("down: decrease prameters(-1)\n");
  445. print("pgup: increase prameters(+10)\n");
  446. print("pgdown: decrease prameters(-10)\n");
  447. print("\nspeed = delta * max_speed * (repeat / time_to_max)\n");
  448. print("where delta: cursor="); pdec(MOUSEKEY_MOVE_DELTA);
  449. print(", wheel="); pdec(MOUSEKEY_WHEEL_DELTA); print("\n");
  450. print("See http://en.wikipedia.org/wiki/Mouse_keys\n");
  451. }
  452. static bool mousekey_console(uint8_t code)
  453. {
  454. switch (code) {
  455. case KC_H:
  456. case KC_SLASH: /* ? */
  457. mousekey_console_help();
  458. break;
  459. case KC_Q:
  460. case KC_ESC:
  461. mousekey_param = 0;
  462. print("\nQuit Mousekey Console\n");
  463. print("C> ");
  464. state = CONSOLE;
  465. return false;
  466. case KC_P:
  467. mousekey_param_print();
  468. break;
  469. case KC_1:
  470. case KC_2:
  471. case KC_3:
  472. case KC_4:
  473. case KC_5:
  474. case KC_6:
  475. case KC_7:
  476. case KC_8:
  477. case KC_9:
  478. case KC_0:
  479. mousekey_param = numkey2num(code);
  480. print("selected parameter: "); pdec(mousekey_param); print("\n");
  481. break;
  482. case KC_UP:
  483. mousekey_param_inc(mousekey_param, 1);
  484. break;
  485. case KC_DOWN:
  486. mousekey_param_dec(mousekey_param, 1);
  487. break;
  488. case KC_PGUP:
  489. mousekey_param_inc(mousekey_param, 10);
  490. break;
  491. case KC_PGDN:
  492. mousekey_param_dec(mousekey_param, 10);
  493. break;
  494. case KC_D:
  495. mk_delay = MOUSEKEY_DELAY/10;
  496. mk_interval = MOUSEKEY_INTERVAL;
  497. mk_max_speed = MOUSEKEY_MAX_SPEED;
  498. mk_time_to_max = MOUSEKEY_TIME_TO_MAX;
  499. mk_wheel_max_speed = MOUSEKEY_WHEEL_MAX_SPEED;
  500. mk_wheel_time_to_max = MOUSEKEY_WHEEL_TIME_TO_MAX;
  501. print("set default values.\n");
  502. break;
  503. default:
  504. print("?");
  505. return false;
  506. }
  507. print("M"); pdec(mousekey_param); print("> ");
  508. return true;
  509. }
  510. #endif
  511. /***********************************************************
  512. * Utilities
  513. ***********************************************************/
  514. static uint8_t numkey2num(uint8_t code)
  515. {
  516. switch (code) {
  517. case KC_1: return 1;
  518. case KC_2: return 2;
  519. case KC_3: return 3;
  520. case KC_4: return 4;
  521. case KC_5: return 5;
  522. case KC_6: return 6;
  523. case KC_7: return 7;
  524. case KC_8: return 8;
  525. case KC_9: return 9;
  526. case KC_0: return 0;
  527. }
  528. return 0;
  529. }
  530. static void switch_default_layer(uint8_t layer)
  531. {
  532. print("switch_default_layer: "); print_dec(default_layer); print(" to "); print_dec(layer); print("\n");
  533. default_layer_set(layer);
  534. overlay_clear();
  535. clear_keyboard();
  536. }