module ti.uiactools.runtime.SyncSTM

index URL

code for injecting sync point info into the System Trace (STM) stream

C synopsis
Individual elements
XDCscript usage
Individual elements

C synopsis target-domain sourced in ti/uiactools/runtime/SyncSTM.xdc

#include <ti/uiactools/runtime/SyncSTM.h>

Functions common to all IUIATraceSyncProvider modules
Void	SyncSTM_injectIntoTrace// Inject syncPoint info into System Trace(UInt32 serialNum, IUIATraceSyncProvider_ContextType ctxType);
Functions common to all target modules
	SyncSTM_Module_getMask// Returns the diagnostics mask for this module, SyncSTM_Module_hasMask// Test whether this module has a diagnostics mask, SyncSTM_Module_heap// The heap from which this module allocates memory, SyncSTM_Module_id// Get this module's unique id, SyncSTM_Module_setMask// Set the diagnostics mask for this module, SyncSTM_Module_startupDone// Test if this module has completed startup
Typedefs
typedef enum	SyncSTM_ContextType// Enumeration of the various types of packet headers. Stored in a 4 bit bitfield (b31-b28) of the first word in the packet ...
Constants
extern const Bool	SyncSTM_isC6XTraceSyncEnabled// Configures whether Sync point information is injected into the C6X hardware trace or not;

enum SyncSTM_ContextType

index URL

Enumeration of the various types of packet headers. Stored in a 4 bit bitfield (b31-b28) of the first word in the packet

C synopsis target-domain

typedef enum SyncSTM_ContextType {

SyncSTM_ContextType_Reserved0,

// reserved for future use

SyncSTM_ContextType_SyncPoint,

// Sync Point event serial number

SyncSTM_ContextType_ContextChange,

// Context Change event serial number

SyncSTM_ContextType_Snapshot,

// Snapshot event Snapshot ID

SyncSTM_ContextType_Reserved4,

// reserved for future use

SyncSTM_ContextType_Reserved5,

// reserved for future use

SyncSTM_ContextType_Reserved6,

// reserved for future use

SyncSTM_ContextType_Reserved7,

// reserved for future use

SyncSTM_ContextType_Reserved8,

// reserved for future use

SyncSTM_ContextType_Reserved9,

// reserved for future use

SyncSTM_ContextType_Reserved10,

// reserved for future use

SyncSTM_ContextType_Reserved11,

// reserved for future use

SyncSTM_ContextType_Reserved12,

// reserved for future use

SyncSTM_ContextType_Reserved13,

// reserved for future use

SyncSTM_ContextType_Global32bTimestamp,

// 32b Global Timestamp

SyncSTM_ContextType_User

// User defined data

} SyncSTM_ContextType;

config SyncSTM_isC6XTraceSyncEnabled // module-wide

index URL

Configures whether Sync point information is injected into the C6X hardware trace or not

C synopsis target-domain

extern const Bool SyncSTM_isC6XTraceSyncEnabled;

SyncSTM_injectIntoTrace() // module-wide

index URL

Inject syncPoint info into System Trace

C synopsis target-domain

Void SyncSTM_injectIntoTrace(UInt32 serialNum, IUIATraceSyncProvider_ContextType ctxType);

ARGUMENTS

serialNum — the serial number that is to be injected

ctxType — the context type ID to be injected into the trace

the CtxChg_ContextType constant that describes what context info the 2 words contain

serialNumber — a sync point serial number to inject into the trace stream

DETAILS

This method logs a sync point event and injects correlation info into the trace stream (if available) to enable correlation between software events and hardware trace.

This method logs a sync point event and injects correlation info into the System Trace stream (if available) to enable correlation between software events and System trace events.

Module-Wide Built-Ins

index URL

C synopsis target-domain

Types_ModuleId SyncSTM_Module_id();

// Get this module's unique id

Bool SyncSTM_Module_startupDone();

// Test if this module has completed startup

IHeap_Handle SyncSTM_Module_heap();

// The heap from which this module allocates memory

