Trace Runnable APIs

Macros
#define	xTraceRunnableStart(xRunnableHandle)
	Creates an event indicating a runnable started.
#define	xTraceRunnableStop()
	Creates an event indicating a runnable stopped.
#define	xTraceRunnableRegisterStaticSet(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)
	Registers a set of static runnables. Requires XML configuration to properly interpret.
#define	xTraceRunnableStartStatic(xRunnableSetHandle, uiRunnableId)
	Start a static runnable. Requires XML configuration to properly interpret.
#define	xTraceRunnableStopStatic()
	Stop a static runnable. Requires XML configuration to properly interpret.

Functions
traceResult	xTraceRunnableRegister (const char *szName, TraceRunnableRegisterMethod_t uxRegisterMethod, TraceRunnableHandle_t *pxRunnableHandle)
	Registers a runnable. Can be called multiple times, will not create additional entries.

Detailed Description

Macro Definition Documentation

xTraceRunnableRegisterStaticSet

#define xTraceRunnableRegisterStaticSet	(		szName,
			uiMajor,
			uiMinor,
			uiPatch,
			uiRunnableCount,
			pxRunnableSetHandle )

Value:

xTraceExtensionCreate(szName, uiMajor, uiMinor, uiPatch, uiRunnableCount, pxRunnableSetHandle)

Registers a set of static runnables. Requires XML configuration to properly interpret.

Parameters

[in]	szName	Name.
[in]	uiMajor	Major version.
[in]	uiMinor	Minor version.
[in]	uiPatch	Patch version.
[in]	uiRunnableCount	Runnables count.
[out]	pxRunnableSetHandle	Pointer to uninitialized TraceRunnableStaticSetHandle_t.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceRunnableStart

#define xTraceRunnableStart

(

xRunnableHandle

)

Value:

xTraceEventCreate1(PSF_EVENT_RUNNABLE_START, (TraceUnsignedBaseType_t)(xRunnableHandle))

Creates an event indicating a runnable started.

Parameters

[in]

xRunnableHandle

Runnable handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceRunnableStartStatic

#define xTraceRunnableStartStatic	(		xRunnableSetHandle,
			uiRunnableId )

Value:

xTraceEventCreate0(xTraceExtensionGetEventId(xRunnableSetHandle, uiRunnableId))

Start a static runnable. Requires XML configuration to properly interpret.

Parameters

[in]	xRunnableSetHandle	Handle to initialized runnable set.
[in]	uiRunnableId	Index in the runnable set.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceRunnableStop

#define xTraceRunnableStop

(

)

Value:

xTraceEventCreate0(PSF_EVENT_RUNNABLE_STOP)

Creates an event indicating a runnable stopped.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceRunnableStopStatic

#define xTraceRunnableStopStatic

(

)

Value:

xTraceRunnableStop()

Stop a static runnable. Requires XML configuration to properly interpret.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Function Documentation

xTraceRunnableRegister()

traceResult xTraceRunnableRegister	(	const char *	szName,
		TraceRunnableRegisterMethod_t	uxRegisterMethod,
		TraceRunnableHandle_t *	pxRunnableHandle )

Registers a runnable. Can be called multiple times, will not create additional entries.

Parameters

[in]	szName	Name.
[in]	uxRegisterMethod	Indicates how to register the runnable. Since there can be thousands of runnables, storing in entry table is not always a good idea. TRC_RUNNABLE_REGISTER_METHOD_USE_ENTRY_TABLE: Store in entry table normally and handle will point to entry. TRC_RUNNABLE_REGISTER_METHOD_USE_STRING_ADDRESS: For this method the string address must be unique and will be used as handle value. TRC_RUNNABLE_REGISTER_METHOD_USE_HANDLE_ADDRESS: For this method the handle address must be unique and will be used as handle value.
[out]	pxRunnableHandle	Pointer to zero-initialized TraceRunnableHandle_t. If handle that is pointed to is not 0 no entry will be created.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success