nrf_edgeai_obsv_metrics.h

Go to the documentation of this file.

/*
 * Copyright (c) 2026 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
#ifndef NRF_EDGEAI_OBSV_METRICS_H
#define NRF_EDGEAI_OBSV_METRICS_H
 
#include <stdbool.h>
#include <stddef.h>
#include <stdint.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
typedef struct {
        uint32_t metric_id;
        uint32_t version;
        uint16_t num_rows;
        uint16_t num_cols;
        const uint32_t *counts;
} nrf_edgeai_obsv_metric_snapshot_t;
 
enum nrf_edgeai_obsv_source {
        NRF_EDGEAI_OBSV_SOURCE_PROBS = 0, /* metric fed via nrf_edgeai_obsv_update_probs */
        NRF_EDGEAI_OBSV_SOURCE_FEATURES = 1,
};
 
typedef struct nrf_edgeai_obsv_metric_s {
        void (*init)(const void *p_cfg, void *priv);
 
        void (*update)(const float *p_data, uint16_t n, void *priv);
 
        void (*clear)(void *priv);
 
        void (*finalize)(void *priv);
 
        void (*snapshot)(nrf_edgeai_obsv_metric_snapshot_t *out, void *priv);
 
        enum nrf_edgeai_obsv_source source;
 
        void *priv;
 
        struct nrf_edgeai_obsv_metric_s *p_next;
} nrf_edgeai_obsv_metric_t;
 
enum nrf_edgeai_obsv_metric_id {
        NRF_EDGEAI_OBSV_METRIC_ID_TRANSITION_MATRIX = 2,
        NRF_EDGEAI_OBSV_METRIC_ID_PROBS_DISTRIBUTION = 3,
        NRF_EDGEAI_OBSV_METRIC_ID_PREDICTION_SWITCHING_RATE = 4,
        NRF_EDGEAI_OBSV_METRIC_ID_PROBS_ENTROPY_DIST = 5,
        NRF_EDGEAI_OBSV_METRIC_ID_PROBS_TOP2_MARGIN_DIST = 6,
        NRF_EDGEAI_OBSV_METRIC_ID_MEL_ENERGY_DESC = 7,
        NRF_EDGEAI_OBSV_METRIC_ID_MEL_SPECTRAL_DESC = 8,
};
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_PROBS_DISTRIBUTION)
 
typedef struct {
        float bin_edges[CONFIG_NRF_EDGEAI_OBSV_PROBS_DISTRIBUTION_BIN_NUM - 1];
} nrf_obsv_probs_dist_cfg_t;
 
typedef struct {
        uint16_t num_classes;
        uint8_t bin_num;
        uint8_t _pad[1];
} _nrf_obsv_pd_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_pd_hdr_t) == 4,
               "Layout changed; update NRF_EDGEAI_OBSV_PD_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_PD_STORAGE_BYTES(n_classes)                                          \
        (sizeof(_nrf_obsv_pd_hdr_t)                                                          \
         + ((size_t)CONFIG_NRF_EDGEAI_OBSV_PROBS_DISTRIBUTION_BIN_NUM - 1U) * sizeof(float)  \
         + (size_t)(n_classes) * CONFIG_NRF_EDGEAI_OBSV_PROBS_DISTRIBUTION_BIN_NUM           \
           * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_pd_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                      uint16_t n_classes);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_PROBS_DISTRIBUTION */
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_TRANSITION_MATRIX)
 
typedef struct {
        uint16_t num_classes;
        uint16_t prev;
} _nrf_obsv_tm_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_tm_hdr_t) == 4,
               "Layout changed; update NRF_EDGEAI_OBSV_TM_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_TM_STORAGE_BYTES(n_classes) \
        (sizeof(_nrf_obsv_tm_hdr_t) + (size_t)(n_classes) * (size_t)(n_classes) * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_tm_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                      uint16_t n_classes);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_TRANSITION_MATRIX */
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_PREDICTION_SWITCHING_RATE)
 
