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)
128 // initialize row and col
134 // initialize matrix state: all keys off
135 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
137 matrix_debouncing[i] = 0;
140 matrix_init_quantum();
144 uint8_t _matrix_scan(void)
146 int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
147 #if (DIODE_DIRECTION == COL2ROW)
148 // Set row, read cols
149 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
150 # if (DEBOUNCING_DELAY > 0)
151 bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
153 if (matrix_changed) {
155 debouncing_time = timer_read();
159 read_cols_on_row(matrix+offset, current_row);
164 #elif (DIODE_DIRECTION == ROW2COL)
165 // Set col, read rows
166 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
167 # if (DEBOUNCING_DELAY > 0)
168 bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
169 if (matrix_changed) {
171 debouncing_time = timer_read();
174 read_rows_on_col(matrix+offset, current_col);
180 # if (DEBOUNCING_DELAY > 0)
181 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
182 for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
183 matrix[i+offset] = matrix_debouncing[i+offset];
194 // Get rows from other half over i2c
195 int i2c_transaction(void) {
196 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
198 int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
199 if (err) goto i2c_error;
201 // start of matrix stored at 0x00
202 err = i2c_master_write(0x00);
203 if (err) goto i2c_error;
205 #ifdef BACKLIGHT_ENABLE
206 // Write backlight level for slave to read
207 err = i2c_master_write(backlight_config.enable ? backlight_config.level : 0);
209 // Write zero, so our byte index is the same
210 err = i2c_master_write(0x00);
212 if (err) goto i2c_error;
215 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
216 if (err) goto i2c_error;
220 for (i = 0; i < ROWS_PER_HAND-1; ++i) {
221 matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
223 matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
226 i2c_error: // the cable is disconnceted, or something else went wrong
236 int serial_transaction(void) {
237 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
239 if (serial_update_buffers()) {
243 for (int i = 0; i < ROWS_PER_HAND; ++i) {
244 matrix[slaveOffset+i] = serial_slave_buffer[i];
247 #ifdef BACKLIGHT_ENABLE
248 // Write backlight level for slave to read
249 serial_master_buffer[SERIAL_LED_ADDR] = backlight_config.enable ? backlight_config.level : 0;
255 uint8_t matrix_scan(void)
257 uint8_t ret = _matrix_scan();
260 if( i2c_transaction() ) {
262 if( serial_transaction() ) {
264 // turn on the indicator led when halves are disconnected
269 if (error_count > ERROR_DISCONNECT_COUNT) {
270 // reset other half if disconnected
271 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
272 for (int i = 0; i < ROWS_PER_HAND; ++i) {
273 matrix[slaveOffset+i] = 0;
277 // turn off the indicator led on no error
281 matrix_scan_quantum();
285 void matrix_slave_scan(void) {
288 int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
291 #ifdef BACKLIGHT_ENABLE
292 // Read backlight level sent from master and update level on slave
293 backlight_set(i2c_slave_buffer[0]);
295 for (int i = 0; i < ROWS_PER_HAND; ++i) {
296 i2c_slave_buffer[i+1] = matrix[offset+i];
299 for (int i = 0; i < ROWS_PER_HAND; ++i) {
300 serial_slave_buffer[i] = matrix[offset+i];
303 #ifdef BACKLIGHT_ENABLE
304 // Read backlight level sent from master and update level on slave
305 backlight_set(serial_master_buffer[SERIAL_LED_ADDR]);
310 bool matrix_is_modified(void)
312 if (debouncing) return false;
317 bool matrix_is_on(uint8_t row, uint8_t col)
319 return (matrix[row] & ((matrix_row_t)1<<col));
323 matrix_row_t matrix_get_row(uint8_t row)
328 void matrix_print(void)
330 print("\nr/c 0123456789ABCDEF\n");
331 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
332 phex(row); print(": ");
333 pbin_reverse16(matrix_get_row(row));
338 uint8_t matrix_key_count(void)
341 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
342 count += bitpop16(matrix[i]);
347 #if (DIODE_DIRECTION == COL2ROW)
349 static void init_cols(void)
351 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
352 uint8_t pin = col_pins[x];
353 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
354 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
358 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
360 // Store last value of row prior to reading
361 matrix_row_t last_row_value = current_matrix[current_row];
363 // Clear data in matrix row
364 current_matrix[current_row] = 0;
366 // Select row and wait for row selecton to stabilize
367 select_row(current_row);
371 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
373 // Select the col pin to read (active low)
374 uint8_t pin = col_pins[col_index];
375 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
377 // Populate the matrix row with the state of the col pin
378 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
382 unselect_row(current_row);
384 return (last_row_value != current_matrix[current_row]);
387 static void select_row(uint8_t row)
389 uint8_t pin = row_pins[row];
390 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
391 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
394 static void unselect_row(uint8_t row)
396 uint8_t pin = row_pins[row];
397 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
398 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
401 static void unselect_rows(void)
403 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
404 uint8_t pin = row_pins[x];
405 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
406 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
410 #elif (DIODE_DIRECTION == ROW2COL)
412 static void init_rows(void)
414 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
415 uint8_t pin = row_pins[x];
416 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
417 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
421 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
423 bool matrix_changed = false;
425 // Select col and wait for col selecton to stabilize
426 select_col(current_col);
430 for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
433 // Store last value of row prior to reading
434 matrix_row_t last_row_value = current_matrix[row_index];
436 // Check row pin state
437 if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
439 // Pin LO, set col bit
440 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
444 // Pin HI, clear col bit
445 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
448 // Determine if the matrix changed state
449 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
451 matrix_changed = true;
456 unselect_col(current_col);
458 return matrix_changed;
461 static void select_col(uint8_t col)
463 uint8_t pin = col_pins[col];
464 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
465 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
468 static void unselect_col(uint8_t col)
470 uint8_t pin = col_pins[col];
471 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
472 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
475 static void unselect_cols(void)
477 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
478 uint8_t pin = col_pins[x];
479 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
480 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI