scan.h

Go to the documentation of this file.

/*
 * Copyright (c) 2018 Nordic Semiconductor ASA
 *
 * SPDX-License-Identifier: LicenseRef-Nordic-5-Clause
 */
 
#ifndef BT_SCAN_H_
#define BT_SCAN_H_
 
#include <zephyr/types.h>
#include <zephyr/sys/slist.h>
#include <zephyr/bluetooth/bluetooth.h>
#include <zephyr/bluetooth/uuid.h>
#include <zephyr/bluetooth/conn.h>
 
#ifdef __cplusplus
extern "C" {
#endif
 
 
#define BT_SCAN_NAME_FILTER 0x01
 
#define BT_SCAN_ADDR_FILTER 0x02
 
#define BT_SCAN_UUID_FILTER 0x04
 
#define BT_SCAN_APPEARANCE_FILTER 0x08
 
#define BT_SCAN_SHORT_NAME_FILTER 0x10
 
#define BT_SCAN_MANUFACTURER_DATA_FILTER 0x20
 
#define BT_SCAN_ALL_FILTER 0x3F
enum bt_scan_type {
        BT_SCAN_TYPE_SCAN_PASSIVE,
 
        BT_SCAN_TYPE_SCAN_ACTIVE
};
 
enum bt_scan_filter_type {
        BT_SCAN_FILTER_TYPE_NAME,
 
        BT_SCAN_FILTER_TYPE_SHORT_NAME,
 
        BT_SCAN_FILTER_TYPE_ADDR,
 
        BT_SCAN_FILTER_TYPE_UUID,
 
        BT_SCAN_FILTER_TYPE_APPEARANCE,
 
        BT_SCAN_FILTER_TYPE_MANUFACTURER_DATA,
};
 
struct bt_scan_filter_info {
        bool enabled;
 
        uint8_t cnt;
};
 
struct bt_filter_status {
        bool all_mode;
 
        struct bt_scan_filter_info name;
 
        struct bt_scan_filter_info short_name;
 
        struct bt_scan_filter_info addr;
 
        struct bt_scan_filter_info uuid;
 
        struct bt_scan_filter_info appearance;
 
        struct bt_scan_filter_info manufacturer_data;
};
 
struct bt_scan_adv_info {
        uint8_t adv_type;
 
        int8_t rssi;
};
 
struct bt_scan_short_name {
        const char *name;
 
        uint8_t min_len;
};
 
struct bt_scan_manufacturer_data {
        uint8_t *data;
 
        uint8_t data_len;
};
 
struct bt_scan_init_param {
        const struct bt_le_scan_param *scan_param;
 
#if CONFIG_BT_CENTRAL
        bool connect_if_match;
#endif /* CONFIG_BT_CENTRAL */
 
        const struct bt_le_conn_param *conn_param;
};
 
struct bt_scan_name_filter_status {
        bool match;
 
        const char *name;
 
        uint8_t len;
};
 
struct bt_scan_addr_filter_status {
        bool match;
 
        const bt_addr_le_t *addr;
};
 
struct bt_scan_uuid_filter_status {
        bool match;
 
        const struct bt_uuid *uuid[CONFIG_BT_SCAN_UUID_CNT];
 
        uint8_t count;
};
 
struct bt_scan_appearance_filter_status {
        bool match;
 
        const uint16_t *appearance;
};
 
struct bt_scan_manufacturer_data_filter_status {
        bool match;
 
        const uint8_t *data;
 
        uint8_t len;
};
 
struct bt_scan_filter_match {
        struct bt_scan_name_filter_status name;
 
        struct bt_scan_name_filter_status short_name;
 
        struct bt_scan_addr_filter_status addr;
 
        struct bt_scan_uuid_filter_status uuid;
 
        struct bt_scan_appearance_filter_status appearance;
 
        struct bt_scan_manufacturer_data_filter_status manufacturer_data;
};
 
struct bt_scan_device_info {
        const struct bt_le_scan_recv_info *recv_info;
 
        const struct bt_le_conn_param *conn_param;
 
        struct net_buf_simple *adv_data;
};
 
#if CONFIG_BT_CENTRAL
#define BT_SCAN_CB_INIT(_name,                          \
                        match_fun,                      \
                        no_match_fun,                   \
                        error_fun,                      \
                        connecting_fun)                 \
        static const struct cb_data _name ## _data = {  \
                .filter_match = match_fun,              \
                .filter_no_match = no_match_fun,        \
                .connecting_error = error_fun,          \
                .connecting = connecting_fun,           \
        };                                              \
        static struct bt_scan_cb _name = {              \
                .cb_addr = &_name ## _data,             \
        }
#else
#define BT_SCAN_CB_INIT(_name,                          \
                        match_fun,                      \
                        no_match_fun,                   \
                        error_fun,                      \
                        connecting_fun)                 \
        static const struct cb_data _name ## _data = {  \
                .filter_match = match_fun,              \
                .filter_no_match = no_match_fun,        \
        };                                              \
        static struct bt_scan_cb _name = {              \
                .cb_addr = &_name ## _data,             \
        }
#endif /* CONFIG_BT_CENTRAL */
 
struct cb_data {
        void (*filter_match)(struct bt_scan_device_info *device_info,
                             struct bt_scan_filter_match *filter_match,
                             bool connectable);
 
        void (*filter_no_match)(struct bt_scan_device_info *device_info,
                                bool connectable);
 
#if CONFIG_BT_CENTRAL
        void (*connecting_error)(struct bt_scan_device_info *device_info);
 
        void (*connecting)(struct bt_scan_device_info *device_info,
                           struct bt_conn *conn);
#endif /* CONFIG_BT_CENTRAL */
};
 
struct bt_scan_cb {
        const struct cb_data *cb_addr;
        sys_snode_t node;
};
 
void bt_scan_cb_register(struct bt_scan_cb *cb);
 
void bt_scan_init(const struct bt_scan_init_param *init);
 
int bt_scan_start(enum bt_scan_type scan_type);
 
int bt_scan_stop(void);
 
void bt_scan_update_init_conn_params(struct bt_le_conn_param *new_conn_param);
 
#if CONFIG_BT_SCAN_FILTER_ENABLE
 
int bt_scan_filter_enable(uint8_t mode, bool match_all);
 
void bt_scan_filter_disable(void);
 
int bt_scan_filter_status_get(struct bt_filter_status *status);
 
int bt_scan_filter_add(enum bt_scan_filter_type type,
                       const void *data);
 
void bt_scan_filter_remove_all(void);
 
#endif /* CONFIG_BT_SCAN_FILTER_ENABLE */
 
int bt_scan_params_set(struct bt_le_scan_param *scan_param);
 
void bt_scan_conn_attempts_filter_clear(void);
 
int bt_scan_blocklist_device_add(const bt_addr_le_t *addr);
 
void bt_scan_blocklist_clear(void);
 
void bt_scan_update_connect_if_match(bool connect_if_match);
 
#ifdef __cplusplus
}
#endif
 
#endif /* BT_SCAN_H_ */