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
  86 __attribute__ ((weak))
  87 void matrix_init_kb(void) {
  88     matrix_init_user();
  89 }
  90
  91 __attribute__ ((weak))
  92 void matrix_scan_kb(void) {
  93     matrix_scan_user();
  94 }
  95
  96 __attribute__ ((weak))
  97 void matrix_init_user(void) {
  98 }
  99
 100 __attribute__ ((weak))
 101 void matrix_scan_user(void) {
 102 }
 103
 104 __attribute__ ((weak))
 105 void matrix_slave_scan_user(void) {
 106 }
 107
 108 inline
 109 uint8_t matrix_rows(void)
 110 {
 111     return MATRIX_ROWS;
 112 }
 113
 114 inline
 115 uint8_t matrix_cols(void)
 116 {
 117     return MATRIX_COLS;
 118 }
 119
 120 void matrix_init(void)
 121 {
 122 #ifdef DISABLE_JTAG
 123   // JTAG disable for PORT F. write JTD bit twice within four cycles.
 124   MCUCR |= (1<<JTD);
 125   MCUCR |= (1<<JTD);
 126 #endif
 127
 128     debug_enable = true;
 129     debug_matrix = true;
 130     debug_mouse = true;
 131     // initialize row and col
 132 #if (DIODE_DIRECTION == COL2ROW)
 133     unselect_rows();
 134     init_cols();
 135 #elif (DIODE_DIRECTION == ROW2COL)
 136     unselect_cols();
 137     init_rows();
 138 #endif
 139
 140     TX_RX_LED_INIT;
 141
 142     // initialize matrix state: all keys off
 143     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 144         matrix[i] = 0;
 145         matrix_debouncing[i] = 0;
 146     }
 147
 148     matrix_init_quantum();
 149
 150 }
 151
 152 uint8_t _matrix_scan(void)
 153 {
 154     int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
 155 #if (DIODE_DIRECTION == COL2ROW)
 156     // Set row, read cols
 157     for (uint8_t current_row = 0; current_row < ROWS_PER_HAND; current_row++) {
 158 #       if (DEBOUNCING_DELAY > 0)
 159             bool matrix_changed = read_cols_on_row(matrix_debouncing+offset, current_row);
 160
 161             if (matrix_changed) {
 162                 debouncing = true;
 163                 debouncing_time = timer_read();
 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     matrix_slave_scan_user();
 294 }
 295
 296 bool matrix_is_modified(void)
 297 {
 298     if (debouncing) return false;
 299     return true;
 300 }
 301
 302 inline
 303 bool matrix_is_on(uint8_t row, uint8_t col)
 304 {
 305     return (matrix[row] & ((matrix_row_t)1<<col));
 306 }
 307
 308 inline
 309 matrix_row_t matrix_get_row(uint8_t row)
 310 {
 311     return matrix[row];
 312 }
 313
 314 void matrix_print(void)
 315 {
 316     print("\nr/c 0123456789ABCDEF\n");
 317     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 318         phex(row); print(": ");
 319         pbin_reverse16(matrix_get_row(row));
 320         print("\n");
 321     }
 322 }
 323
 324 uint8_t matrix_key_count(void)
 325 {
 326     uint8_t count = 0;
 327     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 328         count += bitpop16(matrix[i]);
 329     }
 330     return count;
 331 }
 332
 333 #if (DIODE_DIRECTION == COL2ROW)
 334
 335 static void init_cols(void)
 336 {
 337     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 338         uint8_t pin = col_pins[x];
 339         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 340         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 341     }
 342 }
 343
 344 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
 345 {
 346     // Store last value of row prior to reading
 347     matrix_row_t last_row_value = current_matrix[current_row];
 348
 349     // Clear data in matrix row
 350     current_matrix[current_row] = 0;
 351
 352     // Select row and wait for row selecton to stabilize
 353     select_row(current_row);
 354     wait_us(30);
 355
 356     // For each col...
 357     for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 358
 359         // Select the col pin to read (active low)
 360         uint8_t pin = col_pins[col_index];
 361         uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 362
 363         // Populate the matrix row with the state of the col pin
 364         current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
 365     }
 366
 367     // Unselect row
 368     unselect_row(current_row);
 369
 370     return (last_row_value != current_matrix[current_row]);
 371 }
 372
 373 static void select_row(uint8_t row)
 374 {
 375     uint8_t pin = row_pins[row];
 376     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
 377     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
 378 }
 379
 380 static void unselect_row(uint8_t row)
 381 {
 382     uint8_t pin = row_pins[row];
 383     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 384     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 385 }
 386
 387 static void unselect_rows(void)
 388 {
 389     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
 390         uint8_t pin = row_pins[x];
 391         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 392         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 393     }
 394 }
 395
 396 #elif (DIODE_DIRECTION == ROW2COL)
 397
 398 static void init_rows(void)
 399 {
 400     for(uint8_t x = 0; x < ROWS_PER_HAND; x++) {
 401         uint8_t pin = row_pins[x];
 402         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 403         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 404     }
 405 }
 406
 407 static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
 408 {
 409     bool matrix_changed = false;
 410
 411     // Select col and wait for col selecton to stabilize
 412     select_col(current_col);
 413     wait_us(30);
 414
 415     // For each row...
 416     for(uint8_t row_index = 0; row_index < ROWS_PER_HAND; row_index++)
 417     {
 418
 419         // Store last value of row prior to reading
 420         matrix_row_t last_row_value = current_matrix[row_index];
 421
 422         // Check row pin state
 423         if ((_SFR_IO8(row_pins[row_index] >> 4) & _BV(row_pins[row_index] & 0xF)) == 0)
 424         {
 425             // Pin LO, set col bit
 426             current_matrix[row_index] |= (ROW_SHIFTER << current_col);
 427         }
 428         else
 429         {
 430             // Pin HI, clear col bit
 431             current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
 432         }
 433
 434         // Determine if the matrix changed state
 435         if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
 436         {
 437             matrix_changed = true;
 438         }
 439     }
 440
 441     // Unselect col
 442     unselect_col(current_col);
 443
 444     return matrix_changed;
 445 }
 446
 447 static void select_col(uint8_t col)
 448 {
 449     uint8_t pin = col_pins[col];
 450     _SFR_IO8((pin >> 4) + 1) |=  _BV(pin & 0xF); // OUT
 451     _SFR_IO8((pin >> 4) + 2) &= ~_BV(pin & 0xF); // LOW
 452 }
 453
 454 static void unselect_col(uint8_t col)
 455 {
 456     uint8_t pin = col_pins[col];
 457     _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 458     _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 459 }
 460
 461 static void unselect_cols(void)
 462 {
 463     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 464         uint8_t pin = col_pins[x];
 465         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 466         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 467     }
 468 }
 469
 470 #endif