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