Skip to content

Commit f52c723

Browse files
committed
docs: Add ESP32-C5 and ESP32-C61 docs
1 parent ec309bb commit f52c723

File tree

10 files changed

+393
-10
lines changed

10 files changed

+393
-10
lines changed

.gitlab-ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -433,7 +433,7 @@ target_esp32c61:
433433
tags:
434434
- esptool_esp32c61_target
435435
script:
436-
- coverage run --parallel-mode -m pytest ${CI_PROJECT_DIR}/test/test_esptool.py --port /dev/serial_ports/ESP32C61 --chip esp32c61 --baud 115200
436+
- coverage run --parallel-mode -m pytest ${CI_PROJECT_DIR}/test/test_esptool.py --port /dev/serial_ports/ESP32C61 --chip esp32c61 --baud 115200
437437

438438
.windows_test:
439439
stage: test
@@ -523,7 +523,7 @@ build_docs:
523523
script:
524524
- cd docs
525525
- pip install -r requirements.txt --prefer-binary
526-
- build-docs -l en -t {esp8266,esp32,esp32s2,esp32c3,esp32s3,esp32c2,esp32c6,esp32h2,esp32p4}
526+
- build-docs -l en -t {esp8266,esp32,esp32s2,esp32c3,esp32s3,esp32c2,esp32c6,esp32h2,esp32p4,esp32c5,esp32c61}
527527

528528
.deploy_docs_template:
529529
stage: deploy_docs

docs/_static/esptool_versions.js

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,7 @@ var DOCUMENTATION_VERSIONS = {
1313
{ text: "ESP32-C6", value: "esp32c6" },
1414
{ text: "ESP32-H2", value: "esp32h2" },
1515
{ text: "ESP32-P4", value: "esp32p4" },
16+
{ text: "ESP32-C5", value: "esp32c5" },
17+
{ text: "ESP32-C61", value: "esp32c61" },
1618
]
1719
};

docs/conf_common.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@
1111
"esp32c6",
1212
"esp32h2",
1313
"esp32p4",
14+
"esp32c5",
15+
"esp32c61",
1416
]
1517

1618
# link roles config
@@ -42,6 +44,8 @@
4244
"esp32c6": ESP32_DOCS,
4345
"esp32h2": ESP32_DOCS,
4446
"esp32p4": ESP32_DOCS,
47+
"esp32c5": ESP32_DOCS,
48+
"esp32c61": ESP32_DOCS,
4549
}
4650

4751
# Extra options required by sphinx_idf_theme

docs/en/advanced-topics/boot-mode-selection.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
{IDF_TARGET_STRAP_BOOT_GPIO:default="GPIO9", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32p4="GPIO35"}
1+
{IDF_TARGET_STRAP_BOOT_GPIO:default="GPIO9", esp32="GPIO0", esp32s2="GPIO0", esp32s3="GPIO0", esp32p4="GPIO35", esp32c5="GPIO28"}
22

3-
{IDF_TARGET_STRAP_BOOT_2_GPIO:default="GPIO8", esp32="GPIO2", esp32s2="GPIO46", esp32s3="GPIO46", esp32p4="GPIO36"}
3+
{IDF_TARGET_STRAP_BOOT_2_GPIO:default="GPIO8", esp32="GPIO2", esp32s2="GPIO46", esp32s3="GPIO46", esp32p4="GPIO36", esp32c5="GPIO27"}
44

55
{IDF_TARGET_BOOTLOADER_OFFSET:default="0", esp32="1000", esp32s2="1000", esp32p4="2000"}
66

@@ -87,7 +87,7 @@ This guide explains how to select the boot mode correctly and describes the boot
8787

8888
{IDF_TARGET_STRAP_BOOT_2_GPIO} must also be either left unconnected/floating, or driven Low, in order to enter the serial bootloader.
8989

90-
.. only:: esp32c3 or esp32c2 or esp32h2 or esp32c6 or esp32p4
90+
.. only:: esp32c3 or esp32c2 or esp32h2 or esp32c6 or esp32p4 or esp32c5 or esp32c61
9191

9292
{IDF_TARGET_STRAP_BOOT_2_GPIO} must also be driven High, in order to enter the serial bootloader reliably. The strapping combination of {IDF_TARGET_STRAP_BOOT_2_GPIO} = 0 and {IDF_TARGET_STRAP_BOOT_GPIO} = 0 is invalid and will trigger unexpected behavior.
9393

docs/en/advanced-topics/firmware-image-format.rst

Lines changed: 19 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,7 +91,25 @@ The image header is 8 bytes long:
9191
Flash frequency with value ``0`` can mean either 80MHz or 40MHz based on MSPI clock source mode.
9292

9393

94-
.. only:: not (esp8266 or esp32c6 or esp32s3 or esp32s2 or esp32p4)
94+
.. only:: esp32c5 or esp32c61
95+
96+
+--------+------------------------------------------------------------------------------------------------+
97+
| Byte | Description |
98+
+========+================================================================================================+
99+
| 0 | Magic number (always ``0xE9``) |
100+
+--------+------------------------------------------------------------------------------------------------+
101+
| 1 | Number of segments |
102+
+--------+------------------------------------------------------------------------------------------------+
103+
| 2 | SPI Flash Mode (``0`` = QIO, ``1`` = QOUT, ``2`` = DIO, ``3`` = DOUT) |
104+
+--------+------------------------------------------------------------------------------------------------+
105+
| 3 | High four bits - Flash size (``0`` = 1MB, ``1`` = 2MB, ``2`` = 4MB, ``3`` = 8MB, ``4`` = 16MB) |
106+
| | |
107+
| | Low four bits - Flash frequency (``0xf`` = {IDF_TARGET_FLASH_FREQ_F}MHz, ``0`` = {IDF_TARGET_FLASH_FREQ_0}MHz, ``2`` = {IDF_TARGET_FLASH_FREQ_2}MHz) |
108+
+--------+------------------------------------------------------------------------------------------------+
109+
| 4-7 | Entry point address |
110+
+--------+------------------------------------------------------------------------------------------------+
111+
112+
.. only:: not (esp8266 or esp32c6 or esp32s3 or esp32s2 or esp32p4 or esp32c5 or esp32c61)
95113

96114
+--------+------------------------------------------------------------------------------------------------+
97115
| Byte | Description |

0 commit comments

Comments
 (0)