diff --git a/components/heap/include/esp_heap_caps.h b/components/heap/include/esp_heap_caps.h index bd5e30a2f5..e5adf162b8 100644 --- a/components/heap/include/esp_heap_caps.h +++ b/components/heap/include/esp_heap_caps.h @@ -252,6 +252,9 @@ void heap_caps_print_heap_info( uint32_t caps ); * * @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. */ bool heap_caps_check_integrity_all(bool print_errors); @@ -270,6 +273,9 @@ bool heap_caps_check_integrity_all(bool print_errors); * of memory * @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. */ bool heap_caps_check_integrity(uint32_t caps, bool print_errors);