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