Merge branch 'docs/fatal_errors_c6_h2' into 'master'

docs: update misc system docs for C6/H2

Closes IDF-5920, IDF-6692, IDF-5928, IDF-6684, IDF-5927, and IDF-6685

See merge request espressif/esp-idf!22105
pull/9842/merge
Marius Vikhammer 2023-01-31 09:57:50 +08:00
commit 4c4a0a9427
6 zmienionych plików z 12 dodań i 89 usunięć

Wyświetl plik

@ -1,60 +1,28 @@
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/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/unit-tests
api-guides/deep-sleep-stub
api-guides/blufi
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
api-reference
@ -129,7 +97,6 @@ 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

Wyświetl plik

@ -7,8 +7,6 @@ contribute/style-guide
contribute/copyright-guide
contribute/install-pre-commit-hook
contribute/index
api-guides/core_dump_internals
api-guides/event-handling
api-guides/performance/speed
api-guides/performance/size
api-guides/performance/ram-usage
@ -26,54 +24,25 @@ api-guides/jtag-debugging/index
api-guides/jtag-debugging/esp32.inc
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/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-tools-notes.inc
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/cplusplus
api-guides/SYSVIEW_FreeRTOS.txt
api-guides/build-system
api-guides/freertos-smp
api-guides/core_dump
api-guides/inc/linux-host-requirements
api-guides/dfu
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/host-apps
api-guides/index
api-guides/openthread
api-guides/fatal-errors
api-guides/memory-types
api-guides/general-notes
third-party-tools/platformio
@ -184,7 +153,6 @@ 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/esp_spp

Wyświetl plik

@ -17,7 +17,7 @@ In certain situations, execution of the program can not be continued in a well d
- :doc:`Interrupt watchdog <../api-reference/system/wdts>` timeout
- :doc:`Task watchdog <../api-reference/system/wdts>` timeout (only fatal if :ref:`CONFIG_ESP_TASK_WDT_PANIC` is set)
- Cache access error
:CONFIG_ESP_SYSTEM_MEMPROT_FEATURE: - Memory protection fault
:SOC_MEMPROT_SUPPORTED: - Memory protection fault
- Brownout detection event
- Stack overflow
- Stack smashing protection check
@ -285,20 +285,14 @@ The GDB prompt can be used to inspect CPU registers, local and static variables,
RTC Watchdog Timeout
--------------------
{IDF_TARGET_RTCWDT_RTC_RESET:default="Not updated", esp32="RTCWDT_RTC_RESET", esp32s2="RTCWDT_RTC_RST", esp32s3="RTCWDT_RTC_RST", esp32c3="RTCWDT_RTC_RST", esp32c2="RTCWDT_RTC_RST", esp32c6="LP_WDT_SYS", esp32h2="LP_WDT_SYS"}
The RTC watchdog is used in the startup code to keep track of execution time and it also helps to prevent a lock-up caused by an unstable power source. It is enabled by default (see :ref:`CONFIG_BOOTLOADER_WDT_ENABLE`). If the execution time is exceeded, the RTC watchdog will restart the system. In this case, the ROM bootloader will print a message with the ``RTC Watchdog Timeout`` reason for the reboot.
.. only:: esp32
::
::
rst:0x10 ({IDF_TARGET_RTCWDT_RTC_RESET})
rst:0x10 (RTCWDT_RTC_RESET)
.. only:: not esp32
::
rst:0x10 (RTCWDT_RTC_RST)
The RTC watchdog covers the execution time from the first stage bootloader (ROM bootloader) to application startup. It is initially set in the ROM bootloader, then configured in the bootloader with the :ref:`CONFIG_BOOTLOADER_WDT_TIME_MS` option (9000 ms by default). During the application initialization stage, it is reconfigured because the source of the slow clock may have changed, and finally disabled right before the ``app_main()`` call. There is an option :ref:`CONFIG_BOOTLOADER_WDT_DISABLE_IN_USER_CODE` which prevents the RTC watchdog from being disabled before ``app_main``. Instead, the RTC watchdog remains active and must be fed periodically in your application's code.
@ -405,7 +399,7 @@ Indicates that an interrupt watchdog timeout has occurred. See :doc:`Watchdogs <
In some situations, ESP-IDF will temporarily disable access to external SPI Flash and SPI RAM via caches. For example, this happens when spi_flash APIs are used to read/write/erase/mmap regions of SPI Flash. In these situations, tasks are suspended, and interrupt handlers not registered with ``ESP_INTR_FLAG_IRAM`` are disabled. Make sure that any interrupt handlers registered with this flag have all the code and data in IRAM/DRAM. Refer to the :ref:`SPI flash API documentation <iram-safe-interrupt-handlers>` for more details.
.. only:: CONFIG_ESP_SYSTEM_MEMPROT_FEATURE
.. only:: SOC_MEMPROT_SUPPORTED
Memory protection fault
^^^^^^^^^^^^^^^^^^^^^^^

Wyświetl plik

@ -8,7 +8,7 @@ The IDF Clang Tidy is a tool that uses `clang-tidy <https://clang.llvm.org/extra
This functionality and the toolchain it relies on are still under development. There may be breaking changes before a final release.
.. only:: esp32c3 or esp32h4
.. only:: CONFIG_IDF_TARGET_ARCH_RISCV
.. warning::

Wyświetl plik

@ -16,7 +16,7 @@ Overview
The {IDF_TARGET_NAME} has two cores, with 32 interrupts. Each interrupt has a certain priority level, most (but not all) interrupts are connected to the interrupt mux.
.. only:: esp32c3 or esp32c2
.. only:: esp32c2 or esp32c3 or esp32c6 or esp32h2
The {IDF_TARGET_NAME} has one core, with 31 interrupts. Each interrupt has a programmable priority level.

Wyświetl plik

@ -17,7 +17,7 @@
- :doc:`中断看门狗 <../api-reference/system/wdts>` 超时
- :doc:`任务看门狗 <../api-reference/system/wdts>` 超时(只有开启 :ref:`CONFIG_ESP_TASK_WDT_PANIC` 后才会触发严重错误)
- 高速缓存访问错误
:CONFIG_ESP_SYSTEM_MEMPROT_FEATURE: - 内存保护故障
:SOC_MEMPROT_SUPPORTED: - 内存保护故障
- 掉电检测事件
- 堆栈溢出
- 堆栈粉碎保护检查
@ -285,20 +285,14 @@ GDB Stub
RTC 看门狗超时
----------------
{IDF_TARGET_RTCWDT_RTC_RESET:default="Not updated", esp32="RTCWDT_RTC_RESET", esp32s2="RTCWDT_RTC_RST", esp32s3="RTCWDT_RTC_RST", esp32c3="RTCWDT_RTC_RST", esp32c2="RTCWDT_RTC_RST", esp32c6="LP_WDT_SYS", esp32h2="LP_WDT_SYS"}
RTC 看门狗在启动代码中用于跟踪执行时间也有助于防止由于电源不稳定引起的锁定。RTC 看门狗默认启用,参见 :ref:`CONFIG_BOOTLOADER_WDT_ENABLE`。如果执行时间超时RTC 看门狗将自动重启系统。此时ROM 引导加载程序将打印消息 ``RTC Watchdog Timeout`` 说明重启原因。
.. only:: esp32
::
::
rst:0x10 ({IDF_TARGET_RTCWDT_RTC_RESET})
rst:0x10 (RTCWDT_RTC_RESET)
.. only:: not esp32
::
rst:0x10 (RTCWDT_RTC_RST)
RTC 看门狗涵盖了从一级引导程序ROM 引导程序)到应用程序启动的执行时间,最初在 ROM 引导程序中设置,而后在引导程序中使用 :ref:`CONFIG_BOOTLOADER_WDT_TIME_MS` 选项进行配置(默认 9000 ms。在应用初始化阶段由于慢速时钟源可能已更改RTC 看门狗将被重新配置,最后在调用 ``app_main()`` 之前被禁用。可以使用选项 :ref:`CONFIG_BOOTLOADER_WDT_DISABLE_IN_USER_CODE` 以保证 RTC 看门狗在调用 ``app_main`` 之前不被禁用,而是保持运行状态,用户需要在应用代码中定期“喂狗”。
@ -405,7 +399,7 @@ Interrupt wdt timeout on CPU0 / CPU1
在某些情况下ESP-IDF 会暂时禁止通过高速缓存访问外部 SPI flash 和 SPI RAM例如在使用 spi_flash API 读取/写入/擦除/映射 SPI flash 的时候。在这些情况下,任务会被挂起,并且未使用 ``ESP_INTR_FLAG_IRAM`` 注册的中断处理程序会被禁用。请确保任何使用此标志注册的中断处理程序所访问的代码和数据分别位于 IRAM 和 DRAM 中。更多详细信息请参阅 :ref:`SPI flash API 文档 <iram-safe-interrupt-handlers>`
.. only:: CONFIG_ESP_SYSTEM_MEMPROT_FEATURE
.. only:: SOC_MEMPROT_SUPPORTED
Memory protection fault
^^^^^^^^^^^^^^^^^^^^^^^