Chapter 2. API Reference
this API can recycle the memory for you.
API Reference
Header File
• components/esp_hw_support/include/esp_async_memcpy.h
Functions
esp_err_t esp_async_memcpy_install(const async_memcpy_config_t *config, async_memcpy_t
*asmcp)
Install async memcpy driver.
Return
• ESP_OK: Install async memcpy driver successfully
• ESP_ERR_INVALID_ARG: Install async memcpy driver failed because of invalid argument
• ESP_ERR_NO_MEM: Install async memcpy driver failed because out of memory
• ESP_FAIL: Install async memcpy driver failed because of other error
Parameters
• [in] config: Configuration of async memcpy
• [out] asmcp: Handle of async memcpy that returned from this API. If driver installation is
failed, asmcp would be assigned to NULL.
esp_err_t esp_async_memcpy_uninstall(async_memcpy_t asmcp)
Uninstall async memcpy driver.
Return
• ESP_OK: Uninstall async memcpy driver successfully
• ESP_ERR_INVALID_ARG: Uninstall async memcpy driver failed because of invalid argument
• ESP_FAIL: Uninstall async memcpy driver failed because of other error
Parameters
• [in] asmcp: Handle of async memcpy driver that returned from esp_async_memcpy_install
esp_err_t esp_async_memcpy(async_memcpy_t asmcp, void *dst, void *src, size_t n,
async_memcpy_isr_cb_t cb_isr, void *cb_args)
Send an asynchronous memory copy request.
Return
• ESP_OK: Send memory copy request successfully
• ESP_ERR_INVALID_ARG: Send memory copy request failed because of invalid argument
• ESP_FAIL: Send memory copy request failed because of other error
Note The callback function is invoked in interrupt context, never do blocking jobs in the callback.
Parameters
• [in] asmcp: Handle of async memcpy driver that returned from esp_async_memcpy_install
• [in] dst: Destination address (copy to)
• [in] src: Source address (copy from)
• [in] n: Number of bytes to copy
• [in] cb_isr: Callback function, which got invoked in interrupt context. Set to NULL can
bypass the callback.
• [in] cb_args: User defined argument to be passed to the callback function
Structures
struct async_memcpy_event_t
Type of async memcpy event object.
Public Members
void *data
Event data
Espressif Systems 796
Submit Document Feedback
Release v4.4
To Next Page
Loading...