Macros
#define	xTraceObjectGetAddress(xObjectHandle, ppvAddress)
	Gets trace object address.
#define	pvTraceObjectGetAddressReturn(xObjectHandle)
	Returns trace object address.
#define	xTraceObjectGetName(xObjectHandle, pszName)
	Gets trace object name.
#define	xTraceObjectSetState(xObjectHandle, uxState)
	Sets trace object state.
#define	xTraceObjectSetSpecificState(xObjectHandle, uiIndex, uxState)
	Sets trace object specific state.
#define	xTraceObjectGetSpecificState(xObjectHandle, uiIndex, puxState)
	Gets trace object specific state.
#define	xTraceObjectSetOptions(xObjectHandle, uiOptions)
	Sets trace object options.
#define	xTraceObjectSetStateWithoutHandle(pvObject, uxState)
	Set trace object state without trace object handle.
#define	xTraceObjectFind(pvObject, pxObjectHandle)
	Get the TraceObjectHandle_t of the object.

Functions
traceResult	xTraceObjectRegisterInternal (uint32_t uiEventCode, void const pvObject, const char szName, TraceUnsignedBaseType_t uxStateCount, const TraceUnsignedBaseType_t uxStates[], TraceUnsignedBaseType_t uxOptions, TraceObjectHandle_t *pxObjectHandle)
	Registers trace object.
traceResult	xTraceObjectRegister (uint32_t uiEventCode, void const pvObject, const char szName, TraceUnsignedBaseType_t uxState, TraceObjectHandle_t *pxObjectHandle)
	Registers trace object.
traceResult	xTraceObjectRegister2 (uint32_t uiEventCode, void const pvObject, const char szName, TraceUnsignedBaseType_t uxState1, TraceUnsignedBaseType_t uxState2, TraceObjectHandle_t *pxObjectHandle)
	Registers trace object with two initial states.
traceResult	xTraceObjectUnregister (TraceObjectHandle_t xObjectHandle, uint32_t uiEventCode, TraceUnsignedBaseType_t uxState)
	Unregisters trace object.
traceResult	xTraceObjectSetName (TraceObjectHandle_t xObjectHandle, const char *szName)
	Sets trace object name.
traceResult	xTraceObjectRegisterWithoutHandle (uint32_t uiEventCode, void pvObject, const char szName, TraceUnsignedBaseType_t uxState)
	Registers trace object without trace object handle.
traceResult	xTraceObjectRegisterWithoutHandle2 (uint32_t uiEventCode, void pvObject, const char szName, TraceUnsignedBaseType_t uxState1, TraceUnsignedBaseType_t uxState2)
	Registers trace object with two initial states without trace object handle.
traceResult	xTraceObjectUnregisterWithoutHandle (uint32_t uiEventCode, void *pvObject, TraceUnsignedBaseType_t uxState)
	Unregisters trace object without trace object handle.
traceResult	xTraceObjectSetNameWithoutHandle (void pvObject, const char szName)
	Set trace object name without trace object handle.
traceResult	xTraceObjectSetSpecificStateWithoutHandle (void *pvObject, uint32_t uiIndex, TraceUnsignedBaseType_t uxState)
	Sets trace object specific state without trace object handle.
traceResult	xTraceObjectSetOptionsWithoutHandle (void *pvObject, uint32_t uiOptions)
	Sets trace object options without trace object handle.

Detailed Description

Macro Definition Documentation

◆ pvTraceObjectGetAddressReturn

#define pvTraceObjectGetAddressReturn ( xObjectHandle )

Value:

pvTraceEntryGetAddressReturn((TraceEntryHandle_t)(xObjectHandle))

Returns trace object address.

Parameters

[in] xObjectHandle Object handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectFind

#define xTraceObjectFind	(		pvObject,
			pxObjectHandle )

Value:

xTraceEntryFind(pvObject, (TraceEntryHandle_t*)pxObjectHandle)

xTraceEntryFind

traceResult xTraceEntryFind(const void *const pvAddress, TraceEntryHandle_t *pxEntryHandle)

Finds trace entry mapped to object address.

Definition trcEntryTable.c:166

Get the TraceObjectHandle_t of the object.

Parameters

[in]	pvObject	Object.
[out]	pxObjectHandle	Pointer to returned object handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectGetAddress

