MemoryP

Introduction

MemoryP interface

Files
file	MemoryP.h
	Memory module for the RTOS Porting Interface.

Data Structures
struct	MemoryP_Stats
	Memory Heap stats. More...

Functions
void *	MemoryP_ctrlAlloc (uint32_t size, uint8_t alignment)
	Function which is used to allocate memory for control operations. More...
void	MemoryP_ctrlFree (void *ptr, uint32_t size)
	Function which is used to free previously allocated control memory. More...
void *	MemoryP_dataAlloc (uint32_t size, uint8_t alignment)
	Function which is used to allocate memory for data operations. More...
void	MemoryP_dataFree (void *ptr, uint32_t size)
	Function which is used to free previously allocated data memory. More...
void	MemoryP_getStats (MemoryP_Stats *stats)
	Function which is used to get data memory stats. More...

Function Documentation

MemoryP_ctrlAlloc()

void* MemoryP_ctrlAlloc	(	uint32_t	size,
		uint8_t	alignment
	)

Function which is used to allocate memory for control operations.

Parameters

size	Size of the requested memory
alignment	Requested alignment in bytes

Returns

Pointer to the allocated memory on success or a NULL on an error

MemoryP_ctrlFree()

void MemoryP_ctrlFree	(	void *	ptr,
		uint32_t	size
	)

Function which is used to free previously allocated control memory.

Parameters

ptr	Pointer to the memory to be cleaned up
size	Size of the memory which is being cleaned up

Returns

None

MemoryP_dataAlloc()

void* MemoryP_dataAlloc	(	uint32_t	size,
		uint8_t	alignment
	)

Function which is used to allocate memory for data operations.

Parameters

size	Size of the requested memory
alignment	Requested alignment in bytes

Returns

Pointer to the allocated memory on success or a NULL on an error

MemoryP_dataFree()

void MemoryP_dataFree	(	void *	ptr,
		uint32_t	size
	)

Function which is used to free previously allocated data memory.

Parameters

ptr	Pointer to the memory to be cleaned up
size	Size of the memory which is being cleaned up

Returns

None

MemoryP_getStats()

void MemoryP_getStats

(

MemoryP_Stats *

stats

)

Function which is used to get data memory stats.

Parameters

stats

Pointer to memory stats structure

Returns

None