1 // SPDX-License-Identifier: GPL-2.0+
3 // soc-core.c -- ALSA SoC Audio Layer
5 // Copyright 2005 Wolfson Microelectronics PLC.
6 // Copyright 2005 Openedhand Ltd.
7 // Copyright (C) 2010 Slimlogic Ltd.
8 // Copyright (C) 2010 Texas Instruments Inc.
10 // Author: Liam Girdwood <lrg@slimlogic.co.uk>
11 // with code, comments and ideas from :-
12 // Richard Purdie <richard@openedhand.com>
15 // o Add hw rules to enforce rates, etc.
16 // o More testing with other codecs/machines.
17 // o Add more codecs and platforms to ensure good API coverage.
18 // o Support TDM on PCM and I2S
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/init.h>
23 #include <linux/delay.h>
25 #include <linux/bitops.h>
26 #include <linux/debugfs.h>
27 #include <linux/platform_device.h>
28 #include <linux/pinctrl/consumer.h>
29 #include <linux/ctype.h>
30 #include <linux/slab.h>
32 #include <linux/of_graph.h>
33 #include <linux/dmi.h>
34 #include <sound/core.h>
35 #include <sound/jack.h>
36 #include <sound/pcm.h>
37 #include <sound/pcm_params.h>
38 #include <sound/soc.h>
39 #include <sound/soc-dpcm.h>
40 #include <sound/soc-topology.h>
41 #include <sound/initval.h>
43 #define CREATE_TRACE_POINTS
44 #include <trace/events/asoc.h>
48 #ifdef CONFIG_DEBUG_FS
49 struct dentry *snd_soc_debugfs_root;
50 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
53 static DEFINE_MUTEX(client_mutex);
54 static LIST_HEAD(component_list);
55 static LIST_HEAD(unbind_card_list);
57 #define for_each_component(component) \
58 list_for_each_entry(component, &component_list, list)
61 * This is used if driver don't need to have CPU/Codec/Platform
64 struct snd_soc_dai_link_component null_dailink_component[0];
65 EXPORT_SYMBOL_GPL(null_dailink_component);
68 * This is a timeout to do a DAPM powerdown after a stream is closed().
69 * It can be used to eliminate pops between different playback streams, e.g.
70 * between two audio tracks.
72 static int pmdown_time = 5000;
73 module_param(pmdown_time, int, 0);
74 MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
78 * If a DMI filed contain strings in this blacklist (e.g.
79 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
80 * as invalid and dropped when setting the card long name from DMI info.
82 static const char * const dmi_blacklist[] = {
83 "To be filled by OEM",
89 NULL, /* terminator */
93 static ssize_t pmdown_time_show(struct device *dev,
94 struct device_attribute *attr, char *buf)
96 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
98 return sprintf(buf, "%ld\n", rtd->pmdown_time);
101 static ssize_t pmdown_time_set(struct device *dev,
102 struct device_attribute *attr,
103 const char *buf, size_t count)
105 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
108 ret = kstrtol(buf, 10, &rtd->pmdown_time);
115 static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
117 static struct attribute *soc_dev_attrs[] = {
118 &dev_attr_pmdown_time.attr,
122 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
123 struct attribute *attr, int idx)
125 struct device *dev = kobj_to_dev(kobj);
126 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
131 if (attr == &dev_attr_pmdown_time.attr)
132 return attr->mode; /* always visible */
133 return rtd->num_codecs ? attr->mode : 0; /* enabled only with codec */
136 static const struct attribute_group soc_dapm_dev_group = {
137 .attrs = soc_dapm_dev_attrs,
138 .is_visible = soc_dev_attr_is_visible,
141 static const struct attribute_group soc_dev_group = {
142 .attrs = soc_dev_attrs,
143 .is_visible = soc_dev_attr_is_visible,
146 static const struct attribute_group *soc_dev_attr_groups[] = {
152 #ifdef CONFIG_DEBUG_FS
153 static void soc_init_component_debugfs(struct snd_soc_component *component)
155 if (!component->card->debugfs_card_root)
158 if (component->debugfs_prefix) {
161 name = kasprintf(GFP_KERNEL, "%s:%s",
162 component->debugfs_prefix, component->name);
164 component->debugfs_root = debugfs_create_dir(name,
165 component->card->debugfs_card_root);
169 component->debugfs_root = debugfs_create_dir(component->name,
170 component->card->debugfs_card_root);
173 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
174 component->debugfs_root);
177 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
179 if (!component->debugfs_root)
181 debugfs_remove_recursive(component->debugfs_root);
182 component->debugfs_root = NULL;
185 static int dai_list_show(struct seq_file *m, void *v)
187 struct snd_soc_component *component;
188 struct snd_soc_dai *dai;
190 mutex_lock(&client_mutex);
192 for_each_component(component)
193 for_each_component_dais(component, dai)
194 seq_printf(m, "%s\n", dai->name);
196 mutex_unlock(&client_mutex);
200 DEFINE_SHOW_ATTRIBUTE(dai_list);
202 static int component_list_show(struct seq_file *m, void *v)
204 struct snd_soc_component *component;
206 mutex_lock(&client_mutex);
208 for_each_component(component)
209 seq_printf(m, "%s\n", component->name);
211 mutex_unlock(&client_mutex);
215 DEFINE_SHOW_ATTRIBUTE(component_list);
217 static void soc_init_card_debugfs(struct snd_soc_card *card)
219 card->debugfs_card_root = debugfs_create_dir(card->name,
220 snd_soc_debugfs_root);
222 debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
225 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
228 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
230 debugfs_remove_recursive(card->debugfs_card_root);
231 card->debugfs_card_root = NULL;
234 static void snd_soc_debugfs_init(void)
236 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
238 debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
241 debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
242 &component_list_fops);
245 static void snd_soc_debugfs_exit(void)
247 debugfs_remove_recursive(snd_soc_debugfs_root);
252 static inline void soc_init_component_debugfs(
253 struct snd_soc_component *component)
257 static inline void soc_cleanup_component_debugfs(
258 struct snd_soc_component *component)
262 static inline void soc_init_card_debugfs(struct snd_soc_card *card)
266 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
270 static inline void snd_soc_debugfs_init(void)
274 static inline void snd_soc_debugfs_exit(void)
281 * This is glue code between snd_pcm_lib_ioctl() and
282 * snd_soc_component_driver :: ioctl
284 int snd_soc_pcm_lib_ioctl(struct snd_soc_component *component,
285 struct snd_pcm_substream *substream,
286 unsigned int cmd, void *arg)
288 return snd_pcm_lib_ioctl(substream, cmd, arg);
290 EXPORT_SYMBOL_GPL(snd_soc_pcm_lib_ioctl);
292 static int snd_soc_rtdcom_add(struct snd_soc_pcm_runtime *rtd,
293 struct snd_soc_component *component)
295 struct snd_soc_rtdcom_list *rtdcom;
296 struct snd_soc_component *comp;
298 for_each_rtd_components(rtd, rtdcom, comp) {
299 /* already connected */
300 if (comp == component)
305 * created rtdcom here will be freed when rtd->dev was freed.
307 * soc_free_pcm_runtime() :: device_unregister(rtd->dev)
309 rtdcom = devm_kzalloc(rtd->dev, sizeof(*rtdcom), GFP_KERNEL);
313 rtdcom->component = component;
314 INIT_LIST_HEAD(&rtdcom->list);
317 * When rtd was freed, created rtdcom here will be
319 * And we don't need to call list_del(&rtdcom->list)
320 * when freed, because rtd is also freed.
322 list_add_tail(&rtdcom->list, &rtd->component_list);
327 struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
328 const char *driver_name)
330 struct snd_soc_rtdcom_list *rtdcom;
331 struct snd_soc_component *component;
339 * snd_soc_rtdcom_lookup() will find component from rtd by using
340 * specified driver name.
341 * But, if many components which have same driver name are connected
342 * to 1 rtd, this function will return 1st found component.
344 for_each_rtd_components(rtd, rtdcom, component) {
345 const char *component_name = component->driver->name;
350 if ((component_name == driver_name) ||
351 strcmp(component_name, driver_name) == 0)
352 return rtdcom->component;
357 EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
359 static struct snd_soc_component
360 *snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
362 struct snd_soc_component *component;
363 struct snd_soc_component *found_component;
365 found_component = NULL;
366 for_each_component(component) {
367 if ((dev == component->dev) &&
369 (driver_name == component->driver->name) ||
370 (strcmp(component->driver->name, driver_name) == 0))) {
371 found_component = component;
376 return found_component;
379 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
380 const char *driver_name)
382 struct snd_soc_component *component;
384 mutex_lock(&client_mutex);
385 component = snd_soc_lookup_component_nolocked(dev, driver_name);
386 mutex_unlock(&client_mutex);
390 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
392 static const struct snd_soc_ops null_snd_soc_ops;
394 struct snd_soc_pcm_runtime
395 *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
396 struct snd_soc_dai_link *dai_link)
398 struct snd_soc_pcm_runtime *rtd;
400 for_each_card_rtds(card, rtd) {
401 if (rtd->dai_link == dai_link)
404 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
407 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
409 static void soc_release_rtd_dev(struct device *dev)
411 /* "dev" means "rtd->dev" */
415 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
420 list_del(&rtd->list);
422 if (delayed_work_pending(&rtd->delayed_work))
423 flush_delayed_work(&rtd->delayed_work);
424 snd_soc_pcm_component_free(rtd);
427 * we don't need to call kfree() for rtd->dev
429 * soc_release_rtd_dev()
431 * We don't need rtd->dev NULL check, because
432 * it is alloced *before* rtd.
434 * soc_new_pcm_runtime()
436 device_unregister(rtd->dev);
439 static void close_delayed_work(struct work_struct *work) {
440 struct snd_soc_pcm_runtime *rtd =
441 container_of(work, struct snd_soc_pcm_runtime,
444 if (rtd->close_delayed_work_func)
445 rtd->close_delayed_work_func(rtd);
448 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
449 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
451 struct snd_soc_pcm_runtime *rtd;
458 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
462 dev->parent = card->dev;
463 dev->release = soc_release_rtd_dev;
464 dev->groups = soc_dev_attr_groups;
466 dev_set_name(dev, "%s", dai_link->name);
468 ret = device_register(dev);
470 put_device(dev); /* soc_release_rtd_dev */
477 rtd = devm_kzalloc(dev, sizeof(*rtd), GFP_KERNEL);
482 dev_set_drvdata(dev, rtd);
483 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
486 * for rtd->codec_dais
488 rtd->codec_dais = devm_kcalloc(dev, dai_link->num_codecs,
489 sizeof(struct snd_soc_dai *),
491 if (!rtd->codec_dais)
495 * rtd remaining settings
497 INIT_LIST_HEAD(&rtd->component_list);
498 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
499 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
500 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
501 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
504 rtd->dai_link = dai_link;
505 if (!rtd->dai_link->ops)
506 rtd->dai_link->ops = &null_snd_soc_ops;
508 /* see for_each_card_rtds */
509 list_add_tail(&rtd->list, &card->rtd_list);
510 rtd->num = card->num_rtd;
516 soc_free_pcm_runtime(rtd);
520 static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
522 struct snd_soc_pcm_runtime *rtd;
524 for_each_card_rtds(card, rtd)
525 flush_delayed_work(&rtd->delayed_work);
528 #ifdef CONFIG_PM_SLEEP
529 /* powers down audio subsystem for suspend */
530 int snd_soc_suspend(struct device *dev)
532 struct snd_soc_card *card = dev_get_drvdata(dev);
533 struct snd_soc_component *component;
534 struct snd_soc_pcm_runtime *rtd;
537 /* If the card is not initialized yet there is nothing to do */
538 if (!card->instantiated)
542 * Due to the resume being scheduled into a workqueue we could
543 * suspend before that's finished - wait for it to complete.
545 snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
547 /* we're going to block userspace touching us until resume completes */
548 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
550 /* mute any active DACs */
551 for_each_card_rtds(card, rtd) {
552 struct snd_soc_dai *dai;
554 if (rtd->dai_link->ignore_suspend)
557 for_each_rtd_codec_dai(rtd, i, dai) {
558 if (dai->playback_active)
559 snd_soc_dai_digital_mute(dai, 1,
560 SNDRV_PCM_STREAM_PLAYBACK);
564 /* suspend all pcms */
565 for_each_card_rtds(card, rtd) {
566 if (rtd->dai_link->ignore_suspend)
569 snd_pcm_suspend_all(rtd->pcm);
572 if (card->suspend_pre)
573 card->suspend_pre(card);
575 for_each_card_rtds(card, rtd) {
576 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
578 if (rtd->dai_link->ignore_suspend)
581 if (!cpu_dai->driver->bus_control)
582 snd_soc_dai_suspend(cpu_dai);
585 /* close any waiting streams */
586 snd_soc_flush_all_delayed_work(card);
588 for_each_card_rtds(card, rtd) {
590 if (rtd->dai_link->ignore_suspend)
593 snd_soc_dapm_stream_event(rtd,
594 SNDRV_PCM_STREAM_PLAYBACK,
595 SND_SOC_DAPM_STREAM_SUSPEND);
597 snd_soc_dapm_stream_event(rtd,
598 SNDRV_PCM_STREAM_CAPTURE,
599 SND_SOC_DAPM_STREAM_SUSPEND);
602 /* Recheck all endpoints too, their state is affected by suspend */
603 dapm_mark_endpoints_dirty(card);
604 snd_soc_dapm_sync(&card->dapm);
606 /* suspend all COMPONENTs */
607 for_each_card_components(card, component) {
608 struct snd_soc_dapm_context *dapm =
609 snd_soc_component_get_dapm(component);
612 * If there are paths active then the COMPONENT will be held
613 * with bias _ON and should not be suspended.
615 if (!snd_soc_component_is_suspended(component)) {
616 switch (snd_soc_dapm_get_bias_level(dapm)) {
617 case SND_SOC_BIAS_STANDBY:
619 * If the COMPONENT is capable of idle
620 * bias off then being in STANDBY
621 * means it's doing something,
622 * otherwise fall through.
624 if (dapm->idle_bias_off) {
625 dev_dbg(component->dev,
626 "ASoC: idle_bias_off CODEC on over suspend\n");
631 case SND_SOC_BIAS_OFF:
632 snd_soc_component_suspend(component);
633 if (component->regmap)
634 regcache_mark_dirty(component->regmap);
635 /* deactivate pins to sleep state */
636 pinctrl_pm_select_sleep_state(component->dev);
639 dev_dbg(component->dev,
640 "ASoC: COMPONENT is on over suspend\n");
646 for_each_card_rtds(card, rtd) {
647 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
649 if (rtd->dai_link->ignore_suspend)
652 if (cpu_dai->driver->bus_control)
653 snd_soc_dai_suspend(cpu_dai);
655 /* deactivate pins to sleep state */
656 pinctrl_pm_select_sleep_state(cpu_dai->dev);
659 if (card->suspend_post)
660 card->suspend_post(card);
664 EXPORT_SYMBOL_GPL(snd_soc_suspend);
667 * deferred resume work, so resume can complete before we finished
668 * setting our codec back up, which can be very slow on I2C
670 static void soc_resume_deferred(struct work_struct *work)
672 struct snd_soc_card *card =
673 container_of(work, struct snd_soc_card,
674 deferred_resume_work);
675 struct snd_soc_pcm_runtime *rtd;
676 struct snd_soc_component *component;
680 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
681 * so userspace apps are blocked from touching us
684 dev_dbg(card->dev, "ASoC: starting resume work\n");
686 /* Bring us up into D2 so that DAPM starts enabling things */
687 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
689 if (card->resume_pre)
690 card->resume_pre(card);
692 /* resume control bus DAIs */
693 for_each_card_rtds(card, rtd) {
694 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
696 if (rtd->dai_link->ignore_suspend)
699 if (cpu_dai->driver->bus_control)
700 snd_soc_dai_resume(cpu_dai);
703 for_each_card_components(card, component) {
704 if (snd_soc_component_is_suspended(component))
705 snd_soc_component_resume(component);
708 for_each_card_rtds(card, rtd) {
710 if (rtd->dai_link->ignore_suspend)
713 snd_soc_dapm_stream_event(rtd,
714 SNDRV_PCM_STREAM_PLAYBACK,
715 SND_SOC_DAPM_STREAM_RESUME);
717 snd_soc_dapm_stream_event(rtd,
718 SNDRV_PCM_STREAM_CAPTURE,
719 SND_SOC_DAPM_STREAM_RESUME);
722 /* unmute any active DACs */
723 for_each_card_rtds(card, rtd) {
724 struct snd_soc_dai *dai;
726 if (rtd->dai_link->ignore_suspend)
729 for_each_rtd_codec_dai(rtd, i, dai) {
730 if (dai->playback_active)
731 snd_soc_dai_digital_mute(dai, 0,
732 SNDRV_PCM_STREAM_PLAYBACK);
736 for_each_card_rtds(card, rtd) {
737 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
739 if (rtd->dai_link->ignore_suspend)
742 if (!cpu_dai->driver->bus_control)
743 snd_soc_dai_resume(cpu_dai);
746 if (card->resume_post)
747 card->resume_post(card);
749 dev_dbg(card->dev, "ASoC: resume work completed\n");
751 /* Recheck all endpoints too, their state is affected by suspend */
752 dapm_mark_endpoints_dirty(card);
753 snd_soc_dapm_sync(&card->dapm);
755 /* userspace can access us now we are back as we were before */
756 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
759 /* powers up audio subsystem after a suspend */
760 int snd_soc_resume(struct device *dev)
762 struct snd_soc_card *card = dev_get_drvdata(dev);
763 bool bus_control = false;
764 struct snd_soc_pcm_runtime *rtd;
765 struct snd_soc_dai *codec_dai;
768 /* If the card is not initialized yet there is nothing to do */
769 if (!card->instantiated)
772 /* activate pins from sleep state */
773 for_each_card_rtds(card, rtd) {
774 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
777 pinctrl_pm_select_default_state(cpu_dai->dev);
779 for_each_rtd_codec_dai(rtd, i, codec_dai) {
780 if (codec_dai->active)
781 pinctrl_pm_select_default_state(codec_dai->dev);
786 * DAIs that also act as the control bus master might have other drivers
787 * hanging off them so need to resume immediately. Other drivers don't
788 * have that problem and may take a substantial amount of time to resume
789 * due to I/O costs and anti-pop so handle them out of line.
791 for_each_card_rtds(card, rtd) {
792 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
794 bus_control |= cpu_dai->driver->bus_control;
797 dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
798 soc_resume_deferred(&card->deferred_resume_work);
800 dev_dbg(dev, "ASoC: Scheduling resume work\n");
801 if (!schedule_work(&card->deferred_resume_work))
802 dev_err(dev, "ASoC: resume work item may be lost\n");
807 EXPORT_SYMBOL_GPL(snd_soc_resume);
809 static void soc_resume_init(struct snd_soc_card *card)
811 /* deferred resume work */
812 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
815 #define snd_soc_suspend NULL
816 #define snd_soc_resume NULL
817 static inline void soc_resume_init(struct snd_soc_card *card)
822 static const struct snd_soc_dai_ops null_dai_ops = {
825 static struct device_node
826 *soc_component_to_node(struct snd_soc_component *component)
828 struct device_node *of_node;
830 of_node = component->dev->of_node;
831 if (!of_node && component->dev->parent)
832 of_node = component->dev->parent->of_node;
837 static int snd_soc_is_matching_component(
838 const struct snd_soc_dai_link_component *dlc,
839 struct snd_soc_component *component)
841 struct device_node *component_of_node;
846 component_of_node = soc_component_to_node(component);
848 if (dlc->of_node && component_of_node != dlc->of_node)
850 if (dlc->name && strcmp(component->name, dlc->name))
856 static struct snd_soc_component *soc_find_component(
857 const struct snd_soc_dai_link_component *dlc)
859 struct snd_soc_component *component;
861 lockdep_assert_held(&client_mutex);
866 * It returns *1st* found component, but some driver
867 * has few components by same of_node/name
869 * CPU component and generic DMAEngine component
871 for_each_component(component)
872 if (snd_soc_is_matching_component(dlc, component))
879 * snd_soc_find_dai - Find a registered DAI
881 * @dlc: name of the DAI or the DAI driver and optional component info to match
883 * This function will search all registered components and their DAIs to
884 * find the DAI of the same name. The component's of_node and name
885 * should also match if being specified.
887 * Return: pointer of DAI, or NULL if not found.
889 struct snd_soc_dai *snd_soc_find_dai(
890 const struct snd_soc_dai_link_component *dlc)
892 struct snd_soc_component *component;
893 struct snd_soc_dai *dai;
895 lockdep_assert_held(&client_mutex);
897 /* Find CPU DAI from registered DAIs */
898 for_each_component(component) {
899 if (!snd_soc_is_matching_component(dlc, component))
901 for_each_component_dais(component, dai) {
902 if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
903 && (!dai->driver->name
904 || strcmp(dai->driver->name, dlc->dai_name)))
913 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
915 static int soc_dai_link_sanity_check(struct snd_soc_card *card,
916 struct snd_soc_dai_link *link)
919 struct snd_soc_dai_link_component *codec, *platform;
921 for_each_link_codecs(link, i, codec) {
923 * Codec must be specified by 1 of name or OF node,
924 * not both or neither.
926 if (!!codec->name == !!codec->of_node) {
927 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
932 /* Codec DAI name must be specified */
933 if (!codec->dai_name) {
934 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
940 * Defer card registration if codec component is not added to
943 if (!soc_find_component(codec))
944 return -EPROBE_DEFER;
947 for_each_link_platforms(link, i, platform) {
949 * Platform may be specified by either name or OF node, but it
950 * can be left unspecified, then no components will be inserted
953 if (!!platform->name == !!platform->of_node) {
955 "ASoC: Neither/both platform name/of_node are set for %s\n",
961 * Defer card registration if platform component is not added to
964 if (!soc_find_component(platform))
965 return -EPROBE_DEFER;
969 if (link->num_cpus > 1) {
971 "ASoC: multi cpu is not yet supported %s\n",
977 * CPU device may be specified by either name or OF node, but
978 * can be left unspecified, and will be matched based on DAI
981 if (link->cpus->name && link->cpus->of_node) {
983 "ASoC: Neither/both cpu name/of_node are set for %s\n",
989 * Defer card registration if cpu dai component is not added to
992 if ((link->cpus->of_node || link->cpus->name) &&
993 !soc_find_component(link->cpus))
994 return -EPROBE_DEFER;
997 * At least one of CPU DAI name or CPU device name/node must be
1000 if (!link->cpus->dai_name &&
1001 !(link->cpus->name || link->cpus->of_node)) {
1003 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1012 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
1013 * @card: The ASoC card to which the pcm_runtime has
1014 * @rtd: The pcm_runtime to remove
1016 * This function removes a pcm_runtime from the ASoC card.
1018 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1019 struct snd_soc_pcm_runtime *rtd)
1021 lockdep_assert_held(&client_mutex);
1024 * Notify the machine driver for extra destruction
1026 if (card->remove_dai_link)
1027 card->remove_dai_link(card, rtd->dai_link);
1029 soc_free_pcm_runtime(rtd);
1031 EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
1034 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
1035 * @card: The ASoC card to which the pcm_runtime is added
1036 * @dai_link: The DAI link to find pcm_runtime
1038 * This function adds a pcm_runtime ASoC card by using dai_link.
1040 * Note: Topology can use this API to add pcm_runtime when probing the
1041 * topology component. And machine drivers can still define static
1042 * DAI links in dai_link array.
1044 int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1045 struct snd_soc_dai_link *dai_link)
1047 struct snd_soc_pcm_runtime *rtd;
1048 struct snd_soc_dai_link_component *codec, *platform;
1049 struct snd_soc_component *component;
1052 lockdep_assert_held(&client_mutex);
1055 * Notify the machine driver for extra initialization
1057 if (card->add_dai_link)
1058 card->add_dai_link(card, dai_link);
1060 if (dai_link->ignore)
1063 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1065 ret = soc_dai_link_sanity_check(card, dai_link);
1069 rtd = soc_new_pcm_runtime(card, dai_link);
1073 /* FIXME: we need multi CPU support in the future */
1074 rtd->cpu_dai = snd_soc_find_dai(dai_link->cpus);
1075 if (!rtd->cpu_dai) {
1076 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1077 dai_link->cpus->dai_name);
1080 snd_soc_rtdcom_add(rtd, rtd->cpu_dai->component);
1082 /* Find CODEC from registered CODECs */
1083 rtd->num_codecs = dai_link->num_codecs;
1084 for_each_link_codecs(dai_link, i, codec) {
1085 rtd->codec_dais[i] = snd_soc_find_dai(codec);
1086 if (!rtd->codec_dais[i]) {
1087 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1092 snd_soc_rtdcom_add(rtd, rtd->codec_dais[i]->component);
1095 /* Single codec links expect codec and codec_dai in runtime data */
1096 rtd->codec_dai = rtd->codec_dais[0];
1098 /* Find PLATFORM from registered PLATFORMs */
1099 for_each_link_platforms(dai_link, i, platform) {
1100 for_each_component(component) {
1101 if (!snd_soc_is_matching_component(platform, component))
1104 snd_soc_rtdcom_add(rtd, component);
1111 snd_soc_remove_pcm_runtime(card, rtd);
1112 return -EPROBE_DEFER;
1114 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtime);
1116 static int soc_dai_pcm_new(struct snd_soc_dai **dais, int num_dais,
1117 struct snd_soc_pcm_runtime *rtd)
1121 for (i = 0; i < num_dais; ++i) {
1122 struct snd_soc_dai_driver *drv = dais[i]->driver;
1125 ret = drv->pcm_new(rtd, dais[i]);
1127 dev_err(dais[i]->dev,
1128 "ASoC: Failed to bind %s with pcm device\n",
1137 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1138 struct snd_soc_pcm_runtime *rtd)
1140 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1141 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1142 struct snd_soc_rtdcom_list *rtdcom;
1143 struct snd_soc_component *component;
1146 /* set default power off timeout */
1147 rtd->pmdown_time = pmdown_time;
1149 /* do machine specific initialization */
1150 if (dai_link->init) {
1151 ret = dai_link->init(rtd);
1153 dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1154 dai_link->name, ret);
1159 if (dai_link->dai_fmt) {
1160 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1165 /* add DPCM sysfs entries */
1166 soc_dpcm_debugfs_add(rtd);
1171 * most drivers will register their PCMs using DAI link ordering but
1172 * topology based drivers can use the DAI link id field to set PCM
1173 * device number and then use rtd + a base offset of the BEs.
1175 for_each_rtd_components(rtd, rtdcom, component) {
1176 if (!component->driver->use_dai_pcm_id)
1179 if (rtd->dai_link->no_pcm)
1180 num += component->driver->be_pcm_base;
1182 num = rtd->dai_link->id;
1185 /* create compress_device if possible */
1186 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1187 if (ret != -ENOTSUPP) {
1189 dev_err(card->dev, "ASoC: can't create compress %s\n",
1190 dai_link->stream_name);
1194 /* create the pcm */
1195 ret = soc_new_pcm(rtd, num);
1197 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1198 dai_link->stream_name, ret);
1201 ret = soc_dai_pcm_new(&cpu_dai, 1, rtd);
1204 ret = soc_dai_pcm_new(rtd->codec_dais,
1205 rtd->num_codecs, rtd);
1209 static void soc_set_of_name_prefix(struct snd_soc_component *component)
1211 struct device_node *of_node = soc_component_to_node(component);
1215 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1217 component->name_prefix = str;
1220 static void soc_set_name_prefix(struct snd_soc_card *card,
1221 struct snd_soc_component *component)
1223 struct device_node *of_node = soc_component_to_node(component);
1226 for (i = 0; i < card->num_configs; i++) {
1227 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1229 if (map->of_node && of_node != map->of_node)
1231 if (map->dev_name && strcmp(component->name, map->dev_name))
1233 component->name_prefix = map->name_prefix;
1238 * If there is no configuration table or no match in the table,
1239 * check if a prefix is provided in the node
1241 soc_set_of_name_prefix(component);
1244 static void soc_remove_component(struct snd_soc_component *component,
1248 if (!component->card)
1252 snd_soc_component_remove(component);
1254 /* For framework level robustness */
1255 snd_soc_component_set_jack(component, NULL, NULL);
1257 list_del_init(&component->card_list);
1258 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1259 soc_cleanup_component_debugfs(component);
1260 component->card = NULL;
1261 snd_soc_component_module_put_when_remove(component);
1264 static int soc_probe_component(struct snd_soc_card *card,
1265 struct snd_soc_component *component)
1267 struct snd_soc_dapm_context *dapm =
1268 snd_soc_component_get_dapm(component);
1269 struct snd_soc_dai *dai;
1273 if (!strcmp(component->name, "snd-soc-dummy"))
1276 if (component->card) {
1277 if (component->card != card) {
1278 dev_err(component->dev,
1279 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1280 card->name, component->card->name);
1286 ret = snd_soc_component_module_get_when_probe(component);
1290 component->card = card;
1291 soc_set_name_prefix(card, component);
1293 soc_init_component_debugfs(component);
1295 snd_soc_dapm_init(dapm, card, component);
1297 ret = snd_soc_dapm_new_controls(dapm,
1298 component->driver->dapm_widgets,
1299 component->driver->num_dapm_widgets);
1302 dev_err(component->dev,
1303 "Failed to create new controls %d\n", ret);
1307 for_each_component_dais(component, dai) {
1308 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1310 dev_err(component->dev,
1311 "Failed to create DAI widgets %d\n", ret);
1316 ret = snd_soc_component_probe(component);
1318 dev_err(component->dev,
1319 "ASoC: failed to probe component %d\n", ret);
1322 WARN(dapm->idle_bias_off &&
1323 dapm->bias_level != SND_SOC_BIAS_OFF,
1324 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1328 /* machine specific init */
1329 if (component->init) {
1330 ret = component->init(component);
1332 dev_err(component->dev,
1333 "Failed to do machine specific init %d\n", ret);
1338 ret = snd_soc_add_component_controls(component,
1339 component->driver->controls,
1340 component->driver->num_controls);
1344 ret = snd_soc_dapm_add_routes(dapm,
1345 component->driver->dapm_routes,
1346 component->driver->num_dapm_routes);
1350 /* see for_each_card_components */
1351 list_add(&component->card_list, &card->component_dev_list);
1355 soc_remove_component(component, probed);
1360 static void soc_remove_dai(struct snd_soc_dai *dai, int order)
1364 if (!dai || !dai->probed || !dai->driver ||
1365 dai->driver->remove_order != order)
1368 err = snd_soc_dai_remove(dai);
1371 "ASoC: failed to remove %s: %d\n",
1377 static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1382 dai->driver->probe_order != order)
1385 ret = snd_soc_dai_probe(dai);
1387 dev_err(dai->dev, "ASoC: failed to probe DAI %s: %d\n",
1397 static void soc_remove_link_dais(struct snd_soc_card *card)
1400 struct snd_soc_dai *codec_dai;
1401 struct snd_soc_pcm_runtime *rtd;
1404 for_each_comp_order(order) {
1405 for_each_card_rtds(card, rtd) {
1406 /* remove the CODEC DAI */
1407 for_each_rtd_codec_dai(rtd, i, codec_dai)
1408 soc_remove_dai(codec_dai, order);
1410 soc_remove_dai(rtd->cpu_dai, order);
1415 static int soc_probe_link_dais(struct snd_soc_card *card)
1417 struct snd_soc_dai *codec_dai;
1418 struct snd_soc_pcm_runtime *rtd;
1421 for_each_comp_order(order) {
1422 for_each_card_rtds(card, rtd) {
1425 "ASoC: probe %s dai link %d late %d\n",
1426 card->name, rtd->num, order);
1428 ret = soc_probe_dai(rtd->cpu_dai, order);
1432 /* probe the CODEC DAI */
1433 for_each_rtd_codec_dai(rtd, i, codec_dai) {
1434 ret = soc_probe_dai(codec_dai, order);
1444 static void soc_remove_link_components(struct snd_soc_card *card)
1446 struct snd_soc_component *component;
1447 struct snd_soc_pcm_runtime *rtd;
1448 struct snd_soc_rtdcom_list *rtdcom;
1451 for_each_comp_order(order) {
1452 for_each_card_rtds(card, rtd) {
1453 for_each_rtd_components(rtd, rtdcom, component) {
1454 if (component->driver->remove_order != order)
1457 soc_remove_component(component, 1);
1463 static int soc_probe_link_components(struct snd_soc_card *card)
1465 struct snd_soc_component *component;
1466 struct snd_soc_pcm_runtime *rtd;
1467 struct snd_soc_rtdcom_list *rtdcom;
1470 for_each_comp_order(order) {
1471 for_each_card_rtds(card, rtd) {
1472 for_each_rtd_components(rtd, rtdcom, component) {
1473 if (component->driver->probe_order != order)
1476 ret = soc_probe_component(card, component);
1486 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1488 struct snd_soc_component *component, *_component;
1490 for_each_card_auxs_safe(card, component, _component) {
1491 component->init = NULL;
1492 list_del(&component->card_aux_list);
1496 static int soc_bind_aux_dev(struct snd_soc_card *card)
1498 struct snd_soc_component *component;
1499 struct snd_soc_aux_dev *aux;
1502 for_each_card_pre_auxs(card, i, aux) {
1503 /* codecs, usually analog devices */
1504 component = soc_find_component(&aux->dlc);
1506 return -EPROBE_DEFER;
1508 component->init = aux->init;
1509 /* see for_each_card_auxs */
1510 list_add(&component->card_aux_list, &card->aux_comp_list);
1515 static int soc_probe_aux_devices(struct snd_soc_card *card)
1517 struct snd_soc_component *component;
1521 for_each_comp_order(order) {
1522 for_each_card_auxs(card, component) {
1523 if (component->driver->probe_order != order)
1526 ret = soc_probe_component(card, component);
1535 static void soc_remove_aux_devices(struct snd_soc_card *card)
1537 struct snd_soc_component *comp, *_comp;
1540 for_each_comp_order(order) {
1541 for_each_card_auxs_safe(card, comp, _comp) {
1542 if (comp->driver->remove_order == order)
1543 soc_remove_component(comp, 1);
1549 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1550 * @rtd: The runtime for which the DAI link format should be changed
1551 * @dai_fmt: The new DAI link format
1553 * This function updates the DAI link format for all DAIs connected to the DAI
1554 * link for the specified runtime.
1556 * Note: For setups with a static format set the dai_fmt field in the
1557 * corresponding snd_dai_link struct instead of using this function.
1559 * Returns 0 on success, otherwise a negative error code.
1561 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1562 unsigned int dai_fmt)
1564 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1565 struct snd_soc_dai *codec_dai;
1569 for_each_rtd_codec_dai(rtd, i, codec_dai) {
1570 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1571 if (ret != 0 && ret != -ENOTSUPP) {
1572 dev_warn(codec_dai->dev,
1573 "ASoC: Failed to set DAI format: %d\n", ret);
1579 * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1580 * the component which has non_legacy_dai_naming is Codec
1582 if (cpu_dai->component->driver->non_legacy_dai_naming) {
1583 unsigned int inv_dai_fmt;
1585 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1586 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1587 case SND_SOC_DAIFMT_CBM_CFM:
1588 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1590 case SND_SOC_DAIFMT_CBM_CFS:
1591 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1593 case SND_SOC_DAIFMT_CBS_CFM:
1594 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1596 case SND_SOC_DAIFMT_CBS_CFS:
1597 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1601 dai_fmt = inv_dai_fmt;
1604 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1605 if (ret != 0 && ret != -ENOTSUPP) {
1606 dev_warn(cpu_dai->dev,
1607 "ASoC: Failed to set DAI format: %d\n", ret);
1613 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1617 * Trim special characters, and replace '-' with '_' since '-' is used to
1618 * separate different DMI fields in the card long name. Only number and
1619 * alphabet characters and a few separator characters are kept.
1621 static void cleanup_dmi_name(char *name)
1625 for (i = 0; name[i]; i++) {
1626 if (isalnum(name[i]) || (name[i] == '.')
1627 || (name[i] == '_'))
1628 name[j++] = name[i];
1629 else if (name[i] == '-')
1637 * Check if a DMI field is valid, i.e. not containing any string
1638 * in the black list.
1640 static int is_dmi_valid(const char *field)
1644 while (dmi_blacklist[i]) {
1645 if (strstr(field, dmi_blacklist[i]))
1654 * Append a string to card->dmi_longname with character cleanups.
1656 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1658 char *dst = card->dmi_longname;
1659 size_t dst_len = sizeof(card->dmi_longname);
1663 snprintf(dst + len, dst_len - len, "-%s", str);
1665 len++; /* skip the separator "-" */
1667 cleanup_dmi_name(dst + len);
1671 * snd_soc_set_dmi_name() - Register DMI names to card
1672 * @card: The card to register DMI names
1673 * @flavour: The flavour "differentiator" for the card amongst its peers.
1675 * An Intel machine driver may be used by many different devices but are
1676 * difficult for userspace to differentiate, since machine drivers ususally
1677 * use their own name as the card short name and leave the card long name
1678 * blank. To differentiate such devices and fix bugs due to lack of
1679 * device-specific configurations, this function allows DMI info to be used
1680 * as the sound card long name, in the format of
1681 * "vendor-product-version-board"
1682 * (Character '-' is used to separate different DMI fields here).
1683 * This will help the user space to load the device-specific Use Case Manager
1684 * (UCM) configurations for the card.
1686 * Possible card long names may be:
1687 * DellInc.-XPS139343-01-0310JH
1688 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1689 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1691 * This function also supports flavoring the card longname to provide
1692 * the extra differentiation, like "vendor-product-version-board-flavor".
1694 * We only keep number and alphabet characters and a few separator characters
1695 * in the card long name since UCM in the user space uses the card long names
1696 * as card configuration directory names and AudoConf cannot support special
1697 * charactors like SPACE.
1699 * Returns 0 on success, otherwise a negative error code.
1701 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1703 const char *vendor, *product, *product_version, *board;
1705 if (card->long_name)
1706 return 0; /* long name already set by driver or from DMI */
1708 /* make up dmi long name as: vendor-product-version-board */
1709 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1710 if (!vendor || !is_dmi_valid(vendor)) {
1711 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1715 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1716 cleanup_dmi_name(card->dmi_longname);
1718 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1719 if (product && is_dmi_valid(product)) {
1720 append_dmi_string(card, product);
1723 * some vendors like Lenovo may only put a self-explanatory
1724 * name in the product version field
1726 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1727 if (product_version && is_dmi_valid(product_version))
1728 append_dmi_string(card, product_version);
1731 board = dmi_get_system_info(DMI_BOARD_NAME);
1732 if (board && is_dmi_valid(board)) {
1733 if (!product || strcasecmp(board, product))
1734 append_dmi_string(card, board);
1735 } else if (!product) {
1736 /* fall back to using legacy name */
1737 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1741 /* Add flavour to dmi long name */
1743 append_dmi_string(card, flavour);
1745 /* set the card long name */
1746 card->long_name = card->dmi_longname;
1750 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1751 #endif /* CONFIG_DMI */
1753 static void soc_check_tplg_fes(struct snd_soc_card *card)
1755 struct snd_soc_component *component;
1756 const struct snd_soc_component_driver *comp_drv;
1757 struct snd_soc_dai_link *dai_link;
1760 for_each_component(component) {
1762 /* does this component override BEs ? */
1763 if (!component->driver->ignore_machine)
1766 /* for this machine ? */
1767 if (!strcmp(component->driver->ignore_machine,
1768 card->dev->driver->name))
1770 if (strcmp(component->driver->ignore_machine,
1771 dev_name(card->dev)))
1774 /* machine matches, so override the rtd data */
1775 for_each_card_prelinks(card, i, dai_link) {
1777 /* ignore this FE */
1778 if (dai_link->dynamic) {
1779 dai_link->ignore = true;
1783 dev_info(card->dev, "info: override BE DAI link %s\n",
1784 card->dai_link[i].name);
1786 /* override platform component */
1787 if (!dai_link->platforms) {
1788 dev_err(card->dev, "init platform error");
1791 dai_link->platforms->name = component->name;
1793 /* convert non BE into BE */
1794 dai_link->no_pcm = 1;
1796 /* override any BE fixups */
1797 dai_link->be_hw_params_fixup =
1798 component->driver->be_hw_params_fixup;
1801 * most BE links don't set stream name, so set it to
1802 * dai link name if it's NULL to help bind widgets.
1804 if (!dai_link->stream_name)
1805 dai_link->stream_name = dai_link->name;
1808 /* Inform userspace we are using alternate topology */
1809 if (component->driver->topology_name_prefix) {
1811 /* topology shortname created? */
1812 if (!card->topology_shortname_created) {
1813 comp_drv = component->driver;
1815 snprintf(card->topology_shortname, 32, "%s-%s",
1816 comp_drv->topology_name_prefix,
1818 card->topology_shortname_created = true;
1821 /* use topology shortname */
1822 card->name = card->topology_shortname;
1827 #define soc_setup_card_name(name, name1, name2, norm) \
1828 __soc_setup_card_name(name, sizeof(name), name1, name2, norm)
1829 static void __soc_setup_card_name(char *name, int len,
1830 const char *name1, const char *name2,
1835 snprintf(name, len, "%s", name1 ? name1 : name2);
1841 * Name normalization
1843 * The driver name is somewhat special, as it's used as a key for
1844 * searches in the user-space.
1847 * "abcd??efg" -> "abcd__efg"
1849 for (i = 0; i < len; i++) {
1856 if (!isalnum(name[i]))
1863 static void soc_cleanup_card_resources(struct snd_soc_card *card,
1866 struct snd_soc_pcm_runtime *rtd, *n;
1869 snd_card_disconnect_sync(card->snd_card);
1871 snd_soc_dapm_shutdown(card);
1873 /* remove and free each DAI */
1874 soc_remove_link_dais(card);
1875 soc_remove_link_components(card);
1877 for_each_card_rtds_safe(card, rtd, n)
1878 snd_soc_remove_pcm_runtime(card, rtd);
1880 /* remove auxiliary devices */
1881 soc_remove_aux_devices(card);
1882 soc_unbind_aux_dev(card);
1884 snd_soc_dapm_free(&card->dapm);
1885 soc_cleanup_card_debugfs(card);
1887 /* remove the card */
1888 if (card_probed && card->remove)
1891 if (card->snd_card) {
1892 snd_card_free(card->snd_card);
1893 card->snd_card = NULL;
1897 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1899 if (card->instantiated) {
1900 int card_probed = 1;
1902 card->instantiated = false;
1903 snd_soc_flush_all_delayed_work(card);
1905 soc_cleanup_card_resources(card, card_probed);
1907 list_add(&card->list, &unbind_card_list);
1910 list_del(&card->list);
1914 static int snd_soc_bind_card(struct snd_soc_card *card)
1916 struct snd_soc_pcm_runtime *rtd;
1917 struct snd_soc_dai_link *dai_link;
1918 int ret, i, card_probed = 0;
1920 mutex_lock(&client_mutex);
1921 mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1923 snd_soc_dapm_init(&card->dapm, card, NULL);
1925 /* check whether any platform is ignore machine FE and using topology */
1926 soc_check_tplg_fes(card);
1928 /* bind aux_devs too */
1929 ret = soc_bind_aux_dev(card);
1933 /* add predefined DAI links to the list */
1935 for_each_card_prelinks(card, i, dai_link) {
1936 ret = snd_soc_add_pcm_runtime(card, dai_link);
1941 /* card bind complete so register a sound card */
1942 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1943 card->owner, 0, &card->snd_card);
1946 "ASoC: can't create sound card for card %s: %d\n",
1951 soc_init_card_debugfs(card);
1953 soc_resume_init(card);
1955 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1956 card->num_dapm_widgets);
1960 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1961 card->num_of_dapm_widgets);
1965 /* initialise the sound card only once */
1967 ret = card->probe(card);
1973 /* probe all components used by DAI links on this card */
1974 ret = soc_probe_link_components(card);
1977 "ASoC: failed to instantiate card %d\n", ret);
1981 /* probe auxiliary components */
1982 ret = soc_probe_aux_devices(card);
1985 "ASoC: failed to probe aux component %d\n", ret);
1989 /* probe all DAI links on this card */
1990 ret = soc_probe_link_dais(card);
1993 "ASoC: failed to instantiate card %d\n", ret);
1997 for_each_card_rtds(card, rtd) {
1998 ret = soc_init_pcm_runtime(card, rtd);
2003 snd_soc_dapm_link_dai_widgets(card);
2004 snd_soc_dapm_connect_dai_link_widgets(card);
2006 ret = snd_soc_add_card_controls(card, card->controls,
2007 card->num_controls);
2011 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2012 card->num_dapm_routes);
2016 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2017 card->num_of_dapm_routes);
2021 /* try to set some sane longname if DMI is available */
2022 snd_soc_set_dmi_name(card, NULL);
2024 soc_setup_card_name(card->snd_card->shortname,
2025 card->name, NULL, 0);
2026 soc_setup_card_name(card->snd_card->longname,
2027 card->long_name, card->name, 0);
2028 soc_setup_card_name(card->snd_card->driver,
2029 card->driver_name, card->name, 1);
2031 if (card->components) {
2032 /* the current implementation of snd_component_add() accepts */
2033 /* multiple components in the string separated by space, */
2034 /* but the string collision (identical string) check might */
2035 /* not work correctly */
2036 ret = snd_component_add(card->snd_card, card->components);
2038 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
2044 if (card->late_probe) {
2045 ret = card->late_probe(card);
2047 dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2054 snd_soc_dapm_new_widgets(card);
2056 ret = snd_card_register(card->snd_card);
2058 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2063 card->instantiated = 1;
2064 dapm_mark_endpoints_dirty(card);
2065 snd_soc_dapm_sync(&card->dapm);
2067 /* deactivate pins to sleep state */
2068 for_each_card_rtds(card, rtd) {
2069 struct snd_soc_dai *dai;
2071 for_each_rtd_codec_dai(rtd, i, dai) {
2073 pinctrl_pm_select_sleep_state(dai->dev);
2076 if (!rtd->cpu_dai->active)
2077 pinctrl_pm_select_sleep_state(rtd->cpu_dai->dev);
2082 soc_cleanup_card_resources(card, card_probed);
2084 mutex_unlock(&card->mutex);
2085 mutex_unlock(&client_mutex);
2090 /* probes a new socdev */
2091 static int soc_probe(struct platform_device *pdev)
2093 struct snd_soc_card *card = platform_get_drvdata(pdev);
2096 * no card, so machine driver should be registering card
2097 * we should not be here in that case so ret error
2102 dev_warn(&pdev->dev,
2103 "ASoC: machine %s should use snd_soc_register_card()\n",
2106 /* Bodge while we unpick instantiation */
2107 card->dev = &pdev->dev;
2109 return snd_soc_register_card(card);
2112 /* removes a socdev */
2113 static int soc_remove(struct platform_device *pdev)
2115 struct snd_soc_card *card = platform_get_drvdata(pdev);
2117 snd_soc_unregister_card(card);
2121 int snd_soc_poweroff(struct device *dev)
2123 struct snd_soc_card *card = dev_get_drvdata(dev);
2124 struct snd_soc_pcm_runtime *rtd;
2126 if (!card->instantiated)
2130 * Flush out pmdown_time work - we actually do want to run it
2131 * now, we're shutting down so no imminent restart.
2133 snd_soc_flush_all_delayed_work(card);
2135 snd_soc_dapm_shutdown(card);
2137 /* deactivate pins to sleep state */
2138 for_each_card_rtds(card, rtd) {
2139 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2140 struct snd_soc_dai *codec_dai;
2143 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2144 for_each_rtd_codec_dai(rtd, i, codec_dai) {
2145 pinctrl_pm_select_sleep_state(codec_dai->dev);
2151 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2153 const struct dev_pm_ops snd_soc_pm_ops = {
2154 .suspend = snd_soc_suspend,
2155 .resume = snd_soc_resume,
2156 .freeze = snd_soc_suspend,
2157 .thaw = snd_soc_resume,
2158 .poweroff = snd_soc_poweroff,
2159 .restore = snd_soc_resume,
2161 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2163 /* ASoC platform driver */
2164 static struct platform_driver soc_driver = {
2166 .name = "soc-audio",
2167 .pm = &snd_soc_pm_ops,
2170 .remove = soc_remove,
2174 * snd_soc_cnew - create new control
2175 * @_template: control template
2176 * @data: control private data
2177 * @long_name: control long name
2178 * @prefix: control name prefix
2180 * Create a new mixer control from a template control.
2182 * Returns 0 for success, else error.
2184 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2185 void *data, const char *long_name,
2188 struct snd_kcontrol_new template;
2189 struct snd_kcontrol *kcontrol;
2192 memcpy(&template, _template, sizeof(template));
2196 long_name = template.name;
2199 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2203 template.name = name;
2205 template.name = long_name;
2208 kcontrol = snd_ctl_new1(&template, data);
2214 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2216 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2217 const struct snd_kcontrol_new *controls, int num_controls,
2218 const char *prefix, void *data)
2222 for (i = 0; i < num_controls; i++) {
2223 const struct snd_kcontrol_new *control = &controls[i];
2225 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2226 control->name, prefix));
2228 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2229 control->name, err);
2237 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2240 struct snd_card *card = soc_card->snd_card;
2241 struct snd_kcontrol *kctl;
2243 if (unlikely(!name))
2246 list_for_each_entry(kctl, &card->controls, list)
2247 if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2251 EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2254 * snd_soc_add_component_controls - Add an array of controls to a component.
2256 * @component: Component to add controls to
2257 * @controls: Array of controls to add
2258 * @num_controls: Number of elements in the array
2260 * Return: 0 for success, else error.
2262 int snd_soc_add_component_controls(struct snd_soc_component *component,
2263 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2265 struct snd_card *card = component->card->snd_card;
2267 return snd_soc_add_controls(card, component->dev, controls,
2268 num_controls, component->name_prefix, component);
2270 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2273 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2274 * Convenience function to add a list of controls.
2276 * @soc_card: SoC card to add controls to
2277 * @controls: array of controls to add
2278 * @num_controls: number of elements in the array
2280 * Return 0 for success, else error.
2282 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2283 const struct snd_kcontrol_new *controls, int num_controls)
2285 struct snd_card *card = soc_card->snd_card;
2287 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2290 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2293 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2294 * Convienience function to add a list of controls.
2296 * @dai: DAI to add controls to
2297 * @controls: array of controls to add
2298 * @num_controls: number of elements in the array
2300 * Return 0 for success, else error.
2302 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2303 const struct snd_kcontrol_new *controls, int num_controls)
2305 struct snd_card *card = dai->component->card->snd_card;
2307 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2310 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2313 * snd_soc_register_card - Register a card with the ASoC core
2315 * @card: Card to register
2318 int snd_soc_register_card(struct snd_soc_card *card)
2320 if (!card->name || !card->dev)
2323 dev_set_drvdata(card->dev, card);
2325 INIT_LIST_HEAD(&card->widgets);
2326 INIT_LIST_HEAD(&card->paths);
2327 INIT_LIST_HEAD(&card->dapm_list);
2328 INIT_LIST_HEAD(&card->aux_comp_list);
2329 INIT_LIST_HEAD(&card->component_dev_list);
2330 INIT_LIST_HEAD(&card->list);
2331 INIT_LIST_HEAD(&card->rtd_list);
2332 INIT_LIST_HEAD(&card->dapm_dirty);
2333 INIT_LIST_HEAD(&card->dobj_list);
2335 card->instantiated = 0;
2336 mutex_init(&card->mutex);
2337 mutex_init(&card->dapm_mutex);
2338 mutex_init(&card->pcm_mutex);
2339 spin_lock_init(&card->dpcm_lock);
2341 return snd_soc_bind_card(card);
2343 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2346 * snd_soc_unregister_card - Unregister a card with the ASoC core
2348 * @card: Card to unregister
2351 int snd_soc_unregister_card(struct snd_soc_card *card)
2353 mutex_lock(&client_mutex);
2354 snd_soc_unbind_card(card, true);
2355 mutex_unlock(&client_mutex);
2356 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2360 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2363 * Simplify DAI link configuration by removing ".-1" from device names
2364 * and sanitizing names.
2366 static char *fmt_single_name(struct device *dev, int *id)
2368 char *found, name[NAME_SIZE];
2371 if (dev_name(dev) == NULL)
2374 strlcpy(name, dev_name(dev), NAME_SIZE);
2376 /* are we a "%s.%d" name (platform and SPI components) */
2377 found = strstr(name, dev->driver->name);
2380 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2382 /* discard ID from name if ID == -1 */
2384 found[strlen(dev->driver->name)] = '\0';
2388 /* I2C component devices are named "bus-addr" */
2389 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2390 char tmp[NAME_SIZE];
2392 /* create unique ID number from I2C addr and bus */
2393 *id = ((id1 & 0xffff) << 16) + id2;
2395 /* sanitize component name for DAI link creation */
2396 snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2398 strlcpy(name, tmp, NAME_SIZE);
2403 return devm_kstrdup(dev, name, GFP_KERNEL);
2407 * Simplify DAI link naming for single devices with multiple DAIs by removing
2408 * any ".-1" and using the DAI name (instead of device name).
2410 static inline char *fmt_multiple_name(struct device *dev,
2411 struct snd_soc_dai_driver *dai_drv)
2413 if (dai_drv->name == NULL) {
2415 "ASoC: error - multiple DAI %s registered with no name\n",
2420 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2423 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2425 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2426 list_del(&dai->list);
2428 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2431 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2433 * @component: The component the DAIs are registered for
2434 * @dai_drv: DAI driver to use for the DAI
2435 * @legacy_dai_naming: if %true, use legacy single-name format;
2436 * if %false, use multiple-name format;
2438 * Topology can use this API to register DAIs when probing a component.
2439 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2440 * will be freed in the component cleanup.
2442 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2443 struct snd_soc_dai_driver *dai_drv,
2444 bool legacy_dai_naming)
2446 struct device *dev = component->dev;
2447 struct snd_soc_dai *dai;
2449 dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2451 lockdep_assert_held(&client_mutex);
2453 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2458 * Back in the old days when we still had component-less DAIs,
2459 * instead of having a static name, component-less DAIs would
2460 * inherit the name of the parent device so it is possible to
2461 * register multiple instances of the DAI. We still need to keep
2462 * the same naming style even though those DAIs are not
2463 * component-less anymore.
2465 if (legacy_dai_naming &&
2466 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2467 dai->name = fmt_single_name(dev, &dai->id);
2469 dai->name = fmt_multiple_name(dev, dai_drv);
2471 dai->id = dai_drv->id;
2473 dai->id = component->num_dai;
2478 dai->component = component;
2480 dai->driver = dai_drv;
2481 if (!dai->driver->ops)
2482 dai->driver->ops = &null_dai_ops;
2484 /* see for_each_component_dais */
2485 list_add_tail(&dai->list, &component->dai_list);
2486 component->num_dai++;
2488 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2493 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2495 * @component: The component for which the DAIs should be unregistered
2497 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2499 struct snd_soc_dai *dai, *_dai;
2501 for_each_component_dais_safe(component, dai, _dai)
2502 snd_soc_unregister_dai(dai);
2506 * snd_soc_register_dais - Register a DAI with the ASoC core
2508 * @component: The component the DAIs are registered for
2509 * @dai_drv: DAI driver to use for the DAIs
2510 * @count: Number of DAIs
2512 static int snd_soc_register_dais(struct snd_soc_component *component,
2513 struct snd_soc_dai_driver *dai_drv,
2516 struct snd_soc_dai *dai;
2520 for (i = 0; i < count; i++) {
2521 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2522 !component->driver->non_legacy_dai_naming);
2532 snd_soc_unregister_dais(component);
2537 static int snd_soc_component_initialize(struct snd_soc_component *component,
2538 const struct snd_soc_component_driver *driver, struct device *dev)
2540 INIT_LIST_HEAD(&component->dai_list);
2541 INIT_LIST_HEAD(&component->dobj_list);
2542 INIT_LIST_HEAD(&component->card_list);
2543 mutex_init(&component->io_mutex);
2545 component->name = fmt_single_name(dev, &component->id);
2546 if (!component->name) {
2547 dev_err(dev, "ASoC: Failed to allocate name\n");
2551 component->dev = dev;
2552 component->driver = driver;
2557 static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
2559 int val_bytes = regmap_get_val_bytes(component->regmap);
2561 /* Errors are legitimate for non-integer byte multiples */
2563 component->val_bytes = val_bytes;
2566 #ifdef CONFIG_REGMAP
2569 * snd_soc_component_init_regmap() - Initialize regmap instance for the
2571 * @component: The component for which to initialize the regmap instance
2572 * @regmap: The regmap instance that should be used by the component
2574 * This function allows deferred assignment of the regmap instance that is
2575 * associated with the component. Only use this if the regmap instance is not
2576 * yet ready when the component is registered. The function must also be called
2577 * before the first IO attempt of the component.
2579 void snd_soc_component_init_regmap(struct snd_soc_component *component,
2580 struct regmap *regmap)
2582 component->regmap = regmap;
2583 snd_soc_component_setup_regmap(component);
2585 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
2588 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
2590 * @component: The component for which to de-initialize the regmap instance
2592 * Calls regmap_exit() on the regmap instance associated to the component and
2593 * removes the regmap instance from the component.
2595 * This function should only be used if snd_soc_component_init_regmap() was used
2596 * to initialize the regmap instance.
2598 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
2600 regmap_exit(component->regmap);
2601 component->regmap = NULL;
2603 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
2607 #define ENDIANNESS_MAP(name) \
2608 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2609 static u64 endianness_format_map[] = {
2610 ENDIANNESS_MAP(S16_),
2611 ENDIANNESS_MAP(U16_),
2612 ENDIANNESS_MAP(S24_),
2613 ENDIANNESS_MAP(U24_),
2614 ENDIANNESS_MAP(S32_),
2615 ENDIANNESS_MAP(U32_),
2616 ENDIANNESS_MAP(S24_3),
2617 ENDIANNESS_MAP(U24_3),
2618 ENDIANNESS_MAP(S20_3),
2619 ENDIANNESS_MAP(U20_3),
2620 ENDIANNESS_MAP(S18_3),
2621 ENDIANNESS_MAP(U18_3),
2622 ENDIANNESS_MAP(FLOAT_),
2623 ENDIANNESS_MAP(FLOAT64_),
2624 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2628 * Fix up the DAI formats for endianness: codecs don't actually see
2629 * the endianness of the data but we're using the CPU format
2630 * definitions which do need to include endianness so we ensure that
2631 * codec DAIs always have both big and little endian variants set.
2633 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2637 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2638 if (stream->formats & endianness_format_map[i])
2639 stream->formats |= endianness_format_map[i];
2642 static void snd_soc_try_rebind_card(void)
2644 struct snd_soc_card *card, *c;
2646 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2647 if (!snd_soc_bind_card(card))
2648 list_del(&card->list);
2651 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2653 struct snd_soc_card *card = component->card;
2655 snd_soc_unregister_dais(component);
2658 snd_soc_unbind_card(card, false);
2660 list_del(&component->list);
2663 int snd_soc_add_component(struct device *dev,
2664 struct snd_soc_component *component,
2665 const struct snd_soc_component_driver *component_driver,
2666 struct snd_soc_dai_driver *dai_drv,
2672 mutex_lock(&client_mutex);
2674 ret = snd_soc_component_initialize(component, component_driver, dev);
2678 if (component_driver->endianness) {
2679 for (i = 0; i < num_dai; i++) {
2680 convert_endianness_formats(&dai_drv[i].playback);
2681 convert_endianness_formats(&dai_drv[i].capture);
2685 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2687 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
2691 if (!component->driver->write && !component->driver->read) {
2692 if (!component->regmap)
2693 component->regmap = dev_get_regmap(component->dev,
2695 if (component->regmap)
2696 snd_soc_component_setup_regmap(component);
2699 /* see for_each_component */
2700 list_add(&component->list, &component_list);
2704 snd_soc_del_component_unlocked(component);
2706 mutex_unlock(&client_mutex);
2709 snd_soc_try_rebind_card();
2713 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2715 int snd_soc_register_component(struct device *dev,
2716 const struct snd_soc_component_driver *component_driver,
2717 struct snd_soc_dai_driver *dai_drv,
2720 struct snd_soc_component *component;
2722 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2726 return snd_soc_add_component(dev, component, component_driver,
2729 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2732 * snd_soc_unregister_component - Unregister all related component
2733 * from the ASoC core
2735 * @dev: The device to unregister
2737 void snd_soc_unregister_component(struct device *dev)
2739 struct snd_soc_component *component;
2741 mutex_lock(&client_mutex);
2743 component = snd_soc_lookup_component_nolocked(dev, NULL);
2747 snd_soc_del_component_unlocked(component);
2749 mutex_unlock(&client_mutex);
2751 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2753 /* Retrieve a card's name from device tree */
2754 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2755 const char *propname)
2757 struct device_node *np;
2761 pr_err("card->dev is not set before calling %s\n", __func__);
2765 np = card->dev->of_node;
2767 ret = of_property_read_string_index(np, propname, 0, &card->name);
2769 * EINVAL means the property does not exist. This is fine providing
2770 * card->name was previously set, which is checked later in
2771 * snd_soc_register_card.
2773 if (ret < 0 && ret != -EINVAL) {
2775 "ASoC: Property '%s' could not be read: %d\n",
2782 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2784 static const struct snd_soc_dapm_widget simple_widgets[] = {
2785 SND_SOC_DAPM_MIC("Microphone", NULL),
2786 SND_SOC_DAPM_LINE("Line", NULL),
2787 SND_SOC_DAPM_HP("Headphone", NULL),
2788 SND_SOC_DAPM_SPK("Speaker", NULL),
2791 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2792 const char *propname)
2794 struct device_node *np = card->dev->of_node;
2795 struct snd_soc_dapm_widget *widgets;
2796 const char *template, *wname;
2797 int i, j, num_widgets, ret;
2799 num_widgets = of_property_count_strings(np, propname);
2800 if (num_widgets < 0) {
2802 "ASoC: Property '%s' does not exist\n", propname);
2805 if (num_widgets & 1) {
2807 "ASoC: Property '%s' length is not even\n", propname);
2813 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2818 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2822 "ASoC: Could not allocate memory for widgets\n");
2826 for (i = 0; i < num_widgets; i++) {
2827 ret = of_property_read_string_index(np, propname,
2831 "ASoC: Property '%s' index %d read error:%d\n",
2832 propname, 2 * i, ret);
2836 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2837 if (!strncmp(template, simple_widgets[j].name,
2838 strlen(simple_widgets[j].name))) {
2839 widgets[i] = simple_widgets[j];
2844 if (j >= ARRAY_SIZE(simple_widgets)) {
2846 "ASoC: DAPM widget '%s' is not supported\n",
2851 ret = of_property_read_string_index(np, propname,
2856 "ASoC: Property '%s' index %d read error:%d\n",
2857 propname, (2 * i) + 1, ret);
2861 widgets[i].name = wname;
2864 card->of_dapm_widgets = widgets;
2865 card->num_of_dapm_widgets = num_widgets;
2869 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2871 int snd_soc_of_get_slot_mask(struct device_node *np,
2872 const char *prop_name,
2876 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2882 for (i = 0; i < val; i++)
2883 if (be32_to_cpup(&of_slot_mask[i]))
2888 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2890 int snd_soc_of_parse_tdm_slot(struct device_node *np,
2891 unsigned int *tx_mask,
2892 unsigned int *rx_mask,
2893 unsigned int *slots,
2894 unsigned int *slot_width)
2900 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2902 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2904 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2905 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2913 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2914 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2924 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2926 void snd_soc_of_parse_node_prefix(struct device_node *np,
2927 struct snd_soc_codec_conf *codec_conf,
2928 struct device_node *of_node,
2929 const char *propname)
2934 ret = of_property_read_string(np, propname, &str);
2936 /* no prefix is not error */
2940 codec_conf->of_node = of_node;
2941 codec_conf->name_prefix = str;
2943 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2945 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2946 const char *propname)
2948 struct device_node *np = card->dev->of_node;
2950 struct snd_soc_dapm_route *routes;
2953 num_routes = of_property_count_strings(np, propname);
2954 if (num_routes < 0 || num_routes & 1) {
2956 "ASoC: Property '%s' does not exist or its length is not even\n",
2962 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2967 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2971 "ASoC: Could not allocate DAPM route table\n");
2975 for (i = 0; i < num_routes; i++) {
2976 ret = of_property_read_string_index(np, propname,
2977 2 * i, &routes[i].sink);
2980 "ASoC: Property '%s' index %d could not be read: %d\n",
2981 propname, 2 * i, ret);
2984 ret = of_property_read_string_index(np, propname,
2985 (2 * i) + 1, &routes[i].source);
2988 "ASoC: Property '%s' index %d could not be read: %d\n",
2989 propname, (2 * i) + 1, ret);
2994 card->num_of_dapm_routes = num_routes;
2995 card->of_dapm_routes = routes;
2999 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3001 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
3003 struct device_node **bitclkmaster,
3004 struct device_node **framemaster)
3008 unsigned int format = 0;
3014 } of_fmt_table[] = {
3015 { "i2s", SND_SOC_DAIFMT_I2S },
3016 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
3017 { "left_j", SND_SOC_DAIFMT_LEFT_J },
3018 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
3019 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
3020 { "ac97", SND_SOC_DAIFMT_AC97 },
3021 { "pdm", SND_SOC_DAIFMT_PDM},
3022 { "msb", SND_SOC_DAIFMT_MSB },
3023 { "lsb", SND_SOC_DAIFMT_LSB },
3030 * check "dai-format = xxx"
3031 * or "[prefix]format = xxx"
3032 * SND_SOC_DAIFMT_FORMAT_MASK area
3034 ret = of_property_read_string(np, "dai-format", &str);
3036 snprintf(prop, sizeof(prop), "%sformat", prefix);
3037 ret = of_property_read_string(np, prop, &str);
3040 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3041 if (strcmp(str, of_fmt_table[i].name) == 0) {
3042 format |= of_fmt_table[i].val;
3049 * check "[prefix]continuous-clock"
3050 * SND_SOC_DAIFMT_CLOCK_MASK area
3052 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3053 if (of_property_read_bool(np, prop))
3054 format |= SND_SOC_DAIFMT_CONT;
3056 format |= SND_SOC_DAIFMT_GATED;
3059 * check "[prefix]bitclock-inversion"
3060 * check "[prefix]frame-inversion"
3061 * SND_SOC_DAIFMT_INV_MASK area
3063 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3064 bit = !!of_get_property(np, prop, NULL);
3066 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3067 frame = !!of_get_property(np, prop, NULL);
3069 switch ((bit << 4) + frame) {
3071 format |= SND_SOC_DAIFMT_IB_IF;
3074 format |= SND_SOC_DAIFMT_IB_NF;
3077 format |= SND_SOC_DAIFMT_NB_IF;
3080 /* SND_SOC_DAIFMT_NB_NF is default */
3085 * check "[prefix]bitclock-master"
3086 * check "[prefix]frame-master"
3087 * SND_SOC_DAIFMT_MASTER_MASK area
3089 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3090 bit = !!of_get_property(np, prop, NULL);
3091 if (bit && bitclkmaster)
3092 *bitclkmaster = of_parse_phandle(np, prop, 0);
3094 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3095 frame = !!of_get_property(np, prop, NULL);
3096 if (frame && framemaster)
3097 *framemaster = of_parse_phandle(np, prop, 0);
3099 switch ((bit << 4) + frame) {
3101 format |= SND_SOC_DAIFMT_CBM_CFM;
3104 format |= SND_SOC_DAIFMT_CBM_CFS;
3107 format |= SND_SOC_DAIFMT_CBS_CFM;
3110 format |= SND_SOC_DAIFMT_CBS_CFS;
3116 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
3118 int snd_soc_get_dai_id(struct device_node *ep)
3120 struct snd_soc_component *component;
3121 struct snd_soc_dai_link_component dlc;
3124 dlc.of_node = of_graph_get_port_parent(ep);
3127 * For example HDMI case, HDMI has video/sound port,
3128 * but ALSA SoC needs sound port number only.
3129 * Thus counting HDMI DT port/endpoint doesn't work.
3130 * Then, it should have .of_xlate_dai_id
3133 mutex_lock(&client_mutex);
3134 component = soc_find_component(&dlc);
3136 ret = snd_soc_component_of_xlate_dai_id(component, ep);
3137 mutex_unlock(&client_mutex);
3139 of_node_put(dlc.of_node);
3143 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3145 int snd_soc_get_dai_name(struct of_phandle_args *args,
3146 const char **dai_name)
3148 struct snd_soc_component *pos;
3149 struct device_node *component_of_node;
3150 int ret = -EPROBE_DEFER;
3152 mutex_lock(&client_mutex);
3153 for_each_component(pos) {
3154 component_of_node = soc_component_to_node(pos);
3156 if (component_of_node != args->np)
3159 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3160 if (ret == -ENOTSUPP) {
3161 struct snd_soc_dai *dai;
3164 switch (args->args_count) {
3166 id = 0; /* same as dai_drv[0] */
3176 if (id < 0 || id >= pos->num_dai) {
3183 /* find target DAI */
3184 for_each_component_dais(pos, dai) {
3190 *dai_name = dai->driver->name;
3192 *dai_name = pos->name;
3197 mutex_unlock(&client_mutex);
3200 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3202 int snd_soc_of_get_dai_name(struct device_node *of_node,
3203 const char **dai_name)
3205 struct of_phandle_args args;
3208 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3209 "#sound-dai-cells", 0, &args);
3213 ret = snd_soc_get_dai_name(&args, dai_name);
3215 of_node_put(args.np);
3219 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3222 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3223 * @dai_link: DAI link
3225 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3227 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3229 struct snd_soc_dai_link_component *component;
3232 for_each_link_codecs(dai_link, index, component) {
3233 if (!component->of_node)
3235 of_node_put(component->of_node);
3236 component->of_node = NULL;
3239 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3242 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3244 * @of_node: Device node
3245 * @dai_link: DAI link
3247 * Builds an array of CODEC DAI components from the DAI link property
3249 * The array is set in the DAI link and the number of DAIs is set accordingly.
3250 * The device nodes in the array (of_node) must be dereferenced by calling
3251 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3253 * Returns 0 for success
3255 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3256 struct device_node *of_node,
3257 struct snd_soc_dai_link *dai_link)
3259 struct of_phandle_args args;
3260 struct snd_soc_dai_link_component *component;
3262 int index, num_codecs, ret;
3264 /* Count the number of CODECs */
3266 num_codecs = of_count_phandle_with_args(of_node, name,
3267 "#sound-dai-cells");
3268 if (num_codecs <= 0) {
3269 if (num_codecs == -ENOENT)
3270 dev_err(dev, "No 'sound-dai' property\n");
3272 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3275 component = devm_kcalloc(dev,
3276 num_codecs, sizeof(*component),
3280 dai_link->codecs = component;
3281 dai_link->num_codecs = num_codecs;
3283 /* Parse the list */
3284 for_each_link_codecs(dai_link, index, component) {
3285 ret = of_parse_phandle_with_args(of_node, name,
3290 component->of_node = args.np;
3291 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3297 snd_soc_of_put_dai_link_codecs(dai_link);
3298 dai_link->codecs = NULL;
3299 dai_link->num_codecs = 0;
3302 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3304 static int __init snd_soc_init(void)
3306 snd_soc_debugfs_init();
3307 snd_soc_util_init();
3309 return platform_driver_register(&soc_driver);
3311 module_init(snd_soc_init);
3313 static void __exit snd_soc_exit(void)
3315 snd_soc_util_exit();
3316 snd_soc_debugfs_exit();
3318 platform_driver_unregister(&soc_driver);
3320 module_exit(snd_soc_exit);
3322 /* Module information */
3323 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3324 MODULE_DESCRIPTION("ALSA SoC Core");
3325 MODULE_LICENSE("GPL");
3326 MODULE_ALIAS("platform:soc-audio");