Trace Extension APIs

Macros
#define	xTraceExtensionGetEventId(xExtensionHandle, uiLocalEventId)
	Returns extension event id.

Functions
traceResult	xTraceExtensionInitialize (TraceExtensionData_t *const pxBuffer)
	Initializes the Extension trace system.
traceResult	xTraceExtensionCreate (const char *szName, uint8_t uiMajor, uint8_t uiMinor, uint16_t uiPatch, uint32_t uiEventCount, TraceExtensionHandle_t *pxExtensionHandle)
	Creates trace extension.
traceResult	xTraceExtensionGetBaseEventId (TraceExtensionHandle_t xExtensionHandle, uint32_t *puiBaseEventId)
	Gets extension base event id.
traceResult	xTraceExtensionGetConfigName (TraceExtensionHandle_t xExtensionHandle, const char **pszName)
	Gets extension configuration name.

Detailed Description

Macro Definition Documentation

xTraceExtensionGetEventId

#define xTraceExtensionGetEventId	(		xExtensionHandle,
			uiLocalEventId )

Value:

((uint32_t)xTraceEntryGetStateReturn((TraceEntryHandle_t)(xExtensionHandle), TRC_EXTENSION_STATE_INDEX_BASE_EVENT_ID) + (uiLocalEventId))

Returns extension event id.

Parameters

[in]	xExtensionHandle	Pointer to initialized extension handle.
[in]	uiLocalEventId	Local event id.

Returns

Extension event id

Function Documentation

xTraceExtensionCreate()

traceResult xTraceExtensionCreate	(	const char *	szName,
		uint8_t	uiMajor,
		uint8_t	uiMinor,
		uint16_t	uiPatch,
		uint32_t	uiEventCount,
		TraceExtensionHandle_t *	pxExtensionHandle )

Creates trace extension.

Parameters

[in]	szName	Name.
[in]	uiMajor	Major version.
[in]	uiMinor	Minor version.
[in]	uiPatch	Patch version.
[in]	uiEventCount	Event count.
[out]	pxExtensionHandle	Pointer to uninitialized extension handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceExtensionGetBaseEventId()

traceResult xTraceExtensionGetBaseEventId	(	TraceExtensionHandle_t	xExtensionHandle,
		uint32_t *	puiBaseEventId )

Gets extension base event id.

Parameters

[in]	xExtensionHandle	Pointer to initialized extension handle.
[out]	puiBaseEventId	Base event id.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceExtensionGetConfigName()

traceResult xTraceExtensionGetConfigName	(	TraceExtensionHandle_t	xExtensionHandle,
		const char **	pszName )

Gets extension configuration name.

Parameters

[in]	xExtensionHandle	Pointer to initialized extension handle.
[out]	pszName	Name.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

xTraceExtensionInitialize()

traceResult xTraceExtensionInitialize

(

TraceExtensionData_t *const

pxBuffer

)

Initializes the Extension trace system.

Parameters

[in]

pxBuffer

Pointer to memory that is used by the extension trace system

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success