docs: update misc docs for C6 and H2

This commit is contained in:
Marius Vikhammer
2023-02-15 17:27:31 +08:00
parent 113132e4f4
commit b67c822d10
5 changed files with 12 additions and 69 deletions

View File

@@ -1,17 +1,12 @@
api-guides
api-guides/performance api-guides/performance
api-guides/performance/speed api-guides/performance/speed
api-guides/performance/size api-guides/performance/size
api-guides/performance/ram-usage api-guides/performance/ram-usage
api-guides/performance/index api-guides/performance/index
api-guides/partition-tables
api-guides/startup
api-guides/blufi api-guides/blufi
api-guides/coexist api-guides/coexist
api-guides/usb-serial-jtag-console api-guides/usb-serial-jtag-console
api-guides/wifi api-guides/wifi
api-guides/usb-otg-console
api-guides/wireshark-user-guide
api-guides/esp-wifi-mesh api-guides/esp-wifi-mesh
api-guides/dfu api-guides/dfu
api-guides/esp-ble-mesh api-guides/esp-ble-mesh
@@ -21,14 +16,7 @@ api-guides/esp-ble-mesh/ble-mesh-terminology
api-guides/esp-ble-mesh/ble-mesh-architecture api-guides/esp-ble-mesh/ble-mesh-architecture
api-guides/esp-ble-mesh/ble-mesh-faq api-guides/esp-ble-mesh/ble-mesh-faq
api-guides/wifi-security api-guides/wifi-security
api-guides/index
api-guides/openthread api-guides/openthread
api-guides/memory-types
api-guides/general-notes
api-reference
api-reference/api-conventions
api-reference/template
api-reference/storage
api-reference/storage/vfs api-reference/storage/vfs
api-reference/storage/spiffs api-reference/storage/spiffs
api-reference/storage/wear-levelling api-reference/storage/wear-levelling
@@ -42,18 +30,9 @@ api-reference/storage/nvs_flash
api-reference/storage/sdmmc api-reference/storage/sdmmc
api-reference/storage/mass_mfg api-reference/storage/mass_mfg
api-reference/storage/index api-reference/storage/index
api-reference/peripherals
api-reference/peripherals/usb_host
api-reference/peripherals/usb_device
api-reference/peripherals/dac
api-reference/peripherals/touch_element
api-reference/peripherals/secure_element
api-reference/peripherals/sdio_slave api-reference/peripherals/sdio_slave
api-reference/peripherals/touch_pad
api-reference/peripherals/adc_calibration api-reference/peripherals/adc_calibration
api-reference/peripherals/index
api-reference/peripherals/sdmmc_host api-reference/peripherals/sdmmc_host
api-reference/kconfig
api-reference/network api-reference/network
api-reference/network/esp_openthread api-reference/network/esp_openthread
api-reference/network/esp_dpp api-reference/network/esp_dpp
@@ -62,28 +41,16 @@ api-reference/network/esp-wifi-mesh
api-reference/network/esp_smartconfig api-reference/network/esp_smartconfig
api-reference/network/esp_wifi api-reference/network/esp_wifi
api-reference/network/index api-reference/network/index
api-reference/system
api-reference/system/sleep_modes api-reference/system/sleep_modes
api-reference/system/ulp_macros api-reference/system/ulp_macros
api-reference/system/perfmon
api-reference/system/ulp api-reference/system/ulp
api-reference/system/efuse api-reference/system/efuse
api-reference/system/ulp_instruction_set api-reference/system/ulp_instruction_set
api-reference/system/async_memcpy
api-reference/system/random
api-reference/system/soc_caps
api-reference/system/internal-unstable
api-reference/system/himem
api-reference/system/power_management api-reference/system/power_management
api-reference/system/inc
api-reference/system/inc/show-efuse-table_ESP32-C6 api-reference/system/inc/show-efuse-table_ESP32-C6
api-reference/system/inc/power_management_esp32s2_and_later api-reference/system/inc/power_management_esp32s2_and_later
api-reference/system/inc/espefuse_summary_ESP32-C6 api-reference/system/inc/espefuse_summary_ESP32-C6
api-reference/system/heap_debug
api-reference/system/ulp-risc-v api-reference/system/ulp-risc-v
api-reference/system/esp_err
api-reference/system/console
api-reference/system/index
api-reference/bluetooth api-reference/bluetooth
api-reference/bluetooth/esp_spp api-reference/bluetooth/esp_spp
api-reference/bluetooth/esp_l2cap_bt api-reference/bluetooth/esp_l2cap_bt
@@ -111,9 +78,6 @@ api-reference/bluetooth/esp-ble-mesh
api-reference/bluetooth/index api-reference/bluetooth/index
api-reference/bluetooth/esp_gap_ble api-reference/bluetooth/esp_gap_ble
api-reference/bluetooth/classic_bt api-reference/bluetooth/classic_bt
api-reference/error-codes
api-reference/index
api-reference/protocols
api-reference/protocols/esp_serial_slave_link api-reference/protocols/esp_serial_slave_link
api-reference/protocols/esp_spi_slave_protocol api-reference/protocols/esp_spi_slave_protocol
api-reference/protocols/index api-reference/protocols/index

