Zephyr API Documentation  3.7.0
A Scalable Open Source RTOS
Loading...
Searching...
No Matches
log_ctrl.h File Reference
#include <zephyr/kernel.h>
#include <zephyr/logging/log_backend.h>
#include <zephyr/logging/log_msg.h>
#include <zephyr/logging/log_internal.h>
#include <zephyr/syscalls/log_ctrl.h>

Go to the source code of this file.

Macros

#define LOG_CORE_INIT()   do { } while (false)
 
#define LOG_INIT()   0
 
#define LOG_PANIC()   /* Empty */
 
#define LOG_PROCESS()   false
 

Typedefs

typedef log_timestamp_t(* log_timestamp_get_t) (void)
 

Functions

void log_core_init (void)
 Function system initialization of the logger.
 
void log_init (void)
 Function for user initialization of the logger.
 
void log_thread_trigger (void)
 Trigger the log processing thread to process logs immediately.
 
void log_thread_set (k_tid_t process_tid)
 Function for providing thread which is processing logs.
 
int log_set_timestamp_func (log_timestamp_get_t timestamp_getter, uint32_t freq)
 Function for providing timestamp function.
 
void log_panic (void)
 Switch the logger subsystem to the panic mode.
 
bool log_process (void)
 Process one pending log message.
 
uint32_t log_buffered_cnt (void)
 Return number of buffered log messages.
 
uint32_t log_src_cnt_get (uint32_t domain_id)
 Get number of independent logger sources (modules and instances)
 
const char * log_source_name_get (uint32_t domain_id, uint32_t source_id)
 Get name of the source (module or instance).
 
static uint8_t log_domains_count (void)
 Return number of domains present in the system.
 
const char * log_domain_name_get (uint32_t domain_id)
 Get name of the domain.
 
int log_source_id_get (const char *name)
 Function for finding source ID based on source name.
 
uint32_t log_filter_get (struct log_backend const *const backend, uint32_t domain_id, int16_t source_id, bool runtime)
 Get source filter for the provided backend.
 
uint32_t log_filter_set (struct log_backend const *const backend, uint32_t domain_id, int16_t source_id, uint32_t level)
 Set filter on given source for the provided backend.
 
uint32_t log_frontend_filter_get (int16_t source_id, bool runtime)
 Get source filter for the frontend.
 
uint32_t log_frontend_filter_set (int16_t source_id, uint32_t level)
 Set filter on given source for the frontend.
 
void log_backend_enable (struct log_backend const *const backend, void *ctx, uint32_t level)
 Enable backend with initial maximum filtering level.
 
void log_backend_disable (struct log_backend const *const backend)
 Disable backend.
 
const struct log_backendlog_backend_get_by_name (const char *backend_name)
 Get backend by name.
 
const struct log_backendlog_format_set_all_active_backends (size_t log_type)
 Sets logging format for all active backends.
 
static bool log_data_pending (void)
 Check if there is pending data to be processed by the logging subsystem.
 
int log_set_tag (const char *tag)
 Configure tag used to prefix each message.
 
int log_mem_get_usage (uint32_t *buf_size, uint32_t *usage)
 Get current memory usage.
 
int log_mem_get_max_usage (uint32_t *max)
 Get maximum memory usage.