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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541
  1. /*
  2. Copyright 2012,2013 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 "host.h"
  15. #include "keycode.h"
  16. #include "keyboard.h"
  17. #include "mousekey.h"
  18. #include "command.h"
  19. #include "led.h"
  20. #include "backlight.h"
  21. #include "action_layer.h"
  22. #include "action_tapping.h"
  23. #include "action_macro.h"
  24. #include "action_util.h"
  25. #include "action.h"
  26. #ifdef DEBUG_ACTION
  27. #include "debug.h"
  28. #else
  29. #include "nodebug.h"
  30. #endif
  31. void action_exec(keyevent_t event)
  32. {
  33. if (!IS_NOEVENT(event)) {
  34. dprint("\n---- action_exec: start -----\n");
  35. dprint("EVENT: "); debug_event(event); dprintln();
  36. }
  37. keyrecord_t record = { .event = event };
  38. #ifndef NO_ACTION_TAPPING
  39. action_tapping_process(record);
  40. #else
  41. process_action(&record);
  42. if (!IS_NOEVENT(record.event)) {
  43. dprint("processed: "); debug_record(record); dprintln();
  44. }
  45. #endif
  46. }
  47. void process_action(keyrecord_t *record)
  48. {
  49. keyevent_t event = record->event;
  50. #ifndef NO_ACTION_TAPPING
  51. uint8_t tap_count = record->tap.count;
  52. #endif
  53. if (IS_NOEVENT(event)) { return; }
  54. action_t action = layer_switch_get_action(event.key);
  55. dprint("ACTION: "); debug_action(action);
  56. #ifndef NO_ACTION_LAYER
  57. dprint(" layer_state: "); layer_debug();
  58. dprint(" default_layer_state: "); default_layer_debug();
  59. #endif
  60. dprintln();
  61. switch (action.kind.id) {
  62. /* Key and Mods */
  63. case ACT_LMODS:
  64. case ACT_RMODS:
  65. {
  66. uint8_t mods = (action.kind.id == ACT_LMODS) ? action.key.mods :
  67. action.key.mods<<4;
  68. if (event.pressed) {
  69. if (mods) {
  70. add_weak_mods(mods);
  71. send_keyboard_report();
  72. }
  73. register_code(action.key.code);
  74. } else {
  75. unregister_code(action.key.code);
  76. if (mods) {
  77. del_weak_mods(mods);
  78. send_keyboard_report();
  79. }
  80. }
  81. }
  82. break;
  83. #ifndef NO_ACTION_TAPPING
  84. case ACT_LMODS_TAP:
  85. case ACT_RMODS_TAP:
  86. {
  87. uint8_t mods = (action.kind.id == ACT_LMODS_TAP) ? action.key.mods :
  88. action.key.mods<<4;
  89. switch (action.layer_tap.code) {
  90. #ifndef NO_ACTION_ONESHOT
  91. case MODS_ONESHOT:
  92. // Oneshot modifier
  93. if (event.pressed) {
  94. if (tap_count == 0) {
  95. register_mods(mods);
  96. }
  97. else if (tap_count == 1) {
  98. dprint("MODS_TAP: Oneshot: start\n");
  99. set_oneshot_mods(mods);
  100. }
  101. else {
  102. register_mods(mods);
  103. }
  104. } else {
  105. if (tap_count == 0) {
  106. clear_oneshot_mods();
  107. unregister_mods(mods);
  108. }
  109. else if (tap_count == 1) {
  110. // Retain Oneshot mods
  111. }
  112. else {
  113. clear_oneshot_mods();
  114. unregister_mods(mods);
  115. }
  116. }
  117. break;
  118. #endif
  119. default:
  120. if (event.pressed) {
  121. if (tap_count > 0) {
  122. if (record->tap.interrupted) {
  123. dprint("MODS_TAP: Tap: Cancel: add_mods\n");
  124. // ad hoc: set 0 to cancel tap
  125. record->tap.count = 0;
  126. register_mods(mods);
  127. } else {
  128. dprint("MODS_TAP: Tap: register_code\n");
  129. register_code(action.key.code);
  130. }
  131. } else {
  132. dprint("MODS_TAP: No tap: add_mods\n");
  133. register_mods(mods);
  134. }
  135. } else {
  136. if (tap_count > 0) {
  137. dprint("MODS_TAP: Tap: unregister_code\n");
  138. unregister_code(action.key.code);
  139. } else {
  140. dprint("MODS_TAP: No tap: add_mods\n");
  141. unregister_mods(mods);
  142. }
  143. }
  144. break;
  145. }
  146. }
  147. break;
  148. #endif
  149. #ifdef EXTRAKEY_ENABLE
  150. /* other HID usage */
  151. case ACT_USAGE:
  152. switch (action.usage.page) {
  153. case PAGE_SYSTEM:
  154. if (event.pressed) {
  155. host_system_send(action.usage.code);
  156. } else {
  157. host_system_send(0);
  158. }
  159. break;
  160. case PAGE_CONSUMER:
  161. if (event.pressed) {
  162. host_consumer_send(action.usage.code);
  163. } else {
  164. host_consumer_send(0);
  165. }
  166. break;
  167. }
  168. break;
  169. #endif
  170. #ifdef MOUSEKEY_ENABLE
  171. /* Mouse key */
  172. case ACT_MOUSEKEY:
  173. if (event.pressed) {
  174. mousekey_on(action.key.code);
  175. mousekey_send();
  176. } else {
  177. mousekey_off(action.key.code);
  178. mousekey_send();
  179. }
  180. break;
  181. #endif
  182. #ifndef NO_ACTION_LAYER
  183. case ACT_LAYER:
  184. if (action.layer_bitop.on == 0) {
  185. /* Default Layer Bitwise Operation */
  186. if (!event.pressed) {
  187. uint8_t shift = action.layer_bitop.part*4;
  188. uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
  189. uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
  190. switch (action.layer_bitop.op) {
  191. case OP_BIT_AND: default_layer_and(bits | mask); break;
  192. case OP_BIT_OR: default_layer_or(bits | mask); break;
  193. case OP_BIT_XOR: default_layer_xor(bits | mask); break;
  194. case OP_BIT_SET: default_layer_and(mask); default_layer_or(bits); break;
  195. }
  196. }
  197. } else {
  198. /* Layer Bitwise Operation */
  199. if (event.pressed ? (action.layer_bitop.on & ON_PRESS) :
  200. (action.layer_bitop.on & ON_RELEASE)) {
  201. uint8_t shift = action.layer_bitop.part*4;
  202. uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
  203. uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
  204. switch (action.layer_bitop.op) {
  205. case OP_BIT_AND: layer_and(bits | mask); break;
  206. case OP_BIT_OR: layer_or(bits | mask); break;
  207. case OP_BIT_XOR: layer_xor(bits | mask); break;
  208. case OP_BIT_SET: layer_and(mask); layer_or(bits); break;
  209. }
  210. }
  211. }
  212. break;
  213. #ifndef NO_ACTION_TAPPING
  214. case ACT_LAYER_TAP:
  215. case ACT_LAYER_TAP_EXT:
  216. switch (action.layer_tap.code) {
  217. case OP_TAP_TOGGLE:
  218. /* tap toggle */
  219. if (event.pressed) {
  220. if (tap_count < TAPPING_TOGGLE) {
  221. layer_invert(action.layer_tap.val);
  222. }
  223. } else {
  224. if (tap_count <= TAPPING_TOGGLE) {
  225. layer_invert(action.layer_tap.val);
  226. }
  227. }
  228. break;
  229. case OP_ON_OFF:
  230. event.pressed ? layer_on(action.layer_tap.val) :
  231. layer_off(action.layer_tap.val);
  232. break;
  233. case OP_OFF_ON:
  234. event.pressed ? layer_off(action.layer_tap.val) :
  235. layer_on(action.layer_tap.val);
  236. break;
  237. case OP_SET_CLEAR:
  238. event.pressed ? layer_move(action.layer_tap.val) :
  239. layer_clear();
  240. break;
  241. default:
  242. /* tap key */
  243. if (event.pressed) {
  244. if (tap_count > 0) {
  245. dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
  246. register_code(action.layer_tap.code);
  247. } else {
  248. dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
  249. layer_on(action.layer_tap.val);
  250. }
  251. } else {
  252. if (tap_count > 0) {
  253. dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
  254. unregister_code(action.layer_tap.code);
  255. } else {
  256. dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
  257. layer_off(action.layer_tap.val);
  258. }
  259. }
  260. break;
  261. }
  262. break;
  263. #endif
  264. #endif
  265. /* Extentions */
  266. #ifndef NO_ACTION_MACRO
  267. case ACT_MACRO:
  268. action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
  269. break;
  270. #endif
  271. #ifdef BACKLIGHT_ENABLE
  272. case ACT_BACKLIGHT:
  273. if (!event.pressed) {
  274. switch (action.backlight.id) {
  275. case BACKLIGHT_INCREASE:
  276. backlight_increase();
  277. break;
  278. case BACKLIGHT_DECREASE:
  279. backlight_decrease();
  280. break;
  281. case BACKLIGHT_TOGGLE:
  282. backlight_toggle();
  283. break;
  284. case BACKLIGHT_STEP:
  285. backlight_step();
  286. break;
  287. }
  288. }
  289. break;
  290. #endif
  291. case ACT_COMMAND:
  292. break;
  293. #ifndef NO_ACTION_FUNCTION
  294. case ACT_FUNCTION:
  295. action_function(record, action.func.id, action.func.opt);
  296. break;
  297. #endif
  298. default:
  299. break;
  300. }
  301. }
  302. /*
  303. * Utilities for actions.
  304. */
  305. void register_code(uint8_t code)
  306. {
  307. if (code == KC_NO) {
  308. return;
  309. }
  310. #ifdef LOCKING_SUPPORT_ENABLE
  311. else if (KC_LOCKING_CAPS == code) {
  312. #ifdef LOCKING_RESYNC_ENABLE
  313. // Resync: ignore if caps lock already is on
  314. if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
  315. #endif
  316. add_key(KC_CAPSLOCK);
  317. send_keyboard_report();
  318. del_key(KC_CAPSLOCK);
  319. send_keyboard_report();
  320. }
  321. else if (KC_LOCKING_NUM == code) {
  322. #ifdef LOCKING_RESYNC_ENABLE
  323. if (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) return;
  324. #endif
  325. add_key(KC_NUMLOCK);
  326. send_keyboard_report();
  327. del_key(KC_NUMLOCK);
  328. send_keyboard_report();
  329. }
  330. else if (KC_LOCKING_SCROLL == code) {
  331. #ifdef LOCKING_RESYNC_ENABLE
  332. if (host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK)) return;
  333. #endif
  334. add_key(KC_SCROLLLOCK);
  335. send_keyboard_report();
  336. del_key(KC_SCROLLLOCK);
  337. send_keyboard_report();
  338. }
  339. #endif
  340. else if IS_KEY(code) {
  341. // TODO: should push command_proc out of this block?
  342. if (command_proc(code)) return;
  343. #ifndef NO_ACTION_ONESHOT
  344. /* TODO: remove
  345. if (oneshot_state.mods && !oneshot_state.disabled) {
  346. uint8_t tmp_mods = get_mods();
  347. add_mods(oneshot_state.mods);
  348. add_key(code);
  349. send_keyboard_report();
  350. set_mods(tmp_mods);
  351. send_keyboard_report();
  352. oneshot_cancel();
  353. } else
  354. */
  355. #endif
  356. {
  357. add_key(code);
  358. send_keyboard_report();
  359. }
  360. }
  361. else if IS_MOD(code) {
  362. add_mods(MOD_BIT(code));
  363. send_keyboard_report();
  364. }
  365. else if IS_SYSTEM(code) {
  366. host_system_send(KEYCODE2SYSTEM(code));
  367. }
  368. else if IS_CONSUMER(code) {
  369. host_consumer_send(KEYCODE2CONSUMER(code));
  370. }
  371. }
  372. void unregister_code(uint8_t code)
  373. {
  374. if (code == KC_NO) {
  375. return;
  376. }
  377. #ifdef LOCKING_SUPPORT_ENABLE
  378. else if (KC_LOCKING_CAPS == code) {
  379. #ifdef LOCKING_RESYNC_ENABLE
  380. // Resync: ignore if caps lock already is off
  381. if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
  382. #endif
  383. add_key(KC_CAPSLOCK);
  384. send_keyboard_report();
  385. del_key(KC_CAPSLOCK);
  386. send_keyboard_report();
  387. }
  388. else if (KC_LOCKING_NUM == code) {
  389. #ifdef LOCKING_RESYNC_ENABLE
  390. if (!(host_keyboard_leds() & (1<<USB_LED_NUM_LOCK))) return;
  391. #endif
  392. add_key(KC_NUMLOCK);
  393. send_keyboard_report();
  394. del_key(KC_NUMLOCK);
  395. send_keyboard_report();
  396. }
  397. else if (KC_LOCKING_SCROLL == code) {
  398. #ifdef LOCKING_RESYNC_ENABLE
  399. if (!(host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK))) return;
  400. #endif
  401. add_key(KC_SCROLLLOCK);
  402. send_keyboard_report();
  403. del_key(KC_SCROLLLOCK);
  404. send_keyboard_report();
  405. }
  406. #endif
  407. else if IS_KEY(code) {
  408. del_key(code);
  409. send_keyboard_report();
  410. }
  411. else if IS_MOD(code) {
  412. del_mods(MOD_BIT(code));
  413. send_keyboard_report();
  414. }
  415. else if IS_SYSTEM(code) {
  416. host_system_send(0);
  417. }
  418. else if IS_CONSUMER(code) {
  419. host_consumer_send(0);
  420. }
  421. }
  422. void register_mods(uint8_t mods)
  423. {
  424. if (mods) {
  425. add_mods(mods);
  426. send_keyboard_report();
  427. }
  428. }
  429. void unregister_mods(uint8_t mods)
  430. {
  431. if (mods) {
  432. del_mods(mods);
  433. send_keyboard_report();
  434. }
  435. }
  436. void clear_keyboard(void)
  437. {
  438. clear_mods();
  439. clear_keyboard_but_mods();
  440. }
  441. void clear_keyboard_but_mods(void)
  442. {
  443. clear_weak_mods();
  444. clear_keys();
  445. send_keyboard_report();
  446. #ifdef MOUSEKEY_ENABLE
  447. mousekey_clear();
  448. mousekey_send();
  449. #endif
  450. #ifdef EXTRAKEY_ENABLE
  451. host_system_send(0);
  452. host_consumer_send(0);
  453. #endif
  454. }
  455. bool is_tap_key(key_t key)
  456. {
  457. action_t action = layer_switch_get_action(key);
  458. switch (action.kind.id) {
  459. case ACT_LMODS_TAP:
  460. case ACT_RMODS_TAP:
  461. case ACT_LAYER_TAP:
  462. case ACT_LAYER_TAP_EXT:
  463. return true;
  464. case ACT_MACRO:
  465. case ACT_FUNCTION:
  466. if (action.func.opt & FUNC_TAP) { return true; }
  467. return false;
  468. }
  469. return false;
  470. }
  471. /*
  472. * debug print
  473. */
  474. void debug_event(keyevent_t event)
  475. {
  476. dprintf("%04X%c(%u)", (event.key.row<<8 | event.key.col), (event.pressed ? 'd' : 'u'), event.time);
  477. }
  478. void debug_record(keyrecord_t record)
  479. {
  480. debug_event(record.event);
  481. #ifndef NO_ACTION_TAPPING
  482. dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
  483. #endif
  484. }
  485. void debug_action(action_t action)
  486. {
  487. switch (action.kind.id) {
  488. case ACT_LMODS: dprint("ACT_LMODS"); break;
  489. case ACT_RMODS: dprint("ACT_RMODS"); break;
  490. case ACT_LMODS_TAP: dprint("ACT_LMODS_TAP"); break;
  491. case ACT_RMODS_TAP: dprint("ACT_RMODS_TAP"); break;
  492. case ACT_USAGE: dprint("ACT_USAGE"); break;
  493. case ACT_MOUSEKEY: dprint("ACT_MOUSEKEY"); break;
  494. case ACT_LAYER: dprint("ACT_LAYER"); break;
  495. case ACT_LAYER_TAP: dprint("ACT_LAYER_TAP"); break;
  496. case ACT_LAYER_TAP_EXT: dprint("ACT_LAYER_TAP_EXT"); break;
  497. case ACT_MACRO: dprint("ACT_MACRO"); break;
  498. case ACT_COMMAND: dprint("ACT_COMMAND"); break;
  499. case ACT_FUNCTION: dprint("ACT_FUNCTION"); break;
  500. default: dprint("UNKNOWN"); break;
  501. }
  502. dprintf("[%X:%02X]", action.kind.param>>8, action.kind.param&0xff);
  503. }