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 void keyboard_setup(void)
  67 {
  68     matrix_setup();
  69 }
  70
  71 void keyboard_init(void)
  72 {
  73     timer_init();
  74     matrix_init();
  75 #ifdef PS2_MOUSE_ENABLE
  76     ps2_mouse_init();
  77 #endif
  78 #ifdef SERIAL_MOUSE_ENABLE
  79     serial_mouse_init();
  80 #endif
  81 #ifdef ADB_MOUSE_ENABLE
  82     adb_mouse_init();
  83 #endif
  84
  85
  86 #ifdef BOOTMAGIC_ENABLE
  87     bootmagic();
  88 #endif
  89
  90 #ifdef BACKLIGHT_ENABLE
  91     backlight_init();
  92 #endif
  93 }
  94
  95 /*
  96  * Do keyboard routine jobs: scan mantrix, light LEDs, ...
  97  * This is repeatedly called as fast as possible.
  98  */
  99 void keyboard_task(void)
 100 {
 101     static matrix_row_t matrix_prev[MATRIX_ROWS];
 102 #ifdef MATRIX_HAS_GHOST
 103     static matrix_row_t matrix_ghost[MATRIX_ROWS];
 104 #endif
 105     static uint8_t led_status = 0;
 106     matrix_row_t matrix_row = 0;
 107     matrix_row_t matrix_change = 0;
 108
 109     matrix_scan();
 110     for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
 111         matrix_row = matrix_get_row(r);
 112         matrix_change = matrix_row ^ matrix_prev[r];
 113         if (matrix_change) {
 114 #ifdef MATRIX_HAS_GHOST
 115             if (has_ghost_in_row(r)) {
 116                 /* Keep track of whether ghosted status has changed for
 117                  * debugging. But don't update matrix_prev until un-ghosted, or
 118                  * the last key would be lost.
 119                  */
 120                 if (debug_matrix && matrix_ghost[r] != matrix_row) {
 121                     matrix_print();
 122                 }
 123                 matrix_ghost[r] = matrix_row;
 124                 continue;
 125             }
 126             matrix_ghost[r] = matrix_row;
 127 #endif
 128             if (debug_matrix) matrix_print();
 129             for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 130                 if (matrix_change & ((matrix_row_t)1<<c)) {
 131                     keyevent_t e = (keyevent_t){
 132                         .key = (keypos_t){ .row = r, .col = c },
 133                         .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 134                         .time = (timer_read() | 1) /* time should not be 0 */
 135                     };
 136                     action_exec(e);
 137                     hook_matrix_change(e);
 138                     // record a processed key
 139                     matrix_prev[r] ^= ((matrix_row_t)1<<c);
 140
 141                     // This can miss stroke when scan matrix takes long like Topre
 142                     // process a key per task call
 143                     //goto MATRIX_LOOP_END;
 144                 }
 145             }
 146         }
 147     }
 148     // call with pseudo tick event when no real key event.
 149     action_exec(TICK);
 150
 151 MATRIX_LOOP_END:
 152
 153     hook_keyboard_loop();
 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         if (debug_keyboard) dprintf("LED: %02X\n", led_status);
 176         hook_keyboard_leds_change(led_status);
 177     }
 178 }
 179
 180 void keyboard_set_leds(uint8_t leds)
 181 {
 182     led_set(leds);
 183 }