From ca4ad3ce7c5e16bf3d4e4e92a286886afb97e0f5 Mon Sep 17 00:00:00 2001 From: Marius Vikhammer Date: Tue, 23 Aug 2022 15:25:03 +0800 Subject: [PATCH] docs: add support for building C6 docs --- .gitlab/ci/docs.yml | 2 +- .../esp32c6/include/soc/Kconfig.soc_caps.in | 4 + components/soc/esp32c6/include/soc/soc_caps.h | 3 + docs/conf_common.py | 19 +- docs/docs_not_updated/esp32c6.txt | 283 ++++++++++++++++++ docs/doxygen/Doxyfile_esp32c6 | 20 ++ docs/en/api-guides/index.rst | 2 +- docs/en/api-guides/jtag-debugging/esp32c6.inc | 145 +++++++++ docs/en/api-guides/partition-tables.rst | 2 +- .../en/api-guides/usb-serial-jtag-console.rst | 4 +- docs/en/api-reference/peripherals/index.rst | 4 +- .../system/inc/espefuse_summary_ESP32-C6.rst | 3 + .../system/inc/show-efuse-table_ESP32-C6.rst | 4 + docs/en/security/esp32c6_log.inc | 13 + docs/zh_CN/api-guides/index.rst | 2 +- .../api-guides/jtag-debugging/esp32c6.inc | 145 +++++++++ docs/zh_CN/api-guides/partition-tables.rst | 2 +- .../zh_CN/api-reference/peripherals/index.rst | 4 +- .../system/inc/espefuse_summary_ESP32-C6.rst | 1 + .../system/inc/show-efuse-table_ESP32-C6.rst | 1 + docs/zh_CN/security/esp32c6_log.inc | 13 + .../wifi/iperf/sdkconfig.defaults.esp32c6 | 4 + 22 files changed, 661 insertions(+), 19 deletions(-) create mode 100644 docs/docs_not_updated/esp32c6.txt create mode 100644 docs/doxygen/Doxyfile_esp32c6 create mode 100644 docs/en/api-guides/jtag-debugging/esp32c6.inc create mode 100644 docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst create mode 100644 docs/en/api-reference/system/inc/show-efuse-table_ESP32-C6.rst create mode 100644 docs/en/security/esp32c6_log.inc create mode 100644 docs/zh_CN/api-guides/jtag-debugging/esp32c6.inc create mode 100644 docs/zh_CN/api-reference/system/inc/espefuse_summary_ESP32-C6.rst create mode 100644 docs/zh_CN/api-reference/system/inc/show-efuse-table_ESP32-C6.rst create mode 100644 docs/zh_CN/security/esp32c6_log.inc create mode 100644 examples/wifi/iperf/sdkconfig.defaults.esp32c6 diff --git a/.gitlab/ci/docs.yml b/.gitlab/ci/docs.yml index 82eea28027..4dd0b9f86e 100644 --- a/.gitlab/ci/docs.yml +++ b/.gitlab/ci/docs.yml @@ -68,7 +68,7 @@ check_docs_lang_sync: parallel: matrix: - DOCLANG: ["en", "zh_CN"] - DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2"] + DOCTGT: ["esp32", "esp32s2", "esp32s3", "esp32c3", "esp32c2", "esp32c6"] check_docs_gh_links: image: $ESP_IDF_DOC_ENV_IMAGE diff --git a/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in b/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in index 73d0666948..e9c25a9b5e 100644 --- a/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in +++ b/components/soc/esp32c6/include/soc/Kconfig.soc_caps.in @@ -778,3 +778,7 @@ config SOC_WIFI_CSI_SUPPORT config SOC_WIFI_MESH_SUPPORT bool default y + +config SOC_BLE_SUPPORTED + bool + default y diff --git a/components/soc/esp32c6/include/soc/soc_caps.h b/components/soc/esp32c6/include/soc/soc_caps.h index bdd7165252..3570842015 100644 --- a/components/soc/esp32c6/include/soc/soc_caps.h +++ b/components/soc/esp32c6/include/soc/soc_caps.h @@ -407,3 +407,6 @@ #define SOC_WIFI_WAPI_SUPPORT (1) /*!< Support WAPI */ #define SOC_WIFI_CSI_SUPPORT (1) /*!< Support CSI */ #define SOC_WIFI_MESH_SUPPORT (1) /*!< Support WIFI MESH */ + +/*---------------------------------- Bluetooth CAPS ----------------------------------*/ +#define SOC_BLE_SUPPORTED (1) /*!< Support Bluetooth Low Energy hardware */ diff --git a/docs/conf_common.py b/docs/conf_common.py index a713c45923..a9045912e4 100644 --- a/docs/conf_common.py +++ b/docs/conf_common.py @@ -59,6 +59,9 @@ WIFI_DOCS = ['api-guides/wifi.rst', 'api-guides/wifi-security.rst', 'api-guides/wireshark-user-guide.rst'] +WIFI_MESH_DOCS = ['api-guides/esp-wifi-mesh.rst', + 'api-reference/network/esp-wifi-mesh.rst'] + COEXISTENCE_DOCS = ['api-guides/coexist.rst'] SDMMC_DOCS = ['api-reference/peripherals/sdmmc_host.rst', @@ -123,8 +126,7 @@ ESP32_DOCS = ['api-reference/system/himem.rst', 'api-reference/peripherals/secure_element.rst', 'api-reference/peripherals/dac.rst', 'hw-reference/esp32/**', - 'api-guides/esp-wifi-mesh.rst', - 'api-reference/network/esp-wifi-mesh.rst'] + FTDI_JTAG_DOCS + 'api-guides/RF_calibration.rst'] + FTDI_JTAG_DOCS ESP32S2_DOCS = ['hw-reference/esp32s2/**', 'api-guides/usb-console.rst', @@ -133,19 +135,18 @@ ESP32S2_DOCS = ['hw-reference/esp32s2/**', 'api-reference/peripherals/temp_sensor.rst', 'api-reference/system/async_memcpy.rst', 'api-reference/peripherals/touch_element.rst', - 'api-guides/esp-wifi-mesh.rst', - 'api-reference/network/esp-wifi-mesh.rst'] + FTDI_JTAG_DOCS + 'api-guides/RF_calibration.rst'] + FTDI_JTAG_DOCS ESP32S3_DOCS = ['hw-reference/esp32s3/**', 'api-reference/system/ipc.rst', 'api-guides/flash_psram_config.rst', - 'api-guides/esp-wifi-mesh.rst', - 'api-reference/network/esp-wifi-mesh.rst'] + 'api-guides/RF_calibration.rst'] # No JTAG docs for this one as it gets gated on SOC_USB_SERIAL_JTAG_SUPPORTED down below. ESP32C3_DOCS = ['hw-reference/esp32c3/**', - 'api-guides/esp-wifi-mesh.rst', - 'api-reference/network/esp-wifi-mesh.rst'] + 'api-guides/RF_calibration.rst'] + +ESP32C2_DOCS = ['api-guides/RF_calibration.rst'] # format: {tag needed to include: documents to included}, tags are parsed from sdkconfig and peripheral_caps.h headers conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS, @@ -178,9 +179,11 @@ conditional_include_dict = {'SOC_BT_SUPPORTED':BT_DOCS, 'SOC_ADC_SUPPORTED':ADC_DOCS, 'SOC_ADC_DMA_SUPPORTED':ADC_DMA_DOCS, 'SOC_SDM_SUPPORTED':SDM_DOCS, + 'SOC_WIFI_MESH_SUPPORT':WIFI_MESH_DOCS, 'esp32':ESP32_DOCS, 'esp32s2':ESP32S2_DOCS, 'esp32s3':ESP32S3_DOCS, + 'esp32c2':ESP32C2_DOCS, 'esp32c3':ESP32C3_DOCS} extensions += ['sphinx_copybutton', diff --git a/docs/docs_not_updated/esp32c6.txt b/docs/docs_not_updated/esp32c6.txt new file mode 100644 index 0000000000..023b3148b0 --- /dev/null +++ b/docs/docs_not_updated/esp32c6.txt @@ -0,0 +1,283 @@ +languages +contribute +contribute/esp-idf-tests-with-pytest +contribute/contributor-agreement +contribute/documenting-code +contribute/creating-examples +contribute/style-guide +contribute/copyright-guide +contribute/install-pre-commit-hook +contribute/index +api-guides +api-guides/core_dump_internals +api-guides/event-handling +api-guides/performance +api-guides/performance/speed +api-guides/performance/size +api-guides/performance/ram-usage +api-guides/performance/index +api-guides/jtag-debugging +api-guides/jtag-debugging/debugging-examples +api-guides/jtag-debugging/configure-ft2232h-jtag +api-guides/jtag-debugging/tips-and-quirks +api-guides/jtag-debugging/using-debugger +api-guides/jtag-debugging/building-openocd-macos +api-guides/jtag-debugging/building-openocd-linux +api-guides/jtag-debugging/configure-other-jtag +api-guides/jtag-debugging/building-openocd-windows +api-guides/jtag-debugging/index +api-guides/jtag-debugging/configure-builtin-jtag +api-guides/partition-tables +api-guides/app_trace +api-guides/thread-local-storage +api-guides/error-handling +api-guides/tools +api-guides/tools/idf-tools +api-guides/tools/idf-clang-tidy +api-guides/tools/idf-component-manager +api-guides/tools/idf-py +api-guides/tools/idf-windows-installer +api-guides/tools/idf-monitor +api-guides/tools/idf-docker-image +api-guides/tools/index +api-guides/startup +api-guides/hlinterrupts +api-guides/RF_calibration +api-guides/unit-tests +api-guides/deep-sleep-stub +api-guides/blufi +api-guides/lwip +api-guides/coexist +api-guides/flash_psram_config +api-guides/usb-serial-jtag-console +api-guides/linker-script-generation +api-guides/wifi +api-guides/usb-otg-console +api-guides/wireshark-user-guide +api-guides/bootloader +api-guides/esp-wifi-mesh +api-guides/SYSVIEW_FreeRTOS.txt +api-guides/build-system +api-guides/freertos-smp +api-guides/core_dump +api-guides/inc +api-guides/inc/external-ram-esp32-notes +api-guides/inc/linux-host-requirements +api-guides/dfu +api-guides/linux-host-testing +api-guides/esp-ble-mesh +api-guides/esp-ble-mesh/ble-mesh-index +api-guides/esp-ble-mesh/ble-mesh-feature-list +api-guides/esp-ble-mesh/ble-mesh-terminology +api-guides/esp-ble-mesh/ble-mesh-architecture +api-guides/esp-ble-mesh/ble-mesh-faq +api-guides/external-ram +api-guides/reproducible-builds +api-guides/hardware-abstraction +api-guides/wifi-security +api-guides/index +api-guides/openthread +api-guides/fatal-errors +api-guides/memory-types +api-guides/general-notes +third-party-tools +third-party-tools/platformio +COPYRIGHT +libraries-and-frameworks +libraries-and-frameworks/libs-frameworks +libraries-and-frameworks/index +libraries-and-frameworks/cloud-frameworks +conf.py +versions +api-reference +api-reference/api-conventions +api-reference/template +api-reference/provisioning +api-reference/provisioning/protocomm +api-reference/provisioning/provisioning +api-reference/provisioning/index +api-reference/provisioning/wifi_provisioning +api-reference/storage +api-reference/storage/vfs +api-reference/storage/spiffs +api-reference/storage/wear-levelling +api-reference/storage/fatfs +api-reference/storage/nvs_partition_gen +api-reference/storage/spi_flash_concurrency +api-reference/storage/spi_flash +api-reference/storage/spi_flash_override_driver +api-reference/storage/spi_flash_optional_feature +api-reference/storage/nvs_flash +api-reference/storage/sdmmc +api-reference/storage/mass_mfg +api-reference/storage/index +api-reference/peripherals +api-reference/peripherals/sdspi_share +api-reference/peripherals/adc_continuous +api-reference/peripherals/adc_oneshot +api-reference/peripherals/usb_host +api-reference/peripherals/twai +api-reference/peripherals/hmac +api-reference/peripherals/usb_device +api-reference/peripherals/gpio +api-reference/peripherals/sdspi_host +api-reference/peripherals/dac +api-reference/peripherals/spi_slave +api-reference/peripherals/i2s +api-reference/peripherals/gptimer +api-reference/peripherals/pcnt +api-reference/peripherals/touch_element +api-reference/peripherals/lcd +api-reference/peripherals/mcpwm +api-reference/peripherals/secure_element +api-reference/peripherals/ledc +api-reference/peripherals/temp_sensor +api-reference/peripherals/spi_features +api-reference/peripherals/sdio_slave +api-reference/peripherals/clk_tree +api-reference/peripherals/sdm +api-reference/peripherals/touch_pad +api-reference/peripherals/adc_calibration +api-reference/peripherals/spi_slave_hd +api-reference/peripherals/ds +api-reference/peripherals/i2c +api-reference/peripherals/dedic_gpio +api-reference/peripherals/sd_pullup_requirements +api-reference/peripherals/spi_master +api-reference/peripherals/index +api-reference/peripherals/sdmmc_host +api-reference/peripherals/uart +api-reference/peripherals/rmt +api-reference/kconfig +api-reference/network +api-reference/network/esp_openthread +api-reference/network/esp_eth +api-reference/network/esp_netif_driver +api-reference/network/esp_dpp +api-reference/network/esp_now +api-reference/network/esp-wifi-mesh +api-reference/network/esp_smartconfig +api-reference/network/esp_wifi +api-reference/network/index +api-reference/network/esp_netif +api-reference/system +api-reference/system/sleep_modes +api-reference/system/ota +api-reference/system/app_trace +api-reference/system/ulp_macros +api-reference/system/perfmon +api-reference/system/ulp +api-reference/system/esp_function_with_shared_stack +api-reference/system/efuse +api-reference/system/ulp_instruction_set +api-reference/system/async_memcpy +api-reference/system/random +api-reference/system/esp_timer +api-reference/system/esp_event +api-reference/system/freertos +api-reference/system/system_time +api-reference/system/log +api-reference/system/soc_caps +api-reference/system/internal-unstable +api-reference/system/app_image_format +api-reference/system/freertos_additions +api-reference/system/himem +api-reference/system/power_management +api-reference/system/mem_alloc +api-reference/system/wdts +api-reference/system/misc_system_api +api-reference/system/inc +api-reference/system/inc/show-efuse-table_ESP32-C6 +api-reference/system/inc/power_management_esp32s2_and_later +api-reference/system/inc/espefuse_summary_ESP32-C6 +api-reference/system/heap_debug +api-reference/system/ipc +api-reference/system/esp_https_ota +api-reference/system/ulp-risc-v +api-reference/system/esp_err +api-reference/system/console +api-reference/system/intr_alloc +api-reference/system/index +api-reference/system/pthread +api-reference/bluetooth +api-reference/bluetooth/esp_spp +api-reference/bluetooth/esp_l2cap_bt +api-reference/bluetooth/esp_hidd +api-reference/bluetooth/esp_avrc +api-reference/bluetooth/controller_vhci +api-reference/bluetooth/esp_bt_defs +api-reference/bluetooth/esp_hf_ag +api-reference/bluetooth/esp_bt_main +api-reference/bluetooth/esp_bt_device +api-reference/bluetooth/esp_gatts +api-reference/bluetooth/esp_gattc +api-reference/bluetooth/esp_sdp +api-reference/bluetooth/bt_common +api-reference/bluetooth/nimble +api-reference/bluetooth/nimble/index +api-reference/bluetooth/esp_hf_client +api-reference/bluetooth/esp_a2dp +api-reference/bluetooth/esp_blufi +api-reference/bluetooth/bt_le +api-reference/bluetooth/esp_hf_defs +api-reference/bluetooth/esp_gap_bt +api-reference/bluetooth/esp_gatt_defs +api-reference/bluetooth/esp-ble-mesh +api-reference/bluetooth/index +api-reference/bluetooth/esp_gap_ble +api-reference/bluetooth/classic_bt +api-reference/error-codes +api-reference/index +api-reference/protocols +api-reference/protocols/icmp_echo +api-reference/protocols/esp_serial_slave_link +api-reference/protocols/mqtt +api-reference/protocols/mbedtls +api-reference/protocols/esp_http_server +api-reference/protocols/esp_sdio_slave_protocol +api-reference/protocols/esp_local_ctrl +api-reference/protocols/esp_crt_bundle +api-reference/protocols/esp_http_client +api-reference/protocols/esp_https_server +api-reference/protocols/esp_spi_slave_protocol +api-reference/protocols/modbus +api-reference/protocols/esp_tls +api-reference/protocols/mdns +api-reference/protocols/index +api-reference/protocols/asio +security +security/flash-encryption +security/secure-boot-v2 +security/secure-boot-v1 +about +resources +migration-guides +migration-guides/release-5.x +migration-guides/release-5.x/bluetooth-classic +migration-guides/release-5.x/gcc +migration-guides/release-5.x/bluetooth-low-energy +migration-guides/release-5.x/removed-components +migration-guides/release-5.x/protocols +migration-guides/release-5.x/networking +migration-guides/release-5.x/provisioning +migration-guides/release-5.x/build-system +migration-guides/release-5.x/storage +migration-guides/release-5.x/index +migration-guides/release-5.x/system +migration-guides/release-5.x/tools +migration-guides/release-5.x/peripherals +migration-guides/index +_templates +_templates/layout.html +get-started +get-started/establish-serial-connection +get-started/linux-macos-setup +get-started/linux-macos-start-project +get-started/windows-setup +get-started/start-project +get-started/flashing-troubleshooting +get-started/windows-start-project +get-started/index +get-started/windows-setup-update +404 +index diff --git a/docs/doxygen/Doxyfile_esp32c6 b/docs/doxygen/Doxyfile_esp32c6 new file mode 100644 index 0000000000..e6bd60cf79 --- /dev/null +++ b/docs/doxygen/Doxyfile_esp32c6 @@ -0,0 +1,20 @@ +INPUT += \ + $(PROJECT_PATH)/components/driver/include/driver/i2s_common.h \ + $(PROJECT_PATH)/components/driver/include/driver/i2s_pdm.h \ + $(PROJECT_PATH)/components/driver/include/driver/i2s_std.h \ + $(PROJECT_PATH)/components/driver/include/driver/i2s_tdm.h \ + $(PROJECT_PATH)/components/driver/include/driver/i2s_types.h \ + $(PROJECT_PATH)/components/driver/include/driver/rmt_common.h \ + $(PROJECT_PATH)/components/driver/include/driver/rmt_encoder.h \ + $(PROJECT_PATH)/components/driver/include/driver/rmt_rx.h \ + $(PROJECT_PATH)/components/driver/include/driver/rmt_tx.h \ + $(PROJECT_PATH)/components/driver/include/driver/rmt_types.h \ + $(PROJECT_PATH)/components/driver/include/driver/temperature_sensor.h \ + $(PROJECT_PATH)/components/esp_hw_support/include/soc/esp32c6/esp_ds.h \ + $(PROJECT_PATH)/components/esp_hw_support/include/soc/esp32c6/esp_hmac.h \ + $(PROJECT_PATH)/components/hal/include/hal/i2s_types.h \ + $(PROJECT_PATH)/components/hal/include/hal/rmt_types.h \ + $(PROJECT_PATH)/components/ulp/ulp_riscv/include/ulp_riscv_lock.h \ + $(PROJECT_PATH)/components/ulp/ulp_riscv/shared/include/ulp_riscv_lock_shared.h \ + $(PROJECT_PATH)/components/driver/include/driver/pulse_cnt.h \ + $(PROJECT_PATH)/components/hal/include/hal/pcnt_types.h \ diff --git a/docs/en/api-guides/index.rst b/docs/en/api-guides/index.rst index ef0891f243..620435020b 100644 --- a/docs/en/api-guides/index.rst +++ b/docs/en/api-guides/index.rst @@ -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 diff --git a/docs/en/api-guides/jtag-debugging/esp32c6.inc b/docs/en/api-guides/jtag-debugging/esp32c6.inc new file mode 100644 index 0000000000..563b64b939 --- /dev/null +++ b/docs/en/api-guides/jtag-debugging/esp32c6.inc @@ -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" + +--- + +.. 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. + +--- diff --git a/docs/en/api-guides/partition-tables.rst b/docs/en/api-guides/partition-tables.rst index 0fb17fbeb9..0847768b0c 100644 --- a/docs/en/api-guides/partition-tables.rst +++ b/docs/en/api-guides/partition-tables.rst @@ -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. diff --git a/docs/en/api-guides/usb-serial-jtag-console.rst b/docs/en/api-guides/usb-serial-jtag-console.rst index 6d64aa4547..a6fa0956bd 100644 --- a/docs/en/api-guides/usb-serial-jtag-console.rst +++ b/docs/en/api-guides/usb-serial-jtag-console.rst @@ -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: diff --git a/docs/en/api-reference/peripherals/index.rst b/docs/en/api-reference/peripherals/index.rst index 1acaff26f6..ec8e0c13e6 100644 --- a/docs/en/api-reference/peripherals/index.rst +++ b/docs/en/api-reference/peripherals/index.rst @@ -6,9 +6,9 @@ Peripherals API .. toctree:: :maxdepth: 1 - adc_oneshot + :SOC_ADC_SUPPORTED: adc_oneshot :SOC_ADC_DMA_SUPPORTED: adc_continuous - adc_calibration + :SOC_ADC_SUPPORTED: adc_calibration clk_tree :SOC_DAC_SUPPORTED: dac gpio diff --git a/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst new file mode 100644 index 0000000000..7d58c58d57 --- /dev/null +++ b/docs/en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst @@ -0,0 +1,3 @@ +.. code-block:: none + + TO BE UPDATED IDF-5919 \ No newline at end of file diff --git a/docs/en/api-reference/system/inc/show-efuse-table_ESP32-C6.rst b/docs/en/api-reference/system/inc/show-efuse-table_ESP32-C6.rst new file mode 100644 index 0000000000..af20255cc9 --- /dev/null +++ b/docs/en/api-reference/system/inc/show-efuse-table_ESP32-C6.rst @@ -0,0 +1,4 @@ + +.. code-block:: none + + TO BE UPDATED IDF-5919 \ No newline at end of file diff --git a/docs/en/security/esp32c6_log.inc b/docs/en/security/esp32c6_log.inc new file mode 100644 index 0000000000..53eb89084e --- /dev/null +++ b/docs/en/security/esp32c6_log.inc @@ -0,0 +1,13 @@ + +.. first_boot_enc + +TO BE UPDATED TODO IDF-5932 + +------ + +.. already_en_enc + + +TO BE UPDATED TODO IDF-5932 + +------ diff --git a/docs/zh_CN/api-guides/index.rst b/docs/zh_CN/api-guides/index.rst index 31c1530961..6f12f705c1 100644 --- a/docs/zh_CN/api-guides/index.rst +++ b/docs/zh_CN/api-guides/index.rst @@ -30,7 +30,7 @@ API 指南 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 diff --git a/docs/zh_CN/api-guides/jtag-debugging/esp32c6.inc b/docs/zh_CN/api-guides/jtag-debugging/esp32c6.inc new file mode 100644 index 0000000000..563b64b939 --- /dev/null +++ b/docs/zh_CN/api-guides/jtag-debugging/esp32c6.inc @@ -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" + +--- + +.. 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. + +--- diff --git a/docs/zh_CN/api-guides/partition-tables.rst b/docs/zh_CN/api-guides/partition-tables.rst index ee5db60474..6a1902da3f 100644 --- a/docs/zh_CN/api-guides/partition-tables.rst +++ b/docs/zh_CN/api-guides/partition-tables.rst @@ -88,7 +88,7 @@ Type 字段可以指定为 app (0x00) 或者 data (0x01)，也可以直接使用 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)"} SubType 字段长度为 8 bit，内容与具体分区 Type 有关。目前，esp-idf 仅仅规定了 “app” 和 “data” 两种分区类型的子类型含义。 diff --git a/docs/zh_CN/api-reference/peripherals/index.rst b/docs/zh_CN/api-reference/peripherals/index.rst index f388a2dd69..bc68e2f6b9 100644 --- a/docs/zh_CN/api-reference/peripherals/index.rst +++ b/docs/zh_CN/api-reference/peripherals/index.rst @@ -6,9 +6,9 @@ .. toctree:: :maxdepth: 1 - adc_oneshot + :SOC_ADC_SUPPORTED: adc_oneshot :SOC_ADC_DMA_SUPPORTED: adc_continuous - adc_calibration + :SOC_ADC_SUPPORTED: adc_calibration clk_tree :SOC_DAC_SUPPORTED: dac gpio diff --git a/docs/zh_CN/api-reference/system/inc/espefuse_summary_ESP32-C6.rst b/docs/zh_CN/api-reference/system/inc/espefuse_summary_ESP32-C6.rst new file mode 100644 index 0000000000..a09a6b7ca1 --- /dev/null +++ b/docs/zh_CN/api-reference/system/inc/espefuse_summary_ESP32-C6.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/inc/espefuse_summary_ESP32-C6.rst \ No newline at end of file diff --git a/docs/zh_CN/api-reference/system/inc/show-efuse-table_ESP32-C6.rst b/docs/zh_CN/api-reference/system/inc/show-efuse-table_ESP32-C6.rst new file mode 100644 index 0000000000..991c752a99 --- /dev/null +++ b/docs/zh_CN/api-reference/system/inc/show-efuse-table_ESP32-C6.rst @@ -0,0 +1 @@ +.. include:: ../../../en/api-reference/system/inc/show-efuse-table_ESP32-C6.rst diff --git a/docs/zh_CN/security/esp32c6_log.inc b/docs/zh_CN/security/esp32c6_log.inc new file mode 100644 index 0000000000..53eb89084e --- /dev/null +++ b/docs/zh_CN/security/esp32c6_log.inc @@ -0,0 +1,13 @@ + +.. first_boot_enc + +TO BE UPDATED TODO IDF-5932 + +------ + +.. already_en_enc + + +TO BE UPDATED TODO IDF-5932 + +------ diff --git a/examples/wifi/iperf/sdkconfig.defaults.esp32c6 b/examples/wifi/iperf/sdkconfig.defaults.esp32c6 new file mode 100644 index 0000000000..d80cbcd798 --- /dev/null +++ b/examples/wifi/iperf/sdkconfig.defaults.esp32c6 @@ -0,0 +1,4 @@ +# +# ESP32-C6 +# +# To be updated when wifi bringup is done IDF-5679