Added "device-selected" meta-feature and simplified feature gates

Also reworked some use statements to reduce amount of meta code

Signed-off-by: Daniel Egger <[email protected]>

Author: therealprof

CHANGELOG.md

@@ -10,8 +10,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added
 
 - Added Sync & Send ability to Pin
-- Added overflow guards to delay
 - Added initial implementation of an ADC interface (#13) - @HarkonenBade
+- Added virtual-feature "device-selected" to simplify feature gating
+
+### Changed
+
+- Added overflow guards to delay
 
 ## [v0.10.0] - 2018-12-23
 

Cargo.toml

@@ -44,16 +44,17 @@ version = "0.2.2"
 panic-halt = "0.2.0"
 
 [features]
+device-selected = []
 rt = ["stm32f0/rt"]
-stm32f042 = ["stm32f0/stm32f0x2"]
-stm32f030 = ["stm32f0/stm32f0x0"]
-stm32f030x4 = ["stm32f030x6"]
-stm32f030x6 = ["stm32f030"]
-stm32f030x8 = ["stm32f030"]
-stm32f030xc = ["stm32f030"]
-stm32f070 = ["stm32f0/stm32f0x0"]
-stm32f070x6 = ["stm32f070"]
-stm32f070xb = ["stm32f070"]
+stm32f042 = ["stm32f0/stm32f0x2", "device-selected"]
+stm32f030 = ["stm32f0/stm32f0x0", "device-selected"]
+stm32f030x4 = ["stm32f030x6", "device-selected"]
+stm32f030x6 = ["stm32f030", "device-selected"]
+stm32f030x8 = ["stm32f030", "device-selected"]
+stm32f030xc = ["stm32f030", "device-selected"]
+stm32f070 = ["stm32f0/stm32f0x0", "device-selected"]
+stm32f070x6 = ["stm32f070", "device-selected"]
+stm32f070xb = ["stm32f070", "device-selected"]
 
 [profile.dev]
 debug = true

src/adc.rs

@@ -33,12 +33,13 @@
 //! }
 //! ```
 
+#[cfg(feature = "device-selected")]
 use embedded_hal::adc::{Channel, OneShot};
 
-use crate::stm32;
-
-use crate::gpio::*;
+#[cfg(feature = "device-selected")]
+use crate::{stm32, gpio::*};
 
+#[cfg(feature = "device-selected")]
 /// Analog to Digital converter interface
 pub struct Adc {
     rb: stm32::ADC,
@@ -70,6 +71,7 @@ pub enum AdcSampleTime {
     T_239,
 }
 
+#[cfg(feature = "device-selected")]
 impl AdcSampleTime {
     fn write_bits(&self, adc: &mut stm32::ADC) {
         unsafe {
@@ -117,6 +119,7 @@ pub enum AdcAlign {
     LeftAsRM,
 }
 
+#[cfg(feature = "device-selected")]
 impl AdcAlign {
     fn write_bits(&self, adc: &mut stm32::ADC) {
         adc.cfgr1.write(|w| {
@@ -147,6 +150,7 @@ pub enum AdcPrecision {
     B_6,
 }
 
+#[cfg(feature = "device-selected")]
 impl AdcPrecision {
     fn write_bits(&self, adc: &mut stm32::ADC) {
         unsafe {
@@ -167,6 +171,7 @@ impl AdcPrecision {
     }
 }
 
+#[cfg(feature = "device-selected")]
 macro_rules! adc_pins {
     ($($pin:ty => $chan:expr),+ $(,)*) => {
         $(
@@ -179,7 +184,7 @@ macro_rules! adc_pins {
     };
 }
 
-#[cfg(any(feature = "stm32f042", feature = "stm32f030", feature = "stm32f070",))]
+#[cfg(feature = "device-selected")]
 adc_pins!(
     gpioa::PA0<Analog> => 0_u8,
     gpioa::PA1<Analog> => 1_u8,
@@ -211,11 +216,13 @@ pub struct VTemp;
 /// Internal voltage reference (ADC Channel 17)
 pub struct VRef;
 
+#[cfg(feature = "device-selected")]
 adc_pins!(
     VTemp => 16_u8,
     VRef  => 17_u8,
 );
 
+#[cfg(feature = "device-selected")]
 impl VTemp {
     /// Init a new VTemp
     pub fn new() -> Self {
@@ -236,6 +243,7 @@ impl VTemp {
     }
 }
 
+#[cfg(feature = "device-selected")]
 impl VRef {
     /// Init a new VRef
     pub fn new() -> Self {
@@ -253,17 +261,17 @@ impl VRef {
     }
 }
 
-#[cfg(any(feature = "stm32f042",))]
+#[cfg(feature = "stm32f042")]
 #[derive(Debug)]
 /// Battery reference voltage (ADC Channel 18)
 pub struct VBat;
 
-#[cfg(any(feature = "stm32f042",))]
+#[cfg(feature = "stm32f042")]
 adc_pins!(
     VBat  => 18_u8,
 );
 
-#[cfg(any(feature = "stm32f042",))]
+#[cfg(feature = "stm32f042")]
 impl VBat {
     /// Init a new VBat
     pub fn new() -> Self {
@@ -282,6 +290,7 @@ impl VBat {
     }
 }
 
+#[cfg(feature = "device-selected")]
 impl Adc {
     /// Init a new Adc
     ///
@@ -381,6 +390,7 @@ impl Adc {
     }
 }
 
+#[cfg(feature = "device-selected")]
 impl<WORD, PIN> OneShot<Adc, WORD, PIN> for Adc
 where
     WORD: From<u16>,

src/gpio.rs

@@ -143,18 +143,10 @@ macro_rules! gpio_trait {
     };
 }
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 gpio_trait!(gpioa);
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 gpio_trait!(gpiof);
 
 #[allow(unused)]
@@ -535,11 +527,7 @@ macro_rules! gpio {
     }
 }
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 gpio!(GPIOA, gpioa, iopaen, PA, [
     PA0: (pa0, 0, Input<Floating>),
     PA1: (pa1, 1, Input<Floating>),
@@ -559,11 +547,7 @@ gpio!(GPIOA, gpioa, iopaen, PA, [
     PA15: (pa15, 15, Input<Floating>),
 ]);
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 gpio!(GPIOB, gpiob, iopben, PB, [
     PB0: (pb0, 0, Input<Floating>),
     PB1: (pb1, 1, Input<Floating>),

src/i2c.rs

@@ -7,7 +7,6 @@ use embedded_hal::blocking::i2c::{Write, WriteRead};
 #[allow(unused)]
 use crate::{
     gpio::*,
-    stm32,
     time::{KiloHertz, U32Ext},
 };
 
@@ -29,10 +28,10 @@ macro_rules! i2c_pins {
     })+) => {
         $(
             $(
-                impl SclPin<stm32::$I2C> for $scl {}
+                impl SclPin<crate::stm32::$I2C> for $scl {}
             )+
             $(
-                impl SdaPin<stm32::$I2C> for $sda {}
+                impl SdaPin<crate::stm32::$I2C> for $sda {}
             )+
         )+
     }
@@ -121,7 +120,7 @@ macro_rules! i2c {
                     SDAPIN: SdaPin<$I2C>,
                 {
                     // NOTE(unsafe) This executes only during initialisation
-                    let rcc = unsafe { &(*stm32::RCC::ptr()) };
+                    let rcc = unsafe { &(*crate::stm32::RCC::ptr()) };
 
                     /* Enable clock for I2C */
                     rcc.$apbenr.modify(|_, w| w.$i2cXen().set_bit());
@@ -135,14 +134,12 @@ macro_rules! i2c {
         )+
     }
 }
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+
+#[cfg(feature = "device-selected")]
 i2c! {
     I2C1: (i2c1, i2c1en, i2c1rst, apb1enr, apb1rstr),
 }
+
 #[cfg(any(
     feature = "stm32f030xc",
     // XXX: This can't be right
@@ -153,20 +150,12 @@ i2c! {
     I2C2: (i2c2, i2c2en, i2c2rst, apb1enr, apb1rstr),
 }
 
+#[cfg(feature = "device-selected")]
 // It's s needed for the impls, but rustc doesn't recognize that
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
 #[allow(dead_code)]
-type I2cRegisterBlock = stm32::i2c1::RegisterBlock;
+type I2cRegisterBlock = crate::stm32::i2c1::RegisterBlock;
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 impl<I2C, SCLPIN, SDAPIN> I2c<I2C, SCLPIN, SDAPIN>
 where
     I2C: Deref<Target = I2cRegisterBlock>,
@@ -251,11 +240,7 @@ where
     }
 }
 
-#[cfg(any(
-    feature = "stm32f042",
-    feature = "stm32f030",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 impl<I2C, SCLPIN, SDAPIN> WriteRead for I2c<I2C, SCLPIN, SDAPIN>
 where
     I2C: Deref<Target = I2cRegisterBlock>,
@@ -336,11 +321,7 @@ where
     }
 }
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 impl<I2C, SCLPIN, SDAPIN> Write for I2c<I2C, SCLPIN, SDAPIN>
 where
     I2C: Deref<Target = I2cRegisterBlock>,

src/lib.rs

@@ -9,14 +9,6 @@ pub use stm32f0::stm32f0x2 as stm32;
 #[cfg(any(feature = "stm32f030", feature = "stm32f070"))]
 pub use stm32f0::stm32f0x0 as stm32;
 
-
-#[cfg(not(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-)))]
-pub mod stm32 {}
-
 pub mod adc;
 pub mod delay;
 pub mod gpio;

src/rcc.rs

@@ -1,10 +1,3 @@
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
-use crate::stm32::{FLASH, RCC};
-
 use crate::time::Hertz;
 
 /// Extension trait that constrains the `RCC` peripheral
@@ -13,12 +6,8 @@ pub trait RccExt {
     fn constrain(self) -> Rcc;
 }
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
-impl RccExt for RCC {
+#[cfg(feature = "device-selected")]
+impl RccExt for crate::stm32::RCC {
     fn constrain(self) -> Rcc {
         Rcc {
             cfgr: CFGR {
@@ -45,11 +34,7 @@ pub struct CFGR {
     sysclk: Option<u32>,
 }
 
-#[cfg(any(
-    feature = "stm32f030",
-    feature = "stm32f042",
-    feature = "stm32f070"
-))]
+#[cfg(feature = "device-selected")]
 impl CFGR {
     pub fn hclk<F>(mut self, freq: F) -> Self
     where
@@ -121,7 +106,7 @@ impl CFGR {
 
         // adjust flash wait states
         unsafe {
-            let flash = &*FLASH::ptr();
+            let flash = &*crate::stm32::FLASH::ptr();
             flash.acr.write(|w| {
                 w.latency().bits(if sysclk <= 24_000_000 {
                     0b000
@@ -133,7 +118,7 @@ impl CFGR {
             })
         }
 
-        let rcc = unsafe { &*RCC::ptr() };
+        let rcc = unsafe { &*crate::stm32::RCC::ptr() };
         if let Some(pllmul_bits) = pllmul_bits {
             // use PLL as source