pioduino/esp-idf
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: add section in ram-uasge.rst to clarify DRAM limitations on esp32.

Browse Source 
The sections details that only 160KB of DRAM can be used for statically allocated data.
Reference this new section in mem_alloc.rst and memory-types.rst.
This commit is contained in:
Guillaume Souchere
2022-11-14 12:41:04 +01:00
parent 66b1c34095
commit abe56e2bbe
2 changed files with 7 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/system/mem_alloc.rst
+3 -1
View File
@@ -40,6 +40,8 @@ the standard ``free()`` function.
Available Heap
--------------
.. _dram-definition:
DRAM
^^^^
@@ -49,7 +51,7 @@ To find the amount of statically allocated memory, use the :ref:`idf.py size <id
.. only:: esp32
.. note:: Due to a technical limitation, the maximum statically allocated DRAM usage is 160KB. The remaining 160KB (for a total of 320KB of DRAM) can only be allocated at runtime as heap.
.. note:: See the :ref:`dram` section for more details about the DRAM usage limitations.
.. note:: At runtime, the available heap DRAM may be less than calculated at compile time, because at startup some memory is allocated from the heap before the FreeRTOS scheduler is started (including memory for the stacks of initial FreeRTOS tasks).