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

docs(mem_alloc): Fix typo to make a section visible for non-esp32 spiram targets

Browse Source
This commit is contained in:
harshal.patil
2024-10-28 16:08:34 +05:30
parent ae51dcc227
commit 7786cbe2c8
3 changed files with 5 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/en/api-reference/system/mem_alloc.rst
+1 -1
View File
@@ -105,7 +105,7 @@ DMA-Capable Memory
Use the ``MALLOC_CAP_DMA`` flag to allocate memory which is suitable for use with hardware DMA engines (for example SPI and I2S). This capability flag excludes any external PSRAM.
.. only SOC_SPIRAM_SUPPORTED and not esp32::
.. only:: SOC_SPIRAM_SUPPORTED and not esp32
The EDMA hardware feature allows DMA buffers to be placed in external PSRAM, but there may be additional alignment constraints. Consult the {IDF_TARGET_NAME} Technical Reference Manual for details. To allocate a DMA-capable external memory buffer, use the ``MALLOC_CAP_SPIRAM | MALLOC_CAP_DMA`` capabilities flags; the heap allocator will take care of alignment requirements imposed by the cache and DMA subsystems. If a peripheral has additional alignment requirements, you can use :cpp:func:`heap_caps_aligned_alloc` with the necessary alignment specified.