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

11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
11 years ago
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565
  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. case MODS_TAP_TOGGLE:
  120. if (event.pressed) {
  121. if (tap_count <= TAPPING_TOGGLE) {
  122. register_mods(mods);
  123. }
  124. } else {
  125. if (tap_count < TAPPING_TOGGLE) {
  126. unregister_mods(mods);
  127. }
  128. }
  129. break;
  130. default:
  131. if (event.pressed) {
  132. if (tap_count > 0) {
  133. if (record->tap.interrupted) {
  134. dprint("MODS_TAP: Tap: Cancel: add_mods\n");
  135. // ad hoc: set 0 to cancel tap
  136. record->tap.count = 0;
  137. register_mods(mods);
  138. } else {
  139. dprint("MODS_TAP: Tap: register_code\n");
  140. register_code(action.key.code);
  141. }
  142. } else {
  143. dprint("MODS_TAP: No tap: add_mods\n");
  144. register_mods(mods);
  145. }
  146. } else {
  147. if (tap_count > 0) {
  148. dprint("MODS_TAP: Tap: unregister_code\n");
  149. unregister_code(action.key.code);
  150. } else {
  151. dprint("MODS_TAP: No tap: add_mods\n");
  152. unregister_mods(mods);
  153. }
  154. }
  155. break;
  156. }
  157. }
  158. break;
  159. #endif
  160. #ifdef EXTRAKEY_ENABLE
  161. /* other HID usage */
  162. case ACT_USAGE:
  163. switch (action.usage.page) {
  164. case PAGE_SYSTEM:
  165. if (event.pressed) {
  166. host_system_send(action.usage.code);
  167. } else {
  168. host_system_send(0);
  169. }
  170. break;
  171. case PAGE_CONSUMER:
  172. if (event.pressed) {
  173. host_consumer_send(action.usage.code);
  174. } else {
  175. host_consumer_send(0);
  176. }
  177. break;
  178. }
  179. break;
  180. #endif
  181. #ifdef MOUSEKEY_ENABLE
  182. /* Mouse key */
  183. case ACT_MOUSEKEY:
  184. if (event.pressed) {
  185. mousekey_on(action.key.code);
  186. mousekey_send();
  187. } else {
  188. mousekey_off(action.key.code);
  189. mousekey_send();
  190. }
  191. break;
  192. #endif
  193. #ifndef NO_ACTION_LAYER
  194. case ACT_LAYER:
  195. if (action.layer_bitop.on == 0) {
  196. /* Default Layer Bitwise Operation */
  197. if (!event.pressed) {
  198. uint8_t shift = action.layer_bitop.part*4;
  199. uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
  200. uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
  201. switch (action.layer_bitop.op) {
  202. case OP_BIT_AND: default_layer_and(bits | mask); break;
  203. case OP_BIT_OR: default_layer_or(bits | mask); break;
  204. case OP_BIT_XOR: default_layer_xor(bits | mask); break;
  205. case OP_BIT_SET: default_layer_and(mask); default_layer_or(bits); break;
  206. }
  207. }
  208. } else {
  209. /* Layer Bitwise Operation */
  210. if (event.pressed ? (action.layer_bitop.on & ON_PRESS) :
  211. (action.layer_bitop.on & ON_RELEASE)) {
  212. uint8_t shift = action.layer_bitop.part*4;
  213. uint32_t bits = ((uint32_t)action.layer_bitop.bits)<<shift;
  214. uint32_t mask = (action.layer_bitop.xbit) ? ~(((uint32_t)0xf)<<shift) : 0;
  215. switch (action.layer_bitop.op) {
  216. case OP_BIT_AND: layer_and(bits | mask); break;
  217. case OP_BIT_OR: layer_or(bits | mask); break;
  218. case OP_BIT_XOR: layer_xor(bits | mask); break;
  219. case OP_BIT_SET: layer_and(mask); layer_or(bits); break;
  220. }
  221. }
  222. }
  223. break;
  224. #ifndef NO_ACTION_TAPPING
  225. case ACT_LAYER_TAP:
  226. case ACT_LAYER_TAP_EXT:
  227. switch (action.layer_tap.code) {
  228. case 0xe0 ... 0xef:
  229. /* layer On/Off with modifiers(left only) */
  230. if (event.pressed) {
  231. layer_on(action.layer_tap.val);
  232. register_mods(action.layer_tap.code & 0x0f);
  233. } else {
  234. layer_off(action.layer_tap.val);
  235. unregister_mods(action.layer_tap.code & 0x0f);
  236. }
  237. break;
  238. case OP_TAP_TOGGLE:
  239. /* tap toggle */
  240. if (event.pressed) {
  241. if (tap_count < TAPPING_TOGGLE) {
  242. layer_invert(action.layer_tap.val);
  243. }
  244. } else {
  245. if (tap_count <= TAPPING_TOGGLE) {
  246. layer_invert(action.layer_tap.val);
  247. }
  248. }
  249. break;
  250. case OP_ON_OFF:
  251. event.pressed ? layer_on(action.layer_tap.val) :
  252. layer_off(action.layer_tap.val);
  253. break;
  254. case OP_OFF_ON:
  255. event.pressed ? layer_off(action.layer_tap.val) :
  256. layer_on(action.layer_tap.val);
  257. break;
  258. case OP_SET_CLEAR:
  259. event.pressed ? layer_move(action.layer_tap.val) :
  260. layer_clear();
  261. break;
  262. default:
  263. /* tap key */
  264. if (event.pressed) {
  265. if (tap_count > 0) {
  266. dprint("KEYMAP_TAP_KEY: Tap: register_code\n");
  267. register_code(action.layer_tap.code);
  268. } else {
  269. dprint("KEYMAP_TAP_KEY: No tap: On on press\n");
  270. layer_on(action.layer_tap.val);
  271. }
  272. } else {
  273. if (tap_count > 0) {
  274. dprint("KEYMAP_TAP_KEY: Tap: unregister_code\n");
  275. unregister_code(action.layer_tap.code);
  276. } else {
  277. dprint("KEYMAP_TAP_KEY: No tap: Off on release\n");
  278. layer_off(action.layer_tap.val);
  279. }
  280. }
  281. break;
  282. }
  283. break;
  284. #endif
  285. #endif
  286. /* Extentions */
  287. #ifndef NO_ACTION_MACRO
  288. case ACT_MACRO:
  289. action_macro_play(action_get_macro(record, action.func.id, action.func.opt));
  290. break;
  291. #endif
  292. #ifdef BACKLIGHT_ENABLE
  293. case ACT_BACKLIGHT:
  294. if (!event.pressed) {
  295. switch (action.backlight.opt) {
  296. case BACKLIGHT_INCREASE:
  297. backlight_increase();
  298. break;
  299. case BACKLIGHT_DECREASE:
  300. backlight_decrease();
  301. break;
  302. case BACKLIGHT_TOGGLE:
  303. backlight_toggle();
  304. break;
  305. case BACKLIGHT_STEP:
  306. backlight_step();
  307. break;
  308. case BACKLIGHT_LEVEL:
  309. backlight_level(action.backlight.level);
  310. break;
  311. }
  312. }
  313. break;
  314. #endif
  315. case ACT_COMMAND:
  316. break;
  317. #ifndef NO_ACTION_FUNCTION
  318. case ACT_FUNCTION:
  319. action_function(record, action.func.id, action.func.opt);
  320. break;
  321. #endif
  322. default:
  323. break;
  324. }
  325. }
  326. /*
  327. * Utilities for actions.
  328. */
  329. void register_code(uint8_t code)
  330. {
  331. if (code == KC_NO) {
  332. return;
  333. }
  334. #ifdef LOCKING_SUPPORT_ENABLE
  335. else if (KC_LOCKING_CAPS == code) {
  336. #ifdef LOCKING_RESYNC_ENABLE
  337. // Resync: ignore if caps lock already is on
  338. if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) return;
  339. #endif
  340. add_key(KC_CAPSLOCK);
  341. send_keyboard_report();
  342. del_key(KC_CAPSLOCK);
  343. send_keyboard_report();
  344. }
  345. else if (KC_LOCKING_NUM == code) {
  346. #ifdef LOCKING_RESYNC_ENABLE
  347. if (host_keyboard_leds() & (1<<USB_LED_NUM_LOCK)) return;
  348. #endif
  349. add_key(KC_NUMLOCK);
  350. send_keyboard_report();
  351. del_key(KC_NUMLOCK);
  352. send_keyboard_report();
  353. }
  354. else if (KC_LOCKING_SCROLL == code) {
  355. #ifdef LOCKING_RESYNC_ENABLE
  356. if (host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK)) return;
  357. #endif
  358. add_key(KC_SCROLLLOCK);
  359. send_keyboard_report();
  360. del_key(KC_SCROLLLOCK);
  361. send_keyboard_report();
  362. }
  363. #endif
  364. else if IS_KEY(code) {
  365. // TODO: should push command_proc out of this block?
  366. if (command_proc(code)) return;
  367. #ifndef NO_ACTION_ONESHOT
  368. /* TODO: remove
  369. if (oneshot_state.mods && !oneshot_state.disabled) {
  370. uint8_t tmp_mods = get_mods();
  371. add_mods(oneshot_state.mods);
  372. add_key(code);
  373. send_keyboard_report();
  374. set_mods(tmp_mods);
  375. send_keyboard_report();
  376. oneshot_cancel();
  377. } else
  378. */
  379. #endif
  380. {
  381. add_key(code);
  382. send_keyboard_report();
  383. }
  384. }
  385. else if IS_MOD(code) {
  386. add_mods(MOD_BIT(code));
  387. send_keyboard_report();
  388. }
  389. else if IS_SYSTEM(code) {
  390. host_system_send(KEYCODE2SYSTEM(code));
  391. }
  392. else if IS_CONSUMER(code) {
  393. host_consumer_send(KEYCODE2CONSUMER(code));
  394. }
  395. }
  396. void unregister_code(uint8_t code)
  397. {
  398. if (code == KC_NO) {
  399. return;
  400. }
  401. #ifdef LOCKING_SUPPORT_ENABLE
  402. else if (KC_LOCKING_CAPS == code) {
  403. #ifdef LOCKING_RESYNC_ENABLE
  404. // Resync: ignore if caps lock already is off
  405. if (!(host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK))) return;
  406. #endif
  407. add_key(KC_CAPSLOCK);
  408. send_keyboard_report();
  409. del_key(KC_CAPSLOCK);
  410. send_keyboard_report();
  411. }
  412. else if (KC_LOCKING_NUM == code) {
  413. #ifdef LOCKING_RESYNC_ENABLE
  414. if (!(host_keyboard_leds() & (1<<USB_LED_NUM_LOCK))) return;
  415. #endif
  416. add_key(KC_NUMLOCK);
  417. send_keyboard_report();
  418. del_key(KC_NUMLOCK);
  419. send_keyboard_report();
  420. }
  421. else if (KC_LOCKING_SCROLL == code) {
  422. #ifdef LOCKING_RESYNC_ENABLE
  423. if (!(host_keyboard_leds() & (1<<USB_LED_SCROLL_LOCK))) return;
  424. #endif
  425. add_key(KC_SCROLLLOCK);
  426. send_keyboard_report();
  427. del_key(KC_SCROLLLOCK);
  428. send_keyboard_report();
  429. }
  430. #endif
  431. else if IS_KEY(code) {
  432. del_key(code);
  433. send_keyboard_report();
  434. }
  435. else if IS_MOD(code) {
  436. del_mods(MOD_BIT(code));
  437. send_keyboard_report();
  438. }
  439. else if IS_SYSTEM(code) {
  440. host_system_send(0);
  441. }
  442. else if IS_CONSUMER(code) {
  443. host_consumer_send(0);
  444. }
  445. }
  446. void register_mods(uint8_t mods)
  447. {
  448. if (mods) {
  449. add_mods(mods);
  450. send_keyboard_report();
  451. }
  452. }
  453. void unregister_mods(uint8_t mods)
  454. {
  455. if (mods) {
  456. del_mods(mods);
  457. send_keyboard_report();
  458. }
  459. }
  460. void clear_keyboard(void)
  461. {
  462. clear_mods();
  463. clear_keyboard_but_mods();
  464. }
  465. void clear_keyboard_but_mods(void)
  466. {
  467. clear_weak_mods();
  468. clear_keys();
  469. send_keyboard_report();
  470. #ifdef MOUSEKEY_ENABLE
  471. mousekey_clear();
  472. mousekey_send();
  473. #endif
  474. #ifdef EXTRAKEY_ENABLE
  475. host_system_send(0);
  476. host_consumer_send(0);
  477. #endif
  478. }
  479. bool is_tap_key(keypos_t key)
  480. {
  481. action_t action = layer_switch_get_action(key);
  482. switch (action.kind.id) {
  483. case ACT_LMODS_TAP:
  484. case ACT_RMODS_TAP:
  485. case ACT_LAYER_TAP:
  486. case ACT_LAYER_TAP_EXT:
  487. return true;
  488. case ACT_MACRO:
  489. case ACT_FUNCTION:
  490. if (action.func.opt & FUNC_TAP) { return true; }
  491. return false;
  492. }
  493. return false;
  494. }
  495. /*
  496. * debug print
  497. */
  498. void debug_event(keyevent_t event)
  499. {
  500. dprintf("%04X%c(%u)", (event.key.row<<8 | event.key.col), (event.pressed ? 'd' : 'u'), event.time);
  501. }
  502. void debug_record(keyrecord_t record)
  503. {
  504. debug_event(record.event);
  505. #ifndef NO_ACTION_TAPPING
  506. dprintf(":%u%c", record.tap.count, (record.tap.interrupted ? '-' : ' '));
  507. #endif
  508. }
  509. void debug_action(action_t action)
  510. {
  511. switch (action.kind.id) {
  512. case ACT_LMODS: dprint("ACT_LMODS"); break;
  513. case ACT_RMODS: dprint("ACT_RMODS"); break;
  514. case ACT_LMODS_TAP: dprint("ACT_LMODS_TAP"); break;
  515. case ACT_RMODS_TAP: dprint("ACT_RMODS_TAP"); break;
  516. case ACT_USAGE: dprint("ACT_USAGE"); break;
  517. case ACT_MOUSEKEY: dprint("ACT_MOUSEKEY"); break;
  518. case ACT_LAYER: dprint("ACT_LAYER"); break;
  519. case ACT_LAYER_TAP: dprint("ACT_LAYER_TAP"); break;
  520. case ACT_LAYER_TAP_EXT: dprint("ACT_LAYER_TAP_EXT"); break;
  521. case ACT_MACRO: dprint("ACT_MACRO"); break;
  522. case ACT_COMMAND: dprint("ACT_COMMAND"); break;
  523. case ACT_FUNCTION: dprint("ACT_FUNCTION"); break;
  524. default: dprint("UNKNOWN"); break;
  525. }
  526. dprintf("[%X:%02X]", action.kind.param>>8, action.kind.param&0xff);
  527. }