ble_cgms.h

/*
 * Copyright (c) 2016 - 2025 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
#ifndef BLE_CGMS_H__
#define BLE_CGMS_H__
 
#include <stdint.h>
 
#include <bm/bluetooth/ble_common.h>
#include <bm/bluetooth/ble_gq.h>
#include <bm/bluetooth/ble_racp.h>
#include <bm/softdevice_handler/nrf_sdh_ble.h>
#include <zephyr/sys/util.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BLE_CGMS_DEF(_name)                                                                        \
        static struct ble_cgms _name;                                                              \
        NRF_SDH_BLE_OBSERVER(_name##_obs, ble_cgms_on_ble_evt, &_name, HIGH)
 
#define BLE_CGMS_CONFIG_SEC_MODE_DEFAULT                                                           \
        {                                                                                          \
                .feature_char.read = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                            \
                .status_char.read = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                             \
                .srt_char.read = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                                \
                .meas_char = {                                                                     \
                        .cccd_write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                           \
                },                                                                                 \
                .racp_char = {                                                                     \
                        .write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                                \
                        .cccd_write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                           \
                },                                                                                 \
                .socp_char = {                                                                     \
                        .write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                                \
                        .cccd_write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                           \
                },                                                                                 \
                .sst_char = {                                                                      \
                        .read = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                                 \
                        .write = BLE_GAP_CONN_SEC_MODE_ENC_NO_MITM,                                \
                },                                                                                 \
        }
 
#define BLE_CGMS_DATA_MAX_LEN_CALC(mtu_size) ((mtu_size) - ATT_OPCODE_LEN - ATT_HANDLE_LEN)
 
#define BLE_CGMS_FEAT_CALIBRATION_SUPPORTED BIT(0)
#define BLE_CGMS_FEAT_PATIENT_HIGH_LOW_ALERTS_SUPPORTED BIT(1)
#define BLE_CGMS_FEAT_HYPO_ALERTS_SUPPORTED BIT(2)
#define BLE_CGMS_FEAT_HYPER_ALERTS_SUPPORTED BIT(3)
#define BLE_CGMS_FEAT_RATE_OF_INCREASE_DECREASE_ALERTS_SUPPORTED BIT(4)
#define BLE_CGMS_FEAT_DEVICE_SPECIFIC_ALERT_SUPPORTED BIT(5)
#define BLE_CGMS_FEAT_SENSOR_MALFUNCTION_DETECTION_SUPPORTED BIT(6)
#define BLE_CGMS_FEAT_SENSOR_TEMPERATURE_HIGH_LOW_DETECTION_SUPPORTED BIT(7)
#define BLE_CGMS_FEAT_SENSOR_RESULT_HIGH_LOW_DETECTION_SUPPORTED BIT(8)
#define BLE_CGMS_FEAT_LOW_BATTERY_DETECTION_SUPPORTED BIT(9)
#define BLE_CGMS_FEAT_SENSOR_TYPE_ERROR_DETECTION_SUPPORTED BIT(10)
#define BLE_CGMS_FEAT_GENERAL_DEVICE_FAULT_SUPPORTED BIT(11)
#define BLE_CGMS_FEAT_E2E_CRC_SUPPORTED BIT(12)
#define BLE_CGMS_FEAT_MULTIPLE_BOND_SUPPORTED BIT(13)
#define BLE_CGMS_FEAT_MULTIPLE_SESSIONS_SUPPORTED BIT(14)
#define BLE_CGMS_FEAT_CGM_TREND_INFORMATION_SUPPORTED BIT(15)
#define BLE_CGMS_FEAT_CGM_QUALITY_SUPPORTED BIT(16)
#define BLE_CGMS_MEAS_TYPE_CAP_BLOOD 0x01
#define BLE_CGMS_MEAS_TYPE_CAP_PLASMA 0x02
#define BLE_CGMS_MEAS_TYPE_VEN_BLOOD 0x03
#define BLE_CGMS_MEAS_TYPE_VEN_PLASMA 0x04
#define BLE_CGMS_MEAS_TYPE_ART_BLOOD 0x05
#define BLE_CGMS_MEAS_TYPE_ART_PLASMA 0x06
#define BLE_CGMS_MEAS_TYPE_UNDET_BLOOD 0x07
#define BLE_CGMS_MEAS_TYPE_UNDET_PLASMA 0x08
#define BLE_CGMS_MEAS_TYPE_FLUID 0x09
#define BLE_CGMS_MEAS_TYPE_CONTROL 0x0A
#define BLE_CGMS_MEAS_LOC_FINGER 0x01
#define BLE_CGMS_MEAS_LOC_AST 0x02
#define BLE_CGMS_MEAS_LOC_EAR 0x03
#define BLE_CGMS_MEAS_LOC_CONTROL 0x04
#define BLE_CGMS_MEAS_LOC_SUB_TISSUE 0x05
#define BLE_CGMS_MEAS_LOC_NOT_AVAIL 0x0F
#define BLE_CGMS_STATUS_SESSION_STOPPED BIT(0)
#define BLE_CGMS_STATUS_DEVICE_BATTERY_LOW BIT(1)
#define BLE_CGMS_STATUS_SENSOR_TYPE_INCORRECT_FOR_DEVICE BIT(2)
#define BLE_CGMS_STATUS_SENSOR_MALFUNCTION BIT(3)
#define BLE_CGMS_STATUS_DEVICE_SPECIFIC_ALERT BIT(4)
#define BLE_CGMS_STATUS_GENERAL_DEVICE_FAULT BIT(5)
#define BLE_CGMS_FLAG_TREND_INFO_PRESENT BIT(0)
#define BLE_CGMS_FLAGS_QUALITY_PRESENT BIT(1)
#define BLE_CGMS_STATUS_FLAGS_WARNING_OCT_PRESENT BIT(5)
#define BLE_CGMS_STATUS_FLAGS_CALTEMP_OCT_PRESENT BIT(6)
#define BLE_CGMS_STATUS_FLAGS_STATUS_OCT_PRESENT BIT(7)
#define BLE_CGMS_CRC_LEN 2
 
#define BLE_CGMS_MEAS_LEN_MAX BLE_CGMS_DATA_MAX_LEN_CALC(CONFIG_NRF_SDH_BLE_GATT_MAX_MTU_SIZE)
 
#define BLE_CGMS_MEAS_REC_LEN_MAX 15
#define BLE_CGMS_MEAS_REC_LEN_MIN 6
 
#define BLE_CGMS_MEAS_REC_PER_NOTIF_MAX (BLE_CGMS_MEAS_LEN_MAX / BLE_CGMS_MEAS_REC_LEN_MIN)
 
#define BLE_CGMS_FEATURE_LEN 6
 
#define BLE_CGMS_STATUS_LEN 7
 
#define BLE_CGMS_SST_LEN 11
 
#define BLE_CGMS_SRT_LEN 4
 
#define BLE_CGMS_SOCP_OPERAND_MAX 17
 
#define BLE_CGMS_SOCP_LEN 20
 
#define BLE_CGMS_MAX_CALIB_LEN 10
 
#define BLE_CGMS_CALIBS_NB_MAX 5
 
#define BLE_CGMS_RACP_PENDING_OPERANDS_MAX 2
enum ble_cgms_evt_type {
        BLE_CGMS_EVT_NOTIFICATION_ENABLED,
        BLE_CGMS_EVT_NOTIFICATION_DISABLED,
        BLE_CGMS_EVT_START_SESSION,
        BLE_CGMS_EVT_STOP_SESSION,
        BLE_CGMS_EVT_WRITE_COMM_INTERVAL,
        BLE_CGMS_EVT_ERROR,
};
 
 /* ble_cgms_enums */
 
