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

- When PSRAM is enabled, the heap integrity check APIs
  (`heap_caps_check_integrity` and `heap_caps_check_integrity_all`)
  take more time to execute and keep the interrupts disabled for a
  longer time.
pull/10092/head
Laukik Hase 2022-10-28 14:10:42 +05:30
rodzic 93e0434f40
commit d0b1b5a8aa
Nie znaleziono w bazie danych klucza dla tego podpisu
ID klucza GPG: 11C571361F51A199
1 zmienionych plików z 6 dodań i 0 usunięć

Wyświetl plik

@ -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);