diff options
| author | xoviat <[email protected]> | 2025-12-03 16:10:07 -0600 |
|---|---|---|
| committer | xoviat <[email protected]> | 2025-12-03 16:10:07 -0600 |
| commit | 2691978b16cda1f0285c95f98138fb267bb11ca7 (patch) | |
| tree | 13d4a64dfc3c5290f9a1497b51ff94298be41009 /embassy-stm32 | |
| parent | 0fc247a384b70e29f78c303909fc3fe636710283 (diff) | |
doc
Diffstat (limited to 'embassy-stm32')
| -rw-r--r-- | embassy-stm32/src/timer/complementary_pwm.rs | 4 | ||||
| -rw-r--r-- | embassy-stm32/src/timer/low_level.rs | 3 | ||||
| -rw-r--r-- | embassy-stm32/src/timer/simple_pwm.rs | 4 |
3 files changed, 5 insertions, 6 deletions
diff --git a/embassy-stm32/src/timer/complementary_pwm.rs b/embassy-stm32/src/timer/complementary_pwm.rs index 4f2ac4079..19211d933 100644 --- a/embassy-stm32/src/timer/complementary_pwm.rs +++ b/embassy-stm32/src/timer/complementary_pwm.rs | |||
| @@ -219,9 +219,7 @@ impl<'d, T: AdvancedInstance4Channel> ComplementaryPwm<'d, T> { | |||
| 219 | /// Generate a sequence of PWM waveform | 219 | /// Generate a sequence of PWM waveform |
| 220 | /// | 220 | /// |
| 221 | /// Note: | 221 | /// Note: |
| 222 | /// You will need to provide corresponding `TIMx_UP` DMA channel to use this method. | 222 | /// The DMA channel provided does not need to correspond to the requested channel. |
| 223 | /// Also be aware that embassy timers use one of timers internally. It is possible to | ||
| 224 | /// switch this timer by using `time-driver-timX` feature. | ||
| 225 | pub async fn waveform<C: TimerChannel, W: Word + Into<T::Word>>( | 223 | pub async fn waveform<C: TimerChannel, W: Word + Into<T::Word>>( |
| 226 | &mut self, | 224 | &mut self, |
| 227 | dma: Peri<'_, impl super::Dma<T, C>>, | 225 | dma: Peri<'_, impl super::Dma<T, C>>, |
diff --git a/embassy-stm32/src/timer/low_level.rs b/embassy-stm32/src/timer/low_level.rs index da1bfac5f..82e936f3a 100644 --- a/embassy-stm32/src/timer/low_level.rs +++ b/embassy-stm32/src/timer/low_level.rs | |||
| @@ -686,6 +686,9 @@ impl<'d, T: GeneralInstance4Channel> Timer<'d, T> { | |||
| 686 | } | 686 | } |
| 687 | 687 | ||
| 688 | /// Generate a sequence of PWM waveform | 688 | /// Generate a sequence of PWM waveform |
| 689 | /// | ||
| 690 | /// Note: | ||
| 691 | /// The DMA channel provided does not need to correspond to the requested channel. | ||
| 689 | pub fn setup_channel_update_dma<'a, C: TimerChannel, W: Word + Into<T::Word>>( | 692 | pub fn setup_channel_update_dma<'a, C: TimerChannel, W: Word + Into<T::Word>>( |
| 690 | &mut self, | 693 | &mut self, |
| 691 | dma: Peri<'a, impl super::Dma<T, C>>, | 694 | dma: Peri<'a, impl super::Dma<T, C>>, |
diff --git a/embassy-stm32/src/timer/simple_pwm.rs b/embassy-stm32/src/timer/simple_pwm.rs index 3f050a366..9a5f0fd1d 100644 --- a/embassy-stm32/src/timer/simple_pwm.rs +++ b/embassy-stm32/src/timer/simple_pwm.rs | |||
| @@ -340,9 +340,7 @@ impl<'d, T: GeneralInstance4Channel> SimplePwm<'d, T> { | |||
| 340 | /// Generate a sequence of PWM waveform | 340 | /// Generate a sequence of PWM waveform |
| 341 | /// | 341 | /// |
| 342 | /// Note: | 342 | /// Note: |
| 343 | /// You will need to provide corresponding `TIMx_UP` DMA channel to use this method. | 343 | /// The DMA channel provided does not need to correspond to the requested channel. |
| 344 | /// Also be aware that embassy timers use one of timers internally. It is possible to | ||
| 345 | /// switch this timer by using `time-driver-timX` feature. | ||
| 346 | pub async fn waveform<C: TimerChannel, W: Word + Into<T::Word>>( | 344 | pub async fn waveform<C: TimerChannel, W: Word + Into<T::Word>>( |
| 347 | &mut self, | 345 | &mut self, |
| 348 | dma: Peri<'_, impl super::Dma<T, C>>, | 346 | dma: Peri<'_, impl super::Dma<T, C>>, |
