include/zephyr/logging/log_frontend.h

/*
 * Copyright (c) 2019 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
#ifndef LOG_FRONTEND_H_
#define LOG_FRONTEND_H_

#include <zephyr/logging/log_core.h>

/** @brief Initialize frontend.
 */
void log_frontend_init(void);

/** @brief 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.
 *
 * @param source Pointer to a structure associated with given source. It points to
 * static structure or dynamic structure if runtime filtering is enabled.
 * @ref log_const_source_id or @ref log_dynamic_source_id can be used to determine
 * source id.
 *
 * @param desc Message descriptor.
 *
 * @param package Cbprintf package containing logging formatted string. Length s in @p desc.
 *
 * @param data Hexdump data. Length is in @p desc.
 */
void log_frontend_msg(const void *source,
		      const struct log_msg_desc desc,
		      uint8_t *package, const void *data);

/** @brief 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.
 *
 * @param source Pointer to a structure associated with given source. It points to
 * static structure or dynamic structure if runtime filtering is enabled.
 * @ref log_const_source_id or @ref log_dynamic_source_id can be used to determine
 * source id.
 * @param level Severity level.
 * @param fmt  String.
 */
void log_frontend_simple_0(const void *source, uint32_t level, const char *fmt);

/** @brief 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.
 *
 * @param source Pointer to a structure associated with given source. It points to
 * static structure or dynamic structure if runtime filtering is enabled.
 * @ref log_const_source_id or @ref log_dynamic_source_id can be used to determine
 * source id.
 * @param level Severity level.
 * @param fmt  String.
 * @param arg  Argument passed to the string.
 */
void log_frontend_simple_1(const void *source, uint32_t level, const char *fmt, uint32_t arg);

/** @brief 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.
 *
 * @param source Pointer to a structure associated with given source. It points to
 * static structure or dynamic structure if runtime filtering is enabled.
 * @ref log_const_source_id or @ref log_dynamic_source_id can be used to determine
 * source id.
 * @param level Severity level.
 * @param fmt   String.
 * @param arg0  First argument passed to the string.
 * @param arg1  Second argument passed to the string.
 */
void log_frontend_simple_2(const void *source, uint32_t level,
			   const char *fmt, uint32_t arg0, uint32_t arg1);

/** @brief Panic state notification. */
void log_frontend_panic(void);

#endif /* LOG_FRONTEND_H_ */