Zephyr Project API 3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
Tracing format APIs

Tracing format APIs. More...

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)    ((struct tracing_data){.data = (uint8_t *)&(x), .length = sizeof((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

Tracing format APIs.

Macro Definition Documentation

◆ TRACING_DATA

#define TRACING_DATA (   ...)

#include <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)
A structure to represent tracing data format.
Definition tracing_format.h:24

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)     ((struct tracing_data){.data = (uint8_t *)&(x), .length = sizeof((x))})

#include <include/zephyr/tracing/tracing_format.h>

Macro to format data to tracing data format.

Parameters
xData field.

◆ TRACING_STRING

#define TRACING_STRING (   fmt,
  ... 
)

#include <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
fmtThe format string.
...The format arguments.

Typedef Documentation

◆ tracing_data_t

typedef struct tracing_data tracing_data_t

#include <include/zephyr/tracing/tracing_format.h>

A structure to represent tracing data format.

Function Documentation

◆ tracing_format_data()

void tracing_format_data ( tracing_data_t tracing_data_array,
uint32_t  count 
)

#include <include/zephyr/tracing/tracing_format.h>

Tracing a message in tracing data format.

Parameters
tracing_data_arrayTracing_data format data array to be traced.
countTracing_data array data count.

◆ tracing_format_raw_data()

void tracing_format_raw_data ( uint8_t data,
uint32_t  length 
)

#include <include/zephyr/tracing/tracing_format.h>

Tracing a message in raw data format.

Parameters
dataRaw data to be traced.
lengthRaw data length.

◆ tracing_format_string()

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

#include <include/zephyr/tracing/tracing_format.h>

Tracing a message in string format.

Parameters
strString to format.
...Variable length arguments.