typedef struct {
        uint16_t num_classes;
        uint16_t prev;
} _nrf_obsv_psr_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_psr_hdr_t) == 4,
               "Layout changed; update NRF_EDGEAI_OBSV_PSR_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_PSR_STORAGE_BYTES(n_classes) \
        (sizeof(_nrf_obsv_psr_hdr_t) + 2U * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_psr_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                       uint16_t n_classes);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_PREDICTION_SWITCHING_RATE */
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_PROBS_ENTROPY_DIST)
 
typedef struct {
        uint16_t num_classes;
        uint8_t bin_num;
        uint8_t _pad[1];
} _nrf_obsv_ped_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_ped_hdr_t) == 4,
               "Layout changed; update NRF_EDGEAI_OBSV_PED_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_PED_STORAGE_BYTES(n_classes)                                          \
        (sizeof(_nrf_obsv_ped_hdr_t)                                                          \
         + (size_t)CONFIG_NRF_EDGEAI_OBSV_PROBS_ENTROPY_DIST_BIN_NUM * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_ped_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                       uint16_t n_classes);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_PROBS_ENTROPY_DIST */
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_PROBS_TOP2_MARGIN_DIST)
 
typedef struct {
        uint16_t num_classes;
        uint8_t bin_num;
        uint8_t _pad[1];
} _nrf_obsv_pmd_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_pmd_hdr_t) == 4,
               "Layout changed; update NRF_EDGEAI_OBSV_PMD_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_PMD_STORAGE_BYTES(n_classes)                                            \
        (sizeof(_nrf_obsv_pmd_hdr_t)                                                            \
         + (size_t)CONFIG_NRF_EDGEAI_OBSV_PROBS_TOP2_MARGIN_DIST_BIN_NUM * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_pmd_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                       uint16_t n_classes);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_PROBS_TOP2_MARGIN_DIST */
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_MEL_ENERGY_DESC)
 
typedef struct {
        uint16_t num_features;
        uint8_t bin_num;
        uint8_t _pad[1];
        float scale_min;
        float scale_max;
} _nrf_obsv_med_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_med_hdr_t) == 12,
               "Layout changed; update NRF_EDGEAI_OBSV_MED_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_MED_NUM_ROWS 4
 
#define NRF_EDGEAI_OBSV_MED_STORAGE_BYTES(n_features)                                           \
        (sizeof(_nrf_obsv_med_hdr_t)                                                            \
         + (size_t)NRF_EDGEAI_OBSV_MED_NUM_ROWS                                                 \
           * CONFIG_NRF_EDGEAI_OBSV_MEL_ENERGY_DESC_BIN_NUM * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_med_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                       uint16_t n_features);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_MEL_ENERGY_DESC */
 
#if defined(CONFIG_NRF_EDGEAI_OBSV_METRIC_MEL_SPECTRAL_DESC)
 
typedef struct {
        uint16_t num_features;
        uint8_t bin_num;
        uint8_t _pad[1];
} _nrf_obsv_msd_hdr_t;
 
_Static_assert(sizeof(_nrf_obsv_msd_hdr_t) == 4,
               "Layout changed; update NRF_EDGEAI_OBSV_MSD_STORAGE_BYTES and storage accessors");
 
#define NRF_EDGEAI_OBSV_MSD_NUM_ROWS 8
 
#define NRF_EDGEAI_OBSV_MSD_STORAGE_BYTES(n_features)                                           \
        (sizeof(_nrf_obsv_msd_hdr_t)                                                            \
         + (size_t)NRF_EDGEAI_OBSV_MSD_NUM_ROWS                                                 \
           * CONFIG_NRF_EDGEAI_OBSV_MEL_SPECTRAL_DESC_BIN_NUM * sizeof(uint32_t))
 
void nrf_edgeai_obsv_metric_msd_create(nrf_edgeai_obsv_metric_t *metric, void *buf,
                                       uint16_t n_features);
 
#endif /* CONFIG_NRF_EDGEAI_OBSV_METRIC_MEL_SPECTRAL_DESC */
 
#ifdef __cplusplus
}
#endif
 
#endif /* NRF_EDGEAI_OBSV_METRICS_H */