tmk_core/common/keyboard.c

   1 /*
   2 Copyright 2011, 2012, 2013 Jun Wako <wakojun@gmail.com>
   3
   4 This program is free software: you can redistribute it and/or modify
   5 it under the terms of the GNU General Public License as published by
   6 the Free Software Foundation, either version 2 of the License, or
   7 (at your option) any later version.
   8
   9 This program is distributed in the hope that it will be useful,
  10 but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12 GNU General Public License for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16 */
  17
  18 #include <stdint.h>
  19 #include "keyboard.h"
  20 #include "matrix.h"
  21 #include "keymap.h"
  22 #include "host.h"
  23 #include "led.h"
  24 #include "keycode.h"
  25 #include "timer.h"
  26 #include "print.h"
  27 #include "debug.h"
  28 #include "command.h"
  29 #include "util.h"
  30 #include "sendchar.h"
  31 #include "eeconfig.h"
  32 #include "backlight.h"
  33 #include "action_layer.h"
  34 #ifdef BOOTMAGIC_ENABLE
  35 #   include "bootmagic.h"
  36 #else
  37 #   include "magic.h"
  38 #endif
  39 #ifdef MOUSEKEY_ENABLE
  40 #   include "mousekey.h"
  41 #endif
  42 #ifdef PS2_MOUSE_ENABLE
  43 #   include "ps2_mouse.h"
  44 #endif
  45 #ifdef SERIAL_MOUSE_ENABLE
  46 #   include "serial_mouse.h"
  47 #endif
  48 #ifdef ADB_MOUSE_ENABLE
  49 #   include "adb.h"
  50 #endif
  51 #ifdef RGBLIGHT_ENABLE
  52 #   include "rgblight.h"
  53 #endif
  54 #ifdef STENO_ENABLE
  55 #   include "process_steno.h"
  56 #endif
  57 #ifdef FAUXCLICKY_ENABLE
  58 #   include "fauxclicky.h"
  59 #endif
  60 #ifdef SERIAL_LINK_ENABLE
  61 #   include "serial_link/system/serial_link.h"
  62 #endif
  63 #ifdef VISUALIZER_ENABLE
  64 #   include "visualizer/visualizer.h"
  65 #endif
  66 #ifdef POINTING_DEVICE_ENABLE
  67 #   include "pointing_device.h"
  68 #endif
  69 #ifdef MIDI_ENABLE
  70 #   include "process_midi.h"
  71 #endif
  72 #ifdef HD44780_ENABLE
  73 #   include "hd44780.h"
  74 #endif
  75 #ifdef QWIIC_ENABLE
  76 #   include "qwiic.h"
  77 #endif
  78
  79 #ifdef MATRIX_HAS_GHOST
  80 extern const uint16_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
  81 static matrix_row_t get_real_keys(uint8_t row, matrix_row_t rowdata){
  82     matrix_row_t out = 0;
  83     for (uint8_t col = 0; col < MATRIX_COLS; col++) {
  84         //read each key in the row data and check if the keymap defines it as a real key
  85         if (pgm_read_byte(&keymaps[0][row][col]) && (rowdata & (1<<col))){
  86             //this creates new row data, if a key is defined in the keymap, it will be set here
  87             out |= 1<<col;
  88         }
  89     }
  90     return out;
  91 }
  92
  93 static inline bool popcount_more_than_one(matrix_row_t rowdata)
  94 {
  95     rowdata &= rowdata-1; //if there are less than two bits (keys) set, rowdata will become zero
  96     return rowdata;
  97 }
  98
  99 static inline bool has_ghost_in_row(uint8_t row, matrix_row_t rowdata)
 100 {
 101     /* No ghost exists when less than 2 keys are down on the row.
 102     If there are "active" blanks in the matrix, the key can't be pressed by the user,
 103     there is no doubt as to which keys are really being pressed.
 104     The ghosts will be ignored, they are KC_NO.   */
 105     rowdata = get_real_keys(row, rowdata);
 106     if ((popcount_more_than_one(rowdata)) == 0){
 107         return false;
 108     }
 109     /* Ghost occurs when the row shares a column line with other row,
 110     and two columns are read on each row. Blanks in the matrix don't matter,
 111     so they are filtered out.
 112     If there are two or more real keys pressed and they match columns with
 113     at least two of another row's real keys, the row will be ignored. Keep in mind,
 114     we are checking one row at a time, not all of them at once.
 115     */
 116     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 117         if (i != row && popcount_more_than_one(get_real_keys(i, matrix_get_row(i)) & rowdata)){
 118             return true;
 119         }
 120     }
 121     return false;
 122 }
 123
 124 #endif
 125
 126 void disable_jtag(void) {
 127 // To use PORTF disable JTAG with writing JTD bit twice within four cycles.
 128 #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega32U4__))
 129     MCUCR |= _BV(JTD);
 130     MCUCR |= _BV(JTD);
 131 #endif
 132 }
 133
 134 /** \brief matrix_setup
 135  *
 136  * FIXME: needs doc
 137  */
 138 __attribute__ ((weak))
 139 void matrix_setup(void) {
 140 }
 141
 142 /** \brief keyboard_pre_init_user
 143  *
 144  * FIXME: needs doc
 145  */
 146 __attribute__ ((weak))
 147 void keyboard_pre_init_user(void) { }
 148
 149 /** \brief keyboard_pre_init_kb
 150  *
 151  * FIXME: needs doc
 152  */
 153 __attribute__ ((weak))
 154 void keyboard_pre_init_kb(void) {
 155   keyboard_pre_init_user();
 156 }
 157
 158 /** \brief keyboard_post_init_user
 159  *
 160  * FIXME: needs doc
 161  */
 162
 163 __attribute__ ((weak))
 164 void keyboard_post_init_user() {}
 165
 166 /** \brief keyboard_post_init_kb
 167  *
 168  * FIXME: needs doc
 169  */
 170
 171 __attribute__ ((weak))
 172 void keyboard_post_init_kb(void) {
 173   keyboard_post_init_user();
 174 }
 175
 176 /** \brief keyboard_setup
 177  *
 178  * FIXME: needs doc
 179  */
 180 void keyboard_setup(void) {
 181     disable_jtag();
 182     matrix_setup();
 183     keyboard_pre_init_kb();
 184 }
 185
 186 /** \brief is_keyboard_master
 187  *
 188  * FIXME: needs doc
 189  */
 190 __attribute__((weak))
 191 bool is_keyboard_master(void) {
 192     return true;
 193 }
 194
 195 /** \brief keyboard_init
 196  *
 197  * FIXME: needs doc
 198  */
 199 void keyboard_init(void) {
 200     timer_init();
 201     matrix_init();
 202 #ifdef QWIIC_ENABLE
 203     qwiic_init();
 204 #endif
 205 #ifdef PS2_MOUSE_ENABLE
 206     ps2_mouse_init();
 207 #endif
 208 #ifdef SERIAL_MOUSE_ENABLE
 209     serial_mouse_init();
 210 #endif
 211 #ifdef ADB_MOUSE_ENABLE
 212     adb_mouse_init();
 213 #endif
 214 #ifdef BOOTMAGIC_ENABLE
 215     bootmagic();
 216 #else
 217     magic();
 218 #endif
 219 #ifdef BACKLIGHT_ENABLE
 220     backlight_init();
 221 #endif
 222 #ifdef RGBLIGHT_ENABLE
 223     rgblight_init();
 224 #endif
 225 #ifdef STENO_ENABLE
 226     steno_init();
 227 #endif
 228 #ifdef FAUXCLICKY_ENABLE
 229     fauxclicky_init();
 230 #endif
 231 #ifdef POINTING_DEVICE_ENABLE
 232     pointing_device_init();
 233 #endif
 234 #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
 235     keymap_config.nkro = 1;
 236 #endif
 237     keyboard_post_init_kb(); /* Always keep this last */
 238 }
 239
 240 /** \brief Keyboard task: Do keyboard routine jobs
 241  *
 242  * Do routine keyboard jobs:
 243  *
 244  * * scan matrix
 245  * * handle mouse movements
 246  * * run visualizer code
 247  * * handle midi commands
 248  * * light LEDs
 249  *
 250  * This is repeatedly called as fast as possible.
 251  */
 252 void keyboard_task(void)
 253 {
 254     static matrix_row_t matrix_prev[MATRIX_ROWS];
 255     static uint8_t led_status = 0;
 256     matrix_row_t matrix_row = 0;
 257     matrix_row_t matrix_change = 0;
 258 #ifdef QMK_KEYS_PER_SCAN
 259     uint8_t keys_processed = 0;
 260 #endif
 261
 262     matrix_scan();
 263
 264     if (is_keyboard_master()) {
 265         for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 266             matrix_row = matrix_get_row(r);
 267             matrix_change = matrix_row ^ matrix_prev[r];
 268             if (matrix_change) {
 269 #ifdef MATRIX_HAS_GHOST
 270                 if (has_ghost_in_row(r, matrix_row)) { continue; }
 271 #endif
 272                 if (debug_matrix) matrix_print();
 273                 for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 274                     if (matrix_change & ((matrix_row_t)1<<c)) {
 275                         action_exec((keyevent_t){
 276                             .key = (keypos_t){ .row = r, .col = c },
 277                             .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 278                             .time = (timer_read() | 1) /* time should not be 0 */
 279                         });
 280                         // record a processed key
 281                         matrix_prev[r] ^= ((matrix_row_t)1<<c);
 282 #ifdef QMK_KEYS_PER_SCAN
 283                         // only jump out if we have processed "enough" keys.
 284                         if (++keys_processed >= QMK_KEYS_PER_SCAN)
 285 #endif
 286                         // process a key per task call
 287                         goto MATRIX_LOOP_END;
 288                     }
 289                 }
 290             }
 291         }
 292     }
 293     // call with pseudo tick event when no real key event.
 294 #ifdef QMK_KEYS_PER_SCAN
 295     // we can get here with some keys processed now.
 296     if (!keys_processed)
 297 #endif
 298     action_exec(TICK);
 299
 300 MATRIX_LOOP_END:
 301
 302 #ifdef QWIIC_ENABLE
 303     qwiic_task();
 304 #endif
 305
 306 #ifdef MOUSEKEY_ENABLE
 307     // mousekey repeat & acceleration
 308     mousekey_task();
 309 #endif
 310
 311 #ifdef PS2_MOUSE_ENABLE
 312     ps2_mouse_task();
 313 #endif
 314
 315 #ifdef SERIAL_MOUSE_ENABLE
 316     serial_mouse_task();
 317 #endif
 318
 319 #ifdef ADB_MOUSE_ENABLE
 320     adb_mouse_task();
 321 #endif
 322
 323 #ifdef SERIAL_LINK_ENABLE
 324         serial_link_update();
 325 #endif
 326
 327 #ifdef VISUALIZER_ENABLE
 328     visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
 329 #endif
 330
 331 #ifdef POINTING_DEVICE_ENABLE
 332     pointing_device_task();
 333 #endif
 334
 335 #ifdef MIDI_ENABLE
 336     midi_task();
 337 #endif
 338
 339     // update LED
 340     if (led_status != host_keyboard_leds()) {
 341         led_status = host_keyboard_leds();
 342         keyboard_set_leds(led_status);
 343     }
 344 }
 345
 346 /** \brief keyboard set leds
 347  *
 348  * FIXME: needs doc
 349  */
 350 void keyboard_set_leds(uint8_t leds)
 351 {
 352     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 353     led_set(leds);
 354 }