quantum/debounce/eager_pk.c

   1 /*
   2 Copyright 2017 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-key algorithm. Uses an 8-bit counter per key.
  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 #if (MATRIX_COLS <= 8)
  31 #  define ROW_SHIFTER ((uint8_t)1)
  32 #elif (MATRIX_COLS <= 16)
  33 #  define ROW_SHIFTER ((uint16_t)1)
  34 #elif (MATRIX_COLS <= 32)
  35 #  define ROW_SHIFTER ((uint32_t)1)
  36 #endif
  37
  38 #define debounce_counter_t uint8_t
  39
  40 static debounce_counter_t *debounce_counters;
  41 static bool                counters_need_update;
  42 static bool                matrix_need_update;
  43
  44 #define DEBOUNCE_ELAPSED 251
  45 #define MAX_DEBOUNCE (DEBOUNCE_ELAPSED - 1)
  46
  47 void update_debounce_counters(uint8_t num_rows, uint8_t current_time);
  48 void transfer_matrix_values(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, uint8_t current_time);
  49
  50 // we use num_rows rather than MATRIX_ROWS to support split keyboards
  51 void debounce_init(uint8_t num_rows) {
  52   debounce_counters = (debounce_counter_t *)malloc(num_rows * MATRIX_COLS * sizeof(debounce_counter_t));
  53   int i             = 0;
  54   for (uint8_t r = 0; r < num_rows; r++) {
  55     for (uint8_t c = 0; c < MATRIX_COLS; c++) {
  56       debounce_counters[i++] = DEBOUNCE_ELAPSED;
  57     }
  58   }
  59 }
  60
  61 void debounce(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, bool changed) {
  62   uint8_t current_time = timer_read() % MAX_DEBOUNCE;
  63   if (counters_need_update) {
  64     update_debounce_counters(num_rows, current_time);
  65   }
  66
  67   if (changed || matrix_need_update) {
  68     transfer_matrix_values(raw, cooked, num_rows, current_time);
  69   }
  70 }
  71
  72 // If the current time is > debounce counter, set the counter to enable input.
  73 void update_debounce_counters(uint8_t num_rows, uint8_t current_time) {
  74   counters_need_update                 = false;
  75   debounce_counter_t *debounce_pointer = debounce_counters;
  76   for (uint8_t row = 0; row < num_rows; row++) {
  77     for (uint8_t col = 0; col < MATRIX_COLS; col++) {
  78       if (*debounce_pointer != DEBOUNCE_ELAPSED) {
  79         if (TIMER_DIFF(current_time, *debounce_pointer, MAX_DEBOUNCE) >= DEBOUNCE) {
  80           *debounce_pointer = DEBOUNCE_ELAPSED;
  81         } else {
  82           counters_need_update = true;
  83         }
  84       }
  85       debounce_pointer++;
  86     }
  87   }
  88 }
  89
  90 // upload from raw_matrix to final matrix;
  91 void transfer_matrix_values(matrix_row_t raw[], matrix_row_t cooked[], uint8_t num_rows, uint8_t current_time) {
  92   matrix_need_update = false;
  93   debounce_counter_t *debounce_pointer = debounce_counters;
  94   for (uint8_t row = 0; row < num_rows; row++) {
  95     matrix_row_t delta        = raw[row] ^ cooked[row];
  96     matrix_row_t existing_row = cooked[row];
  97     for (uint8_t col = 0; col < MATRIX_COLS; col++) {
  98       matrix_row_t col_mask = (ROW_SHIFTER << col);
  99       if (delta & col_mask) {
 100         if (*debounce_pointer == DEBOUNCE_ELAPSED) {
 101           *debounce_pointer    = current_time;
 102           counters_need_update = true;
 103           existing_row ^= col_mask;  // flip the bit.
 104         } else {
 105           matrix_need_update = true;
 106         }
 107       }
 108       debounce_pointer++;
 109     }
 110     cooked[row] = existing_row;
 111   }
 112 }
 113
 114 bool debounce_active(void) { return true; }