Bluetooth: CCP: Client: Add support for get provider name

Add support for getting the remote bearer provider
name.

Signed-off-by: Emil Gydesen <[email protected]>

Author: Thalley

doc/connectivity/bluetooth/shell/audio/ccp.rst

@@ -93,3 +93,10 @@ Example Usage when connected
 
    uart:~$ ccp_call_control_client discover
    Discovery completed with GTBS and 1 TBS bearers
+
+.. code-block:: console
+
+   uart:~$ ccp_call_control_client read_bearer_name
+   Bearer 0x20046254 name: Generic TBS
+   uart:~$ ccp_call_control_client read_bearer_name 1
+   Bearer 0x20046256 name: Telephone Bearer #1

include/zephyr/bluetooth/audio/ccp.h

@@ -182,6 +182,21 @@ struct bt_ccp_call_control_client_cb {
 	void (*discover)(struct bt_ccp_call_control_client *client, int err,
 			 struct bt_ccp_call_control_client_bearers *bearers);
 
+#if defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME)
+	/**
+	 * @brief Callback function for bt_ccp_call_control_client_read_bearer_provider_name().
+	 *
+	 * This callback is called once the read bearer provider name procedure is completed.
+	 *
+	 * @param client Call Control Client instance pointer.
+	 * @param err    Error value. 0 on success, GATT error on positive
+	 *               value or errno on negative value.
+	 * @param name   The bearer provider name. NULL if @p err is not 0.
+	 */
+	void (*bearer_provider_name)(struct bt_ccp_call_control_client_bearer *bearer, int err,
+				     const char *name);
+#endif /* CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME */
+
 	/** @cond INTERNAL_HIDDEN */
 	/** Internally used field for list handling */
 	sys_snode_t _node;
@@ -243,6 +258,23 @@ int bt_ccp_call_control_client_unregister_cb(struct bt_ccp_call_control_client_c
 int bt_ccp_call_control_client_get_bearers(struct bt_ccp_call_control_client *client,
 					   struct bt_ccp_call_control_client_bearers *bearers);
 
+/**
+ * @brief Read the bearer provider name of a remote TBS bearer.
+ *
+ * @kconfig_dep{CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME}
+ *
+ * @param bearer The bearer to read the name from
+ *
+ * @retval 0 Success
+ * @retval -EINVAL @p bearer is NULL
+ * @retval -EFAULT @p bearer has not been discovered
+ * @retval -EEXIST A @ref bt_ccp_call_control_client could not be identified for @p bearer
+ * @retval -EBUSY The @ref bt_ccp_call_control_client identified by @p bearer is busy, or the TBS
+ * instance of @p bearer is busy.
+ * @retval -ENOTCONN The @ref bt_ccp_call_control_client identified by @p bearer is not connected
+ */
+int bt_ccp_call_control_client_read_bearer_provider_name(
+	struct bt_ccp_call_control_client_bearer *bearer);
 /** @} */ /* End of group bt_ccp_call_control_client */
 #ifdef __cplusplus
 }

samples/bluetooth/ccp_call_control_client/prj.conf

@@ -16,6 +16,7 @@ CONFIG_BT_CCP_CALL_CONTROL_CLIENT_BEARER_COUNT=2
 CONFIG_BT_TBS_CLIENT_GTBS=y
 CONFIG_BT_TBS_CLIENT_TBS=y
 CONFIG_BT_TBS_CLIENT_MAX_TBS_INSTANCES=1
+CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME=y
 CONFIG_UTF8=y
 
 # TBS Client may require up to 12 buffers

samples/bluetooth/ccp_call_control_client/src/main.c

@@ -207,6 +207,21 @@ static void ccp_call_control_client_discover_cb(struct bt_ccp_call_control_clien
 	k_sem_give(&sem_ccp_action_completed);
 }
 
+#if defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME)
+static void ccp_call_control_client_read_bearer_provider_name_cb(
+	struct bt_ccp_call_control_client_bearer *bearer, int err, const char *name)
+{
+	if (err != 0) {
+		LOG_ERR("Failed to read bearer %p provider name: %d\n", (void *)bearer, err);
+		return;
+	}
+
+	LOG_INF("Bearer %p provider name: %s", (void *)bearer, name);
+
+	k_sem_give(&sem_ccp_action_completed);
+}
+#endif /* CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME */
+
 static int reset_ccp_call_control_client(void)
 {
 	int err;
@@ -259,13 +274,59 @@ static int discover_services(void)
 	return 0;
 }
 
+static int read_bearer_name(struct bt_ccp_call_control_client_bearer *bearer)
+{
+	int err;
+
+	err = bt_ccp_call_control_client_read_bearer_provider_name(bearer);
+	if (err != 0) {
+		return err;
+	}
+
+	err = k_sem_take(&sem_ccp_action_completed, SEM_TIMEOUT);
+	if (err != 0) {
+		LOG_ERR("Failed to take sem_ccp_action_completed: %d", err);
+		return err;
+	}
+
+	return 0;
+}
+
+static int read_bearer_names(void)
+{
+	int err;
+
+#if defined(CONFIG_BT_TBS_CLIENT_GTBS)
+	err = read_bearer_name(client_bearers.gtbs_bearer);
+	if (err != 0) {
+		LOG_ERR("Failed to read name for GTBS bearer: %d", err);
+		return err;
+	}
+#endif /* CONFIG_BT_TBS_CLIENT_GTBS */
+
+#if defined(CONFIG_BT_TBS_CLIENT_TBS)
+	for (size_t i = 0; i < client_bearers.tbs_count; i++) {
+		err = read_bearer_name(client_bearers.tbs_bearers[i]);
+		if (err != 0) {
+			LOG_ERR("Failed to read name for bearer[%zu]: %d", i, err);
+			return err;
+		}
+	}
+#endif /* CONFIG_BT_TBS_CLIENT_TBS */
+
+	return 0;
+}
+
 static int init_ccp_call_control_client(void)
 {
-	static struct bt_le_scan_cb scan_cbs = {
-		.recv = scan_recv_cb,
-	};
 	static struct bt_ccp_call_control_client_cb ccp_call_control_client_cbs = {
 		.discover = ccp_call_control_client_discover_cb,
+#if defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME)
+		.bearer_provider_name = ccp_call_control_client_read_bearer_provider_name_cb
+#endif /* CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME */
+	};
+	static struct bt_le_scan_cb scan_cbs = {
+		.recv = scan_recv_cb,
 	};
 	int err;
 
@@ -323,6 +384,13 @@ int main(void)
 			continue;
 		}
 
+		if (IS_ENABLED(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME)) {
+			err = read_bearer_names();
+			if (err != 0) {
+				continue;
+			}
+		}
+
 		/* Reset if disconnected */
 		err = k_sem_take(&sem_conn_state_change, K_FOREVER);
 		if (err != 0) {

subsys/bluetooth/audio/ccp_call_control_client.c

@@ -28,6 +28,7 @@ LOG_MODULE_REGISTER(bt_ccp_call_control_client, CONFIG_BT_CCP_CALL_CONTROL_CLIEN
 
 static sys_slist_t ccp_call_control_client_cbs =
 	SYS_SLIST_STATIC_INIT(&ccp_call_control_client_cbs);
+static struct bt_tbs_client_cb tbs_client_cbs;
 
 static struct bt_tbs_client_cb tbs_client_cbs;
 
@@ -53,6 +54,32 @@ struct bt_ccp_call_control_client {
 
 static struct bt_ccp_call_control_client clients[CONFIG_BT_MAX_CONN];
 
+static struct bt_ccp_call_control_client_bearer *
+get_bearer_by_tbs_index(struct bt_ccp_call_control_client *client, uint8_t index)
+{
+	for (size_t i = 0U; i < ARRAY_SIZE(client->bearers); i++) {
+		struct bt_ccp_call_control_client_bearer *bearer = &client->bearers[i];
+
+		if (bearer->discovered && bearer->tbs_index == index) {
+			return bearer;
+		}
+	}
+
+	return NULL;
+}
+
+static struct bt_ccp_call_control_client *
+get_client_by_bearer(const struct bt_ccp_call_control_client_bearer *bearer)
+{
+	for (size_t i = 0U; i < ARRAY_SIZE(clients); i++) {
+		if (IS_ARRAY_ELEMENT(clients[i].bearers, bearer)) {
+			return &clients[i];
+		}
+	}
+
+	return NULL;
+}
+
 static struct bt_ccp_call_control_client *get_client_by_conn(const struct bt_conn *conn)
 {
 	return &clients[bt_conn_index(conn)];
@@ -84,6 +111,8 @@ static void disconnected_cb(struct bt_conn *conn, uint8_t reason)
 	if (client->conn == conn) {
 		bt_conn_unref(client->conn);
 		client->conn = NULL;
+
+		memset(client->bearers, 0, sizeof(client->bearers));
 	}
 }
 
@@ -252,3 +281,104 @@ int bt_ccp_call_control_client_get_bearers(struct bt_ccp_call_control_client *cl
 
 	return 0;
 }
+
+#if defined(CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME)
+static void tbs_client_read_bearer_provider_name_cb(struct bt_conn *conn, int err,
+						    uint8_t inst_index, const char *name)
+{
+	struct bt_ccp_call_control_client *client = get_client_by_conn(conn);
+	struct bt_ccp_call_control_client_cb *listener, *next;
+	struct bt_ccp_call_control_client_bearer *bearer;
+
+	atomic_clear_bit(client->flags, CCP_CALL_CONTROL_CLIENT_FLAG_BUSY);
+
+	bearer = get_bearer_by_tbs_index(client, inst_index);
+	if (bearer == NULL) {
+		LOG_DBG("Could not lookup bearer for client %p and index 0x%02X", client,
+			inst_index);
+
+		return;
+	}
+
+	SYS_SLIST_FOR_EACH_CONTAINER_SAFE(&ccp_call_control_client_cbs, listener, next, _node) {
+		if (listener->bearer_provider_name != NULL) {
+			listener->bearer_provider_name(bearer, err, name);
+		}
+	}
+}
+
+/**
+ * @brief Validates a bearer and provides a client with ownership of the busy flag
+ *
+ * @param[in] bearer The bearer to validate
+ * @param[out] client A client identified by the @p bearer with the busy flag set if return
+ *                    value is 0.
+ *
+ * @return 0 if the bearer is valid and the @p client has been populated, else an error.
+ */
+static int validate_bearer_and_get_client(const struct bt_ccp_call_control_client_bearer *bearer,
+					  struct bt_ccp_call_control_client **client)
+{
+	CHECKIF(bearer == NULL) {
+		LOG_DBG("bearer is NULL");
+
+		return -EINVAL;
+	}
+
+	*client = get_client_by_bearer(bearer);
+	if (*client == NULL) {
+		LOG_DBG("Could not identify client from bearer %p", bearer);
+
+		return -EEXIST;
+	}
+
+	if (!bearer->discovered) {
+		LOG_DBG("bearer %p is not discovered", bearer);
+
+		return -EFAULT;
+	}
+
+	if (atomic_test_and_set_bit((*client)->flags, CCP_CALL_CONTROL_CLIENT_FLAG_BUSY)) {
+		LOG_DBG("Client %p identified by bearer %p is busy", *client, bearer);
+
+		return -EBUSY;
+	}
+
+	return 0;
+}
+
+int bt_ccp_call_control_client_read_bearer_provider_name(
+	struct bt_ccp_call_control_client_bearer *bearer)
+{
+	struct bt_ccp_call_control_client *client;
+	int err;
+
+	err = validate_bearer_and_get_client(bearer, &client);
+	if (err != 0) {
+		return err;
+	}
+
+	tbs_client_cbs.bearer_provider_name = tbs_client_read_bearer_provider_name_cb;
+
+	err = bt_tbs_client_read_bearer_provider_name(client->conn, bearer->tbs_index);
+	if (err != 0) {
+		atomic_clear_bit(client->flags, CCP_CALL_CONTROL_CLIENT_FLAG_BUSY);
+
+		/* Return expected return values directly */
+		if (err == -ENOTCONN || err == -EBUSY) {
+			LOG_DBG("bt_tbs_client_read_bearer_provider_name returned %d", err);
+
+			return err;
+		}
+
+		/* Assert if the return value is -EINVAL as that means we are missing a check */
+		__ASSERT(err != -EINVAL, "err shall not be -EINVAL");
+
+		LOG_DBG("Unexpected error from bt_tbs_client_read_bearer_provider_name: %d", err);
+
+		return -ENOEXEC;
+	}
+
+	return 0;
+}
+#endif /* CONFIG_BT_TBS_CLIENT_BEARER_PROVIDER_NAME */