module ti.uia.runtime.LoggerTypes

Function pointer type definitions for various types of loggers

This module defines function prototypes for use in defining callback functions that support device-specific features (e.g. synchronization with CPU Trace) and support customization and extensibility of core UIA features (e.g. logging a range of memory values).
C synopsis target-domain sourced in ti/uia/runtime/LoggerTypes.xdc
 
typedef LoggerTypes_InjectIntoTraceFxn

Callback function that injects syncPoint info into GEM Trace

C synopsis target-domain
typedef Void (*LoggerTypes_InjectIntoTraceFxn)(UInt32,IUIATraceSyncProvider_ContextType);
 
VALUES
serialNum — the serial number that is to be injected
ctxType — the context type ID to be injected into the trace
DETAILS
This callback function injects correlation info into the trace stream to enable correlation between software events and hardware trace.
SEE
 
typedef LoggerTypes_LogMemoryRangeFxn

Log an event along with values from a range of memory addresses

C synopsis target-domain
typedef Void (*LoggerTypes_LogMemoryRangeFxn)(Ptr,Log_Event,UInt32,UInt32,IArg,IArg,IArg,IArg,IArg);
 
VALUES
ptr — module instance object handle
evt — event to be logged
snapshotId — 0 = no other snapshot groups, Use value from LogSnapshot.getSnapshotId() for all snapshots to be grouped.
fileName — __FILE__ result
lineNum — __LINE__ result
fmt — a printf style format string
startAdrs — value for first format conversion character
lengthInMAUs — value for second format conversion character
DETAILS
Note that this function can support logging of null terminated strings, arrays of characters and memory mapped registgers as well as blocks of memory. The LogSnapshot module uses this callback function. Modules that implement the ILoggerSnapshot interface provide implementations of this callback function.
SEE
Module-Wide Built-Ins

C synopsis target-domain
Types_ModuleId LoggerTypes_Module_id();
// Get this module's unique id
 
Bool LoggerTypes_Module_startupDone();
// Test if this module has completed startup
 
IHeap_Handle LoggerTypes_Module_heap();
// The heap from which this module allocates memory
 
Bool LoggerTypes_Module_hasMask();
// Test whether this module has a diagnostics mask
 
Bits16 LoggerTypes_Module_getMask();
// Returns the diagnostics mask for this module
 
Void LoggerTypes_Module_setMask(Bits16 mask);
// Set the diagnostics mask for this module
 
Configuration settings sourced in ti/uia/runtime/LoggerTypes.xdc
var LoggerTypes = xdc.useModule('ti.uia.runtime.LoggerTypes');
module-wide config parameters
 
 
metaonly config LoggerTypes.common$  // module-wide

Common module configuration parameters

Configuration settings
LoggerTypes.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 Tue, 14 Feb 2017 00:15:16 GMT