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"
33 #include "backlight.h"
41 #ifndef DEBOUNCING_DELAY
42 # define DEBOUNCING_DELAY 5
45 #if (DEBOUNCING_DELAY > 0)
46 static uint16_t debouncing_time;
47 static bool debouncing = false;
50 #if (MATRIX_COLS <= 8)
51 # define print_matrix_header() print("\nr/c 01234567\n")
52 # define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
53 # define matrix_bitpop(i) bitpop(matrix[i])
54 # define ROW_SHIFTER ((uint8_t)1)
56 # error "Currently only supports 8 COLS"
58 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
60 #define ERROR_DISCONNECT_COUNT 5
62 #define SERIAL_LED_ADDR 0x00
64 #define ROWS_PER_HAND (MATRIX_ROWS/2)
66 static uint8_t error_count = 0;
68 static const uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
69 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
71 /* matrix state(1:on, 0:off) */
72 static matrix_row_t matrix[MATRIX_ROWS];
73 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
75 #if (DIODE_DIRECTION == COL2ROW)
76 static void init_cols(void);
77 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
78 static void unselect_rows(void);
79 static void select_row(uint8_t row);
80 static void unselect_row(uint8_t row);
81 #elif (DIODE_DIRECTION == ROW2COL)
82 static void init_rows(void);
83 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
84 static void unselect_cols(void);
85 static void unselect_col(uint8_t col);
86 static void select_col(uint8_t col);
89 __attribute__ ((weak))
90 void matrix_init_kb(void) {
94 __attribute__ ((weak))
95 void matrix_scan_kb(void) {
99 __attribute__ ((weak))
100 void matrix_init_user(void) {
103 __attribute__ ((weak))
104 void matrix_scan_user(void) {
108 uint8_t matrix_rows(void)
114 uint8_t matrix_cols(void)
119 void matrix_init(void)
124 // initialize row and col
130 // initialize matrix state: all keys off
131 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
133 matrix_debouncing[i] = 0;
139 uint8_t _matrix_scan(void)
141 int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
142 #if (DIODE_DIRECTION == COL2ROW)
143 // Set row, read cols
144 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
145 # if (DEBOUNCING_DELAY > 0)
146 bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
148 if (matrix_changed) {
150 debouncing_time = timer_read();
154 read_cols_on_row(matrix+offset, current_row);
159 #elif (DIODE_DIRECTION == ROW2COL)
160 // Set col, read rows
161 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
162 # if (DEBOUNCING_DELAY > 0)
163 bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
164 if (matrix_changed) {
166 debouncing_time = timer_read();
169 read_rows_on_col(matrix+offset, current_col);
175 # if (DEBOUNCING_DELAY > 0)
176 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
177 for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
178 matrix[i+offset] = matrix_debouncing[i+offset];
189 // Get rows from other half over i2c
190 int i2c_transaction(void) {
191 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
193 int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
194 if (err) goto i2c_error;
196 // start of matrix stored at 0x00
197 err = i2c_master_write(0x00);
198 if (err) goto i2c_error;
201 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
202 if (err) goto i2c_error;
206 for (i = 0; i < ROWS_PER_HAND-1; ++i) {
207 matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
209 matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
212 i2c_error: // the cable is disconnceted, or something else went wrong
222 int serial_transaction(void) {
223 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
225 if (serial_update_buffers()) {
229 for (int i = 0; i < ROWS_PER_HAND; ++i) {
230 matrix[slaveOffset+i] = serial_slave_buffer[i];
233 #ifdef BACKLIGHT_ENABLE
234 // Write backlight level for slave to read
235 serial_master_buffer[SERIAL_LED_ADDR] = get_backlight_level();
241 uint8_t matrix_scan(void)
243 uint8_t ret = _matrix_scan();
246 if( i2c_transaction() ) {
248 if( serial_transaction() ) {
250 // turn on the indicator led when halves are disconnected
255 if (error_count > ERROR_DISCONNECT_COUNT) {
256 // reset other half if disconnected
257 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
258 for (int i = 0; i < ROWS_PER_HAND; ++i) {
259 matrix[slaveOffset+i] = 0;
263 // turn off the indicator led on no error
270 void matrix_slave_scan(void) {
273 int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
276 for (int i = 0; i < ROWS_PER_HAND; ++i) {
277 i2c_slave_buffer[i] = matrix[offset+i];
280 for (int i = 0; i < ROWS_PER_HAND; ++i) {
281 serial_slave_buffer[i] = matrix[offset+i];
284 #ifdef BACKLIGHT_ENABLE
285 // Read backlight level sent from master and update level on slave
286 backlight_set(serial_master_buffer[SERIAL_LED_ADDR]);
291 bool matrix_is_modified(void)
293 if (debouncing) return false;
298 bool matrix_is_on(uint8_t row, uint8_t col)
300 return (matrix[row] & ((matrix_row_t)1<<col));
304 matrix_row_t matrix_get_row(uint8_t row)
309 void matrix_print(void)
311 print("\nr/c 0123456789ABCDEF\n");
312 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
313 phex(row); print(": ");
314 pbin_reverse16(matrix_get_row(row));
319 uint8_t matrix_key_count(void)
322 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
323 count += bitpop16(matrix[i]);
328 #if (DIODE_DIRECTION == COL2ROW)
330 static void init_cols(void)
332 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
333 uint8_t pin = col_pins[x];
334 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
335 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
339 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
341 // Store last value of row prior to reading
342 matrix_row_t last_row_value = current_matrix[current_row];
344 // Clear data in matrix row
345 current_matrix[current_row] = 0;
347 // Select row and wait for row selecton to stabilize
348 select_row(current_row);
352 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
354 // Select the col pin to read (active low)
355 uint8_t pin = col_pins[col_index];
356 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
358 // Populate the matrix row with the state of the col pin
359 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
363 unselect_row(current_row);
365 return (last_row_value != current_matrix[current_row]);
368 static void select_row(uint8_t row)
370 uint8_t pin = row_pins[row];
371 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
372 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
375 static void unselect_row(uint8_t row)
377 uint8_t pin = row_pins[row];
378 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
379 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
382 static void unselect_rows(void)
384 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
385 uint8_t pin = row_pins[x];
386 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
387 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
391 #elif (DIODE_DIRECTION == ROW2COL)
393 static void init_rows(void)
395 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
396 uint8_t pin = row_pins[x];
397 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
398 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
402 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
404 bool matrix_changed = false;
406 // Select col and wait for col selecton to stabilize
407 select_col(current_col);
411 for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
414 // Store last value of row prior to reading
415 matrix_row_t last_row_value = current_matrix[row_index];
417 // Check row pin state
418 if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
420 // Pin LO, set col bit
421 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
425 // Pin HI, clear col bit
426 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
429 // Determine if the matrix changed state
430 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
432 matrix_changed = true;
437 unselect_col(current_col);
439 return matrix_changed;
442 static void select_col(uint8_t col)
444 uint8_t pin = col_pins[col];
445 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
446 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
449 static void unselect_col(uint8_t col)
451 uint8_t pin = col_pins[col];
452 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
453 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
456 static void unselect_cols(void)
458 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
459 uint8_t pin = col_pins[x];
460 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
461 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI