151 lines
4.9 KiB
C
151 lines
4.9 KiB
C
/*
|
|
Copyright 2017 Alex Ong<the.onga@gmail.com>
|
|
Copyright 2021 Simon Arlott
|
|
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/>.
|
|
*/
|
|
|
|
/*
|
|
Basic per-key algorithm. Uses an 8-bit counter per key.
|
|
After pressing a key, it immediately changes state, and sets a counter.
|
|
No further inputs are accepted until DEBOUNCE milliseconds have occurred.
|
|
*/
|
|
|
|
#include "matrix.h"
|
|
#include "timer.h"
|
|
#include "quantum.h"
|
|
#include <stdlib.h>
|
|
|
|
#ifdef PROTOCOL_CHIBIOS
|
|
# if CH_CFG_USE_MEMCORE == FALSE
|
|
# error ChibiOS is configured without a memory allocator. Your keyboard may have set `#define CH_CFG_USE_MEMCORE FALSE`, which is incompatible with this debounce algorithm.
|
|
# endif
|
|
#endif
|
|
|
|
#ifndef DEBOUNCE
|
|
# define DEBOUNCE 5
|
|
#endif
|
|
|
|
// Maximum debounce: 255ms
|
|
#if DEBOUNCE > UINT8_MAX
|
|
# undef DEBOUNCE
|
|
# define DEBOUNCE UINT8_MAX
|
|
#endif
|
|
|
|
#define ROW_SHIFTER ((matrix_row_t)1)
|
|
|
|
typedef uint8_t debounce_counter_t;
|
|
|
|
#if DEBOUNCE > 0
|
|
static debounce_counter_t *debounce_counters;
|
|
static fast_timer_t last_time;
|
|
static bool counters_need_update;
|
|
static bool matrix_need_update;
|
|
static bool cooked_changed;
|
|
|
|
# define DEBOUNCE_ELAPSED 0
|
|
|
|
static void update_debounce_counters(uint8_t num_rows, uint8_t elapsed_time);
|
|
static void transfer_matrix_values(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows);
|
|
|
|
// we use num_rows rather than MATRIX_ROWS to support split keyboards
|
|
void debounce_init(uint8_t num_rows) {
|
|
debounce_counters = (debounce_counter_t *)malloc(num_rows * MATRIX_COLS * sizeof(debounce_counter_t));
|
|
int i = 0;
|
|
for (uint8_t r = 0; r < num_rows; r++) {
|
|
for (uint8_t c = 0; c < MATRIX_COLS; c++) {
|
|
debounce_counters[i++] = DEBOUNCE_ELAPSED;
|
|
}
|
|
}
|
|
}
|
|
|
|
void debounce_free(void) {
|
|
free(debounce_counters);
|
|
debounce_counters = NULL;
|
|
}
|
|
|
|
bool debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool changed) {
|
|
bool updated_last = false;
|
|
cooked_changed = false;
|
|
|
|
if (counters_need_update) {
|
|
fast_timer_t now = timer_read_fast();
|
|
fast_timer_t elapsed_time = TIMER_DIFF_FAST(now, last_time);
|
|
|
|
last_time = now;
|
|
updated_last = true;
|
|
if (elapsed_time > UINT8_MAX) {
|
|
elapsed_time = UINT8_MAX;
|
|
}
|
|
|
|
if (elapsed_time > 0) {
|
|
update_debounce_counters(num_rows, elapsed_time);
|
|
}
|
|
}
|
|
|
|
if (changed || matrix_need_update) {
|
|
if (!updated_last) {
|
|
last_time = timer_read_fast();
|
|
}
|
|
|
|
transfer_matrix_values(raw, cooked, num_rows);
|
|
}
|
|
|
|
return cooked_changed;
|
|
}
|
|
|
|
// If the current time is > debounce counter, set the counter to enable input.
|
|
static void update_debounce_counters(uint8_t num_rows, uint8_t elapsed_time) {
|
|
counters_need_update = false;
|
|
matrix_need_update = false;
|
|
debounce_counter_t *debounce_pointer = debounce_counters;
|
|
for (uint8_t row = 0; row < num_rows; row++) {
|
|
for (uint8_t col = 0; col < MATRIX_COLS; col++) {
|
|
if (*debounce_pointer != DEBOUNCE_ELAPSED) {
|
|
if (*debounce_pointer <= elapsed_time) {
|
|
*debounce_pointer = DEBOUNCE_ELAPSED;
|
|
matrix_need_update = true;
|
|
} else {
|
|
*debounce_pointer -= elapsed_time;
|
|
counters_need_update = true;
|
|
}
|
|
}
|
|
debounce_pointer++;
|
|
}
|
|
}
|
|
}
|
|
|
|
// upload from raw_matrix to final matrix;
|
|
static void transfer_matrix_values(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows) {
|
|
debounce_counter_t *debounce_pointer = debounce_counters;
|
|
for (uint8_t row = 0; row < num_rows; row++) {
|
|
matrix_row_t delta = raw[row] ^ cooked[row];
|
|
matrix_row_t existing_row = cooked[row];
|
|
for (uint8_t col = 0; col < MATRIX_COLS; col++) {
|
|
matrix_row_t col_mask = (ROW_SHIFTER << col);
|
|
if (delta & col_mask) {
|
|
if (*debounce_pointer == DEBOUNCE_ELAPSED) {
|
|
*debounce_pointer = DEBOUNCE;
|
|
counters_need_update = true;
|
|
existing_row ^= col_mask; // flip the bit.
|
|
cooked_changed = true;
|
|
}
|
|
}
|
|
debounce_pointer++;
|
|
}
|
|
cooked[row] = existing_row;
|
|
}
|
|
}
|
|
|
|
#else
|
|
# include "none.c"
|
|
#endif
|