Percepio Trace Recorder  v4.6.6
Trace Event Buffer APIs

Data Structures

struct  TraceEventBuffer
 Trace Event Buffer Structure. More...
 

Macros

#define TRC_EVENT_BUFFER_OPTION_SKIP   (0U)
 Buffer should skip new events when full.
 
#define TRC_EVENT_BUFFER_OPTION_OVERWRITE   (1U)
 Buffer should overwrite old events when full.
 

Typedefs

typedef struct TraceEventBuffer TraceEventBuffer_t
 Trace Event Buffer Structure.
 

Functions

traceResult xTraceEventBufferPush (TraceEventBuffer_t *pxTraceEventBuffer, void *pxData, uint32_t uiSize, int32_t *piBytesWritten)
 Pushes data into trace event buffer. More...
 
traceResult xTraceEventBufferTransfer (TraceEventBuffer_t *pxTraceEventBuffer, int32_t *piBytesWritten)
 Transfer trace event buffer data through streamport. More...
 
traceResult xTraceEventBufferClear (TraceEventBuffer_t *pxTraceEventBuffer)
 Clears all data from event buffer. More...
 

Detailed Description

Function Documentation

◆ xTraceEventBufferClear()

traceResult xTraceEventBufferClear ( TraceEventBuffer_t pxTraceEventBuffer)

Clears all data from event buffer.

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

◆ xTraceEventBufferPush()

traceResult xTraceEventBufferPush ( TraceEventBuffer_t pxTraceEventBuffer,
void *  pxData,
uint32_t  uiSize,
int32_t *  piBytesWritten 
)

Pushes data into trace event buffer.

This routine attempts to push data into the trace event buffer.

Parameters
[in]pxTraceEventBufferPointer to initialized trace event buffer.
[in]pxDataPointer to data that should be pushed into trace event buffer.
[in]uiSizeSize of data.
[out]piBytesWrittenBytes written.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceEventBufferTransfer()

traceResult xTraceEventBufferTransfer ( TraceEventBuffer_t pxTraceEventBuffer,
int32_t *  piBytesWritten 
)

Transfer trace event buffer data through streamport.

This routine will attempt to transfer all existing data in the trace event buffer through the streamport. New data pushed to the trace event buffer during the execution of this routine will not be transfered to

Parameters
[in]pxTraceEventBufferPointer to initialized trace event buffer.
[out]piBytesWrittenBytes written.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess