Merge pull request #283 from Sh3Rm4n/features

Set some features as the default

Author: Sh3Rm4n

.clippy.toml

@@ -1 +1 @@
-msrv = "1.51"
+msrv = "1.52"

.github/workflows/ci.yml

@@ -24,7 +24,7 @@ jobs:
           - stm32f303x6
           # - stm32f303x8
           - stm32f303xb
-          # - stm32f303xc
+          - stm32f303xc
           - stm32f303xd
           # - stm32f303xe
           - stm32f328x8
@@ -37,10 +37,6 @@ jobs:
           - stm32f334x4
           # - stm32f334x6
           # - stm32f334x8
-        features: ["rt"]
-        include:
-          - mcu: stm32f303xc
-            features: rt,can,stm32-usbd,enumset
     steps:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
@@ -49,7 +45,7 @@ jobs:
           target: thumbv7em-none-eabihf
           override: true
           profile: minimal
-      - run: cargo check --features=${{ matrix.mcu }},ld,${{ matrix.features }} --lib --examples
+      - run: cargo check --features=${{ matrix.mcu }} --lib --examples
 
   # This is our MSRV. However this is only for documentation
   # purposes and should be increased if newer features are used.
@@ -61,7 +57,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions-rs/toolchain@v1
         with:
-          toolchain: 1.51.0
+          toolchain: 1.52.0
           target: thumbv7em-none-eabihf
           override: true
           profile: minimal
@@ -138,7 +134,7 @@ jobs:
       - uses: actions-rs/cargo@v1
         with:
           command: doc
-          args: --features=stm32f303xc,rt,stm32-usbd,can,enumset
+          args: --features=stm32f303xc
 
   clippy:
     name: Clippy
@@ -156,7 +152,7 @@ jobs:
         with:
           token: ${{ secrets.GITHUB_TOKEN }}
           args: >
-            --features=stm32f303xc,ld,rt,stm32-usbd,can --lib --examples
+            --features=stm32f303xc --lib --examples
             -- -D warnings
 
   rustfmt:

CHANGELOG.md

@@ -14,7 +14,23 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## Unreleased
 
