Macros
#define	xTracePrintCompactF0(szChannel, szFormat)
	Generate a "User Event" with 0 parameters. Channel and format string are only stored in ELF.
#define	xTracePrintCompactF1(szChannel, szFormat, uxParam1)
	Generate a "User Event" with 1 parameter. Channel and format string are only stored in ELF.
#define	xTracePrintCompactF2(szChannel, szFormat, uxParam1, uxParam2)
	Generate a "User Event" with 2 parameters. Channel and format string are only stored in ELF.
#define	xTracePrintCompactF3(szChannel, szFormat, uxParam1, uxParam2, uxParam3)
	Generate a "User Event" with 3 parameters. Channel and format string are only stored in ELF.
#define	xTracePrintCompactF4(szChannel, szFormat, uxParam1, uxParam2, uxParam3, uxParam4)
	Generate a "User Event" with 4 parameters. Channel and format string are only stored in ELF.
#define	xTracePrintF0(xChannelStringHandle, xFormatStringHandle)
	Generate a "User Event" with 0 parameters.
#define	xTracePrintF1(xChannelStringHandle, xFormatStringHandle, uxParam1)
	Generate a "User Event" with 1 parameter.
#define	xTracePrintF2(xChannelStringHandle, xFormatStringHandle, uxParam1, uxParam2)
	Generate a "User Event" with 2 parameters.
#define	xTracePrintF3(xChannelStringHandle, xFormatStringHandle, uxParam1, uxParam2, uxParam3)
	Generate a "User Event" with 3 parameters.
#define	xTracePrintF4(xChannelStringHandle, xFormatStringHandle, uxParam1, uxParam2, uxParam3, uxParam4)
	Generate a "User Event" with 4 parameters.

Functions
traceResult	xTracePrintCompactF (const char szChannel, const char szFormat,...)
	Generate a "User Event". Channel and format string are only stored in ELF.
traceResult	xTracePrint (TraceStringHandle_t xChannel, const char *szString)
	Generate "User Events" with unformatted text.
traceResult	xTraceConsoleChannelPrintF (const char *szFormat,...)
	Wrapper for xTracePrintF for printing to default channel.
traceResult	xTracePrintF (TraceStringHandle_t xChannel, const char *szFormat,...)
	Generates "User Events" with formatted text and data.
traceResult	xTraceVPrintF (TraceStringHandle_t xChannel, const char szFormat, va_list pxVariableList)
	Generates "User Events" with formatted text and data.

Detailed Description

Macro Definition Documentation

◆ xTracePrintCompactF0

#define xTracePrintCompactF0	(		szChannel,
			szFormat )

Value:

xTraceEventCreate2(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat))

xTraceEventCreate2

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

Creates an event with 2 parameters.

Definition trcCTI.c:1274

Generate a "User Event" with 0 parameters. Channel and format string are only stored in ELF.

This is a compact and fixed version of xTracePrintF(). Only addresses to channel and format strings are stored and an ELF file must be provided to interpret the trace.

Example: xTraceDependencyRegister("my_project.elf", TRC_DEPENDENCY_TYPE_ELF); ... xTracePrintCompactF0("MyChannel", "MyText");

Parameters

[in]	szChannel	Channel string.
[in]	szFormat	Format string.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintCompactF1

#define xTracePrintCompactF1	(	szChannel,
		szFormat,
		uxParam1 )

Value:

xTraceEventCreate3(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1)

xTraceEventCreate3

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

Creates an event with 3 parameters.

Definition trcCTI.c:1298

Generate a "User Event" with 1 parameter. Channel and format string are only stored in ELF.

This is a compact and fixed version of xTracePrintF(). Only addresses to channel and format strings are stored and an ELF file must be provided to interpret the trace.

Example: xTraceDependencyRegister("my_project.elf", TRC_DEPENDENCY_TYPE_ELF); ... xTracePrintCompactF1("MyChannel", "MyFormat %u", 1);

Parameters

[in]	szChannel	Channel string.
[in]	szFormat	Format string.
[in]	uxParam1	First parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintCompactF2

