log_instance.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_INSTANCE_H_
#define ZEPHYR_INCLUDE_LOGGING_LOG_INSTANCE_H_
 
#include <zephyr/types.h>
#include <zephyr/sys/iterable_sections.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
struct log_source_const_data {
        const char *name;
        uint8_t level;
#ifdef CONFIG_NIOS2
        /* Workaround alert! Dummy data to ensure that structure is >8 bytes.
         * Nios2 uses global pointer register for structures <=8 bytes and
         * apparently does not handle well variables placed in custom sections.
         */
        uint32_t dummy;
#endif
};
 
struct log_source_dynamic_data {
        uint32_t filters;
#ifdef CONFIG_NIOS2
        /* Workaround alert! Dummy data to ensure that structure is >8 bytes.
         * Nios2 uses global pointer register for structures <=8 bytes and
         * apparently does not handle well variables placed in custom sections.
         */
        uint32_t dummy[2];
#endif
#if defined(CONFIG_64BIT)
        /* Workaround: Ensure that structure size is a multiple of 8 bytes. */
        uint32_t dummy_64;
#endif
};
 
#define Z_LOG_ITEM_CONST_DATA(_name) UTIL_CAT(log_const_, _name)
 
#define Z_LOG_CONST_ITEM_REGISTER(_name, _str_name, _level)                    \
        const STRUCT_SECTION_ITERABLE_ALTERNATE(log_const,                     \
                log_source_const_data,                                         \
                Z_LOG_ITEM_CONST_DATA(_name)) =                                \
        {                                                                      \
                .name = _str_name,                                             \
                .level  = (_level),                                            \
        }
 
#define LOG_OBJECT_PTR_INIT(_name, _object) \
        IF_ENABLED(CONFIG_LOG, (._name = _object,))
 
#define Z_LOG_INSTANCE_FULL_NAME(_module_name, _inst_name) \
        UTIL_CAT(_module_name, UTIL_CAT(_, _inst_name))
 
#define Z_LOG_OBJECT_PTR(_name) \
                COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, \
                        (&LOG_ITEM_DYNAMIC_DATA(_name)), \
                        (&Z_LOG_ITEM_CONST_DATA(_name))) \
 
#define LOG_INSTANCE_PTR(_module_name, _inst_name) \
        Z_LOG_OBJECT_PTR(Z_LOG_INSTANCE_FULL_NAME(_module_name, _inst_name))
 
#define LOG_INSTANCE_PTR_INIT(_name, _module_name, _inst_name)     \
        LOG_OBJECT_PTR_INIT(_name, LOG_INSTANCE_PTR(_module_name, _inst_name))
 
#define Z_LOG_INSTANCE_STRUCT \
        COND_CODE_1(CONFIG_LOG_RUNTIME_FILTERING, \
                    (struct log_source_dynamic_data), \
                    (const struct log_source_const_data))
 
#define LOG_INSTANCE_PTR_DECLARE(_name) \
        COND_CODE_1(CONFIG_LOG, (Z_LOG_INSTANCE_STRUCT * _name), \
                                (int _name[TOOLCHAIN_HAS_ZLA ? 0 : 1]))
 
#define Z_LOG_RUNTIME_INSTANCE_REGISTER(_module_name, _inst_name) \
        STRUCT_SECTION_ITERABLE_ALTERNATE(log_dynamic, log_source_dynamic_data, \
                        LOG_INSTANCE_DYNAMIC_DATA(_module_name, _inst_name))
 
#define Z_LOG_INSTANCE_REGISTER(_module_name, _inst_name, _level) \
        Z_LOG_CONST_ITEM_REGISTER( \
                Z_LOG_INSTANCE_FULL_NAME(_module_name, _inst_name), \
                STRINGIFY(_module_name._inst_name), \
                _level); \
        IF_ENABLED(CONFIG_LOG_RUNTIME_FILTERING, \
                   (Z_LOG_RUNTIME_INSTANCE_REGISTER(_module_name, _inst_name)))
 
#define LOG_INSTANCE_REGISTER(_module_name, _inst_name, _level) \
        IF_ENABLED(CONFIG_LOG, (Z_LOG_INSTANCE_REGISTER(_module_name, _inst_name, _level)))
 
#ifdef __cplusplus
}
#endif
 
#endif /* ZEPHYR_INCLUDE_LOGGING_LOG_INSTANCE_H_ */