add proper error when trying to use direct-boot with c3 rev2 or lower

icewind1991 · icewind1991 · commit 417e4362bdd8 · 2021-10-15T17:46:37.000+02:00
diff --git a/cargo-espflash/src/main.rs b/cargo-espflash/src/main.rs
@@ -388,7 +388,7 @@ fn save_image(
         .transpose()?
         .or(metadata.format);
 
-    let flash_image = chip.get_flash_image(&image, None, None, image_format)?;
+    let flash_image = chip.get_flash_image(&image, None, None, image_format, None)?;
     let parts: Vec<_> = flash_image.ota_segments().collect();
 
     let out_path = matches.value_of("file").unwrap();
diff --git a/espflash/src/chip/esp32/esp32.rs b/espflash/src/chip/esp32/esp32.rs
@@ -118,6 +118,7 @@ impl ChipType for Esp32 {
         bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
         image_format: ImageFormatId,
+        _chip_revision: Option<u32>,
     ) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error> {
         match image_format {
             ImageFormatId::Bootloader => Ok(Box::new(Esp32BootloaderFormat::new(
@@ -127,7 +128,7 @@ impl ChipType for Esp32 {
                 partition_table,
                 bootloader,
             )?)),
-            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266).into()),
+            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp32, None).into()),
         }
     }
 
diff --git a/espflash/src/chip/esp32/esp32c3.rs b/espflash/src/chip/esp32/esp32c3.rs
@@ -1,6 +1,7 @@
 use std::ops::Range;
 
 use super::Esp32Params;
+use crate::error::UnsupportedImageFormatError;
 use crate::image_format::Esp32DirectBootFormat;
 use crate::{
     chip::{bytes_to_mac_addr, ChipType, ReadEFuse, SpiRegisters},
@@ -71,16 +72,22 @@ impl ChipType for Esp32c3 {
         bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
         image_format: ImageFormatId,
+        chip_revision: Option<u32>,
     ) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error> {
-        match image_format {
-            ImageFormatId::Bootloader => Ok(Box::new(Esp32BootloaderFormat::new(
+        match (image_format, chip_revision) {
+            (ImageFormatId::Bootloader, _) => Ok(Box::new(Esp32BootloaderFormat::new(
                 image,
                 Chip::Esp32c3,
                 PARAMS,
                 partition_table,
                 bootloader,
             )?)),
-            ImageFormatId::DirectBoot => Ok(Box::new(Esp32DirectBootFormat::new(image)?)),
+            (ImageFormatId::DirectBoot, None | Some(3..)) => {
+                Ok(Box::new(Esp32DirectBootFormat::new(image)?))
+            }
+            _ => Err(
+                UnsupportedImageFormatError::new(image_format, Chip::Esp32c3, chip_revision).into(),
+            ),
         }
     }
 
diff --git a/espflash/src/chip/esp32/esp32s2.rs b/espflash/src/chip/esp32/esp32s2.rs
@@ -95,6 +95,7 @@ impl ChipType for Esp32s2 {
         bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
         image_format: ImageFormatId,
+        _chip_revision: Option<u32>,
     ) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error> {
         match image_format {
             ImageFormatId::Bootloader => Ok(Box::new(Esp32BootloaderFormat::new(
@@ -104,7 +105,7 @@ impl ChipType for Esp32s2 {
                 partition_table,
                 bootloader,
             )?)),
-            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266).into()),
+            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp32s2, None).into()),
         }
     }
 
diff --git a/espflash/src/chip/esp8266.rs b/espflash/src/chip/esp8266.rs
@@ -47,10 +47,11 @@ impl ChipType for Esp8266 {
         _bootloader: Option<Vec<u8>>,
         _partition_table: Option<PartitionTable>,
         image_format: ImageFormatId,
+        _chip_revision: Option<u32>,
     ) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error> {
         match image_format {
             ImageFormatId::Bootloader => Ok(Box::new(Esp8266Format::new(image)?)),
-            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266).into()),
+            _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266, None).into()),
         }
     }
 
diff --git a/espflash/src/chip/mod.rs b/espflash/src/chip/mod.rs
@@ -53,6 +53,7 @@ pub trait ChipType {
         bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
         image_format: ImageFormatId,
+        chip_revision: Option<u32>,
     ) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error>;
 
     /// Read the MAC address of the connected chip.
