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 DEBOUNCE
  35 #   define DEBOUNCE 5
  36 #endif
  37
  38 #if (DEBOUNCE > 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     // initialize row and col
 108     unselect_rows();
 109     init_cols();
 110
 111     // initialize matrix state: all keys off
 112     for (uint8_t i=0; i < MATRIX_ROWS; i++) {
 113         matrix[i] = 0;
 114         matrix_debouncing[i] = 0;
 115     }
 116
 117     matrix_init_quantum();
 118 }
 119
 120 uint8_t matrix_scan(void)
 121 {
 122     // Set row, read cols
 123     for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
 124 #       if (DEBOUNCE > 0)
 125             bool matrix_changed = read_cols_on_row(matrix_debouncing, current_row);
 126
 127             if (matrix_changed) {
 128                 debouncing = true;
 129                 debouncing_time = timer_read();
 130             }
 131
 132 #       else
 133             read_cols_on_row(matrix, current_row);
 134 #       endif
 135
 136     }
 137
 138 #   if (DEBOUNCE > 0)
 139         if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCE)) {
 140             for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 141                 matrix[i] = matrix_debouncing[i];
 142             }
 143             debouncing = false;
 144         }
 145 #   endif
 146
 147     matrix_scan_quantum();
 148     return 1;
 149 }
 150
 151 bool matrix_is_modified(void)
 152 {
 153 #if (DEBOUNCE > 0)
 154     if (debouncing) return false;
 155 #endif
 156     return true;
 157 }
 158
 159 inline
 160 bool matrix_is_on(uint8_t row, uint8_t col)
 161
 162 {
 163     return (matrix[row] & ((matrix_row_t)1<<col));
 164 }
 165
 166 inline
 167 matrix_row_t matrix_get_row(uint8_t row)
 168 {
 169     // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
 170     // switch blocker installed and the switch is always pressed.
 171 #ifdef MATRIX_MASKED
 172     return matrix[row] & matrix_mask[row];
 173 #else
 174     return matrix[row];
 175 #endif
 176 }
 177
 178 void matrix_print(void)
 179 {
 180     print_matrix_header();
 181
 182     for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
 183         phex(row); print(": ");
 184         print_matrix_row(row);
 185         print("\n");
 186     }
 187 }
 188
 189 uint8_t matrix_key_count(void)
 190 {
 191     uint8_t count = 0;
 192     for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
 193         count += matrix_bitpop(i);
 194     }
 195     return count;
 196 }
 197
 198
 199 #define ROW_MASK 0b11100000
 200
 201 static const uint8_t row_bit[MATRIX_ROWS] = {
 202   //  76543210
 203     0b00000000,
 204     0b00100000,
 205     0b01000000,
 206     0b01100000,
 207     0b10000000,
 208     0b10100000,
 209     0b11000000,
 210     0b11100000,
 211 };
 212
 213 static void init_cols(void)
 214 {
 215     // columns
 216     for(uint8_t x = 0; x < MATRIX_COLS; x++) {
 217         uint8_t pin = col_pins[x];
 218         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 219         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 220     }
 221
 222     // rows
 223     DDRF  |=  ROW_MASK;
 224     PORTF &= ~ROW_MASK;
 225
 226     // trackpoint
 227     for(uint8_t x = 0; x < 3; x++) {
 228         uint8_t pin = tp_pins[x];
 229         _SFR_IO8((pin >> 4) + 1) &= ~_BV(pin & 0xF); // IN
 230         _SFR_IO8((pin >> 4) + 2) |=  _BV(pin & 0xF); // HI
 231     }
 232 }
 233
 234 static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
 235     {
 236         // Store last value of row prior to reading
 237         matrix_row_t last_row_value = current_matrix[current_row];
 238
 239         // Clear data in matrix row
 240         current_matrix[current_row] = 0;
 241
 242         // special case for trackpoint
 243         if (current_row == 8) {
 244             for(uint8_t tp_index = 0; tp_index < 3; tp_index++) {
 245
 246                 // Select the TP pin to read (active low)
 247                 uint8_t pin = tp_pins[tp_index];
 248                 uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 249
 250                 // Populate the matrix row with the state of the col pin
 251                 current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << tp_index);
 252             }
 253             return (last_row_value != current_matrix[current_row]);
 254         }
 255
 256         // Select row and wait for row selecton to stabilize
 257         select_row(current_row);
 258         _delay_us(5);       // without this wait it won't read stable value.
 259         // wait_us(50);
 260
 261         // For each col...
 262         for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
 263
 264             // Select the col pin to read (active low)
 265             uint8_t pin = col_pins[col_index];
 266             uint8_t pin_state = (_SFR_IO8(pin >> 4) & _BV(pin & 0xF));
 267
 268             // Populate the matrix row with the state of the col pin
 269             current_matrix[current_row] |=  pin_state ? 0 : (ROW_SHIFTER << col_index);
 270         }
 271
 272         // Unselect row
 273         unselect_row(current_row);
 274
 275         return (last_row_value != current_matrix[current_row]);
 276 }
 277
 278 static void select_row(uint8_t row)
 279 {
 280     PORTF = row_bit[row] | (PORTF & ~ROW_MASK);
 281 }
 282
 283 static void unselect_row(uint8_t row)
 284 {
 285 }
 286
 287 static void unselect_rows(void)
 288 {
 289 }