struct ble_cgms_evt {
        enum ble_cgms_evt_type evt_type;
        uint16_t conn_handle;
        union {
                struct {
                        uint32_t reason;
                } error;
        };
};
 
 /* ble_cgms_structs */
 
struct ble_cgms;
 
typedef void (*ble_cgms_evt_handler_t)(struct ble_cgms *cgms, const struct ble_cgms_evt *evt);
 
 /* ble_cgms_types */
 
struct ble_cgms_sensor_annunc {
        uint8_t warning;
        uint8_t calib_temp;
        uint8_t status;
};
 
struct ble_cgms_meas {
        uint8_t flags;
        uint16_t glucose_concentration;
        uint16_t time_offset;
        struct ble_cgms_sensor_annunc sensor_status_annunciation;
        uint16_t trend;
        uint16_t quality;
};
 
struct ble_cgms_rec {
        struct ble_cgms_meas meas;
};
 
struct ble_cgms_feature {
        uint32_t feature;
        uint8_t type;
        uint8_t sample_location;
};
 
struct ble_cgms_status {
        uint16_t time_offset;
        struct ble_cgms_sensor_annunc status;
};
 
struct ble_cgms_config {
        ble_cgms_evt_handler_t evt_handler;
        const struct ble_gq *gatt_queue;
        struct ble_cgms_feature feature;
        struct ble_cgms_status initial_sensor_status;
        uint16_t initial_run_time;
        uint8_t initial_comm_interval;
        struct {
                struct {
                        ble_gap_conn_sec_mode_t read;
                } feature_char;
                struct {
                        ble_gap_conn_sec_mode_t read;
                } status_char;
                struct {
                        ble_gap_conn_sec_mode_t read;
                } srt_char;
                struct {
                        ble_gap_conn_sec_mode_t cccd_write;
                } meas_char;
                struct {
                        ble_gap_conn_sec_mode_t write;
                        ble_gap_conn_sec_mode_t cccd_write;
                } racp_char;
                struct {
                        ble_gap_conn_sec_mode_t write;
                        ble_gap_conn_sec_mode_t cccd_write;
                } socp_char;
                struct {
                        ble_gap_conn_sec_mode_t read;
                        ble_gap_conn_sec_mode_t write;
                } sst_char;
        } sec_mode;
};
 
