keyboard.c 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501
  1. /*
  2. Copyright 2011, 2012, 2013 Jun Wako <wakojun@gmail.com>
  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 "keyboard.h"
  16. #include "matrix.h"
  17. #include "keymap.h"
  18. #include "host.h"
  19. #include "led.h"
  20. #include "keycode.h"
  21. #include "timer.h"
  22. #include "sync_timer.h"
  23. #include "print.h"
  24. #include "debug.h"
  25. #include "command.h"
  26. #include "util.h"
  27. #include "sendchar.h"
  28. #include "eeconfig.h"
  29. #include "action_layer.h"
  30. #ifdef BACKLIGHT_ENABLE
  31. # include "backlight.h"
  32. #endif
  33. #ifdef BOOTMAGIC_ENABLE
  34. # include "bootmagic.h"
  35. #else
  36. # include "magic.h"
  37. #endif
  38. #ifdef MOUSEKEY_ENABLE
  39. # include "mousekey.h"
  40. #endif
  41. #ifdef PS2_MOUSE_ENABLE
  42. # include "ps2_mouse.h"
  43. #endif
  44. #ifdef SERIAL_MOUSE_ENABLE
  45. # include "serial_mouse.h"
  46. #endif
  47. #ifdef ADB_MOUSE_ENABLE
  48. # include "adb.h"
  49. #endif
  50. #ifdef RGBLIGHT_ENABLE
  51. # include "rgblight.h"
  52. #endif
  53. #ifdef ENCODER_ENABLE
  54. # include "encoder.h"
  55. #endif
  56. #ifdef STENO_ENABLE
  57. # include "process_steno.h"
  58. #endif
  59. #ifdef FAUXCLICKY_ENABLE
  60. # include "fauxclicky.h"
  61. #endif
  62. #ifdef SERIAL_LINK_ENABLE
  63. # include "serial_link/system/serial_link.h"
  64. #endif
  65. #ifdef VISUALIZER_ENABLE
  66. # include "visualizer/visualizer.h"
  67. #endif
  68. #ifdef POINTING_DEVICE_ENABLE
  69. # include "pointing_device.h"
  70. #endif
  71. #ifdef MIDI_ENABLE
  72. # include "process_midi.h"
  73. #endif
  74. #ifdef JOYSTICK_ENABLE
  75. # include "process_joystick.h"
  76. #endif
  77. #ifdef HD44780_ENABLE
  78. # include "hd44780.h"
  79. #endif
  80. #ifdef QWIIC_ENABLE
  81. # include "qwiic.h"
  82. #endif
  83. #ifdef OLED_DRIVER_ENABLE
  84. # include "oled_driver.h"
  85. #endif
  86. #ifdef VELOCIKEY_ENABLE
  87. # include "velocikey.h"
  88. #endif
  89. #ifdef VIA_ENABLE
  90. # include "via.h"
  91. #endif
  92. #ifdef DIP_SWITCH_ENABLE
  93. # include "dip_switch.h"
  94. #endif
  95. static uint32_t last_input_modification_time = 0;
  96. uint32_t last_input_activity_time(void) { return last_input_modification_time; }
  97. uint32_t last_input_activity_elapsed(void) { return timer_elapsed32(last_input_modification_time); }
  98. static uint32_t last_matrix_modification_time = 0;
  99. uint32_t last_matrix_activity_time(void) { return last_matrix_modification_time; }
  100. uint32_t last_matrix_activity_elapsed(void) { return timer_elapsed32(last_matrix_modification_time); }
  101. void last_matrix_activity_trigger(void) { last_matrix_modification_time = last_input_modification_time = timer_read32(); }
  102. static uint32_t last_encoder_modification_time = 0;
  103. uint32_t last_encoder_activity_time(void) { return last_encoder_modification_time; }
  104. uint32_t last_encoder_activity_elapsed(void) { return timer_elapsed32(last_encoder_modification_time); }
  105. void last_encoder_activity_trigger(void) { last_encoder_modification_time = last_input_modification_time = timer_read32(); }
  106. // Only enable this if console is enabled to print to
  107. #if defined(DEBUG_MATRIX_SCAN_RATE)
  108. static uint32_t matrix_timer = 0;
  109. static uint32_t matrix_scan_count = 0;
  110. static uint32_t last_matrix_scan_count = 0;
  111. void matrix_scan_perf_task(void) {
  112. matrix_scan_count++;
  113. uint32_t timer_now = timer_read32();
  114. if (TIMER_DIFF_32(timer_now, matrix_timer) > 1000) {
  115. # if defined(CONSOLE_ENABLE)
  116. dprintf("matrix scan frequency: %lu\n", matrix_scan_count);
  117. # endif
  118. last_matrix_scan_count = matrix_scan_count;
  119. matrix_timer = timer_now;
  120. matrix_scan_count = 0;
  121. }
  122. }
  123. uint32_t get_matrix_scan_rate(void) { return last_matrix_scan_count; }
  124. #else
  125. # define matrix_scan_perf_task()
  126. #endif
  127. #ifdef MATRIX_HAS_GHOST
  128. extern const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
  129. static matrix_row_t get_real_keys(uint8_t row, matrix_row_t rowdata) {
  130. matrix_row_t out = 0;
  131. for (uint8_t col = 0; col < MATRIX_COLS; col++) {
  132. // read each key in the row data and check if the keymap defines it as a real key
  133. if (pgm_read_byte(&keymaps[0][row][col]) && (rowdata & (1 << col))) {
  134. // this creates new row data, if a key is defined in the keymap, it will be set here
  135. out |= 1 << col;
  136. }
  137. }
  138. return out;
  139. }
  140. static inline bool popcount_more_than_one(matrix_row_t rowdata) {
  141. rowdata &= rowdata - 1; // if there are less than two bits (keys) set, rowdata will become zero
  142. return rowdata;
  143. }
  144. static inline bool has_ghost_in_row(uint8_t row, matrix_row_t rowdata) {
  145. /* No ghost exists when less than 2 keys are down on the row.
  146. If there are "active" blanks in the matrix, the key can't be pressed by the user,
  147. there is no doubt as to which keys are really being pressed.
  148. The ghosts will be ignored, they are KC_NO. */
  149. rowdata = get_real_keys(row, rowdata);
  150. if ((popcount_more_than_one(rowdata)) == 0) {
  151. return false;
  152. }
  153. /* Ghost occurs when the row shares a column line with other row,
  154. and two columns are read on each row. Blanks in the matrix don't matter,
  155. so they are filtered out.
  156. If there are two or more real keys pressed and they match columns with
  157. at least two of another row's real keys, the row will be ignored. Keep in mind,
  158. we are checking one row at a time, not all of them at once.
  159. */
  160. for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
  161. if (i != row && popcount_more_than_one(get_real_keys(i, matrix_get_row(i)) & rowdata)) {
  162. return true;
  163. }
  164. }
  165. return false;
  166. }
  167. #endif
  168. void disable_jtag(void) {
  169. // To use PF4-7 (PC2-5 on ATmega32A), disable JTAG by writing JTD bit twice within four cycles.
  170. #if (defined(__AVR_AT90USB646__) || defined(__AVR_AT90USB647__) || defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega16U4__) || defined(__AVR_ATmega32U4__))
  171. MCUCR |= _BV(JTD);
  172. MCUCR |= _BV(JTD);
  173. #elif defined(__AVR_ATmega32A__)
  174. MCUCSR |= _BV(JTD);
  175. MCUCSR |= _BV(JTD);
  176. #endif
  177. }
  178. /** \brief matrix_setup
  179. *
  180. * FIXME: needs doc
  181. */
  182. __attribute__((weak)) void matrix_setup(void) {}
  183. /** \brief keyboard_pre_init_user
  184. *
  185. * FIXME: needs doc
  186. */
  187. __attribute__((weak)) void keyboard_pre_init_user(void) {}
  188. /** \brief keyboard_pre_init_kb
  189. *
  190. * FIXME: needs doc
  191. */
  192. __attribute__((weak)) void keyboard_pre_init_kb(void) { keyboard_pre_init_user(); }
  193. /** \brief keyboard_post_init_user
  194. *
  195. * FIXME: needs doc
  196. */
  197. __attribute__((weak)) void keyboard_post_init_user() {}
  198. /** \brief keyboard_post_init_kb
  199. *
  200. * FIXME: needs doc
  201. */
  202. __attribute__((weak)) void keyboard_post_init_kb(void) { keyboard_post_init_user(); }
  203. /** \brief keyboard_setup
  204. *
  205. * FIXME: needs doc
  206. */
  207. void keyboard_setup(void) {
  208. #ifndef NO_JTAG_DISABLE
  209. disable_jtag();
  210. #endif
  211. matrix_setup();
  212. keyboard_pre_init_kb();
  213. }
  214. /** \brief is_keyboard_master
  215. *
  216. * FIXME: needs doc
  217. */
  218. __attribute__((weak)) bool is_keyboard_master(void) { return true; }
  219. /** \brief is_keyboard_left
  220. *
  221. * FIXME: needs doc
  222. */
  223. __attribute__((weak)) bool is_keyboard_left(void) { return true; }
  224. /** \brief should_process_keypress
  225. *
  226. * Override this function if you have a condition where keypresses processing should change:
  227. * - splits where the slave side needs to process for rgb/oled functionality
  228. */
  229. __attribute__((weak)) bool should_process_keypress(void) { return is_keyboard_master(); }
  230. /** \brief housekeeping_task_kb
  231. *
  232. * Override this function if you have a need to execute code for every keyboard main loop iteration.
  233. * This is specific to keyboard-level functionality.
  234. */
  235. __attribute__((weak)) void housekeeping_task_kb(void) {}
  236. /** \brief housekeeping_task_user
  237. *
  238. * Override this function if you have a need to execute code for every keyboard main loop iteration.
  239. * This is specific to user/keymap-level functionality.
  240. */
  241. __attribute__((weak)) void housekeeping_task_user(void) {}
  242. /** \brief keyboard_init
  243. *
  244. * FIXME: needs doc
  245. */
  246. void keyboard_init(void) {
  247. timer_init();
  248. sync_timer_init();
  249. matrix_init();
  250. #ifdef VIA_ENABLE
  251. via_init();
  252. #endif
  253. #ifdef QWIIC_ENABLE
  254. qwiic_init();
  255. #endif
  256. #ifdef OLED_DRIVER_ENABLE
  257. oled_init(OLED_ROTATION_0);
  258. #endif
  259. #ifdef PS2_MOUSE_ENABLE
  260. ps2_mouse_init();
  261. #endif
  262. #ifdef SERIAL_MOUSE_ENABLE
  263. serial_mouse_init();
  264. #endif
  265. #ifdef ADB_MOUSE_ENABLE
  266. adb_mouse_init();
  267. #endif
  268. #ifdef BOOTMAGIC_ENABLE
  269. bootmagic();
  270. #else
  271. magic();
  272. #endif
  273. #ifdef BACKLIGHT_ENABLE
  274. backlight_init();
  275. #endif
  276. #ifdef RGBLIGHT_ENABLE
  277. rgblight_init();
  278. #endif
  279. #ifdef ENCODER_ENABLE
  280. encoder_init();
  281. #endif
  282. #ifdef STENO_ENABLE
  283. steno_init();
  284. #endif
  285. #ifdef FAUXCLICKY_ENABLE
  286. fauxclicky_init();
  287. #endif
  288. #ifdef POINTING_DEVICE_ENABLE
  289. pointing_device_init();
  290. #endif
  291. #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
  292. keymap_config.nkro = 1;
  293. eeconfig_update_keymap(keymap_config.raw);
  294. #endif
  295. #ifdef DIP_SWITCH_ENABLE
  296. dip_switch_init();
  297. #endif
  298. #if defined(DEBUG_MATRIX_SCAN_RATE) && defined(CONSOLE_ENABLE)
  299. debug_enable = true;
  300. #endif
  301. keyboard_post_init_kb(); /* Always keep this last */
  302. }
  303. /** \brief Keyboard task: Do keyboard routine jobs
  304. *
  305. * Do routine keyboard jobs:
  306. *
  307. * * scan matrix
  308. * * handle mouse movements
  309. * * run visualizer code
  310. * * handle midi commands
  311. * * light LEDs
  312. *
  313. * This is repeatedly called as fast as possible.
  314. */
  315. void keyboard_task(void) {
  316. static matrix_row_t matrix_prev[MATRIX_ROWS];
  317. static uint8_t led_status = 0;
  318. matrix_row_t matrix_row = 0;
  319. matrix_row_t matrix_change = 0;
  320. #ifdef QMK_KEYS_PER_SCAN
  321. uint8_t keys_processed = 0;
  322. #endif
  323. #ifdef ENCODER_ENABLE
  324. bool encoders_changed = false;
  325. #endif
  326. housekeeping_task_kb();
  327. housekeeping_task_user();
  328. uint8_t matrix_changed = matrix_scan();
  329. if (matrix_changed) last_matrix_activity_trigger();
  330. if (should_process_keypress()) {
  331. for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
  332. matrix_row = matrix_get_row(r);
  333. matrix_change = matrix_row ^ matrix_prev[r];
  334. if (matrix_change) {
  335. #ifdef MATRIX_HAS_GHOST
  336. if (has_ghost_in_row(r, matrix_row)) {
  337. continue;
  338. }
  339. #endif
  340. if (debug_matrix) matrix_print();
  341. matrix_row_t col_mask = 1;
  342. for (uint8_t c = 0; c < MATRIX_COLS; c++, col_mask <<= 1) {
  343. if (matrix_change & col_mask) {
  344. action_exec((keyevent_t){
  345. .key = (keypos_t){.row = r, .col = c}, .pressed = (matrix_row & col_mask), .time = (timer_read() | 1) /* time should not be 0 */
  346. });
  347. // record a processed key
  348. matrix_prev[r] ^= col_mask;
  349. #ifdef QMK_KEYS_PER_SCAN
  350. // only jump out if we have processed "enough" keys.
  351. if (++keys_processed >= QMK_KEYS_PER_SCAN)
  352. #endif
  353. // process a key per task call
  354. goto MATRIX_LOOP_END;
  355. }
  356. }
  357. }
  358. }
  359. }
  360. // call with pseudo tick event when no real key event.
  361. #ifdef QMK_KEYS_PER_SCAN
  362. // we can get here with some keys processed now.
  363. if (!keys_processed)
  364. #endif
  365. action_exec(TICK);
  366. MATRIX_LOOP_END:
  367. #ifdef DEBUG_MATRIX_SCAN_RATE
  368. matrix_scan_perf_task();
  369. #endif
  370. #if defined(RGBLIGHT_ENABLE)
  371. rgblight_task();
  372. #endif
  373. #if defined(BACKLIGHT_ENABLE)
  374. # if defined(BACKLIGHT_PIN) || defined(BACKLIGHT_PINS)
  375. backlight_task();
  376. # endif
  377. #endif
  378. #ifdef ENCODER_ENABLE
  379. encoders_changed = encoder_read();
  380. if (encoders_changed) last_encoder_activity_trigger();
  381. #endif
  382. #ifdef QWIIC_ENABLE
  383. qwiic_task();
  384. #endif
  385. #ifdef OLED_DRIVER_ENABLE
  386. oled_task();
  387. # ifndef OLED_DISABLE_TIMEOUT
  388. // Wake up oled if user is using those fabulous keys or spinning those encoders!
  389. # ifdef ENCODER_ENABLE
  390. if (matrix_changed || encoders_changed) oled_on();
  391. # else
  392. if (matrix_changed) oled_on();
  393. # endif
  394. # endif
  395. #endif
  396. #ifdef MOUSEKEY_ENABLE
  397. // mousekey repeat & acceleration
  398. mousekey_task();
  399. #endif
  400. #ifdef PS2_MOUSE_ENABLE
  401. ps2_mouse_task();
  402. #endif
  403. #ifdef SERIAL_MOUSE_ENABLE
  404. serial_mouse_task();
  405. #endif
  406. #ifdef ADB_MOUSE_ENABLE
  407. adb_mouse_task();
  408. #endif
  409. #ifdef SERIAL_LINK_ENABLE
  410. serial_link_update();
  411. #endif
  412. #ifdef VISUALIZER_ENABLE
  413. visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
  414. #endif
  415. #ifdef POINTING_DEVICE_ENABLE
  416. pointing_device_task();
  417. #endif
  418. #ifdef MIDI_ENABLE
  419. midi_task();
  420. #endif
  421. #ifdef VELOCIKEY_ENABLE
  422. if (velocikey_enabled()) {
  423. velocikey_decelerate();
  424. }
  425. #endif
  426. #ifdef JOYSTICK_ENABLE
  427. joystick_task();
  428. #endif
  429. // update LED
  430. if (led_status != host_keyboard_leds()) {
  431. led_status = host_keyboard_leds();
  432. keyboard_set_leds(led_status);
  433. }
  434. }
  435. /** \brief keyboard set leds
  436. *
  437. * FIXME: needs doc
  438. */
  439. void keyboard_set_leds(uint8_t leds) {
  440. if (debug_keyboard) {
  441. debug("keyboard_set_led: ");
  442. debug_hex8(leds);
  443. debug("\n");
  444. }
  445. led_set(leds);
  446. }