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 "print.h"
  21 #include "debug.h"
  22 #include "util.h"
  23 #include "matrix.h"
  24 #include "debounce.h"
  25 #include "quantum.h"
  26
  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)
  42 #endif
  43
  44 #ifdef MATRIX_MASKED
  45 extern const matrix_row_t matrix_mask[];
  46 #endif
  47
  48 #ifdef DIRECT_PINS
  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;
  53 #endif
  54
  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
  58
  59 __attribute__((weak)) void matrix_init_quantum(void) { matrix_init_kb(); }
  60
  61 __attribute__((weak)) void matrix_scan_quantum(void) { matrix_scan_kb(); }
  62
  63 __attribute__((weak)) void matrix_init_kb(void) { matrix_init_user(); }
  64
  65 __attribute__((weak)) void matrix_scan_kb(void) { matrix_scan_user(); }
  66
  67 __attribute__((weak)) void matrix_init_user(void) {}
  68
  69 __attribute__((weak)) void matrix_scan_user(void) {}
  70
  71 inline uint8_t matrix_rows(void) { return MATRIX_ROWS; }
  72
  73 inline uint8_t matrix_cols(void) { return MATRIX_COLS; }
  74
  75 // Deprecated.
  76 bool matrix_is_modified(void) {
  77     if (debounce_active()) return false;
  78     return true;
  79 }
  80
  81 inline bool matrix_is_on(uint8_t row, uint8_t col) { return (matrix[row] & ((matrix_row_t)1 << col)); }
  82
  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.
  86 #ifdef MATRIX_MASKED
  87     return matrix[row] & matrix_mask[row];
  88 #else
  89     return matrix[row];
  90 #endif
  91 }
  92
  93 void matrix_print(void) {
  94     print_matrix_header();
  95
  96     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
  97         phex(row);
  98         print(": ");
  99         print_matrix_row(row);
 100         print("\n");
 101     }
 102 }
 103
 104 uint8_t matrix_key_count(void) {
 105     uint8_t count = 0;
 106     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 107         count += matrix_bitpop(i);
 108     }
 109     return count;
 110 }
 111
 112 #ifdef DIRECT_PINS
 113
 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];
 118             if (pin != NO_PIN) {
 119                 setPinInputHigh(pin);
 120             }
 121         }
 122     }
 123 }
 124
 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;
 128
 129     for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 130         pin_t pin = direct_pins[current_row][col_index];
 131         if (pin != NO_PIN) {
 132             current_matrix[current_row] |= readPin(pin) ? 0 : (ROW_SHIFTER << col_index);
 133         }
 134     }
 135
 136     return (last_row_value != current_matrix[current_row]);
 137 }
 138
 139 #elif (DIODE_DIRECTION == COL2ROW)
 140
 141 static void select_row(uint8_t row) {
 142     setPinOutput(row_pins[row]);
 143     writePinLow(row_pins[row]);
 144 }
 145
 146 static void unselect_row(uint8_t row) { setPinInputHigh(row_pins[row]); }
 147
 148 static void unselect_rows(void) {
 149     for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
 150         setPinInputHigh(row_pins[x]);
 151     }
 152 }
 153
 154 static void init_pins(void) {
 155     unselect_rows();
 156     for (uint8_t x = 0; x < MATRIX_COLS; x++) {
 157         setPinInputHigh(col_pins[x]);
 158     }
 159 }
 160
 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];
 164
 165     // Clear data in matrix row
 166     current_matrix[current_row] = 0;
 167
 168     // Select row and wait for row selecton to stabilize
 169     select_row(current_row);
 170     wait_us(30);
 171
 172     // For each col...
 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]);
 176
 177         // Populate the matrix row with the state of the col pin
 178         current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
 179     }
 180
 181     // Unselect row
 182     unselect_row(current_row);
 183
 184     return (last_row_value != current_matrix[current_row]);
 185 }
 186
 187 #elif (DIODE_DIRECTION == ROW2COL)
 188
 189 static void select_col(uint8_t col) {
 190     setPinOutput(col_pins[col]);
 191     writePinLow(col_pins[col]);
 192 }
 193
 194 static void unselect_col(uint8_t col) { setPinInputHigh(col_pins[col]); }
 195
 196 static void unselect_cols(void) {
 197     for (uint8_t x = 0; x < MATRIX_COLS; x++) {
 198         setPinInputHigh(col_pins[x]);
 199     }
 200 }
 201
 202 static void init_pins(void) {
 203     unselect_cols();
 204     for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
 205         setPinInputHigh(row_pins[x]);
 206     }
 207 }
 208
 209 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col) {
 210     bool matrix_changed = false;
 211
 212     // Select col and wait for col selecton to stabilize
 213     select_col(current_col);
 214     wait_us(30);
 215
 216     // For each row...
 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];
 220
 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);
 225         } else {
 226             // Pin HI, clear col bit
 227             current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
 228         }
 229
 230         // Determine if the matrix changed state
 231         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed)) {
 232             matrix_changed = true;
 233         }
 234     }
 235
 236     // Unselect col
 237     unselect_col(current_col);
 238
 239     return matrix_changed;
 240 }
 241
 242 #endif
 243
 244 void matrix_init(void) {
 245     // initialize key pins
 246     init_pins();
 247
 248     // initialize matrix state: all keys off
 249     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 250         raw_matrix[i] = 0;
 251         matrix[i]     = 0;
 252     }
 253
 254     debounce_init(MATRIX_ROWS);
 255
 256     matrix_init_quantum();
 257 }
 258
 259 uint8_t matrix_scan(void) {
 260     bool changed = false;
 261
 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);
 266     }
 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);
 271     }
 272 #endif
 273
 274     debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
 275
 276     matrix_scan_quantum();
 277     return (uint8_t)changed;
 278 }