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
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 /**
19 * struct sof_ipc4_timestamp_info - IPC4 timestamp info
20 * @host_copier: the host copier of the pcm stream
21 * @dai_copier: the dai copier of the pcm stream
22 * @stream_start_offset: reported by fw in memory window (converted to frames)
23 * @stream_end_offset: reported by fw in memory window (converted to frames)
24 * @llp_offset: llp offset in memory window
25 * @boundary: wrap boundary should be used for the LLP frame counter
26 * @delay: Calculated and stored in pointer callback. The stored value is
27 * returned in the delay callback.
28 */
29 struct sof_ipc4_timestamp_info {
30 struct sof_ipc4_copier *host_copier;
31 struct sof_ipc4_copier *dai_copier;
32 u64 stream_start_offset;
33 u64 stream_end_offset;
34 u32 llp_offset;
35
36 u64 boundary;
37 snd_pcm_sframes_t delay;
38 };
39
40 /**
41 * struct sof_ipc4_pcm_stream_priv - IPC4 specific private data
42 * @time_info: pointer to time info struct if it is supported, otherwise NULL
43 * @chain_dma_allocated: indicates the ChainDMA allocation state
44 */
45 struct sof_ipc4_pcm_stream_priv {
46 struct sof_ipc4_timestamp_info *time_info;
47
48 bool chain_dma_allocated;
49 };
50
51 static inline struct sof_ipc4_timestamp_info *
sof_ipc4_sps_to_time_info(struct snd_sof_pcm_stream * sps)52 sof_ipc4_sps_to_time_info(struct snd_sof_pcm_stream *sps)
53 {
54 struct sof_ipc4_pcm_stream_priv *stream_priv = sps->private;
55
56 return stream_priv->time_info;
57 }
58
sof_ipc4_set_multi_pipeline_state(struct snd_sof_dev * sdev,u32 state,struct ipc4_pipeline_set_state_data * trigger_list)59 static int sof_ipc4_set_multi_pipeline_state(struct snd_sof_dev *sdev, u32 state,
60 struct ipc4_pipeline_set_state_data *trigger_list)
61 {
62 struct sof_ipc4_msg msg = {{ 0 }};
63 u32 primary, ipc_size;
64
65 /* trigger a single pipeline */
66 if (trigger_list->count == 1)
67 return sof_ipc4_set_pipeline_state(sdev, trigger_list->pipeline_instance_ids[0],
68 state);
69
70 primary = state;
71 primary |= SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_SET_PIPELINE_STATE);
72 primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
73 primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
74 msg.primary = primary;
75
76 /* trigger multiple pipelines with a single IPC */
77 msg.extension = SOF_IPC4_GLB_PIPE_STATE_EXT_MULTI;
78
79 /* ipc_size includes the count and the pipeline IDs for the number of pipelines */
80 ipc_size = sizeof(u32) * (trigger_list->count + 1);
81 msg.data_size = ipc_size;
82 msg.data_ptr = trigger_list;
83
84 return sof_ipc_tx_message_no_reply(sdev->ipc, &msg, ipc_size);
85 }
86
sof_ipc4_set_pipeline_state(struct snd_sof_dev * sdev,u32 instance_id,u32 state)87 int sof_ipc4_set_pipeline_state(struct snd_sof_dev *sdev, u32 instance_id, u32 state)
88 {
89 struct sof_ipc4_msg msg = {{ 0 }};
90 u32 primary;
91
92 dev_dbg(sdev->dev, "ipc4 set pipeline instance %d state %d", instance_id, state);
93
94 primary = state;
95 primary |= SOF_IPC4_GLB_PIPE_STATE_ID(instance_id);
96 primary |= SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_SET_PIPELINE_STATE);
97 primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
98 primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
99
100 msg.primary = primary;
101
102 return sof_ipc_tx_message_no_reply(sdev->ipc, &msg, 0);
103 }
104 EXPORT_SYMBOL(sof_ipc4_set_pipeline_state);
105
sof_ipc4_add_pipeline_by_priority(struct ipc4_pipeline_set_state_data * trigger_list,struct snd_sof_widget * pipe_widget,s8 * pipe_priority,bool ascend)106 static void sof_ipc4_add_pipeline_by_priority(struct ipc4_pipeline_set_state_data *trigger_list,
107 struct snd_sof_widget *pipe_widget,
108 s8 *pipe_priority, bool ascend)
109 {
110 struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
111 int i, j;
112
113 for (i = 0; i < trigger_list->count; i++) {
114 /* add pipeline from low priority to high */
115 if (ascend && pipeline->priority < pipe_priority[i])
116 break;
117 /* add pipeline from high priority to low */
118 else if (!ascend && pipeline->priority > pipe_priority[i])
119 break;
120 }
121
122 for (j = trigger_list->count - 1; j >= i; j--) {
123 trigger_list->pipeline_instance_ids[j + 1] = trigger_list->pipeline_instance_ids[j];
124 pipe_priority[j + 1] = pipe_priority[j];
125 }
126
127 trigger_list->pipeline_instance_ids[i] = pipe_widget->instance_id;
128 trigger_list->count++;
129 pipe_priority[i] = pipeline->priority;
130 }
131
132 static void
sof_ipc4_add_pipeline_to_trigger_list(struct snd_sof_dev * sdev,int state,struct snd_sof_pipeline * spipe,struct ipc4_pipeline_set_state_data * trigger_list,s8 * pipe_priority)133 sof_ipc4_add_pipeline_to_trigger_list(struct snd_sof_dev *sdev, int state,
134 struct snd_sof_pipeline *spipe,
135 struct ipc4_pipeline_set_state_data *trigger_list,
136 s8 *pipe_priority)
137 {
138 struct snd_sof_widget *pipe_widget = spipe->pipe_widget;
139 struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
140
141 if (pipeline->skip_during_fe_trigger && state != SOF_IPC4_PIPE_RESET)
142 return;
143
144 switch (state) {
145 case SOF_IPC4_PIPE_RUNNING:
146 /*
147 * Trigger pipeline if all PCMs containing it are paused or if it is RUNNING
148 * for the first time
149 */
150 if (spipe->started_count == spipe->paused_count)
151 sof_ipc4_add_pipeline_by_priority(trigger_list, pipe_widget, pipe_priority,
152 false);
153 break;
154 case SOF_IPC4_PIPE_RESET:
155 /* RESET if the pipeline is neither running nor paused */
156 if (!spipe->started_count && !spipe->paused_count)
157 sof_ipc4_add_pipeline_by_priority(trigger_list, pipe_widget, pipe_priority,
158 true);
159 break;
160 case SOF_IPC4_PIPE_PAUSED:
161 /* Pause the pipeline only when its started_count is 1 more than paused_count */
162 if (spipe->paused_count == (spipe->started_count - 1))
163 sof_ipc4_add_pipeline_by_priority(trigger_list, pipe_widget, pipe_priority,
164 true);
165 break;
166 default:
167 break;
168 }
169 }
170
171 static void
sof_ipc4_update_pipeline_state(struct snd_sof_dev * sdev,int state,int cmd,struct snd_sof_pipeline * spipe,struct ipc4_pipeline_set_state_data * trigger_list)172 sof_ipc4_update_pipeline_state(struct snd_sof_dev *sdev, int state, int cmd,
173 struct snd_sof_pipeline *spipe,
174 struct ipc4_pipeline_set_state_data *trigger_list)
175 {
176 struct snd_sof_widget *pipe_widget = spipe->pipe_widget;
177 struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
178 int i;
179
180 if (pipeline->skip_during_fe_trigger && state != SOF_IPC4_PIPE_RESET)
181 return;
182
183 /* set state for pipeline if it was just triggered */
184 for (i = 0; i < trigger_list->count; i++) {
185 if (trigger_list->pipeline_instance_ids[i] == pipe_widget->instance_id) {
186 pipeline->state = state;
187 break;
188 }
189 }
190
191 switch (state) {
192 case SOF_IPC4_PIPE_PAUSED:
193 switch (cmd) {
194 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
195 /*
196 * increment paused_count if the PAUSED is the final state during
197 * the PAUSE trigger
198 */
199 spipe->paused_count++;
200 break;
201 case SNDRV_PCM_TRIGGER_STOP:
202 case SNDRV_PCM_TRIGGER_SUSPEND:
203 /*
204 * decrement started_count if PAUSED is the final state during the
205 * STOP trigger
206 */
207 spipe->started_count--;
208 break;
209 default:
210 break;
211 }
212 break;
213 case SOF_IPC4_PIPE_RUNNING:
214 switch (cmd) {
215 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
216 /* decrement paused_count for RELEASE */
217 spipe->paused_count--;
218 break;
219 case SNDRV_PCM_TRIGGER_START:
220 case SNDRV_PCM_TRIGGER_RESUME:
221 /* increment started_count for START/RESUME */
222 spipe->started_count++;
223 break;
224 default:
225 break;
226 }
227 break;
228 default:
229 break;
230 }
231 }
232
233 /*
234 * The picture below represents the pipeline state machine wrt PCM actions corresponding to the
235 * triggers and ioctls
236 * +---------------+
237 * | |
238 * | INIT |
239 * | |
240 * +-------+-------+
241 * |
242 * |
243 * | START
244 * |
245 * |
246 * +----------------+ +------v-------+ +-------------+
247 * | | START | | HW_FREE | |
248 * | RUNNING <-------------+ PAUSED +--------------> + RESET |
249 * | | PAUSE | | | |
250 * +------+---------+ RELEASE +---------+----+ +-------------+
251 * | ^
252 * | |
253 * | |
254 * | |
255 * | PAUSE |
256 * +---------------------------------+
257 * STOP/SUSPEND
258 *
259 * Note that during system suspend, the suspend trigger is followed by a hw_free in
260 * sof_pcm_trigger(). So, the final state during suspend would be RESET.
261 * Also, since the SOF driver doesn't support full resume, streams would be restarted with the
262 * prepare ioctl before the START trigger.
263 */
264
265 /*
266 * Chained DMA is a special case where there is no processing on
267 * DSP. The samples are just moved over by host side DMA to a single
268 * buffer on DSP and directly from there to link DMA. However, the
269 * model on SOF driver has two notional pipelines, one at host DAI,
270 * and another at link DAI. They both shall have the use_chain_dma
271 * attribute.
272 */
273
sof_ipc4_chain_dma_trigger(struct snd_sof_dev * sdev,struct snd_sof_pcm * spcm,int direction,struct snd_sof_pcm_stream_pipeline_list * pipeline_list,int state,int cmd)274 static int sof_ipc4_chain_dma_trigger(struct snd_sof_dev *sdev,
275 struct snd_sof_pcm *spcm, int direction,
276 struct snd_sof_pcm_stream_pipeline_list *pipeline_list,
277 int state, int cmd)
278 {
279 struct sof_ipc4_fw_data *ipc4_data = sdev->private;
280 struct sof_ipc4_pcm_stream_priv *stream_priv;
281 bool allocate, enable, set_fifo_size;
282 struct sof_ipc4_msg msg = {{ 0 }};
283 int ret, i;
284
285 stream_priv = spcm->stream[direction].private;
286
287 switch (state) {
288 case SOF_IPC4_PIPE_RUNNING: /* Allocate and start chained dma */
289 allocate = true;
290 enable = true;
291 /*
292 * SOF assumes creation of a new stream from the presence of fifo_size
293 * in the message, so we must leave it out in pause release case.
294 */
295 if (cmd == SNDRV_PCM_TRIGGER_PAUSE_RELEASE)
296 set_fifo_size = false;
297 else
298 set_fifo_size = true;
299 break;
300 case SOF_IPC4_PIPE_PAUSED: /* Disable chained DMA. */
301 allocate = true;
302 enable = false;
303 set_fifo_size = false;
304 break;
305 case SOF_IPC4_PIPE_RESET: /* Disable and free chained DMA. */
306
307 /* ChainDMA can only be reset if it has been allocated */
308 if (!stream_priv->chain_dma_allocated)
309 return 0;
310
311 allocate = false;
312 enable = false;
313 set_fifo_size = false;
314 break;
315 default:
316 spcm_err(spcm, direction, "Unexpected pipeline state %d\n", state);
317 return -EINVAL;
318 }
319
320 msg.primary = SOF_IPC4_MSG_TYPE_SET(SOF_IPC4_GLB_CHAIN_DMA);
321 msg.primary |= SOF_IPC4_MSG_DIR(SOF_IPC4_MSG_REQUEST);
322 msg.primary |= SOF_IPC4_MSG_TARGET(SOF_IPC4_FW_GEN_MSG);
323
324 /*
325 * To set-up the DMA chain, the host DMA ID and SCS setting
326 * are retrieved from the host pipeline configuration. Likewise
327 * the link DMA ID and fifo_size are retrieved from the link
328 * pipeline configuration.
329 */
330 for (i = 0; i < pipeline_list->count; i++) {
331 struct snd_sof_pipeline *spipe = pipeline_list->pipelines[i];
332 struct snd_sof_widget *pipe_widget = spipe->pipe_widget;
333 struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
334
335 if (!pipeline->use_chain_dma) {
336 spcm_err(spcm, direction,
337 "All pipelines in chained DMA path should have use_chain_dma attribute set.");
338 return -EINVAL;
339 }
340
341 msg.primary |= pipeline->msg.primary;
342
343 /* Add fifo_size (actually DMA buffer size) field to the message */
344 if (set_fifo_size)
345 msg.extension |= pipeline->msg.extension;
346 }
347
348 if (direction == SNDRV_PCM_STREAM_CAPTURE) {
349 /*
350 * For ChainDMA the DMA ids are unique with the following mapping:
351 * playback: 0 - (num_playback_streams - 1)
352 * capture: num_playback_streams - (num_playback_streams +
353 * num_capture_streams - 1)
354 *
355 * Add the num_playback_streams offset to the DMA ids stored in
356 * msg.primary in case capture
357 */
358 msg.primary += SOF_IPC4_GLB_CHAIN_DMA_HOST_ID(ipc4_data->num_playback_streams);
359 msg.primary += SOF_IPC4_GLB_CHAIN_DMA_LINK_ID(ipc4_data->num_playback_streams);
360 }
361
362 if (allocate)
363 msg.primary |= SOF_IPC4_GLB_CHAIN_DMA_ALLOCATE_MASK;
364
365 if (enable)
366 msg.primary |= SOF_IPC4_GLB_CHAIN_DMA_ENABLE_MASK;
367
368 ret = sof_ipc_tx_message_no_reply(sdev->ipc, &msg, 0);
369 /* Update the ChainDMA allocation state */
370 if (!ret)
371 stream_priv->chain_dma_allocated = allocate;
372
373 return ret;
374 }
375
sof_ipc4_trigger_pipelines(struct snd_soc_component * component,struct snd_pcm_substream * substream,int state,int cmd)376 static int sof_ipc4_trigger_pipelines(struct snd_soc_component *component,
377 struct snd_pcm_substream *substream, int state, int cmd)
378 {
379 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
380 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
381 struct snd_sof_pcm_stream_pipeline_list *pipeline_list;
382 struct sof_ipc4_fw_data *ipc4_data = sdev->private;
383 struct ipc4_pipeline_set_state_data *trigger_list;
384 struct snd_sof_widget *pipe_widget;
385 struct sof_ipc4_pipeline *pipeline;
386 struct snd_sof_pipeline *spipe;
387 struct snd_sof_pcm *spcm;
388 u8 *pipe_priority;
389 int ret;
390 int i;
391
392 spcm = snd_sof_find_spcm_dai(component, rtd);
393 if (!spcm)
394 return -EINVAL;
395
396 spcm_dbg(spcm, substream->stream, "cmd: %d, state: %d\n", cmd, state);
397
398 pipeline_list = &spcm->stream[substream->stream].pipeline_list;
399
400 /* nothing to trigger if the list is empty */
401 if (!pipeline_list->pipelines || !pipeline_list->count)
402 return 0;
403
404 spipe = pipeline_list->pipelines[0];
405 pipe_widget = spipe->pipe_widget;
406 pipeline = pipe_widget->private;
407
408 /*
409 * If use_chain_dma attribute is set we proceed to chained DMA
410 * trigger function that handles the rest for the substream.
411 */
412 if (pipeline->use_chain_dma)
413 return sof_ipc4_chain_dma_trigger(sdev, spcm, substream->stream,
414 pipeline_list, state, cmd);
415
416 /* allocate memory for the pipeline data */
417 trigger_list = kzalloc(struct_size(trigger_list, pipeline_instance_ids,
418 pipeline_list->count), GFP_KERNEL);
419 if (!trigger_list)
420 return -ENOMEM;
421
422 pipe_priority = kzalloc(pipeline_list->count, GFP_KERNEL);
423 if (!pipe_priority) {
424 kfree(trigger_list);
425 return -ENOMEM;
426 }
427
428 mutex_lock(&ipc4_data->pipeline_state_mutex);
429
430 /*
431 * IPC4 requires pipelines to be triggered in order starting at the sink and
432 * walking all the way to the source. So traverse the pipeline_list in the order
433 * sink->source when starting PCM's and in the reverse order to pause/stop PCM's.
434 * Skip the pipelines that have their skip_during_fe_trigger flag set. If there is a fork
435 * in the pipeline, the order of triggering between the left/right paths will be
436 * indeterministic. But the sink->source trigger order sink->source would still be
437 * guaranteed for each fork independently.
438 */
439 if (state == SOF_IPC4_PIPE_RUNNING || state == SOF_IPC4_PIPE_RESET)
440 for (i = pipeline_list->count - 1; i >= 0; i--) {
441 spipe = pipeline_list->pipelines[i];
442 sof_ipc4_add_pipeline_to_trigger_list(sdev, state, spipe, trigger_list,
443 pipe_priority);
444 }
445 else
446 for (i = 0; i < pipeline_list->count; i++) {
447 spipe = pipeline_list->pipelines[i];
448 sof_ipc4_add_pipeline_to_trigger_list(sdev, state, spipe, trigger_list,
449 pipe_priority);
450 }
451
452 /* return if all pipelines are in the requested state already */
453 if (!trigger_list->count) {
454 ret = 0;
455 goto free;
456 }
457
458 /* no need to pause before reset or before pause release */
459 if (state == SOF_IPC4_PIPE_RESET || cmd == SNDRV_PCM_TRIGGER_PAUSE_RELEASE)
460 goto skip_pause_transition;
461
462 /*
463 * set paused state for pipelines if the final state is PAUSED or when the pipeline
464 * is set to RUNNING for the first time after the PCM is started.
465 */
466 ret = sof_ipc4_set_multi_pipeline_state(sdev, SOF_IPC4_PIPE_PAUSED, trigger_list);
467 if (ret < 0) {
468 spcm_err(spcm, substream->stream, "failed to pause all pipelines\n");
469 goto free;
470 }
471
472 /* update PAUSED state for all pipelines just triggered */
473 for (i = 0; i < pipeline_list->count ; i++) {
474 spipe = pipeline_list->pipelines[i];
475 sof_ipc4_update_pipeline_state(sdev, SOF_IPC4_PIPE_PAUSED, cmd, spipe,
476 trigger_list);
477 }
478
479 /* return if this is the final state */
480 if (state == SOF_IPC4_PIPE_PAUSED) {
481 struct sof_ipc4_timestamp_info *time_info;
482
483 /*
484 * Invalidate the stream_start_offset to make sure that it is
485 * going to be updated if the stream resumes
486 */
487 time_info = sof_ipc4_sps_to_time_info(&spcm->stream[substream->stream]);
488 if (time_info)
489 time_info->stream_start_offset = SOF_IPC4_INVALID_STREAM_POSITION;
490
491 goto free;
492 }
493 skip_pause_transition:
494 /* else set the RUNNING/RESET state in the DSP */
495 ret = sof_ipc4_set_multi_pipeline_state(sdev, state, trigger_list);
496 if (ret < 0) {
497 spcm_err(spcm, substream->stream,
498 "failed to set final state %d for all pipelines\n",
499 state);
500 /*
501 * workaround: if the firmware is crashed while setting the
502 * pipelines to reset state we must ignore the error code and
503 * reset it to 0.
504 * Since the firmware is crashed we will not send IPC messages
505 * and we are going to see errors printed, but the state of the
506 * widgets will be correct for the next boot.
507 */
508 if (sdev->fw_state != SOF_FW_CRASHED || state != SOF_IPC4_PIPE_RESET)
509 goto free;
510
511 ret = 0;
512 }
513
514 /* update RUNNING/RESET state for all pipelines that were just triggered */
515 for (i = 0; i < pipeline_list->count; i++) {
516 spipe = pipeline_list->pipelines[i];
517 sof_ipc4_update_pipeline_state(sdev, state, cmd, spipe, trigger_list);
518 }
519
520 free:
521 mutex_unlock(&ipc4_data->pipeline_state_mutex);
522 kfree(trigger_list);
523 kfree(pipe_priority);
524 return ret;
525 }
526
sof_ipc4_pcm_trigger(struct snd_soc_component * component,struct snd_pcm_substream * substream,int cmd)527 static int sof_ipc4_pcm_trigger(struct snd_soc_component *component,
528 struct snd_pcm_substream *substream, int cmd)
529 {
530 int state;
531
532 /* determine the pipeline state */
533 switch (cmd) {
534 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
535 case SNDRV_PCM_TRIGGER_RESUME:
536 case SNDRV_PCM_TRIGGER_START:
537 state = SOF_IPC4_PIPE_RUNNING;
538 break;
539 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
540 case SNDRV_PCM_TRIGGER_SUSPEND:
541 case SNDRV_PCM_TRIGGER_STOP:
542 state = SOF_IPC4_PIPE_PAUSED;
543 break;
544 default:
545 dev_err(component->dev, "%s: unhandled trigger cmd %d\n", __func__, cmd);
546 return -EINVAL;
547 }
548
549 /* set the pipeline state */
550 return sof_ipc4_trigger_pipelines(component, substream, state, cmd);
551 }
552
sof_ipc4_pcm_hw_free(struct snd_soc_component * component,struct snd_pcm_substream * substream)553 static int sof_ipc4_pcm_hw_free(struct snd_soc_component *component,
554 struct snd_pcm_substream *substream)
555 {
556 /* command is not relevant with RESET, so just pass 0 */
557 return sof_ipc4_trigger_pipelines(component, substream, SOF_IPC4_PIPE_RESET, 0);
558 }
559
ipc4_ssp_dai_config_pcm_params_match(struct snd_sof_dev * sdev,const char * link_name,struct snd_pcm_hw_params * params)560 static void ipc4_ssp_dai_config_pcm_params_match(struct snd_sof_dev *sdev, const char *link_name,
561 struct snd_pcm_hw_params *params)
562 {
563 struct snd_sof_dai_link *slink;
564 struct snd_sof_dai *dai;
565 bool dai_link_found = false;
566 int i;
567
568 list_for_each_entry(slink, &sdev->dai_link_list, list) {
569 if (!strcmp(slink->link->name, link_name)) {
570 dai_link_found = true;
571 break;
572 }
573 }
574
575 if (!dai_link_found)
576 return;
577
578 for (i = 0; i < slink->num_hw_configs; i++) {
579 struct snd_soc_tplg_hw_config *hw_config = &slink->hw_configs[i];
580
581 if (params_rate(params) == le32_to_cpu(hw_config->fsync_rate)) {
582 /* set current config for all DAI's with matching name */
583 list_for_each_entry(dai, &sdev->dai_list, list)
584 if (!strcmp(slink->link->name, dai->name))
585 dai->current_config = le32_to_cpu(hw_config->id);
586 break;
587 }
588 }
589 }
590
591 /*
592 * Fixup DAI link parameters for sampling rate based on
593 * DAI copier configuration.
594 */
sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev * sdev,struct snd_pcm_hw_params * params,struct sof_ipc4_copier * ipc4_copier)595 static int sof_ipc4_pcm_dai_link_fixup_rate(struct snd_sof_dev *sdev,
596 struct snd_pcm_hw_params *params,
597 struct sof_ipc4_copier *ipc4_copier)
598 {
599 struct sof_ipc4_pin_format *pin_fmts = ipc4_copier->available_fmt.input_pin_fmts;
600 struct snd_interval *rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
601 int num_input_formats = ipc4_copier->available_fmt.num_input_formats;
602 unsigned int fe_rate = params_rate(params);
603 bool fe_be_rate_match = false;
604 bool single_be_rate = true;
605 unsigned int be_rate;
606 int i;
607
608 if (WARN_ON_ONCE(!num_input_formats))
609 return -EINVAL;
610
611 /*
612 * Copier does not change sampling rate, so we
613 * need to only consider the input pin information.
614 */
615 be_rate = pin_fmts[0].audio_fmt.sampling_frequency;
616 for (i = 0; i < num_input_formats; i++) {
617 unsigned int val = pin_fmts[i].audio_fmt.sampling_frequency;
618
619 if (val != be_rate)
620 single_be_rate = false;
621
622 if (val == fe_rate) {
623 fe_be_rate_match = true;
624 break;
625 }
626 }
627
628 /*
629 * If rate is different than FE rate, topology must
630 * contain an SRC. But we do require topology to
631 * define a single rate in the DAI copier config in
632 * this case (FE rate may be variable).
633 */
634 if (!fe_be_rate_match) {
635 if (!single_be_rate) {
636 dev_err(sdev->dev, "Unable to select sampling rate for DAI link\n");
637 return -EINVAL;
638 }
639
640 rate->min = be_rate;
641 rate->max = rate->min;
642 }
643
644 return 0;
645 }
646
sof_ipc4_pcm_dai_link_fixup(struct snd_soc_pcm_runtime * rtd,struct snd_pcm_hw_params * params)647 static int sof_ipc4_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd,
648 struct snd_pcm_hw_params *params)
649 {
650 struct snd_soc_component *component = snd_soc_rtdcom_lookup(rtd, SOF_AUDIO_PCM_DRV_NAME);
651 struct snd_sof_dai *dai = snd_sof_find_dai(component, rtd->dai_link->name);
652 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
653 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
654 struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0);
655 struct sof_ipc4_audio_format *ipc4_fmt;
656 struct sof_ipc4_copier *ipc4_copier;
657 bool single_bitdepth = false;
658 u32 valid_bits = 0;
659 int dir, ret;
660
661 if (!dai) {
662 dev_err(component->dev, "%s: No DAI found with name %s\n", __func__,
663 rtd->dai_link->name);
664 return -EINVAL;
665 }
666
667 ipc4_copier = dai->private;
668 if (!ipc4_copier) {
669 dev_err(component->dev, "%s: No private data found for DAI %s\n",
670 __func__, rtd->dai_link->name);
671 return -EINVAL;
672 }
673
674 for_each_pcm_streams(dir) {
675 struct snd_soc_dapm_widget *w = snd_soc_dai_get_widget(cpu_dai, dir);
676
677 if (w) {
678 struct sof_ipc4_available_audio_format *available_fmt =
679 &ipc4_copier->available_fmt;
680 struct snd_sof_widget *swidget = w->dobj.private;
681 struct snd_sof_widget *pipe_widget = swidget->spipe->pipe_widget;
682 struct sof_ipc4_pipeline *pipeline = pipe_widget->private;
683
684 /* Chain DMA does not use copiers, so no fixup needed */
685 if (pipeline->use_chain_dma)
686 return 0;
687
688 if (dir == SNDRV_PCM_STREAM_PLAYBACK) {
689 if (sof_ipc4_copier_is_single_bitdepth(sdev,
690 available_fmt->output_pin_fmts,
691 available_fmt->num_output_formats)) {
692 ipc4_fmt = &available_fmt->output_pin_fmts->audio_fmt;
693 single_bitdepth = true;
694 }
695 } else {
696 if (sof_ipc4_copier_is_single_bitdepth(sdev,
697 available_fmt->input_pin_fmts,
698 available_fmt->num_input_formats)) {
699 ipc4_fmt = &available_fmt->input_pin_fmts->audio_fmt;
700 single_bitdepth = true;
701 }
702 }
703 }
704 }
705
706 ret = sof_ipc4_pcm_dai_link_fixup_rate(sdev, params, ipc4_copier);
707 if (ret)
708 return ret;
709
710 if (single_bitdepth) {
711 snd_mask_none(fmt);
712 valid_bits = SOF_IPC4_AUDIO_FORMAT_CFG_V_BIT_DEPTH(ipc4_fmt->fmt_cfg);
713 dev_dbg(component->dev, "Set %s to %d bit format\n", dai->name, valid_bits);
714 }
715
716 /* Set format if it is specified */
717 switch (valid_bits) {
718 case 16:
719 snd_mask_set_format(fmt, SNDRV_PCM_FORMAT_S16_LE);
720 break;
721 case 24:
722 snd_mask_set_format(fmt, SNDRV_PCM_FORMAT_S24_LE);
723 break;
724 case 32:
725 snd_mask_set_format(fmt, SNDRV_PCM_FORMAT_S32_LE);
726 break;
727 default:
728 break;
729 }
730
731 switch (ipc4_copier->dai_type) {
732 case SOF_DAI_INTEL_SSP:
733 ipc4_ssp_dai_config_pcm_params_match(sdev, (char *)rtd->dai_link->name, params);
734 break;
735 default:
736 break;
737 }
738
739 return 0;
740 }
741
sof_ipc4_pcm_free(struct snd_sof_dev * sdev,struct snd_sof_pcm * spcm)742 static void sof_ipc4_pcm_free(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm)
743 {
744 struct snd_sof_pcm_stream_pipeline_list *pipeline_list;
745 struct sof_ipc4_pcm_stream_priv *stream_priv;
746 int stream;
747
748 for_each_pcm_streams(stream) {
749 pipeline_list = &spcm->stream[stream].pipeline_list;
750 kfree(pipeline_list->pipelines);
751 pipeline_list->pipelines = NULL;
752
753 stream_priv = spcm->stream[stream].private;
754 kfree(stream_priv->time_info);
755 kfree(spcm->stream[stream].private);
756 spcm->stream[stream].private = NULL;
757 }
758 }
759
sof_ipc4_pcm_setup(struct snd_sof_dev * sdev,struct snd_sof_pcm * spcm)760 static int sof_ipc4_pcm_setup(struct snd_sof_dev *sdev, struct snd_sof_pcm *spcm)
761 {
762 struct snd_sof_pcm_stream_pipeline_list *pipeline_list;
763 struct sof_ipc4_fw_data *ipc4_data = sdev->private;
764 struct sof_ipc4_pcm_stream_priv *stream_priv;
765 struct sof_ipc4_timestamp_info *time_info;
766 bool support_info = true;
767 u32 abi_version;
768 u32 abi_offset;
769 int stream;
770
771 abi_offset = offsetof(struct sof_ipc4_fw_registers, abi_ver);
772 sof_mailbox_read(sdev, sdev->fw_info_box.offset + abi_offset, &abi_version,
773 sizeof(abi_version));
774
775 if (abi_version < SOF_IPC4_FW_REGS_ABI_VER)
776 support_info = false;
777
778 /* For delay reporting the get_host_byte_counter callback is needed */
779 if (!sof_ops(sdev) || !sof_ops(sdev)->get_host_byte_counter)
780 support_info = false;
781
782 for_each_pcm_streams(stream) {
783 pipeline_list = &spcm->stream[stream].pipeline_list;
784
785 /* allocate memory for max number of pipeline IDs */
786 pipeline_list->pipelines = kcalloc(ipc4_data->max_num_pipelines,
787 sizeof(struct snd_sof_widget *), GFP_KERNEL);
788 if (!pipeline_list->pipelines) {
789 sof_ipc4_pcm_free(sdev, spcm);
790 return -ENOMEM;
791 }
792
793 stream_priv = kzalloc(sizeof(*stream_priv), GFP_KERNEL);
794 if (!stream_priv) {
795 sof_ipc4_pcm_free(sdev, spcm);
796 return -ENOMEM;
797 }
798
799 spcm->stream[stream].private = stream_priv;
800
801 /* Delay reporting is only supported on playback */
802 if (!support_info || stream == SNDRV_PCM_STREAM_CAPTURE)
803 continue;
804
805 time_info = kzalloc(sizeof(*time_info), GFP_KERNEL);
806 if (!time_info) {
807 sof_ipc4_pcm_free(sdev, spcm);
808 return -ENOMEM;
809 }
810
811 stream_priv->time_info = time_info;
812 }
813
814 return 0;
815 }
816
sof_ipc4_build_time_info(struct snd_sof_dev * sdev,struct snd_sof_pcm_stream * sps)817 static void sof_ipc4_build_time_info(struct snd_sof_dev *sdev, struct snd_sof_pcm_stream *sps)
818 {
819 struct sof_ipc4_copier *host_copier = NULL;
820 struct sof_ipc4_copier *dai_copier = NULL;
821 struct sof_ipc4_llp_reading_slot llp_slot;
822 struct sof_ipc4_timestamp_info *time_info;
823 struct snd_soc_dapm_widget *widget;
824 struct snd_sof_dai *dai;
825 int i;
826
827 /* find host & dai to locate info in memory window */
828 for_each_dapm_widgets(sps->list, i, widget) {
829 struct snd_sof_widget *swidget = widget->dobj.private;
830
831 if (!swidget)
832 continue;
833
834 if (WIDGET_IS_AIF(swidget->widget->id)) {
835 host_copier = swidget->private;
836 } else if (WIDGET_IS_DAI(swidget->widget->id)) {
837 dai = swidget->private;
838 dai_copier = dai->private;
839 }
840 }
841
842 /* both host and dai copier must be valid for time_info */
843 if (!host_copier || !dai_copier) {
844 dev_err(sdev->dev, "host or dai copier are not found\n");
845 return;
846 }
847
848 time_info = sof_ipc4_sps_to_time_info(sps);
849 time_info->host_copier = host_copier;
850 time_info->dai_copier = dai_copier;
851 time_info->llp_offset = offsetof(struct sof_ipc4_fw_registers,
852 llp_gpdma_reading_slots) + sdev->fw_info_box.offset;
853
854 /* find llp slot used by current dai */
855 for (i = 0; i < SOF_IPC4_MAX_LLP_GPDMA_READING_SLOTS; i++) {
856 sof_mailbox_read(sdev, time_info->llp_offset, &llp_slot, sizeof(llp_slot));
857 if (llp_slot.node_id == dai_copier->data.gtw_cfg.node_id)
858 break;
859
860 time_info->llp_offset += sizeof(llp_slot);
861 }
862
863 if (i < SOF_IPC4_MAX_LLP_GPDMA_READING_SLOTS)
864 return;
865
866 /* if no llp gpdma slot is used, check aggregated sdw slot */
867 time_info->llp_offset = offsetof(struct sof_ipc4_fw_registers,
868 llp_sndw_reading_slots) + sdev->fw_info_box.offset;
869 for (i = 0; i < SOF_IPC4_MAX_LLP_SNDW_READING_SLOTS; i++) {
870 sof_mailbox_read(sdev, time_info->llp_offset, &llp_slot, sizeof(llp_slot));
871 if (llp_slot.node_id == dai_copier->data.gtw_cfg.node_id)
872 break;
873
874 time_info->llp_offset += sizeof(llp_slot);
875 }
876
877 if (i < SOF_IPC4_MAX_LLP_SNDW_READING_SLOTS)
878 return;
879
880 /* check EVAD slot */
881 time_info->llp_offset = offsetof(struct sof_ipc4_fw_registers,
882 llp_evad_reading_slot) + sdev->fw_info_box.offset;
883 sof_mailbox_read(sdev, time_info->llp_offset, &llp_slot, sizeof(llp_slot));
884 if (llp_slot.node_id != dai_copier->data.gtw_cfg.node_id)
885 time_info->llp_offset = 0;
886 }
887
sof_ipc4_pcm_hw_params(struct snd_soc_component * component,struct snd_pcm_substream * substream,struct snd_pcm_hw_params * params,struct snd_sof_platform_stream_params * platform_params)888 static int sof_ipc4_pcm_hw_params(struct snd_soc_component *component,
889 struct snd_pcm_substream *substream,
890 struct snd_pcm_hw_params *params,
891 struct snd_sof_platform_stream_params *platform_params)
892 {
893 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
894 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
895 struct sof_ipc4_timestamp_info *time_info;
896 struct snd_sof_pcm *spcm;
897
898 spcm = snd_sof_find_spcm_dai(component, rtd);
899 if (!spcm)
900 return -EINVAL;
901
902 time_info = sof_ipc4_sps_to_time_info(&spcm->stream[substream->stream]);
903 /* delay calculation is not supported by current fw_reg ABI */
904 if (!time_info)
905 return 0;
906
907 time_info->stream_start_offset = SOF_IPC4_INVALID_STREAM_POSITION;
908 time_info->llp_offset = 0;
909
910 sof_ipc4_build_time_info(sdev, &spcm->stream[substream->stream]);
911
912 return 0;
913 }
914
sof_ipc4_get_stream_start_offset(struct snd_sof_dev * sdev,struct snd_pcm_substream * substream,struct snd_sof_pcm_stream * sps,struct sof_ipc4_timestamp_info * time_info)915 static int sof_ipc4_get_stream_start_offset(struct snd_sof_dev *sdev,
916 struct snd_pcm_substream *substream,
917 struct snd_sof_pcm_stream *sps,
918 struct sof_ipc4_timestamp_info *time_info)
919 {
920 struct sof_ipc4_copier *host_copier = time_info->host_copier;
921 struct sof_ipc4_copier *dai_copier = time_info->dai_copier;
922 struct sof_ipc4_pipeline_registers ppl_reg;
923 u32 dai_sample_size;
924 u32 ch, node_index;
925 u32 offset;
926
927 if (!host_copier || !dai_copier)
928 return -EINVAL;
929
930 if (host_copier->data.gtw_cfg.node_id == SOF_IPC4_INVALID_NODE_ID)
931 return -EINVAL;
932
933 node_index = SOF_IPC4_NODE_INDEX(host_copier->data.gtw_cfg.node_id);
934 offset = offsetof(struct sof_ipc4_fw_registers, pipeline_regs) + node_index * sizeof(ppl_reg);
935 sof_mailbox_read(sdev, sdev->fw_info_box.offset + offset, &ppl_reg, sizeof(ppl_reg));
936 if (ppl_reg.stream_start_offset == SOF_IPC4_INVALID_STREAM_POSITION)
937 return -EINVAL;
938
939 ch = dai_copier->data.out_format.fmt_cfg;
940 ch = SOF_IPC4_AUDIO_FORMAT_CFG_CHANNELS_COUNT(ch);
941 dai_sample_size = (dai_copier->data.out_format.bit_depth >> 3) * ch;
942
943 /* convert offsets to frame count */
944 time_info->stream_start_offset = ppl_reg.stream_start_offset;
945 do_div(time_info->stream_start_offset, dai_sample_size);
946 time_info->stream_end_offset = ppl_reg.stream_end_offset;
947 do_div(time_info->stream_end_offset, dai_sample_size);
948
949 /*
950 * Calculate the wrap boundary need to be used for delay calculation
951 * The host counter is in bytes, it will wrap earlier than the frames
952 * based link counter.
953 */
954 time_info->boundary = div64_u64(~((u64)0),
955 frames_to_bytes(substream->runtime, 1));
956 /* Initialize the delay value to 0 (no delay) */
957 time_info->delay = 0;
958
959 return 0;
960 }
961
sof_ipc4_pcm_pointer(struct snd_soc_component * component,struct snd_pcm_substream * substream,snd_pcm_uframes_t * pointer)962 static int sof_ipc4_pcm_pointer(struct snd_soc_component *component,
963 struct snd_pcm_substream *substream,
964 snd_pcm_uframes_t *pointer)
965 {
966 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
967 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
968 struct sof_ipc4_timestamp_info *time_info;
969 struct sof_ipc4_llp_reading_slot llp;
970 snd_pcm_uframes_t head_cnt, tail_cnt;
971 struct snd_sof_pcm_stream *sps;
972 u64 dai_cnt, host_cnt, host_ptr;
973 struct snd_sof_pcm *spcm;
974 int ret;
975
976 spcm = snd_sof_find_spcm_dai(component, rtd);
977 if (!spcm)
978 return -EOPNOTSUPP;
979
980 sps = &spcm->stream[substream->stream];
981 time_info = sof_ipc4_sps_to_time_info(sps);
982 if (!time_info)
983 return -EOPNOTSUPP;
984
985 /*
986 * stream_start_offset is updated to memory window by FW based on
987 * pipeline statistics and it may be invalid if host query happens before
988 * the statistics is complete. And it will not change after the first initiailization.
989 */
990 if (time_info->stream_start_offset == SOF_IPC4_INVALID_STREAM_POSITION) {
991 ret = sof_ipc4_get_stream_start_offset(sdev, substream, sps, time_info);
992 if (ret < 0)
993 return -EOPNOTSUPP;
994 }
995
996 /* For delay calculation we need the host counter */
997 host_cnt = snd_sof_pcm_get_host_byte_counter(sdev, component, substream);
998 host_ptr = host_cnt;
999
1000 /* convert the host_cnt to frames */
1001 host_cnt = div64_u64(host_cnt, frames_to_bytes(substream->runtime, 1));
1002
1003 /*
1004 * If the LLP counter is not reported by firmware in the SRAM window
1005 * then read the dai (link) counter via host accessible means if
1006 * available.
1007 */
1008 if (!time_info->llp_offset) {
1009 dai_cnt = snd_sof_pcm_get_dai_frame_counter(sdev, component, substream);
1010 if (!dai_cnt)
1011 return -EOPNOTSUPP;
1012 } else {
1013 sof_mailbox_read(sdev, time_info->llp_offset, &llp, sizeof(llp));
1014 dai_cnt = ((u64)llp.reading.llp_u << 32) | llp.reading.llp_l;
1015 }
1016 dai_cnt += time_info->stream_end_offset;
1017
1018 /* In two cases dai dma counter is not accurate
1019 * (1) dai pipeline is started before host pipeline
1020 * (2) multiple streams mixed into one. Each stream has the same dai dma
1021 * counter
1022 *
1023 * Firmware calculates correct stream_start_offset for all cases
1024 * including above two.
1025 * Driver subtracts stream_start_offset from dai dma counter to get
1026 * accurate one
1027 */
1028
1029 /*
1030 * On stream start the dai counter might not yet have reached the
1031 * stream_start_offset value which means that no frames have left the
1032 * DSP yet from the audio stream (on playback, capture streams have
1033 * offset of 0 as we start capturing right away).
1034 * In this case we need to adjust the distance between the counters by
1035 * increasing the host counter by (offset - dai_counter).
1036 * Otherwise the dai_counter needs to be adjusted to reflect the number
1037 * of valid frames passed on the DAI side.
1038 *
1039 * The delay is the difference between the counters on the two
1040 * sides of the DSP.
1041 */
1042 if (dai_cnt < time_info->stream_start_offset) {
1043 host_cnt += time_info->stream_start_offset - dai_cnt;
1044 dai_cnt = 0;
1045 } else {
1046 dai_cnt -= time_info->stream_start_offset;
1047 }
1048
1049 /* Wrap the dai counter at the boundary where the host counter wraps */
1050 div64_u64_rem(dai_cnt, time_info->boundary, &dai_cnt);
1051
1052 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
1053 head_cnt = host_cnt;
1054 tail_cnt = dai_cnt;
1055 } else {
1056 head_cnt = dai_cnt;
1057 tail_cnt = host_cnt;
1058 }
1059
1060 if (head_cnt < tail_cnt) {
1061 time_info->delay = time_info->boundary - tail_cnt + head_cnt;
1062 goto out;
1063 }
1064
1065 time_info->delay = head_cnt - tail_cnt;
1066
1067 out:
1068 /*
1069 * Convert the host byte counter to PCM pointer which wraps in buffer
1070 * and it is in frames
1071 */
1072 div64_u64_rem(host_ptr, snd_pcm_lib_buffer_bytes(substream), &host_ptr);
1073 *pointer = bytes_to_frames(substream->runtime, host_ptr);
1074
1075 return 0;
1076 }
1077
sof_ipc4_pcm_delay(struct snd_soc_component * component,struct snd_pcm_substream * substream)1078 static snd_pcm_sframes_t sof_ipc4_pcm_delay(struct snd_soc_component *component,
1079 struct snd_pcm_substream *substream)
1080 {
1081 struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
1082 struct sof_ipc4_timestamp_info *time_info;
1083 struct snd_sof_pcm *spcm;
1084
1085 spcm = snd_sof_find_spcm_dai(component, rtd);
1086 if (!spcm)
1087 return 0;
1088
1089 time_info = sof_ipc4_sps_to_time_info(&spcm->stream[substream->stream]);
1090 /*
1091 * Report the stored delay value calculated in the pointer callback.
1092 * In the unlikely event that the calculation was skipped/aborted, the
1093 * default 0 delay returned.
1094 */
1095 if (time_info)
1096 return time_info->delay;
1097
1098 /* No delay information available, report 0 as delay */
1099 return 0;
1100
1101 }
1102
1103 const struct sof_ipc_pcm_ops ipc4_pcm_ops = {
1104 .hw_params = sof_ipc4_pcm_hw_params,
1105 .trigger = sof_ipc4_pcm_trigger,
1106 .hw_free = sof_ipc4_pcm_hw_free,
1107 .dai_link_fixup = sof_ipc4_pcm_dai_link_fixup,
1108 .pcm_setup = sof_ipc4_pcm_setup,
1109 .pcm_free = sof_ipc4_pcm_free,
1110 .pointer = sof_ipc4_pcm_pointer,
1111 .delay = sof_ipc4_pcm_delay,
1112 .ipc_first_on_start = true,
1113 .platform_stop_during_hw_free = true,
1114 };
1115