diff options
Diffstat (limited to 'docs/ws2812_driver.md')
| -rw-r--r-- | docs/ws2812_driver.md | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/docs/ws2812_driver.md b/docs/ws2812_driver.md index cca6827ec..fa14f02fd 100644 --- a/docs/ws2812_driver.md +++ b/docs/ws2812_driver.md | |||
| @@ -102,11 +102,14 @@ Configure the hardware via your config.h: | |||
| 102 | #define WS2812_PWM_DRIVER PWMD2 // default: PWMD2 | 102 | #define WS2812_PWM_DRIVER PWMD2 // default: PWMD2 |
| 103 | #define WS2812_PWM_CHANNEL 2 // default: 2 | 103 | #define WS2812_PWM_CHANNEL 2 // default: 2 |
| 104 | #define WS2812_PWM_PAL_MODE 2 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2 | 104 | #define WS2812_PWM_PAL_MODE 2 // Pin "alternate function", see the respective datasheet for the appropriate values for your MCU. default: 2 |
| 105 | //#define WS2812_PWM_COMPLEMENTARY_OUTPUT // Define for a complementary timer output (TIMx_CHyN); omit for a normal timer output (TIMx_CHy). | ||
| 105 | #define WS2812_DMA_STREAM STM32_DMA1_STREAM2 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. | 106 | #define WS2812_DMA_STREAM STM32_DMA1_STREAM2 // DMA Stream for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. |
| 106 | #define WS2812_DMA_CHANNEL 2 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. | 107 | #define WS2812_DMA_CHANNEL 2 // DMA Channel for TIMx_UP, see the respective reference manual for the appropriate values for your MCU. |
| 107 | #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. | 108 | #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. |
| 108 | ``` | 109 | ``` |
| 109 | 110 | ||
| 111 | Note that using a complementary timer output (TIMx_CHyN) is possible only for advanced-control timers (TIM1, TIM8, TIM20 on STM32), and the `STM32_PWM_USE_ADVANCED` option in mcuconf.h must be set to `TRUE`. Complementary outputs of general-purpose timers are not supported due to ChibiOS limitations. | ||
| 112 | |||
| 110 | You must also turn on the PWM feature in your halconf.h and mcuconf.h | 113 | You must also turn on the PWM feature in your halconf.h and mcuconf.h |
| 111 | 114 | ||
| 112 | #### Testing Notes | 115 | #### Testing Notes |