Percepio Trace Recorder  v4.6.6
Trace Interval APIs

Macros

#define xTraceIntervalGetState(xIntervalChannelHandle, puxState)   xTraceEntryGetState((TraceEntryHandle_t)(xIntervalChannelHandle), TRC_INTERVAL_CHANNEL_SET_INDEX, puxState)
 Gets trace interval channel state. More...
 

Functions

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

Detailed Description

Macro Definition Documentation

◆ xTraceIntervalGetState

#define xTraceIntervalGetState (   xIntervalChannelHandle,
  puxState 
)    xTraceEntryGetState((TraceEntryHandle_t)(xIntervalChannelHandle), TRC_INTERVAL_CHANNEL_SET_INDEX, puxState)

Gets trace interval channel state.

Parameters
[in]xIntervalChannelHandlePointer to initialized trace interval.
[out]puxStateState.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceIntervalChannelCreate()

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

Creates trace interval channel.

Parameters
[in]szNameName.
[in]xIntervalChannelSetHandleInterval set that this channel belongs to.
[out]pxIntervalChannelHandlePointer to uninitialized trace interval channel.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceIntervalChannelSetCreate()

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

Creates trace interval channel set.

Parameters
[in]szNameName.
[out]pxIntervalChannelSetHandlePointer to uninitialized trace interval channel set.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceIntervalStart()

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

Starts trace interval instance.

Parameters
[in]xIntervalChannelHandleInterval handle.
[in]uxValueValue that can be used to tell instances apart.
[out]pxIntervalInstanceHandlePointer to interval instance variable.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceIntervalStop()

traceResult xTraceIntervalStop ( TraceIntervalChannelHandle_t  xIntervalChannelHandle,
TraceIntervalInstanceHandle_t  xIntervalInstanceHandle 
)

Stops trace interval instance.

Parameters
[in]xIntervalChannelHandleInterval handle.
[in]xIntervalInstanceHandleInterval instance.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess