keyboards/hhkb/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 <util/delay.h>
  24 #include "print.h"
  25 #include "debug.h"
  26 #include "util.h"
  27 #include "timer.h"
  28 #include "matrix.h"
  29 #include "hhkb_avr.h"
  30 #include <avr/wdt.h>
  31 #include "suspend.h"
  32 #include "lufa.h"
  33
  34
  35 // matrix power saving
  36 #define MATRIX_POWER_SAVE       10000
  37 static uint32_t matrix_last_modified = 0;
  38
  39 // matrix state buffer(1:on, 0:off)
  40 static matrix_row_t *matrix;
  41 static matrix_row_t *matrix_prev;
  42 static matrix_row_t _matrix0[MATRIX_ROWS];
  43 static matrix_row_t _matrix1[MATRIX_ROWS];
  44
  45
  46 inline
  47 uint8_t matrix_rows(void)
  48 {
  49     return MATRIX_ROWS;
  50 }
  51
  52 inline
  53 uint8_t matrix_cols(void)
  54 {
  55     return MATRIX_COLS;
  56 }
  57
  58 void matrix_init(void)
  59 {
  60 #ifdef DEBUG
  61     debug_enable = true;
  62     debug_keyboard = true;
  63 #endif
  64
  65     KEY_INIT();
  66
  67     // initialize matrix state: all keys off
  68     for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0x00;
  69     for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix1[i] = 0x00;
  70     matrix = _matrix0;
  71     matrix_prev = _matrix1;
  72 }
  73
  74 __attribute__ ((weak))
  75 void matrix_scan_user(void) {
  76 }
  77
  78 void matrix_scan_kb(void) {
  79   matrix_scan_user();
  80 }
  81
  82 uint8_t matrix_scan(void)
  83 {
  84     uint8_t *tmp;
  85
  86     tmp = matrix_prev;
  87     matrix_prev = matrix;
  88     matrix = tmp;
  89
  90     // power on
  91     if (!KEY_POWER_STATE()) KEY_POWER_ON();
  92     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
  93         for (uint8_t col = 0; col < MATRIX_COLS; col++) {
  94             KEY_SELECT(row, col);
  95             _delay_us(5);
  96
  97             // Not sure this is needed. This just emulates HHKB controller's behaviour.
  98             if (matrix_prev[row] & (1<<col)) {
  99                 KEY_PREV_ON();
 100             }
 101             _delay_us(10);
 102
 103             // NOTE: KEY_STATE is valid only in 20us after KEY_ENABLE.
 104             // If V-USB interrupts in this section we could lose 40us or so
 105             // and would read invalid value from KEY_STATE.
 106             uint8_t last = TIMER_RAW;
 107
 108             KEY_ENABLE();
 109
 110             // Wait for KEY_STATE outputs its value.
 111             // 1us was ok on one HHKB, but not worked on another.
 112             // no   wait doesn't work on Teensy++ with pro(1us works)
 113             // no   wait does    work on tmk PCB(8MHz) with pro2
 114             // 1us  wait does    work on both of above
 115             // 1us  wait doesn't work on tmk(16MHz)
 116             // 5us  wait does    work on tmk(16MHz)
 117             // 5us  wait does    work on tmk(16MHz/2)
 118             // 5us  wait does    work on tmk(8MHz)
 119             // 10us wait does    work on Teensy++ with pro
 120             // 10us wait does    work on 328p+iwrap with pro
 121             // 10us wait doesn't work on tmk PCB(8MHz) with pro2(very lagged scan)
 122             _delay_us(5);
 123
 124             if (KEY_STATE()) {
 125                 matrix[row] &= ~(1<<col);
 126             } else {
 127                 matrix[row] |= (1<<col);
 128             }
 129
 130             // Ignore if this code region execution time elapses more than 20us.
 131             // MEMO: 20[us] * (TIMER_RAW_FREQ / 1000000)[count per us]
 132             // MEMO: then change above using this rule: a/(b/c) = a*1/(b/c) = a*(c/b)
 133             if (TIMER_DIFF_RAW(TIMER_RAW, last) > 20/(1000000/TIMER_RAW_FREQ)) {
 134                 matrix[row] = matrix_prev[row];
 135             }
 136
 137             _delay_us(5);
 138             KEY_PREV_OFF();
 139             KEY_UNABLE();
 140
 141             // NOTE: KEY_STATE keep its state in 20us after KEY_ENABLE.
 142             // This takes 25us or more to make sure KEY_STATE returns to idle state.
 143 #ifdef HHKB_JP
 144             // Looks like JP needs faster scan due to its twice larger matrix
 145             // or it can drop keys in fast key typing
 146             _delay_us(30);
 147 #else
 148             _delay_us(75);
 149 #endif
 150         }
 151         if (matrix[row] ^ matrix_prev[row]) matrix_last_modified = timer_read32();
 152     }
 153     // power off
 154     if (KEY_POWER_STATE() &&
 155             (USB_DeviceState == DEVICE_STATE_Suspended ||
 156              USB_DeviceState == DEVICE_STATE_Unattached ) &&
 157             timer_elapsed32(matrix_last_modified) > MATRIX_POWER_SAVE) {
 158         KEY_POWER_OFF();
 159         suspend_power_down();
 160     }
 161
 162     matrix_scan_quantum();
 163
 164     return 1;
 165 }
 166
 167 bool matrix_is_modified(void)
 168 {
 169     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 170         if (matrix[i] != matrix_prev[i])
 171             return true;
 172     }
 173     return false;
 174 }
 175
 176 inline
 177 bool matrix_has_ghost(void)
 178 {
 179     return false;
 180 }
 181
 182 inline
 183 bool matrix_is_on(uint8_t row, uint8_t col)
 184 {
 185     return (matrix[row] & (1<<col));
 186 }
 187
 188 inline
 189 matrix_row_t matrix_get_row(uint8_t row)
 190 {
 191     return matrix[row];
 192 }
 193
 194 void matrix_print(void)
 195 {
 196     print("\nr/c 01234567\n");
 197     for (uint8_t row = 0; row < matrix_rows(); row++) {
 198         xprintf("%02X: %08b\n", row, bitrev(matrix_get_row(row)));
 199     }
 200 }
 201
 202 uint8_t matrix_key_count(void) {
 203     uint8_t count = 0;
 204     for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
 205         count += bitpop16(matrix_get_row(r));
 206     }
 207     return count;
 208 }
 209
 210 void matrix_power_up(void) {
 211     KEY_POWER_ON();
 212 }
 213 void matrix_power_down(void) {
 214     KEY_POWER_OFF();
 215 }