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