]> git.donarmstrong.com Git - qmk_firmware.git/blob - keyboards/deltasplit75/matrix.c
Redox: move curly brackets one row down. (#4364)
[qmk_firmware.git] / keyboards / deltasplit75 / matrix.c
1 /*
2 Copyright 2012 Jun Wako <wakojun@gmail.com>
3
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.
8
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.
13
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/>.
16 */
17
18 /*
19  * scan matrix
20  */
21 #include <stdint.h>
22 #include <stdbool.h>
23 #include <avr/io.h>
24 #include "wait.h"
25 #include "print.h"
26 #include "debug.h"
27 #include "util.h"
28 #include "matrix.h"
29 #include "split_util.h"
30 #include "pro_micro.h"
31 #include "config.h"
32 #include "timer.h"
33
34 #ifdef USE_I2C
35 #  include "i2c.h"
36 #else // USE_SERIAL
37 #  include "serial.h"
38 #endif
39
40 #ifndef DEBOUNCING_DELAY
41 #   define DEBOUNCING_DELAY 5
42 #endif
43
44 #if (DEBOUNCING_DELAY > 0)
45     static uint16_t debouncing_time;
46     static bool debouncing = false;
47 #endif
48
49 #if (MATRIX_COLS <= 8)
50 #    define print_matrix_header()  print("\nr/c 01234567\n")
51 #    define print_matrix_row(row)  print_bin_reverse8(matrix_get_row(row))
52 #    define matrix_bitpop(i)       bitpop(matrix[i])
53 #    define ROW_SHIFTER ((uint8_t)1)
54 #else
55 #    error "Currently only supports 8 COLS"
56 #endif
57 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
58
59 #define ERROR_DISCONNECT_COUNT 5
60
61 #define ROWS_PER_HAND (MATRIX_ROWS/2)
62
63 static uint8_t error_count = 0;
64
65 static const uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
66 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
67
68 /* matrix state(1:on, 0:off) */
69 static matrix_row_t matrix[MATRIX_ROWS];
70 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
71
72 #if (DIODE_DIRECTION == COL2ROW)
73     static void init_cols(void);
74     static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
75     static void unselect_rows(void);
76     static void select_row(uint8_t row);
77     static void unselect_row(uint8_t row);
78 #elif (DIODE_DIRECTION == ROW2COL)
79     static void init_rows(void);
80     static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
81     static void unselect_cols(void);
82     static void unselect_col(uint8_t col);
83     static void select_col(uint8_t col);
84 #endif
85
86 __attribute__ ((weak))
87 void matrix_init_kb(void) {
88     matrix_init_user();
89 }
90
91 __attribute__ ((weak))
92 void matrix_scan_kb(void) {
93     matrix_scan_user();
94 }
95
96 __attribute__ ((weak))
97 void matrix_init_user(void) {
98 }
99
100 __attribute__ ((weak))
101 void matrix_scan_user(void) {
102 }
103
104 inline
105 uint8_t matrix_rows(void)
106 {
107     return MATRIX_ROWS;
108 }
109
110 inline
111 uint8_t matrix_cols(void)
112 {
113     return MATRIX_COLS;
114 }
115
116 void matrix_init(void)
117 {
118     debug_enable = true;
119     debug_matrix = true;
120     debug_mouse = true;
121     // initialize row and col
122     unselect_rows();
123     init_cols();
124
125     TX_RX_LED_INIT;
126
127     // initialize matrix state: all keys off
128     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
129         matrix[i] = 0;
130         matrix_debouncing[i] = 0;
131     }
132
133     matrix_init_quantum();
134
135 }
136
137 uint8_t _matrix_scan(void)
138 {
139     int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
140 #if (DIODE_DIRECTION == COL2ROW)
141     // Set row, read cols
142     for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
143 #       if (DEBOUNCING_DELAY > 0)
144             bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
145
146             if (matrix_changed) {
147                 debouncing = true;
148                 debouncing_time = timer_read();
149             }
150
151 #       else
152             read_cols_on_row(matrix+offset, current_row);
153 #       endif
154
155     }
156
157 #elif (DIODE_DIRECTION == ROW2COL)
158     // Set col, read rows
159     for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
160 #       if (DEBOUNCING_DELAY > 0)
161             bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
162             if (matrix_changed) {
163                 debouncing = true;
164                 debouncing_time = timer_read();
165             }
166 #       else
167              read_rows_on_col(matrix+offset, current_col);
168 #       endif
169
170     }
171 #endif
172
173 #   if (DEBOUNCING_DELAY > 0)
174         if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
175             for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
176                 matrix[i+offset] = matrix_debouncing[i+offset];
177             }
178             debouncing = false;
179         }
180 #   endif
181
182     return 1;
183 }
184
185 #ifdef USE_I2C
186
187 // Get rows from other half over i2c
188 int i2c_transaction(void) {
189     int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
190
191     int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
192     if (err) goto i2c_error;
193
194     // start of matrix stored at 0x00
195     err = i2c_master_write(0x00);
196     if (err) goto i2c_error;
197
198     // Start read
199     err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
200     if (err) goto i2c_error;
201
202     if (!err) {
203         int i;
204         for (i = 0; i < ROWS_PER_HAND-1; ++i) {
205             matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
206         }
207         matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
208         i2c_master_stop();
209     } else {
210 i2c_error: // the cable is disconnceted, or something else went wrong
211         i2c_reset_state();
212         return err;
213     }
214
215     return 0;
216 }
217
218 #else // USE_SERIAL
219
220 int serial_transaction(void) {
221     int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
222
223     if (serial_update_buffers()) {
224         return 1;
225     }
226
227     for (int i = 0; i < ROWS_PER_HAND; ++i) {
228         matrix[slaveOffset+i] = serial_slave_buffer[i];
229     }
230     return 0;
231 }
232 #endif
233
234 uint8_t matrix_scan(void)
235 {
236     uint8_t ret = _matrix_scan();
237
238 #ifdef USE_I2C
239     if( i2c_transaction() ) {
240 #else // USE_SERIAL
241     if( serial_transaction() ) {
242 #endif
243         // turn on the indicator led when halves are disconnected
244         TXLED1;
245
246         error_count++;
247
248         if (error_count > ERROR_DISCONNECT_COUNT) {
249             // reset other half if disconnected
250             int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
251             for (int i = 0; i < ROWS_PER_HAND; ++i) {
252                 matrix[slaveOffset+i] = 0;
253             }
254         }
255     } else {
256         // turn off the indicator led on no error
257         TXLED0;
258         error_count = 0;
259     }
260     matrix_scan_quantum();
261     return ret;
262 }
263
264 void matrix_slave_scan(void) {
265     _matrix_scan();
266
267     int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
268
269 #ifdef USE_I2C
270     for (int i = 0; i < ROWS_PER_HAND; ++i) {
271         i2c_slave_buffer[i] = matrix[offset+i];
272     }
273 #else // USE_SERIAL
274     for (int i = 0; i < ROWS_PER_HAND; ++i) {
275         serial_slave_buffer[i] = matrix[offset+i];
276     }
277 #endif
278 }
279
280 bool matrix_is_modified(void)
281 {
282     if (debouncing) return false;
283     return true;
284 }
285
286 inline
287 bool matrix_is_on(uint8_t row, uint8_t col)
288 {
289     return (matrix[row] & ((matrix_row_t)1<<col));
290 }
291
292 inline
293 matrix_row_t matrix_get_row(uint8_t row)
294 {
295     return matrix[row];
296 }
297
298 void matrix_print(void)
299 {
300     print("\nr/c 0123456789ABCDEF\n");
301     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
302         phex(row); print(": ");
303         pbin_reverse16(matrix_get_row(row));
304         print("\n");
305     }
306 }
307
308 uint8_t matrix_key_count(void)
309 {
310     uint8_t count = 0;
311     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
312         count += bitpop16(matrix[i]);
313     }
314     return count;
315 }
316
317 #if (DIODE_DIRECTION == COL2ROW)
318
319 static void init_cols(void)
320 {
321     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
322         uint8_t pin = col_pins[x];
323         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
324         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
325     }
326 }
327
328 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
329 {
330     // Store last value of row prior to reading
331     matrix_row_t last_row_value = current_matrix[current_row];
332
333     // Clear data in matrix row
334     current_matrix[current_row] = 0;
335
336     // Select row and wait for row selecton to stabilize
337     select_row(current_row);
338     wait_us(30);
339
340     // For each col...
341     for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
342
343         // Select the col pin to read (active low)
344         uint8_t pin = col_pins[col_index];
345         uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
346
347         // Populate the matrix row with the state of the col pin
348         current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
349     }
350
351     // Unselect row
352     unselect_row(current_row);
353
354     return (last_row_value != current_matrix[current_row]);
355 }
356
357 static void select_row(uint8_t row)
358 {
359     uint8_t pin = row_pins[row];
360     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
361     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
362 }
363
364 static void unselect_row(uint8_t row)
365 {
366     uint8_t pin = row_pins[row];
367     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
368     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
369 }
370
371 static void unselect_rows(void)
372 {
373     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
374         uint8_t pin = row_pins[x];
375         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
376         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
377     }
378 }
379
380 #elif (DIODE_DIRECTION == ROW2COL)
381
382 static void init_rows(void)
383 {
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
388     }
389 }
390
391 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
392 {
393     bool matrix_changed = false;
394
395     // Select col and wait for col selecton to stabilize
396     select_col(current_col);
397     wait_us(30);
398
399     // For each row...
400     for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
401     {
402
403         // Store last value of row prior to reading
404         matrix_row_t last_row_value = current_matrix[row_index];
405
406         // Check row pin state
407         if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
408         {
409             // Pin LO, set col bit
410             current_matrix[row_index] |= (ROW_SHIFTER << current_col);
411         }
412         else
413         {
414             // Pin HI, clear col bit
415             current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
416         }
417
418         // Determine if the matrix changed state
419         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
420         {
421             matrix_changed = true;
422         }
423     }
424
425     // Unselect col
426     unselect_col(current_col);
427
428     return matrix_changed;
429 }
430
431 static void select_col(uint8_t col)
432 {
433     uint8_t pin = col_pins[col];
434     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
435     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
436 }
437
438 static void unselect_col(uint8_t col)
439 {
440     uint8_t pin = col_pins[col];
441     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
442     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
443 }
444
445 static void unselect_cols(void)
446 {
447     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
448         uint8_t pin = col_pins[x];
449         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
450         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
451     }
452 }
453
454 #endif