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.

02.00.00.68_beta1

============================================================================

Copyright (c) 2008-2009, Texas Instruments Incorporated

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

* Neither the name of Texas Instruments Incorporated nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. Contact information for paper mail: Texas Instruments Post Office Box 655303 Dallas, Texas 75265 Contact information: http://www-k.ext.ti.com/sc/technical-support/product-information-centers.htm? DCMP=TIHomeTracking&HQS=Other+OT+home_d_contact ============================================================================

Definition in file MemoryOS.h.

#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_SUCCESS   MEMORYOS_MAKE_SUCCESS(0)
	Operation successfully completed.
#define	MEMORYOS_S_ALREADYSETUP   MEMORYOS_MAKE_SUCCESS(1)
	Module already initialized.
Functions
Int32	MemoryOS_setup (void)
Int32	MemoryOS_destroy (void)
Ptr	MemoryOS_alloc (UInt32 size, UInt32 align, UInt32 flags)
Ptr	MemoryOS_calloc (UInt32 size, UInt32 align, UInt32 flags)
Void	MemoryOS_free (Ptr ptr, UInt32 size, UInt32 flags)
Int	MemoryOS_map (Memory_MapInfo *mapInfo)
Int	MemoryOS_unmap (Memory_UnmapInfo *unmapInfo)
Ptr	MemoryOS_copy (Ptr dst, Ptr src, UInt32 len)
Ptr	MemoryOS_set (Ptr buf, Int value, UInt32 len)
Ptr	MemoryOS_translate (Ptr srcAddr, Memory_XltFlags flags)

---

Define Documentation

#define MEMORYOS_E_FAIL   MEMORYOS_MAKE_FAILURE(6)

Genral failure. Definition at line 126 of file MemoryOS.h.

#define MEMORYOS_E_INVALIDARG   MEMORYOS_MAKE_FAILURE(2)

Invalid argument provided. Definition at line 102 of file MemoryOS.h.

#define MEMORYOS_E_INVALIDSTATE   MEMORYOS_MAKE_FAILURE(5)

Module is in invalidstate. Definition at line 120 of file MemoryOS.h.

#define MEMORYOS_E_MAP   MEMORYOS_MAKE_FAILURE(3)

Failed to map to host address space. Definition at line 108 of file MemoryOS.h.

#define MEMORYOS_E_MEMORY   MEMORYOS_MAKE_FAILURE(1)

Indicates Memory alloc/free failure. Definition at line 96 of file MemoryOS.h.

#define MEMORYOS_E_UNMAP   MEMORYOS_MAKE_FAILURE(4)

Failed to unmap from host address space. Definition at line 114 of file MemoryOS.h.

#define MEMORYOS_MAKE_FAILURE (  x   )

Value: ((Int) (0x80000000 \ + (MEMORYOS_STATUSCODEBASE + (x)))) Convert to failure code. Definition at line 84 of file MemoryOS.h.

#define MEMORYOS_MAKE_SUCCESS (  x   )     (MEMORYOS_STATUSCODEBASE + (x))

Convert to success code. Definition at line 90 of file MemoryOS.h.

#define MEMORYOS_MODULEID   (UInt16) 0x97D2

Module ID for Memory OSAL module. Definition at line 68 of file MemoryOS.h.

#define MEMORYOS_S_ALREADYSETUP   MEMORYOS_MAKE_SUCCESS(1)

Module already initialized. Definition at line 138 of file MemoryOS.h.

#define MEMORYOS_STATUSCODEBASE   (MEMORYOS_MODULEID << 12u)

Stauts code base for MEMORY module. Definition at line 78 of file MemoryOS.h.

#define MEMORYOS_SUCCESS   MEMORYOS_MAKE_SUCCESS(0)

Operation successfully completed. Definition at line 132 of file MemoryOS.h.

---

Function Documentation

Ptr MemoryOS_alloc (  UInt32  size, UInt32  align, UInt32  flags )

Ptr MemoryOS_calloc (  UInt32  size, UInt32  align, UInt32  flags )

Ptr MemoryOS_copy (  Ptr  dst, Ptr  src, UInt32  len )

Int32 MemoryOS_destroy (  void   )

Void MemoryOS_free (  Ptr  ptr, UInt32  size, UInt32  flags )

Int MemoryOS_map (  Memory_MapInfo *  mapInfo  )

Ptr MemoryOS_set (  Ptr  buf, Int  value, UInt32  len )

Int32 MemoryOS_setup (  void   )

Ptr MemoryOS_translate (  Ptr  srcAddr, Memory_XltFlags  flags )

Int MemoryOS_unmap (  Memory_UnmapInfo *  unmapInfo  )

---