Trace Event APIs

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

Macro Definition Documentation

prvTraceEventCreate0

#define prvTraceEventCreate0

(

_eventID

)

Value:

xTraceEventCreate0(_eventID)

Helper macro that handles type casting for all parameters. Accepts no parameters.

Parameters

[in]

_eventID

Event id

prvTraceEventCreate1

#define prvTraceEventCreate1	(		_eventID,
			_param )

Value:

xTraceEventCreate1(_eventID, (TraceUnsignedBaseType_t)(_param))

Helper macro that handles type casting for all parameters. Accepts 1 parameters.

Parameters

[in]	_eventID	Event id
[in]	_param	Param

prvTraceEventCreate2

#define prvTraceEventCreate2	(		_eventID,
			_param1,
			_param2 )

Value:

xTraceEventCreate2(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2))

Helper macro that handles type casting for all parameters. Accepts 2 parameters.

Parameters

[in]	_eventID	Event id
[in]	_param1	Param 1
[in]	_param2	Param 2

prvTraceEventCreate3

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

Value:

xTraceEventCreate3(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3))

Helper macro that handles type casting for all parameters. Accepts 3 parameters.

Parameters

[in]	_eventID	Event id
[in]	_param1	Param 1
[in]	_param2	Param 2
[in]	_param3	Param 3

prvTraceEventCreate4

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

Value:

xTraceEventCreate4(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3), (TraceUnsignedBaseType_t)(_param4))

Helper macro that handles type casting for all parameters. Accepts 4 parameters.

Parameters

[in]	_eventID	Event id
[in]	_param1	Param 1
[in]	_param2	Param 2
[in]	_param3	Param 3
[in]	_param4	Param 4

prvTraceEventCreate5

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

Value:

xTraceEventCreate5(_eventID, (TraceUnsignedBaseType_t)(_param1), (TraceUnsignedBaseType_t)(_param2), (TraceUnsignedBaseType_t)(_param3), (TraceUnsignedBaseType_t)(_param4), (TraceUnsignedBaseType_t)(_param5))

Helper macro that handles type casting for all parameters. Accepts 5 parameters.

Parameters

[in]	_eventID	Event id
[in]	_param1	Param 1
[in]	_param2	Param 2
[in]	_param3	Param 3
[in]	_param4	Param 4
[in]	_param5	Param 5

prvTraceEventCreate6

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

Value:

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

Helper macro that handles type casting for all parameters. Accepts 6 parameters.

Parameters

[in]	_eventID	Event id
[in]	_param1	Param 1
[in]	_param2	Param 2
[in]	_param3	Param 3
[in]	_param4	Param 4
[in]	_param5	Param 5
[in]	_param6	Param 6

Function Documentation

xTraceEventCreate0()

traceResult xTraceEventCreate0

(

uint32_t

uiEventCode

)

Creates an event with 0 parameters.

Parameters

[in]

uiEventCode

Event code.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreate1()

traceResult xTraceEventCreate1	(	uint32_t	uiEventCode,
		TraceUnsignedBaseType_t	uxParam1 )

Creates an event with 1 parameters.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreate2()

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

Creates an event with 2 parameters.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreate3()

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

Creates an event with 3 parameters.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreate4()

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

Creates an event with 4 parameters.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreate5()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.
[in]	uxParam5	Fifth parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreate6()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.
[in]	uxParam5	Fifth parameter.
[in]	uxParam6	Sixth parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData0()

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

Creates an event with no parameters and a payload.

Parameters

[in]	uiEventCode	Event code.
[in]	puxData	Pointer to payload buffer
[in]	uxSize	Size of the payload buffer

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData1()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	puxData	Pointer to payload buffer.
[in]	uxSize	Size of the payload buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData2()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	puxData	Pointer to payload buffer.
[in]	uxSize	Size of the payload buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData3()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	puxData	Pointer to payload buffer.
[in]	uxSize	Size of the payload buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData4()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.
[in]	puxData	Pointer to payload buffer.
[in]	uxSize	Size of the payload buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData5()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.
[in]	uxParam5	Fifth parameter.
[in]	puxData	Pointer to payload buffer.
[in]	uxSize	Size of the payload buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateData6()

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.

Parameters

[in]	uiEventCode	Event code.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.
[in]	uxParam5	Fifth parameter.
[in]	uxParam6	Sixth parameter.
[in]	puxData	Pointer to payload buffer.
[in]	uxSize	Size of the payload buffer.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateDataOffline0()

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

Creates an offline event with no parameters and a payload.

Parameters

[in]	uiEventCode	Event code.
[in]	puxData	Pointer to payload buffer
[in]	uxSize	Size of the payload buffer

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceEventCreateRawBlocking()

traceResult xTraceEventCreateRawBlocking	(	const void *	pxSource,
		uint32_t	ulSize )

Create a raw data event (i.e. not event code provided)

Parameters

pxSource	The source buffer which should be copied
ulSize	The size of the data to be copied

Return values

TRC_FAIL
TRC_SUCCESS

xTraceEventGetSize()

traceResult xTraceEventGetSize	(	const void *const	pvAddress,
		uint32_t *	puiSize )

Gets trace event size.

Parameters

[in]	pvAddress	Pointer to initialized trace event.
[out]	puiSize	Size.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success