aboutsummaryrefslogtreecommitdiff
path: root/quantum/debounce/sym_defer_pk.c
diff options
context:
space:
mode:
Diffstat (limited to 'quantum/debounce/sym_defer_pk.c')
-rw-r--r--quantum/debounce/sym_defer_pk.c149
1 files changed, 69 insertions, 80 deletions
diff --git a/quantum/debounce/sym_defer_pk.c b/quantum/debounce/sym_defer_pk.c
index 156535a373..063094efe5 100644
--- a/quantum/debounce/sym_defer_pk.c
+++ b/quantum/debounce/sym_defer_pk.c
@@ -1,33 +1,14 @@
-/*
-Copyright 2017 Alex Ong<[email protected]>
-Copyright 2020 Andrei Purdea<[email protected]>
-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 symmetric per-key algorithm. Uses an 8-bit counter per key.
-When no state changes have occured for DEBOUNCE milliseconds, we push the state.
-*/
+// Copyright 2017 Alex Ong<[email protected]>
+// Copyright 2020 Andrei Purdea<[email protected]>
+// Copyright 2021 Simon Arlott
+// SPDX-License-Identifier: GPL-2.0-or-later
+//
+// Basic symmetric per-key algorithm. Uses an 8-bit counter per key.
+// When no state changes have occured for DEBOUNCE milliseconds, we push the state.
#include "debounce.h"
#include "timer.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
+#include "util.h"
#ifndef DEBOUNCE
# define DEBOUNCE 5
@@ -39,40 +20,24 @@ When no state changes have occured for DEBOUNCE milliseconds, we push the state.
# define DEBOUNCE UINT8_MAX
#endif
-#define ROW_SHIFTER ((matrix_row_t)1)
+#define DEBOUNCE_ELAPSED 0
+#if DEBOUNCE > 0
typedef uint8_t debounce_counter_t;
+// Uses MATRIX_ROWS_PER_HAND instead of MATRIX_ROWS to support split keyboards
+static debounce_counter_t debounce_counters[MATRIX_ROWS_PER_HAND * MATRIX_COLS] = {DEBOUNCE_ELAPSED};
+static bool counters_need_update;
+static bool cooked_changed;
-#if DEBOUNCE > 0
-static debounce_counter_t *debounce_counters;
-static fast_timer_t last_time;
-static bool counters_need_update;
-static bool cooked_changed;
-
-# define DEBOUNCE_ELAPSED 0
-
-static void update_debounce_counters_and_transfer_if_expired(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, uint8_t elapsed_time);
-static void start_debounce_counters(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;
- }
- }
-}
+static inline void update_debounce_counters_and_transfer_if_expired(matrix_row_t raw[], matrix_row_t cooked[], uint8_t elapsed_time);
+static inline void start_debounce_counters(matrix_row_t raw[], matrix_row_t cooked[]);
-void debounce_free(void) {
- free(debounce_counters);
- debounce_counters = NULL;
-}
+void debounce_init(uint8_t num_rows) {}
bool debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool changed) {
- bool updated_last = false;
- cooked_changed = false;
+ static fast_timer_t last_time;
+ bool updated_last = false;
+ cooked_changed = false;
if (counters_need_update) {
fast_timer_t now = timer_read_fast();
@@ -80,12 +45,10 @@ bool debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool
last_time = now;
updated_last = true;
- if (elapsed_time > UINT8_MAX) {
- elapsed_time = UINT8_MAX;
- }
if (elapsed_time > 0) {
- update_debounce_counters_and_transfer_if_expired(raw, cooked, num_rows, elapsed_time);
+ // Update debounce counters with elapsed timer clamped to UINT8_MAX
+ update_debounce_counters_and_transfer_if_expired(raw, cooked, MIN(elapsed_time, UINT8_MAX));
}
}
@@ -94,47 +57,73 @@ bool debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool
last_time = timer_read_fast();
}
- start_debounce_counters(raw, cooked, num_rows);
+ start_debounce_counters(raw, cooked);
}
return cooked_changed;
}
-static void update_debounce_counters_and_transfer_if_expired(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, uint8_t elapsed_time) {
- counters_need_update = false;
- debounce_counter_t *debounce_pointer = debounce_counters;
- for (uint8_t row = 0; row < num_rows; row++) {
+/**
+ * @brief Updates debounce counters and transfers debounced key states if the debounce period has expired.
+ *
+ * Iterates through each key in the matrix and checks its debounce counter. If the debounce period has expired
+ * for a key, the debounced state is updated to match the raw state. Otherwise, the debounce counter is decremented
+ * by the elapsed time and marked for further updates.
+ *
+ * @param raw The current raw key state matrix.
+ * @param cooked The debounced key state matrix to be updated.
+ * @param elapsed_time The time elapsed since the last debounce update, in milliseconds.
+ */
+static inline void update_debounce_counters_and_transfer_if_expired(matrix_row_t raw[], matrix_row_t cooked[], uint8_t elapsed_time) {
+ counters_need_update = false;
+ for (uint8_t row = 0; row < MATRIX_ROWS_PER_HAND; row++) {
+ uint16_t row_offset = row * MATRIX_COLS;
+
for (uint8_t col = 0; col < MATRIX_COLS; col++) {
- if (*debounce_pointer != DEBOUNCE_ELAPSED) {
- if (*debounce_pointer <= elapsed_time) {
- *debounce_pointer = DEBOUNCE_ELAPSED;
- matrix_row_t cooked_next = (cooked[row] & ~(ROW_SHIFTER << col)) | (raw[row] & (ROW_SHIFTER << col));
+ uint16_t index = row_offset + col;
+
+ if (debounce_counters[index] != DEBOUNCE_ELAPSED) {
+ if (debounce_counters[index] <= elapsed_time) {
+ debounce_counters[index] = DEBOUNCE_ELAPSED;
+ matrix_row_t col_mask = (MATRIX_ROW_SHIFTER << col);
+ matrix_row_t cooked_next = (cooked[row] & ~col_mask) | (raw[row] & col_mask);
cooked_changed |= cooked[row] ^ cooked_next;
cooked[row] = cooked_next;
} else {
- *debounce_pointer -= elapsed_time;
+ debounce_counters[index] -= elapsed_time;
counters_need_update = true;
}
}
- debounce_pointer++;
}
}
}
-static void start_debounce_counters(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];
+/**
+ * @brief Initializes debounce counters for keys with changed states.
+ *
+ * For each key in the matrix, this function checks if the raw state differs from the debounced state.
+ * If a change is detected and the debounce counter has elapsed, the counter is set to the debounce period
+ * and marked for update. Otherwise, the counter is cleared.
+ *
+ * @param raw The current raw key state matrix.
+ * @param cooked The debounced key state matrix.
+ */
+static inline void start_debounce_counters(matrix_row_t raw[], matrix_row_t cooked[]) {
+ for (uint8_t row = 0; row < MATRIX_ROWS_PER_HAND; row++) {
+ uint16_t row_offset = row * MATRIX_COLS;
+ matrix_row_t delta = raw[row] ^ cooked[row];
+
for (uint8_t col = 0; col < MATRIX_COLS; col++) {
- if (delta & (ROW_SHIFTER << col)) {
- if (*debounce_pointer == DEBOUNCE_ELAPSED) {
- *debounce_pointer = DEBOUNCE;
- counters_need_update = true;
+ uint16_t index = row_offset + col;
+
+ if (delta & (MATRIX_ROW_SHIFTER << col)) {
+ if (debounce_counters[index] == DEBOUNCE_ELAPSED) {
+ debounce_counters[index] = DEBOUNCE;
+ counters_need_update = true;
}
} else {
- *debounce_pointer = DEBOUNCE_ELAPSED;
+ debounce_counters[index] = DEBOUNCE_ELAPSED;
}
- debounce_pointer++;
}
}
}