Percepio Trace Recorder v4.8.0.hotfix1
Loading...
Searching...
No Matches
Trace Event APIs

Macros

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

Functions

traceResult xTraceEventGetSize (const void *const pvAddress, uint32_t *puiSize)
 Gets trace event size.
 
traceResult xTraceEventCreate0 (uint32_t uiEventCode)
 Creates an event with 0 parameters.
 
traceResult xTraceEventCreate1 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1)
 Creates an event with 1 parameters.
 
traceResult xTraceEventCreate2 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2)
 Creates an event with 2 parameters.
 
traceResult xTraceEventCreate3 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3)
 Creates an event with 3 parameters.
 
traceResult xTraceEventCreate4 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4)
 Creates an event with 4 parameters.
 
traceResult xTraceEventCreate5 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5)
 Creates an event with 5 parameters.
 
traceResult xTraceEventCreate6 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5, TraceUnsignedBaseType_t uxParam6)
 Creates an event with 6 parameters.
 
traceResult xTraceEventAddData (TraceEventHandle_t xEventHandle, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)
 Adds data to event payload.
 

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

◆ xTraceEventAddString

#define xTraceEventAddString (   xEventHandle,
  szString,
  uiLength 
)    xTraceEventAddData(xEventHandle, (TraceUnsignedBaseType_t*)(szString), (((uiLength) + (sizeof(TraceUnsignedBaseType_t) - 1)) / sizeof(TraceUnsignedBaseType_t)))

Adds string to event payload.

Parameters
[in]xEventHandlePointer to initialized trace event.
[in]szStringPointer to string.
[in]uiLengthSize.
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() ? 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(TraceEvent0_t) + (TRC_EVENT_GET_PARAM_COUNT(((TraceEvent0_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,
const TraceUnsignedBaseType_t *const  puxData,
TraceUnsignedBaseType_t  uxSize 
)

Adds data to event payload.

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

◆ xTraceEventCreate0()

traceResult xTraceEventCreate0 ( uint32_t  uiEventCode)

Creates an event with 0 parameters.

Parameters
[in]uiEventCodeEvent code.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventCreate1()

traceResult xTraceEventCreate1 ( uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxParam1 
)

Creates an event with 1 parameters.

Parameters
[in]uiEventCodeEvent code.
[in]uxParam1First parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventCreate2()

traceResult xTraceEventCreate2 ( uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxParam1,
TraceUnsignedBaseType_t  uxParam2 
)

Creates an event with 2 parameters.

Parameters
[in]uiEventCodeEvent code.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventCreate3()

traceResult xTraceEventCreate3 ( uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxParam1,
TraceUnsignedBaseType_t  uxParam2,
TraceUnsignedBaseType_t  uxParam3 
)

Creates an event with 3 parameters.

Parameters
[in]uiEventCodeEvent code.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventCreate4()

traceResult xTraceEventCreate4 ( uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxParam1,
TraceUnsignedBaseType_t  uxParam2,
TraceUnsignedBaseType_t  uxParam3,
TraceUnsignedBaseType_t  uxParam4 
)

Creates an event with 4 parameters.

Parameters
[in]uiEventCodeEvent code.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
[in]uxParam4Fourth parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventCreate5()

traceResult xTraceEventCreate5 ( uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxParam1,
TraceUnsignedBaseType_t  uxParam2,
TraceUnsignedBaseType_t  uxParam3,
TraceUnsignedBaseType_t  uxParam4,
TraceUnsignedBaseType_t  uxParam5 
)

Creates an event with 5 parameters.

Parameters
[in]uiEventCodeEvent code.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
[in]uxParam4Fourth parameter.
[in]uxParam5Fifth parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventCreate6()

traceResult xTraceEventCreate6 ( uint32_t  uiEventCode,
TraceUnsignedBaseType_t  uxParam1,
TraceUnsignedBaseType_t  uxParam2,
TraceUnsignedBaseType_t  uxParam3,
TraceUnsignedBaseType_t  uxParam4,
TraceUnsignedBaseType_t  uxParam5,
TraceUnsignedBaseType_t  uxParam6 
)

Creates an event with 6 parameters.

Parameters
[in]uiEventCodeEvent code.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
[in]uxParam4Fourth parameter.
[in]uxParam5Fifth parameter.
[in]uxParam6Sixth parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventGetSize()

traceResult xTraceEventGetSize ( const void *const  pvAddress,
uint32_t *  puiSize 
)

Gets trace event size.

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