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 <util/delay.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 "bootmagic.h"
  32 #include "eeconfig.h"
  33 #include "mousekey.h"
  34
  35
  36 #ifdef MATRIX_HAS_GHOST
  37 static bool has_ghost_in_row(uint8_t row)
  38 {
  39     matrix_row_t matrix_row = matrix_get_row(row);
  40     // No ghost exists when less than 2 keys are down on the row
  41     if (((matrix_row - 1) & matrix_row) == 0)
  42         return false;
  43
  44     // Ghost occurs when the row shares column line with other row
  45     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
  46         if (i != row && (matrix_get_row(i) & matrix_row))
  47             return true;
  48     }
  49     return false;
  50 }
  51 #endif
  52
  53
  54 void keyboard_init(void)
  55 {
  56     // TODO: configuration of sendchar impl
  57     print_sendchar_func = sendchar;
  58
  59     timer_init();
  60     matrix_init();
  61 #ifdef PS2_MOUSE_ENABLE
  62     ps2_mouse_init();
  63 #endif
  64
  65 #ifdef BOOTMAGIC_ENABLE
  66     bootmagic();
  67
  68     if (eeconfig_is_enabled()) {
  69         uint8_t config;
  70         config = eeconfig_read_debug();
  71         // ignored if debug is enabled by program before.
  72         if (!debug_enable)   debug_enable   = (config & EECONFIG_DEBUG_ENABLE);
  73         if (!debug_matrix)   debug_matrix   = (config & EECONFIG_DEBUG_MATRIX);
  74         if (!debug_keyboard) debug_keyboard = (config & EECONFIG_DEBUG_KEYBOARD);
  75         if (!debug_mouse)    debug_mouse    = (config & EECONFIG_DEBUG_MOUSE);
  76     } else {
  77         eeconfig_init();
  78     }
  79 #endif
  80 }
  81
  82 /*
  83  * Do keyboard routine jobs: scan mantrix, light LEDs, ...
  84  * This is repeatedly called as fast as possible.
  85  */
  86 void keyboard_task(void)
  87 {
  88     static matrix_row_t matrix_prev[MATRIX_ROWS];
  89     static uint8_t led_status = 0;
  90     matrix_row_t matrix_row = 0;
  91     matrix_row_t matrix_change = 0;
  92
  93     matrix_scan();
  94     for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
  95         matrix_row = matrix_get_row(r);
  96         matrix_change = matrix_row ^ matrix_prev[r];
  97         if (matrix_change) {
  98             if (debug_matrix) matrix_print();
  99 #ifdef MATRIX_HAS_GHOST
 100             if (has_ghost_in_row(r)) {
 101                 matrix_prev[r] = matrix_row;
 102                 continue;
 103             }
 104 #endif
 105             for (uint8_t c = 0; c < MATRIX_COLS; c++) {
 106                 if (matrix_change & ((matrix_row_t)1<<c)) {
 107                     action_exec((keyevent_t){
 108                         .key = (key_t){ .row = r, .col = c },
 109                         .pressed = (matrix_row & ((matrix_row_t)1<<c)),
 110                         .time = (timer_read() | 1) /* time should not be 0 */
 111                     });
 112                     // record a processed key
 113                     matrix_prev[r] ^= ((matrix_row_t)1<<c);
 114                     // process a key per task call
 115                     goto MATRIX_LOOP_END;
 116                 }
 117             }
 118         }
 119     }
 120     // call with pseudo tick event when no real key event.
 121     action_exec(TICK);
 122
 123 MATRIX_LOOP_END:
 124 #ifdef MOUSEKEY_ENABLE
 125     // mousekey repeat & acceleration
 126     mousekey_task();
 127 #endif
 128     // update LED
 129     if (led_status != host_keyboard_leds()) {
 130         led_status = host_keyboard_leds();
 131         keyboard_set_leds(led_status);
 132     }
 133 }
 134
 135 void keyboard_set_leds(uint8_t leds)
 136 {
 137     if (debug_keyboard) { debug("keyboard_set_led: "); debug_hex8(leds); debug("\n"); }
 138     led_set(leds);
 139 }