/*
-Copyright 2012 Jun Wako
-Copyright 2014 Jack Humbert
+Copyright 2012-2018 Jun Wako, Jack Humbert, Yiancar
This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
*/
#include <stdint.h>
#include <stdbool.h>
-#include <avr/io.h>
#include "wait.h"
#include "print.h"
#include "debug.h"
#include "util.h"
#include "matrix.h"
+#include "debounce.h"
+#include "quantum.h"
-#ifdef MATRIX_HAS_GHOST
-# error "The universal matrix.c file cannot be used for this keyboard."
+#if (MATRIX_COLS <= 8)
+# define print_matrix_header() print("\nr/c 01234567\n")
+# define print_matrix_row(row) print_bin_reverse8(matrix_get_row(row))
+# define matrix_bitpop(i) bitpop(matrix[i])
+# define ROW_SHIFTER ((uint8_t)1)
+#elif (MATRIX_COLS <= 16)
+# define print_matrix_header() print("\nr/c 0123456789ABCDEF\n")
+# define print_matrix_row(row) print_bin_reverse16(matrix_get_row(row))
+# define matrix_bitpop(i) bitpop16(matrix[i])
+# define ROW_SHIFTER ((uint16_t)1)
+#elif (MATRIX_COLS <= 32)
+# define print_matrix_header() print("\nr/c 0123456789ABCDEF0123456789ABCDEF\n")
+# define print_matrix_row(row) print_bin_reverse32(matrix_get_row(row))
+# define matrix_bitpop(i) bitpop32(matrix[i])
+# define ROW_SHIFTER ((uint32_t)1)
#endif
-#ifndef DEBOUNCING_DELAY
-# define DEBOUNCING_DELAY 5
+#ifdef MATRIX_MASKED
+ extern const matrix_row_t matrix_mask[];
#endif
-static const io_pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
-static const io_pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
-/* matrix state */
-#if DIODE_DIRECTION == COL2ROW
-static matrix_row_t matrix[MATRIX_ROWS];
-#else
-static matrix_col_t matrix[MATRIX_COLS];
+#ifdef DIRECT_PINS
+static pin_t direct_pins[MATRIX_ROWS][MATRIX_COLS] = DIRECT_PINS;
+#elif (DIODE_DIRECTION == ROW2COL) || (DIODE_DIRECTION == COL2ROW)
+static const pin_t row_pins[MATRIX_ROWS] = MATRIX_ROW_PINS;
+static const pin_t col_pins[MATRIX_COLS] = MATRIX_COL_PINS;
#endif
-static int8_t debouncing_delay = -1;
-#if DIODE_DIRECTION == COL2ROW
-static void toggle_row(uint8_t row);
-static matrix_row_t read_cols(void);
-#else
-static void toggle_col(uint8_t col);
-static matrix_col_t read_rows(void);
-#endif
+/* matrix state(1:on, 0:off) */
+static matrix_row_t raw_matrix[MATRIX_ROWS]; //raw values
+static matrix_row_t matrix[MATRIX_ROWS]; //debounced values
__attribute__ ((weak))
void matrix_init_quantum(void) {
+ matrix_init_kb();
}
__attribute__ ((weak))
void matrix_scan_quantum(void) {
+ matrix_scan_kb();
+}
+
+__attribute__ ((weak))
+void matrix_init_kb(void) {
+ matrix_init_user();
+}
+
+__attribute__ ((weak))
+void matrix_scan_kb(void) {
+ matrix_scan_user();
+}
+
+__attribute__ ((weak))
+void matrix_init_user(void) {
}
+__attribute__ ((weak))
+void matrix_scan_user(void) {
+}
+
+inline
uint8_t matrix_rows(void) {
return MATRIX_ROWS;
}
+inline
uint8_t matrix_cols(void) {
return MATRIX_COLS;
}
-void matrix_init(void) {
- /* frees PORTF by setting the JTD bit twice within four cycles */
- #ifdef __AVR_ATmega32U4__
- MCUCR |= _BV(JTD);
- MCUCR |= _BV(JTD);
- #endif
- /* initializes the I/O pins */
-#if DIODE_DIRECTION == COL2ROW
- for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
- /* DDRxn */
- _SFR_IO8(row_pins[r].input_addr + 1) |= _BV(row_pins[r].bit);
- toggle_row(r);
- }
- for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
- /* PORTxn */
- _SFR_IO8(col_pins[c].input_addr + 2) |= _BV(col_pins[c].bit);
- }
+//Deprecated.
+bool matrix_is_modified(void)
+{
+ if (debounce_active()) return false;
+ return true;
+}
+
+inline
+bool matrix_is_on(uint8_t row, uint8_t col)
+{
+ return (matrix[row] & ((matrix_row_t)1<<col));
+}
+
+inline
+matrix_row_t matrix_get_row(uint8_t row)
+{
+ // Matrix mask lets you disable switches in the returned matrix data. For example, if you have a
+ // switch blocker installed and the switch is always pressed.
+#ifdef MATRIX_MASKED
+ return matrix[row] & matrix_mask[row];
#else
- for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
- /* DDRxn */
- _SFR_IO8(col_pins[c].input_addr + 1) |= _BV(col_pins[c].bit);
- toggle_col(c);
- }
- for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
- /* PORTxn */
- _SFR_IO8(row_pins[r].input_addr + 2) |= _BV(row_pins[r].bit);
- }
+ return matrix[row];
#endif
- matrix_init_quantum();
}
-#if DIODE_DIRECTION == COL2ROW
-uint8_t matrix_scan(void) {
- static matrix_row_t debouncing_matrix[MATRIX_ROWS];
- for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
- toggle_row(r);
- matrix_row_t state = read_cols();
- if (debouncing_matrix[r] != state) {
- debouncing_matrix[r] = state;
- debouncing_delay = DEBOUNCING_DELAY;
- }
- toggle_row(r);
+void matrix_print(void)
+{
+ print_matrix_header();
+
+ for (uint8_t row = 0; row < MATRIX_ROWS; row++) {
+ phex(row); print(": ");
+ print_matrix_row(row);
+ print("\n");
}
- if (debouncing_delay >= 0) {
- dprintf("Debouncing delay remaining: %X\n", debouncing_delay);
- --debouncing_delay;
- if (debouncing_delay >= 0) {
- wait_ms(1);
- }
- else {
- for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
- matrix[r] = debouncing_matrix[r];
- }
- }
+}
+
+uint8_t matrix_key_count(void)
+{
+ uint8_t count = 0;
+ for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
+ count += matrix_bitpop(i);
}
- matrix_scan_quantum();
- return 1;
+ return count;
}
-static void toggle_row(uint8_t row) {
- /* PINxn */
- _SFR_IO8(row_pins[row].input_addr) = _BV(row_pins[row].bit);
+
+#ifdef DIRECT_PINS
+
+static void init_pins(void) {
+ for (int row = 0; row < MATRIX_ROWS; row++) {
+ for (int col = 0; col < MATRIX_COLS; col++) {
+ pin_t pin = direct_pins[row][col];
+ if (pin != NO_PIN) {
+ setPinInputHigh(pin);
+ }
+ }
+ }
}
-static matrix_row_t read_cols(void) {
- matrix_row_t state = 0;
- for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
- /* PINxn */
- if (!(_SFR_IO8(col_pins[c].input_addr) & _BV(col_pins[c].bit))) {
- state |= (matrix_row_t)1 << c;
- }
+static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row) {
+ matrix_row_t last_row_value = current_matrix[current_row];
+ current_matrix[current_row] = 0;
+
+ for (uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
+ pin_t pin = direct_pins[current_row][col_index];
+ if (pin != NO_PIN) {
+ current_matrix[current_row] |= readPin(pin) ? 0 : (ROW_SHIFTER << col_index);
}
- return state;
+ }
+
+ return (last_row_value != current_matrix[current_row]);
}
-matrix_row_t matrix_get_row(uint8_t row) {
- return matrix[row];
+#elif (DIODE_DIRECTION == COL2ROW)
+
+static void select_row(uint8_t row)
+{
+ setPinOutput(row_pins[row]);
+ writePinLow(row_pins[row]);
}
-#else
-uint8_t matrix_scan(void) {
- static matrix_col_t debouncing_matrix[MATRIX_COLS];
- for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
- toggle_col(c);
- matrix_col_t state = read_rows();
- if (debouncing_matrix[c] != state) {
- debouncing_matrix[c] = state;
- debouncing_delay = DEBOUNCING_DELAY;
- }
- toggle_col(c);
+static void unselect_row(uint8_t row)
+{
+ setPinInputHigh(row_pins[row]);
+}
+
+static void unselect_rows(void)
+{
+ for(uint8_t x = 0; x < MATRIX_ROWS; x++) {
+ setPinInputHigh(row_pins[x]);
}
- if (debouncing_delay >= 0) {
- dprintf("Debouncing delay remaining: %X\n", debouncing_delay);
- --debouncing_delay;
- if (debouncing_delay >= 0) {
- wait_ms(1);
- }
- else {
- for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
- matrix[c] = debouncing_matrix[c];
- }
- }
+}
+
+static void init_pins(void) {
+ unselect_rows();
+ for (uint8_t x = 0; x < MATRIX_COLS; x++) {
+ setPinInputHigh(col_pins[x]);
+ }
+}
+
+static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row)
+{
+ // Store last value of row prior to reading
+ matrix_row_t last_row_value = current_matrix[current_row];
+
+ // Clear data in matrix row
+ current_matrix[current_row] = 0;
+
+ // Select row and wait for row selecton to stabilize
+ select_row(current_row);
+ wait_us(30);
+
+ // For each col...
+ for(uint8_t col_index = 0; col_index < MATRIX_COLS; col_index++) {
+
+ // Select the col pin to read (active low)
+ uint8_t pin_state = readPin(col_pins[col_index]);
+
+ // Populate the matrix row with the state of the col pin
+ current_matrix[current_row] |= pin_state ? 0 : (ROW_SHIFTER << col_index);
}
- matrix_scan_quantum();
- return 1;
+
+ // Unselect row
+ unselect_row(current_row);
+
+ return (last_row_value != current_matrix[current_row]);
}
-static void toggle_col(uint8_t col) {
- /* PINxn */
- _SFR_IO8(col_pins[col].input_addr) = _BV(col_pins[col].bit);
+#elif (DIODE_DIRECTION == ROW2COL)
+
+static void select_col(uint8_t col)
+{
+ setPinOutput(col_pins[col]);
+ writePinLow(col_pins[col]);
}
-static matrix_col_t read_rows(void) {
- matrix_col_t state = 0;
- for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
- /* PINxn */
- if (!(_SFR_IO8(row_pins[r].input_addr) & _BV(row_pins[r].bit))) {
- state |= (matrix_col_t)1 << r;
- }
+static void unselect_col(uint8_t col)
+{
+ setPinInputHigh(col_pins[col]);
+}
+
+static void unselect_cols(void)
+{
+ for(uint8_t x = 0; x < MATRIX_COLS; x++) {
+ setPinInputHigh(col_pins[x]);
}
- return state;
}
-matrix_row_t matrix_get_row(uint8_t row) {
- matrix_row_t state = 0;
- matrix_col_t mask = (matrix_col_t)1 << row;
- for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
- if (matrix[c] & mask) {
- state |= (matrix_row_t)1 << c;
+static void init_pins(void) {
+ unselect_cols();
+ for (uint8_t x = 0; x < MATRIX_ROWS; x++) {
+ setPinInputHigh(row_pins[x]);
+ }
+}
+
+static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col)
+{
+ bool matrix_changed = false;
+
+ // Select col and wait for col selecton to stabilize
+ select_col(current_col);
+ wait_us(30);
+
+ // For each row...
+ for(uint8_t row_index = 0; row_index < MATRIX_ROWS; row_index++)
+ {
+
+ // Store last value of row prior to reading
+ matrix_row_t last_row_value = current_matrix[row_index];
+
+ // Check row pin state
+ if (readPin(row_pins[row_index]) == 0)
+ {
+ // Pin LO, set col bit
+ current_matrix[row_index] |= (ROW_SHIFTER << current_col);
+ }
+ else
+ {
+ // Pin HI, clear col bit
+ current_matrix[row_index] &= ~(ROW_SHIFTER << current_col);
+ }
+
+ // Determine if the matrix changed state
+ if ((last_row_value != current_matrix[row_index]) && !(matrix_changed))
+ {
+ matrix_changed = true;
}
}
- return state;
+
+ // Unselect col
+ unselect_col(current_col);
+
+ return matrix_changed;
}
#endif
-bool matrix_is_modified(void) {
- if (debouncing_delay >= 0) return false;
- return true;
-}
+void matrix_init(void) {
-bool matrix_is_on(uint8_t row, uint8_t col) {
- return matrix_get_row(row) & (matrix_row_t)1 << col;
-}
+ // initialize key pins
+ init_pins();
-void matrix_print(void) {
- dprintln("Human-readable matrix state:");
- for (uint8_t r = 0; r < MATRIX_ROWS; r++) {
- dprintf("State of row %X: %016b\n", r, bitrev16(matrix_get_row(r)));
+ // initialize matrix state: all keys off
+ for (uint8_t i=0; i < MATRIX_ROWS; i++) {
+ raw_matrix[i] = 0;
+ matrix[i] = 0;
}
+
+ debounce_init(MATRIX_ROWS);
+
+ matrix_init_quantum();
}
-uint8_t matrix_key_count(void) {
- uint8_t count = 0;
- for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
- count += bitpop16(matrix_get_row(r));
- }
- return count;
+uint8_t matrix_scan(void)
+{
+ bool changed = false;
+
+#if defined(DIRECT_PINS) || (DIODE_DIRECTION == COL2ROW)
+ // Set row, read cols
+ for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
+ changed |= read_cols_on_row(raw_matrix, current_row);
+ }
+#elif (DIODE_DIRECTION == ROW2COL)
+ // Set col, read rows
+ for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
+ changed |= read_rows_on_col(raw_matrix, current_col);
+ }
+#endif
+
+ debounce(raw_matrix, matrix, MATRIX_ROWS, changed);
+
+ matrix_scan_quantum();
+ return (uint8_t)changed;
}