diff options
| author | alex-ong <the.onga@gmail.com> | 2019-01-26 20:37:47 +1100 |
|---|---|---|
| committer | alex-ong <the.onga@gmail.com> | 2019-01-26 20:37:47 +1100 |
| commit | cce8dfab394a643fd6d0250bc8a80a721703a154 (patch) | |
| tree | 5fa5191b9c4a1bbe3828439e2a728212798e63bd | |
| parent | 14ed96aa064323acb0f8ceecaee3516fb372a56c (diff) | |
| download | qmk_firmware-cce8dfab394a643fd6d0250bc8a80a721703a154.tar.gz qmk_firmware-cce8dfab394a643fd6d0250bc8a80a721703a154.zip | |
Removed check for custom_matrix. We can safely include the debounce file for compilation when custom_matrix is used.
| -rw-r--r-- | common_features.mk | 4 | ||||
| -rw-r--r-- | docs/feature_debounce_algo.md | 18 |
2 files changed, 7 insertions, 15 deletions
diff --git a/common_features.mk b/common_features.mk index deb30706a..2c86fd31b 100644 --- a/common_features.mk +++ b/common_features.mk | |||
| @@ -271,9 +271,7 @@ else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g) | |||
| 271 | QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_sym_g.c | 271 | QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_sym_g.c |
| 272 | else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk) | 272 | else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk) |
| 273 | QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_eager_pk.c | 273 | QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_eager_pk.c |
| 274 | else ifeq ($(strip $(CUSTOM_MATRIX)), yes) | 274 | else # default algorithm. Won't be used if we have a custom_matrix that doesn't utilize it |
| 275 | # Do nothing. Custom matrix code. | ||
| 276 | else # default algorithm | ||
| 277 | QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_sym_g.c | 275 | QUANTUM_SRC += $(DEBOUNCE_DIR)/debounce_sym_g.c |
| 278 | endif | 276 | endif |
| 279 | 277 | ||
diff --git a/docs/feature_debounce_algo.md b/docs/feature_debounce_algo.md index e4489662e..c4ef86fc7 100644 --- a/docs/feature_debounce_algo.md +++ b/docs/feature_debounce_algo.md | |||
| @@ -13,24 +13,18 @@ else ifeq ($(strip $(DEBOUNCE_ALGO)), sym_g) | |||
| 13 | QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c | 13 | QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c |
| 14 | else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk) | 14 | else ifeq ($(strip $(DEBOUNCE_ALGO)), eager_pk) |
| 15 | QUANTUM_SRC += $(DEBOUNCE)/debounce_eager_pk.c | 15 | QUANTUM_SRC += $(DEBOUNCE)/debounce_eager_pk.c |
| 16 | else ifeq ($(strip $(CUSTOM_MATRIX)), yes) | ||
| 17 | # Do nothing. Custom matrix code. | ||
| 18 | else # default algorithm | 16 | else # default algorithm |
| 19 | QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c | 17 | QUANTUM_SRC += $(DEBOUNCE)/debounce_sym_g.c |
| 20 | endif | 18 | endif |
| 21 | ``` | 19 | ``` |
| 22 | 20 | ||
| 23 | # Debounce selection | 21 | # Debounce selection |
| 24 | The following is for keyboards where ```SPLIT_KEYBOARD``` is **not** defined as ```YES``` | ||
| 25 | 22 | ||
| 26 | | DEBOUNCE_ALGO | CUSTOM_MATRIX | Description | What to do | | 23 | | DEBOUNCE_ALGO | Description | What to do | |
| 27 | | ------------- | -------------| --------------------------------------------------- | ----------------------------- | | 24 | | ------------- | --------------------------------------------------- | ----------------------------- | |
| 28 | | Not defined | Not defined | You are using the included matrix.c and debounce.c | Nothing. Debounce_sym_g used. | | 25 | | Not defined | You are using the included matrix.c and debounce.c | Nothing. Debounce_sym_g will be compiled, and used if necessary | |
| 29 | | manual | Not defined | You are using the included matrix.c but your own debounce.c | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions | | 26 | | manual | Use your own debounce.c | ```SRC += debounce.c``` add your own debounce.c and implement necessary functions | |
| 30 | | sym_g / eager_pk | Not defined | You are using the included matrix.c and debounce.c | Nothing. Chosen debounce method used. | | 27 | | sym_g / eager_pk | You are using the included matrix.c and debounce.c | Use an alternative debounce algorithm | |
| 31 | | Not defined | YES | You have your own matrix.c, and your own debounce | Write the fully debounced matrix into matrix.c's matrix | | ||
| 32 | | manual | YES | Same as above | same as above | | ||
| 33 | | sym_g / eager_pk | YES | You are using your own matrix.c, but included debounce | Write the raw matrix values into matrix.c's matrix | | ||
| 34 | 28 | ||
| 35 | **Regarding split keyboards**: | 29 | **Regarding split keyboards**: |
| 36 | The debounce code is compatible with split keyboards. | 30 | The debounce code is compatible with split keyboards. |
| @@ -38,7 +32,7 @@ The debounce code is compatible with split keyboards. | |||
| 38 | # Use your own debouncing code | 32 | # Use your own debouncing code |
| 39 | * Set ```DEBOUNCE_ALGO = manual```. | 33 | * Set ```DEBOUNCE_ALGO = manual```. |
| 40 | * Add ```SRC += debounce.c``` | 34 | * Add ```SRC += debounce.c``` |
| 41 | * Add your own ```debounce.c```. Look at included debounce.c's for sample implementations. | 35 | * Add your own ```debounce.c```. Look at included ```debounce_sym_g.c```s for sample implementations. |
| 42 | * Debouncing occurs after every raw matrix scan. | 36 | * Debouncing occurs after every raw matrix scan. |
| 43 | 37 | ||
| 44 | # Changing between included debouncing methods | 38 | # Changing between included debouncing methods |
