hal_heap.h

Go to the documentation of this file.

#ifndef HAL_HEAP_H
#define HAL_HEAP_H

#include <stdint.h>
#include <stddef.h>
#include "hal_config.h"



#ifndef HAL_HEAP_MODE
#define HAL_HEAP_MODE       0
#endif

#ifndef HAL_HEAP_DEBUG
#define HAL_HEAP_DEBUG      0
#endif

#ifndef HAL_HEAP_ALIGNMENT
#define HAL_HEAP_ALIGNMENT  4
#endif

#if defined HAL_HEAP_MODE && (HAL_HEAP_MODE == 0)

// In this mode the heap is serviced by malloc() and free(), with exception to
// OS-specific heap management (such as FreeRTOS pvPortMalloc and vPortFree)

#ifndef HAL_OS_FREERTOS
#include <stdlib.h>

#define HEAP_Alloc      malloc

#define HEAP_Free       free

#define HEAP_Calloc     calloc

#define HEAP_Realloc    realloc

#else

void* HEAP_PORT_Alloc(size_t size);

 void HEAP_PORT_Free(void* ptr);

#define HEAP_Alloc      HEAP_PORT_Alloc

#define HEAP_Free       HEAP_PORT_Free

#endif
#endif

#if defined HAL_HEAP_MODE && ((HAL_HEAP_MODE == 1) || (HAL_HEAP_MODE == 2))

// In this mode the heap is serviced by simple internal HALFRED memory manager


void* HEAP_Alloc(size_t size);

void HEAP_Free(void* ptr);


size_t HEAP_GetSpaceUsed(void);

size_t HEAP_GetSpaceLeft(void);

#endif

#if defined HAL_HEAP_MODE && (HAL_HEAP_MODE == 3)

// In this mode the the user is responsible for providing own implementation
// of HEAP_Alloc and HEAP_Free functions.

extern void* HEAP_Alloc(size_t size);

extern void HEAP_Free(void* ptr);

#endif


#endif /* HAL_HEAP_H */