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