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_setup
 143  *
 144  * FIXME: needs doc
 145  */
 146 void keyboard_setup(void) {
 147     disable_jtag();
 148     matrix_setup();
 149 }
 150
 151 /** \brief is_keyboard_master
 152  *
 153  * FIXME: needs doc
 154  */
 155 __attribute__((weak))
 156 bool is_keyboard_master(void) {
 157     return true;
 158 }
 159
 160 /** \brief keyboard_init
 161  *
 162  * FIXME: needs doc
 163  */
 164 void keyboard_init(void) {
 165     timer_init();
 166     matrix_init();
 167 #ifdef QWIIC_ENABLE
 168     qwiic_init();
 169 #endif
 170 #ifdef PS2_MOUSE_ENABLE
 171     ps2_mouse_init();
 172 #endif
 173 #ifdef SERIAL_MOUSE_ENABLE
 174     serial_mouse_init();
 175 #endif
 176 #ifdef ADB_MOUSE_ENABLE
 177     adb_mouse_init();
 178 #endif
 179 #ifdef BOOTMAGIC_ENABLE
 180     bootmagic();
 181 #else
 182     magic();
 183 #endif
 184 #ifdef BACKLIGHT_ENABLE
 185     backlight_init();
 186 #endif
 187 #ifdef RGBLIGHT_ENABLE
 188     rgblight_init();
 189 #endif
 190 #ifdef STENO_ENABLE
 191     steno_init();
 192 #endif
 193 #ifdef FAUXCLICKY_ENABLE
 194     fauxclicky_init();
 195 #endif
 196 #ifdef POINTING_DEVICE_ENABLE
 197     pointing_device_init();
 198 #endif
 199 #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
 200     keymap_config.nkro = 1;
 201 #endif
 202 }
 203
 204 /** \brief Keyboard task: Do keyboard routine jobs
 205  *
 206  * Do routine keyboard jobs:
 207  *
 208  * * scan matrix
 209  * * handle mouse movements
 210  * * run visualizer code
 211  * * handle midi commands
 212  * * light LEDs
 213  *
 214  * This is repeatedly called as fast as possible.
 215  */
 216 void keyboard_task(void)
 217 {
 218     static matrix_row_t matrix_prev[MATRIX_ROWS];
 219 #ifdef MATRIX_HAS_GHOST
 220   //  static matrix_row_t matrix_ghost[MATRIX_ROWS];
 221 #endif
 222     static uint8_t led_status = 0;
 223     matrix_row_t matrix_row = 0;
 224     matrix_row_t matrix_change = 0;
 225 #ifdef QMK_KEYS_PER_SCAN
 226     uint8_t keys_processed = 0;
 227 #endif
 228
 229     matrix_scan();
 230     if (is_keyboard_master()) {
 231         for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 232             matrix_row = matrix_get_row(r);
 233             matrix_change = matrix_row ^ matrix_prev[r];
 234             if (matrix_change) {
 235 #ifdef MATRIX_HAS_GHOST
 236                 if (has_ghost_in_row(r, matrix_row)) {
 237                     /* Keep track of whether ghosted status has changed for
 238                     * debugging. But don't update matrix_prev until un-ghosted, or
 239                     * the last key would be lost.
 240                     */
 241                     //if (debug_matrix && matrix_ghost[r] != matrix_row) {
 242                     //    matrix_print();
 243                     //}
 244                     //matrix_ghost[r] = matrix_row;
 245                     continue;
 246                 }
 247                 //matrix_ghost[r] = matrix_row;
 248 #endif
 249                 if (debug_matrix) matrix_print();
 250                 for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 251                     if (matrix_change & ((matrix_row_t)1<<c)) {
 252                         action_exec((keyevent_t){
 253                             .key = (keypos_t){ .row = r, .col = c },
 254                             .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 255                             .time = (timer_read() | 1) /* time should not be 0 */
 256                         });
 257                         // record a processed key
 258                         matrix_prev[r] ^= ((matrix_row_t)1<<c);
 259 #ifdef QMK_KEYS_PER_SCAN
 260                         // only jump out if we have processed "enough" keys.
 261                         if (++keys_processed >= QMK_KEYS_PER_SCAN)
 262 #endif
 263                         // process a key per task call
 264                         goto MATRIX_LOOP_END;
 265                     }
 266                 }
 267             }
 268         }
 269     }
 270     // call with pseudo tick event when no real key event.
 271 #ifdef QMK_KEYS_PER_SCAN
 272     // we can get here with some keys processed now.
 273     if (!keys_processed)
 274 #endif
 275     action_exec(TICK);
 276
 277 MATRIX_LOOP_END:
 278
 279 #ifdef QWIIC_ENABLE
 280     qwiic_task();
 281 #endif
 282
 283 #ifdef MOUSEKEY_ENABLE
 284     // mousekey repeat & acceleration
 285     mousekey_task();
 286 #endif
 287
 288 #ifdef PS2_MOUSE_ENABLE
 289     ps2_mouse_task();
 290 #endif
 291
 292 #ifdef SERIAL_MOUSE_ENABLE
 293     serial_mouse_task();
 294 #endif
 295
 296 #ifdef ADB_MOUSE_ENABLE
 297     adb_mouse_task();
 298 #endif
 299
 300 #ifdef SERIAL_LINK_ENABLE
 301         serial_link_update();
 302 #endif
 303
 304 #ifdef VISUALIZER_ENABLE
 305     visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
 306 #endif
 307
 308 #ifdef POINTING_DEVICE_ENABLE
 309     pointing_device_task();
 310 #endif
 311
 312 #ifdef MIDI_ENABLE
 313     midi_task();
 314 #endif
 315
 316     // update LED
 317     if (led_status != host_keyboard_leds()) {
 318         led_status = host_keyboard_leds();
 319         keyboard_set_leds(led_status);
 320     }
 321 }
 322
 323 /** \brief keyboard set leds
 324  *
 325  * FIXME: needs doc
 326  */
 327 void keyboard_set_leds(uint8_t leds)
 328 {
 329     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 330     led_set(leds);
 331 }