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