log_ctrl.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef ZEPHYR_INCLUDE_LOGGING_LOG_CTRL_H_
#define ZEPHYR_INCLUDE_LOGGING_LOG_CTRL_H_
 
#include <zephyr/kernel.h>
#include <zephyr/logging/log_backend.h>
#include <zephyr/logging/log_msg.h>
#include <zephyr/logging/log_internal.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef log_timestamp_t (*log_timestamp_get_t)(void);
 
void log_core_init(void);
 
void log_init(void);
 
void log_thread_set(k_tid_t process_tid);
 
int log_set_timestamp_func(log_timestamp_get_t timestamp_getter,
                           uint32_t freq);
 
__syscall void log_panic(void);
 
__syscall bool log_process(bool bypass);
 
__syscall uint32_t log_buffered_cnt(void);
 
uint32_t log_src_cnt_get(uint32_t domain_id);
 
 
const char *log_source_name_get(uint32_t domain_id, uint32_t source_id);
 
const char *log_domain_name_get(uint32_t domain_id);
 
uint32_t log_filter_get(struct log_backend const *const backend,
                        uint32_t domain_id, int16_t source_id, bool runtime);
 
__syscall uint32_t log_filter_set(struct log_backend const *const backend,
                                  uint32_t domain_id, int16_t source_id,
                                  uint32_t level);
 
void log_backend_enable(struct log_backend const *const backend,
                        void *ctx,
                        uint32_t level);
 
void log_backend_disable(struct log_backend const *const backend);
 
const struct log_backend *log_backend_get_by_name(const char *backend_name);
 
const struct log_backend *log_format_set_all_active_backends(size_t log_type);
 
uint32_t log_get_strdup_pool_current_utilization(void);
 
uint32_t log_get_strdup_pool_utilization(void);
 
uint32_t log_get_strdup_longest_string(void);
 
static inline bool log_data_pending(void)
{
        if (IS_ENABLED(CONFIG_LOG_MODE_DEFERRED)) {
                return IS_ENABLED(CONFIG_LOG2) ?
                        z_log_msg2_pending() : (log_msg_mem_get_used() > 0);
        }
 
        return false;
}
 
int log_set_tag(const char *tag);
 
int log_mem_get_usage(uint32_t *buf_size, uint32_t *usage);
 
int log_mem_get_max_usage(uint32_t *max);
 
#if defined(CONFIG_LOG) && !defined(CONFIG_LOG_MODE_MINIMAL)
#define LOG_CORE_INIT() log_core_init()
#define LOG_PANIC() log_panic()
#if defined(CONFIG_LOG_FRONTEND_ONLY)
#define LOG_INIT() 0
#define LOG_PROCESS() false
#else /* !CONFIG_LOG_FRONTEND_ONLY */
#define LOG_INIT() log_init()
#define LOG_PROCESS() log_process(false)
#endif /* !CONFIG_LOG_FRONTEND_ONLY */
#else
#define LOG_CORE_INIT() do { } while (false)
#define LOG_INIT() 0
#define LOG_PANIC() /* Empty */
#define LOG_PROCESS() false
#endif
 
#include <syscalls/log_ctrl.h>
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_CTRL_H_ */