2 Copyright 2012-2018 Jun Wako, Jack Humbert, Yiancar
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/>.
27 #if (MATRIX_COLS <= 8)
28 # define print_matrix_header() print("\nr/c 01234567\n")
29 # define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
30 # define matrix_bitpop(i) bitpop(matrix[i])
31 # define ROW_SHIFTER ((uint8_t)1)
32 #elif (MATRIX_COLS <= 16)
33 # define print_matrix_header() print("\nr/c 0123456789ABCDEF\n")
34 # define print_matrix_row(row) print_bin_reverse16(matrix_get_row(row))
35 # define matrix_bitpop(i) bitpop16(matrix[i])
36 # define ROW_SHIFTER ((uint16_t)1)
37 #elif (MATRIX_COLS <= 32)
38 # define print_matrix_header() print("\nr/c 0123456789ABCDEF0123456789ABCDEF\n")
39 # define print_matrix_row(row) print_bin_reverse32(matrix_get_row(row))
40 # define matrix_bitpop(i) bitpop32(matrix[i])
41 # define ROW_SHIFTER ((uint32_t)1)
45 extern const matrix_row_t matrix_mask[];
48 static const pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
49 static const pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
51 /* matrix state(1:on, 0:off) */
52 static matrix_row_t raw_matrix[MATRIX_ROWS]; //raw values
53 static matrix_row_t matrix[MATRIX_ROWS]; //debounced values
55 __attribute__ ((weak))
56 void matrix_init_quantum(void) {
60 __attribute__ ((weak))
61 void matrix_scan_quantum(void) {
65 __attribute__ ((weak))
66 void matrix_init_kb(void) {
70 __attribute__ ((weak))
71 void matrix_scan_kb(void) {
75 __attribute__ ((weak))
76 void matrix_init_user(void) {
79 __attribute__ ((weak))
80 void matrix_scan_user(void) {
84 uint8_t matrix_rows(void) {
89 uint8_t matrix_cols(void) {
94 bool matrix_is_modified(void)
96 if (debounce_active()) return false;
101 bool matrix_is_on(uint8_t row, uint8_t col)
103 return (matrix[row] & ((matrix_row_t)1<<col));
107 matrix_row_t matrix_get_row(uint8_t row)
109 // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
110 // switch blocker installed and the switch is always pressed.
112 return matrix[row] & matrix_mask[row];
118 void matrix_print(void)
120 print_matrix_header();
122 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
123 phex(row); print(": ");
124 print_matrix_row(row);
129 uint8_t matrix_key_count(void)
132 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
133 count += matrix_bitpop(i);
138 static void select_row(uint8_t row)
140 setPinOutput(row_pins[row]);
141 writePinLow(row_pins[row]);
144 static void unselect_row(uint8_t row)
146 setPinInputHigh(row_pins[row]);
149 static void unselect_rows(void)
151 for(uint8_t x = 0; x < MATRIX_ROWS; x++) {
152 setPinInputHigh(row_pins[x]);
156 static void select_col(uint8_t col)
158 setPinOutput(col_pins[col]);
159 writePinLow(col_pins[col]);
162 static void unselect_col(uint8_t col)
164 setPinInputHigh(col_pins[col]);
167 static void unselect_cols(void)
169 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
170 setPinInputHigh(col_pins[x]);
174 static void init_pins(void) {
177 for (uint8_t x = 0; x < MATRIX_COLS; x++) {
178 setPinInputHigh(col_pins[x]);
180 for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
181 setPinInputHigh(row_pins[x]);
185 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
187 // Store last value of row prior to reading
188 matrix_row_t last_row_value = current_matrix[current_row];
190 // Clear data in matrix row
191 current_matrix[current_row] = 0;
193 // Select row and wait for row selecton to stabilize
194 select_row(current_row);
198 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
200 // Select the col pin to read (active low)
201 uint8_t pin_state = readPin(col_pins[col_index]);
203 // Populate the matrix row with the state of the col pin
204 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
208 unselect_row(current_row);
210 return (last_row_value != current_matrix[current_row]);
213 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
215 bool matrix_changed = false;
217 // Select col and wait for col selecton to stabilize
218 select_col(current_col);
222 for(uint8_t row_index = 0; row_index < MATRIX_ROWS/2; row_index++)
224 uint8_t tmp = row_index + MATRIX_ROWS/2;
225 // Store last value of row prior to reading
226 matrix_row_t last_row_value = current_matrix[tmp];
228 // Check row pin state
229 if (readPin(row_pins[row_index]) == 0)
231 // Pin LO, set col bit
232 current_matrix[tmp] |= (ROW_SHIFTER << current_col);
236 // Pin HI, clear col bit
237 current_matrix[tmp] &= ~(ROW_SHIFTER << current_col);
240 // Determine if the matrix changed state
241 if ((last_row_value != current_matrix[tmp]) && !(matrix_changed))
243 matrix_changed = true;
248 unselect_col(current_col);
250 return matrix_changed;
253 void matrix_init(void) {
255 // initialize key pins
258 // initialize matrix state: all keys off
259 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
264 debounce_init(MATRIX_ROWS);
266 matrix_init_quantum();
269 uint8_t matrix_scan(void)
271 bool changed = false;
273 // Set row, read cols
274 for (uint8_t current_row = 0; current_row < MATRIX_ROWS / 2; current_row++) {
275 changed |= read_cols_on_row(raw_matrix, current_row);
278 // Set col, read rows
279 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
280 changed |= read_rows_on_col(raw_matrix, current_col);
283 debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
285 matrix_scan_quantum();
286 return (uint8_t)changed;