Memory.h File Reference

---

Detailed Description

Memory manager interface definitions.

This abstracts the Memory management interface to be used with SysLink code. Allocation, Freeing-up, copy and address translate are supported for the memory management.

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 Memory.h.

#include <ti/syslink/utils/MemoryDefs.h>
#include <ti/syslink/utils/MemoryOS.h>
#include <ti/syslink/utils/IHeap.h>

Include dependency graph for Memory.h:

Go to the source code of this file.

Defines
#define	Memory_Q_BLOCKING   1
	Blocking quality Heaps with this "quality" may cause the calling thread to block; i.e., suspend execution until another thread leaves the gate.
#define	Memory_map   MemoryOS_map
	Maps a memory area into virtual space.
#define	Memory_unmap   MemoryOS_unmap
	Unmaps a memory area into virtual space.
#define	Memory_copy   MemoryOS_copy
	Copies the data between memory areas.
#define	Memory_set   MemoryOS_set
	Set the specific value in the said memory area.
Functions
Ptr	Memory_alloc (IHeap_Handle heap, SizeT size, SizeT align, Ptr eb)
	Allocates the specified number of bytes.
Ptr	Memory_calloc (IHeap_Handle heap, SizeT size, SizeT align, Ptr eb)
	Allocates the specified number of bytes and memory is set to zero.
Void	Memory_free (IHeap_Handle heap, Ptr block, SizeT size)
	Frees up the specified chunk of memory.
Void	Memory_getStats (IHeap_Handle heap, Memory_Stats *stats)
	Function to obtain statistics from a heap.
Bool	Memory_query (IHeap_Handle heap, Int qual)
	Function to test for a particular IHeap quality.
SizeT	Memory_getMaxDefaultTypeAlign (Void)
	Function to get memory alignment.
Ptr	Memory_valloc (IHeap_Handle heap, SizeT size, SizeT align, Char value, Ptr eb)
	Allocates the specified number of bytes and memory is set to the specified value.
Ptr	Memory_translate (Ptr srcAddr, Memory_XltFlags flags)
	Function to translate an address.

---

Define Documentation

#define Memory_copy   MemoryOS_copy

Copies the data between memory areas. Definition at line 216 of file Memory.h.

#define Memory_map   MemoryOS_map

Maps a memory area into virtual space. See also: Memory_unmap Definition at line 205 of file Memory.h.

#define Memory_Q_BLOCKING   1

Blocking quality Heaps with this "quality" may cause the calling thread to block; i.e., suspend execution until another thread leaves the gate. Definition at line 81 of file Memory.h.

#define Memory_set   MemoryOS_set

Set the specific value in the said memory area. Definition at line 221 of file Memory.h.

#define Memory_unmap   MemoryOS_unmap

Unmaps a memory area into virtual space. See also: Memory_unmap Definition at line 211 of file Memory.h.

---

Function Documentation

Ptr Memory_alloc (  IHeap_Handle  heap, SizeT  size, SizeT  align, Ptr  eb )

Allocates the specified number of bytes. Parameters: heap  Handle to the heap from which the memory is to be allocated. Specify NULL to allocate from local memory. size  Amount of memory to be allocated. align  Alignment constraints (power of 2) eb  Not used. Pass as NULL. Return values: Pointer  Success: Pointer to allocated buffer NULL  Failed to allocate memory See also: Memory_calloc

Ptr Memory_calloc (  IHeap_Handle  heap, SizeT  size, SizeT  align, Ptr  eb )

Allocates the specified number of bytes and memory is set to zero. Parameters: heap  Handle to the heap from which the memory is to be allocated. Specify NULL to allocate from local memory. size  Amount of memory to be allocated. align  Alignment constraints (power of 2) eb  Not used. Pass as NULL. Return values: Pointer  Success: Pointer to allocated buffer NULL  Failed to allocate memory See also: Memory_alloc, MemoryOS_calloc

Void Memory_free (  IHeap_Handle  heap, Ptr  block, SizeT  size )

Frees up the specified chunk of memory. Parameters: heap  Handle to the heap block  Block of memory to be freed size  Amount of memory to be freed See also: IHeap_free, MemoryOS_free

SizeT Memory_getMaxDefaultTypeAlign (  Void   )

Function to get memory alignment. Return values: Alignment  Maximum default alignment

Void Memory_getStats (  IHeap_Handle  heap, Memory_Stats *  stats )

Function to obtain statistics from a heap. Parameters: heap  Handle to the heap stats  Pointer to the Memory stats structure to be filled. See also:

Bool Memory_query (  IHeap_Handle  heap, Int  qual )

Function to test for a particular IHeap quality. Parameters: heap  Handle to the heap qual  Quality to be queried. See also: Memory_Q_BLOCKING

Ptr Memory_translate (  Ptr  srcAddr, Memory_XltFlags  flags )

Function to translate an address. Parameters: srcAddr  source address. flags  Tranlation flags. Return values: Pointer  Success: Pointer to translated buffer NULL  Failed to translate

Ptr Memory_valloc (  IHeap_Handle  heap, SizeT  size, SizeT  align, Char  value, Ptr  eb )

Allocates the specified number of bytes and memory is set to the specified value. Parameters: heap  Handle to the heap from which the memory is to be allocated. Specify NULL to allocate from local memory. size  Amount of memory to be allocated. align  Alignment constraints (power of 2) value  Value to be set for all bytes in the buffer eb  Not used. Pass as NULL. Return values: Pointer  Success: Pointer to allocated buffer NULL  Failed to allocate memory See also: Memory_alloc, MemoryOS_calloc

---