trcRecorder.h

Go to the documentation of this file.

/*
 * Percepio TraceRecorder for Tracealyzer v4.12.0
 * Copyright 2025 Percepio AB
 * www.percepio.com
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef TRC_RECORDER_H
#define TRC_RECORDER_H

 
#ifdef __cplusplus
extern "C" {
#endif

 
#define TRC_ACKNOWLEDGED (0xABC99123)
 
#include <trcDefines.h>
#include <trcConfig.h>
 
#ifndef TRC_CFG_ENTRY_SLOTS
#error TRC_CFG_ENTRY_SLOTS not defined. Please ensure you are using updated config files.
#endif
 
#include <trcKernelPortConfig.h>
 
#include <trcTypes.h>
 
#ifndef TRC_CFG_TEST_MODE
#define TRC_CFG_TEST_MODE 0
#endif
 
/* Unless specified in trcConfig.h we assume this is a single core target */
#ifndef TRC_CFG_CORE_COUNT
#define TRC_CFG_CORE_COUNT 1
#endif
 
/* Unless specified in trcConfig.h we assume this is a single core target */
#ifndef TRC_CFG_GET_CURRENT_CORE
#define TRC_CFG_GET_CURRENT_CORE() 0
#endif
 
/* Unless specified in trcConfig.h or trcKernelPortConfig.h we assume
 * GCC statement expressions aren't supported. */
#ifndef TRC_CFG_USE_GCC_STATEMENT_EXPR
#define TRC_CFG_USE_GCC_STATEMENT_EXPR 0
#endif
 
/* Backwards compatibility */
#undef traceHandle
#define traceHandle TraceISRHandle_t
 
/* Maximum event size */
#define TRC_MAX_BLOB_SIZE (16UL * sizeof(TraceUnsignedBaseType_t))
 
/* Platform name length */
#define TRC_PLATFORM_CFG_LENGTH 8UL
 
/* Header size */
#define TRC_HEADER_BUFFER_SIZE (sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint16_t) + sizeof(uint32_t) + sizeof(uint32_t) + sizeof(uint32_t) + sizeof(uint16_t) + sizeof(uint8_t) + sizeof(uint8_t) + (sizeof(char) * (TRC_PLATFORM_CFG_LENGTH)))
 
typedef struct TraceHeaderBuffer    /* Aligned */
{
    uint8_t buffer[TRC_HEADER_BUFFER_SIZE];
} TraceHeaderBuffer_t;
 
#include <trcHardwarePort.h>
#include <trcKernelPort.h>
#include <trcString.h>
#include <trcStaticBuffer.h>
#include <trcError.h>
#include <trcEvent.h>
#include <trcEventBuffer.h>
#include <trcMultiCoreEventBuffer.h>
#include <trcTimestamp.h>
#include <trcEntryTable.h>
#include <trcStreamPort.h>
#include <trcISR.h>
#include <trcTask.h>
#include <trcObject.h>
#include <trcPrint.h>
#include <trcHeap.h>
#include <trcExtension.h>
#include <trcUtility.h>
#include <trcStackMonitor.h>
#include <trcInternalEventBuffer.h>
#include <trcDiagnostics.h>
#include <trcAssert.h>
#include <trcRunnable.h>
#include <trcDependency.h>
#include <trcProcess.h>
#include <trcThread.h>
#include <trcInterval.h>
#include <trcStateMachine.h>
#include <trcCounter.h>
#include <trcTaskMonitor.h>
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)

traceResult xTraceInitialize(void);

traceResult xTraceEnable(uint32_t uiStartOption);

traceResult xTraceDisable(void);
 
#ifndef TRC_EXTERNAL_BUFFERS
#define TRC_EXTERNAL_BUFFERS 0
#endif
 
/* Empty default define */
#ifndef TRC_CFG_PRINTF
#define TRC_CFG_PRINTF(...)
#endif
 
