mod: add bind/unbind hook to sink/source API

This commit adds bind/unbind hook to sink/source API
It is guaranteed that the hooks will be called on
core that the API will be / was used on, what makes
them a perfect place for cache operations needed at
start/end of usage.
Note that free method is not a good place for this, as
in case of shared buffers it may happen on either of
the cores the buffer connects

Signed-off-by: Marcin Szkudlinski <marcin.szkudlinski@intel.com>

Author: marcinszkudlinski

src/audio/module_adapter/module/generic.c

@@ -495,20 +495,50 @@ EXPORT_SYMBOL(module_set_configuration);
 
 int module_bind(struct processing_module *mod, struct bind_info *bind_data)
 {
+	int ret;
 	const struct module_interface *const ops = mod->dev->drv->adapter_ops;
 
+	switch (bind_data->bind_type) {
+	case COMP_BIND_TYPE_SINK:
+		ret = sink_bind(bind_data->sink, mod);
+		break;
+	case COMP_BIND_TYPE_SOURCE:
+		ret = source_bind(bind_data->source, mod);
+		break;
+	default:
+		ret = -EINVAL;
+	}
+	if (ret)
+		return ret;
+
 	if (ops->bind)
-		return ops->bind(mod, bind_data);
-	return 0;
+		ret = ops->bind(mod, bind_data);
+
+	return ret;
 }
 
 int module_unbind(struct processing_module *mod, struct bind_info *unbind_data)
 {
+	int ret;
 	const struct module_interface *const ops = mod->dev->drv->adapter_ops;
 
+	switch (unbind_data->bind_type) {
+	case COMP_BIND_TYPE_SINK:
+		ret = sink_unbind(unbind_data->sink);
+		break;
+	case COMP_BIND_TYPE_SOURCE:
+		ret = source_unbind(unbind_data->source);
+		break;
+	default:
+		ret = -EINVAL;
+	}
+	if (ret)
+		return ret;
+
 	if (ops->unbind)
-		return ops->unbind(mod, unbind_data);
-	return 0;
+		ret = ops->unbind(mod, unbind_data);
+
+	return ret;
 }
 
 void module_update_buffer_position(struct input_stream_buffer *input_buffers,

src/include/module/audio/sink_api.h

@@ -51,6 +51,7 @@
 struct sof_sink;
 struct sof_audio_stream_params;
 struct sof_ipc_stream_params;
+struct processing_module;
 
 /**
  * this is a definition of internals of sink API
@@ -101,6 +102,14 @@ struct sink_ops {
 	int (*set_alignment_constants)(struct sof_sink *sink,
 				       const uint32_t byte_align,
 				       const uint32_t frame_align_req);
+
+	/**
+	 * OPTIONAL
+	 * events called when a module is starting / finishing using of the API
+	 * on the core that the module and API will executed on
+	 */
+	int (*on_bind)(struct sof_sink *sink, struct processing_module *module);
+	int (*on_unbind)(struct sof_sink *sink);
 };
 
 /** internals of sink API. NOT TO BE MODIFIED OUTSIDE OF sink_api.c */
@@ -111,6 +120,7 @@ struct sof_sink {
 	size_t min_free_space;		  /** minimum buffer space required by the module using sink
 					    *  it is module's OBS as declared in module bind IPC
 					    */
+	struct processing_module *bound_module; /* a pointer module that is using sink API */
 	struct sof_audio_stream_params *audio_stream_params; /** pointer to audio params */
 };
 
@@ -291,4 +301,51 @@ static inline uint32_t sink_get_pipeline_id(struct sof_sink *sink)
 	return sink->audio_stream_params->pipeline_id;
 }
 
+/**
+ * @brief hook to be called when a module connects to the API
+ *
+ * NOTE! it MUST be called at core that a module is bound to
+ */
+static inline int sink_bind(struct sof_sink *sink, struct processing_module *module)
+{
+	int ret = 0;
+
+	if (sink->bound_module)
+		return -EBUSY;
+
+	if (sink->ops->on_bind)
+		ret = sink->ops->on_bind(sink, module);
+
+	if (!ret)
+		sink->bound_module = module;
+
+	return ret;
+}
+
+/**
+ * @brief hook to be called when a module disconnects from the API
+ *
+ * NOTE! it MUST be called at core that a module is bound to
+ */
+static inline int sink_unbind(struct sof_sink *sink)
+{
+	int ret = 0;
+
+	if (!sink->bound_module)
+		return -EINVAL;
+
+	if (sink->ops->on_unbind)
+		ret = sink->ops->on_unbind(sink);
+
+	if (!ret)
+		sink->bound_module = NULL;
+
+	return ret;
+}
+
+static inline struct processing_module *sink_get_bound_module(struct sof_sink *sink)
+{
+	return sink->bound_module;
+}
+
 #endif /* __MODULE_AUDIO_SINK_API_H__ */

src/include/module/audio/source_api.h

@@ -51,6 +51,7 @@
 struct sof_source;
 struct sof_audio_stream_params;
 struct sof_ipc_stream_params;
+struct processing_module;
 
 /**
  * this is a definition of internals of source API
@@ -101,6 +102,14 @@ struct source_ops {
 	int (*set_alignment_constants)(struct sof_source *source,
 				       const uint32_t byte_align,
 				       const uint32_t frame_align_req);
+
+	/**
+	 * OPTIONAL
+	 * events called when a module is starting / finishing using of the API
+	 * on the core that the module and API will executed on
+	 */
+	int (*on_bind)(struct sof_source *source, struct processing_module *module);
+	int (*on_unbind)(struct sof_source *source);
 };
 
 /** internals of source API. NOT TO BE MODIFIED OUTSIDE OF source_api.c */
@@ -112,7 +121,7 @@ struct sof_source {
 					  * source
 					  * it is module's IBS as declared in module bind IPC
 					  */
-
+	struct processing_module *bound_module; /* a pointer module that is using source API */
 	struct sof_audio_stream_params *audio_stream_params;
 };
 
@@ -267,4 +276,51 @@ static inline uint32_t source_get_pipeline_id(struct sof_source *source)
 	return source->audio_stream_params->pipeline_id;
 }
 
+/**
+ * @brief hook to be called when a module connects to the API
+ *
+ * NOTE! it MUST be called at core that a module is bound to
+ */
+static inline int source_bind(struct sof_source *source, struct processing_module *module)
+{
+	int ret = 0;
+
+	if (source->bound_module)
+		return -EBUSY;
+
+	if (source->ops->on_bind)
+		ret = source->ops->on_bind(source, module);
+
+	if (!ret)
+		source->bound_module = module;
+
+	return ret;
+}
+
+/**
+ * @brief hook to be called when a module disconnects from the API
+ *
+ * NOTE! it MUST be called at core that a module is bound to
+ */
+static inline int source_unbind(struct sof_source *source)
+{
+	int ret = 0;
+
+	if (!source->bound_module)
+		return -EINVAL;
+
+	if (source->ops->on_unbind)
+		ret = source->ops->on_unbind(source);
+
+	if (!ret)
+		source->bound_module = NULL;
+
+	return ret;
+}
+
+static inline struct processing_module *source_get_bound_module(struct sof_source *source)
+{
+	return source->bound_module;
+}
+
 #endif /* __MODULE_AUDIO_SOURCE_API_H__ */