1 // SPDX-License-Identifier: GPL-2.0+
3 // soc-compress.c -- ALSA SoC Compress
5 // Copyright (C) 2012 Intel Corp.
7 // Authors: Namarta Kohli <namartax.kohli@intel.com>
8 // Ramesh Babu K V <ramesh.babu@linux.intel.com>
9 // Vinod Koul <vinod.koul@linux.intel.com>
11 #include <linux/kernel.h>
12 #include <linux/init.h>
13 #include <linux/delay.h>
14 #include <linux/slab.h>
15 #include <linux/workqueue.h>
16 #include <sound/core.h>
17 #include <sound/compress_params.h>
18 #include <sound/compress_driver.h>
19 #include <sound/soc.h>
20 #include <sound/initval.h>
21 #include <sound/soc-dpcm.h>
22 #include <sound/soc-link.h>
24 static int snd_soc_compr_components_open(struct snd_compr_stream *cstream)
26 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
27 struct snd_soc_component *component;
31 for_each_rtd_components(rtd, i, component) {
32 ret = snd_soc_component_module_get_when_open(component, cstream);
36 ret = snd_soc_component_compr_open(component, cstream);
44 static void snd_soc_compr_components_free(struct snd_compr_stream *cstream,
47 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
48 struct snd_soc_component *component;
51 for_each_rtd_components(rtd, i, component) {
52 snd_soc_component_compr_free(component, cstream, rollback);
53 snd_soc_component_module_put_when_close(component, cstream, rollback);
57 static int soc_compr_clean(struct snd_compr_stream *cstream, int rollback)
59 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
60 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
61 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
62 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
64 snd_soc_dpcm_mutex_lock(rtd);
67 snd_soc_runtime_deactivate(rtd, stream);
69 snd_soc_dai_digital_mute(codec_dai, 1, stream);
71 if (!snd_soc_dai_active(cpu_dai))
74 if (!snd_soc_dai_active(codec_dai))
77 snd_soc_link_compr_shutdown(cstream, rollback);
79 snd_soc_compr_components_free(cstream, rollback);
81 snd_soc_dai_compr_shutdown(cpu_dai, cstream, rollback);
84 snd_soc_dapm_stream_stop(rtd, stream);
86 snd_soc_dpcm_mutex_unlock(rtd);
88 snd_soc_pcm_component_pm_runtime_put(rtd, cstream, rollback);
93 static int soc_compr_free(struct snd_compr_stream *cstream)
95 return soc_compr_clean(cstream, 0);
98 static int soc_compr_open(struct snd_compr_stream *cstream)
100 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
101 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
102 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
105 ret = snd_soc_pcm_component_pm_runtime_get(rtd, cstream);
109 snd_soc_dpcm_mutex_lock(rtd);
111 ret = snd_soc_dai_compr_startup(cpu_dai, cstream);
115 ret = snd_soc_compr_components_open(cstream);
119 ret = snd_soc_link_compr_startup(cstream);
123 snd_soc_runtime_activate(rtd, stream);
125 snd_soc_dpcm_mutex_unlock(rtd);
128 soc_compr_clean(cstream, 1);
133 static int soc_compr_open_fe(struct snd_compr_stream *cstream)
135 struct snd_soc_pcm_runtime *fe = cstream->private_data;
136 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(fe, 0);
137 struct snd_soc_dpcm *dpcm;
138 struct snd_soc_dapm_widget_list *list;
139 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
142 snd_soc_card_mutex_lock(fe->card);
144 ret = dpcm_path_get(fe, stream, &list);
148 snd_soc_dpcm_mutex_lock(fe);
150 /* calculate valid and active FE <-> BE dpcms */
151 dpcm_process_paths(fe, stream, &list, 1);
153 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
155 ret = dpcm_be_dai_startup(fe, stream);
157 /* clean up all links */
158 for_each_dpcm_be(fe, stream, dpcm)
159 dpcm->state = SND_SOC_DPCM_LINK_STATE_FREE;
161 dpcm_be_disconnect(fe, stream);
165 ret = snd_soc_dai_compr_startup(cpu_dai, cstream);
169 ret = snd_soc_compr_components_open(cstream);
173 ret = snd_soc_link_compr_startup(cstream);
177 dpcm_clear_pending_state(fe, stream);
178 dpcm_path_put(&list);
180 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_OPEN;
181 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
183 snd_soc_runtime_activate(fe, stream);
184 snd_soc_dpcm_mutex_unlock(fe);
186 snd_soc_card_mutex_unlock(fe->card);
191 snd_soc_compr_components_free(cstream, 1);
193 snd_soc_dai_compr_shutdown(cpu_dai, cstream, 1);
195 dpcm_path_put(&list);
196 snd_soc_dpcm_mutex_unlock(fe);
198 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
199 snd_soc_card_mutex_unlock(fe->card);
203 static int soc_compr_free_fe(struct snd_compr_stream *cstream)
205 struct snd_soc_pcm_runtime *fe = cstream->private_data;
206 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(fe, 0);
207 struct snd_soc_dpcm *dpcm;
208 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
210 snd_soc_card_mutex_lock(fe->card);
212 snd_soc_dpcm_mutex_lock(fe);
213 snd_soc_runtime_deactivate(fe, stream);
215 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
217 dpcm_be_dai_hw_free(fe, stream);
219 dpcm_be_dai_shutdown(fe, stream);
221 /* mark FE's links ready to prune */
222 for_each_dpcm_be(fe, stream, dpcm)
223 dpcm->state = SND_SOC_DPCM_LINK_STATE_FREE;
225 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_STOP);
227 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_CLOSE;
228 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
230 dpcm_be_disconnect(fe, stream);
232 snd_soc_dpcm_mutex_unlock(fe);
234 snd_soc_link_compr_shutdown(cstream, 0);
236 snd_soc_compr_components_free(cstream, 0);
238 snd_soc_dai_compr_shutdown(cpu_dai, cstream, 0);
240 snd_soc_card_mutex_unlock(fe->card);
244 static int soc_compr_trigger(struct snd_compr_stream *cstream, int cmd)
246 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
247 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
248 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
249 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
252 snd_soc_dpcm_mutex_lock(rtd);
254 ret = snd_soc_component_compr_trigger(cstream, cmd);
258 ret = snd_soc_dai_compr_trigger(cpu_dai, cstream, cmd);
263 case SNDRV_PCM_TRIGGER_START:
264 snd_soc_dai_digital_mute(codec_dai, 0, stream);
266 case SNDRV_PCM_TRIGGER_STOP:
267 snd_soc_dai_digital_mute(codec_dai, 1, stream);
272 snd_soc_dpcm_mutex_unlock(rtd);
276 static int soc_compr_trigger_fe(struct snd_compr_stream *cstream, int cmd)
278 struct snd_soc_pcm_runtime *fe = cstream->private_data;
279 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(fe, 0);
280 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
283 if (cmd == SND_COMPR_TRIGGER_PARTIAL_DRAIN ||
284 cmd == SND_COMPR_TRIGGER_DRAIN)
285 return snd_soc_component_compr_trigger(cstream, cmd);
287 snd_soc_card_mutex_lock(fe->card);
289 ret = snd_soc_dai_compr_trigger(cpu_dai, cstream, cmd);
293 ret = snd_soc_component_compr_trigger(cstream, cmd);
297 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
299 ret = dpcm_be_dai_trigger(fe, stream, cmd);
302 case SNDRV_PCM_TRIGGER_START:
303 case SNDRV_PCM_TRIGGER_RESUME:
304 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
305 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_START;
307 case SNDRV_PCM_TRIGGER_STOP:
308 case SNDRV_PCM_TRIGGER_SUSPEND:
309 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_STOP;
311 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
312 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_PAUSED;
317 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
318 snd_soc_card_mutex_unlock(fe->card);
322 static int soc_compr_set_params(struct snd_compr_stream *cstream,
323 struct snd_compr_params *params)
325 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
326 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
327 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
330 snd_soc_dpcm_mutex_lock(rtd);
333 * First we call set_params for the CPU DAI, then the component
334 * driver this should configure the SoC side. If the machine has
335 * compressed ops then we call that as well. The expectation is
336 * that these callbacks will configure everything for this compress
337 * path, like configuring a PCM port for a CODEC.
339 ret = snd_soc_dai_compr_set_params(cpu_dai, cstream, params);
343 ret = snd_soc_component_compr_set_params(cstream, params);
347 ret = snd_soc_link_compr_set_params(cstream);
351 snd_soc_dapm_stream_event(rtd, stream, SND_SOC_DAPM_STREAM_START);
353 /* cancel any delayed stream shutdown that is pending */
355 snd_soc_dpcm_mutex_unlock(rtd);
357 cancel_delayed_work_sync(&rtd->delayed_work);
362 snd_soc_dpcm_mutex_unlock(rtd);
366 static int soc_compr_set_params_fe(struct snd_compr_stream *cstream,
367 struct snd_compr_params *params)
369 struct snd_soc_pcm_runtime *fe = cstream->private_data;
370 struct snd_pcm_substream *fe_substream =
371 fe->pcm->streams[cstream->direction].substream;
372 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(fe, 0);
373 int stream = cstream->direction; /* SND_COMPRESS_xxx is same as SNDRV_PCM_STREAM_xxx */
376 snd_soc_card_mutex_lock(fe->card);
379 * Create an empty hw_params for the BE as the machine driver must
380 * fix this up to match DSP decoder and ASRC configuration.
381 * I.e. machine driver fixup for compressed BE is mandatory.
383 memset(&fe->dpcm[fe_substream->stream].hw_params, 0,
384 sizeof(struct snd_pcm_hw_params));
386 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
388 ret = dpcm_be_dai_hw_params(fe, stream);
392 ret = dpcm_be_dai_prepare(fe, stream);
396 ret = snd_soc_dai_compr_set_params(cpu_dai, cstream, params);
400 ret = snd_soc_component_compr_set_params(cstream, params);
404 ret = snd_soc_link_compr_set_params(cstream);
407 snd_soc_dpcm_mutex_lock(fe);
408 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_START);
409 snd_soc_dpcm_mutex_unlock(fe);
410 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_PREPARE;
413 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
414 snd_soc_card_mutex_unlock(fe->card);
418 static int soc_compr_get_params(struct snd_compr_stream *cstream,
419 struct snd_codec *params)
421 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
422 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
425 snd_soc_dpcm_mutex_lock(rtd);
427 ret = snd_soc_dai_compr_get_params(cpu_dai, cstream, params);
431 ret = snd_soc_component_compr_get_params(cstream, params);
433 snd_soc_dpcm_mutex_unlock(rtd);
437 static int soc_compr_ack(struct snd_compr_stream *cstream, size_t bytes)
439 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
440 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
443 snd_soc_dpcm_mutex_lock(rtd);
445 ret = snd_soc_dai_compr_ack(cpu_dai, cstream, bytes);
449 ret = snd_soc_component_compr_ack(cstream, bytes);
451 snd_soc_dpcm_mutex_unlock(rtd);
455 static int soc_compr_pointer(struct snd_compr_stream *cstream,
456 struct snd_compr_tstamp *tstamp)
458 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
460 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
462 snd_soc_dpcm_mutex_lock(rtd);
464 ret = snd_soc_dai_compr_pointer(cpu_dai, cstream, tstamp);
468 ret = snd_soc_component_compr_pointer(cstream, tstamp);
470 snd_soc_dpcm_mutex_unlock(rtd);
474 static int soc_compr_set_metadata(struct snd_compr_stream *cstream,
475 struct snd_compr_metadata *metadata)
477 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
478 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
481 ret = snd_soc_dai_compr_set_metadata(cpu_dai, cstream, metadata);
485 return snd_soc_component_compr_set_metadata(cstream, metadata);
488 static int soc_compr_get_metadata(struct snd_compr_stream *cstream,
489 struct snd_compr_metadata *metadata)
491 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
492 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
495 ret = snd_soc_dai_compr_get_metadata(cpu_dai, cstream, metadata);
499 return snd_soc_component_compr_get_metadata(cstream, metadata);
502 /* ASoC Compress operations */
503 static struct snd_compr_ops soc_compr_ops = {
504 .open = soc_compr_open,
505 .free = soc_compr_free,
506 .set_params = soc_compr_set_params,
507 .set_metadata = soc_compr_set_metadata,
508 .get_metadata = soc_compr_get_metadata,
509 .get_params = soc_compr_get_params,
510 .trigger = soc_compr_trigger,
511 .pointer = soc_compr_pointer,
512 .ack = soc_compr_ack,
513 .get_caps = snd_soc_component_compr_get_caps,
514 .get_codec_caps = snd_soc_component_compr_get_codec_caps,
517 /* ASoC Dynamic Compress operations */
518 static struct snd_compr_ops soc_compr_dyn_ops = {
519 .open = soc_compr_open_fe,
520 .free = soc_compr_free_fe,
521 .set_params = soc_compr_set_params_fe,
522 .get_params = soc_compr_get_params,
523 .set_metadata = soc_compr_set_metadata,
524 .get_metadata = soc_compr_get_metadata,
525 .trigger = soc_compr_trigger_fe,
526 .pointer = soc_compr_pointer,
527 .ack = soc_compr_ack,
528 .get_caps = snd_soc_component_compr_get_caps,
529 .get_codec_caps = snd_soc_component_compr_get_codec_caps,
533 * snd_soc_new_compress - create a new compress.
535 * @rtd: The runtime for which we will create compress
536 * @num: the device index number (zero based - shared with normal PCMs)
538 * Return: 0 for success, else error.
540 int snd_soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
542 struct snd_soc_component *component;
543 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
544 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
545 struct snd_compr *compr;
546 struct snd_pcm *be_pcm;
548 int ret = 0, direction = 0;
549 int playback = 0, capture = 0;
553 * make sure these are same value,
554 * and then use these as equally
556 BUILD_BUG_ON((int)SNDRV_PCM_STREAM_PLAYBACK != (int)SND_COMPRESS_PLAYBACK);
557 BUILD_BUG_ON((int)SNDRV_PCM_STREAM_CAPTURE != (int)SND_COMPRESS_CAPTURE);
559 if (rtd->dai_link->num_cpus > 1 ||
560 rtd->dai_link->num_codecs > 1) {
561 dev_err(rtd->card->dev,
562 "Compress ASoC: Multi CPU/Codec not supported\n");
567 dev_err(rtd->card->dev, "Missing codec\n");
571 /* check client and interface hw capabilities */
572 if (snd_soc_dai_stream_valid(codec_dai, SNDRV_PCM_STREAM_PLAYBACK) &&
573 snd_soc_dai_stream_valid(cpu_dai, SNDRV_PCM_STREAM_PLAYBACK))
575 if (snd_soc_dai_stream_valid(codec_dai, SNDRV_PCM_STREAM_CAPTURE) &&
576 snd_soc_dai_stream_valid(cpu_dai, SNDRV_PCM_STREAM_CAPTURE))
580 * Compress devices are unidirectional so only one of the directions
581 * should be set, check for that (xor)
583 if (playback + capture != 1) {
584 dev_err(rtd->card->dev,
585 "Compress ASoC: Invalid direction for P %d, C %d\n",
591 direction = SND_COMPRESS_PLAYBACK;
593 direction = SND_COMPRESS_CAPTURE;
595 compr = devm_kzalloc(rtd->card->dev, sizeof(*compr), GFP_KERNEL);
599 compr->ops = devm_kzalloc(rtd->card->dev, sizeof(soc_compr_ops),
604 if (rtd->dai_link->dynamic) {
605 snprintf(new_name, sizeof(new_name), "(%s)",
606 rtd->dai_link->stream_name);
608 ret = snd_pcm_new_internal(rtd->card->snd_card, new_name, num,
609 rtd->dai_link->dpcm_playback,
610 rtd->dai_link->dpcm_capture, &be_pcm);
612 dev_err(rtd->card->dev,
613 "Compress ASoC: can't create compressed for %s: %d\n",
614 rtd->dai_link->name, ret);
618 /* inherit atomicity from DAI link */
619 be_pcm->nonatomic = rtd->dai_link->nonatomic;
623 if (rtd->dai_link->dpcm_playback)
624 be_pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream->private_data = rtd;
625 if (rtd->dai_link->dpcm_capture)
626 be_pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream->private_data = rtd;
627 memcpy(compr->ops, &soc_compr_dyn_ops, sizeof(soc_compr_dyn_ops));
629 snprintf(new_name, sizeof(new_name), "%s %s-%d",
630 rtd->dai_link->stream_name, codec_dai->name, num);
632 memcpy(compr->ops, &soc_compr_ops, sizeof(soc_compr_ops));
635 for_each_rtd_components(rtd, i, component) {
636 if (!component->driver->compress_ops ||
637 !component->driver->compress_ops->copy)
640 compr->ops->copy = snd_soc_component_compr_copy;
644 ret = snd_compress_new(rtd->card->snd_card, num, direction,
647 component = asoc_rtd_to_codec(rtd, 0)->component;
648 dev_err(component->dev,
649 "Compress ASoC: can't create compress for codec %s: %d\n",
650 component->name, ret);
654 /* DAPM dai link stream work */
655 rtd->close_delayed_work_func = snd_soc_close_delayed_work;
658 compr->private_data = rtd;
660 dev_dbg(rtd->card->dev, "Compress ASoC: %s <-> %s mapping ok\n",
661 codec_dai->name, cpu_dai->name);
665 EXPORT_SYMBOL_GPL(snd_soc_new_compress);