Percepio Trace Recorder  v4.6.6
Trace Timestamp APIs

Data Structures

struct  TraceTimestamp
 Trace Timestamp Structure. More...
 

Macros

#define xTraceTimestampGet(puiTimestamp)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4(*(puiTimestamp) = TRC_HWTC_COUNT, (*(puiTimestamp) < pxTraceTimestamp->latestTimestamp) ? pxTraceTimestamp->wraparounds++ : 0, pxTraceTimestamp->latestTimestamp = *(puiTimestamp), TRC_SUCCESS)
 Gets current trace timestamp. More...
 
#define xTraceTimestampGetWraparounds(puiTimerWraparounds)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiTimerWraparounds) = pxTraceTimestamp->wraparounds, TRC_SUCCESS)
 Gets trace timestamp wraparounds. More...
 
#define xTraceTimestampSetFrequency(uxFrequency)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->frequency = uxFrequency, TRC_SUCCESS)
 Sets trace timestamp frequency. More...
 
#define xTraceTimestampSetPeriod(uiPeriod)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->period = uiPeriod, TRC_SUCCESS)
 Sets trace timestamp period. More...
 
#define xTraceTimestampSetOsTickCount(uiOsTickCount)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->osTickCount = uiOsTickCount, TRC_SUCCESS)
 Sets trace timestamp OS tick count. More...
 
#define xTraceTimestampGetFrequency(puxFrequency)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puxFrequency) = pxTraceTimestamp->frequency, TRC_SUCCESS)
 Gets trace timestamp frequency. More...
 
#define xTraceTimestampGetPeriod(puiPeriod)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiPeriod) = pxTraceTimestamp->period, TRC_SUCCESS)
 Gets trace timestamp period. More...
 
#define xTraceTimestampGetOsTickCount(puiOsTickCount)   TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puiOsTickCount) = pxTraceTimestamp->osTickCount, TRC_SUCCESS)
 Gets trace timestamp OS tick count. More...
 

Typedefs

typedef struct TraceTimestamp TraceTimestamp_t
 Trace Timestamp Structure.
 

Detailed Description

Macro Definition Documentation

◆ xTraceTimestampGet

#define xTraceTimestampGet (   puiTimestamp)    TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4(*(puiTimestamp) = TRC_HWTC_COUNT, (*(puiTimestamp) < pxTraceTimestamp->latestTimestamp) ? pxTraceTimestamp->wraparounds++ : 0, pxTraceTimestamp->latestTimestamp = *(puiTimestamp), TRC_SUCCESS)

Gets current trace timestamp.

Parameters
[out]puiTimestampTimestamp.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampGetFrequency

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

Gets trace timestamp frequency.

Parameters
[out]puxFrequencyFrequency.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampGetOsTickCount

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

Gets trace timestamp OS tick count.

Parameters
[in]puiOsTickCount
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampGetPeriod

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

Gets trace timestamp period.

Parameters
[out]puiPeriodPeriod.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampGetWraparounds

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

Gets trace timestamp wraparounds.

Parameters
[out]puiTimerWraparoundsTimer wraparounds.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampSetFrequency

#define xTraceTimestampSetFrequency (   uxFrequency)    TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->frequency = uxFrequency, TRC_SUCCESS)

Sets trace timestamp frequency.

Parameters
[in]uxFrequencyFrequency.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampSetOsTickCount

#define xTraceTimestampSetOsTickCount (   uiOsTickCount)    TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->osTickCount = uiOsTickCount, TRC_SUCCESS)

Sets trace timestamp OS tick count.

Parameters
[in]uiOsTickCountOS tick count.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceTimestampSetPeriod

#define xTraceTimestampSetPeriod (   uiPeriod)    TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceTimestamp->period = uiPeriod, TRC_SUCCESS)

Sets trace timestamp period.

Parameters
[in]uiPeriodPeriod.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess