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