Bool SyncSTM_Module_hasMask();

// Test whether this module has a diagnostics mask

Bits16 SyncSTM_Module_getMask();

// Returns the diagnostics mask for this module

Void SyncSTM_Module_setMask(Bits16 mask);

// Set the diagnostics mask for this module

XDCscript usage meta-domain sourced in ti/uiactools/runtime/SyncSTM.xdc

var SyncSTM = xdc.useModule('ti.uiactools.runtime.SyncSTM');

module-wide constants & types

values of type SyncSTM.ContextType// Enumeration of the various types of packet headers. Stored in a 4 bit bitfield (b31-b28) of the first word in the packet

const SyncSTM.ContextType_Reserved0// reserved for future use;

const SyncSTM.ContextType_SyncPoint// Sync Point event serial number;

const SyncSTM.ContextType_ContextChange// Context Change event serial number;

const SyncSTM.ContextType_Snapshot// Snapshot event Snapshot ID;

const SyncSTM.ContextType_Reserved4// reserved for future use;

const SyncSTM.ContextType_Reserved5// reserved for future use;

const SyncSTM.ContextType_Reserved6// reserved for future use;

const SyncSTM.ContextType_Reserved7// reserved for future use;

const SyncSTM.ContextType_Reserved8// reserved for future use;

const SyncSTM.ContextType_Reserved9// reserved for future use;

const SyncSTM.ContextType_Reserved10// reserved for future use;

const SyncSTM.ContextType_Reserved11// reserved for future use;

const SyncSTM.ContextType_Reserved12// reserved for future use;

const SyncSTM.ContextType_Reserved13// reserved for future use;

const SyncSTM.ContextType_Global32bTimestamp// 32b Global Timestamp;

const SyncSTM.ContextType_User// User defined data;

module-wide config parameters

SyncSTM.isC6XTraceSyncEnabled// Configures whether Sync point information is injected into the C6X hardware trace or not = Bool false;

SyncSTM.common$// Common module configuration parameters = Types.Common$ undefined;

enum SyncSTM.ContextType

index URL

Enumeration of the various types of packet headers. Stored in a 4 bit bitfield (b31-b28) of the first word in the packet

XDCscript usage meta-domain

values of type SyncSTM.ContextType

const SyncSTM.ContextType_Reserved0;

// reserved for future use

const SyncSTM.ContextType_SyncPoint;

// Sync Point event serial number

const SyncSTM.ContextType_ContextChange;

// Context Change event serial number

const SyncSTM.ContextType_Snapshot;

// Snapshot event Snapshot ID

const SyncSTM.ContextType_Reserved4;

// reserved for future use

const SyncSTM.ContextType_Reserved5;

// reserved for future use

const SyncSTM.ContextType_Reserved6;

// reserved for future use

const SyncSTM.ContextType_Reserved7;

// reserved for future use

const SyncSTM.ContextType_Reserved8;

// reserved for future use

const SyncSTM.ContextType_Reserved9;

// reserved for future use

const SyncSTM.ContextType_Reserved10;

// reserved for future use

const SyncSTM.ContextType_Reserved11;

// reserved for future use

const SyncSTM.ContextType_Reserved12;

// reserved for future use

const SyncSTM.ContextType_Reserved13;

// reserved for future use

const SyncSTM.ContextType_Global32bTimestamp;

// 32b Global Timestamp

const SyncSTM.ContextType_User;

// User defined data

C SYNOPSIS

SyncSTM_ContextType

config SyncSTM.isC6XTraceSyncEnabled // module-wide

index URL

Configures whether Sync point information is injected into the C6X hardware trace or not

XDCscript usage meta-domain

SyncSTM.isC6XTraceSyncEnabled = Bool false;

C SYNOPSIS

SyncSTM_isC6XTraceSyncEnabled

metaonly config SyncSTM.common$ // module-wide

index URL

Common module configuration parameters

XDCscript usage meta-domain

SyncSTM.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 Wed, 27 Jun 2012 04:11:42 GMT