Merge pull request #332 from bobmcwhirter/memory_x_gen

Emit a default memory.x alongside device.x from metapac.

13 files changed, 55 insertions, 68 deletions

diff --git a/embassy-stm32/Cargo.toml b/embassy-stm32/Cargo.toml
index d94c9d523..6f8691c3e 100644
--- a/embassy-stm32/Cargo.toml
+++ b/embassy-stm32/Cargo.toml
@@ -42,6 +42,7 @@ defmt-warn = [ ]
 defmt-error = [ ]
 sdmmc-rs = ["embedded-sdmmc"]
 net = ["embassy-net", "vcell"]
+memory-x = ["stm32-metapac/memory-x"]
 
 # Reexport stm32-metapac at `embassy_stm32::pac`.
 # This is unstable because semver-minor (non-breaking) releases of embassy-stm32 may major-bump (breaking) the stm32-metapac version.
diff --git a/embassy-stm32/src/lib.rs b/embassy-stm32/src/lib.rs
index 89fd86448..0567aa72a 100644
--- a/embassy-stm32/src/lib.rs
+++ b/embassy-stm32/src/lib.rs
@@ -39,6 +39,7 @@ pub mod eth;
 pub mod exti;
 #[cfg(i2c)]
 pub mod i2c;
+
 #[cfg(pwr)]
 pub mod pwr;
 #[cfg(rng)]
diff --git a/examples/stm32f4/Cargo.toml b/examples/stm32f4/Cargo.toml
index 693dac545..84b1e30ee 100644
--- a/examples/stm32f4/Cargo.toml
+++ b/examples/stm32f4/Cargo.toml
@@ -19,7 +19,7 @@ defmt-error = []
 [dependencies]
 embassy = { version = "0.1.0", path = "../../embassy", features = ["defmt", "defmt-trace"] }
 embassy-traits = { version = "0.1.0", path = "../../embassy-traits", features = ["defmt"] }
-embassy-stm32 = { version = "0.1.0", path = "../../embassy-stm32", features = ["defmt", "defmt-trace", "stm32f429zi", "unstable-pac"]  }
+embassy-stm32 = { version = "0.1.0", path = "../../embassy-stm32", features = ["defmt", "defmt-trace", "stm32f429zi", "unstable-pac", "memory-x"]  }
 embassy-hal-common = {version = "0.1.0", path = "../../embassy-hal-common" }
 
 defmt = "0.2.0"
diff --git a/examples/stm32f4/build.rs b/examples/stm32f4/build.rs
deleted file mode 100644
index d534cc3df..000000000
--- a/examples/stm32f4/build.rs
+++ /dev/null
@@ -1,31 +0,0 @@
-//! This build script copies the `memory.x` file from the crate root into
-//! a directory where the linker can always find it at build time.
-//! For many projects this is optional, as the linker always searches the
-//! project root directory -- wherever `Cargo.toml` is. However, if you
-//! are using a workspace or have a more complicated build setup, this
-//! build script becomes required. Additionally, by requesting that
-//! Cargo re-run the build script whenever `memory.x` is changed,
-//! updating `memory.x` ensures a rebuild of the application with the
-//! new memory settings.
-
-use std::env;
-use std::fs::File;
-use std::io::Write;
-use std::path::PathBuf;
-
-fn main() {
-    // Put `memory.x` in our output directory and ensure it's
-    // on the linker search path.
-    let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
-    File::create(out.join("memory.x"))
-        .unwrap()
-        .write_all(include_bytes!("memory.x"))
-        .unwrap();
-    println!("cargo:rustc-link-search={}", out.display());
-
-    // By default, Cargo will re-run a build script whenever
-    // any file in the project changes. By specifying `memory.x`
-    // here, we ensure the build script is only re-run when
-    // `memory.x` is changed.
-    println!("cargo:rerun-if-changed=memory.x");
-}
diff --git a/examples/stm32f4/memory.x b/examples/stm32f4/memory.x
deleted file mode 100644
index f21e32572..000000000
--- a/examples/stm32f4/memory.x
+++ /dev/null
@@ -1,7 +0,0 @@
-MEMORY
-{
-  /* NOTE 1 K = 1 KiBi = 1024 bytes */
-  /* These values correspond to the STM32F429ZI */
-  FLASH : ORIGIN = 0x08000000, LENGTH = 2048K
-  RAM : ORIGIN = 0x20000000, LENGTH = 192K
-}
diff --git a/examples/stm32h7/Cargo.toml b/examples/stm32h7/Cargo.toml
index 278ab6f6b..8bc6781e0 100644
--- a/examples/stm32h7/Cargo.toml
+++ b/examples/stm32h7/Cargo.toml
@@ -19,7 +19,7 @@ defmt-error = []
 [dependencies]
 embassy = { version = "0.1.0", path = "../../embassy", features = ["defmt", "defmt-trace"] }
 embassy-traits = { version = "0.1.0", path = "../../embassy-traits", features = ["defmt"] }