@@ -158,20 +159,35 @@ impl Chip {
         bootloader: Option<Vec<u8>>,
         partition_table: Option<PartitionTable>,
         image_format: Option<ImageFormatId>,
+        chip_revision: Option<u32>,
     ) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error> {
         let image_format = image_format.unwrap_or_else(|| self.default_image_format());
 
         match self {
-            Chip::Esp32 => {
-                Esp32::get_flash_segments(image, bootloader, partition_table, image_format)
+            Chip::Esp32 => Esp32::get_flash_segments(
+                image,
+                bootloader,
+                partition_table,
+                image_format,
+                chip_revision,
+            ),
+            Chip::Esp32c3 => Esp32c3::get_flash_segments(
+                image,
+                bootloader,
+                partition_table,
+                image_format,
+                chip_revision,
+            ),
+            Chip::Esp32s2 => Esp32s2::get_flash_segments(
+                image,
+                bootloader,
+                partition_table,
+                image_format,
+                chip_revision,
+            ),
+            Chip::Esp8266 => {
+                Esp8266::get_flash_segments(image, None, None, image_format, chip_revision)
             }
-            Chip::Esp32c3 => {
-                Esp32c3::get_flash_segments(image, bootloader, partition_table, image_format)
-            }
-            Chip::Esp32s2 => {
-                Esp32s2::get_flash_segments(image, bootloader, partition_table, image_format)
-            }
-            Chip::Esp8266 => Esp8266::get_flash_segments(image, None, None, image_format),
         }
     }
 
diff --git a/espflash/src/error.rs b/espflash/src/error.rs
@@ -497,20 +497,58 @@ impl From<u8> for FlashDetectError {
     }
 }
 
-#[derive(Debug, Error, Diagnostic)]
-#[error("Image format {format} is not supported by the {chip}")]
-#[diagnostic(
-    code(espflash::unsupported_image_format),
-    help("The following image formats are supported by the {}: {}", self.chip, self.supported_formats())
-)]
+#[derive(Debug)]
 pub struct UnsupportedImageFormatError {
     format: ImageFormatId,
     chip: Chip,
+    revision: Option<u32>,
+}
+
+impl Display for UnsupportedImageFormatError {
+    fn fmt(&self, f: &mut Formatter<'_>) -> std::fmt::Result {
+        write!(
+            f,
+            "Image format {} is not supported by the {}",
+            self.format, self.chip
+        )?;
+        if let Some(revision) = self.revision {
+            write!(f, " revision {}", revision)?;
+        }
+        Ok(())
+    }
+}
+
+impl std::error::Error for UnsupportedImageFormatError {}
+
+impl Diagnostic for UnsupportedImageFormatError {
+    fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
+        Some(Box::new("espflash::unsupported_image_format"))
+    }
+
+    fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>> {
+        let str = if self.chip == Chip::Esp32c3 && self.format == ImageFormatId::DirectBoot {
+            format!(
+                "The {}: only supports direct-boot starting with revision 3",
+                self.chip,
+            )
+        } else {
+            format!(
+                "The following image formats are supported by the {}: {}",
+                self.chip,
+                self.supported_formats()
+            )
+        };
+        Some(Box::new(str))
+    }
 }
 
 impl UnsupportedImageFormatError {
-    pub fn new(format: ImageFormatId, chip: Chip) -> Self {
-        UnsupportedImageFormatError { format, chip }
+    pub fn new(format: ImageFormatId, chip: Chip, revision: Option<u32>) -> Self {
+        UnsupportedImageFormatError {
+            format,
+            chip,
+            revision,
+        }
     }
 
     fn supported_formats(&self) -> String {
diff --git a/espflash/src/flasher.rs b/espflash/src/flasher.rs
@@ -542,9 +542,13 @@ impl Flasher {
         let mut target = self.chip.flash_target(self.spi_params);
         target.begin(&mut self.connection, &image).flashing()?;
 
-        let flash_image =
-            self.chip
-                .get_flash_image(&image, bootloader, partition_table, image_format)?;
+        let flash_image = self.chip.get_flash_image(
+            &image,
+            bootloader,
+            partition_table,
+            image_format,
+            self.chip.chip_revision(&mut self.connection)?,
+        )?;
 
         for segment in flash_image.flash_segments() {
             target

Original file line number	Diff line number	Diff line change
`@@ -47,10 +47,11 @@ impl ChipType for Esp8266 {`
`47`	`47`	`_bootloader: Option<Vec<u8>>,`
`48`	`48`	`_partition_table: Option<PartitionTable>,`
`49`	`49`	`image_format: ImageFormatId,`
	`50`	`+ _chip_revision: Option<u32>,`
`50`	`51`	`) -> Result<Box<dyn ImageFormat<'a> + 'a>, Error> {`
`51`	`52`	`match image_format {`
`52`	`53`	`ImageFormatId::Bootloader => Ok(Box::new(Esp8266Format::new(image)?)),`
`53`		`- _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266).into()),`
	`54`	`+ _ => Err(UnsupportedImageFormatError::new(image_format, Chip::Esp8266, None).into()),`
`54`	`55`	`}`
`55`	`56`	`}`
`56`	`57`