xref: /openbmc/linux/sound/soc/sof/ipc4-pcm.c (revision 1b36955c)
1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
2 //
3 // This file is provided under a dual BSD/GPLv2 license.  When using or
4 // redistributing this file, you may do so under either license.
5 //
6 // Copyright(c) 2022 Intel Corporation. All rights reserved.
7 //
8 
9 #include <sound/pcm_params.h>
10 #include <sound/sof/ipc4/header.h>
11 #include "sof-audio.h"
12 #include "sof-priv.h"
13 #include "ops.h"
14 #include "ipc4-priv.h"
15 #include "ipc4-topology.h"
16 #include "ipc4-fw-reg.h"
17 
18 static int sof_ipc4_set_multi_pipeline_state(struct snd_sof_dev *sdev, u32 state,
19 					     struct ipc4_pipeline_set_state_data *trigger_list)
20 {
21 	struct sof_ipc4_msg msg = {{ 0 }};
22 	u32 primary, ipc_size;
23 
24 	/* trigger a single pipeline */
25 	if (trigger_list->count == 1)
26 		return sof_ipc4_set_pipeline_state(sdev, trigger_list->pipeline_ids[0], state);
27 
28 	primary = state;
29 	primary |= SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_SET_PIPELINE_STATE);
30 	primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
31 	primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
32 	msg.primary = primary;
33 
34 	/* trigger multiple pipelines with a single IPC */
35 	msg.extension = SOF_IPC4_GLB_PIPE_STATE_EXT_MULTI;
36 
37 	/* ipc_size includes the count and the pipeline IDs for the number of pipelines */
38 	ipc_size = sizeof(u32) * (trigger_list->count + 1);
39 	msg.data_size = ipc_size;
40 	msg.data_ptr = trigger_list;
41 
42 	return sof_ipc_tx_message_no_reply(sdev->ipc, &msg, ipc_size);
43 }
44 
45 int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 id, u32 state)
46 {
47 	struct sof_ipc4_msg msg = {{ 0 }};
48 	u32 primary;
49 
50 	dev_dbg(sdev->dev, "ipc4 set pipeline %d state %d", id, state);
51 
52 	primary = state;
53 	primary |= SOF_IPC4_GLB_PIPE_STATE_ID(id);
54 	primary |= SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_SET_PIPELINE_STATE);
55 	primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
56 	primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
57 
58 	msg.primary = primary;
59 
60 	return sof_ipc_tx_message_no_reply(sdev->ipc, &msg, 0);
61 }
62 EXPORT_SYMBOL(sof_ipc4_set_pipeline_state);
63 
64 static void
65 sof_ipc4_add_pipeline_to_trigger_list(struct snd_sof_dev *sdev, int state,
66 				      struct snd_sof_pipeline *spipe,
67 				      struct ipc4_pipeline_set_state_data *trigger_list)
68 {
69 	struct snd_sof_widget *pipe_widget = spipe->pipe_widget;
70 	struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
71 
72 	if (pipeline->skip_during_fe_trigger && state != SOF_IPC4_PIPE_RESET)
73 		return;
74 
75 	switch (state) {
76 	case SOF_IPC4_PIPE_RUNNING:
77 		/*
78 		 * Trigger pipeline if all PCMs containing it are paused or if it is RUNNING
79 		 * for the first time
80 		 */
81 		if (spipe->started_count == spipe->paused_count)
82 			trigger_list->pipeline_ids[trigger_list->count++] =
83 				pipe_widget->instance_id;
84 		break;
85 	case SOF_IPC4_PIPE_RESET:
86 		/* RESET if the pipeline is neither running nor paused */
87 		if (!spipe->started_count && !spipe->paused_count)
88 			trigger_list->pipeline_ids[trigger_list->count++] =
89 				pipe_widget->instance_id;
90 		break;
91 	case SOF_IPC4_PIPE_PAUSED:
92 		/* Pause the pipeline only when its started_count is 1 more than paused_count */
93 		if (spipe->paused_count == (spipe->started_count - 1))
94 			trigger_list->pipeline_ids[trigger_list->count++] =
95 				pipe_widget->instance_id;
96 		break;
97 	default:
98 		break;
99 	}
100 }
101 
102 static void
103 sof_ipc4_update_pipeline_state(struct snd_sof_dev *sdev, int state, int cmd,
104 			       struct snd_sof_pipeline *spipe,
105 			       struct ipc4_pipeline_set_state_data *trigger_list)
106 {
107 	struct snd_sof_widget *pipe_widget = spipe->pipe_widget;
108 	struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
109 	int i;
110 
111 	if (pipeline->skip_during_fe_trigger && state != SOF_IPC4_PIPE_RESET)
112 		return;
113 
114 	/* set state for pipeline if it was just triggered */
115 	for (i = 0; i < trigger_list->count; i++) {
116 		if (trigger_list->pipeline_ids[i] == pipe_widget->instance_id) {
117 			pipeline->state = state;
118 			break;
119 		}
120 	}
121 
122 	switch (state) {
123 	case SOF_IPC4_PIPE_PAUSED:
124 		switch (cmd) {
125 		case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
126 			/*
127 			 * increment paused_count if the PAUSED is the final state during
128 			 * the PAUSE trigger
129 			 */
130 			spipe->paused_count++;
131 			break;
132 		case SNDRV_PCM_TRIGGER_STOP:
133 		case SNDRV_PCM_TRIGGER_SUSPEND:
134 			/*
135 			 * decrement started_count if PAUSED is the final state during the
136 			 * STOP trigger
137 			 */
138 			spipe->started_count--;
139 			break;
140 		default:
141 			break;
142 		}
143 		break;
144 	case SOF_IPC4_PIPE_RUNNING:
145 		switch (cmd) {
146 		case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
147 			/* decrement paused_count for RELEASE */
148 			spipe->paused_count--;
149 			break;
150 		case SNDRV_PCM_TRIGGER_START:
151 		case SNDRV_PCM_TRIGGER_RESUME:
152 			/* increment started_count for START/RESUME */
153 			spipe->started_count++;
154 			break;
155 		default:
156 			break;
157 		}
158 		break;
159 	default:
160 		break;
161 	}
162 }
163 
164 /*
165  * The picture below represents the pipeline state machine wrt PCM actions corresponding to the
166  * triggers and ioctls
167  *				+---------------+
168  *				|               |
169  *				|    INIT       |
170  *				|               |
171  *				+-------+-------+
172  *					|
173  *					|
174  *					| START
175  *					|
176  *					|
177  * +----------------+		   +------v-------+		  +-------------+
178  * |                |   START     |              |   HW_FREE	  |             |
179  * |   RUNNING      <-------------+  PAUSED      +--------------> +   RESET     |
180  * |                |   PAUSE     |              |		  |             |
181  * +------+---------+   RELEASE   +---------+----+		  +-------------+
182  *	  |				     ^
183  *	  |				     |
184  *	  |				     |
185  *	  |				     |
186  *	  |		PAUSE		     |
187  *	  +---------------------------------+
188  *			STOP/SUSPEND
189  *
190  * Note that during system suspend, the suspend trigger is followed by a hw_free in
191  * sof_pcm_trigger(). So, the final state during suspend would be RESET.
192  * Also, since the SOF driver doesn't support full resume, streams would be restarted with the
193  * prepare ioctl before the START trigger.
194  */
195 
196 /*
197  * Chained DMA is a special case where there is no processing on
198  * DSP. The samples are just moved over by host side DMA to a single
199  * buffer on DSP and directly from there to link DMA. However, the
200  * model on SOF driver has two notional pipelines, one at host DAI,
201  * and another at link DAI. They both shall have the use_chain_dma
202  * attribute.
203  */
204 
205 static int sof_ipc4_chain_dma_trigger(struct snd_sof_dev *sdev,
206 				      struct snd_sof_pcm_stream_pipeline_list *pipeline_list,
207 				      int state, int cmd)
208 {
209 	bool allocate, enable, set_fifo_size;
210 	struct sof_ipc4_msg msg = {{ 0 }};
211 	int i;
212 
213 	switch (state) {
214 	case SOF_IPC4_PIPE_RUNNING: /* Allocate and start chained dma */
215 		allocate = true;
216 		enable = true;
217 		/*
218 		 * SOF assumes creation of a new stream from the presence of fifo_size
219 		 * in the message, so we must leave it out in pause release case.
220 		 */
221 		if (cmd == SNDRV_PCM_TRIGGER_PAUSE_RELEASE)
222 			set_fifo_size = false;
223 		else
224 			set_fifo_size = true;
225 		break;
226 	case SOF_IPC4_PIPE_PAUSED: /* Disable chained DMA. */
227 		allocate = true;
228 		enable = false;
229 		set_fifo_size = false;
230 		break;
231 	case SOF_IPC4_PIPE_RESET: /* Disable and free chained DMA. */
232 		allocate = false;
233 		enable = false;
234 		set_fifo_size = false;
235 		break;
236 	default:
237 		dev_err(sdev->dev, "Unexpected state %d", state);
238 		return -EINVAL;
239 	}
240 
241 	msg.primary = SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_CHAIN_DMA);
242 	msg.primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
243 	msg.primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
244 
245 	/*
246 	 * To set-up the DMA chain, the host DMA ID and SCS setting
247 	 * are retrieved from the host pipeline configuration. Likewise
248 	 * the link DMA ID and fifo_size are retrieved from the link
249 	 * pipeline configuration.
250 	 */
251 	for (i = 0; i < pipeline_list->count; i++) {
252 		struct snd_sof_pipeline *spipe = pipeline_list->pipelines[i];
253 		struct snd_sof_widget *pipe_widget = spipe->pipe_widget;
254 		struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
255 
256 		if (!pipeline->use_chain_dma) {
257 			dev_err(sdev->dev,
258 				"All pipelines in chained DMA stream should have use_chain_dma attribute set.");
259 			return -EINVAL;
260 		}
261 
262 		msg.primary |= pipeline->msg.primary;
263 
264 		/* Add fifo_size (actually DMA buffer size) field to the message */
265 		if (set_fifo_size)
266 			msg.extension |= pipeline->msg.extension;
267 	}
268 
269 	if (allocate)
270 		msg.primary |= SOF_IPC4_GLB_CHAIN_DMA_ALLOCATE_MASK;
271 
272 	if (enable)
273 		msg.primary |= SOF_IPC4_GLB_CHAIN_DMA_ENABLE_MASK;
274 
275 	return sof_ipc_tx_message_no_reply(sdev->ipc, &msg, 0);
276 }
277 
278 static int sof_ipc4_trigger_pipelines(struct snd_soc_component *component,
279 				      struct snd_pcm_substream *substream, int state, int cmd)
280 {
281 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
282 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
283 	struct snd_sof_pcm_stream_pipeline_list *pipeline_list;
284 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
285 	struct ipc4_pipeline_set_state_data *trigger_list;
286 	struct snd_sof_widget *pipe_widget;
287 	struct sof_ipc4_pipeline *pipeline;
288 	struct snd_sof_pipeline *spipe;
289 	struct snd_sof_pcm *spcm;
290 	int ret;
291 	int i;
292 
293 	dev_dbg(sdev->dev, "trigger cmd: %d state: %d\n", cmd, state);
294 
295 	spcm = snd_sof_find_spcm_dai(component, rtd);
296 	if (!spcm)
297 		return -EINVAL;
298 
299 	pipeline_list = &spcm->stream[substream->stream].pipeline_list;
300 
301 	/* nothing to trigger if the list is empty */
302 	if (!pipeline_list->pipelines || !pipeline_list->count)
303 		return 0;
304 
305 	spipe = pipeline_list->pipelines[0];
306 	pipe_widget = spipe->pipe_widget;
307 	pipeline = pipe_widget->private;
308 
309 	/*
310 	 * If use_chain_dma attribute is set we proceed to chained DMA
311 	 * trigger function that handles the rest for the substream.
312 	 */
313 	if (pipeline->use_chain_dma)
314 		return sof_ipc4_chain_dma_trigger(sdev, pipeline_list, state, cmd);
315 
316 	/* allocate memory for the pipeline data */
317 	trigger_list = kzalloc(struct_size(trigger_list, pipeline_ids, pipeline_list->count),
318 			       GFP_KERNEL);
319 	if (!trigger_list)
320 		return -ENOMEM;
321 
322 	mutex_lock(&ipc4_data->pipeline_state_mutex);
323 
324 	/*
325 	 * IPC4 requires pipelines to be triggered in order starting at the sink and
326 	 * walking all the way to the source. So traverse the pipeline_list in the order
327 	 * sink->source when starting PCM's and in the reverse order to pause/stop PCM's.
328 	 * Skip the pipelines that have their skip_during_fe_trigger flag set. If there is a fork
329 	 * in the pipeline, the order of triggering between the left/right paths will be
330 	 * indeterministic. But the sink->source trigger order sink->source would still be
331 	 * guaranteed for each fork independently.
332 	 */
333 	if (state == SOF_IPC4_PIPE_RUNNING || state == SOF_IPC4_PIPE_RESET)
334 		for (i = pipeline_list->count - 1; i >= 0; i--) {
335 			spipe = pipeline_list->pipelines[i];
336 			sof_ipc4_add_pipeline_to_trigger_list(sdev, state, spipe, trigger_list);
337 		}
338 	else
339 		for (i = 0; i < pipeline_list->count; i++) {
340 			spipe = pipeline_list->pipelines[i];
341 			sof_ipc4_add_pipeline_to_trigger_list(sdev, state, spipe, trigger_list);
342 		}
343 
344 	/* return if all pipelines are in the requested state already */
345 	if (!trigger_list->count) {
346 		ret = 0;
347 		goto free;
348 	}
349 
350 	/* no need to pause before reset or before pause release */
351 	if (state == SOF_IPC4_PIPE_RESET || cmd == SNDRV_PCM_TRIGGER_PAUSE_RELEASE)
352 		goto skip_pause_transition;
353 
354 	/*
355 	 * set paused state for pipelines if the final state is PAUSED or when the pipeline
356 	 * is set to RUNNING for the first time after the PCM is started.
357 	 */
358 	ret = sof_ipc4_set_multi_pipeline_state(sdev, SOF_IPC4_PIPE_PAUSED, trigger_list);
359 	if (ret < 0) {
360 		dev_err(sdev->dev, "failed to pause all pipelines\n");
361 		goto free;
362 	}
363 
364 	/* update PAUSED state for all pipelines just triggered */
365 	for (i = 0; i < pipeline_list->count ; i++) {
366 		spipe = pipeline_list->pipelines[i];
367 		sof_ipc4_update_pipeline_state(sdev, SOF_IPC4_PIPE_PAUSED, cmd, spipe,
368 					       trigger_list);
369 	}
370 
371 	/* return if this is the final state */
372 	if (state == SOF_IPC4_PIPE_PAUSED)
373 		goto free;
374 skip_pause_transition:
375 	/* else set the RUNNING/RESET state in the DSP */
376 	ret = sof_ipc4_set_multi_pipeline_state(sdev, state, trigger_list);
377 	if (ret < 0) {
378 		dev_err(sdev->dev, "failed to set final state %d for all pipelines\n", state);
379 		goto free;
380 	}
381 
382 	/* update RUNNING/RESET state for all pipelines that were just triggered */
383 	for (i = 0; i < pipeline_list->count; i++) {
384 		spipe = pipeline_list->pipelines[i];
385 		sof_ipc4_update_pipeline_state(sdev, state, cmd, spipe, trigger_list);
386 	}
387 
388 free:
389 	mutex_unlock(&ipc4_data->pipeline_state_mutex);
390 	kfree(trigger_list);
391 	return ret;
392 }
393 
394 static int sof_ipc4_pcm_trigger(struct snd_soc_component *component,
395 				struct snd_pcm_substream *substream, int cmd)
396 {
397 	int state;
398 
399 	/* determine the pipeline state */
400 	switch (cmd) {
401 	case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
402 		state = SOF_IPC4_PIPE_PAUSED;
403 		break;
404 	case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
405 	case SNDRV_PCM_TRIGGER_RESUME:
406 	case SNDRV_PCM_TRIGGER_START:
407 		state = SOF_IPC4_PIPE_RUNNING;
408 		break;
409 	case SNDRV_PCM_TRIGGER_SUSPEND:
410 	case SNDRV_PCM_TRIGGER_STOP:
411 		state = SOF_IPC4_PIPE_PAUSED;
412 		break;
413 	default:
414 		dev_err(component->dev, "%s: unhandled trigger cmd %d\n", __func__, cmd);
415 		return -EINVAL;
416 	}
417 
418 	/* set the pipeline state */
419 	return sof_ipc4_trigger_pipelines(component, substream, state, cmd);
420 }
421 
422 static int sof_ipc4_pcm_hw_free(struct snd_soc_component *component,
423 				struct snd_pcm_substream *substream)
424 {
425 	/* command is not relevant with RESET, so just pass 0 */
426 	return sof_ipc4_trigger_pipelines(component, substream, SOF_IPC4_PIPE_RESET, 0);
427 }
428 
429 static void ipc4_ssp_dai_config_pcm_params_match(struct snd_sof_dev *sdev, const char *link_name,
430 						 struct snd_pcm_hw_params *params)
431 {
432 	struct snd_sof_dai_link *slink;
433 	struct snd_sof_dai *dai;
434 	bool dai_link_found = false;
435 	int i;
436 
437 	list_for_each_entry(slink, &sdev->dai_link_list, list) {
438 		if (!strcmp(slink->link->name, link_name)) {
439 			dai_link_found = true;
440 			break;
441 		}
442 	}
443 
444 	if (!dai_link_found)
445 		return;
446 
447 	for (i = 0; i < slink->num_hw_configs; i++) {
448 		struct snd_soc_tplg_hw_config *hw_config = &slink->hw_configs[i];
449 
450 		if (params_rate(params) == le32_to_cpu(hw_config->fsync_rate)) {
451 			/* set current config for all DAI's with matching name */
452 			list_for_each_entry(dai, &sdev->dai_list, list)
453 				if (!strcmp(slink->link->name, dai->name))
454 					dai->current_config = le32_to_cpu(hw_config->id);
455 			break;
456 		}
457 	}
458 }
459 
460 /*
461  * Fixup DAI link parameters for sampling rate based on
462  * DAI copier configuration.
463  */
464 static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev,
465 					    struct snd_pcm_hw_params *params,
466 					    struct sof_ipc4_copier *ipc4_copier)
467 {
468 	struct sof_ipc4_pin_format *pin_fmts = ipc4_copier->available_fmt.input_pin_fmts;
469 	struct snd_interval *rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
470 	int num_input_formats = ipc4_copier->available_fmt.num_input_formats;
471 	unsigned int fe_rate = params_rate(params);
472 	bool fe_be_rate_match = false;
473 	bool single_be_rate = true;
474 	unsigned int be_rate;
475 	int i;
476 
477 	/*
478 	 * Copier does not change sampling rate, so we
479 	 * need to only consider the input pin information.
480 	 */
481 	for (i = 0; i < num_input_formats; i++) {
482 		unsigned int val = pin_fmts[i].audio_fmt.sampling_frequency;
483 
484 		if (i == 0)
485 			be_rate = val;
486 		else if (val != be_rate)
487 			single_be_rate = false;
488 
489 		if (val == fe_rate) {
490 			fe_be_rate_match = true;
491 			break;
492 		}
493 	}
494 
495 	/*
496 	 * If rate is different than FE rate, topology must
497 	 * contain an SRC. But we do require topology to
498 	 * define a single rate in the DAI copier config in
499 	 * this case (FE rate may be variable).
500 	 */
501 	if (!fe_be_rate_match) {
502 		if (!single_be_rate) {
503 			dev_err(sdev->dev, "Unable to select sampling rate for DAI link\n");
504 			return -EINVAL;
505 		}
506 
507 		rate->min = be_rate;
508 		rate->max = rate->min;
509 	}
510 
511 	return 0;
512 }
513 
514 static int sof_ipc4_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd,
515 				       struct snd_pcm_hw_params *params)
516 {
517 	struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, SOF_AUDIO_PCM_DRV_NAME);
518 	struct snd_sof_dai *dai = snd_sof_find_dai(component, rtd->dai_link->name);
519 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
520 	struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
521 	struct sof_ipc4_copier *ipc4_copier;
522 	bool use_chain_dma = false;
523 	int dir;
524 
525 	if (!dai) {
526 		dev_err(component->dev, "%s: No DAI found with name %s\n", __func__,
527 			rtd->dai_link->name);
528 		return -EINVAL;
529 	}
530 
531 	ipc4_copier = dai->private;
532 	if (!ipc4_copier) {
533 		dev_err(component->dev, "%s: No private data found for DAI %s\n",
534 			__func__, rtd->dai_link->name);
535 		return -EINVAL;
536 	}
537 
538 	for_each_pcm_streams(dir) {
539 		struct snd_soc_dapm_widget *w = snd_soc_dai_get_widget(cpu_dai, dir);
540 
541 		if (w) {
542 			struct snd_sof_widget *swidget = w->dobj.private;
543 			struct snd_sof_widget *pipe_widget = swidget->spipe->pipe_widget;
544 			struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
545 
546 			if (pipeline->use_chain_dma)
547 				use_chain_dma = true;
548 		}
549 	}
550 
551 	/* Chain DMA does not use copiers, so no fixup needed */
552 	if (!use_chain_dma) {
553 		int ret = sof_ipc4_pcm_dai_link_fixup_rate(sdev, params, ipc4_copier);
554 
555 		if (ret)
556 			return ret;
557 	}
558 
559 	switch (ipc4_copier->dai_type) {
560 	case SOF_DAI_INTEL_SSP:
561 		ipc4_ssp_dai_config_pcm_params_match(sdev, (char *)rtd->dai_link->name, params);
562 		break;
563 	default:
564 		break;
565 	}
566 
567 	return 0;
568 }
569 
570 static void sof_ipc4_pcm_free(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm)
571 {
572 	struct snd_sof_pcm_stream_pipeline_list *pipeline_list;
573 	int stream;
574 
575 	for_each_pcm_streams(stream) {
576 		pipeline_list = &spcm->stream[stream].pipeline_list;
577 		kfree(pipeline_list->pipelines);
578 		pipeline_list->pipelines = NULL;
579 		kfree(spcm->stream[stream].private);
580 		spcm->stream[stream].private = NULL;
581 	}
582 }
583 
584 static int sof_ipc4_pcm_setup(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm)
585 {
586 	struct snd_sof_pcm_stream_pipeline_list *pipeline_list;
587 	struct sof_ipc4_fw_data *ipc4_data = sdev->private;
588 	struct sof_ipc4_timestamp_info *stream_info;
589 	bool support_info = true;
590 	u32 abi_version;
591 	u32 abi_offset;
592 	int stream;
593 
594 	abi_offset = offsetof(struct sof_ipc4_fw_registers, abi_ver);
595 	sof_mailbox_read(sdev, sdev->fw_info_box.offset + abi_offset, &abi_version,
596 			 sizeof(abi_version));
597 
598 	if (abi_version < SOF_IPC4_FW_REGS_ABI_VER)
599 		support_info = false;
600 
601 	for_each_pcm_streams(stream) {
602 		pipeline_list = &spcm->stream[stream].pipeline_list;
603 
604 		/* allocate memory for max number of pipeline IDs */
605 		pipeline_list->pipelines = kcalloc(ipc4_data->max_num_pipelines,
606 						   sizeof(struct snd_sof_widget *), GFP_KERNEL);
607 		if (!pipeline_list->pipelines) {
608 			sof_ipc4_pcm_free(sdev, spcm);
609 			return -ENOMEM;
610 		}
611 
612 		if (!support_info)
613 			continue;
614 
615 		stream_info = kzalloc(sizeof(*stream_info), GFP_KERNEL);
616 		if (!stream_info) {
617 			sof_ipc4_pcm_free(sdev, spcm);
618 			return -ENOMEM;
619 		}
620 
621 		spcm->stream[stream].private = stream_info;
622 	}
623 
624 	return 0;
625 }
626 
627 static void sof_ipc4_build_time_info(struct snd_sof_dev *sdev, struct snd_sof_pcm_stream *spcm)
628 {
629 	struct sof_ipc4_copier *host_copier = NULL;
630 	struct sof_ipc4_copier *dai_copier = NULL;
631 	struct sof_ipc4_llp_reading_slot llp_slot;
632 	struct sof_ipc4_timestamp_info *info;
633 	struct snd_soc_dapm_widget *widget;
634 	struct snd_sof_dai *dai;
635 	int i;
636 
637 	/* find host & dai to locate info in memory window */
638 	for_each_dapm_widgets(spcm->list, i, widget) {
639 		struct snd_sof_widget *swidget = widget->dobj.private;
640 
641 		if (!swidget)
642 			continue;
643 
644 		if (WIDGET_IS_AIF(swidget->widget->id)) {
645 			host_copier = swidget->private;
646 		} else if (WIDGET_IS_DAI(swidget->widget->id)) {
647 			dai = swidget->private;
648 			dai_copier = dai->private;
649 		}
650 	}
651 
652 	/* both host and dai copier must be valid for time_info */
653 	if (!host_copier || !dai_copier) {
654 		dev_err(sdev->dev, "host or dai copier are not found\n");
655 		return;
656 	}
657 
658 	info = spcm->private;
659 	info->host_copier = host_copier;
660 	info->dai_copier = dai_copier;
661 	info->llp_offset = offsetof(struct sof_ipc4_fw_registers, llp_gpdma_reading_slots) +
662 				    sdev->fw_info_box.offset;
663 
664 	/* find llp slot used by current dai */
665 	for (i = 0; i < SOF_IPC4_MAX_LLP_GPDMA_READING_SLOTS; i++) {
666 		sof_mailbox_read(sdev, info->llp_offset, &llp_slot, sizeof(llp_slot));
667 		if (llp_slot.node_id == dai_copier->data.gtw_cfg.node_id)
668 			break;
669 
670 		info->llp_offset += sizeof(llp_slot);
671 	}
672 
673 	if (i < SOF_IPC4_MAX_LLP_GPDMA_READING_SLOTS)
674 		return;
675 
676 	/* if no llp gpdma slot is used, check aggregated sdw slot */
677 	info->llp_offset = offsetof(struct sof_ipc4_fw_registers, llp_sndw_reading_slots) +
678 					sdev->fw_info_box.offset;
679 	for (i = 0; i < SOF_IPC4_MAX_LLP_SNDW_READING_SLOTS; i++) {
680 		sof_mailbox_read(sdev, info->llp_offset, &llp_slot, sizeof(llp_slot));
681 		if (llp_slot.node_id == dai_copier->data.gtw_cfg.node_id)
682 			break;
683 
684 		info->llp_offset += sizeof(llp_slot);
685 	}
686 
687 	if (i < SOF_IPC4_MAX_LLP_SNDW_READING_SLOTS)
688 		return;
689 
690 	/* check EVAD slot */
691 	info->llp_offset = offsetof(struct sof_ipc4_fw_registers, llp_evad_reading_slot) +
692 					sdev->fw_info_box.offset;
693 	sof_mailbox_read(sdev, info->llp_offset, &llp_slot, sizeof(llp_slot));
694 	if (llp_slot.node_id != dai_copier->data.gtw_cfg.node_id) {
695 		dev_info(sdev->dev, "no llp found, fall back to default HDA path");
696 		info->llp_offset = 0;
697 	}
698 }
699 
700 static int sof_ipc4_pcm_hw_params(struct snd_soc_component *component,
701 				  struct snd_pcm_substream *substream,
702 				  struct snd_pcm_hw_params *params,
703 				  struct snd_sof_platform_stream_params *platform_params)
704 {
705 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
706 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
707 	struct sof_ipc4_timestamp_info *time_info;
708 	struct snd_sof_pcm *spcm;
709 
710 	spcm = snd_sof_find_spcm_dai(component, rtd);
711 	if (!spcm)
712 		return -EINVAL;
713 
714 	time_info = spcm->stream[substream->stream].private;
715 	/* delay calculation is not supported by current fw_reg ABI */
716 	if (!time_info)
717 		return 0;
718 
719 	time_info->stream_start_offset = SOF_IPC4_INVALID_STREAM_POSITION;
720 	time_info->llp_offset = 0;
721 
722 	sof_ipc4_build_time_info(sdev, &spcm->stream[substream->stream]);
723 
724 	return 0;
725 }
726 
727 static int sof_ipc4_get_stream_start_offset(struct snd_sof_dev *sdev,
728 					    struct snd_pcm_substream *substream,
729 					    struct snd_sof_pcm_stream *stream,
730 					    struct sof_ipc4_timestamp_info *time_info)
731 {
732 	struct sof_ipc4_copier *host_copier = time_info->host_copier;
733 	struct sof_ipc4_copier *dai_copier = time_info->dai_copier;
734 	struct sof_ipc4_pipeline_registers ppl_reg;
735 	u64 stream_start_position;
736 	u32 dai_sample_size;
737 	u32 ch, node_index;
738 	u32 offset;
739 
740 	if (!host_copier || !dai_copier)
741 		return -EINVAL;
742 
743 	if (host_copier->data.gtw_cfg.node_id == SOF_IPC4_INVALID_NODE_ID)
744 		return -EINVAL;
745 
746 	node_index = SOF_IPC4_NODE_INDEX(host_copier->data.gtw_cfg.node_id);
747 	offset = offsetof(struct sof_ipc4_fw_registers, pipeline_regs) + node_index * sizeof(ppl_reg);
748 	sof_mailbox_read(sdev, sdev->fw_info_box.offset + offset, &ppl_reg, sizeof(ppl_reg));
749 	if (ppl_reg.stream_start_offset == SOF_IPC4_INVALID_STREAM_POSITION)
750 		return -EINVAL;
751 
752 	stream_start_position = ppl_reg.stream_start_offset;
753 	ch = dai_copier->data.out_format.fmt_cfg;
754 	ch = SOF_IPC4_AUDIO_FORMAT_CFG_CHANNELS_COUNT(ch);
755 	dai_sample_size = (dai_copier->data.out_format.bit_depth >> 3) * ch;
756 	/* convert offset to sample count */
757 	do_div(stream_start_position, dai_sample_size);
758 	time_info->stream_start_offset = stream_start_position;
759 
760 	return 0;
761 }
762 
763 static snd_pcm_sframes_t sof_ipc4_pcm_delay(struct snd_soc_component *component,
764 					    struct snd_pcm_substream *substream)
765 {
766 	struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
767 	struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
768 	struct sof_ipc4_timestamp_info *time_info;
769 	struct sof_ipc4_llp_reading_slot llp;
770 	snd_pcm_uframes_t head_ptr, tail_ptr;
771 	struct snd_sof_pcm_stream *stream;
772 	struct snd_sof_pcm *spcm;
773 	u64 tmp_ptr;
774 	int ret;
775 
776 	spcm = snd_sof_find_spcm_dai(component, rtd);
777 	if (!spcm)
778 		return 0;
779 
780 	stream = &spcm->stream[substream->stream];
781 	time_info = stream->private;
782 	if (!time_info)
783 		return 0;
784 
785 	/*
786 	 * stream_start_offset is updated to memory window by FW based on
787 	 * pipeline statistics and it may be invalid if host query happens before
788 	 * the statistics is complete. And it will not change after the first initiailization.
789 	 */
790 	if (time_info->stream_start_offset == SOF_IPC4_INVALID_STREAM_POSITION) {
791 		ret = sof_ipc4_get_stream_start_offset(sdev, substream, stream, time_info);
792 		if (ret < 0)
793 			return 0;
794 	}
795 
796 	/*
797 	 * HDaudio links don't support the LLP counter reported by firmware
798 	 * the link position is read directly from hardware registers.
799 	 */
800 	if (!time_info->llp_offset) {
801 		tmp_ptr = snd_sof_pcm_get_stream_position(sdev, component, substream);
802 		if (!tmp_ptr)
803 			return 0;
804 	} else {
805 		sof_mailbox_read(sdev, time_info->llp_offset, &llp, sizeof(llp));
806 		tmp_ptr = ((u64)llp.reading.llp_u << 32) | llp.reading.llp_l;
807 	}
808 
809 	/* In two cases dai dma position is not accurate
810 	 * (1) dai pipeline is started before host pipeline
811 	 * (2) multiple streams mixed into one. Each stream has the same dai dma position
812 	 *
813 	 * Firmware calculates correct stream_start_offset for all cases including above two.
814 	 * Driver subtracts stream_start_offset from dai dma position to get accurate one
815 	 */
816 	tmp_ptr -= time_info->stream_start_offset;
817 
818 	/* Calculate the delay taking into account that both pointer can wrap */
819 	div64_u64_rem(tmp_ptr, substream->runtime->boundary, &tmp_ptr);
820 	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
821 		head_ptr = substream->runtime->status->hw_ptr;
822 		tail_ptr = tmp_ptr;
823 	} else {
824 		head_ptr = tmp_ptr;
825 		tail_ptr = substream->runtime->status->hw_ptr;
826 	}
827 
828 	if (head_ptr < tail_ptr)
829 		return substream->runtime->boundary - tail_ptr + head_ptr;
830 
831 	return head_ptr - tail_ptr;
832 }
833 
834 const struct sof_ipc_pcm_ops ipc4_pcm_ops = {
835 	.hw_params = sof_ipc4_pcm_hw_params,
836 	.trigger = sof_ipc4_pcm_trigger,
837 	.hw_free = sof_ipc4_pcm_hw_free,
838 	.dai_link_fixup = sof_ipc4_pcm_dai_link_fixup,
839 	.pcm_setup = sof_ipc4_pcm_setup,
840 	.pcm_free = sof_ipc4_pcm_free,
841 	.delay = sof_ipc4_pcm_delay,
842 	.ipc_first_on_start = true,
843 	.platform_stop_during_hw_free = true,
844 };
845