alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-10-16 08:59:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

heap: add documentation about the function placement in IRAM and its usage in ISR

Browse Source 
This commits adds a internal.md file in the heap directory to clarify the idea behind
which functions is placed in IRAM or in flash.

A section in mem_alloc.rst documentation is added to specify which functions from the
heap component API can be used in interrupt handlers.
This commit is contained in:
Guillaume Souchere
2022-11-03 12:38:36 +01:00
committed by BOT
parent 8700bdc156
commit 5f735a22ec
2 changed files with 31 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
docs/en/api-reference/system/mem_alloc.rst
View File

@@ -130,7 +130,28 @@ Thread Safety
Heap functions are thread safe, meaning they can be called from different tasks simultaneously without any limitations.
It is technically possible to call ``malloc``, ``free``, and related functions from interrupt handler (ISR) context. However this is not recommended, as heap function calls may delay other interrupts. It is strongly recommended to refactor applications so that any buffers used by an ISR are pre-allocated outside of the ISR. Support for calling heap functions from ISRs may be removed in a future update.
It is technically possible to call ``malloc``, ``free``, and related functions from interrupt handler (ISR) context (see :ref:`calling-heap-related-functions-from-isr`). However this is not recommended, as heap function calls may delay other interrupts. It is strongly recommended to refactor applications so that any buffers used by an ISR are pre-allocated outside of the ISR. Support for calling heap functions from ISRs may be removed in a future update.
.. _calling-heap-related-functions-from-isr:
Calling heap related functions from ISR
---------------------------------------
The following functions from the heap component can be called form interrupt handler (ISR):
* :cpp:func:`heap_caps_malloc`
* :cpp:func:`heap_caps_malloc_default`
* :cpp:func:`heap_caps_realloc_default`
* :cpp:func:`heap_caps_malloc_prefer`
* :cpp:func:`heap_caps_realloc_prefer`
* :cpp:func:`heap_caps_calloc_prefer`
* :cpp:func:`heap_caps_free`
* :cpp:func:`heap_caps_realloc`
* :cpp:func:`heap_caps_calloc`
* :cpp:func:`heap_caps_aligned_alloc`
* :cpp:func:`heap_caps_aligned_free`
Note however this practice is strongly discouraged.
Heap Tracing & Debugging
------------------------