#define xTracePrintCompactF2	(	szChannel,
		szFormat,
		uxParam1,
		uxParam2 )

Value:

xTraceEventCreate4(PSF_EVENT_USER_EVENT_FIXED + 2, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1, uxParam2)

xTraceEventCreate4

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

Creates an event with 4 parameters.

Definition trcCTI.c:1322

Generate a "User Event" with 2 parameters. Channel and format string are only stored in ELF.

This is a compact and fixed version of xTracePrintF(). Only addresses to channel and format strings are stored and an ELF file must be provided to interpret the trace.

Example xTraceDependencyRegister("my_project.elf", TRC_DEPENDENCY_TYPE_ELF); ... xTracePrintCompactF2("MyChannel", "MyFormat %u %u", 1, 2);

Parameters

[in]	szChannel	Channel string.
[in]	szFormat	Format string.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintCompactF3

#define xTracePrintCompactF3	(	szChannel,
		szFormat,
		uxParam1,
		uxParam2,
		uxParam3 )

Value:

xTraceEventCreate5(PSF_EVENT_USER_EVENT_FIXED + 3, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1, uxParam2, uxParam3)

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.

Definition trcCTI.c:1346

Generate a "User Event" with 3 parameters. Channel and format string are only stored in ELF.

This is a compact and fixed version of xTracePrintF(). Only addresses to channel and format strings are stored and an ELF file must be provided to interpret the trace.

Example: xTraceDependencyRegister("my_project.elf", TRC_DEPENDENCY_TYPE_ELF); ... xTracePrintCompactF3("MyChannel", "MyFormat %u %u %u", 1, 2, 3);

Parameters

[in]	szChannel	Channel string.
[in]	szFormat	Format string.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintCompactF4

#define xTracePrintCompactF4	(	szChannel,
		szFormat,
		uxParam1,
		uxParam2,
		uxParam3,
		uxParam4 )

Value:

xTraceEventCreate6(PSF_EVENT_USER_EVENT_FIXED + 4, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1, uxParam2, uxParam3, uxParam4)

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.

Definition trcCTI.c:1370

Generate a "User Event" with 4 parameters. Channel and format string are only stored in ELF.

This is a compact and fixed version of xTracePrintF(). Only addresses to channel and format strings are stored and an ELF file must be provided to interpret the trace.

Example: xTraceDependencyRegister("my_project.elf", TRC_DEPENDENCY_TYPE_ELF); ... xTracePrintCompactF4("MyChannel", "MyFormat %u %u %u %u", 1, 2, 3, 4);

Parameters

[in]	szChannel	Channel string.
[in]	szFormat	Format string.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintF0

#define xTracePrintF0	(		xChannelStringHandle,
			xFormatStringHandle )

Value:

xTraceEventCreate2(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle))

Generate a "User Event" with 0 parameters.

This is a highly optimized version of xTracePrintF(). The channel and format string must be registered using xTraceStringRegister().

Example: TraceStringHandle_t xChannel; TraceStringHandle_t xHelloWorld;

xTraceStringRegister("MyChannel", &xChannel); xTraceStringRegister("Hello world!", &xHelloWorld); ... xTracePrintF0(xChannel, xHelloWorld);

Parameters

[in]	xChannel	Channel handle.
[in]	xFormatStringHandle	Format string handle.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintF1

#define xTracePrintF1	(	xChannelStringHandle,
		xFormatStringHandle,
		uxParam1 )

Value:

xTraceEventCreate3(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1)

Generate a "User Event" with 1 parameter.

This is a highly optimized version of xTracePrintF(). The channel and format string must be registered using xTraceStringRegister().

Example: TraceStringHandle_t xChannel; TraceStringHandle_t xHelloWorld;

xTraceStringRegister("MyChannel", &xChannel); xTraceStringRegister("Hello world! %d", &xHelloWorld); ... xTracePrintF1(xChannel, xHelloWorld, 1);

Parameters

[in]	xChannel	Channel handle.
[in]	xFormatStringHandle	Format string handle.
[in]	uxParam1	First parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintF2

