Peter's keyboard firmware (QMK) https://qmk.fm/
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.

keyboard.c 8.2KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317
  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 "print.h"
  23. #include "debug.h"
  24. #include "command.h"
  25. #include "util.h"
  26. #include "sendchar.h"
  27. #include "eeconfig.h"
  28. #include "backlight.h"
  29. #include "action_layer.h"
  30. #ifdef BOOTMAGIC_ENABLE
  31. # include "bootmagic.h"
  32. #else
  33. # include "magic.h"
  34. #endif
  35. #ifdef MOUSEKEY_ENABLE
  36. # include "mousekey.h"
  37. #endif
  38. #ifdef PS2_MOUSE_ENABLE
  39. # include "ps2_mouse.h"
  40. #endif
  41. #ifdef SERIAL_MOUSE_ENABLE
  42. # include "serial_mouse.h"
  43. #endif
  44. #ifdef ADB_MOUSE_ENABLE
  45. # include "adb.h"
  46. #endif
  47. #ifdef RGBLIGHT_ENABLE
  48. # include "rgblight.h"
  49. #endif
  50. #ifdef STENO_ENABLE
  51. # include "process_steno.h"
  52. #endif
  53. #ifdef FAUXCLICKY_ENABLE
  54. # include "fauxclicky.h"
  55. #endif
  56. #ifdef SERIAL_LINK_ENABLE
  57. # include "serial_link/system/serial_link.h"
  58. #endif
  59. #ifdef VISUALIZER_ENABLE
  60. # include "visualizer/visualizer.h"
  61. #endif
  62. #ifdef POINTING_DEVICE_ENABLE
  63. # include "pointing_device.h"
  64. #endif
  65. #ifdef MIDI_ENABLE
  66. # include "process_midi.h"
  67. #endif
  68. #ifdef HD44780_ENABLE
  69. # include "hd44780.h"
  70. #endif
  71. #ifdef MATRIX_HAS_GHOST
  72. extern const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
  73. static matrix_row_t get_real_keys(uint8_t row, matrix_row_t rowdata){
  74. matrix_row_t out = 0;
  75. for (uint8_t col = 0; col < MATRIX_COLS; col++) {
  76. //read each key in the row data and check if the keymap defines it as a real key
  77. if (pgm_read_byte(&keymaps[0][row][col]) && (rowdata & (1<<col))){
  78. //this creates new row data, if a key is defined in the keymap, it will be set here
  79. out |= 1<<col;
  80. }
  81. }
  82. return out;
  83. }
  84. static inline bool popcount_more_than_one(matrix_row_t rowdata)
  85. {
  86. rowdata &= rowdata-1; //if there are less than two bits (keys) set, rowdata will become zero
  87. return rowdata;
  88. }
  89. static inline bool has_ghost_in_row(uint8_t row, matrix_row_t rowdata)
  90. {
  91. /* No ghost exists when less than 2 keys are down on the row.
  92. If there are "active" blanks in the matrix, the key can't be pressed by the user,
  93. there is no doubt as to which keys are really being pressed.
  94. The ghosts will be ignored, they are KC_NO. */
  95. rowdata = get_real_keys(row, rowdata);
  96. if ((popcount_more_than_one(rowdata)) == 0){
  97. return false;
  98. }
  99. /* Ghost occurs when the row shares a column line with other row,
  100. and two columns are read on each row. Blanks in the matrix don't matter,
  101. so they are filtered out.
  102. If there are two or more real keys pressed and they match columns with
  103. at least two of another row's real keys, the row will be ignored. Keep in mind,
  104. we are checking one row at a time, not all of them at once.
  105. */
  106. for (uint8_t i=0; i < MATRIX_ROWS; i++) {
  107. if (i != row && popcount_more_than_one(get_real_keys(i, matrix_get_row(i)) & rowdata)){
  108. return true;
  109. }
  110. }
  111. return false;
  112. }
  113. #endif
  114. /** \brief matrix_setup
  115. *
  116. * FIXME: needs doc
  117. */
  118. __attribute__ ((weak))
  119. void matrix_setup(void) {
  120. }
  121. /** \brief keyboard_setup
  122. *
  123. * FIXME: needs doc
  124. */
  125. void keyboard_setup(void) {
  126. matrix_setup();
  127. }
  128. /** \brief is_keyboard_master
  129. *
  130. * FIXME: needs doc
  131. */
  132. __attribute__((weak))
  133. bool is_keyboard_master(void) {
  134. return true;
  135. }
  136. /** \brief keyboard_init
  137. *
  138. * FIXME: needs doc
  139. */
  140. void keyboard_init(void) {
  141. timer_init();
  142. // To use PORTF disable JTAG with writing JTD bit twice within four cycles.
  143. #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega32U4__))
  144. MCUCR |= _BV(JTD);
  145. MCUCR |= _BV(JTD);
  146. #endif
  147. matrix_init();
  148. #ifdef PS2_MOUSE_ENABLE
  149. ps2_mouse_init();
  150. #endif
  151. #ifdef SERIAL_MOUSE_ENABLE
  152. serial_mouse_init();
  153. #endif
  154. #ifdef ADB_MOUSE_ENABLE
  155. adb_mouse_init();
  156. #endif
  157. #ifdef BOOTMAGIC_ENABLE
  158. bootmagic();
  159. #else
  160. magic();
  161. #endif
  162. #ifdef BACKLIGHT_ENABLE
  163. backlight_init();
  164. #endif
  165. #ifdef RGBLIGHT_ENABLE
  166. rgblight_init();
  167. #endif
  168. #ifdef STENO_ENABLE
  169. steno_init();
  170. #endif
  171. #ifdef FAUXCLICKY_ENABLE
  172. fauxclicky_init();
  173. #endif
  174. #ifdef POINTING_DEVICE_ENABLE
  175. pointing_device_init();
  176. #endif
  177. #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
  178. keymap_config.nkro = 1;
  179. #endif
  180. }
  181. /** \brief Keyboard task: Do keyboard routine jobs
  182. *
  183. * Do routine keyboard jobs:
  184. *
  185. * * scan matrix
  186. * * handle mouse movements
  187. * * run visualizer code
  188. * * handle midi commands
  189. * * light LEDs
  190. *
  191. * This is repeatedly called as fast as possible.
  192. */
  193. void keyboard_task(void)
  194. {
  195. static matrix_row_t matrix_prev[MATRIX_ROWS];
  196. #ifdef MATRIX_HAS_GHOST
  197. // static matrix_row_t matrix_ghost[MATRIX_ROWS];
  198. #endif
  199. static uint8_t led_status = 0;
  200. matrix_row_t matrix_row = 0;
  201. matrix_row_t matrix_change = 0;
  202. #ifdef QMK_KEYS_PER_SCAN
  203. uint8_t keys_processed = 0;
  204. #endif
  205. matrix_scan();
  206. if (is_keyboard_master()) {
  207. for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
  208. matrix_row = matrix_get_row(r);
  209. matrix_change = matrix_row ^ matrix_prev[r];
  210. if (matrix_change) {
  211. #ifdef MATRIX_HAS_GHOST
  212. if (has_ghost_in_row(r, matrix_row)) {
  213. /* Keep track of whether ghosted status has changed for
  214. * debugging. But don't update matrix_prev until un-ghosted, or
  215. * the last key would be lost.
  216. */
  217. //if (debug_matrix && matrix_ghost[r] != matrix_row) {
  218. // matrix_print();
  219. //}
  220. //matrix_ghost[r] = matrix_row;
  221. continue;
  222. }
  223. //matrix_ghost[r] = matrix_row;
  224. #endif
  225. if (debug_matrix) matrix_print();
  226. for (uint8_t c = 0; c < MATRIX_COLS; c++) {
  227. if (matrix_change & ((matrix_row_t)1<<c)) {
  228. action_exec((keyevent_t){
  229. .key = (keypos_t){ .row = r, .col = c },
  230. .pressed = (matrix_row & ((matrix_row_t)1<<c)),
  231. .time = (timer_read() | 1) /* time should not be 0 */
  232. });
  233. // record a processed key
  234. matrix_prev[r] ^= ((matrix_row_t)1<<c);
  235. #ifdef QMK_KEYS_PER_SCAN
  236. // only jump out if we have processed "enough" keys.
  237. if (++keys_processed >= QMK_KEYS_PER_SCAN)
  238. #endif
  239. // process a key per task call
  240. goto MATRIX_LOOP_END;
  241. }
  242. }
  243. }
  244. }
  245. }
  246. // call with pseudo tick event when no real key event.
  247. #ifdef QMK_KEYS_PER_SCAN
  248. // we can get here with some keys processed now.
  249. if (!keys_processed)
  250. #endif
  251. action_exec(TICK);
  252. MATRIX_LOOP_END:
  253. #ifdef MOUSEKEY_ENABLE
  254. // mousekey repeat & acceleration
  255. mousekey_task();
  256. #endif
  257. #ifdef PS2_MOUSE_ENABLE
  258. ps2_mouse_task();
  259. #endif
  260. #ifdef SERIAL_MOUSE_ENABLE
  261. serial_mouse_task();
  262. #endif
  263. #ifdef ADB_MOUSE_ENABLE
  264. adb_mouse_task();
  265. #endif
  266. #ifdef SERIAL_LINK_ENABLE
  267. serial_link_update();
  268. #endif
  269. #ifdef VISUALIZER_ENABLE
  270. visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
  271. #endif
  272. #ifdef POINTING_DEVICE_ENABLE
  273. pointing_device_task();
  274. #endif
  275. #ifdef MIDI_ENABLE
  276. midi_task();
  277. #endif
  278. // update LED
  279. if (led_status != host_keyboard_leds()) {
  280. led_status = host_keyboard_leds();
  281. keyboard_set_leds(led_status);
  282. }
  283. }
  284. /** \brief keyboard set leds
  285. *
  286. * FIXME: needs doc
  287. */
  288. void keyboard_set_leds(uint8_t leds)
  289. {
  290. if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
  291. led_set(leds);
  292. }