keyboards/lets_split/matrix.c

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