codegen: Emit 'auto-generated' comment

Author: teskje

codegen/src/codegen/gpio.rs

@@ -80,7 +80,7 @@ fn gen_port(port: &Port, feature: &str) -> Result<()> {
     );
     println!("        pins: [");
 
-    for pin in port.pins.iter() {
+    for pin in &port.pins {
         gen_pin(pin)?;
     }
 
@@ -130,7 +130,7 @@ fn get_pin_reset_mode(pin: &gpio::Pin) -> Result<&'static str> {
 
 fn get_pin_af_numbers(pin: &gpio::Pin) -> Result<Vec<u8>> {
     let mut numbers = Vec::new();
-    for signal in pin.pin_signals.iter() {
+    for signal in &pin.pin_signals {
         numbers.push(signal.af()?);
     }
 

codegen/src/codegen/mod.rs

@@ -1 +1,11 @@
 pub mod gpio;
+
+use crate::cubemx::package::Package;
+
+pub fn gen_autogen_comment(package: &Package) {
+    println!("// auto-generated using codegen");
+    println!(
+        "// STM32CubeMX DB release: {}",
+        package.pack_description.release
+    );
+}

codegen/src/cubemx/db.rs

@@ -23,4 +23,11 @@ impl Db {
         serde_xml_rs::de::from_reader(file)
             .with_context(|| format!("cannot parse DB file: {:?}", path))
     }
+
+    pub fn load_mcu<'de, P: AsRef<Path>, T: Deserialize<'de>>(&self, name: P) -> Result<T> {
+        let mut mcu_path = PathBuf::new();
+        mcu_path.push("mcu");
+        mcu_path.push(name);
+        self.load(&mcu_path)
+    }
 }

codegen/src/cubemx/families.rs

@@ -3,7 +3,7 @@ use anyhow::{Context, Result};
 use serde::Deserialize;
 
 pub fn load(db: &Db) -> Result<Families> {
-    db.load("families")
+    db.load_mcu("families")
 }
 
 pub fn load_f3(db: &Db) -> Result<Family> {

codegen/src/cubemx/ip/gpio.rs

@@ -1,13 +1,14 @@
-use super::ip_path;
 use crate::cubemx::Db;
 use anyhow::{bail, Context, Result};
 use once_cell::sync::Lazy;
 use regex::Regex;
 use serde::Deserialize;
+use std::path::PathBuf;
 
 pub fn load(db: &Db, version: &str) -> Result<Ip> {
     let name = format!("GPIO-{}_Modes", version);
-    db.load(ip_path(&name))
+    let ip_path: PathBuf = ["IP", &name].iter().collect();
+    db.load_mcu(&ip_path)
 }
 
 #[derive(Debug, Deserialize)]

codegen/src/cubemx/ip/mod.rs

@@ -1,7 +1 @@
 pub mod gpio;
-
-use std::path::PathBuf;
-
-fn ip_path(name: &str) -> PathBuf {
-    ["IP", name].iter().collect()
-}

codegen/src/cubemx/mcu.rs

@@ -3,7 +3,7 @@ use anyhow::Result;
 use serde::Deserialize;
 
 pub fn load(db: &Db, name: &str) -> Result<Mcu> {
-    db.load(name)
+    db.load_mcu(name)
 }
 
 #[derive(Debug, Deserialize)]

codegen/src/cubemx/mod.rs

@@ -1,6 +1,7 @@
 pub mod families;
 pub mod ip;
 pub mod mcu;
+pub mod package;
 
 mod db;
 

codegen/src/cubemx/package.rs

@@ -0,0 +1,19 @@
+use crate::cubemx::Db;
+use anyhow::Result;
+use serde::Deserialize;
+
+pub fn load(db: &Db) -> Result<Package> {
+    db.load("package")
+}
+
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+pub struct Package {
+    pub pack_description: PackDescription,
+}
+
+#[derive(Debug, Deserialize)]
+#[serde(rename_all = "PascalCase")]
+pub struct PackDescription {
+    pub release: String,
+}

codegen/src/main.rs

@@ -3,6 +3,7 @@ mod cubemx;
 
 use anyhow::Result;
 use clap::{App, AppSettings, Arg, ArgMatches, SubCommand};
+use cubemx::Db;
 
 fn parse_args() -> ArgMatches<'static> {
     App::new("codegen")
@@ -33,8 +34,17 @@ fn handle_gpio(args: &ArgMatches) -> Result<()> {
     let db_path = args.value_of("db_path").unwrap();
     let db = cubemx::Db::new(db_path);
 
+    emit_autogen_comment(&db)?;
+
     let gpio_ips = cubemx::load_f3_gpio_ips(&db)?;
     codegen::gpio::gen_mappings(&gpio_ips)?;
 
     Ok(())
 }
+
+fn emit_autogen_comment(db: &Db) -> Result<()> {
+    let package = cubemx::package::load(&db)?;
+    codegen::gen_autogen_comment(&package);
+
+    Ok(())
+}

src/gpio.rs

@@ -668,9 +668,8 @@ macro_rules! gpio {
         }
     };
 }
-
-// The below mappings were auto-generated with the `codegen` crate.
-// Do not edit them manually!
+// auto-generated using codegen
+// STM32CubeMX DB release: DB.6.0.0
 
 #[cfg(feature = "gpio-f302")]
 gpio!([