From 9eb07f92ba935183dfcac8feeb0c559b670525ff Mon Sep 17 00:00:00 2001 From: Peter Dragun Date: Fri, 12 Sep 2025 08:51:00 +0200 Subject: [PATCH] docs: Update unify and update espefuse command outputs --- .../peripherals/sd_pullup_requirements.rst | 20 +++++++++++++++---- .../inc/espefuse_summary_ESP32-C2_dump.rst | 12 +++++------ .../inc/espefuse_summary_ESP32-C3_dump.rst | 10 +++++----- .../system/inc/espefuse_summary_ESP32-C5.rst | 5 +++-- .../inc/espefuse_summary_ESP32-C5_dump.rst | 12 ++++++----- .../system/inc/espefuse_summary_ESP32-C61.rst | 4 ++-- .../inc/espefuse_summary_ESP32-C61_dump.rst | 5 ++++- .../inc/espefuse_summary_ESP32-C6_dump.rst | 10 +++++----- .../inc/espefuse_summary_ESP32-H2_dump.rst | 10 +++++----- .../inc/espefuse_summary_ESP32-P4_dump.rst | 10 +++++----- .../inc/espefuse_summary_ESP32-S2_dump.rst | 10 +++++----- .../inc/espefuse_summary_ESP32-S3_dump.rst | 10 +++++----- .../inc/espefuse_summary_ESP32_dump.rst | 10 +++++----- docs/zh_CN/api-guides/bootloader.rst | 2 +- docs/zh_CN/api-guides/build-system.rst | 1 - docs/zh_CN/api-guides/flash_psram_config.rst | 2 +- .../peripherals/sd_pullup_requirements.rst | 20 +++++++++++++++---- tools/test_idf_py/test_idf_py.py | 8 ++++---- 18 files changed, 95 insertions(+), 66 deletions(-) diff --git a/docs/en/api-reference/peripherals/sd_pullup_requirements.rst b/docs/en/api-reference/peripherals/sd_pullup_requirements.rst index 1c1ff7c0b7..ee71488b85 100644 --- a/docs/en/api-reference/peripherals/sd_pullup_requirements.rst +++ b/docs/en/api-reference/peripherals/sd_pullup_requirements.rst @@ -228,15 +228,27 @@ No Pull-ups .. code-block:: bash - espefuse.py v2.6 + espefuse v5.0.2 Connecting.... - Enable internal flash voltage regulator (VDD_SDIO) to 3.3 V. + === Run "set-flash-voltage" command === + Enable internal flash voltage regulator (VDD_SDIO) to 3.3V. The following eFuses are burned: XPD_SDIO_FORCE, XPD_SDIO_REG, XPD_SDIO_TIEH. - This is an irreversible operation. + VDD_SDIO setting complete. + + Check all blocks for burn... + idx, BLOCK_NAME, Conclusion + [00] BLOCK0 is not empty + (written ): 0x0000000400182226000004320000a8b0002bc8f09e47e69800000000 + (to write): 0x00000000000000000001c00000000000000000000000000000000000 + (coding scheme = NONE) + . + This is an irreversible operation! Type 'BURN' (all capitals) to continue. BURN - VDD_SDIO setting complete. + BURN BLOCK0 - OK (write block == read block) + Reading updated eFuses... + Successful. To check the status of the eFuses, run: diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C2_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C2_dump.rst index d0178a7be9..23db498b6b 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C2_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C2_dump.rst @@ -3,10 +3,12 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32c2"... - espefuse.py v4.6-dev - Connecting.... + Running espefuse in directory + Executing "espefuse dump --chip esp32c2"... + espefuse v5.0.2 + Connecting... + + === Run "dump" command === BLOCK0 (BLOCK0 ) [0 ] read_regs: 00000000 00000000 BLOCK1 (BLOCK1 ) [1 ] read_regs: 00000000 00000000 00000000 BLOCK2 (BLOCK2 ) [2 ] read_regs: 8d5c4b94 8252083a 5c01e953 80d0a824 c0860b18 00006890 00000000 4b000000 @@ -14,5 +16,3 @@ BLOCK0 (BLOCK0 ) [0 ] err__regs: 00000000 00000000 EFUSE_RD_RS_ERR_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C3_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C3_dump.rst index eac0fe28da..710d100ccf 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C3_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C3_dump.rst @@ -3,10 +3,12 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32c3"... - espefuse.py v4.6-dev + Running espefuse in directory + Executing "espefuse dump --chip esp32c3"... + espefuse v5.0.2 Connecting.... + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 80000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: 790f968c 000058cf 00000000 020c0000 715424e0 0047d2f2 BLOCK_SYS_DATA (BLOCK2 ) [2 ] read_regs: 96046025 6f41fdc3 512cedbe 217ee31d d864ea41 5aba3a86 1e260363 00000009 @@ -22,5 +24,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5.rst index c1acf3cf6b..f59087a18f 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5.rst @@ -1,8 +1,9 @@ .. code-block:: none - espefuse.py -p PORT summary + idf.py -p PORT efuse-summary - espefuse.py v4.8.dev4 + Executing action: efuse-summary + (...) === Run "summary" command === EFUSE_NAME (Block) Description = [Meaningful Value] [Readable/Writeable] (Hex Value) diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5_dump.rst index a38afb695b..8e96f47a74 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5_dump.rst @@ -1,10 +1,14 @@ .. code-block:: none - espefuse.py dump + idf.py efuse-dump - espefuse.py v4.8.dev4 + Executing action: efuse-dump + Running espefuse in directory + Executing "espefuse dump --chip esp32c5"... + espefuse v5.0.2 Connecting.... - Detecting chip type... ESP32-C5 + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: f9f95440 fffe6055 00000000 00000000 00000000 00000000 BLOCK_SYS_DATA (BLOCK2 ) [2 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 @@ -20,5 +24,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61.rst index 7838b515cf..0326cfbdd1 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61.rst @@ -2,8 +2,8 @@ idf.py -p /dev/ttyUSB0 efuse-summary - espefuse.py v4.10.dev2 - Connecting.... + Executing action: efuse-summary + (...) === Run "summary" command === EFUSE_NAME (Block) Description = [Meaningful Value] [Readable/Writeable] (Hex Value) diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61_dump.rst index 797bd7e973..9b7638b241 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61_dump.rst @@ -2,7 +2,10 @@ idf.py -p /dev/ttyUSB0 efuse-dump - espefuse.py v4.10.dev2 + espefuse v5.0.2 + Executing action: efuse-dump + Running espefuse in directory + Executing "espefuse dump --chip esp32c61"... Connecting.... === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6_dump.rst index 8d52e713fb..c52442c4e6 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6_dump.rst @@ -3,10 +3,12 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32c6"... - espefuse.py v4.6-dev + Running espefuse in directory + Executing "espefuse dump --chip esp32c6"... + espefuse v5.0.2 Connecting.... + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: f9f7529c 00006055 00000000 01040000 00000000 00000000 BLOCK_SYS_DATA (BLOCK2 ) [2 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 @@ -22,5 +24,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-H2_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-H2_dump.rst index 6818c475e7..b22319eed4 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-H2_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-H2_dump.rst @@ -3,10 +3,12 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32h2"... - espefuse.py v4.6-dev + Running espefuse in directory + Executing "espefuse dump --chip esp32h2"... + espefuse v5.0.2 Connecting.... + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: f9f72ca2 fffe6055 00000000 00000000 00000000 00000000 BLOCK_SYS_DATA (BLOCK2 ) [2 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 @@ -22,5 +24,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-P4_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-P4_dump.rst index b05d66bb06..121db9d3cc 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-P4_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-P4_dump.rst @@ -3,10 +3,12 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32p4"... - espefuse.py v4.7.dev1 + Running espefuse in directory + Executing "espefuse dump --chip esp32p4"... + espefuse v5.0.2 Connecting.... + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 BLOCK_SYS_DATA (BLOCK2 ) [2 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 @@ -21,5 +23,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S2_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S2_dump.rst index 882467597f..326804869e 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S2_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S2_dump.rst @@ -3,10 +3,12 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32s2"... - espefuse.py v4.6-dev + Running espefuse in directory + Executing "espefuse dump --chip esp32s2"... + espefuse v5.0.2 Connecting.... + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: 79b3b954 000058cf 00000000 10440000 00000000 00000000 BLOCK_SYS_DATA (BLOCK2 ) [2 ] read_regs: f1c60eea 8238f201 595b98e9 0200fe81 1c549f24 88491102 06461421 070c2083 @@ -22,5 +24,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S3_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S3_dump.rst index 1b21b5359a..e2e9d37893 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S3_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-S3_dump.rst @@ -3,9 +3,11 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32s3"... - espefuse.py v4.6-dev + Running espefuse in directory + Executing "espefuse dump --chip esp32s3"... + espefuse v5.0.2 + + === Run "dump" command === Connecting.... BLOCK0 ( ) [0 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 MAC_SPI_8M_0 (BLOCK1 ) [1 ] read_regs: 3b41f270 0000ecda 00000000 030c0000 2c707800 9800cc58 @@ -22,5 +24,3 @@ BLOCK0 ( ) [0 ] err__regs: 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_RD_RS_ERR0_REG 0x00000000 EFUSE_RD_RS_ERR1_REG 0x00000000 - - === Run "dump" command === diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32_dump.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32_dump.rst index e946529de6..6235abd311 100644 --- a/docs/en/api-reference/system/inc/espefuse_summary_ESP32_dump.rst +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32_dump.rst @@ -3,15 +3,15 @@ idf.py efuse-dump Executing action: efuse-dump - Running espefuse.py in directory - Executing "espefuse.py dump --chip esp32"... - espefuse.py v4.6-dev + Running espefuse in directory + Executing "espefuse dump --chip esp32"... + espefuse v5.0.2 Connecting.... + + === Run "dump" command === BLOCK0 ( ) [0 ] read_regs: 00000000 7e5a6e58 00e294b9 0000a200 00000333 00100000 00000004 BLOCK1 (flash_encryption) [1 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 BLOCK2 (secure_boot_v1 s) [2 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 BLOCK3 ( ) [3 ] read_regs: 00000000 00000000 00000000 00000000 00000000 00000000 00000000 00000000 EFUSE_REG_DEC_STATUS 0x00000000 - - === Run "dump" command === diff --git a/docs/zh_CN/api-guides/bootloader.rst b/docs/zh_CN/api-guides/bootloader.rst index 4c217de8b5..83396708e6 100644 --- a/docs/zh_CN/api-guides/bootloader.rst +++ b/docs/zh_CN/api-guides/bootloader.rst @@ -202,7 +202,7 @@ ESP-IDF 二级引导加载程序位于 flash 的 {IDF_TARGET_CONFIG_BOOTLOADER_O 恢复引导加载程序功能可在 OTA 升级失败时为引导加载程序提供安全回退机制。eFuse 字段 ``ESP_EFUSE_RECOVERY_BOOTLOADER_FLASH_SECTOR`` 将指定恢复引导加载程序的 flash（以扇区为单位）地址。如果位于 {IDF_TARGET_CONFIG_BOOTLOADER_OFFSET_IN_FLASH} 的主引导加载程序加载失败，ROM 引导加载程序会尝试从指定地址加载恢复引导加载程序。 - - 可以使用 ``espefuse.py`` 或在用户应用程序中调用 :cpp:func:`esp_efuse_set_recovery_bootloader_offset()` 来设置 eFuse。 + - 可以使用 ``espefuse`` 或在用户应用程序中调用 :cpp:func:`esp_efuse_set_recovery_bootloader_offset()` 来设置 eFuse。 - 该地址可通过 ``CONFIG_BOOTLOADER_RECOVERY_OFFSET`` 进行设置，且必须为 flash 扇区大小（0x1000 字节）的整数倍。此 Kconfig 选项有助于确保恢复引导加载程序不会与现有分区重叠。 - 注意，eFuse 字段存储的是以扇区为单位的偏移量。将其设置为最大值 ``0xFFF`` 可禁用恢复引导加载程序功能。 - 默认情况下，``CONFIG_BOOTLOADER_RECOVERY_OFFSET`` 处的恢复引导加载程序镜像不会被烧录，但可以作为 OTA 升级流程的一部分进行写入。 diff --git a/docs/zh_CN/api-guides/build-system.rst b/docs/zh_CN/api-guides/build-system.rst index 89bf49c94b..718d35e29b 100644 --- a/docs/zh_CN/api-guides/build-system.rst +++ b/docs/zh_CN/api-guides/build-system.rst @@ -1380,7 +1380,6 @@ ESP-IDF 构建命令 # 注册该依赖，使其在 ELF 链接完成后、BIN 生成之前运行 idf_build_add_post_elf_dependency("${CMAKE_PROJECT_NAME}.elf" strip_elf) - .. code-block:: none idf_build_get_post_elf_dependencies(elf_filename out_var) diff --git a/docs/zh_CN/api-guides/flash_psram_config.rst b/docs/zh_CN/api-guides/flash_psram_config.rst index fe475962eb..b439c20d2f 100644 --- a/docs/zh_CN/api-guides/flash_psram_config.rst +++ b/docs/zh_CN/api-guides/flash_psram_config.rst @@ -241,7 +241,7 @@ F4R4 硬件 load:0x3fcd0108,len:0x171c ets_loader.c 78 - 这可能意味着必要的 efuse 未得到正确烧录。请使用命令 ``espefuse summary``，检查芯片的 eFuse 位。 + 这可能意味着必要的 efuse 未得到正确烧录。请使用命令 ``idf.py efuse-summary``，检查芯片的 eFuse 位。 一级 (ROM) 引导加载程序可通过 eFuse 位 ``FLASH_TYPE`` 将 flash 复位为默认模式（SPI 模式）。如果未烧录此位，且 flash 处于 OPI 模式，则一级 (ROM) 引导加载程序可能无法从 flash 中读取并加载以下图像。 diff --git a/docs/zh_CN/api-reference/peripherals/sd_pullup_requirements.rst b/docs/zh_CN/api-reference/peripherals/sd_pullup_requirements.rst index 51a0d48655..bc2ac35e9c 100644 --- a/docs/zh_CN/api-reference/peripherals/sd_pullup_requirements.rst +++ b/docs/zh_CN/api-reference/peripherals/sd_pullup_requirements.rst @@ -228,15 +228,27 @@ SD 上拉需求 .. code-block:: bash - espefuse.py v2.6 + espefuse v5.0.2 Connecting.... - Enable internal flash voltage regulator (VDD_SDIO) to 3.3 V. + === Run "set-flash-voltage" command === + Enable internal flash voltage regulator (VDD_SDIO) to 3.3V. The following eFuses are burned: XPD_SDIO_FORCE, XPD_SDIO_REG, XPD_SDIO_TIEH. - This is an irreversible operation. + VDD_SDIO setting complete. + + Check all blocks for burn... + idx, BLOCK_NAME, Conclusion + [00] BLOCK0 is not empty + (written ): 0x0000000400182226000004320000a8b0002bc8f09e47e69800000000 + (to write): 0x00000000000000000001c00000000000000000000000000000000000 + (coding scheme = NONE) + . + This is an irreversible operation! Type 'BURN' (all capitals) to continue. BURN - VDD_SDIO setting complete. + BURN BLOCK0 - OK (write block == read block) + Reading updated eFuses... + Successful. 要检查 eFuse 的状态，请运行： diff --git a/tools/test_idf_py/test_idf_py.py b/tools/test_idf_py/test_idf_py.py index 893544668c..18b1dfa16b 100755 --- a/tools/test_idf_py/test_idf_py.py +++ b/tools/test_idf_py/test_idf_py.py @@ -374,8 +374,8 @@ class TestWrapperCommands(TestCase): class TestEFuseCommands(TestWrapperCommands): """ - Test if wrapper commands for espefuse.py are working as expected. - The goal is NOT to test the functionality of espefuse.py + Test if wrapper commands for espefuse are working as expected. + The goal is NOT to test the functionality of espefuse but to test if the wrapper commands are working as expected. """ @@ -438,8 +438,8 @@ class TestEFuseCommands(TestWrapperCommands): class TestSecureCommands(TestWrapperCommands): """ - Test if wrapper commands for espsecure.py are working as expected. - The goal is NOT to test the functionality of espsecure.py + Test if wrapper commands for espsecure are working as expected. + The goal is NOT to test the functionality of espsecure but to test if the wrapper commands are working as expected. """