Zephyr Project API 3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
log_frontend.h File Reference

Go to the source code of this file.

Functions

void log_frontend_init (void)
 Initialize frontend.
 
void log_frontend_msg (const void *source, const struct log_msg_desc desc, uint8_t *package, const void *data)
 Log generic message.
 
void log_frontend_simple_0 (const void *source, uint32_t level, const char *fmt)
 Log message with 0 arguments.
 
void log_frontend_simple_1 (const void *source, uint32_t level, const char *fmt, uint32_t arg)
 Log message with 1 argument.
 
void log_frontend_simple_2 (const void *source, uint32_t level, const char *fmt, uint32_t arg0, uint32_t arg1)
 Log message with 2 arguments.
 
void log_frontend_panic (void)
 Panic state notification.
 

Function Documentation

◆ log_frontend_init()

void log_frontend_init ( void  )

Initialize frontend.

◆ log_frontend_msg()

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

Log generic 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_panic()

void log_frontend_panic ( void  )

Panic state notification.

◆ log_frontend_simple_0()

void log_frontend_simple_0 ( const void *  source,
uint32_t  level,
const char *  fmt 
)

Log message with 0 arguments.

Optimized version for log message which does not have arguments (only string). This API is optional and is used only if optimizing common log messages is enabled.

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.
levelSeverity level.
fmtString.

◆ log_frontend_simple_1()

void log_frontend_simple_1 ( const void *  source,
uint32_t  level,
const char *  fmt,
uint32_t  arg 
)

Log message with 1 argument.

Optimized version for log message which has one argument that fits in a 32 bit word. This API is optional and is used only if optimizing common log messages is enabled.

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.
levelSeverity level.
fmtString.
argArgument passed to the string.

◆ log_frontend_simple_2()

void log_frontend_simple_2 ( const void *  source,
uint32_t  level,
const char *  fmt,
uint32_t  arg0,
uint32_t  arg1 
)

Log message with 2 arguments.

Optimized version for log message which has two arguments that fit in a 32 bit word. This API is optional and is used only if optimizing common log messages is enabled.

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.
levelSeverity level.
fmtString.
arg0First argument passed to the string.
arg1Second argument passed to the string.