-embassy-stm32 = { version = "0.1.0", path = "../../embassy-stm32", features = ["defmt", "defmt-trace", "stm32h743zi", "net"] }
+embassy-stm32 = { version = "0.1.0", path = "../../embassy-stm32", features = ["defmt", "defmt-trace", "stm32h743zi", "net", "memory-x"] }
 embassy-hal-common = {version = "0.1.0", path = "../../embassy-hal-common" }
 embassy-net = { path = "../../embassy-net", default-features = false, features = ["defmt-debug", "defmt", "tcp", "medium-ethernet", "pool-16"] }
 stm32-metapac = { path = "../../stm32-metapac", features = ["stm32h743zi"] }
diff --git a/examples/stm32h7/build.rs b/examples/stm32h7/build.rs
deleted file mode 100644
index 555cdf687..000000000
--- a/examples/stm32h7/build.rs
+++ /dev/null
@@ -1,21 +0,0 @@
-use std::env;
-use std::fs::File;
-use std::io::Write;
-use std::path::PathBuf;
-
-fn main() {
-    // Put `memory.x` in our output directory and ensure it's
-    // on the linker search path.
-    let out = &PathBuf::from(env::var_os("OUT_DIR").unwrap());
-    File::create(out.join("memory.x"))
-        .unwrap()
-        .write_all(include_bytes!("memory.x"))
-        .unwrap();
-    println!("cargo:rustc-link-search={}", out.display());
-
-    // By default, Cargo will re-run a build script whenever
-    // any file in the project changes. By specifying `memory.x`
-    // here, we ensure the build script is only re-run when
-    // `memory.x` is changed.
-    println!("cargo:rerun-if-changed=memory.x");
-}
diff --git a/examples/stm32h7/memory.x b/examples/stm32h7/memory.x
deleted file mode 100644
index ef9485d12..000000000
--- a/examples/stm32h7/memory.x
+++ /dev/null
@@ -1,5 +0,0 @@
-MEMORY
-{
-  FLASH : ORIGIN = 0x08000000, LENGTH = 2048K
-  RAM : ORIGIN = 0x24000000, LENGTH = 384K
-}
diff --git a/stm32-data b/stm32-data
-Subproject 0ad27b2fd1126c6c9d9f4602d1331f5d82f4aa2
+Subproject af0611ff9b29f2c0ab675a4f0e51d8241a4097f
diff --git a/stm32-metapac-gen/src/assets/build.rs b/stm32-metapac-gen/src/assets/build.rs
index c16bd6407..4110fe485 100644
--- a/stm32-metapac-gen/src/assets/build.rs
+++ b/stm32-metapac-gen/src/assets/build.rs
@@ -9,6 +9,9 @@ fn main() {
         .unwrap()
         .to_ascii_lowercase();
 
+    #[cfg(feature = "memory-x")]
+    println!("cargo:rustc-link-search=src/chips/{}/memory_x/", _chip_name);
+
     #[cfg(feature = "rt")]
     println!("cargo:rustc-link-search=src/chips/{}", _chip_name);
 
diff --git a/stm32-metapac-gen/src/lib.rs b/stm32-metapac-gen/src/lib.rs
index f508b3658..5e0cc58d4 100644
--- a/stm32-metapac-gen/src/lib.rs
+++ b/stm32-metapac-gen/src/lib.rs
@@ -19,12 +19,24 @@ pub struct Chip {
     pub family: String,
     pub line: String,
     pub cores: Vec<Core>,
-    pub flash: u32,
-    pub ram: u32,
+    pub flash: Memory,
+    pub ram: Memory,
     pub packages: Vec<Package>,
 }
 
 #[derive(Debug, Eq, PartialEq, Clone, Deserialize)]
+pub struct Memory {
+    pub bytes: u32,
+    pub regions: HashMap<String, MemoryRegion>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize)]
+pub struct MemoryRegion {
+    pub base: u32,
+    pub bytes: Option<u32>,
+}
+
+#[derive(Debug, Eq, PartialEq, Clone, Deserialize)]
 pub struct Core {
     pub name: String,
     pub peripherals: HashMap<String, Peripheral>,
@@ -636,6 +648,9 @@ pub fn gen(options: Options) {
             .unwrap()
             .write_all(device_x.as_bytes())
             .unwrap();
+
+        // generate default memory.x
+        gen_memory_x(&chip_dir, &chip);
     }
 
     for (module, version) in all_peripheral_versions {
@@ -674,6 +689,7 @@ pub fn gen(options: Options) {
         let re = Regex::new("# *! *\\[.*\\]").unwrap();
         let data = re.replace_all(&data, "");
         file.write_all(data.as_bytes()).unwrap();
+
     }
 
     // Generate src/lib_inner.rs
@@ -734,6 +750,7 @@ pub fn gen(options: Options) {
 
     // Generate build.rs
     fs::write(out_dir.join("build.rs"), include_bytes!("assets/build.rs")).unwrap();
+
 }
 
 fn bytes_find(haystack: &[u8], needle: &[u8]) -> Option<usize> {
@@ -741,3 +758,23 @@ fn bytes_find(haystack: &[u8], needle: &[u8]) -> Option<usize> {
         .windows(needle.len())
         .position(|window| window == needle)
 }
+
+fn gen_memory_x(out_dir: &PathBuf, chip: &Chip) {
+    let mut memory_x = String::new();
+
+    let flash_bytes = chip.flash.regions.get("BANK_1").unwrap().bytes.unwrap_or(chip.flash.bytes);
+    let flash_origin = chip.flash.regions.get("BANK_1").unwrap().base;
+
+    let ram_bytes = chip.ram.regions.get("SRAM").unwrap().bytes.unwrap_or(chip.ram.bytes);
+    let ram_origin = chip.ram.regions.get("SRAM").unwrap().base;
+
+    write!(memory_x, "MEMORY\n{{\n").unwrap();
+    write!(memory_x, "    FLASH : ORIGIN = 0x{:x}, LENGTH = {}\n", flash_origin, flash_bytes).unwrap();
+    write!(memory_x, "    RAM : ORIGIN = 0x{:x}, LENGTH = {}\n", ram_origin, ram_bytes).unwrap();
+    write!(memory_x, "}}").unwrap();
+
+    fs::create_dir_all(out_dir.join("memory_x")).unwrap();
+    let mut file = File::create(out_dir.join("memory_x").join("memory.x")).unwrap();
+    file.write_all( memory_x.as_bytes() ).unwrap();
+
+}
diff --git a/stm32-metapac/Cargo.toml b/stm32-metapac/Cargo.toml
index 2e01d5183..fabd95664 100644
--- a/stm32-metapac/Cargo.toml
+++ b/stm32-metapac/Cargo.toml
@@ -17,6 +17,7 @@ regex = "1.5.4"
 
 [features]
 rt = ["cortex-m-rt/device"]
+memory-x = []
 
 # BEGIN GENERATED FEATURES
 # Generated by gen_features.py. DO NOT EDIT.
diff --git a/stm32-metapac/build.rs b/stm32-metapac/build.rs
index b44d98f3a..ca964c9ec 100644
--- a/stm32-metapac/build.rs
+++ b/stm32-metapac/build.rs
@@ -27,5 +27,13 @@ fn main() {
         out_dir.display(),
         chip_name.to_ascii_lowercase()
     );
+
+    #[cfg(feature = "memory-x")]
+    println!(
+        "cargo:rustc-link-search={}/src/chips/{}/memory_x/",
+        out_dir.display(),
+        chip_name.to_ascii_lowercase()
+    );
+
     println!("cargo:rerun-if-changed=build.rs");
 }