embedded-time: move to a non-default feature

This reduces the compile time from 17.6s to 16.2s when not used.

Author: newAM

.github/workflows/ci.yml

@@ -128,7 +128,7 @@ jobs:
     env: {"RUSTFLAGS": "-D warnings"}
     strategy:
       matrix:
-        feature:
+        mcu:
           - "stm32wl5x_cm0p"
           - "stm32wl5x_cm4"
           - "stm32wle5"
@@ -139,17 +139,16 @@ jobs:
           toolchain: stable
 
       - name: Test HAL
-        run: cargo test --features ${{ matrix.feature }}
+        run: cargo test --features ${{ matrix.mcu }},embedded-time
 
       - name: Test nucleo BSP
         if: ${{ startsWith(matrix.mcu, 'stm32wl5x') }}
         run: |
-          cargo test -p nucleo-wl55jc-bsp --features ${{ matrix.feature }}
+          cargo test -p nucleo-wl55jc-bsp --features ${{ matrix.mcu }},embedded-time
 
       - name: Test LoRa E5 BSP
         if: ${{ matrix.mcu == 'stm32wle5' }}
-        run: |
-          cargo test -p lora-e5-bsp --features ${{ matrix.feature }}
+        run: cargo test -p lora-e5-bsp --features embedded-time
 
   clippy:
     name: Clippy
@@ -203,7 +202,7 @@ jobs:
         run: |
           cd hal
           cargo +nightly rustdoc \
-          --features rt,stm32wl5x_cm4 \
+          --features embedded-time,rt,stm32wl5x_cm4 \
           -- -Z unstable-options --enable-index-page
       - name: deploy
         if: ${{ github.ref == 'refs/heads/main' }}

CHANGELOG.md

@@ -17,11 +17,14 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `info::UID64`
   - Moved to `info::Uid64::PTR`.
   - Changed the type from `*const u8` to `*const u32`.
-- Moved `info::uid64` to `info::Uid64::from_device`.
-- Moved `info::uid64_devnum` to `info::Uid64::read_devnum`.
-- Moved `info::package` to `info::Package::from_device`.
-- Moved `info::uid` to `info::Uid::from_device`.
+- Moved functions in `info` into the associated structs/enums.
+  - Moved `info::uid64` to `info::Uid64::from_device`.
+  - Moved `info::uid64_devnum` to `info::Uid64::read_devnum`.
+  - Moved `info::package` to `info::Package::from_device`.
+  - Moved `info::uid` to `info::Uid::from_device`.
 - Added `#[inline]` to `util::new_delay` and `util::reset_cycle_count`.
+- `embedded-time` is now an optional feature.
+  - Changed `I2C::new` to use `u32` instead of `embedded_time::Hertz`.
 
 ## [0.2.1] - 2021-11-20
 ### Fixed

README.md

