keyboards/fortitude60/matrix.c

   1 /*
   2 Copyright 2017 Danny Nguyen <danny@keeb.io>
   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
  18 /*
  19  * scan matrix
  20  */
  21 #include <stdint.h>
  22 #include <stdbool.h>
  23 #include <avr/io.h>
  24 #include "wait.h"
  25 #include "print.h"
  26 #include "debug.h"
  27 #include "util.h"
  28 #include "matrix.h"
  29 #include "split_util.h"
  30 #include "pro_micro.h"
  31 #include "config.h"
  32 #include "timer.h"
  33
  34 #ifdef BACKLIGHT_ENABLE
  35 #include "backlight.h"
  36 extern backlight_config_t backlight_config;
  37 #endif
  38
  39 #include "serial.h"
  40
  41 #ifndef DEBOUNCE
  42 #   define DEBOUNCE 5
  43 #endif
  44
  45 #if (DEBOUNCE > 0)
  46     static uint16_t debouncing_time;
  47     static bool debouncing = false;
  48 #endif
  49
  50 #if (MATRIX_COLS <= 8)
  51 #    define print_matrix_header()  print("\nr/c 01234567\n")
  52 #    define print_matrix_row(row)  print_bin_reverse8(matrix_get_row(row))
  53 #    define matrix_bitpop(i)       bitpop(matrix[i])
  54 #    define ROW_SHIFTER ((uint8_t)1)
  55 #else
  56 #    error "Currently only supports 8 COLS"
  57 #endif
  58 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
  59
  60 #define ERROR_DISCONNECT_COUNT 5
  61
  62 #define SERIAL_LED_ADDR 0x00
  63
  64 #define ROWS_PER_HAND (MATRIX_ROWS/2)
  65
  66 static uint8_t error_count = 0;
  67
  68 static const uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
  69 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
  70
  71 /* matrix state(1:on, 0:off) */
  72 static matrix_row_t matrix[MATRIX_ROWS];
  73 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
  74
  75 #if (DIODE_DIRECTION == COL2ROW)
  76     static void init_cols(void);
  77     static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
  78     static void unselect_rows(void);
  79     static void select_row(uint8_t row);
  80     static void unselect_row(uint8_t row);
  81 #elif (DIODE_DIRECTION == ROW2COL)
  82     static void init_rows(void);
  83     static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
  84     static void unselect_cols(void);
  85     static void unselect_col(uint8_t col);
  86     static void select_col(uint8_t col);
  87 #endif
  88
  89
  90 __attribute__ ((weak))
  91 void matrix_init_kb(void) {
  92     matrix_init_user();
  93 }
  94
  95 __attribute__ ((weak))
  96 void matrix_scan_kb(void) {
  97     matrix_scan_user();
  98 }
  99
 100 __attribute__ ((weak))
 101 void matrix_init_user(void) {
 102 }
 103
 104 __attribute__ ((weak))
 105 void matrix_scan_user(void) {
 106 }
 107
 108 inline
 109 uint8_t matrix_rows(void)
 110 {
 111     return MATRIX_ROWS;
 112 }
 113
 114 inline
 115 uint8_t matrix_cols(void)
 116 {
 117     return MATRIX_COLS;
 118 }
 119
 120 void matrix_init(void)
 121 {
 122     debug_enable = true;
 123     debug_matrix = true;
 124     debug_mouse = true;
 125     // initialize row and col
 126     unselect_rows();
 127     init_cols();
 128
 129     TX_RX_LED_INIT;
 130
 131     // initialize matrix state: all keys off
 132     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 133         matrix[i] = 0;
 134         matrix_debouncing[i] = 0;
 135     }
 136
 137     matrix_init_quantum();
 138
 139 }
 140
 141 uint8_t _matrix_scan(void)
 142 {
 143     int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
 144 #if (DIODE_DIRECTION == COL2ROW)
 145     // Set row, read cols
 146     for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
 147 #       if (DEBOUNCE > 0)
 148             bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
 149
 150             if (matrix_changed) {
 151                 debouncing = true;
 152                 debouncing_time = timer_read();
 153             }
 154
 155 #       else
 156             read_cols_on_row(matrix+offset, current_row);
 157 #       endif
 158
 159     }
 160
 161 #elif (DIODE_DIRECTION == ROW2COL)
 162     // Set col, read rows
 163     for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
 164 #       if (DEBOUNCE > 0)
 165             bool matrix_changed = read_rows_on_col(matrix_debouncing+offset, current_col);
 166             if (matrix_changed) {
 167                 debouncing = true;
 168                 debouncing_time = timer_read();
 169             }
 170 #       else
 171              read_rows_on_col(matrix+offset, current_col);
 172 #       endif
 173
 174     }
 175 #endif
 176
 177 #   if (DEBOUNCE > 0)
 178         if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCE)) {
 179             for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
 180                 matrix[i+offset] = matrix_debouncing[i+offset];
 181             }
 182             debouncing = false;
 183         }
 184 #   endif
 185
 186     return 1;
 187 }
 188
 189 int serial_transaction(void) {
 190     int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 191
 192     if (serial_update_buffers()) {
 193         return 1;
 194     }
 195
 196     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 197         matrix[slaveOffset+i] = serial_slave_buffer[i];
 198     }
 199
 200 #ifdef BACKLIGHT_ENABLE
 201     // Write backlight level for slave to read
 202     serial_master_buffer[SERIAL_LED_ADDR] = backlight_config.enable ? backlight_config.level : 0;
 203 #endif
 204     return 0;
 205 }
 206
 207
 208 uint8_t matrix_scan(void)
 209 {
 210     uint8_t ret = _matrix_scan();
 211
 212     if( serial_transaction() ) {
 213         // turn on the indicator led when halves are disconnected
 214         TXLED1;
 215
 216         error_count++;
 217
 218         if (error_count > ERROR_DISCONNECT_COUNT) {
 219             // reset other half if disconnected
 220             int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 221             for (int i = 0; i < ROWS_PER_HAND; ++i) {
 222                 matrix[slaveOffset+i] = 0;
 223             }
 224         }
 225     } else {
 226         // turn off the indicator led on no error
 227         TXLED0;
 228         error_count = 0;
 229     }
 230     matrix_scan_quantum();
 231     return ret;
 232 }
 233
 234 void matrix_slave_scan(void) {
 235     _matrix_scan();
 236
 237     int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
 238
 239     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 240         serial_slave_buffer[i] = matrix[offset+i];
 241     }
 242
 243 #ifdef BACKLIGHT_ENABLE
 244     // Read backlight level sent from master and update level on slave
 245     backlight_set(serial_master_buffer[SERIAL_LED_ADDR]);
 246 #endif
 247 }
 248
 249 bool matrix_is_modified(void)
 250 {
 251     if (debouncing) return false;
 252     return true;
 253 }
 254
 255 inline
 256 bool matrix_is_on(uint8_t row, uint8_t col)
 257 {
 258     return (matrix[row] & ((matrix_row_t)1<<col));
 259 }
 260
 261 inline
 262 matrix_row_t matrix_get_row(uint8_t row)
 263 {
 264     return matrix[row];
 265 }
 266
 267 void matrix_print(void)
 268 {
 269     print("\nr/c 0123456789ABCDEF\n");
 270     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 271         phex(row); print(": ");
 272         pbin_reverse16(matrix_get_row(row));
 273         print("\n");
 274     }
 275 }
 276
 277 uint8_t matrix_key_count(void)
 278 {
 279     uint8_t count = 0;
 280     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 281         count += bitpop16(matrix[i]);
 282     }
 283     return count;
 284 }
 285
 286 #if (DIODE_DIRECTION == COL2ROW)
 287
 288 static void init_cols(void)
 289 {
 290     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 291         uint8_t pin = col_pins[x];
 292         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 293         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 294     }
 295 }
 296
 297 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
 298 {
 299     // Store last value of row prior to reading
 300     matrix_row_t last_row_value = current_matrix[current_row];
 301
 302     // Clear data in matrix row
 303     current_matrix[current_row] = 0;
 304
 305     // Select row and wait for row selecton to stabilize
 306     select_row(current_row);
 307     wait_us(30);
 308
 309     // For each col...
 310     for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 311
 312         // Select the col pin to read (active low)
 313         uint8_t pin = col_pins[col_index];
 314         uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 315
 316         // Populate the matrix row with the state of the col pin
 317         current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
 318     }
 319
 320     // Unselect row
 321     unselect_row(current_row);
 322
 323     return (last_row_value != current_matrix[current_row]);
 324 }
 325
 326 static void select_row(uint8_t row)
 327 {
 328     uint8_t pin = row_pins[row];
 329     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
 330     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
 331 }
 332
 333 static void unselect_row(uint8_t row)
 334 {
 335     uint8_t pin = row_pins[row];
 336     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 337     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 338 }
 339
 340 static void unselect_rows(void)
 341 {
 342     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
 343         uint8_t pin = row_pins[x];
 344         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 345         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 346     }
 347 }
 348
 349 #elif (DIODE_DIRECTION == ROW2COL)
 350
 351 static void init_rows(void)
 352 {
 353     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
 354         uint8_t pin = row_pins[x];
 355         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 356         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 357     }
 358 }
 359
 360 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
 361 {
 362     bool matrix_changed = false;
 363
 364     // Select col and wait for col selecton to stabilize
 365     select_col(current_col);
 366     wait_us(30);
 367
 368     // For each row...
 369     for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
 370     {
 371
 372         // Store last value of row prior to reading
 373         matrix_row_t last_row_value = current_matrix[row_index];
 374
 375         // Check row pin state
 376         if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
 377         {
 378             // Pin LO, set col bit
 379             current_matrix[row_index] |= (ROW_SHIFTER << current_col);
 380         }
 381         else
 382         {
 383             // Pin HI, clear col bit
 384             current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
 385         }
 386
 387         // Determine if the matrix changed state
 388         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
 389         {
 390             matrix_changed = true;
 391         }
 392     }
 393
 394     // Unselect col
 395     unselect_col(current_col);
 396
 397     return matrix_changed;
 398 }
 399
 400 static void select_col(uint8_t col)
 401 {
 402     uint8_t pin = col_pins[col];
 403     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
 404     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
 405 }
 406
 407 static void unselect_col(uint8_t col)
 408 {
 409     uint8_t pin = col_pins[col];
 410     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 411     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 412 }
 413
 414 static void unselect_cols(void)
 415 {
 416     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 417         uint8_t pin = col_pins[x];
 418         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 419         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 420     }
 421 }
 422
 423 #endif