trcInternalEventBuffer.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_INTERNAL_BUFFER_H
#define TRC_INTERNAL_BUFFER_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
 
#include <trcDefines.h>
 
#ifdef TRC_CFG_STREAM_PORT_USE_INTERNAL_BUFFER
#define TRC_USE_INTERNAL_BUFFER TRC_CFG_STREAM_PORT_USE_INTERNAL_BUFFER
#else
#define TRC_USE_INTERNAL_BUFFER 1
#endif
 
#if (TRC_USE_INTERNAL_BUFFER == 1)
 
/* Aligned */
#define TRC_INTERNAL_BUFFER_SIZE ((((TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_SIZE) + sizeof(TraceUnsignedBaseType_t) - 1) / sizeof(TraceUnsignedBaseType_t)) * sizeof(TraceUnsignedBaseType_t))

typedef struct TraceInternalEventBufferData /* Aligned */
{
    uint8_t aubBuffer[TRC_INTERNAL_BUFFER_SIZE];
} TraceInternalEventBufferData_t;
 
#include <trcTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#ifdef TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_TRANSFER_MODE
#define TRC_INTERNAL_EVENT_BUFFER_TRANSFER_MODE TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_TRANSFER_MODE
#else
#define TRC_INTERNAL_EVENT_BUFFER_TRANSFER_MODE TRC_INTERNAL_EVENT_BUFFER_OPTION_TRANSFER_MODE_ALL
#endif
 
#ifdef TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_CHUNK_SIZE
#define TRC_INTERNAL_BUFFER_CHUNK_SIZE TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_CHUNK_SIZE
#else
#define TRC_INTERNAL_BUFFER_CHUNK_SIZE (1024UL)
#endif
 
#ifdef TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_SIZE_LIMIT
#define TRC_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_SIZE_LIMIT TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_SIZE_LIMIT
#else
#define TRC_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_SIZE_LIMIT (512UL)
#endif
 
#ifdef TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_COUNT_LIMIT
#define TRC_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_COUNT_LIMIT TRC_CFG_STREAM_PORT_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_COUNT_LIMIT
#else
#define TRC_INTERNAL_BUFFER_CHUNK_TRANSFER_AGAIN_COUNT_LIMIT (5UL)
#endif


traceResult xTraceInternalEventBufferInitialize(TraceInternalEventBufferData_t* pxBuffer);

traceResult xTraceInternalEventBufferAlloc(uint32_t uiSize, void **ppvData);

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

traceResult xTraceInternalEventBufferPush(void *pvData, uint32_t uiSize, int32_t *piBytesWritten);
 
#if (TRC_INTERNAL_EVENT_BUFFER_TRANSFER_MODE == TRC_INTERNAL_EVENT_BUFFER_OPTION_TRANSFER_MODE_ALL)
#define xTraceInternalEventBufferTransfer xTraceInternalEventBufferTransferAll
#else
#define xTraceInternalEventBufferTransfer xTraceInternalEventBufferTransferChunk
#endif

traceResult xTraceInternalEventBufferTransferAll(void);

traceResult xTraceInternalEventBufferTransferChunk(void);

traceResult xTraceInternalEventBufferClear(void);

 
#ifdef __cplusplus
}
#endif
 
#else /* (TRC_USE_INTERNAL_BUFFER == 1)*/
 
#define xTraceInternalEventBufferInitialize(pxBuffer) ((pxBuffer) != 0 ? TRC_SUCCESS : TRC_FAIL)
#define xTraceInternalEventBufferAlloc(ppvData, uiSize) ((void)(uiSize), (ppvData) != 0 ? TRC_SUCCESS : TRC_FAIL)
#define xTraceInternalEventBufferAllocCommit(pvData, uiSize, piBytesWritten) ((void)(pvData), (void)(uiSize), (void)(piBytesWritten), TRC_SUCCESS)
#define xTraceInternalEventBufferPush(pvData, uiSize, piBytesWritten) ((void)(uiSize), (void)(piBytesWritten), (pvData) != 0 ? TRC_SUCCESS : TRC_FAIL)
#define xTraceInternalEventBufferTransfer() (void)(TRC_SUCCESS)
#define xTraceInternalEventBufferTransferChunk(piBytesWritten, uiChunkSize) ((void)(piBytesWritten), (void)(uiChunkSize), TRC_SUCCESS)
#define xTraceInternalEventBufferClear() (void)(TRC_SUCCESS)
 
#endif /* (TRC_USE_INTERNAL_BUFFER == 1)*/
 
#endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
 
#endif /* TRC_INTERNAL_BUFFER_H */