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