Macros
#define	xTraceObjectSetState(xObjectHandle, uxState) xTraceObjectSetSpecificState(xObjectHandle, 0, uxState)
	Sets trace object state. More...

#define	xTraceObjectSetSpecificState(xObjectHandle, uiIndex, uxState) xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)
	Sets trace object specific state state. More...

#define	xTraceObjectSetOptions(xObjectHandle, uiOptions) xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)
	Sets trace object options. More...

#define	xTraceObjectSetStateWithoutHandle(pvObject, uxState) xTraceObjectSetSpecificStateWithoutHandle(pvObject, 0, uxState)
	Set trace object state without trace object handle. More...

Functions
traceResult	xTraceObjectRegisterInternal (uint32_t uiEventCode, void pvObject, const char szName, TraceUnsignedBaseType_t uxStateCount, TraceUnsignedBaseType_t uxStates[], TraceUnsignedBaseType_t uxOptions, TraceObjectHandle_t *pxObjectHandle)
	Registers trace object. More...

traceResult	xTraceObjectRegister (uint32_t uiEventCode, void pvObject, const char szName, TraceUnsignedBaseType_t uxState, TraceObjectHandle_t *pxObjectHandle)
	Registers trace object. More...

traceResult	xTraceObjectUnregister (TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState)
	Unregisters trace object. More...

traceResult	xTraceObjectSetName (TraceObjectHandle_t xObjectHandle, const char *szName)
	Sets trace object name. More...

traceResult	xTraceObjectRegisterWithoutHandle (uint32_t uiEventCode, void pvObject, const char szName, TraceUnsignedBaseType_t uxState)
	Registers trace object without trace object handle. More...

traceResult	xTraceObjectUnregisterWithoutHandle (uint32_t uiEventCode, void *pvObject, TraceUnsignedBaseType_t uxState)
	Unregisters trace object without trace object handle. More...

traceResult	xTraceObjectSetNameWithoutHandle (void pvObject, const char szName)
	Set trace object name without trace object handle. More...

traceResult	xTraceObjectSetSpecificStateWithoutHandle (void *pvObject, uint32_t uiIndex, TraceUnsignedBaseType_t uxState)
	Sets trace object specific state without trace object handle. More...

traceResult	xTraceObjectSetOptionsWithoutHandle (void *pvObject, uint32_t uiOptions)
	Sets trace object options without trace object handle. More...

Detailed Description

Macro Definition Documentation

◆ xTraceObjectSetOptions

#define xTraceObjectSetOptions	(	xObjectHandle,
		uiOptions
	)	xTraceEntrySetOptions((TraceEntryHandle_t)(xObjectHandle), uiOptions)

Sets trace object options.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[in]	uiOptions	Options.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetSpecificState

#define xTraceObjectSetSpecificState	(	xObjectHandle,
		uiIndex,
		uxState
	)	xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)

Sets trace object specific state state.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[in]	uiIndex	State Index.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetState

#define xTraceObjectSetState	(	xObjectHandle,
		uxState
	)	xTraceObjectSetSpecificState(xObjectHandle, 0, uxState)

Sets trace object state.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetStateWithoutHandle

#define xTraceObjectSetStateWithoutHandle	(	pvObject,
		uxState
	)	xTraceObjectSetSpecificStateWithoutHandle(pvObject, 0, uxState)

Set trace object state without trace object handle.

Parameters

[in]	pvObject	Object.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Function Documentation

◆ xTraceObjectRegister()

traceResult xTraceObjectRegister	(	uint32_t	uiEventCode,
		void *	pvObject,
		const char *	szName,
		TraceUnsignedBaseType_t	uxState,
		TraceObjectHandle_t *	pxObjectHandle
	)

Registers trace object.

Parameters

[in]	uiEventCode	Event code.
[in]	pvObject	Object.
[in]	szName	Name.
[in]	uxState	State.
[out]	pxObjectHandle	Pointer to uninitialized trace object.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectRegisterInternal()

traceResult xTraceObjectRegisterInternal	(	uint32_t	uiEventCode,
		void *	pvObject,
		const char *	szName,
		TraceUnsignedBaseType_t	uxStateCount,
		TraceUnsignedBaseType_t	uxStates[],
		TraceUnsignedBaseType_t	uxOptions,
		TraceObjectHandle_t *	pxObjectHandle
	)

Registers trace object.

Parameters

[in]	uiEventCode	Event code.
[in]	pvObject	Object.
[in]	szName	Name.
[in]	uxStateCount	State count.
[in]	uxStates	States.
[in]	uxOptions	Options.
[out]	pxObjectHandle	Pointer to uninitialized trace object.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectRegisterWithoutHandle()

traceResult xTraceObjectRegisterWithoutHandle	(	uint32_t	uiEventCode,
		void *	pvObject,
		const char *	szName,
		TraceUnsignedBaseType_t	uxState
	)

Registers trace object without trace object handle.

Parameters

[in]	uiEventCode	Event code.
[in]	pvObject	Object.
[in]	szName	Name.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetName()

traceResult xTraceObjectSetName	(	TraceObjectHandle_t	xObjectHandle,
		const char *	szName
	)

Sets trace object name.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[in]	szName	Name.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetNameWithoutHandle()

traceResult xTraceObjectSetNameWithoutHandle	(	void *	pvObject,
		const char *	szName
	)

Set trace object name without trace object handle.

Parameters

[in]	pvObject	Object.
[in]	szName	Name.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetOptionsWithoutHandle()

traceResult xTraceObjectSetOptionsWithoutHandle	(	void *	pvObject,
		uint32_t	uiOptions
	)

Sets trace object options without trace object handle.

Parameters

[in]	pvObject	Object.
[in]	uiOptions	Options.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetSpecificStateWithoutHandle()

traceResult xTraceObjectSetSpecificStateWithoutHandle	(	void *	pvObject,
		uint32_t	uiIndex,
		TraceUnsignedBaseType_t	uxState
	)

Sets trace object specific state without trace object handle.

Parameters

[in]	pvObject	Object.
[in]	uiIndex	State index.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectUnregister()

traceResult xTraceObjectUnregister	(	TraceObjectHandle_t	xObjectHandle,
		uint32_t	uiEventCode,
		TraceUnsignedBaseType_t	uxState
	)

Unregisters trace object.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[in]	uiEventCode	Event code.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectUnregisterWithoutHandle()

traceResult xTraceObjectUnregisterWithoutHandle	(	uint32_t	uiEventCode,
		void *	pvObject,
		TraceUnsignedBaseType_t	uxState
	)

Unregisters trace object without trace object handle.

Parameters

[in]	uiEventCode	Event code.
[in]	pvObject	Object.
[in]	uxState	State.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ xTraceObjectSetOptions

◆ xTraceObjectSetSpecificState

◆ xTraceObjectSetState

◆ xTraceObjectSetStateWithoutHandle

Function Documentation

◆ xTraceObjectRegister()

◆ xTraceObjectRegisterInternal()

◆ xTraceObjectRegisterWithoutHandle()

◆ xTraceObjectSetName()

◆ xTraceObjectSetNameWithoutHandle()

◆ xTraceObjectSetOptionsWithoutHandle()

◆ xTraceObjectSetSpecificStateWithoutHandle()

◆ xTraceObjectUnregister()

◆ xTraceObjectUnregisterWithoutHandle()