Merge pull request #41 from jessebraham/bootloader

Add support for providing custom bootloaders

Author: icewind1991

cargo-espflash/README.md

@@ -21,9 +21,11 @@ FLAGS:
     -V, --version       Prints version information
 
 OPTIONS:
-        --example <EXAMPLE>      Example to build and flash
-        --features <FEATURES>    Comma delimited list of build features
-        --speed <SPEED>          Baud rate at which to flash target device
+        --bootloader <PATH>         Path to a binary (.bin) bootloader file
+        --example <EXAMPLE>         Example to build and flash
+        --features <FEATURES>       Comma delimited list of build features
+        --partition-table <PATH>    Path to a CSV file containing partition table
+        --speed <SPEED>             Baud rate at which to flash target device
 
 ARGS:
     <SERIAL>    Serial port connected to target device

cargo-espflash/src/main.rs

@@ -36,6 +36,13 @@ fn main() -> anyhow::Result<()> {
                         .long("release")
                         .help("Build the application using the release profile"),
                 )
+                .arg(
+                    Arg::with_name("bootloader")
+                        .long("bootloader")
+                        .takes_value(true)
+                        .value_name("PATH")
+                        .help("Path to a binary (.bin) bootloader file"),
+                )
                 .arg(
                     Arg::with_name("example")
                         .long("example")
@@ -135,6 +142,16 @@ fn main() -> anyhow::Result<()> {
         return Ok(());
     }
 
+    // If the '--bootloader' option is provided, load the binary file at the
+    // specified path.
+    let bootloader = if let Some(path) = matches.value_of("bootloader") {
+        let path = fs::canonicalize(path)?;
+        let data = fs::read(path)?;
+        Some(data)
+    } else {
+        None
+    };
+
     // If the '--partition-table' option is provided, load the partition table from
     // the CSV at the specified path.
     let partition_table = if let Some(path) = matches.value_of("partition_table") {
@@ -154,7 +171,7 @@ fn main() -> anyhow::Result<()> {
     if matches.is_present("ram") {
         flasher.load_elf_to_ram(&elf_data)?;
     } else {
-        flasher.load_elf_to_flash(&elf_data, partition_table)?;
+        flasher.load_elf_to_flash(&elf_data, bootloader, partition_table)?;
     }
 
     // We're all done!

espflash/src/chip/esp32.rs

@@ -51,9 +51,15 @@ impl ChipType for Esp32 {
 
     fn get_flash_segments<'a>(
         image: &'a FirmwareImage,
+        bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
     ) -> Box<dyn Iterator<Item = Result<RomSegment<'a>, Error>> + 'a> {
-        let bootloader = include_bytes!("../../bootloader/esp32-bootloader.bin");
+        let bootloader = if let Some(bytes) = bootloader {
+            bytes
+        } else {
+            let bytes = include_bytes!("../../bootloader/esp32-bootloader.bin");
+            bytes.to_vec()
+        };
 
         let partition_table = if let Some(table) = partition_table {
             table
@@ -161,7 +167,7 @@ impl ChipType for Esp32 {
         Box::new(
             once(Ok(RomSegment {
                 addr: BOOT_ADDR,
-                data: Cow::Borrowed(bootloader),
+                data: Cow::Owned(bootloader),
             }))
             .chain(once(Ok(RomSegment {
                 addr: PARTION_ADDR,
@@ -181,7 +187,7 @@ fn test_esp32_rom() {
 
     let image = FirmwareImage::from_data(&input_bytes).unwrap();
 
-    let segments = Esp32::get_flash_segments(&image, None)
+    let segments = Esp32::get_flash_segments(&image, None, None)
         .collect::<Result<Vec<_>, Error>>()
         .unwrap();
 

espflash/src/chip/esp32c3.rs

@@ -52,9 +52,15 @@ impl ChipType for Esp32c3 {
 
     fn get_flash_segments<'a>(
         image: &'a FirmwareImage,
+        bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
     ) -> Box<dyn Iterator<Item = Result<RomSegment<'a>, Error>> + 'a> {
-        let bootloader = include_bytes!("../../bootloader/esp32c3-bootloader.bin");
+        let bootloader = if let Some(bytes) = bootloader {
+            bytes
+        } else {
+            let bytes = include_bytes!("../../bootloader/esp32c3-bootloader.bin");
+            bytes.to_vec()
+        };
 
         let partition_table = if let Some(table) = partition_table {
             table
@@ -162,7 +168,7 @@ impl ChipType for Esp32c3 {
         Box::new(
             once(Ok(RomSegment {
                 addr: BOOT_ADDR,
-                data: Cow::Borrowed(bootloader),
+                data: Cow::Owned(bootloader),
             }))
             .chain(once(Ok(RomSegment {
                 addr: PARTITION_ADDR,

espflash/src/chip/esp8266.rs

@@ -34,6 +34,7 @@ impl ChipType for Esp8266 {
 
     fn get_flash_segments<'a>(
         image: &'a FirmwareImage,
+        _bootloader: Option<Vec<u8>>,
         _partition_table: Option<PartitionTable>,
     ) -> Box<dyn Iterator<Item = Result<RomSegment<'a>, Error>> + 'a> {
         // irom goes into a separate plain bin
@@ -144,7 +145,7 @@ fn test_esp8266_rom() {
 
     let image = FirmwareImage::from_data(&input_bytes).unwrap();
 
-    let segments = Esp8266::get_flash_segments(&image, None)
+    let segments = Esp8266::get_flash_segments(&image, None, None)
         .collect::<Result<Vec<_>, Error>>()
         .unwrap();
 

espflash/src/chip/mod.rs

@@ -29,6 +29,7 @@ pub trait ChipType {
     /// Get the firmware segments for writing an image to flash
     fn get_flash_segments<'a>(
         image: &'a FirmwareImage,
+        bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
     ) -> Box<dyn Iterator<Item = Result<RomSegment<'a>, Error>> + 'a>;
 
@@ -113,12 +114,13 @@ impl Chip {
     pub fn get_flash_segments<'a>(
         &self,
         image: &'a FirmwareImage,
+        bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
     ) -> Box<dyn Iterator<Item = Result<RomSegment<'a>, Error>> + 'a> {
         match self {
-            Chip::Esp32 => Esp32::get_flash_segments(image, partition_table),
-            Chip::Esp32c3 => Esp32c3::get_flash_segments(image, partition_table),
-            Chip::Esp8266 => Esp8266::get_flash_segments(image, None),
+            Chip::Esp32 => Esp32::get_flash_segments(image, bootloader, partition_table),
+            Chip::Esp32c3 => Esp32c3::get_flash_segments(image, bootloader, partition_table),
+            Chip::Esp8266 => Esp8266::get_flash_segments(image, None, None),
         }
     }
 

espflash/src/flasher.rs

@@ -554,13 +554,18 @@ impl Flasher {
     pub fn load_elf_to_flash(
         &mut self,
         elf_data: &[u8],
+        bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
     ) -> Result<(), Error> {
         self.enable_flash(self.spi_params)?;
+
         let mut image = FirmwareImage::from_data(elf_data).map_err(|_| Error::InvalidElf)?;
         image.flash_size = self.flash_size();
 
-        for segment in self.chip.get_flash_segments(&image, partition_table) {
+        for segment in self
+            .chip
+            .get_flash_segments(&image, bootloader, partition_table)
+        {
             let segment = segment?;
             let addr = segment.addr;
             let block_count = (segment.data.len() + FLASH_WRITE_SIZE - 1) / FLASH_WRITE_SIZE;

espflash/src/main.rs

@@ -62,7 +62,7 @@ fn main() -> Result<()> {
     if ram {
         flasher.load_elf_to_ram(&input_bytes)?;
     } else {
-        flasher.load_elf_to_flash(&input_bytes, None)?;
+        flasher.load_elf_to_flash(&input_bytes, None, None)?;
     }
 
     Ok(())