validate that the image is setup for direct boot

Author: icewind1991

espflash/src/chip/esp32/esp32.rs

@@ -1,6 +1,7 @@
 use std::ops::Range;
 
 use super::Esp32Params;
+use crate::error::UnsupportedImageFormatError;
 use crate::{
     chip::{bytes_to_mac_addr, Chip, ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
@@ -126,9 +127,7 @@ impl ChipType for Esp32 {
                 partition_table,
                 bootloader,
             )?)),
-            ImageFormatId::DirectBoot => {
-                todo!()
-            }
+            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266).into()),
         }
     }
 

espflash/src/chip/esp32/esp32s2.rs

@@ -1,6 +1,7 @@
 use std::ops::Range;
 
 use super::Esp32Params;
+use crate::error::UnsupportedImageFormatError;
 use crate::{
     chip::{bytes_to_mac_addr, ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
@@ -103,9 +104,7 @@ impl ChipType for Esp32s2 {
                 partition_table,
                 bootloader,
             )?)),
-            ImageFormatId::DirectBoot => {
-                todo!()
-            }
+            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266).into()),
         }
     }
 

espflash/src/error.rs

@@ -57,6 +57,15 @@ pub enum Error {
         help("The following image formats are {}", ImageFormatId::VARIANTS.join(", "))
     )]
     UnknownImageFormat(String),
+    #[error("binary is not setup correct to support direct boot")]
+    #[diagnostic(
+        code(espflash::invalid_direct_boot),
+        help(
+            "See the following page for documentation on how to setup your binary for direct boot:
+https://github.com/espressif/esp32c3-direct-boot-example"
+        )
+    )]
+    InvalidDirectBootBinary,
 }
 
 #[derive(Error, Debug, Diagnostic)]

espflash/src/image_format/esp32directboot.rs

@@ -26,6 +26,12 @@ impl<'a> Esp32DirectBootFormat<'a> {
             });
         segment.pad_align(4);
 
+        if segment.addr != 0
+            || segment.data()[0..8] != [0x1d, 0x04, 0xdb, 0xae, 0x1d, 0x04, 0xdb, 0xae]
+        {
+            return Err(Error::InvalidDirectBootBinary);
+        }
+
         Ok(Self {
             segment: segment.into(),
         })