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