Add missing docs

esp-rs · Dec 3, 2024 · 01c70c2 · 01c70c2
1 parent 0f5a9f4
commit 01c70c2
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 4 deletions.
diff --git a/esp-hal/src/dma/buffers.rs b/esp-hal/src/dma/buffers.rs
@@ -28,6 +28,7 @@ pub enum DmaBufError {
     InvalidChunkSize,
 }
 
+/// DMA buffer alignment errors.
 #[derive(Debug, PartialEq, Eq, Hash, Clone, Copy)]
 #[cfg_attr(feature = "defmt", derive(defmt::Format))]
 pub enum DmaAlignmentError {

diff --git a/esp-hal/src/dma/mod.rs b/esp-hal/src/dma/mod.rs
@@ -1966,8 +1966,11 @@ where
                     if crate::soc::addr_in_range(des.buffer as usize, psram_range.clone()) {
                         uses_psram = true;
                         // both the size and address of the buffer must be aligned
-                        if des.buffer as usize % alignment != 0 && des.size() % alignment != 0 {
-                            return Err(DmaError::InvalidAlignment);
+                        if des.buffer as usize % alignment != 0 {
+                            return Err(DmaError::InvalidAlignment(DmaAlignmentError::Address));
+                        }
+                        if des.size() % alignment != 0 {
+                            return Err(DmaError::InvalidAlignment(DmaAlignmentError::Size));
                         }
                         crate::soc::cache_invalidate_addr(des.buffer as u32, des.size() as u32);
                     }
@@ -2255,8 +2258,11 @@ where
                     if crate::soc::addr_in_range(des.buffer as usize, psram_range.clone()) {
                         uses_psram = true;
                         // both the size and address of the buffer must be aligned
-                        if des.buffer as usize % alignment != 0 && des.size() % alignment != 0 {
-                            return Err(DmaError::InvalidAlignment);
+                        if des.buffer as usize % alignment != 0 {
+                            return Err(DmaError::InvalidAlignment(DmaAlignmentError::Address));
+                        }
+                        if des.size() % alignment != 0 {
+                            return Err(DmaError::InvalidAlignment(DmaAlignmentError::Size));
                         }
                         crate::soc::cache_writeback_addr(des.buffer as u32, des.size() as u32);
                     }