Skip to content

Commit a8fc7e9

Browse files
Daiziyan0225Daiziyan0225
committed
Merge branch 'docs/update_out-of-sync_documents' into 'master'
Docs/update out of sync documents See merge request espressif/esp-idf!22600
2 parents 54b0779 + 9ba9dc0 commit a8fc7e9

File tree

8 files changed

+175
-52
lines changed

8 files changed

+175
-52
lines changed

‎docs/en/api-reference/system/console.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Linenoise library does not need explicit initialization. However, some configura
4444

4545
:cpp:func:`linenoiseSetMaxLineLen`
4646

47-
Set maximum length of the line for linenoise library. Default length is 4096. The default value can be updated to optimize RAM memory usage.
47+
Set maximum length of the line for linenoise library. Default length is 4096 bytes. The default value can be updated to optimize RAM memory usage.
4848

4949

5050
Main loop

‎docs/en/api-reference/system/misc_system_api.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -169,8 +169,8 @@ Once custom eFuse MAC address has been obtained (using :cpp:func:`esp_efuse_mac_
169169

170170
.. _local-mac-addresses:
171171

172-
Local vs Universal MAC Addresses
173-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
172+
Local Versus Universal MAC Addresses
173+
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
174174

175175
{IDF_TARGET_NAME} comes pre-programmed with enough valid Espressif universally administered MAC addresses for all internal interfaces. The table above shows how to calculate and derive the MAC address for a specific interface according to the base MAC address.
176176

‎docs/zh_CN/api-guides/memory-types.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -164,6 +164,13 @@ DROM（数据存储在 flash 中）
164164
RTC FAST memory（RTC 快速存储器）
165165
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
166166

167+
.. only:: esp32c6 or esp32h2
168+
169+
.. note::
170+
171+
对于 {IDF_TARGET_NAME}， RTC 存储器已被重新重命名为 LP（低功耗）存储器。在与 {IDF_TARGET_NAME} 相关的 IDF 代码、文档以及技术参考手册中，可能会出现这两个术语混用的情况。
172+
173+
167174
RTC FAST memory 的同一区域既可以作为指令存储器也可以作为数据存储器进行访问。从深度睡眠模式唤醒后必须要运行的代码要放在 RTC 存储器中，更多信息请查阅文档 :doc:`深度睡眠 <deep-sleep-stub>`。
168175

169176
.. only:: esp32

‎docs/zh_CN/api-guides/startup.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
:SOC_RTC_MEM_SUPPORTED: #. 从深度睡眠模式复位：如果 ``RTC_CNTL_STORE6_REG`` 寄存器的值非零，且 ``RTC_CNTL_STORE7_REG`` 寄存器中的 RTC 内存的 CRC 校验值有效，那么程序会使用 ``RTC_CNTL_STORE6_REG`` 寄存器的值作为入口地址，并立即跳转到该地址运行。如果 ``RTC_CNTL_STORE6_REG`` 的值为零，或 ``RTC_CNTL_STORE7_REG`` 中的 CRC 校验值无效，又或通过 ``RTC_CNTL_STORE6_REG`` 调用的代码返回，那么则像上电复位一样继续启动。 **注意**：如果想在这里运行自定义的代码，可以参考 :doc:`深度睡眠 <deep-sleep-stub>` 文档里面介绍的深度睡眠存根机制方法。
3737

38-
#. 上电复位、软件 SoC 复位、看门狗 SoC 复位：检查 ``GPIO_STRAP_REG`` 寄存器，判断是否请求自定义启动模式，如 UART 下载模式。如果是，ROM 会执行此自定义加载器模式。否则程会像软件 CPU 复位一样继续启动。请参考 {IDF_TARGET_NAME} 技术规格书了解 SoC 启动模式以及具体执行过程。
38+
#. 上电复位、软件 SoC 复位、看门狗 SoC 复位：检查 ``GPIO_STRAP_REG`` 寄存器，判断是否请求自定义启动模式，如 UART 下载模式。如果是，ROM 会执行此自定义加载模式，否则会像软件 CPU 复位一样继续启动。请参考 {IDF_TARGET_NAME} 技术规格书了解 SoC 启动模式以及具体执行过程。
3939

4040
#. 软件 CPU 复位、看门狗 CPU 复位：根据 EFUSE 中的值配置 SPI flash，然后尝试从 flash 中加载代码，这部分将会在后面一小节详细介绍。
4141

‎docs/zh_CN/api-reference/system/console.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Linenoise 库不需要显式地初始化，但是在调用行编辑函数之前
4444

4545
:cpp:func:`linenoiseSetMaxLineLen`
4646

47-
设置 linenoise 库中每行的最大长度。默认长度为 4096。如果需要优化 RAM 内存的使用，则可以通过这个函数设置一个小于默认 4 KB 的值来实现。
47+
设置 linenoise 库中每行的最大长度，默认长度为 4096 字节，可以通过更新该默认值来优化 RAM 内存的使用。
4848

4949

5050
主循环

‎docs/zh_CN/api-reference/system/misc_system_api.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
:link_to_translation:`en:[English]`
44

55
{IDF_TARGET_BASE_MAC_BLOCK: default="BLK1", esp32="BLK0"}
6-
{IDF_TARGET_CPU_RESET_DES: default="两个 CPU 复位", esp32c3="CPU 复位", esp32c2="CPU 复位"}
6+
{IDF_TARGET_CPU_RESET_DES: default="CPU 复位", esp32="两个 CPU 均复位", esp32s3="两个 CPU 均复位"}
77

88
软件复位
99
------------

‎docs/zh_CN/security/esp32s3_log.inc

Lines changed: 119 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,131 @@
33

44
.. code-block:: none
55

6-
TODO
7-
6+
ESP-ROM:esp32s3-20210327
7+
Build:Mar 27 2021
8+
rst:0x1 (POWERON),boot:0x8 (SPI_FAST_FLASH_BOOT)
9+
SPIWP:0xee
10+
mode:DIO, clock div:1
11+
load:0x3fcd0270,len:0x2598
12+
load:0x403b6000,len:0x878
13+
load:0x403ba000,len:0x3dd4
14+
entry 0x403b61c0
15+
I (27) boot: ESP-IDF v4.4-dev-2003-g72fdecc1b7-dirty 2nd stage bootloader
16+
I (28) boot: compile time 14:15:37
17+
I (28) boot: chip revision: 0
18+
I (32) boot.esp32s3: SPI Speed : 80MHz
19+
I (36) boot.esp32s3: SPI Mode : DIO
20+
I (41) boot.esp32s3: SPI Flash Size : 2MB
21+
I (46) boot: Enabling RNG early entropy source...
22+
I (58) boot: Partition Table:
23+
I (62) boot: ## Label Usage Type ST Offset Length
24+
I (69) boot: 0 nvs WiFi data 01 02 0000a000 00006000
25+
I (76) boot: 1 storage Unknown data 01 ff 00010000 00001000
26+
I (84) boot: 2 factory factory app 00 00 00020000 00100000
27+
I (91) boot: 3 nvs_key NVS keys 01 04 00120000 00001000
28+
I (99) boot: End of partition table
29+
I (103) esp_image: segment 0: paddr=00020020 vaddr=3c020020 size=08118h ( 33048) map
30+
I (117) esp_image: segment 1: paddr=00028140 vaddr=3fc8fa30 size=023f4h ( 9204) load
31+
I (122) esp_image: segment 2: paddr=0002a53c vaddr=40374000 size=05adch ( 23260) load
32+
I (134) esp_image: segment 3: paddr=00030020 vaddr=42000020 size=1a710h (108304) map
33+
I (156) esp_image: segment 4: paddr=0004a738 vaddr=40379adc size=05f48h ( 24392) load
34+
I (162) esp_image: segment 5: paddr=00050688 vaddr=600fe000 size=00010h ( 16) load
35+
I (167) boot: Loaded app from partition at offset 0x20000
36+
I (168) boot: Checking flash encryption...
37+
I (173) efuse: Batch mode of writing fields is enabled
38+
I (179) flash_encrypt: Generating new flash encryption key...
39+
I (188) efuse: Writing EFUSE_BLK_KEY0 with purpose 4
40+
W (194) flash_encrypt: Not disabling UART bootloader encryption
41+
I (197) flash_encrypt: Disable UART bootloader cache...
42+
I (203) flash_encrypt: Disable JTAG...
43+
I (212) efuse: Batch mode. Prepared fields are committed
44+
I (214) esp_image: segment 0: paddr=00000020 vaddr=3fcd0270 size=02598h ( 9624)
45+
I (223) esp_image: segment 1: paddr=000025c0 vaddr=403b6000 size=00878h ( 2168)
46+
I (230) esp_image: segment 2: paddr=00002e40 vaddr=403ba000 size=03dd4h ( 15828)
47+
I (534) flash_encrypt: bootloader encrypted successfully
48+
I (578) flash_encrypt: partition table encrypted and loaded successfully
49+
I (578) flash_encrypt: Encrypting partition 1 at offset 0x10000 (length 0x1000)...
50+
I (628) flash_encrypt: Done encrypting
51+
I (629) esp_image: segment 0: paddr=00020020 vaddr=3c020020 size=08118h ( 33048) map
52+
I (636) esp_image: segment 1: paddr=00028140 vaddr=3fc8fa30 size=023f4h ( 9204)
53+
I (640) esp_image: segment 2: paddr=0002a53c vaddr=40374000 size=05adch ( 23260)
54+
I (651) esp_image: segment 3: paddr=00030020 vaddr=42000020 size=1a710h (108304) map
55+
I (675) esp_image: segment 4: paddr=0004a738 vaddr=40379adc size=05f48h ( 24392)
56+
I (679) esp_image: segment 5: paddr=00050688 vaddr=600fe000 size=00010h ( 16)
57+
I (680) flash_encrypt: Encrypting partition 2 at offset 0x20000 (length 0x100000)...
58+
I (11571) flash_encrypt: Done encrypting
59+
I (11571) flash_encrypt: Encrypting partition 3 at offset 0x120000 (length 0x1000)...
60+
I (11617) flash_encrypt: Done encrypting
61+
I (11618) flash_encrypt: Flash encryption completed
62+
I (11623) boot: Resetting with flash encryption enabled...
863

964
------
1065

1166
.. already_en_enc
1267

1368
.. code-block:: none
1469

15-
TODO
70+
ESP-ROM:esp32s3-20210327
71+
Build:Mar 27 2021
72+
rst:0x3 (RTC_SW_SYS_RST),boot:0x8 (SPI_FAST_FLASH_BOOT)
73+
Saved PC:0x403bb1d6
74+
SPIWP:0xee
75+
mode:DIO, clock div:1
76+
load:0x3fcd0270,len:0x2598
77+
load:0x403b6000,len:0x878
78+
load:0x403ba000,len:0x3dd4
79+
entry 0x403b61c0
80+
I (35) boot: ESP-IDF v4.4-dev-2003-g72fdecc1b7-dirty 2nd stage bootloader
81+
I (35) boot: compile time 14:15:37
82+
I (35) boot: chip revision: 0
83+
I (39) boot.esp32s3: SPI Speed : 80MHz
84+
I (44) boot.esp32s3: SPI Mode : DIO
85+
I (48) boot.esp32s3: SPI Flash Size : 2MB
86+
I (53) boot: Enabling RNG early entropy source...
87+
I (65) boot: Partition Table:
88+
I (69) boot: ## Label Usage Type ST Offset Length
89+
I (76) boot: 0 nvs WiFi data 01 02 0000a000 00006000
90+
I (84) boot: 1 storage Unknown data 01 ff 00010000 00001000
91+
I (91) boot: 2 factory factory app 00 00 00020000 00100000
92+
I (99) boot: 3 nvs_key NVS keys 01 04 00120000 00001000
93+
I (106) boot: End of partition table
94+
I (110) esp_image: segment 0: paddr=00020020 vaddr=3c020020 size=08118h ( 33048) map
95+
I (126) esp_image: segment 1: paddr=00028140 vaddr=3fc8fa30 size=023f4h ( 9204) load
96+
I (129) esp_image: segment 2: paddr=0002a53c vaddr=40374000 size=05adch ( 23260) load
97+
I (141) esp_image: segment 3: paddr=00030020 vaddr=42000020 size=1a710h (108304) map
98+
I (166) esp_image: segment 4: paddr=0004a738 vaddr=40379adc size=05f48h ( 24392) load
99+
I (172) esp_image: segment 5: paddr=00050688 vaddr=600fe000 size=00010h ( 16) load
100+
I (177) boot: Loaded app from partition at offset 0x20000
101+
I (178) boot: Checking flash encryption...
102+
I (183) flash_encrypt: flash encryption is enabled (1 plaintext flashes left)
103+
I (190) boot: Disabling RNG early entropy source...
104+
I (214) cpu_start: Pro cpu up.
105+
I (214) cpu_start: Starting app cpu, entry point is 0x40374fa8
106+
0x40374fa8: call_start_cpu1 at /home/marius/esp-idf_3/components/esp_system/port/cpu_start.c:160
107+
108+
I (0) cpu_start: App cpu up.
109+
I (228) cpu_start: Pro cpu start user code
110+
I (228) cpu_start: cpu freq: 160000000
111+
I (228) cpu_start: Application information:
112+
I (231) cpu_start: Project name: flash_encryption
113+
I (237) cpu_start: App version: v4.4-dev-2003-g72fdecc1b7-dirty
114+
I (244) cpu_start: Compile time: Jul 12 2021 14:15:34
115+
I (250) cpu_start: ELF file SHA256: a7e6343c6a1c2215...
116+
I (256) cpu_start: ESP-IDF: v4.4-dev-2003-g72fdecc1b7-dirty
117+
I (263) heap_init: Initializing. RAM available for dynamic allocation:
118+
I (270) heap_init: At 3FC92810 len 0004D7F0 (309 KiB): D/IRAM
119+
I (277) heap_init: At 3FCE0000 len 0000EE34 (59 KiB): STACK/DRAM
120+
I (283) heap_init: At 3FCF0000 len 00008000 (32 KiB): DRAM
121+
I (290) spi_flash: detected chip: generic
122+
I (294) spi_flash: flash io: dio
123+
W (298) spi_flash: Detected size(8192k) larger than the size in the binary image header(2048k). Using the size in the binary image header.
124+
I (311) flash_encrypt: Flash encryption mode is DEVELOPMENT (not secure)
125+
I (318) cpu_start: Starting scheduler on PRO CPU.
126+
I (0) cpu_start: Starting scheduler on APP CPU.
127+
128+
Example to check Flash Encryption status
129+
This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2MB external flash
130+
FLASH_CRYPT_CNT eFuse value is 1
131+
Flash encryption feature is enabled in DEVELOPMENT mode
16132

17133
------

0 commit comments

Comments
 (0)