summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorNick Brassel <nick@tzarc.org>2020-07-16 16:39:49 +1000
committerJames Young <18669334+noroadsleft@users.noreply.github.com>2020-08-29 14:30:02 -0700
commitc6b7a0d386c347f20117943831a0215659d37c47 (patch)
tree0b53a602c61b58842dba0f9dc3080371bfe1c027 /docs
parent8a4a0c25fdb2c4d0ac3ac8fd5f6ba14b56f4cd28 (diff)
Add support for DMAMUX-capable MCU configuration with WS2812 PWM driver. (#9471)
Diffstat (limited to 'docs')
-rw-r--r--docs/ws2812_driver.md3
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md
index 941e1bde08..c1b96329e9 100644
--- a/docs/ws2812_driver.md
+++ b/docs/ws2812_driver.md
@@ -92,6 +92,7 @@ Configure the hardware via your config.h:
#define WS2812_PWM_PAL_MODE 2 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2
#define WS2812_DMA_STREAM STM32_DMA1_STREAM2 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
#define WS2812_DMA_CHANNEL 2 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU.
+#define WS2812_DMAMUX_ID STM32_DMAMUX1_TIM2_UP // DMAMUX configuration for TIMx_UP -- only required if your MCU has a DMAMUX peripheral, see the respective reference manual for the appropriate values for your MCU.
```
You must also turn on the PWM feature in your halconf.h and mcuconf.h
@@ -117,5 +118,5 @@ Note: This only applies to STM32 boards.
To configure the `RGB_DI_PIN` to open drain configuration add this to your config.h file:
```c
- #define WS2812_EXTERNAL_PULLUP
+#define WS2812_EXTERNAL_PULLUP
```