Merge pull request #273 from Sh3Rm4n/spi

Rework Spi

Author: Sh3Rm4n

CHANGELOG.md

@@ -139,6 +139,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
   - `Timer::new` now does not take a timeout value. This means, that the
     timer will now not be started automatically and one has to explicitly call
     `start()`.
+- Rework SPI implementation: ([#273])
+  - A generic `Instance` trait now represents all Spi peripherals.
+  - `Spi::spi1` and so on are renamed to `Spi::new`.
+  - Add SPI configuration type to be passed into `Spi::new`
 
 ## [v0.7.0] - 2021-06-18
 
@@ -464,6 +468,7 @@ let clocks = rcc
 [defmt]: https://github.com/knurling-rs/defmt
 [filter]: https://defmt.ferrous-systems.com/filtering.html
 
+[#273]: https://github.com/stm32-rs/stm32f3xx-hal/pull/273
 [#271]: https://github.com/stm32-rs/stm32f3xx-hal/pull/271
 [#270]: https://github.com/stm32-rs/stm32f3xx-hal/pull/270
 [#267]: https://github.com/stm32-rs/stm32f3xx-hal/pull/267

Cargo.toml

@@ -175,15 +175,15 @@ required-features = ["ld", "stm32f303xc", "usb"]
 
 [[example]]
 name = "spi"
-required-features = ["ld", "stm32f303"]
+required-features = ["ld", "stm32f303xc"]
 
 [[example]]
 name = "can"
 required-features = ["ld", "rt", "can", "stm32f302"]
 
 [[example]]
 name = "serial_dma"
-required-features = ["ld", "rt", "stm32f303"]
+required-features = ["ld", "rt", "stm32f303xc"]
 
 [[example]]
 name = "serial_echo_rtic"

examples/spi.rs

@@ -3,8 +3,6 @@
 #![no_std]
 #![no_main]
 
-use core::convert::TryInto;
-
 use panic_semihosting as _;
 
 use stm32f3xx_hal as hal;
@@ -14,15 +12,15 @@ use cortex_m_rt::entry;
 
 use hal::pac;
 use hal::prelude::*;
-use hal::spi::{Mode, Phase, Polarity, Spi};
+use hal::spi::Spi;
 
 #[entry]
 fn main() -> ! {
     let dp = pac::Peripherals::take().unwrap();
 
     let mut flash = dp.FLASH.constrain();
     let mut rcc = dp.RCC.constrain();
-    let mut gpioa = dp.GPIOA.split(&mut rcc.ahb);
+    let mut gpioc = dp.GPIOC.split(&mut rcc.ahb);
 
     let clocks = rcc
         .cfgr
@@ -32,29 +30,17 @@ fn main() -> ! {
         .freeze(&mut flash.acr);
 
     // Configure pins for SPI
-    let sck = gpioa
-        .pa5
-        .into_af5_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrl);
-    let miso = gpioa
-        .pa6
-        .into_af5_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrl);
-    let mosi = gpioa
-        .pa7
-        .into_af5_push_pull(&mut gpioa.moder, &mut gpioa.otyper, &mut gpioa.afrl);
-
-    let spi_mode = Mode {
-        polarity: Polarity::IdleLow,
-        phase: Phase::CaptureOnFirstTransition,
-    };
-
-    let mut spi = Spi::spi1(
-        dp.SPI1,
-        (sck, miso, mosi),
-        spi_mode,
-        3u32.MHz().try_into().unwrap(),
-        clocks,
-        &mut rcc.apb2,
-    );
+    let sck = gpioc
+        .pc10
+        .into_af6_push_pull(&mut gpioc.moder, &mut gpioc.otyper, &mut gpioc.afrh);
+    let miso = gpioc
+        .pc11
+        .into_af6_push_pull(&mut gpioc.moder, &mut gpioc.otyper, &mut gpioc.afrh);
+    let mosi = gpioc
+        .pc12
+        .into_af6_push_pull(&mut gpioc.moder, &mut gpioc.otyper, &mut gpioc.afrh);
+
+    let mut spi = Spi::new(dp.SPI3, (sck, miso, mosi), 3.MHz(), clocks, &mut rcc.apb1);
 
     // Create an `u8` array, which can be transfered via SPI.
     let msg_send: [u8; 8] = [0xD, 0xE, 0xA, 0xD, 0xB, 0xE, 0xE, 0xF];

release.toml

@@ -51,12 +51,48 @@ file = "src/i2c.rs"
 search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
 replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
 
+[[pre-release-replacements]]
+min = 0
+file = "src/timer.rs"
+search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
+replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
+
+[[pre-release-replacements]]
+min = 0
+file = "src/timer/interrupts.rs"
+search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
+replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
+
+[[pre-release-replacements]]
+min = 0
+file = "src/spi.rs"
+search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
+replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
+
+[[pre-release-replacements]]
+min = 0
+file = "src/spi/config.rs"
+search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
+replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
+
 [[pre-release-replacements]]
 min = 0
 file = "src/serial.rs"
 search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
 replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
 
+[[pre-release-replacements]]
+min = 0
+file = "src/serial/config.rs"
+search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
+replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
+
+[[pre-release-replacements]]
+min = 0
+file = "src/interrupts.rs"
+search = "https://github.com/stm32-rs/stm32f3xx-hal/blob/[a-z0-9\\.-]+/"
+replace = "https://github.com/stm32-rs/stm32f3xx-hal/blob/v{{version}}/"
+
 [[pre-release-replacements]]
 min = 0
 file = "src/watchdog.rs"

src/adc.rs

@@ -72,7 +72,7 @@ pub enum SampleTime {
 }
 
 impl Default for SampleTime {
-    /// [`SampelTime::Cycles1C5`] is also the reset value.
+    /// [`SampleTime::Cycles1C5`] is also the reset value.
     fn default() -> Self {
         SampleTime::Cycles1C5
     }

src/serial.rs

@@ -319,152 +319,7 @@ cfg_if! {
     }
 }
 
-/// Types for configuring a serial interface.
-pub mod config {
-    use crate::pac::usart1::cr2::STOP_A;
-    use crate::time::rate::{Baud, Extensions};
-
-    /// Stop Bit configuration parameter for serial.
-    ///
-    /// Wrapper around [`STOP_A`]
-    #[derive(Clone, Copy, Debug, PartialEq)]
-    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-    pub enum StopBits {
-        /// 0.5 stop bit
-        Stop0P5,
-        /// 1 stop bit
-        Stop1,
-        /// 1.5 stop bit
-        Stop1P5,
-        /// 2 stop bit
-        Stop2,
-    }
-
-    impl From<StopBits> for STOP_A {
-        fn from(stopbit: StopBits) -> Self {
-            match stopbit {
-                StopBits::Stop0P5 => STOP_A::STOP0P5,
-                StopBits::Stop1 => STOP_A::STOP1,
-                StopBits::Stop1P5 => STOP_A::STOP1P5,
-                StopBits::Stop2 => STOP_A::STOP2,
-            }
-        }
-    }
-
-    impl From<STOP_A> for StopBits {
-        fn from(stopbit: STOP_A) -> Self {
-            match stopbit {
-                STOP_A::STOP0P5 => StopBits::Stop0P5,
-                STOP_A::STOP1 => StopBits::Stop1,
-                STOP_A::STOP1P5 => StopBits::Stop1P5,
-                STOP_A::STOP2 => StopBits::Stop2,
-            }
-        }
-    }
-
-    /// Parity generation and checking. If odd or even parity is selected, the
-    /// underlying USART will be configured to send/receive the parity bit in
-    /// addtion to the data bits.
-    #[cfg_attr(feature = "defmt", derive(defmt::Format))]
-    #[derive(Debug, Clone, Copy, PartialEq)]
-    pub enum Parity {
-        /// No parity bit will be added/checked.
-        None,
-        /// The MSB transmitted/received will be generated/checked to have a
-        /// even number of bits set.
-        Even,
-        /// The MSB transmitted/received will be generated/checked to have a
-        /// odd number of bits set.
-        Odd,
-    }
-
-    /// Configuration struct for [`Serial`](super::Serial) providing all
-    /// communication-related / parameters. `Serial` always uses eight data
-    /// bits plus the parity bit - if selected.
-    ///
-    /// Create a configuration by using `default` in combination with the
-    /// builder methods. The following snippet shows creating a configuration
-    /// for 19,200 Baud, 8N1 by deriving it from the default value:
-    /// ```
-    /// # use stm32f3xx_hal::serial::config::*;
-    /// # use stm32f3xx_hal::time::rate::{Baud, Extensions};
-    /// let config = Config::default().baudrate(19_200.Bd());
-    ///
-    /// assert!(config.baudrate == 19_200.Bd());
-    /// assert!(config.parity == Parity::None);
-    /// assert!(config.stopbits == StopBits::STOP1);
-    /// ```
-    #[derive(Debug, Clone, Copy, PartialEq)]
-    #[non_exhaustive]
-    pub struct Config {
-        /// Serial interface baud rate
-        pub baudrate: Baud,
-        /// Whether and how to generate/check a parity bit
-        pub parity: Parity,
-        /// The number of stop bits to follow the last data bit or the parity
-        /// bit
-        pub stopbits: StopBits,
-    }
-
-    impl Config {
-        /// Sets the given baudrate.
-        pub fn baudrate(mut self, baudrate: impl Into<Baud>) -> Self {
-            self.baudrate = baudrate.into();
-            self
-        }
-
-        /// Sets the given parity.
-        pub fn parity(mut self, parity: Parity) -> Self {
-            self.parity = parity;
-            self
-        }
-
-        /// Sets the stop bits to `stopbits`.
-        pub fn stopbits(mut self, stopbits: StopBits) -> Self {
-            self.stopbits = stopbits;
-            self
-        }
-    }
-
-    impl Default for Config {
-        /// Creates a new configuration with typically used parameters: 115,200
-        /// Baud 8N1.
-        fn default() -> Config {
-            Config {
-                baudrate: 115_200.Bd(),
-                parity: Parity::None,
-                stopbits: StopBits::Stop1,
-            }
-        }
-    }
-
-    impl<T: Into<Baud>> From<T> for Config {
-        fn from(b: T) -> Config {
-            Config {
-                baudrate: b.into(),
-                ..Default::default()
-            }
-        }
-    }
-
-    #[cfg(feature = "defmt")]
-    impl defmt::Format for Config {
-        fn format(&self, f: defmt::Formatter) {
-            // Omitting pins makes it:
-            // 1. Easier.
-            // 2. Not to specialized to use it ergonimically for users
-            //    even in a generic context.
-            // 3. Not require specialization.
-            defmt::write!(
-                f,
-                "Serial {{ baudrate: {} Bd , parity: {} , stopbits: {} }}",
-                self.baudrate.0,
-                self.parity,
-                self.stopbits,
-            );
-        }
-    }
-}
+pub mod config;
 
 /// Serial abstraction
 ///
@@ -615,7 +470,7 @@ where
         Rx: RxPin<Usart>,
         Config: Into<config::Config>,
     {
-        use self::config::*;
+        use config::*;
 
         let config = config.into();
 
@@ -724,7 +579,6 @@ where
 
     /// Obtain the associated interrupt number for the serial peripheral.
     ///
-    ///
     /// Used to unmask / enable the interrupt with [`cortex_m::peripheral::NVIC::unmask()`].
     /// This is useful for all `cortex_m::peripheral::INTERRUPT` functions.
     ///