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 use XMOS xScope as a streaming channel.
 */
 
#ifndef TRC_STREAMING_PORT_H
#define TRC_STREAMING_PORT_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
 
#ifdef __cplusplus
extern "C" {
#endif
 
#include <trcTypes.h>
#include <trcStreamPortConfig.h>

typedef struct TraceStreamPortBuffer    /* Aligned */
{
    uint8_t uiBuffer[8];
} TraceStreamPortBuffer_t;

traceResult xTraceStreamPortInitialize(TraceStreamPortBuffer_t* pxBuffer);

traceResult xTraceStreamPortOnBegin(void);

traceResult xTraceStreamPortOnEnd(void);

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

traceResult xTraceStreamPortReadData(void* pvData, uint32_t uiSize, int32_t* piBytesRead);
 
#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)
 
#define xTraceStreamPortOnTraceBegin() TRC_COMMA_EXPR_TO_STATEMENT_EXPR_1(TRC_SUCCESS)
 
#define xTraceStreamPortOnTraceEnd() TRC_COMMA_EXPR_TO_STATEMENT_EXPR_1(TRC_SUCCESS)
 
#ifdef __cplusplus
}
#endif
 
#endif /*(TRC_USE_TRACEALYZER_RECORDER == 1)*/
 
#endif /* TRC_STREAMING_PORT_H */