Remove chip target files (#891)

* remove the efuse trait

* remove the target trait

* remove the target structs, use Chip for everything

* move some things around, make FlashTarget public

* rename idf image format, don't rexport things we don't need to

* fix compilation by removing erroneous feature gate

* Add `MissingPartition` and `MissingPartitionTable` to `Error`

* Address review comments

* CHANGELOG

* rename targets module to target

Author: MabezDev

.gitignore

@@ -14,3 +14,5 @@ target/
 .DS_Store
 *.swp
 .idea/
+
+!espflash/src/target

CHANGELOG.md

@@ -30,6 +30,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Add support for serial port configuration files. (#777, #883)
 - Add a `check-app-descriptor` bool option to `ImageArgs` and add the flag to `flash` commad(#872)
 - `Connection::into_serial` to get the underlying port from the connection (#882)
+- All methods on the now removed `Target` & `ReadEFuse`, `UsbOtg` and `RtcWdtReset` traits have been implemented directly on (#891)
 
 ### Changed
 
@@ -55,7 +56,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - `Flasher::into_serial` has been replaced by `Flasher::into_connection` (#882)
 - Automatically migrate `espflash@3` configuration files to the new format (#883)
 - Update dependencies to their latest versions (#893)
-
+- `ProgressCallbacks` has moved to `flasher` (#891)
+- `Chip::crystal_freq` has been renamed to `Chip::xtal_frequency` (#891)
+- `Chip::chip_revision` has been renamed to `Chip::revision` (also applies to `minor` and `major`) (#891)
+- Any reference to `esp_idf` or `EspIdf` has been cut to just `idf` (#891)
+- Renamed `targets` module to `target` (#891)
 
 ### Fixed
 
@@ -76,6 +81,8 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Removed the `flasher::parse_partition_table` function (#798)
 - The `FirmwareImage` trait has been removed (#802)
 - The `elf` module has been removed, and its contents moved to the `image_format` module (#802)
+- The `Target` trait, the `ReadEFuse` trait, and `Chip::into_target` (#891)
+- The `UsbOtg` and `RtcWdtReset` traits have been removed, along with `Chip::into_rtc_wdt_reset` & `Chip::into_usb_otg` (#891)
 
 ## [3.3.0] - 2025-01-13
 

cargo-espflash/src/error.rs

@@ -3,7 +3,7 @@ use std::{
     iter::once,
 };
 
-use espflash::targets::Chip;
+use espflash::target::Chip;
 use miette::{Diagnostic, LabeledSpan, SourceCode};
 use thiserror::Error;
 
@@ -112,7 +112,7 @@ impl UnsupportedTargetError {
     }
 
     fn supported_targets(&self) -> String {
-        self.chip.into_target().supported_build_targets().join(", ")
+        self.chip.supported_build_targets().join(", ")
     }
 }
 
@@ -139,7 +139,7 @@ impl Diagnostic for NoTargetError {
             Some(chip) => format!(
                 "Specify the target in `.cargo/config.toml`, the {} support the following targets: {}",
                 chip,
-                chip.into_target().supported_build_targets().join(", ")
+                chip.supported_build_targets().join(", ")
             ),
             None => "Specify the target in `.cargo/config.toml`".into(),
         }))

cargo-espflash/src/main.rs

@@ -18,11 +18,10 @@ use espflash::{
     image_format::{
         ImageFormat,
         ImageFormatKind,
-        check_idf_bootloader,
-        esp_idf::parse_partition_table,
+        idf::{check_idf_bootloader, parse_partition_table},
     },
     logging::initialize_logger,
-    targets::{Chip, XtalFrequency},
+    target::{Chip, XtalFrequency},
     update::check_for_update,
 };
 use log::{LevelFilter, debug, info};
@@ -208,7 +207,7 @@ struct FlashArgs {
     format: ImageFormatKind,
     /// ESP-IDF format arguments
     #[clap(flatten)]
-    esp_idf_format_args: cli::EspIdfFormatArgs,
+    idf_format_args: cli::IdfFormatArgs,
 }
 
 #[derive(Debug, Args)]
@@ -223,7 +222,7 @@ struct SaveImageArgs {
     format: ImageFormatKind,
     /// ESP-IDF format arguments
     #[clap(flatten)]
-    esp_idf_format_args: cli::EspIdfFormatArgs,
+    idf_format_args: cli::IdfFormatArgs,
 }
 
 fn main() -> Result<()> {
@@ -284,7 +283,7 @@ pub fn erase_parts(args: ErasePartsArgs, config: &Config) -> Result<()> {
 
     let partition_table = args.partition_table.as_deref().or(config
         .project_config
-        .esp_idf_format_args
+        .idf_format_args
         .partition_table
         .as_deref());
     let mut flasher = connect(&args.connect_args, config, false, false)?;
@@ -325,8 +324,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
     }
 
     let chip = flasher.chip();
-    let target = chip.into_target();
-    let target_xtal_freq = target.crystal_freq(flasher.connection())?;
+    let target_xtal_freq = chip.xtal_frequency(flasher.connection())?;
 
     flasher.disable_watchdog()?;
 
@@ -345,7 +343,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
     monitor_args.elf = Some(build_ctx.artifact_path.clone());
 
     check_monitor_args(&args.flash_args.monitor, &monitor_args)?;
-    check_esp_idf_args(
+    check_idf_args(
         args.format,
         &args.flash_args.erase_parts,
         &args.flash_args.erase_data_parts,
@@ -376,7 +374,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
             &flash_data,
             args.format,
             config,
-            Some(args.esp_idf_format_args),
+            Some(args.idf_format_args),
             build_ctx.bootloader_path,
             build_ctx.partition_table_path,
         )?;
@@ -441,7 +439,7 @@ fn build(
     }
     let metadata = metadata_cmd.exec().into_diagnostic()?;
 
-    if !chip.into_target().supports_build_target(target) {
+    if !chip.supports_build_target(target) {
         return Err(UnsupportedTargetError::new(target, chip).into());
     }
 
@@ -627,7 +625,7 @@ fn save_image(args: SaveImageArgs, config: &Config) -> Result<()> {
     let xtal_freq = args
         .save_image_args
         .xtal_freq
-        .unwrap_or(args.save_image_args.chip.default_crystal_frequency());
+        .unwrap_or(args.save_image_args.chip.default_xtal_frequency());
 
     let flash_data = make_flash_data(
         args.save_image_args.image,
@@ -641,7 +639,7 @@ fn save_image(args: SaveImageArgs, config: &Config) -> Result<()> {
         &flash_data,
         args.format,
         config,
-        Some(args.esp_idf_format_args),
+        Some(args.idf_format_args),
         build_ctx.bootloader_path,
         build_ctx.partition_table_path,
     )?;

espflash/src/bin/espflash.rs

@@ -13,11 +13,10 @@ use espflash::{
     image_format::{
         ImageFormat,
         ImageFormatKind,
-        check_idf_bootloader,
-        esp_idf::parse_partition_table,
+        idf::{check_idf_bootloader, parse_partition_table},
     },
     logging::initialize_logger,
-    targets::{Chip, XtalFrequency},
+    target::{Chip, XtalFrequency},
     update::check_for_update,
 };
 use log::{LevelFilter, debug, info};
@@ -138,7 +137,7 @@ struct FlashArgs {
     format: ImageFormatKind,
     /// ESP-IDF arguments
     #[clap(flatten)]
-    esp_idf_format_args: cli::EspIdfFormatArgs,
+    idf_format_args: cli::IdfFormatArgs,
 }
 
 #[derive(Debug, Args)]
@@ -157,7 +156,7 @@ struct SaveImageArgs {
     format: ImageFormatKind,
     // ESP-IDF arguments
     #[clap(flatten)]
-    esp_idf_format_args: cli::EspIdfFormatArgs,
+    idf_format_args: cli::IdfFormatArgs,
 }
 
 fn main() -> Result<()> {
@@ -229,7 +228,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
     let mut monitor_args = args.flash_args.monitor_args;
     monitor_args.elf = Some(args.image.clone());
     check_monitor_args(&args.flash_args.monitor, &monitor_args)?;
-    check_esp_idf_args(
+    check_idf_args(
         args.format,
         &args.flash_args.erase_parts,
         &args.flash_args.erase_data_parts,
@@ -252,8 +251,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
     }
 
     let chip = flasher.chip();
-    let target = chip.into_target();
-    let target_xtal_freq = target.crystal_freq(flasher.connection())?;
+    let target_xtal_freq = chip.xtal_frequency(flasher.connection())?;
 
     // Read the ELF data from the build path and load it to the target.
     let elf_data = fs::read(&args.image).into_diagnostic()?;
@@ -288,7 +286,7 @@ fn flash(args: FlashArgs, config: &Config) -> Result<()> {
             &flash_data,
             args.format,
             config,
-            Some(args.esp_idf_format_args),
+            Some(args.idf_format_args),
             None,
             None,
         )?;
@@ -353,7 +351,7 @@ fn save_image(args: SaveImageArgs, config: &Config) -> Result<()> {
     let xtal_freq = args
         .save_image_args
         .xtal_freq
-        .unwrap_or(args.save_image_args.chip.default_crystal_frequency());
+        .unwrap_or(args.save_image_args.chip.default_xtal_frequency());
 
     let flash_data = make_flash_data(
         args.save_image_args.image,
@@ -367,7 +365,7 @@ fn save_image(args: SaveImageArgs, config: &Config) -> Result<()> {
         &flash_data,
         args.format,
         config,
-        Some(args.esp_idf_format_args),
+        Some(args.idf_format_args),
         None,
         None,
     )?;

espflash/src/cli/config.rs

@@ -92,7 +92,7 @@ pub struct ProjectConfig {
     pub format: ImageFormatKind,
     /// ESP-IDF format arguments
     #[serde(default)]
-    pub esp_idf_format_args: cli::EspIdfFormatArgs,
+    pub idf_format_args: cli::IdfFormatArgs,
     /// Flash settings
     #[serde(default)]
     pub flash: FlashSettings,
@@ -124,14 +124,14 @@ impl Config {
             ProjectConfig::default()
         };
 
-        if let Some(table) = &project_config.esp_idf_format_args.partition_table {
+        if let Some(table) = &project_config.idf_format_args.partition_table {
             match table.extension() {
                 Some(ext) if ext == "bin" || ext == "csv" => {}
                 _ => return Err(Error::InvalidPartitionTablePath.into()),
             }
         }
 
-        if let Some(bootloader) = &project_config.esp_idf_format_args.bootloader {
+        if let Some(bootloader) = &project_config.idf_format_args.bootloader {
             if bootloader.extension() != Some(OsStr::new("bin")) {
                 return Err(Error::InvalidBootloaderPath.into());
             }

espflash/src/cli/mod.rs

@@ -53,9 +53,9 @@ use crate::{
         ImageFormat,
         ImageFormatKind,
         Metadata,
-        esp_idf::{IdfBootloaderFormat, parse_partition_table},
+        idf::{IdfBootloaderFormat, parse_partition_table},
     },
-    targets::{Chip, XtalFrequency},
+    target::{Chip, XtalFrequency},
 };
 
 pub mod config;
@@ -266,7 +266,7 @@ pub struct ImageArgs {
 #[derive(Debug, Args, Clone, Deserialize, Serialize, Default)]
 #[non_exhaustive]
 #[group(skip)]
-pub struct EspIdfFormatArgs {
+pub struct IdfFormatArgs {
     /// Path to a binary ESP-IDF bootloader file
     #[arg(long, value_name = "FILE")]
     pub bootloader: Option<PathBuf>,
@@ -642,13 +642,11 @@ pub fn serial_monitor(args: MonitorArgs, config: &Config) -> Result<()> {
 
     ensure_chip_compatibility(chip, elf.as_deref())?;
 
-    let target = chip.into_target();
-
     let mut monitor_args = args.monitor_args;
 
     // The 26MHz ESP32-C2's need to be treated as a special case.
     if chip == Chip::Esp32c2
-        && target.crystal_freq(flasher.connection())? == XtalFrequency::_26Mhz
+        && chip.xtal_frequency(flasher.connection())? == XtalFrequency::_26Mhz
         && monitor_args.monitor_baud == 115_200
     {
         // 115_200 * 26 MHz / 40 MHz = 74_880
@@ -1022,18 +1020,18 @@ pub fn make_image_format<'a>(
     flash_data: &FlashData,
     image_format_kind: ImageFormatKind,
     config: &Config,
-    esp_idf_format_args: Option<EspIdfFormatArgs>,
+    idf_format_args: Option<IdfFormatArgs>,
     build_ctx_bootloader: Option<PathBuf>,
     build_ctx_partition_table: Option<PathBuf>,
 ) -> Result<ImageFormat<'a>, Error> {
     let image_format = match image_format_kind {
         ImageFormatKind::EspIdf => {
-            let mut args = esp_idf_format_args.unwrap_or_default();
+            let mut args = idf_format_args.unwrap_or_default();
             // Set bootloader path with precedence
             if args.bootloader.is_none() {
                 args.bootloader = config
                     .project_config
-                    .esp_idf_format_args
+                    .idf_format_args
                     .bootloader
                     .clone()
                     .or(build_ctx_bootloader);
@@ -1043,7 +1041,7 @@ pub fn make_image_format<'a>(
             if args.partition_table.is_none() {
                 args.partition_table = config
                     .project_config
-                    .esp_idf_format_args
+                    .idf_format_args
                     .partition_table
                     .clone()
                     .or(build_ctx_partition_table);
@@ -1115,8 +1113,7 @@ pub fn write_bin(args: WriteBinArgs, config: &Config) -> Result<()> {
     print_board_info(&mut flasher)?;
 
     let chip = flasher.chip();
-    let target = chip.into_target();
-    let target_xtal_freq = target.crystal_freq(flasher.connection())?;
+    let target_xtal_freq = chip.xtal_frequency(flasher.connection())?;
 
     flasher.write_bin_to_flash(
         args.address,
@@ -1179,7 +1176,7 @@ pub fn ensure_chip_compatibility(chip: Chip, elf: Option<&[u8]>) -> Result<()> {
 }
 
 /// Check if the given arguments are valid for the ESP-IDF format
-pub fn check_esp_idf_args(
+pub fn check_idf_args(
     format: ImageFormatKind,
     erase_parts: &Option<Vec<String>>,
     erase_data_parts: &Option<Vec<DataType>>,
@@ -1201,7 +1198,7 @@ mod test {
     #[derive(Parser)]
     struct TestParser {
         #[clap(flatten)]
-        args: EspIdfFormatArgs,
+        args: IdfFormatArgs,
     }
 
     #[test]