Refactor the spi module

boards/feather_m0/src/lib.rs

@@ -234,13 +234,13 @@ pub use pins::*;
 
 /// SPI pads for the labelled SPI peripheral
 ///
-/// You can use these pads with other, user-defined [`spi::Config`]urations.
+/// You can use these pads with other, user-defined configurations.
 pub type SpiPads = spi::Pads<SpiSercom, Miso, Mosi, Sclk>;
 
 /// SPI master for the labelled SPI peripheral
 ///
 /// This type implements [`FullDuplex<u8>`](ehal::spi::FullDuplex).
-pub type Spi = spi::Spi<spi::Config<SpiPads>, spi::Duplex>;
+pub type Spi = spi::Spi<SpiPads>;
 
 /// Convenience for setting up the labelled SPI peripheral.
 /// This powers up the SPI SERCOM and configures it for use as an
@@ -259,7 +259,7 @@ pub fn spi_master(
     let freq = clock.freq();
     let (miso, mosi, sclk) = (miso.into(), mosi.into(), sclk.into());
     let pads = spi::Pads::default().data_in(miso).data_out(mosi).sclk(sclk);
-    spi::Config::new(pm, sercom, pads, freq)
+    spi::Spi::config(pm, sercom, pads, freq)
         .baud(baud)
         .spi_mode(spi::MODE_0)
         .enable()

boards/feather_m4/src/lib.rs

@@ -169,13 +169,13 @@ hal::bsp_pins!(
 
 /// SPI pads for the labelled SPI peripheral
 ///
-/// You can use these pads with other, user-defined [`spi::Config`]urations.
+/// You can use these pads with other, user-defined configurations.
 pub type SpiPads = spi::Pads<SpiSercom, UndocIoSet1, Miso, Mosi, Sclk>;
 
 /// SPI master for the labelled SPI peripheral
 ///
 /// This type implements [`FullDuplex<u8>`](ehal::spi::FullDuplex).
-pub type Spi = spi::Spi<spi::Config<SpiPads>, spi::Duplex>;
+pub type Spi = spi::Spi<SpiPads>;
 
 /// Convenience for setting up the labelled SPI peripheral.
 /// This powers up SERCOM1 and configures it for use as an
@@ -194,7 +194,7 @@ pub fn spi_master(
     let freq = clock.freq();
     let (miso, mosi, sclk) = (miso.into(), mosi.into(), sclk.into());
     let pads = spi::Pads::default().data_in(miso).data_out(mosi).sclk(sclk);
-    spi::Config::new(mclk, sercom, pads, freq)
+    spi::Spi::config(mclk, sercom, pads, freq)
         .baud(baud)
         .spi_mode(spi::MODE_0)
         .enable()

boards/metro_m0/src/lib.rs

@@ -200,13 +200,13 @@ pub use pins::*;
 
 /// SPI pads for the labelled SPI peripheral
 ///
-/// You can use these pads with other, user-defined [`spi::Config`]urations.
+/// You can use these pads with other, user-defined configurations.
 pub type SpiPads = spi::Pads<Sercom4, Miso, Mosi, Sclk>;
 
 /// SPI master for the labelled SPI peripheral
 ///
 /// This type implements [`FullDuplex<u8>`](ehal::spi::FullDuplex).
-pub type Spi = spi::Spi<spi::Config<SpiPads>, spi::Duplex>;
+pub type Spi = spi::Spi<SpiPads>;
 
 /// Convenience for setting up the 2x3 header block for SPI.
 /// This powers up SERCOM4 and configures it for use as an
@@ -229,7 +229,7 @@ pub fn spi_master(
     let freq = clock.freq();
     let (miso, mosi, sclk) = (miso.into(), mosi.into(), sclk.into());
     let pads = spi::Pads::default().data_in(miso).data_out(mosi).sclk(sclk);
-    spi::Config::new(pm, sercom4, pads, freq)
+    spi::Spi::config(pm, sercom4, pads, freq)
         .baud(baud)
         .spi_mode(spi::MODE_0)
         .enable()
@@ -241,7 +241,7 @@ pub type FlashPads = spi::Pads<Sercom5, FlashMiso, FlashMosi, FlashSclk>;
 /// SPI master for the labelled SPI peripheral
 ///
 /// This type implements [`FullDuplex<u8>`](ehal::spi::FullDuplex).
-pub type FlashSpi = (spi::Spi<spi::Config<FlashPads>, spi::Duplex>, FlashCs);
+pub type FlashSpi = (spi::Spi<FlashPads>, FlashCs);
 
 /// Convenience for accessing the on-board SPI Flash device.
 /// This powers up SERCOM5 and configures it for use as an
@@ -260,7 +260,7 @@ pub fn flash_spi_master(
     let freq = clock.freq();
     let (miso, mosi, sclk, mut cs) = (miso.into(), mosi.into(), sclk.into(), cs.into());
     let pads = spi::Pads::default().data_in(miso).data_out(mosi).sclk(sclk);
-    let spi = spi::Config::new(pm, sercom5, pads, freq)
+    let spi = spi::Spi::config(pm, sercom5, pads, freq)
         .baud(MegaHertz(48))
         .spi_mode(spi::MODE_0)
         .enable();

boards/metro_m4/src/lib.rs

@@ -235,13 +235,13 @@ hal::bsp_pins!(
 
 /// SPI pads for the labelled SPI peripheral
 ///
-/// You can use these pads with other, user-defined [`spi::Config`]urations.
+/// You can use these pads with other, user-defined configurations.
 pub type SpiPads = spi::Pads<SpiSercom, IoSet1, Miso, Mosi, Sclk>;
 
 /// SPI master for the labelled SPI peripheral
 ///
 /// This type implements [`FullDuplex<u8>`](ehal::spi::FullDuplex).
-pub type Spi = spi::Spi<spi::Config<SpiPads>, spi::Duplex>;
+pub type Spi = spi::Spi<SpiPads>;
 
 /// Convenience for setting up the 2x3 header block for SPI.
 /// This powers up SERCOM2 and configures it for use as an
@@ -260,7 +260,7 @@ pub fn spi_master(
     let freq = clock.freq();
     let (miso, mosi, sclk) = (miso.into(), mosi.into(), sclk.into());
     let pads = spi::Pads::default().data_in(miso).data_out(mosi).sclk(sclk);
-    spi::Config::new(mclk, sercom, pads, freq)
+    spi::Spi::config(mclk, sercom, pads, freq)
         .baud(baud)
         .spi_mode(spi::MODE_0)
         .enable()

boards/wio_terminal/src/display.rs

@@ -37,7 +37,7 @@ pub struct Display {
 }
 
 pub type LcdPads = spi::Pads<Sercom7, IoSet4, NoneT, LcdMosi, LcdSck>;
-pub type LcdSpi = spi::Spi<spi::Config<LcdPads>, spi::Tx>;
+pub type LcdSpi = spi::Spi<LcdPads>;
 
 /// Type alias for the ILI9341 LCD display.
 pub type LCD = Ili9341<SPIInterface<LcdSpi, LcdDc, LcdCs>, LcdReset>;
@@ -60,7 +60,7 @@ impl Display {
         let gclk0 = clocks.gclk0();
         let clock = &clocks.sercom7_core(&gclk0).ok_or(())?;
         let pads = spi::Pads::default().data_out(self.mosi).sclk(self.sck);
-        let spi = spi::Config::new(mclk, sercom7, pads, clock.freq())
+        let spi = spi::Spi::config(mclk, sercom7, pads, clock.freq())
             .spi_mode(spi::MODE_0)
             .baud(baud)
             .enable();

boards/wio_terminal/src/storage.rs

@@ -58,7 +58,7 @@ pub struct SDCard {
 }
 
 pub type SdPads = spi::Pads<Sercom6, IoSet1, SdMiso, SdMosi, SdSck>;
-pub type SdSpi = spi::Spi<spi::Config<SdPads>, spi::Duplex>;
+pub type SdSpi = spi::Spi<SdPads>;
 type Controller<TS> = embedded_sdmmc::Controller<SdMmcSpi<SdSpi, SdCs>, TS>;
 
 /// An initialized SPI SDMMC controller.
@@ -104,7 +104,7 @@ impl SDCard {
             .data_out(self.mosi)
             .data_in(self.miso)
             .sclk(self.sck);
-        let spi = spi::Config::new(mclk, sercom6, pads, sercom6_clk.freq())
+        let spi = spi::Spi::config(mclk, sercom6, pads, sercom6_clk.freq())
             .spi_mode(spi::MODE_0)
             .baud(400.khz())
             .enable();

hal/CHANGELOG.md

@@ -2,6 +2,7 @@
 
 - Fix failing `bsp_pins!` invocation with no aliases (#605 fixes #599)
 - Add Advanced Encryption Standard (AES) peripheral support including RustCrypto compatible backend
+- Improve the architecture of `SpiFuture` (#577)
 
 # v0.15.1
 

hal/src/sercom/dma.rs

@@ -277,15 +277,14 @@ where
 // SPI DMA transfers
 //=============================================================================
 
-unsafe impl<C, A> Buffer for Spi<C, A>
+unsafe impl<P, M, Z> Buffer for Spi<P, M, Z>
 where
-    C: spi::ValidConfig,
-    C::OpMode: spi::MasterMode,
-    C::Size: spi::AtomicSize<Word = C::Word>,
-    C::Word: Beat,
-    A: spi::Capability,
+    P: spi::ValidPads,
+    M: spi::MasterMode,
+    Z: spi::AtomicSize,
+    Z::Word: Beat,
 {
-    type Beat = C::Word;
+    type Beat = Z::Word;
 
     #[inline]
     fn dma_ptr(&mut self) -> *mut Self::Beat {
@@ -303,11 +302,13 @@ where
     }
 }
 
-impl<C, A> Spi<C, A>
+impl<P, M, Z> Spi<P, M, Z>
 where
-    C: spi::ValidConfig,
-    A: spi::Transmit,
-    Self: Buffer<Beat = C::Word>,
+    P: spi::ValidPads,
+    P::Capability: spi::Transmit,
+    M: spi::OpMode,
+    Z: spi::Size,
+    Self: Buffer<Beat = Z::Word>,
 {
     /// Transform an [`Spi`] into a DMA [`Transfer`]) and
     /// start a send transaction.
@@ -320,7 +321,7 @@ where
     ) -> Transfer<Channel<Ch::Id, Busy>, BufferPair<B, Self>, W>
     where
         Ch: AnyChannel<Status = Ready>,
-        B: Buffer<Beat = C::Word> + 'static,
+        B: Buffer<Beat = Z::Word> + 'static,
         W: FnOnce(CallbackStatus) + 'static,
     {
         channel
@@ -337,15 +338,17 @@ where
         // for `B`, and the fact that the buffer length of an `Spi` is always 1.
         let xfer = unsafe { Transfer::new_unchecked(channel, buf, self, false) };
         xfer.with_waker(waker)
-            .begin(C::Sercom::DMA_TX_TRIGGER, trigger_action)
+            .begin(P::Sercom::DMA_TX_TRIGGER, trigger_action)
     }
 }
 
-impl<C, A> Spi<C, A>
+impl<P, M, Z> Spi<P, M, Z>
 where
-    C: spi::ValidConfig,
-    A: spi::Receive,
-    Self: Buffer<Beat = C::Word>,
+    P: spi::ValidPads,
+    P::Capability: spi::Receive,
+    M: spi::OpMode,
+    Z: spi::Size,
+    Self: Buffer<Beat = Z::Word>,
 {
     /// Transform an [`Spi`] into a DMA [`Transfer`]) and
     /// start a receive transaction.
@@ -358,7 +361,7 @@ where
     ) -> Transfer<Channel<Ch::Id, Busy>, BufferPair<Self, B>, W>
     where
         Ch: AnyChannel<Status = Ready>,
-        B: Buffer<Beat = C::Word> + 'static,
+        B: Buffer<Beat = Z::Word> + 'static,
         W: FnOnce(CallbackStatus) + 'static,
     {
         channel
@@ -375,6 +378,6 @@ where
         // for `B`, and the fact that the buffer length of an `Spi` is always 1.
         let xfer = unsafe { Transfer::new_unchecked(channel, self, buf, false) };
         xfer.with_waker(waker)
-            .begin(C::Sercom::DMA_RX_TRIGGER, trigger_action)
+            .begin(P::Sercom::DMA_RX_TRIGGER, trigger_action)
     }
 }