trcEventBuffer.h

Go to the documentation of this file.

/*
* Percepio Trace Recorder for Tracealyzer v4.11.0
* Copyright 2025 Percepio AB
* www.percepio.com
*
* SPDX-License-Identifier: Apache-2.0
*/

 
#ifndef TRC_EVENT_BUFFER_H
#define TRC_EVENT_BUFFER_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
 
#include <trcTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif


#define TRC_EVENT_BUFFER_OPTION_SKIP        (0U)

#define TRC_EVENT_BUFFER_OPTION_OVERWRITE   (1U)

typedef struct TraceEventBuffer /* Aligned */
{
    uint32_t uiHead;                
    uint32_t uiTail;                
    uint32_t uiSize;                
    uint32_t uiOptions;             
    uint32_t uiDroppedEvents;       
    uint32_t uiFree;                
    uint32_t uiSlack;               
    uint32_t uiNextHead;            
    uint32_t uiTimerWraparounds;    
    uint32_t uiReserved;            
    uint8_t* puiBuffer;             
} TraceEventBuffer_t;

traceResult xTraceEventBufferInitialize(TraceEventBuffer_t *pxTraceEventBuffer, uint32_t uiOptions,
        uint8_t *puiBuffer, uint32_t uiSize);

traceResult xTraceEventBufferAlloc(TraceEventBuffer_t *pxTraceEventBuffer, uint32_t uiSize, void **ppvData);

traceResult xTraceEventBufferAllocCommit(TraceEventBuffer_t *pxTraceEventBuffer, const void *pvData, uint32_t uiSize, int32_t *piBytesWritten);

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

traceResult xTraceEventBufferTransferAll(TraceEventBuffer_t* pxTraceEventBuffer, uint32_t uiCoreId, int32_t* piBytesWritten);

traceResult xTraceEventBufferTransferChunk(TraceEventBuffer_t* pxTraceEventBuffer, uint32_t uiChunkSize, uint32_t uiCoreId, int32_t* piBytesWritten);
 

traceResult xTraceEventBufferClear(TraceEventBuffer_t* pxTraceEventBuffer);

 
#ifdef __cplusplus
}
#endif
 
#endif
 
#endif