View File

@@ -11,14 +11,10 @@ api-guides/performance/speed
api-guides/performance/size api-guides/performance/size
api-guides/performance/ram-usage api-guides/performance/ram-usage
api-guides/performance/index api-guides/performance/index
api-guides/partition-tables
api-guides/startup
api-guides/RF_calibration api-guides/RF_calibration
api-guides/blufi api-guides/blufi
api-guides/coexist api-guides/coexist
api-guides/wifi api-guides/wifi
api-guides/usb-otg-console
api-guides/wireshark-user-guide
api-guides/esp-wifi-mesh api-guides/esp-wifi-mesh
api-guides/cplusplus api-guides/cplusplus
api-guides/dfu api-guides/dfu
@@ -30,16 +26,12 @@ api-guides/esp-ble-mesh/ble-mesh-faq
api-guides/wifi-security api-guides/wifi-security
api-guides/index api-guides/index
api-guides/openthread api-guides/openthread
api-guides/memory-types
api-guides/general-notes
third-party-tools/platformio third-party-tools/platformio
COPYRIGHT COPYRIGHT
libraries-and-frameworks/libs-frameworks libraries-and-frameworks/libs-frameworks
libraries-and-frameworks/index libraries-and-frameworks/index
libraries-and-frameworks/cloud-frameworks libraries-and-frameworks/cloud-frameworks
versions versions
api-reference/api-conventions
api-reference/template
api-reference/provisioning/protocomm api-reference/provisioning/protocomm
api-reference/provisioning/provisioning api-reference/provisioning/provisioning
api-reference/provisioning/index api-reference/provisioning/index
@@ -62,10 +54,7 @@ api-reference/peripherals/usb_host
api-reference/peripherals/twai api-reference/peripherals/twai
api-reference/peripherals/usb_device api-reference/peripherals/usb_device
api-reference/peripherals/sdspi_host api-reference/peripherals/sdspi_host
api-reference/peripherals/dac
api-reference/peripherals/i2s api-reference/peripherals/i2s
api-reference/peripherals/touch_element
api-reference/peripherals/secure_element
api-reference/peripherals/temp_sensor api-reference/peripherals/temp_sensor
api-reference/peripherals/spi_features api-reference/peripherals/spi_features
api-reference/peripherals/sdio_slave api-reference/peripherals/sdio_slave
@@ -76,14 +65,12 @@ api-reference/peripherals/spi_flash/spi_flash_override_driver
api-reference/peripherals/spi_flash/spi_flash_optional_feature api-reference/peripherals/spi_flash/spi_flash_optional_feature
api-reference/peripherals/spi_flash/index api-reference/peripherals/spi_flash/index
api-reference/peripherals/spi_flash/auto_suspend.inc api-reference/peripherals/spi_flash/auto_suspend.inc
api-reference/peripherals/touch_pad
api-reference/peripherals/adc_calibration api-reference/peripherals/adc_calibration
api-reference/peripherals/i2c api-reference/peripherals/i2c
api-reference/peripherals/dedic_gpio api-reference/peripherals/dedic_gpio
api-reference/peripherals/sd_pullup_requirements api-reference/peripherals/sd_pullup_requirements
api-reference/peripherals/index api-reference/peripherals/index
api-reference/peripherals/sdmmc_host api-reference/peripherals/sdmmc_host
api-reference/kconfig
api-reference/network/esp_openthread api-reference/network/esp_openthread
api-reference/network/esp_eth api-reference/network/esp_eth
api-reference/network/esp_netif_driver api-reference/network/esp_netif_driver
@@ -95,18 +82,10 @@ api-reference/network/esp_wifi
api-reference/network/index api-reference/network/index
api-reference/network/esp_netif api-reference/network/esp_netif
api-reference/system/sleep_modes api-reference/system/sleep_modes
api-reference/system/ulp_macros
api-reference/system/perfmon
api-reference/system/ulp
api-reference/system/efuse api-reference/system/efuse
api-reference/system/chip_revision api-reference/system/chip_revision
api-reference/system/ulp_instruction_set
api-reference/system/random
api-reference/system/esp_timer api-reference/system/esp_timer
api-reference/system/system_time api-reference/system/system_time
api-reference/system/soc_caps
api-reference/system/internal-unstable
api-reference/system/himem
api-reference/system/power_management api-reference/system/power_management
api-reference/system/wdts api-reference/system/wdts
api-reference/system/inc/power_management_esp32 api-reference/system/inc/power_management_esp32
@@ -114,11 +93,6 @@ api-reference/system/inc/espefuse_summary_ESP32-H2
api-reference/system/inc/revisions_ESP32-H2 api-reference/system/inc/revisions_ESP32-H2
api-reference/system/inc/show-efuse-table_ESP32-H2 api-reference/system/inc/show-efuse-table_ESP32-H2
api-reference/system/inc/power_management_esp32s2_and_later api-reference/system/inc/power_management_esp32s2_and_later
api-reference/system/heap_debug
api-reference/system/ulp-risc-v
api-reference/system/esp_err
api-reference/system/console
api-reference/system/index
api-reference/bluetooth/esp_spp api-reference/bluetooth/esp_spp
api-reference/bluetooth/esp_l2cap_bt api-reference/bluetooth/esp_l2cap_bt
api-reference/bluetooth/esp_hidd api-reference/bluetooth/esp_hidd
@@ -145,8 +119,6 @@ api-reference/bluetooth/esp-ble-mesh
api-reference/bluetooth/index api-reference/bluetooth/index
api-reference/bluetooth/esp_gap_ble api-reference/bluetooth/esp_gap_ble
api-reference/bluetooth/classic_bt api-reference/bluetooth/classic_bt
api-reference/error-codes
api-reference/index
api-reference/protocols/icmp_echo api-reference/protocols/icmp_echo
api-reference/protocols/esp_serial_slave_link api-reference/protocols/esp_serial_slave_link
api-reference/protocols/mqtt api-reference/protocols/mqtt

