trcEvent.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_EVENT_H
#define TRC_EVENT_H
 
#if (TRC_USE_TRACEALYZER_RECORDER == 1)
 
#include <trcTypes.h>
 
#ifdef __cplusplus
extern "C" {
#endif


typedef struct {    /* Aligned */
    uint16_t EventID;       
    uint16_t EventCount;    
    uint32_t TS;            
} TraceEvent0_t;

typedef struct {    /* Aligned */
    uint16_t EventID;                       
    uint16_t EventCount;                    
    uint32_t TS;                            
    TraceUnsignedBaseType_t uxParams[1];    
} TraceEvent1_t;

typedef struct {    /* Aligned */
    uint16_t EventID;                       
    uint16_t EventCount;                    
    uint32_t TS;                            
    TraceUnsignedBaseType_t uxParams[2];    
} TraceEvent2_t;

typedef struct {    /* Aligned */
    uint16_t EventID;                       
    uint16_t EventCount;                    
    uint32_t TS;                            
    TraceUnsignedBaseType_t uxParams[3];    
} TraceEvent3_t;

typedef struct {    /* Aligned */
    uint16_t EventID;                       
    uint16_t EventCount;                    
    uint32_t TS;                            
    TraceUnsignedBaseType_t uxParams[4];    
} TraceEvent4_t;

typedef struct {    /* Aligned */
    uint16_t EventID;                       
    uint16_t EventCount;                    
    uint32_t TS;                            
    TraceUnsignedBaseType_t uxParams[5];    
} TraceEvent5_t;

typedef struct {    /* Aligned */
    uint16_t EventID;                       
    uint16_t EventCount;                    
    uint32_t TS;                            
    TraceUnsignedBaseType_t uxParams[6];    
} TraceEvent6_t;

typedef struct TraceCoreEventData   /* Aligned */
{
    uint32_t eventCounter;                                      
    uint32_t reserved;                                          /* alignment */
} TraceCoreEventData_t;

typedef struct TraceEventDataTable  /* Aligned */
{
    TraceCoreEventData_t coreEventData[TRC_CFG_CORE_COUNT]; 
} TraceEventDataTable_t;

traceResult xTraceEventInitialize(TraceEventDataTable_t* pxBuffer);

traceResult xTraceEventCreateRawBlocking(const void* pxSource, uint32_t ulSize);

traceResult xTraceEventCreate0(uint32_t uiEventCode);

traceResult xTraceEventCreate1(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1);

traceResult xTraceEventCreate2(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2);

traceResult xTraceEventCreate3(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3);

traceResult xTraceEventCreate4(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4);

traceResult xTraceEventCreate5(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5);

traceResult xTraceEventCreate6(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5, TraceUnsignedBaseType_t uxParam6);

traceResult xTraceEventCreateDataOffline0(uint32_t uiEventCode, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);
 

traceResult xTraceEventCreateData0(uint32_t uiEventCode, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventCreateData1(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventCreateData2(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventCreateData3(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventCreateData4(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventCreateData5(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventCreateData6(uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5, TraceUnsignedBaseType_t uxParam6, const TraceUnsignedBaseType_t* const puxData, TraceUnsignedBaseType_t uxSize);

traceResult xTraceEventGetSize(const void* const pvAddress, uint32_t* puiSize);
 
/* Helper macros */

#define prvTraceEventCreate0(_eventID) xTraceEventCreate0(_eventID)

#define prvTraceEventCreate1(_eventID, _param) xTraceEventCreate1(_eventID, (TraceUnsignedBaseType_t)(_param))

#define prvTraceEventCreate2(_eventID, _param1, _param2)  xTraceEventCreate2(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2))

#define prvTraceEventCreate3(_eventID, _param1, _param2, _param3) xTraceEventCreate3(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3))

#define prvTraceEventCreate4(_eventID, _param1, _param2, _param3, _param4) xTraceEventCreate4(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3), (TraceUnsignedBaseType_t)(_param4))

#define prvTraceEventCreate5(_eventID, _param1, _param2, _param3, _param4, _param5) xTraceEventCreate5(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3), (TraceUnsignedBaseType_t)(_param4), (TraceUnsignedBaseType_t)(_param5))

#define prvTraceEventCreate6(_eventID, _param1, _param2, _param3, _param4, _param5, _param6) xTraceEventCreate6(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3), (TraceUnsignedBaseType_t)(_param4), (TraceUnsignedBaseType_t)(_param5), (TraceUnsignedBaseType_t)(_param6))

 
#ifdef __cplusplus
}
#endif
 
#endif /* (TRC_USE_TRACEALYZER_RECORDER == 1) */
 
#endif /* TRC_EVENT_H */