Bluetooth: Host: Add support for PAwR Sync

hermabe · carlescufi · commit 95bc5cf8e5e2 · 2023-04-26T20:08:16.000+02:00
Adds API for Periodic Advertising with Responses - Scanner:
 - Synchronize to a PAwR train
 - Choose which subevents to synchronize to
 - Receive advertising reports from subevents
 - Send responses

The support is enabled by CONFIG_BT_PER_ADV_SYNC_RSP, and requires
a controller that selects CONFIG_BT_CTLR_SYNC_PERIODIC_RSP_SUPPORT.

Signed-off-by: Herman Berget &lt;herman.berget@nordicsemi.no&gt;
diff --git a/include/zephyr/bluetooth/bluetooth.h b/include/zephyr/bluetooth/bluetooth.h
@@ -1392,6 +1392,20 @@ struct bt_le_per_adv_sync_synced_info {
 	 *
 	 */
 	struct bt_conn *conn;
+#if defined(CONFIG_BT_PER_ADV_SYNC_RSP)
+	/** Number of subevents */
+	uint8_t num_subevents;
+
+	/** Subevent interval (N * 1.25 ms) */
+	uint8_t subevent_interval;
+
+	/** Response slot delay (N * 1.25 ms) */
+	uint8_t response_slot_delay;
+
+	/** Response slot spacing (N * 1.25 ms) */
+	uint8_t response_slot_spacing;
+
+#endif /* CONFIG_BT_PER_ADV_SYNC_RSP */
 };
 
 struct bt_le_per_adv_sync_term_info {
@@ -1420,6 +1434,13 @@ struct bt_le_per_adv_sync_recv_info {
 
 	/** The Constant Tone Extension (CTE) of the advertisement (@ref bt_df_cte_type) */
 	uint8_t cte_type;
+#if defined(CONFIG_BT_PER_ADV_SYNC_RSP)
+	/** The value of the event counter where the subevent indication was received. */
+	uint16_t periodic_event_counter;
+
+	/** The subevent where the subevend indication was received. */
+	uint8_t subevent;
+#endif /* CONFIG_BT_PER_ADV_SYNC_RSP */
 };
 
 
@@ -1463,6 +1484,9 @@ struct bt_le_per_adv_sync_cb {
 	 * @param sync  The advertising set object.
 	 * @param info  Information about the periodic advertising event.
 	 * @param buf   Buffer containing the periodic advertising data.
+	 *              NULL if the controller failed to receive a subevent
+	 *              indication. Only happens if
+	 *              @kconfig{CONFIG_BT_PER_ADV_SYNC_RSP} is enabled.
 	 */
 	void (*recv)(struct bt_le_per_adv_sync *sync,
 		     const struct bt_le_per_adv_sync_recv_info *info,
@@ -2515,6 +2539,79 @@ void bt_foreach_bond(uint8_t id, void (*func)(const struct bt_bond_info *info,
 int bt_configure_data_path(uint8_t dir, uint8_t id, uint8_t vs_config_len,
 			   const uint8_t *vs_config);
 
+struct bt_le_per_adv_sync_subevent_params {
+	/** @brief Periodic Advertising Properties.
+	 *
+	 * Bit 6 is include TxPower, all others RFU.
+	 *
+	 */
+	uint16_t properties;
+
+	/** Number of subevents to sync to */
+	uint8_t num_subevents;
+
+	/** @brief The subevent(s) to synchronize with
+	 *
+	 * The array must have @ref num_subevents elements.
+	 *
+	 */
+	uint8_t *subevents;
+};
+
+/** @brief Synchronize with a subset of subevents
+ *
+ *  Until this command is issued, the subevent(s) the controller is synchronized
+ *  to is unspecified.
+ *
+ *  @param per_adv_sync   The periodic advertising sync object.
+ *  @param params         Parameters.
+ *
+ *  @return 0 in case of success or negative value in case of error.
+ */
+int bt_le_per_adv_sync_subevent(struct bt_le_per_adv_sync *per_adv_sync,
+				struct bt_le_per_adv_sync_subevent_params *params);
+
+struct bt_le_per_adv_response_params {
+	/** @brief The periodic event counter of the request the response is sent to.
+	 *
+	 * @ref bt_le_per_adv_sync_recv_info
+	 *
+	 * @note The response can be sent up to one periodic interval after
+	 * the request was received.
+	 *
+	 */
+	uint16_t request_event;
+
+	/** @brief The subevent counter of the request the response is sent to.
+	 *
+	 * @ref bt_le_per_adv_sync_recv_info
+	 *
+	 */
+	uint8_t request_subevent;
+
+	/** The subevent the response shall be sent in */
+	uint8_t response_subevent;
+
+	/** The response slot the response shall be sent in */
+	uint8_t response_slot;
+};
+
+/**
+ * @brief Set the data for a response slot in a specific subevent of the PAwR.
+ *
+ * This function is called by the Host to set the response dat.
+ * The data for a repsonse slot shall be transmitted only once.
+ *
+ * @param per_adv_sync The periodic advertising sync object.
+ * @param params       Parameters.
+ * @param data         The response data to send.
+ *
+ * @return Zero on success or (negative) error code otherwise.
+ */
+int bt_le_per_adv_set_response_data(struct bt_le_per_adv_sync *per_adv_sync,
+				    const struct bt_le_per_adv_response_params *params,
+				    const struct net_buf_simple *data);
+
 /**
  * @}
  */
diff --git a/include/zephyr/bluetooth/hci.h b/include/zephyr/bluetooth/hci.h
@@ -178,6 +178,7 @@ struct bt_hci_cmd_hdr {
 #define BT_LE_FEAT_BIT_CHANNEL_CLASSIFICATION   39
 
 #define BT_LE_FEAT_BIT_PAWR_ADVERTISER          43
+#define BT_LE_FEAT_BIT_PAWR_SCANNER             44
 
 #define BT_LE_FEAT_TEST(feat, n)                (feat[(n) >> 3] & \
 						 BIT((n) & 7))
@@ -244,6 +245,8 @@ struct bt_hci_cmd_hdr {
 						  BT_LE_FEAT_BIT_CHANNEL_CLASSIFICATION)
 #define BT_FEAT_LE_PAWR_ADVERTISER(feat)	  BT_LE_FEAT_TEST(feat, \
 						  BT_LE_FEAT_BIT_PAWR_ADVERTISER)
+#define BT_FEAT_LE_PAWR_SCANNER(feat)             BT_LE_FEAT_TEST(feat, \
+						  BT_LE_FEAT_BIT_PAWR_SCANNER)
 
 #define BT_FEAT_LE_CIS(feat)            (BT_FEAT_LE_CIS_CENTRAL(feat) | \
 					BT_FEAT_LE_CIS_PERIPHERAL(feat))
@@ -1511,6 +1514,27 @@ struct bt_hci_cp_le_set_pawr_subevent_data {
 	struct bt_hci_cp_le_set_pawr_subevent_data_element subevents[0];
 } __packed;
 
+
+#define BT_HCI_OP_LE_SET_PER_ADV_RESPONSE_DATA  BT_OP(BT_OGF_LE, 0x0083)
+struct bt_hci_cp_le_set_pawr_response_data {
+	uint16_t sync_handle;
+	uint16_t request_event;
+	uint8_t request_subevent;
+	uint8_t response_subevent;
+	uint8_t response_slot;
+	uint8_t response_data_length;
+	uint8_t response_data[0];
+} __packed;
+
+#define BT_HCI_OP_LE_SET_PER_ADV_SYNC_SUBEVENT  BT_OP(BT_OGF_LE, 0x0084)
+struct bt_hci_cp_le_set_pawr_sync_subevent {
+	uint16_t sync_handle;
+	uint16_t periodic_adv_properties;
+	uint8_t num_subevents;
+	uint8_t subevents[0];
+} __packed;
+
+
 #define BT_HCI_OP_LE_SET_PER_ADV_PARAM_V2       BT_OP(BT_OGF_LE, 0x0086)
 struct bt_hci_cp_le_set_per_adv_param_v2 {
 	uint8_t  handle;
@@ -2330,6 +2354,51 @@ struct bt_hci_evt_remote_ext_features {
 	uint8_t  features[8];
 } __packed;
 
+#define BT_HCI_EVT_LE_PER_ADV_SYNC_ESTABLISHED_V2 0x24
+struct bt_hci_evt_le_per_adv_sync_established_v2 {
+	uint8_t status;
+	uint16_t handle;
+	uint8_t sid;
+	bt_addr_le_t adv_addr;
+	uint8_t phy;
+	uint16_t interval;
+	uint8_t clock_accuracy;
+	uint8_t num_subevents;
+	uint8_t subevent_interval;
+	uint8_t response_slot_delay;
+	uint8_t response_slot_spacing;
+} __packed;
+
+#define BT_HCI_EVT_LE_PER_ADVERTISING_REPORT_V2 0x25
+struct bt_hci_evt_le_per_advertising_report_v2 {
+	uint16_t handle;
+	int8_t tx_power;
+	int8_t rssi;
+	uint8_t cte_type;
+	uint16_t periodic_event_counter;
+	uint8_t subevent;
+	uint8_t data_status;
+	uint8_t length;
+	uint8_t data[0];
+} __packed;
+
+#define BT_HCI_EVT_LE_PAST_RECEIVED_V2 0x26
+struct bt_hci_evt_le_past_received_v2 {
+	uint8_t status;
+	uint16_t conn_handle;
+	uint16_t service_data;
+	uint16_t sync_handle;
+	uint8_t adv_sid;
+	bt_addr_le_t addr;
+	uint8_t phy;
+	uint16_t interval;
+	uint8_t clock_accuracy;
+	uint8_t num_subevents;
+	uint8_t subevent_interval;
+	uint8_t response_slot_delay;
+	uint8_t response_slot_spacing;
+} __packed;
+
 #define BT_HCI_EVT_LE_PER_ADV_SUBEVENT_DATA_REQUEST 0x27
 struct bt_hci_evt_le_per_adv_subevent_data_request {
 	uint8_t adv_handle;
@@ -2881,6 +2950,9 @@ struct bt_hci_evt_le_biginfo_adv_report {
 #define BT_EVT_MASK_LE_TRANSMIT_POWER_REPORTING  BT_EVT_BIT(32)
 #define BT_EVT_MASK_LE_BIGINFO_ADV_REPORT        BT_EVT_BIT(33)
 
+#define BT_EVT_MASK_LE_PER_ADV_SYNC_ESTABLISHED_V2 BT_EVT_BIT(35)
+#define BT_EVT_MASK_LE_PER_ADVERTISING_REPORT_V2   BT_EVT_BIT(36)
+#define BT_EVT_MASK_LE_PAST_RECEIVED_V2            BT_EVT_BIT(37)
 #define BT_EVT_MASK_LE_PER_ADV_SUBEVENT_DATA_REQ   BT_EVT_BIT(38)
 #define BT_EVT_MASK_LE_PER_ADV_RESPONSE_REPORT     BT_EVT_BIT(39)
 
diff --git a/subsys/bluetooth/Kconfig.adv b/subsys/bluetooth/Kconfig.adv
@@ -60,6 +60,14 @@ config BT_PER_ADV_SYNC
 	  and deterministic receive data from that device in a connectionless
 	  manner.
 
+config BT_PER_ADV_SYNC_RSP
+	bool "Periodic Advertising with Responses sync support [EXPERIMENTAL]"
+	select EXPERIMENTAL
+	depends on BT_OBSERVER
+	help
+	  Select this to enable Periodic Advertising with Responses Sync
+	  API support.
+
 if BT_PER_ADV_SYNC
 
 config BT_PER_ADV_SYNC_MAX
diff --git a/subsys/bluetooth/controller/Kconfig b/subsys/bluetooth/controller/Kconfig
@@ -51,6 +51,10 @@ config BT_CTLR_SYNC_PERIODIC_SUPPORT
 	depends on BT_CTLR_ADV_EXT_SUPPORT
 	bool
 
+config BT_CTLR_SYNC_PERIODIC_RSP_SUPPORT
+	depends on BT_CTLR_SYNC_PERIODIC_SUPPORT
+	bool
+
 config BT_CTLR_SYNC_TRANSFER_SENDER_SUPPORT
 	depends on BT_CTLR_SYNC_PERIODIC_SUPPORT || BT_CTLR_ADV_PERIODIC_SUPPORT
 	bool
@@ -650,6 +654,15 @@ config BT_CTLR_SYNC_PERIODIC
 	  Enable support for Bluetooth 5.0 LE Periodic Advertising in
 	  Synchronization state in the Controller.
 
+config BT_CTLR_SYNC_PERIODIC_RSP
+	bool "LE Periodic Advertising with Responses in Synchronization State"
+	depends on BT_OBSERVER && BT_CTLR_SYNC_PERIODIC_RSP_SUPPORT
+	select BT_CTLR_CHAN_SEL_2
+	default y if BT_PER_ADV_SYNC_RSP
+	help
+	  Enable support for Bluetooth 5.4 LE Periodic Advertising with
+	  Responses in Synchronization state in the Controller.
+
 if BT_CTLR_SYNC_PERIODIC
 
 config BT_CTLR_SYNC_PERIODIC_ADV_LIST
diff --git a/subsys/bluetooth/host/hci_core.c b/subsys/bluetooth/host/hci_core.c
@@ -2325,6 +2325,15 @@ static const struct event_handler meta_events[] = {
 	EVENT_HANDLER(BT_HCI_EVT_LE_CTE_REQUEST_FAILED, bt_hci_le_df_cte_req_failed,
 		      sizeof(struct bt_hci_evt_le_cte_req_failed)),
 #endif /* CONFIG_BT_DF_CONNECTION_CTE_REQ */
+#if defined(CONFIG_BT_PER_ADV_SYNC_RSP)
+	EVENT_HANDLER(BT_HCI_EVT_LE_PER_ADVERTISING_REPORT_V2, bt_hci_le_per_adv_report_v2,
+		      sizeof(struct bt_hci_evt_le_per_advertising_report_v2)),
+	EVENT_HANDLER(BT_HCI_EVT_LE_PAST_RECEIVED_V2, bt_hci_le_past_received_v2,
+		      sizeof(struct bt_hci_evt_le_past_received_v2)),
+	EVENT_HANDLER(BT_HCI_EVT_LE_PER_ADV_SYNC_ESTABLISHED_V2,
+		      bt_hci_le_per_adv_sync_established_v2,
+		      sizeof(struct bt_hci_evt_le_per_adv_sync_established_v2)),
+#endif /* CONFIG_BT_PER_ADV_SYNC_RSP */
 #if defined(CONFIG_BT_PER_ADV_RSP)
 	EVENT_HANDLER(BT_HCI_EVT_LE_PER_ADV_SUBEVENT_DATA_REQUEST,
 		      bt_hci_le_per_adv_subevent_data_request,
@@ -2911,6 +2920,12 @@ static int le_set_event_mask(void)
 		mask |= BT_EVT_MASK_LE_PER_ADV_RESPONSE_REPORT;
 	}
 
+	if (IS_ENABLED(CONFIG_BT_PER_ADV_SYNC_RSP)) {
+		mask |= BT_EVT_MASK_LE_PER_ADVERTISING_REPORT_V2;
+		mask |= BT_EVT_MASK_LE_PER_ADV_SYNC_ESTABLISHED_V2;
+		mask |= BT_EVT_MASK_LE_PAST_RECEIVED_V2;
+	}
+
 	sys_put_le64(mask, cp_mask->events);
 	return bt_hci_cmd_send_sync(BT_HCI_OP_LE_SET_EVENT_MASK, buf, NULL);
 }
diff --git a/subsys/bluetooth/host/hci_core.h b/subsys/bluetooth/host/hci_core.h
@@ -227,6 +227,20 @@ struct bt_le_per_adv_sync {
 
 	/** Flags */
 	ATOMIC_DEFINE(flags, BT_PER_ADV_SYNC_NUM_FLAGS);
+
+#if defined(CONFIG_BT_PER_ADV_SYNC_RSP)
+	/** Number of subevents */
+	uint8_t num_subevents;
+
+	/** Subevent interval (N * 1.25ms) */
+	uint8_t subevent_interval;
+
+	/** Response slot delay (N * 1.25ms) */
+	uint8_t response_slot_delay;
+
+	/** Response slot spacing (N * 1.25ms) */
+	uint8_t response_slot_spacing;
+#endif /* CONFIG_BT_PER_ADV_SYNC_RSP */
 };
 
 struct bt_dev_le {
@@ -459,12 +473,15 @@ void bt_hci_le_adv_report(struct net_buf *buf);
 void bt_hci_le_scan_timeout(struct net_buf *buf);
 void bt_hci_le_adv_ext_report(struct net_buf *buf);
 void bt_hci_le_per_adv_sync_established(struct net_buf *buf);
+void bt_hci_le_per_adv_sync_established_v2(struct net_buf *buf);
 void bt_hci_le_per_adv_report(struct net_buf *buf);
+void bt_hci_le_per_adv_report_v2(struct net_buf *buf);
 void bt_hci_le_per_adv_sync_lost(struct net_buf *buf);
 void bt_hci_le_biginfo_adv_report(struct net_buf *buf);
 void bt_hci_le_df_connectionless_iq_report(struct net_buf *buf);
 void bt_hci_le_vs_df_connectionless_iq_report(struct net_buf *buf);
 void bt_hci_le_past_received(struct net_buf *buf);
+void bt_hci_le_past_received_v2(struct net_buf *buf);
 
 /* Adv HCI event handlers */
 void bt_hci_le_adv_set_terminated(struct net_buf *buf);
diff --git a/subsys/bluetooth/host/scan.c b/subsys/bluetooth/host/scan.c
