Symbols

loading...

Files

loading (2/5)...

Summary Syntax Arguments References Call Tree Data Use Lifecycle

SourceVuESP-IDF Framework and ExamplesESP-IDFheap_caps_add_region_with_caps()

heap_caps_add_region_with_caps() function

Add a region of memory to the collection of heaps at runtime, with custom capabilities. Similar to heap_caps_add_region(), only custom memory capabilities are specified by the caller.

Syntax

Show:

Summary

Declaration

Definition

from esp_heap_caps_init.h:106

esp_err_t heap_caps_add_region_with_caps(const uint32_t caps[], intptr_t start, intptr_t end);

Implemented in heap_caps_init.c:221

Arguments

Argument

Description

caps

Ordered array of capability masks for the new region, in order of priority. Must have length SOC_MEMORY_TYPE_NO_PRIOS. Does not need to remain valid after the call returns.

start

Start address of new region.

end

End address of new region.

Return value

- ESP_OK on success - ESP_ERR_INVALID_ARG if a parameter is invalid - ESP_ERR_NO_MEM if no memory to register new heap. - ESP_ERR_INVALID_SIZE if the memory region is too small to fit a heap - ESP_FAIL if region overlaps the start and/or end of an existing region

Notes

Please refer to following example for memory regions allowed for addition to heap based on an existing region (address range for demonstration purpose only): @verbatim Existing region: 0x1000 0x3000 New region: 0x1000 0x3000 (Allowed) New region: 0x1000 0x2000 (Allowed) New region: 0x0000 0x1000 (Allowed) New region: 0x3000 0x4000 (Allowed) New region: 0x0000 0x2000 (NOT Allowed) New region: 0x0000 0x4000 (NOT Allowed) New region: 0x1000 0x4000 (NOT Allowed) New region: 0x2000 0x4000 (NOT Allowed) @endverbatim

References

Code

Location

Referrer

esp_err_t heap_caps_add_region_with_caps(const uint32_t caps[], intptr_t start, intptr_t end)

heap_caps_init.c:221

esp_err_t heap_caps_add_region_with_caps(const uint32_t caps[], intptr_t start, intptr_t end);

esp_heap_caps_init.h:106

ret = heap_caps_add_region_with_caps(byte_aligned_caps,

esp_psram.c:373

esp_psram_extram_add_to_heap_allocator()

ret = heap_caps_add_region_with_caps(word_aligned_caps,

esp_psram.c:383

esp_psram_extram_add_to_heap_allocator()

esp_err_t e = heap_caps_add_region_with_caps(caps, (intptr_t)dma_heap, (intptr_t)dma_heap + next_size - 1);

esp_psram.c:426

esp_psram_extram_reserve_dma_pool()

return heap_caps_add_region_with_caps(caps, start, end);

heap_caps_init.c:176

heap_caps_add_region()

Call Tree

heap_caps_add_region_with_caps() is called by 3 functions and calls 11 functions:

heap_caps_add_region()

esp_psram_extram_add_to_heap_allocator()

esp_psram_extram_reserve_dma_pool()

heap_caps_add_region_with_caps()

esp_log_get_default_level()

spinlock_initialize()

vPortEnterCriticalSafe()

vPortExitCriticalSafe()

esp_rom_printf()

esp_log_timestamp()

multi_heap_register()

multi_heap_set_lock()

heap_caps_malloc()

heap_caps_check_add_region_allowed()

Data Use

heap_caps_add_region_with_caps() reads 7 variables and writes 3 variables:

esp_log_level_t::ESP_LOG_DEBUG

heap_caps_add_region_with_caps()

Class Tree

All items filtered out

All items filtered out

Override Tree

All items filtered out

All items filtered out

Implementations

All items filtered out

All items filtered out

Instances

Lifecycle

heap_caps_add_region_with_caps() allocates 1 types:

heap_caps_add_region_with_caps()