qmk_firmware

matrix.c (6456B)

---

 /*
 Copyright 2012-2018 Jun Wako, Jack Humbert, Yiancar
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation, either version 2 of the License, or
 (at your option) any later version.
 
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
 
 You should have received a copy of the GNU General Public License
 along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
 #include "wait.h"
 #include "print.h"
 #include "debug.h"
 #include "util.h"
 #include "matrix.h"
 #include "debounce.h"
 
 #if (MATRIX_COLS <= 8)
 #    define print_matrix_header() print("\nr/c 01234567\n")
 #    define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
 #    define ROW_SHIFTER ((uint8_t)1)
 #elif (MATRIX_COLS <= 16)
 #    define print_matrix_header() print("\nr/c 0123456789ABCDEF\n")
 #    define print_matrix_row(row) print_bin_reverse16(matrix_get_row(row))
 #    define ROW_SHIFTER ((uint16_t)1)
 #elif (MATRIX_COLS <= 32)
 #    define print_matrix_header() print("\nr/c 0123456789ABCDEF0123456789ABCDEF\n")
 #    define print_matrix_row(row) print_bin_reverse32(matrix_get_row(row))
 #    define ROW_SHIFTER ((uint32_t)1)
 #endif
 
 #ifdef MATRIX_MASKED
 extern const matrix_row_t matrix_mask[];
 #endif
 
 static const pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
 static const pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
 
 /* matrix state(1:on, 0:off) */
 static matrix_row_t raw_matrix[MATRIX_ROWS]; // raw values
 static matrix_row_t matrix[MATRIX_ROWS];     // debounced values
 
 __attribute__((weak)) void matrix_init_kb(void) {
     matrix_init_user();
 }
 
 __attribute__((weak)) void matrix_scan_kb(void) {
     matrix_scan_user();
 }
 
 __attribute__((weak)) void matrix_init_user(void) {}
 
 __attribute__((weak)) void matrix_scan_user(void) {}
 
 inline uint8_t matrix_rows(void) {
     return MATRIX_ROWS;
 }
 
 inline uint8_t matrix_cols(void) {
     return MATRIX_COLS;
 }
 
 inline bool matrix_is_on(uint8_t row, uint8_t col) {
     return (matrix[row] & ((matrix_row_t)1 << col));
 }
 
 inline matrix_row_t matrix_get_row(uint8_t row) {
     // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
     // switch blocker installed and the switch is always pressed.
 #ifdef MATRIX_MASKED
     return matrix[row] & matrix_mask[row];
 #else
     return matrix[row];
 #endif
 }
 
 void matrix_print(void) {
     print_matrix_header();
 
     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
         print_hex8(row);
         print(": ");
         print_matrix_row(row);
         print("\n");
     }
 }
 
 static void select_row(uint8_t row) {
     gpio_set_pin_output(row_pins[row]);
     gpio_write_pin_low(row_pins[row]);
 }
 
 static void unselect_row(uint8_t row) {
     gpio_set_pin_input_high(row_pins[row]);
 }
 
 static void unselect_rows(void) {
     for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
         gpio_set_pin_input_high(row_pins[x]);
     }
 }
 
 static void select_col(uint8_t col) {
     gpio_set_pin_output(col_pins[col]);
     gpio_write_pin_low(col_pins[col]);
 }
 
 static void unselect_col(uint8_t col) {
     gpio_set_pin_input_high(col_pins[col]);
 }
 
 static void unselect_cols(void) {
     for (uint8_t x = 0; x < MATRIX_COLS; x++) {
         gpio_set_pin_input_high(col_pins[x]);
     }
 }
 
 static void init_pins(void) {
     unselect_rows();
     unselect_cols();
     for (uint8_t x = 0; x < MATRIX_COLS; x++) {
         gpio_set_pin_input_high(col_pins[x]);
     }
     for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
         gpio_set_pin_input_high(row_pins[x]);
     }
 }
 
 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
     // Store last value of row prior to reading
     matrix_row_t last_row_value = current_matrix[current_row];
 
     // Clear data in matrix row
     current_matrix[current_row] = 0;
 
     // Select row and wait for row selecton to stabilize
     select_row(current_row);
     wait_us(30);
 
     // For each col...
     for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
         // Select the col pin to read (active low)
         uint8_t pin_state = gpio_read_pin(col_pins[col_index]);
 
         // Populate the matrix row with the state of the col pin
         current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
     }
 
     // Unselect row
     unselect_row(current_row);
 
     return (last_row_value != current_matrix[current_row]);
 }
 
 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col) {
     bool matrix_changed = false;
 
     // Select col and wait for col selecton to stabilize
     select_col(current_col);
     wait_us(30);
 
     // For each row...
     for (uint8_t row_index = 0; row_index < MATRIX_ROWS / 2; row_index++) {
         uint8_t tmp = row_index + MATRIX_ROWS / 2;
         // Store last value of row prior to reading
         matrix_row_t last_row_value = current_matrix[tmp];
 
         // Check row pin state
         if (gpio_read_pin(row_pins[row_index]) == 0) {
             // Pin LO, set col bit
             current_matrix[tmp] |= (ROW_SHIFTER << current_col);
         } else {
             // Pin HI, clear col bit
             current_matrix[tmp] &= ~(ROW_SHIFTER << current_col);
         }
 
         // Determine if the matrix changed state
         if ((last_row_value != current_matrix[tmp]) && !(matrix_changed)) {
             matrix_changed = true;
         }
     }
 
     // Unselect col
     unselect_col(current_col);
 
     return matrix_changed;
 }
 
 void matrix_init(void) {
     // initialize key pins
     init_pins();
 
     // initialize matrix state: all keys off
     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
         raw_matrix[i] = 0;
         matrix[i]     = 0;
     }
 
     debounce_init();
 
     matrix_init_kb();
 }
 
 uint8_t matrix_scan(void) {
     bool changed = false;
 
     // Set row, read cols
     for (uint8_t current_row = 0; current_row < MATRIX_ROWS / 2; current_row++) {
         changed |= read_cols_on_row(raw_matrix, current_row);
     }
     // else
     //  Set col, read rows
     for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
         changed |= read_rows_on_col(raw_matrix, current_col);
     }
 
     debounce(raw_matrix, matrix, changed);
 
     matrix_scan_kb();
     return (uint8_t)changed;
 }