diff options
| author | Nick Brassel <nick@tzarc.org> | 2020-07-16 16:39:49 +1000 |
|---|---|---|
| committer | James Young <18669334+noroadsleft@users.noreply.github.com> | 2020-08-29 14:30:02 -0700 |
| commit | c6b7a0d386c347f20117943831a0215659d37c47 (patch) | |
| tree | 0b53a602c61b58842dba0f9dc3080371bfe1c027 /docs/ws2812_driver.md | |
| parent | 8a4a0c25fdb2c4d0ac3ac8fd5f6ba14b56f4cd28 (diff) | |
| download | qmk_firmware-c6b7a0d386c347f20117943831a0215659d37c47.tar.gz qmk_firmware-c6b7a0d386c347f20117943831a0215659d37c47.zip | |
Add support for DMAMUX-capable MCU configuration with WS2812 PWM driver. (#9471)
Diffstat (limited to 'docs/ws2812_driver.md')
| -rw-r--r-- | docs/ws2812_driver.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md index 941e1bde0..c1b96329e 100644 --- a/docs/ws2812_driver.md +++ b/docs/ws2812_driver.md | |||
| @@ -92,6 +92,7 @@ Configure the hardware via your config.h: | |||
| 92 | #define WS2812_PWM_PAL_MODE 2 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2 | 92 | #define WS2812_PWM_PAL_MODE 2 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2 |
| 93 | #define WS2812_DMA_STREAM STM32_DMA1_STREAM2 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. | 93 | #define WS2812_DMA_STREAM STM32_DMA1_STREAM2 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. |
| 94 | #define WS2812_DMA_CHANNEL 2 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. | 94 | #define WS2812_DMA_CHANNEL 2 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. |
| 95 | #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. | ||
| 95 | ``` | 96 | ``` |
| 96 | 97 | ||
| 97 | You must also turn on the PWM feature in your halconf.h and mcuconf.h | 98 | 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. | |||
| 117 | 118 | ||
| 118 | To configure the `RGB_DI_PIN` to open drain configuration add this to your config.h file: | 119 | To configure the `RGB_DI_PIN` to open drain configuration add this to your config.h file: |
| 119 | ```c | 120 | ```c |
| 120 | #define WS2812_EXTERNAL_PULLUP | 121 | #define WS2812_EXTERNAL_PULLUP |
| 121 | ``` | 122 | ``` |