#define xTraceObjectGetAddress	(		xObjectHandle,
			ppvAddress )

Value:

xTraceEntryGetAddress((TraceEntryHandle_t)(xObjectHandle), ppvAddress)

Gets trace object address.

Parameters

[in]	xObjectHandle	Object handle.
[out]	ppvAddress	Pointer to returned task address.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectGetName

#define xTraceObjectGetName	(		xObjectHandle,
			pszName )

Value:

xTraceEntryGetSymbol((TraceEntryHandle_t)(xObjectHandle), pszName)

Gets trace object name.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[out]	pszName	Pointer to name variable.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectGetSpecificState

#define xTraceObjectGetSpecificState	(	xObjectHandle,
		uiIndex,
		puxState )

Value:

xTraceEntryGetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, puxState)

Gets trace object specific state.

Parameters

[in]	xObjectHandle	Pointer to initialized trace object.
[in]	uiIndex	State Index.
[out]	puxState	Pointer to state.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectSetOptions

#define xTraceObjectSetOptions	(		xObjectHandle,
			uiOptions )

Value:

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 )

Value:

xTraceEntrySetState((TraceEntryHandle_t)(xObjectHandle), uiIndex, uxState)

Sets trace object specific 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 )

Value:

xTraceObjectSetSpecificState(xObjectHandle, 0, uxState)

xTraceObjectSetSpecificState

#define xTraceObjectSetSpecificState(xObjectHandle, uiIndex, uxState)

Sets trace object specific state.

Definition trcObject.h:153

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 )

Value:

xTraceObjectSetSpecificStateWithoutHandle(pvObject, 0, uxState)

xTraceObjectSetSpecificStateWithoutHandle

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

Sets trace object specific state without trace object handle.

Definition trcObject.c:252

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 *const	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

◆ xTraceObjectRegister2()

traceResult xTraceObjectRegister2	(	uint32_t	uiEventCode,
		void *const	pvObject,
		const char *	szName,
		TraceUnsignedBaseType_t	uxState1,
		TraceUnsignedBaseType_t	uxState2,
		TraceObjectHandle_t *	pxObjectHandle )

Registers trace object with two initial states.

Parameters

[in]	uiEventCode	Event code.
[in]	pvObject	Object.
[in]	szName	Name.
[in]	uxState1	State 1.
[in]	uxState2	State 2.
[out]	pxObjectHandle	Pointer to uninitialized trace object.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceObjectRegisterInternal()

traceResult xTraceObjectRegisterInternal	(	uint32_t	uiEventCode,
		void *const	pvObject,
		const char *	szName,
		TraceUnsignedBaseType_t	uxStateCount,
		const 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

◆ xTraceObjectRegisterWithoutHandle2()

traceResult xTraceObjectRegisterWithoutHandle2	(	uint32_t	uiEventCode,
		void *	pvObject,
		const char *	szName,
		TraceUnsignedBaseType_t	uxState1,
		TraceUnsignedBaseType_t	uxState2 )

Registers trace object with two initial states without trace object handle.

Parameters

[in]	uiEventCode	Event code.
[in]	pvObject	Object.
[in]	szName	Name.
[in]	uxState1	State 1.
[in]	uxState2	State 2.

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

◆ pvTraceObjectGetAddressReturn

◆ xTraceObjectFind

◆ xTraceObjectGetAddress

◆ xTraceObjectGetName

◆ xTraceObjectGetSpecificState

◆ xTraceObjectSetOptions

◆ xTraceObjectSetSpecificState

◆ xTraceObjectSetState

◆ xTraceObjectSetStateWithoutHandle

Function Documentation

◆ xTraceObjectRegister()

◆ xTraceObjectRegister2()

◆ xTraceObjectRegisterInternal()

◆ xTraceObjectRegisterWithoutHandle()

◆ xTraceObjectRegisterWithoutHandle2()

◆ xTraceObjectSetName()

◆ xTraceObjectSetNameWithoutHandle()

◆ xTraceObjectSetOptionsWithoutHandle()

◆ xTraceObjectSetSpecificStateWithoutHandle()

◆ xTraceObjectUnregister()

◆ xTraceObjectUnregisterWithoutHandle()