keyboards/handwired/promethium/matrix.c

   1 /*
   2 Copyright 2012 Jun Wako
   3 Copyright 2014 Jack Humbert
   4 Copyright 2017 Priyadi Iman Nurcahyo
   5
   6 This program is free software: you can redistribute it and/or modify
   7 it under the terms of the GNU General Public License as published by
   8 the Free Software Foundation, either version 2 of the License, or
   9 (at your option) any later version.
  10
  11 This program is distributed in the hope that it will be useful,
  12 but WITHOUT ANY WARRANTY; without even the implied warranty of
  13 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14 GNU General Public License for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18 */
  19 #include <stdint.h>
  20 #include <stdbool.h>
  21 #if defined(__AVR__)
  22 #include <avr/io.h>
  23 #endif
  24 #include "wait.h"
  25 #include "print.h"
  26 #include "debug.h"
  27 #include "util.h"
  28 #include "matrix.h"
  29 #include "timer.h"
  30
  31
  32 /* Set 0 if debouncing isn't needed */
  33
  34 #ifndef DEBOUNCING_DELAY
  35 #   define DEBOUNCING_DELAY 5
  36 #endif
  37
  38 #if (DEBOUNCING_DELAY > 0)
  39     static uint16_t debouncing_time;
  40     static bool debouncing = false;
  41 #endif
  42
  43 #if (MATRIX_COLS <= 8)
  44 #    define print_matrix_header()  print("\nr/c 01234567\n")
  45 #    define print_matrix_row(row)  print_bin_reverse8(matrix_get_row(row))
  46 #    define matrix_bitpop(i)       bitpop(matrix[i])
  47 #    define ROW_SHIFTER ((uint8_t)1)
  48 #elif (MATRIX_COLS <= 16)
  49 #    define print_matrix_header()  print("\nr/c 0123456789ABCDEF\n")
  50 #    define print_matrix_row(row)  print_bin_reverse16(matrix_get_row(row))
  51 #    define matrix_bitpop(i)       bitpop16(matrix[i])
  52 #    define ROW_SHIFTER ((uint16_t)1)
  53 #elif (MATRIX_COLS <= 32)
  54 #    define print_matrix_header()  print("\nr/c 0123456789ABCDEF0123456789ABCDEF\n")
  55 #    define print_matrix_row(row)  print_bin_reverse32(matrix_get_row(row))
  56 #    define matrix_bitpop(i)       bitpop32(matrix[i])
  57 #    define ROW_SHIFTER  ((uint32_t)1)
  58 #endif
  59
  60 #ifdef MATRIX_MASKED
  61     extern const matrix_row_t matrix_mask[];
  62 #endif
  63
  64 static const uint8_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
  65 static const uint8_t tp_pins[3] = TRACKPOINT_PINS;
  66
  67 /* matrix state(1:on, 0:off) */
  68 static matrix_row_t matrix[MATRIX_ROWS];
  69 static matrix_row_t matrix_debouncing[MATRIX_ROWS];
  70
  71 static void init_cols(void);
  72 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
  73 static void unselect_rows(void);
  74 static void select_row(uint8_t row);
  75 static void unselect_row(uint8_t row);
  76
  77
  78 __attribute__ ((weak))
  79 void matrix_init_kb(void) {
  80     matrix_init_user();
  81 }
  82
  83 __attribute__ ((weak))
  84 void matrix_scan_kb(void) {
  85     matrix_scan_user();
  86 }
  87
  88 __attribute__ ((weak))
  89 void matrix_init_user(void) {
  90 }
  91
  92 __attribute__ ((weak))
  93 void matrix_scan_user(void) {
  94 }
  95
  96 inline
  97 uint8_t matrix_rows(void) {
  98     return MATRIX_ROWS;
  99 }
 100
 101 inline
 102 uint8_t matrix_cols(void) {
 103     return MATRIX_COLS;
 104 }
 105
 106 void matrix_init(void) {
 107
 108     // To use PORTF disable JTAG with writing JTD bit twice within four cycles.
 109     #if  (defined(__AVR_AT90USB1286__) || defined(__AVR_AT90USB1287__) || defined(__AVR_ATmega32U4__))
 110         MCUCR |= _BV(JTD);
 111         MCUCR |= _BV(JTD);
 112     #endif
 113
 114     // initialize row and col
 115     unselect_rows();
 116     init_cols();
 117
 118     // initialize matrix state: all keys off
 119     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 120         matrix[i] = 0;
 121         matrix_debouncing[i] = 0;
 122     }
 123
 124     matrix_init_quantum();
 125 }
 126
 127 uint8_t matrix_scan(void)
 128 {
 129     // Set row, read cols
 130     for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
 131 #       if (DEBOUNCING_DELAY > 0)
 132             bool matrix_changed = read_cols_on_row(matrix_debouncing, current_row);
 133
 134             if (matrix_changed) {
 135                 debouncing = true;
 136                 debouncing_time = timer_read();
 137             }
 138
 139 #       else
 140             read_cols_on_row(matrix, current_row);
 141 #       endif
 142
 143     }
 144
 145 #   if (DEBOUNCING_DELAY > 0)
 146         if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
 147             for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 148                 matrix[i] = matrix_debouncing[i];
 149             }
 150             debouncing = false;
 151         }
 152 #   endif
 153
 154     matrix_scan_quantum();
 155     return 1;
 156 }
 157
 158 bool matrix_is_modified(void)
 159 {
 160 #if (DEBOUNCING_DELAY > 0)
 161     if (debouncing) return false;
 162 #endif
 163     return true;
 164 }
 165
 166 inline
 167 bool matrix_is_on(uint8_t row, uint8_t col)
 168
 169 {
 170     return (matrix[row] & ((matrix_row_t)1<col));
 171 }
 172
 173 inline
 174 matrix_row_t matrix_get_row(uint8_t row)
 175 {
 176     // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
 177     // switch blocker installed and the switch is always pressed.
 178 #ifdef MATRIX_MASKED
 179     return matrix[row] & matrix_mask[row];
 180 #else
 181     return matrix[row];
 182 #endif
 183 }
 184
 185 void matrix_print(void)
 186 {
 187     print_matrix_header();
 188
 189     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 190         phex(row); print(": ");
 191         print_matrix_row(row);
 192         print("\n");
 193     }
 194 }
 195
 196 uint8_t matrix_key_count(void)
 197 {
 198     uint8_t count = 0;
 199     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 200         count += matrix_bitpop(i);
 201     }
 202     return count;
 203 }
 204
 205
 206 #define ROW_MASK 0b11100000
 207
 208 static const uint8_t row_bit[MATRIX_ROWS] = {
 209   //  76543210
 210     0b00000000,
 211     0b00100000,
 212     0b01000000,
 213     0b01100000,
 214     0b10000000,
 215     0b10100000,
 216     0b11000000,
 217     0b11100000,
 218 };
 219
 220 static void init_cols(void)
 221 {
 222     // columns
 223     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 224         uint8_t pin = col_pins[x];
 225         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 226         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 227     }
 228
 229     // rows
 230     DDRF  |=  ROW_MASK;
 231     PORTF &= ~ROW_MASK;
 232
 233     // trackpoint
 234     for(uint8_t x = 0; x < 3; x++) {
 235         uint8_t pin = tp_pins[x];
 236         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 237         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 238     }
 239 }
 240
 241 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
 242     {
 243         // Store last value of row prior to reading
 244         matrix_row_t last_row_value = current_matrix[current_row];
 245
 246         // Clear data in matrix row
 247         current_matrix[current_row] = 0;
 248
 249         // special case for trackpoint
 250         if (current_row == 8) {
 251             for(uint8_t tp_index = 0; tp_index < 3; tp_index++) {
 252
 253                 // Select the TP pin to read (active low)
 254                 uint8_t pin = tp_pins[tp_index];
 255                 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 256
 257                 // Populate the matrix row with the state of the col pin
 258                 current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << tp_index);
 259             }
 260             return (last_row_value != current_matrix[current_row]);
 261         }
 262
 263         // Select row and wait for row selecton to stabilize
 264         select_row(current_row);
 265         _delay_us(5);       // without this wait it won't read stable value.
 266         // wait_us(50);
 267
 268         // For each col...
 269         for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 270
 271             // Select the col pin to read (active low)
 272             uint8_t pin = col_pins[col_index];
 273             uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 274
 275             // Populate the matrix row with the state of the col pin
 276             current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
 277         }
 278
 279         // Unselect row
 280         unselect_row(current_row);
 281
 282         return (last_row_value != current_matrix[current_row]);
 283 }
 284
 285 static void select_row(uint8_t row)
 286 {
 287     PORTF = row_bit[row] | (PORTF & ~ROW_MASK);
 288 }
 289
 290 static void unselect_row(uint8_t row)
 291 {
 292 }
 293
 294 static void unselect_rows(void)
 295 {
 296 }
 297