2 Copyright 2012 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/>.
29 #include "split_util.h"
30 #include "pro_micro.h"
33 #include "split_flags.h"
35 #ifdef RGBLIGHT_ENABLE
36 # include "rgblight.h"
38 #ifdef BACKLIGHT_ENABLE
39 # include "backlight.h"
40 extern backlight_config_t backlight_config;
43 #if defined(USE_I2C) || defined(EH)
49 #ifndef DEBOUNCING_DELAY
50 # define DEBOUNCING_DELAY 5
53 #if (DEBOUNCING_DELAY > 0)
54 static uint16_t debouncing_time;
55 static bool debouncing = false;
58 #if (MATRIX_COLS <= 8)
59 # define print_matrix_header() print("\nr/c 01234567\n")
60 # define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
61 # define matrix_bitpop(i) bitpop(matrix[i])
62 # define ROW_SHIFTER ((uint8_t)1)
64 # error "Currently only supports 8 COLS"
66 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
68 #define ERROR_DISCONNECT_COUNT 5
70 #define ROWS_PER_HAND (MATRIX_ROWS/2)
72 static uint8_t error_count = 0;
74 #if ((DIODE_DIRECTION == COL2ROW) || (DIODE_DIRECTION == ROW2COL))
75 static uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
76 static uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
77 #elif (DIODE_DIRECTION == CUSTOM_MATRIX)
78 static uint8_t row_col_pins[MATRIX_ROWS][MATRIX_COLS] = MATRIX_ROW_COL_PINS;
81 /* matrix state(1:on, 0:off) */
82 static matrix_row_t matrix[MATRIX_ROWS];
83 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
85 #if (DIODE_DIRECTION == COL2ROW)
86 static void init_cols(void);
87 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
88 static void unselect_rows(void);
89 static void select_row(uint8_t row);
90 static void unselect_row(uint8_t row);
91 #elif (DIODE_DIRECTION == ROW2COL)
92 static void init_rows(void);
93 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
94 static void unselect_cols(void);
95 static void unselect_col(uint8_t col);
96 static void select_col(uint8_t col);
97 #elif (DIODE_DIRECTION == CUSTOM_MATRIX)
98 static void init_cols_rows(void);
99 static bool read_cols(matrix_row_t current_matrix[], uint8_t current_row);
102 __attribute__ ((weak))
103 void matrix_init_kb(void) {
107 __attribute__ ((weak))
108 void matrix_scan_kb(void) {
112 __attribute__ ((weak))
113 void matrix_init_user(void) {
116 __attribute__ ((weak))
117 void matrix_scan_user(void) {
120 __attribute__ ((weak))
121 void matrix_slave_scan_user(void) {
125 uint8_t matrix_rows(void)
131 uint8_t matrix_cols(void)
136 void matrix_init(void)
139 // JTAG disable for PORT F. write JTD bit twice within four cycles.
148 // Set pinout for right half if pinout for that half is defined
150 #ifdef MATRIX_ROW_PINS_RIGHT
151 const uint8_t row_pins_right[MATRIX_ROWS] = MATRIX_ROW_PINS_RIGHT;
152 for (uint8_t i = 0; i < MATRIX_ROWS; i++)
153 row_pins[i] = row_pins_right[i];
155 #ifdef MATRIX_COL_PINS_RIGHT
156 const uint8_t col_pins_right[MATRIX_COLS] = MATRIX_COL_PINS_RIGHT;
157 for (uint8_t i = 0; i < MATRIX_COLS; i++)
158 col_pins[i] = col_pins_right[i];
162 // initialize row and col
163 #if (DIODE_DIRECTION == COL2ROW)
166 #elif (DIODE_DIRECTION == ROW2COL)
169 #elif (DIODE_DIRECTION == CUSTOM_MATRIX)
173 // initialize matrix state: all keys off
174 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
176 matrix_debouncing[i] = 0;
179 matrix_init_quantum();
183 uint8_t _matrix_scan(void)
185 int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
186 #if (DIODE_DIRECTION == COL2ROW)
187 // Set row, read cols
188 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
189 # if (DEBOUNCING_DELAY > 0)
190 bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
192 if (matrix_changed) {
194 debouncing_time = timer_read();
198 read_cols_on_row(matrix+offset, current_row);
203 #elif (DIODE_DIRECTION == ROW2COL)
204 // Set col, read rows
205 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
206 # if (DEBOUNCING_DELAY > 0)
207 bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
208 if (matrix_changed) {
210 debouncing_time = timer_read();
213 read_rows_on_col(matrix+offset, current_col);
218 #elif (DIODE_DIRECTION == CUSTOM_MATRIX)
219 // Set row, read cols
220 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
221 # if (DEBOUNCING_DELAY > 0)
222 bool matrix_changed = read_cols(matrix_debouncing+offset, current_row);
223 if (matrix_changed) {
225 debouncing_time = timer_read();
228 read_cols(matrix+offset, current_row);
233 # if (DEBOUNCING_DELAY > 0)
234 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
235 for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
236 matrix[i+offset] = matrix_debouncing[i+offset];
245 #if defined(USE_I2C) || defined(EH)
247 // Get rows from other half over i2c
248 int i2c_transaction(void) {
249 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
252 // write backlight info
253 #ifdef BACKLIGHT_ENABLE
255 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
256 if (err) goto i2c_error;
258 // Backlight location
259 err = i2c_master_write(I2C_BACKLIT_START);
260 if (err) goto i2c_error;
263 i2c_master_write(get_backlight_level());
265 BACKLIT_DIRTY = false;
269 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
270 if (err) goto i2c_error;
272 // start of matrix stored at I2C_KEYMAP_START
273 err = i2c_master_write(I2C_KEYMAP_START);
274 if (err) goto i2c_error;
277 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
278 if (err) goto i2c_error;
282 for (i = 0; i < ROWS_PER_HAND-1; ++i) {
283 matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
285 matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
288 i2c_error: // the cable is disconnceted, or something else went wrong
293 #ifdef RGBLIGHT_ENABLE
295 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
296 if (err) goto i2c_error;
299 err = i2c_master_write(I2C_RGB_START);
300 if (err) goto i2c_error;
302 uint32_t dword = eeconfig_read_rgblight();
305 err = i2c_master_write_data(&dword, 4);
306 if (err) goto i2c_error;
318 int serial_transaction(void) {
319 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
321 if (serial_update_buffers()) {
325 for (int i = 0; i < ROWS_PER_HAND; ++i) {
326 matrix[slaveOffset+i] = serial_slave_buffer[i];
329 #ifdef RGBLIGHT_ENABLE
330 // Code to send RGB over serial goes here (not implemented yet)
333 #ifdef BACKLIGHT_ENABLE
334 // Write backlight level for slave to read
335 serial_master_buffer[SERIAL_BACKLIT_START] = backlight_config.enable ? backlight_config.level : 0;
342 uint8_t matrix_scan(void)
344 uint8_t ret = _matrix_scan();
346 #if defined(USE_I2C) || defined(EH)
347 if( i2c_transaction() ) {
349 if( serial_transaction() ) {
354 if (error_count > ERROR_DISCONNECT_COUNT) {
355 // reset other half if disconnected
356 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
357 for (int i = 0; i < ROWS_PER_HAND; ++i) {
358 matrix[slaveOffset+i] = 0;
364 matrix_scan_quantum();
368 void matrix_slave_scan(void) {
371 int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
373 #if defined(USE_I2C) || defined(EH)
374 for (int i = 0; i < ROWS_PER_HAND; ++i) {
375 i2c_slave_buffer[I2C_KEYMAP_START+i] = matrix[offset+i];
378 for (int i = 0; i < ROWS_PER_HAND; ++i) {
379 serial_slave_buffer[i] = matrix[offset+i];
382 matrix_slave_scan_user();
385 bool matrix_is_modified(void)
387 if (debouncing) return false;
392 bool matrix_is_on(uint8_t row, uint8_t col)
394 return (matrix[row] & ((matrix_row_t)1<<col));
398 matrix_row_t matrix_get_row(uint8_t row)
403 void matrix_print(void)
405 print("\nr/c 0123456789ABCDEF\n");
406 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
407 phex(row); print(": ");
408 pbin_reverse16(matrix_get_row(row));
413 uint8_t matrix_key_count(void)
416 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
417 count += bitpop16(matrix[i]);
422 #if (DIODE_DIRECTION == COL2ROW)
424 static void init_cols(void)
426 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
427 uint8_t pin = col_pins[x];
428 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
429 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
433 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
435 // Store last value of row prior to reading
436 matrix_row_t last_row_value = current_matrix[current_row];
438 // Clear data in matrix row
439 current_matrix[current_row] = 0;
441 // Select row and wait for row selecton to stabilize
442 select_row(current_row);
446 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
448 // Select the col pin to read (active low)
449 uint8_t pin = col_pins[col_index];
450 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
452 // Populate the matrix row with the state of the col pin
453 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
457 unselect_row(current_row);
459 return (last_row_value != current_matrix[current_row]);
462 static void select_row(uint8_t row)
464 uint8_t pin = row_pins[row];
465 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
466 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
469 static void unselect_row(uint8_t row)
471 uint8_t pin = row_pins[row];
472 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
473 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
476 static void unselect_rows(void)
478 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
479 uint8_t pin = row_pins[x];
480 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
481 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
485 #elif (DIODE_DIRECTION == ROW2COL)
487 static void init_rows(void)
489 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
490 uint8_t pin = row_pins[x];
491 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
492 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
496 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
498 bool matrix_changed = false;
500 // Select col and wait for col selecton to stabilize
501 select_col(current_col);
505 for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
508 // Store last value of row prior to reading
509 matrix_row_t last_row_value = current_matrix[row_index];
511 // Check row pin state
512 if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
514 // Pin LO, set col bit
515 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
519 // Pin HI, clear col bit
520 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
523 // Determine if the matrix changed state
524 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
526 matrix_changed = true;
531 unselect_col(current_col);
533 return matrix_changed;
536 static void select_col(uint8_t col)
538 uint8_t pin = col_pins[col];
539 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
540 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
543 static void unselect_col(uint8_t col)
545 uint8_t pin = col_pins[col];
546 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
547 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
550 static void unselect_cols(void)
552 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
553 uint8_t pin = col_pins[x];
554 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
555 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
559 #elif (DIODE_DIRECTION == CUSTOM_MATRIX)
561 static void init_cols_rows(void)
563 for(int row = 0; row < MATRIX_ROWS; row++) {
564 for(int col = 0; col < MATRIX_COLS; col++) {
565 uint8_t pin = row_col_pins[row][col];
569 // DDxn set 0 for input
570 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF);
571 // PORTxn set 1 for input/pullup
572 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF);
577 static bool read_cols(matrix_row_t current_matrix[], uint8_t current_row)
579 matrix_row_t last_row_value = current_matrix[current_row];
580 current_matrix[current_row] = 0;
582 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
583 uint8_t pin = row_col_pins[current_row][col_index];
585 current_matrix[current_row] |= 0;
588 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
589 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
593 return (last_row_value != current_matrix[current_row]);