trcEvent.h File Reference

Public trace event APIs. More...

#include <trcTypes.h>

Go to the source code of this file.

Macros
#define	prvTraceEventCreate0(_eventID)
	Helper macro that handles type casting for all parameters. Accepts no parameters.
#define	prvTraceEventCreate1(_eventID, _param)
	Helper macro that handles type casting for all parameters. Accepts 1 parameters.
#define	prvTraceEventCreate2(_eventID, _param1, _param2)
	Helper macro that handles type casting for all parameters. Accepts 2 parameters.
#define	prvTraceEventCreate3(_eventID, _param1, _param2, _param3)
	Helper macro that handles type casting for all parameters. Accepts 3 parameters.
#define	prvTraceEventCreate4(_eventID, _param1, _param2, _param3, _param4)
	Helper macro that handles type casting for all parameters. Accepts 4 parameters.
#define	prvTraceEventCreate5(_eventID, _param1, _param2, _param3, _param4, _param5)
	Helper macro that handles type casting for all parameters. Accepts 5 parameters.
#define	prvTraceEventCreate6(_eventID, _param1, _param2, _param3, _param4, _param5, _param6)
	Helper macro that handles type casting for all parameters. Accepts 6 parameters.

Functions
traceResult	xTraceEventCreateRawBlocking (const void *pxSource, uint32_t ulSize)
traceResult	xTraceEventCreate0 (uint32_t uiEventCode)
	Creates an event with 0 parameters.
traceResult	xTraceEventCreate1 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1)
	Creates an event with 1 parameters.
traceResult	xTraceEventCreate2 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2)
	Creates an event with 2 parameters.
traceResult	xTraceEventCreate3 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3)
	Creates an event with 3 parameters.
traceResult	xTraceEventCreate4 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4)
	Creates an event with 4 parameters.
traceResult	xTraceEventCreate5 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5)
	Creates an event with 5 parameters.
traceResult	xTraceEventCreate6 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, TraceUnsignedBaseType_t uxParam4, TraceUnsignedBaseType_t uxParam5, TraceUnsignedBaseType_t uxParam6)
	Creates an event with 6 parameters.
traceResult	xTraceEventCreateDataOffline0 (uint32_t uiEventCode, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)
	Creates an offline event with no parameters and a payload.
traceResult	xTraceEventCreateData0 (uint32_t uiEventCode, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)
	Creates an event with no parameters and a payload.
traceResult	xTraceEventCreateData1 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)
	Creates an event with 1 parameter and a payload.
traceResult	xTraceEventCreateData2 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)
	Creates an event with 2 parameters and a payload.
traceResult	xTraceEventCreateData3 (uint32_t uiEventCode, TraceUnsignedBaseType_t uxParam1, TraceUnsignedBaseType_t uxParam2, TraceUnsignedBaseType_t uxParam3, const TraceUnsignedBaseType_t *const puxData, TraceUnsignedBaseType_t uxSize)
	Creates an event with 3 parameters and a payload.
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)
	Creates an event with 4 parameters and a payload.
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)
	Creates an event with 5 parameters and a payload.
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)
	Creates an event with 6 parameters and a payload.
traceResult	xTraceEventGetSize (const void *const pvAddress, uint32_t *puiSize)
	Gets trace event size.

Detailed Description

Public trace event APIs.