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