Feature: add subcommand for merging binaries (#152)

* Feature: add option for mergin bootloader, partition-table and application binary into single one binary

* Add padding bytes to whole remaining flash

Author: JurajSadel

cargo-espflash/src/main.rs

@@ -91,6 +91,15 @@ pub struct SaveImageOpts {
     pub build_opts: BuildOpts,
     /// File name to save the generated image to
     pub file: PathBuf,
+    /// Boolean flag to merge binaries into single binary
+    #[clap(long, short = 'M')]
+    pub merge: bool,
+    /// Custom bootloader for merging
+    #[clap(long, short = 'B')]
+    pub bootloader: Option<PathBuf>,
+    /// Custom partition table for merging
+    #[clap(long, short = 'T')]
+    pub partition_table: Option<PathBuf>,
 }
 
 fn main() -> Result<()> {
@@ -326,6 +335,9 @@ fn save_image(
         opts.build_opts.flash_config_opts.flash_mode,
         opts.build_opts.flash_config_opts.flash_size,
         opts.build_opts.flash_config_opts.flash_freq,
+        opts.merge,
+        opts.bootloader,
+        opts.partition_table,
     )?;
 
     Ok(())

espflash/src/cli/mod.rs

@@ -4,6 +4,7 @@
 
 use std::{
     fs,
+    io::Write,
     path::{Path, PathBuf},
 };
 
@@ -101,6 +102,9 @@ pub fn save_elf_as_image(
     flash_mode: Option<FlashMode>,
     flash_size: Option<FlashSize>,
     flash_freq: Option<FlashFrequency>,
+    merge: bool,
+    bootloader_path: Option<PathBuf>,
+    partition_table_path: Option<PathBuf>,
 ) -> Result<()> {
     let image = FirmwareImageBuilder::new(elf_data)
         .flash_mode(flash_mode)
@@ -112,7 +116,7 @@ pub fn save_elf_as_image(
     let parts: Vec<_> = flash_image.ota_segments().collect();
 
     match parts.as_slice() {
-        [single] => fs::write(path, &single.data).into_diagnostic()?,
+        [single] => fs::write(&path, &single.data).into_diagnostic()?,
         parts => {
             for part in parts {
                 let part_path = format!("{:#x}_{}", part.addr, path.display());
@@ -121,6 +125,77 @@ pub fn save_elf_as_image(
         }
     }
 
+    // merge_bin is TRUE
+    // merge bootloader, partition table and app binaries
+    // basic functionality, only merge 3 binaries
+    if merge {
+        // If the '-B' option is provided, load the bootloader binary file at the
+        // specified path.
+        let bootloader = if let Some(bootloader_path) = bootloader_path {
+            let path = fs::canonicalize(bootloader_path).into_diagnostic()?;
+            let data = fs::read(path).into_diagnostic()?;
+
+            Some(data)
+        } else {
+            None
+        };
+
+        // If the '-T' option is provided, load the partition table from
+        // the CSV at the specified path.
+        let partition_table = if let Some(partition_table_path) = partition_table_path {
+            let path = fs::canonicalize(partition_table_path).into_diagnostic()?;
+            let data = fs::read_to_string(path)
+                .into_diagnostic()
+                .wrap_err("Failed to open partition table")?;
+
+            let table =
+                PartitionTable::try_from_str(data).wrap_err("Failed to parse partition table")?;
+
+            Some(table)
+        } else {
+            None
+        };
+
+        // To get a chip revision, the connection is needed
+        // For simplicity, the revision None is used
+        let image =
+            chip.get_flash_image(&image, bootloader, partition_table, image_format, None)?;
+
+        let merged_bin = format!(
+            "merged_{path}",
+            path = &path.to_str().unwrap_or("merged_bins.bin")
+        );
+
+        if Path::new(&merged_bin).exists() {
+            fs::remove_file(&merged_bin).into_diagnostic()?;
+        }
+
+        let mut file = fs::OpenOptions::new()
+            .write(true)
+            .create_new(true)
+            .open(merged_bin)
+            .into_diagnostic()?;
+
+        for segment in image.flash_segments() {
+            let padding_bytes = vec![
+                0xffu8;
+                segment.addr as usize
+                    - file.metadata().into_diagnostic()?.len() as usize
+            ];
+            file.write_all(&padding_bytes).into_diagnostic()?;
+            file.write_all(&segment.data).into_diagnostic()?;
+        }
+
+        // Take flash_size as input parameter, if None, use default value of 4Mb
+        let padding_bytes = vec![
+            0xffu8;
+            flash_size.unwrap_or(FlashSize::Flash4Mb).size() as usize
+                - file.metadata().into_diagnostic()?.len() as usize
+        ];
+        file.write_all(&padding_bytes).into_diagnostic()?;
+    }
+
+    println!("The final merge binary was created successfully.");
     Ok(())
 }
 

espflash/src/main.rs

@@ -49,6 +49,15 @@ pub struct SaveImageOpts {
     image: PathBuf,
     /// File name to save the generated image to
     file: PathBuf,
+    /// Boolean flag, if set, bootloader, partition table and application binaries will be merged into single binary
+    #[clap(long, short = 'M')]
+    pub merge: bool,
+    /// Custom bootloader for merging
+    #[clap(long, short = 'B')]
+    pub bootloader: Option<PathBuf>,
+    /// Custom partition table for merging
+    #[clap(long, short = 'T')]
+    pub partition_table: Option<PathBuf>,
 }
 
 fn main() -> Result<()> {
@@ -150,6 +159,9 @@ fn save_image(opts: SaveImageOpts) -> Result<()> {
         opts.flash_config_opts.flash_mode,
         opts.flash_config_opts.flash_size,
         opts.flash_config_opts.flash_freq,
+        opts.merge,
+        opts.bootloader,
+        opts.partition_table,
     )?;
 
     Ok(())