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