Main Page | Alphabetical List | Data Structures | Directories | File List | Data Fields | Globals

MemoryDefs.h File Reference


Detailed Description

Definitions for Memory module.

This provides macros and type definitions for the Memory module.

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

Go to the source code of this file.

Data Structures

struct  Memory_Stats_tag
 Structure defining memory related statistics. More...
struct  MemoryOS_MapInfo_tag
 Structure containing information required for mapping a memory region. More...
struct  MemoryOS_UnmapInfo_tag
 Structure containing information required for unmapping a memory region. More...
struct  MemoryOS_SGList
 Structure for scatter-gathered list. More...

Defines

#define Memory_MapInfo   MemoryOS_MapInfo
 Structure containing information required for mapping a memory region.
#define Memory_UnmapInfo   MemoryOS_UnmapInfo
 Structure containing information required for unmapping a memory region.
#define Memory_SGList   MemoryOS_SGList
 Structure for scatter-gathered list.

Typedefs

typedef Memory_Stats_tag Memory_Stats
 Structure defining memory related statistics.
typedef MemoryOS_MapInfo_tag MemoryOS_MapInfo
 Structure containing information required for mapping a memory region.
typedef MemoryOS_UnmapInfo_tag MemoryOS_UnmapInfo
 Structure containing information required for unmapping a memory region.
typedef MemoryOS_SGList MemoryOS_SGList
 Structure for scatter-gathered list.

Enumerations

enum  MemoryOS_CacheFlags { MemoryOS_CacheFlags_Default = 0x00000000, MemoryOS_CacheFlags_Cached = 0x00010000, MemoryOS_CacheFlags_Uncached = 0x00020000, MemoryOS_CacheFlags_EndValue = 0x00030000 }
 Enumerates the types of Caching for memory regions. More...
enum  MemoryOS_MemTypeFlags { MemoryOS_MemTypeFlags_Default = 0x00000000, MemoryOS_MemTypeFlags_Physical = 0x00000001, MemoryOS_MemTypeFlags_Dma = 0x00000002, MemoryOS_MemTypeFlags_EndValue = 0x00000003 }
 Enumerates the types of memory allocation. More...
enum  Memory_XltFlags { Memory_XltFlags_Virt2Phys = 0x00000000, Memory_XltFlags_Phys2Virt = 0x00000001, Memory_XltFlags_EndValue = 0x00000002 }
 Enumerates the types of translation. More...


Define Documentation

#define Memory_MapInfo   MemoryOS_MapInfo
 

Structure containing information required for mapping a memory region.

Definition at line 166 of file MemoryDefs.h.

#define Memory_SGList   MemoryOS_SGList
 

Structure for scatter-gathered list.

Definition at line 177 of file MemoryDefs.h.

#define Memory_UnmapInfo   MemoryOS_UnmapInfo
 

Structure containing information required for unmapping a memory region.

Definition at line 172 of file MemoryDefs.h.


Typedef Documentation

typedef struct Memory_Stats_tag Memory_Stats
 

Structure defining memory related statistics.

typedef struct MemoryOS_MapInfo_tag MemoryOS_MapInfo
 

Structure containing information required for mapping a memory region.

typedef struct MemoryOS_SGList MemoryOS_SGList
 

Structure for scatter-gathered list.

typedef struct MemoryOS_UnmapInfo_tag MemoryOS_UnmapInfo
 

Structure containing information required for unmapping a memory region.


Enumeration Type Documentation

enum Memory_XltFlags
 

Enumerates the types of translation.

Enumerator:
Memory_XltFlags_Virt2Phys  Virtual to physical
Memory_XltFlags_Phys2Virt  Virtual to physical
Memory_XltFlags_EndValue  End delimiter indicating start of invalid values for this enum

Definition at line 109 of file MemoryDefs.h.

00109              {
00110     Memory_XltFlags_Virt2Phys       = 0x00000000,
00111     /*!< Virtual to physical */
00112     Memory_XltFlags_Phys2Virt       = 0x00000001,
00113     /*!< Virtual to physical */
00114     Memory_XltFlags_EndValue        = 0x00000002
00115     /*!< End delimiter indicating start of invalid values for this enum */
00116 } Memory_XltFlags;

enum MemoryOS_CacheFlags
 

Enumerates the types of Caching for memory regions.

Enumerator:
MemoryOS_CacheFlags_Default  Default flags - Cached
MemoryOS_CacheFlags_Cached  Cached memory
MemoryOS_CacheFlags_Uncached  Uncached memory
MemoryOS_CacheFlags_EndValue  End delimiter indicating start of invalid values for this enum

Definition at line 81 of file MemoryDefs.h.

00081              {
00082     MemoryOS_CacheFlags_Default           = 0x00000000,
00083     /*!< Default flags - Cached */
00084     MemoryOS_CacheFlags_Cached            = 0x00010000,
00085     /*!< Cached memory */
00086     MemoryOS_CacheFlags_Uncached          = 0x00020000,
00087     /*!< Uncached memory */
00088     MemoryOS_CacheFlags_EndValue          = 0x00030000
00089     /*!< End delimiter indicating start of invalid values for this enum */
00090 } MemoryOS_CacheFlags;

enum MemoryOS_MemTypeFlags
 

Enumerates the types of memory allocation.

Enumerator:
MemoryOS_MemTypeFlags_Default  Default flags - virtually contiguous
MemoryOS_MemTypeFlags_Physical  Physically contiguous
MemoryOS_MemTypeFlags_Dma  Physically contiguous
MemoryOS_MemTypeFlags_EndValue  End delimiter indicating start of invalid values for this enum

Definition at line 95 of file MemoryDefs.h.

00095              {
00096     MemoryOS_MemTypeFlags_Default         = 0x00000000,
00097     /*!< Default flags - virtually contiguous */
00098     MemoryOS_MemTypeFlags_Physical        = 0x00000001,
00099     /*!< Physically contiguous */
00100     MemoryOS_MemTypeFlags_Dma             = 0x00000002,
00101     /*!< Physically contiguous */
00102     MemoryOS_MemTypeFlags_EndValue        = 0x00000003
00103     /*!< End delimiter indicating start of invalid values for this enum */
00104 } MemoryOS_MemTypeFlags;


Generated on Mon Mar 14 11:59:47 2011 for Syslink by  doxygen 1.4.4