improve spi traits

Author: andrewgazelka

src/dma/macros.rs

@@ -125,7 +125,7 @@ macro_rules! peripheral_target_instance {
             unsafe impl TargetAddress<M2P> for spi::Spi<$peripheral, spi::Disabled, $size> {
                 #[inline(always)]
                 fn address(&self) -> usize {
-                    use spi::SpiAll;
+                    use spi::HalSpi;
                     &self.inner().$txreg as *const _ as usize
                 }
 
@@ -137,7 +137,7 @@ macro_rules! peripheral_target_instance {
             unsafe impl TargetAddress<P2M> for spi::Spi<$peripheral, spi::Disabled, $size> {
                 #[inline(always)]
                 fn address(&self) -> usize {
-                    use spi::SpiAll;
+                    use spi::HalSpi;
                     &self.inner().$rxreg as *const _ as usize
                 }
 

src/prelude.rs

@@ -23,9 +23,9 @@ pub use crate::sai::SaiPdmExt as _stm32h7xx_hal_spi_SaiPdmExt;
 #[cfg(feature = "sdmmc")]
 pub use crate::sdmmc::SdmmcExt as _stm32h7xx_hal_sdmmc_SdmmcExt;
 pub use crate::serial::SerialExt as _stm32h7xx_hal_serial_SerialExt;
-pub use crate::spi::SpiAll as _stm32h7xx_hal_spi_SpiAll;
-pub use crate::spi::SpiDisabled as _stm32h7xx_hal_spi_SpiDisabled;
-pub use crate::spi::SpiEnabled as _stm32h7xx_hal_spi_SpiEnabled;
+pub use crate::spi::HalDisabledSpi as _stm32h7xx_hal_spi_HalDisabledSpi;
+pub use crate::spi::HalEnabledSpi as _stm32h7xx_hal_spi_HalEnabledSpi;
+pub use crate::spi::HalSpi as _stm32h7xx_hal_spi_HalSpi;
 pub use crate::spi::SpiExt as _stm32h7xx_hal_spi_SpiExt;
 pub use crate::time::U32Ext as _stm32h7xx_hal_time_U32Ext;
 pub use crate::timer::TimerExt as _stm32h7xx_hal_timer_TimerExt;

src/spi.rs

@@ -541,8 +541,10 @@ pub trait SpiExt<SPI, WORD>: Sized {
         CONFIG: Into<Config>;
 }
 
-pub trait SpiEnabled: SpiAll + FullDuplex<Self::Word, Error = Error> {
-    type Disabled: SpiDisabled<
+pub trait HalEnabledSpi:
+    HalSpi + FullDuplex<Self::Word, Error = Error>
+{
+    type Disabled: HalDisabledSpi<
         Spi = Self::Spi,
         Word = Self::Word,
         Enabled = Self,
@@ -556,10 +558,16 @@ pub trait SpiEnabled: SpiAll + FullDuplex<Self::Word, Error = Error> {
     /// disabled.
     fn disable(self) -> Self::Disabled;
 
-    /// Resets the SPI peripheral. This is just a call to [SpiEnabled::disable]
-    /// and [SpiDisabled::enable]
-    fn reset(self) -> Self {
-        self.disable().enable()
+    /// Resets the SPI peripheral. This is just a call to [HalEnabledSpi::disable]
+    /// and [HalDisabledSpi::enable]
+    fn reset(&mut self) {
+        // SAFETY: we are essentially `core::mem::take`ing here without replacing with a default
+        // value. This is safe because we are not using the old value and are replacing it with
+        // a valid value at the end of the function. `mem::take`ing is needed because the `disable`
+        // and `enable` methods take ownership of the HAL SPI.
+        let spi_enabled: Self = unsafe { core::mem::transmute_copy(self) };
+        let spi_disabled = spi_enabled.disable();
+        *self = spi_disabled.enable();
     }
 
     /// Sets up a frame transaction with the given amount of data words.
@@ -585,9 +593,9 @@ pub trait SpiEnabled: SpiAll + FullDuplex<Self::Word, Error = Error> {
     fn end_transaction(&mut self) -> Result<(), Error>;
 }
 
-pub trait SpiDisabled: SpiAll {
+pub trait HalDisabledSpi: HalSpi {
     type Rec;
-    type Enabled: SpiEnabled<Spi = Self::Spi, Word = Self::Word>;
+    type Enabled: HalEnabledSpi<Spi = Self::Spi, Word = Self::Word>;
 
     /// Enables the SPI peripheral.
     /// Clears the MODF flag, the SSI flag, and sets the SPE bit.
@@ -611,7 +619,7 @@ pub trait SpiDisabled: SpiAll {
     fn free(self) -> (Self::Spi, Self::Rec);
 }
 
-pub trait SpiAll: Sized {
+pub trait HalSpi: Sized {
     type Spi;
     type Word;
 
@@ -805,7 +813,7 @@ macro_rules! spi {
                     }
                 }
 
-                impl SpiEnabled for Spi<$SPIX, Enabled, $TY> {
+                impl HalEnabledSpi for Spi<$SPIX, Enabled, $TY> {
                     type Disabled = Spi<Self::Spi, Disabled, Self::Word>;
 
                     fn disable(self) -> Spi<$SPIX, Disabled, $TY> {
@@ -859,7 +867,7 @@ macro_rules! spi {
                     }
                 }
 
-                impl SpiDisabled for Spi<$SPIX, Disabled, $TY> {
+                impl HalDisabledSpi for Spi<$SPIX, Disabled, $TY> {
                     type Rec = rec::$Rec;
                     type Enabled = Spi<Self::Spi, Enabled, Self::Word>;
 
@@ -895,7 +903,7 @@ macro_rules! spi {
                     }
                 }
 
-                impl<EN> SpiAll for Spi<$SPIX, EN, $TY>
+                impl<EN> HalSpi for Spi<$SPIX, EN, $TY>
                 {
                     type Word = $TY;
                     type Spi = $SPIX;