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.
11 // with code, comments and ideas from :-
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 static int soc_dai_link_sanity_check(struct snd_soc_card *card,
838 struct snd_soc_dai_link *link)
841 struct snd_soc_dai_link_component *cpu, *codec, *platform;
843 for_each_link_codecs(link, i, codec) {
845 * Codec must be specified by 1 of name or OF node,
846 * not both or neither.
848 if (!!codec->name == !!codec->of_node) {
849 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
854 /* Codec DAI name must be specified */
855 if (!codec->dai_name) {
856 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
862 * Defer card registration if codec component is not added to
865 if (!soc_find_component(codec)) {
867 "ASoC: codec component %s not found for link %s\n",
868 codec->name, link->name);
869 return -EPROBE_DEFER;
873 for_each_link_platforms(link, i, platform) {
875 * Platform may be specified by either name or OF node, but it
876 * can be left unspecified, then no components will be inserted
879 if (!!platform->name == !!platform->of_node) {
881 "ASoC: Neither/both platform name/of_node are set for %s\n",
887 * Defer card registration if platform component is not added to
890 if (!soc_find_component(platform)) {
892 "ASoC: platform component %s not found for link %s\n",
893 platform->name, link->name);
894 return -EPROBE_DEFER;
898 for_each_link_cpus(link, i, cpu) {
900 * CPU device may be specified by either name or OF node, but
901 * can be left unspecified, and will be matched based on DAI
904 if (cpu->name && cpu->of_node) {
906 "ASoC: Neither/both cpu name/of_node are set for %s\n",
912 * Defer card registration if cpu dai component is not added to
915 if ((cpu->of_node || cpu->name) &&
916 !soc_find_component(cpu)) {
918 "ASoC: cpu component %s not found for link %s\n",
919 cpu->name, link->name);
920 return -EPROBE_DEFER;
924 * At least one of CPU DAI name or CPU device name/node must be
927 if (!cpu->dai_name &&
928 !(cpu->name || cpu->of_node)) {
930 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
940 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
941 * @card: The ASoC card to which the pcm_runtime has
942 * @rtd: The pcm_runtime to remove
944 * This function removes a pcm_runtime from the ASoC card.
946 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
947 struct snd_soc_pcm_runtime *rtd)
949 lockdep_assert_held(&client_mutex);
951 /* release machine specific resources */
952 snd_soc_link_exit(rtd);
955 * Notify the machine driver for extra destruction
957 snd_soc_card_remove_dai_link(card, rtd->dai_link);
959 soc_free_pcm_runtime(rtd);
961 EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
964 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
965 * @card: The ASoC card to which the pcm_runtime is added
966 * @dai_link: The DAI link to find pcm_runtime
968 * This function adds a pcm_runtime ASoC card by using dai_link.
970 * Note: Topology can use this API to add pcm_runtime when probing the
971 * topology component. And machine drivers can still define static
972 * DAI links in dai_link array.
974 int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
975 struct snd_soc_dai_link *dai_link)
977 struct snd_soc_pcm_runtime *rtd;
978 struct snd_soc_dai_link_component *codec, *platform, *cpu;
979 struct snd_soc_component *component;
982 lockdep_assert_held(&client_mutex);
985 * Notify the machine driver for extra initialization
987 ret = snd_soc_card_add_dai_link(card, dai_link);
991 if (dai_link->ignore)
994 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
996 ret = soc_dai_link_sanity_check(card, dai_link);
1000 rtd = soc_new_pcm_runtime(card, dai_link);
1004 for_each_link_cpus(dai_link, i, cpu) {
1005 asoc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
1006 if (!asoc_rtd_to_cpu(rtd, i)) {
1007 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1011 snd_soc_rtd_add_component(rtd, asoc_rtd_to_cpu(rtd, i)->component);
1014 /* Find CODEC from registered CODECs */
1015 for_each_link_codecs(dai_link, i, codec) {
1016 asoc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1017 if (!asoc_rtd_to_codec(rtd, i)) {
1018 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1023 snd_soc_rtd_add_component(rtd, asoc_rtd_to_codec(rtd, i)->component);
1026 /* Find PLATFORM from registered PLATFORMs */
1027 for_each_link_platforms(dai_link, i, platform) {
1028 for_each_component(component) {
1029 if (!snd_soc_is_matching_component(platform, component))
1032 snd_soc_rtd_add_component(rtd, component);
1039 snd_soc_remove_pcm_runtime(card, rtd);
1040 return -EPROBE_DEFER;
1042 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtime);
1044 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1045 struct snd_soc_pcm_runtime *rtd)
1047 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1048 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
1049 struct snd_soc_component *component;
1052 /* set default power off timeout */
1053 rtd->pmdown_time = pmdown_time;
1055 /* do machine specific initialization */
1056 ret = snd_soc_link_init(rtd);
1060 if (dai_link->dai_fmt) {
1061 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1066 /* add DPCM sysfs entries */
1067 soc_dpcm_debugfs_add(rtd);
1072 * most drivers will register their PCMs using DAI link ordering but
1073 * topology based drivers can use the DAI link id field to set PCM
1074 * device number and then use rtd + a base offset of the BEs.
1076 for_each_rtd_components(rtd, i, component) {
1077 if (!component->driver->use_dai_pcm_id)
1080 if (rtd->dai_link->no_pcm)
1081 num += component->driver->be_pcm_base;
1083 num = rtd->dai_link->id;
1086 /* create compress_device if possible */
1087 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1088 if (ret != -ENOTSUPP) {
1090 dev_err(card->dev, "ASoC: can't create compress %s\n",
1091 dai_link->stream_name);
1095 /* create the pcm */
1096 ret = soc_new_pcm(rtd, num);
1098 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1099 dai_link->stream_name, ret);
1103 return snd_soc_pcm_dai_new(rtd);
1106 static void soc_set_name_prefix(struct snd_soc_card *card,
1107 struct snd_soc_component *component)
1109 struct device_node *of_node = soc_component_to_node(component);
1113 for (i = 0; i < card->num_configs; i++) {
1114 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1116 if (snd_soc_is_matching_component(&map->dlc, component)) {
1117 component->name_prefix = map->name_prefix;
1123 * If there is no configuration table or no match in the table,
1124 * check if a prefix is provided in the node
1126 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1130 component->name_prefix = str;
1133 static void soc_remove_component(struct snd_soc_component *component,
1137 if (!component->card)
1141 snd_soc_component_remove(component);
1143 /* For framework level robustness */
1144 snd_soc_component_set_jack(component, NULL, NULL);
1146 list_del_init(&component->card_list);
1147 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1148 soc_cleanup_component_debugfs(component);
1149 component->card = NULL;
1150 snd_soc_component_module_put_when_remove(component);
1153 static int soc_probe_component(struct snd_soc_card *card,
1154 struct snd_soc_component *component)
1156 struct snd_soc_dapm_context *dapm =
1157 snd_soc_component_get_dapm(component);
1158 struct snd_soc_dai *dai;
1162 if (!strcmp(component->name, "snd-soc-dummy"))
1165 if (component->card) {
1166 if (component->card != card) {
1167 dev_err(component->dev,
1168 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1169 card->name, component->card->name);
1175 ret = snd_soc_component_module_get_when_probe(component);
1179 component->card = card;
1180 soc_set_name_prefix(card, component);
1182 soc_init_component_debugfs(component);
1184 snd_soc_dapm_init(dapm, card, component);
1186 ret = snd_soc_dapm_new_controls(dapm,
1187 component->driver->dapm_widgets,
1188 component->driver->num_dapm_widgets);
1191 dev_err(component->dev,
1192 "Failed to create new controls %d\n", ret);
1196 for_each_component_dais(component, dai) {
1197 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1199 dev_err(component->dev,
1200 "Failed to create DAI widgets %d\n", ret);
1205 ret = snd_soc_component_probe(component);
1207 dev_err(component->dev,
1208 "ASoC: failed to probe component %d\n", ret);
1211 WARN(dapm->idle_bias_off &&
1212 dapm->bias_level != SND_SOC_BIAS_OFF,
1213 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1218 * machine specific init
1220 * snd_soc_component_set_aux()
1222 ret = snd_soc_component_init(component);
1226 ret = snd_soc_add_component_controls(component,
1227 component->driver->controls,
1228 component->driver->num_controls);
1232 ret = snd_soc_dapm_add_routes(dapm,
1233 component->driver->dapm_routes,
1234 component->driver->num_dapm_routes);
1236 if (card->disable_route_checks) {
1238 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1242 "%s: snd_soc_dapm_add_routes failed: %d\n",
1248 /* see for_each_card_components */
1249 list_add(&component->card_list, &card->component_dev_list);
1253 soc_remove_component(component, probed);
1258 static void soc_remove_link_dais(struct snd_soc_card *card)
1260 struct snd_soc_pcm_runtime *rtd;
1263 for_each_comp_order(order) {
1264 for_each_card_rtds(card, rtd) {
1265 /* remove all rtd connected DAIs in good order */
1266 snd_soc_pcm_dai_remove(rtd, order);
1271 static int soc_probe_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) {
1280 "ASoC: probe %s dai link %d late %d\n",
1281 card->name, rtd->num, order);
1283 /* probe all rtd connected DAIs in good order */
1284 ret = snd_soc_pcm_dai_probe(rtd, order);
1293 static void soc_remove_link_components(struct snd_soc_card *card)
1295 struct snd_soc_component *component;
1296 struct snd_soc_pcm_runtime *rtd;
1299 for_each_comp_order(order) {
1300 for_each_card_rtds(card, rtd) {
1301 for_each_rtd_components(rtd, i, component) {
1302 if (component->driver->remove_order != order)
1305 soc_remove_component(component, 1);
1311 static int soc_probe_link_components(struct snd_soc_card *card)
1313 struct snd_soc_component *component;
1314 struct snd_soc_pcm_runtime *rtd;
1317 for_each_comp_order(order) {
1318 for_each_card_rtds(card, rtd) {
1319 for_each_rtd_components(rtd, i, component) {
1320 if (component->driver->probe_order != order)
1323 ret = soc_probe_component(card, component);
1333 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1335 struct snd_soc_component *component, *_component;
1337 for_each_card_auxs_safe(card, component, _component) {
1338 /* for snd_soc_component_init() */
1339 snd_soc_component_set_aux(component, NULL);
1340 list_del(&component->card_aux_list);
1344 static int soc_bind_aux_dev(struct snd_soc_card *card)
1346 struct snd_soc_component *component;
1347 struct snd_soc_aux_dev *aux;
1350 for_each_card_pre_auxs(card, i, aux) {
1351 /* codecs, usually analog devices */
1352 component = soc_find_component(&aux->dlc);
1354 return -EPROBE_DEFER;
1356 /* for snd_soc_component_init() */
1357 snd_soc_component_set_aux(component, aux);
1358 /* see for_each_card_auxs */
1359 list_add(&component->card_aux_list, &card->aux_comp_list);
1364 static int soc_probe_aux_devices(struct snd_soc_card *card)
1366 struct snd_soc_component *component;
1370 for_each_comp_order(order) {
1371 for_each_card_auxs(card, component) {
1372 if (component->driver->probe_order != order)
1375 ret = soc_probe_component(card, component);
1384 static void soc_remove_aux_devices(struct snd_soc_card *card)
1386 struct snd_soc_component *comp, *_comp;
1389 for_each_comp_order(order) {
1390 for_each_card_auxs_safe(card, comp, _comp) {
1391 if (comp->driver->remove_order == order)
1392 soc_remove_component(comp, 1);
1398 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1399 * @rtd: The runtime for which the DAI link format should be changed
1400 * @dai_fmt: The new DAI link format
1402 * This function updates the DAI link format for all DAIs connected to the DAI
1403 * link for the specified runtime.
1405 * Note: For setups with a static format set the dai_fmt field in the
1406 * corresponding snd_dai_link struct instead of using this function.
1408 * Returns 0 on success, otherwise a negative error code.
1410 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1411 unsigned int dai_fmt)
1413 struct snd_soc_dai *cpu_dai;
1414 struct snd_soc_dai *codec_dai;
1415 unsigned int inv_dai_fmt;
1419 for_each_rtd_codec_dais(rtd, i, codec_dai) {
1420 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1421 if (ret != 0 && ret != -ENOTSUPP) {
1422 dev_warn(codec_dai->dev,
1423 "ASoC: Failed to set DAI format: %d\n", ret);
1429 * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1430 * the component which has non_legacy_dai_naming is Codec
1432 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1433 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1434 case SND_SOC_DAIFMT_CBM_CFM:
1435 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1437 case SND_SOC_DAIFMT_CBM_CFS:
1438 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1440 case SND_SOC_DAIFMT_CBS_CFM:
1441 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1443 case SND_SOC_DAIFMT_CBS_CFS:
1444 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1447 for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1448 unsigned int fmt = dai_fmt;
1450 if (cpu_dai->component->driver->non_legacy_dai_naming)
1453 ret = snd_soc_dai_set_fmt(cpu_dai, fmt);
1454 if (ret != 0 && ret != -ENOTSUPP) {
1455 dev_warn(cpu_dai->dev,
1456 "ASoC: Failed to set DAI format: %d\n", ret);
1463 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1467 * If a DMI filed contain strings in this blacklist (e.g.
1468 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1469 * as invalid and dropped when setting the card long name from DMI info.
1471 static const char * const dmi_blacklist[] = {
1472 "To be filled by OEM",
1475 "Board Manufacturer",
1476 "Board Vendor Name",
1477 "Board Product Name",
1478 NULL, /* terminator */
1482 * Trim special characters, and replace '-' with '_' since '-' is used to
1483 * separate different DMI fields in the card long name. Only number and
1484 * alphabet characters and a few separator characters are kept.
1486 static void cleanup_dmi_name(char *name)
1490 for (i = 0; name[i]; i++) {
1491 if (isalnum(name[i]) || (name[i] == '.')
1492 || (name[i] == '_'))
1493 name[j++] = name[i];
1494 else if (name[i] == '-')
1502 * Check if a DMI field is valid, i.e. not containing any string
1503 * in the black list.
1505 static int is_dmi_valid(const char *field)
1509 while (dmi_blacklist[i]) {
1510 if (strstr(field, dmi_blacklist[i]))
1519 * Append a string to card->dmi_longname with character cleanups.
1521 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1523 char *dst = card->dmi_longname;
1524 size_t dst_len = sizeof(card->dmi_longname);
1528 snprintf(dst + len, dst_len - len, "-%s", str);
1530 len++; /* skip the separator "-" */
1532 cleanup_dmi_name(dst + len);
1536 * snd_soc_set_dmi_name() - Register DMI names to card
1537 * @card: The card to register DMI names
1538 * @flavour: The flavour "differentiator" for the card amongst its peers.
1540 * An Intel machine driver may be used by many different devices but are
1541 * difficult for userspace to differentiate, since machine drivers ususally
1542 * use their own name as the card short name and leave the card long name
1543 * blank. To differentiate such devices and fix bugs due to lack of
1544 * device-specific configurations, this function allows DMI info to be used
1545 * as the sound card long name, in the format of
1546 * "vendor-product-version-board"
1547 * (Character '-' is used to separate different DMI fields here).
1548 * This will help the user space to load the device-specific Use Case Manager
1549 * (UCM) configurations for the card.
1551 * Possible card long names may be:
1552 * DellInc.-XPS139343-01-0310JH
1553 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1554 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1556 * This function also supports flavoring the card longname to provide
1557 * the extra differentiation, like "vendor-product-version-board-flavor".
1559 * We only keep number and alphabet characters and a few separator characters
1560 * in the card long name since UCM in the user space uses the card long names
1561 * as card configuration directory names and AudoConf cannot support special
1562 * charactors like SPACE.
1564 * Returns 0 on success, otherwise a negative error code.
1566 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1568 const char *vendor, *product, *product_version, *board;
1570 if (card->long_name)
1571 return 0; /* long name already set by driver or from DMI */
1573 /* make up dmi long name as: vendor-product-version-board */
1574 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1575 if (!vendor || !is_dmi_valid(vendor)) {
1576 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1580 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1581 cleanup_dmi_name(card->dmi_longname);
1583 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1584 if (product && is_dmi_valid(product)) {
1585 append_dmi_string(card, product);
1588 * some vendors like Lenovo may only put a self-explanatory
1589 * name in the product version field
1591 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1592 if (product_version && is_dmi_valid(product_version))
1593 append_dmi_string(card, product_version);
1596 board = dmi_get_system_info(DMI_BOARD_NAME);
1597 if (board && is_dmi_valid(board)) {
1598 if (!product || strcasecmp(board, product))
1599 append_dmi_string(card, board);
1600 } else if (!product) {
1601 /* fall back to using legacy name */
1602 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1606 /* Add flavour to dmi long name */
1608 append_dmi_string(card, flavour);
1610 /* set the card long name */
1611 card->long_name = card->dmi_longname;
1615 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1616 #endif /* CONFIG_DMI */
1618 static void soc_check_tplg_fes(struct snd_soc_card *card)
1620 struct snd_soc_component *component;
1621 const struct snd_soc_component_driver *comp_drv;
1622 struct snd_soc_dai_link *dai_link;
1625 for_each_component(component) {
1627 /* does this component override BEs ? */
1628 if (!component->driver->ignore_machine)
1631 /* for this machine ? */
1632 if (!strcmp(component->driver->ignore_machine,
1633 card->dev->driver->name))
1635 if (strcmp(component->driver->ignore_machine,
1636 dev_name(card->dev)))
1639 /* machine matches, so override the rtd data */
1640 for_each_card_prelinks(card, i, dai_link) {
1642 /* ignore this FE */
1643 if (dai_link->dynamic) {
1644 dai_link->ignore = true;
1648 dev_dbg(card->dev, "info: override BE DAI link %s\n",
1649 card->dai_link[i].name);
1651 /* override platform component */
1652 if (!dai_link->platforms) {
1653 dev_err(card->dev, "init platform error");
1656 dai_link->platforms->name = component->name;
1658 /* convert non BE into BE */
1659 if (!dai_link->no_pcm) {
1660 dai_link->no_pcm = 1;
1662 if (dai_link->dpcm_playback)
1664 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1666 if (dai_link->dpcm_capture)
1668 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1671 /* convert normal link into DPCM one */
1672 if (!(dai_link->dpcm_playback ||
1673 dai_link->dpcm_capture)) {
1674 dai_link->dpcm_playback = !dai_link->capture_only;
1675 dai_link->dpcm_capture = !dai_link->playback_only;
1680 * override any BE fixups
1682 * snd_soc_link_be_hw_params_fixup()
1684 dai_link->be_hw_params_fixup =
1685 component->driver->be_hw_params_fixup;
1688 * most BE links don't set stream name, so set it to
1689 * dai link name if it's NULL to help bind widgets.
1691 if (!dai_link->stream_name)
1692 dai_link->stream_name = dai_link->name;
1695 /* Inform userspace we are using alternate topology */
1696 if (component->driver->topology_name_prefix) {
1698 /* topology shortname created? */
1699 if (!card->topology_shortname_created) {
1700 comp_drv = component->driver;
1702 snprintf(card->topology_shortname, 32, "%s-%s",
1703 comp_drv->topology_name_prefix,
1705 card->topology_shortname_created = true;
1708 /* use topology shortname */
1709 card->name = card->topology_shortname;
1714 #define soc_setup_card_name(name, name1, name2, norm) \
1715 __soc_setup_card_name(name, sizeof(name), name1, name2, norm)
1716 static void __soc_setup_card_name(char *name, int len,
1717 const char *name1, const char *name2,
1722 snprintf(name, len, "%s", name1 ? name1 : name2);
1728 * Name normalization
1730 * The driver name is somewhat special, as it's used as a key for
1731 * searches in the user-space.
1734 * "abcd??efg" -> "abcd__efg"
1736 for (i = 0; i < len; i++) {
1743 if (!isalnum(name[i]))
1750 static void soc_cleanup_card_resources(struct snd_soc_card *card)
1752 struct snd_soc_pcm_runtime *rtd, *n;
1755 snd_card_disconnect_sync(card->snd_card);
1757 snd_soc_dapm_shutdown(card);
1759 /* remove and free each DAI */
1760 soc_remove_link_dais(card);
1761 soc_remove_link_components(card);
1763 for_each_card_rtds_safe(card, rtd, n)
1764 snd_soc_remove_pcm_runtime(card, rtd);
1766 /* remove auxiliary devices */
1767 soc_remove_aux_devices(card);
1768 soc_unbind_aux_dev(card);
1770 snd_soc_dapm_free(&card->dapm);
1771 soc_cleanup_card_debugfs(card);
1773 /* remove the card */
1774 snd_soc_card_remove(card);
1776 if (card->snd_card) {
1777 snd_card_free(card->snd_card);
1778 card->snd_card = NULL;
1782 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1784 if (card->instantiated) {
1785 card->instantiated = false;
1786 snd_soc_flush_all_delayed_work(card);
1788 soc_cleanup_card_resources(card);
1790 list_add(&card->list, &unbind_card_list);
1793 list_del(&card->list);
1797 static int snd_soc_bind_card(struct snd_soc_card *card)
1799 struct snd_soc_pcm_runtime *rtd;
1800 struct snd_soc_component *component;
1801 struct snd_soc_dai_link *dai_link;
1804 mutex_lock(&client_mutex);
1805 mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1807 snd_soc_dapm_init(&card->dapm, card, NULL);
1809 /* check whether any platform is ignore machine FE and using topology */
1810 soc_check_tplg_fes(card);
1812 /* bind aux_devs too */
1813 ret = soc_bind_aux_dev(card);
1817 /* add predefined DAI links to the list */
1819 for_each_card_prelinks(card, i, dai_link) {
1820 ret = snd_soc_add_pcm_runtime(card, dai_link);
1825 /* card bind complete so register a sound card */
1826 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1827 card->owner, 0, &card->snd_card);
1830 "ASoC: can't create sound card for card %s: %d\n",
1835 soc_init_card_debugfs(card);
1837 soc_resume_init(card);
1839 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1840 card->num_dapm_widgets);
1844 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1845 card->num_of_dapm_widgets);
1849 /* initialise the sound card only once */
1850 ret = snd_soc_card_probe(card);
1854 /* probe all components used by DAI links on this card */
1855 ret = soc_probe_link_components(card);
1858 "ASoC: failed to instantiate card %d\n", ret);
1862 /* probe auxiliary components */
1863 ret = soc_probe_aux_devices(card);
1866 "ASoC: failed to probe aux component %d\n", ret);
1870 /* probe all DAI links on this card */
1871 ret = soc_probe_link_dais(card);
1874 "ASoC: failed to instantiate card %d\n", ret);
1878 for_each_card_rtds(card, rtd) {
1879 ret = soc_init_pcm_runtime(card, rtd);
1884 snd_soc_dapm_link_dai_widgets(card);
1885 snd_soc_dapm_connect_dai_link_widgets(card);
1887 ret = snd_soc_add_card_controls(card, card->controls,
1888 card->num_controls);
1892 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
1893 card->num_dapm_routes);
1895 if (card->disable_route_checks) {
1897 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1901 "%s: snd_soc_dapm_add_routes failed: %d\n",
1907 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
1908 card->num_of_dapm_routes);
1912 /* try to set some sane longname if DMI is available */
1913 snd_soc_set_dmi_name(card, NULL);
1915 soc_setup_card_name(card->snd_card->shortname,
1916 card->name, NULL, 0);
1917 soc_setup_card_name(card->snd_card->longname,
1918 card->long_name, card->name, 0);
1919 soc_setup_card_name(card->snd_card->driver,
1920 card->driver_name, card->name, 1);
1922 if (card->components) {
1923 /* the current implementation of snd_component_add() accepts */
1924 /* multiple components in the string separated by space, */
1925 /* but the string collision (identical string) check might */
1926 /* not work correctly */
1927 ret = snd_component_add(card->snd_card, card->components);
1929 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
1935 ret = snd_soc_card_late_probe(card);
1939 snd_soc_dapm_new_widgets(card);
1941 ret = snd_card_register(card->snd_card);
1943 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
1948 card->instantiated = 1;
1949 dapm_mark_endpoints_dirty(card);
1950 snd_soc_dapm_sync(&card->dapm);
1952 /* deactivate pins to sleep state */
1953 for_each_card_components(card, component)
1954 if (!snd_soc_component_active(component))
1955 pinctrl_pm_select_sleep_state(component->dev);
1959 soc_cleanup_card_resources(card);
1961 mutex_unlock(&card->mutex);
1962 mutex_unlock(&client_mutex);
1967 /* probes a new socdev */
1968 static int soc_probe(struct platform_device *pdev)
1970 struct snd_soc_card *card = platform_get_drvdata(pdev);
1973 * no card, so machine driver should be registering card
1974 * we should not be here in that case so ret error
1979 dev_warn(&pdev->dev,
1980 "ASoC: machine %s should use snd_soc_register_card()\n",
1983 /* Bodge while we unpick instantiation */
1984 card->dev = &pdev->dev;
1986 return snd_soc_register_card(card);
1989 /* removes a socdev */
1990 static int soc_remove(struct platform_device *pdev)
1992 struct snd_soc_card *card = platform_get_drvdata(pdev);
1994 snd_soc_unregister_card(card);
1998 int snd_soc_poweroff(struct device *dev)
2000 struct snd_soc_card *card = dev_get_drvdata(dev);
2001 struct snd_soc_component *component;
2003 if (!card->instantiated)
2007 * Flush out pmdown_time work - we actually do want to run it
2008 * now, we're shutting down so no imminent restart.
2010 snd_soc_flush_all_delayed_work(card);
2012 snd_soc_dapm_shutdown(card);
2014 /* deactivate pins to sleep state */
2015 for_each_card_components(card, component)
2016 pinctrl_pm_select_sleep_state(component->dev);
2020 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2022 const struct dev_pm_ops snd_soc_pm_ops = {
2023 .suspend = snd_soc_suspend,
2024 .resume = snd_soc_resume,
2025 .freeze = snd_soc_suspend,
2026 .thaw = snd_soc_resume,
2027 .poweroff = snd_soc_poweroff,
2028 .restore = snd_soc_resume,
2030 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2032 /* ASoC platform driver */
2033 static struct platform_driver soc_driver = {
2035 .name = "soc-audio",
2036 .pm = &snd_soc_pm_ops,
2039 .remove = soc_remove,
2043 * snd_soc_cnew - create new control
2044 * @_template: control template
2045 * @data: control private data
2046 * @long_name: control long name
2047 * @prefix: control name prefix
2049 * Create a new mixer control from a template control.
2051 * Returns 0 for success, else error.
2053 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2054 void *data, const char *long_name,
2057 struct snd_kcontrol_new template;
2058 struct snd_kcontrol *kcontrol;
2061 memcpy(&template, _template, sizeof(template));
2065 long_name = template.name;
2068 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2072 template.name = name;
2074 template.name = long_name;
2077 kcontrol = snd_ctl_new1(&template, data);
2083 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2085 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2086 const struct snd_kcontrol_new *controls, int num_controls,
2087 const char *prefix, void *data)
2091 for (i = 0; i < num_controls; i++) {
2092 const struct snd_kcontrol_new *control = &controls[i];
2094 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2095 control->name, prefix));
2097 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2098 control->name, err);
2107 * snd_soc_add_component_controls - Add an array of controls to a component.
2109 * @component: Component to add controls to
2110 * @controls: Array of controls to add
2111 * @num_controls: Number of elements in the array
2113 * Return: 0 for success, else error.
2115 int snd_soc_add_component_controls(struct snd_soc_component *component,
2116 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2118 struct snd_card *card = component->card->snd_card;
2120 return snd_soc_add_controls(card, component->dev, controls,
2121 num_controls, component->name_prefix, component);
2123 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2126 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2127 * Convenience function to add a list of controls.
2129 * @soc_card: SoC card to add controls to
2130 * @controls: array of controls to add
2131 * @num_controls: number of elements in the array
2133 * Return 0 for success, else error.
2135 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2136 const struct snd_kcontrol_new *controls, int num_controls)
2138 struct snd_card *card = soc_card->snd_card;
2140 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2143 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2146 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2147 * Convienience function to add a list of controls.
2149 * @dai: DAI to add controls to
2150 * @controls: array of controls to add
2151 * @num_controls: number of elements in the array
2153 * Return 0 for success, else error.
2155 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2156 const struct snd_kcontrol_new *controls, int num_controls)
2158 struct snd_card *card = dai->component->card->snd_card;
2160 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2163 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2166 * snd_soc_register_card - Register a card with the ASoC core
2168 * @card: Card to register
2171 int snd_soc_register_card(struct snd_soc_card *card)
2173 if (!card->name || !card->dev)
2176 dev_set_drvdata(card->dev, card);
2178 INIT_LIST_HEAD(&card->widgets);
2179 INIT_LIST_HEAD(&card->paths);
2180 INIT_LIST_HEAD(&card->dapm_list);
2181 INIT_LIST_HEAD(&card->aux_comp_list);
2182 INIT_LIST_HEAD(&card->component_dev_list);
2183 INIT_LIST_HEAD(&card->list);
2184 INIT_LIST_HEAD(&card->rtd_list);
2185 INIT_LIST_HEAD(&card->dapm_dirty);
2186 INIT_LIST_HEAD(&card->dobj_list);
2188 card->instantiated = 0;
2189 mutex_init(&card->mutex);
2190 mutex_init(&card->dapm_mutex);
2191 mutex_init(&card->pcm_mutex);
2192 spin_lock_init(&card->dpcm_lock);
2194 return snd_soc_bind_card(card);
2196 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2199 * snd_soc_unregister_card - Unregister a card with the ASoC core
2201 * @card: Card to unregister
2204 int snd_soc_unregister_card(struct snd_soc_card *card)
2206 mutex_lock(&client_mutex);
2207 snd_soc_unbind_card(card, true);
2208 mutex_unlock(&client_mutex);
2209 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2213 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2216 * Simplify DAI link configuration by removing ".-1" from device names
2217 * and sanitizing names.
2219 static char *fmt_single_name(struct device *dev, int *id)
2221 char *found, name[NAME_SIZE];
2224 if (dev_name(dev) == NULL)
2227 strlcpy(name, dev_name(dev), NAME_SIZE);
2229 /* are we a "%s.%d" name (platform and SPI components) */
2230 found = strstr(name, dev->driver->name);
2233 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2235 /* discard ID from name if ID == -1 */
2237 found[strlen(dev->driver->name)] = '\0';
2241 /* I2C component devices are named "bus-addr" */
2242 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2243 char tmp[NAME_SIZE];
2245 /* create unique ID number from I2C addr and bus */
2246 *id = ((id1 & 0xffff) << 16) + id2;
2248 /* sanitize component name for DAI link creation */
2249 snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2251 strlcpy(name, tmp, NAME_SIZE);
2256 return devm_kstrdup(dev, name, GFP_KERNEL);
2260 * Simplify DAI link naming for single devices with multiple DAIs by removing
2261 * any ".-1" and using the DAI name (instead of device name).
2263 static inline char *fmt_multiple_name(struct device *dev,
2264 struct snd_soc_dai_driver *dai_drv)
2266 if (dai_drv->name == NULL) {
2268 "ASoC: error - multiple DAI %s registered with no name\n",
2273 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2276 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2278 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2279 list_del(&dai->list);
2281 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2284 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2286 * @component: The component the DAIs are registered for
2287 * @dai_drv: DAI driver to use for the DAI
2288 * @legacy_dai_naming: if %true, use legacy single-name format;
2289 * if %false, use multiple-name format;
2291 * Topology can use this API to register DAIs when probing a component.
2292 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2293 * will be freed in the component cleanup.
2295 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2296 struct snd_soc_dai_driver *dai_drv,
2297 bool legacy_dai_naming)
2299 struct device *dev = component->dev;
2300 struct snd_soc_dai *dai;
2302 dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2304 lockdep_assert_held(&client_mutex);
2306 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2311 * Back in the old days when we still had component-less DAIs,
2312 * instead of having a static name, component-less DAIs would
2313 * inherit the name of the parent device so it is possible to
2314 * register multiple instances of the DAI. We still need to keep
2315 * the same naming style even though those DAIs are not
2316 * component-less anymore.
2318 if (legacy_dai_naming &&
2319 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2320 dai->name = fmt_single_name(dev, &dai->id);
2322 dai->name = fmt_multiple_name(dev, dai_drv);
2324 dai->id = dai_drv->id;
2326 dai->id = component->num_dai;
2331 dai->component = component;
2333 dai->driver = dai_drv;
2335 /* see for_each_component_dais */
2336 list_add_tail(&dai->list, &component->dai_list);
2337 component->num_dai++;
2339 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2344 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2346 * @component: The component for which the DAIs should be unregistered
2348 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2350 struct snd_soc_dai *dai, *_dai;
2352 for_each_component_dais_safe(component, dai, _dai)
2353 snd_soc_unregister_dai(dai);
2357 * snd_soc_register_dais - Register a DAI with the ASoC core
2359 * @component: The component the DAIs are registered for
2360 * @dai_drv: DAI driver to use for the DAIs
2361 * @count: Number of DAIs
2363 static int snd_soc_register_dais(struct snd_soc_component *component,
2364 struct snd_soc_dai_driver *dai_drv,
2367 struct snd_soc_dai *dai;
2371 for (i = 0; i < count; i++) {
2372 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2373 !component->driver->non_legacy_dai_naming);
2383 snd_soc_unregister_dais(component);
2388 #define ENDIANNESS_MAP(name) \
2389 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2390 static u64 endianness_format_map[] = {
2391 ENDIANNESS_MAP(S16_),
2392 ENDIANNESS_MAP(U16_),
2393 ENDIANNESS_MAP(S24_),
2394 ENDIANNESS_MAP(U24_),
2395 ENDIANNESS_MAP(S32_),
2396 ENDIANNESS_MAP(U32_),
2397 ENDIANNESS_MAP(S24_3),
2398 ENDIANNESS_MAP(U24_3),
2399 ENDIANNESS_MAP(S20_3),
2400 ENDIANNESS_MAP(U20_3),
2401 ENDIANNESS_MAP(S18_3),
2402 ENDIANNESS_MAP(U18_3),
2403 ENDIANNESS_MAP(FLOAT_),
2404 ENDIANNESS_MAP(FLOAT64_),
2405 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2409 * Fix up the DAI formats for endianness: codecs don't actually see
2410 * the endianness of the data but we're using the CPU format
2411 * definitions which do need to include endianness so we ensure that
2412 * codec DAIs always have both big and little endian variants set.
2414 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2418 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2419 if (stream->formats & endianness_format_map[i])
2420 stream->formats |= endianness_format_map[i];
2423 static void snd_soc_try_rebind_card(void)
2425 struct snd_soc_card *card, *c;
2427 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2428 if (!snd_soc_bind_card(card))
2429 list_del(&card->list);
2432 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2434 struct snd_soc_card *card = component->card;
2436 snd_soc_unregister_dais(component);
2439 snd_soc_unbind_card(card, false);
2441 list_del(&component->list);
2444 int snd_soc_component_initialize(struct snd_soc_component *component,
2445 const struct snd_soc_component_driver *driver,
2448 INIT_LIST_HEAD(&component->dai_list);
2449 INIT_LIST_HEAD(&component->dobj_list);
2450 INIT_LIST_HEAD(&component->card_list);
2451 mutex_init(&component->io_mutex);
2453 component->name = fmt_single_name(dev, &component->id);
2454 if (!component->name) {
2455 dev_err(dev, "ASoC: Failed to allocate name\n");
2459 component->dev = dev;
2460 component->driver = driver;
2464 EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2466 int snd_soc_add_component(struct snd_soc_component *component,
2467 struct snd_soc_dai_driver *dai_drv,
2473 mutex_lock(&client_mutex);
2475 if (component->driver->endianness) {
2476 for (i = 0; i < num_dai; i++) {
2477 convert_endianness_formats(&dai_drv[i].playback);
2478 convert_endianness_formats(&dai_drv[i].capture);
2482 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2484 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2489 if (!component->driver->write && !component->driver->read) {
2490 if (!component->regmap)
2491 component->regmap = dev_get_regmap(component->dev,
2493 if (component->regmap)
2494 snd_soc_component_setup_regmap(component);
2497 /* see for_each_component */
2498 list_add(&component->list, &component_list);
2502 snd_soc_del_component_unlocked(component);
2504 mutex_unlock(&client_mutex);
2507 snd_soc_try_rebind_card();
2511 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2513 int snd_soc_register_component(struct device *dev,
2514 const struct snd_soc_component_driver *component_driver,
2515 struct snd_soc_dai_driver *dai_drv,
2518 struct snd_soc_component *component;
2521 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2525 ret = snd_soc_component_initialize(component, component_driver, dev);
2529 return snd_soc_add_component(component, dai_drv, num_dai);
2531 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2534 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2535 * from the ASoC core
2537 * @dev: The device to unregister
2538 * @component_driver: The component driver to unregister
2540 void snd_soc_unregister_component_by_driver(struct device *dev,
2541 const struct snd_soc_component_driver *component_driver)
2543 struct snd_soc_component *component;
2545 if (!component_driver)
2548 mutex_lock(&client_mutex);
2549 component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2553 snd_soc_del_component_unlocked(component);
2556 mutex_unlock(&client_mutex);
2558 EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2561 * snd_soc_unregister_component - Unregister all related component
2562 * from the ASoC core
2564 * @dev: The device to unregister
2566 void snd_soc_unregister_component(struct device *dev)
2568 struct snd_soc_component *component;
2570 mutex_lock(&client_mutex);
2572 component = snd_soc_lookup_component_nolocked(dev, NULL);
2576 snd_soc_del_component_unlocked(component);
2578 mutex_unlock(&client_mutex);
2580 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2582 /* Retrieve a card's name from device tree */
2583 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2584 const char *propname)
2586 struct device_node *np;
2590 pr_err("card->dev is not set before calling %s\n", __func__);
2594 np = card->dev->of_node;
2596 ret = of_property_read_string_index(np, propname, 0, &card->name);
2598 * EINVAL means the property does not exist. This is fine providing
2599 * card->name was previously set, which is checked later in
2600 * snd_soc_register_card.
2602 if (ret < 0 && ret != -EINVAL) {
2604 "ASoC: Property '%s' could not be read: %d\n",
2611 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2613 static const struct snd_soc_dapm_widget simple_widgets[] = {
2614 SND_SOC_DAPM_MIC("Microphone", NULL),
2615 SND_SOC_DAPM_LINE("Line", NULL),
2616 SND_SOC_DAPM_HP("Headphone", NULL),
2617 SND_SOC_DAPM_SPK("Speaker", NULL),
2620 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2621 const char *propname)
2623 struct device_node *np = card->dev->of_node;
2624 struct snd_soc_dapm_widget *widgets;
2625 const char *template, *wname;
2626 int i, j, num_widgets, ret;
2628 num_widgets = of_property_count_strings(np, propname);
2629 if (num_widgets < 0) {
2631 "ASoC: Property '%s' does not exist\n", propname);
2634 if (num_widgets & 1) {
2636 "ASoC: Property '%s' length is not even\n", propname);
2642 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2647 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2651 "ASoC: Could not allocate memory for widgets\n");
2655 for (i = 0; i < num_widgets; i++) {
2656 ret = of_property_read_string_index(np, propname,
2660 "ASoC: Property '%s' index %d read error:%d\n",
2661 propname, 2 * i, ret);
2665 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2666 if (!strncmp(template, simple_widgets[j].name,
2667 strlen(simple_widgets[j].name))) {
2668 widgets[i] = simple_widgets[j];
2673 if (j >= ARRAY_SIZE(simple_widgets)) {
2675 "ASoC: DAPM widget '%s' is not supported\n",
2680 ret = of_property_read_string_index(np, propname,
2685 "ASoC: Property '%s' index %d read error:%d\n",
2686 propname, (2 * i) + 1, ret);
2690 widgets[i].name = wname;
2693 card->of_dapm_widgets = widgets;
2694 card->num_of_dapm_widgets = num_widgets;
2698 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2700 int snd_soc_of_get_slot_mask(struct device_node *np,
2701 const char *prop_name,
2705 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2711 for (i = 0; i < val; i++)
2712 if (be32_to_cpup(&of_slot_mask[i]))
2717 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2719 int snd_soc_of_parse_tdm_slot(struct device_node *np,
2720 unsigned int *tx_mask,
2721 unsigned int *rx_mask,
2722 unsigned int *slots,
2723 unsigned int *slot_width)
2729 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2731 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2733 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2734 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2742 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2743 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2753 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2755 void snd_soc_of_parse_node_prefix(struct device_node *np,
2756 struct snd_soc_codec_conf *codec_conf,
2757 struct device_node *of_node,
2758 const char *propname)
2763 ret = of_property_read_string(np, propname, &str);
2765 /* no prefix is not error */
2769 codec_conf->dlc.of_node = of_node;
2770 codec_conf->name_prefix = str;
2772 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2774 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2775 const char *propname)
2777 struct device_node *np = card->dev->of_node;
2779 struct snd_soc_dapm_route *routes;
2782 num_routes = of_property_count_strings(np, propname);
2783 if (num_routes < 0 || num_routes & 1) {
2785 "ASoC: Property '%s' does not exist or its length is not even\n",
2791 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2796 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2800 "ASoC: Could not allocate DAPM route table\n");
2804 for (i = 0; i < num_routes; i++) {
2805 ret = of_property_read_string_index(np, propname,
2806 2 * i, &routes[i].sink);
2809 "ASoC: Property '%s' index %d could not be read: %d\n",
2810 propname, 2 * i, ret);
2813 ret = of_property_read_string_index(np, propname,
2814 (2 * i) + 1, &routes[i].source);
2817 "ASoC: Property '%s' index %d could not be read: %d\n",
2818 propname, (2 * i) + 1, ret);
2823 card->num_of_dapm_routes = num_routes;
2824 card->of_dapm_routes = routes;
2828 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
2830 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
2832 struct device_node **bitclkmaster,
2833 struct device_node **framemaster)
2837 unsigned int format = 0;
2843 } of_fmt_table[] = {
2844 { "i2s", SND_SOC_DAIFMT_I2S },
2845 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
2846 { "left_j", SND_SOC_DAIFMT_LEFT_J },
2847 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
2848 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
2849 { "ac97", SND_SOC_DAIFMT_AC97 },
2850 { "pdm", SND_SOC_DAIFMT_PDM},
2851 { "msb", SND_SOC_DAIFMT_MSB },
2852 { "lsb", SND_SOC_DAIFMT_LSB },
2859 * check "dai-format = xxx"
2860 * or "[prefix]format = xxx"
2861 * SND_SOC_DAIFMT_FORMAT_MASK area
2863 ret = of_property_read_string(np, "dai-format", &str);
2865 snprintf(prop, sizeof(prop), "%sformat", prefix);
2866 ret = of_property_read_string(np, prop, &str);
2869 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
2870 if (strcmp(str, of_fmt_table[i].name) == 0) {
2871 format |= of_fmt_table[i].val;
2878 * check "[prefix]continuous-clock"
2879 * SND_SOC_DAIFMT_CLOCK_MASK area
2881 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
2882 if (of_property_read_bool(np, prop))
2883 format |= SND_SOC_DAIFMT_CONT;
2885 format |= SND_SOC_DAIFMT_GATED;
2888 * check "[prefix]bitclock-inversion"
2889 * check "[prefix]frame-inversion"
2890 * SND_SOC_DAIFMT_INV_MASK area
2892 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
2893 bit = !!of_get_property(np, prop, NULL);
2895 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
2896 frame = !!of_get_property(np, prop, NULL);
2898 switch ((bit << 4) + frame) {
2900 format |= SND_SOC_DAIFMT_IB_IF;
2903 format |= SND_SOC_DAIFMT_IB_NF;
2906 format |= SND_SOC_DAIFMT_NB_IF;
2909 /* SND_SOC_DAIFMT_NB_NF is default */
2914 * check "[prefix]bitclock-master"
2915 * check "[prefix]frame-master"
2916 * SND_SOC_DAIFMT_MASTER_MASK area
2918 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
2919 bit = !!of_get_property(np, prop, NULL);
2920 if (bit && bitclkmaster)
2921 *bitclkmaster = of_parse_phandle(np, prop, 0);
2923 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
2924 frame = !!of_get_property(np, prop, NULL);
2925 if (frame && framemaster)
2926 *framemaster = of_parse_phandle(np, prop, 0);
2928 switch ((bit << 4) + frame) {
2930 format |= SND_SOC_DAIFMT_CBM_CFM;
2933 format |= SND_SOC_DAIFMT_CBM_CFS;
2936 format |= SND_SOC_DAIFMT_CBS_CFM;
2939 format |= SND_SOC_DAIFMT_CBS_CFS;
2945 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
2947 int snd_soc_get_dai_id(struct device_node *ep)
2949 struct snd_soc_component *component;
2950 struct snd_soc_dai_link_component dlc;
2953 dlc.of_node = of_graph_get_port_parent(ep);
2956 * For example HDMI case, HDMI has video/sound port,
2957 * but ALSA SoC needs sound port number only.
2958 * Thus counting HDMI DT port/endpoint doesn't work.
2959 * Then, it should have .of_xlate_dai_id
2962 mutex_lock(&client_mutex);
2963 component = soc_find_component(&dlc);
2965 ret = snd_soc_component_of_xlate_dai_id(component, ep);
2966 mutex_unlock(&client_mutex);
2968 of_node_put(dlc.of_node);
2972 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
2974 int snd_soc_get_dai_name(struct of_phandle_args *args,
2975 const char **dai_name)
2977 struct snd_soc_component *pos;
2978 struct device_node *component_of_node;
2979 int ret = -EPROBE_DEFER;
2981 mutex_lock(&client_mutex);
2982 for_each_component(pos) {
2983 component_of_node = soc_component_to_node(pos);
2985 if (component_of_node != args->np)
2988 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
2989 if (ret == -ENOTSUPP) {
2990 struct snd_soc_dai *dai;
2993 switch (args->args_count) {
2995 id = 0; /* same as dai_drv[0] */
3005 if (id < 0 || id >= pos->num_dai) {
3012 /* find target DAI */
3013 for_each_component_dais(pos, dai) {
3019 *dai_name = dai->driver->name;
3021 *dai_name = pos->name;
3024 * if another error than ENOTSUPP is returned go on and
3025 * check if another component is provided with the same
3026 * node. This may happen if a device provides several
3034 mutex_unlock(&client_mutex);
3037 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3039 int snd_soc_of_get_dai_name(struct device_node *of_node,
3040 const char **dai_name)
3042 struct of_phandle_args args;
3045 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3046 "#sound-dai-cells", 0, &args);
3050 ret = snd_soc_get_dai_name(&args, dai_name);
3052 of_node_put(args.np);
3056 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3059 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3060 * @dai_link: DAI link
3062 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3064 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3066 struct snd_soc_dai_link_component *component;
3069 for_each_link_codecs(dai_link, index, component) {
3070 if (!component->of_node)
3072 of_node_put(component->of_node);
3073 component->of_node = NULL;
3076 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3079 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3081 * @of_node: Device node
3082 * @dai_link: DAI link
3084 * Builds an array of CODEC DAI components from the DAI link property
3086 * The array is set in the DAI link and the number of DAIs is set accordingly.
3087 * The device nodes in the array (of_node) must be dereferenced by calling
3088 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3090 * Returns 0 for success
3092 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3093 struct device_node *of_node,
3094 struct snd_soc_dai_link *dai_link)
3096 struct of_phandle_args args;
3097 struct snd_soc_dai_link_component *component;
3099 int index, num_codecs, ret;
3101 /* Count the number of CODECs */
3103 num_codecs = of_count_phandle_with_args(of_node, name,
3104 "#sound-dai-cells");
3105 if (num_codecs <= 0) {
3106 if (num_codecs == -ENOENT)
3107 dev_err(dev, "No 'sound-dai' property\n");
3109 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3112 component = devm_kcalloc(dev,
3113 num_codecs, sizeof(*component),
3117 dai_link->codecs = component;
3118 dai_link->num_codecs = num_codecs;
3120 /* Parse the list */
3121 for_each_link_codecs(dai_link, index, component) {
3122 ret = of_parse_phandle_with_args(of_node, name,
3127 component->of_node = args.np;
3128 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3134 snd_soc_of_put_dai_link_codecs(dai_link);
3135 dai_link->codecs = NULL;
3136 dai_link->num_codecs = 0;
3139 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3141 static int __init snd_soc_init(void)
3143 snd_soc_debugfs_init();
3144 snd_soc_util_init();
3146 return platform_driver_register(&soc_driver);
3148 module_init(snd_soc_init);
3150 static void __exit snd_soc_exit(void)
3152 snd_soc_util_exit();
3153 snd_soc_debugfs_exit();
3155 platform_driver_unregister(&soc_driver);
3157 module_exit(snd_soc_exit);
3159 /* Module information */
3161 MODULE_DESCRIPTION("ALSA SoC Core");
3162 MODULE_LICENSE("GPL");
3163 MODULE_ALIAS("platform:soc-audio");