Keyboard firmwares for Atmel AVR and Cortex-M
選択できるのは25トピックまでです。 トピックは、先頭が英数字で、英数字とダッシュ('-')を使用した35文字以内のものにしてください。

action.c 16KB

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