espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-02 10:00:57 +02:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update unify and update espefuse command outputs

Browse Source
This commit is contained in:
Peter Dragun
2025-09-12 08:51:00 +02:00
parent 1ce7513222
commit 9eb07f92ba
18 changed files with 95 additions and 66 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
docs/en/api-reference/peripherals/sd_pullup_requirements.rst
View File

@@ -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:

12
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C2_dump.rst
View File

@@ -3,10 +3,12 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32c2"...
espefuse.py v4.6-dev
Connecting....
Running espefuse in directory <project-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 ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C3_dump.rst
View File

@@ -3,10 +3,12 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32c3"...
espefuse.py v4.6-dev
Running espefuse in directory <project-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 ===

5
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5.rst
View File

@@ -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)

12
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C5_dump.rst
View File

@@ -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 <project-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 ===

4
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61.rst
View File

@@ -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)

5
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C61_dump.rst
View File

@@ -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 <project-directory>
Executing "espefuse dump --chip esp32c61"...
Connecting....
=== Run "dump" command ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6_dump.rst
View File

@@ -3,10 +3,12 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32c6"...
espefuse.py v4.6-dev
Running espefuse in directory <project-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 ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32-H2_dump.rst
View File

@@ -3,10 +3,12 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32h2"...
espefuse.py v4.6-dev
Running espefuse in directory <project-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 ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32-P4_dump.rst
View File

@@ -3,10 +3,12 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32p4"...
espefuse.py v4.7.dev1
Running espefuse in directory <project-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 ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32-S2_dump.rst
View File

@@ -3,10 +3,12 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32s2"...
espefuse.py v4.6-dev
Running espefuse in directory <project-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 ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32-S3_dump.rst
View File

@@ -3,9 +3,11 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32s3"...
espefuse.py v4.6-dev
Running espefuse in directory <project-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 ===

10
docs/en/api-reference/system/inc/espefuse_summary_ESP32_dump.rst
View File

@@ -3,15 +3,15 @@
idf.py efuse-dump
Executing action: efuse-dump
Running espefuse.py in directory <project-directory>
Executing "espefuse.py dump --chip esp32"...
espefuse.py v4.6-dev
Running espefuse in directory <project-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 ===

2
docs/zh_CN/api-guides/bootloader.rst
View File

@@ -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 升级流程的一部分进行写入。

1
docs/zh_CN/api-guides/build-system.rst
View File

@@ -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)

2
docs/zh_CN/api-guides/flash_psram_config.rst
View File

@@ -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 中读取并加载以下图像。

20
docs/zh_CN/api-reference/peripherals/sd_pullup_requirements.rst
View File

@@ -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 的状态，请运行：

8
tools/test_idf_py/test_idf_py.py
View File

@@ -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.
"""