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