Zephyr API Documentation  2.7.0-rc2
A Scalable Open Source RTOS
tracing_format.h File Reference
#include <toolchain/common.h>

Go to the source code of this file.

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. More...
 
#define TRACING_FORMAT_DATA(x)    ((struct tracing_data){.data = (uint8_t *)&(x), .length = sizeof((x))})
 Macro to format data to tracing data format. More...
 
#define TRACING_DATA(...)
 Macro to trace a message in tracing data format. More...
 

Typedefs

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

Functions

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

Macro Definition Documentation

◆ TRACING_DATA

#define TRACING_DATA (   ...)
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:19
void tracing_format_data(tracing_data_t *tracing_data_array, uint32_t count)
Tracing a message in tracing data format.

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))})

Macro to format data to tracing data format.

◆ TRACING_STRING

#define TRACING_STRING (   fmt,
  ... 
)
Value:
do { \
tracing_format_string(fmt, ##__VA_ARGS__); \
} while (false)

Macro to trace a message in string format.

Typedef Documentation

◆ tracing_data_t

typedef struct tracing_data tracing_data_t

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 
)

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 
)

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,
  ... 
)

Tracing a message in string format.

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