typedef struct TraceRecorderData    /* Aligned */
{
    uint32_t uiSessionCounter;
    uint32_t uiRecorderEnabled;
    TraceUnsignedBaseType_t uxTraceSystemStates[TRC_CFG_CORE_COUNT];
    uint32_t reserved;                              /* alignment */
 
    TraceAssertData_t xAssertBuffer;                /* aligned */
    TraceEntryIndexTable_t xEntryIndexTableBuffer;  /* aligned */
#if (TRC_EXTERNAL_BUFFERS == 0)
    TraceHeaderBuffer_t xHeaderBuffer;              /* aligned */
    TraceEntryTable_t xEntryTable;                  /* aligned */
    TraceTimestampData_t xTimestampBuffer;          /* aligned */
#endif
#if (TRC_USE_INTERNAL_BUFFER == 1)
    TraceInternalEventBufferData_t xInternalEventBuffer;    /* aligned */
#endif
    TraceStreamPortBuffer_t xStreamPortBuffer;      /* verify alignment in xTraceInitialize() */
    TraceStaticBufferTable_t xStaticBufferBuffer;   /* aligned */
    TraceEventDataTable_t xEventDataBuffer;         /* verify alignment in xTraceInitialize() */
    TracePrintData_t xPrintBuffer;                  /* aligned */
    TraceErrorData_t xErrorBuffer;                  /* aligned */
    TraceISRData_t xISRBuffer;                      /* aligned */
    TraceKernelPortDataBuffer_t xKernelPortBuffer;  /* verify alignment in xTraceInitialize() */
    TraceTaskData_t xTaskInfoBuffer;                /* aligned */
    TraceStackMonitorData_t xStackMonitorBuffer;    /* aligned */
    TraceDiagnosticsData_t xDiagnosticsBuffer;      /* aligned */
    TraceExtensionData_t xExtensionBuffer;          /* aligned */
    TraceCounterData_t xCounterBuffer;              /* aligned */
    TraceTaskMonitorData_t xTaskMonitorBuffer;      /* aligned */
} TraceRecorderData_t;
 
extern TraceRecorderData_t* pxTraceRecorderData;
extern uint32_t RecorderInitialized;

traceResult xTraceHeaderInitialize(TraceHeaderBuffer_t* pxBuffer);

#define xTraceIsRecorderEnabled() (xTraceIsRecorderInitialized() && pxTraceRecorderData->uiRecorderEnabled)

#define xTraceIsRecorderInitialized() xTraceIsComponentInitialized(TRC_RECORDER_COMPONENT_CORE)

#define xTraceSetComponentInitialized(uiComponentBit) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(RecorderInitialized |= (uiComponentBit), TRC_SUCCESS)

#define xTraceIsComponentInitialized(uiComponentBit) (RecorderInitialized & (uiComponentBit))

#define xTraceStateSet(uxState) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(pxTraceRecorderData->uxTraceSystemStates[TRC_CFG_GET_CURRENT_CORE()] = (uxState), TRC_SUCCESS)

#define xTraceStateGet(puxState) TRC_COMMA_EXPR_TO_STATEMENT_EXPR_2(*(puxState) = pxTraceRecorderData->uxTraceSystemStates[TRC_CFG_GET_CURRENT_CORE()], TRC_SUCCESS)

traceResult xTraceTzCtrl(void);
 
/******************************************************************************/
/*** INTERNAL STREAMING FUNCTIONS *********************************************/
/******************************************************************************/
 
#if (TRC_CFG_RECORDER_BUFFER_ALLOCATION == TRC_RECORDER_BUFFER_ALLOCATION_CUSTOM)
traceResult xTraceSetBuffer(TraceRecorderData_t *pxBuffer);
#else
#define xTraceSetBuffer(p) (TRC_SUCCESS)
#endif

traceResult xTraceGetEventBuffer(void** ppvBuffer, TraceUnsignedBaseType_t * puiSize);
 
#else /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
 
#define xTraceInitialize() (TRC_SUCCESS)
#define xTraceEnable(x) ((void)(x), TRC_SUCCESS)
#define xTraceDisable() (TRC_SUCCESS)
 
#define prvTraceSetReadyEventsEnabled(status) (void)(status)
 
#define vTraceExcludeTask(handle) (void)(handle)
 
#define vTraceConsoleChannelPrintF(fmt, ...) (void)(fmt)
 
#ifndef TRC_ALLOC_CUSTOM_BUFFER
#define TRC_ALLOC_CUSTOM_BUFFER(bufname)
#endif
 
#define xTraceIsRecorderEnabled() (0)
#define xTraceIsRecorderInitialized() (0)
 
#define xTraceSetBuffer(p) (TRC_SUCCESS)
#define xTraceGetEventBuffer(p) (TRC_FAIL)
 
#define vTraceSetStopHook(x) (void)(x)
 
#define TraceRecorderData_t uint32_t
 
#endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */

#define vTraceInitialize (void)xTraceInitialize

#define vTraceEnable (void)xTraceEnable

#define vTraceStop (void)xTraceDisable

#define vTraceInstanceFinishedNow (void)xTraceTaskInstanceFinishedNow

#define vTraceInstanceFinishedNext (void)xTraceTaskInstanceFinishedNext

#define vTracePrintF (void)xTracePrintF

#define vTraceVPrintF (void)xTraceVPrintF

#define vTracePrint (void)xTracePrint

#define vTraceSetRecorderDataBuffer(pxBuffer) xTraceSetBuffer((TraceRecorderData_t*)(pxBuffer))
 
#ifdef __cplusplus
}
#endif
 
#endif