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