7fe03d085c
* Update quantum matrix to support both AVR and Chibios ARM - Addition of STM32 pin definitions - Created abstruction layer defines to control GPIO (This is a bit pointless for Chibios as we are creating a PAL ontop of a PAL but it is necessary for uniformity with AVR) - Modified matrix.c to use the above functions * minor ifdef fix * Rename of functions and docs - Added documentation. - Renamed functions according to Jack's spec. * Massdrop fix * Update matrix.c * Update quantum.h * Update quantum.h * Update quantum.h * Update internals_gpio_control.md
389 lines
9.4 KiB
C
389 lines
9.4 KiB
C
/*
|
|
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
|
|
the Free Software Foundation, either version 2 of the License, or
|
|
(at your option) any later version.
|
|
|
|
This program is distributed in the hope that it will be useful,
|
|
but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
GNU General Public License for more details.
|
|
|
|
You should have received a copy of the GNU General Public License
|
|
along with this program. If not, see <http://www.gnu.org/licenses/>.
|
|
*/
|
|
#include <stdint.h>
|
|
#include <stdbool.h>
|
|
#include "wait.h"
|
|
#include "print.h"
|
|
#include "debug.h"
|
|
#include "util.h"
|
|
#include "matrix.h"
|
|
#include "timer.h"
|
|
#include "quantum.h"
|
|
|
|
|
|
/* Set 0 if debouncing isn't needed */
|
|
|
|
#ifndef DEBOUNCING_DELAY
|
|
# define DEBOUNCING_DELAY 5
|
|
#endif
|
|
|
|
#if (DEBOUNCING_DELAY > 0)
|
|
static uint16_t debouncing_time;
|
|
static bool debouncing = false;
|
|
#endif
|
|
|
|
#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
|
|
|
|
#ifdef MATRIX_MASKED
|
|
extern const matrix_row_t matrix_mask[];
|
|
#endif
|
|
|
|
#if (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
|
|
|
|
/* matrix state(1:on, 0:off) */
|
|
static matrix_row_t matrix[MATRIX_ROWS];
|
|
|
|
static matrix_row_t matrix_debouncing[MATRIX_ROWS];
|
|
|
|
|
|
#if (DIODE_DIRECTION == COL2ROW)
|
|
static void init_cols(void);
|
|
static bool read_cols_on_row(matrix_row_t current_matrix[], uint8_t current_row);
|
|
static void unselect_rows(void);
|
|
static void select_row(uint8_t row);
|
|
static void unselect_row(uint8_t row);
|
|
#elif (DIODE_DIRECTION == ROW2COL)
|
|
static void init_rows(void);
|
|
static bool read_rows_on_col(matrix_row_t current_matrix[], uint8_t current_col);
|
|
static void unselect_cols(void);
|
|
static void unselect_col(uint8_t col);
|
|
static void select_col(uint8_t col);
|
|
#endif
|
|
|
|
__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_power_up(void) {
|
|
// #if (DIODE_DIRECTION == COL2ROW)
|
|
// for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
|
|
// /* DDRxn */
|
|
// _SFR_IO8((row_pins[r] >> 4) + 1) |= _BV(row_pins[r] & 0xF);
|
|
// toggle_row(r);
|
|
// }
|
|
// for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
|
|
// /* PORTxn */
|
|
// _SFR_IO8((col_pins[c] >> 4) + 2) |= _BV(col_pins[c] & 0xF);
|
|
// }
|
|
// #elif (DIODE_DIRECTION == ROW2COL)
|
|
// for (int8_t c = MATRIX_COLS - 1; c >= 0; --c) {
|
|
// /* DDRxn */
|
|
// _SFR_IO8((col_pins[c] >> 4) + 1) |= _BV(col_pins[c] & 0xF);
|
|
// toggle_col(c);
|
|
// }
|
|
// for (int8_t r = MATRIX_ROWS - 1; r >= 0; --r) {
|
|
// /* PORTxn */
|
|
// _SFR_IO8((row_pins[r] >> 4) + 2) |= _BV(row_pins[r] & 0xF);
|
|
// }
|
|
// #endif
|
|
// }
|
|
|
|
void matrix_init(void) {
|
|
|
|
// initialize row and col
|
|
#if (DIODE_DIRECTION == COL2ROW)
|
|
unselect_rows();
|
|
init_cols();
|
|
#elif (DIODE_DIRECTION == ROW2COL)
|
|
unselect_cols();
|
|
init_rows();
|
|
#endif
|
|
|
|
// initialize matrix state: all keys off
|
|
for (uint8_t i=0; i < MATRIX_ROWS; i++) {
|
|
matrix[i] = 0;
|
|
matrix_debouncing[i] = 0;
|
|
}
|
|
|
|
matrix_init_quantum();
|
|
}
|
|
|
|
uint8_t matrix_scan(void)
|
|
{
|
|
|
|
#if (DIODE_DIRECTION == COL2ROW)
|
|
|
|
// Set row, read cols
|
|
for (uint8_t current_row = 0; current_row < MATRIX_ROWS; current_row++) {
|
|
# if (DEBOUNCING_DELAY > 0)
|
|
bool matrix_changed = read_cols_on_row(matrix_debouncing, current_row);
|
|
|
|
if (matrix_changed) {
|
|
debouncing = true;
|
|
debouncing_time = timer_read();
|
|
}
|
|
|
|
# else
|
|
read_cols_on_row(matrix, current_row);
|
|
# endif
|
|
|
|
}
|
|
|
|
#elif (DIODE_DIRECTION == ROW2COL)
|
|
|
|
// Set col, read rows
|
|
for (uint8_t current_col = 0; current_col < MATRIX_COLS; current_col++) {
|
|
# if (DEBOUNCING_DELAY > 0)
|
|
bool matrix_changed = read_rows_on_col(matrix_debouncing, current_col);
|
|
if (matrix_changed) {
|
|
debouncing = true;
|
|
debouncing_time = timer_read();
|
|
}
|
|
# else
|
|
read_rows_on_col(matrix, current_col);
|
|
# endif
|
|
|
|
}
|
|
|
|
#endif
|
|
|
|
# if (DEBOUNCING_DELAY > 0)
|
|
if (debouncing && (timer_elapsed(debouncing_time) > DEBOUNCING_DELAY)) {
|
|
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
|
|
matrix[i] = matrix_debouncing[i];
|
|
}
|
|
debouncing = false;
|
|
}
|
|
# endif
|
|
|
|
matrix_scan_quantum();
|
|
return 1;
|
|
}
|
|
|
|
bool matrix_is_modified(void)
|
|
{
|
|
#if (DEBOUNCING_DELAY > 0)
|
|
if (debouncing) return false;
|
|
#endif
|
|
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
|
|
return matrix[row];
|
|
#endif
|
|
}
|
|
|
|
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");
|
|
}
|
|
}
|
|
|
|
uint8_t matrix_key_count(void)
|
|
{
|
|
uint8_t count = 0;
|
|
for (uint8_t i = 0; i < MATRIX_ROWS; i++) {
|
|
count += matrix_bitpop(i);
|
|
}
|
|
return count;
|
|
}
|
|
|
|
|
|
|
|
#if (DIODE_DIRECTION == COL2ROW)
|
|
|
|
static void init_cols(void)
|
|
{
|
|
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);
|
|
}
|
|
|
|
// Unselect row
|
|
unselect_row(current_row);
|
|
|
|
return (last_row_value != current_matrix[current_row]);
|
|
}
|
|
|
|
static void select_row(uint8_t row)
|
|
{
|
|
setPinOutput(row_pins[row]);
|
|
writePinLow(row_pins[row]);
|
|
}
|
|
|
|
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++) {
|
|
setPinInput(row_pins[x]);
|
|
}
|
|
}
|
|
|
|
#elif (DIODE_DIRECTION == ROW2COL)
|
|
|
|
static void init_rows(void)
|
|
{
|
|
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;
|
|
}
|
|
}
|
|
|
|
// Unselect col
|
|
unselect_col(current_col);
|
|
|
|
return matrix_changed;
|
|
}
|
|
|
|
static void select_col(uint8_t col)
|
|
{
|
|
setPinOutput(col_pins[col]);
|
|
writePinLow(col_pins[col]);
|
|
}
|
|
|
|
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]);
|
|
}
|
|
}
|
|
|
|
#endif
|