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 __attribute__ ((weak))
 121 void matrix_setup(void) {
 122 }
 123
 124 void keyboard_setup(void) {
 125     matrix_setup();
 126 }
 127
 128 __attribute__((weak))
 129 bool is_keyboard_master(void) {
 130     return true;
 131 }
 132
 133 void keyboard_init(void) {
 134     timer_init();
 135     matrix_init();
 136 #ifdef PS2_MOUSE_ENABLE
 137     ps2_mouse_init();
 138 #endif
 139 #ifdef SERIAL_MOUSE_ENABLE
 140     serial_mouse_init();
 141 #endif
 142 #ifdef ADB_MOUSE_ENABLE
 143     adb_mouse_init();
 144 #endif
 145 #ifdef BOOTMAGIC_ENABLE
 146     bootmagic();
 147 #else
 148     magic();
 149 #endif
 150 #ifdef BACKLIGHT_ENABLE
 151     backlight_init();
 152 #endif
 153 #ifdef RGBLIGHT_ENABLE
 154     rgblight_init();
 155 #endif
 156 #ifdef STENO_ENABLE
 157     steno_init();
 158 #endif
 159 #ifdef FAUXCLICKY_ENABLE
 160     fauxclicky_init();
 161 #endif
 162 #ifdef POINTING_DEVICE_ENABLE
 163     pointing_device_init();
 164 #endif
 165 #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
 166     keymap_config.nkro = 1;
 167 #endif
 168 }
 169
 170 /*
 171  * Do keyboard routine jobs: scan matrix, light LEDs, ...
 172  * This is repeatedly called as fast as possible.
 173  */
 174 void keyboard_task(void)
 175 {
 176     static matrix_row_t matrix_prev[MATRIX_ROWS];
 177 #ifdef MATRIX_HAS_GHOST
 178   //  static matrix_row_t matrix_ghost[MATRIX_ROWS];
 179 #endif
 180     static uint8_t led_status = 0;
 181     matrix_row_t matrix_row = 0;
 182     matrix_row_t matrix_change = 0;
 183 #ifdef QMK_KEYS_PER_SCAN
 184     uint8_t keys_processed = 0;
 185 #endif
 186
 187     matrix_scan();
 188     if (is_keyboard_master()) {
 189         for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 190             matrix_row = matrix_get_row(r);
 191             matrix_change = matrix_row ^ matrix_prev[r];
 192             if (matrix_change) {
 193 #ifdef MATRIX_HAS_GHOST
 194                 if (has_ghost_in_row(r, matrix_row)) {
 195                     /* Keep track of whether ghosted status has changed for
 196                     * debugging. But don't update matrix_prev until un-ghosted, or
 197                     * the last key would be lost.
 198                     */
 199                     //if (debug_matrix && matrix_ghost[r] != matrix_row) {
 200                     //    matrix_print();
 201                     //}
 202                     //matrix_ghost[r] = matrix_row;
 203                     continue;
 204                 }
 205                 //matrix_ghost[r] = matrix_row;
 206 #endif
 207                 if (debug_matrix) matrix_print();
 208                 for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 209                     if (matrix_change & ((matrix_row_t)1<<c)) {
 210                         action_exec((keyevent_t){
 211                             .key = (keypos_t){ .row = r, .col = c },
 212                             .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 213                             .time = (timer_read() | 1) /* time should not be 0 */
 214                         });
 215                         // record a processed key
 216                         matrix_prev[r] ^= ((matrix_row_t)1<<c);
 217 #ifdef QMK_KEYS_PER_SCAN
 218                         // only jump out if we have processed "enough" keys.
 219                         if (++keys_processed >= QMK_KEYS_PER_SCAN)
 220 #endif
 221                         // process a key per task call
 222                         goto MATRIX_LOOP_END;
 223                     }
 224                 }
 225             }
 226         }
 227     }
 228     // call with pseudo tick event when no real key event.
 229 #ifdef QMK_KEYS_PER_SCAN
 230     // we can get here with some keys processed now.
 231     if (!keys_processed)
 232 #endif
 233     action_exec(TICK);
 234
 235 MATRIX_LOOP_END:
 236
 237 #ifdef MOUSEKEY_ENABLE
 238     // mousekey repeat & acceleration
 239     mousekey_task();
 240 #endif
 241
 242 #ifdef PS2_MOUSE_ENABLE
 243     ps2_mouse_task();
 244 #endif
 245
 246 #ifdef SERIAL_MOUSE_ENABLE
 247     serial_mouse_task();
 248 #endif
 249
 250 #ifdef ADB_MOUSE_ENABLE
 251     adb_mouse_task();
 252 #endif
 253
 254 #ifdef SERIAL_LINK_ENABLE
 255         serial_link_update();
 256 #endif
 257
 258 #ifdef VISUALIZER_ENABLE
 259     visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
 260 #endif
 261
 262 #ifdef POINTING_DEVICE_ENABLE
 263     pointing_device_task();
 264 #endif
 265
 266 #ifdef MIDI_ENABLE
 267     midi_task();
 268 #endif
 269
 270     // update LED
 271     if (led_status != host_keyboard_leds()) {
 272         led_status = host_keyboard_leds();
 273         keyboard_set_leds(led_status);
 274     }
 275 }
 276
 277 void keyboard_set_leds(uint8_t leds)
 278 {
 279     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 280     led_set(leds);
 281 }