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", platform->name);
45 if (rtd->dai_link->compr_ops && rtd->dai_link->compr_ops->startup) {
46 ret = rtd->dai_link->compr_ops->startup(cstream);
48 pr_err("compress asoc: %s startup failed\n", rtd->dai_link->name);
53 snd_soc_runtime_activate(rtd, cstream->direction);
55 mutex_unlock(&rtd->pcm_mutex);
60 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
61 platform->driver->compr_ops->free(cstream);
63 mutex_unlock(&rtd->pcm_mutex);
67 static int soc_compr_open_fe(struct snd_compr_stream *cstream)
69 struct snd_soc_pcm_runtime *fe = cstream->private_data;
70 struct snd_pcm_substream *fe_substream = fe->pcm->streams[0].substream;
71 struct snd_soc_platform *platform = fe->platform;
72 struct snd_soc_dpcm *dpcm;
73 struct snd_soc_dapm_widget_list *list;
77 if (cstream->direction == SND_COMPRESS_PLAYBACK)
78 stream = SNDRV_PCM_STREAM_PLAYBACK;
80 stream = SNDRV_PCM_STREAM_CAPTURE;
82 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
84 if (platform->driver->compr_ops && platform->driver->compr_ops->open) {
85 ret = platform->driver->compr_ops->open(cstream);
87 pr_err("compress asoc: can't open platform %s\n", platform->name);
92 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->startup) {
93 ret = fe->dai_link->compr_ops->startup(cstream);
95 pr_err("compress asoc: %s startup failed\n", fe->dai_link->name);
100 fe->dpcm[stream].runtime = fe_substream->runtime;
102 if (dpcm_path_get(fe, stream, &list) <= 0) {
103 dev_dbg(fe->dev, "ASoC: %s no valid %s route\n",
104 fe->dai_link->name, stream ? "capture" : "playback");
107 /* calculate valid and active FE <-> BE dpcms */
108 dpcm_process_paths(fe, stream, &list, 1);
110 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
112 ret = dpcm_be_dai_startup(fe, stream);
114 /* clean up all links */
115 list_for_each_entry(dpcm, &fe->dpcm[stream].be_clients, list_be)
116 dpcm->state = SND_SOC_DPCM_LINK_STATE_FREE;
118 dpcm_be_disconnect(fe, stream);
119 fe->dpcm[stream].runtime = NULL;
123 dpcm_clear_pending_state(fe, stream);
124 dpcm_path_put(&list);
126 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_OPEN;
127 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
129 snd_soc_runtime_activate(fe, stream);
131 mutex_unlock(&fe->card->mutex);
136 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->shutdown)
137 fe->dai_link->compr_ops->shutdown(cstream);
139 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
140 platform->driver->compr_ops->free(cstream);
142 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
143 mutex_unlock(&fe->card->mutex);
148 * Power down the audio subsystem pmdown_time msecs after close is called.
149 * This is to ensure there are no pops or clicks in between any music tracks
150 * due to DAPM power cycling.
152 static void close_delayed_work(struct work_struct *work)
154 struct snd_soc_pcm_runtime *rtd =
155 container_of(work, struct snd_soc_pcm_runtime, delayed_work.work);
156 struct snd_soc_dai *codec_dai = rtd->codec_dai;
158 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
160 dev_dbg(rtd->dev, "ASoC: pop wq checking: %s status: %s waiting: %s\n",
161 codec_dai->driver->playback.stream_name,
162 codec_dai->playback_active ? "active" : "inactive",
163 rtd->pop_wait ? "yes" : "no");
165 /* are we waiting on this codec DAI stream */
166 if (rtd->pop_wait == 1) {
168 snd_soc_dapm_stream_event(rtd, SNDRV_PCM_STREAM_PLAYBACK,
169 SND_SOC_DAPM_STREAM_STOP);
172 mutex_unlock(&rtd->pcm_mutex);
175 static int soc_compr_free(struct snd_compr_stream *cstream)
177 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
178 struct snd_soc_platform *platform = rtd->platform;
179 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
180 struct snd_soc_dai *codec_dai = rtd->codec_dai;
183 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
185 if (cstream->direction == SND_COMPRESS_PLAYBACK)
186 stream = SNDRV_PCM_STREAM_PLAYBACK;
188 stream = SNDRV_PCM_STREAM_CAPTURE;
190 snd_soc_runtime_deactivate(rtd, stream);
192 snd_soc_dai_digital_mute(codec_dai, 1, cstream->direction);
194 if (!cpu_dai->active)
197 if (!codec_dai->active)
201 if (rtd->dai_link->compr_ops && rtd->dai_link->compr_ops->shutdown)
202 rtd->dai_link->compr_ops->shutdown(cstream);
204 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
205 platform->driver->compr_ops->free(cstream);
207 if (cstream->direction == SND_COMPRESS_PLAYBACK) {
208 if (snd_soc_runtime_ignore_pmdown_time(rtd)) {
209 snd_soc_dapm_stream_event(rtd,
210 SNDRV_PCM_STREAM_PLAYBACK,
211 SND_SOC_DAPM_STREAM_STOP);
214 queue_delayed_work(system_power_efficient_wq,
216 msecs_to_jiffies(rtd->pmdown_time));
219 /* capture streams can be powered down now */
220 snd_soc_dapm_stream_event(rtd,
221 SNDRV_PCM_STREAM_CAPTURE,
222 SND_SOC_DAPM_STREAM_STOP);
225 mutex_unlock(&rtd->pcm_mutex);
229 static int soc_compr_free_fe(struct snd_compr_stream *cstream)
231 struct snd_soc_pcm_runtime *fe = cstream->private_data;
232 struct snd_soc_platform *platform = fe->platform;
233 struct snd_soc_dpcm *dpcm;
236 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
238 if (cstream->direction == SND_COMPRESS_PLAYBACK)
239 stream = SNDRV_PCM_STREAM_PLAYBACK;
241 stream = SNDRV_PCM_STREAM_CAPTURE;
243 snd_soc_runtime_deactivate(fe, stream);
245 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
247 ret = dpcm_be_dai_hw_free(fe, stream);
249 dev_err(fe->dev, "compressed hw_free failed %d\n", ret);
251 ret = dpcm_be_dai_shutdown(fe, stream);
253 /* mark FE's links ready to prune */
254 list_for_each_entry(dpcm, &fe->dpcm[stream].be_clients, list_be)
255 dpcm->state = SND_SOC_DPCM_LINK_STATE_FREE;
257 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
258 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_STOP);
260 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_STOP);
262 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_CLOSE;
263 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
265 dpcm_be_disconnect(fe, stream);
267 fe->dpcm[stream].runtime = NULL;
269 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->shutdown)
270 fe->dai_link->compr_ops->shutdown(cstream);
272 if (platform->driver->compr_ops && platform->driver->compr_ops->free)
273 platform->driver->compr_ops->free(cstream);
275 mutex_unlock(&fe->card->mutex);
279 static int soc_compr_trigger(struct snd_compr_stream *cstream, int cmd)
282 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
283 struct snd_soc_platform *platform = rtd->platform;
284 struct snd_soc_dai *codec_dai = rtd->codec_dai;
287 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
289 if (platform->driver->compr_ops && platform->driver->compr_ops->trigger) {
290 ret = platform->driver->compr_ops->trigger(cstream, cmd);
296 case SNDRV_PCM_TRIGGER_START:
297 snd_soc_dai_digital_mute(codec_dai, 0, cstream->direction);
299 case SNDRV_PCM_TRIGGER_STOP:
300 snd_soc_dai_digital_mute(codec_dai, 1, cstream->direction);
305 mutex_unlock(&rtd->pcm_mutex);
309 static int soc_compr_trigger_fe(struct snd_compr_stream *cstream, int cmd)
311 struct snd_soc_pcm_runtime *fe = cstream->private_data;
312 struct snd_soc_platform *platform = fe->platform;
315 if (cmd == SND_COMPR_TRIGGER_PARTIAL_DRAIN ||
316 cmd == SND_COMPR_TRIGGER_DRAIN) {
318 if (platform->driver->compr_ops &&
319 platform->driver->compr_ops->trigger)
320 return platform->driver->compr_ops->trigger(cstream,
324 if (cstream->direction == SND_COMPRESS_PLAYBACK)
325 stream = SNDRV_PCM_STREAM_PLAYBACK;
327 stream = SNDRV_PCM_STREAM_CAPTURE;
330 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
332 if (platform->driver->compr_ops && platform->driver->compr_ops->trigger) {
333 ret = platform->driver->compr_ops->trigger(cstream, cmd);
338 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
340 ret = dpcm_be_dai_trigger(fe, stream, cmd);
343 case SNDRV_PCM_TRIGGER_START:
344 case SNDRV_PCM_TRIGGER_RESUME:
345 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
346 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_START;
348 case SNDRV_PCM_TRIGGER_STOP:
349 case SNDRV_PCM_TRIGGER_SUSPEND:
350 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_STOP;
352 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
353 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_PAUSED;
358 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
359 mutex_unlock(&fe->card->mutex);
363 static int soc_compr_set_params(struct snd_compr_stream *cstream,
364 struct snd_compr_params *params)
366 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
367 struct snd_soc_platform *platform = rtd->platform;
370 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
372 /* first we call set_params for the platform driver
373 * this should configure the soc side
374 * if the machine has compressed ops then we call that as well
375 * expectation is that platform and machine will configure everything
376 * for this compress path, like configuring pcm port for codec
378 if (platform->driver->compr_ops && platform->driver->compr_ops->set_params) {
379 ret = platform->driver->compr_ops->set_params(cstream, params);
384 if (rtd->dai_link->compr_ops && rtd->dai_link->compr_ops->set_params) {
385 ret = rtd->dai_link->compr_ops->set_params(cstream);
390 if (cstream->direction == SND_COMPRESS_PLAYBACK)
391 snd_soc_dapm_stream_event(rtd, SNDRV_PCM_STREAM_PLAYBACK,
392 SND_SOC_DAPM_STREAM_START);
394 snd_soc_dapm_stream_event(rtd, SNDRV_PCM_STREAM_CAPTURE,
395 SND_SOC_DAPM_STREAM_START);
397 /* cancel any delayed stream shutdown that is pending */
399 mutex_unlock(&rtd->pcm_mutex);
401 cancel_delayed_work_sync(&rtd->delayed_work);
406 mutex_unlock(&rtd->pcm_mutex);
410 static int soc_compr_set_params_fe(struct snd_compr_stream *cstream,
411 struct snd_compr_params *params)
413 struct snd_soc_pcm_runtime *fe = cstream->private_data;
414 struct snd_pcm_substream *fe_substream = fe->pcm->streams[0].substream;
415 struct snd_soc_platform *platform = fe->platform;
418 if (cstream->direction == SND_COMPRESS_PLAYBACK)
419 stream = SNDRV_PCM_STREAM_PLAYBACK;
421 stream = SNDRV_PCM_STREAM_CAPTURE;
423 mutex_lock_nested(&fe->card->mutex, SND_SOC_CARD_CLASS_RUNTIME);
425 if (platform->driver->compr_ops && platform->driver->compr_ops->set_params) {
426 ret = platform->driver->compr_ops->set_params(cstream, params);
431 if (fe->dai_link->compr_ops && fe->dai_link->compr_ops->set_params) {
432 ret = fe->dai_link->compr_ops->set_params(cstream);
438 * Create an empty hw_params for the BE as the machine driver must
439 * fix this up to match DSP decoder and ASRC configuration.
440 * I.e. machine driver fixup for compressed BE is mandatory.
442 memset(&fe->dpcm[fe_substream->stream].hw_params, 0,
443 sizeof(struct snd_pcm_hw_params));
445 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_FE;
447 ret = dpcm_be_dai_hw_params(fe, stream);
451 ret = dpcm_be_dai_prepare(fe, stream);
455 if (stream == SNDRV_PCM_STREAM_PLAYBACK)
456 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_START);
458 dpcm_dapm_stream_event(fe, stream, SND_SOC_DAPM_STREAM_START);
460 fe->dpcm[stream].state = SND_SOC_DPCM_STATE_PREPARE;
463 fe->dpcm[stream].runtime_update = SND_SOC_DPCM_UPDATE_NO;
464 mutex_unlock(&fe->card->mutex);
468 static int soc_compr_get_params(struct snd_compr_stream *cstream,
469 struct snd_codec *params)
471 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
472 struct snd_soc_platform *platform = rtd->platform;
475 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
477 if (platform->driver->compr_ops && platform->driver->compr_ops->get_params)
478 ret = platform->driver->compr_ops->get_params(cstream, params);
480 mutex_unlock(&rtd->pcm_mutex);
484 static int soc_compr_get_caps(struct snd_compr_stream *cstream,
485 struct snd_compr_caps *caps)
487 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
488 struct snd_soc_platform *platform = rtd->platform;
491 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
493 if (platform->driver->compr_ops && platform->driver->compr_ops->get_caps)
494 ret = platform->driver->compr_ops->get_caps(cstream, caps);
496 mutex_unlock(&rtd->pcm_mutex);
500 static int soc_compr_get_codec_caps(struct snd_compr_stream *cstream,
501 struct snd_compr_codec_caps *codec)
503 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
504 struct snd_soc_platform *platform = rtd->platform;
507 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
509 if (platform->driver->compr_ops && platform->driver->compr_ops->get_codec_caps)
510 ret = platform->driver->compr_ops->get_codec_caps(cstream, codec);
512 mutex_unlock(&rtd->pcm_mutex);
516 static int soc_compr_ack(struct snd_compr_stream *cstream, size_t bytes)
518 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
519 struct snd_soc_platform *platform = rtd->platform;
522 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
524 if (platform->driver->compr_ops && platform->driver->compr_ops->ack)
525 ret = platform->driver->compr_ops->ack(cstream, bytes);
527 mutex_unlock(&rtd->pcm_mutex);
531 static int soc_compr_pointer(struct snd_compr_stream *cstream,
532 struct snd_compr_tstamp *tstamp)
534 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
535 struct snd_soc_platform *platform = rtd->platform;
537 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
539 if (platform->driver->compr_ops && platform->driver->compr_ops->pointer)
540 platform->driver->compr_ops->pointer(cstream, tstamp);
542 mutex_unlock(&rtd->pcm_mutex);
546 static int soc_compr_copy(struct snd_compr_stream *cstream,
547 char __user *buf, size_t count)
549 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
550 struct snd_soc_platform *platform = rtd->platform;
553 mutex_lock_nested(&rtd->pcm_mutex, rtd->pcm_subclass);
555 if (platform->driver->compr_ops && platform->driver->compr_ops->copy)
556 ret = platform->driver->compr_ops->copy(cstream, buf, count);
558 mutex_unlock(&rtd->pcm_mutex);
562 static int soc_compr_set_metadata(struct snd_compr_stream *cstream,
563 struct snd_compr_metadata *metadata)
565 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
566 struct snd_soc_platform *platform = rtd->platform;
569 if (platform->driver->compr_ops && platform->driver->compr_ops->set_metadata)
570 ret = platform->driver->compr_ops->set_metadata(cstream, metadata);
575 static int soc_compr_get_metadata(struct snd_compr_stream *cstream,
576 struct snd_compr_metadata *metadata)
578 struct snd_soc_pcm_runtime *rtd = cstream->private_data;
579 struct snd_soc_platform *platform = rtd->platform;
582 if (platform->driver->compr_ops && platform->driver->compr_ops->get_metadata)
583 ret = platform->driver->compr_ops->get_metadata(cstream, metadata);
588 /* ASoC Compress operations */
589 static struct snd_compr_ops soc_compr_ops = {
590 .open = soc_compr_open,
591 .free = soc_compr_free,
592 .set_params = soc_compr_set_params,
593 .set_metadata = soc_compr_set_metadata,
594 .get_metadata = soc_compr_get_metadata,
595 .get_params = soc_compr_get_params,
596 .trigger = soc_compr_trigger,
597 .pointer = soc_compr_pointer,
598 .ack = soc_compr_ack,
599 .get_caps = soc_compr_get_caps,
600 .get_codec_caps = soc_compr_get_codec_caps
603 /* ASoC Dynamic Compress operations */
604 static struct snd_compr_ops soc_compr_dyn_ops = {
605 .open = soc_compr_open_fe,
606 .free = soc_compr_free_fe,
607 .set_params = soc_compr_set_params_fe,
608 .get_params = soc_compr_get_params,
609 .set_metadata = soc_compr_set_metadata,
610 .get_metadata = soc_compr_get_metadata,
611 .trigger = soc_compr_trigger_fe,
612 .pointer = soc_compr_pointer,
613 .ack = soc_compr_ack,
614 .get_caps = soc_compr_get_caps,
615 .get_codec_caps = soc_compr_get_codec_caps
618 /* create a new compress */
619 int soc_new_compress(struct snd_soc_pcm_runtime *rtd, int num)
621 struct snd_soc_codec *codec = rtd->codec;
622 struct snd_soc_platform *platform = rtd->platform;
623 struct snd_soc_dai *codec_dai = rtd->codec_dai;
624 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
625 struct snd_compr *compr;
626 struct snd_pcm *be_pcm;
628 int ret = 0, direction = 0;
630 /* check client and interface hw capabilities */
631 snprintf(new_name, sizeof(new_name), "%s %s-%d",
632 rtd->dai_link->stream_name, codec_dai->name, num);
634 if (codec_dai->driver->playback.channels_min)
635 direction = SND_COMPRESS_PLAYBACK;
636 else if (codec_dai->driver->capture.channels_min)
637 direction = SND_COMPRESS_CAPTURE;
641 compr = kzalloc(sizeof(*compr), GFP_KERNEL);
643 snd_printk(KERN_ERR "Cannot allocate compr\n");
647 compr->ops = devm_kzalloc(rtd->card->dev, sizeof(soc_compr_ops),
649 if (compr->ops == NULL) {
650 dev_err(rtd->card->dev, "Cannot allocate compressed ops\n");
655 if (rtd->dai_link->dynamic) {
656 snprintf(new_name, sizeof(new_name), "(%s)",
657 rtd->dai_link->stream_name);
659 ret = snd_pcm_new_internal(rtd->card->snd_card, new_name, num,
662 dev_err(rtd->card->dev, "ASoC: can't create compressed for %s\n",
663 rtd->dai_link->name);
669 be_pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream->private_data = rtd;
670 be_pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream->private_data = rtd;
671 memcpy(compr->ops, &soc_compr_dyn_ops, sizeof(soc_compr_dyn_ops));
673 memcpy(compr->ops, &soc_compr_ops, sizeof(soc_compr_ops));
675 /* Add copy callback for not memory mapped DSPs */
676 if (platform->driver->compr_ops && platform->driver->compr_ops->copy)
677 compr->ops->copy = soc_compr_copy;
679 mutex_init(&compr->lock);
680 ret = snd_compress_new(rtd->card->snd_card, num, direction, compr);
682 pr_err("compress asoc: can't create compress for codec %s\n",
687 /* DAPM dai link stream work */
688 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
691 compr->private_data = rtd;
693 printk(KERN_INFO "compress asoc: %s <-> %s mapping ok\n", codec_dai->name,