log_frontend.h File Reference

#include <zephyr/logging/log_core.h>

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

source	Pointer 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.
desc	Message descriptor.
package	Cbprintf package containing logging formatted string. Length s in desc.
data	Hexdump 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

source	Pointer 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.
level	Severity level.
fmt	String.

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

source	Pointer 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.
level	Severity level.
fmt	String.
arg	Argument 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

source	Pointer 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.
level	Severity level.
fmt	String.
arg0	First argument passed to the string.
arg1	Second argument passed to the string.