michaelh/zephyr
1
0
Fork 0
Code Releases Activity

logging: Deprecate backend API

Browse source 
Deprecate v1 backend API.

Signed-off-by: Krzysztof Chruscinski <krzysztof.chruscinski@nordicsemi.no>
This commit is contained in:
Krzysztof Chruscinski 2022-01-12 11:12:08 +01:00 • committed by Anas Nashif
commit ce6297c501
1 changed files with 9 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

9
include/logging/log_backend.h
View file

@ -30,9 +30,11 @@ struct log_backend;
* @brief Logger backend API. * @brief Logger backend API.
*/ */
struct log_backend_api { struct log_backend_api {
/* Logging v2 function. */
void (*process)(const struct log_backend *const backend, void (*process)(const struct log_backend *const backend,
union log_msg2_generic *msg); union log_msg2_generic *msg);
/* DEPRECATED! Functions used for logging v1. */
void (*put)(const struct log_backend *const backend, void (*put)(const struct log_backend *const backend,
struct log_msg *msg); struct log_msg *msg);
void (*put_sync_string)(const struct log_backend *const backend, void (*put_sync_string)(const struct log_backend *const backend,
@ -42,6 +44,7 @@ struct log_backend_api {
struct log_msg_ids src_level, uint32_t timestamp, struct log_msg_ids src_level, uint32_t timestamp,
const char *metadata, const uint8_t *data, uint32_t len); const char *metadata, const uint8_t *data, uint32_t len);
/* Functions used by v1 and v2 */
void (*dropped)(const struct log_backend *const backend, uint32_t cnt); void (*dropped)(const struct log_backend *const backend, uint32_t cnt);
void (*panic)(const struct log_backend *const backend); void (*panic)(const struct log_backend *const backend);
void (*init)(const struct log_backend *const backend); void (*init)(const struct log_backend *const backend);
@ -98,6 +101,8 @@ extern const struct log_backend __log_backends_end[];
/** /**
* @brief Put message with log entry to the backend. * @brief Put message with log entry to the backend.
* *
* @warning DEPRECATED. Use logging v2.
*
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
* @param[in] msg Pointer to message with log entry. * @param[in] msg Pointer to message with log entry.
*/ */
@ -122,6 +127,8 @@ static inline void log_backend_msg2_process(
/** /**
* @brief Synchronously process log message. * @brief Synchronously process log message.
* *
* @warning DEPRECATED. Use logging v2.
*
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
* @param[in] src_level Message details. * @param[in] src_level Message details.
* @param[in] timestamp Timestamp. * @param[in] timestamp Timestamp.
@ -145,6 +152,8 @@ static inline void log_backend_put_sync_string(
/** /**
* @brief Synchronously process log hexdump_message. * @brief Synchronously process log hexdump_message.
* *
* @warning DEPRECATED. Use logging v2.
*
* @param[in] backend Pointer to the backend instance. * @param[in] backend Pointer to the backend instance.
* @param[in] src_level Message details. * @param[in] src_level Message details.
* @param[in] timestamp Timestamp. * @param[in] timestamp Timestamp.