keyboard/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 <avr/io.h>
  24 #include <avr/interrupt.h>
  25 #include <util/delay.h>
  26 #include "print.h"
  27 #include "debug.h"
  28 #include "util.h"
  29 #include "timer.h"
  30 #include "matrix.h"
  31
  32
  33 // Timer resolution check
  34 #if (1000000/TIMER_RAW_FREQ > 20)
  35 #   error "Timer resolution(>20us) is not enough for HHKB matrix scan tweak on V-USB."
  36 #endif
  37
  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 // Matrix I/O ports
  47 //
  48 // row:     HC4051[A,B,C]  selects scan row0-7
  49 // col:     LS145[A,B,C,D] selects scan col0-7 and enable(D)
  50 // key:     on: 0/off: 1
  51 // prev:    unknown: output previous key state(negated)?
  52
  53 #if defined(__AVR_AT90USB1286__)
  54 // Ports for Teensy++
  55 // row:     PB0-2
  56 // col:     PB3-5,6
  57 // key:     PE6(pull-uped)
  58 // prev:    PE7
  59 #define KEY_INIT()              do {    \
  60     DDRB |= 0x7F;                       \
  61     DDRE |=  (1<<7);                    \
  62     DDRE &= ~(1<<6);                    \
  63     PORTE |= (1<<6);                    \
  64 } while (0)
  65 #define KEY_SELECT(ROW, COL)    (PORTB = (PORTB & 0xC0) |       \
  66                                          (((COL) & 0x07)<<3) |    \
  67                                          ((ROW) & 0x07))
  68 #define KEY_ENABLE()            (PORTB &= ~(1<<6))
  69 #define KEY_UNABLE()            (PORTB |=  (1<<6))
  70 #define KEY_STATE()             (PINE & (1<<6))
  71 #define KEY_PREV_ON()           (PORTE |=  (1<<7))
  72 #define KEY_PREV_OFF()          (PORTE &= ~(1<<7))
  73 #define KEY_POWER_ON()
  74 #define KEY_POWER_OFF()
  75
  76 #elif defined(__AVR_ATmega32U4__)
  77 // Ports for my designed Alt Controller PCB
  78 // row:     PB0-2
  79 // col:     PB3-5,6
  80 // key:     PD7(pull-uped)
  81 // prev:    PB7
  82 #define KEY_INIT()              do {    \
  83     DDRB  = 0xFF;                       \
  84     PORTB = 0x00;                       \
  85     DDRD  &= ~0x80;                     \
  86     PORTD |= 0x80;                      \
  87     KEY_UNABLE();                       \
  88     KEY_PREV_OFF();                     \
  89 } while (0)
  90 #define KEY_SELECT(ROW, COL)    (PORTB = (PORTB & 0xC0) |       \
  91                                          (((COL) & 0x07)<<3) |    \
  92                                          ((ROW) & 0x07))
  93 #define KEY_ENABLE()            (PORTB &= ~(1<<6))
  94 #define KEY_UNABLE()            (PORTB |=  (1<<6))
  95 #define KEY_STATE()             (PIND & (1<<7))
  96 #define KEY_PREV_ON()           (PORTB |=  (1<<7))
  97 #define KEY_PREV_OFF()          (PORTB &= ~(1<<7))
  98 #define KEY_POWER_ON()
  99 #define KEY_POWER_OFF()
 100
 101
 102 #elif defined(__AVR_ATmega328P__)
 103 // Ports for V-USB
 104 // key:     PB0(pull-uped)
 105 // prev:    PB1
 106 // row:     PB2-4
 107 // col:     PC0-2,3
 108 // power:   PB5(Low:on/Hi-z:off)
 109 #define KEY_INIT()              do {    \
 110     DDRB  |= 0x3E;                      \
 111     DDRB  &= ~(1<<0);                   \
 112     PORTB |= 1<<0;                      \
 113     DDRC  |= 0x0F;                      \
 114     KEY_UNABLE();                       \
 115     KEY_PREV_OFF();                     \
 116 } while (0)
 117 #define KEY_SELECT(ROW, COL)    do {    \
 118     PORTB = (PORTB & 0xE3) | ((ROW) & 0x07)<<2; \
 119     PORTC = (PORTC & 0xF8) | ((COL) & 0x07);    \
 120 } while (0)
 121 #define KEY_ENABLE()            (PORTC &= ~(1<<3))
 122 #define KEY_UNABLE()            (PORTC |=  (1<<3))
 123 #define KEY_STATE()             (PINB & (1<<0))
 124 #define KEY_PREV_ON()           (PORTB |=  (1<<1))
 125 #define KEY_PREV_OFF()          (PORTB &= ~(1<<1))
 126 // Power supply switching
 127 #define KEY_POWER_ON()          do {    \
 128     KEY_INIT();                         \
 129     PORTB &= ~(1<<5);                   \
 130     _delay_ms(1);                       \
 131 } while (0)
 132 #define KEY_POWER_OFF()         do {    \
 133     DDRB  &= ~0x3F;                     \
 134     PORTB &= ~0x3F;                     \
 135     DDRC  &= ~0x0F;                     \
 136     PORTC &= ~0x0F;                     \
 137 } while (0)
 138
 139 #else
 140 #   error "define code for matrix scan"
 141 #endif
 142
 143
 144 inline
 145 uint8_t matrix_rows(void)
 146 {
 147     return MATRIX_ROWS;
 148 }
 149
 150 inline
 151 uint8_t matrix_cols(void)
 152 {
 153     return MATRIX_COLS;
 154 }
 155
 156 void matrix_init(void)
 157 {
 158 #ifdef DEBUG
 159     debug_enable = true;
 160     debug_keyboard = true;
 161 #endif
 162
 163     KEY_INIT();
 164
 165     // initialize matrix state: all keys off
 166     for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0x00;
 167     for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix1[i] = 0x00;
 168     matrix = _matrix0;
 169     matrix_prev = _matrix1;
 170 }
 171
 172 uint8_t matrix_scan(void)
 173 {
 174     uint8_t *tmp;
 175
 176     tmp = matrix_prev;
 177     matrix_prev = matrix;
 178     matrix = tmp;
 179
 180     KEY_POWER_ON();
 181     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 182         for (uint8_t col = 0; col < MATRIX_COLS; col++) {
 183             KEY_SELECT(row, col);
 184             _delay_us(40);
 185
 186             // Not sure this is needed. This just emulates HHKB controller's behaviour.
 187             if (matrix_prev[row] & (1<<col)) {
 188                 KEY_PREV_ON();
 189             }
 190             _delay_us(7);
 191
 192             // NOTE: KEY_STATE is valid only in 20us after KEY_ENABLE.
 193             // If V-USB interrupts in this section we could lose 40us or so
 194             // and would read invalid value from KEY_STATE.
 195             uint8_t last = TIMER_RAW;
 196
 197             KEY_ENABLE();
 198             // Wait for KEY_STATE outputs its value.
 199             // 1us was ok on one HHKB, but not worked on another.
 200             // no   wait doesn't work on Teensy++ with pro(1us works)
 201             // no   wait does    work on tmk PCB(8MHz) with pro2
 202             // 1us  wait does    work on both of above
 203             // 10us wait does    work on Teensy++ with pro
 204             // 10us wait does    work on 328p+iwrap with pro
 205             // 10us wait doesn't work on tmk PCB(8MHz) with pro2(very lagged scan)
 206             _delay_us(1);
 207 //            _delay_us(10);
 208             if (KEY_STATE()) {
 209                 matrix[row] &= ~(1<<col);
 210             } else {
 211                 matrix[row] |= (1<<col);
 212             }
 213
 214             // Ignore if this code region execution time elapses more than 20us.
 215             // MEMO: 20[us] * (TIMER_RAW_FREQ / 1000000)[count per us]
 216             // MEMO: then change above using this rule: a/(b/c) = a*1/(b/c) = a*(c/b)
 217             if (TIMER_DIFF_RAW(TIMER_RAW, last) > 20/(1000000/TIMER_RAW_FREQ)) {
 218                 matrix[row] = matrix_prev[row];
 219             }
 220
 221             KEY_PREV_OFF();
 222             KEY_UNABLE();
 223             // NOTE: KEY_STATE keep its state in 20us after KEY_ENABLE.
 224             // This takes 25us or more to make sure KEY_STATE returns to idle state.
 225             _delay_us(150);
 226         }
 227     }
 228     KEY_POWER_OFF();
 229     return 1;
 230 }
 231
 232 bool matrix_is_modified(void)
 233 {
 234     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 235         if (matrix[i] != matrix_prev[i])
 236             return true;
 237     }
 238     return false;
 239 }
 240
 241 inline
 242 bool matrix_has_ghost(void)
 243 {
 244     return false;
 245 }
 246
 247 inline
 248 bool matrix_is_on(uint8_t row, uint8_t col)
 249 {
 250     return (matrix[row] & (1<<col));
 251 }
 252
 253 inline
 254 matrix_row_t matrix_get_row(uint8_t row)
 255 {
 256     return matrix[row];
 257 }
 258
 259 void matrix_print(void)
 260 {
 261     print("\nr/c 01234567\n");
 262     for (uint8_t row = 0; row < matrix_rows(); row++) {
 263         xprintf("%02X: %08b\n", row, bitrev(matrix_get_row(row)));
 264     }
 265 }