Cache.h File Reference

---

Detailed Description

Defines Cache API interface.

Go to the source code of this file.

Macros
#define	Cache_S_ALREADYSETUP   (1)
	Cache module is already setup.
#define	Cache_S_SUCCESS   (0)
	Operation is successful.
#define	Cache_E_FAIL   (-1)
	Generic failure.
#define	Cache_E_INVALIDARG   (-2)
	Argument passed to a function is invalid.
#define	Cache_E_OSFAILURE   (-3)
	Failure in OS call.

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.

---

Macro Definition Documentation

#define Cache_S_ALREADYSETUP   (1)

Cache module is already setup.

#define Cache_S_SUCCESS   (0)

Operation is successful.

#define Cache_E_FAIL   (-1)

Generic failure.

#define Cache_E_INVALIDARG   (-2)

Argument passed to a function is invalid.

#define Cache_E_OSFAILURE   (-3)

Failure in OS call.

---

Enumeration Type Documentation

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

enum Cache_Mode

Lists of cache modes

Enumerator:

Cache_Mode_FREEZE
Cache_Mode_BYPASS
Cache_Mode_NORMAL

---

Function Documentation

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

Invalidate the Cache module.

See also:

Cache_inv

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

Void Cache_wait

(

Void

)

Wait for cache operation to complete.

See also:

Cache_wait

enum Cache_Mode Cache_setMode	(	Bits16	type,
		enum Cache_Mode	mode
	)

Set the mode of Cache module.

See also:

Cache_setMode