From 7777f0ac6c8f5b789cfc2e062118e9e2e68f7de8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A1niel=20Buga?= Date: Mon, 26 Jun 2023 18:55:53 +0200 Subject: [PATCH] Update PDMA descriptor docs --- esp-hal-common/src/dma/pdma.rs | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/esp-hal-common/src/dma/pdma.rs b/esp-hal-common/src/dma/pdma.rs index f4ddcbc48..976de292b 100644 --- a/esp-hal-common/src/dma/pdma.rs +++ b/esp-hal-common/src/dma/pdma.rs @@ -224,7 +224,8 @@ macro_rules! ImplSpiChannel { impl [] { /// 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 [] { /// 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,