ASoC: SOF: ipc4: Add support for triggering pipelines in order

ranj063 · ranj063 · commit 768141b36cb9 · 2022-10-11T20:00:26.000-07:00
IPC4 requires pipelines to be triggered starting at the sink pipeline
and walking all the way to source in order. Add a helper function to
determine all the pipelines that need to triggered in the FE DAI trigger
in order and trigger them all simultaenously using the new
sof_ipc4_set_multi_pipeline_state() helper function.

Signed-off-by: Ranjani Sridharan &lt;ranjani.sridharan@linux.intel.com&gt;
diff --git a/include/sound/sof/ipc4/header.h b/include/sound/sof/ipc4/header.h
@@ -185,6 +185,9 @@ enum sof_ipc4_pipeline_state {
 #define SOF_IPC4_GLB_PIPE_STATE_MASK		GENMASK(15, 0)
 #define SOF_IPC4_GLB_PIPE_STATE(x)		((x) << SOF_IPC4_GLB_PIPE_STATE_SHIFT)
 
+#define SOF_IPC4_GLB_PIPE_MULTI		BIT(0)
+#define SOF_IPC4_GLB_PIPE_MULTI_SYNC_STOP	BIT(1)
+
 /* load library ipc msg */
 #define SOF_IPC4_GLB_LOAD_LIBRARY_LIB_ID_SHIFT	16
 #define SOF_IPC4_GLB_LOAD_LIBRARY_LIB_ID(x)	((x) << SOF_IPC4_GLB_LOAD_LIBRARY_LIB_ID_SHIFT)
diff --git a/sound/soc/sof/ipc4-pcm.c b/sound/soc/sof/ipc4-pcm.c
@@ -13,6 +13,34 @@
 #include "ipc4-priv.h"
 #include "ipc4-topology.h"
 
+static int sof_ipc4_set_multi_pipeline_state(struct snd_sof_dev *sdev, u32 state,
+					     struct sof_ipc4_multi_pipeline_info *info)
+{
+	struct ipc4_pipeline_set_state_data data;
+	struct sof_ipc4_msg msg = {{ 0 }};
+	u32 primary, ipc_size;
+	int i;
+
+	primary = state;
+	primary |= SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_SET_PIPELINE_STATE);
+	primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
+	primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
+
+	msg.primary = primary;
+
+	msg.extension = SOF_IPC4_GLB_PIPE_MULTI;
+
+	data.count = info->count;
+	for (i = 0; i < info->count; i++)
+		data.pipeline_ids[i] = info->pipelines[i]->instance_id;
+
+	ipc_size = sizeof(u32) * (info->count + 1);
+	msg.data_size = ipc_size;
+	msg.data_ptr = &data;
+
+	return sof_ipc_tx_message(sdev->ipc, &msg, ipc_size, NULL, 0);
+}
+
 int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 id, u32 state)
 {
 	struct sof_ipc4_msg msg = {{ 0 }};
@@ -32,65 +60,184 @@ int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 id, u32 state)
 }
 EXPORT_SYMBOL(sof_ipc4_set_pipeline_state);
 
