Skip to content

Commit c6bc55f

Browse files
LindazhxyLindazhxy
committed
Merge branch 'docs/update_getting_started_page_c5' into 'master'
docs: update get-started documents for ESP32-C5 See merge request espressif/esp-idf!38992
2 parents a952037 + a93d61b commit c6bc55f

File tree

13 files changed

+122
-24
lines changed

13 files changed

+122
-24
lines changed

‎docs/docs_not_updated/esp32c5.txt‎

Lines changed: 0 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,3 @@ api-reference/system/inc/power_management_esp32c5.rst
3939
api-reference/index.rst
4040
api-reference/protocols/esp_serial_slave_link.rst
4141
api-reference/protocols/esp_crt_bundle.rst
42-
get-started/establish-serial-connection.rst
43-
get-started/linux-macos-setup.rst
44-
get-started/linux-macos-start-project.rst
45-
get-started/windows-setup.rst
46-
get-started/start-project.rst
47-
get-started/flashing-troubleshooting.rst
48-
get-started/windows-start-project.rst
49-
get-started/index.rst
50-
get-started/windows-setup-update.rst
51-
hw-reference/index.rst

‎docs/en/get-started/esp32c5_output_log.inc‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,40 @@
22

33
.. code-block:: none
44

5-
To be updated for C5
5+
...
6+
esptool.py --chip esp32c5 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset --no-stub write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x2000 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
7+
esptool.py v4.9.dev6
8+
Serial port /dev/ttyUSB0
9+
Connecting....
10+
Chip is ESP32-C5 (revision v1.0)
11+
Features: WiFi 6, BT 5, IEEE802.15.4
12+
Crystal is 48MHz
13+
MAC: 30:ed:a0:ff:fe:e0:af:38
14+
BASE MAC: 30:ed:a0:e0:af:38
15+
MAC_EXT: ff:fe
16+
ROM expects crystal freq: 48 MHz, detected 48 MHz
17+
Changing baud rate to 460800
18+
Changed.
19+
Enabling default SPI flash mode...
20+
Configuring flash size...
21+
Flash will be erased from 0x00002000 to 0x00007fff...
22+
Flash will be erased from 0x00010000 to 0x00034fff...
23+
Flash will be erased from 0x00008000 to 0x00008fff...
24+
Erasing flash...
25+
Took 0.09s to erase flash block
26+
Writing at 0x00007400... (100 %)
27+
Wrote 22528 bytes at 0x00002000 in 0.7 seconds (276.3 kbit/s)...
28+
Hash of data verified.
29+
Erasing flash...
30+
Took 0.37s to erase flash block
31+
Writing at 0x00034c00... (100 %)
32+
Wrote 151552 bytes at 0x00010000 in 4.4 seconds (275.6 kbit/s)...
33+
Hash of data verified.
34+
Erasing flash...
35+
Took 0.02s to erase flash block
36+
Writing at 0x00008800... (100 %)
37+
Wrote 3072 bytes at 0x00008000 in 0.1 seconds (281.8 kbit/s)...
38+
Hash of data verified.
39+
40+
Leaving...
41+
Hard resetting via RTS pin...

‎docs/en/get-started/establish-serial-connection.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@ Sometimes the USB-to-UART bridge is external. This is often used in small develo
141141

142142
For the {IDF_TARGET_NAME}, the USB peripheral is available, allowing you to flash the binaries without the need for an external USB-to-UART bridge.
143143

