spi docs rejig

esp-rs · Aug 27, 2024 · 79967fc · 79967fc
1 parent bcdbbd8
commit 79967fc
Show file tree

Hide file tree

Showing 6 changed files with 8 additions and 16 deletions.
diff --git a/esp-hal/src/spi/master.rs b/esp-hal/src/spi/master.rs
@@ -58,6 +58,7 @@
 
 use core::marker::PhantomData;
 
+pub use dma::*;
 #[cfg(not(any(esp32, esp32s2)))]
 use enumset::EnumSet;
 #[cfg(not(any(esp32, esp32s2)))]
@@ -87,14 +88,6 @@ use crate::{
     system::PeripheralClockControl,
 };
 
-/// Prelude for the SPI (Master) driver
-pub mod prelude {
-    pub use super::{
-        Instance as _esp_hal_spi_master_Instance,
-        InstanceDma as _esp_hal_spi_master_InstanceDma,
-    };
-}
-
 /// Enumeration of possible SPI interrupt events.
 #[cfg(not(any(esp32, esp32s2)))]
 #[derive(EnumSetType)]
@@ -944,8 +937,7 @@ where
     }
 }
 
-/// DMA (Direct Memory Access) funtionality (Master).
-pub mod dma {
+mod dma {
     use core::{
         cmp::min,
         sync::atomic::{fence, Ordering},
@@ -1845,7 +1837,7 @@ pub mod dma {
 
     /// Async functionality
     #[cfg(feature = "async")]
-    pub mod asynch {
+    mod asynch {
         use core::{cmp::min, mem::take};
 
         use super::*;

diff --git a/hil-test/tests/spi_full_duplex_dma.rs b/hil-test/tests/spi_full_duplex_dma.rs
@@ -21,7 +21,7 @@ use esp_hal::{
     peripherals::{Peripherals, SPI2},
     prelude::*,
     spi::{
-        master::{dma::SpiDma, Spi},
+        master::{Spi, SpiDma},
         FullDuplexMode,
         SpiMode,
     },

diff --git a/hil-test/tests/spi_full_duplex_dma_async.rs b/hil-test/tests/spi_full_duplex_dma_async.rs
@@ -34,7 +34,7 @@ use esp_hal::{
     peripherals::{Peripherals, SPI2},
     prelude::*,
     spi::{
-        master::{dma::SpiDmaBus, Spi},
+        master::{Spi, SpiDmaBus},
         FullDuplexMode,
         SpiMode,
     },

diff --git a/hil-test/tests/spi_full_duplex_dma_pcnt.rs b/hil-test/tests/spi_full_duplex_dma_pcnt.rs
@@ -30,7 +30,7 @@ use esp_hal::{
     peripherals::{Peripherals, SPI2},
     prelude::*,
     spi::{
-        master::{dma::SpiDma, Spi},
+        master::{Spi, SpiDma},
         FullDuplexMode,
         SpiMode,
     },

diff --git a/hil-test/tests/spi_half_duplex_read.rs b/hil-test/tests/spi_half_duplex_read.rs
@@ -21,7 +21,7 @@ use esp_hal::{
     peripherals::{Peripherals, SPI2},
     prelude::*,
     spi::{
-        master::{dma::SpiDma, Address, Command, HalfDuplexReadWrite, Spi},
+        master::{Address, Command, HalfDuplexReadWrite, Spi, SpiDma},
         HalfDuplexMode,
         SpiDataMode,
         SpiMode,

diff --git a/hil-test/tests/spi_half_duplex_write.rs b/hil-test/tests/spi_half_duplex_write.rs
@@ -26,7 +26,7 @@ use esp_hal::{
     peripherals::{Peripherals, SPI2},
     prelude::*,
     spi::{
-        master::{dma::SpiDma, Address, Command, HalfDuplexReadWrite, Spi},
+        master::{Address, Command, HalfDuplexReadWrite, Spi, SpiDma},
         HalfDuplexMode,
         SpiDataMode,
         SpiMode,