keyboards/zinc/reva/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 <string.h>
  24 #include <avr/io.h>
  25 #include <avr/wdt.h>
  26 #include <avr/interrupt.h>
  27 #include <util/delay.h>
  28 #include "print.h"
  29 #include "debug.h"
  30 #include "util.h"
  31 #include "matrix.h"
  32 #include "split_util.h"
  33 #include "pro_micro.h"
  34
  35 #ifdef USE_MATRIX_I2C
  36 #  include "i2c.h"
  37 #else // USE_SERIAL
  38 #  include "split_scomm.h"
  39 #endif
  40
  41 #ifndef DEBOUNCE
  42 #  define DEBOUNCE      5
  43 #endif
  44
  45 #define ERROR_DISCONNECT_COUNT 5
  46
  47 static uint8_t debouncing = DEBOUNCE;
  48 static const int ROWS_PER_HAND = MATRIX_ROWS/2;
  49 static uint8_t error_count = 0;
  50 uint8_t is_master = 0 ;
  51
  52 static const uint8_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
  53 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
  54
  55 /* matrix state(1:on, 0:off) */
  56 static matrix_row_t matrix[MATRIX_ROWS];
  57 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
  58
  59 static matrix_row_t read_cols(void);
  60 static void init_cols(void);
  61 static void unselect_rows(void);
  62 static void select_row(uint8_t row);
  63 static uint8_t matrix_master_scan(void);
  64
  65
  66 __attribute__ ((weak))
  67 void matrix_init_kb(void) {
  68     matrix_init_user();
  69 }
  70
  71 __attribute__ ((weak))
  72 void matrix_scan_kb(void) {
  73     matrix_scan_user();
  74 }
  75
  76 __attribute__ ((weak))
  77 void matrix_init_user(void) {
  78 }
  79
  80 __attribute__ ((weak))
  81 void matrix_scan_user(void) {
  82 }
  83
  84 inline
  85 uint8_t matrix_rows(void)
  86 {
  87     return MATRIX_ROWS;
  88 }
  89
  90 inline
  91 uint8_t matrix_cols(void)
  92 {
  93     return MATRIX_COLS;
  94 }
  95
  96 void matrix_init(void)
  97 {
  98     debug_enable = true;
  99     debug_matrix = true;
 100     debug_mouse = true;
 101     // initialize row and col
 102     unselect_rows();
 103     init_cols();
 104
 105     TX_RX_LED_INIT;
 106     TXLED0;
 107     RXLED0;
 108
 109     // initialize matrix state: all keys off
 110     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 111         matrix[i] = 0;
 112         matrix_debouncing[i] = 0;
 113     }
 114
 115     is_master = has_usb();
 116
 117     matrix_init_quantum();
 118 }
 119
 120 uint8_t _matrix_scan(void)
 121 {
 122     // Right hand is stored after the left in the matirx so, we need to offset it
 123     int offset = isLeftHand ? 0 : (ROWS_PER_HAND);
 124
 125     for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
 126         select_row(i);
 127         _delay_us(30);  // without this wait read unstable value.
 128         matrix_row_t cols = read_cols();
 129         if (matrix_debouncing[i+offset] != cols) {
 130             matrix_debouncing[i+offset] = cols;
 131             debouncing = DEBOUNCE;
 132         }
 133         unselect_rows();
 134     }
 135
 136     if (debouncing) {
 137         if (--debouncing) {
 138             _delay_ms(1);
 139         } else {
 140             for (uint8_t i = 0; i < ROWS_PER_HAND; i++) {
 141                 matrix[i+offset] = matrix_debouncing[i+offset];
 142             }
 143         }
 144     }
 145
 146     return 1;
 147 }
 148
 149 #ifdef USE_MATRIX_I2C
 150
 151 // Get rows from other half over i2c
 152 int i2c_transaction(void) {
 153     int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 154
 155     int err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_WRITE);
 156     if (err) goto i2c_error;
 157
 158     // start of matrix stored at 0x00
 159     err = i2c_master_write(0x00);
 160     if (err) goto i2c_error;
 161
 162     // Start read
 163     err = i2c_master_start(SLAVE_I2C_ADDRESS + I2C_READ);
 164     if (err) goto i2c_error;
 165
 166     if (!err) {
 167         int i;
 168         for (i = 0; i < ROWS_PER_HAND-1; ++i) {
 169             matrix[slaveOffset+i] = i2c_master_read(I2C_ACK);
 170         }
 171         matrix[slaveOffset+i] = i2c_master_read(I2C_NACK);
 172         i2c_master_stop();
 173     } else {
 174 i2c_error: // the cable is disconnceted, or something else went wrong
 175         i2c_reset_state();
 176         return err;
 177     }
 178
 179     return 0;
 180 }
 181
 182 #else // USE_SERIAL
 183
 184 int serial_transaction(int master_changed) {
 185     int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 186 #ifdef SERIAL_USE_MULTI_TRANSACTION
 187     int ret=serial_update_buffers(master_changed);
 188 #else
 189     int ret=serial_update_buffers();
 190 #endif
 191     if (ret ) {
 192         if(ret==2) RXLED1;
 193         return 1;
 194     }
 195     RXLED0;
 196     memcpy(&matrix[slaveOffset],
 197         (void *)serial_slave_buffer, sizeof(serial_slave_buffer));
 198     return 0;
 199 }
 200 #endif
 201
 202 uint8_t matrix_scan(void)
 203 {
 204     if (is_master) {
 205         matrix_master_scan();
 206     }else{
 207         matrix_slave_scan();
 208         int offset = (isLeftHand) ? ROWS_PER_HAND : 0;
 209         memcpy(&matrix[offset],
 210                (void *)serial_master_buffer, sizeof(serial_master_buffer));
 211         matrix_scan_quantum();
 212     }
 213     return 1;
 214 }
 215
 216
 217 uint8_t matrix_master_scan(void) {
 218
 219     int ret = _matrix_scan();
 220     int mchanged = 1;
 221     int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
 222
 223 #ifdef USE_MATRIX_I2C
 224 //    for (int i = 0; i < ROWS_PER_HAND; ++i) {
 225         /* i2c_slave_buffer[i] = matrix[offset+i]; */
 226 //        i2c_slave_buffer[i] = matrix[offset+i];
 227 //    }
 228 #else // USE_SERIAL
 229   #ifdef SERIAL_USE_MULTI_TRANSACTION
 230     mchanged = memcmp((void *)serial_master_buffer,
 231                       &matrix[offset], sizeof(serial_master_buffer));
 232   #endif
 233     memcpy((void *)serial_master_buffer,
 234            &matrix[offset], sizeof(serial_master_buffer));
 235 #endif
 236
 237 #ifdef USE_MATRIX_I2C
 238     if( i2c_transaction() ) {
 239 #else // USE_SERIAL
 240     if( serial_transaction(mchanged) ) {
 241 #endif
 242         // turn on the indicator led when halves are disconnected
 243         TXLED1;
 244
 245         error_count++;
 246
 247         if (error_count > ERROR_DISCONNECT_COUNT) {
 248             // reset other half if disconnected
 249             int slaveOffset = (isLeftHand) ? (ROWS_PER_HAND) : 0;
 250             for (int i = 0; i < ROWS_PER_HAND; ++i) {
 251                 matrix[slaveOffset+i] = 0;
 252             }
 253         }
 254     } else {
 255         // turn off the indicator led on no error
 256         TXLED0;
 257         error_count = 0;
 258     }
 259     matrix_scan_quantum();
 260     return ret;
 261 }
 262
 263 void matrix_slave_scan(void) {
 264     _matrix_scan();
 265
 266     int offset = (isLeftHand) ? 0 : ROWS_PER_HAND;
 267
 268 #ifdef USE_MATRIX_I2C
 269     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 270         /* i2c_slave_buffer[i] = matrix[offset+i]; */
 271         i2c_slave_buffer[i] = matrix[offset+i];
 272     }
 273 #else // USE_SERIAL
 274   #ifdef SERIAL_USE_MULTI_TRANSACTION
 275     int change = 0;
 276   #endif
 277     for (int i = 0; i < ROWS_PER_HAND; ++i) {
 278   #ifdef SERIAL_USE_MULTI_TRANSACTION
 279         if( serial_slave_buffer[i] != matrix[offset+i] )
 280             change = 1;
 281   #endif
 282         serial_slave_buffer[i] = matrix[offset+i];
 283     }
 284   #ifdef SERIAL_USE_MULTI_TRANSACTION
 285     slave_buffer_change_count += change;
 286   #endif
 287 #endif
 288 }
 289
 290 bool matrix_is_modified(void)
 291 {
 292     if (debouncing) return false;
 293     return true;
 294 }
 295
 296 inline
 297 bool matrix_is_on(uint8_t row, uint8_t col)
 298 {
 299     return (matrix[row] & ((matrix_row_t)1<<col));
 300 }
 301
 302 inline
 303 matrix_row_t matrix_get_row(uint8_t row)
 304 {
 305     return matrix[row];
 306 }
 307
 308 void matrix_print(void)
 309 {
 310     print("\nr/c 0123456789ABCDEF\n");
 311     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 312         phex(row); print(": ");
 313         pbin_reverse16(matrix_get_row(row));
 314         print("\n");
 315     }
 316 }
 317
 318 uint8_t matrix_key_count(void)
 319 {
 320     uint8_t count = 0;
 321     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 322         count += bitpop16(matrix[i]);
 323     }
 324     return count;
 325 }
 326
 327 static void  init_cols(void)
 328 {
 329     for(int x = 0; x < MATRIX_COLS; x++) {
 330         _SFR_IO8((col_pins[x] >> 4) + 1) &=  ~_BV(col_pins[x] & 0xF);
 331         _SFR_IO8((col_pins[x] >> 4) + 2) |= _BV(col_pins[x] & 0xF);
 332     }
 333 }
 334
 335 static matrix_row_t read_cols(void)
 336 {
 337     matrix_row_t result = 0;
 338     for(int x = 0; x < MATRIX_COLS; x++) {
 339         result |= (_SFR_IO8(col_pins[x] >> 4) & _BV(col_pins[x] & 0xF)) ? 0 : (1 << x);
 340     }
 341     return result;
 342 }
 343
 344 static void unselect_rows(void)
 345 {
 346     for(int x = 0; x < ROWS_PER_HAND; x++) {
 347         _SFR_IO8((row_pins[x] >> 4) + 1) &=  ~_BV(row_pins[x] & 0xF);
 348         _SFR_IO8((row_pins[x] >> 4) + 2) |= _BV(row_pins[x] & 0xF);
 349     }
 350 }
 351
 352 static void select_row(uint8_t row)
 353 {
 354     _SFR_IO8((row_pins[row] >> 4) + 1) |=  _BV(row_pins[row] & 0xF);
 355     _SFR_IO8((row_pins[row] >> 4) + 2) &= ~_BV(row_pins[row] & 0xF);
 356 }