summaryrefslogtreecommitdiffstats
path: root/quantum/debounce/readme.md
diff options
context:
space:
mode:
authorPurdea Andrei <andrei@purdea.ro>2020-09-06 23:13:49 +0300
committerGitHub <noreply@github.com>2020-09-06 13:13:49 -0700
commitf7ccbfcea88e127319a4665a6c8ca67883854030 (patch)
tree25a2d9f5c7b9b95795d097c9514928af90d5080a /quantum/debounce/readme.md
parent8ac9940a76f09d4a47be342fc123306ecbfb27f3 (diff)
quantum/debounce: rename debouncing algorithms (#9564)
* quantum/debounce: rename debouncing algorithms according to Issue 8763 This is the second attempt at implementation, with no ts_ and cy_ prefixes, since those will be implemented with macros. * Debouncing documentation: Refactor, add some generic info, and merge into a single document
Diffstat (limited to 'quantum/debounce/readme.md')
-rw-r--r--quantum/debounce/readme.md28
1 files changed, 0 insertions, 28 deletions
diff --git a/quantum/debounce/readme.md b/quantum/debounce/readme.md
deleted file mode 100644
index f77f78c764..0000000000
--- a/quantum/debounce/readme.md
+++ /dev/null
@@ -1,28 +0,0 @@
-Debounce algorithms belong in this folder.
-Here are a few ideas
-
-1) Global vs Per-Key vs Per-Row
- * Global - one timer for all keys. Any key change state affects global timer
- * Per key - one timer per key
- * Per row - one timer per row
-
-2) Eager vs symmetric vs asymmetric
- * Eager - any key change is reported immediately. All further inputs for DEBOUNCE ms are ignored.
- * Symmetric - wait for no changes for DEBOUNCE ms before reporting change
- * Asymmetric - wait for different times depending on key-down/key-up. E.g. Eager key-down, DEBOUNCE ms key up.
-
-3) Timestamp vs cycles
- * old old old code waits n cycles, decreasing count by one each matrix_scan
- * newer code stores the millisecond the change occurred, and does subraction to figure out time elapsed.
- * Timestamps are superior, i don't think cycles will ever be used again once upgraded.
-
-The default algorithm is symmetric and global.
-Here are a few that could be implemented:
-
-sym_g.c
-sym_pk.c
-sym_pr.c
-sym_pr_cycles.c
-eager_g.c
-eager_pk.c
-eager_pr.c //could be used in ergo-dox!