Revert "unicode: Don't special case ignorable code points"
[linux.git] / sound / soc / soc-core.c
bloba1dace4bb61664e7f2b4f17147be399077e2fe25
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 <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
56 * dai_link. see soc.h
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);
83 int ret;
85 ret = kstrtol(buf, 10, &rtd->pmdown_time);
86 if (ret)
87 return ret;
89 return count;
92 static DEVICE_ATTR_RW(pmdown_time);
94 static struct attribute *soc_dev_attrs[] = {
95 &dev_attr_pmdown_time.attr,
96 NULL
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);
105 if (!rtd)
106 return 0;
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[] = {
124 &soc_dapm_dev_group,
125 &soc_dev_group,
126 NULL
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)
136 return;
138 if (component->debugfs_prefix) {
139 char *name;
141 name = kasprintf(GFP_KERNEL, "%s:%s",
142 component->debugfs_prefix, component->name);
143 if (name) {
144 component->debugfs_root = debugfs_create_dir(name,
145 component->card->debugfs_card_root);
146 kfree(name);
148 } else {
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)
160 return;
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);
178 return 0;
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);
193 return 0;
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,
203 &card->pop_time);
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,
219 &dai_list_fops);
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);
230 #else
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) { }
239 #endif
241 static int snd_soc_is_match_dai_args(const struct of_phandle_args *args1,
242 const struct of_phandle_args *args2)
244 if (!args1 || !args2)
245 return 0;
247 if (args1->np != args2->np)
248 return 0;
250 for (int i = 0; i < args1->args_count; i++)
251 if (args1->args[i] != args2->args[i])
252 return 0;
254 return 1;
257 static inline int snd_soc_dlc_component_is_empty(struct snd_soc_dai_link_component *dlc)
259 return !(dlc->dai_args || dlc->name || dlc->of_node);
262 static inline int snd_soc_dlc_component_is_invalid(struct snd_soc_dai_link_component *dlc)
264 return (dlc->name && dlc->of_node);
267 static inline int snd_soc_dlc_dai_is_empty(struct snd_soc_dai_link_component *dlc)
269 return !(dlc->dai_args || dlc->dai_name);
272 static int snd_soc_is_matching_dai(const struct snd_soc_dai_link_component *dlc,
273 struct snd_soc_dai *dai)
275 if (!dlc)
276 return 0;
278 if (dlc->dai_args)
279 return snd_soc_is_match_dai_args(dai->driver->dai_args, dlc->dai_args);
281 if (!dlc->dai_name)
282 return 1;
284 /* see snd_soc_dai_name_get() */
286 if (dai->driver->name &&
287 strcmp(dlc->dai_name, dai->driver->name) == 0)
288 return 1;
290 if (strcmp(dlc->dai_name, dai->name) == 0)
291 return 1;
293 if (dai->component->name &&
294 strcmp(dlc->dai_name, dai->component->name) == 0)
295 return 1;
297 return 0;
300 const char *snd_soc_dai_name_get(const struct snd_soc_dai *dai)
302 /* see snd_soc_is_matching_dai() */
303 if (dai->driver->name)
304 return dai->driver->name;
306 if (dai->name)
307 return dai->name;
309 if (dai->component->name)
310 return dai->component->name;
312 return NULL;
314 EXPORT_SYMBOL_GPL(snd_soc_dai_name_get);
316 static int snd_soc_rtd_add_component(struct snd_soc_pcm_runtime *rtd,
317 struct snd_soc_component *component)
319 struct snd_soc_component *comp;
320 int i;
322 for_each_rtd_components(rtd, i, comp) {
323 /* already connected */
324 if (comp == component)
325 return 0;
328 /* see for_each_rtd_components */
329 rtd->num_components++; // increment flex array count at first
330 rtd->components[rtd->num_components - 1] = component;
332 return 0;
335 struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
336 const char *driver_name)
338 struct snd_soc_component *component;
339 int i;
341 if (!driver_name)
342 return NULL;
345 * NOTE
347 * snd_soc_rtdcom_lookup() will find component from rtd by using
348 * specified driver name.
349 * But, if many components which have same driver name are connected
350 * to 1 rtd, this function will return 1st found component.
352 for_each_rtd_components(rtd, i, component) {
353 const char *component_name = component->driver->name;
355 if (!component_name)
356 continue;
358 if ((component_name == driver_name) ||
359 strcmp(component_name, driver_name) == 0)
360 return component;
363 return NULL;
365 EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
367 struct snd_soc_component
368 *snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
370 struct snd_soc_component *component;
371 struct snd_soc_component *found_component;
373 found_component = NULL;
374 for_each_component(component) {
375 if ((dev == component->dev) &&
376 (!driver_name ||
377 (driver_name == component->driver->name) ||
378 (strcmp(component->driver->name, driver_name) == 0))) {
379 found_component = component;
380 break;
384 return found_component;
386 EXPORT_SYMBOL_GPL(snd_soc_lookup_component_nolocked);
388 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
389 const char *driver_name)
391 struct snd_soc_component *component;
393 mutex_lock(&client_mutex);
394 component = snd_soc_lookup_component_nolocked(dev, driver_name);
395 mutex_unlock(&client_mutex);
397 return component;
399 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
401 struct snd_soc_pcm_runtime
402 *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
403 struct snd_soc_dai_link *dai_link)
405 struct snd_soc_pcm_runtime *rtd;
407 for_each_card_rtds(card, rtd) {
408 if (rtd->dai_link == dai_link)
409 return rtd;
411 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
412 return NULL;
414 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
417 * Power down the audio subsystem pmdown_time msecs after close is called.
418 * This is to ensure there are no pops or clicks in between any music tracks
419 * due to DAPM power cycling.
421 void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd)
423 struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
424 int playback = SNDRV_PCM_STREAM_PLAYBACK;
426 snd_soc_dpcm_mutex_lock(rtd);
428 dev_dbg(rtd->dev,
429 "ASoC: pop wq checking: %s status: %s waiting: %s\n",
430 codec_dai->driver->playback.stream_name,
431 snd_soc_dai_stream_active(codec_dai, playback) ?
432 "active" : "inactive",
433 rtd->pop_wait ? "yes" : "no");
435 /* are we waiting on this codec DAI stream */
436 if (rtd->pop_wait == 1) {
437 rtd->pop_wait = 0;
438 snd_soc_dapm_stream_event(rtd, playback,
439 SND_SOC_DAPM_STREAM_STOP);
442 snd_soc_dpcm_mutex_unlock(rtd);
444 EXPORT_SYMBOL_GPL(snd_soc_close_delayed_work);
446 static void soc_release_rtd_dev(struct device *dev)
448 /* "dev" means "rtd->dev" */
449 kfree(dev);
452 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
454 if (!rtd)
455 return;
457 list_del(&rtd->list);
459 if (delayed_work_pending(&rtd->delayed_work))
460 flush_delayed_work(&rtd->delayed_work);
461 snd_soc_pcm_component_free(rtd);
464 * we don't need to call kfree() for rtd->dev
465 * see
466 * soc_release_rtd_dev()
468 * We don't need rtd->dev NULL check, because
469 * it is alloced *before* rtd.
470 * see
471 * soc_new_pcm_runtime()
473 * We don't need to mind freeing for rtd,
474 * because it was created from dev (= rtd->dev)
475 * see
476 * soc_new_pcm_runtime()
478 * rtd = devm_kzalloc(dev, ...);
479 * rtd->dev = dev
481 device_unregister(rtd->dev);
484 static void close_delayed_work(struct work_struct *work) {
485 struct snd_soc_pcm_runtime *rtd =
486 container_of(work, struct snd_soc_pcm_runtime,
487 delayed_work.work);
489 if (rtd->close_delayed_work_func)
490 rtd->close_delayed_work_func(rtd);
493 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
494 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
496 struct snd_soc_pcm_runtime *rtd;
497 struct device *dev;
498 int ret;
499 int stream;
502 * for rtd->dev
504 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
505 if (!dev)
506 return NULL;
508 dev->parent = card->dev;
509 dev->release = soc_release_rtd_dev;
511 dev_set_name(dev, "%s", dai_link->name);
513 ret = device_register(dev);
514 if (ret < 0) {
515 put_device(dev); /* soc_release_rtd_dev */
516 return NULL;
520 * for rtd
522 rtd = devm_kzalloc(dev,
523 struct_size(rtd, components,
524 dai_link->num_cpus +
525 dai_link->num_codecs +
526 dai_link->num_platforms),
527 GFP_KERNEL);
528 if (!rtd) {
529 device_unregister(dev);
530 return NULL;
533 rtd->dev = dev;
534 INIT_LIST_HEAD(&rtd->list);
535 for_each_pcm_streams(stream) {
536 INIT_LIST_HEAD(&rtd->dpcm[stream].be_clients);
537 INIT_LIST_HEAD(&rtd->dpcm[stream].fe_clients);
539 dev_set_drvdata(dev, rtd);
540 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
543 * for rtd->dais
545 rtd->dais = devm_kcalloc(dev, dai_link->num_cpus + dai_link->num_codecs,
546 sizeof(struct snd_soc_dai *),
547 GFP_KERNEL);
548 if (!rtd->dais)
549 goto free_rtd;
552 * dais = [][][][][][][][][][][][][][][][][][]
553 * ^cpu_dais ^codec_dais
554 * |--- num_cpus ---|--- num_codecs --|
555 * see
556 * snd_soc_rtd_to_cpu()
557 * snd_soc_rtd_to_codec()
559 rtd->card = card;
560 rtd->dai_link = dai_link;
561 rtd->id = card->num_rtd++;
562 rtd->pmdown_time = pmdown_time; /* default power off timeout */
564 /* see for_each_card_rtds */
565 list_add_tail(&rtd->list, &card->rtd_list);
567 ret = device_add_groups(dev, soc_dev_attr_groups);
568 if (ret < 0)
569 goto free_rtd;
571 return rtd;
573 free_rtd:
574 soc_free_pcm_runtime(rtd);
575 return NULL;
578 static void snd_soc_fill_dummy_dai(struct snd_soc_card *card)
580 struct snd_soc_dai_link *dai_link;
581 int i;
584 * COMP_DUMMY() creates size 0 array on dai_link.
585 * Fill it as dummy DAI in case of CPU/Codec here.
586 * Do nothing for Platform.
588 for_each_card_prelinks(card, i, dai_link) {
589 if (dai_link->num_cpus == 0 && dai_link->cpus) {
590 dai_link->num_cpus = 1;
591 dai_link->cpus = &snd_soc_dummy_dlc;
593 if (dai_link->num_codecs == 0 && dai_link->codecs) {
594 dai_link->num_codecs = 1;
595 dai_link->codecs = &snd_soc_dummy_dlc;
600 static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
602 struct snd_soc_pcm_runtime *rtd;
604 for_each_card_rtds(card, rtd)
605 flush_delayed_work(&rtd->delayed_work);
608 #ifdef CONFIG_PM_SLEEP
609 static void soc_playback_digital_mute(struct snd_soc_card *card, int mute)
611 struct snd_soc_pcm_runtime *rtd;
612 struct snd_soc_dai *dai;
613 int playback = SNDRV_PCM_STREAM_PLAYBACK;
614 int i;
616 for_each_card_rtds(card, rtd) {
618 if (rtd->dai_link->ignore_suspend)
619 continue;
621 for_each_rtd_dais(rtd, i, dai) {
622 if (snd_soc_dai_stream_active(dai, playback))
623 snd_soc_dai_digital_mute(dai, mute, playback);
628 static void soc_dapm_suspend_resume(struct snd_soc_card *card, int event)
630 struct snd_soc_pcm_runtime *rtd;
631 int stream;
633 for_each_card_rtds(card, rtd) {
635 if (rtd->dai_link->ignore_suspend)
636 continue;
638 for_each_pcm_streams(stream)
639 snd_soc_dapm_stream_event(rtd, stream, event);
643 /* powers down audio subsystem for suspend */
644 int snd_soc_suspend(struct device *dev)
646 struct snd_soc_card *card = dev_get_drvdata(dev);
647 struct snd_soc_component *component;
648 struct snd_soc_pcm_runtime *rtd;
649 int i;
651 /* If the card is not initialized yet there is nothing to do */
652 if (!snd_soc_card_is_instantiated(card))
653 return 0;
656 * Due to the resume being scheduled into a workqueue we could
657 * suspend before that's finished - wait for it to complete.
659 snd_power_wait(card->snd_card);
661 /* we're going to block userspace touching us until resume completes */
662 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
664 /* mute any active DACs */
665 soc_playback_digital_mute(card, 1);
667 /* suspend all pcms */
668 for_each_card_rtds(card, rtd) {
669 if (rtd->dai_link->ignore_suspend)
670 continue;
672 snd_pcm_suspend_all(rtd->pcm);
675 snd_soc_card_suspend_pre(card);
677 /* close any waiting streams */
678 snd_soc_flush_all_delayed_work(card);
680 soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_SUSPEND);
682 /* Recheck all endpoints too, their state is affected by suspend */
683 dapm_mark_endpoints_dirty(card);
684 snd_soc_dapm_sync(&card->dapm);
686 /* suspend all COMPONENTs */
687 for_each_card_rtds(card, rtd) {
689 if (rtd->dai_link->ignore_suspend)
690 continue;
692 for_each_rtd_components(rtd, i, component) {
693 struct snd_soc_dapm_context *dapm =
694 snd_soc_component_get_dapm(component);
697 * ignore if component was already suspended
699 if (snd_soc_component_is_suspended(component))
700 continue;
703 * If there are paths active then the COMPONENT will be
704 * held with bias _ON and should not be suspended.
706 switch (snd_soc_dapm_get_bias_level(dapm)) {
707 case SND_SOC_BIAS_STANDBY:
709 * If the COMPONENT is capable of idle
710 * bias off then being in STANDBY
711 * means it's doing something,
712 * otherwise fall through.
714 if (dapm->idle_bias_off) {
715 dev_dbg(component->dev,
716 "ASoC: idle_bias_off CODEC on over suspend\n");
717 break;
719 fallthrough;
721 case SND_SOC_BIAS_OFF:
722 snd_soc_component_suspend(component);
723 if (component->regmap)
724 regcache_mark_dirty(component->regmap);
725 /* deactivate pins to sleep state */
726 pinctrl_pm_select_sleep_state(component->dev);
727 break;
728 default:
729 dev_dbg(component->dev,
730 "ASoC: COMPONENT is on over suspend\n");
731 break;
736 snd_soc_card_suspend_post(card);
738 return 0;
740 EXPORT_SYMBOL_GPL(snd_soc_suspend);
743 * deferred resume work, so resume can complete before we finished
744 * setting our codec back up, which can be very slow on I2C
746 static void soc_resume_deferred(struct work_struct *work)
748 struct snd_soc_card *card =
749 container_of(work, struct snd_soc_card,
750 deferred_resume_work);
751 struct snd_soc_component *component;
754 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
755 * so userspace apps are blocked from touching us
758 dev_dbg(card->dev, "ASoC: starting resume work\n");
760 /* Bring us up into D2 so that DAPM starts enabling things */
761 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
763 snd_soc_card_resume_pre(card);
765 for_each_card_components(card, component) {
766 if (snd_soc_component_is_suspended(component))
767 snd_soc_component_resume(component);
770 soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_RESUME);
772 /* unmute any active DACs */
773 soc_playback_digital_mute(card, 0);
775 snd_soc_card_resume_post(card);
777 dev_dbg(card->dev, "ASoC: resume work completed\n");
779 /* Recheck all endpoints too, their state is affected by suspend */
780 dapm_mark_endpoints_dirty(card);
781 snd_soc_dapm_sync(&card->dapm);
783 /* userspace can access us now we are back as we were before */
784 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
787 /* powers up audio subsystem after a suspend */
788 int snd_soc_resume(struct device *dev)
790 struct snd_soc_card *card = dev_get_drvdata(dev);
791 struct snd_soc_component *component;
793 /* If the card is not initialized yet there is nothing to do */
794 if (!snd_soc_card_is_instantiated(card))
795 return 0;
797 /* activate pins from sleep state */
798 for_each_card_components(card, component)
799 if (snd_soc_component_active(component))
800 pinctrl_pm_select_default_state(component->dev);
802 dev_dbg(dev, "ASoC: Scheduling resume work\n");
803 if (!schedule_work(&card->deferred_resume_work))
804 dev_err(dev, "ASoC: resume work item may be lost\n");
806 return 0;
808 EXPORT_SYMBOL_GPL(snd_soc_resume);
810 static void soc_resume_init(struct snd_soc_card *card)
812 /* deferred resume work */
813 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
815 #else
816 #define snd_soc_suspend NULL
817 #define snd_soc_resume NULL
818 static inline void soc_resume_init(struct snd_soc_card *card) { }
819 #endif
821 static struct device_node
822 *soc_component_to_node(struct snd_soc_component *component)
824 struct device_node *of_node;
826 of_node = component->dev->of_node;
827 if (!of_node && component->dev->parent)
828 of_node = component->dev->parent->of_node;
830 return of_node;
833 struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev,
834 const struct of_phandle_args *args)
836 struct of_phandle_args *ret = devm_kzalloc(dev, sizeof(*ret), GFP_KERNEL);
838 if (!ret)
839 return NULL;
841 *ret = *args;
843 return ret;
845 EXPORT_SYMBOL_GPL(snd_soc_copy_dai_args);
847 static int snd_soc_is_matching_component(
848 const struct snd_soc_dai_link_component *dlc,
849 struct snd_soc_component *component)
851 struct device_node *component_of_node;
853 if (!dlc)
854 return 0;
856 if (dlc->dai_args) {
857 struct snd_soc_dai *dai;
859 for_each_component_dais(component, dai)
860 if (snd_soc_is_matching_dai(dlc, dai))
861 return 1;
862 return 0;
865 component_of_node = soc_component_to_node(component);
867 if (dlc->of_node && component_of_node != dlc->of_node)
868 return 0;
869 if (dlc->name && strcmp(component->name, dlc->name))
870 return 0;
872 return 1;
875 static struct snd_soc_component *soc_find_component(
876 const struct snd_soc_dai_link_component *dlc)
878 struct snd_soc_component *component;
880 lockdep_assert_held(&client_mutex);
883 * NOTE
885 * It returns *1st* found component, but some driver
886 * has few components by same of_node/name
887 * ex)
888 * CPU component and generic DMAEngine component
890 for_each_component(component)
891 if (snd_soc_is_matching_component(dlc, component))
892 return component;
894 return NULL;
898 * snd_soc_find_dai - Find a registered DAI
900 * @dlc: name of the DAI or the DAI driver and optional component info to match
902 * This function will search all registered components and their DAIs to
903 * find the DAI of the same name. The component's of_node and name
904 * should also match if being specified.
906 * Return: pointer of DAI, or NULL if not found.
908 struct snd_soc_dai *snd_soc_find_dai(
909 const struct snd_soc_dai_link_component *dlc)
911 struct snd_soc_component *component;
912 struct snd_soc_dai *dai;
914 lockdep_assert_held(&client_mutex);
916 /* Find CPU DAI from registered DAIs */
917 for_each_component(component)
918 if (snd_soc_is_matching_component(dlc, component))
919 for_each_component_dais(component, dai)
920 if (snd_soc_is_matching_dai(dlc, dai))
921 return dai;
923 return NULL;
925 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
927 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
928 const struct snd_soc_dai_link_component *dlc)
930 struct snd_soc_dai *dai;
932 mutex_lock(&client_mutex);
933 dai = snd_soc_find_dai(dlc);
934 mutex_unlock(&client_mutex);
936 return dai;
938 EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
940 static int soc_dai_link_sanity_check(struct snd_soc_card *card,
941 struct snd_soc_dai_link *link)
943 int i;
944 struct snd_soc_dai_link_component *dlc;
946 /* Codec check */
947 for_each_link_codecs(link, i, dlc) {
949 * Codec must be specified by 1 of name or OF node,
950 * not both or neither.
952 if (snd_soc_dlc_component_is_invalid(dlc))
953 goto component_invalid;
955 if (snd_soc_dlc_component_is_empty(dlc))
956 goto component_empty;
958 /* Codec DAI name must be specified */
959 if (snd_soc_dlc_dai_is_empty(dlc))
960 goto dai_empty;
963 * Defer card registration if codec component is not added to
964 * component list.
966 if (!soc_find_component(dlc))
967 goto component_not_found;
970 /* Platform check */
971 for_each_link_platforms(link, i, dlc) {
973 * Platform may be specified by either name or OF node, but it
974 * can be left unspecified, then no components will be inserted
975 * in the rtdcom list
977 if (snd_soc_dlc_component_is_invalid(dlc))
978 goto component_invalid;
980 if (snd_soc_dlc_component_is_empty(dlc))
981 goto component_empty;
984 * Defer card registration if platform component is not added to
985 * component list.
987 if (!soc_find_component(dlc))
988 goto component_not_found;
991 /* CPU check */
992 for_each_link_cpus(link, i, dlc) {
994 * CPU device may be specified by either name or OF node, but
995 * can be left unspecified, and will be matched based on DAI
996 * name alone..
998 if (snd_soc_dlc_component_is_invalid(dlc))
999 goto component_invalid;
1002 if (snd_soc_dlc_component_is_empty(dlc)) {
1004 * At least one of CPU DAI name or CPU device name/node must be specified
1006 if (snd_soc_dlc_dai_is_empty(dlc))
1007 goto component_dai_empty;
1008 } else {
1010 * Defer card registration if Component is not added
1012 if (!soc_find_component(dlc))
1013 goto component_not_found;
1017 return 0;
1019 component_invalid:
1020 dev_err(card->dev, "ASoC: Both Component name/of_node are set for %s\n", link->name);
1021 return -EINVAL;
1023 component_empty:
1024 dev_err(card->dev, "ASoC: Neither Component name/of_node are set for %s\n", link->name);
1025 return -EINVAL;
1027 component_not_found:
1028 dev_dbg(card->dev, "ASoC: Component %s not found for link %s\n", dlc->name, link->name);
1029 return -EPROBE_DEFER;
1031 dai_empty:
1032 dev_err(card->dev, "ASoC: DAI name is not set for %s\n", link->name);
1033 return -EINVAL;
1035 component_dai_empty:
1036 dev_err(card->dev, "ASoC: Neither DAI/Component name/of_node are set for %s\n", link->name);
1037 return -EINVAL;
1040 #define MAX_DEFAULT_CH_MAP_SIZE 8
1041 static struct snd_soc_dai_link_ch_map default_ch_map_sync[MAX_DEFAULT_CH_MAP_SIZE] = {
1042 { .cpu = 0, .codec = 0 },
1043 { .cpu = 1, .codec = 1 },
1044 { .cpu = 2, .codec = 2 },
1045 { .cpu = 3, .codec = 3 },
1046 { .cpu = 4, .codec = 4 },
1047 { .cpu = 5, .codec = 5 },
1048 { .cpu = 6, .codec = 6 },
1049 { .cpu = 7, .codec = 7 },
1051 static struct snd_soc_dai_link_ch_map default_ch_map_1cpu[MAX_DEFAULT_CH_MAP_SIZE] = {
1052 { .cpu = 0, .codec = 0 },
1053 { .cpu = 0, .codec = 1 },
1054 { .cpu = 0, .codec = 2 },
1055 { .cpu = 0, .codec = 3 },
1056 { .cpu = 0, .codec = 4 },
1057 { .cpu = 0, .codec = 5 },
1058 { .cpu = 0, .codec = 6 },
1059 { .cpu = 0, .codec = 7 },
1061 static struct snd_soc_dai_link_ch_map default_ch_map_1codec[MAX_DEFAULT_CH_MAP_SIZE] = {
1062 { .cpu = 0, .codec = 0 },
1063 { .cpu = 1, .codec = 0 },
1064 { .cpu = 2, .codec = 0 },
1065 { .cpu = 3, .codec = 0 },
1066 { .cpu = 4, .codec = 0 },
1067 { .cpu = 5, .codec = 0 },
1068 { .cpu = 6, .codec = 0 },
1069 { .cpu = 7, .codec = 0 },
1071 static int snd_soc_compensate_channel_connection_map(struct snd_soc_card *card,
1072 struct snd_soc_dai_link *dai_link)
1074 struct snd_soc_dai_link_ch_map *ch_maps;
1075 int i;
1078 * dai_link->ch_maps indicates how CPU/Codec are connected.
1079 * It will be a map seen from a larger number of DAI.
1080 * see
1081 * soc.h :: [dai_link->ch_maps Image sample]
1084 /* it should have ch_maps if connection was N:M */
1085 if (dai_link->num_cpus > 1 && dai_link->num_codecs > 1 &&
1086 dai_link->num_cpus != dai_link->num_codecs && !dai_link->ch_maps) {
1087 dev_err(card->dev, "need to have ch_maps when N:M connection (%s)",
1088 dai_link->name);
1089 return -EINVAL;
1092 /* do nothing if it has own maps */
1093 if (dai_link->ch_maps)
1094 goto sanity_check;
1096 /* check default map size */
1097 if (dai_link->num_cpus > MAX_DEFAULT_CH_MAP_SIZE ||
1098 dai_link->num_codecs > MAX_DEFAULT_CH_MAP_SIZE) {
1099 dev_err(card->dev, "soc-core.c needs update default_connection_maps");
1100 return -EINVAL;
1103 /* Compensate missing map for ... */
1104 if (dai_link->num_cpus == dai_link->num_codecs)
1105 dai_link->ch_maps = default_ch_map_sync; /* for 1:1 or N:N */
1106 else if (dai_link->num_cpus < dai_link->num_codecs)
1107 dai_link->ch_maps = default_ch_map_1cpu; /* for 1:N */
1108 else
1109 dai_link->ch_maps = default_ch_map_1codec; /* for N:1 */
1111 sanity_check:
1112 dev_dbg(card->dev, "dai_link %s\n", dai_link->stream_name);
1113 for_each_link_ch_maps(dai_link, i, ch_maps) {
1114 if ((ch_maps->cpu >= dai_link->num_cpus) ||
1115 (ch_maps->codec >= dai_link->num_codecs)) {
1116 dev_err(card->dev,
1117 "unexpected dai_link->ch_maps[%d] index (cpu(%d/%d) codec(%d/%d))",
1119 ch_maps->cpu, dai_link->num_cpus,
1120 ch_maps->codec, dai_link->num_codecs);
1121 return -EINVAL;
1124 dev_dbg(card->dev, " [%d] cpu%d <-> codec%d\n",
1125 i, ch_maps->cpu, ch_maps->codec);
1128 return 0;
1132 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
1133 * @card: The ASoC card to which the pcm_runtime has
1134 * @rtd: The pcm_runtime to remove
1136 * This function removes a pcm_runtime from the ASoC card.
1138 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1139 struct snd_soc_pcm_runtime *rtd)
1141 lockdep_assert_held(&client_mutex);
1144 * Notify the machine driver for extra destruction
1146 snd_soc_card_remove_dai_link(card, rtd->dai_link);
1148 soc_free_pcm_runtime(rtd);
1150 EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
1153 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
1154 * @card: The ASoC card to which the pcm_runtime is added
1155 * @dai_link: The DAI link to find pcm_runtime
1157 * This function adds a pcm_runtime ASoC card by using dai_link.
1159 * Note: Topology can use this API to add pcm_runtime when probing the
1160 * topology component. And machine drivers can still define static
1161 * DAI links in dai_link array.
1163 static int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1164 struct snd_soc_dai_link *dai_link)
1166 struct snd_soc_pcm_runtime *rtd;
1167 struct snd_soc_dai_link_component *codec, *platform, *cpu;
1168 struct snd_soc_component *component;
1169 int i, id, ret;
1171 lockdep_assert_held(&client_mutex);
1174 * Notify the machine driver for extra initialization
1176 ret = snd_soc_card_add_dai_link(card, dai_link);
1177 if (ret < 0)
1178 return ret;
1180 if (dai_link->ignore)
1181 return 0;
1183 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1185 ret = soc_dai_link_sanity_check(card, dai_link);
1186 if (ret < 0)
1187 return ret;
1189 rtd = soc_new_pcm_runtime(card, dai_link);
1190 if (!rtd)
1191 return -ENOMEM;
1193 for_each_link_cpus(dai_link, i, cpu) {
1194 snd_soc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
1195 if (!snd_soc_rtd_to_cpu(rtd, i)) {
1196 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1197 cpu->dai_name);
1198 goto _err_defer;
1200 snd_soc_rtd_add_component(rtd, snd_soc_rtd_to_cpu(rtd, i)->component);
1203 /* Find CODEC from registered CODECs */
1204 for_each_link_codecs(dai_link, i, codec) {
1205 snd_soc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1206 if (!snd_soc_rtd_to_codec(rtd, i)) {
1207 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1208 codec->dai_name);
1209 goto _err_defer;
1212 snd_soc_rtd_add_component(rtd, snd_soc_rtd_to_codec(rtd, i)->component);
1215 /* Find PLATFORM from registered PLATFORMs */
1216 for_each_link_platforms(dai_link, i, platform) {
1217 for_each_component(component) {
1218 if (!snd_soc_is_matching_component(platform, component))
1219 continue;
1221 if (snd_soc_component_is_dummy(component) && component->num_dai)
1222 continue;
1224 snd_soc_rtd_add_component(rtd, component);
1229 * Most drivers will register their PCMs using DAI link ordering but
1230 * topology based drivers can use the DAI link id field to set PCM
1231 * device number and then use rtd + a base offset of the BEs.
1233 * FIXME
1235 * This should be implemented by using "dai_link" feature instead of
1236 * "component" feature.
1238 id = rtd->id;
1239 for_each_rtd_components(rtd, i, component) {
1240 if (!component->driver->use_dai_pcm_id)
1241 continue;
1243 if (rtd->dai_link->no_pcm)
1244 id += component->driver->be_pcm_base;
1245 else
1246 id = rtd->dai_link->id;
1248 rtd->id = id;
1250 return 0;
1252 _err_defer:
1253 snd_soc_remove_pcm_runtime(card, rtd);
1254 return -EPROBE_DEFER;
1257 int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1258 struct snd_soc_dai_link *dai_link,
1259 int num_dai_link)
1261 for (int i = 0; i < num_dai_link; i++) {
1262 int ret;
1264 ret = snd_soc_compensate_channel_connection_map(card, dai_link + i);
1265 if (ret < 0)
1266 return ret;
1268 ret = snd_soc_add_pcm_runtime(card, dai_link + i);
1269 if (ret < 0)
1270 return ret;
1273 return 0;
1275 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtimes);
1277 static void snd_soc_runtime_get_dai_fmt(struct snd_soc_pcm_runtime *rtd)
1279 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1280 struct snd_soc_dai *dai, *not_used;
1281 u64 pos, possible_fmt;
1282 unsigned int mask = 0, dai_fmt = 0;
1283 int i, j, priority, pri, until;
1286 * Get selectable format from each DAIs.
1288 ****************************
1289 * NOTE
1290 * Using .auto_selectable_formats is not mandatory,
1291 * we can select format manually from Sound Card.
1292 * When use it, driver should list well tested format only.
1293 ****************************
1295 * ex)
1296 * auto_selectable_formats (= SND_SOC_POSSIBLE_xxx)
1297 * (A) (B) (C)
1298 * DAI0_: { 0x000F, 0x00F0, 0x0F00 };
1299 * DAI1 : { 0xF000, 0x0F00 };
1300 * (X) (Y)
1302 * "until" will be 3 in this case (MAX array size from DAI0 and DAI1)
1303 * Here is dev_dbg() message and comments
1305 * priority = 1
1306 * DAI0: (pri, fmt) = (1, 000000000000000F) // 1st check (A) DAI1 is not selected
1307 * DAI1: (pri, fmt) = (0, 0000000000000000) // Necessary Waste
1308 * DAI0: (pri, fmt) = (1, 000000000000000F) // 2nd check (A)
1309 * DAI1: (pri, fmt) = (1, 000000000000F000) // (X)
1310 * priority = 2
1311 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 3rd check (A) + (B)
1312 * DAI1: (pri, fmt) = (1, 000000000000F000) // (X)
1313 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 4th check (A) + (B)
1314 * DAI1: (pri, fmt) = (2, 000000000000FF00) // (X) + (Y)
1315 * priority = 3
1316 * DAI0: (pri, fmt) = (3, 0000000000000FFF) // 5th check (A) + (B) + (C)
1317 * DAI1: (pri, fmt) = (2, 000000000000FF00) // (X) + (Y)
1318 * found auto selected format: 0000000000000F00
1320 until = snd_soc_dai_get_fmt_max_priority(rtd);
1321 for (priority = 1; priority <= until; priority++) {
1322 for_each_rtd_dais(rtd, j, not_used) {
1324 possible_fmt = ULLONG_MAX;
1325 for_each_rtd_dais(rtd, i, dai) {
1326 u64 fmt = 0;
1328 pri = (j >= i) ? priority : priority - 1;
1329 fmt = snd_soc_dai_get_fmt(dai, pri);
1330 possible_fmt &= fmt;
1332 if (possible_fmt)
1333 goto found;
1336 /* Not Found */
1337 return;
1338 found:
1340 * convert POSSIBLE_DAIFMT to DAIFMT
1342 * Some basic/default settings on each is defined as 0.
1343 * see
1344 * SND_SOC_DAIFMT_NB_NF
1345 * SND_SOC_DAIFMT_GATED
1347 * SND_SOC_DAIFMT_xxx_MASK can't notice it if Sound Card specify
1348 * these value, and will be overwrite to auto selected value.
1350 * To avoid such issue, loop from 63 to 0 here.
1351 * Small number of SND_SOC_POSSIBLE_xxx will be Hi priority.
1352 * Basic/Default settings of each part and above are defined
1353 * as Hi priority (= small number) of SND_SOC_POSSIBLE_xxx.
1355 for (i = 63; i >= 0; i--) {
1356 pos = 1ULL << i;
1357 switch (possible_fmt & pos) {
1359 * for format
1361 case SND_SOC_POSSIBLE_DAIFMT_I2S:
1362 case SND_SOC_POSSIBLE_DAIFMT_RIGHT_J:
1363 case SND_SOC_POSSIBLE_DAIFMT_LEFT_J:
1364 case SND_SOC_POSSIBLE_DAIFMT_DSP_A:
1365 case SND_SOC_POSSIBLE_DAIFMT_DSP_B:
1366 case SND_SOC_POSSIBLE_DAIFMT_AC97:
1367 case SND_SOC_POSSIBLE_DAIFMT_PDM:
1368 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_FORMAT_MASK) | i;
1369 break;
1371 * for clock
1373 case SND_SOC_POSSIBLE_DAIFMT_CONT:
1374 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_CONT;
1375 break;
1376 case SND_SOC_POSSIBLE_DAIFMT_GATED:
1377 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_GATED;
1378 break;
1380 * for clock invert
1382 case SND_SOC_POSSIBLE_DAIFMT_NB_NF:
1383 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_NF;
1384 break;
1385 case SND_SOC_POSSIBLE_DAIFMT_NB_IF:
1386 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_IF;
1387 break;
1388 case SND_SOC_POSSIBLE_DAIFMT_IB_NF:
1389 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_NF;
1390 break;
1391 case SND_SOC_POSSIBLE_DAIFMT_IB_IF:
1392 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_IF;
1393 break;
1395 * for clock provider / consumer
1397 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFP:
1398 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFP;
1399 break;
1400 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFP:
1401 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFP;
1402 break;
1403 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFC:
1404 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFC;
1405 break;
1406 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFC:
1407 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFC;
1408 break;
1413 * Some driver might have very complex limitation.
1414 * In such case, user want to auto-select non-limitation part,
1415 * and want to manually specify complex part.
1417 * Or for example, if both CPU and Codec can be clock provider,
1418 * but because of its quality, user want to specify it manually.
1420 * Use manually specified settings if sound card did.
1422 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK))
1423 mask |= SND_SOC_DAIFMT_FORMAT_MASK;
1424 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_MASK))
1425 mask |= SND_SOC_DAIFMT_CLOCK_MASK;
1426 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_INV_MASK))
1427 mask |= SND_SOC_DAIFMT_INV_MASK;
1428 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK))
1429 mask |= SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
1431 dai_link->dai_fmt |= (dai_fmt & mask);
1435 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1436 * @rtd: The runtime for which the DAI link format should be changed
1437 * @dai_fmt: The new DAI link format
1439 * This function updates the DAI link format for all DAIs connected to the DAI
1440 * link for the specified runtime.
1442 * Note: For setups with a static format set the dai_fmt field in the
1443 * corresponding snd_dai_link struct instead of using this function.
1445 * Returns 0 on success, otherwise a negative error code.
1447 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1448 unsigned int dai_fmt)
1450 struct snd_soc_dai *cpu_dai;
1451 struct snd_soc_dai *codec_dai;
1452 unsigned int i;
1453 int ret;
1455 if (!dai_fmt)
1456 return 0;
1458 for_each_rtd_codec_dais(rtd, i, codec_dai) {
1459 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1460 if (ret != 0 && ret != -ENOTSUPP)
1461 return ret;
1464 /* Flip the polarity for the "CPU" end of link */
1465 dai_fmt = snd_soc_daifmt_clock_provider_flipped(dai_fmt);
1467 for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1468 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1469 if (ret != 0 && ret != -ENOTSUPP)
1470 return ret;
1473 return 0;
1475 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1477 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1478 struct snd_soc_pcm_runtime *rtd)
1480 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1481 struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0);
1482 int ret;
1484 /* do machine specific initialization */
1485 ret = snd_soc_link_init(rtd);
1486 if (ret < 0)
1487 return ret;
1489 snd_soc_runtime_get_dai_fmt(rtd);
1490 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1491 if (ret)
1492 goto err;
1494 /* add DPCM sysfs entries */
1495 soc_dpcm_debugfs_add(rtd);
1497 /* create compress_device if possible */
1498 ret = snd_soc_dai_compress_new(cpu_dai, rtd);
1499 if (ret != -ENOTSUPP)
1500 goto err;
1502 /* create the pcm */
1503 ret = soc_new_pcm(rtd);
1504 if (ret < 0) {
1505 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1506 dai_link->stream_name, ret);
1507 goto err;
1510 ret = snd_soc_pcm_dai_new(rtd);
1511 if (ret < 0)
1512 goto err;
1514 rtd->initialized = true;
1516 return 0;
1517 err:
1518 snd_soc_link_exit(rtd);
1519 return ret;
1522 static void soc_set_name_prefix(struct snd_soc_card *card,
1523 struct snd_soc_component *component)
1525 struct device_node *of_node = soc_component_to_node(component);
1526 const char *str;
1527 int ret, i;
1529 for (i = 0; i < card->num_configs; i++) {
1530 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1532 if (snd_soc_is_matching_component(&map->dlc, component) &&
1533 map->name_prefix) {
1534 component->name_prefix = map->name_prefix;
1535 return;
1540 * If there is no configuration table or no match in the table,
1541 * check if a prefix is provided in the node
1543 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1544 if (ret < 0)
1545 return;
1547 component->name_prefix = str;
1550 static void soc_remove_component(struct snd_soc_component *component,
1551 int probed)
1554 if (!component->card)
1555 return;
1557 if (probed)
1558 snd_soc_component_remove(component);
1560 list_del_init(&component->card_list);
1561 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1562 soc_cleanup_component_debugfs(component);
1563 component->card = NULL;
1564 snd_soc_component_module_put_when_remove(component);
1567 static int soc_probe_component(struct snd_soc_card *card,
1568 struct snd_soc_component *component)
1570 struct snd_soc_dapm_context *dapm =
1571 snd_soc_component_get_dapm(component);
1572 struct snd_soc_dai *dai;
1573 int probed = 0;
1574 int ret;
1576 if (snd_soc_component_is_dummy(component))
1577 return 0;
1579 if (component->card) {
1580 if (component->card != card) {
1581 dev_err(component->dev,
1582 "Trying to bind component \"%s\" to card \"%s\" but is already bound to card \"%s\"\n",
1583 component->name, card->name, component->card->name);
1584 return -ENODEV;
1586 return 0;
1589 ret = snd_soc_component_module_get_when_probe(component);
1590 if (ret < 0)
1591 return ret;
1593 component->card = card;
1594 soc_set_name_prefix(card, component);
1596 soc_init_component_debugfs(component);
1598 snd_soc_dapm_init(dapm, card, component);
1600 ret = snd_soc_dapm_new_controls(dapm,
1601 component->driver->dapm_widgets,
1602 component->driver->num_dapm_widgets);
1604 if (ret != 0) {
1605 dev_err(component->dev,
1606 "Failed to create new controls %d\n", ret);
1607 goto err_probe;
1610 for_each_component_dais(component, dai) {
1611 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1612 if (ret != 0) {
1613 dev_err(component->dev,
1614 "Failed to create DAI widgets %d\n", ret);
1615 goto err_probe;
1619 ret = snd_soc_component_probe(component);
1620 if (ret < 0)
1621 goto err_probe;
1623 WARN(dapm->idle_bias_off &&
1624 dapm->bias_level != SND_SOC_BIAS_OFF,
1625 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1626 component->name);
1627 probed = 1;
1630 * machine specific init
1631 * see
1632 * snd_soc_component_set_aux()
1634 ret = snd_soc_component_init(component);
1635 if (ret < 0)
1636 goto err_probe;
1638 ret = snd_soc_add_component_controls(component,
1639 component->driver->controls,
1640 component->driver->num_controls);
1641 if (ret < 0)
1642 goto err_probe;
1644 ret = snd_soc_dapm_add_routes(dapm,
1645 component->driver->dapm_routes,
1646 component->driver->num_dapm_routes);
1647 if (ret < 0) {
1648 if (card->disable_route_checks) {
1649 dev_info(card->dev,
1650 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1651 __func__);
1652 } else {
1653 dev_err(card->dev,
1654 "%s: snd_soc_dapm_add_routes failed: %d\n",
1655 __func__, ret);
1656 goto err_probe;
1660 /* see for_each_card_components */
1661 list_add(&component->card_list, &card->component_dev_list);
1663 err_probe:
1664 if (ret < 0)
1665 soc_remove_component(component, probed);
1667 return ret;
1670 static void soc_remove_link_dais(struct snd_soc_card *card)
1672 struct snd_soc_pcm_runtime *rtd;
1673 int order;
1675 for_each_comp_order(order) {
1676 for_each_card_rtds(card, rtd) {
1677 /* remove all rtd connected DAIs in good order */
1678 snd_soc_pcm_dai_remove(rtd, order);
1683 static int soc_probe_link_dais(struct snd_soc_card *card)
1685 struct snd_soc_pcm_runtime *rtd;
1686 int order, ret;
1688 for_each_comp_order(order) {
1689 for_each_card_rtds(card, rtd) {
1690 /* probe all rtd connected DAIs in good order */
1691 ret = snd_soc_pcm_dai_probe(rtd, order);
1692 if (ret)
1693 return ret;
1697 return 0;
1700 static void soc_remove_link_components(struct snd_soc_card *card)
1702 struct snd_soc_component *component;
1703 struct snd_soc_pcm_runtime *rtd;
1704 int i, order;
1706 for_each_comp_order(order) {
1707 for_each_card_rtds(card, rtd) {
1708 for_each_rtd_components(rtd, i, component) {
1709 if (component->driver->remove_order != order)
1710 continue;
1712 soc_remove_component(component, 1);
1718 static int soc_probe_link_components(struct snd_soc_card *card)
1720 struct snd_soc_component *component;
1721 struct snd_soc_pcm_runtime *rtd;
1722 int i, ret, order;
1724 for_each_comp_order(order) {
1725 for_each_card_rtds(card, rtd) {
1726 for_each_rtd_components(rtd, i, component) {
1727 if (component->driver->probe_order != order)
1728 continue;
1730 ret = soc_probe_component(card, component);
1731 if (ret < 0)
1732 return ret;
1737 return 0;
1740 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1742 struct snd_soc_component *component, *_component;
1744 for_each_card_auxs_safe(card, component, _component) {
1745 /* for snd_soc_component_init() */
1746 snd_soc_component_set_aux(component, NULL);
1747 list_del(&component->card_aux_list);
1751 static int soc_bind_aux_dev(struct snd_soc_card *card)
1753 struct snd_soc_component *component;
1754 struct snd_soc_aux_dev *aux;
1755 int i;
1757 for_each_card_pre_auxs(card, i, aux) {
1758 /* codecs, usually analog devices */
1759 component = soc_find_component(&aux->dlc);
1760 if (!component)
1761 return -EPROBE_DEFER;
1763 /* for snd_soc_component_init() */
1764 snd_soc_component_set_aux(component, aux);
1765 /* see for_each_card_auxs */
1766 list_add(&component->card_aux_list, &card->aux_comp_list);
1768 return 0;
1771 static int soc_probe_aux_devices(struct snd_soc_card *card)
1773 struct snd_soc_component *component;
1774 int order;
1775 int ret;
1777 for_each_comp_order(order) {
1778 for_each_card_auxs(card, component) {
1779 if (component->driver->probe_order != order)
1780 continue;
1782 ret = soc_probe_component(card, component);
1783 if (ret < 0)
1784 return ret;
1788 return 0;
1791 static void soc_remove_aux_devices(struct snd_soc_card *card)
1793 struct snd_soc_component *comp, *_comp;
1794 int order;
1796 for_each_comp_order(order) {
1797 for_each_card_auxs_safe(card, comp, _comp) {
1798 if (comp->driver->remove_order == order)
1799 soc_remove_component(comp, 1);
1804 #ifdef CONFIG_DMI
1806 * If a DMI filed contain strings in this blacklist (e.g.
1807 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1808 * as invalid and dropped when setting the card long name from DMI info.
1810 static const char * const dmi_blacklist[] = {
1811 "To be filled by OEM",
1812 "TBD by OEM",
1813 "Default String",
1814 "Board Manufacturer",
1815 "Board Vendor Name",
1816 "Board Product Name",
1817 NULL, /* terminator */
1821 * Trim special characters, and replace '-' with '_' since '-' is used to
1822 * separate different DMI fields in the card long name. Only number and
1823 * alphabet characters and a few separator characters are kept.
1825 static void cleanup_dmi_name(char *name)
1827 int i, j = 0;
1829 for (i = 0; name[i]; i++) {
1830 if (isalnum(name[i]) || (name[i] == '.')
1831 || (name[i] == '_'))
1832 name[j++] = name[i];
1833 else if (name[i] == '-')
1834 name[j++] = '_';
1837 name[j] = '\0';
1841 * Check if a DMI field is valid, i.e. not containing any string
1842 * in the black list.
1844 static int is_dmi_valid(const char *field)
1846 int i = 0;
1848 while (dmi_blacklist[i]) {
1849 if (strstr(field, dmi_blacklist[i]))
1850 return 0;
1851 i++;
1854 return 1;
1858 * Append a string to card->dmi_longname with character cleanups.
1860 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1862 char *dst = card->dmi_longname;
1863 size_t dst_len = sizeof(card->dmi_longname);
1864 size_t len;
1866 len = strlen(dst);
1867 snprintf(dst + len, dst_len - len, "-%s", str);
1869 len++; /* skip the separator "-" */
1870 if (len < dst_len)
1871 cleanup_dmi_name(dst + len);
1875 * snd_soc_set_dmi_name() - Register DMI names to card
1876 * @card: The card to register DMI names
1877 * @flavour: The flavour "differentiator" for the card amongst its peers.
1879 * An Intel machine driver may be used by many different devices but are
1880 * difficult for userspace to differentiate, since machine drivers usually
1881 * use their own name as the card short name and leave the card long name
1882 * blank. To differentiate such devices and fix bugs due to lack of
1883 * device-specific configurations, this function allows DMI info to be used
1884 * as the sound card long name, in the format of
1885 * "vendor-product-version-board"
1886 * (Character '-' is used to separate different DMI fields here).
1887 * This will help the user space to load the device-specific Use Case Manager
1888 * (UCM) configurations for the card.
1890 * Possible card long names may be:
1891 * DellInc.-XPS139343-01-0310JH
1892 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1893 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1895 * This function also supports flavoring the card longname to provide
1896 * the extra differentiation, like "vendor-product-version-board-flavor".
1898 * We only keep number and alphabet characters and a few separator characters
1899 * in the card long name since UCM in the user space uses the card long names
1900 * as card configuration directory names and AudoConf cannot support special
1901 * characters like SPACE.
1903 * Returns 0 on success, otherwise a negative error code.
1905 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1907 const char *vendor, *product, *board;
1909 if (card->long_name)
1910 return 0; /* long name already set by driver or from DMI */
1912 if (!dmi_available)
1913 return 0;
1915 /* make up dmi long name as: vendor-product-version-board */
1916 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1917 if (!vendor || !is_dmi_valid(vendor)) {
1918 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1919 return 0;
1922 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1923 cleanup_dmi_name(card->dmi_longname);
1925 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1926 if (product && is_dmi_valid(product)) {
1927 const char *product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1929 append_dmi_string(card, product);
1932 * some vendors like Lenovo may only put a self-explanatory
1933 * name in the product version field
1935 if (product_version && is_dmi_valid(product_version))
1936 append_dmi_string(card, product_version);
1939 board = dmi_get_system_info(DMI_BOARD_NAME);
1940 if (board && is_dmi_valid(board)) {
1941 if (!product || strcasecmp(board, product))
1942 append_dmi_string(card, board);
1943 } else if (!product) {
1944 /* fall back to using legacy name */
1945 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1946 return 0;
1949 /* Add flavour to dmi long name */
1950 if (flavour)
1951 append_dmi_string(card, flavour);
1953 /* set the card long name */
1954 card->long_name = card->dmi_longname;
1956 return 0;
1958 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1959 #endif /* CONFIG_DMI */
1961 static void soc_check_tplg_fes(struct snd_soc_card *card)
1963 struct snd_soc_component *component;
1964 const struct snd_soc_component_driver *comp_drv;
1965 struct snd_soc_dai_link *dai_link;
1966 int i;
1968 for_each_component(component) {
1970 /* does this component override BEs ? */
1971 if (!component->driver->ignore_machine)
1972 continue;
1974 /* for this machine ? */
1975 if (!strcmp(component->driver->ignore_machine,
1976 card->dev->driver->name))
1977 goto match;
1978 if (strcmp(component->driver->ignore_machine,
1979 dev_name(card->dev)))
1980 continue;
1981 match:
1982 /* machine matches, so override the rtd data */
1983 for_each_card_prelinks(card, i, dai_link) {
1985 /* ignore this FE */
1986 if (dai_link->dynamic) {
1987 dai_link->ignore = true;
1988 continue;
1991 dev_dbg(card->dev, "info: override BE DAI link %s\n",
1992 card->dai_link[i].name);
1994 /* override platform component */
1995 if (!dai_link->platforms) {
1996 dev_err(card->dev, "init platform error");
1997 continue;
2000 if (component->dev->of_node)
2001 dai_link->platforms->of_node = component->dev->of_node;
2002 else
2003 dai_link->platforms->name = component->name;
2005 /* convert non BE into BE */
2006 dai_link->no_pcm = 1;
2009 * override any BE fixups
2010 * see
2011 * snd_soc_link_be_hw_params_fixup()
2013 dai_link->be_hw_params_fixup =
2014 component->driver->be_hw_params_fixup;
2017 * most BE links don't set stream name, so set it to
2018 * dai link name if it's NULL to help bind widgets.
2020 if (!dai_link->stream_name)
2021 dai_link->stream_name = dai_link->name;
2024 /* Inform userspace we are using alternate topology */
2025 if (component->driver->topology_name_prefix) {
2027 /* topology shortname created? */
2028 if (!card->topology_shortname_created) {
2029 comp_drv = component->driver;
2031 snprintf(card->topology_shortname, 32, "%s-%s",
2032 comp_drv->topology_name_prefix,
2033 card->name);
2034 card->topology_shortname_created = true;
2037 /* use topology shortname */
2038 card->name = card->topology_shortname;
2043 #define soc_setup_card_name(card, name, name1, name2) \
2044 __soc_setup_card_name(card, name, sizeof(name), name1, name2)
2045 static void __soc_setup_card_name(struct snd_soc_card *card,
2046 char *name, int len,
2047 const char *name1, const char *name2)
2049 const char *src = name1 ? name1 : name2;
2050 int i;
2052 snprintf(name, len, "%s", src);
2054 if (name != card->snd_card->driver)
2055 return;
2058 * Name normalization (driver field)
2060 * The driver name is somewhat special, as it's used as a key for
2061 * searches in the user-space.
2063 * ex)
2064 * "abcd??efg" -> "abcd__efg"
2066 for (i = 0; i < len; i++) {
2067 switch (name[i]) {
2068 case '_':
2069 case '-':
2070 case '\0':
2071 break;
2072 default:
2073 if (!isalnum(name[i]))
2074 name[i] = '_';
2075 break;
2080 * The driver field should contain a valid string from the user view.
2081 * The wrapping usually does not work so well here. Set a smaller string
2082 * in the specific ASoC driver.
2084 if (strlen(src) > len - 1)
2085 dev_err(card->dev, "ASoC: driver name too long '%s' -> '%s'\n", src, name);
2088 static void soc_cleanup_card_resources(struct snd_soc_card *card)
2090 struct snd_soc_pcm_runtime *rtd, *n;
2092 if (card->snd_card)
2093 snd_card_disconnect_sync(card->snd_card);
2095 snd_soc_dapm_shutdown(card);
2097 /* release machine specific resources */
2098 for_each_card_rtds(card, rtd)
2099 if (rtd->initialized)
2100 snd_soc_link_exit(rtd);
2101 /* remove and free each DAI */
2102 soc_remove_link_dais(card);
2103 soc_remove_link_components(card);
2105 for_each_card_rtds_safe(card, rtd, n)
2106 snd_soc_remove_pcm_runtime(card, rtd);
2108 /* remove auxiliary devices */
2109 soc_remove_aux_devices(card);
2110 soc_unbind_aux_dev(card);
2112 snd_soc_dapm_free(&card->dapm);
2113 soc_cleanup_card_debugfs(card);
2115 /* remove the card */
2116 snd_soc_card_remove(card);
2118 if (card->snd_card) {
2119 snd_card_free(card->snd_card);
2120 card->snd_card = NULL;
2124 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
2126 if (snd_soc_card_is_instantiated(card)) {
2127 card->instantiated = false;
2128 snd_soc_flush_all_delayed_work(card);
2130 soc_cleanup_card_resources(card);
2131 if (!unregister)
2132 list_add(&card->list, &unbind_card_list);
2133 } else {
2134 if (unregister)
2135 list_del(&card->list);
2139 static int snd_soc_bind_card(struct snd_soc_card *card)
2141 struct snd_soc_pcm_runtime *rtd;
2142 struct snd_soc_component *component;
2143 int ret;
2145 mutex_lock(&client_mutex);
2146 snd_soc_card_mutex_lock_root(card);
2148 snd_soc_fill_dummy_dai(card);
2150 snd_soc_dapm_init(&card->dapm, card, NULL);
2152 /* check whether any platform is ignore machine FE and using topology */
2153 soc_check_tplg_fes(card);
2155 /* bind aux_devs too */
2156 ret = soc_bind_aux_dev(card);
2157 if (ret < 0)
2158 goto probe_end;
2160 /* add predefined DAI links to the list */
2161 card->num_rtd = 0;
2162 ret = snd_soc_add_pcm_runtimes(card, card->dai_link, card->num_links);
2163 if (ret < 0)
2164 goto probe_end;
2166 /* card bind complete so register a sound card */
2167 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2168 card->owner, 0, &card->snd_card);
2169 if (ret < 0) {
2170 dev_err(card->dev,
2171 "ASoC: can't create sound card for card %s: %d\n",
2172 card->name, ret);
2173 goto probe_end;
2176 soc_init_card_debugfs(card);
2178 soc_resume_init(card);
2180 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2181 card->num_dapm_widgets);
2182 if (ret < 0)
2183 goto probe_end;
2185 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2186 card->num_of_dapm_widgets);
2187 if (ret < 0)
2188 goto probe_end;
2190 /* initialise the sound card only once */
2191 ret = snd_soc_card_probe(card);
2192 if (ret < 0)
2193 goto probe_end;
2195 /* probe all components used by DAI links on this card */
2196 ret = soc_probe_link_components(card);
2197 if (ret < 0) {
2198 if (ret != -EPROBE_DEFER) {
2199 dev_err(card->dev,
2200 "ASoC: failed to instantiate card %d\n", ret);
2202 goto probe_end;
2205 /* probe auxiliary components */
2206 ret = soc_probe_aux_devices(card);
2207 if (ret < 0) {
2208 dev_err(card->dev,
2209 "ASoC: failed to probe aux component %d\n", ret);
2210 goto probe_end;
2213 /* probe all DAI links on this card */
2214 ret = soc_probe_link_dais(card);
2215 if (ret < 0) {
2216 dev_err(card->dev,
2217 "ASoC: failed to instantiate card %d\n", ret);
2218 goto probe_end;
2221 for_each_card_rtds(card, rtd) {
2222 ret = soc_init_pcm_runtime(card, rtd);
2223 if (ret < 0)
2224 goto probe_end;
2227 snd_soc_dapm_link_dai_widgets(card);
2228 snd_soc_dapm_connect_dai_link_widgets(card);
2230 ret = snd_soc_add_card_controls(card, card->controls,
2231 card->num_controls);
2232 if (ret < 0)
2233 goto probe_end;
2235 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2236 card->num_dapm_routes);
2237 if (ret < 0) {
2238 if (card->disable_route_checks) {
2239 dev_info(card->dev,
2240 "%s: disable_route_checks set, ignoring errors on add_routes\n",
2241 __func__);
2242 } else {
2243 dev_err(card->dev,
2244 "%s: snd_soc_dapm_add_routes failed: %d\n",
2245 __func__, ret);
2246 goto probe_end;
2250 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2251 card->num_of_dapm_routes);
2252 if (ret < 0)
2253 goto probe_end;
2255 /* try to set some sane longname if DMI is available */
2256 snd_soc_set_dmi_name(card, NULL);
2258 soc_setup_card_name(card, card->snd_card->shortname,
2259 card->name, NULL);
2260 soc_setup_card_name(card, card->snd_card->longname,
2261 card->long_name, card->name);
2262 soc_setup_card_name(card, card->snd_card->driver,
2263 card->driver_name, card->name);
2265 if (card->components) {
2266 /* the current implementation of snd_component_add() accepts */
2267 /* multiple components in the string separated by space, */
2268 /* but the string collision (identical string) check might */
2269 /* not work correctly */
2270 ret = snd_component_add(card->snd_card, card->components);
2271 if (ret < 0) {
2272 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
2273 card->name, ret);
2274 goto probe_end;
2278 ret = snd_soc_card_late_probe(card);
2279 if (ret < 0)
2280 goto probe_end;
2282 snd_soc_dapm_new_widgets(card);
2283 snd_soc_card_fixup_controls(card);
2285 ret = snd_card_register(card->snd_card);
2286 if (ret < 0) {
2287 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2288 ret);
2289 goto probe_end;
2292 card->instantiated = 1;
2293 dapm_mark_endpoints_dirty(card);
2294 snd_soc_dapm_sync(&card->dapm);
2296 /* deactivate pins to sleep state */
2297 for_each_card_components(card, component)
2298 if (!snd_soc_component_active(component))
2299 pinctrl_pm_select_sleep_state(component->dev);
2301 probe_end:
2302 if (ret < 0)
2303 soc_cleanup_card_resources(card);
2305 snd_soc_card_mutex_unlock(card);
2306 mutex_unlock(&client_mutex);
2308 return ret;
2311 /* probes a new socdev */
2312 static int soc_probe(struct platform_device *pdev)
2314 struct snd_soc_card *card = platform_get_drvdata(pdev);
2317 * no card, so machine driver should be registering card
2318 * we should not be here in that case so ret error
2320 if (!card)
2321 return -EINVAL;
2323 dev_warn(&pdev->dev,
2324 "ASoC: machine %s should use snd_soc_register_card()\n",
2325 card->name);
2327 /* Bodge while we unpick instantiation */
2328 card->dev = &pdev->dev;
2330 return devm_snd_soc_register_card(&pdev->dev, card);
2333 int snd_soc_poweroff(struct device *dev)
2335 struct snd_soc_card *card = dev_get_drvdata(dev);
2336 struct snd_soc_component *component;
2338 if (!snd_soc_card_is_instantiated(card))
2339 return 0;
2342 * Flush out pmdown_time work - we actually do want to run it
2343 * now, we're shutting down so no imminent restart.
2345 snd_soc_flush_all_delayed_work(card);
2347 snd_soc_dapm_shutdown(card);
2349 /* deactivate pins to sleep state */
2350 for_each_card_components(card, component)
2351 pinctrl_pm_select_sleep_state(component->dev);
2353 return 0;
2355 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2357 const struct dev_pm_ops snd_soc_pm_ops = {
2358 .suspend = snd_soc_suspend,
2359 .resume = snd_soc_resume,
2360 .freeze = snd_soc_suspend,
2361 .thaw = snd_soc_resume,
2362 .poweroff = snd_soc_poweroff,
2363 .restore = snd_soc_resume,
2365 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2367 /* ASoC platform driver */
2368 static struct platform_driver soc_driver = {
2369 .driver = {
2370 .name = "soc-audio",
2371 .pm = &snd_soc_pm_ops,
2373 .probe = soc_probe,
2377 * snd_soc_cnew - create new control
2378 * @_template: control template
2379 * @data: control private data
2380 * @long_name: control long name
2381 * @prefix: control name prefix
2383 * Create a new mixer control from a template control.
2385 * Returns 0 for success, else error.
2387 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2388 void *data, const char *long_name,
2389 const char *prefix)
2391 struct snd_kcontrol_new template;
2392 struct snd_kcontrol *kcontrol;
2393 char *name = NULL;
2395 memcpy(&template, _template, sizeof(template));
2396 template.index = 0;
2398 if (!long_name)
2399 long_name = template.name;
2401 if (prefix) {
2402 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2403 if (!name)
2404 return NULL;
2406 template.name = name;
2407 } else {
2408 template.name = long_name;
2411 kcontrol = snd_ctl_new1(&template, data);
2413 kfree(name);
2415 return kcontrol;
2417 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2419 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2420 const struct snd_kcontrol_new *controls, int num_controls,
2421 const char *prefix, void *data)
2423 int i;
2425 for (i = 0; i < num_controls; i++) {
2426 const struct snd_kcontrol_new *control = &controls[i];
2427 int err = snd_ctl_add(card, snd_soc_cnew(control, data,
2428 control->name, prefix));
2429 if (err < 0) {
2430 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2431 control->name, err);
2432 return err;
2436 return 0;
2440 * snd_soc_add_component_controls - Add an array of controls to a component.
2442 * @component: Component to add controls to
2443 * @controls: Array of controls to add
2444 * @num_controls: Number of elements in the array
2446 * Return: 0 for success, else error.
2448 int snd_soc_add_component_controls(struct snd_soc_component *component,
2449 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2451 struct snd_card *card = component->card->snd_card;
2453 return snd_soc_add_controls(card, component->dev, controls,
2454 num_controls, component->name_prefix, component);
2456 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2459 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2460 * Convenience function to add a list of controls.
2462 * @soc_card: SoC card to add controls to
2463 * @controls: array of controls to add
2464 * @num_controls: number of elements in the array
2466 * Return 0 for success, else error.
2468 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2469 const struct snd_kcontrol_new *controls, int num_controls)
2471 struct snd_card *card = soc_card->snd_card;
2473 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2474 NULL, soc_card);
2476 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2479 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2480 * Convenience function to add a list of controls.
2482 * @dai: DAI to add controls to
2483 * @controls: array of controls to add
2484 * @num_controls: number of elements in the array
2486 * Return 0 for success, else error.
2488 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2489 const struct snd_kcontrol_new *controls, int num_controls)
2491 struct snd_card *card = dai->component->card->snd_card;
2493 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2494 NULL, dai);
2496 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2499 * snd_soc_register_card - Register a card with the ASoC core
2501 * @card: Card to register
2504 int snd_soc_register_card(struct snd_soc_card *card)
2506 if (!card->name || !card->dev)
2507 return -EINVAL;
2509 dev_set_drvdata(card->dev, card);
2511 INIT_LIST_HEAD(&card->widgets);
2512 INIT_LIST_HEAD(&card->paths);
2513 INIT_LIST_HEAD(&card->dapm_list);
2514 INIT_LIST_HEAD(&card->aux_comp_list);
2515 INIT_LIST_HEAD(&card->component_dev_list);
2516 INIT_LIST_HEAD(&card->list);
2517 INIT_LIST_HEAD(&card->rtd_list);
2518 INIT_LIST_HEAD(&card->dapm_dirty);
2519 INIT_LIST_HEAD(&card->dobj_list);
2521 card->instantiated = 0;
2522 mutex_init(&card->mutex);
2523 mutex_init(&card->dapm_mutex);
2524 mutex_init(&card->pcm_mutex);
2526 return snd_soc_bind_card(card);
2528 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2531 * snd_soc_unregister_card - Unregister a card with the ASoC core
2533 * @card: Card to unregister
2536 void snd_soc_unregister_card(struct snd_soc_card *card)
2538 mutex_lock(&client_mutex);
2539 snd_soc_unbind_card(card, true);
2540 mutex_unlock(&client_mutex);
2541 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2543 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2546 * Simplify DAI link configuration by removing ".-1" from device names
2547 * and sanitizing names.
2549 static char *fmt_single_name(struct device *dev, int *id)
2551 const char *devname = dev_name(dev);
2552 char *found, *name;
2553 unsigned int id1, id2;
2555 if (devname == NULL)
2556 return NULL;
2558 name = devm_kstrdup(dev, devname, GFP_KERNEL);
2559 if (!name)
2560 return NULL;
2562 /* are we a "%s.%d" name (platform and SPI components) */
2563 found = strstr(name, dev->driver->name);
2564 if (found) {
2565 /* get ID */
2566 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2568 /* discard ID from name if ID == -1 */
2569 if (*id == -1)
2570 found[strlen(dev->driver->name)] = '\0';
2573 /* I2C component devices are named "bus-addr" */
2574 } else if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2576 /* create unique ID number from I2C addr and bus */
2577 *id = ((id1 & 0xffff) << 16) + id2;
2579 devm_kfree(dev, name);
2581 /* sanitize component name for DAI link creation */
2582 name = devm_kasprintf(dev, GFP_KERNEL, "%s.%s", dev->driver->name, devname);
2583 } else {
2584 *id = 0;
2587 return name;
2591 * Simplify DAI link naming for single devices with multiple DAIs by removing
2592 * any ".-1" and using the DAI name (instead of device name).
2594 static inline char *fmt_multiple_name(struct device *dev,
2595 struct snd_soc_dai_driver *dai_drv)
2597 if (dai_drv->name == NULL) {
2598 dev_err(dev,
2599 "ASoC: error - multiple DAI %s registered with no name\n",
2600 dev_name(dev));
2601 return NULL;
2604 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2607 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2609 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2610 list_del(&dai->list);
2612 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2615 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2617 * @component: The component the DAIs are registered for
2618 * @dai_drv: DAI driver to use for the DAI
2619 * @legacy_dai_naming: if %true, use legacy single-name format;
2620 * if %false, use multiple-name format;
2622 * Topology can use this API to register DAIs when probing a component.
2623 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2624 * will be freed in the component cleanup.
2626 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2627 struct snd_soc_dai_driver *dai_drv,
2628 bool legacy_dai_naming)
2630 struct device *dev = component->dev;
2631 struct snd_soc_dai *dai;
2633 lockdep_assert_held(&client_mutex);
2635 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2636 if (dai == NULL)
2637 return NULL;
2640 * Back in the old days when we still had component-less DAIs,
2641 * instead of having a static name, component-less DAIs would
2642 * inherit the name of the parent device so it is possible to
2643 * register multiple instances of the DAI. We still need to keep
2644 * the same naming style even though those DAIs are not
2645 * component-less anymore.
2647 if (legacy_dai_naming &&
2648 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2649 dai->name = fmt_single_name(dev, &dai->id);
2650 } else {
2651 dai->name = fmt_multiple_name(dev, dai_drv);
2652 if (dai_drv->id)
2653 dai->id = dai_drv->id;
2654 else
2655 dai->id = component->num_dai;
2657 if (!dai->name)
2658 return NULL;
2660 dai->component = component;
2661 dai->dev = dev;
2662 dai->driver = dai_drv;
2664 /* see for_each_component_dais */
2665 list_add_tail(&dai->list, &component->dai_list);
2666 component->num_dai++;
2668 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2669 return dai;
2671 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2674 * snd_soc_unregister_dais - Unregister DAIs from the ASoC core
2676 * @component: The component for which the DAIs should be unregistered
2678 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2680 struct snd_soc_dai *dai, *_dai;
2682 for_each_component_dais_safe(component, dai, _dai)
2683 snd_soc_unregister_dai(dai);
2687 * snd_soc_register_dais - Register a DAI with the ASoC core
2689 * @component: The component the DAIs are registered for
2690 * @dai_drv: DAI driver to use for the DAIs
2691 * @count: Number of DAIs
2693 static int snd_soc_register_dais(struct snd_soc_component *component,
2694 struct snd_soc_dai_driver *dai_drv,
2695 size_t count)
2697 struct snd_soc_dai *dai;
2698 unsigned int i;
2699 int ret;
2701 for (i = 0; i < count; i++) {
2702 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2703 component->driver->legacy_dai_naming);
2704 if (dai == NULL) {
2705 ret = -ENOMEM;
2706 goto err;
2710 return 0;
2712 err:
2713 snd_soc_unregister_dais(component);
2715 return ret;
2718 #define ENDIANNESS_MAP(name) \
2719 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2720 static u64 endianness_format_map[] = {
2721 ENDIANNESS_MAP(S16_),
2722 ENDIANNESS_MAP(U16_),
2723 ENDIANNESS_MAP(S24_),
2724 ENDIANNESS_MAP(U24_),
2725 ENDIANNESS_MAP(S32_),
2726 ENDIANNESS_MAP(U32_),
2727 ENDIANNESS_MAP(S24_3),
2728 ENDIANNESS_MAP(U24_3),
2729 ENDIANNESS_MAP(S20_3),
2730 ENDIANNESS_MAP(U20_3),
2731 ENDIANNESS_MAP(S18_3),
2732 ENDIANNESS_MAP(U18_3),
2733 ENDIANNESS_MAP(FLOAT_),
2734 ENDIANNESS_MAP(FLOAT64_),
2735 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2739 * Fix up the DAI formats for endianness: codecs don't actually see
2740 * the endianness of the data but we're using the CPU format
2741 * definitions which do need to include endianness so we ensure that
2742 * codec DAIs always have both big and little endian variants set.
2744 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2746 int i;
2748 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2749 if (stream->formats & endianness_format_map[i])
2750 stream->formats |= endianness_format_map[i];
2753 static void snd_soc_try_rebind_card(void)
2755 struct snd_soc_card *card, *c;
2757 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2758 if (!snd_soc_bind_card(card))
2759 list_del(&card->list);
2762 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2764 struct snd_soc_card *card = component->card;
2766 snd_soc_unregister_dais(component);
2768 if (card)
2769 snd_soc_unbind_card(card, false);
2771 list_del(&component->list);
2774 int snd_soc_component_initialize(struct snd_soc_component *component,
2775 const struct snd_soc_component_driver *driver,
2776 struct device *dev)
2778 INIT_LIST_HEAD(&component->dai_list);
2779 INIT_LIST_HEAD(&component->dobj_list);
2780 INIT_LIST_HEAD(&component->card_list);
2781 INIT_LIST_HEAD(&component->list);
2782 mutex_init(&component->io_mutex);
2784 if (!component->name) {
2785 component->name = fmt_single_name(dev, &component->id);
2786 if (!component->name) {
2787 dev_err(dev, "ASoC: Failed to allocate name\n");
2788 return -ENOMEM;
2792 component->dev = dev;
2793 component->driver = driver;
2795 #ifdef CONFIG_DEBUG_FS
2796 if (!component->debugfs_prefix)
2797 component->debugfs_prefix = driver->debugfs_prefix;
2798 #endif
2800 return 0;
2802 EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2804 int snd_soc_add_component(struct snd_soc_component *component,
2805 struct snd_soc_dai_driver *dai_drv,
2806 int num_dai)
2808 int ret;
2809 int i;
2811 mutex_lock(&client_mutex);
2813 if (component->driver->endianness) {
2814 for (i = 0; i < num_dai; i++) {
2815 convert_endianness_formats(&dai_drv[i].playback);
2816 convert_endianness_formats(&dai_drv[i].capture);
2820 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2821 if (ret < 0) {
2822 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2823 ret);
2824 goto err_cleanup;
2827 if (!component->driver->write && !component->driver->read) {
2828 if (!component->regmap)
2829 component->regmap = dev_get_regmap(component->dev,
2830 NULL);
2831 if (component->regmap)
2832 snd_soc_component_setup_regmap(component);
2835 /* see for_each_component */
2836 list_add(&component->list, &component_list);
2838 err_cleanup:
2839 if (ret < 0)
2840 snd_soc_del_component_unlocked(component);
2842 mutex_unlock(&client_mutex);
2844 if (ret == 0)
2845 snd_soc_try_rebind_card();
2847 return ret;
2849 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2851 int snd_soc_register_component(struct device *dev,
2852 const struct snd_soc_component_driver *component_driver,
2853 struct snd_soc_dai_driver *dai_drv,
2854 int num_dai)
2856 struct snd_soc_component *component;
2857 int ret;
2859 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2860 if (!component)
2861 return -ENOMEM;
2863 ret = snd_soc_component_initialize(component, component_driver, dev);
2864 if (ret < 0)
2865 return ret;
2867 return snd_soc_add_component(component, dai_drv, num_dai);
2869 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2872 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2873 * from the ASoC core
2875 * @dev: The device to unregister
2876 * @component_driver: The component driver to unregister
2878 void snd_soc_unregister_component_by_driver(struct device *dev,
2879 const struct snd_soc_component_driver *component_driver)
2881 struct snd_soc_component *component;
2883 if (!component_driver)
2884 return;
2886 mutex_lock(&client_mutex);
2887 component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2888 if (!component)
2889 goto out;
2891 snd_soc_del_component_unlocked(component);
2893 out:
2894 mutex_unlock(&client_mutex);
2896 EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2899 * snd_soc_unregister_component - Unregister all related component
2900 * from the ASoC core
2902 * @dev: The device to unregister
2904 void snd_soc_unregister_component(struct device *dev)
2906 mutex_lock(&client_mutex);
2907 while (1) {
2908 struct snd_soc_component *component = snd_soc_lookup_component_nolocked(dev, NULL);
2910 if (!component)
2911 break;
2913 snd_soc_del_component_unlocked(component);
2915 mutex_unlock(&client_mutex);
2917 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2919 /* Retrieve a card's name from device tree */
2920 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2921 const char *propname)
2923 struct device_node *np;
2924 int ret;
2926 if (!card->dev) {
2927 pr_err("card->dev is not set before calling %s\n", __func__);
2928 return -EINVAL;
2931 np = card->dev->of_node;
2933 ret = of_property_read_string_index(np, propname, 0, &card->name);
2935 * EINVAL means the property does not exist. This is fine providing
2936 * card->name was previously set, which is checked later in
2937 * snd_soc_register_card.
2939 if (ret < 0 && ret != -EINVAL) {
2940 dev_err(card->dev,
2941 "ASoC: Property '%s' could not be read: %d\n",
2942 propname, ret);
2943 return ret;
2946 return 0;
2948 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2950 static const struct snd_soc_dapm_widget simple_widgets[] = {
2951 SND_SOC_DAPM_MIC("Microphone", NULL),
2952 SND_SOC_DAPM_LINE("Line", NULL),
2953 SND_SOC_DAPM_HP("Headphone", NULL),
2954 SND_SOC_DAPM_SPK("Speaker", NULL),
2957 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2958 const char *propname)
2960 struct device_node *np = card->dev->of_node;
2961 struct snd_soc_dapm_widget *widgets;
2962 const char *template, *wname;
2963 int i, j, num_widgets;
2965 num_widgets = of_property_count_strings(np, propname);
2966 if (num_widgets < 0) {
2967 dev_err(card->dev,
2968 "ASoC: Property '%s' does not exist\n", propname);
2969 return -EINVAL;
2971 if (!num_widgets) {
2972 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2973 propname);
2974 return -EINVAL;
2976 if (num_widgets & 1) {
2977 dev_err(card->dev,
2978 "ASoC: Property '%s' length is not even\n", propname);
2979 return -EINVAL;
2982 num_widgets /= 2;
2984 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2985 GFP_KERNEL);
2986 if (!widgets) {
2987 dev_err(card->dev,
2988 "ASoC: Could not allocate memory for widgets\n");
2989 return -ENOMEM;
2992 for (i = 0; i < num_widgets; i++) {
2993 int ret = of_property_read_string_index(np, propname,
2994 2 * i, &template);
2995 if (ret) {
2996 dev_err(card->dev,
2997 "ASoC: Property '%s' index %d read error:%d\n",
2998 propname, 2 * i, ret);
2999 return -EINVAL;
3002 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3003 if (!strncmp(template, simple_widgets[j].name,
3004 strlen(simple_widgets[j].name))) {
3005 widgets[i] = simple_widgets[j];
3006 break;
3010 if (j >= ARRAY_SIZE(simple_widgets)) {
3011 dev_err(card->dev,
3012 "ASoC: DAPM widget '%s' is not supported\n",
3013 template);
3014 return -EINVAL;
3017 ret = of_property_read_string_index(np, propname,
3018 (2 * i) + 1,
3019 &wname);
3020 if (ret) {
3021 dev_err(card->dev,
3022 "ASoC: Property '%s' index %d read error:%d\n",
3023 propname, (2 * i) + 1, ret);
3024 return -EINVAL;
3027 widgets[i].name = wname;
3030 card->of_dapm_widgets = widgets;
3031 card->num_of_dapm_widgets = num_widgets;
3033 return 0;
3035 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3037 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop)
3039 const unsigned int nb_controls_max = 16;
3040 const char **strings, *control_name;
3041 struct snd_kcontrol_new *controls;
3042 struct device *dev = card->dev;
3043 unsigned int i, nb_controls;
3044 int ret;
3046 if (!of_property_read_bool(dev->of_node, prop))
3047 return 0;
3049 strings = devm_kcalloc(dev, nb_controls_max,
3050 sizeof(*strings), GFP_KERNEL);
3051 if (!strings)
3052 return -ENOMEM;
3054 ret = of_property_read_string_array(dev->of_node, prop,
3055 strings, nb_controls_max);
3056 if (ret < 0)
3057 return ret;
3059 nb_controls = (unsigned int)ret;
3061 controls = devm_kcalloc(dev, nb_controls,
3062 sizeof(*controls), GFP_KERNEL);
3063 if (!controls)
3064 return -ENOMEM;
3066 for (i = 0; i < nb_controls; i++) {
3067 control_name = devm_kasprintf(dev, GFP_KERNEL,
3068 "%s Switch", strings[i]);
3069 if (!control_name)
3070 return -ENOMEM;
3072 controls[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
3073 controls[i].name = control_name;
3074 controls[i].info = snd_soc_dapm_info_pin_switch;
3075 controls[i].get = snd_soc_dapm_get_pin_switch;
3076 controls[i].put = snd_soc_dapm_put_pin_switch;
3077 controls[i].private_value = (unsigned long)strings[i];
3080 card->controls = controls;
3081 card->num_controls = nb_controls;
3083 return 0;
3085 EXPORT_SYMBOL_GPL(snd_soc_of_parse_pin_switches);
3087 int snd_soc_of_get_slot_mask(struct device_node *np,
3088 const char *prop_name,
3089 unsigned int *mask)
3091 u32 val;
3092 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3093 int i;
3095 if (!of_slot_mask)
3096 return 0;
3097 val /= sizeof(u32);
3098 for (i = 0; i < val; i++)
3099 if (be32_to_cpup(&of_slot_mask[i]))
3100 *mask |= (1 << i);
3102 return val;
3104 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
3106 int snd_soc_of_parse_tdm_slot(struct device_node *np,
3107 unsigned int *tx_mask,
3108 unsigned int *rx_mask,
3109 unsigned int *slots,
3110 unsigned int *slot_width)
3112 u32 val;
3113 int ret;
3115 if (tx_mask)
3116 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3117 if (rx_mask)
3118 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3120 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3121 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3122 if (ret)
3123 return ret;
3125 if (slots)
3126 *slots = val;
3129 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3130 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3131 if (ret)
3132 return ret;
3134 if (slot_width)
3135 *slot_width = val;
3138 return 0;
3140 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3142 void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
3143 struct snd_soc_dai_link_component *cpus)
3145 platforms->of_node = cpus->of_node;
3146 platforms->dai_args = cpus->dai_args;
3148 EXPORT_SYMBOL_GPL(snd_soc_dlc_use_cpu_as_platform);
3150 void snd_soc_of_parse_node_prefix(struct device_node *np,
3151 struct snd_soc_codec_conf *codec_conf,
3152 struct device_node *of_node,
3153 const char *propname)
3155 const char *str;
3156 int ret;
3158 ret = of_property_read_string(np, propname, &str);
3159 if (ret < 0) {
3160 /* no prefix is not error */
3161 return;
3164 codec_conf->dlc.of_node = of_node;
3165 codec_conf->name_prefix = str;
3167 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
3169 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3170 const char *propname)
3172 struct device_node *np = card->dev->of_node;
3173 int num_routes;
3174 struct snd_soc_dapm_route *routes;
3175 int i;
3177 num_routes = of_property_count_strings(np, propname);
3178 if (num_routes < 0 || num_routes & 1) {
3179 dev_err(card->dev,
3180 "ASoC: Property '%s' does not exist or its length is not even\n",
3181 propname);
3182 return -EINVAL;
3184 num_routes /= 2;
3186 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
3187 GFP_KERNEL);
3188 if (!routes) {
3189 dev_err(card->dev,
3190 "ASoC: Could not allocate DAPM route table\n");
3191 return -ENOMEM;
3194 for (i = 0; i < num_routes; i++) {
3195 int ret = of_property_read_string_index(np, propname,
3196 2 * i, &routes[i].sink);
3197 if (ret) {
3198 dev_err(card->dev,
3199 "ASoC: Property '%s' index %d could not be read: %d\n",
3200 propname, 2 * i, ret);
3201 return -EINVAL;
3203 ret = of_property_read_string_index(np, propname,
3204 (2 * i) + 1, &routes[i].source);
3205 if (ret) {
3206 dev_err(card->dev,
3207 "ASoC: Property '%s' index %d could not be read: %d\n",
3208 propname, (2 * i) + 1, ret);
3209 return -EINVAL;
3213 card->num_of_dapm_routes = num_routes;
3214 card->of_dapm_routes = routes;
3216 return 0;
3218 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3220 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname)
3222 struct device_node *node = card->dev->of_node;
3223 struct snd_soc_aux_dev *aux;
3224 int num, i;
3226 num = of_count_phandle_with_args(node, propname, NULL);
3227 if (num == -ENOENT) {
3228 return 0;
3229 } else if (num < 0) {
3230 dev_err(card->dev, "ASOC: Property '%s' could not be read: %d\n",
3231 propname, num);
3232 return num;
3235 aux = devm_kcalloc(card->dev, num, sizeof(*aux), GFP_KERNEL);
3236 if (!aux)
3237 return -ENOMEM;
3238 card->aux_dev = aux;
3239 card->num_aux_devs = num;
3241 for_each_card_pre_auxs(card, i, aux) {
3242 aux->dlc.of_node = of_parse_phandle(node, propname, i);
3243 if (!aux->dlc.of_node)
3244 return -EINVAL;
3247 return 0;
3249 EXPORT_SYMBOL_GPL(snd_soc_of_parse_aux_devs);
3251 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt)
3253 unsigned int inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
3255 switch (dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
3256 case SND_SOC_DAIFMT_CBP_CFP:
3257 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
3258 break;
3259 case SND_SOC_DAIFMT_CBP_CFC:
3260 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
3261 break;
3262 case SND_SOC_DAIFMT_CBC_CFP:
3263 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
3264 break;
3265 case SND_SOC_DAIFMT_CBC_CFC:
3266 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
3267 break;
3270 return inv_dai_fmt;
3272 EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_flipped);
3274 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame)
3277 * bit_frame is return value from
3278 * snd_soc_daifmt_parse_clock_provider_raw()
3281 /* Codec base */
3282 switch (bit_frame) {
3283 case 0x11:
3284 return SND_SOC_DAIFMT_CBP_CFP;
3285 case 0x10:
3286 return SND_SOC_DAIFMT_CBP_CFC;
3287 case 0x01:
3288 return SND_SOC_DAIFMT_CBC_CFP;
3289 default:
3290 return SND_SOC_DAIFMT_CBC_CFC;
3293 return 0;
3295 EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_from_bitmap);
3297 unsigned int snd_soc_daifmt_parse_format(struct device_node *np,
3298 const char *prefix)
3300 int ret;
3301 char prop[128];
3302 unsigned int format = 0;
3303 int bit, frame;
3304 const char *str;
3305 struct {
3306 char *name;
3307 unsigned int val;
3308 } of_fmt_table[] = {
3309 { "i2s", SND_SOC_DAIFMT_I2S },
3310 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
3311 { "left_j", SND_SOC_DAIFMT_LEFT_J },
3312 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
3313 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
3314 { "ac97", SND_SOC_DAIFMT_AC97 },
3315 { "pdm", SND_SOC_DAIFMT_PDM},
3316 { "msb", SND_SOC_DAIFMT_MSB },
3317 { "lsb", SND_SOC_DAIFMT_LSB },
3320 if (!prefix)
3321 prefix = "";
3324 * check "dai-format = xxx"
3325 * or "[prefix]format = xxx"
3326 * SND_SOC_DAIFMT_FORMAT_MASK area
3328 ret = of_property_read_string(np, "dai-format", &str);
3329 if (ret < 0) {
3330 snprintf(prop, sizeof(prop), "%sformat", prefix);
3331 ret = of_property_read_string(np, prop, &str);
3333 if (ret == 0) {
3334 int i;
3336 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3337 if (strcmp(str, of_fmt_table[i].name) == 0) {
3338 format |= of_fmt_table[i].val;
3339 break;
3345 * check "[prefix]continuous-clock"
3346 * SND_SOC_DAIFMT_CLOCK_MASK area
3348 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3349 if (of_property_read_bool(np, prop))
3350 format |= SND_SOC_DAIFMT_CONT;
3351 else
3352 format |= SND_SOC_DAIFMT_GATED;
3355 * check "[prefix]bitclock-inversion"
3356 * check "[prefix]frame-inversion"
3357 * SND_SOC_DAIFMT_INV_MASK area
3359 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3360 bit = of_property_read_bool(np, prop);
3362 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3363 frame = of_property_read_bool(np, prop);
3365 switch ((bit << 4) + frame) {
3366 case 0x11:
3367 format |= SND_SOC_DAIFMT_IB_IF;
3368 break;
3369 case 0x10:
3370 format |= SND_SOC_DAIFMT_IB_NF;
3371 break;
3372 case 0x01:
3373 format |= SND_SOC_DAIFMT_NB_IF;
3374 break;
3375 default:
3376 /* SND_SOC_DAIFMT_NB_NF is default */
3377 break;
3380 return format;
3382 EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_format);
3384 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
3385 const char *prefix,
3386 struct device_node **bitclkmaster,
3387 struct device_node **framemaster)
3389 char prop[128];
3390 unsigned int bit, frame;
3392 if (!prefix)
3393 prefix = "";
3396 * check "[prefix]bitclock-master"
3397 * check "[prefix]frame-master"
3399 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3400 bit = of_property_read_bool(np, prop);
3401 if (bit && bitclkmaster)
3402 *bitclkmaster = of_parse_phandle(np, prop, 0);
3404 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3405 frame = of_property_read_bool(np, prop);
3406 if (frame && framemaster)
3407 *framemaster = of_parse_phandle(np, prop, 0);
3410 * return bitmap.
3411 * It will be parameter of
3412 * snd_soc_daifmt_clock_provider_from_bitmap()
3414 return (bit << 4) + frame;
3416 EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_clock_provider_raw);
3418 int snd_soc_get_stream_cpu(const struct snd_soc_dai_link *dai_link, int stream)
3421 * [Normal]
3423 * Playback
3424 * CPU : SNDRV_PCM_STREAM_PLAYBACK
3425 * Codec: SNDRV_PCM_STREAM_PLAYBACK
3427 * Capture
3428 * CPU : SNDRV_PCM_STREAM_CAPTURE
3429 * Codec: SNDRV_PCM_STREAM_CAPTURE
3431 if (!dai_link->c2c_params)
3432 return stream;
3435 * [Codec2Codec]
3437 * Playback
3438 * CPU : SNDRV_PCM_STREAM_CAPTURE
3439 * Codec: SNDRV_PCM_STREAM_PLAYBACK
3441 * Capture
3442 * CPU : SNDRV_PCM_STREAM_PLAYBACK
3443 * Codec: SNDRV_PCM_STREAM_CAPTURE
3445 if (stream == SNDRV_PCM_STREAM_CAPTURE)
3446 return SNDRV_PCM_STREAM_PLAYBACK;
3448 return SNDRV_PCM_STREAM_CAPTURE;
3450 EXPORT_SYMBOL_GPL(snd_soc_get_stream_cpu);
3452 int snd_soc_get_dai_id(struct device_node *ep)
3454 struct snd_soc_component *component;
3455 struct snd_soc_dai_link_component dlc = {
3456 .of_node = of_graph_get_port_parent(ep),
3458 int ret;
3462 * For example HDMI case, HDMI has video/sound port,
3463 * but ALSA SoC needs sound port number only.
3464 * Thus counting HDMI DT port/endpoint doesn't work.
3465 * Then, it should have .of_xlate_dai_id
3467 ret = -ENOTSUPP;
3468 mutex_lock(&client_mutex);
3469 component = soc_find_component(&dlc);
3470 if (component)
3471 ret = snd_soc_component_of_xlate_dai_id(component, ep);
3472 mutex_unlock(&client_mutex);
3474 of_node_put(dlc.of_node);
3476 return ret;
3478 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3480 int snd_soc_get_dlc(const struct of_phandle_args *args, struct snd_soc_dai_link_component *dlc)
3482 struct snd_soc_component *pos;
3483 int ret = -EPROBE_DEFER;
3485 mutex_lock(&client_mutex);
3486 for_each_component(pos) {
3487 struct device_node *component_of_node = soc_component_to_node(pos);
3489 if (component_of_node != args->np || !pos->num_dai)
3490 continue;
3492 ret = snd_soc_component_of_xlate_dai_name(pos, args, &dlc->dai_name);
3493 if (ret == -ENOTSUPP) {
3494 struct snd_soc_dai *dai;
3495 int id = -1;
3497 switch (args->args_count) {
3498 case 0:
3499 id = 0; /* same as dai_drv[0] */
3500 break;
3501 case 1:
3502 id = args->args[0];
3503 break;
3504 default:
3505 /* not supported */
3506 break;
3509 if (id < 0 || id >= pos->num_dai) {
3510 ret = -EINVAL;
3511 continue;
3514 ret = 0;
3516 /* find target DAI */
3517 for_each_component_dais(pos, dai) {
3518 if (id == 0)
3519 break;
3520 id--;
3523 dlc->dai_name = snd_soc_dai_name_get(dai);
3524 } else if (ret) {
3526 * if another error than ENOTSUPP is returned go on and
3527 * check if another component is provided with the same
3528 * node. This may happen if a device provides several
3529 * components
3531 continue;
3534 break;
3537 if (ret == 0)
3538 dlc->of_node = args->np;
3540 mutex_unlock(&client_mutex);
3541 return ret;
3543 EXPORT_SYMBOL_GPL(snd_soc_get_dlc);
3545 int snd_soc_of_get_dlc(struct device_node *of_node,
3546 struct of_phandle_args *args,
3547 struct snd_soc_dai_link_component *dlc,
3548 int index)
3550 struct of_phandle_args __args;
3551 int ret;
3553 if (!args)
3554 args = &__args;
3556 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3557 "#sound-dai-cells", index, args);
3558 if (ret)
3559 return ret;
3561 return snd_soc_get_dlc(args, dlc);
3563 EXPORT_SYMBOL_GPL(snd_soc_of_get_dlc);
3565 int snd_soc_get_dai_name(const struct of_phandle_args *args,
3566 const char **dai_name)
3568 struct snd_soc_dai_link_component dlc;
3569 int ret = snd_soc_get_dlc(args, &dlc);
3571 if (ret == 0)
3572 *dai_name = dlc.dai_name;
3574 return ret;
3576 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3578 int snd_soc_of_get_dai_name(struct device_node *of_node,
3579 const char **dai_name, int index)
3581 struct snd_soc_dai_link_component dlc;
3582 int ret = snd_soc_of_get_dlc(of_node, NULL, &dlc, index);
3584 if (ret == 0)
3585 *dai_name = dlc.dai_name;
3587 return ret;
3589 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3591 struct snd_soc_dai *snd_soc_get_dai_via_args(const struct of_phandle_args *dai_args)
3593 struct snd_soc_dai *dai;
3594 struct snd_soc_component *component;
3596 mutex_lock(&client_mutex);
3597 for_each_component(component) {
3598 for_each_component_dais(component, dai)
3599 if (snd_soc_is_match_dai_args(dai->driver->dai_args, dai_args))
3600 goto found;
3602 dai = NULL;
3603 found:
3604 mutex_unlock(&client_mutex);
3605 return dai;
3607 EXPORT_SYMBOL_GPL(snd_soc_get_dai_via_args);
3609 static void __snd_soc_of_put_component(struct snd_soc_dai_link_component *component)
3611 if (component->of_node) {
3612 of_node_put(component->of_node);
3613 component->of_node = NULL;
3617 static int __snd_soc_of_get_dai_link_component_alloc(
3618 struct device *dev, struct device_node *of_node,
3619 struct snd_soc_dai_link_component **ret_component,
3620 int *ret_num)
3622 struct snd_soc_dai_link_component *component;
3623 int num;
3625 /* Count the number of CPUs/CODECs */
3626 num = of_count_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells");
3627 if (num <= 0) {
3628 if (num == -ENOENT)
3629 dev_err(dev, "No 'sound-dai' property\n");
3630 else
3631 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3632 return num;
3634 component = devm_kcalloc(dev, num, sizeof(*component), GFP_KERNEL);
3635 if (!component)
3636 return -ENOMEM;
3638 *ret_component = component;
3639 *ret_num = num;
3641 return 0;
3645 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3646 * @dai_link: DAI link
3648 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3650 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3652 struct snd_soc_dai_link_component *component;
3653 int index;
3655 for_each_link_codecs(dai_link, index, component)
3656 __snd_soc_of_put_component(component);
3658 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3661 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3662 * @dev: Card device
3663 * @of_node: Device node
3664 * @dai_link: DAI link
3666 * Builds an array of CODEC DAI components from the DAI link property
3667 * 'sound-dai'.
3668 * The array is set in the DAI link and the number of DAIs is set accordingly.
3669 * The device nodes in the array (of_node) must be dereferenced by calling
3670 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3672 * Returns 0 for success
3674 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3675 struct device_node *of_node,
3676 struct snd_soc_dai_link *dai_link)
3678 struct snd_soc_dai_link_component *component;
3679 int index, ret;
3681 ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3682 &dai_link->codecs, &dai_link->num_codecs);
3683 if (ret < 0)
3684 return ret;
3686 /* Parse the list */
3687 for_each_link_codecs(dai_link, index, component) {
3688 ret = snd_soc_of_get_dlc(of_node, NULL, component, index);
3689 if (ret)
3690 goto err;
3692 return 0;
3693 err:
3694 snd_soc_of_put_dai_link_codecs(dai_link);
3695 dai_link->codecs = NULL;
3696 dai_link->num_codecs = 0;
3697 return ret;
3699 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3702 * snd_soc_of_put_dai_link_cpus - Dereference device nodes in the codecs array
3703 * @dai_link: DAI link
3705 * Dereference device nodes acquired by snd_soc_of_get_dai_link_cpus().
3707 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link)
3709 struct snd_soc_dai_link_component *component;
3710 int index;
3712 for_each_link_cpus(dai_link, index, component)
3713 __snd_soc_of_put_component(component);
3715 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_cpus);
3718 * snd_soc_of_get_dai_link_cpus - Parse a list of CPU DAIs in the devicetree
3719 * @dev: Card device
3720 * @of_node: Device node
3721 * @dai_link: DAI link
3723 * Is analogous to snd_soc_of_get_dai_link_codecs but parses a list of CPU DAIs
3724 * instead.
3726 * Returns 0 for success
3728 int snd_soc_of_get_dai_link_cpus(struct device *dev,
3729 struct device_node *of_node,
3730 struct snd_soc_dai_link *dai_link)
3732 struct snd_soc_dai_link_component *component;
3733 int index, ret;
3735 /* Count the number of CPUs */
3736 ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3737 &dai_link->cpus, &dai_link->num_cpus);
3738 if (ret < 0)
3739 return ret;
3741 /* Parse the list */
3742 for_each_link_cpus(dai_link, index, component) {
3743 ret = snd_soc_of_get_dlc(of_node, NULL, component, index);
3744 if (ret)
3745 goto err;
3747 return 0;
3748 err:
3749 snd_soc_of_put_dai_link_cpus(dai_link);
3750 dai_link->cpus = NULL;
3751 dai_link->num_cpus = 0;
3752 return ret;
3754 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_cpus);
3756 static int __init snd_soc_init(void)
3758 int ret;
3760 snd_soc_debugfs_init();
3761 ret = snd_soc_util_init();
3762 if (ret)
3763 goto err_util_init;
3765 ret = platform_driver_register(&soc_driver);
3766 if (ret)
3767 goto err_register;
3768 return 0;
3770 err_register:
3771 snd_soc_util_exit();
3772 err_util_init:
3773 snd_soc_debugfs_exit();
3774 return ret;
3776 module_init(snd_soc_init);
3778 static void __exit snd_soc_exit(void)
3780 snd_soc_util_exit();
3781 snd_soc_debugfs_exit();
3783 platform_driver_unregister(&soc_driver);
3785 module_exit(snd_soc_exit);
3787 /* Module information */
3788 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3789 MODULE_DESCRIPTION("ALSA SoC Core");
3790 MODULE_LICENSE("GPL");
3791 MODULE_ALIAS("platform:soc-audio");