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.

action.c 17KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572
  1. #include "host.h"
  2. #include "timer.h"
  3. //#include "keymap.h"
  4. #include "keycode.h"
  5. #include "keyboard.h"
  6. #include "mousekey.h"
  7. #include "command.h"
  8. #include "util.h"
  9. #include "debug.h"
  10. #include "action.h"
  11. #define Kdebug(s) do { if (debug_keyboard) debug(s); } while(0)
  12. #define Kdebug_P(s) do { if (debug_keyboard) debug_P(s); } while(0)
  13. #define Kdebug_hex(s) do { if (debug_keyboard) debug_hex(s); } while(0)
  14. /*
  15. *
  16. * Event/State|IDLE PRESSING DELAYING[f] WAITING[f,k]
  17. * -----------+------------------------------------------------------------------
  18. * Fn Down |(L+) -*1 WAITING(Sk) IDLE(Rf,Ps)*7
  19. * Up |(L-) IDLE(L-)*8 IDLE(L-)*8 IDLE(L-)*8
  20. * Fnk Down |DELAYING(Sf)* (Rf) WAITING(Sk) IDLE(Rf,Ps,Rf)
  21. * Up |(L-) IDLE(L-/Uf)*8 IDLE(Rf,Uf/L-)*3 IDLE(Rf,Ps,Uf/L-)*3
  22. * Key Down |PRESSING(Rk) (Rk) WAITING(Sk) IDLE(Rf,Ps,Rk)
  23. * Up |(Uk) IDLE(Uk)*4 (Uk) IDLE(L+,Ps,Pk)/(Uk)*a
  24. * |
  25. * Delay |- - IDLE(L+) IDLE(L+,Ps)
  26. * Magic Key |COMMAND*5
  27. *
  28. * *1: ignore Fn if other key is down.
  29. * *2: register Fnk if any key is pressing
  30. * *3: register/unregister delayed Fnk and move to IDLE if code == delayed Fnk, else *8
  31. * *4: if no keys registered to host
  32. * *5: unregister all keys
  33. * *6: only if no keys down
  34. * *7: ignore Fn because Fnk key and stored key are down.
  35. * *8: move to IDLE if layer switch(off) occurs, else stay at current state
  36. * *9: repeat key if pressing Fnk twice quickly(move to PRESSING)
  37. * *a: layer switch and process waiting key and code if code == wainting key, else unregister key
  38. *
  39. * States:
  40. * IDLE: No key is down except modifiers
  41. * DELAYING: delay layer switch after pressing Fn with alt keycode
  42. * WAITING: key is pressed during DELAYING
  43. *
  44. * Events:
  45. * Fn: Fn key without alternative keycode
  46. * Fnk: Fn key with alternative keycode
  47. * -: ignore
  48. * Delay: layer switch delay term is elapsed
  49. *
  50. * Actions:
  51. * Rk: register key
  52. * Uk: unregister key
  53. * Rf: register Fn(alt keycode)
  54. * Uf: unregister Fn(alt keycode)
  55. * Rs: register stored key
  56. * Us: unregister stored key
  57. * Sk: Store key(waiting Key)
  58. * Sf: Store Fn(delayed Fn)
  59. * Ps: Process stored key
  60. * Ps: Process key
  61. * Is: Interpret stored keys in current layer
  62. * L+: Switch to new layer(*unregister* all keys but modifiers)
  63. * L-: Switch back to last layer(*unregister* all keys but modifiers)
  64. * Ld: Switch back to default layer(*unregister* all keys but modifiers)
  65. */
  66. typedef enum { IDLE, DELAYING, WAITING, PRESSING } kbdstate_t;
  67. #define NEXT(state) do { \
  68. Kdebug("NEXT: "); Kdebug_P(state_str(kbdstate)); \
  69. kbdstate = state; \
  70. Kdebug(" -> "); Kdebug_P(state_str(kbdstate)); Kdebug("\n"); \
  71. } while (0)
  72. static kbdstate_t kbdstate = IDLE;
  73. static uint8_t fn_state_bits = 0;
  74. static keyrecord_t delayed_fn = {};
  75. static keyrecord_t waiting_key = {};
  76. static const char *state_str(kbdstate_t state)
  77. {
  78. if (state == IDLE) return PSTR("IDLE");
  79. if (state == DELAYING) return PSTR("DELAYING");
  80. if (state == WAITING) return PSTR("WAITING");
  81. if (state == PRESSING) return PSTR("PRESSING");
  82. return PSTR("UNKNOWN");
  83. }
  84. static bool anykey_sent_to_host(void)
  85. {
  86. return (host_has_anykey() || host_mouse_in_use() ||
  87. host_last_sysytem_report() || host_last_consumer_report());
  88. }
  89. /*
  90. static void layer_switch_on(uint8_t code);
  91. static void layer_switch_off(uint8_t code);
  92. static void key_action(uint8_t code, keyevent_t event);
  93. static void key_pressed(uint8_t code, keyevent_t event);
  94. static void key_released(uint8_t code, keyevent_t event);
  95. static void mod_pressed(uint8_t code, keyevent_t event);
  96. static void mod_released(uint8_t code, keyevent_t event);
  97. */
  98. static void register_code(uint8_t code);
  99. static void unregister_code(uint8_t code);
  100. static void register_mods(uint8_t mods);
  101. static void unregister_mods(uint8_t mods);
  102. static void clear_keyboard(void);
  103. static void clear_keyboard_but_mods(void);
  104. static void layer_switch(uint8_t new_layer);
  105. /* tap */
  106. #define TAP_TIME 200
  107. static keyevent_t last_event = {};
  108. static uint16_t last_event_time = 0;
  109. static uint8_t tap_count = 0;
  110. /* layer */
  111. uint8_t default_layer = 0;
  112. uint8_t current_layer = 0;
  113. uint8_t waiting_layer = 0;
  114. void action_exec(action_t action, keyevent_t event)
  115. {
  116. /* count tap when key is up */
  117. if (KEYEQ(event.key, last_event.key) && timer_elapsed(last_event_time) < TAP_TIME) {
  118. if (!event.pressed) tap_count++;
  119. } else {
  120. tap_count = 0;
  121. }
  122. debug("action: "); debug_hex16(action.code); debug("\n");
  123. debug("kind.id: "); debug_hex(action.kind.id); debug("\n");
  124. debug("kind.param: "); debug_hex16(action.kind.param); debug("\n");
  125. debug("key.code: "); debug_hex(action.key.code); debug("\n");
  126. debug("key.mods: "); debug_hex(action.key.mods); debug("\n");
  127. switch (action.kind.id) {
  128. case ACT_LMODS:
  129. if (event.pressed) {
  130. register_mods(action.key.mods);
  131. register_code(action.key.code);
  132. } else {
  133. unregister_code(action.key.code);
  134. unregister_mods(action.key.mods);
  135. }
  136. break;
  137. case ACT_RMODS:
  138. if (event.pressed) {
  139. register_mods(action.key.mods<<4);
  140. register_code(action.key.code);
  141. } else {
  142. unregister_code(action.key.code);
  143. unregister_mods(action.key.mods<<4);
  144. }
  145. break;
  146. case ACT_LAYER:
  147. switch (action.layer_key.code) {
  148. case 0x00: // Momentary switch
  149. // TODO: history of layer switch
  150. if (event.pressed) {
  151. layer_switch(action.layer_key.layer);
  152. } else {
  153. layer_switch(default_layer);
  154. }
  155. break;
  156. case 0x01: // Oneshot switch
  157. // TODO:
  158. break;
  159. case 0x02: // reserved
  160. case 0x03: // reserved
  161. break;
  162. case 0xF0 ... 0xF7: // Tap to enable/disable
  163. case 0xF8 ... 0xFF: // Tap to toggle layer
  164. // TODO:
  165. break;
  166. default: // with keycode for tap
  167. debug("tap: "); debug_hex(tap_count); debug("\n");
  168. // TODO: layer switch
  169. // TODO: in case tap is interrupted by other key
  170. if (event.pressed) {
  171. // when any key down
  172. if (host_has_anykey()) {
  173. if (tap_count == 0)
  174. register_code(action.layer_key.code);
  175. } else {
  176. }
  177. if (tap_count == 0) {
  178. if (host_has_anykey()) {
  179. register_code(action.layer_key.code);
  180. } else {
  181. waiting_layer = action.layer_key.layer;
  182. }
  183. }
  184. // register key when press after a tap
  185. if (tap_count > 0) {
  186. register_code(action.layer_key.code);
  187. }
  188. } else {
  189. // type key after tap
  190. if (tap_count == 1) {
  191. register_code(action.layer_key.code);
  192. }
  193. unregister_code(action.layer_key.code);
  194. }
  195. break;
  196. }
  197. break;
  198. case ACT_USAGE:
  199. #ifdef EXTRAKEY_ENABLE
  200. switch (action.usage.page) {
  201. case ACTION_USAGE_PAGE_SYSTEM:
  202. if (event.pressed) {
  203. host_system_send(action.usage.code);
  204. } else {
  205. host_system_send(0);
  206. }
  207. break;
  208. case ACTION_USAGE_PAGE_CONSUMER:
  209. if (event.pressed) {
  210. host_consumer_send(action.usage.code);
  211. } else {
  212. host_consumer_send(0);
  213. }
  214. break;
  215. }
  216. #endif
  217. break;
  218. case ACT_MOUSEKEY:
  219. #ifdef MOUSEKEY_ENABLE
  220. if (event.pressed) {
  221. mousekey_on(action.key.code);
  222. mousekey_send();
  223. } else {
  224. mousekey_off(action.key.code);
  225. mousekey_send();
  226. }
  227. #endif
  228. break;
  229. case ACT_LMOD_TAP:
  230. case ACT_RMOD_TAP:
  231. case ACT_MACRO:
  232. case ACT_COMMAND:
  233. case ACT_FUNCTION:
  234. default:
  235. break;
  236. }
  237. /* last event */
  238. last_event = event;
  239. last_event_time = timer_read();
  240. }
  241. #if 0
  242. /* Key Action */
  243. inline
  244. static void key_action(uint8_t code, keyevent_t event)
  245. {
  246. if (event.pressed)
  247. key_pressed(code, event);
  248. else
  249. key_released(code, event);
  250. }
  251. void fn_action(uint8_t code, keyevent_t event)
  252. {
  253. }
  254. /* Key */
  255. inline static void key_pressed(uint8_t code, keyevent_t event)
  256. {
  257. uint8_t tmp_mods;
  258. switch (kbdstate) {
  259. case IDLE:
  260. register_code(code);
  261. NEXT(PRESSING);
  262. break;
  263. case PRESSING:
  264. register_code(code);
  265. break;
  266. case DELAYING:
  267. waiting_key = (keyrecord_t) {
  268. .event = event,
  269. .code = code,
  270. .mods = keyboard_report->mods,
  271. .time = timer_read()
  272. };
  273. NEXT(WAITING);
  274. break;
  275. case WAITING:
  276. // play back key stroke
  277. tmp_mods = keyboard_report->mods;
  278. host_set_mods(delayed_fn.mods);
  279. register_code(delayed_fn.code);
  280. host_set_mods(waiting_key.mods);
  281. register_code(waiting_key.code);
  282. host_set_mods(tmp_mods);
  283. register_code(code);
  284. NEXT(IDLE);
  285. break;
  286. }
  287. }
  288. inline static void key_released(uint8_t code, keyevent_t event)
  289. {
  290. uint8_t tmp_mods;
  291. switch (kbdstate) {
  292. case IDLE:
  293. unregister_code(code);
  294. break;
  295. case PRESSING:
  296. unregister_code(code);
  297. if (!anykey_sent_to_host())
  298. NEXT(IDLE);
  299. break;
  300. case DELAYING:
  301. unregister_code(code);
  302. break;
  303. case WAITING:
  304. if (code == waiting_key.code) {
  305. layer_switch_on(delayed_fn.code);
  306. NEXT(IDLE);
  307. // process waiting_key
  308. tmp_mods = keyboard_report->mods;
  309. host_set_mods(waiting_key.mods);
  310. keymap_process_event(waiting_key.event);
  311. host_set_mods(tmp_mods);
  312. keymap_process_event(event);
  313. } else {
  314. unregister_code(code);
  315. }
  316. break;
  317. }
  318. }
  319. /* layer switch momentary */
  320. inline static void layerkey_pressed(uint8_t code, keyevent_t event)
  321. {
  322. uint8_t tmp_mods;
  323. switch (kbdstate) {
  324. case IDLE:
  325. layer_switch_on(code);
  326. break;
  327. case PRESSING:
  328. // ignore
  329. break;
  330. case DELAYING:
  331. waiting_key = (keyrecord_t) {
  332. .event = event,
  333. .code = code,
  334. .mods = keyboard_report->mods,
  335. .time = timer_read()
  336. };
  337. NEXT(WAITING);
  338. break;
  339. case WAITING:
  340. tmp_mods = keyboard_report->mods;
  341. host_set_mods(delayed_fn.mods);
  342. register_code(delayed_fn.code);
  343. host_set_mods(waiting_key.mods);
  344. register_code(waiting_key.code);
  345. host_set_mods(tmp_mods);
  346. if (kind == FN_DOWN) {
  347. // ignore Fn
  348. } else if (kind == FNK_DOWN) {
  349. register_code(code);
  350. } else if (kind == KEY_DOWN) {
  351. register_code(code);
  352. }
  353. NEXT(IDLE);
  354. break;
  355. }
  356. }
  357. inline static void layerkey_released(uint8_t code, keyevent_t event)
  358. {
  359. switch (kbdstate) {
  360. case IDLE:
  361. layer_switch_off(code);
  362. break;
  363. case PRESSING:
  364. case DELAYING:
  365. case WAITING:
  366. if (layer_switch_off(code))
  367. NEXT(IDLE);
  368. break;
  369. }
  370. }
  371. #endif
  372. static void register_code(uint8_t code)
  373. {
  374. if (code == KC_NO) {
  375. return;
  376. }
  377. else if IS_KEY(code) {
  378. // TODO: should push command_proc out of this block?
  379. if (!command_proc(code)) {
  380. host_add_key(code);
  381. host_send_keyboard_report();
  382. }
  383. }
  384. else if IS_MOD(code) {
  385. host_add_mods(MOD_BIT(code));
  386. host_send_keyboard_report();
  387. }
  388. #ifdef MOUSEKEY_ENABLE
  389. else if IS_MOUSEKEY(code) {
  390. mousekey_on(code);
  391. mousekey_send();
  392. }
  393. #endif
  394. #ifdef EXTRAKEY_ENABLE
  395. else if IS_CONSUMER(code) {
  396. uint16_t usage = 0;
  397. switch (code) {
  398. case KC_AUDIO_MUTE:
  399. usage = AUDIO_MUTE;
  400. break;
  401. case KC_AUDIO_VOL_UP:
  402. usage = AUDIO_VOL_UP;
  403. break;
  404. case KC_AUDIO_VOL_DOWN:
  405. usage = AUDIO_VOL_DOWN;
  406. break;
  407. case KC_MEDIA_NEXT_TRACK:
  408. usage = TRANSPORT_NEXT_TRACK;
  409. break;
  410. case KC_MEDIA_PREV_TRACK:
  411. usage = TRANSPORT_PREV_TRACK;
  412. break;
  413. case KC_MEDIA_STOP:
  414. usage = TRANSPORT_STOP;
  415. break;
  416. case KC_MEDIA_PLAY_PAUSE:
  417. usage = TRANSPORT_PLAY_PAUSE;
  418. break;
  419. case KC_MEDIA_SELECT:
  420. usage = AL_CC_CONFIG;
  421. break;
  422. case KC_MAIL:
  423. usage = AL_EMAIL;
  424. break;
  425. case KC_CALCULATOR:
  426. usage = AL_CALCULATOR;
  427. break;
  428. case KC_MY_COMPUTER:
  429. usage = AL_LOCAL_BROWSER;
  430. break;
  431. case KC_WWW_SEARCH:
  432. usage = AC_SEARCH;
  433. break;
  434. case KC_WWW_HOME:
  435. usage = AC_HOME;
  436. break;
  437. case KC_WWW_BACK:
  438. usage = AC_BACK;
  439. break;
  440. case KC_WWW_FORWARD:
  441. usage = AC_FORWARD;
  442. break;
  443. case KC_WWW_STOP:
  444. usage = AC_STOP;
  445. break;
  446. case KC_WWW_REFRESH:
  447. usage = AC_REFRESH;
  448. break;
  449. case KC_WWW_FAVORITES:
  450. usage = AC_BOOKMARKS;
  451. break;
  452. }
  453. host_consumer_send(usage);
  454. }
  455. else if IS_SYSTEM(code) {
  456. uint16_t usage = 0;
  457. switch (code) {
  458. case KC_SYSTEM_POWER:
  459. usage = SYSTEM_POWER_DOWN;
  460. break;
  461. case KC_SYSTEM_SLEEP:
  462. usage = SYSTEM_SLEEP;
  463. break;
  464. case KC_SYSTEM_WAKE:
  465. usage = SYSTEM_WAKE_UP;
  466. break;
  467. }
  468. host_system_send(usage);
  469. }
  470. #endif
  471. }
  472. static void unregister_code(uint8_t code)
  473. {
  474. if IS_KEY(code) {
  475. host_del_key(code);
  476. host_send_keyboard_report();
  477. }
  478. else if IS_MOD(code) {
  479. host_del_mods(MOD_BIT(code));
  480. host_send_keyboard_report();
  481. }
  482. #ifdef MOUSEKEY_ENABLE
  483. else if IS_MOUSEKEY(code) {
  484. mousekey_off(code);
  485. mousekey_send();
  486. }
  487. #endif
  488. #ifdef EXTRAKEY_ENABLE
  489. else if IS_CONSUMER(code) {
  490. host_consumer_send(0x0000);
  491. }
  492. else if IS_SYSTEM(code) {
  493. host_system_send(0x0000);
  494. }
  495. #endif
  496. }
  497. static void register_mods(uint8_t mods)
  498. {
  499. if (!mods) return;
  500. host_add_mods(mods);
  501. host_send_keyboard_report();
  502. }
  503. static void unregister_mods(uint8_t mods)
  504. {
  505. if (!mods) return;
  506. host_del_mods(mods);
  507. host_send_keyboard_report();
  508. }
  509. static void clear_keyboard(void)
  510. {
  511. host_clear_mods();
  512. clear_keyboard_but_mods();
  513. }
  514. static void clear_keyboard_but_mods(void)
  515. {
  516. host_clear_keys();
  517. host_send_keyboard_report();
  518. #ifdef MOUSEKEY_ENABLE
  519. mousekey_clear();
  520. mousekey_send();
  521. #endif
  522. #ifdef EXTRAKEY_ENABLE
  523. host_system_send(0);
  524. host_consumer_send(0);
  525. #endif
  526. }
  527. static void layer_switch(uint8_t new_layer)
  528. {
  529. if (current_layer != new_layer) {
  530. Kdebug("Layer Switch: "); Kdebug_hex(current_layer);
  531. Kdebug(" -> "); Kdebug_hex(new_layer); Kdebug("\n");
  532. current_layer = new_layer;
  533. clear_keyboard_but_mods(); // To avoid stuck keys
  534. }
  535. }