144-
{IDF_TARGET_USB_PIN_DM:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12", esp32h2="GPIO26", esp32p4="GPIO24/26"}
145-
{IDF_TARGET_USB_PIN_DP:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13", esp32h2="GPIO27", esp32p4="GPIO25/27"}
144+
{IDF_TARGET_USB_PIN_DM:default="Not Updated!", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12", esp32h2="GPIO26", esp32p4="GPIO24/26", esp32c5="GPIO13"}
145+
{IDF_TARGET_USB_PIN_DP:default="Not Updated!", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13", esp32h2="GPIO27", esp32p4="GPIO25/27", esp32c5="GPIO14"}
146146

147147
The USB on the {IDF_TARGET_NAME} uses the **{IDF_TARGET_USB_PIN_DP}** for **D+** and **{IDF_TARGET_USB_PIN_DM}** for **D-**.
148148

@@ -347,7 +347,7 @@ If there is no log output, check
347347
Example Output
348348
^^^^^^^^^^^^^^
349349

350-
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35"}
350+
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35", esp32c5="GPIO28"}
351351

352352
An example log is shown below. Reset the board if you do not see anything.
353353

‎docs/en/get-started/flashing-troubleshooting.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Flashing Troubleshooting
66
Failed to Connect
77
-----------------
88

9-
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35"}
9+
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35", esp32c5="GPIO28"}
1010

1111
If you run the given command and see errors such as "Failed to connect", there might be several reasons for this. One of the reasons might be issues encountered by ``esptool.py``, the utility that is called by the build system to reset the chip, interact with the first stage (ROM) bootloader, and flash firmware. One simple solution to try is to manually reset as described below. If it does not help, you can find more details about possible issues in the `esptool troubleshooting <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_ page.
1212

‎docs/en/get-started/index.rst‎

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,15 @@ Introduction
5959
* Multiple peripherals
6060
* Intended for simple, high-volume IoT applications
6161

62+
.. only:: esp32c5
63+
64+
* Wi-Fi 6 (2.4 and 5 GHz dual-band)
65+
* Bluetooth Low Energy
66+
* 802.15.4 Thread/Zigbee
67+
* High performance 32-bit RISC-V single-core processor
68+
* Multiple peripherals
69+
* Built-in security hardware
70+
6271
.. only:: esp32c6
6372

6473
* Wi-Fi 6 (2.4 GHz band)
@@ -158,6 +167,13 @@ If you have one of {IDF_TARGET_NAME} official development boards listed below, y
158167

159168
ESP8684-DevKitM-1 <https://docs.espressif.com/projects/espressif-esp-dev-kits/en/latest/esp8684/esp8684-devkitm-1/index.html>
160169

170+
.. only:: esp32c5
171+
172+
.. toctree::
173+
:maxdepth: 1
174+
175+
ESP32-C5-DevKitC-1 <https://docs.espressif.com/projects/esp-dev-kits/en/latest/esp32c5/esp32-c5-devkitc-1/index.html>
176+
161177
.. only:: esp32c6
162178

163179
.. toctree::

‎docs/en/get-started/start-project.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
{IDF_TARGET_FEATURES:default="[NEEDS TO BE UPDATED]", esp32="WiFi/BT/BLE, silicon revision 1, 2 MB external flash", esp32s2="WiFi, silicon revision 0, 2 MB external flash", esp32s3="This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c2="WiFi/BLE, silicon revision 0, 2 MB embedded flash", esp32c3="WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c6="WiFi/BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.0, 2 MB external flash", esp32h2="BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.1, 2 MB external flash", esp32p4="silicon revision v0.0, 2 MB external flash"}
1+
{IDF_TARGET_FEATURES:default="[NEEDS TO BE UPDATED]", esp32="WiFi/BT/BLE, silicon revision 1, 2 MB external flash", esp32s2="WiFi, silicon revision 0, 2 MB external flash", esp32s3="This is esp32s3 chip with 2 CPU core(s), WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c2="WiFi/BLE, silicon revision 0, 2 MB embedded flash", esp32c3="WiFi/BLE, silicon revision 0, 2 MB external flash", esp32c6="WiFi/BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.0, 2 MB external flash", esp32h2="BLE, 802.15.4 (Zigbee/Thread), silicon revision v0.1, 2 MB external flash", esp32p4="silicon revision v0.0, 2 MB external flash", esp32c5="WiFi/BLE, 802.15.4 (Zigbee/Thread), silicon revision v1.0, 2 MB external flash"}
22

3-
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332", esp32c6="473816", esp32h2="268256", esp32p4="618848"}
3+
{IDF_TARGET_HEAP_SIZE:default="[NEEDS TO BE UPDATED]", esp32="298968", esp32s2="253900", esp32s3="390684", esp32c2="203888", esp32c3="337332", esp32c6="473816", esp32h2="268256", esp32p4="618848", esp32c5="348724"}
44

55
Build the Project
66
=================

‎docs/en/hw-reference/index.rst‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ Hardware Reference
1515
:esp32c3: Chip Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32-c3_datasheet_en.pdf>
1616
:esp32c6: Chip Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32-c6_datasheet_en.pdf>
1717
:esp32h2: Chip Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32-h2_datasheet_en.pdf>
18+
:esp32c5: Chip Datasheet (PDF) <https://espressif.com/sites/default/files/documentation/esp32-c5_datasheet_en.pdf>
1819
:esp32: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32/index.html>
1920
:esp32s2: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32s2/index.html>
2021
:esp32s3: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32s3/index.html>
@@ -23,6 +24,7 @@ Hardware Reference
2324
:esp32c6: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32c6/index.html>
2425
:esp32h2: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32h2/index.html>
2526
:esp32p4: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32p4/index.html>
27+
:esp32c5: Hardware Design Guidelines <https://docs.espressif.com/projects/esp-hardware-design-guidelines/en/latest/esp32c5/index.html>
2628
:esp32: SoC Errata <https://docs.espressif.com/projects/esp-chip-errata/en/latest/esp32/index.html>
2729
:esp32s2: SoC Errata <https://docs.espressif.com/projects/esp-chip-errata/en/latest/esp32s2/index.html>
2830
:esp32s3: SoC Errata <https://docs.espressif.com/projects/esp-chip-errata/en/latest/esp32s3/index.html>

‎docs/zh_CN/get-started/esp32c5_output_log.inc‎

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,4 +2,40 @@
22

33
.. code-block:: none
44

5-
To be updated for C5
5+
...
6+
esptool.py --chip esp32c5 -p /dev/ttyUSB0 -b 460800 --before=default_reset --after=hard_reset --no-stub write_flash --flash_mode dio --flash_freq 80m --flash_size 2MB 0x2000 bootloader/bootloader.bin 0x10000 hello_world.bin 0x8000 partition_table/partition-table.bin
7+
esptool.py v4.9.dev6
8+
Serial port /dev/ttyUSB0
9+
Connecting....
10+
Chip is ESP32-C5 (revision v1.0)
11+
Features: WiFi 6, BT 5, IEEE802.15.4
12+
Crystal is 48MHz
13+
MAC: 30:ed:a0:ff:fe:e0:af:38
14+
BASE MAC: 30:ed:a0:e0:af:38
15+
MAC_EXT: ff:fe
16+
ROM expects crystal freq: 48 MHz, detected 48 MHz
17+
Changing baud rate to 460800
18+
Changed.
19+
Enabling default SPI flash mode...
20+
Configuring flash size...
21+
Flash will be erased from 0x00002000 to 0x00007fff...
22+
Flash will be erased from 0x00010000 to 0x00034fff...
23+
Flash will be erased from 0x00008000 to 0x00008fff...
24+
Erasing flash...
25+
Took 0.09s to erase flash block
26+
Writing at 0x00007400... (100 %)
27+
Wrote 22528 bytes at 0x00002000 in 0.7 seconds (276.3 kbit/s)...
28+
Hash of data verified.
29+
Erasing flash...
30+
Took 0.37s to erase flash block
31+
Writing at 0x00034c00... (100 %)
32+
Wrote 151552 bytes at 0x00010000 in 4.4 seconds (275.6 kbit/s)...
33+
Hash of data verified.
34+
Erasing flash...
35+
Took 0.02s to erase flash block
36+
Writing at 0x00008800... (100 %)
37+
Wrote 3072 bytes at 0x00008000 in 0.1 seconds (281.8 kbit/s)...
38+
Hash of data verified.
39+
40+
Leaving...
41+
Hard resetting via RTS pin...

‎docs/zh_CN/get-started/establish-serial-connection.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,8 +141,8 @@
141141

142142
{IDF_TARGET_NAME} 支持 USB 外设，无需外部 USB 至 UART 桥，即可烧录二进制文件。
143143

144-
{IDF_TARGET_USB_PIN_DM:default="尚未更新！", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12", esp32h2="GPIO26", esp32p4="GPIO24/26"}
145-
{IDF_TARGET_USB_PIN_DP:default="尚未更新！", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13", esp32h2="GPIO27", esp32p4="GPIO25/27"}
144+
{IDF_TARGET_USB_PIN_DM:default="尚未更新！", esp32c3="GPIO18", esp32s3="GPIO19", esp32s2="GPIO19", esp32c6="GPIO12", esp32h2="GPIO26", esp32p4="GPIO24/26", esp32c5="GPIO13"}
145+
{IDF_TARGET_USB_PIN_DP:default="尚未更新！", esp32c3="GPIO19", esp32s3="GPIO20", esp32s2="GPIO20", esp32c6="GPIO13", esp32h2="GPIO27", esp32p4="GPIO25/27", esp32c5="GPIO14"}
146146

147147
{IDF_TARGET_NAME} 上的 USB 使用 **{IDF_TARGET_USB_PIN_DP}** 作为 **D+**， **{IDF_TARGET_USB_PIN_DM}** 作为 **D-**。
148148

@@ -347,7 +347,7 @@ macOS 提供了 **屏幕** 命令，因此无需安装串口终端程序。
347347
输出示例
348348
^^^^^^^^^^^
349349

350-
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35"}
350+
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35", esp32c5="GPIO28"}
351351

352352
以下是一个日志示例。如果没看到任何输出，请尝试重置开发板。
353353

‎docs/zh_CN/get-started/flashing-troubleshooting.rst‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
连接失败
77
-----------------
88

9-
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35"}
9+
{IDF_TARGET_STRAP_GPIO:default="[NEEDS TO BE UPDATED]", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32c2="GPIO9", esp32c3="GPIO9", esp32c6="GPIO9", esp32h2="GPIO9", esp32p4="GPIO35", esp32c5="GPIO28"}
1010

1111
如果在运行给定命令时出现如“连接失败”这样的错误，造成该错误的原因之一可能是运行 ``esptool.py`` 时出现错误。 ``esptool.py`` 是构建系统调用的程序，用于重置芯片、与 ROM 引导加载器交互以及烧录固件的工具。可以按照以下步骤进行手动复位，轻松解决该问题。如果问题仍未解决，请参考 `esptool 故障排除 <https://docs.espressif.com/projects/esptool/en/latest/esp32/troubleshooting.html>`_ 获取更多信息。
1212

0 commit comments

Comments
 (0)