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 #include "backlight.h"
  34
  35 #ifdef USE_I2C
  36 #  include "i2c.h"
  37 #else // USE_SERIAL
  38 #  include "serial.h"
  39 #endif
  40
  41 #ifndef DEBOUNCING_DELAY
  42 #   define DEBOUNCING_DELAY 5
  43 #endif
  44
  45 #if (DEBOUNCING_DELAY > 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 __attribute__ ((weak))
  89 void matrix_init_quantum(void) {
  90     matrix_init_kb();
  91 }
  92
  93 __attribute__ ((weak))
  94 void matrix_scan_quantum(void) {
  95     matrix_scan_kb();
  96 }
  97
  98 __attribute__ ((weak))
  99 void matrix_init_kb(void) {
 100     matrix_init_user();
 101 }
 102
 103 __attribute__ ((weak))
 104 void matrix_scan_kb(void) {
 105     matrix_scan_user();
 106 }
 107
 108 __attribute__ ((weak))
 109 void matrix_init_user(void) {
 110 }
 111
 112 __attribute__ ((weak))
 113 void matrix_scan_user(void) {
 114 }
 115
 116 inline
 117 uint8_t matrix_rows(void)
 118 {
 119     return MATRIX_ROWS;
 120 }
 121
 122 inline
 123 uint8_t matrix_cols(void)
 124 {
 125     return MATRIX_COLS;
 126 }
 127
 128 void matrix_init(void)
 129 {
 130     debug_enable = true;
 131     debug_matrix = true;
 132     debug_mouse = true;
 133     // initialize row and col
 134     unselect_rows();
 135     init_cols();
 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     // Start read
 212     err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
 213     if (err) goto i2c_error;
 214
 215     if (!err) {
 216         int i;
 217         for (i = 0; i < ROWS_PER_HAND-1; ++i) {
 218             matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
 219         }
 220         matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
 221         i2c_master_stop();
 222     } else {
 223 i2c_error: // the cable is disconnceted, or something else went wrong
 224         i2c_reset_state();
 225         return err;
 226     }
 227
 228     return 0;
 229 }
 230
 231 #else // USE_SERIAL
 232
 233 int serial_transaction(void) {
 234     int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 235
 236     if (serial_update_buffers()) {
 237         return 1;
 238     }
 239
 240     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 241         matrix[slaveOffset+i] = serial_slave_buffer[i];
 242     }
 243
 244 #ifdef BACKLIGHT_ENABLE
 245     // Write backlight level for slave to read
 246     serial_master_buffer[SERIAL_LED_ADDR] = get_backlight_level();
 247 #endif
 248     return 0;
 249 }
 250 #endif
 251
 252 uint8_t matrix_scan(void)
 253 {
 254     uint8_t ret = _matrix_scan();
 255
 256 #ifdef USE_I2C
 257     if( i2c_transaction() ) {
 258 #else // USE_SERIAL
 259     if( serial_transaction() ) {
 260 #endif
 261         // turn on the indicator led when halves are disconnected
 262         TXLED1;
 263
 264         error_count++;
 265
 266         if (error_count > ERROR_DISCONNECT_COUNT) {
 267             // reset other half if disconnected
 268             int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 269             for (int i = 0; i < ROWS_PER_HAND; ++i) {
 270                 matrix[slaveOffset+i] = 0;
 271             }
 272         }
 273     } else {
 274         // turn off the indicator led on no error
 275         TXLED0;
 276         error_count = 0;
 277     }
 278     matrix_scan_quantum();
 279     return ret;
 280 }
 281
 282 void matrix_slave_scan(void) {
 283     _matrix_scan();
 284
 285     int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
 286
 287 #ifdef USE_I2C
 288     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 289         i2c_slave_buffer[i] = matrix[offset+i];
 290     }
 291 #else // USE_SERIAL
 292     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 293         serial_slave_buffer[i] = matrix[offset+i];
 294     }
 295
 296 #ifdef BACKLIGHT_ENABLE
 297     // Read backlight level sent from master and update level on slave
 298     backlight_set(serial_master_buffer[SERIAL_LED_ADDR]);
 299 #endif
 300 #endif
 301 }
 302
 303 bool matrix_is_modified(void)
 304 {
 305     if (debouncing) return false;
 306     return true;
 307 }
 308
 309 inline
 310 bool matrix_is_on(uint8_t row, uint8_t col)
 311 {
 312     return (matrix[row] & ((matrix_row_t)1<<col));
 313 }
 314
 315 inline
 316 matrix_row_t matrix_get_row(uint8_t row)
 317 {
 318     return matrix[row];
 319 }
 320
 321 void matrix_print(void)
 322 {
 323     print("\nr/c 0123456789ABCDEF\n");
 324     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 325         phex(row); print(": ");
 326         pbin_reverse16(matrix_get_row(row));
 327         print("\n");
 328     }
 329 }
 330
 331 uint8_t matrix_key_count(void)
 332 {
 333     uint8_t count = 0;
 334     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 335         count += bitpop16(matrix[i]);
 336     }
 337     return count;
 338 }
 339
 340 #if (DIODE_DIRECTION == COL2ROW)
 341
 342 static void init_cols(void)
 343 {
 344     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 345         uint8_t pin = col_pins[x];
 346         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 347         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 348     }
 349 }
 350
 351 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
 352 {
 353     // Store last value of row prior to reading
 354     matrix_row_t last_row_value = current_matrix[current_row];
 355
 356     // Clear data in matrix row
 357     current_matrix[current_row] = 0;
 358
 359     // Select row and wait for row selecton to stabilize
 360     select_row(current_row);
 361     wait_us(30);
 362
 363     // For each col...
 364     for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 365
 366         // Select the col pin to read (active low)
 367         uint8_t pin = col_pins[col_index];
 368         uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 369
 370         // Populate the matrix row with the state of the col pin
 371         current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
 372     }
 373
 374     // Unselect row
 375     unselect_row(current_row);
 376
 377     return (last_row_value != current_matrix[current_row]);
 378 }
 379
 380 static void select_row(uint8_t row)
 381 {
 382     uint8_t pin = row_pins[row];
 383     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
 384     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
 385 }
 386
 387 static void unselect_row(uint8_t row)
 388 {
 389     uint8_t pin = row_pins[row];
 390     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 391     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 392 }
 393
 394 static void unselect_rows(void)
 395 {
 396     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
 397         uint8_t pin = row_pins[x];
 398         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 399         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 400     }
 401 }
 402
 403 #elif (DIODE_DIRECTION == ROW2COL)
 404
 405 static void init_rows(void)
 406 {
 407     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
 408         uint8_t pin = row_pins[x];
 409         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 410         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 411     }
 412 }
 413
 414 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
 415 {
 416     bool matrix_changed = false;
 417
 418     // Select col and wait for col selecton to stabilize
 419     select_col(current_col);
 420     wait_us(30);
 421
 422     // For each row...
 423     for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
 424     {
 425
 426         // Store last value of row prior to reading
 427         matrix_row_t last_row_value = current_matrix[row_index];
 428
 429         // Check row pin state
 430         if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
 431         {
 432             // Pin LO, set col bit
 433             current_matrix[row_index] |= (ROW_SHIFTER << current_col);
 434         }
 435         else
 436         {
 437             // Pin HI, clear col bit
 438             current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
 439         }
 440
 441         // Determine if the matrix changed state
 442         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
 443         {
 444             matrix_changed = true;
 445         }
 446     }
 447
 448     // Unselect col
 449     unselect_col(current_col);
 450
 451     return matrix_changed;
 452 }
 453
 454 static void select_col(uint8_t col)
 455 {
 456     uint8_t pin = col_pins[col];
 457     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
 458     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
 459 }
 460
 461 static void unselect_col(uint8_t col)
 462 {
 463     uint8_t pin = col_pins[col];
 464     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 465     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 466 }
 467
 468 static void unselect_cols(void)
 469 {
 470     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 471         uint8_t pin = col_pins[x];
 472         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 473         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 474     }
 475 }
 476
 477 #endif