summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authoralex-ong <the.onga@gmail.com>2019-01-27 07:23:15 +1100
committeralex-ong <the.onga@gmail.com>2019-01-27 07:23:15 +1100
commit7d8c62993921383a35f9cd172fe0a1d2e893b2f3 (patch)
tree9d62d3bd3f51eec384b46478465a83e62c179b8e /docs
parent562c0d702a326488d79963969ef71f2a52664cdc (diff)
Stricter, leaner DEBOUNCE_TYPE section in common_features.mk. Cleanup debounce_type.mk
Diffstat (limited to 'docs')
-rw-r--r--docs/feature_debounce_type.md (renamed from docs/feature_debounce_algo.md)22
1 files changed, 12 insertions, 10 deletions
diff --git a/docs/feature_debounce_algo.md b/docs/feature_debounce_type.md
index c4ef86fc7d..82b3d7de12 100644
--- a/docs/feature_debounce_algo.md
+++ b/docs/feature_debounce_type.md
@@ -7,14 +7,15 @@ The underlying debounce algorithm is determined by which matrix.c file you are u
The logic for which debounce method called is below. It checks various defines that you have set in rules.mk
```
-ifeq ($(strip $(DEBOUNCE_ALGO)), manual)
- # Do nothing. do your debouncing in matrix.c
-else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g)
- QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c
-else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk)
- QUANTUM_SRC += $(DEBOUNCE)/debounce_eager_pk.c
-else # default algorithm
- QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c
+DEBOUNCE_TYPE?= sym_g
+VALID_DEBOUNCE_TYPES := sym_g eager_pk custom
+ifeq ($(filter $(DEBOUNCE_TYPE),$(VALID_DEBOUNCE_TYPES)),)
+ $(error DEBOUNCE_TYPE="$(DEBOUNCE_TYPE)" is not a valid debounce algorithm)
+endif
+ifeq ($(strip $(DEBOUNCE_TYPE)), sym_g)
+ QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_sym_g.c
+else ifeq ($(strip $(DEBOUNCE_TYPE)), eager_pk)
+ QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_eager_pk.c
endif
```
@@ -23,17 +24,18 @@ endif
| DEBOUNCE_ALGO | Description | What to do |
| ------------- | --------------------------------------------------- | ----------------------------- |
| Not defined | You are using the included matrix.c and debounce.c | Nothing. Debounce_sym_g will be compiled, and used if necessary |
-| manual | Use your own debounce.c | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions |
+| custom | Use your own debounce.c | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions |
| sym_g / eager_pk | You are using the included matrix.c and debounce.c | Use an alternative debounce algorithm |
**Regarding split keyboards**:
The debounce code is compatible with split keyboards.
# Use your own debouncing code
-* Set ```DEBOUNCE_ALGO = manual```.
+* Set ```DEBOUNCE_TYPE = custom ```.
* Add ```SRC += debounce.c```
* Add your own ```debounce.c```. Look at included ```debounce_sym_g.c```s for sample implementations.
* Debouncing occurs after every raw matrix scan.
+* Use num_rows rather than MATRIX_ROWS, so that split keyboards are supported correctly.
# Changing between included debouncing methods
You can either use your own code, by including your own debounce.c, or switch to another included one.