esp_dma_capable_malloc() function

Helper function for malloc a DMA capable memory buffer

Syntax

Show:

Summary

Declaration

Definition

from esp_dma_utils.h:43

esp_err_t esp_dma_capable_malloc(size_t size, const esp_dma_mem_info_t *dma_mem_info, void **out_ptr, size_t *actual_size);

Implemented in esp_dma_utils.c:147

Arguments

Argument

Description

size

Size in bytes, the amount of memory to allocate

dma_mem_info

DMA and memory info, see `esp_dma_mem_info_t`

out_ptr

A pointer to the memory allocated successfully

actual_size

Actual size for allocation in bytes, when the size you specified doesn't meet the DMA alignment requirements, this value might be bigger than the size you specified. Set null if you don't care this value.

Return value

- ESP_OK: - ESP_ERR_INVALID_ARG: Invalid argument - ESP_ERR_NO_MEM: No enough memory for allocation

Notes

This API will take care of the cache alignment internally, you will need to set `esp_dma_mem_info_t: dma_alignment_bytes` with either the custom alignment or DMA alignment of used peripheral driver.

Examples

References

from examples

esp_dma_capable_malloc() function

Syntax

Arguments

Return value

Notes

Examples

References

Call Tree

Data Use

Class Tree

Override Tree

Implementations

Instances

Lifecycle