Extract a module inside chip for code specific to the ESP32 and variants

Author: jessebraham

espflash/src/chip/esp32.rs renamed to espflash/src/chip/esp32/esp32.rs

@@ -1,14 +1,13 @@
-use crate::chip::Esp32Params;
+use std::ops::Range;
 
-use crate::image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId};
+use super::Esp32Params;
 use crate::{
     chip::{Chip, ChipType, SpiRegisters},
     elf::FirmwareImage,
+    image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId},
     Error, PartitionTable,
 };
 
-use std::ops::Range;
-
 pub struct Esp32;
 
 const IROM_MAP_START: u32 = 0x400d0000;
@@ -27,7 +26,7 @@ pub const PARAMS: Esp32Params = Esp32Params {
     app_addr: 0x10000,
     app_size: 0x3f0000,
     chip_id: 0,
-    default_bootloader: include_bytes!("../../bootloader/esp32-bootloader.bin"),
+    default_bootloader: include_bytes!("../../../bootloader/esp32-bootloader.bin"),
 };
 
 impl ChipType for Esp32 {

espflash/src/chip/esp32c3.rs renamed to espflash/src/chip/esp32/esp32c3.rs

@@ -1,13 +1,13 @@
-use crate::chip::Esp32Params;
-use crate::image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId};
+use std::ops::Range;
+
+use super::Esp32Params;
 use crate::{
     chip::{ChipType, SpiRegisters},
     elf::FirmwareImage,
+    image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
 
-use std::ops::Range;
-
 pub struct Esp32c3;
 
 const IROM_MAP_START: u32 = 0x42000000;
@@ -26,7 +26,7 @@ pub const PARAMS: Esp32Params = Esp32Params {
     app_addr: 0x10000,
     app_size: 0x3f0000,
     chip_id: 5,
-    default_bootloader: include_bytes!("../../bootloader/esp32c3-bootloader.bin"),
+    default_bootloader: include_bytes!("../../../bootloader/esp32c3-bootloader.bin"),
 };
 
 impl ChipType for Esp32c3 {

espflash/src/chip/esp32s2.rs renamed to espflash/src/chip/esp32/esp32s2.rs

@@ -1,13 +1,13 @@
-use crate::chip::Esp32Params;
-use crate::image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId};
+use std::ops::Range;
+
+use super::Esp32Params;
 use crate::{
     chip::{ChipType, SpiRegisters},
     elf::FirmwareImage,
+    image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
 
-use std::ops::Range;
-
 pub struct Esp32s2;
 
 const IROM_MAP_START: u32 = 0x40080000;
@@ -26,7 +26,7 @@ pub const PARAMS: Esp32Params = Esp32Params {
     app_addr: 0x10000,
     app_size: 0x100000,
     chip_id: 2,
-    default_bootloader: include_bytes!("../../bootloader/esp32s2-bootloader.bin"),
+    default_bootloader: include_bytes!("../../../bootloader/esp32s2-bootloader.bin"),
 };
 
 impl ChipType for Esp32s2 {

espflash/src/chip/esp32/mod.rs

@@ -0,0 +1,36 @@
+use crate::PartitionTable;
+
+mod esp32;
+mod esp32c3;
+mod esp32s2;
+
+pub use esp32::Esp32;
+pub use esp32c3::Esp32c3;
+pub use esp32s2::Esp32s2;
+
+#[derive(Clone, Copy, Debug)]
+pub struct Esp32Params {
+    pub boot_addr: u32,
+    pub partition_addr: u32,
+    pub nvs_addr: u32,
+    pub nvs_size: u32,
+    pub phy_init_data_addr: u32,
+    pub phy_init_data_size: u32,
+    pub app_addr: u32,
+    pub app_size: u32,
+    pub chip_id: u16,
+    pub default_bootloader: &'static [u8],
+}
+
+impl Esp32Params {
+    pub fn default_partition_table(&self) -> PartitionTable {
+        PartitionTable::basic(
+            self.nvs_addr,
+            self.nvs_size,
+            self.phy_init_data_addr,
+            self.phy_init_data_size,
+            self.app_addr,
+            self.app_size,
+        )
+    }
+}

espflash/src/chip/esp8266.rs

@@ -1,12 +1,15 @@
-use super::ChipType;
-use crate::{chip::SpiRegisters, elf::FirmwareImage, Chip, Error, PartitionTable};
-
-use crate::error::UnsupportedImageFormatError;
-use crate::image_format::{Esp8266Format, ImageFormat, ImageFormatId};
-
 use std::ops::Range;
 
-pub const IROM_MAP_START: u32 = 0x40200000;
+use super::ChipType;
+use crate::{
+    chip::SpiRegisters,
+    elf::FirmwareImage,
+    error::UnsupportedImageFormatError,
+    image_format::{Esp8266Format, ImageFormat, ImageFormatId},
+    Chip, Error, PartitionTable,
+};
+
+const IROM_MAP_START: u32 = 0x40200000;
 const IROM_MAP_END: u32 = 0x40300000;
 
 pub struct Esp8266;

espflash/src/chip/mod.rs

@@ -1,25 +1,22 @@
+use std::ops::Range;
+
 use strum_macros::Display;
 
 use crate::{
     elf::FirmwareImage,
     error::ChipDetectError,
     flash_target::{Esp32Target, Esp8266Target, FlashTarget, RamTarget},
     flasher::SpiAttachParams,
+    image_format::{ImageFormat, ImageFormatId},
     Error, PartitionTable,
 };
 
-use crate::image_format::{ImageFormat, ImageFormatId};
-pub use esp32::Esp32;
-pub use esp32c3::Esp32c3;
-pub use esp32s2::Esp32s2;
-pub use esp8266::Esp8266;
-use std::ops::Range;
-
 mod esp32;
-mod esp32c3;
-mod esp32s2;
 mod esp8266;
 
+pub use esp32::{Esp32, Esp32Params, Esp32c3, Esp32s2};
+pub use esp8266::Esp8266;
+
 pub trait ChipType {
     const CHIP_DETECT_MAGIC_VALUE: u32;
     const CHIP_DETECT_MAGIC_VALUE2: u32 = 0x0; // give default value, as most chips don't only have one
@@ -198,30 +195,3 @@ impl Chip {
         }
     }
 }
-
-#[derive(Clone, Copy, Debug)]
-pub struct Esp32Params {
-    pub boot_addr: u32,
-    pub partition_addr: u32,
-    pub nvs_addr: u32,
-    pub nvs_size: u32,
-    pub phy_init_data_addr: u32,
-    pub phy_init_data_size: u32,
-    pub app_addr: u32,
-    pub app_size: u32,
-    pub chip_id: u16,
-    pub default_bootloader: &'static [u8],
-}
-
-impl Esp32Params {
-    pub fn default_partition_table(&self) -> PartitionTable {
-        PartitionTable::basic(
-            self.nvs_addr,
-            self.nvs_size,
-            self.phy_init_data_addr,
-            self.phy_init_data_size,
-            self.app_addr,
-            self.app_size,
-        )
-    }
-}