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 #include <stdint.h>
  18 #include "keyboard.h"
  19 #include "matrix.h"
  20 #include "keymap.h"
  21 #include "host.h"
  22 #include "led.h"
  23 #include "keycode.h"
  24 #include "timer.h"
  25 #include "print.h"
  26 #include "debug.h"
  27 #include "command.h"
  28 #include "util.h"
  29 #include "sendchar.h"
  30 #ifdef BOOTMAGIC_ENABLE
  31     #include "bootmagic.h"
  32 #else
  33     #include "magic.h"
  34 #endif
  35 #include "eeconfig.h"
  36 #include "backlight.h"
  37 #ifdef MOUSEKEY_ENABLE
  38 #   include "mousekey.h"
  39 #endif
  40 #ifdef PS2_MOUSE_ENABLE
  41 #   include "ps2_mouse.h"
  42 #endif
  43 #ifdef SERIAL_MOUSE_ENABLE
  44 #include "serial_mouse.h"
  45 #endif
  46 #ifdef ADB_MOUSE_ENABLE
  47 #include "adb.h"
  48 #endif
  49
  50
  51 #ifdef MATRIX_HAS_GHOST
  52 static bool has_ghost_in_row(uint8_t row)
  53 {
  54     matrix_row_t matrix_row = matrix_get_row(row);
  55     // No ghost exists when less than 2 keys are down on the row
  56     if (((matrix_row - 1) & matrix_row) == 0)
  57         return false;
  58
  59     // Ghost occurs when the row shares column line with other row
  60     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
  61         if (i != row && (matrix_get_row(i) & matrix_row))
  62             return true;
  63     }
  64     return false;
  65 }
  66 #endif
  67
  68
  69 __attribute__ ((weak)) void matrix_setup(void) {}
  70 void keyboard_setup(void)
  71 {
  72     matrix_setup();
  73 }
  74
  75 void keyboard_init(void)
  76 {
  77
  78     timer_init();
  79     matrix_init();
  80 #ifdef PS2_MOUSE_ENABLE
  81     ps2_mouse_init();
  82 #endif
  83 #ifdef SERIAL_MOUSE_ENABLE
  84     serial_mouse_init();
  85 #endif
  86 #ifdef ADB_MOUSE_ENABLE
  87     adb_mouse_init();
  88 #endif
  89
  90
  91 #ifdef BOOTMAGIC_ENABLE
  92     bootmagic();
  93 #else
  94     magic();
  95 #endif
  96
  97 #ifdef BACKLIGHT_ENABLE
  98     backlight_init();
  99 #endif
 100
 101 #if defined(NKRO_ENABLE) && defined(FORCE_NKRO)
 102         keyboard_nkro = true;
 103 #endif
 104
 105 }
 106
 107 /*
 108  * Do keyboard routine jobs: scan mantrix, light LEDs, ...
 109  * This is repeatedly called as fast as possible.
 110  */
 111 void keyboard_task(void)
 112 {
 113     static matrix_row_t matrix_prev[MATRIX_ROWS];
 114 #ifdef MATRIX_HAS_GHOST
 115     static matrix_row_t matrix_ghost[MATRIX_ROWS];
 116 #endif
 117     static uint8_t led_status = 0;
 118     matrix_row_t matrix_row = 0;
 119     matrix_row_t matrix_change = 0;
 120
 121     matrix_scan();
 122     for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 123         matrix_row = matrix_get_row(r);
 124         matrix_change = matrix_row ^ matrix_prev[r];
 125         if (matrix_change) {
 126 #ifdef MATRIX_HAS_GHOST
 127             if (has_ghost_in_row(r)) {
 128                 /* Keep track of whether ghosted status has changed for
 129                  * debugging. But don't update matrix_prev until un-ghosted, or
 130                  * the last key would be lost.
 131                  */
 132                 if (debug_matrix && matrix_ghost[r] != matrix_row) {
 133                     matrix_print();
 134                 }
 135                 matrix_ghost[r] = matrix_row;
 136                 continue;
 137             }
 138             matrix_ghost[r] = matrix_row;
 139 #endif
 140             if (debug_matrix) matrix_print();
 141             for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 142                 if (matrix_change & ((matrix_row_t)1<<c)) {
 143                     action_exec((keyevent_t){
 144                         .key = (keypos_t){ .row = r, .col = c },
 145                         .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 146                         .time = (timer_read() | 1) /* time should not be 0 */
 147                     });
 148                     // record a processed key
 149                     matrix_prev[r] ^= ((matrix_row_t)1<<c);
 150                     // process a key per task call
 151                     goto MATRIX_LOOP_END;
 152                 }
 153             }
 154         }
 155     }
 156     // call with pseudo tick event when no real key event.
 157     action_exec(TICK);
 158
 159 MATRIX_LOOP_END:
 160
 161 #ifdef MOUSEKEY_ENABLE
 162     // mousekey repeat & acceleration
 163     mousekey_task();
 164 #endif
 165
 166 #ifdef PS2_MOUSE_ENABLE
 167     ps2_mouse_task();
 168 #endif
 169
 170 #ifdef SERIAL_MOUSE_ENABLE
 171         serial_mouse_task();
 172 #endif
 173
 174 #ifdef ADB_MOUSE_ENABLE
 175         adb_mouse_task();
 176 #endif
 177
 178     // update LED
 179     if (led_status != host_keyboard_leds()) {
 180         led_status = host_keyboard_leds();
 181         keyboard_set_leds(led_status);
 182     }
 183 }
 184
 185 void keyboard_set_leds(uint8_t leds)
 186 {
 187     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 188     led_set(leds);
 189 }