Percepio Trace Recorder  v4.6.6
Trace Event APIs

Macros

#define xTraceEventBegin(uiEventCode, uiTotalPayloadSize, pxEventHandle)   (xTraceIsRecorderEnabled() ? xTraceEventBeginOffline(uiEventCode, uiTotalPayloadSize, pxEventHandle) : TRC_FAIL)
 Begins a trace event. More...
 
#define xTraceEventEnd(xEventHandle)   (xTraceIsRecorderEnabled() == 0 ? TRC_FAIL : xTraceEventEndOffline(xEventHandle))
 Ends a trace event. More...
 
#define xTraceEventGetSize(pvAddress, puiSize)   (*(uint32_t*)(puiSize) = sizeof(TraceBaseEvent_t) + (TRC_EVENT_GET_PARAM_COUNT(((TraceBaseEvent_t*)(pvAddress))->EventID)) * sizeof(uint32_t), TRC_SUCCESS)
 Gets trace event size. More...
 
#define xTraceEventGetRawData   TRC_EVENT_GET_RAW_DATA
 Gets trace event data pointer with an offset. More...
 
#define xTraceEventGetPayload   TRC_EVENT_GET_PAYLOAD
 Gets trace event payload pointer with an offset. More...
 
#define xTraceEventPayloadRemaining   TRC_EVENT_PAYLOAD_REMAINING
 Gets the amount of remaining trace event payload. More...
 
#define xTraceEventPayloadUsed   TRC_EVENT_PAYLOAD_USED
 Gets the amount of used trace event payload. More...
 
#define xTraceEventPayloadSize   TRC_EVENT_PAYLOAD_SIZE
 Gets trace event payload size. More...
 
#define xTraceEventAddUnsignedBaseType   TRC_EVENT_ADD_UNSIGNED_BASE_TYPE
 Adds an unsigned base type value as trace event payload. More...
 
#define xTraceEventAdd32   TRC_EVENT_ADD_32
 Adds an uint32_t as trace event payload. More...
 
#define xTraceEventAdd16   TRC_EVENT_ADD_16
 Adds an uint16_t as trace event payload. More...
 
#define xTraceEventAdd8   TRC_EVENT_ADD_8
 Adds an uint8_t as trace event payload. More...
 

Functions

traceResult xTraceEventGetSize (void *pvAddress, uint32_t *puiSize)
 Gets trace event size. More...
 
traceResult xTraceEventAddData (TraceEventHandle_t xEventHandle, void *pvData, uint32_t uiSize)
 Adds data to event payload. More...
 

Detailed Description

Macro Definition Documentation

◆ xTraceEventAdd16

#define xTraceEventAdd16   TRC_EVENT_ADD_16

Adds an uint16_t as trace event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]valueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventAdd32

#define xTraceEventAdd32   TRC_EVENT_ADD_32

Adds an uint32_t as trace event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]valueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventAdd8

#define xTraceEventAdd8   TRC_EVENT_ADD_8

Adds an uint8_t as trace event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]valueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventAddUnsignedBaseType

#define xTraceEventAddUnsignedBaseType   TRC_EVENT_ADD_UNSIGNED_BASE_TYPE

Adds an unsigned base type value as trace event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]uxValueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventBegin

#define xTraceEventBegin (   uiEventCode,
  uiTotalPayloadSize,
  pxEventHandle 
)    (xTraceIsRecorderEnabled() ? xTraceEventBeginOffline(uiEventCode, uiTotalPayloadSize, pxEventHandle) : TRC_FAIL)

Begins a trace event.

This routine begins a trace event with specified size. Must call xTraceEventEnd() to finalize event creation. Does not care about RecorderEnabled.

Parameters
[in]uiSizeSize.
[in]pxEventHandlePointer to initialized trace event.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventEnd

#define xTraceEventEnd (   xEventHandle)    (xTraceIsRecorderEnabled() == 0 ? TRC_FAIL : xTraceEventEndOffline(xEventHandle))

Ends a trace event.

This routine ends the event that was begun by calling on xTraceEventBegin(). Does not care about uiRecorderEnabled.

Parameters
[in]xEventHandlePointer to initialized trace event.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventGetPayload

#define xTraceEventGetPayload   TRC_EVENT_GET_PAYLOAD

Gets trace event payload pointer with an offset.

This routine gets a trace event payload pointer with an offset. It also verifies that the size so it won't go outside its payload buffer.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]uiOffsetOffset.
[in]uiSizeSize.
[out]ppvDataData.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventGetRawData

#define xTraceEventGetRawData   TRC_EVENT_GET_RAW_DATA

Gets trace event data pointer with an offset.

This routine gets a trace event data pointer with an offset. It also verfies that the size so it won't go outside its buffer.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]uiOffsetOffset.
[in]uiSizeSize.
[out]ppvDataData.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventGetSize

#define xTraceEventGetSize (   pvAddress,
  puiSize 
)    (*(uint32_t*)(puiSize) = sizeof(TraceBaseEvent_t) + (TRC_EVENT_GET_PARAM_COUNT(((TraceBaseEvent_t*)(pvAddress))->EventID)) * sizeof(uint32_t), TRC_SUCCESS)

Gets trace event size.

Parameters
[in]pvAddressPointer to initialized trace event.
[out]puiSizeSize.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventPayloadRemaining

#define xTraceEventPayloadRemaining   TRC_EVENT_PAYLOAD_REMAINING

Gets the amount of remaining trace event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[out]puiValueValue.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventPayloadSize

#define xTraceEventPayloadSize   TRC_EVENT_PAYLOAD_SIZE

Gets trace event payload size.

Parameters
[in]xEventHandlePointer to initialized trace event.
[out]puiValueValue
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventPayloadUsed

#define xTraceEventPayloadUsed   TRC_EVENT_PAYLOAD_USED

Gets the amount of used trace event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[out]puiValueValue
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceEventAddData()

traceResult xTraceEventAddData ( TraceEventHandle_t  xEventHandle,
void *  pvData,
uint32_t  uiSize 
)

Adds data to event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]pvDataPointer to data.
[in]uiSizeSize.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventGetSize()

traceResult xTraceEventGetSize ( void *  pvAddress,
uint32_t *  puiSize 
)

Gets trace event size.

Parameters
[in]pvAddressPointer to initialized trace event.
[out]puiSizeSize.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess