espressif/esp-idf
1
0
Fork 1
mirror of https://github.com/espressif/esp-idf.git synced 2025-11-04 00:51:42 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
20183e0770a1eb6b5f2724e3c77a96cfd3b1dd8c
esp-idf/components/espcoredump/Kconfig

155 lines
6.1 KiB
Plaintext
Raw Normal View History

coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
menu "Core dump"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
choice ESP_COREDUMP_TO_FLASH_OR_UART
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
prompt "Data destination"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
default ESP_COREDUMP_ENABLE_TO_NONE
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
help
Select place to store core dump: flash, uart or none (to disable core dumps generation).
core dump: don't allow core dumps to Flash if PSRAM is used for stacks It is not possible to write to Flash when the stack is located in PSRAM, and it is not possible to write PSRAM buffers into Flash when malloc can not be used.
2020-03-02 14:43:05 +01:00
Core dumps to Flash are not available if PSRAM is used for task stacks.
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
If core dump is configured to be stored in flash and custom partition table is used add
corresponding entry to your CSV. For examples, please see predefined partition table CSV descriptions
in the components/partition_table directory.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_ENABLE_TO_FLASH
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
bool "Flash"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
select ESP_COREDUMP_ENABLE
config ESP_COREDUMP_ENABLE_TO_UART
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
bool "UART"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
select ESP_COREDUMP_ENABLE
config ESP_COREDUMP_ENABLE_TO_NONE
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
bool "None"
endchoice
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
choice ESP_COREDUMP_DATA_FORMAT
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
prompt "Core dump data format"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
default ESP_COREDUMP_DATA_FORMAT_ELF
depends on !ESP_COREDUMP_ENABLE_TO_NONE
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
help
Select the data format for core dump.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_DATA_FORMAT_BIN
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
bool "Binary format"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_DATA_FORMAT_ELF
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
bool "ELF format"
endchoice
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
choice ESP_COREDUMP_CHECKSUM
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
prompt "Core dump data integrity check"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
default ESP_COREDUMP_CHECKSUM_CRC32
depends on !ESP_COREDUMP_ENABLE_TO_NONE
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
help
Select the integrity check for the core dump.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_CHECKSUM_CRC32
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
bool "Use CRC32 for integrity verification"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_CHECKSUM_SHA256
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
bool "Use SHA256 for integrity verification"
feat(coredump): use SHA ROM functions for all targets except ESP32 For ESP32, continue using mbedtls due to a required ROM patch for the SHA implementation. For other targets, we can now leverage the ROM functions.
2024-01-10 13:41:18 +01:00
depends on ESP_COREDUMP_DATA_FORMAT_ELF
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
endchoice
feat(coredump): save .bss, .data and .heap sections to the elf file
2024-03-11 21:19:17 +01:00
config ESP_COREDUMP_CAPTURE_DRAM
bool "Include whole .bss and .data sections and heap data into core dump file"
default n
#TODO: Heap walker api is not ready for the esp32c5 (IDF-9641)
depends on ESP_COREDUMP_DATA_FORMAT_ELF && !IDF_TARGET_ESP32C5
help
Storing these sections can help with easier debugging and troubleshooting.
However, additional storage space will be required in the core dump partition.
At least 128KB should be reserved, but the actual amount required may vary based
on the application's DRAM usage.
Note that sections located in external RAM will not be stored.
coredump: core dump data check can now be parametrized Core dump integrity check can now be parametrized through menuconfig. It can be performed on boot or ignored. When core dump is activated in the menuconfig, the user can still check the core dump at any time with the function `esp_core_dump_image_check()`. Fix a bug where `esp_core_dump_image_get()` was not accessible when core dump was disabled. Closes https://github.com/espressif/esp-idf/issues/6620
2021-03-03 19:39:04 +08:00
config ESP_COREDUMP_CHECK_BOOT
bool "Check core dump data integrity on boot"
default y
depends on ESP_COREDUMP_ENABLE_TO_FLASH
help
When enabled, if any data are found on the flash core dump partition,
they will be checked by calculating their checksum.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_ENABLE
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
bool
default F
help
Enables/disable core dump module.
Optionally disable logs in espcoredump component Early log strings used by this component are placed in DRAM. Disabling these logs saves ~5KB of internal memory Signed-off-by: Vikram <vikram.dattu@espressif.com>
2023-03-06 11:36:06 +05:30
config ESP_COREDUMP_LOGS
bool "Enable coredump logs for debugging"
depends on ESP_COREDUMP_ENABLE
default y
help
Enable/disable coredump logs. Logs strings from espcoredump component are
placed in DRAM. Disabling these helps to save ~5KB of internal memory.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_MAX_TASKS_NUM
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
int "Maximum number of tasks"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
depends on ESP_COREDUMP_ENABLE
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
default 64
help
Maximum number of tasks snapshots in core dump.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_UART_DELAY
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
int "Delay before print to UART"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
depends on ESP_COREDUMP_ENABLE_TO_UART
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
default 0
help
Config delay (in ms) before printing core dump to UART.
Delay can be interrupted by pressing Enter key.
espcoredump: Support for not overwriting existing core dump in flash If there's an unattended boot loop or a crash that causes another crash on the next boot, it needs to be possible to avoid overwriting a saved core dump with another core dump. Add an option to do this and skip writing core dumps if the partition isn't empty. Fixes #12027. Mergeshttps://github.com/espressif/esp-idf/pull/12105
2023-08-20 14:05:47 +01:00
config ESP_COREDUMP_FLASH_NO_OVERWRITE
bool "Don't overwrite existing core dump"
depends on ESP_COREDUMP_ENABLE_TO_FLASH
default n
help
Don't overwrite an existing core dump already present in flash.
Enable this option to only keep the first of multiple core dumps.
If enabled, the core dump partition must be erased before the first
core dump can be written.
coredump: add support for stacks in external RAM Tasks having their stacks in SPIRAM can now be part of the coredump written to flash
2022-11-11 14:47:58 +08:00
config ESP_COREDUMP_USE_STACK_SIZE
bool
default y if ESP_COREDUMP_ENABLE_TO_FLASH && SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY
default n
help
Force the use of a custom DRAM stack for coredump when Task stacks can be in PSRAM.
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_STACK_SIZE
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
int "Reserved stack size"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
depends on ESP_COREDUMP_ENABLE
coredump: add support for stacks in external RAM Tasks having their stacks in SPIRAM can now be part of the coredump written to flash
2022-11-11 14:47:58 +08:00
range 0 4096 if !ESP_COREDUMP_USE_STACK_SIZE
refactor(espcoredump): simplify uart/flash write flow
2024-02-27 15:42:09 +01:00
range 1792 4096 if ESP_COREDUMP_USE_STACK_SIZE
Coredump: add a test to check that coredump supports stacks in SPIRAM
2022-12-19 17:38:17 +01:00
default 0 if !ESP_COREDUMP_USE_STACK_SIZE
refactor(espcoredump): simplify uart/flash write flow
2024-02-27 15:42:09 +01:00
default 1792 if ESP_COREDUMP_USE_STACK_SIZE
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
help
Size of the memory to be reserved for core dump stack. If 0 core dump process will run on
the stack of crashed task/ISR, otherwise special stack will be allocated.
feat(coredump): save .bss, .data and .heap sections to the elf file
2024-03-11 21:19:17 +01:00
To ensure that core dump itself will not overflow task/ISR stack set this to the value around 1300-1800
depending on the chosen checksum calculation method. SHA256 method needs more stack space than CRC32.
coredump: change data format to ELF
2019-11-22 13:25:43 +08:00
NOTE: It eats DRAM.
coredump: Parse backtrace info for RISCV For RISCV, backtrace generation on device is not possible without including and parsing DWARF sections. We extract the crash task stack and let the host generate the backtrace
2021-05-05 17:03:22 +05:30
config ESP_COREDUMP_SUMMARY_STACKDUMP_SIZE
int "Size of the stack dump buffer"
depends on ESP_COREDUMP_DATA_FORMAT_ELF && ESP_COREDUMP_ENABLE_TO_FLASH && IDF_TARGET_ARCH_RISCV
range 512 4096
default 1024
help
Size of the buffer that would be reserved for extracting backtrace info summary.
This buffer will contain the stack dump of the crashed task. This dump is useful in generating backtrace
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
choice ESP_COREDUMP_DECODE
tools/idf_monitor: automatically decode UART core dumps This adds detection of UART core dumps to IDF monitor. By default, core dumps are not printed to the console, but are processed by espcoredump.py using 'info_corefile' command. The result is printed to stdout. This feature can be disabled in menuconfig. In the future this can be extended to allow running espcoredump.py with 'dbg_corefile' argument, which is similar to the current GDB Stub behavior. Related to IDF-52.
2020-02-06 19:29:50 +01:00
prompt "Handling of UART core dumps in IDF Monitor"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
depends on ESP_COREDUMP_ENABLE_TO_UART
config ESP_COREDUMP_DECODE_INFO
tools/idf_monitor: automatically decode UART core dumps This adds detection of UART core dumps to IDF monitor. By default, core dumps are not printed to the console, but are processed by espcoredump.py using 'info_corefile' command. The result is printed to stdout. This feature can be disabled in menuconfig. In the future this can be extended to allow running espcoredump.py with 'dbg_corefile' argument, which is similar to the current GDB Stub behavior. Related to IDF-52.
2020-02-06 19:29:50 +01:00
bool "Decode and show summary (info_corefile)"
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_DECODE_DISABLE
tools/idf_monitor: automatically decode UART core dumps This adds detection of UART core dumps to IDF monitor. By default, core dumps are not printed to the console, but are processed by espcoredump.py using 'info_corefile' command. The result is printed to stdout. This feature can be disabled in menuconfig. In the future this can be extended to allow running espcoredump.py with 'dbg_corefile' argument, which is similar to the current GDB Stub behavior. Related to IDF-52.
2020-02-06 19:29:50 +01:00
bool "Don't decode"
endchoice
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
config ESP_COREDUMP_DECODE
tools/idf_monitor: automatically decode UART core dumps This adds detection of UART core dumps to IDF monitor. By default, core dumps are not printed to the console, but are processed by espcoredump.py using 'info_corefile' command. The result is printed to stdout. This feature can be disabled in menuconfig. In the future this can be extended to allow running espcoredump.py with 'dbg_corefile' argument, which is similar to the current GDB Stub behavior. Related to IDF-52.
2020-02-06 19:29:50 +01:00
string
espcoredump: remove ESP32 prefix from config options - This component is applicable for ESP32 and ESP32-S2, hence the change - Backward compatibility is maintained using `sdkconfig.rename` file
2020-09-29 20:57:28 +05:30
default "disable" if ESP_COREDUMP_DECODE_DISABLE
default "info" if ESP_COREDUMP_DECODE_INFO
tools/idf_monitor: automatically decode UART core dumps This adds detection of UART core dumps to IDF monitor. By default, core dumps are not printed to the console, but are processed by espcoredump.py using 'info_corefile' command. The result is printed to stdout. This feature can be disabled in menuconfig. In the future this can be extended to allow running espcoredump.py with 'dbg_corefile' argument, which is similar to the current GDB Stub behavior. Related to IDF-52.
2020-02-06 19:29:50 +01:00
coredump: improvements refactoring Move existing core dump files into espcoredump component folder Add KConfig, linker.lf, make and CMakeList.txt for new component Existing functionality separated into core_dump_common, core_dump_flash, core_dump_uart Update test_core_dump.c and make files to link it as unit test Update according to review: Move target and RTOS related functionality into separated file (core_dump_port.c).
2019-01-29 15:49:56 +01:00
endmenu
Reference in New Issue Copy Permalink