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