ddfs.h

Go to the documentation of this file.

/*
 * Copyright (c) 2022 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_DDFS_H_
#define BT_DDFS_H_
 
#include <stdlib.h>
#include <zephyr/types.h>
#include <zephyr/bluetooth/conn.h>
#include <zephyr/bluetooth/uuid.h>
#include <zephyr/bluetooth/gatt.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
#define BT_UUID_DDFS_VAL \
        BT_UUID_128_ENCODE(0x21490000, 0x494a, 0x4573, 0x98af, 0xf126af76f490)
 
#define BT_UUID_DDFS_DISTANCE_MEAS_VAL \
        BT_UUID_128_ENCODE(0x21490001, 0x494a, 0x4573, 0x98af, 0xf126af76f490)
 
#define BT_UUID_DDFS_AZIMUTH_MEAS_VAL \
        BT_UUID_128_ENCODE(0x21490002, 0x494a, 0x4573, 0x98af, 0xf126af76f490)
 
#define BT_UUID_DDFS_ELEVATION_MEAS_VAL \
        BT_UUID_128_ENCODE(0x21490003, 0x494a, 0x4573, 0x98af, 0xf126af76f490)
 
#define BT_UUID_DDFS_FEATURE_VAL \
        BT_UUID_128_ENCODE(0x21490004, 0x494a, 0x4573, 0x98af, 0xf126af76f490)
 
#define BT_UUID_DDFS_CTRL_POINT_VAL \
        BT_UUID_128_ENCODE(0x21490005, 0x494a, 0x4573, 0x98af, 0xf126af76f490)
 
#define BT_UUID_DDFS                 BT_UUID_DECLARE_128(BT_UUID_DDFS_VAL)
#define BT_UUID_DDFS_DISTANCE_MEAS   BT_UUID_DECLARE_128(BT_UUID_DDFS_DISTANCE_MEAS_VAL)
#define BT_UUID_DFFS_AZIMUTH_MEAS    BT_UUID_DECLARE_128(BT_UUID_DDFS_AZIMUTH_MEAS_VAL)
#define BT_UUID_DFFS_ELEVATION_MEAS  BT_UUID_DECLARE_128(BT_UUID_DDFS_ELEVATION_MEAS_VAL)
#define BT_UUID_DDFS_FEATURE         BT_UUID_DECLARE_128(BT_UUID_DDFS_FEATURE_VAL)
#define BT_UUID_DFFS_CTRL_POINT      BT_UUID_DECLARE_128(BT_UUID_DDFS_CTRL_POINT_VAL)
 
enum bt_ddfs_dm_ranging_mode {
        BT_DDFS_DM_RANGING_MODE_RTT,
 
        BT_DDFS_DM_RANGING_MODE_MCPD,
};
 
enum bt_ddfs_quality {
        BT_DDFS_QUALITY_OK,
 
        BT_DDFS_QUALITY_POOR,
 
        BT_DDFS_QUALITY_DO_NOT_USE,
 
        BT_DDFS_QUALITY_NONE,
};
struct bt_ddfs_features {
        uint8_t ranging_mode_rtt : 1;
 
        uint8_t ranging_mode_mcpd : 1;
};
 
struct bt_ddfs_dm_config {
        enum bt_ddfs_dm_ranging_mode mode;
 
        bool high_precision;
};
 
struct bt_ddfs_cb {
        int (*dm_ranging_mode_set)(uint8_t mode);
 
        int (*dm_config_read)(struct bt_ddfs_dm_config *config);
 
        void (*am_notification_config_changed)(bool enabled);
 
        void (*dm_notification_config_changed)(bool enabled);
 
        void (*em_notification_config_changed)(bool enabled);
};
 
struct bt_ddfs_distance_measurement {
        enum bt_ddfs_quality quality;
 
        bt_addr_le_t bt_addr;
 
        enum bt_ddfs_dm_ranging_mode ranging_mode;
        union {
                struct _mcpd {
                        uint16_t ifft;
 
                        uint16_t phase_slope;
 
                        uint16_t rssi_openspace;
 
                        uint16_t best;
 
#ifdef CONFIG_DM_HIGH_PRECISION_CALC
                        /* MCPD: Distance estimate based on advanced algorithms */
                        uint16_t high_precision;
#endif
                } mcpd;
                struct _rtt {
                        uint16_t rtt;
                } rtt;
        } dist_estimates;
};
 
struct bt_ddfs_azimuth_measurement {
        enum bt_ddfs_quality quality;
 
        bt_addr_le_t bt_addr;
 
        uint16_t value;
};
 
struct bt_ddfs_elevation_measurement {
        enum bt_ddfs_quality quality;
 
        bt_addr_le_t bt_addr;
 
        int8_t value;
};
 
struct bt_ddfs_init_params {
        struct bt_ddfs_features dm_features;
 
        const struct bt_ddfs_cb *cb;
};
 
int bt_ddfs_distance_measurement_notify(struct bt_conn *conn,
                                        const struct bt_ddfs_distance_measurement *measurement);
 
int bt_ddfs_azimuth_measurement_notify(struct bt_conn *conn,
                                       const struct bt_ddfs_azimuth_measurement *measurement);
 
int bt_ddfs_elevation_measurement_notify(struct bt_conn *conn,
                                        const struct bt_ddfs_elevation_measurement *measurement);
 
int bt_ddfs_init(const struct bt_ddfs_init_params *init);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_DDFS_H_ */