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 FAUXCLICKY_ENABLE
  55 #   include "fauxclicky.h"
  56 #endif
  57 #ifdef SERIAL_LINK_ENABLE
  58 #   include "serial_link/system/serial_link.h"
  59 #endif
  60 #ifdef VISUALIZER_ENABLE
  61 #   include "visualizer/visualizer.h"
  62 #endif
  63
  64
  65
  66 #ifdef MATRIX_HAS_GHOST
  67 static uint16_t matrix_ghost_check[MATRIX_ROWS];
  68 static bool has_ghost_in_row(uint8_t row)
  69 {
  70     matrix_row_t matrix_row = (matrix_get_row(row) & matrix_ghost_check[row]);
  71     /* No ghost exists when less than 2 keys are down on the row.
  72     If there are "active" blanks in the matrix, the key can't be pressed by the user,
  73     there is no doubt as to which keys are really being pressed.
  74     The ghosts will be ignored, they are KC_NO.   */
  75     if (((matrix_row - 1) & matrix_row) == 0){
  76         return false;
  77     }
  78     // Ghost occurs when the row shares column line with other row, blanks in the matrix don't matter
  79     // If there are more than two real keys pressed and they match another row's real keys, the row will be ignored.
  80     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
  81         if (i != row && __builtin_popcount((matrix_get_row(i) & matrix_ghost_check[i]) & matrix_row) > 1){
  82             return true;
  83         }
  84     }
  85     return false;
  86     return false;
  87 }
  88
  89 extern const uint8_t keymaps[][MATRIX_ROWS][MATRIX_COLS];
  90 // bit map of true keys and empty spots in matrix, each row is reversed
  91 void make_ghost_check_array(){
  92     for (int row = 0; row < MATRIX_ROWS; row++) {
  93         for (int col = 0; col < MATRIX_COLS; col++) {
  94             if (keymaps[0][row][col] & 0xFF)
  95                 matrix_ghost_check[row] |= 1<<col;
  96             else
  97                 matrix_ghost_check[row] |= 0<<col;
  98         }
  99     }
 100 }
 101
 102 #endif
 103
 104 __attribute__ ((weak))
 105 void matrix_setup(void) {
 106 }
 107
 108 void keyboard_setup(void) {
 109     matrix_setup();
 110 }
 111
 112 void keyboard_init(void) {
 113     timer_init();
 114     matrix_init();
 115 #ifdef PS2_MOUSE_ENABLE
 116     ps2_mouse_init();
 117 #endif
 118 #ifdef SERIAL_MOUSE_ENABLE
 119     serial_mouse_init();
 120 #endif
 121 #ifdef ADB_MOUSE_ENABLE
 122     adb_mouse_init();
 123 #endif
 124 #ifdef BOOTMAGIC_ENABLE
 125     bootmagic();
 126 #else
 127     magic();
 128 #endif
 129 #ifdef BACKLIGHT_ENABLE
 130     backlight_init();
 131 #endif
 132 #ifdef RGBLIGHT_ENABLE
 133     rgblight_init();
 134 #endif
 135 #ifdef FAUXCLICKY_ENABLE
 136     fauxclicky_init();
 137 #endif
 138 #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
 139     keymap_config.nkro = 1;
 140 #endif
 141 #ifdef MATRIX_HAS_GHOST
 142     make_ghost_check_array();
 143 #endif
 144 }
 145
 146 /*
 147  * Do keyboard routine jobs: scan mantrix, light LEDs, ...
 148  * This is repeatedly called as fast as possible.
 149  */
 150 void keyboard_task(void)
 151 {
 152     static matrix_row_t matrix_prev[MATRIX_ROWS];
 153 #ifdef MATRIX_HAS_GHOST
 154     static matrix_row_t matrix_ghost[MATRIX_ROWS];
 155 #endif
 156     static uint8_t led_status = 0;
 157     matrix_row_t matrix_row = 0;
 158     matrix_row_t matrix_change = 0;
 159
 160     matrix_scan();
 161     for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 162         matrix_row = matrix_get_row(r);
 163         matrix_change = matrix_row ^ matrix_prev[r];
 164         if (matrix_change) {
 165 #ifdef MATRIX_HAS_GHOST
 166             if (has_ghost_in_row(r)) {
 167                 /* Keep track of whether ghosted status has changed for
 168                  * debugging. But don't update matrix_prev until un-ghosted, or
 169                  * the last key would be lost.
 170                  */
 171                 if (debug_matrix && matrix_ghost[r] != matrix_row) {
 172                     matrix_print();
 173                 }
 174                 matrix_ghost[r] = matrix_row;
 175                 continue;
 176             }
 177             matrix_ghost[r] = matrix_row;
 178 #endif
 179             if (debug_matrix) matrix_print();
 180             for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 181                 if (matrix_change & ((matrix_row_t)1<<c)) {
 182                     action_exec((keyevent_t){
 183                         .key = (keypos_t){ .row = r, .col = c },
 184                         .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 185                         .time = (timer_read() | 1) /* time should not be 0 */
 186                     });
 187                     // record a processed key
 188                     matrix_prev[r] ^= ((matrix_row_t)1<<c);
 189                     // process a key per task call
 190                     goto MATRIX_LOOP_END;
 191                 }
 192             }
 193         }
 194     }
 195     // call with pseudo tick event when no real key event.
 196     action_exec(TICK);
 197
 198 MATRIX_LOOP_END:
 199
 200 #ifdef MOUSEKEY_ENABLE
 201     // mousekey repeat & acceleration
 202     mousekey_task();
 203 #endif
 204
 205 #ifdef PS2_MOUSE_ENABLE
 206     ps2_mouse_task();
 207 #endif
 208
 209 #ifdef SERIAL_MOUSE_ENABLE
 210     serial_mouse_task();
 211 #endif
 212
 213 #ifdef ADB_MOUSE_ENABLE
 214     adb_mouse_task();
 215 #endif
 216
 217 #ifdef SERIAL_LINK_ENABLE
 218         serial_link_update();
 219 #endif
 220
 221 #ifdef VISUALIZER_ENABLE
 222     visualizer_update(default_layer_state, layer_state, visualizer_get_mods(), host_keyboard_leds());
 223 #endif
 224
 225     // update LED
 226     if (led_status != host_keyboard_leds()) {
 227         led_status = host_keyboard_leds();
 228         keyboard_set_leds(led_status);
 229     }
 230 }
 231
 232 void keyboard_set_leds(uint8_t leds)
 233 {
 234     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 235     led_set(leds);
 236 }