keyboard.c 12 KB

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