dm.h

Go to the documentation of this file.

/*
 * Copyright (c) 2021 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef DM_H_
#define DM_H_
 
#include <stdlib.h>
 
#include <zephyr/types.h>
#include <zephyr/kernel.h>
#include <zephyr/bluetooth/addr.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
enum dm_dev_role {
        DM_ROLE_NONE,
 
        DM_ROLE_INITIATOR,
 
        DM_ROLE_REFLECTOR,
};
 
enum dm_ranging_mode {
        DM_RANGING_MODE_RTT,
 
        DM_RANGING_MODE_MCPD,
};
 
enum dm_quality {
        DM_QUALITY_OK,
 
        DM_QUALITY_POOR,
 
        DM_QUALITY_DO_NOT_USE,
 
        DM_QUALITY_CRC_FAIL,
 
        DM_QUALITY_NONE,
};
 
struct dm_result {
        bool status;
 
        enum dm_quality quality;
 
        bt_addr_le_t bt_addr;
 
        enum dm_ranging_mode ranging_mode;
 
        union {
                struct mcpd {
                        float ifft;
 
                        float phase_slope;
 
                        float rssi_openspace;
 
                        float best;
 
#ifdef CONFIG_DM_HIGH_PRECISION_CALC
                        /* MCPD: Distance estimate based on advanced algorithms */
                        float high_precision;
#endif
                } mcpd;
                struct rtt {
                        float rtt;
                } rtt;
        } dist_estimates;
};
 
struct dm_cb {
        void (*data_ready)(struct dm_result *result);
};
 
struct dm_init_param {
        struct dm_cb *cb;
};
 
struct dm_request {
        enum dm_dev_role role;
 
        bt_addr_le_t bt_addr;
 
        uint32_t rng_seed;
 
        enum dm_ranging_mode ranging_mode;
 
        uint32_t start_delay_us;
 
        uint32_t extra_window_time_us;
};
 
int dm_init(struct dm_init_param *init_param);
 
int dm_request_add(struct dm_request *req);
 
#ifdef __cplusplus
}
#endif
 
#endif /* DM_H_ */