#define xTracePrintF2	(	xChannelStringHandle,
		xFormatStringHandle,
		uxParam1,
		uxParam2 )

Value:

xTraceEventCreate4(PSF_EVENT_USER_EVENT_FIXED + 2, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2)

Generate a "User Event" with 2 parameters.

This is a highly optimized version of xTracePrintF(). The channel and format string must be registered using xTraceStringRegister().

Example: TraceStringHandle_t xChannel; TraceStringHandle_t xHelloWorld;

xTraceStringRegister("MyChannel", &xChannel); xTraceStringRegister("Hello world! %d %d", &xHelloWorld); ... xTracePrintF2(xChannel, xHelloWorld, 1, 2);

Parameters

[in]	xChannel	Channel handle.
[in]	xFormatStringHandle	Format string handle.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintF3

#define xTracePrintF3	(	xChannelStringHandle,
		xFormatStringHandle,
		uxParam1,
		uxParam2,
		uxParam3 )

Value:

xTraceEventCreate5(PSF_EVENT_USER_EVENT_FIXED + 3, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2, uxParam3)

Generate a "User Event" with 3 parameters.

This is a highly optimized version of xTracePrintF(). The channel and format string must be registered using xTraceStringRegister().

Example: TraceStringHandle_t xChannel; TraceStringHandle_t xHelloWorld;

xTraceStringRegister("MyChannel", &xChannel); xTraceStringRegister("Hello world! %d %d %d", &xHelloWorld); ... xTracePrintF3(xChannel, xHelloWorld, 1, 2, 3);

Parameters

[in]	xChannel	Channel handle.
[in]	xFormatStringHandle	Format string handle.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintF4

#define xTracePrintF4	(	xChannelStringHandle,
		xFormatStringHandle,
		uxParam1,
		uxParam2,
		uxParam3,
		uxParam4 )

Value:

xTraceEventCreate6(PSF_EVENT_USER_EVENT_FIXED + 4, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2, uxParam3, uxParam4)

Generate a "User Event" with 4 parameters.

This is a highly optimized version of xTracePrintF(). The channel and format string must be registered using xTraceStringRegister().

Example: TraceStringHandle_t xChannel; TraceStringHandle_t xHelloWorld;

xTraceStringRegister("MyChannel", &xChannel); xTraceStringRegister("Hello world! %d %d %d %d", &xHelloWorld); ... xTracePrintF4(xChannel, xHelloWorld, 1, 2, 3, 4);

Parameters

[in]	xChannel	Channel handle.
[in]	xFormatStringHandle	Format string handle.
[in]	uxParam1	First parameter.
[in]	uxParam2	Second parameter.
[in]	uxParam3	Third parameter.
[in]	uxParam4	Fourth parameter.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Function Documentation

◆ xTraceConsoleChannelPrintF()

traceResult xTraceConsoleChannelPrintF	(	const char *	szFormat,
			... )

Wrapper for xTracePrintF for printing to default channel.

Wrapper for xTracePrintF, using the default channel. Can be used as a drop-in replacement for printf and similar functions, e.g. in a debug logging macro. NOTE! All parameters must be cast to TraceUnsignedBaseType_t/TraceBaseType_t!

Example: // Old: #define LogString debug_console_printf

// New, log to Tracealyzer instead: #define LogString xTraceConsoleChannelPrintF ... LogString("My value is: %d", myValue);

Parameters

[in]	szFormat	Format.
[in]	...	Parameters.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrint()

traceResult xTracePrint	(	TraceStringHandle_t	xChannel,
		const char *	szString )

Generate "User Events" with unformatted text.

User Events can be used for very efficient application logging, and are shown as yellow labels in the main trace view.

You may group User Events into User Event Channels. The yellow User Event labels shows the logged string, preceded by the channel name within brackets. For example:

"[MyChannel] Hello World!"

The User Event Channels are shown in the View Filter, which makes it easy to select what User Events you wish to display. User Event Channels are created using xTraceStringRegister().

Example:

