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 the trace to file.
 */
 
#ifndef TRC_STREAM_PORT_H
#define TRC_STREAM_PORT_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
 
#include <stdint.h>
#include <trcTypes.h>
#include <trcStreamPortConfig.h>
#include <stdio.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
/* Default file name */
#ifndef TRC_CFG_STREAM_PORT_TRACE_FILE
#define TRC_CFG_STREAM_PORT_TRACE_FILE "trace.psf"
#endif
 
#define TRC_STREAM_PORT_MULTISTREAM_SUPPORT
 
typedef struct TraceStreamPortBuffer
{
    FILE* pxFiles[TRC_CFG_CORE_COUNT]; 
} TraceStreamPortBuffer_t;

traceResult xTraceStreamPortInitialize(TraceStreamPortBuffer_t* pxBuffer);

traceResult xTraceStreamPortWriteData(void* pvData, uint32_t uiSize, uint32_t uiChannel, int32_t* piBytesWritten);

#define xTraceStreamPortReadData(pvData, uiSize, piBytesRead) ((void)(pvData), (void)(uiSize), (void)(piBytesRead), TRC_SUCCESS)
 
#define xTraceStreamPortOnEnable(uiStartOption) ((void)(uiStartOption), TRC_SUCCESS)
 
#define xTraceStreamPortOnDisable() (TRC_SUCCESS)
 
traceResult xTraceStreamPortOnTraceBegin(void);
 
traceResult xTraceStreamPortOnTraceEnd(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /*(TRC_USE_TRACEALYZER_RECORDER == 1)*/
 
#endif /* TRC_STREAM_PORT_H */