esp-idf/components/espcoredump/Kconfig
Omar Chebib 5186a968be 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-06-23 16:17:15 +08:00

108 lines
3.9 KiB
Plaintext

menu "Core dump"
choice ESP_COREDUMP_TO_FLASH_OR_UART
prompt "Data destination"
default ESP_COREDUMP_ENABLE_TO_NONE
help
Select place to store core dump: flash, uart or none (to disable core dumps generation).
Core dumps to Flash are not available if PSRAM is used for task stacks.
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.
config ESP_COREDUMP_ENABLE_TO_FLASH
bool "Flash"
depends on !SPIRAM_ALLOW_STACK_EXTERNAL_MEMORY
select ESP_COREDUMP_ENABLE
config ESP_COREDUMP_ENABLE_TO_UART
bool "UART"
select ESP_COREDUMP_ENABLE
config ESP_COREDUMP_ENABLE_TO_NONE
bool "None"
endchoice
choice ESP_COREDUMP_DATA_FORMAT
prompt "Core dump data format"
default ESP_COREDUMP_DATA_FORMAT_ELF
depends on !ESP_COREDUMP_ENABLE_TO_NONE
help
Select the data format for core dump.
config ESP_COREDUMP_DATA_FORMAT_BIN
bool "Binary format"
config ESP_COREDUMP_DATA_FORMAT_ELF
bool "ELF format"
endchoice
choice ESP_COREDUMP_CHECKSUM
prompt "Core dump data integrity check"
default ESP_COREDUMP_CHECKSUM_CRC32
depends on !ESP_COREDUMP_ENABLE_TO_NONE
help
Select the integrity check for the core dump.
config ESP_COREDUMP_CHECKSUM_CRC32
bool "Use CRC32 for integrity verification"
config ESP_COREDUMP_CHECKSUM_SHA256
bool "Use SHA256 for integrity verification"
depends on ESP_COREDUMP_DATA_FORMAT_ELF && IDF_TARGET_ESP32
endchoice
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.
config ESP_COREDUMP_ENABLE
bool
default F
help
Enables/disable core dump module.
config ESP_COREDUMP_MAX_TASKS_NUM
int "Maximum number of tasks"
depends on ESP_COREDUMP_ENABLE
default 64
help
Maximum number of tasks snapshots in core dump.
config ESP_COREDUMP_UART_DELAY
int "Delay before print to UART"
depends on ESP_COREDUMP_ENABLE_TO_UART
default 0
help
Config delay (in ms) before printing core dump to UART.
Delay can be interrupted by pressing Enter key.
config ESP_COREDUMP_STACK_SIZE
int "Reserved stack size"
depends on ESP_COREDUMP_ENABLE
# Temporarily disable this feature on Xtensa boards as switching stack
# pointer triggers an exception (IDF-2797)
depends on IDF_TARGET_ARCH_RISCV
default 0
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.
To ensure that core dump itself will not overflow task/ISR stack set this to the value above 800.
NOTE: It eats DRAM.
choice ESP_COREDUMP_DECODE
prompt "Handling of UART core dumps in IDF Monitor"
depends on ESP_COREDUMP_ENABLE_TO_UART
config ESP_COREDUMP_DECODE_INFO
bool "Decode and show summary (info_corefile)"
config ESP_COREDUMP_DECODE_DISABLE
bool "Don't decode"
endchoice
config ESP_COREDUMP_DECODE
string
default "disable" if ESP_COREDUMP_DECODE_DISABLE
default "info" if ESP_COREDUMP_DECODE_INFO
endmenu