Merge branch 'docs/psram_heap_integrity_int_wdt' into 'master'

heap: Added note to increase INT_WDT timeout for integrity-check APIs

See merge request espressif/esp-idf!20852
This commit is contained in:
Mahavir Jain
2022-10-31 15:40:49 +08:00

View File

@@ -252,6 +252,9 @@ void heap_caps_print_heap_info( uint32_t caps );
* *
* @param print_errors Print specific errors if heap corruption is found. * @param print_errors Print specific errors if heap corruption is found.
* *
* @note Please increase the value of `CONFIG_ESP_INT_WDT_TIMEOUT_MS` when using this API
* with PSRAM enabled.
*
* @return True if all heaps are valid, False if at least one heap is corrupt. * @return True if all heaps are valid, False if at least one heap is corrupt.
*/ */
bool heap_caps_check_integrity_all(bool print_errors); bool heap_caps_check_integrity_all(bool print_errors);
@@ -270,6 +273,9 @@ bool heap_caps_check_integrity_all(bool print_errors);
* of memory * of memory
* @param print_errors Print specific errors if heap corruption is found. * @param print_errors Print specific errors if heap corruption is found.
* *
* @note Please increase the value of `CONFIG_ESP_INT_WDT_TIMEOUT_MS` when using this API
* with PSRAM capability flag.
*
* @return True if all heaps are valid, False if at least one heap is corrupt. * @return True if all heaps are valid, False if at least one heap is corrupt.
*/ */
bool heap_caps_check_integrity(uint32_t caps, bool print_errors); bool heap_caps_check_integrity(uint32_t caps, bool print_errors);