_MemoryOS.h File Reference

---

Detailed Description

Memory abstraction APIs for local memory allocation.

This provides a direct access to local memory allocation, which does not require creation of a Heap.

#include <ti/syslink/utils/_MemoryDefs.h>

Include dependency graph for _MemoryOS.h:

Go to the source code of this file.

Defines
#define	MEMORYOS_MODULEID   (UInt16) 0x97D2
	Module ID for Memory OSAL module.
#define	MEMORYOS_STATUSCODEBASE   (MEMORYOS_MODULEID << 12u)
	Stauts code base for MEMORY module.
#define	MEMORYOS_MAKE_FAILURE(x)
	Convert to failure code.
#define	MEMORYOS_MAKE_SUCCESS(x)   (MEMORYOS_STATUSCODEBASE + (x))
	Convert to success code.
#define	MEMORYOS_E_MEMORY   MEMORYOS_MAKE_FAILURE(1)
	Indicates Memory alloc/free failure.
#define	MEMORYOS_E_INVALIDARG   MEMORYOS_MAKE_FAILURE(2)
	Invalid argument provided.
#define	MEMORYOS_E_MAP   MEMORYOS_MAKE_FAILURE(3)
	Failed to map to host address space.
#define	MEMORYOS_E_UNMAP   MEMORYOS_MAKE_FAILURE(4)
	Failed to unmap from host address space.
#define	MEMORYOS_E_INVALIDSTATE   MEMORYOS_MAKE_FAILURE(5)
	Module is in invalidstate.
#define	MEMORYOS_E_FAIL   MEMORYOS_MAKE_FAILURE(6)
	Genral failure.
#define	MEMORYOS_S_SUCCESS   MEMORYOS_MAKE_SUCCESS(0)
	Operation successfully completed.
#define	MEMORYOS_S_ALREADYSETUP   MEMORYOS_MAKE_SUCCESS(1)
	Module already initialized.
Functions
Int	MemoryOS_map (Memory_MapInfo *mapInfo)
Int	MemoryOS_unmap (Memory_UnmapInfo *unmapInfo)

---

Define Documentation

#define MEMORYOS_MODULEID   (UInt16) 0x97D2

Module ID for Memory OSAL module.

#define MEMORYOS_STATUSCODEBASE   (MEMORYOS_MODULEID << 12u)

Stauts code base for MEMORY module.

#define MEMORYOS_MAKE_FAILURE

(

x )

Value:

((Int) (0x80000000  \
                                           + (MEMORYOS_STATUSCODEBASE + (x))))

Convert to failure code.

#define MEMORYOS_MAKE_SUCCESS

(

x )

(MEMORYOS_STATUSCODEBASE + (x))

Convert to success code.

#define MEMORYOS_E_MEMORY   MEMORYOS_MAKE_FAILURE(1)

Indicates Memory alloc/free failure.

#define MEMORYOS_E_INVALIDARG   MEMORYOS_MAKE_FAILURE(2)

Invalid argument provided.

#define MEMORYOS_E_MAP   MEMORYOS_MAKE_FAILURE(3)

Failed to map to host address space.

#define MEMORYOS_E_UNMAP   MEMORYOS_MAKE_FAILURE(4)

Failed to unmap from host address space.

#define MEMORYOS_E_INVALIDSTATE   MEMORYOS_MAKE_FAILURE(5)

Module is in invalidstate.

#define MEMORYOS_E_FAIL   MEMORYOS_MAKE_FAILURE(6)

Genral failure.

#define MEMORYOS_S_SUCCESS   MEMORYOS_MAKE_SUCCESS(0)

Operation successfully completed.

#define MEMORYOS_S_ALREADYSETUP   MEMORYOS_MAKE_SUCCESS(1)

Module already initialized.

---

Function Documentation

Int MemoryOS_map

(

Memory_MapInfo *

mapInfo )

Int MemoryOS_unmap

(

Memory_UnmapInfo *

unmapInfo )