3 Note for ErgoDox EZ customizers: Here be dragons!
4 This is not a file you want to be messing with.
5 All of the interesting stuff for you is under keymaps/ :)
8 Copyright 2013 Oleg Kostyuk <cub.uanic@gmail.com>
10 This program is free software: you can redistribute it and/or modify
11 it under the terms of the GNU General Public License as published by
12 the Free Software Foundation, either version 2 of the License, or
13 (at your option) any later version.
15 This program is distributed in the hope that it will be useful,
16 but WITHOUT ANY WARRANTY; without even the implied warranty of
17 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 GNU General Public License for more details.
20 You should have received a copy of the GNU General Public License
21 along with this program. If not, see <http://www.gnu.org/licenses/>.
31 #include "action_layer.h"
36 #include QMK_KEYBOARD_H
37 #include "i2cmaster.h"
38 #ifdef DEBUG_MATRIX_SCAN_RATE
43 * This constant define not debouncing time in msecs, but amount of matrix
44 * scan loops which should be made to get stable debounced results.
46 * On Ergodox matrix scan rate is relatively low, because of slow I2C.
47 * Now it's only 317 scans/second, or about 3.15 msec/scan.
48 * According to Cherry specs, debouncing time is 5 msec.
50 * And so, there is no sense to have DEBOUNCE higher than 2.
57 /* matrix state(1:on, 0:off) */
58 static matrix_row_t matrix[MATRIX_ROWS];
60 // Debouncing: store for each key the number of scans until it's eligible to
61 // change. When scanning the matrix, ignore any changes in keys that have
62 // already changed in the last DEBOUNCE scans.
63 static uint8_t debounce_matrix[MATRIX_ROWS * MATRIX_COLS];
65 static matrix_row_t read_cols(uint8_t row);
66 static void init_cols(void);
67 static void unselect_rows(void);
68 static void select_row(uint8_t row);
70 static uint8_t mcp23018_reset_loop;
72 #ifdef DEBUG_MATRIX_SCAN_RATE
73 uint32_t matrix_timer;
74 uint32_t matrix_scan_count;
78 __attribute__ ((weak))
79 void matrix_init_user(void) {}
81 __attribute__ ((weak))
82 void matrix_scan_user(void) {}
84 __attribute__ ((weak))
85 void matrix_init_kb(void) {
89 __attribute__ ((weak))
90 void matrix_scan_kb(void) {
95 uint8_t matrix_rows(void)
101 uint8_t matrix_cols(void)
106 void matrix_init(void)
108 // initialize row and col
110 mcp23018_status = init_mcp23018();
116 // initialize matrix state: all keys off
117 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
119 for (uint8_t j=0; j < MATRIX_COLS; ++j) {
120 debounce_matrix[i * MATRIX_COLS + j] = 0;
124 #ifdef DEBUG_MATRIX_SCAN_RATE
125 matrix_timer = timer_read32();
126 matrix_scan_count = 0;
129 matrix_init_quantum();
133 void matrix_power_up(void) {
134 mcp23018_status = init_mcp23018();
139 // initialize matrix state: all keys off
140 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
144 #ifdef DEBUG_MATRIX_SCAN_RATE
145 matrix_timer = timer_read32();
146 matrix_scan_count = 0;
150 // Returns a matrix_row_t whose bits are set if the corresponding key should be
151 // eligible to change in this scan.
152 matrix_row_t debounce_mask(uint8_t row) {
153 matrix_row_t result = 0;
154 for (uint8_t j=0; j < MATRIX_COLS; ++j) {
155 if (debounce_matrix[row * MATRIX_COLS + j]) {
156 --debounce_matrix[row * MATRIX_COLS + j];
164 // Report changed keys in the given row. Resets the debounce countdowns
165 // corresponding to each set bit in 'change' to DEBOUNCE.
166 void debounce_report(matrix_row_t change, uint8_t row) {
167 for (uint8_t i = 0; i < MATRIX_COLS; ++i) {
168 if (change & (1 << i)) {
169 debounce_matrix[row * MATRIX_COLS + i] = DEBOUNCE;
174 uint8_t matrix_scan(void)
176 if (mcp23018_status) { // if there was an error
177 if (++mcp23018_reset_loop == 0) {
178 // since mcp23018_reset_loop is 8 bit - we'll try to reset once in 255 matrix scans
179 // this will be approx bit more frequent than once per second
180 print("trying to reset mcp23018\n");
181 mcp23018_status = init_mcp23018();
182 if (mcp23018_status) {
183 print("left side not responding\n");
185 print("left side attached\n");
186 ergodox_blink_all_leds();
191 #ifdef DEBUG_MATRIX_SCAN_RATE
194 uint32_t timer_now = timer_read32();
195 if (TIMER_DIFF_32(timer_now, matrix_timer)>1000) {
196 print("matrix scan frequency: ");
197 pdec(matrix_scan_count);
200 matrix_timer = timer_now;
201 matrix_scan_count = 0;
206 mcp23018_status = ergodox_left_leds_update();
208 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
210 wait_us(30); // without this wait read unstable value.
211 matrix_row_t mask = debounce_mask(i);
212 matrix_row_t cols = (read_cols(i) & mask) | (matrix[i] & ~mask);
213 debounce_report(cols ^ matrix[i], i);
219 matrix_scan_quantum();
224 bool matrix_is_modified(void) // deprecated and evidently not called.
230 bool matrix_is_on(uint8_t row, uint8_t col)
232 return (matrix[row] & ((matrix_row_t)1<<col));
236 matrix_row_t matrix_get_row(uint8_t row)
241 void matrix_print(void)
243 print("\nr/c 0123456789ABCDEF\n");
244 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
245 phex(row); print(": ");
246 pbin_reverse16(matrix_get_row(row));
251 uint8_t matrix_key_count(void)
254 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
255 count += bitpop16(matrix[i]);
260 /* Column pin configuration
264 * pin: F0 F1 F4 F5 F6 F7
268 * pin: B5 B4 B3 B2 B1 B0
270 static void init_cols(void)
273 // not needed, already done as part of init_mcp23018()
276 // Input with pull-up(DDR:0, PORT:1)
277 DDRF &= ~(1<<7 | 1<<6 | 1<<5 | 1<<4 | 1<<1 | 1<<0);
278 PORTF |= (1<<7 | 1<<6 | 1<<5 | 1<<4 | 1<<1 | 1<<0);
281 static matrix_row_t read_cols(uint8_t row)
284 if (mcp23018_status) { // if there was an error
288 mcp23018_status = i2c_start(I2C_ADDR_WRITE); if (mcp23018_status) goto out;
289 mcp23018_status = i2c_write(GPIOB); if (mcp23018_status) goto out;
290 mcp23018_status = i2c_start(I2C_ADDR_READ); if (mcp23018_status) goto out;
291 data = i2c_readNak();
300 (PINF&(1<<0) ? 0 : (1<<0)) |
301 (PINF&(1<<1) ? 0 : (1<<1)) |
302 (PINF&(1<<4) ? 0 : (1<<2)) |
303 (PINF&(1<<5) ? 0 : (1<<3)) |
304 (PINF&(1<<6) ? 0 : (1<<4)) |
305 (PINF&(1<<7) ? 0 : (1<<5)) ;
309 /* Row pin configuration
312 * row: 7 8 9 10 11 12 13
313 * pin: B0 B1 B2 B3 D2 D3 C6
317 * pin: A0 A1 A2 A3 A4 A5 A6
319 static void unselect_rows(void)
321 // unselect on mcp23018
322 if (mcp23018_status) { // if there was an error
325 // set all rows hi-Z : 1
326 mcp23018_status = i2c_start(I2C_ADDR_WRITE); if (mcp23018_status) goto out;
327 mcp23018_status = i2c_write(GPIOA); if (mcp23018_status) goto out;
328 mcp23018_status = i2c_write( 0xFF
330 ); if (mcp23018_status) goto out;
335 // unselect on teensy
336 // Hi-Z(DDR:0, PORT:0) to unselect
337 DDRB &= ~(1<<0 | 1<<1 | 1<<2 | 1<<3);
338 PORTB &= ~(1<<0 | 1<<1 | 1<<2 | 1<<3);
339 DDRD &= ~(1<<2 | 1<<3);
340 PORTD &= ~(1<<2 | 1<<3);
345 static void select_row(uint8_t row)
348 // select on mcp23018
349 if (mcp23018_status) { // if there was an error
352 // set active row low : 0
353 // set other rows hi-Z : 1
354 mcp23018_status = i2c_start(I2C_ADDR_WRITE); if (mcp23018_status) goto out;
355 mcp23018_status = i2c_write(GPIOA); if (mcp23018_status) goto out;
356 mcp23018_status = i2c_write( 0xFF & ~(1<<row)
358 ); if (mcp23018_status) goto out;
364 // Output low(DDR:1, PORT:0) to select