MemManager

Overview

Data Structures
struct	mem_config_t
	Memory user config. More...

Macros
#define	MEM_BLOCK_DATA_BUFFER_DEFINE(name, numberOfBlocks, blockSize, id)
	Defines the memory buffer. More...
#define	MEM_BLOCK_BUFFER(name)   (uint8_t *)&g_poolHeadBuffer##name
	\ More...

Enumerations
enum	mem_status_t
	Memory status.

Functions
mem_status_t	MEM_Init (void)
	Initialises the Memory Manager.
mem_status_t	MEM_AddBuffer (uint8_t *buffer)
	Add memory buffer to memory manager buffer list. More...
void *	MEM_BufferAllocWithId (uint32_t numBytes, uint8_t poolId)
	Allocate a block from the memory pools. More...
mem_status_t	MEM_BufferFree (void *buffer)
	Memory buffer free . More...
uint16_t	MEM_BufferGetSize (void *buffer)
	Returns the size of a given buffer. More...
mem_status_t	MEM_BufferFreeAllWithId (uint8_t poolId)
	Frees all allocated blocks by selected source and in selected pool. More...
void *	MEM_BufferRealloc (void *buffer, uint32_t new_size)
	Memory buffer realloc. More...

---

Data Structure Documentation

struct mem_config_t

Macro Definition Documentation

#define MEM_BLOCK_DATA_BUFFER_DEFINE	(		name,
			numberOfBlocks,
			blockSize,
			id
	)

Value:

uint32_t                                                              \
        g_poolBuffer##name[(MEM_POOL_SIZE + numberOfBlocks * MEM_BLOCK_SIZE + numberOfBlocks * blockSize + 3U) >> 2U];

This macro is used to define the shell memory buffer for memory manager. And then uses the macro MEM_BLOCK_BUFFER to get the memory buffer pointer. The macro should not be used in any function.

This is a example,

* MEM_BLOCK_BUFFER_DEFINE(app64, 5, 64,0);
* MEM_BLOCK_BUFFER_DEFINE(app128, 6, 128,0);
* MEM_BLOCK_BUFFER_DEFINE(app256, 7, 256,0);
* 

Parameters

name	The name string of the memory buffer.
numberOfBlocks	The number Of Blocks.
blockSize	The memory block size.
id	The id Of memory buffer.

#define MEM_BLOCK_BUFFER

(

name

)

(uint8_t *)&g_poolHeadBuffer##name

Gets the memory buffer pointer \ \ This macro is used to get the memory buffer pointer. The macro should \ not be used before the macro MEM_BLOCK_BUFFER_DEFINE is used. \ \

Parameters

name	The memory name string of the buffer. \

Function Documentation

mem_status_t MEM_AddBuffer

(

uint8_t *

buffer

)

Note

This API should be called when need add memory buffer to memory manager buffer list. First use MEM_BLOCK_BUFFER_DEFINE to define memory buffer, then call MEM_AddBuffer function with MEM_BLOCK_BUFFER Macro as the input parameter.

* MEM_BLOCK_BUFFER_DEFINE(app64, 5, 64,0);
* MEM_BLOCK_BUFFER_DEFINE(app128, 6, 128,0);
* MEM_BLOCK_BUFFER_DEFINE(app256, 7, 256,0);
*
* MEM_AddBuffer(MEM_BLOCK_BUFFER(app64));
* MEM_AddBuffer(MEM_BLOCK_BUFFER(app128));
* MEM_AddBuffer(MEM_BLOCK_BUFFER(app256));
* 

Parameters

buffer

Pointer the memory pool buffer, use MEM_BLOCK_BUFFER Macro as the input parameter.

Return values

kStatus_MemSuccess	Memory manager add buffer succeed.
kStatus_MemUnknownError	Memory manager add buffer error occurred.

void* MEM_BufferAllocWithId	(	uint32_t	numBytes,
		uint8_t	poolId
	)

The function uses the numBytes argument to look up a pool with adequate block sizes.

Parameters

numBytes	The number of bytes will be allocated.
poolId	The ID of the pool where to search for a free buffer.

Return values

Memory

buffer address when allocate success, NULL when allocate fail.

mem_status_t MEM_BufferFree

(

void *

buffer

)

Parameters

buffer

The memory buffer address will be free.

Return values

kStatus_MemSuccess	Memory free succeed.
kStatus_MemFreeError	Memory free error occurred.

uint16_t MEM_BufferGetSize

(

void *

buffer

)

Parameters

buffer

The memory buffer address will be get size.

Return values

The	size of a given buffer.

mem_status_t MEM_BufferFreeAllWithId

(

uint8_t

poolId

)

Parameters

poolId

Selected pool Id (4 LSBs of poolId parameter) and selected source Id (4 MSBs of poolId parameter).

Return values

kStatus_MemSuccess	Memory free succeed.
kStatus_MemFreeError	Memory free error occurred.

void* MEM_BufferRealloc	(	void *	buffer,
		uint32_t	new_size
	)

Parameters

buffer	The memory buffer address will be reallocated.
new_size	The number of bytes will be reallocated

Return values

kStatus_MemSuccess	Memory free succeed.
kStatus_MemFreeError	Memory free error occurred.