Percepio Trace Recorder v4.8.0.hotfix1
Loading...
Searching...
No Matches
Trace Print APIs

Macros

#define xTracePrintCompactF0(szChannel, szFormat)   xTraceEventCreate2(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat))
 Generate a "User Event" with 0 parameters. Channel and format string are only stored in ELF.
 
#define xTracePrintCompactF1(szChannel, szFormat, uxParam1)   xTraceEventCreate3(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1)
 Generate a "User Event" with 1 parameter. Channel and format string are only stored in ELF.
 
#define xTracePrintCompactF2(szChannel, szFormat, uxParam1, uxParam2)   xTraceEventCreate4(PSF_EVENT_USER_EVENT_FIXED + 2, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(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)   xTraceEventCreate5(PSF_EVENT_USER_EVENT_FIXED + 3, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(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)   xTraceEventCreate6(PSF_EVENT_USER_EVENT_FIXED + 4, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(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)   xTraceEventCreate2(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle))
 Generate a "User Event" with 0 parameters.
 
#define xTracePrintF1(xChannelStringHandle, xFormatStringHandle, uxParam1)   xTraceEventCreate3(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1)
 Generate a "User Event" with 1 parameter.
 
#define xTracePrintF2(xChannelStringHandle, xFormatStringHandle, uxParam1, uxParam2)   xTraceEventCreate4(PSF_EVENT_USER_EVENT_FIXED + 2, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2)
 Generate a "User Event" with 2 parameters.
 
#define xTracePrintF3(xChannelStringHandle, xFormatStringHandle, uxParam1, uxParam2, uxParam3)   xTraceEventCreate5(PSF_EVENT_USER_EVENT_FIXED + 3, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(xFormatStringHandle), uxParam1, uxParam2, uxParam3)
 Generate a "User Event" with 3 parameters.
 
#define xTracePrintF4(xChannelStringHandle, xFormatStringHandle, uxParam1, uxParam2, uxParam3, uxParam4)   xTraceEventCreate6(PSF_EVENT_USER_EVENT_FIXED + 4, (TraceUnsignedBaseType_t)(xChannelStringHandle), (TraceUnsignedBaseType_t)(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 xVariableList)
 Generates "User Events" with formatted text and data.
 

Detailed Description

Macro Definition Documentation

◆ xTracePrintCompactF0

#define xTracePrintCompactF0 (   szChannel,
  szFormat 
)    xTraceEventCreate2(PSF_EVENT_USER_EVENT_FIXED, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat))

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: xTracePrintCompactF0("MyChannel", "MyText");

Parameters
[in]szChannelChannel string.
[in]szFormatFormat string.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintCompactF1

#define xTracePrintCompactF1 (   szChannel,
  szFormat,
  uxParam1 
)    xTraceEventCreate3(PSF_EVENT_USER_EVENT_FIXED + 1, (TraceUnsignedBaseType_t)(szChannel), (TraceUnsignedBaseType_t)(szFormat), uxParam1)

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: xTracePrintCompactF1("MyChannel", "MyFormat %u", 1);

Parameters
[in]szChannelChannel string.
[in]szFormatFormat string.
[in]uxParam1First parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintCompactF2

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

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.

Examp xTracePrintCompactF2("MyChannel", "MyFormat %u %u", 1, 2);

Parameters
[in]szChannelChannel string.
[in]szFormatFormat string.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintCompactF3

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

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: xTracePrintCompactF3("MyChannel", "MyFormat %u %u %u", 1, 2, 3);

Parameters
[in]szChannelChannel string.
[in]szFormatFormat string.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintCompactF4

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

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: xTracePrintCompactF4("MyChannel", "MyFormat %u %u %u %u", 1, 2, 3, 4);

Parameters
[in]szChannelChannel string.
[in]szFormatFormat string.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
[in]uxParam4Fourth parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintF0

#define xTracePrintF0 (   xChannelStringHandle,
  xFormatStringHandle 
)    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); ... xTracePrintFormat0(xChannel, xHelloWorld);

Parameters
[in]xChannelChannel handle.
[in]xFormatStringHandleFormat string handle.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintF1

#define xTracePrintF1 (   xChannelStringHandle,
  xFormatStringHandle,
  uxParam1 
)    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); ... xTracePrintFormat1(xChannel, xHelloWorld, 1);

Parameters
[in]xChannelChannel handle.
[in]xFormatStringHandleFormat string handle.
[in]uxParam1First parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintF2

#define xTracePrintF2 (   xChannelStringHandle,
  xFormatStringHandle,
  uxParam1,
  uxParam2 
)    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); ... xTracePrintFormat2(xChannel, xHelloWorld, 1, 2);

Parameters
[in]xChannelChannel handle.
[in]xFormatStringHandleFormat string handle.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintF3

#define xTracePrintF3 (   xChannelStringHandle,
  xFormatStringHandle,
  uxParam1,
  uxParam2,
  uxParam3 
)    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); ... xTracePrintFormat3(xChannel, xHelloWorld, 1, 2, 3);

Parameters
[in]xChannelChannel handle.
[in]xFormatStringHandleFormat string handle.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTracePrintF4

#define xTracePrintF4 (   xChannelStringHandle,
  xFormatStringHandle,
  uxParam1,
  uxParam2,
  uxParam3,
  uxParam4 
)    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); ... xTracePrintFormat4(xChannel, xHelloWorld, 1, 2, 3, 4);

Parameters
[in]xChannelChannel handle.
[in]xFormatStringHandleFormat string handle.
[in]uxParam1First parameter.
[in]uxParam2Second parameter.
[in]uxParam3Third parameter.
[in]uxParam4Fourth parameter.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

Function Documentation

◆ xTraceConsoleChannelPrintF()

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

Wrapper for xTracePrintF for printing to default channel.

Wrapper for vTracePrintF, 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]szFormatFormat.
[in]...Parameters.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ 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]xChannelChannel.
[in]szStringString.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ 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]szChannelChannel string.
[in]szFormatFormat string.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ 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, adc_reading);

NOTE! All data arguments are assumed to be TraceUnsignedBaseType_t/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 (currently, this must be an earlier stored symbol name)

Up to 15 data arguments are allowed, with a total size of maximum 60 byte including 8 byte for the base event fields and the format string. So with one data argument, the maximum string length is 48 chars. If this is exceeded the string is truncated (4 bytes at a time).

Parameters
[in]xChannelChannel.
[in]szFormatFormat.
[in]...Parameters.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess

◆ xTraceVPrintF()

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

Generates "User Events" with formatted text and data.

Parameters
[in]xChannelChannel.
[in]szFormatFormat.
[in]xVariableListVariable list arguments.
Return values
TRC_FAILFailure
TRC_SUCCESSSuccess