Percepio Trace Recorder  v4.6.6
trcEvent.h File Reference

Public trace event APIs. More...

#include <trcTypes.h>

Go to the source code of this file.

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

Public trace event APIs.