Log messages

Log message. More...

Files
file	log_msg.h
	Header file for log messages.

Typedefs
typedef uint32_t	log_timestamp_t
	Timestamp value associated with a log message.

Functions
static uint32_t	log_msg_get_total_wlen (const struct log_msg_desc desc)
	Get total length (in 32 bit words) of a log message.
static uint32_t	log_msg_generic_get_wlen (const union mpsc_pbuf_generic *item)
	Get length of the log item.
static uint8_t	log_msg_get_domain (struct log_msg *msg)
	Get log message domain ID.
static uint8_t	log_msg_get_level (struct log_msg *msg)
	Get log message level.
static const void *	log_msg_get_source (struct log_msg *msg)
	Get message source data.
int16_t	log_msg_get_source_id (struct log_msg *msg)
	Get log message source ID.
static log_timestamp_t	log_msg_get_timestamp (struct log_msg *msg)
	Get timestamp.
static void *	log_msg_get_tid (struct log_msg *msg)
	Get Thread ID.
static uint8_t	log_msg_get_core_id (struct log_msg *msg)
	Get Core ID.
static uint8_t *	log_msg_get_data (struct log_msg *msg, size_t *len)
	Get data buffer.
static uint8_t *	log_msg_get_package (struct log_msg *msg, size_t *len)
	Get string package.

Detailed Description

Log message.

Typedef Documentation

log_timestamp_t

typedef uint32_t log_timestamp_t

#include <zephyr/logging/log_msg.h>

Timestamp value associated with a log message.

32-bit wide by default, or 64-bit when CONFIG_LOG_TIMESTAMP_64BIT is enabled. The meaning of the value (ticks, cycles, microseconds, ...) depends on the registered timestamp source; see log_set_timestamp_func().

Function Documentation

log_msg_generic_get_wlen()

uint32_t log_msg_generic_get_wlen ( const union mpsc_pbuf_generic * item )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get length of the log item.

Parameters

item

Item.

Returns

Length in 32 bit words.

log_msg_get_core_id()

uint8_t log_msg_get_core_id ( struct log_msg * msg )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get Core ID.

Parameters

msg	Log message.

Returns

Core ID.

log_msg_get_data()

uint8_t * log_msg_get_data ( struct log_msg * msg, size_t * len )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get data buffer.

Parameters

msg	log message.
len	location where data length is written.

Returns

pointer to the data buffer.

log_msg_get_domain()

uint8_t log_msg_get_domain ( struct log_msg * msg )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get log message domain ID.

Parameters

msg	Log message.

Returns

Domain ID

log_msg_get_level()

uint8_t log_msg_get_level ( struct log_msg * msg )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get log message level.

Parameters

msg	Log message.

Returns

Log level.

log_msg_get_package()

uint8_t * log_msg_get_package ( struct log_msg * msg, size_t * len )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get string package.

Parameters

msg	log message.
len	location where string package length is written.

Returns

pointer to the package.

log_msg_get_source()

const void * log_msg_get_source ( struct log_msg * msg )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get message source data.

Parameters

msg	Log message.

Returns

Pointer to the source data.

log_msg_get_source_id()

int16_t log_msg_get_source_id

(

struct log_msg *

msg

)

#include <zephyr/logging/log_msg.h>

Get log message source ID.

Parameters

msg	Log message.

Returns

Source ID, or -1 if not available.

log_msg_get_tid()

void * log_msg_get_tid ( struct log_msg * msg )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get Thread ID.

Parameters

msg	Log message.

Returns

Thread ID.

log_msg_get_timestamp()

log_timestamp_t log_msg_get_timestamp ( struct log_msg * msg )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get timestamp.

Parameters

msg	Log message.

Returns

Timestamp.

log_msg_get_total_wlen()

uint32_t log_msg_get_total_wlen ( const struct log_msg_desc desc )

inlinestatic

#include <zephyr/logging/log_msg.h>

Get total length (in 32 bit words) of a log message.

Parameters

desc	Log message descriptor.

Returns

Length.