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