alex/esp-idf
alex/esp-idf
1
0
Fork 0
mirror of https://github.com/espressif/esp-idf.git synced 2024-10-05 20:47:46 -04:00
Code Issues Actions 2 Packages Projects Releases Wiki Activity

change(dma): remove esp_dma_x usage in programming guide

Browse Source
This commit is contained in:
Armando 2024-06-11 11:42:36 +08:00
parent b3b234f3e5
commit 9780c49128
3 changed files with 0 additions and 35 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/doxygen/Doxyfile
View File

@ -161,7 +161,6 @@ INPUT = \
$(PROJECT_PATH)/components/esp_http_server/include/esp_http_server.h \
$(PROJECT_PATH)/components/esp_https_ota/include/esp_https_ota.h \
$(PROJECT_PATH)/components/esp_https_server/include/esp_https_server.h \
$(PROJECT_PATH)/components/esp_hw_support/dma/include/esp_dma_utils.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_clk_tree.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_async_memcpy.h \
$(PROJECT_PATH)/components/esp_hw_support/include/esp_chip_info.h \

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

@ -103,17 +103,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
-----------------------------------------
@ -140,9 +129,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

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

@ -103,17 +103,6 @@ cache 与内存同步的类型：
默认情况下，如果指定了非对齐地址区域，则 :cpp:func:`esp_cache_msync` 将报错 :c:macro:`ESP_ERR_INVALID_ARG`，并告知所需的对齐方式。
内存分配助手
------------
在涉及 DMA 时通常会考虑同步 cache 和内存。ESP-IDF 提供了能进行内存分配的 API，可同时满足 cache 和 DMA 的对齐要求。
- :cpp:func:`esp_dma_capable_malloc`。此 API 可分配一块满足 cache 和 DMA 对齐要求的内存块。
- :cpp:func:`esp_dma_capable_calloc`。此 API 可分配一块满足 cache 和 DMA 对齐要求的内存块，且内存中的初始化值已设置为零。
也可以使用 :c:macro:`ESP_DMA_MALLOC_FLAG_PSRAM`， 从 PSRAM 中分配内存。
有关地址对齐要求的警告
----------------------
@ -140,9 +129,3 @@ API 参考 - ESP Msync 驱动程序
-----------------------------
.. include-build-file:: inc/esp_cache.inc
API 参考 - ESP DMA 实用程序
---------------------------
.. include-build-file:: inc/esp_dma_utils.inc