quantum/matrix.c

   1 /*
   2 Copyright 2012-2018 Jun Wako, Jack Humbert, Yiancar
   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 #include <stdint.h>
  18 #include <stdbool.h>
  19 #include "wait.h"
  20 #include "util.h"
  21 #include "matrix.h"
  22 #include "debounce.h"
  23 #include "quantum.h"
  24
  25 #ifdef DIRECT_PINS
  26 static pin_t direct_pins[MATRIX_ROWS][MATRIX_COLS] = DIRECT_PINS;
  27 #elif (DIODE_DIRECTION == ROW2COL) || (DIODE_DIRECTION == COL2ROW)
  28 static const pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
  29 static const pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
  30 #endif
  31
  32 /* matrix state(1:on, 0:off) */
  33 extern matrix_row_t raw_matrix[MATRIX_ROWS];  // raw values
  34 extern matrix_row_t matrix[MATRIX_ROWS];      // debounced values
  35
  36 // matrix code
  37
  38 #ifdef DIRECT_PINS
  39
  40 static void init_pins(void) {
  41     for (int row = 0; row < MATRIX_ROWS; row++) {
  42         for (int col = 0; col < MATRIX_COLS; col++) {
  43             pin_t pin = direct_pins[row][col];
  44             if (pin != NO_PIN) {
  45                 setPinInputHigh(pin);
  46             }
  47         }
  48     }
  49 }
  50
  51 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
  52     matrix_row_t last_row_value = current_matrix[current_row];
  53     current_matrix[current_row] = 0;
  54
  55     for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
  56         pin_t pin = direct_pins[current_row][col_index];
  57         if (pin != NO_PIN) {
  58             current_matrix[current_row] |= readPin(pin) ? 0 : (MATRIX_ROW_SHIFTER << col_index);
  59         }
  60     }
  61
  62     return (last_row_value != current_matrix[current_row]);
  63 }
  64
  65 #elif defined(DIODE_DIRECTION)
  66 #    if (DIODE_DIRECTION == COL2ROW)
  67
  68 static void select_row(uint8_t row) {
  69     setPinOutput(row_pins[row]);
  70     writePinLow(row_pins[row]);
  71 }
  72
  73 static void unselect_row(uint8_t row) { setPinInputHigh(row_pins[row]); }
  74
  75 static void unselect_rows(void) {
  76     for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
  77         setPinInputHigh(row_pins[x]);
  78     }
  79 }
  80
  81 static void init_pins(void) {
  82     unselect_rows();
  83     for (uint8_t x = 0; x < MATRIX_COLS; x++) {
  84         setPinInputHigh(col_pins[x]);
  85     }
  86 }
  87
  88 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
  89     // Store last value of row prior to reading
  90     matrix_row_t last_row_value = current_matrix[current_row];
  91
  92     // Clear data in matrix row
  93     current_matrix[current_row] = 0;
  94
  95     // Select row and wait for row selecton to stabilize
  96     select_row(current_row);
  97     wait_us(30);
  98
  99     // For each col...
 100     for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 101         // Select the col pin to read (active low)
 102         uint8_t pin_state = readPin(col_pins[col_index]);
 103
 104         // Populate the matrix row with the state of the col pin
 105         current_matrix[current_row] |= pin_state ? 0 : (MATRIX_ROW_SHIFTER << col_index);
 106     }
 107
 108     // Unselect row
 109     unselect_row(current_row);
 110
 111     return (last_row_value != current_matrix[current_row]);
 112 }
 113
 114 #    elif (DIODE_DIRECTION == ROW2COL)
 115
 116 static void select_col(uint8_t col) {
 117     setPinOutput(col_pins[col]);
 118     writePinLow(col_pins[col]);
 119 }
 120
 121 static void unselect_col(uint8_t col) { setPinInputHigh(col_pins[col]); }
 122
 123 static void unselect_cols(void) {
 124     for (uint8_t x = 0; x < MATRIX_COLS; x++) {
 125         setPinInputHigh(col_pins[x]);
 126     }
 127 }
 128
 129 static void init_pins(void) {
 130     unselect_cols();
 131     for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
 132         setPinInputHigh(row_pins[x]);
 133     }
 134 }
 135
 136 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col) {
 137     bool matrix_changed = false;
 138
 139     // Select col and wait for col selecton to stabilize
 140     select_col(current_col);
 141     wait_us(30);
 142
 143     // For each row...
 144     for (uint8_t row_index = 0; row_index < MATRIX_ROWS; row_index++) {
 145         // Store last value of row prior to reading
 146         matrix_row_t last_row_value = current_matrix[row_index];
 147
 148         // Check row pin state
 149         if (readPin(row_pins[row_index]) == 0) {
 150             // Pin LO, set col bit
 151             current_matrix[row_index] |= (MATRIX_ROW_SHIFTER << current_col);
 152         } else {
 153             // Pin HI, clear col bit
 154             current_matrix[row_index] &= ~(MATRIX_ROW_SHIFTER << current_col);
 155         }
 156
 157         // Determine if the matrix changed state
 158         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed)) {
 159             matrix_changed = true;
 160         }
 161     }
 162
 163     // Unselect col
 164     unselect_col(current_col);
 165
 166     return matrix_changed;
 167 }
 168
 169 #    else
 170 #        error DIODE_DIRECTION must be one of COL2ROW or ROW2COL!
 171 #    endif
 172 #else
 173 #    error DIODE_DIRECTION is not defined!
 174 #endif
 175
 176 void matrix_init(void) {
 177     // initialize key pins
 178     init_pins();
 179
 180     // initialize matrix state: all keys off
 181     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 182         raw_matrix[i] = 0;
 183         matrix[i]     = 0;
 184     }
 185
 186     debounce_init(MATRIX_ROWS);
 187
 188     matrix_init_quantum();
 189 }
 190
 191 uint8_t matrix_scan(void) {
 192     bool changed = false;
 193
 194 #if defined(DIRECT_PINS) || (DIODE_DIRECTION == COL2ROW)
 195     // Set row, read cols
 196     for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
 197         changed |= read_cols_on_row(raw_matrix, current_row);
 198     }
 199 #elif (DIODE_DIRECTION == ROW2COL)
 200     // Set col, read rows
 201     for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
 202         changed |= read_rows_on_col(raw_matrix, current_col);
 203     }
 204 #endif
 205
 206     debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
 207
 208     matrix_scan_quantum();
 209     return (uint8_t)changed;
 210 }