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