+/* helper function to get the list of pipeline widgets that need to be triggered */
+static int
+sof_ipc4_get_pipelines_in_order(struct snd_sof_dev *sdev, struct snd_soc_dapm_widget *widget,
+				struct snd_soc_dapm_widget_list *list,
+				struct sof_ipc4_multi_pipeline_info *pipeline_info)
+{
+	struct snd_sof_widget *swidget = widget->dobj.private;
+	struct snd_sof_widget *pipeline_widget;
+	struct sof_ipc4_pipeline *pipeline;
+	struct snd_soc_dapm_path *p;
+	uint32_t pipeline_count;
+	int ret, i;
+
+	if (!swidget)
+		goto src_add;
+
+	/* find pipeline widget for the pipeline that this widget belongs to */
+	pipeline_widget = swidget->pipe_widget;
+	pipeline = pipeline_widget->private;
+
+	/* do not add backend pipelines */
+	if (pipeline->is_backend)
+		goto src_add;
+
+	/* check if pipeline has already been added to the list */
+	for (i = 0 ; i < pipeline_info->count; i++)
+		if (pipeline_info->pipelines[i] == pipeline_widget)
+			goto src_add;
+
+	pipeline_count = pipeline_info->count++;
+	if (pipeline_info->count > SOF_IPC4_TRIGGER_MAX_PIPELINE_COUNT) {
+		dev_err(sdev->dev, "Cannot trigger %d pipelines at once\n", pipeline_info->count);
+		return -EINVAL;
+	}
+
+	pipeline_info->pipelines[pipeline_count] = pipeline_widget;
+
+src_add:
+	/* add pipelines in the source paths */
+	snd_soc_dapm_widget_for_each_source_path(widget, p) {
+		if (!widget_in_list(list, p->source))
+			continue;
+
+		if (!p->walking && p->source->dobj.private) {
+			p->walking = true;
+			ret = sof_ipc4_get_pipelines_in_order(sdev, p->source, list, pipeline_info);
+			p->walking = false;
+			if (ret < 0)
+				return ret;
+		}
+	}
+
+	return 0;
+}
+
 static int sof_ipc4_trigger_pipelines(struct snd_soc_component *component,
 				      struct snd_pcm_substream *substream, int state)
 {
 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
+	struct sof_ipc4_multi_pipeline_info pipeline_info;
 	struct snd_sof_widget *pipeline_widget;
 	struct snd_soc_dapm_widget_list *list;
 	struct snd_soc_dapm_widget *widget;
 	struct sof_ipc4_pipeline *pipeline;
 	struct snd_sof_widget *swidget;
 	struct snd_sof_pcm *spcm;
 	int ret = 0;
-	int num_widgets;
+	int num_widgets, i;
 
 	spcm = snd_sof_find_spcm_dai(component, rtd);
 	if (!spcm)
 		return -EINVAL;
 
 	list = spcm->stream[substream->stream].list;
 
+	pipeline_info.count = 0;
+
+	/* get the list of pipeline widgets that need to be triggered */
 	for_each_dapm_widgets(list, num_widgets, widget) {
 		swidget = widget->dobj.private;
 
 		if (!swidget)
 			continue;
 
-		/* find pipeline widget for the pipeline that this widget belongs to */
-		pipeline_widget = swidget->pipe_widget;
-		pipeline = pipeline_widget->private;
+		/*
+		 * IPC4 requires pipelines to be triggered in order starting at the sink and
+		 * walking all the way to the source. So the starting widget for playback is of
+		 * DAI type and for capture, it is of AIF type.
+		 */
+		if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK && !WIDGET_IS_DAI(widget->id))
+			continue;
 
-		/* skip triggering backend pipelines */
-		if (pipeline->is_backend || pipeline->state == state)
+		if (substream->stream == SNDRV_PCM_STREAM_CAPTURE && !WIDGET_IS_AIF(widget->id))
 			continue;
 
+		ret = sof_ipc4_get_pipelines_in_order(sdev, widget, list, &pipeline_info);
+		if (ret < 0)
+			return ret;
+	}
+
+	if (!pipeline_info.count)
+		return ret;
+
+	/* trigger a single pipeline if count is 1 */
+	if (pipeline_info.count == 1) {
+		pipeline_widget = pipeline_info.pipelines[0];
+		pipeline = pipeline_widget->private;
+
 		/* first set the pipeline to PAUSED state */
 		if (pipeline->state != SOF_IPC4_PIPE_PAUSED) {
 			ret = sof_ipc4_set_pipeline_state(sdev, pipeline_widget->instance_id,
 							  SOF_IPC4_PIPE_PAUSED);
+
 			if (ret < 0) {
 				dev_err(sdev->dev, "failed to pause pipeline %d\n",
-					swidget->pipeline_id);
+					pipeline_widget->pipeline_id);
 				return ret;
 			}
 		}
 
 		pipeline->state = SOF_IPC4_PIPE_PAUSED;
 
 		if (pipeline->state == state)
