Zephyr Project API  3.1.0
A Scalable Open Source RTOS
log_frontend.h File Reference

Go to the source code of this file.

Functions

void log_frontend_init (void)
 Initialize frontend. More...
 
void log_frontend_0 (const char *str, struct log_msg_ids src_level)
 Standard log with no arguments. More...
 
void log_frontend_1 (const char *str, log_arg_t arg0, struct log_msg_ids src_level)
 Standard log with one argument. More...
 
void log_frontend_2 (const char *str, log_arg_t arg0, log_arg_t arg1, struct log_msg_ids src_level)
 Standard log with two arguments. More...
 
void log_frontend_3 (const char *str, log_arg_t arg0, log_arg_t arg1, log_arg_t arg2, struct log_msg_ids src_level)
 Standard log with three arguments. More...
 
void log_frontend_n (const char *str, log_arg_t *args, uint32_t narg, struct log_msg_ids src_level)
 Standard log with arguments list. More...
 
void log_frontend_hexdump (const char *str, const uint8_t *data, uint32_t length, struct log_msg_ids src_level)
 Hexdump log. More...
 
void log_frontend_msg (const void *source, const struct log_msg2_desc desc, uint8_t *package, const void *data)
 Log message. More...
 
void log_frontend_panic (void)
 Panic state notification. More...
 

Function Documentation

◆ log_frontend_0()

void log_frontend_0 ( const char *  str,
struct log_msg_ids  src_level 
)

Standard log with no arguments.

Parameters
strString.
src_levelLog identification.

◆ log_frontend_1()

void log_frontend_1 ( const char *  str,
log_arg_t  arg0,
struct log_msg_ids  src_level 
)

Standard log with one argument.

Parameters
strString.
arg0First argument.
src_levelLog identification.

◆ log_frontend_2()

void log_frontend_2 ( const char *  str,
log_arg_t  arg0,
log_arg_t  arg1,
struct log_msg_ids  src_level 
)

Standard log with two arguments.

Parameters
strString.
arg0First argument.
arg1Second argument.
src_levelLog identification.

◆ log_frontend_3()

void log_frontend_3 ( const char *  str,
log_arg_t  arg0,
log_arg_t  arg1,
log_arg_t  arg2,
struct log_msg_ids  src_level 
)

Standard log with three arguments.

Parameters
strString.
arg0First argument.
arg1Second argument.
arg2Third argument.
src_levelLog identification.

◆ log_frontend_hexdump()

void log_frontend_hexdump ( const char *  str,
const uint8_t data,
uint32_t  length,
struct log_msg_ids  src_level 
)

Hexdump log.

Parameters
strString.
dataData.
lengthData length.
src_levelLog identification.

◆ log_frontend_init()

void log_frontend_init ( void  )

Initialize frontend.

◆ log_frontend_msg()

void log_frontend_msg ( const void *  source,
const struct log_msg2_desc  desc,
uint8_t package,
const void *  data 
)

Log message.

Message details does not contain timestamp. Since function is called in the context of log message call, implementation can use its own timestamping scheme.

Parameters
sourcePointer to a structure associated with given source. It points to static structure or dynamic structure if runtime filtering is enabled. log_const_source_id or log_dynamic_source_id can be used to determine source id.
descMessage descriptor.
packageCbprintf package containing logging formatted string. Length s in desc.
dataHexdump data. Length is in desc.

◆ log_frontend_n()

void log_frontend_n ( const char *  str,
log_arg_t args,
uint32_t  narg,
struct log_msg_ids  src_level 
)

Standard log with arguments list.

Parameters
strString.
argsArray with arguments.
nargNumber of arguments in the array.
src_levelLog identification.

◆ log_frontend_panic()

void log_frontend_panic ( void  )

Panic state notification.