2 * soc-core.c -- ALSA SoC Audio Layer
4 * Copyright 2005 Wolfson Microelectronics PLC.
5 * Copyright 2005 Openedhand Ltd.
6 * Copyright (C) 2010 Slimlogic Ltd.
7 * Copyright (C) 2010 Texas Instruments Inc.
9 * Author: Liam Girdwood <lrg@slimlogic.co.uk>
10 * with code, comments and ideas from :-
11 * Richard Purdie <richard@openedhand.com>
13 * This program is free software; you can redistribute it and/or modify it
14 * under the terms of the GNU General Public License as published by the
15 * Free Software Foundation; either version 2 of the License, or (at your
16 * option) any later version.
19 * o Add hw rules to enforce rates, etc.
20 * o More testing with other codecs/machines.
21 * o Add more codecs and platforms to ensure good API coverage.
22 * o Support TDM on PCM and I2S
25 #include <linux/module.h>
26 #include <linux/moduleparam.h>
27 #include <linux/init.h>
28 #include <linux/delay.h>
30 #include <linux/bitops.h>
31 #include <linux/debugfs.h>
32 #include <linux/platform_device.h>
33 #include <linux/pinctrl/consumer.h>
34 #include <linux/ctype.h>
35 #include <linux/slab.h>
37 #include <linux/of_graph.h>
38 #include <linux/dmi.h>
39 #include <sound/core.h>
40 #include <sound/jack.h>
41 #include <sound/pcm.h>
42 #include <sound/pcm_params.h>
43 #include <sound/soc.h>
44 #include <sound/soc-dpcm.h>
45 #include <sound/soc-topology.h>
46 #include <sound/initval.h>
48 #define CREATE_TRACE_POINTS
49 #include <trace/events/asoc.h>
53 #ifdef CONFIG_DEBUG_FS
54 struct dentry *snd_soc_debugfs_root;
55 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
58 static DEFINE_MUTEX(client_mutex);
59 static LIST_HEAD(platform_list);
60 static LIST_HEAD(codec_list);
61 static LIST_HEAD(component_list);
64 * This is a timeout to do a DAPM powerdown after a stream is closed().
65 * It can be used to eliminate pops between different playback streams, e.g.
66 * between two audio tracks.
68 static int pmdown_time = 5000;
69 module_param(pmdown_time, int, 0);
70 MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
72 /* If a DMI filed contain strings in this blacklist (e.g.
73 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
74 * as invalid and dropped when setting the card long name from DMI info.
76 static const char * const dmi_blacklist[] = {
77 "To be filled by OEM",
83 NULL, /* terminator */
86 /* returns the minimum number of bytes needed to represent
87 * a particular given value */
88 static int min_bytes_needed(unsigned long val)
93 for (i = (sizeof val * 8) - 1; i >= 0; --i, ++c)
96 c = (sizeof val * 8) - c;
104 /* fill buf which is 'len' bytes with a formatted
105 * string of the form 'reg: value\n' */
106 static int format_register_str(struct snd_soc_codec *codec,
107 unsigned int reg, char *buf, size_t len)
109 int wordsize = min_bytes_needed(codec->driver->reg_cache_size) * 2;
110 int regsize = codec->driver->reg_word_size * 2;
113 /* +2 for ': ' and + 1 for '\n' */
114 if (wordsize + regsize + 2 + 1 != len)
117 sprintf(buf, "%.*x: ", wordsize, reg);
120 ret = snd_soc_read(codec, reg);
122 memset(buf, 'X', regsize);
124 sprintf(buf, "%.*x", regsize, ret);
126 /* no NUL-termination needed */
130 /* codec register dump */
131 static ssize_t soc_codec_reg_show(struct snd_soc_codec *codec, char *buf,
132 size_t count, loff_t pos)
135 int wordsize, regsize;
140 wordsize = min_bytes_needed(codec->driver->reg_cache_size) * 2;
141 regsize = codec->driver->reg_word_size * 2;
143 len = wordsize + regsize + 2 + 1;
145 if (!codec->driver->reg_cache_size)
148 if (codec->driver->reg_cache_step)
149 step = codec->driver->reg_cache_step;
151 for (i = 0; i < codec->driver->reg_cache_size; i += step) {
152 /* only support larger than PAGE_SIZE bytes debugfs
153 * entries for the default case */
155 if (total + len >= count - 1)
157 format_register_str(codec, i, buf + total, len);
163 total = min(total, count - 1);
168 static ssize_t codec_reg_show(struct device *dev,
169 struct device_attribute *attr, char *buf)
171 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
173 return soc_codec_reg_show(rtd->codec, buf, PAGE_SIZE, 0);
176 static DEVICE_ATTR(codec_reg, 0444, codec_reg_show, NULL);
178 static ssize_t pmdown_time_show(struct device *dev,
179 struct device_attribute *attr, char *buf)
181 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
183 return sprintf(buf, "%ld\n", rtd->pmdown_time);
186 static ssize_t pmdown_time_set(struct device *dev,
187 struct device_attribute *attr,
188 const char *buf, size_t count)
190 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
193 ret = kstrtol(buf, 10, &rtd->pmdown_time);
200 static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
202 static struct attribute *soc_dev_attrs[] = {
203 &dev_attr_codec_reg.attr,
204 &dev_attr_pmdown_time.attr,
208 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
209 struct attribute *attr, int idx)
211 struct device *dev = kobj_to_dev(kobj);
212 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
214 if (attr == &dev_attr_pmdown_time.attr)
215 return attr->mode; /* always visible */
216 return rtd->codec ? attr->mode : 0; /* enabled only with codec */
219 static const struct attribute_group soc_dapm_dev_group = {
220 .attrs = soc_dapm_dev_attrs,
221 .is_visible = soc_dev_attr_is_visible,
224 static const struct attribute_group soc_dev_roup = {
225 .attrs = soc_dev_attrs,
226 .is_visible = soc_dev_attr_is_visible,
229 static const struct attribute_group *soc_dev_attr_groups[] = {
235 #ifdef CONFIG_DEBUG_FS
236 static ssize_t codec_reg_read_file(struct file *file, char __user *user_buf,
237 size_t count, loff_t *ppos)
240 struct snd_soc_codec *codec = file->private_data;
243 if (*ppos < 0 || !count)
246 buf = kmalloc(count, GFP_KERNEL);
250 ret = soc_codec_reg_show(codec, buf, count, *ppos);
252 if (copy_to_user(user_buf, buf, ret)) {
263 static ssize_t codec_reg_write_file(struct file *file,
264 const char __user *user_buf, size_t count, loff_t *ppos)
269 unsigned long reg, value;
270 struct snd_soc_codec *codec = file->private_data;
273 buf_size = min(count, (sizeof(buf)-1));
274 if (copy_from_user(buf, user_buf, buf_size))
278 while (*start == ' ')
280 reg = simple_strtoul(start, &start, 16);
281 while (*start == ' ')
283 ret = kstrtoul(start, 16, &value);
287 /* Userspace has been fiddling around behind the kernel's back */
288 add_taint(TAINT_USER, LOCKDEP_NOW_UNRELIABLE);
290 snd_soc_write(codec, reg, value);
294 static const struct file_operations codec_reg_fops = {
296 .read = codec_reg_read_file,
297 .write = codec_reg_write_file,
298 .llseek = default_llseek,
301 static void soc_init_component_debugfs(struct snd_soc_component *component)
303 if (!component->card->debugfs_card_root)
306 if (component->debugfs_prefix) {
309 name = kasprintf(GFP_KERNEL, "%s:%s",
310 component->debugfs_prefix, component->name);
312 component->debugfs_root = debugfs_create_dir(name,
313 component->card->debugfs_card_root);
317 component->debugfs_root = debugfs_create_dir(component->name,
318 component->card->debugfs_card_root);
321 if (!component->debugfs_root) {
322 dev_warn(component->dev,
323 "ASoC: Failed to create component debugfs directory\n");
327 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
328 component->debugfs_root);
330 if (component->init_debugfs)
331 component->init_debugfs(component);
334 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
336 debugfs_remove_recursive(component->debugfs_root);
339 static void soc_init_codec_debugfs(struct snd_soc_component *component)
341 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
343 codec->debugfs_reg = debugfs_create_file("codec_reg", 0644,
344 codec->component.debugfs_root,
345 codec, &codec_reg_fops);
346 if (!codec->debugfs_reg)
348 "ASoC: Failed to create codec register debugfs file\n");
351 static ssize_t codec_list_read_file(struct file *file, char __user *user_buf,
352 size_t count, loff_t *ppos)
354 char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
355 ssize_t len, ret = 0;
356 struct snd_soc_codec *codec;
361 mutex_lock(&client_mutex);
363 list_for_each_entry(codec, &codec_list, list) {
364 len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
365 codec->component.name);
368 if (ret > PAGE_SIZE) {
374 mutex_unlock(&client_mutex);
377 ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
384 static const struct file_operations codec_list_fops = {
385 .read = codec_list_read_file,
386 .llseek = default_llseek,/* read accesses f_pos */
389 static ssize_t dai_list_read_file(struct file *file, char __user *user_buf,
390 size_t count, loff_t *ppos)
392 char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
393 ssize_t len, ret = 0;
394 struct snd_soc_component *component;
395 struct snd_soc_dai *dai;
400 mutex_lock(&client_mutex);
402 list_for_each_entry(component, &component_list, list) {
403 list_for_each_entry(dai, &component->dai_list, list) {
404 len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
408 if (ret > PAGE_SIZE) {
415 mutex_unlock(&client_mutex);
417 ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
424 static const struct file_operations dai_list_fops = {
425 .read = dai_list_read_file,
426 .llseek = default_llseek,/* read accesses f_pos */
429 static ssize_t platform_list_read_file(struct file *file,
430 char __user *user_buf,
431 size_t count, loff_t *ppos)
433 char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
434 ssize_t len, ret = 0;
435 struct snd_soc_platform *platform;
440 mutex_lock(&client_mutex);
442 list_for_each_entry(platform, &platform_list, list) {
443 len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
444 platform->component.name);
447 if (ret > PAGE_SIZE) {
453 mutex_unlock(&client_mutex);
455 ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
462 static const struct file_operations platform_list_fops = {
463 .read = platform_list_read_file,
464 .llseek = default_llseek,/* read accesses f_pos */
467 static void soc_init_card_debugfs(struct snd_soc_card *card)
469 if (!snd_soc_debugfs_root)
472 card->debugfs_card_root = debugfs_create_dir(card->name,
473 snd_soc_debugfs_root);
474 if (!card->debugfs_card_root) {
476 "ASoC: Failed to create card debugfs directory\n");
480 card->debugfs_pop_time = debugfs_create_u32("dapm_pop_time", 0644,
481 card->debugfs_card_root,
483 if (!card->debugfs_pop_time)
485 "ASoC: Failed to create pop time debugfs file\n");
488 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
490 debugfs_remove_recursive(card->debugfs_card_root);
494 static void snd_soc_debugfs_init(void)
496 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
497 if (IS_ERR(snd_soc_debugfs_root) || !snd_soc_debugfs_root) {
498 pr_warn("ASoC: Failed to create debugfs directory\n");
499 snd_soc_debugfs_root = NULL;
503 if (!debugfs_create_file("codecs", 0444, snd_soc_debugfs_root, NULL,
505 pr_warn("ASoC: Failed to create CODEC list debugfs file\n");
507 if (!debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
509 pr_warn("ASoC: Failed to create DAI list debugfs file\n");
511 if (!debugfs_create_file("platforms", 0444, snd_soc_debugfs_root, NULL,
512 &platform_list_fops))
513 pr_warn("ASoC: Failed to create platform list debugfs file\n");
516 static void snd_soc_debugfs_exit(void)
518 debugfs_remove_recursive(snd_soc_debugfs_root);
523 #define soc_init_codec_debugfs NULL
525 static inline void soc_init_component_debugfs(
526 struct snd_soc_component *component)
530 static inline void soc_cleanup_component_debugfs(
531 struct snd_soc_component *component)
535 static inline void soc_init_card_debugfs(struct snd_soc_card *card)
539 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
543 static inline void snd_soc_debugfs_init(void)
547 static inline void snd_soc_debugfs_exit(void)
553 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
554 const char *dai_link, int stream)
556 struct snd_soc_pcm_runtime *rtd;
558 list_for_each_entry(rtd, &card->rtd_list, list) {
559 if (rtd->dai_link->no_pcm &&
560 !strcmp(rtd->dai_link->name, dai_link))
561 return rtd->pcm->streams[stream].substream;
563 dev_dbg(card->dev, "ASoC: failed to find dai link %s\n", dai_link);
566 EXPORT_SYMBOL_GPL(snd_soc_get_dai_substream);
568 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
569 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
571 struct snd_soc_pcm_runtime *rtd;
573 rtd = kzalloc(sizeof(struct snd_soc_pcm_runtime), GFP_KERNEL);
578 rtd->dai_link = dai_link;
579 rtd->codec_dais = kzalloc(sizeof(struct snd_soc_dai *) *
580 dai_link->num_codecs,
582 if (!rtd->codec_dais) {
590 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
592 if (rtd && rtd->codec_dais)
593 kfree(rtd->codec_dais);
597 static void soc_add_pcm_runtime(struct snd_soc_card *card,
598 struct snd_soc_pcm_runtime *rtd)
600 list_add_tail(&rtd->list, &card->rtd_list);
601 rtd->num = card->num_rtd;
605 static void soc_remove_pcm_runtimes(struct snd_soc_card *card)
607 struct snd_soc_pcm_runtime *rtd, *_rtd;
609 list_for_each_entry_safe(rtd, _rtd, &card->rtd_list, list) {
610 list_del(&rtd->list);
611 soc_free_pcm_runtime(rtd);
617 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
618 const char *dai_link)
620 struct snd_soc_pcm_runtime *rtd;
622 list_for_each_entry(rtd, &card->rtd_list, list) {
623 if (!strcmp(rtd->dai_link->name, dai_link))
626 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link);
629 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
631 static void codec2codec_close_delayed_work(struct work_struct *work)
633 /* Currently nothing to do for c2c links
634 * Since c2c links are internal nodes in the DAPM graph and
635 * don't interface with the outside world or application layer
636 * we don't have to do any special handling on close.
640 #ifdef CONFIG_PM_SLEEP
641 /* powers down audio subsystem for suspend */
642 int snd_soc_suspend(struct device *dev)
644 struct snd_soc_card *card = dev_get_drvdata(dev);
645 struct snd_soc_component *component;
646 struct snd_soc_pcm_runtime *rtd;
649 /* If the card is not initialized yet there is nothing to do */
650 if (!card->instantiated)
653 /* Due to the resume being scheduled into a workqueue we could
654 * suspend before that's finished - wait for it to complete.
656 snd_power_lock(card->snd_card);
657 snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
658 snd_power_unlock(card->snd_card);
660 /* we're going to block userspace touching us until resume completes */
661 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
663 /* mute any active DACs */
664 list_for_each_entry(rtd, &card->rtd_list, list) {
666 if (rtd->dai_link->ignore_suspend)
669 for (i = 0; i < rtd->num_codecs; i++) {
670 struct snd_soc_dai *dai = rtd->codec_dais[i];
671 struct snd_soc_dai_driver *drv = dai->driver;
673 if (drv->ops->digital_mute && dai->playback_active)
674 drv->ops->digital_mute(dai, 1);
678 /* suspend all pcms */
679 list_for_each_entry(rtd, &card->rtd_list, list) {
680 if (rtd->dai_link->ignore_suspend)
683 snd_pcm_suspend_all(rtd->pcm);
686 if (card->suspend_pre)
687 card->suspend_pre(card);
689 list_for_each_entry(rtd, &card->rtd_list, list) {
690 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
692 if (rtd->dai_link->ignore_suspend)
695 if (cpu_dai->driver->suspend && !cpu_dai->driver->bus_control)
696 cpu_dai->driver->suspend(cpu_dai);
699 /* close any waiting streams */
700 list_for_each_entry(rtd, &card->rtd_list, list)
701 flush_delayed_work(&rtd->delayed_work);
703 list_for_each_entry(rtd, &card->rtd_list, list) {
705 if (rtd->dai_link->ignore_suspend)
708 snd_soc_dapm_stream_event(rtd,
709 SNDRV_PCM_STREAM_PLAYBACK,
710 SND_SOC_DAPM_STREAM_SUSPEND);
712 snd_soc_dapm_stream_event(rtd,
713 SNDRV_PCM_STREAM_CAPTURE,
714 SND_SOC_DAPM_STREAM_SUSPEND);
717 /* Recheck all endpoints too, their state is affected by suspend */
718 dapm_mark_endpoints_dirty(card);
719 snd_soc_dapm_sync(&card->dapm);
721 /* suspend all COMPONENTs */
722 list_for_each_entry(component, &card->component_dev_list, card_list) {
723 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
725 /* If there are paths active then the COMPONENT will be held with
726 * bias _ON and should not be suspended. */
727 if (!component->suspended) {
728 switch (snd_soc_dapm_get_bias_level(dapm)) {
729 case SND_SOC_BIAS_STANDBY:
731 * If the COMPONENT is capable of idle
732 * bias off then being in STANDBY
733 * means it's doing something,
734 * otherwise fall through.
736 if (dapm->idle_bias_off) {
737 dev_dbg(component->dev,
738 "ASoC: idle_bias_off CODEC on over suspend\n");
742 case SND_SOC_BIAS_OFF:
743 if (component->suspend)
744 component->suspend(component);
745 component->suspended = 1;
746 if (component->regmap)
747 regcache_mark_dirty(component->regmap);
748 /* deactivate pins to sleep state */
749 pinctrl_pm_select_sleep_state(component->dev);
752 dev_dbg(component->dev,
753 "ASoC: COMPONENT is on over suspend\n");
759 list_for_each_entry(rtd, &card->rtd_list, list) {
760 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
762 if (rtd->dai_link->ignore_suspend)
765 if (cpu_dai->driver->suspend && cpu_dai->driver->bus_control)
766 cpu_dai->driver->suspend(cpu_dai);
768 /* deactivate pins to sleep state */
769 pinctrl_pm_select_sleep_state(cpu_dai->dev);
772 if (card->suspend_post)
773 card->suspend_post(card);
777 EXPORT_SYMBOL_GPL(snd_soc_suspend);
779 /* deferred resume work, so resume can complete before we finished
780 * setting our codec back up, which can be very slow on I2C
782 static void soc_resume_deferred(struct work_struct *work)
784 struct snd_soc_card *card =
785 container_of(work, struct snd_soc_card, deferred_resume_work);
786 struct snd_soc_pcm_runtime *rtd;
787 struct snd_soc_component *component;
790 /* our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
791 * so userspace apps are blocked from touching us
794 dev_dbg(card->dev, "ASoC: starting resume work\n");
796 /* Bring us up into D2 so that DAPM starts enabling things */
797 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
799 if (card->resume_pre)
800 card->resume_pre(card);
802 /* resume control bus DAIs */
803 list_for_each_entry(rtd, &card->rtd_list, list) {
804 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
806 if (rtd->dai_link->ignore_suspend)
809 if (cpu_dai->driver->resume && cpu_dai->driver->bus_control)
810 cpu_dai->driver->resume(cpu_dai);
813 list_for_each_entry(component, &card->component_dev_list, card_list) {
814 if (component->suspended) {
815 if (component->resume)
816 component->resume(component);
817 component->suspended = 0;
821 list_for_each_entry(rtd, &card->rtd_list, list) {
823 if (rtd->dai_link->ignore_suspend)
826 snd_soc_dapm_stream_event(rtd,
827 SNDRV_PCM_STREAM_PLAYBACK,
828 SND_SOC_DAPM_STREAM_RESUME);
830 snd_soc_dapm_stream_event(rtd,
831 SNDRV_PCM_STREAM_CAPTURE,
832 SND_SOC_DAPM_STREAM_RESUME);
835 /* unmute any active DACs */
836 list_for_each_entry(rtd, &card->rtd_list, list) {
838 if (rtd->dai_link->ignore_suspend)
841 for (i = 0; i < rtd->num_codecs; i++) {
842 struct snd_soc_dai *dai = rtd->codec_dais[i];
843 struct snd_soc_dai_driver *drv = dai->driver;
845 if (drv->ops->digital_mute && dai->playback_active)
846 drv->ops->digital_mute(dai, 0);
850 list_for_each_entry(rtd, &card->rtd_list, list) {
851 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
853 if (rtd->dai_link->ignore_suspend)
856 if (cpu_dai->driver->resume && !cpu_dai->driver->bus_control)
857 cpu_dai->driver->resume(cpu_dai);
860 if (card->resume_post)
861 card->resume_post(card);
863 dev_dbg(card->dev, "ASoC: resume work completed\n");
865 /* Recheck all endpoints too, their state is affected by suspend */
866 dapm_mark_endpoints_dirty(card);
867 snd_soc_dapm_sync(&card->dapm);
869 /* userspace can access us now we are back as we were before */
870 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
873 /* powers up audio subsystem after a suspend */
874 int snd_soc_resume(struct device *dev)
876 struct snd_soc_card *card = dev_get_drvdata(dev);
877 bool bus_control = false;
878 struct snd_soc_pcm_runtime *rtd;
880 /* If the card is not initialized yet there is nothing to do */
881 if (!card->instantiated)
884 /* activate pins from sleep state */
885 list_for_each_entry(rtd, &card->rtd_list, list) {
886 struct snd_soc_dai **codec_dais = rtd->codec_dais;
887 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
891 pinctrl_pm_select_default_state(cpu_dai->dev);
893 for (j = 0; j < rtd->num_codecs; j++) {
894 struct snd_soc_dai *codec_dai = codec_dais[j];
895 if (codec_dai->active)
896 pinctrl_pm_select_default_state(codec_dai->dev);
901 * DAIs that also act as the control bus master might have other drivers
902 * hanging off them so need to resume immediately. Other drivers don't
903 * have that problem and may take a substantial amount of time to resume
904 * due to I/O costs and anti-pop so handle them out of line.
906 list_for_each_entry(rtd, &card->rtd_list, list) {
907 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
908 bus_control |= cpu_dai->driver->bus_control;
911 dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
912 soc_resume_deferred(&card->deferred_resume_work);
914 dev_dbg(dev, "ASoC: Scheduling resume work\n");
915 if (!schedule_work(&card->deferred_resume_work))
916 dev_err(dev, "ASoC: resume work item may be lost\n");
921 EXPORT_SYMBOL_GPL(snd_soc_resume);
923 #define snd_soc_suspend NULL
924 #define snd_soc_resume NULL
927 static const struct snd_soc_dai_ops null_dai_ops = {
930 static struct snd_soc_component *soc_find_component(
931 const struct device_node *of_node, const char *name)
933 struct snd_soc_component *component;
935 lockdep_assert_held(&client_mutex);
937 list_for_each_entry(component, &component_list, list) {
939 if (component->dev->of_node == of_node)
941 } else if (strcmp(component->name, name) == 0) {
950 * snd_soc_find_dai - Find a registered DAI
952 * @dlc: name of the DAI and optional component info to match
954 * This function will search all registered components and their DAIs to
955 * find the DAI of the same name. The component's of_node and name
956 * should also match if being specified.
958 * Return: pointer of DAI, or NULL if not found.
960 struct snd_soc_dai *snd_soc_find_dai(
961 const struct snd_soc_dai_link_component *dlc)
963 struct snd_soc_component *component;
964 struct snd_soc_dai *dai;
965 struct device_node *component_of_node;
967 lockdep_assert_held(&client_mutex);
969 /* Find CPU DAI from registered DAIs*/
970 list_for_each_entry(component, &component_list, list) {
971 component_of_node = component->dev->of_node;
972 if (!component_of_node && component->dev->parent)
973 component_of_node = component->dev->parent->of_node;
975 if (dlc->of_node && component_of_node != dlc->of_node)
977 if (dlc->name && strcmp(component->name, dlc->name))
979 list_for_each_entry(dai, &component->dai_list, list) {
980 if (dlc->dai_name && strcmp(dai->name, dlc->dai_name))
989 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
993 * snd_soc_find_dai_link - Find a DAI link
996 * @id: DAI link ID to match
997 * @name: DAI link name to match, optional
998 * @stream_name: DAI link stream name to match, optional
1000 * This function will search all existing DAI links of the soc card to
1001 * find the link of the same ID. Since DAI links may not have their
1002 * unique ID, so name and stream name should also match if being
1005 * Return: pointer of DAI link, or NULL if not found.
1007 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1008 int id, const char *name,
1009 const char *stream_name)
1011 struct snd_soc_dai_link *link, *_link;
1013 lockdep_assert_held(&client_mutex);
1015 list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1019 if (name && (!link->name || strcmp(name, link->name)))
1022 if (stream_name && (!link->stream_name
1023 || strcmp(stream_name, link->stream_name)))
1031 EXPORT_SYMBOL_GPL(snd_soc_find_dai_link);
1033 static bool soc_is_dai_link_bound(struct snd_soc_card *card,
1034 struct snd_soc_dai_link *dai_link)
1036 struct snd_soc_pcm_runtime *rtd;
1038 list_for_each_entry(rtd, &card->rtd_list, list) {
1039 if (rtd->dai_link == dai_link)
1046 static int soc_bind_dai_link(struct snd_soc_card *card,
1047 struct snd_soc_dai_link *dai_link)
1049 struct snd_soc_pcm_runtime *rtd;
1050 struct snd_soc_dai_link_component *codecs = dai_link->codecs;
1051 struct snd_soc_dai_link_component cpu_dai_component;
1052 struct snd_soc_dai **codec_dais;
1053 struct snd_soc_platform *platform;
1054 struct device_node *platform_of_node;
1055 const char *platform_name;
1058 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1060 if (soc_is_dai_link_bound(card, dai_link)) {
1061 dev_dbg(card->dev, "ASoC: dai link %s already bound\n",
1066 rtd = soc_new_pcm_runtime(card, dai_link);
1070 cpu_dai_component.name = dai_link->cpu_name;
1071 cpu_dai_component.of_node = dai_link->cpu_of_node;
1072 cpu_dai_component.dai_name = dai_link->cpu_dai_name;
1073 rtd->cpu_dai = snd_soc_find_dai(&cpu_dai_component);
1074 if (!rtd->cpu_dai) {
1075 dev_err(card->dev, "ASoC: CPU DAI %s not registered\n",
1076 dai_link->cpu_dai_name);
1080 rtd->num_codecs = dai_link->num_codecs;
1082 /* Find CODEC from registered CODECs */
1083 codec_dais = rtd->codec_dais;
1084 for (i = 0; i < rtd->num_codecs; i++) {
1085 codec_dais[i] = snd_soc_find_dai(&codecs[i]);
1086 if (!codec_dais[i]) {
1087 dev_err(card->dev, "ASoC: CODEC DAI %s not registered\n",
1088 codecs[i].dai_name);
1093 /* Single codec links expect codec and codec_dai in runtime data */
1094 rtd->codec_dai = codec_dais[0];
1095 rtd->codec = rtd->codec_dai->codec;
1097 /* if there's no platform we match on the empty platform */
1098 platform_name = dai_link->platform_name;
1099 if (!platform_name && !dai_link->platform_of_node)
1100 platform_name = "snd-soc-dummy";
1102 /* find one from the set of registered platforms */
1103 list_for_each_entry(platform, &platform_list, list) {
1104 platform_of_node = platform->dev->of_node;
1105 if (!platform_of_node && platform->dev->parent->of_node)
1106 platform_of_node = platform->dev->parent->of_node;
1108 if (dai_link->platform_of_node) {
1109 if (platform_of_node != dai_link->platform_of_node)
1112 if (strcmp(platform->component.name, platform_name))
1116 rtd->platform = platform;
1118 if (!rtd->platform) {
1119 dev_err(card->dev, "ASoC: platform %s not registered\n",
1120 dai_link->platform_name);
1124 soc_add_pcm_runtime(card, rtd);
1128 soc_free_pcm_runtime(rtd);
1129 return -EPROBE_DEFER;
1132 static void soc_remove_component(struct snd_soc_component *component)
1134 if (!component->card)
1137 list_del(&component->card_list);
1139 if (component->remove)
1140 component->remove(component);
1142 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1144 soc_cleanup_component_debugfs(component);
1145 component->card = NULL;
1146 module_put(component->dev->driver->owner);
1149 static void soc_remove_dai(struct snd_soc_dai *dai, int order)
1153 if (dai && dai->probed &&
1154 dai->driver->remove_order == order) {
1155 if (dai->driver->remove) {
1156 err = dai->driver->remove(dai);
1159 "ASoC: failed to remove %s: %d\n",
1166 static void soc_remove_link_dais(struct snd_soc_card *card,
1167 struct snd_soc_pcm_runtime *rtd, int order)
1171 /* unregister the rtd device */
1172 if (rtd->dev_registered) {
1173 device_unregister(rtd->dev);
1174 rtd->dev_registered = 0;
1177 /* remove the CODEC DAI */
1178 for (i = 0; i < rtd->num_codecs; i++)
1179 soc_remove_dai(rtd->codec_dais[i], order);
1181 soc_remove_dai(rtd->cpu_dai, order);
1184 static void soc_remove_link_components(struct snd_soc_card *card,
1185 struct snd_soc_pcm_runtime *rtd, int order)
1187 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1188 struct snd_soc_platform *platform = rtd->platform;
1189 struct snd_soc_component *component;
1192 /* remove the platform */
1193 if (platform && platform->component.driver->remove_order == order)
1194 soc_remove_component(&platform->component);
1196 /* remove the CODEC-side CODEC */
1197 for (i = 0; i < rtd->num_codecs; i++) {
1198 component = rtd->codec_dais[i]->component;
1199 if (component->driver->remove_order == order)
1200 soc_remove_component(component);
1203 /* remove any CPU-side CODEC */
1205 if (cpu_dai->component->driver->remove_order == order)
1206 soc_remove_component(cpu_dai->component);
1210 static void soc_remove_dai_links(struct snd_soc_card *card)
1213 struct snd_soc_pcm_runtime *rtd;
1214 struct snd_soc_dai_link *link, *_link;
1216 for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1218 list_for_each_entry(rtd, &card->rtd_list, list)
1219 soc_remove_link_dais(card, rtd, order);
1222 for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1224 list_for_each_entry(rtd, &card->rtd_list, list)
1225 soc_remove_link_components(card, rtd, order);
1228 list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1229 if (link->dobj.type == SND_SOC_DOBJ_DAI_LINK)
1230 dev_warn(card->dev, "Topology forgot to remove link %s?\n",
1233 list_del(&link->list);
1234 card->num_dai_links--;
1238 static int snd_soc_init_multicodec(struct snd_soc_card *card,
1239 struct snd_soc_dai_link *dai_link)
1241 /* Legacy codec/codec_dai link is a single entry in multicodec */
1242 if (dai_link->codec_name || dai_link->codec_of_node ||
1243 dai_link->codec_dai_name) {
1244 dai_link->num_codecs = 1;
1246 dai_link->codecs = devm_kzalloc(card->dev,
1247 sizeof(struct snd_soc_dai_link_component),
1249 if (!dai_link->codecs)
1252 dai_link->codecs[0].name = dai_link->codec_name;
1253 dai_link->codecs[0].of_node = dai_link->codec_of_node;
1254 dai_link->codecs[0].dai_name = dai_link->codec_dai_name;
1257 if (!dai_link->codecs) {
1258 dev_err(card->dev, "ASoC: DAI link has no CODECs\n");
1265 static int soc_init_dai_link(struct snd_soc_card *card,
1266 struct snd_soc_dai_link *link)
1270 ret = snd_soc_init_multicodec(card, link);
1272 dev_err(card->dev, "ASoC: failed to init multicodec\n");
1276 for (i = 0; i < link->num_codecs; i++) {
1278 * Codec must be specified by 1 of name or OF node,
1279 * not both or neither.
1281 if (!!link->codecs[i].name ==
1282 !!link->codecs[i].of_node) {
1283 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
1287 /* Codec DAI name must be specified */
1288 if (!link->codecs[i].dai_name) {
1289 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
1296 * Platform may be specified by either name or OF node, but
1297 * can be left unspecified, and a dummy platform will be used.
1299 if (link->platform_name && link->platform_of_node) {
1301 "ASoC: Both platform name/of_node are set for %s\n",
1307 * CPU device may be specified by either name or OF node, but
1308 * can be left unspecified, and will be matched based on DAI
1311 if (link->cpu_name && link->cpu_of_node) {
1313 "ASoC: Neither/both cpu name/of_node are set for %s\n",
1318 * At least one of CPU DAI name or CPU device name/node must be
1321 if (!link->cpu_dai_name &&
1322 !(link->cpu_name || link->cpu_of_node)) {
1324 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1333 * snd_soc_add_dai_link - Add a DAI link dynamically
1334 * @card: The ASoC card to which the DAI link is added
1335 * @dai_link: The new DAI link to add
1337 * This function adds a DAI link to the ASoC card's link list.
1339 * Note: Topology can use this API to add DAI links when probing the
1340 * topology component. And machine drivers can still define static
1341 * DAI links in dai_link array.
1343 int snd_soc_add_dai_link(struct snd_soc_card *card,
1344 struct snd_soc_dai_link *dai_link)
1346 if (dai_link->dobj.type
1347 && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1348 dev_err(card->dev, "Invalid dai link type %d\n",
1349 dai_link->dobj.type);
1353 lockdep_assert_held(&client_mutex);
1354 /* Notify the machine driver for extra initialization
1355 * on the link created by topology.
1357 if (dai_link->dobj.type && card->add_dai_link)
1358 card->add_dai_link(card, dai_link);
1360 list_add_tail(&dai_link->list, &card->dai_link_list);
1361 card->num_dai_links++;
1365 EXPORT_SYMBOL_GPL(snd_soc_add_dai_link);
1368 * snd_soc_remove_dai_link - Remove a DAI link from the list
1369 * @card: The ASoC card that owns the link
1370 * @dai_link: The DAI link to remove
1372 * This function removes a DAI link from the ASoC card's link list.
1374 * For DAI links previously added by topology, topology should
1375 * remove them by using the dobj embedded in the link.
1377 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1378 struct snd_soc_dai_link *dai_link)
1380 struct snd_soc_dai_link *link, *_link;
1382 if (dai_link->dobj.type
1383 && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1384 dev_err(card->dev, "Invalid dai link type %d\n",
1385 dai_link->dobj.type);
1389 lockdep_assert_held(&client_mutex);
1390 /* Notify the machine driver for extra destruction
1391 * on the link created by topology.
1393 if (dai_link->dobj.type && card->remove_dai_link)
1394 card->remove_dai_link(card, dai_link);
1396 list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1397 if (link == dai_link) {
1398 list_del(&link->list);
1399 card->num_dai_links--;
1404 EXPORT_SYMBOL_GPL(snd_soc_remove_dai_link);
1406 static void soc_set_name_prefix(struct snd_soc_card *card,
1407 struct snd_soc_component *component)
1411 if (card->codec_conf == NULL)
1414 for (i = 0; i < card->num_configs; i++) {
1415 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1416 if (map->of_node && component->dev->of_node != map->of_node)
1418 if (map->dev_name && strcmp(component->name, map->dev_name))
1420 component->name_prefix = map->name_prefix;
1425 static int soc_probe_component(struct snd_soc_card *card,
1426 struct snd_soc_component *component)
1428 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
1429 struct snd_soc_dai *dai;
1432 if (!strcmp(component->name, "snd-soc-dummy"))
1435 if (component->card) {
1436 if (component->card != card) {
1437 dev_err(component->dev,
1438 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1439 card->name, component->card->name);
1445 if (!try_module_get(component->dev->driver->owner))
1448 component->card = card;
1450 soc_set_name_prefix(card, component);
1452 soc_init_component_debugfs(component);
1454 if (component->dapm_widgets) {
1455 ret = snd_soc_dapm_new_controls(dapm, component->dapm_widgets,
1456 component->num_dapm_widgets);
1459 dev_err(component->dev,
1460 "Failed to create new controls %d\n", ret);
1465 list_for_each_entry(dai, &component->dai_list, list) {
1466 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1468 dev_err(component->dev,
1469 "Failed to create DAI widgets %d\n", ret);
1474 if (component->probe) {
1475 ret = component->probe(component);
1477 dev_err(component->dev,
1478 "ASoC: failed to probe component %d\n", ret);
1482 WARN(dapm->idle_bias_off &&
1483 dapm->bias_level != SND_SOC_BIAS_OFF,
1484 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1488 /* machine specific init */
1489 if (component->init) {
1490 ret = component->init(component);
1492 dev_err(component->dev,
1493 "Failed to do machine specific init %d\n", ret);
1498 if (component->controls)
1499 snd_soc_add_component_controls(component, component->controls,
1500 component->num_controls);
1501 if (component->dapm_routes)
1502 snd_soc_dapm_add_routes(dapm, component->dapm_routes,
1503 component->num_dapm_routes);
1505 list_add(&dapm->list, &card->dapm_list);
1506 list_add(&component->card_list, &card->component_dev_list);
1511 soc_cleanup_component_debugfs(component);
1512 component->card = NULL;
1513 module_put(component->dev->driver->owner);
1518 static void rtd_release(struct device *dev)
1523 static int soc_post_component_init(struct snd_soc_pcm_runtime *rtd,
1528 /* register the rtd device */
1529 rtd->dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1532 device_initialize(rtd->dev);
1533 rtd->dev->parent = rtd->card->dev;
1534 rtd->dev->release = rtd_release;
1535 rtd->dev->groups = soc_dev_attr_groups;
1536 dev_set_name(rtd->dev, "%s", name);
1537 dev_set_drvdata(rtd->dev, rtd);
1538 mutex_init(&rtd->pcm_mutex);
1539 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
1540 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
1541 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
1542 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
1543 ret = device_add(rtd->dev);
1545 /* calling put_device() here to free the rtd->dev */
1546 put_device(rtd->dev);
1547 dev_err(rtd->card->dev,
1548 "ASoC: failed to register runtime device: %d\n", ret);
1551 rtd->dev_registered = 1;
1555 static int soc_probe_link_components(struct snd_soc_card *card,
1556 struct snd_soc_pcm_runtime *rtd,
1559 struct snd_soc_platform *platform = rtd->platform;
1560 struct snd_soc_component *component;
1563 /* probe the CPU-side component, if it is a CODEC */
1564 component = rtd->cpu_dai->component;
1565 if (component->driver->probe_order == order) {
1566 ret = soc_probe_component(card, component);
1571 /* probe the CODEC-side components */
1572 for (i = 0; i < rtd->num_codecs; i++) {
1573 component = rtd->codec_dais[i]->component;
1574 if (component->driver->probe_order == order) {
1575 ret = soc_probe_component(card, component);
1581 /* probe the platform */
1582 if (platform->component.driver->probe_order == order) {
1583 ret = soc_probe_component(card, &platform->component);
1591 static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1595 if (!dai->probed && dai->driver->probe_order == order) {
1596 if (dai->driver->probe) {
1597 ret = dai->driver->probe(dai);
1600 "ASoC: failed to probe DAI %s: %d\n",
1612 static int soc_link_dai_pcm_new(struct snd_soc_dai **dais, int num_dais,
1613 struct snd_soc_pcm_runtime *rtd)
1617 for (i = 0; i < num_dais; ++i) {
1618 struct snd_soc_dai_driver *drv = dais[i]->driver;
1620 if (!rtd->dai_link->no_pcm && drv->pcm_new)
1621 ret = drv->pcm_new(rtd, dais[i]);
1623 dev_err(dais[i]->dev,
1624 "ASoC: Failed to bind %s with pcm device\n",
1633 static int soc_link_dai_widgets(struct snd_soc_card *card,
1634 struct snd_soc_dai_link *dai_link,
1635 struct snd_soc_pcm_runtime *rtd)
1637 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1638 struct snd_soc_dai *codec_dai = rtd->codec_dai;
1639 struct snd_soc_dapm_widget *sink, *source;
1642 if (rtd->num_codecs > 1)
1643 dev_warn(card->dev, "ASoC: Multiple codecs not supported yet\n");
1645 /* link the DAI widgets */
1646 sink = codec_dai->playback_widget;
1647 source = cpu_dai->capture_widget;
1648 if (sink && source) {
1649 ret = snd_soc_dapm_new_pcm(card, dai_link->params,
1650 dai_link->num_params,
1653 dev_err(card->dev, "ASoC: Can't link %s to %s: %d\n",
1654 sink->name, source->name, ret);
1659 sink = cpu_dai->playback_widget;
1660 source = codec_dai->capture_widget;
1661 if (sink && source) {
1662 ret = snd_soc_dapm_new_pcm(card, dai_link->params,
1663 dai_link->num_params,
1666 dev_err(card->dev, "ASoC: Can't link %s to %s: %d\n",
1667 sink->name, source->name, ret);
1675 static int soc_probe_link_dais(struct snd_soc_card *card,
1676 struct snd_soc_pcm_runtime *rtd, int order)
1678 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1679 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1682 dev_dbg(card->dev, "ASoC: probe %s dai link %d late %d\n",
1683 card->name, rtd->num, order);
1685 /* set default power off timeout */
1686 rtd->pmdown_time = pmdown_time;
1688 ret = soc_probe_dai(cpu_dai, order);
1692 /* probe the CODEC DAI */
1693 for (i = 0; i < rtd->num_codecs; i++) {
1694 ret = soc_probe_dai(rtd->codec_dais[i], order);
1699 /* complete DAI probe during last probe */
1700 if (order != SND_SOC_COMP_ORDER_LAST)
1703 /* do machine specific initialization */
1704 if (dai_link->init) {
1705 ret = dai_link->init(rtd);
1707 dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1708 dai_link->name, ret);
1713 if (dai_link->dai_fmt)
1714 snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1716 ret = soc_post_component_init(rtd, dai_link->name);
1720 #ifdef CONFIG_DEBUG_FS
1721 /* add DPCM sysfs entries */
1722 if (dai_link->dynamic)
1723 soc_dpcm_debugfs_add(rtd);
1726 if (cpu_dai->driver->compress_new) {
1727 /*create compress_device"*/
1728 ret = cpu_dai->driver->compress_new(rtd, rtd->num);
1730 dev_err(card->dev, "ASoC: can't create compress %s\n",
1731 dai_link->stream_name);
1736 if (!dai_link->params) {
1737 /* create the pcm */
1738 ret = soc_new_pcm(rtd, rtd->num);
1740 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1741 dai_link->stream_name, ret);
1744 ret = soc_link_dai_pcm_new(&cpu_dai, 1, rtd);
1747 ret = soc_link_dai_pcm_new(rtd->codec_dais,
1748 rtd->num_codecs, rtd);
1752 INIT_DELAYED_WORK(&rtd->delayed_work,
1753 codec2codec_close_delayed_work);
1755 /* link the DAI widgets */
1756 ret = soc_link_dai_widgets(card, dai_link, rtd);
1765 static int soc_bind_aux_dev(struct snd_soc_card *card, int num)
1767 struct snd_soc_aux_dev *aux_dev = &card->aux_dev[num];
1768 struct snd_soc_component *component;
1770 struct device_node *codec_of_node;
1772 if (aux_dev->codec_of_node || aux_dev->codec_name) {
1773 /* codecs, usually analog devices */
1774 name = aux_dev->codec_name;
1775 codec_of_node = aux_dev->codec_of_node;
1776 component = soc_find_component(codec_of_node, name);
1779 name = of_node_full_name(codec_of_node);
1782 } else if (aux_dev->name) {
1783 /* generic components */
1784 name = aux_dev->name;
1785 component = soc_find_component(NULL, name);
1789 dev_err(card->dev, "ASoC: Invalid auxiliary device\n");
1793 component->init = aux_dev->init;
1794 list_add(&component->card_aux_list, &card->aux_comp_list);
1799 dev_err(card->dev, "ASoC: %s not registered\n", name);
1800 return -EPROBE_DEFER;
1803 static int soc_probe_aux_devices(struct snd_soc_card *card)
1805 struct snd_soc_component *comp;
1809 for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1811 list_for_each_entry(comp, &card->aux_comp_list, card_aux_list) {
1812 if (comp->driver->probe_order == order) {
1813 ret = soc_probe_component(card, comp);
1816 "ASoC: failed to probe aux component %s %d\n",
1827 static void soc_remove_aux_devices(struct snd_soc_card *card)
1829 struct snd_soc_component *comp, *_comp;
1832 for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1834 list_for_each_entry_safe(comp, _comp,
1835 &card->aux_comp_list, card_aux_list) {
1837 if (comp->driver->remove_order == order) {
1838 soc_remove_component(comp);
1839 /* remove it from the card's aux_comp_list */
1840 list_del(&comp->card_aux_list);
1846 static int snd_soc_init_codec_cache(struct snd_soc_codec *codec)
1850 if (codec->cache_init)
1853 ret = snd_soc_cache_init(codec);
1856 "ASoC: Failed to set cache compression type: %d\n",
1860 codec->cache_init = 1;
1865 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1866 * @rtd: The runtime for which the DAI link format should be changed
1867 * @dai_fmt: The new DAI link format
1869 * This function updates the DAI link format for all DAIs connected to the DAI
1870 * link for the specified runtime.
1872 * Note: For setups with a static format set the dai_fmt field in the
1873 * corresponding snd_dai_link struct instead of using this function.
1875 * Returns 0 on success, otherwise a negative error code.
1877 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1878 unsigned int dai_fmt)
1880 struct snd_soc_dai **codec_dais = rtd->codec_dais;
1881 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1885 for (i = 0; i < rtd->num_codecs; i++) {
1886 struct snd_soc_dai *codec_dai = codec_dais[i];
1888 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1889 if (ret != 0 && ret != -ENOTSUPP) {
1890 dev_warn(codec_dai->dev,
1891 "ASoC: Failed to set DAI format: %d\n", ret);
1896 /* Flip the polarity for the "CPU" end of a CODEC<->CODEC link */
1897 if (cpu_dai->codec) {
1898 unsigned int inv_dai_fmt;
1900 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1901 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1902 case SND_SOC_DAIFMT_CBM_CFM:
1903 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1905 case SND_SOC_DAIFMT_CBM_CFS:
1906 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1908 case SND_SOC_DAIFMT_CBS_CFM:
1909 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1911 case SND_SOC_DAIFMT_CBS_CFS:
1912 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1916 dai_fmt = inv_dai_fmt;
1919 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1920 if (ret != 0 && ret != -ENOTSUPP) {
1921 dev_warn(cpu_dai->dev,
1922 "ASoC: Failed to set DAI format: %d\n", ret);
1928 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1932 /* Trim special characters, and replace '-' with '_' since '-' is used to
1933 * separate different DMI fields in the card long name. Only number and
1934 * alphabet characters and a few separator characters are kept.
1936 static void cleanup_dmi_name(char *name)
1940 for (i = 0; name[i]; i++) {
1941 if (isalnum(name[i]) || (name[i] == '.')
1942 || (name[i] == '_'))
1943 name[j++] = name[i];
1944 else if (name[i] == '-')
1951 /* Check if a DMI field is valid, i.e. not containing any string
1952 * in the black list.
1954 static int is_dmi_valid(const char *field)
1958 while (dmi_blacklist[i]) {
1959 if (strstr(field, dmi_blacklist[i]))
1968 * snd_soc_set_dmi_name() - Register DMI names to card
1969 * @card: The card to register DMI names
1970 * @flavour: The flavour "differentiator" for the card amongst its peers.
1972 * An Intel machine driver may be used by many different devices but are
1973 * difficult for userspace to differentiate, since machine drivers ususally
1974 * use their own name as the card short name and leave the card long name
1975 * blank. To differentiate such devices and fix bugs due to lack of
1976 * device-specific configurations, this function allows DMI info to be used
1977 * as the sound card long name, in the format of
1978 * "vendor-product-version-board"
1979 * (Character '-' is used to separate different DMI fields here).
1980 * This will help the user space to load the device-specific Use Case Manager
1981 * (UCM) configurations for the card.
1983 * Possible card long names may be:
1984 * DellInc.-XPS139343-01-0310JH
1985 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1986 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1988 * This function also supports flavoring the card longname to provide
1989 * the extra differentiation, like "vendor-product-version-board-flavor".
1991 * We only keep number and alphabet characters and a few separator characters
1992 * in the card long name since UCM in the user space uses the card long names
1993 * as card configuration directory names and AudoConf cannot support special
1994 * charactors like SPACE.
1996 * Returns 0 on success, otherwise a negative error code.
1998 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
2000 const char *vendor, *product, *product_version, *board;
2001 size_t longname_buf_size = sizeof(card->snd_card->longname);
2004 if (card->long_name)
2005 return 0; /* long name already set by driver or from DMI */
2007 /* make up dmi long name as: vendor.product.version.board */
2008 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
2009 if (!vendor || !is_dmi_valid(vendor)) {
2010 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
2015 snprintf(card->dmi_longname, sizeof(card->snd_card->longname),
2017 cleanup_dmi_name(card->dmi_longname);
2019 product = dmi_get_system_info(DMI_PRODUCT_NAME);
2020 if (product && is_dmi_valid(product)) {
2021 len = strlen(card->dmi_longname);
2022 snprintf(card->dmi_longname + len,
2023 longname_buf_size - len,
2026 len++; /* skip the separator "-" */
2027 if (len < longname_buf_size)
2028 cleanup_dmi_name(card->dmi_longname + len);
2030 /* some vendors like Lenovo may only put a self-explanatory
2031 * name in the product version field
2033 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
2034 if (product_version && is_dmi_valid(product_version)) {
2035 len = strlen(card->dmi_longname);
2036 snprintf(card->dmi_longname + len,
2037 longname_buf_size - len,
2038 "-%s", product_version);
2041 if (len < longname_buf_size)
2042 cleanup_dmi_name(card->dmi_longname + len);
2046 board = dmi_get_system_info(DMI_BOARD_NAME);
2047 if (board && is_dmi_valid(board)) {
2048 len = strlen(card->dmi_longname);
2049 snprintf(card->dmi_longname + len,
2050 longname_buf_size - len,
2054 if (len < longname_buf_size)
2055 cleanup_dmi_name(card->dmi_longname + len);
2056 } else if (!product) {
2057 /* fall back to using legacy name */
2058 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
2062 /* Add flavour to dmi long name */
2064 len = strlen(card->dmi_longname);
2065 snprintf(card->dmi_longname + len,
2066 longname_buf_size - len,
2070 if (len < longname_buf_size)
2071 cleanup_dmi_name(card->dmi_longname + len);
2074 /* set the card long name */
2075 card->long_name = card->dmi_longname;
2079 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
2080 #endif /* CONFIG_DMI */
2082 static int snd_soc_instantiate_card(struct snd_soc_card *card)
2084 struct snd_soc_codec *codec;
2085 struct snd_soc_pcm_runtime *rtd;
2086 struct snd_soc_dai_link *dai_link;
2089 mutex_lock(&client_mutex);
2090 mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
2093 for (i = 0; i < card->num_links; i++) {
2094 ret = soc_bind_dai_link(card, &card->dai_link[i]);
2099 /* bind aux_devs too */
2100 for (i = 0; i < card->num_aux_devs; i++) {
2101 ret = soc_bind_aux_dev(card, i);
2106 /* add predefined DAI links to the list */
2107 for (i = 0; i < card->num_links; i++)
2108 snd_soc_add_dai_link(card, card->dai_link+i);
2110 /* initialize the register cache for each available codec */
2111 list_for_each_entry(codec, &codec_list, list) {
2112 if (codec->cache_init)
2114 ret = snd_soc_init_codec_cache(codec);
2119 /* card bind complete so register a sound card */
2120 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2121 card->owner, 0, &card->snd_card);
2124 "ASoC: can't create sound card for card %s: %d\n",
2129 soc_init_card_debugfs(card);
2131 card->dapm.bias_level = SND_SOC_BIAS_OFF;
2132 card->dapm.dev = card->dev;
2133 card->dapm.card = card;
2134 list_add(&card->dapm.list, &card->dapm_list);
2136 #ifdef CONFIG_DEBUG_FS
2137 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
2140 #ifdef CONFIG_PM_SLEEP
2141 /* deferred resume work */
2142 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
2145 if (card->dapm_widgets)
2146 snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2147 card->num_dapm_widgets);
2149 if (card->of_dapm_widgets)
2150 snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2151 card->num_of_dapm_widgets);
2153 /* initialise the sound card only once */
2155 ret = card->probe(card);
2157 goto card_probe_error;
2160 /* probe all components used by DAI links on this card */
2161 for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
2163 list_for_each_entry(rtd, &card->rtd_list, list) {
2164 ret = soc_probe_link_components(card, rtd, order);
2167 "ASoC: failed to instantiate card %d\n",
2174 /* probe auxiliary components */
2175 ret = soc_probe_aux_devices(card);
2179 /* Find new DAI links added during probing components and bind them.
2180 * Components with topology may bring new DAIs and DAI links.
2182 list_for_each_entry(dai_link, &card->dai_link_list, list) {
2183 if (soc_is_dai_link_bound(card, dai_link))
2186 ret = soc_init_dai_link(card, dai_link);
2189 ret = soc_bind_dai_link(card, dai_link);
2194 /* probe all DAI links on this card */
2195 for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
2197 list_for_each_entry(rtd, &card->rtd_list, list) {
2198 ret = soc_probe_link_dais(card, rtd, order);
2201 "ASoC: failed to instantiate card %d\n",
2208 snd_soc_dapm_link_dai_widgets(card);
2209 snd_soc_dapm_connect_dai_link_widgets(card);
2212 snd_soc_add_card_controls(card, card->controls, card->num_controls);
2214 if (card->dapm_routes)
2215 snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2216 card->num_dapm_routes);
2218 if (card->of_dapm_routes)
2219 snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2220 card->num_of_dapm_routes);
2222 /* try to set some sane longname if DMI is available */
2223 snd_soc_set_dmi_name(card, NULL);
2225 snprintf(card->snd_card->shortname, sizeof(card->snd_card->shortname),
2227 snprintf(card->snd_card->longname, sizeof(card->snd_card->longname),
2228 "%s", card->long_name ? card->long_name : card->name);
2229 snprintf(card->snd_card->driver, sizeof(card->snd_card->driver),
2230 "%s", card->driver_name ? card->driver_name : card->name);
2231 for (i = 0; i < ARRAY_SIZE(card->snd_card->driver); i++) {
2232 switch (card->snd_card->driver[i]) {
2238 if (!isalnum(card->snd_card->driver[i]))
2239 card->snd_card->driver[i] = '_';
2244 if (card->late_probe) {
2245 ret = card->late_probe(card);
2247 dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2249 goto probe_aux_dev_err;
2253 snd_soc_dapm_new_widgets(card);
2255 ret = snd_card_register(card->snd_card);
2257 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2259 goto probe_aux_dev_err;
2262 card->instantiated = 1;
2263 snd_soc_dapm_sync(&card->dapm);
2264 mutex_unlock(&card->mutex);
2265 mutex_unlock(&client_mutex);
2270 soc_remove_aux_devices(card);
2273 soc_remove_dai_links(card);
2279 snd_soc_dapm_free(&card->dapm);
2280 soc_cleanup_card_debugfs(card);
2281 snd_card_free(card->snd_card);
2284 soc_remove_pcm_runtimes(card);
2285 mutex_unlock(&card->mutex);
2286 mutex_unlock(&client_mutex);
2291 /* probes a new socdev */
2292 static int soc_probe(struct platform_device *pdev)
2294 struct snd_soc_card *card = platform_get_drvdata(pdev);
2297 * no card, so machine driver should be registering card
2298 * we should not be here in that case so ret error
2303 dev_warn(&pdev->dev,
2304 "ASoC: machine %s should use snd_soc_register_card()\n",
2307 /* Bodge while we unpick instantiation */
2308 card->dev = &pdev->dev;
2310 return snd_soc_register_card(card);
2313 static int soc_cleanup_card_resources(struct snd_soc_card *card)
2315 struct snd_soc_pcm_runtime *rtd;
2317 /* make sure any delayed work runs */
2318 list_for_each_entry(rtd, &card->rtd_list, list)
2319 flush_delayed_work(&rtd->delayed_work);
2321 /* free the ALSA card at first; this syncs with pending operations */
2322 snd_card_free(card->snd_card);
2324 /* remove and free each DAI */
2325 soc_remove_dai_links(card);
2326 soc_remove_pcm_runtimes(card);
2328 /* remove auxiliary devices */
2329 soc_remove_aux_devices(card);
2331 snd_soc_dapm_free(&card->dapm);
2332 soc_cleanup_card_debugfs(card);
2334 /* remove the card */
2341 /* removes a socdev */
2342 static int soc_remove(struct platform_device *pdev)
2344 struct snd_soc_card *card = platform_get_drvdata(pdev);
2346 snd_soc_unregister_card(card);
2350 int snd_soc_poweroff(struct device *dev)
2352 struct snd_soc_card *card = dev_get_drvdata(dev);
2353 struct snd_soc_pcm_runtime *rtd;
2355 if (!card->instantiated)
2358 /* Flush out pmdown_time work - we actually do want to run it
2359 * now, we're shutting down so no imminent restart. */
2360 list_for_each_entry(rtd, &card->rtd_list, list)
2361 flush_delayed_work(&rtd->delayed_work);
2363 snd_soc_dapm_shutdown(card);
2365 /* deactivate pins to sleep state */
2366 list_for_each_entry(rtd, &card->rtd_list, list) {
2367 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2370 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2371 for (i = 0; i < rtd->num_codecs; i++) {
2372 struct snd_soc_dai *codec_dai = rtd->codec_dais[i];
2373 pinctrl_pm_select_sleep_state(codec_dai->dev);
2379 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2381 const struct dev_pm_ops snd_soc_pm_ops = {
2382 .suspend = snd_soc_suspend,
2383 .resume = snd_soc_resume,
2384 .freeze = snd_soc_suspend,
2385 .thaw = snd_soc_resume,
2386 .poweroff = snd_soc_poweroff,
2387 .restore = snd_soc_resume,
2389 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2391 /* ASoC platform driver */
2392 static struct platform_driver soc_driver = {
2394 .name = "soc-audio",
2395 .pm = &snd_soc_pm_ops,
2398 .remove = soc_remove,
2402 * snd_soc_cnew - create new control
2403 * @_template: control template
2404 * @data: control private data
2405 * @long_name: control long name
2406 * @prefix: control name prefix
2408 * Create a new mixer control from a template control.
2410 * Returns 0 for success, else error.
2412 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2413 void *data, const char *long_name,
2416 struct snd_kcontrol_new template;
2417 struct snd_kcontrol *kcontrol;
2420 memcpy(&template, _template, sizeof(template));
2424 long_name = template.name;
2427 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2431 template.name = name;
2433 template.name = long_name;
2436 kcontrol = snd_ctl_new1(&template, data);
2442 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2444 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2445 const struct snd_kcontrol_new *controls, int num_controls,
2446 const char *prefix, void *data)
2450 for (i = 0; i < num_controls; i++) {
2451 const struct snd_kcontrol_new *control = &controls[i];
2452 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2453 control->name, prefix));
2455 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2456 control->name, err);
2464 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2467 struct snd_card *card = soc_card->snd_card;
2468 struct snd_kcontrol *kctl;
2470 if (unlikely(!name))
2473 list_for_each_entry(kctl, &card->controls, list)
2474 if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2478 EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2481 * snd_soc_add_component_controls - Add an array of controls to a component.
2483 * @component: Component to add controls to
2484 * @controls: Array of controls to add
2485 * @num_controls: Number of elements in the array
2487 * Return: 0 for success, else error.
2489 int snd_soc_add_component_controls(struct snd_soc_component *component,
2490 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2492 struct snd_card *card = component->card->snd_card;
2494 return snd_soc_add_controls(card, component->dev, controls,
2495 num_controls, component->name_prefix, component);
2497 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2500 * snd_soc_add_codec_controls - add an array of controls to a codec.
2501 * Convenience function to add a list of controls. Many codecs were
2502 * duplicating this code.
2504 * @codec: codec to add controls to
2505 * @controls: array of controls to add
2506 * @num_controls: number of elements in the array
2508 * Return 0 for success, else error.
2510 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
2511 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2513 return snd_soc_add_component_controls(&codec->component, controls,
2516 EXPORT_SYMBOL_GPL(snd_soc_add_codec_controls);
2519 * snd_soc_add_platform_controls - add an array of controls to a platform.
2520 * Convenience function to add a list of controls.
2522 * @platform: platform to add controls to
2523 * @controls: array of controls to add
2524 * @num_controls: number of elements in the array
2526 * Return 0 for success, else error.
2528 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
2529 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2531 return snd_soc_add_component_controls(&platform->component, controls,
2534 EXPORT_SYMBOL_GPL(snd_soc_add_platform_controls);
2537 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2538 * Convenience function to add a list of controls.
2540 * @soc_card: SoC card to add controls to
2541 * @controls: array of controls to add
2542 * @num_controls: number of elements in the array
2544 * Return 0 for success, else error.
2546 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2547 const struct snd_kcontrol_new *controls, int num_controls)
2549 struct snd_card *card = soc_card->snd_card;
2551 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2554 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2557 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2558 * Convienience function to add a list of controls.
2560 * @dai: DAI to add controls to
2561 * @controls: array of controls to add
2562 * @num_controls: number of elements in the array
2564 * Return 0 for success, else error.
2566 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2567 const struct snd_kcontrol_new *controls, int num_controls)
2569 struct snd_card *card = dai->component->card->snd_card;
2571 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2574 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2577 * snd_soc_dai_set_sysclk - configure DAI system or master clock.
2579 * @clk_id: DAI specific clock ID
2580 * @freq: new clock frequency in Hz
2581 * @dir: new clock direction - input/output.
2583 * Configures the DAI master (MCLK) or system (SYSCLK) clocking.
2585 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
2586 unsigned int freq, int dir)
2588 if (dai->driver && dai->driver->ops->set_sysclk)
2589 return dai->driver->ops->set_sysclk(dai, clk_id, freq, dir);
2590 else if (dai->codec && dai->codec->driver->set_sysclk)
2591 return dai->codec->driver->set_sysclk(dai->codec, clk_id, 0,
2596 EXPORT_SYMBOL_GPL(snd_soc_dai_set_sysclk);
2599 * snd_soc_codec_set_sysclk - configure CODEC system or master clock.
2601 * @clk_id: DAI specific clock ID
2602 * @source: Source for the clock
2603 * @freq: new clock frequency in Hz
2604 * @dir: new clock direction - input/output.
2606 * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
2608 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
2609 int source, unsigned int freq, int dir)
2611 if (codec->driver->set_sysclk)
2612 return codec->driver->set_sysclk(codec, clk_id, source,
2617 EXPORT_SYMBOL_GPL(snd_soc_codec_set_sysclk);
2620 * snd_soc_dai_set_clkdiv - configure DAI clock dividers.
2622 * @div_id: DAI specific clock divider ID
2623 * @div: new clock divisor.
2625 * Configures the clock dividers. This is used to derive the best DAI bit and
2626 * frame clocks from the system or master clock. It's best to set the DAI bit
2627 * and frame clocks as low as possible to save system power.
2629 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
2630 int div_id, int div)
2632 if (dai->driver && dai->driver->ops->set_clkdiv)
2633 return dai->driver->ops->set_clkdiv(dai, div_id, div);
2637 EXPORT_SYMBOL_GPL(snd_soc_dai_set_clkdiv);
2640 * snd_soc_dai_set_pll - configure DAI PLL.
2642 * @pll_id: DAI specific PLL ID
2643 * @source: DAI specific source for the PLL
2644 * @freq_in: PLL input clock frequency in Hz
2645 * @freq_out: requested PLL output clock frequency in Hz
2647 * Configures and enables PLL to generate output clock based on input clock.
2649 int snd_soc_dai_set_pll(struct snd_soc_dai *dai, int pll_id, int source,
2650 unsigned int freq_in, unsigned int freq_out)
2652 if (dai->driver && dai->driver->ops->set_pll)
2653 return dai->driver->ops->set_pll(dai, pll_id, source,
2655 else if (dai->codec && dai->codec->driver->set_pll)
2656 return dai->codec->driver->set_pll(dai->codec, pll_id, source,
2661 EXPORT_SYMBOL_GPL(snd_soc_dai_set_pll);
2664 * snd_soc_codec_set_pll - configure codec PLL.
2666 * @pll_id: DAI specific PLL ID
2667 * @source: DAI specific source for the PLL
2668 * @freq_in: PLL input clock frequency in Hz
2669 * @freq_out: requested PLL output clock frequency in Hz
2671 * Configures and enables PLL to generate output clock based on input clock.
2673 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
2674 unsigned int freq_in, unsigned int freq_out)
2676 if (codec->driver->set_pll)
2677 return codec->driver->set_pll(codec, pll_id, source,
2682 EXPORT_SYMBOL_GPL(snd_soc_codec_set_pll);
2685 * snd_soc_dai_set_bclk_ratio - configure BCLK to sample rate ratio.
2687 * @ratio: Ratio of BCLK to Sample rate.
2689 * Configures the DAI for a preset BCLK to sample rate ratio.
2691 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio)
2693 if (dai->driver && dai->driver->ops->set_bclk_ratio)
2694 return dai->driver->ops->set_bclk_ratio(dai, ratio);
2698 EXPORT_SYMBOL_GPL(snd_soc_dai_set_bclk_ratio);
2701 * snd_soc_dai_set_fmt - configure DAI hardware audio format.
2703 * @fmt: SND_SOC_DAIFMT_ format value.
2705 * Configures the DAI hardware format and clocking.
2707 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
2709 if (dai->driver == NULL)
2711 if (dai->driver->ops->set_fmt == NULL)
2713 return dai->driver->ops->set_fmt(dai, fmt);
2715 EXPORT_SYMBOL_GPL(snd_soc_dai_set_fmt);
2718 * snd_soc_xlate_tdm_slot - generate tx/rx slot mask.
2719 * @slots: Number of slots in use.
2720 * @tx_mask: bitmask representing active TX slots.
2721 * @rx_mask: bitmask representing active RX slots.
2723 * Generates the TDM tx and rx slot default masks for DAI.
2725 static int snd_soc_xlate_tdm_slot_mask(unsigned int slots,
2726 unsigned int *tx_mask,
2727 unsigned int *rx_mask)
2729 if (*tx_mask || *rx_mask)
2735 *tx_mask = (1 << slots) - 1;
2736 *rx_mask = (1 << slots) - 1;
2742 * snd_soc_dai_set_tdm_slot() - Configures a DAI for TDM operation
2743 * @dai: The DAI to configure
2744 * @tx_mask: bitmask representing active TX slots.
2745 * @rx_mask: bitmask representing active RX slots.
2746 * @slots: Number of slots in use.
2747 * @slot_width: Width in bits for each slot.
2749 * This function configures the specified DAI for TDM operation. @slot contains
2750 * the total number of slots of the TDM stream and @slot_with the width of each
2751 * slot in bit clock cycles. @tx_mask and @rx_mask are bitmasks specifying the
2752 * active slots of the TDM stream for the specified DAI, i.e. which slots the
2753 * DAI should write to or read from. If a bit is set the corresponding slot is
2754 * active, if a bit is cleared the corresponding slot is inactive. Bit 0 maps to
2755 * the first slot, bit 1 to the second slot and so on. The first active slot
2756 * maps to the first channel of the DAI, the second active slot to the second
2757 * channel and so on.
2759 * TDM mode can be disabled by passing 0 for @slots. In this case @tx_mask,
2760 * @rx_mask and @slot_width will be ignored.
2762 * Returns 0 on success, a negative error code otherwise.
2764 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
2765 unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width)
2767 if (dai->driver && dai->driver->ops->xlate_tdm_slot_mask)
2768 dai->driver->ops->xlate_tdm_slot_mask(slots,
2769 &tx_mask, &rx_mask);
2771 snd_soc_xlate_tdm_slot_mask(slots, &tx_mask, &rx_mask);
2773 dai->tx_mask = tx_mask;
2774 dai->rx_mask = rx_mask;
2776 if (dai->driver && dai->driver->ops->set_tdm_slot)
2777 return dai->driver->ops->set_tdm_slot(dai, tx_mask, rx_mask,
2782 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tdm_slot);
2785 * snd_soc_dai_set_channel_map - configure DAI audio channel map
2787 * @tx_num: how many TX channels
2788 * @tx_slot: pointer to an array which imply the TX slot number channel
2790 * @rx_num: how many RX channels
2791 * @rx_slot: pointer to an array which imply the RX slot number channel
2794 * configure the relationship between channel number and TDM slot number.
2796 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
2797 unsigned int tx_num, unsigned int *tx_slot,
2798 unsigned int rx_num, unsigned int *rx_slot)
2800 if (dai->driver && dai->driver->ops->set_channel_map)
2801 return dai->driver->ops->set_channel_map(dai, tx_num, tx_slot,
2806 EXPORT_SYMBOL_GPL(snd_soc_dai_set_channel_map);
2809 * snd_soc_dai_set_tristate - configure DAI system or master clock.
2811 * @tristate: tristate enable
2813 * Tristates the DAI so that others can use it.
2815 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate)
2817 if (dai->driver && dai->driver->ops->set_tristate)
2818 return dai->driver->ops->set_tristate(dai, tristate);
2822 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tristate);
2825 * snd_soc_dai_digital_mute - configure DAI system or master clock.
2827 * @mute: mute enable
2828 * @direction: stream to mute
2830 * Mutes the DAI DAC.
2832 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
2838 if (dai->driver->ops->mute_stream)
2839 return dai->driver->ops->mute_stream(dai, mute, direction);
2840 else if (direction == SNDRV_PCM_STREAM_PLAYBACK &&
2841 dai->driver->ops->digital_mute)
2842 return dai->driver->ops->digital_mute(dai, mute);
2846 EXPORT_SYMBOL_GPL(snd_soc_dai_digital_mute);
2849 * snd_soc_register_card - Register a card with the ASoC core
2851 * @card: Card to register
2854 int snd_soc_register_card(struct snd_soc_card *card)
2857 struct snd_soc_pcm_runtime *rtd;
2859 if (!card->name || !card->dev)
2862 for (i = 0; i < card->num_links; i++) {
2863 struct snd_soc_dai_link *link = &card->dai_link[i];
2865 ret = soc_init_dai_link(card, link);
2867 dev_err(card->dev, "ASoC: failed to init link %s\n",
2873 dev_set_drvdata(card->dev, card);
2875 snd_soc_initialize_card_lists(card);
2877 INIT_LIST_HEAD(&card->dai_link_list);
2878 card->num_dai_links = 0;
2880 INIT_LIST_HEAD(&card->rtd_list);
2883 INIT_LIST_HEAD(&card->dapm_dirty);
2884 INIT_LIST_HEAD(&card->dobj_list);
2885 card->instantiated = 0;
2886 mutex_init(&card->mutex);
2887 mutex_init(&card->dapm_mutex);
2889 ret = snd_soc_instantiate_card(card);
2893 /* deactivate pins to sleep state */
2894 list_for_each_entry(rtd, &card->rtd_list, list) {
2895 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2898 for (j = 0; j < rtd->num_codecs; j++) {
2899 struct snd_soc_dai *codec_dai = rtd->codec_dais[j];
2900 if (!codec_dai->active)
2901 pinctrl_pm_select_sleep_state(codec_dai->dev);
2904 if (!cpu_dai->active)
2905 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2910 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2913 * snd_soc_unregister_card - Unregister a card with the ASoC core
2915 * @card: Card to unregister
2918 int snd_soc_unregister_card(struct snd_soc_card *card)
2920 if (card->instantiated) {
2921 card->instantiated = false;
2922 snd_soc_dapm_shutdown(card);
2923 soc_cleanup_card_resources(card);
2924 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2929 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2932 * Simplify DAI link configuration by removing ".-1" from device names
2933 * and sanitizing names.
2935 static char *fmt_single_name(struct device *dev, int *id)
2937 char *found, name[NAME_SIZE];
2940 if (dev_name(dev) == NULL)
2943 strlcpy(name, dev_name(dev), NAME_SIZE);
2945 /* are we a "%s.%d" name (platform and SPI components) */
2946 found = strstr(name, dev->driver->name);
2949 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2951 /* discard ID from name if ID == -1 */
2953 found[strlen(dev->driver->name)] = '\0';
2957 /* I2C component devices are named "bus-addr" */
2958 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2959 char tmp[NAME_SIZE];
2961 /* create unique ID number from I2C addr and bus */
2962 *id = ((id1 & 0xffff) << 16) + id2;
2964 /* sanitize component name for DAI link creation */
2965 snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name, name);
2966 strlcpy(name, tmp, NAME_SIZE);
2971 return kstrdup(name, GFP_KERNEL);
2975 * Simplify DAI link naming for single devices with multiple DAIs by removing
2976 * any ".-1" and using the DAI name (instead of device name).
2978 static inline char *fmt_multiple_name(struct device *dev,
2979 struct snd_soc_dai_driver *dai_drv)
2981 if (dai_drv->name == NULL) {
2983 "ASoC: error - multiple DAI %s registered with no name\n",
2988 return kstrdup(dai_drv->name, GFP_KERNEL);
2992 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2994 * @component: The component for which the DAIs should be unregistered
2996 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2998 struct snd_soc_dai *dai, *_dai;
3000 list_for_each_entry_safe(dai, _dai, &component->dai_list, list) {
3001 dev_dbg(component->dev, "ASoC: Unregistered DAI '%s'\n",
3003 list_del(&dai->list);
3009 /* Create a DAI and add it to the component's DAI list */
3010 static struct snd_soc_dai *soc_add_dai(struct snd_soc_component *component,
3011 struct snd_soc_dai_driver *dai_drv,
3012 bool legacy_dai_naming)
3014 struct device *dev = component->dev;
3015 struct snd_soc_dai *dai;
3017 dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
3019 dai = kzalloc(sizeof(struct snd_soc_dai), GFP_KERNEL);
3024 * Back in the old days when we still had component-less DAIs,
3025 * instead of having a static name, component-less DAIs would
3026 * inherit the name of the parent device so it is possible to
3027 * register multiple instances of the DAI. We still need to keep
3028 * the same naming style even though those DAIs are not
3029 * component-less anymore.
3031 if (legacy_dai_naming &&
3032 (dai_drv->id == 0 || dai_drv->name == NULL)) {
3033 dai->name = fmt_single_name(dev, &dai->id);
3035 dai->name = fmt_multiple_name(dev, dai_drv);
3037 dai->id = dai_drv->id;
3039 dai->id = component->num_dai;
3041 if (dai->name == NULL) {
3046 dai->component = component;
3048 dai->driver = dai_drv;
3049 if (!dai->driver->ops)
3050 dai->driver->ops = &null_dai_ops;
3052 list_add(&dai->list, &component->dai_list);
3053 component->num_dai++;
3055 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
3060 * snd_soc_register_dais - Register a DAI with the ASoC core
3062 * @component: The component the DAIs are registered for
3063 * @dai_drv: DAI driver to use for the DAIs
3064 * @count: Number of DAIs
3065 * @legacy_dai_naming: Use the legacy naming scheme and let the DAI inherit the
3068 static int snd_soc_register_dais(struct snd_soc_component *component,
3069 struct snd_soc_dai_driver *dai_drv, size_t count,
3070 bool legacy_dai_naming)
3072 struct device *dev = component->dev;
3073 struct snd_soc_dai *dai;
3077 dev_dbg(dev, "ASoC: dai register %s #%zu\n", dev_name(dev), count);
3079 component->dai_drv = dai_drv;
3081 for (i = 0; i < count; i++) {
3083 dai = soc_add_dai(component, dai_drv + i,
3084 count == 1 && legacy_dai_naming);
3094 snd_soc_unregister_dais(component);
3100 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
3102 * @component: The component the DAIs are registered for
3103 * @dai_drv: DAI driver to use for the DAI
3105 * Topology can use this API to register DAIs when probing a component.
3106 * These DAIs's widgets will be freed in the card cleanup and the DAIs
3107 * will be freed in the component cleanup.
3109 int snd_soc_register_dai(struct snd_soc_component *component,
3110 struct snd_soc_dai_driver *dai_drv)
3112 struct snd_soc_dapm_context *dapm =
3113 snd_soc_component_get_dapm(component);
3114 struct snd_soc_dai *dai;
3117 if (dai_drv->dobj.type != SND_SOC_DOBJ_PCM) {
3118 dev_err(component->dev, "Invalid dai type %d\n",
3119 dai_drv->dobj.type);
3123 lockdep_assert_held(&client_mutex);
3124 dai = soc_add_dai(component, dai_drv, false);
3128 /* Create the DAI widgets here. After adding DAIs, topology may
3129 * also add routes that need these widgets as source or sink.
3131 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
3133 dev_err(component->dev,
3134 "Failed to create DAI widgets %d\n", ret);
3139 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
3141 static void snd_soc_component_seq_notifier(struct snd_soc_dapm_context *dapm,
3142 enum snd_soc_dapm_type type, int subseq)
3144 struct snd_soc_component *component = dapm->component;
3146 component->driver->seq_notifier(component, type, subseq);
3149 static int snd_soc_component_stream_event(struct snd_soc_dapm_context *dapm,
3152 struct snd_soc_component *component = dapm->component;
3154 return component->driver->stream_event(component, event);
3157 static int snd_soc_component_initialize(struct snd_soc_component *component,
3158 const struct snd_soc_component_driver *driver, struct device *dev)
3160 struct snd_soc_dapm_context *dapm;
3162 component->name = fmt_single_name(dev, &component->id);
3163 if (!component->name) {
3164 dev_err(dev, "ASoC: Failed to allocate name\n");
3168 component->dev = dev;
3169 component->driver = driver;
3170 component->probe = component->driver->probe;
3171 component->remove = component->driver->remove;
3172 component->suspend = component->driver->suspend;
3173 component->resume = component->driver->resume;
3175 dapm = &component->dapm;
3177 dapm->component = component;
3178 dapm->bias_level = SND_SOC_BIAS_OFF;
3179 dapm->idle_bias_off = true;
3180 if (driver->seq_notifier)
3181 dapm->seq_notifier = snd_soc_component_seq_notifier;
3182 if (driver->stream_event)
3183 dapm->stream_event = snd_soc_component_stream_event;
3185 component->controls = driver->controls;
3186 component->num_controls = driver->num_controls;
3187 component->dapm_widgets = driver->dapm_widgets;
3188 component->num_dapm_widgets = driver->num_dapm_widgets;
3189 component->dapm_routes = driver->dapm_routes;
3190 component->num_dapm_routes = driver->num_dapm_routes;
3192 INIT_LIST_HEAD(&component->dai_list);
3193 mutex_init(&component->io_mutex);
3198 static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
3200 int val_bytes = regmap_get_val_bytes(component->regmap);
3202 /* Errors are legitimate for non-integer byte multiples */
3204 component->val_bytes = val_bytes;
3207 #ifdef CONFIG_REGMAP
3210 * snd_soc_component_init_regmap() - Initialize regmap instance for the component
3211 * @component: The component for which to initialize the regmap instance
3212 * @regmap: The regmap instance that should be used by the component
3214 * This function allows deferred assignment of the regmap instance that is
3215 * associated with the component. Only use this if the regmap instance is not
3216 * yet ready when the component is registered. The function must also be called
3217 * before the first IO attempt of the component.
3219 void snd_soc_component_init_regmap(struct snd_soc_component *component,
3220 struct regmap *regmap)
3222 component->regmap = regmap;
3223 snd_soc_component_setup_regmap(component);
3225 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
3228 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the component
3229 * @component: The component for which to de-initialize the regmap instance
3231 * Calls regmap_exit() on the regmap instance associated to the component and
3232 * removes the regmap instance from the component.
3234 * This function should only be used if snd_soc_component_init_regmap() was used
3235 * to initialize the regmap instance.
3237 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
3239 regmap_exit(component->regmap);
3240 component->regmap = NULL;
3242 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
3246 static void snd_soc_component_add_unlocked(struct snd_soc_component *component)
3248 if (!component->write && !component->read) {
3249 if (!component->regmap)
3250 component->regmap = dev_get_regmap(component->dev, NULL);
3251 if (component->regmap)
3252 snd_soc_component_setup_regmap(component);
3255 list_add(&component->list, &component_list);
3256 INIT_LIST_HEAD(&component->dobj_list);
3259 static void snd_soc_component_add(struct snd_soc_component *component)
3261 mutex_lock(&client_mutex);
3262 snd_soc_component_add_unlocked(component);
3263 mutex_unlock(&client_mutex);
3266 static void snd_soc_component_cleanup(struct snd_soc_component *component)
3268 snd_soc_unregister_dais(component);
3269 kfree(component->name);
3272 static void snd_soc_component_del_unlocked(struct snd_soc_component *component)
3274 struct snd_soc_card *card = component->card;
3277 snd_soc_unregister_card(card);
3279 list_del(&component->list);
3282 int snd_soc_register_component(struct device *dev,
3283 const struct snd_soc_component_driver *cmpnt_drv,
3284 struct snd_soc_dai_driver *dai_drv,
3287 struct snd_soc_component *cmpnt;
3290 cmpnt = kzalloc(sizeof(*cmpnt), GFP_KERNEL);
3292 dev_err(dev, "ASoC: Failed to allocate memory\n");
3296 ret = snd_soc_component_initialize(cmpnt, cmpnt_drv, dev);
3300 cmpnt->ignore_pmdown_time = true;
3301 cmpnt->registered_as_component = true;
3303 ret = snd_soc_register_dais(cmpnt, dai_drv, num_dai, true);
3305 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3309 snd_soc_component_add(cmpnt);
3314 snd_soc_component_cleanup(cmpnt);
3319 EXPORT_SYMBOL_GPL(snd_soc_register_component);
3322 * snd_soc_unregister_component - Unregister a component from the ASoC core
3324 * @dev: The device to unregister
3326 void snd_soc_unregister_component(struct device *dev)
3328 struct snd_soc_component *cmpnt;
3330 mutex_lock(&client_mutex);
3331 list_for_each_entry(cmpnt, &component_list, list) {
3332 if (dev == cmpnt->dev && cmpnt->registered_as_component)
3335 mutex_unlock(&client_mutex);
3339 snd_soc_tplg_component_remove(cmpnt, SND_SOC_TPLG_INDEX_ALL);
3340 snd_soc_component_del_unlocked(cmpnt);
3341 mutex_unlock(&client_mutex);
3342 snd_soc_component_cleanup(cmpnt);
3345 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
3347 static int snd_soc_platform_drv_probe(struct snd_soc_component *component)
3349 struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3351 return platform->driver->probe(platform);
3354 static void snd_soc_platform_drv_remove(struct snd_soc_component *component)
3356 struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3358 platform->driver->remove(platform);
3362 * snd_soc_add_platform - Add a platform to the ASoC core
3363 * @dev: The parent device for the platform
3364 * @platform: The platform to add
3365 * @platform_drv: The driver for the platform
3367 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
3368 const struct snd_soc_platform_driver *platform_drv)
3372 ret = snd_soc_component_initialize(&platform->component,
3373 &platform_drv->component_driver, dev);
3377 platform->dev = dev;
3378 platform->driver = platform_drv;
3380 if (platform_drv->probe)
3381 platform->component.probe = snd_soc_platform_drv_probe;
3382 if (platform_drv->remove)
3383 platform->component.remove = snd_soc_platform_drv_remove;
3385 #ifdef CONFIG_DEBUG_FS
3386 platform->component.debugfs_prefix = "platform";
3389 mutex_lock(&client_mutex);
3390 snd_soc_component_add_unlocked(&platform->component);
3391 list_add(&platform->list, &platform_list);
3392 mutex_unlock(&client_mutex);
3394 dev_dbg(dev, "ASoC: Registered platform '%s'\n",
3395 platform->component.name);
3399 EXPORT_SYMBOL_GPL(snd_soc_add_platform);
3402 * snd_soc_register_platform - Register a platform with the ASoC core
3404 * @dev: The device for the platform
3405 * @platform_drv: The driver for the platform
3407 int snd_soc_register_platform(struct device *dev,
3408 const struct snd_soc_platform_driver *platform_drv)
3410 struct snd_soc_platform *platform;
3413 dev_dbg(dev, "ASoC: platform register %s\n", dev_name(dev));
3415 platform = kzalloc(sizeof(struct snd_soc_platform), GFP_KERNEL);
3416 if (platform == NULL)
3419 ret = snd_soc_add_platform(dev, platform, platform_drv);
3425 EXPORT_SYMBOL_GPL(snd_soc_register_platform);
3428 * snd_soc_remove_platform - Remove a platform from the ASoC core
3429 * @platform: the platform to remove
3431 void snd_soc_remove_platform(struct snd_soc_platform *platform)
3434 mutex_lock(&client_mutex);
3435 list_del(&platform->list);
3436 snd_soc_component_del_unlocked(&platform->component);
3437 mutex_unlock(&client_mutex);
3439 dev_dbg(platform->dev, "ASoC: Unregistered platform '%s'\n",
3440 platform->component.name);
3442 snd_soc_component_cleanup(&platform->component);
3444 EXPORT_SYMBOL_GPL(snd_soc_remove_platform);
3446 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev)
3448 struct snd_soc_platform *platform;
3450 mutex_lock(&client_mutex);
3451 list_for_each_entry(platform, &platform_list, list) {
3452 if (dev == platform->dev) {
3453 mutex_unlock(&client_mutex);
3457 mutex_unlock(&client_mutex);
3461 EXPORT_SYMBOL_GPL(snd_soc_lookup_platform);
3464 * snd_soc_unregister_platform - Unregister a platform from the ASoC core
3466 * @dev: platform to unregister
3468 void snd_soc_unregister_platform(struct device *dev)
3470 struct snd_soc_platform *platform;
3472 platform = snd_soc_lookup_platform(dev);
3476 snd_soc_remove_platform(platform);
3479 EXPORT_SYMBOL_GPL(snd_soc_unregister_platform);
3481 static u64 codec_format_map[] = {
3482 SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE,
3483 SNDRV_PCM_FMTBIT_U16_LE | SNDRV_PCM_FMTBIT_U16_BE,
3484 SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE,
3485 SNDRV_PCM_FMTBIT_U24_LE | SNDRV_PCM_FMTBIT_U24_BE,
3486 SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S32_BE,
3487 SNDRV_PCM_FMTBIT_U32_LE | SNDRV_PCM_FMTBIT_U32_BE,
3488 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_U24_3BE,
3489 SNDRV_PCM_FMTBIT_U24_3LE | SNDRV_PCM_FMTBIT_U24_3BE,
3490 SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE,
3491 SNDRV_PCM_FMTBIT_U20_3LE | SNDRV_PCM_FMTBIT_U20_3BE,
3492 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE,
3493 SNDRV_PCM_FMTBIT_U18_3LE | SNDRV_PCM_FMTBIT_U18_3BE,
3494 SNDRV_PCM_FMTBIT_FLOAT_LE | SNDRV_PCM_FMTBIT_FLOAT_BE,
3495 SNDRV_PCM_FMTBIT_FLOAT64_LE | SNDRV_PCM_FMTBIT_FLOAT64_BE,
3496 SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
3497 | SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE,
3500 /* Fix up the DAI formats for endianness: codecs don't actually see
3501 * the endianness of the data but we're using the CPU format
3502 * definitions which do need to include endianness so we ensure that
3503 * codec DAIs always have both big and little endian variants set.
3505 static void fixup_codec_formats(struct snd_soc_pcm_stream *stream)
3509 for (i = 0; i < ARRAY_SIZE(codec_format_map); i++)
3510 if (stream->formats & codec_format_map[i])
3511 stream->formats |= codec_format_map[i];
3514 static int snd_soc_codec_drv_probe(struct snd_soc_component *component)
3516 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3518 return codec->driver->probe(codec);
3521 static void snd_soc_codec_drv_remove(struct snd_soc_component *component)
3523 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3525 codec->driver->remove(codec);
3528 static int snd_soc_codec_drv_suspend(struct snd_soc_component *component)
3530 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3532 return codec->driver->suspend(codec);
3535 static int snd_soc_codec_drv_resume(struct snd_soc_component *component)
3537 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3539 return codec->driver->resume(codec);
3542 static int snd_soc_codec_drv_write(struct snd_soc_component *component,
3543 unsigned int reg, unsigned int val)
3545 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3547 return codec->driver->write(codec, reg, val);
3550 static int snd_soc_codec_drv_read(struct snd_soc_component *component,
3551 unsigned int reg, unsigned int *val)
3553 struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3555 *val = codec->driver->read(codec, reg);
3560 static int snd_soc_codec_set_bias_level(struct snd_soc_dapm_context *dapm,
3561 enum snd_soc_bias_level level)
3563 struct snd_soc_codec *codec = snd_soc_dapm_to_codec(dapm);
3565 return codec->driver->set_bias_level(codec, level);
3569 * snd_soc_register_codec - Register a codec with the ASoC core
3571 * @dev: The parent device for this codec
3572 * @codec_drv: Codec driver
3573 * @dai_drv: The associated DAI driver
3574 * @num_dai: Number of DAIs
3576 int snd_soc_register_codec(struct device *dev,
3577 const struct snd_soc_codec_driver *codec_drv,
3578 struct snd_soc_dai_driver *dai_drv,
3581 struct snd_soc_dapm_context *dapm;
3582 struct snd_soc_codec *codec;
3583 struct snd_soc_dai *dai;
3586 dev_dbg(dev, "codec register %s\n", dev_name(dev));
3588 codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
3592 codec->component.codec = codec;
3594 ret = snd_soc_component_initialize(&codec->component,
3595 &codec_drv->component_driver, dev);
3599 if (codec_drv->probe)
3600 codec->component.probe = snd_soc_codec_drv_probe;
3601 if (codec_drv->remove)
3602 codec->component.remove = snd_soc_codec_drv_remove;
3603 if (codec_drv->suspend)
3604 codec->component.suspend = snd_soc_codec_drv_suspend;
3605 if (codec_drv->resume)
3606 codec->component.resume = snd_soc_codec_drv_resume;
3607 if (codec_drv->write)
3608 codec->component.write = snd_soc_codec_drv_write;
3609 if (codec_drv->read)
3610 codec->component.read = snd_soc_codec_drv_read;
3611 codec->component.ignore_pmdown_time = codec_drv->ignore_pmdown_time;
3613 dapm = snd_soc_codec_get_dapm(codec);
3614 dapm->idle_bias_off = codec_drv->idle_bias_off;
3615 dapm->suspend_bias_off = codec_drv->suspend_bias_off;
3616 if (codec_drv->seq_notifier)
3617 dapm->seq_notifier = codec_drv->seq_notifier;
3618 if (codec_drv->set_bias_level)
3619 dapm->set_bias_level = snd_soc_codec_set_bias_level;
3621 codec->driver = codec_drv;
3622 codec->component.val_bytes = codec_drv->reg_word_size;
3624 #ifdef CONFIG_DEBUG_FS
3625 codec->component.init_debugfs = soc_init_codec_debugfs;
3626 codec->component.debugfs_prefix = "codec";
3629 if (codec_drv->get_regmap)
3630 codec->component.regmap = codec_drv->get_regmap(dev);
3632 for (i = 0; i < num_dai; i++) {
3633 fixup_codec_formats(&dai_drv[i].playback);
3634 fixup_codec_formats(&dai_drv[i].capture);
3637 ret = snd_soc_register_dais(&codec->component, dai_drv, num_dai, false);
3639 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3643 list_for_each_entry(dai, &codec->component.dai_list, list)
3646 mutex_lock(&client_mutex);
3647 snd_soc_component_add_unlocked(&codec->component);
3648 list_add(&codec->list, &codec_list);
3649 mutex_unlock(&client_mutex);
3651 dev_dbg(codec->dev, "ASoC: Registered codec '%s'\n",
3652 codec->component.name);
3656 snd_soc_component_cleanup(&codec->component);
3661 EXPORT_SYMBOL_GPL(snd_soc_register_codec);
3664 * snd_soc_unregister_codec - Unregister a codec from the ASoC core
3666 * @dev: codec to unregister
3668 void snd_soc_unregister_codec(struct device *dev)
3670 struct snd_soc_codec *codec;
3672 mutex_lock(&client_mutex);
3673 list_for_each_entry(codec, &codec_list, list) {
3674 if (dev == codec->dev)
3677 mutex_unlock(&client_mutex);
3681 list_del(&codec->list);
3682 snd_soc_component_del_unlocked(&codec->component);
3683 mutex_unlock(&client_mutex);
3685 dev_dbg(codec->dev, "ASoC: Unregistered codec '%s'\n",
3686 codec->component.name);
3688 snd_soc_component_cleanup(&codec->component);
3689 snd_soc_cache_exit(codec);
3692 EXPORT_SYMBOL_GPL(snd_soc_unregister_codec);
3694 /* Retrieve a card's name from device tree */
3695 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
3696 const char *propname)
3698 struct device_node *np;
3702 pr_err("card->dev is not set before calling %s\n", __func__);
3706 np = card->dev->of_node;
3708 ret = of_property_read_string_index(np, propname, 0, &card->name);
3710 * EINVAL means the property does not exist. This is fine providing
3711 * card->name was previously set, which is checked later in
3712 * snd_soc_register_card.
3714 if (ret < 0 && ret != -EINVAL) {
3716 "ASoC: Property '%s' could not be read: %d\n",
3723 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
3725 static const struct snd_soc_dapm_widget simple_widgets[] = {
3726 SND_SOC_DAPM_MIC("Microphone", NULL),
3727 SND_SOC_DAPM_LINE("Line", NULL),
3728 SND_SOC_DAPM_HP("Headphone", NULL),
3729 SND_SOC_DAPM_SPK("Speaker", NULL),
3732 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
3733 const char *propname)
3735 struct device_node *np = card->dev->of_node;
3736 struct snd_soc_dapm_widget *widgets;
3737 const char *template, *wname;
3738 int i, j, num_widgets, ret;
3740 num_widgets = of_property_count_strings(np, propname);
3741 if (num_widgets < 0) {
3743 "ASoC: Property '%s' does not exist\n", propname);
3746 if (num_widgets & 1) {
3748 "ASoC: Property '%s' length is not even\n", propname);
3754 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3759 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
3763 "ASoC: Could not allocate memory for widgets\n");
3767 for (i = 0; i < num_widgets; i++) {
3768 ret = of_property_read_string_index(np, propname,
3772 "ASoC: Property '%s' index %d read error:%d\n",
3773 propname, 2 * i, ret);
3777 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3778 if (!strncmp(template, simple_widgets[j].name,
3779 strlen(simple_widgets[j].name))) {
3780 widgets[i] = simple_widgets[j];
3785 if (j >= ARRAY_SIZE(simple_widgets)) {
3787 "ASoC: DAPM widget '%s' is not supported\n",
3792 ret = of_property_read_string_index(np, propname,
3797 "ASoC: Property '%s' index %d read error:%d\n",
3798 propname, (2 * i) + 1, ret);
3802 widgets[i].name = wname;
3805 card->of_dapm_widgets = widgets;
3806 card->num_of_dapm_widgets = num_widgets;
3810 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3812 static int snd_soc_of_get_slot_mask(struct device_node *np,
3813 const char *prop_name,
3817 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3823 for (i = 0; i < val; i++)
3824 if (be32_to_cpup(&of_slot_mask[i]))
3830 int snd_soc_of_parse_tdm_slot(struct device_node *np,
3831 unsigned int *tx_mask,
3832 unsigned int *rx_mask,
3833 unsigned int *slots,
3834 unsigned int *slot_width)
3840 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3842 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3844 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3845 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3853 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3854 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3864 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3866 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
3867 struct snd_soc_codec_conf *codec_conf,
3868 struct device_node *of_node,
3869 const char *propname)
3871 struct device_node *np = card->dev->of_node;
3875 ret = of_property_read_string(np, propname, &str);
3877 /* no prefix is not error */
3881 codec_conf->of_node = of_node;
3882 codec_conf->name_prefix = str;
3884 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_prefix);
3886 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3887 const char *propname)
3889 struct device_node *np = card->dev->of_node;
3891 struct snd_soc_dapm_route *routes;
3894 num_routes = of_property_count_strings(np, propname);
3895 if (num_routes < 0 || num_routes & 1) {
3897 "ASoC: Property '%s' does not exist or its length is not even\n",
3903 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3908 routes = devm_kzalloc(card->dev, num_routes * sizeof(*routes),
3912 "ASoC: Could not allocate DAPM route table\n");
3916 for (i = 0; i < num_routes; i++) {
3917 ret = of_property_read_string_index(np, propname,
3918 2 * i, &routes[i].sink);
3921 "ASoC: Property '%s' index %d could not be read: %d\n",
3922 propname, 2 * i, ret);
3925 ret = of_property_read_string_index(np, propname,
3926 (2 * i) + 1, &routes[i].source);
3929 "ASoC: Property '%s' index %d could not be read: %d\n",
3930 propname, (2 * i) + 1, ret);
3935 card->num_of_dapm_routes = num_routes;
3936 card->of_dapm_routes = routes;
3940 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3942 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
3944 struct device_node **bitclkmaster,
3945 struct device_node **framemaster)
3949 unsigned int format = 0;
3955 } of_fmt_table[] = {
3956 { "i2s", SND_SOC_DAIFMT_I2S },
3957 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
3958 { "left_j", SND_SOC_DAIFMT_LEFT_J },
3959 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
3960 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
3961 { "ac97", SND_SOC_DAIFMT_AC97 },
3962 { "pdm", SND_SOC_DAIFMT_PDM},
3963 { "msb", SND_SOC_DAIFMT_MSB },
3964 { "lsb", SND_SOC_DAIFMT_LSB },
3971 * check "dai-format = xxx"
3972 * or "[prefix]format = xxx"
3973 * SND_SOC_DAIFMT_FORMAT_MASK area
3975 ret = of_property_read_string(np, "dai-format", &str);
3977 snprintf(prop, sizeof(prop), "%sformat", prefix);
3978 ret = of_property_read_string(np, prop, &str);
3981 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3982 if (strcmp(str, of_fmt_table[i].name) == 0) {
3983 format |= of_fmt_table[i].val;
3990 * check "[prefix]continuous-clock"
3991 * SND_SOC_DAIFMT_CLOCK_MASK area
3993 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3994 if (of_property_read_bool(np, prop))
3995 format |= SND_SOC_DAIFMT_CONT;
3997 format |= SND_SOC_DAIFMT_GATED;
4000 * check "[prefix]bitclock-inversion"
4001 * check "[prefix]frame-inversion"
4002 * SND_SOC_DAIFMT_INV_MASK area
4004 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
4005 bit = !!of_get_property(np, prop, NULL);
4007 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
4008 frame = !!of_get_property(np, prop, NULL);
4010 switch ((bit << 4) + frame) {
4012 format |= SND_SOC_DAIFMT_IB_IF;
4015 format |= SND_SOC_DAIFMT_IB_NF;
4018 format |= SND_SOC_DAIFMT_NB_IF;
4021 /* SND_SOC_DAIFMT_NB_NF is default */
4026 * check "[prefix]bitclock-master"
4027 * check "[prefix]frame-master"
4028 * SND_SOC_DAIFMT_MASTER_MASK area
4030 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
4031 bit = !!of_get_property(np, prop, NULL);
4032 if (bit && bitclkmaster)
4033 *bitclkmaster = of_parse_phandle(np, prop, 0);
4035 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
4036 frame = !!of_get_property(np, prop, NULL);
4037 if (frame && framemaster)
4038 *framemaster = of_parse_phandle(np, prop, 0);
4040 switch ((bit << 4) + frame) {
4042 format |= SND_SOC_DAIFMT_CBM_CFM;
4045 format |= SND_SOC_DAIFMT_CBM_CFS;
4048 format |= SND_SOC_DAIFMT_CBS_CFM;
4051 format |= SND_SOC_DAIFMT_CBS_CFS;
4057 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
4059 int snd_soc_get_dai_id(struct device_node *ep)
4061 struct snd_soc_component *pos;
4062 struct device_node *node;
4065 node = of_graph_get_port_parent(ep);
4068 * For example HDMI case, HDMI has video/sound port,
4069 * but ALSA SoC needs sound port number only.
4070 * Thus counting HDMI DT port/endpoint doesn't work.
4071 * Then, it should have .of_xlate_dai_id
4074 mutex_lock(&client_mutex);
4075 list_for_each_entry(pos, &component_list, list) {
4076 struct device_node *component_of_node = pos->dev->of_node;
4078 if (!component_of_node && pos->dev->parent)
4079 component_of_node = pos->dev->parent->of_node;
4081 if (component_of_node != node)
4084 if (pos->driver->of_xlate_dai_id)
4085 ret = pos->driver->of_xlate_dai_id(pos, ep);
4089 mutex_unlock(&client_mutex);
4095 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
4097 int snd_soc_get_dai_name(struct of_phandle_args *args,
4098 const char **dai_name)
4100 struct snd_soc_component *pos;
4101 struct device_node *component_of_node;
4102 int ret = -EPROBE_DEFER;
4104 mutex_lock(&client_mutex);
4105 list_for_each_entry(pos, &component_list, list) {
4106 component_of_node = pos->dev->of_node;
4107 if (!component_of_node && pos->dev->parent)
4108 component_of_node = pos->dev->parent->of_node;
4110 if (component_of_node != args->np)
4113 if (pos->driver->of_xlate_dai_name) {
4114 ret = pos->driver->of_xlate_dai_name(pos,
4120 switch (args->args_count) {
4122 id = 0; /* same as dai_drv[0] */
4132 if (id < 0 || id >= pos->num_dai) {
4139 *dai_name = pos->dai_drv[id].name;
4141 *dai_name = pos->name;
4146 mutex_unlock(&client_mutex);
4149 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
4151 int snd_soc_of_get_dai_name(struct device_node *of_node,
4152 const char **dai_name)
4154 struct of_phandle_args args;
4157 ret = of_parse_phandle_with_args(of_node, "sound-dai",
4158 "#sound-dai-cells", 0, &args);
4162 ret = snd_soc_get_dai_name(&args, dai_name);
4164 of_node_put(args.np);
4168 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
4171 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
4173 * @of_node: Device node
4174 * @dai_link: DAI link
4176 * Builds an array of CODEC DAI components from the DAI link property
4178 * The array is set in the DAI link and the number of DAIs is set accordingly.
4179 * The device nodes in the array (of_node) must be dereferenced by the caller.
4181 * Returns 0 for success
4183 int snd_soc_of_get_dai_link_codecs(struct device *dev,
4184 struct device_node *of_node,
4185 struct snd_soc_dai_link *dai_link)
4187 struct of_phandle_args args;
4188 struct snd_soc_dai_link_component *component;
4190 int index, num_codecs, ret;
4192 /* Count the number of CODECs */
4194 num_codecs = of_count_phandle_with_args(of_node, name,
4195 "#sound-dai-cells");
4196 if (num_codecs <= 0) {
4197 if (num_codecs == -ENOENT)
4198 dev_err(dev, "No 'sound-dai' property\n");
4200 dev_err(dev, "Bad phandle in 'sound-dai'\n");
4203 component = devm_kzalloc(dev,
4204 sizeof *component * num_codecs,
4208 dai_link->codecs = component;
4209 dai_link->num_codecs = num_codecs;
4211 /* Parse the list */
4212 for (index = 0, component = dai_link->codecs;
4213 index < dai_link->num_codecs;
4214 index++, component++) {
4215 ret = of_parse_phandle_with_args(of_node, name,
4220 component->of_node = args.np;
4221 ret = snd_soc_get_dai_name(&args, &component->dai_name);
4227 for (index = 0, component = dai_link->codecs;
4228 index < dai_link->num_codecs;
4229 index++, component++) {
4230 if (!component->of_node)
4232 of_node_put(component->of_node);
4233 component->of_node = NULL;
4235 dai_link->codecs = NULL;
4236 dai_link->num_codecs = 0;
4239 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
4241 static int __init snd_soc_init(void)
4243 snd_soc_debugfs_init();
4244 snd_soc_util_init();
4246 return platform_driver_register(&soc_driver);
4248 module_init(snd_soc_init);
4250 static void __exit snd_soc_exit(void)
4252 snd_soc_util_exit();
4253 snd_soc_debugfs_exit();
4255 platform_driver_unregister(&soc_driver);
4257 module_exit(snd_soc_exit);
4259 /* Module information */
4260 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
4261 MODULE_DESCRIPTION("ALSA SoC Core");
4262 MODULE_LICENSE("GPL");
4263 MODULE_ALIAS("platform:soc-audio");