2 Copyright 2011 Jun Wako <wakojun@gmail.com>
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.
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.
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/>.
24 #include <avr/interrupt.h>
25 #include <util/delay.h>
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."
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];
48 // row: HC4051[A,B,C] selects scan row0-7
49 // col: LS145[A,B,C,D] selects scan col0-7 and enable(D)
51 // prev: unknown: output previous key state(negated)?
53 #if defined(__AVR_AT90USB1286__)
57 // key: PE6(pull-uped)
59 #define KEY_INIT() do { \
65 #define KEY_SELECT(ROW, COL) (PORTB = (PORTB & 0xC0) | \
66 (((COL) & 0x07)<<3) | \
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()
76 #elif defined(__AVR_ATmega32U4__)
77 // Ports for my designed Alt Controller PCB
80 // key: PD7(pull-uped)
82 // power: PD4(L:off/H:on)
83 #define KEY_INIT() do { \
88 /* keyswitch board power on */ \
94 #define KEY_SELECT(ROW, COL) (PORTB = (PORTB & 0xC0) | \
95 (((COL) & 0x07)<<3) | \
97 #define KEY_ENABLE() (PORTB &= ~(1<<6))
98 #define KEY_UNABLE() (PORTB |= (1<<6))
99 #define KEY_STATE() (PIND & (1<<7))
100 #define KEY_PREV_ON() (PORTB |= (1<<7))
101 #define KEY_PREV_OFF() (PORTB &= ~(1<<7))
102 #define KEY_POWER_ON()
103 #define KEY_POWER_OFF()
105 #define KEY_POWER_ON() do { \
110 #define KEY_POWER_OFF() do { \
120 #elif defined(__AVR_ATmega328P__)
122 // key: PB0(pull-uped)
126 // power: PB5(Low:on/Hi-z:off)
127 #define KEY_INIT() do { \
135 #define KEY_SELECT(ROW, COL) do { \
136 PORTB = (PORTB & 0xE3) | ((ROW) & 0x07)<<2; \
137 PORTC = (PORTC & 0xF8) | ((COL) & 0x07); \
139 #define KEY_ENABLE() (PORTC &= ~(1<<3))
140 #define KEY_UNABLE() (PORTC |= (1<<3))
141 #define KEY_STATE() (PINB & (1<<0))
142 #define KEY_PREV_ON() (PORTB |= (1<<1))
143 #define KEY_PREV_OFF() (PORTB &= ~(1<<1))
144 // Power supply switching
145 #define KEY_POWER_ON() do { \
150 #define KEY_POWER_OFF() do { \
158 # error "define code for matrix scan"
163 uint8_t matrix_rows(void)
169 uint8_t matrix_cols(void)
174 void matrix_init(void)
178 debug_keyboard = true;
183 // initialize matrix state: all keys off
184 for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix0[i] = 0x00;
185 for (uint8_t i=0; i < MATRIX_ROWS; i++) _matrix1[i] = 0x00;
187 matrix_prev = _matrix1;
190 uint8_t matrix_scan(void)
195 matrix_prev = matrix;
199 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
200 for (uint8_t col = 0; col < MATRIX_COLS; col++) {
201 KEY_SELECT(row, col);
204 // Not sure this is needed. This just emulates HHKB controller's behaviour.
205 if (matrix_prev[row] & (1<<col)) {
210 // NOTE: KEY_STATE is valid only in 20us after KEY_ENABLE.
211 // If V-USB interrupts in this section we could lose 40us or so
212 // and would read invalid value from KEY_STATE.
213 uint8_t last = TIMER_RAW;
217 // Wait for KEY_STATE outputs its value.
218 // 1us was ok on one HHKB, but not worked on another.
219 // no wait doesn't work on Teensy++ with pro(1us works)
220 // no wait does work on tmk PCB(8MHz) with pro2
221 // 1us wait does work on both of above
222 // 1us wait doesn't work on tmk(16MHz)
223 // 5us wait does work on tmk(16MHz)
224 // 5us wait does work on tmk(16MHz/2)
225 // 5us wait does work on tmk(8MHz)
226 // 10us wait does work on Teensy++ with pro
227 // 10us wait does work on 328p+iwrap with pro
228 // 10us wait doesn't work on tmk PCB(8MHz) with pro2(very lagged scan)
232 matrix[row] &= ~(1<<col);
234 matrix[row] |= (1<<col);
237 // Ignore if this code region execution time elapses more than 20us.
238 // MEMO: 20[us] * (TIMER_RAW_FREQ / 1000000)[count per us]
239 // MEMO: then change above using this rule: a/(b/c) = a*1/(b/c) = a*(c/b)
240 if (TIMER_DIFF_RAW(TIMER_RAW, last) > 20/(1000000/TIMER_RAW_FREQ)) {
241 matrix[row] = matrix_prev[row];
246 // NOTE: KEY_STATE keep its state in 20us after KEY_ENABLE.
247 // This takes 25us or more to make sure KEY_STATE returns to idle state.
255 bool matrix_is_modified(void)
257 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
258 if (matrix[i] != matrix_prev[i])
265 bool matrix_has_ghost(void)
271 bool matrix_is_on(uint8_t row, uint8_t col)
273 return (matrix[row] & (1<<col));
277 matrix_row_t matrix_get_row(uint8_t row)
282 void matrix_print(void)
284 print("\nr/c 01234567\n");
285 for (uint8_t row = 0; row < matrix_rows(); row++) {
286 xprintf("%02X: %08b\n", row, bitrev(matrix_get_row(row)));