Tracing format

Helpers to format trace messages as strings or raw data. More...

Files
file	tracing_format.h
	Header file for tracing format API.

Data Structures
struct	tracing_data
	A structure to represent tracing data format. More...

Macros
#define	TRACING_STRING(fmt, ...)
	Macro to trace a message in string format.
#define	TRACING_FORMAT_DATA(x)
	Macro to format data to tracing data format.
#define	TRACING_DATA(...)
	Macro to trace a message in tracing data format.

Typedefs
typedef struct tracing_data	tracing_data_t
	A structure to represent tracing data format.

Functions
void	tracing_format_string (const char *str,...)
	Tracing a message in string format.
void	tracing_format_raw_data (uint8_t *data, uint32_t length)
	Tracing a message in raw data format.
void	tracing_format_data (tracing_data_t *tracing_data_array, uint32_t count)
	Tracing a message in tracing data format.

Detailed Description

Helpers to format trace messages as strings or raw data.

Macro Definition Documentation

TRACING_DATA

#define TRACING_DATA

(

...

)

#include <zephyr/tracing/tracing_format.h>

Value:

        do {                                                                   \
                struct tracing_data arg[] = {__VA_ARGS__};                 \
                                                                               \
                tracing_format_data(arg, sizeof(arg) /                         \
                                    sizeof(struct tracing_data));          \
        } while (false)

Macro to trace a message in tracing data format.

All the parameters should be struct tracing_data.

TRACING_FORMAT_DATA

#define TRACING_FORMAT_DATA

(

x

)

#include <zephyr/tracing/tracing_format.h>

Value:

        ((struct tracing_data){.data = (uint8_t *)&(x), .length = sizeof((x))})

Macro to format data to tracing data format.

Parameters

x	Data field.

TRACING_STRING

#define TRACING_STRING	(		fmt,
			... )

#include <zephyr/tracing/tracing_format.h>

Value:

        do {                                                                   \
                tracing_format_string(fmt, ##__VA_ARGS__);                     \
        } while (false)

Macro to trace a message in string format.

Parameters

fmt	The format string.
...	The format arguments.

Typedef Documentation

tracing_data_t

typedef struct tracing_data tracing_data_t

#include <zephyr/tracing/tracing_format.h>

A structure to represent tracing data format.

This structure represents a piece of data to be emitted through the tracing subsystem. It is typically used with TRACING_FORMAT_DATA and TRACING_DATA to wrap raw values or memory regions in a common format that backends can consume

Function Documentation

tracing_format_data()

void tracing_format_data	(	tracing_data_t *	tracing_data_array,
		uint32_t	count )

#include <zephyr/tracing/tracing_format.h>

Tracing a message in tracing data format.

Parameters

tracing_data_array	Tracing_data format data array to be traced.
count	Tracing_data array data count.

tracing_format_raw_data()

void tracing_format_raw_data	(	uint8_t *	data,
		uint32_t	length )

#include <zephyr/tracing/tracing_format.h>

Tracing a message in raw data format.

Parameters

data	Raw data to be traced.
length	Raw data length.

tracing_format_string()

void tracing_format_string	(	const char *	str,
			... )

#include <zephyr/tracing/tracing_format.h>

Tracing a message in string format.

Parameters

str	String to format.
...	Variable length arguments.