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