Percepio Trace Recorder
v4.6.6
|
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... | |
#define xTraceEventAdd16 TRC_EVENT_ADD_16 |
Adds an uint16_t as trace event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | value | Value. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#define xTraceEventAdd32 TRC_EVENT_ADD_32 |
Adds an uint32_t as trace event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | value | Value. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#define xTraceEventAdd8 TRC_EVENT_ADD_8 |
Adds an uint8_t as trace event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | value | Value. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#define xTraceEventAddUnsignedBaseType TRC_EVENT_ADD_UNSIGNED_BASE_TYPE |
Adds an unsigned base type value as trace event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | uxValue | Value. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#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.
[in] | uiSize | Size. |
[in] | pxEventHandle | Pointer to initialized trace event. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#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.
[in] | xEventHandle | Pointer to initialized trace event. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#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.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | uiOffset | Offset. |
[in] | uiSize | Size. |
[out] | ppvData | Data. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#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.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | uiOffset | Offset. |
[in] | uiSize | Size. |
[out] | ppvData | Data. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#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.
[in] | pvAddress | Pointer to initialized trace event. |
[out] | puiSize | Size. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#define xTraceEventPayloadRemaining TRC_EVENT_PAYLOAD_REMAINING |
Gets the amount of remaining trace event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[out] | puiValue | Value. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#define xTraceEventPayloadSize TRC_EVENT_PAYLOAD_SIZE |
Gets trace event payload size.
[in] | xEventHandle | Pointer to initialized trace event. |
[out] | puiValue | Value |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
#define xTraceEventPayloadUsed TRC_EVENT_PAYLOAD_USED |
Gets the amount of used trace event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[out] | puiValue | Value |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
traceResult xTraceEventAddData | ( | TraceEventHandle_t | xEventHandle, |
void * | pvData, | ||
uint32_t | uiSize | ||
) |
Adds data to event payload.
[in] | xEventHandle | Pointer to initialized trace event. |
[in] | pvData | Pointer to data. |
[in] | uiSize | Size. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |
traceResult xTraceEventGetSize | ( | void * | pvAddress, |
uint32_t * | puiSize | ||
) |
Gets trace event size.
[in] | pvAddress | Pointer to initialized trace event. |
[out] | puiSize | Size. |
TRC_FAIL | Failure |
TRC_SUCCESS | Success |