TraceStringHandle_t xChannel; xTraceStringRegister("MyChannel", &xChannel); ... xTracePrint(xChannel, "Hello World!");

Parameters

[in]	xChannel	Channel.
[in]	szString	String.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintCompactF()

traceResult xTracePrintCompactF	(	const char *	szChannel,
		const char *	szFormat,
			... )

Generate a "User Event". Channel and format string are only stored in ELF.

This is a compact version of xTracePrintF(). Only addresses to channel and format strings are stored and an ELF file must be provided to interpret the trace. NOTE! All parameters must be cast to TraceUnsignedBaseType_t/TraceBaseType_t!

Example: xTracePrintCompact("MyChannel", "MyFormat %d", 1);

Parameters

[in]	szChannel	Channel string.
[in]	szFormat	Format string.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTracePrintF()

traceResult xTracePrintF	(	TraceStringHandle_t	xChannel,
		const char *	szFormat,
			... )

Generates "User Events" with formatted text and data.

Generates "User Events", with formatted text and data, similar to a "printf". It is very fast since the actual formatting is done on the host side when the trace is displayed.

User Events can be used for very efficient application logging, and are shown as yellow labels in the main trace view. An advantage of User Events is that data can be plotted in the "User Event Signal Plot" view, visualizing any data you log as User Events, discrete states or control system signals (e.g. system inputs or outputs).

You may group User Events into User Event Channels. The yellow User Event labels show the logged string, preceded by the channel name within brackets.

Example:

"[MyChannel] Hello World!"

The User Event Channels are shown in the View Filter, which makes it easy to select what User Events you wish to display. User Event Channels are created using xTraceStringRegister().

Example:

TraceStringHandle_t adc_uechannel; xTraceStringRegister("ADC User Events", &adc_uechannel); ... xTracePrintF(adc_uechannel, "ADC channel %d: %d volts", ch, (TraceBaseType_t)adc_reading);

NOTE! All data arguments must be TraceUnsignedBaseType_t or TraceBaseType_t.

The following formats are supported: d - signed integer. The following width and padding format is supported: "%05d" -> "-0042" and "%5d" -> " -42" u - unsigned integer. The following width and padding format is supported: "%05u" -> "00042" and "%5u" -> " 42" X - hexadecimal (uppercase). The following width and padding format is supported: "%04X" -> "002A" and "%4X" -> " 2A" x - hexadecimal (lowercase). The following width and padding format is supported: "%04x" -> "002a" and "%4x" -> " 2a" s - string. A TraceStringHandle_t from a string that was stored using xTraceStringRegister(...).

A maximum of 5 parameters will be stored in the event along with the format string. On a 32-bit system; a maximum size of 52 bytes is allowed for the parameters and format string combined. Each parameter takes 4 bytes. On a 64-bit system; a maximum size of 112 bytes is allowed for the parameters and format string combined. Each parameter takes 8 bytes. The format string will be truncated if maximum size is exceeded.

Parameters

[in]	xChannel	Channel.
[in]	szFormat	Format.
[in]	...	Parameters.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

◆ xTraceVPrintF()

traceResult xTraceVPrintF	(	TraceStringHandle_t	xChannel,
		const char *	szFormat,
		va_list *	pxVariableList )

Generates "User Events" with formatted text and data.

Parameters

[in]	xChannel	Channel.
[in]	szFormat	Format.
[in]	pxVariableList	Pointer to variable list arguments.

Return values

TRC_FAIL	Failure
TRC_SUCCESS	Success

Macros

Functions

Detailed Description

Macro Definition Documentation

◆ xTracePrintCompactF0

◆ xTracePrintCompactF1

◆ xTracePrintCompactF2

◆ xTracePrintCompactF3

◆ xTracePrintCompactF4

◆ xTracePrintF0

◆ xTracePrintF1

◆ xTracePrintF2

◆ xTracePrintF3

◆ xTracePrintF4

Function Documentation

◆ xTraceConsoleChannelPrintF()

◆ xTracePrint()

◆ xTracePrintCompactF()

◆ xTracePrintF()

◆ xTraceVPrintF()