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 <linux/acpi.h>
35 #include <sound/core.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>
47 static DEFINE_MUTEX(client_mutex);
48 static LIST_HEAD(component_list);
49 static LIST_HEAD(unbind_card_list);
51 #define for_each_component(component) \
52 list_for_each_entry(component, &component_list, list)
55 * This is used if driver don't need to have CPU/Codec/Platform
58 struct snd_soc_dai_link_component null_dailink_component[0];
59 EXPORT_SYMBOL_GPL(null_dailink_component);
62 * This is a timeout to do a DAPM powerdown after a stream is closed().
63 * It can be used to eliminate pops between different playback streams, e.g.
64 * between two audio tracks.
66 static int pmdown_time = 5000;
67 module_param(pmdown_time, int, 0);
68 MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
70 static ssize_t pmdown_time_show(struct device *dev,
71 struct device_attribute *attr, char *buf)
73 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
75 return sysfs_emit(buf, "%ld\n", rtd->pmdown_time);
78 static ssize_t pmdown_time_store(struct device *dev,
79 struct device_attribute *attr,
80 const char *buf, size_t count)
82 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
85 ret = kstrtol(buf, 10, &rtd->pmdown_time);
92 static DEVICE_ATTR_RW(pmdown_time);
94 static struct attribute *soc_dev_attrs[] = {
95 &dev_attr_pmdown_time.attr,
99 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
100 struct attribute *attr, int idx)
102 struct device *dev = kobj_to_dev(kobj);
103 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
108 if (attr == &dev_attr_pmdown_time.attr)
109 return attr->mode; /* always visible */
110 return rtd->dai_link->num_codecs ? attr->mode : 0; /* enabled only with codec */
113 static const struct attribute_group soc_dapm_dev_group = {
114 .attrs = soc_dapm_dev_attrs,
115 .is_visible = soc_dev_attr_is_visible,
118 static const struct attribute_group soc_dev_group = {
119 .attrs = soc_dev_attrs,
120 .is_visible = soc_dev_attr_is_visible,
123 static const struct attribute_group *soc_dev_attr_groups[] = {
129 #ifdef CONFIG_DEBUG_FS
130 struct dentry *snd_soc_debugfs_root;
131 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
133 static void soc_init_component_debugfs(struct snd_soc_component *component)
135 if (!component->card->debugfs_card_root)
138 if (component->debugfs_prefix) {
141 name = kasprintf(GFP_KERNEL, "%s:%s",
142 component->debugfs_prefix, component->name);
144 component->debugfs_root = debugfs_create_dir(name,
145 component->card->debugfs_card_root);
149 component->debugfs_root = debugfs_create_dir(component->name,
150 component->card->debugfs_card_root);
153 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
154 component->debugfs_root);
157 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
159 if (!component->debugfs_root)
161 debugfs_remove_recursive(component->debugfs_root);
162 component->debugfs_root = NULL;
165 static int dai_list_show(struct seq_file *m, void *v)
167 struct snd_soc_component *component;
168 struct snd_soc_dai *dai;
170 mutex_lock(&client_mutex);
172 for_each_component(component)
173 for_each_component_dais(component, dai)
174 seq_printf(m, "%s\n", dai->name);
176 mutex_unlock(&client_mutex);
180 DEFINE_SHOW_ATTRIBUTE(dai_list);
182 static int component_list_show(struct seq_file *m, void *v)
184 struct snd_soc_component *component;
186 mutex_lock(&client_mutex);
188 for_each_component(component)
189 seq_printf(m, "%s\n", component->name);
191 mutex_unlock(&client_mutex);
195 DEFINE_SHOW_ATTRIBUTE(component_list);
197 static void soc_init_card_debugfs(struct snd_soc_card *card)
199 card->debugfs_card_root = debugfs_create_dir(card->name,
200 snd_soc_debugfs_root);
202 debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
205 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
208 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
210 debugfs_remove_recursive(card->debugfs_card_root);
211 card->debugfs_card_root = NULL;
214 static void snd_soc_debugfs_init(void)
216 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
218 debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
221 debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
222 &component_list_fops);
225 static void snd_soc_debugfs_exit(void)
227 debugfs_remove_recursive(snd_soc_debugfs_root);
232 static inline void soc_init_component_debugfs(struct snd_soc_component *component) { }
233 static inline void soc_cleanup_component_debugfs(struct snd_soc_component *component) { }
234 static inline void soc_init_card_debugfs(struct snd_soc_card *card) { }
235 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card) { }
236 static inline void snd_soc_debugfs_init(void) { }
237 static inline void snd_soc_debugfs_exit(void) { }
241 static int snd_soc_rtd_add_component(struct snd_soc_pcm_runtime *rtd,
242 struct snd_soc_component *component)
244 struct snd_soc_component *comp;
247 for_each_rtd_components(rtd, i, comp) {
248 /* already connected */
249 if (comp == component)
253 /* see for_each_rtd_components */
254 rtd->components[rtd->num_components] = component;
255 rtd->num_components++;
260 struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
261 const char *driver_name)
263 struct snd_soc_component *component;
272 * snd_soc_rtdcom_lookup() will find component from rtd by using
273 * specified driver name.
274 * But, if many components which have same driver name are connected
275 * to 1 rtd, this function will return 1st found component.
277 for_each_rtd_components(rtd, i, component) {
278 const char *component_name = component->driver->name;
283 if ((component_name == driver_name) ||
284 strcmp(component_name, driver_name) == 0)
290 EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
292 struct snd_soc_component
293 *snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
295 struct snd_soc_component *component;
296 struct snd_soc_component *found_component;
298 found_component = NULL;
299 for_each_component(component) {
300 if ((dev == component->dev) &&
302 (driver_name == component->driver->name) ||
303 (strcmp(component->driver->name, driver_name) == 0))) {
304 found_component = component;
309 return found_component;
311 EXPORT_SYMBOL_GPL(snd_soc_lookup_component_nolocked);
313 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
314 const char *driver_name)
316 struct snd_soc_component *component;
318 mutex_lock(&client_mutex);
319 component = snd_soc_lookup_component_nolocked(dev, driver_name);
320 mutex_unlock(&client_mutex);
324 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
326 struct snd_soc_pcm_runtime
327 *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
328 struct snd_soc_dai_link *dai_link)
330 struct snd_soc_pcm_runtime *rtd;
332 for_each_card_rtds(card, rtd) {
333 if (rtd->dai_link == dai_link)
336 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
339 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
342 * Power down the audio subsystem pmdown_time msecs after close is called.
343 * This is to ensure there are no pops or clicks in between any music tracks
344 * due to DAPM power cycling.
346 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd)
348 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
349 int playback = SNDRV_PCM_STREAM_PLAYBACK;
351 snd_soc_dpcm_mutex_lock(rtd);
354 "ASoC: pop wq checking: %s status: %s waiting: %s\n",
355 codec_dai->driver->playback.stream_name,
356 snd_soc_dai_stream_active(codec_dai, playback) ?
357 "active" : "inactive",
358 rtd->pop_wait ? "yes" : "no");
360 /* are we waiting on this codec DAI stream */
361 if (rtd->pop_wait == 1) {
363 snd_soc_dapm_stream_event(rtd, playback,
364 SND_SOC_DAPM_STREAM_STOP);
367 snd_soc_dpcm_mutex_unlock(rtd);
369 EXPORT_SYMBOL_GPL(snd_soc_close_delayed_work);
371 static void soc_release_rtd_dev(struct device *dev)
373 /* "dev" means "rtd->dev" */
377 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
382 list_del(&rtd->list);
384 if (delayed_work_pending(&rtd->delayed_work))
385 flush_delayed_work(&rtd->delayed_work);
386 snd_soc_pcm_component_free(rtd);
389 * we don't need to call kfree() for rtd->dev
391 * soc_release_rtd_dev()
393 * We don't need rtd->dev NULL check, because
394 * it is alloced *before* rtd.
396 * soc_new_pcm_runtime()
398 * We don't need to mind freeing for rtd,
399 * because it was created from dev (= rtd->dev)
401 * soc_new_pcm_runtime()
403 * rtd = devm_kzalloc(dev, ...);
406 device_unregister(rtd->dev);
409 static void close_delayed_work(struct work_struct *work) {
410 struct snd_soc_pcm_runtime *rtd =
411 container_of(work, struct snd_soc_pcm_runtime,
414 if (rtd->close_delayed_work_func)
415 rtd->close_delayed_work_func(rtd);
418 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
419 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
421 struct snd_soc_pcm_runtime *rtd;
422 struct snd_soc_component *component;
430 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
434 dev->parent = card->dev;
435 dev->release = soc_release_rtd_dev;
437 dev_set_name(dev, "%s", dai_link->name);
439 ret = device_register(dev);
441 put_device(dev); /* soc_release_rtd_dev */
448 rtd = devm_kzalloc(dev,
450 sizeof(component) * (dai_link->num_cpus +
451 dai_link->num_codecs +
452 dai_link->num_platforms),
455 device_unregister(dev);
460 INIT_LIST_HEAD(&rtd->list);
461 for_each_pcm_streams(stream) {
462 INIT_LIST_HEAD(&rtd->dpcm[stream].be_clients);
463 INIT_LIST_HEAD(&rtd->dpcm[stream].fe_clients);
465 dev_set_drvdata(dev, rtd);
466 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
471 rtd->dais = devm_kcalloc(dev, dai_link->num_cpus + dai_link->num_codecs,
472 sizeof(struct snd_soc_dai *),
478 * dais = [][][][][][][][][][][][][][][][][][]
479 * ^cpu_dais ^codec_dais
480 * |--- num_cpus ---|--- num_codecs --|
483 * asoc_rtd_to_codec()
486 rtd->dai_link = dai_link;
487 rtd->num = card->num_rtd++;
488 rtd->pmdown_time = pmdown_time; /* default power off timeout */
490 /* see for_each_card_rtds */
491 list_add_tail(&rtd->list, &card->rtd_list);
493 ret = device_add_groups(dev, soc_dev_attr_groups);
500 soc_free_pcm_runtime(rtd);
504 static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
506 struct snd_soc_pcm_runtime *rtd;
508 for_each_card_rtds(card, rtd)
509 flush_delayed_work(&rtd->delayed_work);
512 #ifdef CONFIG_PM_SLEEP
513 static void soc_playback_digital_mute(struct snd_soc_card *card, int mute)
515 struct snd_soc_pcm_runtime *rtd;
516 struct snd_soc_dai *dai;
517 int playback = SNDRV_PCM_STREAM_PLAYBACK;
520 for_each_card_rtds(card, rtd) {
522 if (rtd->dai_link->ignore_suspend)
525 for_each_rtd_dais(rtd, i, dai) {
526 if (snd_soc_dai_stream_active(dai, playback))
527 snd_soc_dai_digital_mute(dai, mute, playback);
532 static void soc_dapm_suspend_resume(struct snd_soc_card *card, int event)
534 struct snd_soc_pcm_runtime *rtd;
537 for_each_card_rtds(card, rtd) {
539 if (rtd->dai_link->ignore_suspend)
542 for_each_pcm_streams(stream)
543 snd_soc_dapm_stream_event(rtd, stream, event);
547 /* powers down audio subsystem for suspend */
548 int snd_soc_suspend(struct device *dev)
550 struct snd_soc_card *card = dev_get_drvdata(dev);
551 struct snd_soc_component *component;
552 struct snd_soc_pcm_runtime *rtd;
555 /* If the card is not initialized yet there is nothing to do */
556 if (!snd_soc_card_is_instantiated(card))
560 * Due to the resume being scheduled into a workqueue we could
561 * suspend before that's finished - wait for it to complete.
563 snd_power_wait(card->snd_card);
565 /* we're going to block userspace touching us until resume completes */
566 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
568 /* mute any active DACs */
569 soc_playback_digital_mute(card, 1);
571 /* suspend all pcms */
572 for_each_card_rtds(card, rtd) {
573 if (rtd->dai_link->ignore_suspend)
576 snd_pcm_suspend_all(rtd->pcm);
579 snd_soc_card_suspend_pre(card);
581 /* close any waiting streams */
582 snd_soc_flush_all_delayed_work(card);
584 soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_SUSPEND);
586 /* Recheck all endpoints too, their state is affected by suspend */
587 dapm_mark_endpoints_dirty(card);
588 snd_soc_dapm_sync(&card->dapm);
590 /* suspend all COMPONENTs */
591 for_each_card_rtds(card, rtd) {
593 if (rtd->dai_link->ignore_suspend)
596 for_each_rtd_components(rtd, i, component) {
597 struct snd_soc_dapm_context *dapm =
598 snd_soc_component_get_dapm(component);
601 * ignore if component was already suspended
603 if (snd_soc_component_is_suspended(component))
607 * If there are paths active then the COMPONENT will be
608 * held with bias _ON and should not be suspended.
610 switch (snd_soc_dapm_get_bias_level(dapm)) {
611 case SND_SOC_BIAS_STANDBY:
613 * If the COMPONENT is capable of idle
614 * bias off then being in STANDBY
615 * means it's doing something,
616 * otherwise fall through.
618 if (dapm->idle_bias_off) {
619 dev_dbg(component->dev,
620 "ASoC: idle_bias_off CODEC on over suspend\n");
625 case SND_SOC_BIAS_OFF:
626 snd_soc_component_suspend(component);
627 if (component->regmap)
628 regcache_mark_dirty(component->regmap);
629 /* deactivate pins to sleep state */
630 pinctrl_pm_select_sleep_state(component->dev);
633 dev_dbg(component->dev,
634 "ASoC: COMPONENT is on over suspend\n");
640 snd_soc_card_suspend_post(card);
644 EXPORT_SYMBOL_GPL(snd_soc_suspend);
647 * deferred resume work, so resume can complete before we finished
648 * setting our codec back up, which can be very slow on I2C
650 static void soc_resume_deferred(struct work_struct *work)
652 struct snd_soc_card *card =
653 container_of(work, struct snd_soc_card,
654 deferred_resume_work);
655 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 soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_RESUME);
676 /* unmute any active DACs */
677 soc_playback_digital_mute(card, 0);
679 snd_soc_card_resume_post(card);
681 dev_dbg(card->dev, "ASoC: resume work completed\n");
683 /* Recheck all endpoints too, their state is affected by suspend */
684 dapm_mark_endpoints_dirty(card);
685 snd_soc_dapm_sync(&card->dapm);
687 /* userspace can access us now we are back as we were before */
688 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
691 /* powers up audio subsystem after a suspend */
692 int snd_soc_resume(struct device *dev)
694 struct snd_soc_card *card = dev_get_drvdata(dev);
695 struct snd_soc_component *component;
697 /* If the card is not initialized yet there is nothing to do */
698 if (!snd_soc_card_is_instantiated(card))
701 /* activate pins from sleep state */
702 for_each_card_components(card, component)
703 if (snd_soc_component_active(component))
704 pinctrl_pm_select_default_state(component->dev);
706 dev_dbg(dev, "ASoC: Scheduling resume work\n");
707 if (!schedule_work(&card->deferred_resume_work))
708 dev_err(dev, "ASoC: resume work item may be lost\n");
712 EXPORT_SYMBOL_GPL(snd_soc_resume);
714 static void soc_resume_init(struct snd_soc_card *card)
716 /* deferred resume work */
717 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
720 #define snd_soc_suspend NULL
721 #define snd_soc_resume NULL
722 static inline void soc_resume_init(struct snd_soc_card *card) { }
725 static struct device_node
726 *soc_component_to_node(struct snd_soc_component *component)
728 struct device_node *of_node;
730 of_node = component->dev->of_node;
731 if (!of_node && component->dev->parent)
732 of_node = component->dev->parent->of_node;
737 static int snd_soc_is_matching_component(
738 const struct snd_soc_dai_link_component *dlc,
739 struct snd_soc_component *component)
741 struct device_node *component_of_node;
746 component_of_node = soc_component_to_node(component);
748 if (dlc->of_node && component_of_node != dlc->of_node)
750 if (dlc->name && strcmp(component->name, dlc->name))
756 static struct snd_soc_component *soc_find_component(
757 const struct snd_soc_dai_link_component *dlc)
759 struct snd_soc_component *component;
761 lockdep_assert_held(&client_mutex);
766 * It returns *1st* found component, but some driver
767 * has few components by same of_node/name
769 * CPU component and generic DMAEngine component
771 for_each_component(component)
772 if (snd_soc_is_matching_component(dlc, component))
779 * snd_soc_find_dai - Find a registered DAI
781 * @dlc: name of the DAI or the DAI driver and optional component info to match
783 * This function will search all registered components and their DAIs to
784 * find the DAI of the same name. The component's of_node and name
785 * should also match if being specified.
787 * Return: pointer of DAI, or NULL if not found.
789 struct snd_soc_dai *snd_soc_find_dai(
790 const struct snd_soc_dai_link_component *dlc)
792 struct snd_soc_component *component;
793 struct snd_soc_dai *dai;
795 lockdep_assert_held(&client_mutex);
797 /* Find CPU DAI from registered DAIs */
798 for_each_component(component) {
799 if (!snd_soc_is_matching_component(dlc, component))
801 for_each_component_dais(component, dai) {
802 if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
803 && (!dai->driver->name
804 || strcmp(dai->driver->name, dlc->dai_name)))
813 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
815 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
816 const struct snd_soc_dai_link_component *dlc)
818 struct snd_soc_dai *dai;
820 mutex_lock(&client_mutex);
821 dai = snd_soc_find_dai(dlc);
822 mutex_unlock(&client_mutex);
826 EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
828 static int soc_dai_link_sanity_check(struct snd_soc_card *card,
829 struct snd_soc_dai_link *link)
832 struct snd_soc_dai_link_component *cpu, *codec, *platform;
834 for_each_link_codecs(link, i, codec) {
836 * Codec must be specified by 1 of name or OF node,
837 * not both or neither.
839 if (!!codec->name == !!codec->of_node) {
840 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
845 /* Codec DAI name must be specified */
846 if (!codec->dai_name) {
847 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
853 * Defer card registration if codec component is not added to
856 if (!soc_find_component(codec)) {
858 "ASoC: codec component %s not found for link %s\n",
859 codec->name, link->name);
860 return -EPROBE_DEFER;
864 for_each_link_platforms(link, i, platform) {
866 * Platform may be specified by either name or OF node, but it
867 * can be left unspecified, then no components will be inserted
870 if (!!platform->name == !!platform->of_node) {
872 "ASoC: Neither/both platform name/of_node are set for %s\n",
878 * Defer card registration if platform component is not added to
881 if (!soc_find_component(platform)) {
883 "ASoC: platform component %s not found for link %s\n",
884 platform->name, link->name);
885 return -EPROBE_DEFER;
889 for_each_link_cpus(link, i, cpu) {
891 * CPU device may be specified by either name or OF node, but
892 * can be left unspecified, and will be matched based on DAI
895 if (cpu->name && cpu->of_node) {
897 "ASoC: Neither/both cpu name/of_node are set for %s\n",
903 * Defer card registration if cpu dai component is not added to
906 if ((cpu->of_node || cpu->name) &&
907 !soc_find_component(cpu)) {
909 "ASoC: cpu component %s not found for link %s\n",
910 cpu->name, link->name);
911 return -EPROBE_DEFER;
915 * At least one of CPU DAI name or CPU device name/node must be
918 if (!cpu->dai_name &&
919 !(cpu->name || cpu->of_node)) {
921 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
931 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
932 * @card: The ASoC card to which the pcm_runtime has
933 * @rtd: The pcm_runtime to remove
935 * This function removes a pcm_runtime from the ASoC card.
937 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
938 struct snd_soc_pcm_runtime *rtd)
940 lockdep_assert_held(&client_mutex);
943 * Notify the machine driver for extra destruction
945 snd_soc_card_remove_dai_link(card, rtd->dai_link);
947 soc_free_pcm_runtime(rtd);
949 EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
952 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
953 * @card: The ASoC card to which the pcm_runtime is added
954 * @dai_link: The DAI link to find pcm_runtime
956 * This function adds a pcm_runtime ASoC card by using dai_link.
958 * Note: Topology can use this API to add pcm_runtime when probing the
959 * topology component. And machine drivers can still define static
960 * DAI links in dai_link array.
962 static int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
963 struct snd_soc_dai_link *dai_link)
965 struct snd_soc_pcm_runtime *rtd;
966 struct snd_soc_dai_link_component *codec, *platform, *cpu;
967 struct snd_soc_component *component;
970 lockdep_assert_held(&client_mutex);
973 * Notify the machine driver for extra initialization
975 ret = snd_soc_card_add_dai_link(card, dai_link);
979 if (dai_link->ignore)
982 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
984 ret = soc_dai_link_sanity_check(card, dai_link);
988 rtd = soc_new_pcm_runtime(card, dai_link);
992 for_each_link_cpus(dai_link, i, cpu) {
993 asoc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
994 if (!asoc_rtd_to_cpu(rtd, i)) {
995 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
999 snd_soc_rtd_add_component(rtd, asoc_rtd_to_cpu(rtd, i)->component);
1002 /* Find CODEC from registered CODECs */
1003 for_each_link_codecs(dai_link, i, codec) {
1004 asoc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1005 if (!asoc_rtd_to_codec(rtd, i)) {
1006 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1011 snd_soc_rtd_add_component(rtd, asoc_rtd_to_codec(rtd, i)->component);
1014 /* Find PLATFORM from registered PLATFORMs */
1015 for_each_link_platforms(dai_link, i, platform) {
1016 for_each_component(component) {
1017 if (!snd_soc_is_matching_component(platform, component))
1020 snd_soc_rtd_add_component(rtd, component);
1027 snd_soc_remove_pcm_runtime(card, rtd);
1028 return -EPROBE_DEFER;
1031 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1032 struct snd_soc_dai_link *dai_link,
1035 for (int i = 0; i < num_dai_link; i++) {
1036 int ret = snd_soc_add_pcm_runtime(card, dai_link + i);
1044 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtimes);
1046 static void snd_soc_runtime_get_dai_fmt(struct snd_soc_pcm_runtime *rtd)
1048 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1049 struct snd_soc_dai *dai, *not_used;
1050 u64 pos, possible_fmt;
1051 unsigned int mask = 0, dai_fmt = 0;
1052 int i, j, priority, pri, until;
1055 * Get selectable format from each DAIs.
1057 ****************************
1059 * Using .auto_selectable_formats is not mandatory,
1060 * we can select format manually from Sound Card.
1061 * When use it, driver should list well tested format only.
1062 ****************************
1065 * auto_selectable_formats (= SND_SOC_POSSIBLE_xxx)
1067 * DAI0_: { 0x000F, 0x00F0, 0x0F00 };
1068 * DAI1 : { 0xF000, 0x0F00 };
1071 * "until" will be 3 in this case (MAX array size from DAI0 and DAI1)
1072 * Here is dev_dbg() message and comments
1075 * DAI0: (pri, fmt) = (1, 000000000000000F) // 1st check (A) DAI1 is not selected
1076 * DAI1: (pri, fmt) = (0, 0000000000000000) // Necessary Waste
1077 * DAI0: (pri, fmt) = (1, 000000000000000F) // 2nd check (A)
1078 * DAI1: (pri, fmt) = (1, 000000000000F000) // (X)
1080 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 3rd check (A) + (B)
1081 * DAI1: (pri, fmt) = (1, 000000000000F000) // (X)
1082 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 4th check (A) + (B)
1083 * DAI1: (pri, fmt) = (2, 000000000000FF00) // (X) + (Y)
1085 * DAI0: (pri, fmt) = (3, 0000000000000FFF) // 5th check (A) + (B) + (C)
1086 * DAI1: (pri, fmt) = (2, 000000000000FF00) // (X) + (Y)
1087 * found auto selected format: 0000000000000F00
1089 until = snd_soc_dai_get_fmt_max_priority(rtd);
1090 for (priority = 1; priority <= until; priority++) {
1091 for_each_rtd_dais(rtd, j, not_used) {
1093 possible_fmt = ULLONG_MAX;
1094 for_each_rtd_dais(rtd, i, dai) {
1097 pri = (j >= i) ? priority : priority - 1;
1098 fmt = snd_soc_dai_get_fmt(dai, pri);
1099 possible_fmt &= fmt;
1109 * convert POSSIBLE_DAIFMT to DAIFMT
1111 * Some basic/default settings on each is defined as 0.
1113 * SND_SOC_DAIFMT_NB_NF
1114 * SND_SOC_DAIFMT_GATED
1116 * SND_SOC_DAIFMT_xxx_MASK can't notice it if Sound Card specify
1117 * these value, and will be overwrite to auto selected value.
1119 * To avoid such issue, loop from 63 to 0 here.
1120 * Small number of SND_SOC_POSSIBLE_xxx will be Hi priority.
1121 * Basic/Default settings of each part and aboves are defined
1122 * as Hi priority (= small number) of SND_SOC_POSSIBLE_xxx.
1124 for (i = 63; i >= 0; i--) {
1126 switch (possible_fmt & pos) {
1130 case SND_SOC_POSSIBLE_DAIFMT_I2S:
1131 case SND_SOC_POSSIBLE_DAIFMT_RIGHT_J:
1132 case SND_SOC_POSSIBLE_DAIFMT_LEFT_J:
1133 case SND_SOC_POSSIBLE_DAIFMT_DSP_A:
1134 case SND_SOC_POSSIBLE_DAIFMT_DSP_B:
1135 case SND_SOC_POSSIBLE_DAIFMT_AC97:
1136 case SND_SOC_POSSIBLE_DAIFMT_PDM:
1137 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_FORMAT_MASK) | i;
1142 case SND_SOC_POSSIBLE_DAIFMT_CONT:
1143 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_CONT;
1145 case SND_SOC_POSSIBLE_DAIFMT_GATED:
1146 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_GATED;
1151 case SND_SOC_POSSIBLE_DAIFMT_NB_NF:
1152 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_NF;
1154 case SND_SOC_POSSIBLE_DAIFMT_NB_IF:
1155 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_IF;
1157 case SND_SOC_POSSIBLE_DAIFMT_IB_NF:
1158 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_NF;
1160 case SND_SOC_POSSIBLE_DAIFMT_IB_IF:
1161 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_IF;
1164 * for clock provider / consumer
1166 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFP:
1167 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFP;
1169 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFP:
1170 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFP;
1172 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFC:
1173 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFC;
1175 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFC:
1176 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFC;
1182 * Some driver might have very complex limitation.
1183 * In such case, user want to auto-select non-limitation part,
1184 * and want to manually specify complex part.
1186 * Or for example, if both CPU and Codec can be clock provider,
1187 * but because of its quality, user want to specify it manually.
1189 * Use manually specified settings if sound card did.
1191 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK))
1192 mask |= SND_SOC_DAIFMT_FORMAT_MASK;
1193 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_MASK))
1194 mask |= SND_SOC_DAIFMT_CLOCK_MASK;
1195 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_INV_MASK))
1196 mask |= SND_SOC_DAIFMT_INV_MASK;
1197 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK))
1198 mask |= SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
1200 dai_link->dai_fmt |= (dai_fmt & mask);
1204 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1205 * @rtd: The runtime for which the DAI link format should be changed
1206 * @dai_fmt: The new DAI link format
1208 * This function updates the DAI link format for all DAIs connected to the DAI
1209 * link for the specified runtime.
1211 * Note: For setups with a static format set the dai_fmt field in the
1212 * corresponding snd_dai_link struct instead of using this function.
1214 * Returns 0 on success, otherwise a negative error code.
1216 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1217 unsigned int dai_fmt)
1219 struct snd_soc_dai *cpu_dai;
1220 struct snd_soc_dai *codec_dai;
1227 for_each_rtd_codec_dais(rtd, i, codec_dai) {
1228 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1229 if (ret != 0 && ret != -ENOTSUPP)
1233 /* Flip the polarity for the "CPU" end of link */
1234 dai_fmt = snd_soc_daifmt_clock_provider_flipped(dai_fmt);
1236 for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1237 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1238 if (ret != 0 && ret != -ENOTSUPP)
1244 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1246 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1247 struct snd_soc_pcm_runtime *rtd)
1249 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1250 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
1251 struct snd_soc_component *component;
1254 /* do machine specific initialization */
1255 ret = snd_soc_link_init(rtd);
1259 snd_soc_runtime_get_dai_fmt(rtd);
1260 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1264 /* add DPCM sysfs entries */
1265 soc_dpcm_debugfs_add(rtd);
1270 * most drivers will register their PCMs using DAI link ordering but
1271 * topology based drivers can use the DAI link id field to set PCM
1272 * device number and then use rtd + a base offset of the BEs.
1274 for_each_rtd_components(rtd, i, component) {
1275 if (!component->driver->use_dai_pcm_id)
1278 if (rtd->dai_link->no_pcm)
1279 num += component->driver->be_pcm_base;
1281 num = rtd->dai_link->id;
1284 /* create compress_device if possible */
1285 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1286 if (ret != -ENOTSUPP)
1289 /* create the pcm */
1290 ret = soc_new_pcm(rtd, num);
1292 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1293 dai_link->stream_name, ret);
1297 return snd_soc_pcm_dai_new(rtd);
1300 static void soc_set_name_prefix(struct snd_soc_card *card,
1301 struct snd_soc_component *component)
1303 struct device_node *of_node = soc_component_to_node(component);
1307 for (i = 0; i < card->num_configs; i++) {
1308 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1310 if (snd_soc_is_matching_component(&map->dlc, component) &&
1312 component->name_prefix = map->name_prefix;
1318 * If there is no configuration table or no match in the table,
1319 * check if a prefix is provided in the node
1321 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1325 component->name_prefix = str;
1328 static void soc_remove_component(struct snd_soc_component *component,
1332 if (!component->card)
1336 snd_soc_component_remove(component);
1338 list_del_init(&component->card_list);
1339 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1340 soc_cleanup_component_debugfs(component);
1341 component->card = NULL;
1342 snd_soc_component_module_put_when_remove(component);
1345 static int soc_probe_component(struct snd_soc_card *card,
1346 struct snd_soc_component *component)
1348 struct snd_soc_dapm_context *dapm =
1349 snd_soc_component_get_dapm(component);
1350 struct snd_soc_dai *dai;
1354 if (snd_soc_component_is_dummy(component))
1357 if (component->card) {
1358 if (component->card != card) {
1359 dev_err(component->dev,
1360 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1361 card->name, component->card->name);
1367 ret = snd_soc_component_module_get_when_probe(component);
1371 component->card = card;
1372 soc_set_name_prefix(card, component);
1374 soc_init_component_debugfs(component);
1376 snd_soc_dapm_init(dapm, card, component);
1378 ret = snd_soc_dapm_new_controls(dapm,
1379 component->driver->dapm_widgets,
1380 component->driver->num_dapm_widgets);
1383 dev_err(component->dev,
1384 "Failed to create new controls %d\n", ret);
1388 for_each_component_dais(component, dai) {
1389 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1391 dev_err(component->dev,
1392 "Failed to create DAI widgets %d\n", ret);
1397 ret = snd_soc_component_probe(component);
1401 WARN(dapm->idle_bias_off &&
1402 dapm->bias_level != SND_SOC_BIAS_OFF,
1403 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1408 * machine specific init
1410 * snd_soc_component_set_aux()
1412 ret = snd_soc_component_init(component);
1416 ret = snd_soc_add_component_controls(component,
1417 component->driver->controls,
1418 component->driver->num_controls);
1422 ret = snd_soc_dapm_add_routes(dapm,
1423 component->driver->dapm_routes,
1424 component->driver->num_dapm_routes);
1426 if (card->disable_route_checks) {
1428 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1432 "%s: snd_soc_dapm_add_routes failed: %d\n",
1438 /* see for_each_card_components */
1439 list_add(&component->card_list, &card->component_dev_list);
1443 soc_remove_component(component, probed);
1448 static void soc_remove_link_dais(struct snd_soc_card *card)
1450 struct snd_soc_pcm_runtime *rtd;
1453 for_each_comp_order(order) {
1454 for_each_card_rtds(card, rtd) {
1455 /* remove all rtd connected DAIs in good order */
1456 snd_soc_pcm_dai_remove(rtd, order);
1461 static int soc_probe_link_dais(struct snd_soc_card *card)
1463 struct snd_soc_pcm_runtime *rtd;
1466 for_each_comp_order(order) {
1467 for_each_card_rtds(card, rtd) {
1468 /* probe all rtd connected DAIs in good order */
1469 ret = snd_soc_pcm_dai_probe(rtd, order);
1478 static void soc_remove_link_components(struct snd_soc_card *card)
1480 struct snd_soc_component *component;
1481 struct snd_soc_pcm_runtime *rtd;
1484 for_each_comp_order(order) {
1485 for_each_card_rtds(card, rtd) {
1486 for_each_rtd_components(rtd, i, component) {
1487 if (component->driver->remove_order != order)
1490 soc_remove_component(component, 1);
1496 static int soc_probe_link_components(struct snd_soc_card *card)
1498 struct snd_soc_component *component;
1499 struct snd_soc_pcm_runtime *rtd;
1502 for_each_comp_order(order) {
1503 for_each_card_rtds(card, rtd) {
1504 for_each_rtd_components(rtd, i, component) {
1505 if (component->driver->probe_order != order)
1508 ret = soc_probe_component(card, component);
1518 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1520 struct snd_soc_component *component, *_component;
1522 for_each_card_auxs_safe(card, component, _component) {
1523 /* for snd_soc_component_init() */
1524 snd_soc_component_set_aux(component, NULL);
1525 list_del(&component->card_aux_list);
1529 static int soc_bind_aux_dev(struct snd_soc_card *card)
1531 struct snd_soc_component *component;
1532 struct snd_soc_aux_dev *aux;
1535 for_each_card_pre_auxs(card, i, aux) {
1536 /* codecs, usually analog devices */
1537 component = soc_find_component(&aux->dlc);
1539 return -EPROBE_DEFER;
1541 /* for snd_soc_component_init() */
1542 snd_soc_component_set_aux(component, aux);
1543 /* see for_each_card_auxs */
1544 list_add(&component->card_aux_list, &card->aux_comp_list);
1549 static int soc_probe_aux_devices(struct snd_soc_card *card)
1551 struct snd_soc_component *component;
1555 for_each_comp_order(order) {
1556 for_each_card_auxs(card, component) {
1557 if (component->driver->probe_order != order)
1560 ret = soc_probe_component(card, component);
1569 static void soc_remove_aux_devices(struct snd_soc_card *card)
1571 struct snd_soc_component *comp, *_comp;
1574 for_each_comp_order(order) {
1575 for_each_card_auxs_safe(card, comp, _comp) {
1576 if (comp->driver->remove_order == order)
1577 soc_remove_component(comp, 1);
1584 * If a DMI filed contain strings in this blacklist (e.g.
1585 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1586 * as invalid and dropped when setting the card long name from DMI info.
1588 static const char * const dmi_blacklist[] = {
1589 "To be filled by OEM",
1592 "Board Manufacturer",
1593 "Board Vendor Name",
1594 "Board Product Name",
1595 NULL, /* terminator */
1599 * Trim special characters, and replace '-' with '_' since '-' is used to
1600 * separate different DMI fields in the card long name. Only number and
1601 * alphabet characters and a few separator characters are kept.
1603 static void cleanup_dmi_name(char *name)
1607 for (i = 0; name[i]; i++) {
1608 if (isalnum(name[i]) || (name[i] == '.')
1609 || (name[i] == '_'))
1610 name[j++] = name[i];
1611 else if (name[i] == '-')
1619 * Check if a DMI field is valid, i.e. not containing any string
1620 * in the black list.
1622 static int is_dmi_valid(const char *field)
1626 while (dmi_blacklist[i]) {
1627 if (strstr(field, dmi_blacklist[i]))
1636 * Append a string to card->dmi_longname with character cleanups.
1638 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1640 char *dst = card->dmi_longname;
1641 size_t dst_len = sizeof(card->dmi_longname);
1645 snprintf(dst + len, dst_len - len, "-%s", str);
1647 len++; /* skip the separator "-" */
1649 cleanup_dmi_name(dst + len);
1653 * snd_soc_set_dmi_name() - Register DMI names to card
1654 * @card: The card to register DMI names
1655 * @flavour: The flavour "differentiator" for the card amongst its peers.
1657 * An Intel machine driver may be used by many different devices but are
1658 * difficult for userspace to differentiate, since machine drivers ususally
1659 * use their own name as the card short name and leave the card long name
1660 * blank. To differentiate such devices and fix bugs due to lack of
1661 * device-specific configurations, this function allows DMI info to be used
1662 * as the sound card long name, in the format of
1663 * "vendor-product-version-board"
1664 * (Character '-' is used to separate different DMI fields here).
1665 * This will help the user space to load the device-specific Use Case Manager
1666 * (UCM) configurations for the card.
1668 * Possible card long names may be:
1669 * DellInc.-XPS139343-01-0310JH
1670 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1671 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1673 * This function also supports flavoring the card longname to provide
1674 * the extra differentiation, like "vendor-product-version-board-flavor".
1676 * We only keep number and alphabet characters and a few separator characters
1677 * in the card long name since UCM in the user space uses the card long names
1678 * as card configuration directory names and AudoConf cannot support special
1679 * charactors like SPACE.
1681 * Returns 0 on success, otherwise a negative error code.
1683 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1685 const char *vendor, *product, *board;
1687 if (card->long_name)
1688 return 0; /* long name already set by driver or from DMI */
1693 /* make up dmi long name as: vendor-product-version-board */
1694 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1695 if (!vendor || !is_dmi_valid(vendor)) {
1696 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1700 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1701 cleanup_dmi_name(card->dmi_longname);
1703 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1704 if (product && is_dmi_valid(product)) {
1705 const char *product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1707 append_dmi_string(card, product);
1710 * some vendors like Lenovo may only put a self-explanatory
1711 * name in the product version field
1713 if (product_version && is_dmi_valid(product_version))
1714 append_dmi_string(card, product_version);
1717 board = dmi_get_system_info(DMI_BOARD_NAME);
1718 if (board && is_dmi_valid(board)) {
1719 if (!product || strcasecmp(board, product))
1720 append_dmi_string(card, board);
1721 } else if (!product) {
1722 /* fall back to using legacy name */
1723 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1727 /* Add flavour to dmi long name */
1729 append_dmi_string(card, flavour);
1731 /* set the card long name */
1732 card->long_name = card->dmi_longname;
1736 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1737 #endif /* CONFIG_DMI */
1739 static void soc_check_tplg_fes(struct snd_soc_card *card)
1741 struct snd_soc_component *component;
1742 const struct snd_soc_component_driver *comp_drv;
1743 struct snd_soc_dai_link *dai_link;
1746 for_each_component(component) {
1748 /* does this component override BEs ? */
1749 if (!component->driver->ignore_machine)
1752 /* for this machine ? */
1753 if (!strcmp(component->driver->ignore_machine,
1754 card->dev->driver->name))
1756 if (strcmp(component->driver->ignore_machine,
1757 dev_name(card->dev)))
1760 /* machine matches, so override the rtd data */
1761 for_each_card_prelinks(card, i, dai_link) {
1763 /* ignore this FE */
1764 if (dai_link->dynamic) {
1765 dai_link->ignore = true;
1769 dev_dbg(card->dev, "info: override BE DAI link %s\n",
1770 card->dai_link[i].name);
1772 /* override platform component */
1773 if (!dai_link->platforms) {
1774 dev_err(card->dev, "init platform error");
1778 if (component->dev->of_node)
1779 dai_link->platforms->of_node = component->dev->of_node;
1781 dai_link->platforms->name = component->name;
1783 /* convert non BE into BE */
1784 if (!dai_link->no_pcm) {
1785 dai_link->no_pcm = 1;
1787 if (dai_link->dpcm_playback)
1789 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1791 if (dai_link->dpcm_capture)
1793 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1796 /* convert normal link into DPCM one */
1797 if (!(dai_link->dpcm_playback ||
1798 dai_link->dpcm_capture)) {
1799 dai_link->dpcm_playback = !dai_link->capture_only;
1800 dai_link->dpcm_capture = !dai_link->playback_only;
1805 * override any BE fixups
1807 * snd_soc_link_be_hw_params_fixup()
1809 dai_link->be_hw_params_fixup =
1810 component->driver->be_hw_params_fixup;
1813 * most BE links don't set stream name, so set it to
1814 * dai link name if it's NULL to help bind widgets.
1816 if (!dai_link->stream_name)
1817 dai_link->stream_name = dai_link->name;
1820 /* Inform userspace we are using alternate topology */
1821 if (component->driver->topology_name_prefix) {
1823 /* topology shortname created? */
1824 if (!card->topology_shortname_created) {
1825 comp_drv = component->driver;
1827 snprintf(card->topology_shortname, 32, "%s-%s",
1828 comp_drv->topology_name_prefix,
1830 card->topology_shortname_created = true;
1833 /* use topology shortname */
1834 card->name = card->topology_shortname;
1839 #define soc_setup_card_name(card, name, name1, name2) \
1840 __soc_setup_card_name(card, name, sizeof(name), name1, name2)
1841 static void __soc_setup_card_name(struct snd_soc_card *card,
1842 char *name, int len,
1843 const char *name1, const char *name2)
1845 const char *src = name1 ? name1 : name2;
1848 snprintf(name, len, "%s", src);
1850 if (name != card->snd_card->driver)
1854 * Name normalization (driver field)
1856 * The driver name is somewhat special, as it's used as a key for
1857 * searches in the user-space.
1860 * "abcd??efg" -> "abcd__efg"
1862 for (i = 0; i < len; i++) {
1869 if (!isalnum(name[i]))
1876 * The driver field should contain a valid string from the user view.
1877 * The wrapping usually does not work so well here. Set a smaller string
1878 * in the specific ASoC driver.
1880 if (strlen(src) > len - 1)
1881 dev_err(card->dev, "ASoC: driver name too long '%s' -> '%s'\n", src, name);
1884 static void soc_cleanup_card_resources(struct snd_soc_card *card)
1886 struct snd_soc_pcm_runtime *rtd, *n;
1889 snd_card_disconnect_sync(card->snd_card);
1891 snd_soc_dapm_shutdown(card);
1893 /* release machine specific resources */
1894 for_each_card_rtds(card, rtd)
1895 snd_soc_link_exit(rtd);
1896 /* remove and free each DAI */
1897 soc_remove_link_dais(card);
1898 soc_remove_link_components(card);
1900 for_each_card_rtds_safe(card, rtd, n)
1901 snd_soc_remove_pcm_runtime(card, rtd);
1903 /* remove auxiliary devices */
1904 soc_remove_aux_devices(card);
1905 soc_unbind_aux_dev(card);
1907 snd_soc_dapm_free(&card->dapm);
1908 soc_cleanup_card_debugfs(card);
1910 /* remove the card */
1911 snd_soc_card_remove(card);
1913 if (card->snd_card) {
1914 snd_card_free(card->snd_card);
1915 card->snd_card = NULL;
1919 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1921 if (snd_soc_card_is_instantiated(card)) {
1922 card->instantiated = false;
1923 snd_soc_flush_all_delayed_work(card);
1925 soc_cleanup_card_resources(card);
1927 list_add(&card->list, &unbind_card_list);
1930 list_del(&card->list);
1934 static int snd_soc_bind_card(struct snd_soc_card *card)
1936 struct snd_soc_pcm_runtime *rtd;
1937 struct snd_soc_component *component;
1940 mutex_lock(&client_mutex);
1941 snd_soc_card_mutex_lock_root(card);
1943 snd_soc_dapm_init(&card->dapm, card, NULL);
1945 /* check whether any platform is ignore machine FE and using topology */
1946 soc_check_tplg_fes(card);
1948 /* bind aux_devs too */
1949 ret = soc_bind_aux_dev(card);
1953 /* add predefined DAI links to the list */
1955 ret = snd_soc_add_pcm_runtimes(card, card->dai_link, card->num_links);
1959 /* card bind complete so register a sound card */
1960 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1961 card->owner, 0, &card->snd_card);
1964 "ASoC: can't create sound card for card %s: %d\n",
1969 soc_init_card_debugfs(card);
1971 soc_resume_init(card);
1973 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1974 card->num_dapm_widgets);
1978 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1979 card->num_of_dapm_widgets);
1983 /* initialise the sound card only once */
1984 ret = snd_soc_card_probe(card);
1988 /* probe all components used by DAI links on this card */
1989 ret = soc_probe_link_components(card);
1992 "ASoC: failed to instantiate card %d\n", ret);
1996 /* probe auxiliary components */
1997 ret = soc_probe_aux_devices(card);
2000 "ASoC: failed to probe aux component %d\n", ret);
2004 /* probe all DAI links on this card */
2005 ret = soc_probe_link_dais(card);
2008 "ASoC: failed to instantiate card %d\n", ret);
2012 for_each_card_rtds(card, rtd) {
2013 ret = soc_init_pcm_runtime(card, rtd);
2018 snd_soc_dapm_link_dai_widgets(card);
2019 snd_soc_dapm_connect_dai_link_widgets(card);
2021 ret = snd_soc_add_card_controls(card, card->controls,
2022 card->num_controls);
2026 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2027 card->num_dapm_routes);
2029 if (card->disable_route_checks) {
2031 "%s: disable_route_checks set, ignoring errors on add_routes\n",
2035 "%s: snd_soc_dapm_add_routes failed: %d\n",
2041 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2042 card->num_of_dapm_routes);
2046 /* try to set some sane longname if DMI is available */
2047 snd_soc_set_dmi_name(card, NULL);
2049 soc_setup_card_name(card, card->snd_card->shortname,
2051 soc_setup_card_name(card, card->snd_card->longname,
2052 card->long_name, card->name);
2053 soc_setup_card_name(card, card->snd_card->driver,
2054 card->driver_name, card->name);
2056 if (card->components) {
2057 /* the current implementation of snd_component_add() accepts */
2058 /* multiple components in the string separated by space, */
2059 /* but the string collision (identical string) check might */
2060 /* not work correctly */
2061 ret = snd_component_add(card->snd_card, card->components);
2063 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
2069 ret = snd_soc_card_late_probe(card);
2073 snd_soc_dapm_new_widgets(card);
2074 snd_soc_card_fixup_controls(card);
2076 ret = snd_card_register(card->snd_card);
2078 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2083 card->instantiated = 1;
2084 dapm_mark_endpoints_dirty(card);
2085 snd_soc_dapm_sync(&card->dapm);
2087 /* deactivate pins to sleep state */
2088 for_each_card_components(card, component)
2089 if (!snd_soc_component_active(component))
2090 pinctrl_pm_select_sleep_state(component->dev);
2094 soc_cleanup_card_resources(card);
2096 snd_soc_card_mutex_unlock(card);
2097 mutex_unlock(&client_mutex);
2102 /* probes a new socdev */
2103 static int soc_probe(struct platform_device *pdev)
2105 struct snd_soc_card *card = platform_get_drvdata(pdev);
2108 * no card, so machine driver should be registering card
2109 * we should not be here in that case so ret error
2114 dev_warn(&pdev->dev,
2115 "ASoC: machine %s should use snd_soc_register_card()\n",
2118 /* Bodge while we unpick instantiation */
2119 card->dev = &pdev->dev;
2121 return devm_snd_soc_register_card(&pdev->dev, card);
2124 int snd_soc_poweroff(struct device *dev)
2126 struct snd_soc_card *card = dev_get_drvdata(dev);
2127 struct snd_soc_component *component;
2129 if (!snd_soc_card_is_instantiated(card))
2133 * Flush out pmdown_time work - we actually do want to run it
2134 * now, we're shutting down so no imminent restart.
2136 snd_soc_flush_all_delayed_work(card);
2138 snd_soc_dapm_shutdown(card);
2140 /* deactivate pins to sleep state */
2141 for_each_card_components(card, component)
2142 pinctrl_pm_select_sleep_state(component->dev);
2146 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2148 const struct dev_pm_ops snd_soc_pm_ops = {
2149 .suspend = snd_soc_suspend,
2150 .resume = snd_soc_resume,
2151 .freeze = snd_soc_suspend,
2152 .thaw = snd_soc_resume,
2153 .poweroff = snd_soc_poweroff,
2154 .restore = snd_soc_resume,
2156 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2158 /* ASoC platform driver */
2159 static struct platform_driver soc_driver = {
2161 .name = "soc-audio",
2162 .pm = &snd_soc_pm_ops,
2168 * snd_soc_cnew - create new control
2169 * @_template: control template
2170 * @data: control private data
2171 * @long_name: control long name
2172 * @prefix: control name prefix
2174 * Create a new mixer control from a template control.
2176 * Returns 0 for success, else error.
2178 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2179 void *data, const char *long_name,
2182 struct snd_kcontrol_new template;
2183 struct snd_kcontrol *kcontrol;
2186 memcpy(&template, _template, sizeof(template));
2190 long_name = template.name;
2193 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2197 template.name = name;
2199 template.name = long_name;
2202 kcontrol = snd_ctl_new1(&template, data);
2208 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2210 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2211 const struct snd_kcontrol_new *controls, int num_controls,
2212 const char *prefix, void *data)
2216 for (i = 0; i < num_controls; i++) {
2217 const struct snd_kcontrol_new *control = &controls[i];
2218 int err = snd_ctl_add(card, snd_soc_cnew(control, data,
2219 control->name, prefix));
2221 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2222 control->name, err);
2231 * snd_soc_add_component_controls - Add an array of controls to a component.
2233 * @component: Component to add controls to
2234 * @controls: Array of controls to add
2235 * @num_controls: Number of elements in the array
2237 * Return: 0 for success, else error.
2239 int snd_soc_add_component_controls(struct snd_soc_component *component,
2240 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2242 struct snd_card *card = component->card->snd_card;
2244 return snd_soc_add_controls(card, component->dev, controls,
2245 num_controls, component->name_prefix, component);
2247 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2250 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2251 * Convenience function to add a list of controls.
2253 * @soc_card: SoC card to add controls to
2254 * @controls: array of controls to add
2255 * @num_controls: number of elements in the array
2257 * Return 0 for success, else error.
2259 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2260 const struct snd_kcontrol_new *controls, int num_controls)
2262 struct snd_card *card = soc_card->snd_card;
2264 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2267 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2270 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2271 * Convienience function to add a list of controls.
2273 * @dai: DAI to add controls to
2274 * @controls: array of controls to add
2275 * @num_controls: number of elements in the array
2277 * Return 0 for success, else error.
2279 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2280 const struct snd_kcontrol_new *controls, int num_controls)
2282 struct snd_card *card = dai->component->card->snd_card;
2284 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2287 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2290 * snd_soc_register_card - Register a card with the ASoC core
2292 * @card: Card to register
2295 int snd_soc_register_card(struct snd_soc_card *card)
2297 if (!card->name || !card->dev)
2300 dev_set_drvdata(card->dev, card);
2302 INIT_LIST_HEAD(&card->widgets);
2303 INIT_LIST_HEAD(&card->paths);
2304 INIT_LIST_HEAD(&card->dapm_list);
2305 INIT_LIST_HEAD(&card->aux_comp_list);
2306 INIT_LIST_HEAD(&card->component_dev_list);
2307 INIT_LIST_HEAD(&card->list);
2308 INIT_LIST_HEAD(&card->rtd_list);
2309 INIT_LIST_HEAD(&card->dapm_dirty);
2310 INIT_LIST_HEAD(&card->dobj_list);
2312 card->instantiated = 0;
2313 mutex_init(&card->mutex);
2314 mutex_init(&card->dapm_mutex);
2315 mutex_init(&card->pcm_mutex);
2317 return snd_soc_bind_card(card);
2319 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2322 * snd_soc_unregister_card - Unregister a card with the ASoC core
2324 * @card: Card to unregister
2327 void snd_soc_unregister_card(struct snd_soc_card *card)
2329 mutex_lock(&client_mutex);
2330 snd_soc_unbind_card(card, true);
2331 mutex_unlock(&client_mutex);
2332 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2334 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2337 * Simplify DAI link configuration by removing ".-1" from device names
2338 * and sanitizing names.
2340 static char *fmt_single_name(struct device *dev, int *id)
2342 const char *devname = dev_name(dev);
2344 unsigned int id1, id2;
2346 if (devname == NULL)
2349 name = devm_kstrdup(dev, devname, GFP_KERNEL);
2353 /* are we a "%s.%d" name (platform and SPI components) */
2354 found = strstr(name, dev->driver->name);
2357 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2359 /* discard ID from name if ID == -1 */
2361 found[strlen(dev->driver->name)] = '\0';
2364 /* I2C component devices are named "bus-addr" */
2365 } else if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2367 /* create unique ID number from I2C addr and bus */
2368 *id = ((id1 & 0xffff) << 16) + id2;
2370 devm_kfree(dev, name);
2372 /* sanitize component name for DAI link creation */
2373 name = devm_kasprintf(dev, GFP_KERNEL, "%s.%s", dev->driver->name, devname);
2382 * Simplify DAI link naming for single devices with multiple DAIs by removing
2383 * any ".-1" and using the DAI name (instead of device name).
2385 static inline char *fmt_multiple_name(struct device *dev,
2386 struct snd_soc_dai_driver *dai_drv)
2388 if (dai_drv->name == NULL) {
2390 "ASoC: error - multiple DAI %s registered with no name\n",
2395 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2398 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2400 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2401 list_del(&dai->list);
2403 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2406 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2408 * @component: The component the DAIs are registered for
2409 * @dai_drv: DAI driver to use for the DAI
2410 * @legacy_dai_naming: if %true, use legacy single-name format;
2411 * if %false, use multiple-name format;
2413 * Topology can use this API to register DAIs when probing a component.
2414 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2415 * will be freed in the component cleanup.
2417 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2418 struct snd_soc_dai_driver *dai_drv,
2419 bool legacy_dai_naming)
2421 struct device *dev = component->dev;
2422 struct snd_soc_dai *dai;
2424 lockdep_assert_held(&client_mutex);
2426 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2431 * Back in the old days when we still had component-less DAIs,
2432 * instead of having a static name, component-less DAIs would
2433 * inherit the name of the parent device so it is possible to
2434 * register multiple instances of the DAI. We still need to keep
2435 * the same naming style even though those DAIs are not
2436 * component-less anymore.
2438 if (legacy_dai_naming &&
2439 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2440 dai->name = fmt_single_name(dev, &dai->id);
2442 dai->name = fmt_multiple_name(dev, dai_drv);
2444 dai->id = dai_drv->id;
2446 dai->id = component->num_dai;
2451 dai->component = component;
2453 dai->driver = dai_drv;
2455 /* see for_each_component_dais */
2456 list_add_tail(&dai->list, &component->dai_list);
2457 component->num_dai++;
2459 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2462 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2465 * snd_soc_unregister_dais - Unregister DAIs from the ASoC core
2467 * @component: The component for which the DAIs should be unregistered
2469 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2471 struct snd_soc_dai *dai, *_dai;
2473 for_each_component_dais_safe(component, dai, _dai)
2474 snd_soc_unregister_dai(dai);
2478 * snd_soc_register_dais - Register a DAI with the ASoC core
2480 * @component: The component the DAIs are registered for
2481 * @dai_drv: DAI driver to use for the DAIs
2482 * @count: Number of DAIs
2484 static int snd_soc_register_dais(struct snd_soc_component *component,
2485 struct snd_soc_dai_driver *dai_drv,
2488 struct snd_soc_dai *dai;
2492 for (i = 0; i < count; i++) {
2493 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2494 component->driver->legacy_dai_naming);
2504 snd_soc_unregister_dais(component);
2509 #define ENDIANNESS_MAP(name) \
2510 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2511 static u64 endianness_format_map[] = {
2512 ENDIANNESS_MAP(S16_),
2513 ENDIANNESS_MAP(U16_),
2514 ENDIANNESS_MAP(S24_),
2515 ENDIANNESS_MAP(U24_),
2516 ENDIANNESS_MAP(S32_),
2517 ENDIANNESS_MAP(U32_),
2518 ENDIANNESS_MAP(S24_3),
2519 ENDIANNESS_MAP(U24_3),
2520 ENDIANNESS_MAP(S20_3),
2521 ENDIANNESS_MAP(U20_3),
2522 ENDIANNESS_MAP(S18_3),
2523 ENDIANNESS_MAP(U18_3),
2524 ENDIANNESS_MAP(FLOAT_),
2525 ENDIANNESS_MAP(FLOAT64_),
2526 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2530 * Fix up the DAI formats for endianness: codecs don't actually see
2531 * the endianness of the data but we're using the CPU format
2532 * definitions which do need to include endianness so we ensure that
2533 * codec DAIs always have both big and little endian variants set.
2535 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2539 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2540 if (stream->formats & endianness_format_map[i])
2541 stream->formats |= endianness_format_map[i];
2544 static void snd_soc_try_rebind_card(void)
2546 struct snd_soc_card *card, *c;
2548 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2549 if (!snd_soc_bind_card(card))
2550 list_del(&card->list);
2553 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2555 struct snd_soc_card *card = component->card;
2557 snd_soc_unregister_dais(component);
2560 snd_soc_unbind_card(card, false);
2562 list_del(&component->list);
2565 int snd_soc_component_initialize(struct snd_soc_component *component,
2566 const struct snd_soc_component_driver *driver,
2569 INIT_LIST_HEAD(&component->dai_list);
2570 INIT_LIST_HEAD(&component->dobj_list);
2571 INIT_LIST_HEAD(&component->card_list);
2572 INIT_LIST_HEAD(&component->list);
2573 mutex_init(&component->io_mutex);
2575 component->name = fmt_single_name(dev, &component->id);
2576 if (!component->name) {
2577 dev_err(dev, "ASoC: Failed to allocate name\n");
2581 component->dev = dev;
2582 component->driver = driver;
2584 #ifdef CONFIG_DEBUG_FS
2585 if (!component->debugfs_prefix)
2586 component->debugfs_prefix = driver->debugfs_prefix;
2591 EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2593 int snd_soc_add_component(struct snd_soc_component *component,
2594 struct snd_soc_dai_driver *dai_drv,
2600 mutex_lock(&client_mutex);
2602 if (component->driver->endianness) {
2603 for (i = 0; i < num_dai; i++) {
2604 convert_endianness_formats(&dai_drv[i].playback);
2605 convert_endianness_formats(&dai_drv[i].capture);
2609 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2611 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2616 if (!component->driver->write && !component->driver->read) {
2617 if (!component->regmap)
2618 component->regmap = dev_get_regmap(component->dev,
2620 if (component->regmap)
2621 snd_soc_component_setup_regmap(component);
2624 /* see for_each_component */
2625 list_add(&component->list, &component_list);
2629 snd_soc_del_component_unlocked(component);
2631 mutex_unlock(&client_mutex);
2634 snd_soc_try_rebind_card();
2638 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2640 int snd_soc_register_component(struct device *dev,
2641 const struct snd_soc_component_driver *component_driver,
2642 struct snd_soc_dai_driver *dai_drv,
2645 struct snd_soc_component *component;
2648 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2652 ret = snd_soc_component_initialize(component, component_driver, dev);
2656 return snd_soc_add_component(component, dai_drv, num_dai);
2658 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2661 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2662 * from the ASoC core
2664 * @dev: The device to unregister
2665 * @component_driver: The component driver to unregister
2667 void snd_soc_unregister_component_by_driver(struct device *dev,
2668 const struct snd_soc_component_driver *component_driver)
2670 struct snd_soc_component *component;
2672 if (!component_driver)
2675 mutex_lock(&client_mutex);
2676 component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2680 snd_soc_del_component_unlocked(component);
2683 mutex_unlock(&client_mutex);
2685 EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2688 * snd_soc_unregister_component - Unregister all related component
2689 * from the ASoC core
2691 * @dev: The device to unregister
2693 void snd_soc_unregister_component(struct device *dev)
2695 mutex_lock(&client_mutex);
2697 struct snd_soc_component *component = snd_soc_lookup_component_nolocked(dev, NULL);
2702 snd_soc_del_component_unlocked(component);
2704 mutex_unlock(&client_mutex);
2706 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2708 /* Retrieve a card's name from device tree */
2709 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2710 const char *propname)
2712 struct device_node *np;
2716 pr_err("card->dev is not set before calling %s\n", __func__);
2720 np = card->dev->of_node;
2722 ret = of_property_read_string_index(np, propname, 0, &card->name);
2724 * EINVAL means the property does not exist. This is fine providing
2725 * card->name was previously set, which is checked later in
2726 * snd_soc_register_card.
2728 if (ret < 0 && ret != -EINVAL) {
2730 "ASoC: Property '%s' could not be read: %d\n",
2737 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2739 static const struct snd_soc_dapm_widget simple_widgets[] = {
2740 SND_SOC_DAPM_MIC("Microphone", NULL),
2741 SND_SOC_DAPM_LINE("Line", NULL),
2742 SND_SOC_DAPM_HP("Headphone", NULL),
2743 SND_SOC_DAPM_SPK("Speaker", NULL),
2746 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2747 const char *propname)
2749 struct device_node *np = card->dev->of_node;
2750 struct snd_soc_dapm_widget *widgets;
2751 const char *template, *wname;
2752 int i, j, num_widgets;
2754 num_widgets = of_property_count_strings(np, propname);
2755 if (num_widgets < 0) {
2757 "ASoC: Property '%s' does not exist\n", propname);
2761 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2765 if (num_widgets & 1) {
2767 "ASoC: Property '%s' length is not even\n", propname);
2773 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2777 "ASoC: Could not allocate memory for widgets\n");
2781 for (i = 0; i < num_widgets; i++) {
2782 int ret = of_property_read_string_index(np, propname,
2786 "ASoC: Property '%s' index %d read error:%d\n",
2787 propname, 2 * i, ret);
2791 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2792 if (!strncmp(template, simple_widgets[j].name,
2793 strlen(simple_widgets[j].name))) {
2794 widgets[i] = simple_widgets[j];
2799 if (j >= ARRAY_SIZE(simple_widgets)) {
2801 "ASoC: DAPM widget '%s' is not supported\n",
2806 ret = of_property_read_string_index(np, propname,
2811 "ASoC: Property '%s' index %d read error:%d\n",
2812 propname, (2 * i) + 1, ret);
2816 widgets[i].name = wname;
2819 card->of_dapm_widgets = widgets;
2820 card->num_of_dapm_widgets = num_widgets;
2824 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2826 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop)
2828 const unsigned int nb_controls_max = 16;
2829 const char **strings, *control_name;
2830 struct snd_kcontrol_new *controls;
2831 struct device *dev = card->dev;
2832 unsigned int i, nb_controls;
2835 if (!of_property_read_bool(dev->of_node, prop))
2838 strings = devm_kcalloc(dev, nb_controls_max,
2839 sizeof(*strings), GFP_KERNEL);
2843 ret = of_property_read_string_array(dev->of_node, prop,
2844 strings, nb_controls_max);
2848 nb_controls = (unsigned int)ret;
2850 controls = devm_kcalloc(dev, nb_controls,
2851 sizeof(*controls), GFP_KERNEL);
2855 for (i = 0; i < nb_controls; i++) {
2856 control_name = devm_kasprintf(dev, GFP_KERNEL,
2857 "%s Switch", strings[i]);
2861 controls[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
2862 controls[i].name = control_name;
2863 controls[i].info = snd_soc_dapm_info_pin_switch;
2864 controls[i].get = snd_soc_dapm_get_pin_switch;
2865 controls[i].put = snd_soc_dapm_put_pin_switch;
2866 controls[i].private_value = (unsigned long)strings[i];
2869 card->controls = controls;
2870 card->num_controls = nb_controls;
2874 EXPORT_SYMBOL_GPL(snd_soc_of_parse_pin_switches);
2876 int snd_soc_of_get_slot_mask(struct device_node *np,
2877 const char *prop_name,
2881 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2887 for (i = 0; i < val; i++)
2888 if (be32_to_cpup(&of_slot_mask[i]))
2893 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2895 int snd_soc_of_parse_tdm_slot(struct device_node *np,
2896 unsigned int *tx_mask,
2897 unsigned int *rx_mask,
2898 unsigned int *slots,
2899 unsigned int *slot_width)
2905 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2907 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2909 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2910 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2918 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2919 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2929 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2931 void snd_soc_of_parse_node_prefix(struct device_node *np,
2932 struct snd_soc_codec_conf *codec_conf,
2933 struct device_node *of_node,
2934 const char *propname)
2939 ret = of_property_read_string(np, propname, &str);
2941 /* no prefix is not error */
2945 codec_conf->dlc.of_node = of_node;
2946 codec_conf->name_prefix = str;
2948 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2950 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2951 const char *propname)
2953 struct device_node *np = card->dev->of_node;
2955 struct snd_soc_dapm_route *routes;
2958 num_routes = of_property_count_strings(np, propname);
2959 if (num_routes < 0 || num_routes & 1) {
2961 "ASoC: Property '%s' does not exist or its length is not even\n",
2967 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2971 "ASoC: Could not allocate DAPM route table\n");
2975 for (i = 0; i < num_routes; i++) {
2976 int ret = of_property_read_string_index(np, propname,
2977 2 * i, &routes[i].sink);
2980 "ASoC: Property '%s' index %d could not be read: %d\n",
2981 propname, 2 * i, ret);
2984 ret = of_property_read_string_index(np, propname,
2985 (2 * i) + 1, &routes[i].source);
2988 "ASoC: Property '%s' index %d could not be read: %d\n",
2989 propname, (2 * i) + 1, ret);
2994 card->num_of_dapm_routes = num_routes;
2995 card->of_dapm_routes = routes;
2999 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3001 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname)
3003 struct device_node *node = card->dev->of_node;
3004 struct snd_soc_aux_dev *aux;
3007 num = of_count_phandle_with_args(node, propname, NULL);
3008 if (num == -ENOENT) {
3010 } else if (num < 0) {
3011 dev_err(card->dev, "ASOC: Property '%s' could not be read: %d\n",
3016 aux = devm_kcalloc(card->dev, num, sizeof(*aux), GFP_KERNEL);
3019 card->aux_dev = aux;
3020 card->num_aux_devs = num;
3022 for_each_card_pre_auxs(card, i, aux) {
3023 aux->dlc.of_node = of_parse_phandle(node, propname, i);
3024 if (!aux->dlc.of_node)
3030 EXPORT_SYMBOL_GPL(snd_soc_of_parse_aux_devs);
3032 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt)
3034 unsigned int inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
3036 switch (dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
3037 case SND_SOC_DAIFMT_CBP_CFP:
3038 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
3040 case SND_SOC_DAIFMT_CBP_CFC:
3041 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
3043 case SND_SOC_DAIFMT_CBC_CFP:
3044 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
3046 case SND_SOC_DAIFMT_CBC_CFC:
3047 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
3053 EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_flipped);
3055 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame)
3058 * bit_frame is return value from
3059 * snd_soc_daifmt_parse_clock_provider_raw()
3063 switch (bit_frame) {
3065 return SND_SOC_DAIFMT_CBP_CFP;
3067 return SND_SOC_DAIFMT_CBP_CFC;
3069 return SND_SOC_DAIFMT_CBC_CFP;
3071 return SND_SOC_DAIFMT_CBC_CFC;
3076 EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_from_bitmap);
3078 unsigned int snd_soc_daifmt_parse_format(struct device_node *np,
3083 unsigned int format = 0;
3089 } of_fmt_table[] = {
3090 { "i2s", SND_SOC_DAIFMT_I2S },
3091 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
3092 { "left_j", SND_SOC_DAIFMT_LEFT_J },
3093 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
3094 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
3095 { "ac97", SND_SOC_DAIFMT_AC97 },
3096 { "pdm", SND_SOC_DAIFMT_PDM},
3097 { "msb", SND_SOC_DAIFMT_MSB },
3098 { "lsb", SND_SOC_DAIFMT_LSB },
3105 * check "dai-format = xxx"
3106 * or "[prefix]format = xxx"
3107 * SND_SOC_DAIFMT_FORMAT_MASK area
3109 ret = of_property_read_string(np, "dai-format", &str);
3111 snprintf(prop, sizeof(prop), "%sformat", prefix);
3112 ret = of_property_read_string(np, prop, &str);
3117 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3118 if (strcmp(str, of_fmt_table[i].name) == 0) {
3119 format |= of_fmt_table[i].val;
3126 * check "[prefix]continuous-clock"
3127 * SND_SOC_DAIFMT_CLOCK_MASK area
3129 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3130 if (of_property_read_bool(np, prop))
3131 format |= SND_SOC_DAIFMT_CONT;
3133 format |= SND_SOC_DAIFMT_GATED;
3136 * check "[prefix]bitclock-inversion"
3137 * check "[prefix]frame-inversion"
3138 * SND_SOC_DAIFMT_INV_MASK area
3140 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3141 bit = !!of_get_property(np, prop, NULL);
3143 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3144 frame = !!of_get_property(np, prop, NULL);
3146 switch ((bit << 4) + frame) {
3148 format |= SND_SOC_DAIFMT_IB_IF;
3151 format |= SND_SOC_DAIFMT_IB_NF;
3154 format |= SND_SOC_DAIFMT_NB_IF;
3157 /* SND_SOC_DAIFMT_NB_NF is default */
3163 EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_format);
3165 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
3167 struct device_node **bitclkmaster,
3168 struct device_node **framemaster)
3171 unsigned int bit, frame;
3177 * check "[prefix]bitclock-master"
3178 * check "[prefix]frame-master"
3180 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3181 bit = !!of_get_property(np, prop, NULL);
3182 if (bit && bitclkmaster)
3183 *bitclkmaster = of_parse_phandle(np, prop, 0);
3185 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3186 frame = !!of_get_property(np, prop, NULL);
3187 if (frame && framemaster)
3188 *framemaster = of_parse_phandle(np, prop, 0);
3192 * It will be parameter of
3193 * snd_soc_daifmt_clock_provider_from_bitmap()
3195 return (bit << 4) + frame;
3197 EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_clock_provider_raw);
3199 int snd_soc_get_dai_id(struct device_node *ep)
3201 struct snd_soc_component *component;
3202 struct snd_soc_dai_link_component dlc;
3205 dlc.of_node = of_graph_get_port_parent(ep);
3208 * For example HDMI case, HDMI has video/sound port,
3209 * but ALSA SoC needs sound port number only.
3210 * Thus counting HDMI DT port/endpoint doesn't work.
3211 * Then, it should have .of_xlate_dai_id
3214 mutex_lock(&client_mutex);
3215 component = soc_find_component(&dlc);
3217 ret = snd_soc_component_of_xlate_dai_id(component, ep);
3218 mutex_unlock(&client_mutex);
3220 of_node_put(dlc.of_node);
3224 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3226 int snd_soc_get_dai_name(const struct of_phandle_args *args,
3227 const char **dai_name)
3229 struct snd_soc_component *pos;
3230 int ret = -EPROBE_DEFER;
3232 mutex_lock(&client_mutex);
3233 for_each_component(pos) {
3234 struct device_node *component_of_node = soc_component_to_node(pos);
3236 if (component_of_node != args->np || !pos->num_dai)
3239 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3240 if (ret == -ENOTSUPP) {
3241 struct snd_soc_dai *dai;
3244 switch (args->args_count) {
3246 id = 0; /* same as dai_drv[0] */
3256 if (id < 0 || id >= pos->num_dai) {
3263 /* find target DAI */
3264 for_each_component_dais(pos, dai) {
3270 *dai_name = dai->driver->name;
3272 *dai_name = pos->name;
3275 * if another error than ENOTSUPP is returned go on and
3276 * check if another component is provided with the same
3277 * node. This may happen if a device provides several
3285 mutex_unlock(&client_mutex);
3288 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3290 int snd_soc_of_get_dai_name(struct device_node *of_node,
3291 const char **dai_name)
3293 struct of_phandle_args args;
3296 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3297 "#sound-dai-cells", 0, &args);
3301 ret = snd_soc_get_dai_name(&args, dai_name);
3303 of_node_put(args.np);
3307 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3309 static void __snd_soc_of_put_component(struct snd_soc_dai_link_component *component)
3311 if (component->of_node) {
3312 of_node_put(component->of_node);
3313 component->of_node = NULL;
3317 static int __snd_soc_of_get_dai_link_component_alloc(
3318 struct device *dev, struct device_node *of_node,
3319 struct snd_soc_dai_link_component **ret_component,
3322 struct snd_soc_dai_link_component *component;
3325 /* Count the number of CPUs/CODECs */
3326 num = of_count_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells");
3329 dev_err(dev, "No 'sound-dai' property\n");
3331 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3334 component = devm_kcalloc(dev, num, sizeof(*component), GFP_KERNEL);
3338 *ret_component = component;
3344 static int __snd_soc_of_get_dai_link_component_parse(
3345 struct device_node *of_node,
3346 struct snd_soc_dai_link_component *component, int index)
3348 struct of_phandle_args args;
3351 ret = of_parse_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells",
3356 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3360 component->of_node = args.np;
3365 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3366 * @dai_link: DAI link
3368 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3370 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3372 struct snd_soc_dai_link_component *component;
3375 for_each_link_codecs(dai_link, index, component)
3376 __snd_soc_of_put_component(component);
3378 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3381 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3383 * @of_node: Device node
3384 * @dai_link: DAI link
3386 * Builds an array of CODEC DAI components from the DAI link property
3388 * The array is set in the DAI link and the number of DAIs is set accordingly.
3389 * The device nodes in the array (of_node) must be dereferenced by calling
3390 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3392 * Returns 0 for success
3394 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3395 struct device_node *of_node,
3396 struct snd_soc_dai_link *dai_link)
3398 struct snd_soc_dai_link_component *component;
3401 ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3402 &dai_link->codecs, &dai_link->num_codecs);
3406 /* Parse the list */
3407 for_each_link_codecs(dai_link, index, component) {
3408 ret = __snd_soc_of_get_dai_link_component_parse(of_node, component, index);
3414 snd_soc_of_put_dai_link_codecs(dai_link);
3415 dai_link->codecs = NULL;
3416 dai_link->num_codecs = 0;
3419 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3422 * snd_soc_of_put_dai_link_cpus - Dereference device nodes in the codecs array
3423 * @dai_link: DAI link
3425 * Dereference device nodes acquired by snd_soc_of_get_dai_link_cpus().
3427 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link)
3429 struct snd_soc_dai_link_component *component;
3432 for_each_link_cpus(dai_link, index, component)
3433 __snd_soc_of_put_component(component);
3435 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_cpus);
3438 * snd_soc_of_get_dai_link_cpus - Parse a list of CPU DAIs in the devicetree
3440 * @of_node: Device node
3441 * @dai_link: DAI link
3443 * Is analogous to snd_soc_of_get_dai_link_codecs but parses a list of CPU DAIs
3446 * Returns 0 for success
3448 int snd_soc_of_get_dai_link_cpus(struct device *dev,
3449 struct device_node *of_node,
3450 struct snd_soc_dai_link *dai_link)
3452 struct snd_soc_dai_link_component *component;
3455 /* Count the number of CPUs */
3456 ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3457 &dai_link->cpus, &dai_link->num_cpus);
3461 /* Parse the list */
3462 for_each_link_cpus(dai_link, index, component) {
3463 ret = __snd_soc_of_get_dai_link_component_parse(of_node, component, index);
3469 snd_soc_of_put_dai_link_cpus(dai_link);
3470 dai_link->cpus = NULL;
3471 dai_link->num_cpus = 0;
3474 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_cpus);
3476 static int __init snd_soc_init(void)
3480 snd_soc_debugfs_init();
3481 ret = snd_soc_util_init();
3485 ret = platform_driver_register(&soc_driver);
3491 snd_soc_util_exit();
3493 snd_soc_debugfs_exit();
3496 module_init(snd_soc_init);
3498 static void __exit snd_soc_exit(void)
3500 snd_soc_util_exit();
3501 snd_soc_debugfs_exit();
3503 platform_driver_unregister(&soc_driver);
3505 module_exit(snd_soc_exit);
3507 /* Module information */
3508 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3509 MODULE_DESCRIPTION("ALSA SoC Core");
3510 MODULE_LICENSE("GPL");
3511 MODULE_ALIAS("platform:soc-audio");