esp_heap_caps.h File Reference

#include <stdint.h>
#include <stddef.h>
#include <stdbool.h>
#include "esp_err.h"

Go to the source code of this file.

Data Structures
struct	multi_heap_info

Macros
#define	MALLOC_CAP_EXEC   (1u << 0)
#define	MALLOC_CAP_32BIT   (1u << 1)
#define	MALLOC_CAP_8BIT   (1u << 2)
#define	MALLOC_CAP_DMA   (1u << 3)
#define	MALLOC_CAP_PID2   (1u << 4)
#define	MALLOC_CAP_PID3   (1u << 5)
#define	MALLOC_CAP_PID4   (1u << 6)
#define	MALLOC_CAP_PID5   (1u << 7)
#define	MALLOC_CAP_PID6   (1u << 8)
#define	MALLOC_CAP_PID7   (1u << 9)
#define	MALLOC_CAP_SPIRAM   (1u << 10)
#define	MALLOC_CAP_INTERNAL   (1u << 11)
#define	MALLOC_CAP_DEFAULT   (1u << 12)
#define	MALLOC_CAP_IRAM_8BIT   (1u << 13)
#define	MALLOC_CAP_RETENTION   (1u << 14)
#define	MALLOC_CAP_RTCRAM   (1u << 16)
#define	MALLOC_CAP_TCM   (1u << 17)
#define	MALLOC_CAP_INVALID   (1u << 31)

Typedefs
typedef struct multi_heap_info	multi_heap_info_t

Functions
void *	heap_caps_malloc (size_t size, uint32_t caps)
void	heap_caps_free (void *ptr)
void *	heap_caps_realloc (void *ptr, size_t size, uint32_t caps)
void *	heap_caps_calloc (size_t n, size_t size, uint32_t caps)
void *	heap_caps_aligned_alloc (size_t alignment, size_t size, uint32_t caps)
void	heap_caps_aligned_free (void *ptr)
void *	heap_caps_aligned_calloc (size_t alignment, size_t n, size_t size, uint32_t caps)
size_t	heap_caps_get_total_size (uint32_t caps)
size_t	heap_caps_get_free_size (uint32_t caps)
size_t	heap_caps_get_minimum_free_size (uint32_t caps)
size_t	heap_caps_get_largest_free_block (uint32_t caps)
void	heap_caps_get_info (multi_heap_info_t *info, uint32_t caps)
bool	heap_caps_check_integrity_all (bool print_errors)
bool	heap_caps_check_integrity (uint32_t caps, bool print_errors)

Macro Definition Documentation

MALLOC_CAP_EXEC

#define MALLOC_CAP_EXEC   (1u << 0)

MALLOC_CAP_32BIT

#define MALLOC_CAP_32BIT   (1u << 1)

MALLOC_CAP_8BIT

#define MALLOC_CAP_8BIT   (1u << 2)

MALLOC_CAP_DMA

#define MALLOC_CAP_DMA   (1u << 3)

MALLOC_CAP_PID2

#define MALLOC_CAP_PID2   (1u << 4)

MALLOC_CAP_PID3

#define MALLOC_CAP_PID3   (1u << 5)

MALLOC_CAP_PID4

#define MALLOC_CAP_PID4   (1u << 6)

MALLOC_CAP_PID5

#define MALLOC_CAP_PID5   (1u << 7)

MALLOC_CAP_PID6

#define MALLOC_CAP_PID6   (1u << 8)

MALLOC_CAP_PID7

#define MALLOC_CAP_PID7   (1u << 9)

MALLOC_CAP_SPIRAM

#define MALLOC_CAP_SPIRAM   (1u << 10)

MALLOC_CAP_INTERNAL

#define MALLOC_CAP_INTERNAL   (1u << 11)

MALLOC_CAP_DEFAULT

#define MALLOC_CAP_DEFAULT   (1u << 12)

MALLOC_CAP_IRAM_8BIT

#define MALLOC_CAP_IRAM_8BIT   (1u << 13)

MALLOC_CAP_RETENTION

#define MALLOC_CAP_RETENTION   (1u << 14)

MALLOC_CAP_RTCRAM

#define MALLOC_CAP_RTCRAM   (1u << 16)

MALLOC_CAP_TCM

#define MALLOC_CAP_TCM   (1u << 17)

MALLOC_CAP_INVALID

#define MALLOC_CAP_INVALID   (1u << 31)

Typedef Documentation

multi_heap_info_t

typedef struct multi_heap_info multi_heap_info_t

Function Documentation

heap_caps_malloc()

void * heap_caps_malloc ( size_t  size, uint32_t  caps  )

extern

heap_caps_free()

void heap_caps_free ( void *  ptr )

extern

heap_caps_realloc()

void * heap_caps_realloc ( void *  ptr, size_t  size, uint32_t  caps  )

extern

heap_caps_calloc()

void * heap_caps_calloc ( size_t  n, size_t  size, uint32_t  caps  )

extern

heap_caps_aligned_alloc()

void * heap_caps_aligned_alloc ( size_t  alignment, size_t  size, uint32_t  caps  )

extern

heap_caps_aligned_free()

void heap_caps_aligned_free ( void *  ptr )

extern

heap_caps_aligned_calloc()

void * heap_caps_aligned_calloc ( size_t  alignment, size_t  n, size_t  size, uint32_t  caps  )

extern

heap_caps_get_total_size()

size_t heap_caps_get_total_size ( uint32_t  caps )

extern

heap_caps_get_free_size()

size_t heap_caps_get_free_size ( uint32_t  caps )

extern

heap_caps_get_minimum_free_size()

size_t heap_caps_get_minimum_free_size ( uint32_t  caps )

extern

heap_caps_get_largest_free_block()

size_t heap_caps_get_largest_free_block ( uint32_t  caps )

extern

heap_caps_get_info()

void heap_caps_get_info ( multi_heap_info_t *  info, uint32_t  caps  )

extern

heap_caps_check_integrity_all()

bool heap_caps_check_integrity_all ( bool  print_errors )

extern

heap_caps_check_integrity()

bool heap_caps_check_integrity ( uint32_t  caps, bool  print_errors  )

extern