trcStreamPort.h

/*
* Trace Recorder for Tracealyzer v4.11.0
* Copyright 2025 Percepio AB
* www.percepio.com
*
* SPDX-License-Identifier: Apache-2.0
*
* The interface definitions for trace streaming ("stream ports").
* This "stream port" sets up the recorder to stream to a Ring Buffer.
*/
 
#ifndef TRC_STREAM_PORT_H
#define TRC_STREAM_PORT_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
 
#include <trcTypes.h>
#include <trcStreamPortConfig.h>
#include <trcRecorder.h>
 
#ifdef __cplusplus
extern "C" {
#endif

#define TRC_EXTERNAL_BUFFERS 1

#define TRC_SEND_NAME_ONLY_ON_DELETE 1

 
#define TRC_CFG_STREAM_PORT_USE_INTERNAL_BUFFER 0
 
/* The RingBuffer StreamPort is using the Internal Event Buffer in a specific way and therefor we classify this as a custom streamport allocation method */
#define TRC_USE_CUSTOM_STREAMPORT_ALLOCATION
 
#define TRC_STREAM_PORT_BUFFER_SIZE (((uint32_t)(TRC_CFG_STREAM_PORT_BUFFER_SIZE) / sizeof(TraceUnsignedBaseType_t)) * sizeof(TraceUnsignedBaseType_t)) /* aligned */

typedef struct TraceMultiCoreBuffer /* Aligned */
{
    TraceUnsignedBaseType_t uxSize;     /* aligned */
    uint8_t uiBuffer[TRC_STREAM_PORT_BUFFER_SIZE];  /* size is aligned */
} TraceMultiCoreBuffer_t;

typedef struct TraceRingBuffer
{
    uint32_t reserved0; /* alignment with START_MARKERS */
    volatile uint8_t START_MARKERS[12];
    TraceHeaderBuffer_t xHeaderBuffer; /* aligned */
    TraceTimestampData_t xTimestampInfo; /* aligned */
    TraceEntryTable_t xEntryTable; /* aligned */
    TraceMultiCoreBuffer_t xEventBuffer; /* aligned */
    volatile uint8_t END_MARKERS[12];
    uint32_t reserved1; /* alignment */
} TraceRingBuffer_t;

typedef struct TraceStreamPortBuffer
{
    TraceMultiCoreEventBuffer_t xMultiCoreEventBuffer;
    TraceRingBuffer_t xRingBuffer;
} TraceStreamPortBuffer_t;
 
extern TraceStreamPortBuffer_t* pxStreamPortData;

traceResult xTraceStreamPortInitialize(TraceStreamPortBuffer_t* pxBuffer);

#define xTraceStreamPortAllocate(_uiSize, _ppvData) xTraceMultiCoreEventBufferAlloc(&pxStreamPortData->xMultiCoreEventBuffer, _uiSize, _ppvData)

#define xTraceStreamPortCommit(_pvData, _uiSize, _piBytesCommitted) xTraceMultiCoreEventBufferAllocCommit(&pxStreamPortData->xMultiCoreEventBuffer, _pvData, _uiSize, _piBytesCommitted)

#define xTraceStreamPortWriteData(_pvData, _uiSize, _uiChannel, _piBytesWritten) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_5((void)(_pvData), (void)(_uiSize), (void)(_uiChannel), (void)(_piBytesWritten), TRC_SUCCESS)

#define xTraceStreamPortReadData(pvData, uiSize, piBytesRead) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_4((void)(pvData), (void)(uiSize), (void)(piBytesRead), TRC_SUCCESS)

#define xTraceStreamPortOnEnable(uiStartOption) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2((void)(uiStartOption), TRC_SUCCESS)

#define xTraceStreamPortOnDisable() TRC_COMMA_EXPR_TO_STATEMENT_EXPR_1(TRC_SUCCESS)

traceResult xTraceStreamPortOnTraceBegin(void);

#define xTraceStreamPortOnTraceEnd() TRC_COMMA_EXPR_TO_STATEMENT_EXPR_1(TRC_SUCCESS)
 
#ifdef __cplusplus
}
#endif
 
#endif /*(TRC_USE_TRACEALYZER_RECORDER == 1)*/
 
#endif /* TRC_STREAM_PORT_H */