keyboards/redscarf_iiplus/verb/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))
  60 void matrix_init_quantum(void) {
  61     matrix_init_kb();
  62 }
  63
  64 __attribute__ ((weak))
  65 void matrix_scan_quantum(void) {
  66     matrix_scan_kb();
  67 }
  68
  69 __attribute__ ((weak))
  70 void matrix_init_kb(void) {
  71     matrix_init_user();
  72 }
  73
  74 __attribute__ ((weak))
  75 void matrix_scan_kb(void) {
  76     matrix_scan_user();
  77 }
  78
  79 __attribute__ ((weak))
  80 void matrix_init_user(void) {
  81 }
  82
  83 __attribute__ ((weak))
  84 void matrix_scan_user(void) {
  85 }
  86
  87 inline
  88 uint8_t matrix_rows(void) {
  89     return MATRIX_ROWS;
  90 }
  91
  92 inline
  93 uint8_t matrix_cols(void) {
  94     return MATRIX_COLS;
  95 }
  96
  97 //Deprecated.
  98 bool matrix_is_modified(void)
  99 {
 100     if (debounce_active()) return false;
 101     return true;
 102 }
 103
 104 inline
 105 bool matrix_is_on(uint8_t row, uint8_t col)
 106 {
 107     return (matrix[row] & ((matrix_row_t)1<<col));
 108 }
 109
 110 inline
 111 matrix_row_t matrix_get_row(uint8_t row)
 112 {
 113     // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
 114     // switch blocker installed and the switch is always pressed.
 115 #ifdef MATRIX_MASKED
 116     return matrix[row] & matrix_mask[row];
 117 #else
 118     return matrix[row];
 119 #endif
 120 }
 121
 122 void matrix_print(void)
 123 {
 124     print_matrix_header();
 125
 126     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 127         phex(row); print(": ");
 128         print_matrix_row(row);
 129         print("\n");
 130     }
 131 }
 132
 133 uint8_t matrix_key_count(void)
 134 {
 135     uint8_t count = 0;
 136     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 137         count += matrix_bitpop(i);
 138     }
 139     return count;
 140 }
 141
 142
 143 #ifdef DIRECT_PINS
 144
 145 static void init_pins(void) {
 146   for (int row = 0; row < MATRIX_ROWS; row++) {
 147     for (int col = 0; col < MATRIX_COLS; col++) {
 148       pin_t pin = direct_pins[row][col];
 149       if (pin != NO_PIN) {
 150         setPinInputHigh(pin);
 151       }
 152     }
 153   }
 154 }
 155
 156 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
 157   matrix_row_t last_row_value = current_matrix[current_row];
 158   current_matrix[current_row] = 0;
 159
 160   for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 161     pin_t pin = direct_pins[current_row][col_index];
 162     if (pin != NO_PIN) {
 163       current_matrix[current_row] |= readPin(pin) ? 0 : (ROW_SHIFTER << col_index);
 164     }
 165   }
 166
 167   return (last_row_value != current_matrix[current_row]);
 168 }
 169
 170 #elif (DIODE_DIRECTION == COL2ROW)
 171 /* Rows 0 - 5
 172  * These rows use a 74HC237D 3 to 8 bit demultiplexer.
 173  *                C    B    A
 174  * row / pin:    PB0  PB1  PB2
 175  * 0:             0    0    0
 176  * 1:             0    0    1
 177  * 2:             0    1    0
 178  * 3:             0    1    1
 179  * 4:             1    0    0
 180  * 5:             1    0    1
 181  */
 182 static void select_row(uint8_t col)
 183 {
 184     switch (col) {
 185         case 0:
 186             writePinLow(B0);
 187             writePinLow(B1);
 188             writePinLow(B2);
 189             break;
 190         case 1:
 191             writePinLow(B0);
 192             writePinLow(B1);
 193             break;
 194         case 2:
 195             writePinLow(B0);
 196             writePinLow(B2);
 197             break;
 198         case 3:
 199             writePinLow(B0);
 200             break;
 201         case 4:
 202             writePinLow(B1);
 203             writePinLow(B2);
 204             break;
 205         case 5:
 206             writePinLow(B1);
 207             break;
 208     }
 209 }
 210
 211 static void unselect_row(uint8_t col)
 212 {
 213     switch (col) {
 214         case 0:
 215             writePinHigh(B0);
 216             writePinHigh(B1);
 217             writePinHigh(B2);
 218             break;
 219         case 1:
 220             writePinHigh(B0);
 221             writePinHigh(B1);
 222             break;
 223         case 2:
 224             writePinHigh(B0);
 225             writePinHigh(B2);
 226             break;
 227         case 3:
 228             writePinHigh(B0);
 229             break;
 230         case 4:
 231             writePinHigh(B1);
 232             writePinHigh(B2);
 233             break;
 234         case 5:
 235             writePinHigh(B1);
 236             break;
 237     }
 238 }
 239
 240 static void unselect_rows(void)
 241 {
 242     setPinOutput(B0);
 243     setPinOutput(B1);
 244     setPinOutput(B2);
 245         // make all pins high to select Y7, nothing is connected to that (otherwise the first row will act weird)
 246     writePinHigh(B0);
 247     writePinHigh(B1);
 248     writePinHigh(B2);
 249 }
 250
 251 static void init_pins(void) {
 252   unselect_rows();
 253   for (uint8_t x = 0; x < MATRIX_COLS; x++) {
 254     setPinInputHigh(col_pins[x]);
 255   }
 256 }
 257
 258 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
 259 {
 260     // Store last value of row prior to reading
 261     matrix_row_t last_row_value = current_matrix[current_row];
 262
 263     // Clear data in matrix row
 264     current_matrix[current_row] = 0;
 265
 266     // Select row and wait for row selecton to stabilize
 267     select_row(current_row);
 268     wait_us(30);
 269
 270     // For each col...
 271     for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 272
 273         // Select the col pin to read (active low)
 274         uint8_t pin_state = readPin(col_pins[col_index]);
 275
 276         // Populate the matrix row with the state of the col pin
 277         current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
 278     }
 279
 280     // Unselect row
 281     unselect_row(current_row);
 282
 283     return (last_row_value != current_matrix[current_row]);
 284 }
 285
 286 #elif (DIODE_DIRECTION == ROW2COL)
 287
 288 static void select_col(uint8_t col)
 289 {
 290     setPinOutput(col_pins[col]);
 291     writePinLow(col_pins[col]);
 292 }
 293
 294 static void unselect_col(uint8_t col)
 295 {
 296     setPinInputHigh(col_pins[col]);
 297 }
 298
 299 static void unselect_cols(void)
 300 {
 301     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 302         setPinInputHigh(col_pins[x]);
 303     }
 304 }
 305
 306 static void init_pins(void) {
 307   unselect_cols();
 308   for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
 309     setPinInputHigh(row_pins[x]);
 310   }
 311 }
 312
 313 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
 314 {
 315     bool matrix_changed = false;
 316
 317     // Select col and wait for col selecton to stabilize
 318     select_col(current_col);
 319     wait_us(30);
 320
 321     // For each row...
 322     for(uint8_t row_index = 0; row_index < MATRIX_ROWS; row_index++)
 323     {
 324
 325         // Store last value of row prior to reading
 326         matrix_row_t last_row_value = current_matrix[row_index];
 327
 328         // Check row pin state
 329         if (readPin(row_pins[row_index]) == 0)
 330         {
 331             // Pin LO, set col bit
 332             current_matrix[row_index] |= (ROW_SHIFTER << current_col);
 333         }
 334         else
 335         {
 336             // Pin HI, clear col bit
 337             current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
 338         }
 339
 340         // Determine if the matrix changed state
 341         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
 342         {
 343             matrix_changed = true;
 344         }
 345     }
 346
 347     // Unselect col
 348     unselect_col(current_col);
 349
 350     return matrix_changed;
 351 }
 352
 353 #endif
 354
 355 void matrix_init(void) {
 356
 357     // initialize key pins
 358     init_pins();
 359
 360     // initialize matrix state: all keys off
 361     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 362         raw_matrix[i] = 0;
 363         matrix[i] = 0;
 364     }
 365
 366     debounce_init(MATRIX_ROWS);
 367
 368     matrix_init_quantum();
 369 }
 370
 371 uint8_t matrix_scan(void)
 372 {
 373   bool changed = false;
 374
 375 #if defined(DIRECT_PINS) || (DIODE_DIRECTION == COL2ROW)
 376   // Set row, read cols
 377   for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
 378     changed |= read_cols_on_row(raw_matrix, current_row);
 379   }
 380 #elif (DIODE_DIRECTION == ROW2COL)
 381   // Set col, read rows
 382   for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
 383     changed |= read_rows_on_col(raw_matrix, current_col);
 384   }
 385 #endif
 386
 387   debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
 388
 389   matrix_scan_quantum();
 390   return 1;
 391 }