log_multidomain_helper.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: Apache-2.0
 */
 
#ifndef ZEPHYR_INCLUDE_LOGGING_LOG_MULTIDOMAIN_HELPER_H_
#define ZEPHYR_INCLUDE_LOGGING_LOG_MULTIDOMAIN_HELPER_H_
 
/* This module aims to provide baseline for links and backends and simplify
 * the implementation. It is not core part of logging in similar way as
 * log_output module is just a helper for log message formatting. Links and
 * backends can be implemented without this helper.
 */
 
#define Z_LOG_MULTIDOMAIN_ID_MSG 0
 
#define Z_LOG_MULTIDOMAIN_ID_GET_DOMAIN_CNT 1
 
#define Z_LOG_MULTIDOMAIN_ID_GET_SOURCE_CNT 2
 
#define Z_LOG_MULTIDOMAIN_ID_GET_DOMAIN_NAME 3
 
#define Z_LOG_MULTIDOMAIN_ID_GET_SOURCE_NAME 4
 
#define Z_LOG_MULTIDOMAIN_ID_GET_LEVELS 5
 
#define Z_LOG_MULTIDOMAIN_ID_SET_RUNTIME_LEVEL 6
 
#define Z_LOG_MULTIDOMAIN_ID_DROPPED 7
 
#define Z_LOG_MULTIDOMAIN_ID_READY 8
 
#define Z_LOG_MULTIDOMAIN_STATUS_OK 0
#define Z_LOG_MULTIDOMAIN_STATUS_ERR 1
 
struct log_multidomain_log_msg {
        uint8_t data[0];
} __packed;
 
struct log_multidomain_domain_cnt {
        uint16_t count;
} __packed;
 
struct log_multidomain_source_cnt {
        uint8_t domain_id;
        uint16_t count;
} __packed;
 
struct log_multidomain_domain_name {
        uint8_t domain_id;
        char name[0];
} __packed;
 
struct log_multidomain_source_name {
        uint8_t domain_id;
        uint16_t source_id;
        char name[0];
} __packed;
 
struct log_multidomain_levels {
        uint8_t domain_id;
        uint16_t source_id;
        uint8_t level;
        uint8_t runtime_level;
} __packed;
 
struct log_multidomain_set_runtime_level {
        uint8_t domain_id;
        uint16_t source_id;
        uint8_t runtime_level;
} __packed;
 
struct log_multidomain_dropped {
        uint32_t dropped;
} __packed;
 
union log_multidomain_msg_data {
        struct log_multidomain_log_msg log_msg;
        struct log_multidomain_domain_cnt domain_cnt;
        struct log_multidomain_source_cnt source_cnt;
        struct log_multidomain_domain_name domain_name;
        struct log_multidomain_source_name source_name;
        struct log_multidomain_levels levels;
        struct log_multidomain_set_runtime_level set_rt_level;
        struct log_multidomain_dropped dropped;
};
 
struct log_multidomain_msg {
        uint8_t id;
        uint8_t status;
        union log_multidomain_msg_data data;
} __packed;
 
struct log_multidomain_link;
 
struct log_multidomain_link_transport_api {
        int (*init)(struct log_multidomain_link *link);
        int (*send)(struct log_multidomain_link *link, void *data, size_t len);
};
 
union log_multidomain_link_dst {
        uint16_t count;
 
        struct {
                char *dst;
                size_t *len;
        } name;
 
        struct {
                uint8_t level;
                uint8_t runtime_level;
        } levels;
 
        struct {
                uint8_t level;
        } set_runtime_level;
};
 
extern struct log_link_api log_multidomain_link_api;
 
struct log_multidomain_link {
        const struct log_multidomain_link_transport_api *transport_api;
        struct k_sem rdy_sem;
        const struct log_link *link;
        union log_multidomain_link_dst dst;
        int status;
        bool ready;
};
 
struct log_multidomain_backend;
 
struct log_multidomain_backend_transport_api {
        int (*init)(struct log_multidomain_backend *backend);
        int (*send)(struct log_multidomain_backend *backend, void *data, size_t len);
};
 
extern const struct log_backend_api log_multidomain_backend_api;
 
struct log_multidomain_backend {
        const struct log_multidomain_backend_transport_api *transport_api;
        const struct log_backend *log_backend;
        struct k_sem rdy_sem;
        bool panic;
        int status;
        bool ready;
};
 
void log_multidomain_link_on_recv_cb(struct log_multidomain_link *link,
                                     const void *data, size_t len);
 
void log_multidomain_link_on_error(struct log_multidomain_link *link, int err);
 
void log_multidomain_link_on_started(struct log_multidomain_link *link, int err);
 
void log_multidomain_backend_on_recv_cb(struct log_multidomain_backend *backend,
                                        const void *data, size_t len);
 
void log_multidomain_backend_on_error(struct log_multidomain_backend *backend, int err);
 
void log_multidomain_backend_on_started(struct log_multidomain_backend *backend, int err);
 
#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_MULTIDOMAIN_HELPER_H_ */