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