1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
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.
6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
10 // PCM Layer, interface between ALSA and IPC.
13 #include <linux/pm_runtime.h>
14 #include <sound/pcm_params.h>
15 #include <sound/sof.h>
16 #include <trace/events/sof.h>
17 #include "sof-of-dev.h"
19 #include "sof-audio.h"
20 #include "sof-utils.h"
23 /* Create DMA buffer page table for DSP */
24 static int create_page_table(struct snd_soc_component *component,
25 struct snd_pcm_substream *substream,
26 unsigned char *dma_area, size_t size)
28 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
29 struct snd_sof_pcm *spcm;
30 struct snd_dma_buffer *dmab = snd_pcm_get_dma_buf(substream);
31 int stream = substream->stream;
33 spcm = snd_sof_find_spcm_dai(component, rtd);
37 return snd_sof_create_page_table(component->dev, dmab,
38 spcm->stream[stream].page_table.area, size);
42 * sof pcm period elapse work
44 static void snd_sof_pcm_period_elapsed_work(struct work_struct *work)
46 struct snd_sof_pcm_stream *sps =
47 container_of(work, struct snd_sof_pcm_stream,
50 snd_pcm_period_elapsed(sps->substream);
53 void snd_sof_pcm_init_elapsed_work(struct work_struct *work)
55 INIT_WORK(work, snd_sof_pcm_period_elapsed_work);
59 * sof pcm period elapse, this could be called at irq thread context.
61 void snd_sof_pcm_period_elapsed(struct snd_pcm_substream *substream)
63 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
64 struct snd_soc_component *component =
65 snd_soc_rtdcom_lookup(rtd, SOF_AUDIO_PCM_DRV_NAME);
66 struct snd_sof_pcm *spcm;
68 spcm = snd_sof_find_spcm_dai(component, rtd);
70 dev_err(component->dev,
71 "error: period elapsed for unknown stream!\n");
76 * snd_pcm_period_elapsed() can be called in interrupt context
77 * before IRQ_HANDLED is returned. Inside snd_pcm_period_elapsed(),
78 * when the PCM is done draining or xrun happened, a STOP IPC will
79 * then be sent and this IPC will hit IPC timeout.
80 * To avoid sending IPC before the previous IPC is handled, we
81 * schedule delayed work here to call the snd_pcm_period_elapsed().
83 schedule_work(&spcm->stream[substream->stream].period_elapsed_work);
85 EXPORT_SYMBOL(snd_sof_pcm_period_elapsed);
88 sof_pcm_setup_connected_widgets(struct snd_sof_dev *sdev, struct snd_soc_pcm_runtime *rtd,
89 struct snd_sof_pcm *spcm, struct snd_pcm_hw_params *params,
90 struct snd_sof_platform_stream_params *platform_params, int dir)
92 struct snd_soc_dai *dai;
95 /* query DAPM for list of connected widgets and set them up */
96 for_each_rtd_cpu_dais(rtd, j, dai) {
97 struct snd_soc_dapm_widget_list *list;
99 ret = snd_soc_dapm_dai_get_connected_widgets(dai, dir, &list,
100 dpcm_end_walk_at_be);
102 dev_err(sdev->dev, "error: dai %s has no valid %s path\n", dai->name,
103 dir == SNDRV_PCM_STREAM_PLAYBACK ? "playback" : "capture");
107 spcm->stream[dir].list = list;
109 ret = sof_widget_list_setup(sdev, spcm, params, platform_params, dir);
111 dev_err(sdev->dev, "error: failed widget list set up for pcm %d dir %d\n",
112 spcm->pcm.pcm_id, dir);
113 spcm->stream[dir].list = NULL;
114 snd_soc_dapm_dai_free_widgets(&list);
122 static int sof_pcm_hw_params(struct snd_soc_component *component,
123 struct snd_pcm_substream *substream,
124 struct snd_pcm_hw_params *params)
126 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
127 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
128 const struct sof_ipc_pcm_ops *pcm_ops = sof_ipc_get_ops(sdev, pcm);
129 struct snd_sof_platform_stream_params platform_params = { 0 };
130 struct snd_pcm_runtime *runtime = substream->runtime;
131 struct snd_sof_pcm *spcm;
134 /* nothing to do for BE */
135 if (rtd->dai_link->no_pcm)
138 spcm = snd_sof_find_spcm_dai(component, rtd);
143 * Handle repeated calls to hw_params() without free_pcm() in
144 * between. At least ALSA OSS emulation depends on this.
146 if (pcm_ops && pcm_ops->hw_free && spcm->prepared[substream->stream]) {
147 ret = pcm_ops->hw_free(component, substream);
151 spcm->prepared[substream->stream] = false;
154 dev_dbg(component->dev, "pcm: hw params stream %d dir %d\n",
155 spcm->pcm.pcm_id, substream->stream);
157 ret = snd_sof_pcm_platform_hw_params(sdev, substream, params, &platform_params);
159 dev_err(component->dev, "platform hw params failed\n");
163 /* if this is a repeated hw_params without hw_free, skip setting up widgets */
164 if (!spcm->stream[substream->stream].list) {
165 ret = sof_pcm_setup_connected_widgets(sdev, rtd, spcm, params, &platform_params,
171 /* create compressed page table for audio firmware */
172 if (runtime->buffer_changed) {
173 ret = create_page_table(component, substream, runtime->dma_area,
180 if (pcm_ops && pcm_ops->hw_params) {
181 ret = pcm_ops->hw_params(component, substream, params, &platform_params);
186 spcm->prepared[substream->stream] = true;
188 /* save pcm hw_params */
189 memcpy(&spcm->params[substream->stream], params, sizeof(*params));
194 static int sof_pcm_hw_free(struct snd_soc_component *component,
195 struct snd_pcm_substream *substream)
197 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
198 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
199 const struct sof_ipc_pcm_ops *pcm_ops = sof_ipc_get_ops(sdev, pcm);
200 struct snd_sof_pcm *spcm;
203 /* nothing to do for BE */
204 if (rtd->dai_link->no_pcm)
207 spcm = snd_sof_find_spcm_dai(component, rtd);
211 dev_dbg(component->dev, "pcm: free stream %d dir %d\n",
212 spcm->pcm.pcm_id, substream->stream);
214 /* free PCM in the DSP */
215 if (pcm_ops && pcm_ops->hw_free && spcm->prepared[substream->stream]) {
216 ret = pcm_ops->hw_free(component, substream);
220 spcm->prepared[substream->stream] = false;
224 ret = snd_sof_pcm_platform_hw_free(sdev, substream);
226 dev_err(component->dev, "error: platform hw free failed\n");
230 /* free the DAPM widget list */
231 ret = sof_widget_list_free(sdev, spcm, substream->stream);
235 cancel_work_sync(&spcm->stream[substream->stream].period_elapsed_work);
240 static int sof_pcm_prepare(struct snd_soc_component *component,
241 struct snd_pcm_substream *substream)
243 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
244 struct snd_sof_pcm *spcm;
247 /* nothing to do for BE */
248 if (rtd->dai_link->no_pcm)
251 spcm = snd_sof_find_spcm_dai(component, rtd);
255 if (spcm->prepared[substream->stream])
258 dev_dbg(component->dev, "pcm: prepare stream %d dir %d\n",
259 spcm->pcm.pcm_id, substream->stream);
262 ret = sof_pcm_hw_params(component,
263 substream, &spcm->params[substream->stream]);
265 dev_err(component->dev,
266 "error: set pcm hw_params after resume\n");
274 * FE dai link trigger actions are always executed in non-atomic context because
275 * they involve IPC's.
277 static int sof_pcm_trigger(struct snd_soc_component *component,
278 struct snd_pcm_substream *substream, int cmd)
280 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
281 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
282 const struct sof_ipc_pcm_ops *pcm_ops = sof_ipc_get_ops(sdev, pcm);
283 struct snd_sof_pcm *spcm;
284 bool reset_hw_params = false;
285 bool ipc_first = false;
288 /* nothing to do for BE */
289 if (rtd->dai_link->no_pcm)
292 spcm = snd_sof_find_spcm_dai(component, rtd);
296 dev_dbg(component->dev, "pcm: trigger stream %d dir %d cmd %d\n",
297 spcm->pcm.pcm_id, substream->stream, cmd);
300 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
303 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
305 case SNDRV_PCM_TRIGGER_START:
306 if (spcm->stream[substream->stream].suspend_ignored) {
308 * This case will be triggered when INFO_RESUME is
309 * not supported, no need to re-start streams that
310 * remained enabled in D0ix.
312 spcm->stream[substream->stream].suspend_ignored = false;
316 case SNDRV_PCM_TRIGGER_SUSPEND:
317 if (sdev->system_suspend_target == SOF_SUSPEND_S0IX &&
318 spcm->stream[substream->stream].d0i3_compatible) {
320 * trap the event, not sending trigger stop to
321 * prevent the FW pipelines from being stopped,
322 * and mark the flag to ignore the upcoming DAPM
325 spcm->stream[substream->stream].suspend_ignored = true;
329 case SNDRV_PCM_TRIGGER_STOP:
331 reset_hw_params = true;
334 dev_err(component->dev, "Unhandled trigger cmd %d\n", cmd);
339 * DMA and IPC sequence is different for start and stop. Need to send
340 * STOP IPC before stop DMA
343 snd_sof_pcm_platform_trigger(sdev, substream, cmd);
345 if (pcm_ops && pcm_ops->trigger)
346 ret = pcm_ops->trigger(component, substream, cmd);
348 /* need to STOP DMA even if trigger IPC failed */
350 snd_sof_pcm_platform_trigger(sdev, substream, cmd);
352 /* free PCM if reset_hw_params is set and the STOP IPC is successful */
353 if (!ret && reset_hw_params)
354 ret = sof_pcm_stream_free(sdev, substream, spcm, substream->stream, false);
359 static snd_pcm_uframes_t sof_pcm_pointer(struct snd_soc_component *component,
360 struct snd_pcm_substream *substream)
362 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
363 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
364 struct snd_sof_pcm *spcm;
365 snd_pcm_uframes_t host, dai;
367 /* nothing to do for BE */
368 if (rtd->dai_link->no_pcm)
371 /* use dsp ops pointer callback directly if set */
372 if (sof_ops(sdev)->pcm_pointer)
373 return sof_ops(sdev)->pcm_pointer(sdev, substream);
375 spcm = snd_sof_find_spcm_dai(component, rtd);
379 /* read position from DSP */
380 host = bytes_to_frames(substream->runtime,
381 spcm->stream[substream->stream].posn.host_posn);
382 dai = bytes_to_frames(substream->runtime,
383 spcm->stream[substream->stream].posn.dai_posn);
385 trace_sof_pcm_pointer_position(sdev, spcm, substream, host, dai);
390 static int sof_pcm_open(struct snd_soc_component *component,
391 struct snd_pcm_substream *substream)
393 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
394 struct snd_pcm_runtime *runtime = substream->runtime;
395 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
396 struct snd_sof_dsp_ops *ops = sof_ops(sdev);
397 struct snd_sof_pcm *spcm;
398 struct snd_soc_tplg_stream_caps *caps;
401 /* nothing to do for BE */
402 if (rtd->dai_link->no_pcm)
405 spcm = snd_sof_find_spcm_dai(component, rtd);
409 dev_dbg(component->dev, "pcm: open stream %d dir %d\n",
410 spcm->pcm.pcm_id, substream->stream);
413 caps = &spcm->pcm.caps[substream->stream];
415 /* set runtime config */
416 runtime->hw.info = ops->hw_info; /* platform-specific */
418 /* set any runtime constraints based on topology */
419 runtime->hw.formats = le64_to_cpu(caps->formats);
420 runtime->hw.period_bytes_min = le32_to_cpu(caps->period_size_min);
421 runtime->hw.period_bytes_max = le32_to_cpu(caps->period_size_max);
422 runtime->hw.periods_min = le32_to_cpu(caps->periods_min);
423 runtime->hw.periods_max = le32_to_cpu(caps->periods_max);
426 * caps->buffer_size_min is not used since the
427 * snd_pcm_hardware structure only defines buffer_bytes_max
429 runtime->hw.buffer_bytes_max = le32_to_cpu(caps->buffer_size_max);
431 dev_dbg(component->dev, "period min %zd max %zd bytes\n",
432 runtime->hw.period_bytes_min,
433 runtime->hw.period_bytes_max);
434 dev_dbg(component->dev, "period count %d max %d\n",
435 runtime->hw.periods_min,
436 runtime->hw.periods_max);
437 dev_dbg(component->dev, "buffer max %zd bytes\n",
438 runtime->hw.buffer_bytes_max);
440 /* set wait time - TODO: come from topology */
441 substream->wait_time = 500;
443 spcm->stream[substream->stream].posn.host_posn = 0;
444 spcm->stream[substream->stream].posn.dai_posn = 0;
445 spcm->stream[substream->stream].substream = substream;
446 spcm->prepared[substream->stream] = false;
448 ret = snd_sof_pcm_platform_open(sdev, substream);
450 dev_err(component->dev, "error: pcm open failed %d\n", ret);
455 static int sof_pcm_close(struct snd_soc_component *component,
456 struct snd_pcm_substream *substream)
458 struct snd_soc_pcm_runtime *rtd = asoc_substream_to_rtd(substream);
459 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
460 struct snd_sof_pcm *spcm;
463 /* nothing to do for BE */
464 if (rtd->dai_link->no_pcm)
467 spcm = snd_sof_find_spcm_dai(component, rtd);
471 dev_dbg(component->dev, "pcm: close stream %d dir %d\n",
472 spcm->pcm.pcm_id, substream->stream);
474 err = snd_sof_pcm_platform_close(sdev, substream);
476 dev_err(component->dev, "error: pcm close failed %d\n",
479 * keep going, no point in preventing the close
488 * Pre-allocate playback/capture audio buffer pages.
489 * no need to explicitly release memory preallocated by sof_pcm_new in pcm_free
490 * snd_pcm_lib_preallocate_free_for_all() is called by the core.
492 static int sof_pcm_new(struct snd_soc_component *component,
493 struct snd_soc_pcm_runtime *rtd)
495 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
496 struct snd_sof_pcm *spcm;
497 struct snd_pcm *pcm = rtd->pcm;
498 struct snd_soc_tplg_stream_caps *caps;
499 int stream = SNDRV_PCM_STREAM_PLAYBACK;
501 /* find SOF PCM for this RTD */
502 spcm = snd_sof_find_spcm_dai(component, rtd);
504 dev_warn(component->dev, "warn: can't find PCM with DAI ID %d\n",
509 dev_dbg(component->dev, "creating new PCM %s\n", spcm->pcm.pcm_name);
511 /* do we need to pre-allocate playback audio buffer pages */
512 if (!spcm->pcm.playback)
515 caps = &spcm->pcm.caps[stream];
517 /* pre-allocate playback audio buffer pages */
518 dev_dbg(component->dev,
519 "spcm: allocate %s playback DMA buffer size 0x%x max 0x%x\n",
520 caps->name, caps->buffer_size_min, caps->buffer_size_max);
522 if (!pcm->streams[stream].substream) {
523 dev_err(component->dev, "error: NULL playback substream!\n");
527 snd_pcm_set_managed_buffer(pcm->streams[stream].substream,
528 SNDRV_DMA_TYPE_DEV_SG, sdev->dev,
529 0, le32_to_cpu(caps->buffer_size_max));
531 stream = SNDRV_PCM_STREAM_CAPTURE;
533 /* do we need to pre-allocate capture audio buffer pages */
534 if (!spcm->pcm.capture)
537 caps = &spcm->pcm.caps[stream];
539 /* pre-allocate capture audio buffer pages */
540 dev_dbg(component->dev,
541 "spcm: allocate %s capture DMA buffer size 0x%x max 0x%x\n",
542 caps->name, caps->buffer_size_min, caps->buffer_size_max);
544 if (!pcm->streams[stream].substream) {
545 dev_err(component->dev, "error: NULL capture substream!\n");
549 snd_pcm_set_managed_buffer(pcm->streams[stream].substream,
550 SNDRV_DMA_TYPE_DEV_SG, sdev->dev,
551 0, le32_to_cpu(caps->buffer_size_max));
556 /* fixup the BE DAI link to match any values from topology */
557 int sof_pcm_dai_link_fixup(struct snd_soc_pcm_runtime *rtd, struct snd_pcm_hw_params *params)
559 struct snd_interval *rate = hw_param_interval(params,
560 SNDRV_PCM_HW_PARAM_RATE);
561 struct snd_interval *channels = hw_param_interval(params,
562 SNDRV_PCM_HW_PARAM_CHANNELS);
563 struct snd_mask *fmt = hw_param_mask(params, SNDRV_PCM_HW_PARAM_FORMAT);
564 struct snd_soc_component *component =
565 snd_soc_rtdcom_lookup(rtd, SOF_AUDIO_PCM_DRV_NAME);
566 struct snd_sof_dai *dai =
567 snd_sof_find_dai(component, (char *)rtd->dai_link->name);
568 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
569 const struct sof_ipc_pcm_ops *pcm_ops = sof_ipc_get_ops(sdev, pcm);
571 /* no topology exists for this BE, try a common configuration */
573 dev_warn(component->dev,
574 "warning: no topology found for BE DAI %s config\n",
575 rtd->dai_link->name);
577 /* set 48k, stereo, 16bits by default */
585 snd_mask_set_format(fmt, SNDRV_PCM_FORMAT_S16_LE);
590 if (pcm_ops && pcm_ops->dai_link_fixup)
591 return pcm_ops->dai_link_fixup(rtd, params);
595 EXPORT_SYMBOL(sof_pcm_dai_link_fixup);
597 static int sof_pcm_probe(struct snd_soc_component *component)
599 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
600 struct snd_sof_pdata *plat_data = sdev->pdata;
601 const char *tplg_filename;
605 * make sure the device is pm_runtime_active before loading the
606 * topology and initiating IPC or bus transactions
608 ret = pm_runtime_resume_and_get(component->dev);
609 if (ret < 0 && ret != -EACCES)
612 /* load the default topology */
613 sdev->component = component;
615 tplg_filename = devm_kasprintf(sdev->dev, GFP_KERNEL,
617 plat_data->tplg_filename_prefix,
618 plat_data->tplg_filename);
622 ret = snd_sof_load_topology(component, tplg_filename);
624 dev_err(component->dev, "error: failed to load DSP topology %d\n",
629 pm_runtime_mark_last_busy(component->dev);
630 pm_runtime_put_autosuspend(component->dev);
635 static void sof_pcm_remove(struct snd_soc_component *component)
637 /* remove topology */
638 snd_soc_tplg_component_remove(component);
641 static int sof_pcm_ack(struct snd_soc_component *component,
642 struct snd_pcm_substream *substream)
644 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
646 return snd_sof_pcm_platform_ack(sdev, substream);
649 static snd_pcm_sframes_t sof_pcm_delay(struct snd_soc_component *component,
650 struct snd_pcm_substream *substream)
652 struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(component);
653 const struct sof_ipc_pcm_ops *pcm_ops = sof_ipc_get_ops(sdev, pcm);
655 if (pcm_ops && pcm_ops->delay)
656 return pcm_ops->delay(component, substream);
661 void snd_sof_new_platform_drv(struct snd_sof_dev *sdev)
663 struct snd_soc_component_driver *pd = &sdev->plat_drv;
664 struct snd_sof_pdata *plat_data = sdev->pdata;
665 const char *drv_name;
667 if (plat_data->machine)
668 drv_name = plat_data->machine->drv_name;
669 else if (plat_data->of_machine)
670 drv_name = plat_data->of_machine->drv_name;
674 pd->name = "sof-audio-component";
675 pd->probe = sof_pcm_probe;
676 pd->remove = sof_pcm_remove;
677 pd->open = sof_pcm_open;
678 pd->close = sof_pcm_close;
679 pd->hw_params = sof_pcm_hw_params;
680 pd->prepare = sof_pcm_prepare;
681 pd->hw_free = sof_pcm_hw_free;
682 pd->trigger = sof_pcm_trigger;
683 pd->pointer = sof_pcm_pointer;
684 pd->ack = sof_pcm_ack;
685 pd->delay = sof_pcm_delay;
687 #if IS_ENABLED(CONFIG_SND_SOC_SOF_COMPRESS)
688 pd->compress_ops = &sof_compressed_ops;
691 pd->pcm_construct = sof_pcm_new;
692 pd->ignore_machine = drv_name;
693 pd->be_hw_params_fixup = sof_pcm_dai_link_fixup;
694 pd->be_pcm_base = SOF_BE_PCM_BASE;
695 pd->use_dai_pcm_id = true;
696 pd->topology_name_prefix = "sof";
698 /* increment module refcount when a pcm is opened */
699 pd->module_get_upon_open = 1;
701 pd->legacy_dai_naming = 1;