Trace Timestamp APIs

Data Structures
struct	TraceTimestampData
	Trace Timestamp Structure. More...

Macros
#define	xTraceTimestampGet(puiTimestamp)
	Gets current trace timestamp.
#define	xTraceTimestampGetWraparounds(puiTimerWraparounds)
	Gets trace timestamp wraparounds.
#define	xTraceTimestampSetFrequency(uxFrequency)
	Sets trace timestamp frequency.
#define	xTraceTimestampSetPeriod(uiPeriod)
	Sets trace timestamp period.
#define	xTraceTimestampSetOsTickCount(uiOsTickCount)
	Sets trace timestamp OS tick count.
#define	xTraceTimestampGetFrequency(puxFrequency)
	Gets trace timestamp frequency.
#define	xTraceTimestampGetPeriod(puiPeriod)
	Gets trace timestamp period.
#define	xTraceTimestampGetOsTickCount(puiOsTickCount)
	Gets trace timestamp OS tick count.

Typedefs
typedef struct TraceTimestampData	TraceTimestampData_t
	Trace Timestamp Structure.

Detailed Description

Macro Definition Documentation

xTraceTimestampGet

#define xTraceTimestampGet

(

puiTimestamp

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4(*(puiTimestamp) = ((TRC_HWTC_COUNT) & 0x00FFFFFFU) + ((pxTraceTimestamp->osTickCount & 0x000000FFU) << 24), pxTraceTimestamp->wraparounds = pxTraceTimestamp->osTickCount, pxTraceTimestamp->latestTimestamp = *(puiTimestamp), TRC_SUCCESS)

Gets current trace timestamp.

Parameters

[out]

puiTimestamp

Timestamp.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampGetFrequency

#define xTraceTimestampGetFrequency

(

puxFrequency

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puxFrequency) = pxTraceTimestamp->frequency, TRC_SUCCESS)

Gets trace timestamp frequency.

Parameters

[out]

puxFrequency

Frequency.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampGetOsTickCount

#define xTraceTimestampGetOsTickCount

(

puiOsTickCount

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiOsTickCount) = pxTraceTimestamp->osTickCount, TRC_SUCCESS)

Gets trace timestamp OS tick count.

Parameters

[in]

puiOsTickCount

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampGetPeriod

#define xTraceTimestampGetPeriod

(

puiPeriod

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiPeriod) = pxTraceTimestamp->period, TRC_SUCCESS)

Gets trace timestamp period.

Parameters

[out]

puiPeriod

Period.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampGetWraparounds

#define xTraceTimestampGetWraparounds

(

puiTimerWraparounds

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiTimerWraparounds) = pxTraceTimestamp->wraparounds, TRC_SUCCESS)

Gets trace timestamp wraparounds.

Parameters

[out]

puiTimerWraparounds

Timer wraparounds.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampSetFrequency

#define xTraceTimestampSetFrequency

(

uxFrequency

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->frequency = uxFrequency, TRC_SUCCESS)

Sets trace timestamp frequency.

Parameters

[in]

uxFrequency

Frequency.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampSetOsTickCount

#define xTraceTimestampSetOsTickCount

(

uiOsTickCount

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->osTickCount = uiOsTickCount, TRC_SUCCESS)

Sets trace timestamp OS tick count.

Parameters

[in]

uiOsTickCount

OS tick count.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceTimestampSetPeriod

#define xTraceTimestampSetPeriod

(

uiPeriod

)

Value:

TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->period = uiPeriod, TRC_SUCCESS)

Sets trace timestamp period.

Parameters

[in]

uiPeriod

Period.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success