arm64: bpf: Fix branch offset in JIT
[linux/fpc-iii.git] / sound / soc / soc-core.c
blob9df20768a8f29689afa905d623714b26a05a0af8
1 // SPDX-License-Identifier: GPL-2.0+
2 //
3 // soc-core.c -- ALSA SoC Audio Layer
4 //
5 // Copyright 2005 Wolfson Microelectronics PLC.
6 // Copyright 2005 Openedhand Ltd.
7 // Copyright (C) 2010 Slimlogic Ltd.
8 // Copyright (C) 2010 Texas Instruments Inc.
9 //
10 // Author: Liam Girdwood <lrg@slimlogic.co.uk>
11 // with code, comments and ideas from :-
12 // Richard Purdie <richard@openedhand.com>
14 // TODO:
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>
24 #include <linux/pm.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>
31 #include <linux/of.h>
32 #include <linux/of_graph.h>
33 #include <linux/dmi.h>
34 #include <sound/core.h>
35 #include <sound/jack.h>
36 #include <sound/pcm.h>
37 #include <sound/pcm_params.h>
38 #include <sound/soc.h>
39 #include <sound/soc-dpcm.h>
40 #include <sound/soc-topology.h>
41 #include <sound/initval.h>
43 #define CREATE_TRACE_POINTS
44 #include <trace/events/asoc.h>
46 #define NAME_SIZE 32
48 #ifdef CONFIG_DEBUG_FS
49 struct dentry *snd_soc_debugfs_root;
50 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
51 #endif
53 static DEFINE_MUTEX(client_mutex);
54 static LIST_HEAD(component_list);
55 static LIST_HEAD(unbind_card_list);
57 #define for_each_component(component) \
58 list_for_each_entry(component, &component_list, list)
61 * This is used if driver don't need to have CPU/Codec/Platform
62 * dai_link. see soc.h
64 struct snd_soc_dai_link_component null_dailink_component[0];
65 EXPORT_SYMBOL_GPL(null_dailink_component);
68 * This is a timeout to do a DAPM powerdown after a stream is closed().
69 * It can be used to eliminate pops between different playback streams, e.g.
70 * between two audio tracks.
72 static int pmdown_time = 5000;
73 module_param(pmdown_time, int, 0);
74 MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
76 #ifdef CONFIG_DMI
78 * If a DMI filed contain strings in this blacklist (e.g.
79 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
80 * as invalid and dropped when setting the card long name from DMI info.
82 static const char * const dmi_blacklist[] = {
83 "To be filled by OEM",
84 "TBD by OEM",
85 "Default String",
86 "Board Manufacturer",
87 "Board Vendor Name",
88 "Board Product Name",
89 NULL, /* terminator */
91 #endif
93 static ssize_t pmdown_time_show(struct device *dev,
94 struct device_attribute *attr, char *buf)
96 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
98 return sprintf(buf, "%ld\n", rtd->pmdown_time);
101 static ssize_t pmdown_time_set(struct device *dev,
102 struct device_attribute *attr,
103 const char *buf, size_t count)
105 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
106 int ret;
108 ret = kstrtol(buf, 10, &rtd->pmdown_time);
109 if (ret)
110 return ret;
112 return count;
115 static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
117 static struct attribute *soc_dev_attrs[] = {
118 &dev_attr_pmdown_time.attr,
119 NULL
122 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
123 struct attribute *attr, int idx)
125 struct device *dev = kobj_to_dev(kobj);
126 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
128 if (attr == &dev_attr_pmdown_time.attr)
129 return attr->mode; /* always visible */
130 return rtd->num_codecs ? attr->mode : 0; /* enabled only with codec */
133 static const struct attribute_group soc_dapm_dev_group = {
134 .attrs = soc_dapm_dev_attrs,
135 .is_visible = soc_dev_attr_is_visible,
138 static const struct attribute_group soc_dev_group = {
139 .attrs = soc_dev_attrs,
140 .is_visible = soc_dev_attr_is_visible,
143 static const struct attribute_group *soc_dev_attr_groups[] = {
144 &soc_dapm_dev_group,
145 &soc_dev_group,
146 NULL
149 #ifdef CONFIG_DEBUG_FS
150 static void soc_init_component_debugfs(struct snd_soc_component *component)
152 if (!component->card->debugfs_card_root)
153 return;
155 if (component->debugfs_prefix) {
156 char *name;
158 name = kasprintf(GFP_KERNEL, "%s:%s",
159 component->debugfs_prefix, component->name);
160 if (name) {
161 component->debugfs_root = debugfs_create_dir(name,
162 component->card->debugfs_card_root);
163 kfree(name);
165 } else {
166 component->debugfs_root = debugfs_create_dir(component->name,
167 component->card->debugfs_card_root);
170 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
171 component->debugfs_root);
174 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
176 if (!component->debugfs_root)
177 return;
178 debugfs_remove_recursive(component->debugfs_root);
179 component->debugfs_root = NULL;
182 static int dai_list_show(struct seq_file *m, void *v)
184 struct snd_soc_component *component;
185 struct snd_soc_dai *dai;
187 mutex_lock(&client_mutex);
189 for_each_component(component)
190 for_each_component_dais(component, dai)
191 seq_printf(m, "%s\n", dai->name);
193 mutex_unlock(&client_mutex);
195 return 0;
197 DEFINE_SHOW_ATTRIBUTE(dai_list);
199 static int component_list_show(struct seq_file *m, void *v)
201 struct snd_soc_component *component;
203 mutex_lock(&client_mutex);
205 for_each_component(component)
206 seq_printf(m, "%s\n", component->name);
208 mutex_unlock(&client_mutex);
210 return 0;
212 DEFINE_SHOW_ATTRIBUTE(component_list);
214 static void soc_init_card_debugfs(struct snd_soc_card *card)
216 card->debugfs_card_root = debugfs_create_dir(card->name,
217 snd_soc_debugfs_root);
219 debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
220 &card->pop_time);
222 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
225 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
227 debugfs_remove_recursive(card->debugfs_card_root);
228 card->debugfs_card_root = NULL;
231 static void snd_soc_debugfs_init(void)
233 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
235 debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
236 &dai_list_fops);
238 debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
239 &component_list_fops);
242 static void snd_soc_debugfs_exit(void)
244 debugfs_remove_recursive(snd_soc_debugfs_root);
247 #else
249 static inline void soc_init_component_debugfs(
250 struct snd_soc_component *component)
254 static inline void soc_cleanup_component_debugfs(
255 struct snd_soc_component *component)
259 static inline void soc_init_card_debugfs(struct snd_soc_card *card)
263 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
267 static inline void snd_soc_debugfs_init(void)
271 static inline void snd_soc_debugfs_exit(void)
275 #endif
277 static int snd_soc_rtdcom_add(struct snd_soc_pcm_runtime *rtd,
278 struct snd_soc_component *component)
280 struct snd_soc_rtdcom_list *rtdcom;
282 for_each_rtdcom(rtd, rtdcom) {
283 /* already connected */
284 if (rtdcom->component == component)
285 return 0;
288 rtdcom = kmalloc(sizeof(*rtdcom), GFP_KERNEL);
289 if (!rtdcom)
290 return -ENOMEM;
292 rtdcom->component = component;
293 INIT_LIST_HEAD(&rtdcom->list);
295 list_add_tail(&rtdcom->list, &rtd->component_list);
297 return 0;
300 static void snd_soc_rtdcom_del_all(struct snd_soc_pcm_runtime *rtd)
302 struct snd_soc_rtdcom_list *rtdcom1, *rtdcom2;
304 for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2)
305 kfree(rtdcom1);
307 INIT_LIST_HEAD(&rtd->component_list);
310 struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
311 const char *driver_name)
313 struct snd_soc_rtdcom_list *rtdcom;
315 if (!driver_name)
316 return NULL;
319 * NOTE
321 * snd_soc_rtdcom_lookup() will find component from rtd by using
322 * specified driver name.
323 * But, if many components which have same driver name are connected
324 * to 1 rtd, this function will return 1st found component.
326 for_each_rtdcom(rtd, rtdcom) {
327 const char *component_name = rtdcom->component->driver->name;
329 if (!component_name)
330 continue;
332 if ((component_name == driver_name) ||
333 strcmp(component_name, driver_name) == 0)
334 return rtdcom->component;
337 return NULL;
339 EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
341 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
342 const char *dai_link, int stream)
344 struct snd_soc_pcm_runtime *rtd;
346 for_each_card_rtds(card, rtd) {
347 if (rtd->dai_link->no_pcm &&
348 !strcmp(rtd->dai_link->name, dai_link))
349 return rtd->pcm->streams[stream].substream;
351 dev_dbg(card->dev, "ASoC: failed to find dai link %s\n", dai_link);
352 return NULL;
354 EXPORT_SYMBOL_GPL(snd_soc_get_dai_substream);
356 static const struct snd_soc_ops null_snd_soc_ops;
358 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
359 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
361 struct snd_soc_pcm_runtime *rtd;
363 rtd = kzalloc(sizeof(struct snd_soc_pcm_runtime), GFP_KERNEL);
364 if (!rtd)
365 return NULL;
367 INIT_LIST_HEAD(&rtd->component_list);
368 rtd->card = card;
369 rtd->dai_link = dai_link;
370 if (!rtd->dai_link->ops)
371 rtd->dai_link->ops = &null_snd_soc_ops;
373 rtd->codec_dais = kcalloc(dai_link->num_codecs,
374 sizeof(struct snd_soc_dai *),
375 GFP_KERNEL);
376 if (!rtd->codec_dais) {
377 kfree(rtd);
378 return NULL;
381 return rtd;
384 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
386 kfree(rtd->codec_dais);
387 snd_soc_rtdcom_del_all(rtd);
388 kfree(rtd);
391 static void soc_add_pcm_runtime(struct snd_soc_card *card,
392 struct snd_soc_pcm_runtime *rtd)
394 /* see for_each_card_rtds */
395 list_add_tail(&rtd->list, &card->rtd_list);
396 rtd->num = card->num_rtd;
397 card->num_rtd++;
400 static void soc_remove_pcm_runtimes(struct snd_soc_card *card)
402 struct snd_soc_pcm_runtime *rtd, *_rtd;
404 for_each_card_rtds_safe(card, rtd, _rtd) {
405 list_del(&rtd->list);
406 soc_free_pcm_runtime(rtd);
409 card->num_rtd = 0;
412 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
413 const char *dai_link)
415 struct snd_soc_pcm_runtime *rtd;
417 for_each_card_rtds(card, rtd) {
418 if (!strcmp(rtd->dai_link->name, dai_link))
419 return rtd;
421 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link);
422 return NULL;
424 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
426 static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
428 struct snd_soc_pcm_runtime *rtd;
430 for_each_card_rtds(card, rtd)
431 flush_delayed_work(&rtd->delayed_work);
434 #ifdef CONFIG_PM_SLEEP
435 /* powers down audio subsystem for suspend */
436 int snd_soc_suspend(struct device *dev)
438 struct snd_soc_card *card = dev_get_drvdata(dev);
439 struct snd_soc_component *component;
440 struct snd_soc_pcm_runtime *rtd;
441 int i;
443 /* If the card is not initialized yet there is nothing to do */
444 if (!card->instantiated)
445 return 0;
448 * Due to the resume being scheduled into a workqueue we could
449 * suspend before that's finished - wait for it to complete.
451 snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
453 /* we're going to block userspace touching us until resume completes */
454 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
456 /* mute any active DACs */
457 for_each_card_rtds(card, rtd) {
458 struct snd_soc_dai *dai;
460 if (rtd->dai_link->ignore_suspend)
461 continue;
463 for_each_rtd_codec_dai(rtd, i, dai) {
464 if (dai->playback_active)
465 snd_soc_dai_digital_mute(dai, 1,
466 SNDRV_PCM_STREAM_PLAYBACK);
470 /* suspend all pcms */
471 for_each_card_rtds(card, rtd) {
472 if (rtd->dai_link->ignore_suspend)
473 continue;
475 snd_pcm_suspend_all(rtd->pcm);
478 if (card->suspend_pre)
479 card->suspend_pre(card);
481 for_each_card_rtds(card, rtd) {
482 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
484 if (rtd->dai_link->ignore_suspend)
485 continue;
487 if (!cpu_dai->driver->bus_control)
488 snd_soc_dai_suspend(cpu_dai);
491 /* close any waiting streams */
492 snd_soc_flush_all_delayed_work(card);
494 for_each_card_rtds(card, rtd) {
496 if (rtd->dai_link->ignore_suspend)
497 continue;
499 snd_soc_dapm_stream_event(rtd,
500 SNDRV_PCM_STREAM_PLAYBACK,
501 SND_SOC_DAPM_STREAM_SUSPEND);
503 snd_soc_dapm_stream_event(rtd,
504 SNDRV_PCM_STREAM_CAPTURE,
505 SND_SOC_DAPM_STREAM_SUSPEND);
508 /* Recheck all endpoints too, their state is affected by suspend */
509 dapm_mark_endpoints_dirty(card);
510 snd_soc_dapm_sync(&card->dapm);
512 /* suspend all COMPONENTs */
513 for_each_card_components(card, component) {
514 struct snd_soc_dapm_context *dapm =
515 snd_soc_component_get_dapm(component);
518 * If there are paths active then the COMPONENT will be held
519 * with bias _ON and should not be suspended.
521 if (!snd_soc_component_is_suspended(component)) {
522 switch (snd_soc_dapm_get_bias_level(dapm)) {
523 case SND_SOC_BIAS_STANDBY:
525 * If the COMPONENT is capable of idle
526 * bias off then being in STANDBY
527 * means it's doing something,
528 * otherwise fall through.
530 if (dapm->idle_bias_off) {
531 dev_dbg(component->dev,
532 "ASoC: idle_bias_off CODEC on over suspend\n");
533 break;
535 /* fall through */
537 case SND_SOC_BIAS_OFF:
538 snd_soc_component_suspend(component);
539 if (component->regmap)
540 regcache_mark_dirty(component->regmap);
541 /* deactivate pins to sleep state */
542 pinctrl_pm_select_sleep_state(component->dev);
543 break;
544 default:
545 dev_dbg(component->dev,
546 "ASoC: COMPONENT is on over suspend\n");
547 break;
552 for_each_card_rtds(card, rtd) {
553 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
555 if (rtd->dai_link->ignore_suspend)
556 continue;
558 if (cpu_dai->driver->bus_control)
559 snd_soc_dai_suspend(cpu_dai);
561 /* deactivate pins to sleep state */
562 pinctrl_pm_select_sleep_state(cpu_dai->dev);
565 if (card->suspend_post)
566 card->suspend_post(card);
568 return 0;
570 EXPORT_SYMBOL_GPL(snd_soc_suspend);
573 * deferred resume work, so resume can complete before we finished
574 * setting our codec back up, which can be very slow on I2C
576 static void soc_resume_deferred(struct work_struct *work)
578 struct snd_soc_card *card =
579 container_of(work, struct snd_soc_card,
580 deferred_resume_work);
581 struct snd_soc_pcm_runtime *rtd;
582 struct snd_soc_component *component;
583 int i;
586 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
587 * so userspace apps are blocked from touching us
590 dev_dbg(card->dev, "ASoC: starting resume work\n");
592 /* Bring us up into D2 so that DAPM starts enabling things */
593 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
595 if (card->resume_pre)
596 card->resume_pre(card);
598 /* resume control bus DAIs */
599 for_each_card_rtds(card, rtd) {
600 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
602 if (rtd->dai_link->ignore_suspend)
603 continue;
605 if (cpu_dai->driver->bus_control)
606 snd_soc_dai_resume(cpu_dai);
609 for_each_card_components(card, component) {
610 if (snd_soc_component_is_suspended(component))
611 snd_soc_component_resume(component);
614 for_each_card_rtds(card, rtd) {
616 if (rtd->dai_link->ignore_suspend)
617 continue;
619 snd_soc_dapm_stream_event(rtd,
620 SNDRV_PCM_STREAM_PLAYBACK,
621 SND_SOC_DAPM_STREAM_RESUME);
623 snd_soc_dapm_stream_event(rtd,
624 SNDRV_PCM_STREAM_CAPTURE,
625 SND_SOC_DAPM_STREAM_RESUME);
628 /* unmute any active DACs */
629 for_each_card_rtds(card, rtd) {
630 struct snd_soc_dai *dai;
632 if (rtd->dai_link->ignore_suspend)
633 continue;
635 for_each_rtd_codec_dai(rtd, i, dai) {
636 if (dai->playback_active)
637 snd_soc_dai_digital_mute(dai, 0,
638 SNDRV_PCM_STREAM_PLAYBACK);
642 for_each_card_rtds(card, rtd) {
643 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
645 if (rtd->dai_link->ignore_suspend)
646 continue;
648 if (!cpu_dai->driver->bus_control)
649 snd_soc_dai_resume(cpu_dai);
652 if (card->resume_post)
653 card->resume_post(card);
655 dev_dbg(card->dev, "ASoC: resume work completed\n");
657 /* Recheck all endpoints too, their state is affected by suspend */
658 dapm_mark_endpoints_dirty(card);
659 snd_soc_dapm_sync(&card->dapm);
661 /* userspace can access us now we are back as we were before */
662 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
665 /* powers up audio subsystem after a suspend */
666 int snd_soc_resume(struct device *dev)
668 struct snd_soc_card *card = dev_get_drvdata(dev);
669 bool bus_control = false;
670 struct snd_soc_pcm_runtime *rtd;
671 struct snd_soc_dai *codec_dai;
672 int i;
674 /* If the card is not initialized yet there is nothing to do */
675 if (!card->instantiated)
676 return 0;
678 /* activate pins from sleep state */
679 for_each_card_rtds(card, rtd) {
680 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
682 if (cpu_dai->active)
683 pinctrl_pm_select_default_state(cpu_dai->dev);
685 for_each_rtd_codec_dai(rtd, i, codec_dai) {
686 if (codec_dai->active)
687 pinctrl_pm_select_default_state(codec_dai->dev);
692 * DAIs that also act as the control bus master might have other drivers
693 * hanging off them so need to resume immediately. Other drivers don't
694 * have that problem and may take a substantial amount of time to resume
695 * due to I/O costs and anti-pop so handle them out of line.
697 for_each_card_rtds(card, rtd) {
698 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
700 bus_control |= cpu_dai->driver->bus_control;
702 if (bus_control) {
703 dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
704 soc_resume_deferred(&card->deferred_resume_work);
705 } else {
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");
711 return 0;
713 EXPORT_SYMBOL_GPL(snd_soc_resume);
715 static void soc_resume_init(struct snd_soc_card *card)
717 /* deferred resume work */
718 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
720 #else
721 #define snd_soc_suspend NULL
722 #define snd_soc_resume NULL
723 static inline void soc_resume_init(struct snd_soc_card *card)
726 #endif
728 static const struct snd_soc_dai_ops null_dai_ops = {
731 static struct device_node
732 *soc_component_to_node(struct snd_soc_component *component)
734 struct device_node *of_node;
736 of_node = component->dev->of_node;
737 if (!of_node && component->dev->parent)
738 of_node = component->dev->parent->of_node;
740 return of_node;
743 static int snd_soc_is_matching_component(
744 const struct snd_soc_dai_link_component *dlc,
745 struct snd_soc_component *component)
747 struct device_node *component_of_node;
749 if (!dlc)
750 return 0;
752 component_of_node = soc_component_to_node(component);
754 if (dlc->of_node && component_of_node != dlc->of_node)
755 return 0;
756 if (dlc->name && strcmp(component->name, dlc->name))
757 return 0;
759 return 1;
762 static struct snd_soc_component *soc_find_component(
763 const struct snd_soc_dai_link_component *dlc)
765 struct snd_soc_component *component;
767 lockdep_assert_held(&client_mutex);
770 * NOTE
772 * It returns *1st* found component, but some driver
773 * has few components by same of_node/name
774 * ex)
775 * CPU component and generic DMAEngine component
777 for_each_component(component)
778 if (snd_soc_is_matching_component(dlc, component))
779 return component;
781 return NULL;
785 * snd_soc_find_dai - Find a registered DAI
787 * @dlc: name of the DAI or the DAI driver and optional component info to match
789 * This function will search all registered components and their DAIs to
790 * find the DAI of the same name. The component's of_node and name
791 * should also match if being specified.
793 * Return: pointer of DAI, or NULL if not found.
795 struct snd_soc_dai *snd_soc_find_dai(
796 const struct snd_soc_dai_link_component *dlc)
798 struct snd_soc_component *component;
799 struct snd_soc_dai *dai;
801 lockdep_assert_held(&client_mutex);
803 /* Find CPU DAI from registered DAIs */
804 for_each_component(component) {
805 if (!snd_soc_is_matching_component(dlc, component))
806 continue;
807 for_each_component_dais(component, dai) {
808 if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
809 && (!dai->driver->name
810 || strcmp(dai->driver->name, dlc->dai_name)))
811 continue;
813 return dai;
817 return NULL;
819 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
822 * snd_soc_find_dai_link - Find a DAI link
824 * @card: soc card
825 * @id: DAI link ID to match
826 * @name: DAI link name to match, optional
827 * @stream_name: DAI link stream name to match, optional
829 * This function will search all existing DAI links of the soc card to
830 * find the link of the same ID. Since DAI links may not have their
831 * unique ID, so name and stream name should also match if being
832 * specified.
834 * Return: pointer of DAI link, or NULL if not found.
836 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
837 int id, const char *name,
838 const char *stream_name)
840 struct snd_soc_dai_link *link;
842 lockdep_assert_held(&client_mutex);
844 for_each_card_links(card, link) {
845 if (link->id != id)
846 continue;
848 if (name && (!link->name || strcmp(name, link->name)))
849 continue;
851 if (stream_name && (!link->stream_name
852 || strcmp(stream_name, link->stream_name)))
853 continue;
855 return link;
858 return NULL;
860 EXPORT_SYMBOL_GPL(snd_soc_find_dai_link);
862 static bool soc_is_dai_link_bound(struct snd_soc_card *card,
863 struct snd_soc_dai_link *dai_link)
865 struct snd_soc_pcm_runtime *rtd;
867 for_each_card_rtds(card, rtd) {
868 if (rtd->dai_link == dai_link)
869 return true;
872 return false;
875 static int soc_bind_dai_link(struct snd_soc_card *card,
876 struct snd_soc_dai_link *dai_link)
878 struct snd_soc_pcm_runtime *rtd;
879 struct snd_soc_dai_link_component *codec, *platform;
880 struct snd_soc_component *component;
881 int i;
883 if (dai_link->ignore)
884 return 0;
886 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
888 if (soc_is_dai_link_bound(card, dai_link)) {
889 dev_dbg(card->dev, "ASoC: dai link %s already bound\n",
890 dai_link->name);
891 return 0;
894 rtd = soc_new_pcm_runtime(card, dai_link);
895 if (!rtd)
896 return -ENOMEM;
898 /* FIXME: we need multi CPU support in the future */
899 rtd->cpu_dai = snd_soc_find_dai(dai_link->cpus);
900 if (!rtd->cpu_dai) {
901 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
902 dai_link->cpus->dai_name);
903 goto _err_defer;
905 snd_soc_rtdcom_add(rtd, rtd->cpu_dai->component);
907 /* Find CODEC from registered CODECs */
908 rtd->num_codecs = dai_link->num_codecs;
909 for_each_link_codecs(dai_link, i, codec) {
910 rtd->codec_dais[i] = snd_soc_find_dai(codec);
911 if (!rtd->codec_dais[i]) {
912 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
913 codec->dai_name);
914 goto _err_defer;
917 snd_soc_rtdcom_add(rtd, rtd->codec_dais[i]->component);
920 /* Single codec links expect codec and codec_dai in runtime data */
921 rtd->codec_dai = rtd->codec_dais[0];
923 /* Find PLATFORM from registered PLATFORMs */
924 for_each_link_platforms(dai_link, i, platform) {
925 for_each_component(component) {
926 if (!snd_soc_is_matching_component(platform, component))
927 continue;
929 snd_soc_rtdcom_add(rtd, component);
933 soc_add_pcm_runtime(card, rtd);
934 return 0;
936 _err_defer:
937 soc_free_pcm_runtime(rtd);
938 return -EPROBE_DEFER;
941 static void soc_set_of_name_prefix(struct snd_soc_component *component)
943 struct device_node *of_node = soc_component_to_node(component);
944 const char *str;
945 int ret;
947 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
948 if (!ret)
949 component->name_prefix = str;
952 static void soc_set_name_prefix(struct snd_soc_card *card,
953 struct snd_soc_component *component)
955 int i;
957 for (i = 0; i < card->num_configs && card->codec_conf; i++) {
958 struct snd_soc_codec_conf *map = &card->codec_conf[i];
959 struct device_node *of_node = soc_component_to_node(component);
961 if (map->of_node && of_node != map->of_node)
962 continue;
963 if (map->dev_name && strcmp(component->name, map->dev_name))
964 continue;
965 component->name_prefix = map->name_prefix;
966 return;
970 * If there is no configuration table or no match in the table,
971 * check if a prefix is provided in the node
973 soc_set_of_name_prefix(component);
976 static void soc_cleanup_component(struct snd_soc_component *component)
978 /* For framework level robustness */
979 snd_soc_component_set_jack(component, NULL, NULL);
981 list_del_init(&component->card_list);
982 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
983 soc_cleanup_component_debugfs(component);
984 component->card = NULL;
985 snd_soc_component_module_put_when_remove(component);
988 static void soc_remove_component(struct snd_soc_component *component)
990 if (!component->card)
991 return;
993 snd_soc_component_remove(component);
995 soc_cleanup_component(component);
998 static int soc_probe_component(struct snd_soc_card *card,
999 struct snd_soc_component *component)
1001 struct snd_soc_dapm_context *dapm =
1002 snd_soc_component_get_dapm(component);
1003 struct snd_soc_dai *dai;
1004 int ret;
1006 if (!strcmp(component->name, "snd-soc-dummy"))
1007 return 0;
1009 if (component->card) {
1010 if (component->card != card) {
1011 dev_err(component->dev,
1012 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1013 card->name, component->card->name);
1014 return -ENODEV;
1016 return 0;
1019 ret = snd_soc_component_module_get_when_probe(component);
1020 if (ret < 0)
1021 return ret;
1023 component->card = card;
1024 soc_set_name_prefix(card, component);
1026 soc_init_component_debugfs(component);
1028 snd_soc_dapm_init(dapm, card, component);
1030 ret = snd_soc_dapm_new_controls(dapm,
1031 component->driver->dapm_widgets,
1032 component->driver->num_dapm_widgets);
1034 if (ret != 0) {
1035 dev_err(component->dev,
1036 "Failed to create new controls %d\n", ret);
1037 goto err_probe;
1040 for_each_component_dais(component, dai) {
1041 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1042 if (ret != 0) {
1043 dev_err(component->dev,
1044 "Failed to create DAI widgets %d\n", ret);
1045 goto err_probe;
1049 ret = snd_soc_component_probe(component);
1050 if (ret < 0) {
1051 dev_err(component->dev,
1052 "ASoC: failed to probe component %d\n", ret);
1053 goto err_probe;
1055 WARN(dapm->idle_bias_off &&
1056 dapm->bias_level != SND_SOC_BIAS_OFF,
1057 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1058 component->name);
1060 /* machine specific init */
1061 if (component->init) {
1062 ret = component->init(component);
1063 if (ret < 0) {
1064 dev_err(component->dev,
1065 "Failed to do machine specific init %d\n", ret);
1066 goto err_probe;
1070 ret = snd_soc_add_component_controls(component,
1071 component->driver->controls,
1072 component->driver->num_controls);
1073 if (ret < 0)
1074 goto err_probe;
1076 ret = snd_soc_dapm_add_routes(dapm,
1077 component->driver->dapm_routes,
1078 component->driver->num_dapm_routes);
1079 if (ret < 0) {
1080 if (card->disable_route_checks) {
1081 dev_info(card->dev,
1082 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1083 __func__);
1084 } else {
1085 dev_err(card->dev,
1086 "%s: snd_soc_dapm_add_routes failed: %d\n",
1087 __func__, ret);
1088 goto err_probe;
1092 /* see for_each_card_components */
1093 list_add(&component->card_list, &card->component_dev_list);
1095 err_probe:
1096 if (ret < 0)
1097 soc_cleanup_component(component);
1099 return ret;
1102 static void soc_remove_dai(struct snd_soc_dai *dai, int order)
1104 int err;
1106 if (!dai || !dai->probed || !dai->driver ||
1107 dai->driver->remove_order != order)
1108 return;
1110 err = snd_soc_dai_remove(dai);
1111 if (err < 0)
1112 dev_err(dai->dev,
1113 "ASoC: failed to remove %s: %d\n",
1114 dai->name, err);
1116 dai->probed = 0;
1119 static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1121 int ret;
1123 if (dai->probed ||
1124 dai->driver->probe_order != order)
1125 return 0;
1127 ret = snd_soc_dai_probe(dai);
1128 if (ret < 0) {
1129 dev_err(dai->dev, "ASoC: failed to probe DAI %s: %d\n",
1130 dai->name, ret);
1131 return ret;
1134 dai->probed = 1;
1136 return 0;
1139 static void soc_rtd_free(struct snd_soc_pcm_runtime *rtd); /* remove me */
1140 static void soc_remove_link_dais(struct snd_soc_card *card)
1142 int i;
1143 struct snd_soc_dai *codec_dai;
1144 struct snd_soc_pcm_runtime *rtd;
1145 int order;
1147 for_each_comp_order(order) {
1148 for_each_card_rtds(card, rtd) {
1150 /* finalize rtd device */
1151 soc_rtd_free(rtd);
1153 /* remove the CODEC DAI */
1154 for_each_rtd_codec_dai(rtd, i, codec_dai)
1155 soc_remove_dai(codec_dai, order);
1157 soc_remove_dai(rtd->cpu_dai, order);
1162 static int soc_probe_link_dais(struct snd_soc_card *card)
1164 struct snd_soc_dai *codec_dai;
1165 struct snd_soc_pcm_runtime *rtd;
1166 int i, order, ret;
1168 for_each_comp_order(order) {
1169 for_each_card_rtds(card, rtd) {
1171 dev_dbg(card->dev,
1172 "ASoC: probe %s dai link %d late %d\n",
1173 card->name, rtd->num, order);
1175 ret = soc_probe_dai(rtd->cpu_dai, order);
1176 if (ret)
1177 return ret;
1179 /* probe the CODEC DAI */
1180 for_each_rtd_codec_dai(rtd, i, codec_dai) {
1181 ret = soc_probe_dai(codec_dai, order);
1182 if (ret)
1183 return ret;
1188 return 0;
1191 static void soc_remove_link_components(struct snd_soc_card *card)
1193 struct snd_soc_component *component;
1194 struct snd_soc_pcm_runtime *rtd;
1195 struct snd_soc_rtdcom_list *rtdcom;
1196 int order;
1198 for_each_comp_order(order) {
1199 for_each_card_rtds(card, rtd) {
1200 for_each_rtdcom(rtd, rtdcom) {
1201 component = rtdcom->component;
1203 if (component->driver->remove_order != order)
1204 continue;
1206 soc_remove_component(component);
1212 static int soc_probe_link_components(struct snd_soc_card *card)
1214 struct snd_soc_component *component;
1215 struct snd_soc_pcm_runtime *rtd;
1216 struct snd_soc_rtdcom_list *rtdcom;
1217 int ret, order;
1219 for_each_comp_order(order) {
1220 for_each_card_rtds(card, rtd) {
1221 for_each_rtdcom(rtd, rtdcom) {
1222 component = rtdcom->component;
1224 if (component->driver->probe_order != order)
1225 continue;
1227 ret = soc_probe_component(card, component);
1228 if (ret < 0)
1229 return ret;
1234 return 0;
1237 static void soc_remove_dai_links(struct snd_soc_card *card)
1239 struct snd_soc_dai_link *link, *_link;
1241 soc_remove_link_dais(card);
1243 soc_remove_link_components(card);
1245 for_each_card_links_safe(card, link, _link) {
1246 if (link->dobj.type == SND_SOC_DOBJ_DAI_LINK)
1247 dev_warn(card->dev, "Topology forgot to remove link %s?\n",
1248 link->name);
1250 list_del(&link->list);
1254 static int soc_init_dai_link(struct snd_soc_card *card,
1255 struct snd_soc_dai_link *link)
1257 int i;
1258 struct snd_soc_dai_link_component *codec, *platform;
1260 for_each_link_codecs(link, i, codec) {
1262 * Codec must be specified by 1 of name or OF node,
1263 * not both or neither.
1265 if (!!codec->name == !!codec->of_node) {
1266 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
1267 link->name);
1268 return -EINVAL;
1271 /* Codec DAI name must be specified */
1272 if (!codec->dai_name) {
1273 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
1274 link->name);
1275 return -EINVAL;
1279 * Defer card registration if codec component is not added to
1280 * component list.
1282 if (!soc_find_component(codec))
1283 return -EPROBE_DEFER;
1286 for_each_link_platforms(link, i, platform) {
1288 * Platform may be specified by either name or OF node, but it
1289 * can be left unspecified, then no components will be inserted
1290 * in the rtdcom list
1292 if (!!platform->name == !!platform->of_node) {
1293 dev_err(card->dev,
1294 "ASoC: Neither/both platform name/of_node are set for %s\n",
1295 link->name);
1296 return -EINVAL;
1300 * Defer card registration if platform component is not added to
1301 * component list.
1303 if (!soc_find_component(platform))
1304 return -EPROBE_DEFER;
1307 /* FIXME */
1308 if (link->num_cpus > 1) {
1309 dev_err(card->dev,
1310 "ASoC: multi cpu is not yet supported %s\n",
1311 link->name);
1312 return -EINVAL;
1316 * CPU device may be specified by either name or OF node, but
1317 * can be left unspecified, and will be matched based on DAI
1318 * name alone..
1320 if (link->cpus->name && link->cpus->of_node) {
1321 dev_err(card->dev,
1322 "ASoC: Neither/both cpu name/of_node are set for %s\n",
1323 link->name);
1324 return -EINVAL;
1328 * Defer card registartion if cpu dai component is not added to
1329 * component list.
1331 if ((link->cpus->of_node || link->cpus->name) &&
1332 !soc_find_component(link->cpus))
1333 return -EPROBE_DEFER;
1336 * At least one of CPU DAI name or CPU device name/node must be
1337 * specified
1339 if (!link->cpus->dai_name &&
1340 !(link->cpus->name || link->cpus->of_node)) {
1341 dev_err(card->dev,
1342 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1343 link->name);
1344 return -EINVAL;
1347 return 0;
1350 void snd_soc_disconnect_sync(struct device *dev)
1352 struct snd_soc_component *component =
1353 snd_soc_lookup_component(dev, NULL);
1355 if (!component || !component->card)
1356 return;
1358 snd_card_disconnect_sync(component->card->snd_card);
1360 EXPORT_SYMBOL_GPL(snd_soc_disconnect_sync);
1363 * snd_soc_add_dai_link - Add a DAI link dynamically
1364 * @card: The ASoC card to which the DAI link is added
1365 * @dai_link: The new DAI link to add
1367 * This function adds a DAI link to the ASoC card's link list.
1369 * Note: Topology can use this API to add DAI links when probing the
1370 * topology component. And machine drivers can still define static
1371 * DAI links in dai_link array.
1373 int snd_soc_add_dai_link(struct snd_soc_card *card,
1374 struct snd_soc_dai_link *dai_link)
1376 if (dai_link->dobj.type
1377 && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1378 dev_err(card->dev, "Invalid dai link type %d\n",
1379 dai_link->dobj.type);
1380 return -EINVAL;
1383 lockdep_assert_held(&client_mutex);
1385 * Notify the machine driver for extra initialization
1386 * on the link created by topology.
1388 if (dai_link->dobj.type && card->add_dai_link)
1389 card->add_dai_link(card, dai_link);
1391 /* see for_each_card_links */
1392 list_add_tail(&dai_link->list, &card->dai_link_list);
1394 return 0;
1396 EXPORT_SYMBOL_GPL(snd_soc_add_dai_link);
1399 * snd_soc_remove_dai_link - Remove a DAI link from the list
1400 * @card: The ASoC card that owns the link
1401 * @dai_link: The DAI link to remove
1403 * This function removes a DAI link from the ASoC card's link list.
1405 * For DAI links previously added by topology, topology should
1406 * remove them by using the dobj embedded in the link.
1408 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1409 struct snd_soc_dai_link *dai_link)
1411 if (dai_link->dobj.type
1412 && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1413 dev_err(card->dev, "Invalid dai link type %d\n",
1414 dai_link->dobj.type);
1415 return;
1418 lockdep_assert_held(&client_mutex);
1420 * Notify the machine driver for extra destruction
1421 * on the link created by topology.
1423 if (dai_link->dobj.type && card->remove_dai_link)
1424 card->remove_dai_link(card, dai_link);
1426 list_del(&dai_link->list);
1428 EXPORT_SYMBOL_GPL(snd_soc_remove_dai_link);
1430 static void soc_rtd_free(struct snd_soc_pcm_runtime *rtd)
1432 if (rtd->dev_registered) {
1433 /* we don't need to call kfree() for rtd->dev */
1434 device_unregister(rtd->dev);
1435 rtd->dev_registered = 0;
1439 static void soc_rtd_release(struct device *dev)
1441 kfree(dev);
1444 static int soc_rtd_init(struct snd_soc_pcm_runtime *rtd, const char *name)
1446 int ret = 0;
1448 /* register the rtd device */
1449 rtd->dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1450 if (!rtd->dev)
1451 return -ENOMEM;
1452 rtd->dev->parent = rtd->card->dev;
1453 rtd->dev->release = soc_rtd_release;
1454 rtd->dev->groups = soc_dev_attr_groups;
1455 dev_set_name(rtd->dev, "%s", name);
1456 dev_set_drvdata(rtd->dev, rtd);
1457 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
1458 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
1459 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
1460 INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
1461 ret = device_register(rtd->dev);
1462 if (ret < 0) {
1463 /* calling put_device() here to free the rtd->dev */
1464 put_device(rtd->dev);
1465 dev_err(rtd->card->dev,
1466 "ASoC: failed to register runtime device: %d\n", ret);
1467 return ret;
1469 rtd->dev_registered = 1;
1470 return 0;
1473 static int soc_link_dai_pcm_new(struct snd_soc_dai **dais, int num_dais,
1474 struct snd_soc_pcm_runtime *rtd)
1476 int i, ret = 0;
1478 for (i = 0; i < num_dais; ++i) {
1479 struct snd_soc_dai_driver *drv = dais[i]->driver;
1481 if (drv->pcm_new)
1482 ret = drv->pcm_new(rtd, dais[i]);
1483 if (ret < 0) {
1484 dev_err(dais[i]->dev,
1485 "ASoC: Failed to bind %s with pcm device\n",
1486 dais[i]->name);
1487 return ret;
1491 return 0;
1494 static int soc_link_init(struct snd_soc_card *card,
1495 struct snd_soc_pcm_runtime *rtd)
1497 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1498 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1499 struct snd_soc_rtdcom_list *rtdcom;
1500 struct snd_soc_component *component;
1501 int ret, num;
1503 /* set default power off timeout */
1504 rtd->pmdown_time = pmdown_time;
1506 /* do machine specific initialization */
1507 if (dai_link->init) {
1508 ret = dai_link->init(rtd);
1509 if (ret < 0) {
1510 dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1511 dai_link->name, ret);
1512 return ret;
1516 if (dai_link->dai_fmt) {
1517 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1518 if (ret)
1519 return ret;
1522 ret = soc_rtd_init(rtd, dai_link->name);
1523 if (ret)
1524 return ret;
1526 /* add DPCM sysfs entries */
1527 soc_dpcm_debugfs_add(rtd);
1529 num = rtd->num;
1532 * most drivers will register their PCMs using DAI link ordering but
1533 * topology based drivers can use the DAI link id field to set PCM
1534 * device number and then use rtd + a base offset of the BEs.
1536 for_each_rtdcom(rtd, rtdcom) {
1537 component = rtdcom->component;
1539 if (!component->driver->use_dai_pcm_id)
1540 continue;
1542 if (rtd->dai_link->no_pcm)
1543 num += component->driver->be_pcm_base;
1544 else
1545 num = rtd->dai_link->id;
1548 /* create compress_device if possible */
1549 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1550 if (ret != -ENOTSUPP) {
1551 if (ret < 0)
1552 dev_err(card->dev, "ASoC: can't create compress %s\n",
1553 dai_link->stream_name);
1554 return ret;
1557 /* create the pcm */
1558 ret = soc_new_pcm(rtd, num);
1559 if (ret < 0) {
1560 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1561 dai_link->stream_name, ret);
1562 return ret;
1564 ret = soc_link_dai_pcm_new(&cpu_dai, 1, rtd);
1565 if (ret < 0)
1566 return ret;
1567 ret = soc_link_dai_pcm_new(rtd->codec_dais,
1568 rtd->num_codecs, rtd);
1569 return ret;
1572 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1574 struct snd_soc_component *component, *_component;
1576 for_each_card_auxs_safe(card, component, _component) {
1577 component->init = NULL;
1578 list_del(&component->card_aux_list);
1582 static int soc_bind_aux_dev(struct snd_soc_card *card)
1584 struct snd_soc_component *component;
1585 struct snd_soc_aux_dev *aux;
1586 int i;
1588 for_each_card_pre_auxs(card, i, aux) {
1589 /* codecs, usually analog devices */
1590 component = soc_find_component(&aux->dlc);
1591 if (!component)
1592 return -EPROBE_DEFER;
1594 component->init = aux->init;
1595 /* see for_each_card_auxs */
1596 list_add(&component->card_aux_list, &card->aux_comp_list);
1598 return 0;
1601 static int soc_probe_aux_devices(struct snd_soc_card *card)
1603 struct snd_soc_component *comp;
1604 int order;
1605 int ret;
1607 for_each_comp_order(order) {
1608 for_each_card_auxs(card, comp) {
1609 if (comp->driver->probe_order == order) {
1610 ret = soc_probe_component(card, comp);
1611 if (ret < 0) {
1612 dev_err(card->dev,
1613 "ASoC: failed to probe aux component %s %d\n",
1614 comp->name, ret);
1615 return ret;
1621 return 0;
1624 static void soc_remove_aux_devices(struct snd_soc_card *card)
1626 struct snd_soc_component *comp, *_comp;
1627 int order;
1629 for_each_comp_order(order) {
1630 for_each_card_auxs_safe(card, comp, _comp) {
1631 if (comp->driver->remove_order == order)
1632 soc_remove_component(comp);
1638 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1639 * @rtd: The runtime for which the DAI link format should be changed
1640 * @dai_fmt: The new DAI link format
1642 * This function updates the DAI link format for all DAIs connected to the DAI
1643 * link for the specified runtime.
1645 * Note: For setups with a static format set the dai_fmt field in the
1646 * corresponding snd_dai_link struct instead of using this function.
1648 * Returns 0 on success, otherwise a negative error code.
1650 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1651 unsigned int dai_fmt)
1653 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1654 struct snd_soc_dai *codec_dai;
1655 unsigned int i;
1656 int ret;
1658 for_each_rtd_codec_dai(rtd, i, codec_dai) {
1659 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1660 if (ret != 0 && ret != -ENOTSUPP) {
1661 dev_warn(codec_dai->dev,
1662 "ASoC: Failed to set DAI format: %d\n", ret);
1663 return ret;
1668 * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1669 * the component which has non_legacy_dai_naming is Codec
1671 if (cpu_dai->component->driver->non_legacy_dai_naming) {
1672 unsigned int inv_dai_fmt;
1674 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1675 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1676 case SND_SOC_DAIFMT_CBM_CFM:
1677 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1678 break;
1679 case SND_SOC_DAIFMT_CBM_CFS:
1680 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1681 break;
1682 case SND_SOC_DAIFMT_CBS_CFM:
1683 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1684 break;
1685 case SND_SOC_DAIFMT_CBS_CFS:
1686 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1687 break;
1690 dai_fmt = inv_dai_fmt;
1693 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1694 if (ret != 0 && ret != -ENOTSUPP) {
1695 dev_warn(cpu_dai->dev,
1696 "ASoC: Failed to set DAI format: %d\n", ret);
1697 return ret;
1700 return 0;
1702 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1704 #ifdef CONFIG_DMI
1706 * Trim special characters, and replace '-' with '_' since '-' is used to
1707 * separate different DMI fields in the card long name. Only number and
1708 * alphabet characters and a few separator characters are kept.
1710 static void cleanup_dmi_name(char *name)
1712 int i, j = 0;
1714 for (i = 0; name[i]; i++) {
1715 if (isalnum(name[i]) || (name[i] == '.')
1716 || (name[i] == '_'))
1717 name[j++] = name[i];
1718 else if (name[i] == '-')
1719 name[j++] = '_';
1722 name[j] = '\0';
1726 * Check if a DMI field is valid, i.e. not containing any string
1727 * in the black list.
1729 static int is_dmi_valid(const char *field)
1731 int i = 0;
1733 while (dmi_blacklist[i]) {
1734 if (strstr(field, dmi_blacklist[i]))
1735 return 0;
1736 i++;
1739 return 1;
1743 * snd_soc_set_dmi_name() - Register DMI names to card
1744 * @card: The card to register DMI names
1745 * @flavour: The flavour "differentiator" for the card amongst its peers.
1747 * An Intel machine driver may be used by many different devices but are
1748 * difficult for userspace to differentiate, since machine drivers ususally
1749 * use their own name as the card short name and leave the card long name
1750 * blank. To differentiate such devices and fix bugs due to lack of
1751 * device-specific configurations, this function allows DMI info to be used
1752 * as the sound card long name, in the format of
1753 * "vendor-product-version-board"
1754 * (Character '-' is used to separate different DMI fields here).
1755 * This will help the user space to load the device-specific Use Case Manager
1756 * (UCM) configurations for the card.
1758 * Possible card long names may be:
1759 * DellInc.-XPS139343-01-0310JH
1760 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1761 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1763 * This function also supports flavoring the card longname to provide
1764 * the extra differentiation, like "vendor-product-version-board-flavor".
1766 * We only keep number and alphabet characters and a few separator characters
1767 * in the card long name since UCM in the user space uses the card long names
1768 * as card configuration directory names and AudoConf cannot support special
1769 * charactors like SPACE.
1771 * Returns 0 on success, otherwise a negative error code.
1773 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1775 const char *vendor, *product, *product_version, *board;
1776 size_t longname_buf_size = sizeof(card->snd_card->longname);
1777 size_t len;
1779 if (card->long_name)
1780 return 0; /* long name already set by driver or from DMI */
1782 /* make up dmi long name as: vendor.product.version.board */
1783 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1784 if (!vendor || !is_dmi_valid(vendor)) {
1785 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1786 return 0;
1789 snprintf(card->dmi_longname, sizeof(card->snd_card->longname),
1790 "%s", vendor);
1791 cleanup_dmi_name(card->dmi_longname);
1793 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1794 if (product && is_dmi_valid(product)) {
1795 len = strlen(card->dmi_longname);
1796 snprintf(card->dmi_longname + len,
1797 longname_buf_size - len,
1798 "-%s", product);
1800 len++; /* skip the separator "-" */
1801 if (len < longname_buf_size)
1802 cleanup_dmi_name(card->dmi_longname + len);
1805 * some vendors like Lenovo may only put a self-explanatory
1806 * name in the product version field
1808 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1809 if (product_version && is_dmi_valid(product_version)) {
1810 len = strlen(card->dmi_longname);
1811 snprintf(card->dmi_longname + len,
1812 longname_buf_size - len,
1813 "-%s", product_version);
1815 len++;
1816 if (len < longname_buf_size)
1817 cleanup_dmi_name(card->dmi_longname + len);
1821 board = dmi_get_system_info(DMI_BOARD_NAME);
1822 if (board && is_dmi_valid(board)) {
1823 len = strlen(card->dmi_longname);
1824 snprintf(card->dmi_longname + len,
1825 longname_buf_size - len,
1826 "-%s", board);
1828 len++;
1829 if (len < longname_buf_size)
1830 cleanup_dmi_name(card->dmi_longname + len);
1831 } else if (!product) {
1832 /* fall back to using legacy name */
1833 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1834 return 0;
1837 /* Add flavour to dmi long name */
1838 if (flavour) {
1839 len = strlen(card->dmi_longname);
1840 snprintf(card->dmi_longname + len,
1841 longname_buf_size - len,
1842 "-%s", flavour);
1844 len++;
1845 if (len < longname_buf_size)
1846 cleanup_dmi_name(card->dmi_longname + len);
1849 /* set the card long name */
1850 card->long_name = card->dmi_longname;
1852 return 0;
1854 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1855 #endif /* CONFIG_DMI */
1857 static void soc_check_tplg_fes(struct snd_soc_card *card)
1859 struct snd_soc_component *component;
1860 const struct snd_soc_component_driver *comp_drv;
1861 struct snd_soc_dai_link *dai_link;
1862 int i;
1864 for_each_component(component) {
1866 /* does this component override FEs ? */
1867 if (!component->driver->ignore_machine)
1868 continue;
1870 /* for this machine ? */
1871 if (!strcmp(component->driver->ignore_machine,
1872 card->dev->driver->name))
1873 goto match;
1874 if (strcmp(component->driver->ignore_machine,
1875 dev_name(card->dev)))
1876 continue;
1877 match:
1878 /* machine matches, so override the rtd data */
1879 for_each_card_prelinks(card, i, dai_link) {
1881 /* ignore this FE */
1882 if (dai_link->dynamic) {
1883 dai_link->ignore = true;
1884 continue;
1887 dev_info(card->dev, "info: override FE DAI link %s\n",
1888 card->dai_link[i].name);
1890 /* override platform component */
1891 if (!dai_link->platforms) {
1892 dev_err(card->dev, "init platform error");
1893 continue;
1895 dai_link->platforms->name = component->name;
1897 /* convert non BE into BE */
1898 if (!dai_link->no_pcm) {
1899 dai_link->no_pcm = 1;
1901 if (dai_link->dpcm_playback)
1902 dev_warn(card->dev,
1903 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1904 dai_link->name);
1905 if (dai_link->dpcm_capture)
1906 dev_warn(card->dev,
1907 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1908 dai_link->name);
1910 /* convert normal link into DPCM one */
1911 if (!(dai_link->dpcm_playback ||
1912 dai_link->dpcm_capture)) {
1913 dai_link->dpcm_playback = !dai_link->capture_only;
1914 dai_link->dpcm_capture = !dai_link->playback_only;
1918 /* override any BE fixups */
1919 dai_link->be_hw_params_fixup =
1920 component->driver->be_hw_params_fixup;
1923 * most BE links don't set stream name, so set it to
1924 * dai link name if it's NULL to help bind widgets.
1926 if (!dai_link->stream_name)
1927 dai_link->stream_name = dai_link->name;
1930 /* Inform userspace we are using alternate topology */
1931 if (component->driver->topology_name_prefix) {
1933 /* topology shortname created? */
1934 if (!card->topology_shortname_created) {
1935 comp_drv = component->driver;
1937 snprintf(card->topology_shortname, 32, "%s-%s",
1938 comp_drv->topology_name_prefix,
1939 card->name);
1940 card->topology_shortname_created = true;
1943 /* use topology shortname */
1944 card->name = card->topology_shortname;
1949 static void soc_cleanup_card_resources(struct snd_soc_card *card)
1951 /* free the ALSA card at first; this syncs with pending operations */
1952 if (card->snd_card) {
1953 snd_card_free(card->snd_card);
1954 card->snd_card = NULL;
1957 /* remove and free each DAI */
1958 soc_remove_dai_links(card);
1959 soc_remove_pcm_runtimes(card);
1961 /* remove auxiliary devices */
1962 soc_remove_aux_devices(card);
1963 soc_unbind_aux_dev(card);
1965 snd_soc_dapm_free(&card->dapm);
1966 soc_cleanup_card_debugfs(card);
1968 /* remove the card */
1969 if (card->remove)
1970 card->remove(card);
1973 static int snd_soc_instantiate_card(struct snd_soc_card *card)
1975 struct snd_soc_pcm_runtime *rtd;
1976 struct snd_soc_dai_link *dai_link;
1977 int ret, i;
1979 mutex_lock(&client_mutex);
1980 for_each_card_prelinks(card, i, dai_link) {
1981 ret = soc_init_dai_link(card, dai_link);
1982 if (ret) {
1983 dev_err(card->dev, "ASoC: failed to init link %s: %d\n",
1984 dai_link->name, ret);
1985 mutex_unlock(&client_mutex);
1986 return ret;
1989 mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1991 snd_soc_dapm_init(&card->dapm, card, NULL);
1993 /* check whether any platform is ignore machine FE and using topology */
1994 soc_check_tplg_fes(card);
1996 /* bind DAIs */
1997 for_each_card_prelinks(card, i, dai_link) {
1998 ret = soc_bind_dai_link(card, dai_link);
1999 if (ret != 0)
2000 goto probe_end;
2003 /* bind aux_devs too */
2004 ret = soc_bind_aux_dev(card);
2005 if (ret < 0)
2006 goto probe_end;
2008 /* add predefined DAI links to the list */
2009 for_each_card_prelinks(card, i, dai_link) {
2010 ret = snd_soc_add_dai_link(card, dai_link);
2011 if (ret < 0)
2012 goto probe_end;
2015 /* card bind complete so register a sound card */
2016 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2017 card->owner, 0, &card->snd_card);
2018 if (ret < 0) {
2019 dev_err(card->dev,
2020 "ASoC: can't create sound card for card %s: %d\n",
2021 card->name, ret);
2022 goto probe_end;
2025 soc_init_card_debugfs(card);
2027 soc_resume_init(card);
2029 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2030 card->num_dapm_widgets);
2031 if (ret < 0)
2032 goto probe_end;
2034 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2035 card->num_of_dapm_widgets);
2036 if (ret < 0)
2037 goto probe_end;
2039 /* initialise the sound card only once */
2040 if (card->probe) {
2041 ret = card->probe(card);
2042 if (ret < 0)
2043 goto probe_end;
2046 /* probe all components used by DAI links on this card */
2047 ret = soc_probe_link_components(card);
2048 if (ret < 0) {
2049 dev_err(card->dev,
2050 "ASoC: failed to instantiate card %d\n", ret);
2051 goto probe_end;
2054 /* probe auxiliary components */
2055 ret = soc_probe_aux_devices(card);
2056 if (ret < 0)
2057 goto probe_end;
2060 * Find new DAI links added during probing components and bind them.
2061 * Components with topology may bring new DAIs and DAI links.
2063 for_each_card_links(card, dai_link) {
2064 if (soc_is_dai_link_bound(card, dai_link))
2065 continue;
2067 ret = soc_init_dai_link(card, dai_link);
2068 if (ret)
2069 goto probe_end;
2070 ret = soc_bind_dai_link(card, dai_link);
2071 if (ret)
2072 goto probe_end;
2075 /* probe all DAI links on this card */
2076 ret = soc_probe_link_dais(card);
2077 if (ret < 0) {
2078 dev_err(card->dev,
2079 "ASoC: failed to instantiate card %d\n", ret);
2080 goto probe_end;
2083 for_each_card_rtds(card, rtd)
2084 soc_link_init(card, rtd);
2086 snd_soc_dapm_link_dai_widgets(card);
2087 snd_soc_dapm_connect_dai_link_widgets(card);
2089 ret = snd_soc_add_card_controls(card, card->controls,
2090 card->num_controls);
2091 if (ret < 0)
2092 goto probe_end;
2094 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2095 card->num_dapm_routes);
2096 if (ret < 0) {
2097 if (card->disable_route_checks) {
2098 dev_info(card->dev,
2099 "%s: disable_route_checks set, ignoring errors on add_routes\n",
2100 __func__);
2101 } else {
2102 dev_err(card->dev,
2103 "%s: snd_soc_dapm_add_routes failed: %d\n",
2104 __func__, ret);
2105 goto probe_end;
2109 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2110 card->num_of_dapm_routes);
2111 if (ret < 0)
2112 goto probe_end;
2114 /* try to set some sane longname if DMI is available */
2115 snd_soc_set_dmi_name(card, NULL);
2117 snprintf(card->snd_card->shortname, sizeof(card->snd_card->shortname),
2118 "%s", card->name);
2119 snprintf(card->snd_card->longname, sizeof(card->snd_card->longname),
2120 "%s", card->long_name ? card->long_name : card->name);
2121 snprintf(card->snd_card->driver, sizeof(card->snd_card->driver),
2122 "%s", card->driver_name ? card->driver_name : card->name);
2123 for (i = 0; i < ARRAY_SIZE(card->snd_card->driver); i++) {
2124 switch (card->snd_card->driver[i]) {
2125 case '_':
2126 case '-':
2127 case '\0':
2128 break;
2129 default:
2130 if (!isalnum(card->snd_card->driver[i]))
2131 card->snd_card->driver[i] = '_';
2132 break;
2136 if (card->late_probe) {
2137 ret = card->late_probe(card);
2138 if (ret < 0) {
2139 dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2140 card->name, ret);
2141 goto probe_end;
2145 snd_soc_dapm_new_widgets(card);
2147 ret = snd_card_register(card->snd_card);
2148 if (ret < 0) {
2149 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2150 ret);
2151 goto probe_end;
2154 card->instantiated = 1;
2155 dapm_mark_endpoints_dirty(card);
2156 snd_soc_dapm_sync(&card->dapm);
2158 probe_end:
2159 if (ret < 0)
2160 soc_cleanup_card_resources(card);
2162 mutex_unlock(&card->mutex);
2163 mutex_unlock(&client_mutex);
2165 return ret;
2168 /* probes a new socdev */
2169 static int soc_probe(struct platform_device *pdev)
2171 struct snd_soc_card *card = platform_get_drvdata(pdev);
2174 * no card, so machine driver should be registering card
2175 * we should not be here in that case so ret error
2177 if (!card)
2178 return -EINVAL;
2180 dev_warn(&pdev->dev,
2181 "ASoC: machine %s should use snd_soc_register_card()\n",
2182 card->name);
2184 /* Bodge while we unpick instantiation */
2185 card->dev = &pdev->dev;
2187 return snd_soc_register_card(card);
2190 /* removes a socdev */
2191 static int soc_remove(struct platform_device *pdev)
2193 struct snd_soc_card *card = platform_get_drvdata(pdev);
2195 snd_soc_unregister_card(card);
2196 return 0;
2199 int snd_soc_poweroff(struct device *dev)
2201 struct snd_soc_card *card = dev_get_drvdata(dev);
2202 struct snd_soc_pcm_runtime *rtd;
2204 if (!card->instantiated)
2205 return 0;
2208 * Flush out pmdown_time work - we actually do want to run it
2209 * now, we're shutting down so no imminent restart.
2211 snd_soc_flush_all_delayed_work(card);
2213 snd_soc_dapm_shutdown(card);
2215 /* deactivate pins to sleep state */
2216 for_each_card_rtds(card, rtd) {
2217 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2218 struct snd_soc_dai *codec_dai;
2219 int i;
2221 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2222 for_each_rtd_codec_dai(rtd, i, codec_dai) {
2223 pinctrl_pm_select_sleep_state(codec_dai->dev);
2227 return 0;
2229 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2231 const struct dev_pm_ops snd_soc_pm_ops = {
2232 .suspend = snd_soc_suspend,
2233 .resume = snd_soc_resume,
2234 .freeze = snd_soc_suspend,
2235 .thaw = snd_soc_resume,
2236 .poweroff = snd_soc_poweroff,
2237 .restore = snd_soc_resume,
2239 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2241 /* ASoC platform driver */
2242 static struct platform_driver soc_driver = {
2243 .driver = {
2244 .name = "soc-audio",
2245 .pm = &snd_soc_pm_ops,
2247 .probe = soc_probe,
2248 .remove = soc_remove,
2252 * snd_soc_cnew - create new control
2253 * @_template: control template
2254 * @data: control private data
2255 * @long_name: control long name
2256 * @prefix: control name prefix
2258 * Create a new mixer control from a template control.
2260 * Returns 0 for success, else error.
2262 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2263 void *data, const char *long_name,
2264 const char *prefix)
2266 struct snd_kcontrol_new template;
2267 struct snd_kcontrol *kcontrol;
2268 char *name = NULL;
2270 memcpy(&template, _template, sizeof(template));
2271 template.index = 0;
2273 if (!long_name)
2274 long_name = template.name;
2276 if (prefix) {
2277 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2278 if (!name)
2279 return NULL;
2281 template.name = name;
2282 } else {
2283 template.name = long_name;
2286 kcontrol = snd_ctl_new1(&template, data);
2288 kfree(name);
2290 return kcontrol;
2292 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2294 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2295 const struct snd_kcontrol_new *controls, int num_controls,
2296 const char *prefix, void *data)
2298 int err, i;
2300 for (i = 0; i < num_controls; i++) {
2301 const struct snd_kcontrol_new *control = &controls[i];
2303 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2304 control->name, prefix));
2305 if (err < 0) {
2306 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2307 control->name, err);
2308 return err;
2312 return 0;
2315 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2316 const char *name)
2318 struct snd_card *card = soc_card->snd_card;
2319 struct snd_kcontrol *kctl;
2321 if (unlikely(!name))
2322 return NULL;
2324 list_for_each_entry(kctl, &card->controls, list)
2325 if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2326 return kctl;
2327 return NULL;
2329 EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2332 * snd_soc_add_component_controls - Add an array of controls to a component.
2334 * @component: Component to add controls to
2335 * @controls: Array of controls to add
2336 * @num_controls: Number of elements in the array
2338 * Return: 0 for success, else error.
2340 int snd_soc_add_component_controls(struct snd_soc_component *component,
2341 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2343 struct snd_card *card = component->card->snd_card;
2345 return snd_soc_add_controls(card, component->dev, controls,
2346 num_controls, component->name_prefix, component);
2348 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2351 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2352 * Convenience function to add a list of controls.
2354 * @soc_card: SoC card to add controls to
2355 * @controls: array of controls to add
2356 * @num_controls: number of elements in the array
2358 * Return 0 for success, else error.
2360 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2361 const struct snd_kcontrol_new *controls, int num_controls)
2363 struct snd_card *card = soc_card->snd_card;
2365 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2366 NULL, soc_card);
2368 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2371 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2372 * Convienience function to add a list of controls.
2374 * @dai: DAI to add controls to
2375 * @controls: array of controls to add
2376 * @num_controls: number of elements in the array
2378 * Return 0 for success, else error.
2380 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2381 const struct snd_kcontrol_new *controls, int num_controls)
2383 struct snd_card *card = dai->component->card->snd_card;
2385 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2386 NULL, dai);
2388 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2390 static int snd_soc_bind_card(struct snd_soc_card *card)
2392 struct snd_soc_pcm_runtime *rtd;
2393 int ret;
2395 ret = snd_soc_instantiate_card(card);
2396 if (ret != 0)
2397 return ret;
2399 /* deactivate pins to sleep state */
2400 for_each_card_rtds(card, rtd) {
2401 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2402 struct snd_soc_dai *codec_dai;
2403 int j;
2405 for_each_rtd_codec_dai(rtd, j, codec_dai) {
2406 if (!codec_dai->active)
2407 pinctrl_pm_select_sleep_state(codec_dai->dev);
2410 if (!cpu_dai->active)
2411 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2414 return ret;
2418 * snd_soc_register_card - Register a card with the ASoC core
2420 * @card: Card to register
2423 int snd_soc_register_card(struct snd_soc_card *card)
2425 if (!card->name || !card->dev)
2426 return -EINVAL;
2428 dev_set_drvdata(card->dev, card);
2430 INIT_LIST_HEAD(&card->widgets);
2431 INIT_LIST_HEAD(&card->paths);
2432 INIT_LIST_HEAD(&card->dapm_list);
2433 INIT_LIST_HEAD(&card->aux_comp_list);
2434 INIT_LIST_HEAD(&card->component_dev_list);
2435 INIT_LIST_HEAD(&card->list);
2436 INIT_LIST_HEAD(&card->dai_link_list);
2437 INIT_LIST_HEAD(&card->rtd_list);
2438 INIT_LIST_HEAD(&card->dapm_dirty);
2439 INIT_LIST_HEAD(&card->dobj_list);
2441 card->num_rtd = 0;
2442 card->instantiated = 0;
2443 mutex_init(&card->mutex);
2444 mutex_init(&card->dapm_mutex);
2445 mutex_init(&card->pcm_mutex);
2446 spin_lock_init(&card->dpcm_lock);
2448 return snd_soc_bind_card(card);
2450 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2452 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
2454 if (card->instantiated) {
2455 card->instantiated = false;
2456 snd_soc_dapm_shutdown(card);
2457 snd_soc_flush_all_delayed_work(card);
2459 /* remove all components used by DAI links on this card */
2460 soc_remove_link_components(card);
2462 soc_cleanup_card_resources(card);
2463 if (!unregister)
2464 list_add(&card->list, &unbind_card_list);
2465 } else {
2466 if (unregister)
2467 list_del(&card->list);
2472 * snd_soc_unregister_card - Unregister a card with the ASoC core
2474 * @card: Card to unregister
2477 int snd_soc_unregister_card(struct snd_soc_card *card)
2479 mutex_lock(&client_mutex);
2480 snd_soc_unbind_card(card, true);
2481 mutex_unlock(&client_mutex);
2482 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2484 return 0;
2486 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2489 * Simplify DAI link configuration by removing ".-1" from device names
2490 * and sanitizing names.
2492 static char *fmt_single_name(struct device *dev, int *id)
2494 char *found, name[NAME_SIZE];
2495 int id1, id2;
2497 if (dev_name(dev) == NULL)
2498 return NULL;
2500 strlcpy(name, dev_name(dev), NAME_SIZE);
2502 /* are we a "%s.%d" name (platform and SPI components) */
2503 found = strstr(name, dev->driver->name);
2504 if (found) {
2505 /* get ID */
2506 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2508 /* discard ID from name if ID == -1 */
2509 if (*id == -1)
2510 found[strlen(dev->driver->name)] = '\0';
2513 } else {
2514 /* I2C component devices are named "bus-addr" */
2515 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2516 char tmp[NAME_SIZE];
2518 /* create unique ID number from I2C addr and bus */
2519 *id = ((id1 & 0xffff) << 16) + id2;
2521 /* sanitize component name for DAI link creation */
2522 snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2523 name);
2524 strlcpy(name, tmp, NAME_SIZE);
2525 } else
2526 *id = 0;
2529 return kstrdup(name, GFP_KERNEL);
2533 * Simplify DAI link naming for single devices with multiple DAIs by removing
2534 * any ".-1" and using the DAI name (instead of device name).
2536 static inline char *fmt_multiple_name(struct device *dev,
2537 struct snd_soc_dai_driver *dai_drv)
2539 if (dai_drv->name == NULL) {
2540 dev_err(dev,
2541 "ASoC: error - multiple DAI %s registered with no name\n",
2542 dev_name(dev));
2543 return NULL;
2546 return kstrdup(dai_drv->name, GFP_KERNEL);
2550 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2552 * @component: The component for which the DAIs should be unregistered
2554 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2556 struct snd_soc_dai *dai, *_dai;
2558 for_each_component_dais_safe(component, dai, _dai) {
2559 dev_dbg(component->dev, "ASoC: Unregistered DAI '%s'\n",
2560 dai->name);
2561 list_del(&dai->list);
2562 kfree(dai->name);
2563 kfree(dai);
2567 /* Create a DAI and add it to the component's DAI list */
2568 static struct snd_soc_dai *soc_add_dai(struct snd_soc_component *component,
2569 struct snd_soc_dai_driver *dai_drv,
2570 bool legacy_dai_naming)
2572 struct device *dev = component->dev;
2573 struct snd_soc_dai *dai;
2575 dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2577 dai = kzalloc(sizeof(struct snd_soc_dai), GFP_KERNEL);
2578 if (dai == NULL)
2579 return NULL;
2582 * Back in the old days when we still had component-less DAIs,
2583 * instead of having a static name, component-less DAIs would
2584 * inherit the name of the parent device so it is possible to
2585 * register multiple instances of the DAI. We still need to keep
2586 * the same naming style even though those DAIs are not
2587 * component-less anymore.
2589 if (legacy_dai_naming &&
2590 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2591 dai->name = fmt_single_name(dev, &dai->id);
2592 } else {
2593 dai->name = fmt_multiple_name(dev, dai_drv);
2594 if (dai_drv->id)
2595 dai->id = dai_drv->id;
2596 else
2597 dai->id = component->num_dai;
2599 if (dai->name == NULL) {
2600 kfree(dai);
2601 return NULL;
2604 dai->component = component;
2605 dai->dev = dev;
2606 dai->driver = dai_drv;
2607 if (!dai->driver->ops)
2608 dai->driver->ops = &null_dai_ops;
2610 /* see for_each_component_dais */
2611 list_add_tail(&dai->list, &component->dai_list);
2612 component->num_dai++;
2614 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2615 return dai;
2619 * snd_soc_register_dais - Register a DAI with the ASoC core
2621 * @component: The component the DAIs are registered for
2622 * @dai_drv: DAI driver to use for the DAIs
2623 * @count: Number of DAIs
2625 static int snd_soc_register_dais(struct snd_soc_component *component,
2626 struct snd_soc_dai_driver *dai_drv,
2627 size_t count)
2629 struct device *dev = component->dev;
2630 struct snd_soc_dai *dai;
2631 unsigned int i;
2632 int ret;
2634 dev_dbg(dev, "ASoC: dai register %s #%zu\n", dev_name(dev), count);
2636 for (i = 0; i < count; i++) {
2638 dai = soc_add_dai(component, dai_drv + i, count == 1 &&
2639 !component->driver->non_legacy_dai_naming);
2640 if (dai == NULL) {
2641 ret = -ENOMEM;
2642 goto err;
2646 return 0;
2648 err:
2649 snd_soc_unregister_dais(component);
2651 return ret;
2655 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2657 * @component: The component the DAIs are registered for
2658 * @dai_drv: DAI driver to use for the DAI
2660 * Topology can use this API to register DAIs when probing a component.
2661 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2662 * will be freed in the component cleanup.
2664 int snd_soc_register_dai(struct snd_soc_component *component,
2665 struct snd_soc_dai_driver *dai_drv)
2667 struct snd_soc_dapm_context *dapm =
2668 snd_soc_component_get_dapm(component);
2669 struct snd_soc_dai *dai;
2670 int ret;
2672 if (dai_drv->dobj.type != SND_SOC_DOBJ_PCM) {
2673 dev_err(component->dev, "Invalid dai type %d\n",
2674 dai_drv->dobj.type);
2675 return -EINVAL;
2678 lockdep_assert_held(&client_mutex);
2679 dai = soc_add_dai(component, dai_drv, false);
2680 if (!dai)
2681 return -ENOMEM;
2684 * Create the DAI widgets here. After adding DAIs, topology may
2685 * also add routes that need these widgets as source or sink.
2687 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
2688 if (ret != 0) {
2689 dev_err(component->dev,
2690 "Failed to create DAI widgets %d\n", ret);
2693 return ret;
2695 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2697 static int snd_soc_component_initialize(struct snd_soc_component *component,
2698 const struct snd_soc_component_driver *driver, struct device *dev)
2700 INIT_LIST_HEAD(&component->dai_list);
2701 INIT_LIST_HEAD(&component->dobj_list);
2702 INIT_LIST_HEAD(&component->card_list);
2703 mutex_init(&component->io_mutex);
2705 component->name = fmt_single_name(dev, &component->id);
2706 if (!component->name) {
2707 dev_err(dev, "ASoC: Failed to allocate name\n");
2708 return -ENOMEM;
2711 component->dev = dev;
2712 component->driver = driver;
2714 return 0;
2717 static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
2719 int val_bytes = regmap_get_val_bytes(component->regmap);
2721 /* Errors are legitimate for non-integer byte multiples */
2722 if (val_bytes > 0)
2723 component->val_bytes = val_bytes;
2726 #ifdef CONFIG_REGMAP
2729 * snd_soc_component_init_regmap() - Initialize regmap instance for the
2730 * component
2731 * @component: The component for which to initialize the regmap instance
2732 * @regmap: The regmap instance that should be used by the component
2734 * This function allows deferred assignment of the regmap instance that is
2735 * associated with the component. Only use this if the regmap instance is not
2736 * yet ready when the component is registered. The function must also be called
2737 * before the first IO attempt of the component.
2739 void snd_soc_component_init_regmap(struct snd_soc_component *component,
2740 struct regmap *regmap)
2742 component->regmap = regmap;
2743 snd_soc_component_setup_regmap(component);
2745 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
2748 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
2749 * component
2750 * @component: The component for which to de-initialize the regmap instance
2752 * Calls regmap_exit() on the regmap instance associated to the component and
2753 * removes the regmap instance from the component.
2755 * This function should only be used if snd_soc_component_init_regmap() was used
2756 * to initialize the regmap instance.
2758 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
2760 regmap_exit(component->regmap);
2761 component->regmap = NULL;
2763 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
2765 #endif
2767 static void snd_soc_component_add(struct snd_soc_component *component)
2769 mutex_lock(&client_mutex);
2771 if (!component->driver->write && !component->driver->read) {
2772 if (!component->regmap)
2773 component->regmap = dev_get_regmap(component->dev,
2774 NULL);
2775 if (component->regmap)
2776 snd_soc_component_setup_regmap(component);
2779 /* see for_each_component */
2780 list_add(&component->list, &component_list);
2782 mutex_unlock(&client_mutex);
2785 static void snd_soc_component_cleanup(struct snd_soc_component *component)
2787 snd_soc_unregister_dais(component);
2788 kfree(component->name);
2791 static void snd_soc_component_del_unlocked(struct snd_soc_component *component)
2793 struct snd_soc_card *card = component->card;
2795 if (card)
2796 snd_soc_unbind_card(card, false);
2798 list_del(&component->list);
2801 #define ENDIANNESS_MAP(name) \
2802 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2803 static u64 endianness_format_map[] = {
2804 ENDIANNESS_MAP(S16_),
2805 ENDIANNESS_MAP(U16_),
2806 ENDIANNESS_MAP(S24_),
2807 ENDIANNESS_MAP(U24_),
2808 ENDIANNESS_MAP(S32_),
2809 ENDIANNESS_MAP(U32_),
2810 ENDIANNESS_MAP(S24_3),
2811 ENDIANNESS_MAP(U24_3),
2812 ENDIANNESS_MAP(S20_3),
2813 ENDIANNESS_MAP(U20_3),
2814 ENDIANNESS_MAP(S18_3),
2815 ENDIANNESS_MAP(U18_3),
2816 ENDIANNESS_MAP(FLOAT_),
2817 ENDIANNESS_MAP(FLOAT64_),
2818 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2822 * Fix up the DAI formats for endianness: codecs don't actually see
2823 * the endianness of the data but we're using the CPU format
2824 * definitions which do need to include endianness so we ensure that
2825 * codec DAIs always have both big and little endian variants set.
2827 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2829 int i;
2831 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2832 if (stream->formats & endianness_format_map[i])
2833 stream->formats |= endianness_format_map[i];
2836 static void snd_soc_try_rebind_card(void)
2838 struct snd_soc_card *card, *c;
2840 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2841 if (!snd_soc_bind_card(card))
2842 list_del(&card->list);
2845 int snd_soc_add_component(struct device *dev,
2846 struct snd_soc_component *component,
2847 const struct snd_soc_component_driver *component_driver,
2848 struct snd_soc_dai_driver *dai_drv,
2849 int num_dai)
2851 int ret;
2852 int i;
2854 ret = snd_soc_component_initialize(component, component_driver, dev);
2855 if (ret)
2856 goto err_free;
2858 if (component_driver->endianness) {
2859 for (i = 0; i < num_dai; i++) {
2860 convert_endianness_formats(&dai_drv[i].playback);
2861 convert_endianness_formats(&dai_drv[i].capture);
2865 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2866 if (ret < 0) {
2867 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
2868 goto err_cleanup;
2871 snd_soc_component_add(component);
2872 snd_soc_try_rebind_card();
2874 return 0;
2876 err_cleanup:
2877 snd_soc_component_cleanup(component);
2878 err_free:
2879 return ret;
2881 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2883 int snd_soc_register_component(struct device *dev,
2884 const struct snd_soc_component_driver *component_driver,
2885 struct snd_soc_dai_driver *dai_drv,
2886 int num_dai)
2888 struct snd_soc_component *component;
2890 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2891 if (!component)
2892 return -ENOMEM;
2894 return snd_soc_add_component(dev, component, component_driver,
2895 dai_drv, num_dai);
2897 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2900 * snd_soc_unregister_component - Unregister all related component
2901 * from the ASoC core
2903 * @dev: The device to unregister
2905 static int __snd_soc_unregister_component(struct device *dev)
2907 struct snd_soc_component *component;
2908 int found = 0;
2910 mutex_lock(&client_mutex);
2911 for_each_component(component) {
2912 if (dev != component->dev)
2913 continue;
2915 snd_soc_tplg_component_remove(component,
2916 SND_SOC_TPLG_INDEX_ALL);
2917 snd_soc_component_del_unlocked(component);
2918 found = 1;
2919 break;
2921 mutex_unlock(&client_mutex);
2923 if (found)
2924 snd_soc_component_cleanup(component);
2926 return found;
2929 void snd_soc_unregister_component(struct device *dev)
2931 while (__snd_soc_unregister_component(dev))
2934 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2936 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
2937 const char *driver_name)
2939 struct snd_soc_component *component;
2940 struct snd_soc_component *ret;
2942 ret = NULL;
2943 mutex_lock(&client_mutex);
2944 for_each_component(component) {
2945 if (dev != component->dev)
2946 continue;
2948 if (driver_name &&
2949 (driver_name != component->driver->name) &&
2950 (strcmp(component->driver->name, driver_name) != 0))
2951 continue;
2953 ret = component;
2954 break;
2956 mutex_unlock(&client_mutex);
2958 return ret;
2960 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
2962 /* Retrieve a card's name from device tree */
2963 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2964 const char *propname)
2966 struct device_node *np;
2967 int ret;
2969 if (!card->dev) {
2970 pr_err("card->dev is not set before calling %s\n", __func__);
2971 return -EINVAL;
2974 np = card->dev->of_node;
2976 ret = of_property_read_string_index(np, propname, 0, &card->name);
2978 * EINVAL means the property does not exist. This is fine providing
2979 * card->name was previously set, which is checked later in
2980 * snd_soc_register_card.
2982 if (ret < 0 && ret != -EINVAL) {
2983 dev_err(card->dev,
2984 "ASoC: Property '%s' could not be read: %d\n",
2985 propname, ret);
2986 return ret;
2989 return 0;
2991 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2993 static const struct snd_soc_dapm_widget simple_widgets[] = {
2994 SND_SOC_DAPM_MIC("Microphone", NULL),
2995 SND_SOC_DAPM_LINE("Line", NULL),
2996 SND_SOC_DAPM_HP("Headphone", NULL),
2997 SND_SOC_DAPM_SPK("Speaker", NULL),
3000 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
3001 const char *propname)
3003 struct device_node *np = card->dev->of_node;
3004 struct snd_soc_dapm_widget *widgets;
3005 const char *template, *wname;
3006 int i, j, num_widgets, ret;
3008 num_widgets = of_property_count_strings(np, propname);
3009 if (num_widgets < 0) {
3010 dev_err(card->dev,
3011 "ASoC: Property '%s' does not exist\n", propname);
3012 return -EINVAL;
3014 if (num_widgets & 1) {
3015 dev_err(card->dev,
3016 "ASoC: Property '%s' length is not even\n", propname);
3017 return -EINVAL;
3020 num_widgets /= 2;
3021 if (!num_widgets) {
3022 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3023 propname);
3024 return -EINVAL;
3027 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
3028 GFP_KERNEL);
3029 if (!widgets) {
3030 dev_err(card->dev,
3031 "ASoC: Could not allocate memory for widgets\n");
3032 return -ENOMEM;
3035 for (i = 0; i < num_widgets; i++) {
3036 ret = of_property_read_string_index(np, propname,
3037 2 * i, &template);
3038 if (ret) {
3039 dev_err(card->dev,
3040 "ASoC: Property '%s' index %d read error:%d\n",
3041 propname, 2 * i, ret);
3042 return -EINVAL;
3045 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3046 if (!strncmp(template, simple_widgets[j].name,
3047 strlen(simple_widgets[j].name))) {
3048 widgets[i] = simple_widgets[j];
3049 break;
3053 if (j >= ARRAY_SIZE(simple_widgets)) {
3054 dev_err(card->dev,
3055 "ASoC: DAPM widget '%s' is not supported\n",
3056 template);
3057 return -EINVAL;
3060 ret = of_property_read_string_index(np, propname,
3061 (2 * i) + 1,
3062 &wname);
3063 if (ret) {
3064 dev_err(card->dev,
3065 "ASoC: Property '%s' index %d read error:%d\n",
3066 propname, (2 * i) + 1, ret);
3067 return -EINVAL;
3070 widgets[i].name = wname;
3073 card->of_dapm_widgets = widgets;
3074 card->num_of_dapm_widgets = num_widgets;
3076 return 0;
3078 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3080 int snd_soc_of_get_slot_mask(struct device_node *np,
3081 const char *prop_name,
3082 unsigned int *mask)
3084 u32 val;
3085 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3086 int i;
3088 if (!of_slot_mask)
3089 return 0;
3090 val /= sizeof(u32);
3091 for (i = 0; i < val; i++)
3092 if (be32_to_cpup(&of_slot_mask[i]))
3093 *mask |= (1 << i);
3095 return val;
3097 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
3099 int snd_soc_of_parse_tdm_slot(struct device_node *np,
3100 unsigned int *tx_mask,
3101 unsigned int *rx_mask,
3102 unsigned int *slots,
3103 unsigned int *slot_width)
3105 u32 val;
3106 int ret;
3108 if (tx_mask)
3109 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3110 if (rx_mask)
3111 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3113 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3114 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3115 if (ret)
3116 return ret;
3118 if (slots)
3119 *slots = val;
3122 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3123 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3124 if (ret)
3125 return ret;
3127 if (slot_width)
3128 *slot_width = val;
3131 return 0;
3133 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3135 void snd_soc_of_parse_node_prefix(struct device_node *np,
3136 struct snd_soc_codec_conf *codec_conf,
3137 struct device_node *of_node,
3138 const char *propname)
3140 const char *str;
3141 int ret;
3143 ret = of_property_read_string(np, propname, &str);
3144 if (ret < 0) {
3145 /* no prefix is not error */
3146 return;
3149 codec_conf->of_node = of_node;
3150 codec_conf->name_prefix = str;
3152 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
3154 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3155 const char *propname)
3157 struct device_node *np = card->dev->of_node;
3158 int num_routes;
3159 struct snd_soc_dapm_route *routes;
3160 int i, ret;
3162 num_routes = of_property_count_strings(np, propname);
3163 if (num_routes < 0 || num_routes & 1) {
3164 dev_err(card->dev,
3165 "ASoC: Property '%s' does not exist or its length is not even\n",
3166 propname);
3167 return -EINVAL;
3169 num_routes /= 2;
3170 if (!num_routes) {
3171 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3172 propname);
3173 return -EINVAL;
3176 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
3177 GFP_KERNEL);
3178 if (!routes) {
3179 dev_err(card->dev,
3180 "ASoC: Could not allocate DAPM route table\n");
3181 return -EINVAL;
3184 for (i = 0; i < num_routes; i++) {
3185 ret = of_property_read_string_index(np, propname,
3186 2 * i, &routes[i].sink);
3187 if (ret) {
3188 dev_err(card->dev,
3189 "ASoC: Property '%s' index %d could not be read: %d\n",
3190 propname, 2 * i, ret);
3191 return -EINVAL;
3193 ret = of_property_read_string_index(np, propname,
3194 (2 * i) + 1, &routes[i].source);
3195 if (ret) {
3196 dev_err(card->dev,
3197 "ASoC: Property '%s' index %d could not be read: %d\n",
3198 propname, (2 * i) + 1, ret);
3199 return -EINVAL;
3203 card->num_of_dapm_routes = num_routes;
3204 card->of_dapm_routes = routes;
3206 return 0;
3208 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3210 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
3211 const char *prefix,
3212 struct device_node **bitclkmaster,
3213 struct device_node **framemaster)
3215 int ret, i;
3216 char prop[128];
3217 unsigned int format = 0;
3218 int bit, frame;
3219 const char *str;
3220 struct {
3221 char *name;
3222 unsigned int val;
3223 } of_fmt_table[] = {
3224 { "i2s", SND_SOC_DAIFMT_I2S },
3225 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
3226 { "left_j", SND_SOC_DAIFMT_LEFT_J },
3227 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
3228 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
3229 { "ac97", SND_SOC_DAIFMT_AC97 },
3230 { "pdm", SND_SOC_DAIFMT_PDM},
3231 { "msb", SND_SOC_DAIFMT_MSB },
3232 { "lsb", SND_SOC_DAIFMT_LSB },
3235 if (!prefix)
3236 prefix = "";
3239 * check "dai-format = xxx"
3240 * or "[prefix]format = xxx"
3241 * SND_SOC_DAIFMT_FORMAT_MASK area
3243 ret = of_property_read_string(np, "dai-format", &str);
3244 if (ret < 0) {
3245 snprintf(prop, sizeof(prop), "%sformat", prefix);
3246 ret = of_property_read_string(np, prop, &str);
3248 if (ret == 0) {
3249 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3250 if (strcmp(str, of_fmt_table[i].name) == 0) {
3251 format |= of_fmt_table[i].val;
3252 break;
3258 * check "[prefix]continuous-clock"
3259 * SND_SOC_DAIFMT_CLOCK_MASK area
3261 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3262 if (of_property_read_bool(np, prop))
3263 format |= SND_SOC_DAIFMT_CONT;
3264 else
3265 format |= SND_SOC_DAIFMT_GATED;
3268 * check "[prefix]bitclock-inversion"
3269 * check "[prefix]frame-inversion"
3270 * SND_SOC_DAIFMT_INV_MASK area
3272 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3273 bit = !!of_get_property(np, prop, NULL);
3275 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3276 frame = !!of_get_property(np, prop, NULL);
3278 switch ((bit << 4) + frame) {
3279 case 0x11:
3280 format |= SND_SOC_DAIFMT_IB_IF;
3281 break;
3282 case 0x10:
3283 format |= SND_SOC_DAIFMT_IB_NF;
3284 break;
3285 case 0x01:
3286 format |= SND_SOC_DAIFMT_NB_IF;
3287 break;
3288 default:
3289 /* SND_SOC_DAIFMT_NB_NF is default */
3290 break;
3294 * check "[prefix]bitclock-master"
3295 * check "[prefix]frame-master"
3296 * SND_SOC_DAIFMT_MASTER_MASK area
3298 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3299 bit = !!of_get_property(np, prop, NULL);
3300 if (bit && bitclkmaster)
3301 *bitclkmaster = of_parse_phandle(np, prop, 0);
3303 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3304 frame = !!of_get_property(np, prop, NULL);
3305 if (frame && framemaster)
3306 *framemaster = of_parse_phandle(np, prop, 0);
3308 switch ((bit << 4) + frame) {
3309 case 0x11:
3310 format |= SND_SOC_DAIFMT_CBM_CFM;
3311 break;
3312 case 0x10:
3313 format |= SND_SOC_DAIFMT_CBM_CFS;
3314 break;
3315 case 0x01:
3316 format |= SND_SOC_DAIFMT_CBS_CFM;
3317 break;
3318 default:
3319 format |= SND_SOC_DAIFMT_CBS_CFS;
3320 break;
3323 return format;
3325 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
3327 int snd_soc_get_dai_id(struct device_node *ep)
3329 struct snd_soc_component *component;
3330 struct snd_soc_dai_link_component dlc;
3331 int ret;
3333 dlc.of_node = of_graph_get_port_parent(ep);
3334 dlc.name = NULL;
3336 * For example HDMI case, HDMI has video/sound port,
3337 * but ALSA SoC needs sound port number only.
3338 * Thus counting HDMI DT port/endpoint doesn't work.
3339 * Then, it should have .of_xlate_dai_id
3341 ret = -ENOTSUPP;
3342 mutex_lock(&client_mutex);
3343 component = soc_find_component(&dlc);
3344 if (component)
3345 ret = snd_soc_component_of_xlate_dai_id(component, ep);
3346 mutex_unlock(&client_mutex);
3348 of_node_put(dlc.of_node);
3350 return ret;
3352 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3354 int snd_soc_get_dai_name(struct of_phandle_args *args,
3355 const char **dai_name)
3357 struct snd_soc_component *pos;
3358 struct device_node *component_of_node;
3359 int ret = -EPROBE_DEFER;
3361 mutex_lock(&client_mutex);
3362 for_each_component(pos) {
3363 component_of_node = soc_component_to_node(pos);
3365 if (component_of_node != args->np)
3366 continue;
3368 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3369 if (ret == -ENOTSUPP) {
3370 struct snd_soc_dai *dai;
3371 int id = -1;
3373 switch (args->args_count) {
3374 case 0:
3375 id = 0; /* same as dai_drv[0] */
3376 break;
3377 case 1:
3378 id = args->args[0];
3379 break;
3380 default:
3381 /* not supported */
3382 break;
3385 if (id < 0 || id >= pos->num_dai) {
3386 ret = -EINVAL;
3387 continue;
3390 ret = 0;
3392 /* find target DAI */
3393 for_each_component_dais(pos, dai) {
3394 if (id == 0)
3395 break;
3396 id--;
3399 *dai_name = dai->driver->name;
3400 if (!*dai_name)
3401 *dai_name = pos->name;
3404 break;
3406 mutex_unlock(&client_mutex);
3407 return ret;
3409 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3411 int snd_soc_of_get_dai_name(struct device_node *of_node,
3412 const char **dai_name)
3414 struct of_phandle_args args;
3415 int ret;
3417 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3418 "#sound-dai-cells", 0, &args);
3419 if (ret)
3420 return ret;
3422 ret = snd_soc_get_dai_name(&args, dai_name);
3424 of_node_put(args.np);
3426 return ret;
3428 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3431 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3432 * @dai_link: DAI link
3434 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3436 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3438 struct snd_soc_dai_link_component *component;
3439 int index;
3441 for_each_link_codecs(dai_link, index, component) {
3442 if (!component->of_node)
3443 break;
3444 of_node_put(component->of_node);
3445 component->of_node = NULL;
3448 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3451 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3452 * @dev: Card device
3453 * @of_node: Device node
3454 * @dai_link: DAI link
3456 * Builds an array of CODEC DAI components from the DAI link property
3457 * 'sound-dai'.
3458 * The array is set in the DAI link and the number of DAIs is set accordingly.
3459 * The device nodes in the array (of_node) must be dereferenced by calling
3460 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3462 * Returns 0 for success
3464 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3465 struct device_node *of_node,
3466 struct snd_soc_dai_link *dai_link)
3468 struct of_phandle_args args;
3469 struct snd_soc_dai_link_component *component;
3470 char *name;
3471 int index, num_codecs, ret;
3473 /* Count the number of CODECs */
3474 name = "sound-dai";
3475 num_codecs = of_count_phandle_with_args(of_node, name,
3476 "#sound-dai-cells");
3477 if (num_codecs <= 0) {
3478 if (num_codecs == -ENOENT)
3479 dev_err(dev, "No 'sound-dai' property\n");
3480 else
3481 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3482 return num_codecs;
3484 component = devm_kcalloc(dev,
3485 num_codecs, sizeof(*component),
3486 GFP_KERNEL);
3487 if (!component)
3488 return -ENOMEM;
3489 dai_link->codecs = component;
3490 dai_link->num_codecs = num_codecs;
3492 /* Parse the list */
3493 for_each_link_codecs(dai_link, index, component) {
3494 ret = of_parse_phandle_with_args(of_node, name,
3495 "#sound-dai-cells",
3496 index, &args);
3497 if (ret)
3498 goto err;
3499 component->of_node = args.np;
3500 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3501 if (ret < 0)
3502 goto err;
3504 return 0;
3505 err:
3506 snd_soc_of_put_dai_link_codecs(dai_link);
3507 dai_link->codecs = NULL;
3508 dai_link->num_codecs = 0;
3509 return ret;
3511 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3513 static int __init snd_soc_init(void)
3515 snd_soc_debugfs_init();
3516 snd_soc_util_init();
3518 return platform_driver_register(&soc_driver);
3520 module_init(snd_soc_init);
3522 static void __exit snd_soc_exit(void)
3524 snd_soc_util_exit();
3525 snd_soc_debugfs_exit();
3527 platform_driver_unregister(&soc_driver);
3529 module_exit(snd_soc_exit);
3531 /* Module information */
3532 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3533 MODULE_DESCRIPTION("ALSA SoC Core");
3534 MODULE_LICENSE("GPL");
3535 MODULE_ALIAS("platform:soc-audio");