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