nimble/controller/include/controller/ble_ll_scan.h - mynewt-nimble - Git at Google

 /*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements.  See the NOTICE file
  * distributed with this work for additional information
  * regarding copyright ownership.  The ASF licenses this file
  * to you under the Apache License, Version 2.0 (the
  * "License"); you may not use this file except in compliance
  * with the License.  You may obtain a copy of the License at
  *
  *  http://www.apache.org/licenses/LICENSE-2.0
  *
  * Unless required by applicable law or agreed to in writing,
  * software distributed under the License is distributed on an
  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
  */

 #ifndef H_BLE_LL_SCAN_
 #define H_BLE_LL_SCAN_

 #include "controller/ble_ll_sched.h"
 #include "hal/hal_timer.h"
 #include "syscfg/syscfg.h"
 #include "nimble/nimble_npl.h"

 #ifdef __cplusplus
 extern "C" {
 #endif

 /*
  * SCAN_REQ
  *      -> ScanA    (6 bytes)
  *      -> AdvA     (6 bytes)
  *
  *  ScanA is the scanners public (TxAdd=0) or random (TxAdd = 1) address
  *  AdvaA is the advertisers public (RxAdd=0) or random (RxAdd=1) address.
  *
  * Sent by the LL in the Scanning state; received by the LL in the advertising
  * state. The advertising address is the intended recipient of this frame.
  */
 #define BLE_SCAN_REQ_LEN                (12)

 /*
  * SCAN_RSP
  *      -> AdvA         (6 bytes)
  *      -> ScanRspData  (0 - 31 bytes)
  *
  *  AdvaA is the advertisers public (TxAdd=0) or random (TxAdd=1) address.
  *  ScanRspData may contain any data from the advertisers host.
  *
  * Sent by the LL in the advertising state; received by the LL in the
  * scanning state.
  */
 #define BLE_SCAN_RSP_LEGACY_DATA_MAX_LEN       (31)
 #define BLE_SCAN_LEGACY_MAX_PKT_LEN            (37)

 #if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
 #define BLE_SCAN_RSP_DATA_MAX_LEN       MYNEWT_VAL(BLE_EXT_ADV_MAX_SIZE)

 /* For Bluetooth 5.0 we need state machine for two PHYs*/
 #define BLE_LL_SCAN_PHY_NUMBER          (2)
 #else
 #define BLE_LL_SCAN_PHY_NUMBER          (1)
 #define BLE_SCAN_RSP_DATA_MAX_LEN       BLE_SCAN_RSP_LEGACY_DATA_MAX_LEN
 #endif

 #define PHY_UNCODED                    (0)
 #define PHY_CODED                      (1)
 #define PHY_NOT_CONFIGURED             (0xFF)

 #define BLE_LL_EXT_ADV_MODE_NON_CONN    (0x00)
 #define BLE_LL_EXT_ADV_MODE_CONN        (0x01)
 #define BLE_LL_EXT_ADV_MODE_SCAN        (0x02)

 struct ble_ll_scan_params
 {
     uint8_t phy;
     uint8_t own_addr_type;
     uint8_t scan_filt_policy;
     uint8_t configured;
     uint8_t scan_type;
     uint8_t scan_chan;
     uint16_t scan_itvl;
     uint16_t scan_window;
     uint32_t scan_win_start_time;
     uint32_t next_event_start;
 };

 #define BLE_LL_AUX_CHAIN_BIT            0x01
 #define BLE_LL_AUX_INCOMPLETE_BIT       0x02
 #define BLE_LL_AUX_INCOMPLETE_ERR_BIT   0x04
 #define BLE_LL_AUX_HAS_ADDRA            0x08
 #define BLE_LL_AUX_IGNORE_BIT           0x10
 #define BLE_LL_AUX_HAS_DIR_ADDRA        0x20
 #define BLE_LL_AUX_TRUNCATED_SENT       0x40
 #define BLE_LL_AUX_HAS_ADI              0x80

 #define BLE_LL_AUX_SET_FLAG(aux_data, flag) ((aux_data)->flags |= (flag))
 #define BLE_LL_AUX_CLEAR_FLAG(aux_data, flag) ((aux_data)->flags &= ~(flag))
 #define BLE_LL_AUX_CHECK_FLAG(aux_data, flag) ((aux_data)->flags & (flag))

 struct ble_ll_aux_data {
     uint8_t ref_cnt;
     uint8_t chan;
     uint8_t aux_phy;
     uint8_t aux_primary_phy;
     uint8_t mode;
     uint8_t scanning;
     uint8_t flags;
     uint16_t adi;
     uint32_t offset;
     uint8_t offset_units;
     uint8_t addr[6];
     uint8_t addr_type;
     uint8_t dir_addr[6];
     uint8_t dir_addr_type;
     uint8_t evt_type;
     struct ble_ll_sched_item sch;
     struct ble_ll_ext_adv_report *evt;
 };

 struct ble_ll_scan_sm
 {
     uint8_t scan_enabled;
     uint8_t own_addr_type;
     uint8_t scan_filt_dups;
     uint8_t scan_rsp_pending;
     uint8_t scan_rsp_cons_fails;
     uint8_t scan_rsp_cons_ok;
     int8_t scan_rpa_index;
     uint8_t scan_peer_rpa[BLE_DEV_ADDR_LEN];
 #if (MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_PRIVACY) == 1)
     ble_npl_time_t scan_nrpa_timer;
     uint8_t scan_nrpa[BLE_DEV_ADDR_LEN];
 #endif

     /* XXX: Shall we count backoff per phy? */
     uint16_t upper_limit;
     uint16_t backoff_count;
     uint32_t scan_win_start_time;
     struct os_mbuf *scan_req_pdu;
     struct ble_npl_event scan_sched_ev;
     struct hal_timer scan_timer;

 #if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
     struct hal_timer duration_timer;
     struct hal_timer period_timer;
     uint32_t duration_ticks;
     uint32_t period_ticks;
     uint8_t ext_scanning;
 #endif

     uint8_t cur_phy;
     uint8_t next_phy;
     uint8_t restart_timer_needed;
     struct ble_ll_aux_data *cur_aux_data;
     struct ble_ll_scan_params phy_data[BLE_LL_SCAN_PHY_NUMBER];
 };

 /* Scan types */
 #define BLE_SCAN_TYPE_PASSIVE   (BLE_HCI_SCAN_TYPE_PASSIVE)
 #define BLE_SCAN_TYPE_ACTIVE    (BLE_HCI_SCAN_TYPE_ACTIVE)
 #define BLE_SCAN_TYPE_INITIATE  (2)

 /*---- HCI ----*/
 /* Set scanning parameters */
 int ble_ll_scan_set_scan_params(uint8_t *cmd);

 /* Turn scanning on/off */
 int ble_ll_scan_set_enable(uint8_t *cmd, uint8_t ext);

 #if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
 int ble_ll_set_ext_scan_params(uint8_t *cmd, uint8_t cmdlen);
 #endif

 /*--- Controller Internal API ---*/
 /* Initialize the scanner */
 void ble_ll_scan_init(void);

 /* Reset the scanner */
 void ble_ll_scan_reset(void);

 /* Called when Link Layer starts to receive a PDU and is in scanning state */
 int ble_ll_scan_rx_isr_start(uint8_t pdu_type, uint16_t *rxflags);

 /* Called when Link Layer has finished receiving a PDU while scanning */
 int ble_ll_scan_rx_isr_end(struct os_mbuf *rxpdu, uint8_t crcok);

 /* Process a scan response PDU */
 void ble_ll_scan_rx_pkt_in(uint8_t pdu_type, struct os_mbuf *om,
                            struct ble_mbuf_hdr *hdr);

 /* Boolean function denoting whether or not the whitelist can be changed */
 int ble_ll_scan_can_chg_whitelist(void);

 /* Boolean function returning true if scanning enabled */
 int ble_ll_scan_enabled(void);

 /* Boolean function returns true if whitelist is enabled for scanning */
 int ble_ll_scan_whitelist_enabled(void);

 /* Initialize the scanner when we start initiating */
 struct hci_create_conn;
 int ble_ll_scan_initiator_start(struct hci_create_conn *hcc,
                                 struct ble_ll_scan_sm **sm);

 /* Returns the PDU allocated by the scanner */
 struct os_mbuf *ble_ll_scan_get_pdu(void);

 /* Called to set the resolvable private address of the last connected peer */
 void ble_ll_scan_set_peer_rpa(uint8_t *rpa);

 /* Returns peer RPA of last connection made */
 uint8_t *ble_ll_scan_get_peer_rpa(void);

 /* Returns the local RPA used by the scanner/initiator */
 uint8_t *ble_ll_scan_get_local_rpa(void);

 /* Stop the scanning state machine */
 void ble_ll_scan_sm_stop(int chk_disable);

 /* Resume scanning */
 void ble_ll_scan_chk_resume(void);

 /* Called when wait for response timer expires in scanning mode */
 void ble_ll_scan_wfr_timer_exp(void);

 int ble_ll_scan_adv_decode_addr(uint8_t pdu_type, uint8_t *rxbuf,
                                 struct ble_mbuf_hdr *ble_hdr,
                                 uint8_t **addr, uint8_t *addr_type,
                                 uint8_t **inita, uint8_t *init_addr_type,
                                 int *ext_mode);

 #if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
 /* Get aux ptr from ext advertising */
 int ble_ll_scan_get_aux_data(struct ble_mbuf_hdr *ble_hdr, uint8_t *rxbuf);

 /* Initialize the extended scanner when we start initiating */
 struct hci_ext_create_conn;
 int ble_ll_scan_ext_initiator_start(struct hci_ext_create_conn *hcc,
                                     struct ble_ll_scan_sm **sm);

 /* Called to parse extended advertising*/
 struct ble_ll_ext_adv_report;
 int ble_ll_scan_parse_ext_hdr(struct os_mbuf *om,
                               uint8_t *adva, uint8_t adva_type,
                               uint8_t *inita, uint8_t inita_type,
                               struct ble_mbuf_hdr *ble_hdr,
                               struct ble_ll_ext_adv_report *parsed_evt);

 void ble_ll_scan_aux_data_ref(struct ble_ll_aux_data *aux_scan);
 int ble_ll_scan_aux_data_unref(struct ble_ll_aux_data *aux_scan);
 #endif

 /* Called to clean up current aux data */
 void ble_ll_scan_clean_cur_aux_data(void);
 void ble_ll_scan_end_adv_evt(struct ble_ll_aux_data *aux_data);

 #ifdef __cplusplus
 }
 #endif

 #endif /* H_BLE_LL_SCAN_ */
	/*
	* Licensed to the Apache Software Foundation (ASF) under one
	* or more contributor license agreements. See the NOTICE file
	* distributed with this work for additional information
	* regarding copyright ownership. The ASF licenses this file
	* to you under the Apache License, Version 2.0 (the
	* "License"); you may not use this file except in compliance
	* with the License. You may obtain a copy of the License at
	*
	* http://www.apache.org/licenses/LICENSE-2.0
	*
	* Unless required by applicable law or agreed to in writing,
	* software distributed under the License is distributed on an
	* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
	* KIND, either express or implied. See the License for the
	* specific language governing permissions and limitations
	* under the License.
	*/

	#ifndef H_BLE_LL_SCAN_
	#define H_BLE_LL_SCAN_

	#include "controller/ble_ll_sched.h"
	#include "hal/hal_timer.h"
	#include "syscfg/syscfg.h"
	#include "nimble/nimble_npl.h"

	#ifdef __cplusplus
	extern "C" {
	#endif

	/*
	* SCAN_REQ
	* -> ScanA (6 bytes)
	* -> AdvA (6 bytes)
	*
	* ScanA is the scanners public (TxAdd=0) or random (TxAdd = 1) address
	* AdvaA is the advertisers public (RxAdd=0) or random (RxAdd=1) address.
	*
	* Sent by the LL in the Scanning state; received by the LL in the advertising
	* state. The advertising address is the intended recipient of this frame.
	*/
	#define BLE_SCAN_REQ_LEN (12)

	/*
	* SCAN_RSP
	* -> AdvA (6 bytes)
	* -> ScanRspData (0 - 31 bytes)
	*
	* AdvaA is the advertisers public (TxAdd=0) or random (TxAdd=1) address.
	* ScanRspData may contain any data from the advertisers host.
	*
	* Sent by the LL in the advertising state; received by the LL in the
	* scanning state.
	*/
	#define BLE_SCAN_RSP_LEGACY_DATA_MAX_LEN (31)
	#define BLE_SCAN_LEGACY_MAX_PKT_LEN (37)

	#if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
	#define BLE_SCAN_RSP_DATA_MAX_LEN MYNEWT_VAL(BLE_EXT_ADV_MAX_SIZE)

	/* For Bluetooth 5.0 we need state machine for two PHYs*/
	#define BLE_LL_SCAN_PHY_NUMBER (2)
	#else
	#define BLE_LL_SCAN_PHY_NUMBER (1)
	#define BLE_SCAN_RSP_DATA_MAX_LEN BLE_SCAN_RSP_LEGACY_DATA_MAX_LEN
	#endif

	#define PHY_UNCODED (0)
	#define PHY_CODED (1)
	#define PHY_NOT_CONFIGURED (0xFF)

	#define BLE_LL_EXT_ADV_MODE_NON_CONN (0x00)
	#define BLE_LL_EXT_ADV_MODE_CONN (0x01)
	#define BLE_LL_EXT_ADV_MODE_SCAN (0x02)

	struct ble_ll_scan_params
	{
	uint8_t phy;
	uint8_t own_addr_type;
	uint8_t scan_filt_policy;
	uint8_t configured;
	uint8_t scan_type;
	uint8_t scan_chan;
	uint16_t scan_itvl;
	uint16_t scan_window;
	uint32_t scan_win_start_time;
	uint32_t next_event_start;
	};

	#define BLE_LL_AUX_CHAIN_BIT 0x01
	#define BLE_LL_AUX_INCOMPLETE_BIT 0x02
	#define BLE_LL_AUX_INCOMPLETE_ERR_BIT 0x04
	#define BLE_LL_AUX_HAS_ADDRA 0x08
	#define BLE_LL_AUX_IGNORE_BIT 0x10
	#define BLE_LL_AUX_HAS_DIR_ADDRA 0x20
	#define BLE_LL_AUX_TRUNCATED_SENT 0x40
	#define BLE_LL_AUX_HAS_ADI 0x80

	#define BLE_LL_AUX_SET_FLAG(aux_data, flag) ((aux_data)->flags \|= (flag))
	#define BLE_LL_AUX_CLEAR_FLAG(aux_data, flag) ((aux_data)->flags &= ~(flag))
	#define BLE_LL_AUX_CHECK_FLAG(aux_data, flag) ((aux_data)->flags & (flag))

	struct ble_ll_aux_data {
	uint8_t ref_cnt;
	uint8_t chan;
	uint8_t aux_phy;
	uint8_t aux_primary_phy;
	uint8_t mode;
	uint8_t scanning;
	uint8_t flags;
	uint16_t adi;
	uint32_t offset;
	uint8_t offset_units;
	uint8_t addr[6];
	uint8_t addr_type;
	uint8_t dir_addr[6];
	uint8_t dir_addr_type;
	uint8_t evt_type;
	struct ble_ll_sched_item sch;
	struct ble_ll_ext_adv_report *evt;
	};

	struct ble_ll_scan_sm
	{
	uint8_t scan_enabled;
	uint8_t own_addr_type;
	uint8_t scan_filt_dups;
	uint8_t scan_rsp_pending;
	uint8_t scan_rsp_cons_fails;
	uint8_t scan_rsp_cons_ok;
	int8_t scan_rpa_index;
	uint8_t scan_peer_rpa[BLE_DEV_ADDR_LEN];
	#if (MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_PRIVACY) == 1)
	ble_npl_time_t scan_nrpa_timer;
	uint8_t scan_nrpa[BLE_DEV_ADDR_LEN];
	#endif

	/* XXX: Shall we count backoff per phy? */
	uint16_t upper_limit;
	uint16_t backoff_count;
	uint32_t scan_win_start_time;
	struct os_mbuf *scan_req_pdu;
	struct ble_npl_event scan_sched_ev;
	struct hal_timer scan_timer;

	#if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
	struct hal_timer duration_timer;
	struct hal_timer period_timer;
	uint32_t duration_ticks;
	uint32_t period_ticks;
	uint8_t ext_scanning;
	#endif

	uint8_t cur_phy;
	uint8_t next_phy;
	uint8_t restart_timer_needed;
	struct ble_ll_aux_data *cur_aux_data;
	struct ble_ll_scan_params phy_data[BLE_LL_SCAN_PHY_NUMBER];
	};

	/* Scan types */
	#define BLE_SCAN_TYPE_PASSIVE (BLE_HCI_SCAN_TYPE_PASSIVE)
	#define BLE_SCAN_TYPE_ACTIVE (BLE_HCI_SCAN_TYPE_ACTIVE)
	#define BLE_SCAN_TYPE_INITIATE (2)

	/---- HCI ----/
	/* Set scanning parameters */
	int ble_ll_scan_set_scan_params(uint8_t *cmd);

	/* Turn scanning on/off */
	int ble_ll_scan_set_enable(uint8_t *cmd, uint8_t ext);

	#if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
	int ble_ll_set_ext_scan_params(uint8_t *cmd, uint8_t cmdlen);
	#endif

	/--- Controller Internal API ---/
	/* Initialize the scanner */
	void ble_ll_scan_init(void);

	/* Reset the scanner */
	void ble_ll_scan_reset(void);

	/* Called when Link Layer starts to receive a PDU and is in scanning state */
	int ble_ll_scan_rx_isr_start(uint8_t pdu_type, uint16_t *rxflags);

	/* Called when Link Layer has finished receiving a PDU while scanning */
	int ble_ll_scan_rx_isr_end(struct os_mbuf *rxpdu, uint8_t crcok);

	/* Process a scan response PDU */
	void ble_ll_scan_rx_pkt_in(uint8_t pdu_type, struct os_mbuf *om,
	struct ble_mbuf_hdr *hdr);

	/* Boolean function denoting whether or not the whitelist can be changed */
	int ble_ll_scan_can_chg_whitelist(void);

	/* Boolean function returning true if scanning enabled */
	int ble_ll_scan_enabled(void);

	/* Boolean function returns true if whitelist is enabled for scanning */
	int ble_ll_scan_whitelist_enabled(void);

	/* Initialize the scanner when we start initiating */
	struct hci_create_conn;
	int ble_ll_scan_initiator_start(struct hci_create_conn *hcc,
	struct ble_ll_scan_sm **sm);

	/* Returns the PDU allocated by the scanner */
	struct os_mbuf *ble_ll_scan_get_pdu(void);

	/* Called to set the resolvable private address of the last connected peer */
	void ble_ll_scan_set_peer_rpa(uint8_t *rpa);

	/* Returns peer RPA of last connection made */
	uint8_t *ble_ll_scan_get_peer_rpa(void);

	/* Returns the local RPA used by the scanner/initiator */
	uint8_t *ble_ll_scan_get_local_rpa(void);

	/* Stop the scanning state machine */
	void ble_ll_scan_sm_stop(int chk_disable);

	/* Resume scanning */
	void ble_ll_scan_chk_resume(void);

	/* Called when wait for response timer expires in scanning mode */
	void ble_ll_scan_wfr_timer_exp(void);

	int ble_ll_scan_adv_decode_addr(uint8_t pdu_type, uint8_t *rxbuf,
	struct ble_mbuf_hdr *ble_hdr,
	uint8_t *addr, uint8_t addr_type,
	uint8_t *inita, uint8_t init_addr_type,
	int *ext_mode);

	#if MYNEWT_VAL(BLE_LL_CFG_FEAT_LL_EXT_ADV)
	/* Get aux ptr from ext advertising */
	int ble_ll_scan_get_aux_data(struct ble_mbuf_hdr ble_hdr, uint8_t rxbuf);

	/* Initialize the extended scanner when we start initiating */
	struct hci_ext_create_conn;
	int ble_ll_scan_ext_initiator_start(struct hci_ext_create_conn *hcc,
	struct ble_ll_scan_sm **sm);

	/* Called to parse extended advertising*/
	struct ble_ll_ext_adv_report;
	int ble_ll_scan_parse_ext_hdr(struct os_mbuf *om,
	uint8_t *adva, uint8_t adva_type,
	uint8_t *inita, uint8_t inita_type,
	struct ble_mbuf_hdr *ble_hdr,
	struct ble_ll_ext_adv_report *parsed_evt);

	void ble_ll_scan_aux_data_ref(struct ble_ll_aux_data *aux_scan);
	int ble_ll_scan_aux_data_unref(struct ble_ll_aux_data *aux_scan);
	#endif

	/* Called to clean up current aux data */
	void ble_ll_scan_clean_cur_aux_data(void);
	void ble_ll_scan_end_adv_evt(struct ble_ll_aux_data *aux_data);

	#ifdef __cplusplus
	}
	#endif

	#endif /* H_BLE_LL_SCAN_ */