-No changes.
+### Added
+
+- Support cortex-m-rt `v0.7.0` but still allow `v0.6.13` ([#283])
+
+### Fixed
+
+- Fix `can` support. Can would not build for `stm32f302x6` for example.
+  Also support `can` for every chip other than `stm32f301` and `stm32f318`.
+  ([#283])
+
+### Breaking Changes
+
+- Make `rtc` an optional feature. Without that feature `rtcc` as a dependency is
+  not needed. ([#283])
+- Enable `rt`, `usb`, `can`, `rtc` and `ld` feature by default.
+  To disable that behavior, set `default-features = false`. ([#283])
+- The MSRV was bumped to 1.52 ([#283])
 
 ## [v0.8.0] - 2021-08-16
 
@@ -476,6 +492,7 @@ let clocks = rcc
 [defmt]: https://github.com/knurling-rs/defmt
 [filter]: https://defmt.ferrous-systems.com/filtering.html
 
+[#283]: https://github.com/stm32-rs/stm32f3xx-hal/pull/283
 [#278]: https://github.com/stm32-rs/stm32f3xx-hal/pull/278
 [#277]: https://github.com/stm32-rs/stm32f3xx-hal/pull/277
 [#273]: https://github.com/stm32-rs/stm32f3xx-hal/pull/273

Cargo.toml

@@ -35,23 +35,22 @@ rustc-args = ["--cfg", "docsrs"]
 [dependencies]
 cfg-if = "1.0.0"
 cortex-m = "0.7.2"
-cortex-m-rt = "0.6.14"
+cortex-m-rt = { version = ">=0.6.13, <0.8" }
 defmt = { version = "0.2.3", optional = true }
 embedded-dma = "0.1.2"
 embedded-hal = { version = "0.2.5", features = ["unproven"] }
 embedded-time = "0.12.0"
 nb = "1.0.0"
 paste = "1.0.5"
-rtcc = "0.2.1"
-stm32f3 = "0.13.2"
+rtcc = { version = "0.2.1", optional = true }
+stm32f3 = { version = "0.13.2", default-features = false }
 bxcan = { version = ">=0.4, <0.6", optional = true }
 stm32-usbd = { version = "0.6.0", optional = true }
 void = { version = "1.0.2", default-features = false }
 enumset = { version = "1.0.6", optional = true}
 
 [dev-dependencies]
 cortex-m = "0.7.2"
-cortex-m-rt = { version = "0.6.13", features = ["device"] }
 cortex-m-semihosting = "0.3.7"
 defmt-rtt = "0.2.0"
 defmt-test = "0.2.3"
@@ -68,12 +67,14 @@ rtt-target = { version = "0.3.0", features = ["cortex-m"] }
 slice-group-by = "0.2.6"
 
 [features]
+default = ["rt", "ld", "usb", "can", "rtc", "enumset"]
 device-selected = []
 direct-call-deprecated = []
 ld = []
 rt = ["stm32f3/rt"]
 can = ["bxcan"]
 usb = ["stm32-usbd"]
+rtc = ["rtcc"]
 
 svd-f301 = ["stm32f3/stm32f301"]
 svd-f302 = ["stm32f3/stm32f302"]

README.md

@@ -4,7 +4,7 @@
 [![Crate](https://img.shields.io/crates/v/stm32f3xx-hal.svg)](https://crates.io/crates/stm32f3xx-hal)
 [![Docs](https://docs.rs/stm32f3xx-hal/badge.svg)](https://docs.rs/stm32f3xx-hal)
 [![Crates.io](https://img.shields.io/crates/d/stm32f3xx-hal.svg)](https://crates.io/crates/stm32f3xx-hal)
-![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.51+-blue.svg)
+![Minimum Supported Rust Version](https://img.shields.io/badge/rustc-1.52+-blue.svg)
 
 `stm32f3xx-hal` contains a multi device hardware abstraction on top of the
 peripheral access API for the STMicro STM32F3 series microcontrollers. The
@@ -139,7 +139,7 @@ See the [examples folder](examples) for more example programs.
 
 ## Minimum Supported Rust Version (MSRV)
 
-This crate is guaranteed to compile on stable Rust 1.51.0 and up. It *might*
+This crate is guaranteed to compile on stable Rust 1.52.0 and up. It *might*
 compile with older versions but that may change in any new patch release.
 
 <!-- This should not prevent anyone to use newer features. -->

src/can.rs

@@ -12,7 +12,7 @@
 //! [examples/can.rs]: https://github.com/stm32-rs/stm32f3xx-hal/blob/v0.8.0/examples/can.rs
 
 use crate::gpio::{gpioa, gpiob};
-use crate::gpio::{PushPull, AF7, AF9};
+use crate::gpio::{PushPull, AF9};
 use crate::pac;
 
 use crate::rcc::APB1;
@@ -22,33 +22,21 @@ use bxcan::RegisterBlock;
 
 use cfg_if::cfg_if;
 
-mod sealed {
-    pub trait Sealed {}
-}
-
 /// Marker trait for pins (with specific AF mode) that can be used as a CAN RX pin.
-pub trait RxPin: sealed::Sealed {}
+pub trait RxPin: crate::private::Sealed {}
 
 /// Marker trait for pins (with specific AF mode) that can be used as a CAN TX pin.
-pub trait TxPin: sealed::Sealed {}
-
-cfg_if! {
-    if #[cfg(any(feature = "gpio-f302", feature = "gpio-f303"))] {
-        use crate::gpio::gpiod;
-
-        impl sealed::Sealed for gpioa::PA11<AF9<PushPull>> {}
-        impl RxPin for gpioa::PA11<AF9<PushPull>> {}
-        impl sealed::Sealed for gpioa::PA12<AF9<PushPull>> {}
-        impl TxPin for gpioa::PA12<AF9<PushPull>> {}
+pub trait TxPin: crate::private::Sealed {}
 
-        impl sealed::Sealed for gpiob::PB8<AF9<PushPull>> {}
-        impl RxPin for gpiob::PB8<AF9<PushPull>> {}
-        impl sealed::Sealed for gpiob::PB9<AF9<PushPull>> {}
-        impl TxPin for gpiob::PB9<AF9<PushPull>> {}
+impl RxPin for gpioa::PA11<AF9<PushPull>> {}
+impl TxPin for gpioa::PA12<AF9<PushPull>> {}
+impl RxPin for gpiob::PB8<AF9<PushPull>> {}
+impl TxPin for gpiob::PB9<AF9<PushPull>> {}
 
-        impl sealed::Sealed for gpiod::PD0<AF7<PushPull>> {}
+cfg_if! {
+    if #[cfg(any(feature = "gpio-f303", feature = "gpio-f303e", feature = "gpio-f373"))] {
+        use crate::gpio::{gpiod, AF7};
         impl RxPin for gpiod::PD0<AF7<PushPull>> {}
-        impl sealed::Sealed for gpiod::PD1<AF7<PushPull>> {}
         impl TxPin for gpiod::PD1<AF7<PushPull>> {}
     }
 }

src/lib.rs

@@ -80,7 +80,11 @@
 
  ### `usb`
 
- Enable USB peripherals on supported targets via the [`stm32-usbd`](https://crates.io/crates/sttm32-usbd) crate.
+ Enable USB peripherals on supported targets via the [`stm32-usbd`](https://crates.io/crates/stm32-usbd) crate.
+
+ ### `rtc`
+
+ Enables RTC support, build upon [`rtcc`](https://crates.io/crates/rtcc) crate.
 
  ### `enumset`
 
@@ -168,7 +172,7 @@ pub use crate::pac::interrupt;
 #[cfg(feature = "stm32f303")]
 #[cfg_attr(docsrs, doc(cfg(feature = "stm32f303")))]
 pub mod adc;
-#[cfg(feature = "can")]
+#[cfg(all(feature = "can", not(feature = "svd-f301")))]
 #[cfg_attr(docsrs, doc(cfg(feature = "can")))]
 pub mod can;
 pub mod delay;
@@ -180,6 +184,8 @@ pub mod interrupts;
 pub mod prelude;
 pub mod pwm;
 pub mod rcc;
+#[cfg(feature = "rtc")]
+#[cfg_attr(docsrs, doc(cfg(feature = "rtc")))]
 pub mod rtc;
 pub mod serial;
 pub mod spi;

src/spi.rs

@@ -501,6 +501,7 @@ mod interrupts {
             // generated an enum-number for that. The RM0365 does also not list it as an interrupt.
             // Strangly though, the Stm32CubeMx program let's us choose to enable the NVIC
             // interrupt. This is probably a documentation bug.
+            #[allow(unused)]
             pub(crate) const SPI4: Interrupt = Interrupt::SPI3;
         } else if #[cfg(feature = "gpio-f303e")] {
             pub(crate) const SPI4: Interrupt = Interrupt::SPI4;

testsuite/Cargo.toml

@@ -50,25 +50,25 @@ harness = false
 [dependencies]
 cfg-if = "1.0"
 cortex-m = "0.7.0"
-cortex-m-rt = "0.6.15"
+cortex-m-rt = "0.6.13"
 defmt = "0.2.0"
 defmt-rtt = "0.2.0"
 defmt-test = "0.2.0"
 enumset = { version = "1.0.6" }
 # TODO: Set stm32f303xc as default, but make it overwritable
-stm32f3xx-hal = { path = "..", features = ["rt", "defmt-trace", "can", "ld", "enumset"]}
+stm32f3xx-hal = { path = "..", features = ["defmt-trace"]}
 panic-probe = { version = "0.2.0", features = ["print-defmt"] }
 nb = "1.0.0"
 num-traits = { version = "0.2.14", default-features = false }
 
 [features]
 # enable all defmt logging levels
-default = ["defmt-trace", "stm32f3xx-hal/stm32f303xc", "stm32f3xx-hal/ld"]
+default = ["stm32f3xx-hal/stm32f303xc"]
 
 # do not modify these features
-defmt-default = []
-defmt-trace = []
-defmt-debug = []
-defmt-info = []
-defmt-warn = []
-defmt-error = []
+defmt-default = ["defmt-info"]
+defmt-trace = ["stm32f3xx-hal/defmt-trace"]
+defmt-debug = ["stm32f3xx-hal/defmt-trace"]
+defmt-info = ["stm32f3xx-hal/defmt-trace"]
+defmt-warn = ["stm32f3xx-hal/defmt-trace"]
+defmt-error = ["stm32f3xx-hal/defmt-trace"]