GetLitFam/esp-hal
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Update PDMA descriptor docs

Browse Source
This commit is contained in:
Dániel Buga 2023-06-26 18:55:53 +02:00 committed by Scott Mabin
parent 14823d669f
commit 559d00703d
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
esp-hal-common/src/dma/pdma.rs
View File

@ -224,7 +224,8 @@ macro_rules! ImplSpiChannel {
impl [<Spi $num DmaChannelCreator>] {
/// Configure the channel for use
///
/// Descriptors should be sized as (BUFFERSIZE / 4092) * 3
/// Descriptors should be sized as `((BUFFERSIZE + 4091) / 4092) * 3`. I.e., to
/// transfer buffers of size `1..=4092`, you need 3 descriptors.
pub fn configure<'a>(
self,
burst_mode: bool,
@ -462,7 +463,8 @@ macro_rules! ImplI2sChannel {
impl [<I2s $num DmaChannelCreator>] {
/// Configure the channel for use
///
/// Descriptors should be sized as (BUFFERSIZE / 4092) * 3
/// Descriptors should be sized as `((BUFFERSIZE + 4091) / 4092) * 3`. I.e., to
/// transfer buffers of size `1..=4092`, you need 3 descriptors.
pub fn configure<'a>(
self,
burst_mode: bool,