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 "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;
136 matrix_init_quantum();
140 uint8_t _matrix_scan(void)
142 int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
143 #if (DIODE_DIRECTION == COL2ROW)
144 // Set row, read cols
145 for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
146 # if (DEBOUNCING_DELAY > 0)
147 bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
149 if (matrix_changed) {
151 debouncing_time = timer_read();
156 read_cols_on_row(matrix+offset, current_row);
161 #elif (DIODE_DIRECTION == ROW2COL)
162 // Set col, read rows
163 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
164 # if (DEBOUNCING_DELAY > 0)
165 bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
166 if (matrix_changed) {
168 debouncing_time = timer_read();
171 read_rows_on_col(matrix+offset, current_col);
177 # if (DEBOUNCING_DELAY > 0)
178 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
179 for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
180 matrix[i+offset] = matrix_debouncing[i+offset];
191 // Get rows from other half over i2c
192 int i2c_transaction(void) {
193 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
195 int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
196 if (err) goto i2c_error;
198 // start of matrix stored at 0x00
199 err = i2c_master_write(0x00);
200 if (err) goto i2c_error;
203 err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
204 if (err) goto i2c_error;
208 for (i = 0; i < ROWS_PER_HAND-1; ++i) {
209 matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
211 matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
214 i2c_error: // the cable is disconnceted, or something else went wrong
224 int serial_transaction(void) {
225 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
227 if (serial_update_buffers()) {
231 for (int i = 0; i < ROWS_PER_HAND; ++i) {
232 matrix[slaveOffset+i] = serial_slave_buffer[i];
235 #ifdef BACKLIGHT_ENABLE
236 // Write backlight level for slave to read
237 serial_master_buffer[SERIAL_LED_ADDR] = get_backlight_level();
243 uint8_t matrix_scan(void)
245 uint8_t ret = _matrix_scan();
248 if( i2c_transaction() ) {
250 if( serial_transaction() ) {
252 // turn on the indicator led when halves are disconnected
257 if (error_count > ERROR_DISCONNECT_COUNT) {
258 // reset other half if disconnected
259 int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
260 for (int i = 0; i < ROWS_PER_HAND; ++i) {
261 matrix[slaveOffset+i] = 0;
265 // turn off the indicator led on no error
269 matrix_scan_quantum();
273 void matrix_slave_scan(void) {
276 int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
279 for (int i = 0; i < ROWS_PER_HAND; ++i) {
280 i2c_slave_buffer[i] = matrix[offset+i];
283 for (int i = 0; i < ROWS_PER_HAND; ++i) {
284 serial_slave_buffer[i] = matrix[offset+i];
287 #ifdef BACKLIGHT_ENABLE
288 // Read backlight level sent from master and update level on slave
289 backlight_set(serial_master_buffer[SERIAL_LED_ADDR]);
294 bool matrix_is_modified(void)
296 if (debouncing) return false;
301 bool matrix_is_on(uint8_t row, uint8_t col)
303 return (matrix[row] & ((matrix_row_t)1<<col));
307 matrix_row_t matrix_get_row(uint8_t row)
312 void matrix_print(void)
314 print("\nr/c 0123456789ABCDEF\n");
315 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
316 phex(row); print(": ");
317 pbin_reverse16(matrix_get_row(row));
322 uint8_t matrix_key_count(void)
325 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
326 count += bitpop16(matrix[i]);
331 #if (DIODE_DIRECTION == COL2ROW)
333 static void init_cols(void)
335 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
336 uint8_t pin = col_pins[x];
337 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
338 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
342 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
344 // Store last value of row prior to reading
345 matrix_row_t last_row_value = current_matrix[current_row];
347 // Clear data in matrix row
348 current_matrix[current_row] = 0;
350 // Select row and wait for row selecton to stabilize
351 select_row(current_row);
355 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
357 // Select the col pin to read (active low)
358 uint8_t pin = col_pins[col_index];
359 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
361 // Populate the matrix row with the state of the col pin
362 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
366 unselect_row(current_row);
368 return (last_row_value != current_matrix[current_row]);
371 static void select_row(uint8_t row)
373 uint8_t pin = row_pins[row];
374 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
375 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
378 static void unselect_row(uint8_t row)
380 uint8_t pin = row_pins[row];
381 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
382 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
385 static void unselect_rows(void)
387 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
388 uint8_t pin = row_pins[x];
389 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
390 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
394 #elif (DIODE_DIRECTION == ROW2COL)
396 static void init_rows(void)
398 for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
399 uint8_t pin = row_pins[x];
400 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
401 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
405 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
407 bool matrix_changed = false;
409 // Select col and wait for col selecton to stabilize
410 select_col(current_col);
414 for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
417 // Store last value of row prior to reading
418 matrix_row_t last_row_value = current_matrix[row_index];
420 // Check row pin state
421 if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
423 // Pin LO, set col bit
424 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
428 // Pin HI, clear col bit
429 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
432 // Determine if the matrix changed state
433 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
435 matrix_changed = true;
440 unselect_col(current_col);
442 return matrix_changed;
445 static void select_col(uint8_t col)
447 uint8_t pin = col_pins[col];
448 _SFR_IO8((pin >> 4) + 1) |= _BV(pin & 0xF); // OUT
449 _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
452 static void unselect_col(uint8_t col)
454 uint8_t pin = col_pins[col];
455 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
456 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
459 static void unselect_cols(void)
461 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
462 uint8_t pin = col_pins[x];
463 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
464 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI