generated internal conditional compilation gates

.github/workflows/ci.yml

@@ -26,6 +26,7 @@ jobs:
           - stm32l471
           - stm32l475
           - stm32l476
+          - stm32l485
           - stm32l486
           - stm32l496
           - stm32l4a6

Cargo.toml

@@ -19,6 +19,7 @@ exclude = [
 	"docs/*"
 ]
 edition = "2018"
+build = "build/build.rs"
 
 [dependencies]
 cortex-m = "0.7"
@@ -85,6 +86,7 @@ stm32l443 = [ "stm32l4/stm32l4x3" ]
 
 # L4x5
 stm32l475 = [ "stm32l4/stm32l4x5" ]
+stm32l485 = [ "stm32l4/stm32l4x5" ]
 
 # L4x6
 stm32l476 = [ "stm32l4/stm32l4x6" ]

build/build.rs

@@ -0,0 +1,22 @@
+pub(crate) mod features;
+
+fn main() {
+    assert!(
+        features::validate_selected_features(),
+        "
+This crate requires exactly one of the following features to be enabled:
+    stm32l431, stm32l451, stm32l471
+    stm32l412, stm32l422, stm32l432, stm32l442, stm32l452, stm32l462
+    stm32l433, stm32l443
+    stm32l475, 
+    stm32l476, stm32l486, stm32l496, stm32l4a6
+    stm32l4r9, stm32l4s9
+"
+    );
+    features::generate_internal_features();
+}
+
+pub(crate) struct FeatureGate<'a> {
+    pub name: &'a str,
+    pub state: bool,
+}

build/features/family.rs

@@ -0,0 +1,86 @@
+use crate::{features::*, FeatureGate};
+
+/// list of peripherals to be gated and whether they are present for the selected features
+/// see [crate::features::generate_internal_features()] for how to reference these
+pub(crate) const DEVICE_FAMILY: &[FeatureGate] = &[
+    FeatureGate {
+        name: "L4x1",
+        state: IS_FEATURE_ENABLED_L431 || IS_FEATURE_ENABLED_L451 || IS_FEATURE_ENABLED_L471,
+    },
+    FeatureGate {
+        name: "L4x2",
+        state: IS_FEATURE_ENABLED_L412
+            || IS_FEATURE_ENABLED_L422
+            || IS_FEATURE_ENABLED_L432
+            || IS_FEATURE_ENABLED_L442
+            || IS_FEATURE_ENABLED_L452
+            || IS_FEATURE_ENABLED_L462,
+    },
+    FeatureGate {
+        name: "L4x3",
+        state: IS_FEATURE_ENABLED_L433 || IS_FEATURE_ENABLED_L443,
+    },
+    FeatureGate {
+        name: "L4x5",
+        state: IS_FEATURE_ENABLED_L475 || IS_FEATURE_ENABLED_L485,
+    },
+    FeatureGate {
+        name: "L4x6",
+        state: IS_FEATURE_ENABLED_L476
+            || IS_FEATURE_ENABLED_L486
+            || IS_FEATURE_ENABLED_L496
+            || IS_FEATURE_ENABLED_L4A6,
+    },
+    FeatureGate {
+        name: "L4+x5",
+        state: IS_FEATURE_ENABLED_L4P5
+            || IS_FEATURE_ENABLED_L4Q5
+            || IS_FEATURE_ENABLED_L4R5
+            || IS_FEATURE_ENABLED_L4S5,
+    },
+    FeatureGate {
+        name: "L4+x7",
+        state: IS_FEATURE_ENABLED_L4S7 || IS_FEATURE_ENABLED_L4R7,
+    },
+    FeatureGate {
+        name: "L4+x9",
+        state: IS_FEATURE_ENABLED_L4S9 || IS_FEATURE_ENABLED_L4R9,
+    },
+    FeatureGate {
+        name: "L41_42",
+        state: IS_FEATURE_ENABLED_L412 || IS_FEATURE_ENABLED_L422,
+    },
+    FeatureGate {
+        name: "L43_44",
+        state: IS_FEATURE_ENABLED_L431
+            || IS_FEATURE_ENABLED_L432
+            || IS_FEATURE_ENABLED_L433
+            || IS_FEATURE_ENABLED_L442
+            || IS_FEATURE_ENABLED_L443,
+    },
+    FeatureGate {
+        name: "L45_46",
+        state: IS_FEATURE_ENABLED_L451 || IS_FEATURE_ENABLED_L452 || IS_FEATURE_ENABLED_L462,
+    },
+    FeatureGate {
+        name: "L47_48",
+        state: IS_FEATURE_ENABLED_L471
+            || IS_FEATURE_ENABLED_L475
+            || IS_FEATURE_ENABLED_L476
+            || IS_FEATURE_ENABLED_L485
+            || IS_FEATURE_ENABLED_L486,
+    },
+    FeatureGate {
+        name: "L4P_4Q",
+        state: IS_FEATURE_ENABLED_L4P5 || IS_FEATURE_ENABLED_L4Q5,
+    },
+    FeatureGate {
+        name: "L4R_4S",
+        state: IS_FEATURE_ENABLED_L4R5
+            || IS_FEATURE_ENABLED_L4S5
+            || IS_FEATURE_ENABLED_L4R7
+            || IS_FEATURE_ENABLED_L4S7
+            || IS_FEATURE_ENABLED_L4R9
+            || IS_FEATURE_ENABLED_L4S9,
+    },
+];

build/features/mod.rs

@@ -0,0 +1,105 @@
+pub(crate) mod family;
+pub(crate) mod peripherals;
+
+/// check that a valid combination of externally visible features has been enabled by dependant crates
+/// this check asserts:
+/// * exactly one of the device selection features is enabled (e.g. stm32l432)
+pub(crate) fn validate_selected_features() -> bool {
+    const DEVICE_FEATURES: &[bool] = &[
+        IS_FEATURE_ENABLED_L412,
+        IS_FEATURE_ENABLED_L422,
+        IS_FEATURE_ENABLED_L431,
+        IS_FEATURE_ENABLED_L432,
+        IS_FEATURE_ENABLED_L433,
+        IS_FEATURE_ENABLED_L442,
+        IS_FEATURE_ENABLED_L443,
+        IS_FEATURE_ENABLED_L451,
+        IS_FEATURE_ENABLED_L452,
+        IS_FEATURE_ENABLED_L462,
+        IS_FEATURE_ENABLED_L471,
+        IS_FEATURE_ENABLED_L475,
+        IS_FEATURE_ENABLED_L476,
+        IS_FEATURE_ENABLED_L485,
+        IS_FEATURE_ENABLED_L486,
+        IS_FEATURE_ENABLED_L496,
+        IS_FEATURE_ENABLED_L4A6,
+        // These don't count since there isn't an official feature for them
+        //IS_FEATURE_ENABLED_L4P5,
+        //IS_FEATURE_ENABLED_L4Q5,
+        //IS_FEATURE_ENABLED_L4R5,
+        //IS_FEATURE_ENABLED_L4S5,
+        //IS_FEATURE_ENABLED_L4R7,
+        //IS_FEATURE_ENABLED_L4S7,
+        IS_FEATURE_ENABLED_L4R9,
+        IS_FEATURE_ENABLED_L4S9,
+    ];
+    let check_selected_device = DEVICE_FEATURES.iter().filter(|&&b| b).count() == 1;
+
+    check_selected_device
+}
+
+/// the features listed in the crate TOML (e.g. stm32l432) aren't the most enlightening things when developing
+/// (e.g. which U(S)ARTs are present). This function produces a number of internal gates which can be checked almost
+/// exactly like a standard cargo feature
+///
+/// ## To check if the device belongs to a family group
+/// e.g. for the L432, the following conditions are true
+/// ```ignore
+/// #[cfg(family = "L43_44")] // group by the second digit
+/// #[cfg(family = "L4x2")] // group by the third digit
+/// ```
+/// ## To check whether a peripheral is present
+/// For completeness, even the peripherals which are always present can be checked
+/// NOTE: A peripheral missing from the list is a bug
+/// ```ignore
+/// #[cfg(has_peripheral = "adc1")]
+/// ```
+/// ## To check a peripheral variant
+/// Some peripherals have a limited number of variations that it may be clearer to check against
+/// e.g. The L4 RTC comes in two types (RTC2 / RTC3. See AN4759)
+/// ```ignore
+/// #[cfg(has_peripheral_variant = "rtc_type3")]
+/// ```
+pub(crate) fn generate_internal_features() {
+    for gate in family::DEVICE_FAMILY {
+        if gate.state {
+            println!(r#"cargo:rustc-cfg=family="{}""#, gate.name);
+        }
+    }
+    for gate in peripherals::PERIPHERAL_FEATURES {
+        if gate.state {
+            println!(r#"cargo:rustc-cfg=has_peripheral="{}""#, gate.name);
+        }
+    }
+    for gate in peripherals::PERIPHERAL_VARIANTS {
+        if gate.state {
+            println!(r#"cargo:rustc-cfg=has_peripheral_variant="{}""#, gate.name);
+        }
+    }
+}
+
+pub(crate) const IS_FEATURE_ENABLED_L412: bool = cfg!(feature = "stm32l412");
+pub(crate) const IS_FEATURE_ENABLED_L422: bool = cfg!(feature = "stm32l422");
+pub(crate) const IS_FEATURE_ENABLED_L431: bool = cfg!(feature = "stm32l431");
+pub(crate) const IS_FEATURE_ENABLED_L432: bool = cfg!(feature = "stm32l432");
+pub(crate) const IS_FEATURE_ENABLED_L433: bool = cfg!(feature = "stm32l433");
+pub(crate) const IS_FEATURE_ENABLED_L442: bool = cfg!(feature = "stm32l442");
+pub(crate) const IS_FEATURE_ENABLED_L443: bool = cfg!(feature = "stm32l443");
+pub(crate) const IS_FEATURE_ENABLED_L451: bool = cfg!(feature = "stm32l451");
+pub(crate) const IS_FEATURE_ENABLED_L452: bool = cfg!(feature = "stm32l452");
+pub(crate) const IS_FEATURE_ENABLED_L462: bool = cfg!(feature = "stm32l462");
+pub(crate) const IS_FEATURE_ENABLED_L471: bool = cfg!(feature = "stm32l471");
+pub(crate) const IS_FEATURE_ENABLED_L475: bool = cfg!(feature = "stm32l475");
+pub(crate) const IS_FEATURE_ENABLED_L476: bool = cfg!(feature = "stm32l476");
+pub(crate) const IS_FEATURE_ENABLED_L485: bool = cfg!(feature = "stm32l485");
+pub(crate) const IS_FEATURE_ENABLED_L486: bool = cfg!(feature = "stm32l486");
+pub(crate) const IS_FEATURE_ENABLED_L496: bool = cfg!(feature = "stm32l496");
+pub(crate) const IS_FEATURE_ENABLED_L4A6: bool = cfg!(feature = "stm32l4a6");
+pub(crate) const IS_FEATURE_ENABLED_L4P5: bool = cfg!(feature = "stm32l4p5");
+pub(crate) const IS_FEATURE_ENABLED_L4Q5: bool = cfg!(feature = "stm32l4q5");
+pub(crate) const IS_FEATURE_ENABLED_L4R5: bool = cfg!(feature = "stm32l4r5");
+pub(crate) const IS_FEATURE_ENABLED_L4S5: bool = cfg!(feature = "stm32l4s5");
+pub(crate) const IS_FEATURE_ENABLED_L4R7: bool = cfg!(feature = "stm32l4r7");
+pub(crate) const IS_FEATURE_ENABLED_L4S7: bool = cfg!(feature = "stm32l4s7");
+pub(crate) const IS_FEATURE_ENABLED_L4R9: bool = cfg!(feature = "stm32l4r9");
+pub(crate) const IS_FEATURE_ENABLED_L4S9: bool = cfg!(feature = "stm32l4s9");