This module is a proxy to the generic Cache module functions
as defined in ICache.xdc.
The actual implementations of the Cache module functions are
provided by the Cache module delegates.
Additional, family specific Cache module APIs may also be provided
by the Cache module delegates.
Follow the link below to determine which Cache delegate is used
for your Target/Device:
enum Cache.Type |
|
Lists of bitmask cache types
XDCscript usage |
meta-domain |
values of type Cache.Type
const Cache.Type_L1P;
// Level 1 Program cache
const Cache.Type_L1D;
// Level 1 Data cache
const Cache.Type_L1;
// Level 1 caches
const Cache.Type_L2P;
// Level 2 Program cache
const Cache.Type_L2D;
// Level 2 Data cache
const Cache.Type_L2;
// Level 2 caches
const Cache.Type_ALL;
// All caches
typedef enum Cache_Type {
Cache_Type_L1P,
// Level 1 Program cache
Cache_Type_L1D,
// Level 1 Data cache
Cache_Type_L1,
// Level 1 caches
Cache_Type_L2P,
// Level 2 Program cache
Cache_Type_L2D,
// Level 2 Data cache
Cache_Type_L2,
// Level 2 caches
Cache_Type_ALL
// All caches
} Cache_Type;
metaonly struct Cache.ModuleView |
|
XDCscript usage |
meta-domain |
var obj = new Cache.ModuleView;
obj.delegateCacheModule = String ...
metaonly config Cache.common$ // module-wide |
|
Common module configuration parameters
XDCscript usage |
meta-domain |
DETAILS
All modules have this configuration parameter. Its name
contains the '$' character to ensure it does not conflict with
configuration parameters declared by the module. This allows
new configuration parameters to be added in the future without
any chance of breaking existing modules.
metaonly config Cache.rovViewInfo // module-wide |
|
XDCscript usage |
meta-domain |
Cache.disable( ) // module-wide |
|
Disables the 'type' cache(s)
Void Cache_disable( Bits16 type );
ARGUMENTS
type
bit mask of Cache type
Cache.enable( ) // module-wide |
|
Enables all cache(s)
Void Cache_enable( Bits16 type );
ARGUMENTS
type
bit mask of Cache type
Cache.inv( ) // module-wide |
|
Invalidate the range of memory within the specified starting
address and byte count. The range of addresses operated on
gets quantized to whole cache lines in each cache. All lines
in range are invalidated for all the 'type' caches
Void Cache_inv( Ptr blockPtr, SizeT byteCnt, Bits16 type, Bool wait );
ARGUMENTS
blockPtr
start address of range to be invalidated
byteCnt
number of bytes to be invalidated
type
bit mask of Cache type
wait
wait until the operation is completed
Cache.wait( ) // module-wide |
|
Wait for a previous cache operation to complete
DETAILS
Wait for the cache wb/wbInv/inv operation to complete. A cache
operation is not truly complete until it has worked its way
through all buffering and all memory writes have landed in the
source memory.
Cache.wb( ) // module-wide |
|
Writes back a range of memory from all cache(s)
Void Cache_wb( Ptr blockPtr, SizeT byteCnt, Bits16 type, Bool wait );
ARGUMENTS
blockPtr
start address of range to be invalidated
byteCnt
number of bytes to be invalidated
type
bit mask of Cache type
wait
wait until the operation is completed
DETAILS
Writes back the range of memory within the specified starting
address and byte count. The range of addresses operated on
gets quantized to whole cache lines in each cache. All lines
within the range are left valid in the 'type' caches and the data
within the range will be written back to the source memory.
Cache.wbInv( ) // module-wide |
|
Writes back and invalidates the range of memory within the
specified starting address and byte count. The range of
addresses operated on gets quantized to whole cache lines in
each cache. All lines within the range are written back to the
source memory and then invalidated for all 'type' caches
Void Cache_wbInv( Ptr blockPtr, SizeT byteCnt, Bits16 type, Bool wait );
ARGUMENTS
blockPtr
start address of range to be invalidated
byteCnt
number of bytes to be invalidated
type
bit mask of Cache type
wait
wait until the operation is completed
module-wide built-ins |
|
// Get this module's unique id
Bool Cache_Module_startupDone( );
// Test if this module has completed startup
// The heap from which this module allocates memory
Bool Cache_Module_hasMask( );
// Test whether this module has a diagnostics mask
Bits16 Cache_Module_getMask( );
// Returns the diagnostics mask for this module
Void Cache_Module_setMask( Bits16 mask );
// Set the diagnostics mask for this module