2 Copyright 2012 Jun Wako
3 Copyright 2014 Jack Humbert
4 Copyright 2017 Priyadi Iman Nurcahyo
6 This program is free software: you can redistribute it and/or modify
7 it under the terms of the GNU General Public License as published by
8 the Free Software Foundation, either version 2 of the License, or
9 (at your option) any later version.
11 This program is distributed in the hope that it will be useful,
12 but WITHOUT ANY WARRANTY; without even the implied warranty of
13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 GNU General Public License for more details.
16 You should have received a copy of the GNU General Public License
17 along with this program. If not, see <http://www.gnu.org/licenses/>.
32 /* Set 0 if debouncing isn't needed */
34 #ifndef DEBOUNCING_DELAY
35 # define DEBOUNCING_DELAY 5
38 #if (DEBOUNCING_DELAY > 0)
39 static uint16_t debouncing_time;
40 static bool debouncing = false;
43 #if (MATRIX_COLS <= 8)
44 # define print_matrix_header() print("\nr/c 01234567\n")
45 # define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
46 # define matrix_bitpop(i) bitpop(matrix[i])
47 # define ROW_SHIFTER ((uint8_t)1)
48 #elif (MATRIX_COLS <= 16)
49 # define print_matrix_header() print("\nr/c 0123456789ABCDEF\n")
50 # define print_matrix_row(row) print_bin_reverse16(matrix_get_row(row))
51 # define matrix_bitpop(i) bitpop16(matrix[i])
52 # define ROW_SHIFTER ((uint16_t)1)
53 #elif (MATRIX_COLS <= 32)
54 # define print_matrix_header() print("\nr/c 0123456789ABCDEF0123456789ABCDEF\n")
55 # define print_matrix_row(row) print_bin_reverse32(matrix_get_row(row))
56 # define matrix_bitpop(i) bitpop32(matrix[i])
57 # define ROW_SHIFTER ((uint32_t)1)
61 extern const matrix_row_t matrix_mask[];
64 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
65 static const uint8_t tp_pins[3] = TRACKPOINT_PINS;
67 /* matrix state(1:on, 0:off) */
68 static matrix_row_t matrix[MATRIX_ROWS];
69 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
71 static void init_cols(void);
72 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
73 static void unselect_rows(void);
74 static void select_row(uint8_t row);
75 static void unselect_row(uint8_t row);
77 __attribute__ ((weak))
78 void matrix_init_quantum(void) {
82 __attribute__ ((weak))
83 void matrix_scan_quantum(void) {
87 __attribute__ ((weak))
88 void matrix_init_kb(void) {
92 __attribute__ ((weak))
93 void matrix_scan_kb(void) {
97 __attribute__ ((weak))
98 void matrix_init_user(void) {
101 __attribute__ ((weak))
102 void matrix_scan_user(void) {
106 uint8_t matrix_rows(void) {
111 uint8_t matrix_cols(void) {
115 void matrix_init(void) {
117 // To use PORTF disable JTAG with writing JTD bit twice within four cycles.
118 #if (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega32U4__))
123 // initialize row and col
127 // initialize matrix state: all keys off
128 for (uint8_t i=0; i < MATRIX_ROWS; i++) {
130 matrix_debouncing[i] = 0;
133 matrix_init_quantum();
136 uint8_t matrix_scan(void)
138 // Set row, read cols
139 for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
140 # if (DEBOUNCING_DELAY > 0)
141 bool matrix_changed = read_cols_on_row(matrix_debouncing, current_row);
143 if (matrix_changed) {
145 debouncing_time = timer_read();
149 read_cols_on_row(matrix, current_row);
154 # if (DEBOUNCING_DELAY > 0)
155 if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
156 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
157 matrix[i] = matrix_debouncing[i];
163 matrix_scan_quantum();
167 bool matrix_is_modified(void)
169 #if (DEBOUNCING_DELAY > 0)
170 if (debouncing) return false;
176 bool matrix_is_on(uint8_t row, uint8_t col)
179 return (matrix[row] & ((matrix_row_t)1<col));
183 matrix_row_t matrix_get_row(uint8_t row)
185 // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
186 // switch blocker installed and the switch is always pressed.
188 return matrix[row] & matrix_mask[row];
194 void matrix_print(void)
196 print_matrix_header();
198 for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
199 phex(row); print(": ");
200 print_matrix_row(row);
205 uint8_t matrix_key_count(void)
208 for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
209 count += matrix_bitpop(i);
215 #define ROW_MASK 0b11100000
217 static const uint8_t row_bit[MATRIX_ROWS] = {
229 static void init_cols(void)
232 for(uint8_t x = 0; x < MATRIX_COLS; x++) {
233 uint8_t pin = col_pins[x];
234 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
235 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
243 for(uint8_t x = 0; x < 3; x++) {
244 uint8_t pin = tp_pins[x];
245 _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
246 _SFR_IO8((pin >> 4) + 2) |= _BV(pin & 0xF); // HI
250 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
252 // Store last value of row prior to reading
253 matrix_row_t last_row_value = current_matrix[current_row];
255 // Clear data in matrix row
256 current_matrix[current_row] = 0;
258 // special case for trackpoint
259 if (current_row == 8) {
260 for(uint8_t tp_index = 0; tp_index < 3; tp_index++) {
262 // Select the TP pin to read (active low)
263 uint8_t pin = tp_pins[tp_index];
264 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
266 // Populate the matrix row with the state of the col pin
267 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << tp_index);
269 return (last_row_value != current_matrix[current_row]);
272 // Select row and wait for row selecton to stabilize
273 select_row(current_row);
274 _delay_us(5); // without this wait it won't read stable value.
278 for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
280 // Select the col pin to read (active low)
281 uint8_t pin = col_pins[col_index];
282 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
284 // Populate the matrix row with the state of the col pin
285 current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
289 unselect_row(current_row);
291 return (last_row_value != current_matrix[current_row]);
294 static void select_row(uint8_t row)
296 PORTF = row_bit[row] | (PORTF & ~ROW_MASK);
299 static void unselect_row(uint8_t row)
303 static void unselect_rows(void)