quantum/debounce/eager_pr.c

   1 /*
   2 Copyright 2019 Alex Ong<the.onga@gmail.com>
   3 This program is free software: you can redistribute it and/or modify
   4 it under the terms of the GNU General Public License as published by
   5 the Free Software Foundation, either version 2 of the License, or
   6 (at your option) any later version.
   7 This program is distributed in the hope that it will be useful,
   8 but WITHOUT ANY WARRANTY; without even the implied warranty of
   9 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  10 GNU General Public License for more details.
  11 You should have received a copy of the GNU General Public License
  12 along with this program.  If not, see <http://www.gnu.org/licenses/>.
  13 */
  14
  15 /*
  16 Basic per-row algorithm. Uses an 8-bit counter per row.
  17 After pressing a key, it immediately changes state, and sets a counter.
  18 No further inputs are accepted until DEBOUNCE milliseconds have occurred.
  19 */
  20
  21 #include "matrix.h"
  22 #include "timer.h"
  23 #include "quantum.h"
  24 #include <stdlib.h>
  25
  26 #ifndef DEBOUNCE
  27 #  define DEBOUNCE 5
  28 #endif
  29
  30 #define debounce_counter_t uint8_t
  31 static bool                matrix_need_update;
  32
  33 static debounce_counter_t *debounce_counters;
  34 static bool                counters_need_update;
  35
  36 #define DEBOUNCE_ELAPSED 251
  37 #define MAX_DEBOUNCE (DEBOUNCE_ELAPSED - 1)
  38
  39 void update_debounce_counters(uint8_t num_rows, uint8_t current_time);
  40 void transfer_matrix_values(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, uint8_t current_time);
  41
  42 // we use num_rows rather than MATRIX_ROWS to support split keyboards
  43 void debounce_init(uint8_t num_rows) {
  44   debounce_counters = (debounce_counter_t *)malloc(num_rows * sizeof(debounce_counter_t));
  45   for (uint8_t r = 0; r < num_rows; r++) {
  46     debounce_counters[r] = DEBOUNCE_ELAPSED;
  47   }
  48 }
  49
  50 void debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool changed) {
  51   uint8_t current_time = timer_read() % MAX_DEBOUNCE;
  52   bool needed_update = counters_need_update;
  53   if (counters_need_update) {
  54     update_debounce_counters(num_rows, current_time);
  55   }
  56
  57   if (changed || (needed_update && !counters_need_update) || matrix_need_update) {
  58     transfer_matrix_values(raw, cooked, num_rows, current_time);
  59   }
  60 }
  61
  62 // If the current time is > debounce counter, set the counter to enable input.
  63 void update_debounce_counters(uint8_t num_rows, uint8_t current_time) {
  64   counters_need_update                 = false;
  65   debounce_counter_t *debounce_pointer = debounce_counters;
  66   for (uint8_t row = 0; row < num_rows; row++) {
  67     if (*debounce_pointer != DEBOUNCE_ELAPSED) {
  68       if (TIMER_DIFF(current_time, *debounce_pointer, MAX_DEBOUNCE) >= DEBOUNCE) {
  69         *debounce_pointer = DEBOUNCE_ELAPSED;
  70       } else {
  71         counters_need_update = true;
  72       }
  73     }
  74     debounce_pointer++;
  75   }
  76 }
  77
  78 // upload from raw_matrix to final matrix;
  79 void transfer_matrix_values(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, uint8_t current_time) {
  80   matrix_need_update = false;
  81   debounce_counter_t *debounce_pointer = debounce_counters;
  82   for (uint8_t row = 0; row < num_rows; row++) {
  83     matrix_row_t existing_row = cooked[row];
  84     matrix_row_t raw_row      = raw[row];
  85
  86     // determine new value basd on debounce pointer + raw value
  87     if (existing_row != raw_row) {
  88       if (*debounce_pointer == DEBOUNCE_ELAPSED) {
  89         *debounce_pointer    = current_time;
  90         cooked[row]          = raw_row;
  91         counters_need_update = true;
  92       } else {
  93         matrix_need_update = true;
  94       }
  95     }
  96     debounce_pointer++;
  97   }
  98 }
  99
 100 bool debounce_active(void) { return true; }