alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2025-09-30 19:19:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge branch 'change/rm_esp_dma_x_usage_in_doc_v5_3' into 'release/v5.3'

Browse Source 
change(dma): remove esp_dma_x usage in programming guide

See merge request espressif/esp-idf!31430
This commit is contained in:
morris
2024-06-11 16:41:07 +08:00
parent 1c6a8b4521 0b8952dc2e
commit e207b08e28
2 changed files with 0 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

17
docs/en/api-reference/system/mm_sync.rst
View File

@@ -101,17 +101,6 @@ There is address and size alignment requirement (in bytes) for using :cpp:func:`
By default, if you specify an unaligned address region, :cpp:func:`esp_cache_msync` will return an :c:macro:`ESP_ERR_INVALID_ARG` error, together with the required alignment.
Memory Allocation Helper
------------------------
cache memory synchronization is usually considered when DMA is involved. ESP-IDF provides an API to do memory allocation that can meet the alignment requirement from both the cache and the DMA.
- :cpp:func:`esp_dma_capable_malloc`, this API allocates a chunk of memory that meets the alignment requirement from both the cache and the DMA.
- :cpp:func:`esp_dma_capable_calloc`, this API allocates a chunk of memory that meets the alignment requirement from both the cache and the DMA. The initialized value in the memory is set to zero.
You can also use :c:macro:`ESP_DMA_MALLOC_FLAG_PSRAM` to allocate from the PSRAM.
Warning for Address Alignment Requirement
-----------------------------------------
@@ -138,9 +127,3 @@ API Reference - ESP Msync Driver
--------------------------------
.. include-build-file:: inc/esp_cache.inc
API Reference - ESP DMA Utils
-----------------------------
.. include-build-file:: inc/esp_dma_utils.inc