-			continue;
+			return ret;
+
 
 		/* then set the final state */
 		ret = sof_ipc4_set_pipeline_state(sdev, pipeline_widget->instance_id, state);
 		if (ret < 0) {
-			dev_err(sdev->dev, "failed to set state %d for pipeline %d\n",
-				state, swidget->pipeline_id);
-			break;
+			dev_err(sdev->dev, "failed to set state %d pipeline %d\n",
+				state, pipeline_widget->pipeline_id);
+			return ret;
 		}
 
 		pipeline->state = state;
+		return ret;
+	}
+
+	/*
+	 * check if the pipelines are paused already.
+	 * It's enough to check the first pipeline's state
+	 */
+	pipeline_widget = pipeline_info.pipelines[0];
+	pipeline = pipeline_widget->private;
+	if (pipeline->state == SOF_IPC4_PIPE_PAUSED)
+		goto out;
+
+	/* pause all pipelines */
+	ret = sof_ipc4_set_multi_pipeline_state(sdev, SOF_IPC4_PIPE_PAUSED, &pipeline_info);
+	if (ret < 0) {
+		dev_err(sdev->dev, "failed to pause all pipelines\n");
+		return ret;
+	}
+
+	for (i = 0; i < pipeline_info.count; i++) {
+		pipeline_widget = pipeline_info.pipelines[i];
+		pipeline = pipeline_widget->private;
+		pipeline->state = SOF_IPC4_PIPE_PAUSED;
+	}
+
+out:
+	/* check if the pipelines are in the final state already */
+	pipeline_widget = pipeline_info.pipelines[0];
+	pipeline = pipeline_widget->private;
+	if (pipeline->state == state)
+		return ret;
+
+	ret = sof_ipc4_set_multi_pipeline_state(sdev, state, &pipeline_info);
+	if (ret < 0) {
+		dev_err(sdev->dev, "failed to set final state %d for all pipelines\n", state);
+		return ret;
+	}
+
+	for (i = 0; i < pipeline_info.count; i++) {
+		pipeline_widget = pipeline_info.pipelines[i];
+		pipeline = pipeline_widget->private;
+		pipeline->state = state;
 	}
 
 	return ret;
diff --git a/sound/soc/sof/ipc4-topology.h b/sound/soc/sof/ipc4-topology.h
@@ -64,6 +64,8 @@
 /* A magic number from FW */
 #define ALH_MULTI_GTW_COUNT	8
 
+#define SOF_IPC4_TRIGGER_MAX_PIPELINE_COUNT 16
+
 /**
  * struct sof_ipc4_pipeline - pipeline config data
  * @priority: Priority of this pipeline
@@ -82,6 +84,26 @@ struct sof_ipc4_pipeline {
 	struct sof_ipc4_msg msg;
 };
 
+/**
+ * struct sof_ipc4_multi_pipeline_info - multi pipeline trigger IPC info
+ * @pipelines: Array of pipeline widgets to be triggered
+ * @count: number of pipelines to be triggered
+ */
+struct sof_ipc4_multi_pipeline_info {
+	struct snd_sof_widget *pipelines[SOF_IPC4_TRIGGER_MAX_PIPELINE_COUNT];
+	uint32_t count;
+};
+
+/**
+ * struct sof_ipc4_multi_pipeline_data - multi pipeline trigger IPC data
+ * @count: Number of pipelines to be triggered
+ * @pipeline_ids: Arrays of IDs of the pipelines to be triggered
+ */
+struct ipc4_pipeline_set_state_data {
+	uint32_t count;
+	uint32_t pipeline_ids[SOF_IPC4_TRIGGER_MAX_PIPELINE_COUNT];
+};
+
 /**
  * struct sof_ipc4_available_audio_format - Available audio formats
  * @base_config: Available base config
