vtf_monitoring.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef _VTF_MONITORING_H_
#define _VTF_MONITORING_H_
 
#include <stddef.h>
#include <stdint.h>
#include <zephyr/sys/iterable_sections.h>
 
/* Code written at address VTF_CH_INITIALIZATION to verify initialization */
#define VTF_CH_INITIALIZATION_CODE 0xAA
 
enum vtf_channel_id {
        VTF_CH_INITIALIZATION,
        VTF_CH_BATTERY_VOLTAGE,
        VTF_CH_DIE_TEMP,
        VTF_CH_FREQ_OFFSET,
        VTF_CH_COUNT,
};
 
BUILD_ASSERT(VTF_CH_INITIALIZATION  == 0, "VTF_CH_INITIALIZATION must be 0");
BUILD_ASSERT(VTF_CH_BATTERY_VOLTAGE == 1, "VTF_CH_BATTERY_VOLTAGE must be 1");
BUILD_ASSERT(VTF_CH_DIE_TEMP        == 2, "VTF_CH_DIE_TEMP must be 2");
BUILD_ASSERT(VTF_CH_FREQ_OFFSET     == 3, "VTF_CH_FREQ_OFFSET must be 3");
 
enum vtf_sample_status {
        VTF_STATUS_OK,
        VTF_STATUS_UNINITIALISED,
        VTF_STATUS_ERROR,
};
 
enum vtf_sample_type {
        VTF_SAMPLE_TYPE_INT,
        VTF_SAMPLE_TYPE_UINT,
        VTF_SAMPLE_TYPE_FLOAT,
};
 
typedef struct {
        uint16_t init_code;
        uint16_t reserved;
} vtf_metadata_t;
 
union vtf_sample_value {
        vtf_metadata_t metadata;
        int32_t i32;
        uint32_t u32;
        float f32;
};
 
struct vtf_sample {
        enum vtf_sample_type type;
        union vtf_sample_value value;
        uint64_t timestamp_ms;
        enum vtf_sample_status status;
};
 
extern volatile union vtf_sample_value vtf_snapshots[VTF_CH_COUNT];
 
struct vtf_channel {
        enum vtf_channel_id id;
        enum vtf_sample_type default_type;
        union vtf_sample_value default_value;
        int (*sample)(struct vtf_sample *out);
        int (*init)(void);
};
 
#define VTF_CHANNEL_DEFINE(_sym, _id, _sample_fn, _init_fn, _type, _field, _default)               \
        const int unique_id_##_id = 0;                                                             \
        static const STRUCT_SECTION_ITERABLE(vtf_channel, _sym) = {                                \
                .id = (_id),                                                                       \
                .sample = (_sample_fn),                                                            \
                .init = (_init_fn),                                                                \
                .default_type = (_type),                                                           \
                .default_value._field = (_default),                                                \
        }
 
static inline bool vtf_monitoring_is_ready(void)
{
        return vtf_snapshots[VTF_CH_INITIALIZATION].metadata.init_code ==
               VTF_CH_INITIALIZATION_CODE;
}
 
#endif /* _VTF_MONITORING_H_ */