2 * soc-compress.c -- ALSA SoC Compress
4 * Copyright (C) 2012 Intel Corp.
6 * Authors: Namarta Kohli <namartax.kohli@intel.com>
7 * Ramesh Babu K V <ramesh.babu@linux.intel.com>
8 * Vinod Koul <vinod.koul@linux.intel.com>
10 * This program is free software; you can redistribute it and/or modify it
11 * under the terms of the GNU General Public License as published by the
12 * Free Software Foundation; either version 2 of the License, or (at your
13 * option) any later version.
17 #include <linux/kernel.h>
18 #include <linux/init.h>
19 #include <linux/delay.h>
20 #include <linux/slab.h>
21 #include <linux/workqueue.h>
22 #include <sound/core.h>
23 #include <sound/compress_params.h>
24 #include <sound/compress_driver.h>
25 #include <sound/soc.h>
26 #include <sound/initval.h>
27 #include <sound/soc-dpcm.h>
29 static int soc_compr_open(struct snd_compr_stream *cstream)
31 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
32 struct snd_soc_platform *platform = rtd->platform;
35 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
37 if (platform->driver->compr_ops && platform->driver->compr_ops->open) {
38 ret = platform->driver->compr_ops->open(cstream);
40 pr_err("compress asoc: can't open platform %s\n",
41 platform->component.name);
46 if (rtd->dai_link->compr_ops && rtd->dai_link->compr_ops->startup) {
47 ret = rtd->dai_link->compr_ops->startup(cstream);
49 pr_err("compress asoc: %s startup failed\n", rtd->dai_link->name);
54 snd_soc_runtime_activate(rtd, cstream->direction);
56 mutex_unlock(&rtd->pcm_mutex);
61 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
62 platform->driver->compr_ops->free(cstream);
64 mutex_unlock(&rtd->pcm_mutex);
68 static int soc_compr_open_fe(struct snd_compr_stream *cstream)
70 struct snd_soc_pcm_runtime *fe = cstream->private_data;
71 struct snd_pcm_substream *fe_substream = fe->pcm->streams[0].substream;
72 struct snd_soc_platform *platform = fe->platform;
73 struct snd_soc_dpcm *dpcm;
74 struct snd_soc_dapm_widget_list *list;
78 if (cstream->direction == SND_COMPRESS_PLAYBACK)
79 stream = SNDRV_PCM_STREAM_PLAYBACK;
81 stream = SNDRV_PCM_STREAM_CAPTURE;
83 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
85 if (platform->driver->compr_ops && platform->driver->compr_ops->open) {
86 ret = platform->driver->compr_ops->open(cstream);
88 pr_err("compress asoc: can't open platform %s\n",
89 platform->component.name);
94 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->startup) {
95 ret = fe->dai_link->compr_ops->startup(cstream);
97 pr_err("compress asoc: %s startup failed\n", fe->dai_link->name);
102 fe->dpcm[stream].runtime = fe_substream->runtime;
104 ret = dpcm_path_get(fe, stream, &list);
108 dev_dbg(fe->dev, "ASoC: %s no valid %s route\n",
109 fe->dai_link->name, stream ? "capture" : "playback");
111 /* calculate valid and active FE <-> BE dpcms */
112 dpcm_process_paths(fe, stream, &list, 1);
114 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
116 ret = dpcm_be_dai_startup(fe, stream);
118 /* clean up all links */
119 list_for_each_entry(dpcm, &fe->dpcm[stream].be_clients, list_be)
120 dpcm->state = SND_SOC_DPCM_LINK_STATE_FREE;
122 dpcm_be_disconnect(fe, stream);
123 fe->dpcm[stream].runtime = NULL;
127 dpcm_clear_pending_state(fe, stream);
128 dpcm_path_put(&list);
130 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_OPEN;
131 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
133 snd_soc_runtime_activate(fe, stream);
135 mutex_unlock(&fe->card->mutex);
140 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->shutdown)
141 fe->dai_link->compr_ops->shutdown(cstream);
143 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
144 platform->driver->compr_ops->free(cstream);
146 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
147 mutex_unlock(&fe->card->mutex);
152 * Power down the audio subsystem pmdown_time msecs after close is called.
153 * This is to ensure there are no pops or clicks in between any music tracks
154 * due to DAPM power cycling.
156 static void close_delayed_work(struct work_struct *work)
158 struct snd_soc_pcm_runtime *rtd =
159 container_of(work, struct snd_soc_pcm_runtime, delayed_work.work);
160 struct snd_soc_dai *codec_dai = rtd->codec_dai;
162 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
164 dev_dbg(rtd->dev, "ASoC: pop wq checking: %s status: %s waiting: %s\n",
165 codec_dai->driver->playback.stream_name,
166 codec_dai->playback_active ? "active" : "inactive",
167 rtd->pop_wait ? "yes" : "no");
169 /* are we waiting on this codec DAI stream */
170 if (rtd->pop_wait == 1) {
172 snd_soc_dapm_stream_event(rtd, SNDRV_PCM_STREAM_PLAYBACK,
173 SND_SOC_DAPM_STREAM_STOP);
176 mutex_unlock(&rtd->pcm_mutex);
179 static int soc_compr_free(struct snd_compr_stream *cstream)
181 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
182 struct snd_soc_platform *platform = rtd->platform;
183 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
184 struct snd_soc_dai *codec_dai = rtd->codec_dai;
187 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
189 if (cstream->direction == SND_COMPRESS_PLAYBACK)
190 stream = SNDRV_PCM_STREAM_PLAYBACK;
192 stream = SNDRV_PCM_STREAM_CAPTURE;
194 snd_soc_runtime_deactivate(rtd, stream);
196 snd_soc_dai_digital_mute(codec_dai, 1, cstream->direction);
198 if (!cpu_dai->active)
201 if (!codec_dai->active)
205 if (rtd->dai_link->compr_ops && rtd->dai_link->compr_ops->shutdown)
206 rtd->dai_link->compr_ops->shutdown(cstream);
208 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
209 platform->driver->compr_ops->free(cstream);
211 if (cstream->direction == SND_COMPRESS_PLAYBACK) {
212 if (snd_soc_runtime_ignore_pmdown_time(rtd)) {
213 snd_soc_dapm_stream_event(rtd,
214 SNDRV_PCM_STREAM_PLAYBACK,
215 SND_SOC_DAPM_STREAM_STOP);
218 queue_delayed_work(system_power_efficient_wq,
220 msecs_to_jiffies(rtd->pmdown_time));
223 /* capture streams can be powered down now */
224 snd_soc_dapm_stream_event(rtd,
225 SNDRV_PCM_STREAM_CAPTURE,
226 SND_SOC_DAPM_STREAM_STOP);
229 mutex_unlock(&rtd->pcm_mutex);
233 static int soc_compr_free_fe(struct snd_compr_stream *cstream)
235 struct snd_soc_pcm_runtime *fe = cstream->private_data;
236 struct snd_soc_platform *platform = fe->platform;
237 struct snd_soc_dpcm *dpcm;
240 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
242 if (cstream->direction == SND_COMPRESS_PLAYBACK)
243 stream = SNDRV_PCM_STREAM_PLAYBACK;
245 stream = SNDRV_PCM_STREAM_CAPTURE;
247 snd_soc_runtime_deactivate(fe, stream);
249 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
251 ret = dpcm_be_dai_hw_free(fe, stream);
253 dev_err(fe->dev, "compressed hw_free failed %d\n", ret);
255 ret = dpcm_be_dai_shutdown(fe, stream);
257 /* mark FE's links ready to prune */
258 list_for_each_entry(dpcm, &fe->dpcm[stream].be_clients, list_be)
259 dpcm->state = SND_SOC_DPCM_LINK_STATE_FREE;
261 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_STOP);
263 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_CLOSE;
264 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
266 dpcm_be_disconnect(fe, stream);
268 fe->dpcm[stream].runtime = NULL;
270 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->shutdown)
271 fe->dai_link->compr_ops->shutdown(cstream);
273 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
274 platform->driver->compr_ops->free(cstream);
276 mutex_unlock(&fe->card->mutex);
280 static int soc_compr_trigger(struct snd_compr_stream *cstream, int cmd)
283 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
284 struct snd_soc_platform *platform = rtd->platform;
285 struct snd_soc_dai *codec_dai = rtd->codec_dai;
288 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
290 if (platform->driver->compr_ops && platform->driver->compr_ops->trigger) {
291 ret = platform->driver->compr_ops->trigger(cstream, cmd);
297 case SNDRV_PCM_TRIGGER_START:
298 snd_soc_dai_digital_mute(codec_dai, 0, cstream->direction);
300 case SNDRV_PCM_TRIGGER_STOP:
301 snd_soc_dai_digital_mute(codec_dai, 1, cstream->direction);
306 mutex_unlock(&rtd->pcm_mutex);
310 static int soc_compr_trigger_fe(struct snd_compr_stream *cstream, int cmd)
312 struct snd_soc_pcm_runtime *fe = cstream->private_data;
313 struct snd_soc_platform *platform = fe->platform;
316 if (cmd == SND_COMPR_TRIGGER_PARTIAL_DRAIN ||
317 cmd == SND_COMPR_TRIGGER_DRAIN) {
319 if (platform->driver->compr_ops &&
320 platform->driver->compr_ops->trigger)
321 return platform->driver->compr_ops->trigger(cstream,
325 if (cstream->direction == SND_COMPRESS_PLAYBACK)
326 stream = SNDRV_PCM_STREAM_PLAYBACK;
328 stream = SNDRV_PCM_STREAM_CAPTURE;
331 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
333 if (platform->driver->compr_ops && platform->driver->compr_ops->trigger) {
334 ret = platform->driver->compr_ops->trigger(cstream, cmd);
339 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
341 ret = dpcm_be_dai_trigger(fe, stream, cmd);
344 case SNDRV_PCM_TRIGGER_START:
345 case SNDRV_PCM_TRIGGER_RESUME:
346 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
347 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_START;
349 case SNDRV_PCM_TRIGGER_STOP:
350 case SNDRV_PCM_TRIGGER_SUSPEND:
351 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_STOP;
353 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
354 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_PAUSED;
359 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
360 mutex_unlock(&fe->card->mutex);
364 static int soc_compr_set_params(struct snd_compr_stream *cstream,
365 struct snd_compr_params *params)
367 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
368 struct snd_soc_platform *platform = rtd->platform;
371 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
373 /* first we call set_params for the platform driver
374 * this should configure the soc side
375 * if the machine has compressed ops then we call that as well
376 * expectation is that platform and machine will configure everything
377 * for this compress path, like configuring pcm port for codec
379 if (platform->driver->compr_ops && platform->driver->compr_ops->set_params) {
380 ret = platform->driver->compr_ops->set_params(cstream, params);
385 if (rtd->dai_link->compr_ops && rtd->dai_link->compr_ops->set_params) {
386 ret = rtd->dai_link->compr_ops->set_params(cstream);
391 if (cstream->direction == SND_COMPRESS_PLAYBACK)
392 snd_soc_dapm_stream_event(rtd, SNDRV_PCM_STREAM_PLAYBACK,
393 SND_SOC_DAPM_STREAM_START);
395 snd_soc_dapm_stream_event(rtd, SNDRV_PCM_STREAM_CAPTURE,
396 SND_SOC_DAPM_STREAM_START);
398 /* cancel any delayed stream shutdown that is pending */
400 mutex_unlock(&rtd->pcm_mutex);
402 cancel_delayed_work_sync(&rtd->delayed_work);
407 mutex_unlock(&rtd->pcm_mutex);
411 static int soc_compr_set_params_fe(struct snd_compr_stream *cstream,
412 struct snd_compr_params *params)
414 struct snd_soc_pcm_runtime *fe = cstream->private_data;
415 struct snd_pcm_substream *fe_substream = fe->pcm->streams[0].substream;
416 struct snd_soc_platform *platform = fe->platform;
419 if (cstream->direction == SND_COMPRESS_PLAYBACK)
420 stream = SNDRV_PCM_STREAM_PLAYBACK;
422 stream = SNDRV_PCM_STREAM_CAPTURE;
424 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
426 if (platform->driver->compr_ops && platform->driver->compr_ops->set_params) {
427 ret = platform->driver->compr_ops->set_params(cstream, params);
432 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->set_params) {
433 ret = fe->dai_link->compr_ops->set_params(cstream);
439 * Create an empty hw_params for the BE as the machine driver must
440 * fix this up to match DSP decoder and ASRC configuration.
441 * I.e. machine driver fixup for compressed BE is mandatory.
443 memset(&fe->dpcm[fe_substream->stream].hw_params, 0,
444 sizeof(struct snd_pcm_hw_params));
446 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
448 ret = dpcm_be_dai_hw_params(fe, stream);
452 ret = dpcm_be_dai_prepare(fe, stream);
456 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_START);
457 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_PREPARE;
460 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
461 mutex_unlock(&fe->card->mutex);
465 static int soc_compr_get_params(struct snd_compr_stream *cstream,
466 struct snd_codec *params)
468 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
469 struct snd_soc_platform *platform = rtd->platform;
472 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
474 if (platform->driver->compr_ops && platform->driver->compr_ops->get_params)
475 ret = platform->driver->compr_ops->get_params(cstream, params);
477 mutex_unlock(&rtd->pcm_mutex);
481 static int soc_compr_get_caps(struct snd_compr_stream *cstream,
482 struct snd_compr_caps *caps)
484 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
485 struct snd_soc_platform *platform = rtd->platform;
488 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
490 if (platform->driver->compr_ops && platform->driver->compr_ops->get_caps)
491 ret = platform->driver->compr_ops->get_caps(cstream, caps);
493 mutex_unlock(&rtd->pcm_mutex);
497 static int soc_compr_get_codec_caps(struct snd_compr_stream *cstream,
498 struct snd_compr_codec_caps *codec)
500 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
501 struct snd_soc_platform *platform = rtd->platform;
504 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
506 if (platform->driver->compr_ops && platform->driver->compr_ops->get_codec_caps)
507 ret = platform->driver->compr_ops->get_codec_caps(cstream, codec);
509 mutex_unlock(&rtd->pcm_mutex);
513 static int soc_compr_ack(struct snd_compr_stream *cstream, size_t bytes)
515 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
516 struct snd_soc_platform *platform = rtd->platform;
519 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
521 if (platform->driver->compr_ops && platform->driver->compr_ops->ack)
522 ret = platform->driver->compr_ops->ack(cstream, bytes);
524 mutex_unlock(&rtd->pcm_mutex);
528 static int soc_compr_pointer(struct snd_compr_stream *cstream,
529 struct snd_compr_tstamp *tstamp)
531 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
532 struct snd_soc_platform *platform = rtd->platform;
534 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
536 if (platform->driver->compr_ops && platform->driver->compr_ops->pointer)
537 platform->driver->compr_ops->pointer(cstream, tstamp);
539 mutex_unlock(&rtd->pcm_mutex);
543 static int soc_compr_copy(struct snd_compr_stream *cstream,
544 char __user *buf, size_t count)
546 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
547 struct snd_soc_platform *platform = rtd->platform;
550 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
552 if (platform->driver->compr_ops && platform->driver->compr_ops->copy)
553 ret = platform->driver->compr_ops->copy(cstream, buf, count);
555 mutex_unlock(&rtd->pcm_mutex);
559 static int soc_compr_set_metadata(struct snd_compr_stream *cstream,
560 struct snd_compr_metadata *metadata)
562 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
563 struct snd_soc_platform *platform = rtd->platform;
566 if (platform->driver->compr_ops && platform->driver->compr_ops->set_metadata)
567 ret = platform->driver->compr_ops->set_metadata(cstream, metadata);
572 static int soc_compr_get_metadata(struct snd_compr_stream *cstream,
573 struct snd_compr_metadata *metadata)
575 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
576 struct snd_soc_platform *platform = rtd->platform;
579 if (platform->driver->compr_ops && platform->driver->compr_ops->get_metadata)
580 ret = platform->driver->compr_ops->get_metadata(cstream, metadata);
585 /* ASoC Compress operations */
586 static struct snd_compr_ops soc_compr_ops = {
587 .open = soc_compr_open,
588 .free = soc_compr_free,
589 .set_params = soc_compr_set_params,
590 .set_metadata = soc_compr_set_metadata,
591 .get_metadata = soc_compr_get_metadata,
592 .get_params = soc_compr_get_params,
593 .trigger = soc_compr_trigger,
594 .pointer = soc_compr_pointer,
595 .ack = soc_compr_ack,
596 .get_caps = soc_compr_get_caps,
597 .get_codec_caps = soc_compr_get_codec_caps
600 /* ASoC Dynamic Compress operations */
601 static struct snd_compr_ops soc_compr_dyn_ops = {
602 .open = soc_compr_open_fe,
603 .free = soc_compr_free_fe,
604 .set_params = soc_compr_set_params_fe,
605 .get_params = soc_compr_get_params,
606 .set_metadata = soc_compr_set_metadata,
607 .get_metadata = soc_compr_get_metadata,
608 .trigger = soc_compr_trigger_fe,
609 .pointer = soc_compr_pointer,
610 .ack = soc_compr_ack,
611 .get_caps = soc_compr_get_caps,
612 .get_codec_caps = soc_compr_get_codec_caps
615 /* create a new compress */
616 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
618 struct snd_soc_codec *codec = rtd->codec;
619 struct snd_soc_platform *platform = rtd->platform;
620 struct snd_soc_dai *codec_dai = rtd->codec_dai;
621 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
622 struct snd_compr *compr;
623 struct snd_pcm *be_pcm;
625 int ret = 0, direction = 0;
627 if (rtd->num_codecs > 1) {
628 dev_err(rtd->card->dev, "Multicodec not supported for compressed stream\n");
632 /* check client and interface hw capabilities */
633 snprintf(new_name, sizeof(new_name), "%s %s-%d",
634 rtd->dai_link->stream_name, codec_dai->name, num);
636 if (codec_dai->driver->playback.channels_min)
637 direction = SND_COMPRESS_PLAYBACK;
638 else if (codec_dai->driver->capture.channels_min)
639 direction = SND_COMPRESS_CAPTURE;
643 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
645 snd_printk(KERN_ERR "Cannot allocate compr\n");
649 compr->ops = devm_kzalloc(rtd->card->dev, sizeof(soc_compr_ops),
651 if (compr->ops == NULL) {
652 dev_err(rtd->card->dev, "Cannot allocate compressed ops\n");
657 if (rtd->dai_link->dynamic) {
658 snprintf(new_name, sizeof(new_name), "(%s)",
659 rtd->dai_link->stream_name);
661 ret = snd_pcm_new_internal(rtd->card->snd_card, new_name, num,
664 dev_err(rtd->card->dev, "ASoC: can't create compressed for %s\n",
665 rtd->dai_link->name);
671 be_pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream->private_data = rtd;
672 be_pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream->private_data = rtd;
673 memcpy(compr->ops, &soc_compr_dyn_ops, sizeof(soc_compr_dyn_ops));
675 memcpy(compr->ops, &soc_compr_ops, sizeof(soc_compr_ops));
677 /* Add copy callback for not memory mapped DSPs */
678 if (platform->driver->compr_ops && platform->driver->compr_ops->copy)
679 compr->ops->copy = soc_compr_copy;
681 mutex_init(&compr->lock);
682 ret = snd_compress_new(rtd->card->snd_card, num, direction, compr);
684 pr_err("compress asoc: can't create compress for codec %s\n",
685 codec->component.name);
689 /* DAPM dai link stream work */
690 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
693 compr->private_data = rtd;
695 printk(KERN_INFO "compress asoc: %s <-> %s mapping ok\n", codec_dai->name,