@@ -38,6 +38,8 @@ features = [
     "rt",
     # optional: use defmt
     "defmt",
+    # optional: enable conversions with embedded-time types
+    "embedded-time",
 ]
 ```
 

hal/Cargo.toml

@@ -25,7 +25,7 @@ cortex-m = "0.7.2"
 cortex-m-rt = { version = "0.7", optional = true }
 defmt = { version = "0.3", optional = true }
 embedded-hal = { version = "0.2.6", features = ["unproven"] }
-embedded-time = "0.12"
+embedded-time = { version = "0.12", optional = true }
 nb = "1"
 num-traits = { version = "0.2", default-features = false }
 paste = "1"
@@ -38,5 +38,5 @@ static_assertions = "1"
 
 [package.metadata.docs.rs]
 all-features = false
-features = ["stm32wl5x_cm4", "rt"]
+features = ["stm32wl5x_cm4", "rt", "embedded-time"]
 rustdoc-args = ["--cfg", "docsrs"]

hal/src/i2c.rs

@@ -8,10 +8,6 @@ use crate::{
 };
 
 use cortex_m::interrupt::CriticalSection;
-use embedded_time::{
-    fixed_point::FixedPoint,
-    rate::{Extensions, Hertz},
-};
 
 /// I2C error
 #[derive(Debug)]
@@ -347,12 +343,12 @@ macro_rules! impl_clocks_reset {
                 }
 
                 /// Returns the frequency of the peripheral clock driver
-                fn clock(rcc: &RCC) -> Hertz {
+                fn clock(rcc: &RCC) -> u32 {
                     // NOTE(unsafe) atomic read with no side effects
                     match rcc.ccipr.read().$i2cXsel().variant().unwrap() {
-                        I2C3SEL_A::HSI16 => Hertz(16_000_000),
-                        I2C3SEL_A::SYSCLK => Hertz(sysclk_hz(rcc)), // TODO move the HAL to embedded-time?
-                        I2C3SEL_A::PCLK => Hertz(pclk1_hz(rcc)),
+                        I2C3SEL_A::HSI16 => 16_000_000,
+                        I2C3SEL_A::SYSCLK => sysclk_hz(rcc),
+                        I2C3SEL_A::PCLK => pclk1_hz(rcc),
                     }
                 }
             }
@@ -373,12 +369,12 @@ macro_rules! impl_new_free {
                 ///
                 /// * Frequency is greater than 1 MHz
                 /// * Resulting TIMINGR fields PRESC, SCLDEL, SCADEL, SCLH, SCLL are out of range
-                pub fn new(i2c: $I2CX, mut pins: (SCL, SDA), freq: Hertz, rcc: &mut RCC, pullup: bool, cs: &CriticalSection) -> Self
+                pub fn new(i2c: $I2CX, mut pins: (SCL, SDA), freq_hz: u32, rcc: &mut RCC, pullup: bool, cs: &CriticalSection) -> Self
                     where
                     SCL: crate::gpio::sealed::$I2cXScl + crate::gpio::sealed::PinOps,
                     SDA: crate::gpio::sealed::$I2cXSda + crate::gpio::sealed::PinOps,
                     {
-                        assert!(freq.integer() <= 1_000_000); // TODO Return Error instead of panic
+                        assert!(freq_hz <= 1_000_000); // TODO Return Error instead of panic
 
                         Self::enable_clock(rcc);
                         Self::pulse_reset(rcc);
@@ -395,7 +391,7 @@ macro_rules! impl_new_free {
                             pins.1.set_pull(cs, Pull::None);
                         }
 
-                        let (presc, scll, sclh, sdadel, scldel) = i2c_clocks(Self::clock(rcc), freq);
+                        let (presc, scll, sclh, sdadel, scldel) = i2c_clocks(Self::clock(rcc), freq_hz);
 
                         // Configure for "fast mode" (400 KHz)
                         // NOTE(write): writes all non-reserved bits.
@@ -505,18 +501,18 @@ i2c!([1, 2, 3]);
 /// * SCLH
 /// * SDADEL
 /// * SCLDEL
-fn i2c_clocks(clock: Hertz, freq: Hertz) -> (u8, u8, u8, u8, u8) {
-    let i2cclk = clock.integer();
-    let ratio = i2cclk / freq.integer() - 4;
-    let (presc, scll, sclh, sdadel, scldel) = if freq >= 100.kHz() {
+fn i2c_clocks(clock_hz: u32, freq_hz: u32) -> (u8, u8, u8, u8, u8) {
+    let i2cclk = clock_hz;
+    let ratio = i2cclk / freq_hz - 4;
+    let (presc, scll, sclh, sdadel, scldel) = if freq_hz >= 100_000 {
         // fast-mode or fast-mode plus
         // here we pick SCLL + 1 = 2 * (SCLH + 1)
         let presc = ratio / 387;
 
         let sclh = ((ratio / (presc + 1)) - 3) / 3;
         let scll = 2 * (sclh + 1) - 1;
 
-        let (sdadel, scldel) = if freq > 400.kHz() {
+        let (sdadel, scldel) = if freq_hz > 400_000 {
             // fast-mode plus
             let sdadel = 0;
             let scldel = i2cclk / 4_000_000 / (presc + 1) - 1;

hal/src/lib.rs

@@ -74,4 +74,6 @@ pub use cortex_m_rt;
 pub use chrono;
 pub use cortex_m;
 pub use embedded_hal;
+
+#[cfg(feature = "embedded_time")]
 pub use embedded_time;

hal/src/subghz/timeout.rs

@@ -412,18 +412,21 @@ impl From<Timeout> for [u8; 3] {
     }
 }
 
+#[cfg(feature = "embedded_time")]
 impl From<Timeout> for embedded_time::duration::Seconds {
     fn from(to: Timeout) -> Self {
         embedded_time::duration::Seconds(to.as_secs().into())
     }
 }
 
+#[cfg(feature = "embedded_time")]
 impl From<Timeout> for embedded_time::duration::Milliseconds {
     fn from(to: Timeout) -> Self {
         embedded_time::duration::Milliseconds(to.as_millis())
     }
 }
 
+#[cfg(feature = "embedded_time")]
 impl From<Timeout> for embedded_time::duration::Microseconds {
     fn from(to: Timeout) -> Self {
         embedded_time::duration::Microseconds(to.as_micros())

hal/src/subghz/tx_params.rs

@@ -44,6 +44,7 @@ impl From<RampTime> for core::time::Duration {
     }
 }
 
+#[cfg(feature = "embedded_time")]
 impl From<RampTime> for embedded_time::duration::Microseconds {
     fn from(rt: RampTime) -> Self {
         match rt {

lora-e5-bsp/Cargo.toml

@@ -14,6 +14,7 @@ repository = "https://github.com/stm32-rs/stm32wlxx-hal"
 
 [features]
 defmt = ["stm32wlxx-hal/defmt", "dfmt"]
+embedded-time = ["stm32wlxx-hal/embedded-time"]
 rt = ["stm32wlxx-hal/rt"]
 
 [dependencies.stm32wlxx-hal]
@@ -25,3 +26,8 @@ features = ["stm32wle5"]
 package = "defmt"
 version = "0.3"
 optional = true
+
+[package.metadata.docs.rs]
+all-features = false
+features = ["rt", "embedded-time"]
+rustdoc-args = ["--cfg", "docsrs"]

lora-e5-bsp/README.md

@@ -14,6 +14,8 @@ features = [
     "rt",
     # optional: use defmt
     "defmt",
+    # optional: enable conversions with embedded-time types
+    "embedded-time",
 ]
 ```