Trace Interval APIs

Macros
#define	xTraceIntervalGetState(xIntervalChannelHandle, puxState)
	Gets trace interval channel state.

Functions
traceResult	xTraceIntervalChannelSetCreate (const char *szName, TraceIntervalChannelSetHandle_t *pxIntervalChannelSetHandle)
	Creates trace interval channel set.
traceResult	xTraceIntervalChannelCreate (const char *szName, TraceIntervalChannelSetHandle_t xIntervalChannelSetHandle, TraceIntervalChannelHandle_t *pxIntervalChannelHandle)
	Creates trace interval channel.
traceResult	xTraceIntervalStart (TraceIntervalChannelHandle_t xIntervalChannelHandle, TraceUnsignedBaseType_t uxValue, TraceIntervalInstanceHandle_t *pxIntervalInstanceHandle)
	Starts trace interval instance.
traceResult	xTraceIntervalStop (TraceIntervalChannelHandle_t xIntervalChannelHandle, TraceIntervalInstanceHandle_t xIntervalInstanceHandle)
	Stops trace interval instance.

Detailed Description

Macro Definition Documentation

xTraceIntervalGetState

#define xTraceIntervalGetState	(		xIntervalChannelHandle,
			puxState )

Value:

xTraceEntryGetState((TraceEntryHandle_t)(xIntervalChannelHandle), TRC_INTERVAL_CHANNEL_SET_INDEX, puxState)

Gets trace interval channel state.

Parameters

[in]	xIntervalChannelHandle	Pointer to initialized trace interval.
[out]	puxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Function Documentation

xTraceIntervalChannelCreate()

traceResult xTraceIntervalChannelCreate	(	const char *	szName,
		TraceIntervalChannelSetHandle_t	xIntervalChannelSetHandle,
		TraceIntervalChannelHandle_t *	pxIntervalChannelHandle )

Creates trace interval channel.

Parameters

[in]	szName	Name.
[in]	xIntervalChannelSetHandle	Interval set that this channel belongs to.
[out]	pxIntervalChannelHandle	Pointer to uninitialized trace interval channel.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceIntervalChannelSetCreate()

traceResult xTraceIntervalChannelSetCreate	(	const char *	szName,
		TraceIntervalChannelSetHandle_t *	pxIntervalChannelSetHandle )

Creates trace interval channel set.

Parameters

[in]	szName	Name.
[out]	pxIntervalChannelSetHandle	Pointer to uninitialized trace interval channel set.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceIntervalStart()

traceResult xTraceIntervalStart	(	TraceIntervalChannelHandle_t	xIntervalChannelHandle,
		TraceUnsignedBaseType_t	uxValue,
		TraceIntervalInstanceHandle_t *	pxIntervalInstanceHandle )

Starts trace interval instance.

Parameters

[in]	xIntervalChannelHandle	Interval handle.
[in]	uxValue	Value that can be used to tell instances apart.
[out]	pxIntervalInstanceHandle	Pointer to interval instance variable.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceIntervalStop()

traceResult xTraceIntervalStop	(	TraceIntervalChannelHandle_t	xIntervalChannelHandle,
		TraceIntervalInstanceHandle_t	xIntervalInstanceHandle )

Stops trace interval instance.

Parameters

[in]	xIntervalChannelHandle	Interval handle.
[in]	xIntervalInstanceHandle	Interval instance.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success