[nrf fromtree] bluetooth: host: Report status of Channel Sounding complete events

If the HCI status of a complete event is not BT_HCI_ERR_SUCCESS,
the remaining parameters could be invalid.

In this case, the params is passed as NULL pointer to the callbacks.
- LE CS Read Remote Supported Capabilities Complete event
- LE CS Read Remote FAE Table Complete event
- LE CS Config Complete event
- LE CS Security Enable Complete event
- LE CS Procedure Enable Complete event

This change avoids forwarding the invalid fileds to the applications.

Signed-off-by: Ryan Chu <[email protected]>
(cherry picked from commit c9240cc)

Author: ryanjh

include/zephyr/bluetooth/conn.h

@@ -1847,35 +1847,50 @@ struct bt_conn_cb {
 #if defined(CONFIG_BT_CHANNEL_SOUNDING)
 	/** @brief LE CS Read Remote Supported Capabilities Complete event.
 	 *
-	 *  This callback notifies the application that the remote channel
+	 *  This callback notifies the application that a Channel Sounding
+	 *  Capabilities Exchange procedure has completed.
+	 *
+	 *  If status is BT_HCI_ERR_SUCCESS, the remote channel
 	 *  sounding capabilities have been received from the peer.
 	 *
 	 *  @param conn Connection object.
-	 *  @param remote_cs_capabilities Remote Channel Sounding Capabilities.
+	 *  @param status HCI status of complete event.
+	 *  @param remote_cs_capabilities Pointer to CS Capabilities on success or NULL otherwise.
 	 */
-	void (*le_cs_remote_capabilities_available)(struct bt_conn *conn,
-						    struct bt_conn_le_cs_capabilities *params);
+	void (*le_cs_read_remote_capabilities_complete)(struct bt_conn *conn,
+							uint8_t status,
+							struct bt_conn_le_cs_capabilities *params);
 
 	/** @brief LE CS Read Remote FAE Table Complete event.
 	 *
-	 *  This callback notifies the application that the remote mode-0
+	 *  This callback notifies the application that a Channel Sounding
+	 *  Mode-0 FAE Table Request procedure has completed.
+	 *
+	 *  If status is BT_HCI_ERR_SUCCESS, the remote mode-0
 	 *  FAE Table has been received from the peer.
 	 *
 	 *  @param conn Connection object.
-	 *  @param params FAE Table.
+	 *  @param status HCI status of complete event.
+	 *  @param params Pointer to FAE Table on success or NULL otherwise.
 	 */
-	void (*le_cs_remote_fae_table_available)(struct bt_conn *conn,
-						 struct bt_conn_le_cs_fae_table *params);
+	void (*le_cs_read_remote_fae_table_complete)(struct bt_conn *conn,
+						     uint8_t status,
+						     struct bt_conn_le_cs_fae_table *params);
 
 	/** @brief LE CS Config created.
 	 *
 	 *  This callback notifies the application that a Channel Sounding
-	 *  Configuration procedure has completed and a new CS config is created
+	 *  Configuration procedure has completed.
+	 *
+	 *  If status is BT_HCI_ERR_SUCCESS, a new CS config is created.
 	 *
 	 *  @param conn Connection object.
-	 *  @param config CS configuration.
+	 *  @param status HCI status of complete event.
+	 *  @param config Pointer to CS configuration on success or NULL otherwise.
 	 */
-	void (*le_cs_config_created)(struct bt_conn *conn, struct bt_conn_le_cs_config *config);
+	void (*le_cs_config_complete)(struct bt_conn *conn,
+				      uint8_t status,
+				      struct bt_conn_le_cs_config *config);
 
 	/** @brief LE CS Config removed.
 	 *
@@ -1901,22 +1916,29 @@ struct bt_conn_cb {
 	/** @brief LE CS Security Enabled.
 	 *
 	 *  This callback notifies the application that a Channel Sounding
-	 *  Security Enable procedure has completed
+	 *  Security Enable procedure has completed.
+	 *
+	 *  If status is BT_HCI_ERR_SUCCESS, CS Security is enabled.
 	 *
 	 *  @param conn Connection object.
+	 *  @param status HCI status of complete event.
 	 */
-	void (*le_cs_security_enabled)(struct bt_conn *conn);
+	void (*le_cs_security_enable_complete)(struct bt_conn *conn, uint8_t status);
 
 	/** @brief LE CS Procedure Enabled.
 	 *
 	 *  This callback notifies the application that a Channel Sounding
-	 *  Procedure Enable procedure has completed
+	 *  Procedure Enable procedure has completed.
+	 *
+	 *  If status is BT_HCI_ERR_SUCCESS, CS procedure is enabled.
 	 *
 	 *  @param conn Connection object.
-	 *  @param params CS Procedure Enable parameters
+	 *  @param status HCI status.
+	 *  @param params Pointer to CS Procedure Enable parameters on success or NULL otherwise.
 	 */
-	void (*le_cs_procedure_enabled)(
-		struct bt_conn *conn, struct bt_conn_le_cs_procedure_enable_complete *params);
+	void (*le_cs_procedure_enable_complete)(
+		struct bt_conn *conn, uint8_t status,
+		struct bt_conn_le_cs_procedure_enable_complete *params);
 
 #endif
 

subsys/bluetooth/host/conn.c

@@ -3340,53 +3340,56 @@ int bt_conn_le_subrate_request(struct bt_conn *conn,
 #endif /* CONFIG_BT_SUBRATING */
 
 #if defined(CONFIG_BT_CHANNEL_SOUNDING)
-void notify_remote_cs_capabilities(struct bt_conn *conn, struct bt_conn_le_cs_capabilities params)
+void notify_remote_cs_capabilities(struct bt_conn *conn, uint8_t status,
+				   struct bt_conn_le_cs_capabilities *params)
 {
 	struct bt_conn_cb *callback;
 
 	SYS_SLIST_FOR_EACH_CONTAINER(&conn_cbs, callback, _node) {
-		if (callback->le_cs_remote_capabilities_available) {
-			callback->le_cs_remote_capabilities_available(conn, &params);
+		if (callback->le_cs_read_remote_capabilities_complete) {
+			callback->le_cs_read_remote_capabilities_complete(conn, status, params);
 		}
 	}
 
 	STRUCT_SECTION_FOREACH(bt_conn_cb, cb) {
-		if (cb->le_cs_remote_capabilities_available) {
-			cb->le_cs_remote_capabilities_available(conn, &params);
+		if (cb->le_cs_read_remote_capabilities_complete) {
+			cb->le_cs_read_remote_capabilities_complete(conn, status, params);
 		}
 	}
 }
 
-void notify_remote_cs_fae_table(struct bt_conn *conn, struct bt_conn_le_cs_fae_table params)
+void notify_remote_cs_fae_table(struct bt_conn *conn, uint8_t status,
+				struct bt_conn_le_cs_fae_table *params)
 {
 	struct bt_conn_cb *callback;
 
 	SYS_SLIST_FOR_EACH_CONTAINER(&conn_cbs, callback, _node) {
-		if (callback->le_cs_remote_fae_table_available) {
-			callback->le_cs_remote_fae_table_available(conn, &params);
+		if (callback->le_cs_read_remote_fae_table_complete) {
+			callback->le_cs_read_remote_fae_table_complete(conn, status, params);
 		}
 	}
 
 	STRUCT_SECTION_FOREACH(bt_conn_cb, cb) {
-		if (cb->le_cs_remote_fae_table_available) {
-			cb->le_cs_remote_fae_table_available(conn, &params);
+		if (cb->le_cs_read_remote_fae_table_complete) {
+			cb->le_cs_read_remote_fae_table_complete(conn, status, params);
 		}
 	}
 }
 
-void notify_cs_config_created(struct bt_conn *conn, struct bt_conn_le_cs_config *params)
+void notify_cs_config_created(struct bt_conn *conn, uint8_t status,
+			      struct bt_conn_le_cs_config *params)
 {
 	struct bt_conn_cb *callback;
 
 	SYS_SLIST_FOR_EACH_CONTAINER(&conn_cbs, callback, _node) {
-		if (callback->le_cs_config_created) {
-			callback->le_cs_config_created(conn, params);
+		if (callback->le_cs_config_complete) {
+			callback->le_cs_config_complete(conn, status, params);
 		}
 	}
 
 	STRUCT_SECTION_FOREACH(bt_conn_cb, cb) {
-		if (cb->le_cs_config_created) {
-			cb->le_cs_config_created(conn, params);
+		if (cb->le_cs_config_complete) {
+			cb->le_cs_config_complete(conn, status, params);
 		}
 	}
 }
@@ -3408,37 +3411,37 @@ void notify_cs_config_removed(struct bt_conn *conn, uint8_t config_id)
 	}
 }
 
-void notify_cs_security_enable_available(struct bt_conn *conn)
+void notify_cs_security_enable_available(struct bt_conn *conn, uint8_t status)
 {
 	struct bt_conn_cb *callback;
 
 	SYS_SLIST_FOR_EACH_CONTAINER(&conn_cbs, callback, _node) {
-		if (callback->le_cs_security_enabled) {
-			callback->le_cs_security_enabled(conn);
+		if (callback->le_cs_security_enable_complete) {
+			callback->le_cs_security_enable_complete(conn, status);
 		}
 	}
 
 	STRUCT_SECTION_FOREACH(bt_conn_cb, cb) {
-		if (cb->le_cs_security_enabled) {
-			cb->le_cs_security_enabled(conn);
+		if (cb->le_cs_security_enable_complete) {
+			cb->le_cs_security_enable_complete(conn, status);
 		}
 	}
 }
 
-void notify_cs_procedure_enable_available(struct bt_conn *conn,
+void notify_cs_procedure_enable_available(struct bt_conn *conn, uint8_t status,
 					  struct bt_conn_le_cs_procedure_enable_complete *params)
 {
 	struct bt_conn_cb *callback;
 
 	SYS_SLIST_FOR_EACH_CONTAINER(&conn_cbs, callback, _node) {
-		if (callback->le_cs_procedure_enabled) {
-			callback->le_cs_procedure_enabled(conn, params);
+		if (callback->le_cs_procedure_enable_complete) {
+			callback->le_cs_procedure_enable_complete(conn, status, params);
 		}
 	}
 
 	STRUCT_SECTION_FOREACH(bt_conn_cb, cb) {
-		if (cb->le_cs_procedure_enabled) {
-			cb->le_cs_procedure_enabled(conn, params);
+		if (cb->le_cs_procedure_enable_complete) {
+			cb->le_cs_procedure_enable_complete(conn, status, params);
 		}
 	}
 }

subsys/bluetooth/host/conn_internal.h

@@ -498,20 +498,25 @@ void notify_subrate_change(struct bt_conn *conn,
 			   struct bt_conn_le_subrate_changed params);
 
 void notify_remote_cs_capabilities(struct bt_conn *conn,
-			   struct bt_conn_le_cs_capabilities params);
+				   uint8_t status,
+				   struct bt_conn_le_cs_capabilities *params);
 
 void notify_remote_cs_fae_table(struct bt_conn *conn,
-			   struct bt_conn_le_cs_fae_table params);
+				uint8_t status,
+				struct bt_conn_le_cs_fae_table *params);
 
-void notify_cs_config_created(struct bt_conn *conn, struct bt_conn_le_cs_config *params);
+void notify_cs_config_created(struct bt_conn *conn,
+			      uint8_t status,
+			      struct bt_conn_le_cs_config *params);
 
 void notify_cs_config_removed(struct bt_conn *conn, uint8_t config_id);
 
 void notify_cs_subevent_result(struct bt_conn *conn, struct bt_conn_le_cs_subevent_result *result);
 
-void notify_cs_security_enable_available(struct bt_conn *conn);
+void notify_cs_security_enable_available(struct bt_conn *conn, uint8_t status);
 
 void notify_cs_procedure_enable_available(struct bt_conn *conn,
+					  uint8_t status,
 					  struct bt_conn_le_cs_procedure_enable_complete *params);
 
 #if defined(CONFIG_BT_SMP)