aboutsummaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
authorTobias Arndt <[email protected]>2024-03-30 18:24:11 -0700
committerPete Johanson <[email protected]>2024-03-30 19:13:39 -0700
commite7d6519534231525e6173635061ab8e8bda5a997 (patch)
treec6467c163ef8d2616adc57254be2881092b720a1
parenteb5a6fcfe19b32df13488d2ec751f90cb9fa3362 (diff)
downloadzmk-e7d6519534231525e6173635061ab8e8bda5a997.tar.gz
zmk-e7d6519534231525e6173635061ab8e8bda5a997.zip
fix(docs): Fix and note GPIO flags for charlieplex config
-rw-r--r--docs/docs/config/kscan.md12
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/docs/config/kscan.md b/docs/docs/config/kscan.md
index 3aa1b37875..e6e8bb620b 100644
--- a/docs/docs/config/kscan.md
+++ b/docs/docs/config/kscan.md
@@ -187,6 +187,8 @@ Define the transform with a [matrix transform](#matrix-transform). The row is al
For example, in `RC(5,0)` power flows from the 6th pin in `gpios` to the 1st pin in `gpios`.
Exclude all positions where the row and column are the same as these pairs will never be triggered, since no pin can be both input and output at the same time.
+The [GPIO flags](https://docs.zephyrproject.org/3.5.0/hardware/peripherals/gpio.html#api-reference) for the elements in `gpios` should be `GPIO_ACTIVE_HIGH`, and interrupt pins set in `interrupt-gpios` should have the flags `(GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN)`.
+
## Composite Driver
Keyboard scan driver which combines multiple other keyboard scan drivers.
@@ -460,11 +462,11 @@ Note that the entire addressable space does not need to be mapped.
interrupt-gpios = <&pro_micro 21 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN) >;
gpios
- = <&pro_micro 16 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN) >
- , <&pro_micro 17 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN) >
- , <&pro_micro 18 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN) >
- , <&pro_micro 19 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN) >
- , <&pro_micro 20 (GPIO_ACTIVE_HIGH | GPIO_PULL_DOWN) >
+ = <&pro_micro 16 GPIO_ACTIVE_HIGH>
+ , <&pro_micro 17 GPIO_ACTIVE_HIGH>
+ , <&pro_micro 18 GPIO_ACTIVE_HIGH>
+ , <&pro_micro 19 GPIO_ACTIVE_HIGH>
+ , <&pro_micro 20 GPIO_ACTIVE_HIGH>
; // addressable space is 5x5, (minus paired values)
};