Merge branch 'feature/c6_doc_build' into 'master'

docs: add support for building C6 docs

Closes IDF-5829

See merge request espressif/esp-idf!19721
This commit is contained in:
Marius Vikhammer
2022-10-18 09:37:30 +08:00
22 changed files with 661 additions and 19 deletions

View File

@@ -30,7 +30,7 @@ API Guides
openthread
partition-tables
performance/index
RF_calibration
:not esp32c6: RF_calibration
:esp32: ../security/secure-boot-v1
../security/secure-boot-v2
:SOC_SPIRAM_SUPPORTED: external-ram

View File

@@ -0,0 +1,145 @@
.. This file gets included from other .rst files in this folder.
.. It contains target-specific snippets.
.. Comments and '---' lines act as delimiters.
..
.. This is necessary mainly because RST doesn't support substitutions
.. (defined in RST, not in Python) inside code blocks. If that is ever implemented,
.. These code blocks can be moved back to the main .rst files, with target-specific
.. file names being replaced by substitutions.
.. TODO IDF-6033
.. run-openocd
::
openocd -f board/esp32c6-builtin.cfg
.. |run-openocd-device-name| replace:: ESP32-C6 through built-in USB connection
---
.. run-openocd-output
::
TO BE UPDATED
.. |run-openocd-cfg-file-err| replace:: ``Can't find board/esp32c6-builtin.cfg``
---
.. run-openocd-upload
::
openocd -f board/esp32c6-builtin.cfg -c "program_esp filename.bin 0x10000 verify exit"
---
.. run-openocd-src-linux
.. code-block:: bash
src/openocd -f board/esp32c6-builtin.cfg
---
.. run-openocd-src-win
.. code-block:: batch
src\openocd -f board/esp32c6-builtin.cfg
---
.. idf-py-openocd-default-cfg
.. |idf-py-def-cfg| replace:: ``-f board/esp32c6-builtin.cfg``
---
.. run-openocd-appimage-offset
::
openocd -f board/esp32c6-builtin.cfg -c "init; halt; esp appimage_offset 0x210000"
---
.. openocd-cfg-files
.. list-table:: OpenOCD configuration files for ESP32-C3
:widths: 25 75
:header-rows: 1
* - Name
- Description
* - TO BE UPDATED
- TO BE UPDATED
---
.. openocd-target-specific-config-vars
---
---
.. jtag-pins
.. list-table:: ESP32-C6 pins and JTAG signals
:widths: 25 75
:header-rows: 1
* - ESP32-C6 Pin
- JTAG Signal
* - MTDO
- TDO
* - MTDI
- TDI
* - MTCK
- TCK
* - MTMS
- TMS
.. |jtag-sel-gpio| replace:: TO BE UPDATED
.. |jtag-gpio-list| replace:: TO BE UPDATED
---
.. run-openocd-d3
::
openocd -l openocd_log.txt -d3 -f board/esp32c6-builtin.cfg
---
.. run-openocd-d3-tee
::
openocd -d3 -f board/esp32c6-builtin.cfg 2>&1 | tee openocd.log
---
.. run-gdb-remotelog
::
riscv32-esp-elf-gdb -ex "set remotelogfile gdb_log.txt" <all other options>
---
.. devkit-defs
.. |devkit-name| replace:: ESP32-C6
.. |devkit-name-with-link| replace:: :doc:`ESP32-C6 <../../hw-reference/index>`
---
.. devkit-hw-config
* Out of the box, ESP32-C6 doesn't need any additional hardware configuration for JTAG debugging.
---

View File

@@ -88,7 +88,7 @@ The ESP-IDF bootloader ignores any partition types other than ``app`` (0x00) and
SubType
~~~~~~~
{IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp32c2 = "(not updated yet)"}
{IDF_TARGET_ESP_PHY_REF:default = ":ref:`CONFIG_ESP_PHY_INIT_DATA_IN_PARTITION`", esp32c6 = "(not updated yet)"}
The 8-bit SubType field is specific to a given partition type. ESP-IDF currently only specifies the meaning of the subtype field for ``app`` and ``data`` partition types.

View File

@@ -13,8 +13,8 @@ Note that, in contrast with the USB OTG peripheral in some Espressif chips, the
Hardware Requirements
=====================
{IDF_TARGET_USB_DP_GPIO:default="Not Updated!",esp32c3="19",esp32s3="20"}
{IDF_TARGET_USB_DM_GPIO:default="Not Updated!",esp32c3="18",esp32s3="19"}
{IDF_TARGET_USB_DP_GPIO:default="Not Updated!",esp32c3="19",esp32s3="20", esp32c6="13"}
{IDF_TARGET_USB_DM_GPIO:default="Not Updated!",esp32c3="18",esp32s3="19", esp32c6="12"}
Connect {IDF_TARGET_NAME} to the USB port as follows: