summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorDasky <32983009+daskygit@users.noreply.github.com>2023-10-26 22:34:17 +0100
committerGitHub <noreply@github.com>2023-10-26 22:34:17 +0100
commite0c00c35ce195dc0ab3f729235b9490dc69592ec (patch)
tree41b2ecb7d26befc9e57f59471cd6f5ec70e4f98c /docs
parentd2892685c52a8a0892b28872cfc43e8f7fa37465 (diff)
Clarify PIO define is optional in docs. (#22339)
Diffstat (limited to 'docs')
-rw-r--r--docs/serial_driver.md2
-rw-r--r--docs/ws2812_driver.md2
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/serial_driver.md b/docs/serial_driver.md
index c4b42f38dd..b7e803154b 100644
--- a/docs/serial_driver.md
+++ b/docs/serial_driver.md
@@ -235,7 +235,7 @@ Where 'n' matches the peripheral number of your selected USART on the MCU.
The `PIO` subsystem is a Raspberry Pi RP2040 specific implementation, using the integrated PIO peripheral and is therefore only available on this MCU. Because of the flexible nature of the PIO peripherals, **any** GPIO pin can be used as a `TX` or `RX` pin. Half-duplex and Full-duplex operation is fully supported. The Half-duplex operation mode uses the built-in pull-ups and GPIO manipulation on the RP2040 to drive the line high by default. An external pull-up is therefore not necessary.
-Configure the hardware via your config.h:
+You may optionally switch the PIO peripheral used with the following define in config.h:
```c
#define SERIAL_PIO_USE_PIO1 // Force the usage of PIO1 peripheral, by default the Serial implementation uses the PIO0 peripheral
```
diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md
index f8cad20ce0..9b79cfa905 100644
--- a/docs/ws2812_driver.md
+++ b/docs/ws2812_driver.md
@@ -170,7 +170,7 @@ To configure it, add this to your rules.mk:
WS2812_DRIVER = vendor
```
-Configure the hardware via your config.h:
+You may optionally switch the PIO peripheral used with the following define in config.h:
```c
#define WS2812_PIO_USE_PIO1 // Force the usage of PIO1 peripheral, by default the WS2812 implementation uses the PIO0 peripheral
```