struct ble_socp_rsp {
        uint8_t opcode;
        uint8_t req_opcode;
        uint8_t rsp_code;
        uint8_t resp_val[BLE_CGMS_SOCP_OPERAND_MAX];
        uint8_t size_val;
};
 
struct ble_cgms_calib {
        uint8_t value[BLE_CGMS_MAX_CALIB_LEN];
};
 
struct ble_cgms_racp {
        uint8_t racp_proc_operator;
        uint16_t racp_proc_record_idx;
        uint16_t racp_proc_records_idx_last_to_send;
        uint16_t racp_proc_records_reported;
        struct ble_racp_value racp_request;
        struct ble_racp_value pending_racp_response;
        bool racp_processing_active;
        uint8_t pending_racp_response_operand[BLE_CGMS_RACP_PENDING_OPERANDS_MAX];
};
 
struct ble_cgms_char_handles {
        ble_gatts_char_handles_t measurement;
        ble_gatts_char_handles_t feature;
        ble_gatts_char_handles_t status;
        ble_gatts_char_handles_t sst;
        ble_gatts_char_handles_t srt;
        ble_gatts_char_handles_t racp;
        ble_gatts_char_handles_t socp;
};
 
struct ble_cgms {
        ble_cgms_evt_handler_t evt_handler;
        const struct ble_gq  *gatt_queue;
        ble_gq_evt_handler_t ble_gq_evt_handler;
        uint16_t service_handle;
        struct ble_cgms_char_handles char_handles;
        uint16_t conn_handle;
        struct ble_cgms_feature feature;
        uint8_t comm_interval;
        struct ble_socp_rsp socp_response;
        struct ble_cgms_calib calibration_val[BLE_CGMS_CALIBS_NB_MAX];
        bool is_session_started;
        uint8_t nb_run_session;
        uint16_t session_run_time;
        struct ble_cgms_status sensor_status;
        struct ble_cgms_racp racp_data;
};
 
uint32_t ble_cgms_init(struct ble_cgms *cgms, const struct ble_cgms_config *cgms_init);
 
void ble_cgms_on_ble_evt(const ble_evt_t *ble_evt, void *ble_cgms);
 
uint32_t ble_cgms_meas_create(struct ble_cgms *cgms, struct ble_cgms_rec *rec);
 
uint32_t ble_cgms_conn_handle_assign(struct ble_cgms *cgms, uint16_t conn_handle);
 
uint32_t ble_cgms_update_status(struct ble_cgms *cgms, struct ble_cgms_status *status);
 
uint32_t ble_cgms_srt_set(struct ble_cgms *cgms, uint16_t run_time);
 
 /* ble_cgms_functions */
 
#ifdef __cplusplus
}
#endif
 
#endif /* BLE_CGMS_H__ */