Move FlashFrequency and FlashMode enums into the flasher module, where they belong

jessebraham · jessebraham · commit c128742b2b14 · 2022-09-20T07:27:24.000-07:00
diff --git a/espflash/src/chip/esp32/esp32.rs b/espflash/src/chip/esp32/esp32.rs
@@ -4,9 +4,9 @@ use super::Esp32Params;
 use crate::{
     chip::{bytes_to_mac_addr, Chip, ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
+    elf::FirmwareImage,
     error::UnsupportedImageFormatError,
-    flasher::FlashSize,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId},
     Error, PartitionTable,
 };
diff --git a/espflash/src/chip/esp32/esp32c2.rs b/espflash/src/chip/esp32/esp32c2.rs
@@ -6,8 +6,8 @@ use super::Esp32Params;
 use crate::{
     chip::{ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
-    flasher::FlashSize,
+    elf::FirmwareImage,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::{Esp32BootloaderFormat, Esp32DirectBootFormat, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
diff --git a/espflash/src/chip/esp32/esp32c3.rs b/espflash/src/chip/esp32/esp32c3.rs
@@ -4,9 +4,9 @@ use super::Esp32Params;
 use crate::{
     chip::{ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
+    elf::FirmwareImage,
     error::UnsupportedImageFormatError,
-    flasher::FlashSize,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::{Esp32BootloaderFormat, Esp32DirectBootFormat, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
diff --git a/espflash/src/chip/esp32/esp32s2.rs b/espflash/src/chip/esp32/esp32s2.rs
@@ -4,10 +4,10 @@ use super::Esp32Params;
 use crate::{
     chip::{ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
+    elf::FirmwareImage,
     error::UnsupportedImageFormatError,
     flash_target::MAX_RAM_BLOCK_SIZE,
-    flasher::{FlashSize, FLASH_WRITE_SIZE},
+    flasher::{FlashFrequency, FlashMode, FlashSize, FLASH_WRITE_SIZE},
     image_format::{Esp32BootloaderFormat, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
diff --git a/espflash/src/chip/esp32/esp32s3.rs b/espflash/src/chip/esp32/esp32s3.rs
@@ -4,8 +4,8 @@ use super::Esp32Params;
 use crate::{
     chip::{ChipType, ReadEFuse, SpiRegisters},
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
-    flasher::FlashSize,
+    elf::FirmwareImage,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::{Esp32BootloaderFormat, Esp32DirectBootFormat, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
diff --git a/espflash/src/chip/esp8266.rs b/espflash/src/chip/esp8266.rs
@@ -4,9 +4,9 @@ use super::{bytes_to_mac_addr, ChipType};
 use crate::{
     chip::{ReadEFuse, SpiRegisters},
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
+    elf::FirmwareImage,
     error::UnsupportedImageFormatError,
-    flasher::FlashSize,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::{Esp8266Format, ImageFormat, ImageFormatId},
     Chip, Error, PartitionTable,
 };
diff --git a/espflash/src/chip/mod.rs b/espflash/src/chip/mod.rs
@@ -9,10 +9,10 @@ pub use self::{
 };
 use crate::{
     connection::Connection,
-    elf::{FirmwareImage, FlashFrequency, FlashMode},
+    elf::FirmwareImage,
     error::ChipDetectError,
     flash_target::{Esp32Target, Esp8266Target, FlashTarget, RamTarget, MAX_RAM_BLOCK_SIZE},
-    flasher::{FlashSize, SpiAttachParams, FLASH_WRITE_SIZE},
+    flasher::{FlashFrequency, FlashMode, FlashSize, SpiAttachParams, FLASH_WRITE_SIZE},
     image_format::{ImageFormat, ImageFormatId},
     Error, PartitionTable,
 };
diff --git a/espflash/src/cli/mod.rs b/espflash/src/cli/mod.rs
@@ -16,9 +16,9 @@ use strum::VariantNames;
 
 use crate::{
     cli::{monitor::monitor, serial::get_serial_port_info},
-    elf::{ElfFirmwareImage, FlashFrequency, FlashMode},
+    elf::ElfFirmwareImage,
     error::{Error, NoOtadataError},
-    flasher::FlashSize,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::ImageFormatType,
     partition_table, Chip, Flasher, ImageFormatId, InvalidPartitionTable, MissingPartitionTable,
     PartitionTable,
diff --git a/espflash/src/elf.rs b/espflash/src/elf.rs
@@ -4,10 +4,8 @@ use std::{
     fmt::{Debug, Formatter},
     mem::take,
     ops::AddAssign,
-    str::FromStr,
 };
 
-use strum_macros::{Display, EnumVariantNames};
 use xmas_elf::{
     program::Type,
     sections::{SectionData, ShType},
@@ -21,81 +19,6 @@ use crate::{
 
 pub const ESP_CHECKSUM_MAGIC: u8 = 0xef;
 
-#[derive(Copy, Clone, Debug, EnumVariantNames)]
-#[strum(serialize_all = "UPPERCASE")]
-pub enum FlashMode {
-    Qio,
-    Qout,
-    Dio,
-    Dout,
-}
-
-impl FromStr for FlashMode {
-    type Err = Error;
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        let mode = match s.to_uppercase().as_str() {
-            "QIO" => FlashMode::Qio,
-            "QOUT" => FlashMode::Qout,
-            "DIO" => FlashMode::Dio,
-            "DOUT" => FlashMode::Dout,
-            _ => return Err(Error::InvalidFlashMode(s.to_string())),
-        };
-
-        Ok(mode)
-    }
-}
-
-#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, Display, EnumVariantNames)]
-#[repr(u8)]
-pub enum FlashFrequency {
-    #[strum(serialize = "12M")]
-    Flash12M,
-    #[strum(serialize = "15M")]
-    Flash15M,
-    #[strum(serialize = "16M")]
-    Flash16M,
-    #[strum(serialize = "20M")]
-    Flash20M,
-    #[strum(serialize = "24M")]
-    Flash24M,
-    #[strum(serialize = "26M")]
-    Flash26M,
-    #[strum(serialize = "30M")]
-    Flash30M,
-    #[strum(serialize = "40M")]
-    Flash40M,
-    #[strum(serialize = "48M")]
-    Flash48M,
-    #[strum(serialize = "60M")]
-    Flash60M,
-    #[strum(serialize = "80M")]
-    Flash80M,
-}
-
-impl FromStr for FlashFrequency {
-    type Err = Error;
-
-    fn from_str(s: &str) -> Result<Self, Self::Err> {
-        use FlashFrequency::*;
-
-        match s.to_uppercase().as_str() {
-            "12M" => Ok(Flash12M),
-            "15M" => Ok(Flash15M),
-            "16M" => Ok(Flash16M),
-            "20M" => Ok(Flash20M),
-            "24M" => Ok(Flash24M),
-            "26M" => Ok(Flash26M),
-            "30M" => Ok(Flash30M),
-            "40M" => Ok(Flash40M),
-            "48M" => Ok(Flash48M),
-            "60M" => Ok(Flash60M),
-            "80M" => Ok(Flash80M),
-            _ => Err(Error::InvalidFlashFrequency(s.to_string())),
-        }
-    }
-}
-
 pub trait FirmwareImage<'a> {
     fn entry(&self) -> u32;
     fn segments(&'a self) -> Box<dyn Iterator<Item = CodeSegment<'a>> + 'a>;
diff --git a/espflash/src/error.rs b/espflash/src/error.rs
@@ -10,8 +10,7 @@ use thiserror::Error;
 
 use crate::{
     command::CommandType,
-    elf::{FlashFrequency, FlashMode},
-    flasher::FlashSize,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::ImageFormatId,
     partition_table::{CoreType, SubType, Type},
     Chip,
diff --git a/espflash/src/flasher.rs b/espflash/src/flasher.rs
@@ -9,7 +9,7 @@ use crate::{
     chip::Chip,
     command::{Command, CommandType},
     connection::Connection,
-    elf::{ElfFirmwareImage, FirmwareImage, FlashFrequency, FlashMode, RomSegment},
+    elf::{ElfFirmwareImage, FirmwareImage, RomSegment},
     error::{ConnectionError, FlashDetectError, ResultExt},
     image_format::ImageFormatId,
     stubs::FlashStub,
@@ -28,6 +28,81 @@ const CHIP_DETECT_MAGIC_REG_ADDR: u32 = 0x40001000;
 
 const EXPECTED_STUB_HANDSHAKE: &str = "OHAI";
 
+#[derive(Debug, Clone, Copy, Hash, PartialEq, Eq, Display, EnumVariantNames)]
+#[repr(u8)]
+pub enum FlashFrequency {
+    #[strum(serialize = "12M")]
+    Flash12M,
+    #[strum(serialize = "15M")]
+    Flash15M,
+    #[strum(serialize = "16M")]
+    Flash16M,
+    #[strum(serialize = "20M")]
+    Flash20M,
+    #[strum(serialize = "24M")]
+    Flash24M,
+    #[strum(serialize = "26M")]
+    Flash26M,
+    #[strum(serialize = "30M")]
+    Flash30M,
+    #[strum(serialize = "40M")]
+    Flash40M,
+    #[strum(serialize = "48M")]
+    Flash48M,
+    #[strum(serialize = "60M")]
+    Flash60M,
+    #[strum(serialize = "80M")]
+    Flash80M,
+}
+
+impl FromStr for FlashFrequency {
+    type Err = Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        use FlashFrequency::*;
+
+        match s.to_uppercase().as_str() {
+            "12M" => Ok(Flash12M),
+            "15M" => Ok(Flash15M),
+            "16M" => Ok(Flash16M),
+            "20M" => Ok(Flash20M),
+            "24M" => Ok(Flash24M),
+            "26M" => Ok(Flash26M),
+            "30M" => Ok(Flash30M),
+            "40M" => Ok(Flash40M),
+            "48M" => Ok(Flash48M),
+            "60M" => Ok(Flash60M),
+            "80M" => Ok(Flash80M),
+            _ => Err(Error::InvalidFlashFrequency(s.to_string())),
+        }
+    }
+}
+
+#[derive(Copy, Clone, Debug, EnumVariantNames)]
+#[strum(serialize_all = "UPPERCASE")]
+pub enum FlashMode {
+    Qio,
+    Qout,
+    Dio,
+    Dout,
+}
+
+impl FromStr for FlashMode {
+    type Err = Error;
+
+    fn from_str(s: &str) -> Result<Self, Self::Err> {
+        let mode = match s.to_uppercase().as_str() {
+            "QIO" => FlashMode::Qio,
+            "QOUT" => FlashMode::Qout,
+            "DIO" => FlashMode::Dio,
+            "DOUT" => FlashMode::Dout,
+            _ => return Err(Error::InvalidFlashMode(s.to_string())),
+        };
+
+        Ok(mode)
+    }
+}
+
 #[derive(Clone, Copy, Debug, Eq, PartialEq, Display, EnumVariantNames)]
 #[repr(u8)]
 pub enum FlashSize {
diff --git a/espflash/src/image_format/esp32bootloader.rs b/espflash/src/image_format/esp32bootloader.rs
@@ -7,11 +7,11 @@ use super::encode_flash_frequency;
 use crate::{
     chip::Esp32Params,
     elf::{
-        merge_adjacent_segments, update_checksum, CodeSegment, FirmwareImage, FlashFrequency,
-        FlashMode, RomSegment, ESP_CHECKSUM_MAGIC,
+        merge_adjacent_segments, update_checksum, CodeSegment, FirmwareImage, RomSegment,
+        ESP_CHECKSUM_MAGIC,
     },
     error::{Error, FlashDetectError},
-    flasher::FlashSize,
+    flasher::{FlashFrequency, FlashMode, FlashSize},
     image_format::{EspCommonHeader, ImageFormat, SegmentHeader, ESP_MAGIC, WP_PIN_DISABLED},
     partition_table::{CoreType, Partition, Type},
     Chip, PartitionTable,
diff --git a/espflash/src/image_format/mod.rs b/espflash/src/image_format/mod.rs
@@ -5,11 +5,7 @@ use serde::Deserialize;
 use strum_macros::{Display, EnumVariantNames, IntoStaticStr};
 
 pub use self::{esp32bootloader::*, esp32directboot::*, esp8266::*};
-use crate::{
-    chip::Chip,
-    elf::{FlashFrequency, RomSegment},
-    error::Error,
-};
+use crate::{chip::Chip, elf::RomSegment, error::Error, flasher::FlashFrequency};
 
 mod esp32bootloader;
 mod esp32directboot;
diff --git a/espflash/src/lib.rs b/espflash/src/lib.rs
@@ -1,8 +1,8 @@
 pub use self::{
     chip::Chip,
     cli::config::Config,
-    elf::{FlashFrequency, FlashMode},
     error::{Error, InvalidPartitionTable, MissingPartitionTable},
+    flasher::{FlashFrequency, FlashMode},
     flasher::{FlashSize, Flasher},
     image_format::ImageFormatId,
     partition_table::PartitionTable,
