From 2691978b16cda1f0285c95f98138fb267bb11ca7 Mon Sep 17 00:00:00 2001 From: xoviat Date: Wed, 3 Dec 2025 16:10:07 -0600 Subject: doc --- embassy-stm32/src/timer/complementary_pwm.rs | 4 +--- embassy-stm32/src/timer/low_level.rs | 3 +++ 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> { /// Generate a sequence of PWM waveform /// /// Note: - /// You will need to provide corresponding `TIMx_UP` DMA channel to use this method. - /// Also be aware that embassy timers use one of timers internally. It is possible to - /// switch this timer by using `time-driver-timX` feature. + /// The DMA channel provided does not need to correspond to the requested channel. pub async fn waveform>( &mut self, dma: Peri<'_, impl super::Dma>, 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> { } /// Generate a sequence of PWM waveform + /// + /// Note: + /// The DMA channel provided does not need to correspond to the requested channel. pub fn setup_channel_update_dma<'a, C: TimerChannel, W: Word + Into>( &mut self, dma: Peri<'a, impl super::Dma>, 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> { /// Generate a sequence of PWM waveform /// /// Note: - /// You will need to provide corresponding `TIMx_UP` DMA channel to use this method. - /// Also be aware that embassy timers use one of timers internally. It is possible to - /// switch this timer by using `time-driver-timX` feature. + /// The DMA channel provided does not need to correspond to the requested channel. pub async fn waveform>( &mut self, dma: Peri<'_, impl super::Dma>, -- cgit