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 void keyboard_init(void)
  66 {
  67     timer_init();
  68     matrix_init();
  69 #ifdef PS2_MOUSE_ENABLE
  70     ps2_mouse_init();
  71 #endif
  72 #ifdef SERIAL_MOUSE_ENABLE
  73     serial_mouse_init();
  74 #endif
  75 #ifdef ADB_MOUSE_ENABLE
  76     adb_mouse_init();
  77 #endif
  78
  79
  80 #ifdef BOOTMAGIC_ENABLE
  81     bootmagic();
  82 #endif
  83
  84 #ifdef BACKLIGHT_ENABLE
  85     backlight_init();
  86 #endif
  87 }
  88
  89 /*
  90  * Do keyboard routine jobs: scan mantrix, light LEDs, ...
  91  * This is repeatedly called as fast as possible.
  92  */
  93 void keyboard_task(void)
  94 {
  95     static matrix_row_t matrix_prev[MATRIX_ROWS];
  96 #ifdef MATRIX_HAS_GHOST
  97     static matrix_row_t matrix_ghost[MATRIX_ROWS];
  98 #endif
  99     static uint8_t led_status = 0;
 100     matrix_row_t matrix_row = 0;
 101     matrix_row_t matrix_change = 0;
 102
 103     matrix_scan();
 104     for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 105         matrix_row = matrix_get_row(r);
 106         matrix_change = matrix_row ^ matrix_prev[r];
 107         if (matrix_change) {
 108 #ifdef MATRIX_HAS_GHOST
 109             if (has_ghost_in_row(r)) {
 110                 /* Keep track of whether ghosted status has changed for
 111                  * debugging. But don't update matrix_prev until un-ghosted, or
 112                  * the last key would be lost.
 113                  */
 114                 if (debug_matrix && matrix_ghost[r] != matrix_row) {
 115                     matrix_print();
 116                 }
 117                 matrix_ghost[r] = matrix_row;
 118                 continue;
 119             }
 120             matrix_ghost[r] = matrix_row;
 121 #endif
 122             if (debug_matrix) matrix_print();
 123             for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 124                 if (matrix_change & ((matrix_row_t)1<<c)) {
 125                     action_exec((keyevent_t){
 126                         .key = (keypos_t){ .row = r, .col = c },
 127                         .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 128                         .time = (timer_read() | 1) /* time should not be 0 */
 129                     });
 130                     // record a processed key
 131                     matrix_prev[r] ^= ((matrix_row_t)1<<c);
 132                     // process a key per task call
 133                     goto MATRIX_LOOP_END;
 134                 }
 135             }
 136         }
 137     }
 138     // call with pseudo tick event when no real key event.
 139     action_exec(TICK);
 140
 141 MATRIX_LOOP_END:
 142
 143 #ifdef MOUSEKEY_ENABLE
 144     // mousekey repeat & acceleration
 145     mousekey_task();
 146 #endif
 147
 148 #ifdef PS2_MOUSE_ENABLE
 149     ps2_mouse_task();
 150 #endif
 151
 152 #ifdef SERIAL_MOUSE_ENABLE
 153         serial_mouse_task();
 154 #endif
 155
 156 #ifdef ADB_MOUSE_ENABLE
 157         adb_mouse_task();
 158 #endif
 159
 160     // update LED
 161     if (led_status != host_keyboard_leds()) {
 162         led_status = host_keyboard_leds();
 163         keyboard_set_leds(led_status);
 164     }
 165 }
 166
 167 void keyboard_set_leds(uint8_t leds)
 168 {
 169     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 170     led_set(leds);
 171 }