LE Audio: add conn parameter for bt_vcp_vol_rend_cb

ChangNice · henrikbrixandersen · commit e8db417a00ee · 2024-08-20T14:45:35.000+02:00
Add conn parameter to status/flags callbacks of bt_vcp_vol_rend_cb
to differentiate between remote and local changes.

Signed-off-by: Chang An &lt;chang.an_1@nxp.com&gt;
diff --git a/doc/releases/migration-guide-4.0.rst b/doc/releases/migration-guide-4.0.rst
@@ -150,6 +150,12 @@ Bluetooth Mesh
 Bluetooth Audio
 ===============
 
+* The Volume Renderer callback functions :code:`bt_vcp_vol_rend_cb.state` and
+  :code:`bt_vcp_vol_rend_cb.flags` for VCP now contain an additional parameter for
+  the connection.
+  This needs to be added to all instances of VCP Volume Renderer callback functions defined.
+  (:github:`76992`)
+
 Bluetooth Classic
 =================
 
diff --git a/include/zephyr/bluetooth/audio/vcp.h b/include/zephyr/bluetooth/audio/vcp.h
@@ -163,12 +163,14 @@ struct bt_vcp_vol_rend_cb {
 	 * bt_vcp_vol_rend_get_state(), or if the state is changed by either
 	 * the Volume Renderer or a remote Volume Controller.
 	 *
+	 * @param conn    Pointer to the connection to a remote device if
+	 *                the change was caused by it, otherwise NULL.
 	 * @param err     Error value. 0 on success, GATT error on positive value
 	 *                or errno on negative value.
 	 * @param volume  The volume of the Volume Control Service server.
 	 * @param mute    The mute setting of the Volume Control Service server.
 	 */
-	void (*state)(int err, uint8_t volume, uint8_t mute);
+	void (*state)(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute);
 
 	/**
 	 * @brief Callback function for Volume Control Service flags.
@@ -177,11 +179,13 @@ struct bt_vcp_vol_rend_cb {
 	 * Called when the value is remotely read as the client.
 	 * Called if the value is changed by either the server or client.
 	 *
+	 * @param conn    Pointer to the connection to a remote device if
+	 *                the change was caused by it, otherwise NULL.
 	 * @param err     Error value. 0 on success, GATT error on positive value
 	 *                or errno on negative value.
 	 * @param flags   The flags of the Volume Control Service server.
 	 */
-	void (*flags)(int err, uint8_t flags);
+	void (*flags)(struct bt_conn *conn, int err, uint8_t flags);
 };
 
 /**
diff --git a/samples/bluetooth/hap_ha/src/vcp_vol_renderer.c b/samples/bluetooth/hap_ha/src/vcp_vol_renderer.c
@@ -18,7 +18,7 @@
 
 static struct bt_vcp_included vcp_included;
 
-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)
 {
 	if (err) {
 		printk("VCS state get failed (%d)\n", err);
@@ -27,7 +27,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
 	}
 }
 
-static void vcs_flags_cb(int err, uint8_t flags)
+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)
 {
 	if (err) {
 		printk("VCS flags get failed (%d)\n", err);
diff --git a/samples/bluetooth/tmap_bmr/src/vcp_vol_renderer.c b/samples/bluetooth/tmap_bmr/src/vcp_vol_renderer.c
@@ -19,7 +19,7 @@
 
 static struct bt_vcp_included vcp_included;
 
-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)
 {
 	if (err) {
 		printk("VCS state get failed (%d)\n", err);
@@ -28,7 +28,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
 	}
 }
 
-static void vcs_flags_cb(int err, uint8_t flags)
+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)
 {
 	if (err) {
 		printk("VCS flags get failed (%d)\n", err);
diff --git a/samples/bluetooth/tmap_peripheral/src/vcp_vol_renderer.c b/samples/bluetooth/tmap_peripheral/src/vcp_vol_renderer.c
@@ -19,7 +19,7 @@
 
 static struct bt_vcp_included vcp_included;
 
-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)
 {
 	if (err) {
 		printk("VCS state get failed (%d)\n", err);
@@ -28,7 +28,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
 	}
 }
 
-static void vcs_flags_cb(int err, uint8_t flags)
+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)
 {
 	if (err) {
 		printk("VCS flags get failed (%d)\n", err);
diff --git a/subsys/bluetooth/audio/shell/vcp_vol_rend.c b/subsys/bluetooth/audio/shell/vcp_vol_rend.c
@@ -28,7 +28,7 @@
 
 static struct bt_vcp_included vcp_included;
 
-static void vcp_vol_rend_state_cb(int err, uint8_t volume, uint8_t mute)
+static void vcp_vol_rend_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)
 {
 	if (err) {
 		shell_error(ctx_shell, "VCP state get failed (%d)", err);
@@ -37,7 +37,7 @@ static void vcp_vol_rend_state_cb(int err, uint8_t volume, uint8_t mute)
 	}
 }
 
-static void vcp_vol_rend_flags_cb(int err, uint8_t flags)
+static void vcp_vol_rend_flags_cb(struct bt_conn *conn, int err, uint8_t flags)
 {
 	if (err) {
 		shell_error(ctx_shell, "VCP flags get failed (%d)", err);
diff --git a/subsys/bluetooth/audio/vcp_vol_rend.c b/subsys/bluetooth/audio/vcp_vol_rend.c
@@ -269,8 +269,7 @@ static ssize_t write_vcs_control(struct bt_conn *conn,
 		value_changed(&vol_rend, NOTIFY_STATE);
 
 		if (vol_rend.cb && vol_rend.cb->state) {
-			vol_rend.cb->state(0, vol_rend.state.volume,
-					       vol_rend.state.mute);
+			vol_rend.cb->state(conn, 0, vol_rend.state.volume, vol_rend.state.mute);
 		}
 	}
 
@@ -282,7 +281,7 @@ static ssize_t write_vcs_control(struct bt_conn *conn,
 		}
 
 		if (vol_rend.cb && vol_rend.cb->flags) {
-			vol_rend.cb->flags(0, vol_rend.flags);
+			vol_rend.cb->flags(conn, 0, vol_rend.flags);
 		}
 	}
 	return len;
@@ -524,8 +523,7 @@ int bt_vcp_vol_rend_set_step(uint8_t volume_step)
 int bt_vcp_vol_rend_get_state(void)
 {
 	if (vol_rend.cb && vol_rend.cb->state) {
-		vol_rend.cb->state(0, vol_rend.state.volume,
-				   vol_rend.state.mute);
+		vol_rend.cb->state(NULL, 0, vol_rend.state.volume, vol_rend.state.mute);
 	}
 
 	return 0;
@@ -534,7 +532,7 @@ int bt_vcp_vol_rend_get_state(void)
 int bt_vcp_vol_rend_get_flags(void)
 {
 	if (vol_rend.cb && vol_rend.cb->flags) {
-		vol_rend.cb->flags(0, vol_rend.flags);
+		vol_rend.cb->flags(NULL, 0, vol_rend.flags);
 	}
 
 	return 0;
diff --git a/tests/bluetooth/tester/src/audio/btp_vcp.c b/tests/bluetooth/tester/src/audio/btp_vcp.c
@@ -144,12 +144,12 @@ static uint8_t unmute(const void *cmd, uint16_t cmd_len,
 	return BTP_STATUS_SUCCESS;
 }
 
-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)
 {
 	LOG_DBG("VCP state cb err (%d)", err);
 }
 
-static void vcs_flags_cb(int err, uint8_t flags)
+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)
 {
 	LOG_DBG("VCP flags cb err (%d)", err);
 }
diff --git a/tests/bsim/bluetooth/audio/src/vcp_vol_rend_test.c b/tests/bsim/bluetooth/audio/src/vcp_vol_rend_test.c
@@ -54,7 +54,7 @@ static volatile bool g_aics_active = 1;
 static char g_aics_desc[AICS_DESC_SIZE];
 static volatile bool g_cb;
 
-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)
 {
 	if (err != 0) {
 		FAIL("VCP state cb err (%d)", err);
@@ -66,7 +66,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)
 	g_cb = true;
 }
 
-static void vcs_flags_cb(int err, uint8_t flags)
+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)
 {
 	if (err != 0) {
 		FAIL("VCP flags cb err (%d)", err);

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`
`19`	`19`	`static struct bt_vcp_included vcp_included;`
`20`	`20`
`21`		`-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
	`21`	`+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)`
`22`	`22`	`{`
`23`	`23`	`if (err) {`
`24`	`24`	`printk("VCS state get failed (%d)\n", err);`
`@@ -27,7 +27,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`
`30`		`-static void vcs_flags_cb(int err, uint8_t flags)`
	`30`	`+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)`
`31`	`31`	`{`
`32`	`32`	`if (err) {`
`33`	`33`	`printk("VCS flags get failed (%d)\n", err);`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`
`20`	`20`	`static struct bt_vcp_included vcp_included;`
`21`	`21`
`22`		`-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
	`22`	`+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)`
`23`	`23`	`{`
`24`	`24`	`if (err) {`
`25`	`25`	`printk("VCS state get failed (%d)\n", err);`
`@@ -28,7 +28,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
`28`	`28`	`}`
`29`	`29`	`}`
`30`	`30`
`31`		`-static void vcs_flags_cb(int err, uint8_t flags)`
	`31`	`+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)`
`32`	`32`	`{`
`33`	`33`	`if (err) {`
`34`	`34`	`printk("VCS flags get failed (%d)\n", err);`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@`
`28`	`28`
`29`	`29`	`static struct bt_vcp_included vcp_included;`
`30`	`30`
`31`		`-static void vcp_vol_rend_state_cb(int err, uint8_t volume, uint8_t mute)`
	`31`	`+static void vcp_vol_rend_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)`
`32`	`32`	`{`
`33`	`33`	`if (err) {`
`34`	`34`	`shell_error(ctx_shell, "VCP state get failed (%d)", err);`
`@@ -37,7 +37,7 @@ static void vcp_vol_rend_state_cb(int err, uint8_t volume, uint8_t mute)`
`37`	`37`	`}`
`38`	`38`	`}`
`39`	`39`
`40`		`-static void vcp_vol_rend_flags_cb(int err, uint8_t flags)`
	`40`	`+static void vcp_vol_rend_flags_cb(struct bt_conn *conn, int err, uint8_t flags)`
`41`	`41`	`{`
`42`	`42`	`if (err) {`
`43`	`43`	`shell_error(ctx_shell, "VCP flags get failed (%d)", err);`
Original file line number	Diff line number	Diff line change
`@@ -269,8 +269,7 @@ static ssize_t write_vcs_control(struct bt_conn *conn,`
`269`	`269`	`value_changed(&vol_rend, NOTIFY_STATE);`
`270`	`270`
`271`	`271`	`if (vol_rend.cb && vol_rend.cb->state) {`
`272`		`- vol_rend.cb->state(0, vol_rend.state.volume,`
`273`		`- vol_rend.state.mute);`
	`272`	`+ vol_rend.cb->state(conn, 0, vol_rend.state.volume, vol_rend.state.mute);`
`274`	`273`	`}`
`275`	`274`	`}`
`276`	`275`
`@@ -282,7 +281,7 @@ static ssize_t write_vcs_control(struct bt_conn *conn,`
`282`	`281`	`}`
`283`	`282`
`284`	`283`	`if (vol_rend.cb && vol_rend.cb->flags) {`
`285`		`- vol_rend.cb->flags(0, vol_rend.flags);`
	`284`	`+ vol_rend.cb->flags(conn, 0, vol_rend.flags);`
`286`	`285`	`}`
`287`	`286`	`}`
`288`	`287`	`return len;`
`@@ -524,8 +523,7 @@ int bt_vcp_vol_rend_set_step(uint8_t volume_step)`
`524`	`523`	`int bt_vcp_vol_rend_get_state(void)`
`525`	`524`	`{`
`526`	`525`	`if (vol_rend.cb && vol_rend.cb->state) {`
`527`		`- vol_rend.cb->state(0, vol_rend.state.volume,`
`528`		`- vol_rend.state.mute);`
	`526`	`+ vol_rend.cb->state(NULL, 0, vol_rend.state.volume, vol_rend.state.mute);`
`529`	`527`	`}`
`530`	`528`
`531`	`529`	`return 0;`
`@@ -534,7 +532,7 @@ int bt_vcp_vol_rend_get_state(void)`
`534`	`532`	`int bt_vcp_vol_rend_get_flags(void)`
`535`	`533`	`{`
`536`	`534`	`if (vol_rend.cb && vol_rend.cb->flags) {`
`537`		`- vol_rend.cb->flags(0, vol_rend.flags);`
	`535`	`+ vol_rend.cb->flags(NULL, 0, vol_rend.flags);`
`538`	`536`	`}`
`539`	`537`
`540`	`538`	`return 0;`
Original file line number	Diff line number	Diff line change
`@@ -144,12 +144,12 @@ static uint8_t unmute(const void *cmd, uint16_t cmd_len,`
`144`	`144`	`return BTP_STATUS_SUCCESS;`
`145`	`145`	`}`
`146`	`146`
`147`		`-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
	`147`	`+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)`
`148`	`148`	`{`
`149`	`149`	`LOG_DBG("VCP state cb err (%d)", err);`
`150`	`150`	`}`
`151`	`151`
`152`		`-static void vcs_flags_cb(int err, uint8_t flags)`
	`152`	`+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)`
`153`	`153`	`{`
`154`	`154`	`LOG_DBG("VCP flags cb err (%d)", err);`
`155`	`155`	`}`
Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ static volatile bool g_aics_active = 1;`
`54`	`54`	`static char g_aics_desc[AICS_DESC_SIZE];`
`55`	`55`	`static volatile bool g_cb;`
`56`	`56`
`57`		`-static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
	`57`	`+static void vcs_state_cb(struct bt_conn *conn, int err, uint8_t volume, uint8_t mute)`
`58`	`58`	`{`
`59`	`59`	`if (err != 0) {`
`60`	`60`	`FAIL("VCP state cb err (%d)", err);`
`@@ -66,7 +66,7 @@ static void vcs_state_cb(int err, uint8_t volume, uint8_t mute)`
`66`	`66`	`g_cb = true;`
`67`	`67`	`}`
`68`	`68`
`69`		`-static void vcs_flags_cb(int err, uint8_t flags)`
	`69`	`+static void vcs_flags_cb(struct bt_conn *conn, int err, uint8_t flags)`
`70`	`70`	`{`
`71`	`71`	`if (err != 0) {`
`72`	`72`	`FAIL("VCP flags cb err (%d)", err);`