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[];
49 static pin_t direct_pins[MATRIX_ROWS][MATRIX_COLS] = DIRECT_PINS;
50 #elif (DIODE_DIRECTION == ROW2COL) || (DIODE_DIRECTION == COL2ROW)
51 static const pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
52 static const pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
55 /* matrix state(1:on, 0:off) */
56 static matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values
57 static matrix_row_t matrix[MATRIX_ROWS]; // debounced values
59 __attribute__((weak)) void matrix_init_quantum(void) { matrix_init_kb(); }
61 __attribute__((weak)) void matrix_scan_quantum(void) { matrix_scan_kb(); }
63 __attribute__((weak)) void matrix_init_kb(void) { matrix_init_user(); }
65 __attribute__((weak)) void matrix_scan_kb(void) { matrix_scan_user(); }
67 __attribute__((weak)) void matrix_init_user(void) {}
69 __attribute__((weak)) void matrix_scan_user(void) {}
71 inline uint8_t matrix_rows(void) { return MATRIX_ROWS; }
73 inline uint8_t matrix_cols(void) { return MATRIX_COLS; }
76 bool matrix_is_modified(void) {
77 if (debounce_active()) return false;
81 inline bool matrix_is_on(uint8_t row, uint8_t col) { return (matrix[row] & ((matrix_row_t)1 << col)); }
83 inline matrix_row_t matrix_get_row(uint8_t row) {
84 // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
85 // switch blocker installed and the switch is always pressed.
87 return matrix[row] & matrix_mask[row];
93 void matrix_print(void) {
94 print_matrix_header();
96 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
99 print_matrix_row(row);
104 uint8_t matrix_key_count(void) {
106 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
107 count += matrix_bitpop(i);
114 static void init_pins(void) {
115 for (int row = 0; row < MATRIX_ROWS; row++) {
116 for (int col = 0; col < MATRIX_COLS; col++) {
117 pin_t pin = direct_pins[row][col];
119 setPinInputHigh(pin);
125 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
126 matrix_row_t last_row_value = current_matrix[current_row];
127 current_matrix[current_row] = 0;
129 for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
130 pin_t pin = direct_pins[current_row][col_index];
132 current_matrix[current_row] |= readPin(pin) ? 0 : (ROW_SHIFTER << col_index);
136 return (last_row_value != current_matrix[current_row]);
139 #elif (DIODE_DIRECTION == COL2ROW)
141 static void select_row(uint8_t row) {
142 setPinOutput(row_pins[row]);
143 writePinLow(row_pins[row]);
146 static void unselect_row(uint8_t row) { setPinInputHigh(row_pins[row]); }
148 static void unselect_rows(void) {
149 for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
150 setPinInputHigh(row_pins[x]);
154 static void init_pins(void) {
156 for (uint8_t x = 0; x < MATRIX_COLS; x++) {
157 setPinInputHigh(col_pins[x]);
161 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
162 // Store last value of row prior to reading
163 matrix_row_t last_row_value = current_matrix[current_row];
165 // Clear data in matrix row
166 current_matrix[current_row] = 0;
168 // Select row and wait for row selecton to stabilize
169 select_row(current_row);
173 for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
174 // Select the col pin to read (active low)
175 uint8_t pin_state = readPin(col_pins[col_index]);
177 // Populate the matrix row with the state of the col pin
178 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
182 unselect_row(current_row);
184 return (last_row_value != current_matrix[current_row]);
187 #elif (DIODE_DIRECTION == ROW2COL)
189 static void select_col(uint8_t col) {
190 setPinOutput(col_pins[col]);
191 writePinLow(col_pins[col]);
194 static void unselect_col(uint8_t col) { setPinInputHigh(col_pins[col]); }
196 static void unselect_cols(void) {
197 for (uint8_t x = 0; x < MATRIX_COLS; x++) {
198 setPinInputHigh(col_pins[x]);
202 static void init_pins(void) {
204 for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
205 setPinInputHigh(row_pins[x]);
209 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col) {
210 bool matrix_changed = false;
212 // Select col and wait for col selecton to stabilize
213 select_col(current_col);
217 for (uint8_t row_index = 0; row_index < MATRIX_ROWS; row_index++) {
218 // Store last value of row prior to reading
219 matrix_row_t last_row_value = current_matrix[row_index];
221 // Check row pin state
222 if (readPin(row_pins[row_index]) == 0) {
223 // Pin LO, set col bit
224 current_matrix[row_index] |= (ROW_SHIFTER << current_col);
226 // Pin HI, clear col bit
227 current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
230 // Determine if the matrix changed state
231 if ((last_row_value != current_matrix[row_index]) && !(matrix_changed)) {
232 matrix_changed = true;
237 unselect_col(current_col);
239 return matrix_changed;
244 void matrix_init(void) {
245 // initialize key pins
248 // initialize matrix state: all keys off
249 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
254 debounce_init(MATRIX_ROWS);
256 matrix_init_quantum();
259 uint8_t matrix_scan(void) {
260 bool changed = false;
262 #if defined(DIRECT_PINS) || (DIODE_DIRECTION == COL2ROW)
263 // Set row, read cols
264 for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
265 changed |= read_cols_on_row(raw_matrix, current_row);
267 #elif (DIODE_DIRECTION == ROW2COL)
268 // Set col, read rows
269 for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
270 changed |= read_rows_on_col(raw_matrix, current_col);
274 debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
276 matrix_scan_quantum();
277 return (uint8_t)changed;