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/soc-link.h>
42 #include <sound/initval.h>
44 #define CREATE_TRACE_POINTS
45 #include <trace/events/asoc.h>
49 static DEFINE_MUTEX(client_mutex);
50 static LIST_HEAD(component_list);
51 static LIST_HEAD(unbind_card_list);
53 #define for_each_component(component) \
54 list_for_each_entry(component, &component_list, list)
57 * This is used if driver don't need to have CPU/Codec/Platform
60 struct snd_soc_dai_link_component null_dailink_component[0];
61 EXPORT_SYMBOL_GPL(null_dailink_component);
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 static ssize_t pmdown_time_show(struct device *dev,
73 struct device_attribute *attr, char *buf)
75 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
77 return sprintf(buf, "%ld\n", rtd->pmdown_time);
80 static ssize_t pmdown_time_set(struct device *dev,
81 struct device_attribute *attr,
82 const char *buf, size_t count)
84 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
87 ret = kstrtol(buf, 10, &rtd->pmdown_time);
94 static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
96 static struct attribute *soc_dev_attrs[] = {
97 &dev_attr_pmdown_time.attr,
101 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
102 struct attribute *attr, int idx)
104 struct device *dev = kobj_to_dev(kobj);
105 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
110 if (attr == &dev_attr_pmdown_time.attr)
111 return attr->mode; /* always visible */
112 return rtd->num_codecs ? attr->mode : 0; /* enabled only with codec */
115 static const struct attribute_group soc_dapm_dev_group = {
116 .attrs = soc_dapm_dev_attrs,
117 .is_visible = soc_dev_attr_is_visible,
120 static const struct attribute_group soc_dev_group = {
121 .attrs = soc_dev_attrs,
122 .is_visible = soc_dev_attr_is_visible,
125 static const struct attribute_group *soc_dev_attr_groups[] = {
131 #ifdef CONFIG_DEBUG_FS
132 struct dentry *snd_soc_debugfs_root;
133 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
135 static void soc_init_component_debugfs(struct snd_soc_component *component)
137 if (!component->card->debugfs_card_root)
140 if (component->debugfs_prefix) {
143 name = kasprintf(GFP_KERNEL, "%s:%s",
144 component->debugfs_prefix, component->name);
146 component->debugfs_root = debugfs_create_dir(name,
147 component->card->debugfs_card_root);
151 component->debugfs_root = debugfs_create_dir(component->name,
152 component->card->debugfs_card_root);
155 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
156 component->debugfs_root);
159 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
161 if (!component->debugfs_root)
163 debugfs_remove_recursive(component->debugfs_root);
164 component->debugfs_root = NULL;
167 static int dai_list_show(struct seq_file *m, void *v)
169 struct snd_soc_component *component;
170 struct snd_soc_dai *dai;
172 mutex_lock(&client_mutex);
174 for_each_component(component)
175 for_each_component_dais(component, dai)
176 seq_printf(m, "%s\n", dai->name);
178 mutex_unlock(&client_mutex);
182 DEFINE_SHOW_ATTRIBUTE(dai_list);
184 static int component_list_show(struct seq_file *m, void *v)
186 struct snd_soc_component *component;
188 mutex_lock(&client_mutex);
190 for_each_component(component)
191 seq_printf(m, "%s\n", component->name);
193 mutex_unlock(&client_mutex);
197 DEFINE_SHOW_ATTRIBUTE(component_list);
199 static void soc_init_card_debugfs(struct snd_soc_card *card)
201 card->debugfs_card_root = debugfs_create_dir(card->name,
202 snd_soc_debugfs_root);
204 debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
207 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
210 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
212 debugfs_remove_recursive(card->debugfs_card_root);
213 card->debugfs_card_root = NULL;
216 static void snd_soc_debugfs_init(void)
218 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
220 debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
223 debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
224 &component_list_fops);
227 static void snd_soc_debugfs_exit(void)
229 debugfs_remove_recursive(snd_soc_debugfs_root);
234 static inline void soc_init_component_debugfs(
235 struct snd_soc_component *component)
239 static inline void soc_cleanup_component_debugfs(
240 struct snd_soc_component *component)
244 static inline void soc_init_card_debugfs(struct snd_soc_card *card)
248 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
252 static inline void snd_soc_debugfs_init(void)
256 static inline void snd_soc_debugfs_exit(void)
262 static int snd_soc_rtd_add_component(struct snd_soc_pcm_runtime *rtd,
263 struct snd_soc_component *component)
265 struct snd_soc_component *comp;
268 for_each_rtd_components(rtd, i, comp) {
269 /* already connected */
270 if (comp == component)
274 /* see for_each_rtd_components */
275 rtd->components[rtd->num_components] = component;
276 rtd->num_components++;
281 struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
282 const char *driver_name)
284 struct snd_soc_component *component;
293 * snd_soc_rtdcom_lookup() will find component from rtd by using
294 * specified driver name.
295 * But, if many components which have same driver name are connected
296 * to 1 rtd, this function will return 1st found component.
298 for_each_rtd_components(rtd, i, component) {
299 const char *component_name = component->driver->name;
304 if ((component_name == driver_name) ||
305 strcmp(component_name, driver_name) == 0)
311 EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
313 struct snd_soc_component
314 *snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
316 struct snd_soc_component *component;
317 struct snd_soc_component *found_component;
319 found_component = NULL;
320 for_each_component(component) {
321 if ((dev == component->dev) &&
323 (driver_name == component->driver->name) ||
324 (strcmp(component->driver->name, driver_name) == 0))) {
325 found_component = component;
330 return found_component;
332 EXPORT_SYMBOL_GPL(snd_soc_lookup_component_nolocked);
334 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
335 const char *driver_name)
337 struct snd_soc_component *component;
339 mutex_lock(&client_mutex);
340 component = snd_soc_lookup_component_nolocked(dev, driver_name);
341 mutex_unlock(&client_mutex);
345 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
347 struct snd_soc_pcm_runtime
348 *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
349 struct snd_soc_dai_link *dai_link)
351 struct snd_soc_pcm_runtime *rtd;
353 for_each_card_rtds(card, rtd) {
354 if (rtd->dai_link == dai_link)
357 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
360 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
363 * Power down the audio subsystem pmdown_time msecs after close is called.
364 * This is to ensure there are no pops or clicks in between any music tracks
365 * due to DAPM power cycling.
367 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd)
369 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
370 int playback = SNDRV_PCM_STREAM_PLAYBACK;
372 mutex_lock_nested(&rtd->card->pcm_mutex, rtd->card->pcm_subclass);
375 "ASoC: pop wq checking: %s status: %s waiting: %s\n",
376 codec_dai->driver->playback.stream_name,
377 snd_soc_dai_stream_active(codec_dai, playback) ?
378 "active" : "inactive",
379 rtd->pop_wait ? "yes" : "no");
381 /* are we waiting on this codec DAI stream */
382 if (rtd->pop_wait == 1) {
384 snd_soc_dapm_stream_event(rtd, playback,
385 SND_SOC_DAPM_STREAM_STOP);
388 mutex_unlock(&rtd->card->pcm_mutex);
390 EXPORT_SYMBOL_GPL(snd_soc_close_delayed_work);
392 static void soc_release_rtd_dev(struct device *dev)
394 /* "dev" means "rtd->dev" */
398 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
403 list_del(&rtd->list);
405 if (delayed_work_pending(&rtd->delayed_work))
406 flush_delayed_work(&rtd->delayed_work);
407 snd_soc_pcm_component_free(rtd);
410 * we don't need to call kfree() for rtd->dev
412 * soc_release_rtd_dev()
414 * We don't need rtd->dev NULL check, because
415 * it is alloced *before* rtd.
417 * soc_new_pcm_runtime()
419 device_unregister(rtd->dev);
422 static void close_delayed_work(struct work_struct *work) {
423 struct snd_soc_pcm_runtime *rtd =
424 container_of(work, struct snd_soc_pcm_runtime,
427 if (rtd->close_delayed_work_func)
428 rtd->close_delayed_work_func(rtd);
431 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
432 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
434 struct snd_soc_pcm_runtime *rtd;
435 struct snd_soc_component *component;
443 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
447 dev->parent = card->dev;
448 dev->release = soc_release_rtd_dev;
450 dev_set_name(dev, "%s", dai_link->name);
452 ret = device_register(dev);
454 put_device(dev); /* soc_release_rtd_dev */
461 rtd = devm_kzalloc(dev,
463 sizeof(*component) * (dai_link->num_cpus +
464 dai_link->num_codecs +
465 dai_link->num_platforms),
471 INIT_LIST_HEAD(&rtd->list);
472 for_each_pcm_streams(stream) {
473 INIT_LIST_HEAD(&rtd->dpcm[stream].be_clients);
474 INIT_LIST_HEAD(&rtd->dpcm[stream].fe_clients);
476 dev_set_drvdata(dev, rtd);
477 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
482 rtd->dais = devm_kcalloc(dev, dai_link->num_cpus + dai_link->num_codecs,
483 sizeof(struct snd_soc_dai *),
489 * dais = [][][][][][][][][][][][][][][][][][]
490 * ^cpu_dais ^codec_dais
491 * |--- num_cpus ---|--- num_codecs --|
494 * asoc_rtd_to_codec()
496 rtd->num_cpus = dai_link->num_cpus;
497 rtd->num_codecs = dai_link->num_codecs;
499 rtd->dai_link = dai_link;
500 rtd->num = card->num_rtd++;
502 /* see for_each_card_rtds */
503 list_add_tail(&rtd->list, &card->rtd_list);
505 ret = device_add_groups(dev, soc_dev_attr_groups);
512 soc_free_pcm_runtime(rtd);
516 static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
518 struct snd_soc_pcm_runtime *rtd;
520 for_each_card_rtds(card, rtd)
521 flush_delayed_work(&rtd->delayed_work);
524 #ifdef CONFIG_PM_SLEEP
525 /* powers down audio subsystem for suspend */
526 int snd_soc_suspend(struct device *dev)
528 struct snd_soc_card *card = dev_get_drvdata(dev);
529 struct snd_soc_component *component;
530 struct snd_soc_pcm_runtime *rtd;
531 int playback = SNDRV_PCM_STREAM_PLAYBACK;
534 /* If the card is not initialized yet there is nothing to do */
535 if (!card->instantiated)
539 * Due to the resume being scheduled into a workqueue we could
540 * suspend before that's finished - wait for it to complete.
542 snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
544 /* we're going to block userspace touching us until resume completes */
545 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
547 /* mute any active DACs */
548 for_each_card_rtds(card, rtd) {
549 struct snd_soc_dai *dai;
551 if (rtd->dai_link->ignore_suspend)
554 for_each_rtd_dais(rtd, i, dai) {
555 if (snd_soc_dai_stream_active(dai, playback))
556 snd_soc_dai_digital_mute(dai, 1, playback);
560 /* suspend all pcms */
561 for_each_card_rtds(card, rtd) {
562 if (rtd->dai_link->ignore_suspend)
565 snd_pcm_suspend_all(rtd->pcm);
568 snd_soc_card_suspend_pre(card);
570 /* close any waiting streams */
571 snd_soc_flush_all_delayed_work(card);
573 for_each_card_rtds(card, rtd) {
576 if (rtd->dai_link->ignore_suspend)
579 for_each_pcm_streams(stream)
580 snd_soc_dapm_stream_event(rtd, stream,
581 SND_SOC_DAPM_STREAM_SUSPEND);
584 /* Recheck all endpoints too, their state is affected by suspend */
585 dapm_mark_endpoints_dirty(card);
586 snd_soc_dapm_sync(&card->dapm);
588 /* suspend all COMPONENTs */
589 for_each_card_rtds(card, rtd) {
591 if (rtd->dai_link->ignore_suspend)
594 for_each_rtd_components(rtd, i, component) {
595 struct snd_soc_dapm_context *dapm =
596 snd_soc_component_get_dapm(component);
599 * ignore if component was already suspended
601 if (snd_soc_component_is_suspended(component))
605 * If there are paths active then the COMPONENT will be
606 * held with bias _ON and should not be suspended.
608 switch (snd_soc_dapm_get_bias_level(dapm)) {
609 case SND_SOC_BIAS_STANDBY:
611 * If the COMPONENT is capable of idle
612 * bias off then being in STANDBY
613 * means it's doing something,
614 * otherwise fall through.
616 if (dapm->idle_bias_off) {
617 dev_dbg(component->dev,
618 "ASoC: idle_bias_off CODEC on over suspend\n");
623 case SND_SOC_BIAS_OFF:
624 snd_soc_component_suspend(component);
625 if (component->regmap)
626 regcache_mark_dirty(component->regmap);
627 /* deactivate pins to sleep state */
628 pinctrl_pm_select_sleep_state(component->dev);
631 dev_dbg(component->dev,
632 "ASoC: COMPONENT is on over suspend\n");
638 snd_soc_card_suspend_post(card);
642 EXPORT_SYMBOL_GPL(snd_soc_suspend);
645 * deferred resume work, so resume can complete before we finished
646 * setting our codec back up, which can be very slow on I2C
648 static void soc_resume_deferred(struct work_struct *work)
650 struct snd_soc_card *card =
651 container_of(work, struct snd_soc_card,
652 deferred_resume_work);
653 struct snd_soc_pcm_runtime *rtd;
654 struct snd_soc_component *component;
658 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
659 * so userspace apps are blocked from touching us
662 dev_dbg(card->dev, "ASoC: starting resume work\n");
664 /* Bring us up into D2 so that DAPM starts enabling things */
665 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
667 snd_soc_card_resume_pre(card);
669 for_each_card_components(card, component) {
670 if (snd_soc_component_is_suspended(component))
671 snd_soc_component_resume(component);
674 for_each_card_rtds(card, rtd) {
677 if (rtd->dai_link->ignore_suspend)
680 for_each_pcm_streams(stream)
681 snd_soc_dapm_stream_event(rtd, stream,
682 SND_SOC_DAPM_STREAM_RESUME);
685 /* unmute any active DACs */
686 for_each_card_rtds(card, rtd) {
687 struct snd_soc_dai *dai;
688 int playback = SNDRV_PCM_STREAM_PLAYBACK;
690 if (rtd->dai_link->ignore_suspend)
693 for_each_rtd_dais(rtd, i, dai) {
694 if (snd_soc_dai_stream_active(dai, playback))
695 snd_soc_dai_digital_mute(dai, 0, playback);
699 snd_soc_card_resume_post(card);
701 dev_dbg(card->dev, "ASoC: resume work completed\n");
703 /* Recheck all endpoints too, their state is affected by suspend */
704 dapm_mark_endpoints_dirty(card);
705 snd_soc_dapm_sync(&card->dapm);
707 /* userspace can access us now we are back as we were before */
708 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
711 /* powers up audio subsystem after a suspend */
712 int snd_soc_resume(struct device *dev)
714 struct snd_soc_card *card = dev_get_drvdata(dev);
715 struct snd_soc_component *component;
717 /* If the card is not initialized yet there is nothing to do */
718 if (!card->instantiated)
721 /* activate pins from sleep state */
722 for_each_card_components(card, component)
723 if (snd_soc_component_active(component))
724 pinctrl_pm_select_default_state(component->dev);
726 dev_dbg(dev, "ASoC: Scheduling resume work\n");
727 if (!schedule_work(&card->deferred_resume_work))
728 dev_err(dev, "ASoC: resume work item may be lost\n");
732 EXPORT_SYMBOL_GPL(snd_soc_resume);
734 static void soc_resume_init(struct snd_soc_card *card)
736 /* deferred resume work */
737 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
740 #define snd_soc_suspend NULL
741 #define snd_soc_resume NULL
742 static inline void soc_resume_init(struct snd_soc_card *card)
747 static struct device_node
748 *soc_component_to_node(struct snd_soc_component *component)
750 struct device_node *of_node;
752 of_node = component->dev->of_node;
753 if (!of_node && component->dev->parent)
754 of_node = component->dev->parent->of_node;
759 static int snd_soc_is_matching_component(
760 const struct snd_soc_dai_link_component *dlc,
761 struct snd_soc_component *component)
763 struct device_node *component_of_node;
768 component_of_node = soc_component_to_node(component);
770 if (dlc->of_node && component_of_node != dlc->of_node)
772 if (dlc->name && strcmp(component->name, dlc->name))
778 static struct snd_soc_component *soc_find_component(
779 const struct snd_soc_dai_link_component *dlc)
781 struct snd_soc_component *component;
783 lockdep_assert_held(&client_mutex);
788 * It returns *1st* found component, but some driver
789 * has few components by same of_node/name
791 * CPU component and generic DMAEngine component
793 for_each_component(component)
794 if (snd_soc_is_matching_component(dlc, component))
801 * snd_soc_find_dai - Find a registered DAI
803 * @dlc: name of the DAI or the DAI driver and optional component info to match
805 * This function will search all registered components and their DAIs to
806 * find the DAI of the same name. The component's of_node and name
807 * should also match if being specified.
809 * Return: pointer of DAI, or NULL if not found.
811 struct snd_soc_dai *snd_soc_find_dai(
812 const struct snd_soc_dai_link_component *dlc)
814 struct snd_soc_component *component;
815 struct snd_soc_dai *dai;
817 lockdep_assert_held(&client_mutex);
819 /* Find CPU DAI from registered DAIs */
820 for_each_component(component) {
821 if (!snd_soc_is_matching_component(dlc, component))
823 for_each_component_dais(component, dai) {
824 if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
825 && (!dai->driver->name
826 || strcmp(dai->driver->name, dlc->dai_name)))
835 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
837 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
838 const struct snd_soc_dai_link_component *dlc)
840 struct snd_soc_dai *dai;
842 mutex_lock(&client_mutex);
843 dai = snd_soc_find_dai(dlc);
844 mutex_unlock(&client_mutex);
848 EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
850 static int soc_dai_link_sanity_check(struct snd_soc_card *card,
851 struct snd_soc_dai_link *link)
854 struct snd_soc_dai_link_component *cpu, *codec, *platform;
856 for_each_link_codecs(link, i, codec) {
858 * Codec must be specified by 1 of name or OF node,
859 * not both or neither.
861 if (!!codec->name == !!codec->of_node) {
862 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
867 /* Codec DAI name must be specified */
868 if (!codec->dai_name) {
869 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
875 * Defer card registration if codec component is not added to
878 if (!soc_find_component(codec)) {
880 "ASoC: codec component %s not found for link %s\n",
881 codec->name, link->name);
882 return -EPROBE_DEFER;
886 for_each_link_platforms(link, i, platform) {
888 * Platform may be specified by either name or OF node, but it
889 * can be left unspecified, then no components will be inserted
892 if (!!platform->name == !!platform->of_node) {
894 "ASoC: Neither/both platform name/of_node are set for %s\n",
900 * Defer card registration if platform component is not added to
903 if (!soc_find_component(platform)) {
905 "ASoC: platform component %s not found for link %s\n",
906 platform->name, link->name);
907 return -EPROBE_DEFER;
911 for_each_link_cpus(link, i, cpu) {
913 * CPU device may be specified by either name or OF node, but
914 * can be left unspecified, and will be matched based on DAI
917 if (cpu->name && cpu->of_node) {
919 "ASoC: Neither/both cpu name/of_node are set for %s\n",
925 * Defer card registration if cpu dai component is not added to
928 if ((cpu->of_node || cpu->name) &&
929 !soc_find_component(cpu)) {
931 "ASoC: cpu component %s not found for link %s\n",
932 cpu->name, link->name);
933 return -EPROBE_DEFER;
937 * At least one of CPU DAI name or CPU device name/node must be
940 if (!cpu->dai_name &&
941 !(cpu->name || cpu->of_node)) {
943 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
953 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
954 * @card: The ASoC card to which the pcm_runtime has
955 * @rtd: The pcm_runtime to remove
957 * This function removes a pcm_runtime from the ASoC card.
959 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
960 struct snd_soc_pcm_runtime *rtd)
962 lockdep_assert_held(&client_mutex);
964 /* release machine specific resources */
965 snd_soc_link_exit(rtd);
968 * Notify the machine driver for extra destruction
970 snd_soc_card_remove_dai_link(card, rtd->dai_link);
972 soc_free_pcm_runtime(rtd);
974 EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
977 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
978 * @card: The ASoC card to which the pcm_runtime is added
979 * @dai_link: The DAI link to find pcm_runtime
981 * This function adds a pcm_runtime ASoC card by using dai_link.
983 * Note: Topology can use this API to add pcm_runtime when probing the
984 * topology component. And machine drivers can still define static
985 * DAI links in dai_link array.
987 int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
988 struct snd_soc_dai_link *dai_link)
990 struct snd_soc_pcm_runtime *rtd;
991 struct snd_soc_dai_link_component *codec, *platform, *cpu;
992 struct snd_soc_component *component;
995 lockdep_assert_held(&client_mutex);
998 * Notify the machine driver for extra initialization
1000 ret = snd_soc_card_add_dai_link(card, dai_link);
1004 if (dai_link->ignore)
1007 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1009 ret = soc_dai_link_sanity_check(card, dai_link);
1013 rtd = soc_new_pcm_runtime(card, dai_link);
1017 for_each_link_cpus(dai_link, i, cpu) {
1018 asoc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
1019 if (!asoc_rtd_to_cpu(rtd, i)) {
1020 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1024 snd_soc_rtd_add_component(rtd, asoc_rtd_to_cpu(rtd, i)->component);
1027 /* Find CODEC from registered CODECs */
1028 for_each_link_codecs(dai_link, i, codec) {
1029 asoc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1030 if (!asoc_rtd_to_codec(rtd, i)) {
1031 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1036 snd_soc_rtd_add_component(rtd, asoc_rtd_to_codec(rtd, i)->component);
1039 /* Find PLATFORM from registered PLATFORMs */
1040 for_each_link_platforms(dai_link, i, platform) {
1041 for_each_component(component) {
1042 if (!snd_soc_is_matching_component(platform, component))
1045 snd_soc_rtd_add_component(rtd, component);
1052 snd_soc_remove_pcm_runtime(card, rtd);
1053 return -EPROBE_DEFER;
1055 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtime);
1057 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1058 struct snd_soc_pcm_runtime *rtd)
1060 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1061 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
1062 struct snd_soc_component *component;
1065 /* set default power off timeout */
1066 rtd->pmdown_time = pmdown_time;
1068 /* do machine specific initialization */
1069 ret = snd_soc_link_init(rtd);
1073 if (dai_link->dai_fmt) {
1074 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1079 /* add DPCM sysfs entries */
1080 soc_dpcm_debugfs_add(rtd);
1085 * most drivers will register their PCMs using DAI link ordering but
1086 * topology based drivers can use the DAI link id field to set PCM
1087 * device number and then use rtd + a base offset of the BEs.
1089 for_each_rtd_components(rtd, i, component) {
1090 if (!component->driver->use_dai_pcm_id)
1093 if (rtd->dai_link->no_pcm)
1094 num += component->driver->be_pcm_base;
1096 num = rtd->dai_link->id;
1099 /* create compress_device if possible */
1100 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1101 if (ret != -ENOTSUPP) {
1103 dev_err(card->dev, "ASoC: can't create compress %s\n",
1104 dai_link->stream_name);
1108 /* create the pcm */
1109 ret = soc_new_pcm(rtd, num);
1111 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1112 dai_link->stream_name, ret);
1116 return snd_soc_pcm_dai_new(rtd);
1119 static void soc_set_name_prefix(struct snd_soc_card *card,
1120 struct snd_soc_component *component)
1122 struct device_node *of_node = soc_component_to_node(component);
1126 for (i = 0; i < card->num_configs; i++) {
1127 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1129 if (snd_soc_is_matching_component(&map->dlc, component)) {
1130 component->name_prefix = map->name_prefix;
1136 * If there is no configuration table or no match in the table,
1137 * check if a prefix is provided in the node
1139 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1143 component->name_prefix = str;
1146 static void soc_remove_component(struct snd_soc_component *component,
1150 if (!component->card)
1154 snd_soc_component_remove(component);
1156 /* For framework level robustness */
1157 snd_soc_component_set_jack(component, NULL, NULL);
1159 list_del_init(&component->card_list);
1160 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1161 soc_cleanup_component_debugfs(component);
1162 component->card = NULL;
1163 snd_soc_component_module_put_when_remove(component);
1166 static int soc_probe_component(struct snd_soc_card *card,
1167 struct snd_soc_component *component)
1169 struct snd_soc_dapm_context *dapm =
1170 snd_soc_component_get_dapm(component);
1171 struct snd_soc_dai *dai;
1175 if (!strcmp(component->name, "snd-soc-dummy"))
1178 if (component->card) {
1179 if (component->card != card) {
1180 dev_err(component->dev,
1181 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1182 card->name, component->card->name);
1188 ret = snd_soc_component_module_get_when_probe(component);
1192 component->card = card;
1193 soc_set_name_prefix(card, component);
1195 soc_init_component_debugfs(component);
1197 snd_soc_dapm_init(dapm, card, component);
1199 ret = snd_soc_dapm_new_controls(dapm,
1200 component->driver->dapm_widgets,
1201 component->driver->num_dapm_widgets);
1204 dev_err(component->dev,
1205 "Failed to create new controls %d\n", ret);
1209 for_each_component_dais(component, dai) {
1210 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1212 dev_err(component->dev,
1213 "Failed to create DAI widgets %d\n", ret);
1218 ret = snd_soc_component_probe(component);
1220 dev_err(component->dev,
1221 "ASoC: failed to probe component %d\n", ret);
1224 WARN(dapm->idle_bias_off &&
1225 dapm->bias_level != SND_SOC_BIAS_OFF,
1226 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1231 * machine specific init
1233 * snd_soc_component_set_aux()
1235 ret = snd_soc_component_init(component);
1239 ret = snd_soc_add_component_controls(component,
1240 component->driver->controls,
1241 component->driver->num_controls);
1245 ret = snd_soc_dapm_add_routes(dapm,
1246 component->driver->dapm_routes,
1247 component->driver->num_dapm_routes);
1249 if (card->disable_route_checks) {
1251 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1255 "%s: snd_soc_dapm_add_routes failed: %d\n",
1261 /* see for_each_card_components */
1262 list_add(&component->card_list, &card->component_dev_list);
1266 soc_remove_component(component, probed);
1271 static void soc_remove_link_dais(struct snd_soc_card *card)
1273 struct snd_soc_pcm_runtime *rtd;
1276 for_each_comp_order(order) {
1277 for_each_card_rtds(card, rtd) {
1278 /* remove all rtd connected DAIs in good order */
1279 snd_soc_pcm_dai_remove(rtd, order);
1284 static int soc_probe_link_dais(struct snd_soc_card *card)
1286 struct snd_soc_pcm_runtime *rtd;
1289 for_each_comp_order(order) {
1290 for_each_card_rtds(card, rtd) {
1293 "ASoC: probe %s dai link %d late %d\n",
1294 card->name, rtd->num, order);
1296 /* probe all rtd connected DAIs in good order */
1297 ret = snd_soc_pcm_dai_probe(rtd, order);
1306 static void soc_remove_link_components(struct snd_soc_card *card)
1308 struct snd_soc_component *component;
1309 struct snd_soc_pcm_runtime *rtd;
1312 for_each_comp_order(order) {
1313 for_each_card_rtds(card, rtd) {
1314 for_each_rtd_components(rtd, i, component) {
1315 if (component->driver->remove_order != order)
1318 soc_remove_component(component, 1);
1324 static int soc_probe_link_components(struct snd_soc_card *card)
1326 struct snd_soc_component *component;
1327 struct snd_soc_pcm_runtime *rtd;
1330 for_each_comp_order(order) {
1331 for_each_card_rtds(card, rtd) {
1332 for_each_rtd_components(rtd, i, component) {
1333 if (component->driver->probe_order != order)
1336 ret = soc_probe_component(card, component);
1346 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1348 struct snd_soc_component *component, *_component;
1350 for_each_card_auxs_safe(card, component, _component) {
1351 /* for snd_soc_component_init() */
1352 snd_soc_component_set_aux(component, NULL);
1353 list_del(&component->card_aux_list);
1357 static int soc_bind_aux_dev(struct snd_soc_card *card)
1359 struct snd_soc_component *component;
1360 struct snd_soc_aux_dev *aux;
1363 for_each_card_pre_auxs(card, i, aux) {
1364 /* codecs, usually analog devices */
1365 component = soc_find_component(&aux->dlc);
1367 return -EPROBE_DEFER;
1369 /* for snd_soc_component_init() */
1370 snd_soc_component_set_aux(component, aux);
1371 /* see for_each_card_auxs */
1372 list_add(&component->card_aux_list, &card->aux_comp_list);
1377 static int soc_probe_aux_devices(struct snd_soc_card *card)
1379 struct snd_soc_component *component;
1383 for_each_comp_order(order) {
1384 for_each_card_auxs(card, component) {
1385 if (component->driver->probe_order != order)
1388 ret = soc_probe_component(card, component);
1397 static void soc_remove_aux_devices(struct snd_soc_card *card)
1399 struct snd_soc_component *comp, *_comp;
1402 for_each_comp_order(order) {
1403 for_each_card_auxs_safe(card, comp, _comp) {
1404 if (comp->driver->remove_order == order)
1405 soc_remove_component(comp, 1);
1411 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1412 * @rtd: The runtime for which the DAI link format should be changed
1413 * @dai_fmt: The new DAI link format
1415 * This function updates the DAI link format for all DAIs connected to the DAI
1416 * link for the specified runtime.
1418 * Note: For setups with a static format set the dai_fmt field in the
1419 * corresponding snd_dai_link struct instead of using this function.
1421 * Returns 0 on success, otherwise a negative error code.
1423 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1424 unsigned int dai_fmt)
1426 struct snd_soc_dai *cpu_dai;
1427 struct snd_soc_dai *codec_dai;
1428 unsigned int inv_dai_fmt;
1432 for_each_rtd_codec_dais(rtd, i, codec_dai) {
1433 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1434 if (ret != 0 && ret != -ENOTSUPP) {
1435 dev_warn(codec_dai->dev,
1436 "ASoC: Failed to set DAI format: %d\n", ret);
1442 * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1443 * the component which has non_legacy_dai_naming is Codec
1445 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1446 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1447 case SND_SOC_DAIFMT_CBM_CFM:
1448 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1450 case SND_SOC_DAIFMT_CBM_CFS:
1451 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1453 case SND_SOC_DAIFMT_CBS_CFM:
1454 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1456 case SND_SOC_DAIFMT_CBS_CFS:
1457 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1460 for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1461 unsigned int fmt = dai_fmt;
1463 if (cpu_dai->component->driver->non_legacy_dai_naming)
1466 ret = snd_soc_dai_set_fmt(cpu_dai, fmt);
1467 if (ret != 0 && ret != -ENOTSUPP) {
1468 dev_warn(cpu_dai->dev,
1469 "ASoC: Failed to set DAI format: %d\n", ret);
1476 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1480 * If a DMI filed contain strings in this blacklist (e.g.
1481 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1482 * as invalid and dropped when setting the card long name from DMI info.
1484 static const char * const dmi_blacklist[] = {
1485 "To be filled by OEM",
1488 "Board Manufacturer",
1489 "Board Vendor Name",
1490 "Board Product Name",
1491 NULL, /* terminator */
1495 * Trim special characters, and replace '-' with '_' since '-' is used to
1496 * separate different DMI fields in the card long name. Only number and
1497 * alphabet characters and a few separator characters are kept.
1499 static void cleanup_dmi_name(char *name)
1503 for (i = 0; name[i]; i++) {
1504 if (isalnum(name[i]) || (name[i] == '.')
1505 || (name[i] == '_'))
1506 name[j++] = name[i];
1507 else if (name[i] == '-')
1515 * Check if a DMI field is valid, i.e. not containing any string
1516 * in the black list.
1518 static int is_dmi_valid(const char *field)
1522 while (dmi_blacklist[i]) {
1523 if (strstr(field, dmi_blacklist[i]))
1532 * Append a string to card->dmi_longname with character cleanups.
1534 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1536 char *dst = card->dmi_longname;
1537 size_t dst_len = sizeof(card->dmi_longname);
1541 snprintf(dst + len, dst_len - len, "-%s", str);
1543 len++; /* skip the separator "-" */
1545 cleanup_dmi_name(dst + len);
1549 * snd_soc_set_dmi_name() - Register DMI names to card
1550 * @card: The card to register DMI names
1551 * @flavour: The flavour "differentiator" for the card amongst its peers.
1553 * An Intel machine driver may be used by many different devices but are
1554 * difficult for userspace to differentiate, since machine drivers ususally
1555 * use their own name as the card short name and leave the card long name
1556 * blank. To differentiate such devices and fix bugs due to lack of
1557 * device-specific configurations, this function allows DMI info to be used
1558 * as the sound card long name, in the format of
1559 * "vendor-product-version-board"
1560 * (Character '-' is used to separate different DMI fields here).
1561 * This will help the user space to load the device-specific Use Case Manager
1562 * (UCM) configurations for the card.
1564 * Possible card long names may be:
1565 * DellInc.-XPS139343-01-0310JH
1566 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1567 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1569 * This function also supports flavoring the card longname to provide
1570 * the extra differentiation, like "vendor-product-version-board-flavor".
1572 * We only keep number and alphabet characters and a few separator characters
1573 * in the card long name since UCM in the user space uses the card long names
1574 * as card configuration directory names and AudoConf cannot support special
1575 * charactors like SPACE.
1577 * Returns 0 on success, otherwise a negative error code.
1579 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1581 const char *vendor, *product, *product_version, *board;
1583 if (card->long_name)
1584 return 0; /* long name already set by driver or from DMI */
1586 /* make up dmi long name as: vendor-product-version-board */
1587 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1588 if (!vendor || !is_dmi_valid(vendor)) {
1589 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1593 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1594 cleanup_dmi_name(card->dmi_longname);
1596 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1597 if (product && is_dmi_valid(product)) {
1598 append_dmi_string(card, product);
1601 * some vendors like Lenovo may only put a self-explanatory
1602 * name in the product version field
1604 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1605 if (product_version && is_dmi_valid(product_version))
1606 append_dmi_string(card, product_version);
1609 board = dmi_get_system_info(DMI_BOARD_NAME);
1610 if (board && is_dmi_valid(board)) {
1611 if (!product || strcasecmp(board, product))
1612 append_dmi_string(card, board);
1613 } else if (!product) {
1614 /* fall back to using legacy name */
1615 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1619 /* Add flavour to dmi long name */
1621 append_dmi_string(card, flavour);
1623 /* set the card long name */
1624 card->long_name = card->dmi_longname;
1628 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1629 #endif /* CONFIG_DMI */
1631 static void soc_check_tplg_fes(struct snd_soc_card *card)
1633 struct snd_soc_component *component;
1634 const struct snd_soc_component_driver *comp_drv;
1635 struct snd_soc_dai_link *dai_link;
1638 for_each_component(component) {
1640 /* does this component override BEs ? */
1641 if (!component->driver->ignore_machine)
1644 /* for this machine ? */
1645 if (!strcmp(component->driver->ignore_machine,
1646 card->dev->driver->name))
1648 if (strcmp(component->driver->ignore_machine,
1649 dev_name(card->dev)))
1652 /* machine matches, so override the rtd data */
1653 for_each_card_prelinks(card, i, dai_link) {
1655 /* ignore this FE */
1656 if (dai_link->dynamic) {
1657 dai_link->ignore = true;
1661 dev_dbg(card->dev, "info: override BE DAI link %s\n",
1662 card->dai_link[i].name);
1664 /* override platform component */
1665 if (!dai_link->platforms) {
1666 dev_err(card->dev, "init platform error");
1669 dai_link->platforms->name = component->name;
1671 /* convert non BE into BE */
1672 if (!dai_link->no_pcm) {
1673 dai_link->no_pcm = 1;
1675 if (dai_link->dpcm_playback)
1677 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1679 if (dai_link->dpcm_capture)
1681 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1684 /* convert normal link into DPCM one */
1685 if (!(dai_link->dpcm_playback ||
1686 dai_link->dpcm_capture)) {
1687 dai_link->dpcm_playback = !dai_link->capture_only;
1688 dai_link->dpcm_capture = !dai_link->playback_only;
1693 * override any BE fixups
1695 * snd_soc_link_be_hw_params_fixup()
1697 dai_link->be_hw_params_fixup =
1698 component->driver->be_hw_params_fixup;
1701 * most BE links don't set stream name, so set it to
1702 * dai link name if it's NULL to help bind widgets.
1704 if (!dai_link->stream_name)
1705 dai_link->stream_name = dai_link->name;
1708 /* Inform userspace we are using alternate topology */
1709 if (component->driver->topology_name_prefix) {
1711 /* topology shortname created? */
1712 if (!card->topology_shortname_created) {
1713 comp_drv = component->driver;
1715 snprintf(card->topology_shortname, 32, "%s-%s",
1716 comp_drv->topology_name_prefix,
1718 card->topology_shortname_created = true;
1721 /* use topology shortname */
1722 card->name = card->topology_shortname;
1727 #define soc_setup_card_name(name, name1, name2, norm) \
1728 __soc_setup_card_name(name, sizeof(name), name1, name2, norm)
1729 static void __soc_setup_card_name(char *name, int len,
1730 const char *name1, const char *name2,
1735 snprintf(name, len, "%s", name1 ? name1 : name2);
1741 * Name normalization
1743 * The driver name is somewhat special, as it's used as a key for
1744 * searches in the user-space.
1747 * "abcd??efg" -> "abcd__efg"
1749 for (i = 0; i < len; i++) {
1756 if (!isalnum(name[i]))
1763 static void soc_cleanup_card_resources(struct snd_soc_card *card)
1765 struct snd_soc_pcm_runtime *rtd, *n;
1768 snd_card_disconnect_sync(card->snd_card);
1770 snd_soc_dapm_shutdown(card);
1772 /* remove and free each DAI */
1773 soc_remove_link_dais(card);
1774 soc_remove_link_components(card);
1776 for_each_card_rtds_safe(card, rtd, n)
1777 snd_soc_remove_pcm_runtime(card, rtd);
1779 /* remove auxiliary devices */
1780 soc_remove_aux_devices(card);
1781 soc_unbind_aux_dev(card);
1783 snd_soc_dapm_free(&card->dapm);
1784 soc_cleanup_card_debugfs(card);
1786 /* remove the card */
1787 snd_soc_card_remove(card);
1789 if (card->snd_card) {
1790 snd_card_free(card->snd_card);
1791 card->snd_card = NULL;
1795 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1797 if (card->instantiated) {
1798 card->instantiated = false;
1799 snd_soc_flush_all_delayed_work(card);
1801 soc_cleanup_card_resources(card);
1803 list_add(&card->list, &unbind_card_list);
1806 list_del(&card->list);
1810 static int snd_soc_bind_card(struct snd_soc_card *card)
1812 struct snd_soc_pcm_runtime *rtd;
1813 struct snd_soc_component *component;
1814 struct snd_soc_dai_link *dai_link;
1817 mutex_lock(&client_mutex);
1818 mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1820 snd_soc_dapm_init(&card->dapm, card, NULL);
1822 /* check whether any platform is ignore machine FE and using topology */
1823 soc_check_tplg_fes(card);
1825 /* bind aux_devs too */
1826 ret = soc_bind_aux_dev(card);
1830 /* add predefined DAI links to the list */
1832 for_each_card_prelinks(card, i, dai_link) {
1833 ret = snd_soc_add_pcm_runtime(card, dai_link);
1838 /* card bind complete so register a sound card */
1839 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1840 card->owner, 0, &card->snd_card);
1843 "ASoC: can't create sound card for card %s: %d\n",
1848 soc_init_card_debugfs(card);
1850 soc_resume_init(card);
1852 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1853 card->num_dapm_widgets);
1857 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1858 card->num_of_dapm_widgets);
1862 /* initialise the sound card only once */
1863 ret = snd_soc_card_probe(card);
1867 /* probe all components used by DAI links on this card */
1868 ret = soc_probe_link_components(card);
1871 "ASoC: failed to instantiate card %d\n", ret);
1875 /* probe auxiliary components */
1876 ret = soc_probe_aux_devices(card);
1879 "ASoC: failed to probe aux component %d\n", ret);
1883 /* probe all DAI links on this card */
1884 ret = soc_probe_link_dais(card);
1887 "ASoC: failed to instantiate card %d\n", ret);
1891 for_each_card_rtds(card, rtd) {
1892 ret = soc_init_pcm_runtime(card, rtd);
1897 snd_soc_dapm_link_dai_widgets(card);
1898 snd_soc_dapm_connect_dai_link_widgets(card);
1900 ret = snd_soc_add_card_controls(card, card->controls,
1901 card->num_controls);
1905 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
1906 card->num_dapm_routes);
1908 if (card->disable_route_checks) {
1910 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1914 "%s: snd_soc_dapm_add_routes failed: %d\n",
1920 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
1921 card->num_of_dapm_routes);
1925 /* try to set some sane longname if DMI is available */
1926 snd_soc_set_dmi_name(card, NULL);
1928 soc_setup_card_name(card->snd_card->shortname,
1929 card->name, NULL, 0);
1930 soc_setup_card_name(card->snd_card->longname,
1931 card->long_name, card->name, 0);
1932 soc_setup_card_name(card->snd_card->driver,
1933 card->driver_name, card->name, 1);
1935 if (card->components) {
1936 /* the current implementation of snd_component_add() accepts */
1937 /* multiple components in the string separated by space, */
1938 /* but the string collision (identical string) check might */
1939 /* not work correctly */
1940 ret = snd_component_add(card->snd_card, card->components);
1942 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
1948 ret = snd_soc_card_late_probe(card);
1952 snd_soc_dapm_new_widgets(card);
1954 ret = snd_card_register(card->snd_card);
1956 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
1961 card->instantiated = 1;
1962 dapm_mark_endpoints_dirty(card);
1963 snd_soc_dapm_sync(&card->dapm);
1965 /* deactivate pins to sleep state */
1966 for_each_card_components(card, component)
1967 if (!snd_soc_component_active(component))
1968 pinctrl_pm_select_sleep_state(component->dev);
1972 soc_cleanup_card_resources(card);
1974 mutex_unlock(&card->mutex);
1975 mutex_unlock(&client_mutex);
1980 /* probes a new socdev */
1981 static int soc_probe(struct platform_device *pdev)
1983 struct snd_soc_card *card = platform_get_drvdata(pdev);
1986 * no card, so machine driver should be registering card
1987 * we should not be here in that case so ret error
1992 dev_warn(&pdev->dev,
1993 "ASoC: machine %s should use snd_soc_register_card()\n",
1996 /* Bodge while we unpick instantiation */
1997 card->dev = &pdev->dev;
1999 return snd_soc_register_card(card);
2002 /* removes a socdev */
2003 static int soc_remove(struct platform_device *pdev)
2005 struct snd_soc_card *card = platform_get_drvdata(pdev);
2007 snd_soc_unregister_card(card);
2011 int snd_soc_poweroff(struct device *dev)
2013 struct snd_soc_card *card = dev_get_drvdata(dev);
2014 struct snd_soc_component *component;
2016 if (!card->instantiated)
2020 * Flush out pmdown_time work - we actually do want to run it
2021 * now, we're shutting down so no imminent restart.
2023 snd_soc_flush_all_delayed_work(card);
2025 snd_soc_dapm_shutdown(card);
2027 /* deactivate pins to sleep state */
2028 for_each_card_components(card, component)
2029 pinctrl_pm_select_sleep_state(component->dev);
2033 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2035 const struct dev_pm_ops snd_soc_pm_ops = {
2036 .suspend = snd_soc_suspend,
2037 .resume = snd_soc_resume,
2038 .freeze = snd_soc_suspend,
2039 .thaw = snd_soc_resume,
2040 .poweroff = snd_soc_poweroff,
2041 .restore = snd_soc_resume,
2043 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2045 /* ASoC platform driver */
2046 static struct platform_driver soc_driver = {
2048 .name = "soc-audio",
2049 .pm = &snd_soc_pm_ops,
2052 .remove = soc_remove,
2056 * snd_soc_cnew - create new control
2057 * @_template: control template
2058 * @data: control private data
2059 * @long_name: control long name
2060 * @prefix: control name prefix
2062 * Create a new mixer control from a template control.
2064 * Returns 0 for success, else error.
2066 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2067 void *data, const char *long_name,
2070 struct snd_kcontrol_new template;
2071 struct snd_kcontrol *kcontrol;
2074 memcpy(&template, _template, sizeof(template));
2078 long_name = template.name;
2081 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2085 template.name = name;
2087 template.name = long_name;
2090 kcontrol = snd_ctl_new1(&template, data);
2096 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2098 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2099 const struct snd_kcontrol_new *controls, int num_controls,
2100 const char *prefix, void *data)
2104 for (i = 0; i < num_controls; i++) {
2105 const struct snd_kcontrol_new *control = &controls[i];
2107 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2108 control->name, prefix));
2110 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2111 control->name, err);
2120 * snd_soc_add_component_controls - Add an array of controls to a component.
2122 * @component: Component to add controls to
2123 * @controls: Array of controls to add
2124 * @num_controls: Number of elements in the array
2126 * Return: 0 for success, else error.
2128 int snd_soc_add_component_controls(struct snd_soc_component *component,
2129 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2131 struct snd_card *card = component->card->snd_card;
2133 return snd_soc_add_controls(card, component->dev, controls,
2134 num_controls, component->name_prefix, component);
2136 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2139 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2140 * Convenience function to add a list of controls.
2142 * @soc_card: SoC card to add controls to
2143 * @controls: array of controls to add
2144 * @num_controls: number of elements in the array
2146 * Return 0 for success, else error.
2148 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2149 const struct snd_kcontrol_new *controls, int num_controls)
2151 struct snd_card *card = soc_card->snd_card;
2153 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2156 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2159 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2160 * Convienience function to add a list of controls.
2162 * @dai: DAI to add controls to
2163 * @controls: array of controls to add
2164 * @num_controls: number of elements in the array
2166 * Return 0 for success, else error.
2168 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2169 const struct snd_kcontrol_new *controls, int num_controls)
2171 struct snd_card *card = dai->component->card->snd_card;
2173 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2176 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2179 * snd_soc_register_card - Register a card with the ASoC core
2181 * @card: Card to register
2184 int snd_soc_register_card(struct snd_soc_card *card)
2186 if (!card->name || !card->dev)
2189 dev_set_drvdata(card->dev, card);
2191 INIT_LIST_HEAD(&card->widgets);
2192 INIT_LIST_HEAD(&card->paths);
2193 INIT_LIST_HEAD(&card->dapm_list);
2194 INIT_LIST_HEAD(&card->aux_comp_list);
2195 INIT_LIST_HEAD(&card->component_dev_list);
2196 INIT_LIST_HEAD(&card->list);
2197 INIT_LIST_HEAD(&card->rtd_list);
2198 INIT_LIST_HEAD(&card->dapm_dirty);
2199 INIT_LIST_HEAD(&card->dobj_list);
2201 card->instantiated = 0;
2202 mutex_init(&card->mutex);
2203 mutex_init(&card->dapm_mutex);
2204 mutex_init(&card->pcm_mutex);
2205 spin_lock_init(&card->dpcm_lock);
2207 return snd_soc_bind_card(card);
2209 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2212 * snd_soc_unregister_card - Unregister a card with the ASoC core
2214 * @card: Card to unregister
2217 int snd_soc_unregister_card(struct snd_soc_card *card)
2219 mutex_lock(&client_mutex);
2220 snd_soc_unbind_card(card, true);
2221 mutex_unlock(&client_mutex);
2222 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2226 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2229 * Simplify DAI link configuration by removing ".-1" from device names
2230 * and sanitizing names.
2232 static char *fmt_single_name(struct device *dev, int *id)
2234 char *found, name[NAME_SIZE];
2237 if (dev_name(dev) == NULL)
2240 strlcpy(name, dev_name(dev), NAME_SIZE);
2242 /* are we a "%s.%d" name (platform and SPI components) */
2243 found = strstr(name, dev->driver->name);
2246 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2248 /* discard ID from name if ID == -1 */
2250 found[strlen(dev->driver->name)] = '\0';
2254 /* I2C component devices are named "bus-addr" */
2255 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2256 char tmp[NAME_SIZE];
2258 /* create unique ID number from I2C addr and bus */
2259 *id = ((id1 & 0xffff) << 16) + id2;
2261 /* sanitize component name for DAI link creation */
2262 snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2264 strlcpy(name, tmp, NAME_SIZE);
2269 return devm_kstrdup(dev, name, GFP_KERNEL);
2273 * Simplify DAI link naming for single devices with multiple DAIs by removing
2274 * any ".-1" and using the DAI name (instead of device name).
2276 static inline char *fmt_multiple_name(struct device *dev,
2277 struct snd_soc_dai_driver *dai_drv)
2279 if (dai_drv->name == NULL) {
2281 "ASoC: error - multiple DAI %s registered with no name\n",
2286 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2289 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2291 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2292 list_del(&dai->list);
2294 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2297 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2299 * @component: The component the DAIs are registered for
2300 * @dai_drv: DAI driver to use for the DAI
2301 * @legacy_dai_naming: if %true, use legacy single-name format;
2302 * if %false, use multiple-name format;
2304 * Topology can use this API to register DAIs when probing a component.
2305 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2306 * will be freed in the component cleanup.
2308 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2309 struct snd_soc_dai_driver *dai_drv,
2310 bool legacy_dai_naming)
2312 struct device *dev = component->dev;
2313 struct snd_soc_dai *dai;
2315 dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2317 lockdep_assert_held(&client_mutex);
2319 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2324 * Back in the old days when we still had component-less DAIs,
2325 * instead of having a static name, component-less DAIs would
2326 * inherit the name of the parent device so it is possible to
2327 * register multiple instances of the DAI. We still need to keep
2328 * the same naming style even though those DAIs are not
2329 * component-less anymore.
2331 if (legacy_dai_naming &&
2332 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2333 dai->name = fmt_single_name(dev, &dai->id);
2335 dai->name = fmt_multiple_name(dev, dai_drv);
2337 dai->id = dai_drv->id;
2339 dai->id = component->num_dai;
2344 dai->component = component;
2346 dai->driver = dai_drv;
2348 /* see for_each_component_dais */
2349 list_add_tail(&dai->list, &component->dai_list);
2350 component->num_dai++;
2352 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2357 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2359 * @component: The component for which the DAIs should be unregistered
2361 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2363 struct snd_soc_dai *dai, *_dai;
2365 for_each_component_dais_safe(component, dai, _dai)
2366 snd_soc_unregister_dai(dai);
2370 * snd_soc_register_dais - Register a DAI with the ASoC core
2372 * @component: The component the DAIs are registered for
2373 * @dai_drv: DAI driver to use for the DAIs
2374 * @count: Number of DAIs
2376 static int snd_soc_register_dais(struct snd_soc_component *component,
2377 struct snd_soc_dai_driver *dai_drv,
2380 struct snd_soc_dai *dai;
2384 for (i = 0; i < count; i++) {
2385 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2386 !component->driver->non_legacy_dai_naming);
2396 snd_soc_unregister_dais(component);
2401 #define ENDIANNESS_MAP(name) \
2402 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2403 static u64 endianness_format_map[] = {
2404 ENDIANNESS_MAP(S16_),
2405 ENDIANNESS_MAP(U16_),
2406 ENDIANNESS_MAP(S24_),
2407 ENDIANNESS_MAP(U24_),
2408 ENDIANNESS_MAP(S32_),
2409 ENDIANNESS_MAP(U32_),
2410 ENDIANNESS_MAP(S24_3),
2411 ENDIANNESS_MAP(U24_3),
2412 ENDIANNESS_MAP(S20_3),
2413 ENDIANNESS_MAP(U20_3),
2414 ENDIANNESS_MAP(S18_3),
2415 ENDIANNESS_MAP(U18_3),
2416 ENDIANNESS_MAP(FLOAT_),
2417 ENDIANNESS_MAP(FLOAT64_),
2418 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2422 * Fix up the DAI formats for endianness: codecs don't actually see
2423 * the endianness of the data but we're using the CPU format
2424 * definitions which do need to include endianness so we ensure that
2425 * codec DAIs always have both big and little endian variants set.
2427 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2431 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2432 if (stream->formats & endianness_format_map[i])
2433 stream->formats |= endianness_format_map[i];
2436 static void snd_soc_try_rebind_card(void)
2438 struct snd_soc_card *card, *c;
2440 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2441 if (!snd_soc_bind_card(card))
2442 list_del(&card->list);
2445 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2447 struct snd_soc_card *card = component->card;
2449 snd_soc_unregister_dais(component);
2452 snd_soc_unbind_card(card, false);
2454 list_del(&component->list);
2457 int snd_soc_component_initialize(struct snd_soc_component *component,
2458 const struct snd_soc_component_driver *driver,
2461 INIT_LIST_HEAD(&component->dai_list);
2462 INIT_LIST_HEAD(&component->dobj_list);
2463 INIT_LIST_HEAD(&component->card_list);
2464 mutex_init(&component->io_mutex);
2466 component->name = fmt_single_name(dev, &component->id);
2467 if (!component->name) {
2468 dev_err(dev, "ASoC: Failed to allocate name\n");
2472 component->dev = dev;
2473 component->driver = driver;
2477 EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2479 int snd_soc_add_component(struct snd_soc_component *component,
2480 struct snd_soc_dai_driver *dai_drv,
2486 mutex_lock(&client_mutex);
2488 if (component->driver->endianness) {
2489 for (i = 0; i < num_dai; i++) {
2490 convert_endianness_formats(&dai_drv[i].playback);
2491 convert_endianness_formats(&dai_drv[i].capture);
2495 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2497 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2502 if (!component->driver->write && !component->driver->read) {
2503 if (!component->regmap)
2504 component->regmap = dev_get_regmap(component->dev,
2506 if (component->regmap)
2507 snd_soc_component_setup_regmap(component);
2510 /* see for_each_component */
2511 list_add(&component->list, &component_list);
2515 snd_soc_del_component_unlocked(component);
2517 mutex_unlock(&client_mutex);
2520 snd_soc_try_rebind_card();
2524 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2526 int snd_soc_register_component(struct device *dev,
2527 const struct snd_soc_component_driver *component_driver,
2528 struct snd_soc_dai_driver *dai_drv,
2531 struct snd_soc_component *component;
2534 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2538 ret = snd_soc_component_initialize(component, component_driver, dev);
2542 return snd_soc_add_component(component, dai_drv, num_dai);
2544 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2547 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2548 * from the ASoC core
2550 * @dev: The device to unregister
2551 * @component_driver: The component driver to unregister
2553 void snd_soc_unregister_component_by_driver(struct device *dev,
2554 const struct snd_soc_component_driver *component_driver)
2556 struct snd_soc_component *component;
2558 if (!component_driver)
2561 mutex_lock(&client_mutex);
2562 component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2566 snd_soc_del_component_unlocked(component);
2569 mutex_unlock(&client_mutex);
2571 EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2574 * snd_soc_unregister_component - Unregister all related component
2575 * from the ASoC core
2577 * @dev: The device to unregister
2579 void snd_soc_unregister_component(struct device *dev)
2581 struct snd_soc_component *component;
2583 mutex_lock(&client_mutex);
2585 component = snd_soc_lookup_component_nolocked(dev, NULL);
2589 snd_soc_del_component_unlocked(component);
2591 mutex_unlock(&client_mutex);
2593 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2595 /* Retrieve a card's name from device tree */
2596 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2597 const char *propname)
2599 struct device_node *np;
2603 pr_err("card->dev is not set before calling %s\n", __func__);
2607 np = card->dev->of_node;
2609 ret = of_property_read_string_index(np, propname, 0, &card->name);
2611 * EINVAL means the property does not exist. This is fine providing
2612 * card->name was previously set, which is checked later in
2613 * snd_soc_register_card.
2615 if (ret < 0 && ret != -EINVAL) {
2617 "ASoC: Property '%s' could not be read: %d\n",
2624 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2626 static const struct snd_soc_dapm_widget simple_widgets[] = {
2627 SND_SOC_DAPM_MIC("Microphone", NULL),
2628 SND_SOC_DAPM_LINE("Line", NULL),
2629 SND_SOC_DAPM_HP("Headphone", NULL),
2630 SND_SOC_DAPM_SPK("Speaker", NULL),
2633 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2634 const char *propname)
2636 struct device_node *np = card->dev->of_node;
2637 struct snd_soc_dapm_widget *widgets;
2638 const char *template, *wname;
2639 int i, j, num_widgets, ret;
2641 num_widgets = of_property_count_strings(np, propname);
2642 if (num_widgets < 0) {
2644 "ASoC: Property '%s' does not exist\n", propname);
2647 if (num_widgets & 1) {
2649 "ASoC: Property '%s' length is not even\n", propname);
2655 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2660 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2664 "ASoC: Could not allocate memory for widgets\n");
2668 for (i = 0; i < num_widgets; i++) {
2669 ret = of_property_read_string_index(np, propname,
2673 "ASoC: Property '%s' index %d read error:%d\n",
2674 propname, 2 * i, ret);
2678 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2679 if (!strncmp(template, simple_widgets[j].name,
2680 strlen(simple_widgets[j].name))) {
2681 widgets[i] = simple_widgets[j];
2686 if (j >= ARRAY_SIZE(simple_widgets)) {
2688 "ASoC: DAPM widget '%s' is not supported\n",
2693 ret = of_property_read_string_index(np, propname,
2698 "ASoC: Property '%s' index %d read error:%d\n",
2699 propname, (2 * i) + 1, ret);
2703 widgets[i].name = wname;
2706 card->of_dapm_widgets = widgets;
2707 card->num_of_dapm_widgets = num_widgets;
2711 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2713 int snd_soc_of_get_slot_mask(struct device_node *np,
2714 const char *prop_name,
2718 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2724 for (i = 0; i < val; i++)
2725 if (be32_to_cpup(&of_slot_mask[i]))
2730 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2732 int snd_soc_of_parse_tdm_slot(struct device_node *np,
2733 unsigned int *tx_mask,
2734 unsigned int *rx_mask,
2735 unsigned int *slots,
2736 unsigned int *slot_width)
2742 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2744 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2746 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2747 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2755 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2756 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2766 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2768 void snd_soc_of_parse_node_prefix(struct device_node *np,
2769 struct snd_soc_codec_conf *codec_conf,
2770 struct device_node *of_node,
2771 const char *propname)
2776 ret = of_property_read_string(np, propname, &str);
2778 /* no prefix is not error */
2782 codec_conf->dlc.of_node = of_node;
2783 codec_conf->name_prefix = str;
2785 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2787 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2788 const char *propname)
2790 struct device_node *np = card->dev->of_node;
2792 struct snd_soc_dapm_route *routes;
2795 num_routes = of_property_count_strings(np, propname);
2796 if (num_routes < 0 || num_routes & 1) {
2798 "ASoC: Property '%s' does not exist or its length is not even\n",
2804 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2809 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2813 "ASoC: Could not allocate DAPM route table\n");
2817 for (i = 0; i < num_routes; i++) {
2818 ret = of_property_read_string_index(np, propname,
2819 2 * i, &routes[i].sink);
2822 "ASoC: Property '%s' index %d could not be read: %d\n",
2823 propname, 2 * i, ret);
2826 ret = of_property_read_string_index(np, propname,
2827 (2 * i) + 1, &routes[i].source);
2830 "ASoC: Property '%s' index %d could not be read: %d\n",
2831 propname, (2 * i) + 1, ret);
2836 card->num_of_dapm_routes = num_routes;
2837 card->of_dapm_routes = routes;
2841 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
2843 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
2845 struct device_node **bitclkmaster,
2846 struct device_node **framemaster)
2850 unsigned int format = 0;
2856 } of_fmt_table[] = {
2857 { "i2s", SND_SOC_DAIFMT_I2S },
2858 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
2859 { "left_j", SND_SOC_DAIFMT_LEFT_J },
2860 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
2861 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
2862 { "ac97", SND_SOC_DAIFMT_AC97 },
2863 { "pdm", SND_SOC_DAIFMT_PDM},
2864 { "msb", SND_SOC_DAIFMT_MSB },
2865 { "lsb", SND_SOC_DAIFMT_LSB },
2872 * check "dai-format = xxx"
2873 * or "[prefix]format = xxx"
2874 * SND_SOC_DAIFMT_FORMAT_MASK area
2876 ret = of_property_read_string(np, "dai-format", &str);
2878 snprintf(prop, sizeof(prop), "%sformat", prefix);
2879 ret = of_property_read_string(np, prop, &str);
2882 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
2883 if (strcmp(str, of_fmt_table[i].name) == 0) {
2884 format |= of_fmt_table[i].val;
2891 * check "[prefix]continuous-clock"
2892 * SND_SOC_DAIFMT_CLOCK_MASK area
2894 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
2895 if (of_property_read_bool(np, prop))
2896 format |= SND_SOC_DAIFMT_CONT;
2898 format |= SND_SOC_DAIFMT_GATED;
2901 * check "[prefix]bitclock-inversion"
2902 * check "[prefix]frame-inversion"
2903 * SND_SOC_DAIFMT_INV_MASK area
2905 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
2906 bit = !!of_get_property(np, prop, NULL);
2908 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
2909 frame = !!of_get_property(np, prop, NULL);
2911 switch ((bit << 4) + frame) {
2913 format |= SND_SOC_DAIFMT_IB_IF;
2916 format |= SND_SOC_DAIFMT_IB_NF;
2919 format |= SND_SOC_DAIFMT_NB_IF;
2922 /* SND_SOC_DAIFMT_NB_NF is default */
2927 * check "[prefix]bitclock-master"
2928 * check "[prefix]frame-master"
2929 * SND_SOC_DAIFMT_MASTER_MASK area
2931 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
2932 bit = !!of_get_property(np, prop, NULL);
2933 if (bit && bitclkmaster)
2934 *bitclkmaster = of_parse_phandle(np, prop, 0);
2936 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
2937 frame = !!of_get_property(np, prop, NULL);
2938 if (frame && framemaster)
2939 *framemaster = of_parse_phandle(np, prop, 0);
2941 switch ((bit << 4) + frame) {
2943 format |= SND_SOC_DAIFMT_CBM_CFM;
2946 format |= SND_SOC_DAIFMT_CBM_CFS;
2949 format |= SND_SOC_DAIFMT_CBS_CFM;
2952 format |= SND_SOC_DAIFMT_CBS_CFS;
2958 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
2960 int snd_soc_get_dai_id(struct device_node *ep)
2962 struct snd_soc_component *component;
2963 struct snd_soc_dai_link_component dlc;
2966 dlc.of_node = of_graph_get_port_parent(ep);
2969 * For example HDMI case, HDMI has video/sound port,
2970 * but ALSA SoC needs sound port number only.
2971 * Thus counting HDMI DT port/endpoint doesn't work.
2972 * Then, it should have .of_xlate_dai_id
2975 mutex_lock(&client_mutex);
2976 component = soc_find_component(&dlc);
2978 ret = snd_soc_component_of_xlate_dai_id(component, ep);
2979 mutex_unlock(&client_mutex);
2981 of_node_put(dlc.of_node);
2985 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
2987 int snd_soc_get_dai_name(struct of_phandle_args *args,
2988 const char **dai_name)
2990 struct snd_soc_component *pos;
2991 struct device_node *component_of_node;
2992 int ret = -EPROBE_DEFER;
2994 mutex_lock(&client_mutex);
2995 for_each_component(pos) {
2996 component_of_node = soc_component_to_node(pos);
2998 if (component_of_node != args->np)
3001 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3002 if (ret == -ENOTSUPP) {
3003 struct snd_soc_dai *dai;
3006 switch (args->args_count) {
3008 id = 0; /* same as dai_drv[0] */
3018 if (id < 0 || id >= pos->num_dai) {
3025 /* find target DAI */
3026 for_each_component_dais(pos, dai) {
3032 *dai_name = dai->driver->name;
3034 *dai_name = pos->name;
3037 * if another error than ENOTSUPP is returned go on and
3038 * check if another component is provided with the same
3039 * node. This may happen if a device provides several
3047 mutex_unlock(&client_mutex);
3050 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3052 int snd_soc_of_get_dai_name(struct device_node *of_node,
3053 const char **dai_name)
3055 struct of_phandle_args args;
3058 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3059 "#sound-dai-cells", 0, &args);
3063 ret = snd_soc_get_dai_name(&args, dai_name);
3065 of_node_put(args.np);
3069 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3072 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3073 * @dai_link: DAI link
3075 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3077 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3079 struct snd_soc_dai_link_component *component;
3082 for_each_link_codecs(dai_link, index, component) {
3083 if (!component->of_node)
3085 of_node_put(component->of_node);
3086 component->of_node = NULL;
3089 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3092 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3094 * @of_node: Device node
3095 * @dai_link: DAI link
3097 * Builds an array of CODEC DAI components from the DAI link property
3099 * The array is set in the DAI link and the number of DAIs is set accordingly.
3100 * The device nodes in the array (of_node) must be dereferenced by calling
3101 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3103 * Returns 0 for success
3105 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3106 struct device_node *of_node,
3107 struct snd_soc_dai_link *dai_link)
3109 struct of_phandle_args args;
3110 struct snd_soc_dai_link_component *component;
3112 int index, num_codecs, ret;
3114 /* Count the number of CODECs */
3116 num_codecs = of_count_phandle_with_args(of_node, name,
3117 "#sound-dai-cells");
3118 if (num_codecs <= 0) {
3119 if (num_codecs == -ENOENT)
3120 dev_err(dev, "No 'sound-dai' property\n");
3122 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3125 component = devm_kcalloc(dev,
3126 num_codecs, sizeof(*component),
3130 dai_link->codecs = component;
3131 dai_link->num_codecs = num_codecs;
3133 /* Parse the list */
3134 for_each_link_codecs(dai_link, index, component) {
3135 ret = of_parse_phandle_with_args(of_node, name,
3140 component->of_node = args.np;
3141 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3147 snd_soc_of_put_dai_link_codecs(dai_link);
3148 dai_link->codecs = NULL;
3149 dai_link->num_codecs = 0;
3152 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3154 static int __init snd_soc_init(void)
3156 snd_soc_debugfs_init();
3157 snd_soc_util_init();
3159 return platform_driver_register(&soc_driver);
3161 module_init(snd_soc_init);
3163 static void __exit snd_soc_exit(void)
3165 snd_soc_util_exit();
3166 snd_soc_debugfs_exit();
3168 platform_driver_unregister(&soc_driver);
3170 module_exit(snd_soc_exit);
3172 /* Module information */
3173 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3174 MODULE_DESCRIPTION("ALSA SoC Core");
3175 MODULE_LICENSE("GPL");
3176 MODULE_ALIAS("platform:soc-audio");