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