View File

@@ -164,6 +164,13 @@ The ``DRAM_ATTR`` attribute can be used to force constants from DROM into the :r
RTC FAST memory RTC FAST memory
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
.. only:: esp32c6 or esp32h2
.. note::
On {IDF_TARGET_NAME} what was previously referred to as RTC memory has been renamed LP (low power) memory. You might see both terms being used interchangeably in IDF code, docs and the technical reference manual.
The same region of RTC FAST memory can be accessed as both instruction and data memory. Code which has to run after wake-up from deep sleep mode has to be placed into RTC memory. Please check detailed description in :doc:`deep sleep <deep-sleep-stub>` documentation. The same region of RTC FAST memory can be accessed as both instruction and data memory. Code which has to run after wake-up from deep sleep mode has to be placed into RTC memory. Please check detailed description in :doc:`deep sleep <deep-sleep-stub>` documentation.
.. only:: esp32 .. only:: esp32

View File

@@ -35,7 +35,7 @@ Startup code called from the reset vector determines the boot mode by checking `
:SOC_RTC_MEM_SUPPORTED: #. Reset from deep sleep: if the value in ``RTC_CNTL_STORE6_REG`` is non-zero, and CRC value of RTC memory in ``RTC_CNTL_STORE7_REG`` is valid, use ``RTC_CNTL_STORE6_REG`` as an entry point address and jump immediately to it. If ``RTC_CNTL_STORE6_REG`` is zero, or ``RTC_CNTL_STORE7_REG`` contains invalid CRC, or once the code called via ``RTC_CNTL_STORE6_REG`` returns, proceed with boot as if it was a power-on reset. **Note**: to run customized code at this point, a deep sleep stub mechanism is provided. Please see :doc:`deep sleep <deep-sleep-stub>` documentation for this. :SOC_RTC_MEM_SUPPORTED: #. Reset from deep sleep: if the value in ``RTC_CNTL_STORE6_REG`` is non-zero, and CRC value of RTC memory in ``RTC_CNTL_STORE7_REG`` is valid, use ``RTC_CNTL_STORE6_REG`` as an entry point address and jump immediately to it. If ``RTC_CNTL_STORE6_REG`` is zero, or ``RTC_CNTL_STORE7_REG`` contains invalid CRC, or once the code called via ``RTC_CNTL_STORE6_REG`` returns, proceed with boot as if it was a power-on reset. **Note**: to run customized code at this point, a deep sleep stub mechanism is provided. Please see :doc:`deep sleep <deep-sleep-stub>` documentation for this.
#. For power-on reset, software SOC reset, and watchdog SOC reset: check the ``GPIO_STRAP_REG`` register if a custom boot mode (such as UART Download Mode) is requested. If this is the case, this custom loader mode is executed from ROM. Otherwise, proceed with boot as if it was due to software CPU reset. Consult {IDF_TARGET_NAME} datasheet for a description of SoC boot modes and how to execute them. #. For power-on reset, software SoC reset, and watchdog SoC reset: check the ``GPIO_STRAP_REG`` register if a custom boot mode (such as UART Download Mode) is requested. If this is the case, this custom loader mode is executed from ROM. Otherwise, proceed with boot as if it was due to software CPU reset. Consult {IDF_TARGET_NAME} datasheet for a description of SoC boot modes and how to execute them.
#. For software CPU reset and watchdog CPU reset: configure SPI flash based on EFUSE values, and attempt to load the code from flash. This step is described in more detail in the next paragraphs. #. For software CPU reset and watchdog CPU reset: configure SPI flash based on EFUSE values, and attempt to load the code from flash. This step is described in more detail in the next paragraphs.

View File

@@ -10,7 +10,9 @@ API 指南
:SOC_BT_SUPPORTED: blufi :SOC_BT_SUPPORTED: blufi
bootloader bootloader
build-system build-system
:SOC_SUPPORT_COEXISTENCE: coexist
core_dump core_dump
cplusplus
:SOC_RTC_MEM_SUPPORTED: deep-sleep-stub :SOC_RTC_MEM_SUPPORTED: deep-sleep-stub
:SOC_USB_OTG_SUPPORTED: dfu :SOC_USB_OTG_SUPPORTED: dfu
error-handling error-handling
@@ -18,6 +20,7 @@ API 指南
freertos-smp freertos-smp
:SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh :SOC_WIFI_MESH_SUPPORT: esp-wifi-mesh
event-handling event-handling
:SOC_SPIRAM_SUPPORTED: external-ram
fatal-errors fatal-errors
../security/flash-encryption ../security/flash-encryption
:esp32s3: flash_psram_config :esp32s3: flash_psram_config
@@ -30,11 +33,11 @@ API 指南
openthread openthread
partition-tables partition-tables
performance/index performance/index
reproducible-builds
:not esp32h2: RF_calibration :not esp32h2: RF_calibration
../security/security ../security/security
:esp32: ../security/secure-boot-v1 :esp32: ../security/secure-boot-v1
../security/secure-boot-v2 ../security/secure-boot-v2
:SOC_SPIRAM_SUPPORTED: external-ram
thread-local-storage thread-local-storage
tools/index tools/index
unit-tests unit-tests
@@ -43,6 +46,3 @@ API 指南
:SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console :SOC_USB_SERIAL_JTAG_SUPPORTED: usb-serial-jtag-console
:SOC_WIFI_SUPPORTED: wifi :SOC_WIFI_SUPPORTED: wifi
:SOC_WIFI_SUPPORTED: wifi-security :SOC_WIFI_SUPPORTED: wifi-security
:SOC_SUPPORT_COEXISTENCE: coexist
reproducible-builds
cplusplus