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

Cache.h File Reference


Detailed Description

Defines Cache API interface.

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

Go to the source code of this file.

Defines

#define Cache_S_SUCCESS   0
 Operation is successful.
#define Cache_E_FAIL   -1
 Generic failure.

Enumerations

enum  Cache_Type {
  Cache_Type_L1P = 0x1, Cache_Type_L1D = 0x2, Cache_Type_L1 = 0x3, Cache_Type_L2P = 0x4,
  Cache_Type_L2D = 0x8, Cache_Type_L2 = 0xC, Cache_Type_ALL = 0xffff
}
enum  Cache_Mode { Cache_Mode_FREEZE, Cache_Mode_BYPASS, Cache_Mode_NORMAL }

Functions

Void Cache_inv (Ptr blockPtr, UInt32 byteCnt, Bits16 type, Bool wait)
 Invalidate the Cache module.
Void Cache_wb (Ptr blockPtr, UInt32 byteCnt, Bits16 type, Bool wait)
 Writeback the Cache module.
Void Cache_wbInv (Ptr blockPtr, UInt32 byteCnt, Bits16 type, Bool wait)
 Write Back and Invalidate the Cache module.
Void Cache_wait (Void)
 Wait for cache operation to complete.
enum Cache_Mode Cache_setMode (Bits16 type, enum Cache_Mode mode)
 Set the mode of Cache module.


Define Documentation

#define Cache_E_FAIL   -1
 

Generic failure.

Definition at line 74 of file Cache.h.

#define Cache_S_SUCCESS   0
 

Operation is successful.

Definition at line 68 of file Cache.h.


Enumeration Type Documentation

enum Cache_Mode
 

Lists of cache modes

Enumerator:
Cache_Mode_FREEZE 
Cache_Mode_BYPASS 
Cache_Mode_NORMAL 

Definition at line 93 of file Cache.h.

00093                 {
00094     Cache_Mode_FREEZE,
00095     Cache_Mode_BYPASS,
00096     Cache_Mode_NORMAL
00097 };

enum Cache_Type
 

Lists of bitmask cache types

Enumerator:
Cache_Type_L1P 
Cache_Type_L1D  Level 1 Program cache
Cache_Type_L1  Level 1 Data cache
Cache_Type_L2P  Level 1 caches
Cache_Type_L2D  Level 2 Program cache
Cache_Type_L2  Level 2 Data cache
Cache_Type_ALL  Level 2 caches

Definition at line 82 of file Cache.h.

00082                 {
00083     Cache_Type_L1P = 0x1,         /*! Level 1 Program cache */
00084     Cache_Type_L1D = 0x2,         /*! Level 1 Data cache */
00085     Cache_Type_L1  = 0x3,         /*! Level 1 caches */
00086     Cache_Type_L2P = 0x4,         /*! Level 2 Program cache */
00087     Cache_Type_L2D = 0x8,         /*! Level 2 Data cache */
00088     Cache_Type_L2  = 0xC,         /*! Level 2 caches */
00089     Cache_Type_ALL = 0xffff       /*! All caches */
00090 };


Function Documentation

Void Cache_inv Ptr  blockPtr,
UInt32  byteCnt,
Bits16  type,
Bool  wait
 

Invalidate the Cache module.

See also:
Cache_inv

enum Cache_Mode Cache_setMode Bits16  type,
enum Cache_Mode  mode
 

Set the mode of Cache module.

See also:
Cache_setMode

Void Cache_wait Void   ) 
 

Wait for cache operation to complete.

See also:
Cache_wait

Void Cache_wb Ptr  blockPtr,
UInt32  byteCnt,
Bits16  type,
Bool  wait
 

Writeback the Cache module.

See also:
Cache_wb

Void Cache_wbInv Ptr  blockPtr,
UInt32  byteCnt,
Bits16  type,
Bool  wait
 

Write Back and Invalidate the Cache module.

See also:
Cache_wbInv


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