m0110_usb/matrix.c

   1 /*
   2 Copyright 2011 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 /*
  19  * scan matrix
  20  */
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include <avr/io.h>
  24 #include <util/delay.h>
  25 #include "print.h"
  26 #include "util.h"
  27 #include "debug.h"
  28 #include "host.h"
  29 #include "led.h"
  30 #include "m0110.h"
  31 #include "matrix.h"
  32
  33
  34 #define CAPS        0x39
  35 #define CAPS_UP     (CAPS | 0x80)
  36 #define ROW(key)    ((key)>>3&0x0F)
  37 #define COL(key)    ((key)&0x07)
  38
  39
  40 static bool is_modified = false;
  41
  42 // matrix state buffer(1:on, 0:off)
  43 static uint8_t *matrix;
  44 static uint8_t _matrix0[MATRIX_ROWS];
  45
  46 #ifdef MATRIX_HAS_GHOST
  47 static bool matrix_has_ghost_in_row(uint8_t row);
  48 #endif
  49 static void register_key(uint8_t key);
  50
  51
  52 inline
  53 uint8_t matrix_rows(void)
  54 {
  55     return MATRIX_ROWS;
  56 }
  57
  58 inline
  59 uint8_t matrix_cols(void)
  60 {
  61     return MATRIX_COLS;
  62 }
  63
  64 void matrix_init(void)
  65 {
  66     print_enable = true;
  67     debug_enable = true;
  68     debug_matrix = false;
  69     debug_keyboard = false;
  70     debug_mouse = false;
  71     print("debug enabled.\n");
  72
  73     m0110_init();
  74     // initialize matrix state: all keys off
  75     for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0x00;
  76     matrix = _matrix0;
  77     return;
  78 }
  79
  80 uint8_t matrix_scan(void)
  81 {
  82     uint8_t key;
  83
  84     is_modified = false;
  85     key = m0110_recv_key();
  86
  87 #ifdef MATRIX_HAS_LOCKING_CAPS
  88     // Send Caps key up event
  89     if (matrix_is_on(ROW(CAPS), COL(CAPS))) {
  90         is_modified = true;
  91         register_key(CAPS_UP);
  92     }
  93 #endif
  94     if (key == M0110_NULL) {
  95         return 0;
  96     } else if (key == M0110_ERROR) {
  97         // TODO: error recovery or reinit
  98         return 0;
  99     } else {
 100 #ifdef MATRIX_HAS_LOCKING_CAPS
 101         if (host_keyboard_leds() & (1<<USB_LED_CAPS_LOCK)) {
 102             // CAPS LOCK on:
 103             // Ignore LockingCaps key down event
 104             if (key == CAPS) return 0;
 105             // Convert LockingCaps key up event into down event
 106             if (key == CAPS_UP) key = CAPS;
 107         } else {
 108             // CAPS LOCK off:
 109             // Ignore LockingCaps key up event
 110             if (key == CAPS_UP) return 0;
 111         }
 112 #endif
 113         is_modified = true;
 114         register_key(key);
 115     }
 116
 117     if (debug_enable) {
 118         print("key: "); phex(key); print("\n");
 119     }
 120     return 1;
 121 }
 122
 123 bool matrix_is_modified(void)
 124 {
 125     return is_modified;
 126 }
 127
 128 inline
 129 bool matrix_has_ghost(void)
 130 {
 131 #ifdef MATRIX_HAS_GHOST
 132     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 133         if (matrix_has_ghost_in_row(i))
 134             return true;
 135     }
 136 #endif
 137     return false;
 138 }
 139
 140 inline
 141 bool matrix_is_on(uint8_t row, uint8_t col)
 142 {
 143     return (matrix[row] & (1<<col));
 144 }
 145
 146 inline
 147 uint8_t matrix_get_row(uint8_t row)
 148 {
 149     return matrix[row];
 150 }
 151
 152 void matrix_print(void)
 153 {
 154     print("\nr/c 01234567\n");
 155     for (uint8_t row = 0; row < matrix_rows(); row++) {
 156         phex(row); print(": ");
 157         pbin_reverse(matrix_get_row(row));
 158         print("\n");
 159     }
 160 }
 161
 162 uint8_t matrix_key_count(void)
 163 {
 164     uint8_t count = 0;
 165     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 166         count += bitpop(matrix[i]);
 167     }
 168     return count;
 169 }
 170
 171 #ifdef MATRIX_HAS_GHOST
 172 inline
 173 static bool matrix_has_ghost_in_row(uint8_t row)
 174 {
 175     // no ghost exists in case less than 2 keys on
 176     if (((matrix[row] - 1) & matrix[row]) == 0)
 177         return false;
 178
 179     // ghost exists in case same state as other row
 180     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 181         if (i != row && (matrix[i] & matrix[row]) == matrix[row])
 182             return true;
 183     }
 184     return false;
 185 }
 186 #endif
 187
 188 inline
 189 static void register_key(uint8_t key)
 190 {
 191     if (key&0x80) {
 192         matrix[ROW(key)] &= ~(1<<COL(key));
 193     } else {
 194         matrix[ROW(key)] |=  (1<<COL(key));
 195     }
 196 }