2 Copyright 2017 Danny Nguyen <danny@keeb.io>
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/>.
29 #include "split_util.h"
30 #include "pro_micro.h"
34 #ifdef BACKLIGHT_ENABLE
35 #include "backlight.h"
36 extern backlight_config_t backlight_config;
45 #ifndef DEBOUNCING_DELAY
46 # define DEBOUNCING_DELAY 5
49 #if (DEBOUNCING_DELAY > 0)
50 static uint16_t debouncing_time;
51 static bool debouncing = false;
54 #if (MATRIX_COLS <= 8)
55 # define print_matrix_header() print("\nr/c 01234567\n")
56 # define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
57 # define matrix_bitpop(i) bitpop(matrix[i])
58 # define ROW_SHIFTER ((uint8_t)1)
60 # error "Currently only supports 8 COLS"
62 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
64 #define ERROR_DISCONNECT_COUNT 5
66 #define SERIAL_LED_ADDR 0x00
68 #define ROWS_PER_HAND (MATRIX_ROWS/2)
70 static uint8_t error_count = 0;
72 static const uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
73 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
75 /* matrix state(1:on, 0:off) */
76 static matrix_row_t matrix[MATRIX_ROWS];
77 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
79 #if (DIODE_DIRECTION == COL2ROW)
80 static void init_cols(void);
81 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
82 static void unselect_rows(void);
83 static void select_row(uint8_t row);
84 static void unselect_row(uint8_t row);
85 #elif (DIODE_DIRECTION == ROW2COL)
86 static void init_rows(void);
87 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
88 static void unselect_cols(void);
89 static void unselect_col(uint8_t col);
90 static void select_col(uint8_t col);
93 __attribute__ ((weak))
94 void matrix_init_kb(void) {
98 __attribute__ ((weak))
99 void matrix_scan_kb(void) {
103 __attribute__ ((weak))
104 void matrix_init_user(void) {
107 __attribute__ ((weak))
108 void matrix_scan_user(void) {
112 uint8_t matrix_rows(void)
118 uint8_t matrix_cols(void)
123 void matrix_init(void)
126 // JTAG disable for PORT F. write JTD bit twice within four cycles.
134 // initialize row and col
135 #if (DIODE_DIRECTION == COL2ROW)
138 #elif (DIODE_DIRECTION == ROW2COL)
145 // initialize matrix state: all keys off
146 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
148 matrix_debouncing[i] = 0;
151 matrix_init_quantum();
155 uint8_t _matrix_scan(void)
157 int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
158 #if (DIODE_DIRECTION == COL2ROW)
159 // Set row, read cols
160 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
161 # if (DEBOUNCING_DELAY > 0)
162 bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
164 if (matrix_changed) {
166 debouncing_time = timer_read();
170 read_cols_on_row(matrix+offset, current_row);
175 #elif (DIODE_DIRECTION == ROW2COL)
176 // Set col, read rows
177 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
178 # if (DEBOUNCING_DELAY > 0)
179 bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
180 if (matrix_changed) {
182 debouncing_time = timer_read();
185 read_rows_on_col(matrix+offset, current_col);
191 # if (DEBOUNCING_DELAY > 0)
192 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
193 for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
194 matrix[i+offset] = matrix_debouncing[i+offset];
205 // Get rows from other half over i2c
206 int i2c_transaction(void) {
207 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
209 int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
210 if (err) goto i2c_error;
212 // start of matrix stored at 0x00
213 err = i2c_master_write(0x00);
214 if (err) goto i2c_error;
216 #ifdef BACKLIGHT_ENABLE
217 // Write backlight level for slave to read
218 err = i2c_master_write(backlight_config.enable ? backlight_config.level : 0);
220 // Write zero, so our byte index is the same
221 err = i2c_master_write(0x00);
223 if (err) goto i2c_error;
226 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
227 if (err) goto i2c_error;
231 for (i = 0; i < ROWS_PER_HAND-1; ++i) {
232 matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
234 matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
237 i2c_error: // the cable is disconnceted, or something else went wrong
247 int serial_transaction(void) {
248 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
250 if (serial_update_buffers()) {
254 for (int i = 0; i < ROWS_PER_HAND; ++i) {
255 matrix[slaveOffset+i] = serial_slave_buffer[i];
258 #ifdef BACKLIGHT_ENABLE
259 // Write backlight level for slave to read
260 serial_master_buffer[SERIAL_LED_ADDR] = backlight_config.enable ? backlight_config.level : 0;
266 uint8_t matrix_scan(void)
268 uint8_t ret = _matrix_scan();
271 if( i2c_transaction() ) {
273 if( serial_transaction() ) {
275 // turn on the indicator led when halves are disconnected
280 if (error_count > ERROR_DISCONNECT_COUNT) {
281 // reset other half if disconnected
282 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
283 for (int i = 0; i < ROWS_PER_HAND; ++i) {
284 matrix[slaveOffset+i] = 0;
288 // turn off the indicator led on no error
292 matrix_scan_quantum();
296 void matrix_slave_scan(void) {
299 int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
302 #ifdef BACKLIGHT_ENABLE
303 // Read backlight level sent from master and update level on slave
304 backlight_set(i2c_slave_buffer[0]);
306 for (int i = 0; i < ROWS_PER_HAND; ++i) {
307 i2c_slave_buffer[i+1] = matrix[offset+i];
310 for (int i = 0; i < ROWS_PER_HAND; ++i) {
311 serial_slave_buffer[i] = matrix[offset+i];
314 #ifdef BACKLIGHT_ENABLE
315 // Read backlight level sent from master and update level on slave
316 backlight_set(serial_master_buffer[SERIAL_LED_ADDR]);
321 bool matrix_is_modified(void)
323 #if (DEBOUNCING_DELAY > 0)
324 if (debouncing) return false;
330 bool matrix_is_on(uint8_t row, uint8_t col)
332 return (matrix[row] & ((matrix_row_t)1<<col));
336 matrix_row_t matrix_get_row(uint8_t row)
341 void matrix_print(void)
343 print("\nr/c 0123456789ABCDEF\n");
344 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
345 phex(row); print(": ");
346 pbin_reverse16(matrix_get_row(row));
351 uint8_t matrix_key_count(void)
354 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
355 count += bitpop16(matrix[i]);
360 #if (DIODE_DIRECTION == COL2ROW)
362 static void init_cols(void)
364 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
365 uint8_t pin = col_pins[x];
366 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
367 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
371 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
373 // Store last value of row prior to reading
374 matrix_row_t last_row_value = current_matrix[current_row];
376 // Clear data in matrix row
377 current_matrix[current_row] = 0;
379 // Select row and wait for row selecton to stabilize
380 select_row(current_row);
384 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
386 // Select the col pin to read (active low)
387 uint8_t pin = col_pins[col_index];
388 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
390 // Populate the matrix row with the state of the col pin
391 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
395 unselect_row(current_row);
397 return (last_row_value != current_matrix[current_row]);
400 static void select_row(uint8_t row)
402 uint8_t pin = row_pins[row];
403 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
404 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
407 static void unselect_row(uint8_t row)
409 uint8_t pin = row_pins[row];
410 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
411 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
414 static void unselect_rows(void)
416 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
417 uint8_t pin = row_pins[x];
418 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
419 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
423 #elif (DIODE_DIRECTION == ROW2COL)
425 static void init_rows(void)
427 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
428 uint8_t pin = row_pins[x];
429 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
430 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
434 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
436 bool matrix_changed = false;
438 // Select col and wait for col selecton to stabilize
439 select_col(current_col);
443 for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
446 // Store last value of row prior to reading
447 matrix_row_t last_row_value = current_matrix[row_index];
449 // Check row pin state
450 if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
452 // Pin LO, set col bit
453 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
457 // Pin HI, clear col bit
458 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
461 // Determine if the matrix changed state
462 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
464 matrix_changed = true;
469 unselect_col(current_col);
471 return matrix_changed;
474 static void select_col(uint8_t col)
476 uint8_t pin = col_pins[col];
477 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
478 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
481 static void unselect_col(uint8_t col)
483 uint8_t pin = col_pins[col];
484 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
485 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
488 static void unselect_cols(void)
490 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
491 uint8_t pin = col_pins[x];
492 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
493 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI