module xdc.runtime.knl.CacheSupportNull
index URL

Empty ICacheSupport implementation

C synopsis target-domain sourced in xdc/runtime/knl/CacheSupportNull.xdc
#include <xdc/runtime/knl/CacheSupportNull.h>
Functions common to all ICacheSupport modules
Bool 
CacheSupportNull_inv// Invalidates range of memory(Ptr blockPtr, SizeT byteCnt, Bool wait, Error_Block *eb);
Bool 
CacheSupportNull_wait// Wait for a previous cache operation to complete(Error_Block *eb);
Bool 
CacheSupportNull_wb// Writes a range of memory from all cache(s)(Ptr blockPtr, SizeT byteCnt, Bool wait, Error_Block *eb);
Bool 
CacheSupportNull_wbInv// Writes back and invalidates range fo memory(Ptr blockPtr, SizeT byteCnt, Bool wait, Error_Block *eb);
Functions common to all target modules
CacheSupportNull_Module_getMask// Returns the diagnostics mask for this module, CacheSupportNull_Module_hasMask// Test whether this module has a diagnostics mask, CacheSupportNull_Module_heap// The heap from which this module allocates memory, CacheSupportNull_Module_id// Get this module's unique id, CacheSupportNull_Module_setMask// Set the diagnostics mask for this module, CacheSupportNull_Module_startupDone// Test if this module has completed startup
 
 
CacheSupportNull_inv()  // module-wide
index URL

Invalidates range of memory

C synopsis target-domain
Bool CacheSupportNull_inv(Ptr blockPtr, SizeT byteCnt, Bool wait, Error_Block *eb);
 
ARGUMENTS
blockPtr — start address of range to be invalidated
byteCnt — number of bytes to be invalidated
wait — wait until the operation is completed
eb — error block
DETAILS
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.
RETURNS
true for success; false for error.
 
CacheSupportNull_wait()  // module-wide
index URL

Wait for a previous cache operation to complete

C synopsis target-domain
Bool CacheSupportNull_wait(Error_Block *eb);
 
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.
RETURNS
true for success; false for error.
 
CacheSupportNull_wb()  // module-wide
index URL

Writes a range of memory from all cache(s)

C synopsis target-domain
Bool CacheSupportNull_wb(Ptr blockPtr, SizeT byteCnt, Bool wait, Error_Block *eb);
 
ARGUMENTS
blockPtr — start address of range to be invalidated
byteCnt — number of bytes to be invalidated
wait — wait until the operation is completed
eb — error block
DETAILS
Writes 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 to the source memory.
RETURNS
true for success; false for error.
 
CacheSupportNull_wbInv()  // module-wide
index URL

Writes back and invalidates range fo memory

C synopsis target-domain
Bool CacheSupportNull_wbInv(Ptr blockPtr, SizeT byteCnt, Bool wait, Error_Block *eb);
 
ARGUMENTS
blockPtr — start address of range to be invalidated
byteCnt — number of bytes to be invalidated
wait — wait until the operation is completed
eb — error block
DETAILS
Writes 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 to the source memory and then invalidated for all 'type' caches.
RETURNS
true for success; false for error.
Module-Wide Built-Ins
index URL

C synopsis target-domain
Types_ModuleId CacheSupportNull_Module_id();
// Get this module's unique id
 
Bool CacheSupportNull_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle CacheSupportNull_Module_heap();
// The heap from which this module allocates memory
 
Bool CacheSupportNull_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 CacheSupportNull_Module_getMask();
// Returns the diagnostics mask for this module
 
Void CacheSupportNull_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
XDCscript usage meta-domain sourced in xdc/runtime/knl/CacheSupportNull.xdc
var CacheSupportNull = xdc.useModule('xdc.runtime.knl.CacheSupportNull');
module-wide config parameters
    CacheSupportNull.common$// Common module configuration parameters = Types.Common$ undefined;
 
 
metaonly config CacheSupportNull.common$  // module-wide
index URL

Common module configuration parameters

XDCscript usage meta-domain
CacheSupportNull.common$ = Types.Common$ undefined;
 
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.
generated on Thu, 27 Sep 2012 23:21:09 GMT