itsscb/embassy
1
0
Fork 0
mirror of https://github.com/embassy-rs/embassy.git synced 2025-10-02 14:44:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update PWM waveform function documentation for data alignment

Browse Source
This commit is contained in:
Liu Hancheng 2025-01-01 17:17:23 +08:00
parent cbc7a9fe5b
commit 89a1346d00
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
embassy-stm32/src/timer/simple_pwm.rs
View File

@ -365,7 +365,10 @@ macro_rules! impl_waveform_chx {
/// Generate a sequence of PWM waveform /// Generate a sequence of PWM waveform
/// ///
/// Note: /// Note:
/// you will need to provide corresponding TIMx_CHy DMA channel to use this method. /// 1. you will need to provide corresponding TIMx_CHy DMA channel to use this method.
/// 2. Please make sure the duty data length is aligned to the timer data width(16-bit or 32-bit).
/// 3. Please notice the endianess of the duty data. STM32 use little endian,
/// for example, 0x12345678 as u32 will be stored as [0x78, 0x56, 0x34, 0x12] in memory.
pub async fn $fn_name(&mut self, dma: impl Peripheral<P = impl super::$dma_ch<T>>, duty: &[u8]) { pub async fn $fn_name(&mut self, dma: impl Peripheral<P = impl super::$dma_ch<T>>, duty: &[u8]) {
use crate::pac::timer::vals::Ccds; use crate::pac::timer::vals::Ccds;