buf: extend module unbind call API_CALL

marcinszkudlinski · lgirdwood · commit 894fe70ad2bb · 2025-06-25T13:13:15.000+01:00
Currently unbind api call passes IPC4 header
only. This commit extends API by adding
pointers to sink/source of the entity that is
being bound.
Note that in pipeline 2.0 there's a possibility
to bind a module to a module, therefore pointers
to sink/src need to be provided instead of
a pointer to a buffer

Signed-off-by: Marcin Szkudlinski &lt;marcin.szkudlinski@intel.com&gt;
diff --git a/src/audio/copier/copier.c b/src/audio/copier/copier.c
@@ -1202,7 +1202,7 @@ __cold static int copier_bind(struct processing_module *mod, struct bind_info *b
 	return -ENODEV;
 }
 
-__cold static int copier_unbind(struct processing_module *mod, void *data)
+__cold static int copier_unbind(struct processing_module *mod, struct bind_info *unbind_data)
 {
 	struct copier_data *cd = module_get_private_data(mod);
 	struct comp_dev *dev = mod->dev;
@@ -1212,7 +1212,7 @@ __cold static int copier_unbind(struct processing_module *mod, void *data)
 	if (dev->ipc_config.type == SOF_COMP_DAI) {
 		struct dai_data *dd = cd->dd[0];
 
-		return dai_zephyr_unbind(dd, dev, data);
+		return dai_zephyr_unbind(dd, dev, unbind_data);
 	}
 
 	return 0;
diff --git a/src/audio/copier/dai_copier.h b/src/audio/copier/dai_copier.h
@@ -69,7 +69,7 @@ static inline int dai_zephyr_unbind(struct dai_data *dd, struct comp_dev *dev, v
 int dai_zephyr_multi_endpoint_copy(struct dai_data **dd, struct comp_dev *dev,
 				   struct comp_buffer *multi_endpoint_buffer,
 				   int num_endpoints);
-int dai_zephyr_unbind(struct dai_data *dd, struct comp_dev *dev, void *data);
+int dai_zephyr_unbind(struct dai_data *dd, struct comp_dev *dev, struct bind_info *unbind_data);
 #endif
 
 
diff --git a/src/audio/dai-zephyr.c b/src/audio/dai-zephyr.c
@@ -1961,14 +1961,15 @@ static uint64_t dai_get_processed_data(struct comp_dev *dev, uint32_t stream_no,
 }
 
 #ifdef CONFIG_IPC_MAJOR_4
-__cold int dai_zephyr_unbind(struct dai_data *dd, struct comp_dev *dev, void *data)
+__cold
+int dai_zephyr_unbind(struct dai_data *dd, struct comp_dev *dev, struct bind_info *unbind_data)
 {
 	struct ipc4_module_bind_unbind *bu;
 	int buf_id;
 
 	assert_can_be_cold();
 
-	bu = (struct ipc4_module_bind_unbind *)data;
+	bu = unbind_data->ipc4_data;
 	buf_id = IPC4_COMP_ID(bu->extension.r.src_queue, bu->extension.r.dst_queue);
 
 	if (dd && dd->local_buffer) {
diff --git a/src/audio/kpb.c b/src/audio/kpb.c
@@ -383,15 +383,15 @@ static int kpb_bind(struct comp_dev *dev, struct bind_info *bind_data)
  * \param[in] data - ipc4 bind/unbind data.
  * \return: none.
  */
-static int kpb_unbind(struct comp_dev *dev, void *data)
+static int kpb_unbind(struct comp_dev *dev, struct bind_info *unbind_data)
 {
 	struct comp_data *kpb = comp_get_drvdata(dev);
 	struct ipc4_module_bind_unbind *bu;
 	int buf_id;
 
 	comp_dbg(dev, "kpb_bind()");
 
-	bu = (struct ipc4_module_bind_unbind *)data;
+	bu = unbind_data->ipc4_data;
 	buf_id = IPC4_COMP_ID(bu->extension.r.src_queue, bu->extension.r.dst_queue);
 
 	/* Reset sinks when unbinding */
diff --git a/src/audio/mixin_mixout/mixin_mixout.c b/src/audio/mixin_mixout/mixin_mixout.c
@@ -831,7 +831,7 @@ static int mixout_bind(struct processing_module *mod, struct bind_info *bind_dat
 	return 0;
 }
 
-static int mixout_unbind(struct processing_module *mod, void *data)
+static int mixout_unbind(struct processing_module *mod, struct bind_info *unbind_data)
 {
 	struct ipc4_module_bind_unbind *bu;
 	struct comp_dev *mixin;
@@ -841,7 +841,7 @@ static int mixout_unbind(struct processing_module *mod, void *data)
 
 	comp_dbg(mod->dev, "mixout_unbind()");
 
-	bu = (struct ipc4_module_bind_unbind *)data;
+	bu = unbind_data->ipc4_data;
 	src_id = IPC4_COMP_ID(bu->primary.r.module_id, bu->primary.r.instance_id);
 
 	/* we are only interested in unbind for mixin -> mixout pair */
diff --git a/src/audio/module_adapter/module/generic.c b/src/audio/module_adapter/module/generic.c
@@ -502,12 +502,12 @@ int module_bind(struct processing_module *mod, struct bind_info *bind_data)
 	return 0;
 }
 
-int module_unbind(struct processing_module *mod, void *data)
+int module_unbind(struct processing_module *mod, struct bind_info *unbind_data)
 {
 	const struct module_interface *const ops = mod->dev->drv->adapter_ops;
 
 	if (ops->unbind)
-		return ops->unbind(mod, data);
+		return ops->unbind(mod, unbind_data);
 	return 0;
 }
 
diff --git a/src/audio/module_adapter/module_adapter_ipc4.c b/src/audio/module_adapter/module_adapter_ipc4.c
@@ -257,12 +257,12 @@ int module_adapter_bind(struct comp_dev *dev, struct bind_info *bind_data)
 }
 EXPORT_SYMBOL(module_adapter_bind);
 
-int module_adapter_unbind(struct comp_dev *dev, void *data)
+int module_adapter_unbind(struct comp_dev *dev, struct bind_info *unbind_data)
 {
 	struct processing_module *mod = comp_mod(dev);
 	int ret;
 
-	ret = module_unbind(mod, data);
+	ret = module_unbind(mod, unbind_data);
 	if (ret < 0)
 		return ret;
 
diff --git a/src/debug/tester/tester.c b/src/debug/tester/tester.c
@@ -199,13 +199,13 @@ static int tester_bind(struct processing_module *mod, struct bind_info *bind_dat
 	return ret;
 }
 
-static int tester_unbind(struct processing_module *mod, void *data)
+static int tester_unbind(struct processing_module *mod, struct bind_info *unbind_data)
 {
 	struct tester_module_data *cd = module_get_private_data(mod);
 	int ret = 0;
 
 	if (cd->tester_case_interface->unbind)
-		ret = cd->tester_case_interface->unbind(cd->test_case_ctx, mod, data);
+		ret = cd->tester_case_interface->unbind(cd->test_case_ctx, mod, unbind_data);
 
 	return ret;
 }
diff --git a/src/debug/tester/tester.h b/src/debug/tester/tester.h
@@ -80,7 +80,7 @@ struct tester_test_case_interface {
 	/**
 	 * copy of module unbind method, with additional ctx param
 	 */
-	int (*unbind)(void *ctx, struct processing_module *mod, void *data);
+	int (*unbind)(void *ctx, struct processing_module *mod, struct bind_info *unbind_data);
 
 	/**
 	 * copy of module trigger method, with additional ctx param
diff --git a/src/idc/idc.c b/src/idc/idc.c
@@ -102,14 +102,14 @@ static int idc_ipc4_unbind(uint32_t comp_id)
 {
 	struct ipc_comp_dev *ipc_dev;
 	struct idc_payload *payload;
-	struct ipc4_module_bind_unbind *bu;
+	struct bind_info *bu;
 
 	ipc_dev = ipc_get_comp_by_id(ipc_get(), comp_id);
 	if (!ipc_dev)
 		return -ENODEV;
 
 	payload = idc_payload_get(*idc_get(), cpu_get_id());
-	bu = (struct ipc4_module_bind_unbind *)payload;
+	bu = (struct bind_info *)payload;
 
 	return comp_unbind(ipc_dev->cd, bu);
 }
diff --git a/src/include/module/module/interface.h b/src/include/module/module/interface.h
@@ -66,6 +66,7 @@ struct processing_module;
 struct sof_source;
 struct sof_sink;
 struct bind_info;
+struct bind_info;
 
 /*
  * This structure may be used by modules to carry short 16bit parameters.
@@ -273,7 +274,7 @@ struct module_interface {
 	 * (optional) Module specific unbind procedure, called when modules are disconnected from
 	 * one another. Usually can be __cold
 	 */
-	int (*unbind)(struct processing_module *mod, void *data);
+	int (*unbind)(struct processing_module *mod, struct bind_info *unbind_data);
 
 	/**
 	 * (optional) Module specific trigger procedure, called when modules are triggered. Usually
diff --git a/src/include/sof/audio/component.h b/src/include/sof/audio/component.h
@@ -279,7 +279,7 @@ enum bind_type {
 };
 
 struct bind_info {
-	/* pointer to IPC4 bind data */
+	/* pointer to IPC4 bind/unbind data */
 	struct ipc4_module_bind_unbind *ipc4_data;
 
 	/* type of binding
@@ -293,8 +293,8 @@ struct bind_info {
 	/* pointers to sink or source API of the data provider/consumer
 	 * that is being bound to the module
 	 *
-	 * if bind_type == COMP_BIND_TYPE_SOURCE, the pointer below points to source
-	 * if bind_type == COMP_BIND_TYPE_SINK, the pointer below points to sink
+	 * if bind_type == COMP_BIND_TYPE_SOURCE, the pointer points to source being bound/unbound
+	 * if bind_type == COMP_BIND_TYPE_SINK, the pointer points to sink being bound/unbound
 	 *
 	 * NOTE! As in pipeline2.0 there may be a binding between modules,
 	 * without a buffer in between, it cannot be a pointer to any buffer type, module should
@@ -524,7 +524,7 @@ struct comp_ops {
 	 *
 	 * Usually can be __cold.
 	 */
-	int (*unbind)(struct comp_dev *dev, void *data);
+	int (*unbind)(struct comp_dev *dev, struct bind_info *unbind_data);
 
 	/**
 	 * Gets config in component.
diff --git a/src/include/sof/audio/component_ext.h b/src/include/sof/audio/component_ext.h
@@ -461,29 +461,30 @@ static inline int comp_bind(struct comp_dev *dev, struct bind_info *bind_data)
 }
 
 #if CONFIG_IPC_MAJOR_4
-static inline int comp_ipc4_unbind_remote(struct comp_dev *dev, void *data)
+static inline int comp_ipc4_unbind_remote(struct comp_dev *dev, struct bind_info *unbind_data)
 {
 	struct idc_msg msg = { IDC_MSG_UNBIND,
 		IDC_EXTENSION(dev->ipc_config.id), dev->ipc_config.core,
-		sizeof(struct ipc4_module_bind_unbind), data};
+		sizeof(*unbind_data), unbind_data};
 
 	return idc_send_msg(&msg, IDC_BLOCKING);
 }
 #endif
 
-static inline int comp_unbind(struct comp_dev *dev, void *data)
+static inline int comp_unbind(struct comp_dev *dev, struct bind_info *unbind_data)
 {
 #if CONFIG_IPC_MAJOR_4
 	if (dev->drv->ops.unbind)
 		return cpu_is_me(dev->ipc_config.core) ?
-			dev->drv->ops.unbind(dev, data) : comp_ipc4_unbind_remote(dev, data);
+			dev->drv->ops.unbind(dev, unbind_data) :
+			comp_ipc4_unbind_remote(dev, unbind_data);
 
 	return 0;
 #else
 	int ret = 0;
 
 	if (dev->drv->ops.unbind)
-		ret = dev->drv->ops.unbind(dev, data);
+		ret = dev->drv->ops.unbind(dev, unbind_data);
 
 	return ret;
 #endif
diff --git a/src/include/sof/audio/module_adapter/module/generic.h b/src/include/sof/audio/module_adapter/module/generic.h
@@ -206,7 +206,7 @@ int module_set_configuration(struct processing_module *mod,
 			     const uint8_t *fragment, size_t fragment_size, uint8_t *response,
 			     size_t response_size);
 int module_bind(struct processing_module *mod, struct bind_info *bind_data);
-int module_unbind(struct processing_module *mod, void *data);
+int module_unbind(struct processing_module *mod, struct bind_info *unbind_data);
 
 struct comp_dev *module_adapter_new(const struct comp_driver *drv,
 				    const struct comp_ipc_config *config, const void *spec);
@@ -252,7 +252,7 @@ int module_adapter_bind(struct comp_dev *dev, struct bind_info *bind_data)
 }
 
 static inline
-int module_adapter_unbind(struct comp_dev *dev, void *data)
+int module_adapter_unbind(struct comp_dev *dev, struct bind_info *unbind_data)
 {
 	return 0;
 }
@@ -282,7 +282,7 @@ int module_get_large_config(struct comp_dev *dev, uint32_t param_id, bool first_
 int module_adapter_get_attribute(struct comp_dev *dev, uint32_t type, void *value);
 int module_adapter_set_attribute(struct comp_dev *dev, uint32_t type, void *value);
 int module_adapter_bind(struct comp_dev *dev, struct bind_info *bind_data);
-int module_adapter_unbind(struct comp_dev *dev, void *data);
+int module_adapter_unbind(struct comp_dev *dev, struct bind_info *unbind_data);
 uint64_t module_adapter_get_total_data_processed(struct comp_dev *dev,
 						 uint32_t stream_no, bool input);
 
diff --git a/src/ipc/ipc4/helper.c b/src/ipc/ipc4/helper.c
@@ -683,7 +683,10 @@ __cold int ipc_comp_connect(struct ipc *ipc, ipc_pipe_comp_connect *_connect)
 	return IPC4_SUCCESS;
 
 e_sink_bind:
-	comp_unbind(source, bu);
+	/* sink bind was already called */
+	bind_data.bind_type = COMP_BIND_TYPE_SINK;
+	bind_data.sink = audio_buffer_get_sink(&buffer->audio_buffer);
+	comp_unbind(source, &bind_data);
 e_src_bind:
 	pipeline_disconnect(sink, buffer, PPL_CONN_DIR_BUFFER_TO_COMP);
 e_sink_connect:
@@ -710,6 +713,7 @@ __cold int ipc_comp_disconnect(struct ipc *ipc, ipc_pipe_comp_connect *_connect)
 	uint32_t flags = 0;
 	int ret, ret1;
 	bool cross_core_unbind;
+	struct bind_info unbind_data;
 
 	assert_can_be_cold();
 
@@ -779,8 +783,14 @@ __cold int ipc_comp_disconnect(struct ipc *ipc, ipc_pipe_comp_connect *_connect)
 	pipeline_disconnect(src, buffer, PPL_CONN_DIR_COMP_TO_BUFFER);
 	pipeline_disconnect(sink, buffer, PPL_CONN_DIR_BUFFER_TO_COMP);
 	/* these might call comp_ipc4_bind_remote() if necessary */
-	ret = comp_unbind(src, bu);
-	ret1 = comp_unbind(sink, bu);
+	unbind_data.ipc4_data = bu;
+	unbind_data.bind_type = COMP_BIND_TYPE_SINK;
+	unbind_data.sink = audio_buffer_get_sink(&buffer->audio_buffer);
+	ret = comp_unbind(src, &unbind_data);
+
+	unbind_data.bind_type = COMP_BIND_TYPE_SOURCE;
+	unbind_data.source = audio_buffer_get_source(&buffer->audio_buffer);
+	ret1 = comp_unbind(sink, &unbind_data);
 
 	ll_unblock(cross_core_unbind, flags);
 

Original file line number	Diff line number	Diff line change
`@@ -1202,7 +1202,7 @@ __cold static int copier_bind(struct processing_module mod, struct bind_info b`
`1202`	`1202`	`return -ENODEV;`
`1203`	`1203`	`}`
`1204`	`1204`
`1205`		`-__cold static int copier_unbind(struct processing_module mod, void data)`
	`1205`	`+__cold static int copier_unbind(struct processing_module mod, struct bind_info unbind_data)`
`1206`	`1206`	`{`
`1207`	`1207`	`struct copier_data *cd = module_get_private_data(mod);`
`1208`	`1208`	`struct comp_dev *dev = mod->dev;`
`@@ -1212,7 +1212,7 @@ __cold static int copier_unbind(struct processing_module mod, void data)`
`1212`	`1212`	`if (dev->ipc_config.type == SOF_COMP_DAI) {`
`1213`	`1213`	`struct dai_data *dd = cd->dd[0];`
`1214`	`1214`
`1215`		`- return dai_zephyr_unbind(dd, dev, data);`
	`1215`	`+ return dai_zephyr_unbind(dd, dev, unbind_data);`
`1216`	`1216`	`}`
`1217`	`1217`
`1218`	`1218`	`return 0;`
Original file line number	Diff line number	Diff line change
`@@ -1961,14 +1961,15 @@ static uint64_t dai_get_processed_data(struct comp_dev *dev, uint32_t stream_no,`
`1961`	`1961`	`}`
`1962`	`1962`
`1963`	`1963`	`#ifdef CONFIG_IPC_MAJOR_4`
`1964`		`-__cold int dai_zephyr_unbind(struct dai_data dd, struct comp_dev dev, void *data)`
	`1964`	`+__cold`
	`1965`	`+int dai_zephyr_unbind(struct dai_data dd, struct comp_dev dev, struct bind_info *unbind_data)`
`1965`	`1966`	`{`
`1966`	`1967`	`struct ipc4_module_bind_unbind *bu;`
`1967`	`1968`	`int buf_id;`
`1968`	`1969`
`1969`	`1970`	`assert_can_be_cold();`
`1970`	`1971`
`1971`		`- bu = (struct ipc4_module_bind_unbind *)data;`
	`1972`	`+ bu = unbind_data->ipc4_data;`
`1972`	`1973`	`buf_id = IPC4_COMP_ID(bu->extension.r.src_queue, bu->extension.r.dst_queue);`
`1973`	`1974`
`1974`	`1975`	`if (dd && dd->local_buffer) {`
Original file line number	Diff line number	Diff line change
`@@ -831,7 +831,7 @@ static int mixout_bind(struct processing_module mod, struct bind_info bind_dat`
`831`	`831`	`return 0;`
`832`	`832`	`}`
`833`	`833`
`834`		`-static int mixout_unbind(struct processing_module mod, void data)`
	`834`	`+static int mixout_unbind(struct processing_module mod, struct bind_info unbind_data)`
`835`	`835`	`{`
`836`	`836`	`struct ipc4_module_bind_unbind *bu;`
`837`	`837`	`struct comp_dev *mixin;`
`@@ -841,7 +841,7 @@ static int mixout_unbind(struct processing_module mod, void data)`
`841`	`841`
`842`	`842`	`comp_dbg(mod->dev, "mixout_unbind()");`
`843`	`843`
`844`		`- bu = (struct ipc4_module_bind_unbind *)data;`
	`844`	`+ bu = unbind_data->ipc4_data;`
`845`	`845`	`src_id = IPC4_COMP_ID(bu->primary.r.module_id, bu->primary.r.instance_id);`
`846`	`846`
`847`	`847`	`/* we are only interested in unbind for mixin -> mixout pair */`
Original file line number	Diff line number	Diff line change
`@@ -502,12 +502,12 @@ int module_bind(struct processing_module mod, struct bind_info bind_data)`
`502`	`502`	`return 0;`
`503`	`503`	`}`
`504`	`504`
`505`		`-int module_unbind(struct processing_module mod, void data)`
	`505`	`+int module_unbind(struct processing_module mod, struct bind_info unbind_data)`
`506`	`506`	`{`
`507`	`507`	`const struct module_interface *const ops = mod->dev->drv->adapter_ops;`
`508`	`508`
`509`	`509`	`if (ops->unbind)`
`510`		`- return ops->unbind(mod, data);`
	`510`	`+ return ops->unbind(mod, unbind_data);`
`511`	`511`	`return 0;`
`512`	`512`	`}`
`513`	`513`
Original file line number	Diff line number	Diff line change
`@@ -257,12 +257,12 @@ int module_adapter_bind(struct comp_dev dev, struct bind_info bind_data)`
`257`	`257`	`}`
`258`	`258`	`EXPORT_SYMBOL(module_adapter_bind);`
`259`	`259`
`260`		`-int module_adapter_unbind(struct comp_dev dev, void data)`
	`260`	`+int module_adapter_unbind(struct comp_dev dev, struct bind_info unbind_data)`
`261`	`261`	`{`
`262`	`262`	`struct processing_module *mod = comp_mod(dev);`
`263`	`263`	`int ret;`
`264`	`264`
`265`		`- ret = module_unbind(mod, data);`
	`265`	`+ ret = module_unbind(mod, unbind_data);`
`266`	`266`	`if (ret < 0)`
`267`	`267`	`return ret;`
`268`	`268`
Original file line number	Diff line number	Diff line change
`@@ -199,13 +199,13 @@ static int tester_bind(struct processing_module mod, struct bind_info bind_dat`
`199`	`199`	`return ret;`
`200`	`200`	`}`
`201`	`201`
`202`		`-static int tester_unbind(struct processing_module mod, void data)`
	`202`	`+static int tester_unbind(struct processing_module mod, struct bind_info unbind_data)`
`203`	`203`	`{`
`204`	`204`	`struct tester_module_data *cd = module_get_private_data(mod);`
`205`	`205`	`int ret = 0;`
`206`	`206`
`207`	`207`	`if (cd->tester_case_interface->unbind)`
`208`		`- ret = cd->tester_case_interface->unbind(cd->test_case_ctx, mod, data);`
	`208`	`+ ret = cd->tester_case_interface->unbind(cd->test_case_ctx, mod, unbind_data);`
`209`	`209`
`210`	`210`	`return ret;`
`211`	`211`	`}`
Original file line number	Diff line number	Diff line change
`@@ -102,14 +102,14 @@ static int idc_ipc4_unbind(uint32_t comp_id)`
`102`	`102`	`{`
`103`	`103`	`struct ipc_comp_dev *ipc_dev;`
`104`	`104`	`struct idc_payload *payload;`
`105`		`- struct ipc4_module_bind_unbind *bu;`
	`105`	`+ struct bind_info *bu;`
`106`	`106`
`107`	`107`	`ipc_dev = ipc_get_comp_by_id(ipc_get(), comp_id);`
`108`	`108`	`if (!ipc_dev)`
`109`	`109`	`return -ENODEV;`
`110`	`110`
`111`	`111`	`payload = idc_payload_get(*idc_get(), cpu_get_id());`
`112`		`- bu = (struct ipc4_module_bind_unbind *)payload;`
	`112`	`+ bu = (struct bind_info *)payload;`
`113`	`113`
`114`	`114`	`return comp_unbind(ipc_dev->cd, bu);`
`115`	`115`	`}`