oops v2

Author: bugadani

CHANGELOG.md

@@ -19,6 +19,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Non-linux-musl: Only list the available USB Ports by default (#590)
 - `FlashData::new` now returns `crate::Error` (#591)
 - Moved `reset_after_flash` method to `reset` module (#594)
+- Moved `parse_partition_table, DeviceInfo, FlashSettings, FlashData, FlashDataBuilder, FlashFrequency, FlashMode, FlashSize and SpiAttachParams` to `flash_data` (#599)
+- Moved `ProgressCallbacks` to `progress` (#599)
 
 ### Removed
 

espflash/Cargo.toml

@@ -55,7 +55,7 @@ strum = { version = "0.26.1", features = ["derive"] }
 thiserror = "1.0.56"
 toml = { version = "0.8.10", optional = true }
 update-informer = { version = "1.1.0", optional = true }
-xmas-elf        = { version = "0.9.1", optional = true }
+xmas-elf        = { version = "0.9.1" }
 
 [target.'cfg(unix)'.dependencies]
 libc = "0.2.153"
@@ -87,4 +87,4 @@ cli = [
 serialport = ["flashing", "dep:serialport", "dep:slip-codec", "dep:regex"]
 
 # enables flash stubs and stub commands
-flashing = ["xmas-elf", "dep:toml"]
+flashing = ["dep:toml"]

espflash/src/bin/espflash.rs

@@ -14,7 +14,7 @@ use espflash::{
         EspflashProgress, FlashConfigArgs, MonitorArgs, PartitionTableArgs, ReadFlashArgs,
     },
     error::Error,
-    flasher::{parse_partition_table, FlashData, FlashSettings},
+    flash_data::{parse_partition_table, FlashData, FlashSettings},
     logging::initialize_logger,
     targets::{Chip, XtalFrequency},
     update::check_for_update,

espflash/src/cli/mod.rs

@@ -30,10 +30,9 @@ use crate::{
     connection::reset::{ResetAfterOperation, ResetBeforeOperation},
     elf::ElfFirmwareImage,
     error::{Error, MissingPartition, MissingPartitionTable},
-    flasher::{
-        parse_partition_table, FlashData, FlashFrequency, FlashMode, FlashSize, Flasher,
-        ProgressCallbacks,
-    },
+    flash_data::{parse_partition_table, FlashData, FlashFrequency, FlashMode, FlashSize},
+    flasher::Flasher,
+    progress::ProgressCallbacks,
     targets::{Chip, XtalFrequency},
 };
 

espflash/src/command.rs

@@ -5,7 +5,8 @@ use std::{io::Write, mem::size_of, time::Duration};
 use bytemuck::{bytes_of, Pod, Zeroable};
 use strum::Display;
 
-use crate::flasher::{checksum, SpiAttachParams, SpiSetParams, CHECKSUM_INIT};
+use crate::flash_data::{SpiAttachParams, SpiSetParams, CHECKSUM_INIT};
+use crate::flasher::checksum;
 
 const DEFAULT_TIMEOUT: Duration = Duration::from_secs(3);
 const ERASE_REGION_TIMEOUT_PER_MB: Duration = Duration::from_secs(30);

espflash/src/connection/reset.rs

@@ -15,7 +15,7 @@ use crate::{
     command::{Command, CommandType},
     connection::{Connection, Port, USB_SERIAL_JTAG_PID},
     error::Error,
-    flasher,
+    flash_data::FLASH_WRITE_SIZE,
 };
 
 /// Default time to wait before releasing the boot pin after a reset
@@ -253,12 +253,11 @@ pub fn soft_reset(
             connection.with_timeout(CommandType::FlashBegin.timeout(), |connection| {
                 let size: u32 = 0;
                 let offset: u32 = 0;
-                let blocks: u32 = (size + flasher::FLASH_WRITE_SIZE as u32 - 1)
-                    / flasher::FLASH_WRITE_SIZE as u32;
+                let blocks: u32 = (size + FLASH_WRITE_SIZE as u32 - 1) / FLASH_WRITE_SIZE as u32;
                 connection.command(Command::FlashBegin {
                     size,
                     blocks,
-                    block_size: flasher::FLASH_WRITE_SIZE.try_into().unwrap(),
+                    block_size: FLASH_WRITE_SIZE.try_into().unwrap(),
                     offset,
                     supports_encryption: false,
                 })
@@ -272,12 +271,11 @@ pub fn soft_reset(
         connection.with_timeout(CommandType::FlashBegin.timeout(), |connection| {
             let size: u32 = 0;
             let offset: u32 = 0;
-            let blocks: u32 =
-                (size + flasher::FLASH_WRITE_SIZE as u32 - 1) / flasher::FLASH_WRITE_SIZE as u32;
+            let blocks: u32 = (size + FLASH_WRITE_SIZE as u32 - 1) / FLASH_WRITE_SIZE as u32;
             connection.command(Command::FlashBegin {
                 size,
                 blocks,
-                block_size: flasher::FLASH_WRITE_SIZE.try_into().unwrap(),
+                block_size: FLASH_WRITE_SIZE.try_into().unwrap(),
                 offset,
                 supports_encryption: false,
             })

espflash/src/error.rs

@@ -1,9 +1,6 @@
 //! Library and application errors
 
-use std::{
-    fmt::{Display, Formatter},
-    io,
-};
+use std::fmt::{Display, Formatter};
 
 use miette::Diagnostic;
 #[cfg(feature = "serialport")]
@@ -13,11 +10,10 @@ use thiserror::Error;
 
 #[cfg(feature = "cli")]
 use crate::cli::monitor::parser::esp_defmt::DefmtError;
-use crate::{
-    command::CommandType,
-    flasher::{FlashFrequency, FlashSize},
-    targets::Chip,
-};
+#[cfg(feature = "flashing")]
+use crate::command::CommandType;
+use crate::flash_data::{FlashFrequency, FlashSize};
+use crate::targets::Chip;
 
 /// All possible errors returned by espflash
 #[derive(Debug, Diagnostic, Error)]
@@ -188,7 +184,7 @@ pub enum Error {
     #[diagnostic(transparent)]
     RomError(#[from] RomError),
 
-    #[cfg(feature = "serialport")]
+    #[cfg(feature = "cli")]
     #[error(transparent)]
     #[diagnostic(transparent)]
     Defmt(#[from] DefmtError),
@@ -213,8 +209,8 @@ pub enum Error {
 }
 
 #[cfg(feature = "serialport")]
-impl From<io::Error> for Error {
-    fn from(err: io::Error) -> Self {
+impl From<std::io::Error> for Error {
+    fn from(err: std::io::Error) -> Self {
         Self::Connection(err.into())
     }
 }
@@ -282,6 +278,7 @@ pub enum ConnectionError {
 
     #[error("Timeout while running {0}command")]
     #[diagnostic(code(espflash::timeout))]
+    #[cfg(feature = "flashing")]
     Timeout(TimedOutCommand),
 
     #[cfg(feature = "serialport")]
@@ -295,8 +292,8 @@ pub enum ConnectionError {
 }
 
 #[cfg(feature = "serialport")]
-impl From<io::Error> for ConnectionError {
-    fn from(err: io::Error) -> Self {
+impl From<std::io::Error> for ConnectionError {
+    fn from(err: std::io::Error) -> Self {
         from_error_kind(err.kind(), err)
     }
 }
@@ -329,10 +326,12 @@ impl From<SlipError> for ConnectionError {
 
 /// An executed command which has timed out
 #[derive(Clone, Debug, Default)]
+#[cfg(feature = "flashing")]
 pub struct TimedOutCommand {
     command: Option<CommandType>,
 }
 
+#[cfg(feature = "flashing")]
 impl Display for TimedOutCommand {
     fn fmt(&self, f: &mut Formatter) -> std::fmt::Result {
         match &self.command {
@@ -342,6 +341,7 @@ impl Display for TimedOutCommand {
     }
 }
 
+#[cfg(feature = "flashing")]
 impl From<CommandType> for TimedOutCommand {
     fn from(ct: CommandType) -> Self {
         TimedOutCommand { command: Some(ct) }
@@ -488,13 +488,15 @@ impl From<&'static str> for ElfError {
     }
 }
 
+#[cfg(feature = "flashing")]
 pub(crate) trait ResultExt {
     /// Mark an error as having occurred during the flashing stage
     fn flashing(self) -> Self;
     /// Mark the command from which this error originates
     fn for_command(self, command: CommandType) -> Self;
 }
 
+#[cfg(feature = "flashing")]
 impl<T> ResultExt for Result<T, Error> {
     fn flashing(self) -> Self {
         match self {
@@ -518,7 +520,7 @@ impl<T> ResultExt for Result<T, Error> {
 
 #[cfg(feature = "serialport")]
 #[cfg_attr(docsrs, doc(cfg(feature = "serialport")))]
-fn from_error_kind<E>(kind: io::ErrorKind, err: E) -> ConnectionError
+fn from_error_kind<E>(kind: std::io::ErrorKind, err: E) -> ConnectionError
 where
     E: Into<serialport::Error>,
 {