buf: extend module bind call API_CALL

Currently bind 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 <marcin.szkudlinski@intel.com>

Author: marcinszkudlinski

src/audio/copier/copier.c

@@ -1173,9 +1173,9 @@ __cold static int copier_get_hw_params(struct comp_dev *dev, struct sof_ipc_stre
 	return dai_common_get_hw_params(dd, dev, params, dir);
 }
 
-__cold static int copier_bind(struct processing_module *mod, void *data)
+__cold static int copier_bind(struct processing_module *mod, struct bind_info *bind_data)
 {
-	const struct ipc4_module_bind_unbind *const bu = (struct ipc4_module_bind_unbind *)data;
+	const struct ipc4_module_bind_unbind *const bu = bind_data->ipc4_data;
 	const uint32_t src_id = IPC4_COMP_ID(bu->primary.r.module_id, bu->primary.r.instance_id);
 	const uint32_t src_queue_id = bu->extension.r.src_queue;
 	struct copier_data *cd = module_get_private_data(mod);

src/audio/kpb.c

@@ -333,10 +333,10 @@ static int kpb_get_attribute(struct comp_dev *dev,
 /**
  * \brief Initialize KPB sinks when binding.
  * \param[in] dev - component device pointer.
- * \param[in] data - ipc4 bind/unbind data.
+ * \param[in] bind_data - bind/unbind data.
  * \return: none.
  */
-static int kpb_bind(struct comp_dev *dev, void *data)
+static int kpb_bind(struct comp_dev *dev, struct bind_info *bind_data)
 {
 	struct comp_data *kpb = comp_get_drvdata(dev);
 	struct ipc4_module_bind_unbind *bu;
@@ -345,7 +345,7 @@ static int kpb_bind(struct comp_dev *dev, void *data)
 
 	comp_dbg(dev, "kpb_bind()");
 
-	bu = (struct ipc4_module_bind_unbind *)data;
+	bu = bind_data->ipc4_data;
 	buf_id = IPC4_COMP_ID(bu->extension.r.src_queue, bu->extension.r.dst_queue);
 
 	/* We're assuming here that KPB Real Time sink (kpb->sel_sink) is

src/audio/mixin_mixout/mixin_mixout.c

@@ -784,17 +784,15 @@ static int mixout_prepare(struct processing_module *mod,
 	return 0;
 }
 
-static int mixout_bind(struct processing_module *mod, void *data)
+static int mixout_bind(struct processing_module *mod, struct bind_info *bind_data)
 {
 	struct ipc4_module_bind_unbind *bu;
 	struct comp_dev *mixin;
 	struct pending_frames *pending_frames;
 	int src_id;
 	struct mixout_data *mixout_data;
 
-	comp_dbg(mod->dev, "mixout_bind() %p", data);
-
-	bu = (struct ipc4_module_bind_unbind *)data;
+	bu = bind_data->ipc4_data;
 	src_id = IPC4_COMP_ID(bu->primary.r.module_id, bu->primary.r.instance_id);
 
 	/* we are only interested in bind for mixin -> mixout pair */

src/audio/module_adapter/module/generic.c

@@ -493,12 +493,12 @@ int module_set_configuration(struct processing_module *mod,
 }
 EXPORT_SYMBOL(module_set_configuration);
 
-int module_bind(struct processing_module *mod, void *data)
+int module_bind(struct processing_module *mod, struct bind_info *bind_data)
 {
 	const struct module_interface *const ops = mod->dev->drv->adapter_ops;
 
 	if (ops->bind)
-		return ops->bind(mod, data);
+		return ops->bind(mod, bind_data);
 	return 0;
 }
 

src/audio/module_adapter/module_adapter_ipc4.c

@@ -242,12 +242,12 @@ static bool module_adapter_multi_sink_source_prepare(struct comp_dev *dev)
 	return false;
 }
 
-int module_adapter_bind(struct comp_dev *dev, void *data)
+int module_adapter_bind(struct comp_dev *dev, struct bind_info *bind_data)
 {
 	struct processing_module *mod = comp_mod(dev);
 	int ret;
 
-	ret = module_bind(mod, data);
+	ret = module_bind(mod, bind_data);
 	if (ret < 0)
 		return ret;
 

src/debug/tester/tester.c

@@ -188,13 +188,13 @@ static int tester_free(struct processing_module *mod)
 	return ret;
 }
 
-static int tester_bind(struct processing_module *mod, void *data)
+static int tester_bind(struct processing_module *mod, struct bind_info *bind_data)
 {
 	struct tester_module_data *cd = module_get_private_data(mod);
 	int ret = 0;
 
 	if (cd->tester_case_interface->bind)
-		ret = cd->tester_case_interface->bind(cd->test_case_ctx, mod, data);
+		ret = cd->tester_case_interface->bind(cd->test_case_ctx, mod, bind_data);
 
 	return ret;
 }

src/debug/tester/tester.h

@@ -75,7 +75,7 @@ struct tester_test_case_interface {
 	/**
 	 * copy of module bind method, with additional ctx param
 	 */
-	int (*bind)(void *ctx, struct processing_module *mod, void *data);
+	int (*bind)(void *ctx, struct processing_module *mod, struct bind_info *bind_data);
 
 	/**
 	 * copy of module unbind method, with additional ctx param

src/idc/idc.c

@@ -86,14 +86,14 @@ static int idc_ipc4_bind(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_bind(ipc_dev->cd, bu);
 }

src/include/module/module/interface.h

@@ -65,6 +65,7 @@ struct output_stream_buffer {
 struct processing_module;
 struct sof_source;
 struct sof_sink;
+struct bind_info;
 
 /*
  * This structure may be used by modules to carry short 16bit parameters.
@@ -266,7 +267,7 @@ struct module_interface {
 	 * (optional) Module specific bind procedure, called when modules are bound with each other.
 	 * Usually can be __cold
 	 */
-	int (*bind)(struct processing_module *mod, void *data);
+	int (*bind)(struct processing_module *mod, struct bind_info *bind_data);
 
 	/**
 	 * (optional) Module specific unbind procedure, called when modules are disconnected from

src/include/sof/audio/component.h

@@ -271,6 +271,40 @@ enum comp_copy_type {
 struct comp_driver;
 struct comp_ipc_config;
 union ipc_config_specific;
+struct ipc4_module_bind_unbind;
+
+enum bind_type {
+	COMP_BIND_TYPE_SOURCE,
+	COMP_BIND_TYPE_SINK
+};
+
+struct bind_info {
+	/* pointer to IPC4 bind data */
+	struct ipc4_module_bind_unbind *ipc4_data;
+
+	/* type of binding
+	 * bind call will be called twice for every component, first when binding a data source,
+	 * than when binding data sink.
+	 *
+	 * bind_type is indicating type of binding
+	 */
+	enum bind_type bind_type;
+
+	/* 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
+	 *
+	 * 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
+	 * use sink/source API
+	 */
+	union {
+		struct sof_source *source;
+		struct sof_sink *sink;
+	};
+};
 
 /**
  * Audio component operations.
@@ -481,7 +515,7 @@ struct comp_ops {
 	 *
 	 * Usually can be __cold.
 	 */
-	int (*bind)(struct comp_dev *dev, void *data);
+	int (*bind)(struct comp_dev *dev, struct bind_info *bind_data);
 
 	/**
 	 * Unbind, atomic - used to notify component of unbind event.