Loading...
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>
13//
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
19
20#include <linux/module.h>
21#include <linux/moduleparam.h>
22#include <linux/init.h>
23#include <linux/delay.h>
24#include <linux/pm.h>
25#include <linux/bitops.h>
26#include <linux/debugfs.h>
27#include <linux/platform_device.h>
28#include <linux/pinctrl/consumer.h>
29#include <linux/ctype.h>
30#include <linux/slab.h>
31#include <linux/of.h>
32#include <linux/of_graph.h>
33#include <linux/dmi.h>
34#include <sound/core.h>
35#include <sound/jack.h>
36#include <sound/pcm.h>
37#include <sound/pcm_params.h>
38#include <sound/soc.h>
39#include <sound/soc-dpcm.h>
40#include <sound/soc-topology.h>
41#include <sound/soc-link.h>
42#include <sound/initval.h>
43
44#define CREATE_TRACE_POINTS
45#include <trace/events/asoc.h>
46
47#define NAME_SIZE 32
48
49static DEFINE_MUTEX(client_mutex);
50static LIST_HEAD(component_list);
51static LIST_HEAD(unbind_card_list);
52
53#define for_each_component(component) \
54 list_for_each_entry(component, &component_list, list)
55
56/*
57 * This is used if driver don't need to have CPU/Codec/Platform
58 * dai_link. see soc.h
59 */
60struct snd_soc_dai_link_component null_dailink_component[0];
61EXPORT_SYMBOL_GPL(null_dailink_component);
62
63/*
64 * This is a timeout to do a DAPM powerdown after a stream is closed().
65 * It can be used to eliminate pops between different playback streams, e.g.
66 * between two audio tracks.
67 */
68static int pmdown_time = 5000;
69module_param(pmdown_time, int, 0);
70MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
71
72static ssize_t pmdown_time_show(struct device *dev,
73 struct device_attribute *attr, char *buf)
74{
75 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
76
77 return sprintf(buf, "%ld\n", rtd->pmdown_time);
78}
79
80static ssize_t pmdown_time_set(struct device *dev,
81 struct device_attribute *attr,
82 const char *buf, size_t count)
83{
84 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
85 int ret;
86
87 ret = kstrtol(buf, 10, &rtd->pmdown_time);
88 if (ret)
89 return ret;
90
91 return count;
92}
93
94static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
95
96static struct attribute *soc_dev_attrs[] = {
97 &dev_attr_pmdown_time.attr,
98 NULL
99};
100
101static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
102 struct attribute *attr, int idx)
103{
104 struct device *dev = kobj_to_dev(kobj);
105 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
106
107 if (!rtd)
108 return 0;
109
110 if (attr == &dev_attr_pmdown_time.attr)
111 return attr->mode; /* always visible */
112 return rtd->num_codecs ? attr->mode : 0; /* enabled only with codec */
113}
114
115static const struct attribute_group soc_dapm_dev_group = {
116 .attrs = soc_dapm_dev_attrs,
117 .is_visible = soc_dev_attr_is_visible,
118};
119
120static const struct attribute_group soc_dev_group = {
121 .attrs = soc_dev_attrs,
122 .is_visible = soc_dev_attr_is_visible,
123};
124
125static const struct attribute_group *soc_dev_attr_groups[] = {
126 &soc_dapm_dev_group,
127 &soc_dev_group,
128 NULL
129};
130
131#ifdef CONFIG_DEBUG_FS
132struct dentry *snd_soc_debugfs_root;
133EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
134
135static void soc_init_component_debugfs(struct snd_soc_component *component)
136{
137 if (!component->card->debugfs_card_root)
138 return;
139
140 if (component->debugfs_prefix) {
141 char *name;
142
143 name = kasprintf(GFP_KERNEL, "%s:%s",
144 component->debugfs_prefix, component->name);
145 if (name) {
146 component->debugfs_root = debugfs_create_dir(name,
147 component->card->debugfs_card_root);
148 kfree(name);
149 }
150 } else {
151 component->debugfs_root = debugfs_create_dir(component->name,
152 component->card->debugfs_card_root);
153 }
154
155 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
156 component->debugfs_root);
157}
158
159static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
160{
161 if (!component->debugfs_root)
162 return;
163 debugfs_remove_recursive(component->debugfs_root);
164 component->debugfs_root = NULL;
165}
166
167static int dai_list_show(struct seq_file *m, void *v)
168{
169 struct snd_soc_component *component;
170 struct snd_soc_dai *dai;
171
172 mutex_lock(&client_mutex);
173
174 for_each_component(component)
175 for_each_component_dais(component, dai)
176 seq_printf(m, "%s\n", dai->name);
177
178 mutex_unlock(&client_mutex);
179
180 return 0;
181}
182DEFINE_SHOW_ATTRIBUTE(dai_list);
183
184static int component_list_show(struct seq_file *m, void *v)
185{
186 struct snd_soc_component *component;
187
188 mutex_lock(&client_mutex);
189
190 for_each_component(component)
191 seq_printf(m, "%s\n", component->name);
192
193 mutex_unlock(&client_mutex);
194
195 return 0;
196}
197DEFINE_SHOW_ATTRIBUTE(component_list);
198
199static void soc_init_card_debugfs(struct snd_soc_card *card)
200{
201 card->debugfs_card_root = debugfs_create_dir(card->name,
202 snd_soc_debugfs_root);
203
204 debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
205 &card->pop_time);
206
207 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
208}
209
210static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
211{
212 debugfs_remove_recursive(card->debugfs_card_root);
213 card->debugfs_card_root = NULL;
214}
215
216static void snd_soc_debugfs_init(void)
217{
218 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
219
220 debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
221 &dai_list_fops);
222
223 debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
224 &component_list_fops);
225}
226
227static void snd_soc_debugfs_exit(void)
228{
229 debugfs_remove_recursive(snd_soc_debugfs_root);
230}
231
232#else
233
234static inline void soc_init_component_debugfs(
235 struct snd_soc_component *component)
236{
237}
238
239static inline void soc_cleanup_component_debugfs(
240 struct snd_soc_component *component)
241{
242}
243
244static inline void soc_init_card_debugfs(struct snd_soc_card *card)
245{
246}
247
248static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
249{
250}
251
252static inline void snd_soc_debugfs_init(void)
253{
254}
255
256static inline void snd_soc_debugfs_exit(void)
257{
258}
259
260#endif
261
262static int snd_soc_rtd_add_component(struct snd_soc_pcm_runtime *rtd,
263 struct snd_soc_component *component)
264{
265 struct snd_soc_component *comp;
266 int i;
267
268 for_each_rtd_components(rtd, i, comp) {
269 /* already connected */
270 if (comp == component)
271 return 0;
272 }
273
274 /* see for_each_rtd_components */
275 rtd->components[rtd->num_components] = component;
276 rtd->num_components++;
277
278 return 0;
279}
280
281struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
282 const char *driver_name)
283{
284 struct snd_soc_component *component;
285 int i;
286
287 if (!driver_name)
288 return NULL;
289
290 /*
291 * NOTE
292 *
293 * snd_soc_rtdcom_lookup() will find component from rtd by using
294 * specified driver name.
295 * But, if many components which have same driver name are connected
296 * to 1 rtd, this function will return 1st found component.
297 */
298 for_each_rtd_components(rtd, i, component) {
299 const char *component_name = component->driver->name;
300
301 if (!component_name)
302 continue;
303
304 if ((component_name == driver_name) ||
305 strcmp(component_name, driver_name) == 0)
306 return component;
307 }
308
309 return NULL;
310}
311EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
312
313struct snd_soc_component
314*snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
315{
316 struct snd_soc_component *component;
317 struct snd_soc_component *found_component;
318
319 found_component = NULL;
320 for_each_component(component) {
321 if ((dev == component->dev) &&
322 (!driver_name ||
323 (driver_name == component->driver->name) ||
324 (strcmp(component->driver->name, driver_name) == 0))) {
325 found_component = component;
326 break;
327 }
328 }
329
330 return found_component;
331}
332EXPORT_SYMBOL_GPL(snd_soc_lookup_component_nolocked);
333
334struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
335 const char *driver_name)
336{
337 struct snd_soc_component *component;
338
339 mutex_lock(&client_mutex);
340 component = snd_soc_lookup_component_nolocked(dev, driver_name);
341 mutex_unlock(&client_mutex);
342
343 return component;
344}
345EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
346
347struct snd_soc_pcm_runtime
348*snd_soc_get_pcm_runtime(struct snd_soc_card *card,
349 struct snd_soc_dai_link *dai_link)
350{
351 struct snd_soc_pcm_runtime *rtd;
352
353 for_each_card_rtds(card, rtd) {
354 if (rtd->dai_link == dai_link)
355 return rtd;
356 }
357 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
358 return NULL;
359}
360EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
361
362/*
363 * Power down the audio subsystem pmdown_time msecs after close is called.
364 * This is to ensure there are no pops or clicks in between any music tracks
365 * due to DAPM power cycling.
366 */
367void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd)
368{
369 struct snd_soc_dai *codec_dai = asoc_rtd_to_codec(rtd, 0);
370 int playback = SNDRV_PCM_STREAM_PLAYBACK;
371
372 mutex_lock_nested(&rtd->card->pcm_mutex, rtd->card->pcm_subclass);
373
374 dev_dbg(rtd->dev,
375 "ASoC: pop wq checking: %s status: %s waiting: %s\n",
376 codec_dai->driver->playback.stream_name,
377 snd_soc_dai_stream_active(codec_dai, playback) ?
378 "active" : "inactive",
379 rtd->pop_wait ? "yes" : "no");
380
381 /* are we waiting on this codec DAI stream */
382 if (rtd->pop_wait == 1) {
383 rtd->pop_wait = 0;
384 snd_soc_dapm_stream_event(rtd, playback,
385 SND_SOC_DAPM_STREAM_STOP);
386 }
387
388 mutex_unlock(&rtd->card->pcm_mutex);
389}
390EXPORT_SYMBOL_GPL(snd_soc_close_delayed_work);
391
392static void soc_release_rtd_dev(struct device *dev)
393{
394 /* "dev" means "rtd->dev" */
395 kfree(dev);
396}
397
398static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
399{
400 if (!rtd)
401 return;
402
403 list_del(&rtd->list);
404
405 if (delayed_work_pending(&rtd->delayed_work))
406 flush_delayed_work(&rtd->delayed_work);
407 snd_soc_pcm_component_free(rtd);
408
409 /*
410 * we don't need to call kfree() for rtd->dev
411 * see
412 * soc_release_rtd_dev()
413 *
414 * We don't need rtd->dev NULL check, because
415 * it is alloced *before* rtd.
416 * see
417 * soc_new_pcm_runtime()
418 */
419 device_unregister(rtd->dev);
420}
421
422static void close_delayed_work(struct work_struct *work) {
423 struct snd_soc_pcm_runtime *rtd =
424 container_of(work, struct snd_soc_pcm_runtime,
425 delayed_work.work);
426
427 if (rtd->close_delayed_work_func)
428 rtd->close_delayed_work_func(rtd);
429}
430
431static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
432 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
433{
434 struct snd_soc_pcm_runtime *rtd;
435 struct snd_soc_component *component;
436 struct device *dev;
437 int ret;
438 int stream;
439
440 /*
441 * for rtd->dev
442 */
443 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
444 if (!dev)
445 return NULL;
446
447 dev->parent = card->dev;
448 dev->release = soc_release_rtd_dev;
449
450 dev_set_name(dev, "%s", dai_link->name);
451
452 ret = device_register(dev);
453 if (ret < 0) {
454 put_device(dev); /* soc_release_rtd_dev */
455 return NULL;
456 }
457
458 /*
459 * for rtd
460 */
461 rtd = devm_kzalloc(dev,
462 sizeof(*rtd) +
463 sizeof(*component) * (dai_link->num_cpus +
464 dai_link->num_codecs +
465 dai_link->num_platforms),
466 GFP_KERNEL);
467 if (!rtd)
468 goto free_rtd;
469
470 rtd->dev = dev;
471 INIT_LIST_HEAD(&rtd->list);
472 for_each_pcm_streams(stream) {
473 INIT_LIST_HEAD(&rtd->dpcm[stream].be_clients);
474 INIT_LIST_HEAD(&rtd->dpcm[stream].fe_clients);
475 }
476 dev_set_drvdata(dev, rtd);
477 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
478
479 /*
480 * for rtd->dais
481 */
482 rtd->dais = devm_kcalloc(dev, dai_link->num_cpus + dai_link->num_codecs,
483 sizeof(struct snd_soc_dai *),
484 GFP_KERNEL);
485 if (!rtd->dais)
486 goto free_rtd;
487
488 /*
489 * dais = [][][][][][][][][][][][][][][][][][]
490 * ^cpu_dais ^codec_dais
491 * |--- num_cpus ---|--- num_codecs --|
492 * see
493 * asoc_rtd_to_cpu()
494 * asoc_rtd_to_codec()
495 */
496 rtd->num_cpus = dai_link->num_cpus;
497 rtd->num_codecs = dai_link->num_codecs;
498 rtd->card = card;
499 rtd->dai_link = dai_link;
500 rtd->num = card->num_rtd++;
501
502 /* see for_each_card_rtds */
503 list_add_tail(&rtd->list, &card->rtd_list);
504
505 ret = device_add_groups(dev, soc_dev_attr_groups);
506 if (ret < 0)
507 goto free_rtd;
508
509 return rtd;
510
511free_rtd:
512 soc_free_pcm_runtime(rtd);
513 return NULL;
514}
515
516static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
517{
518 struct snd_soc_pcm_runtime *rtd;
519
520 for_each_card_rtds(card, rtd)
521 flush_delayed_work(&rtd->delayed_work);
522}
523
524#ifdef CONFIG_PM_SLEEP
525/* powers down audio subsystem for suspend */
526int snd_soc_suspend(struct device *dev)
527{
528 struct snd_soc_card *card = dev_get_drvdata(dev);
529 struct snd_soc_component *component;
530 struct snd_soc_pcm_runtime *rtd;
531 int playback = SNDRV_PCM_STREAM_PLAYBACK;
532 int i;
533
534 /* If the card is not initialized yet there is nothing to do */
535 if (!card->instantiated)
536 return 0;
537
538 /*
539 * Due to the resume being scheduled into a workqueue we could
540 * suspend before that's finished - wait for it to complete.
541 */
542 snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
543
544 /* we're going to block userspace touching us until resume completes */
545 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
546
547 /* mute any active DACs */
548 for_each_card_rtds(card, rtd) {
549 struct snd_soc_dai *dai;
550
551 if (rtd->dai_link->ignore_suspend)
552 continue;
553
554 for_each_rtd_dais(rtd, i, dai) {
555 if (snd_soc_dai_stream_active(dai, playback))
556 snd_soc_dai_digital_mute(dai, 1, playback);
557 }
558 }
559
560 /* suspend all pcms */
561 for_each_card_rtds(card, rtd) {
562 if (rtd->dai_link->ignore_suspend)
563 continue;
564
565 snd_pcm_suspend_all(rtd->pcm);
566 }
567
568 snd_soc_card_suspend_pre(card);
569
570 /* close any waiting streams */
571 snd_soc_flush_all_delayed_work(card);
572
573 for_each_card_rtds(card, rtd) {
574 int stream;
575
576 if (rtd->dai_link->ignore_suspend)
577 continue;
578
579 for_each_pcm_streams(stream)
580 snd_soc_dapm_stream_event(rtd, stream,
581 SND_SOC_DAPM_STREAM_SUSPEND);
582 }
583
584 /* Recheck all endpoints too, their state is affected by suspend */
585 dapm_mark_endpoints_dirty(card);
586 snd_soc_dapm_sync(&card->dapm);
587
588 /* suspend all COMPONENTs */
589 for_each_card_rtds(card, rtd) {
590
591 if (rtd->dai_link->ignore_suspend)
592 continue;
593
594 for_each_rtd_components(rtd, i, component) {
595 struct snd_soc_dapm_context *dapm =
596 snd_soc_component_get_dapm(component);
597
598 /*
599 * ignore if component was already suspended
600 */
601 if (snd_soc_component_is_suspended(component))
602 continue;
603
604 /*
605 * If there are paths active then the COMPONENT will be
606 * held with bias _ON and should not be suspended.
607 */
608 switch (snd_soc_dapm_get_bias_level(dapm)) {
609 case SND_SOC_BIAS_STANDBY:
610 /*
611 * If the COMPONENT is capable of idle
612 * bias off then being in STANDBY
613 * means it's doing something,
614 * otherwise fall through.
615 */
616 if (dapm->idle_bias_off) {
617 dev_dbg(component->dev,
618 "ASoC: idle_bias_off CODEC on over suspend\n");
619 break;
620 }
621 fallthrough;
622
623 case SND_SOC_BIAS_OFF:
624 snd_soc_component_suspend(component);
625 if (component->regmap)
626 regcache_mark_dirty(component->regmap);
627 /* deactivate pins to sleep state */
628 pinctrl_pm_select_sleep_state(component->dev);
629 break;
630 default:
631 dev_dbg(component->dev,
632 "ASoC: COMPONENT is on over suspend\n");
633 break;
634 }
635 }
636 }
637
638 snd_soc_card_suspend_post(card);
639
640 return 0;
641}
642EXPORT_SYMBOL_GPL(snd_soc_suspend);
643
644/*
645 * deferred resume work, so resume can complete before we finished
646 * setting our codec back up, which can be very slow on I2C
647 */
648static void soc_resume_deferred(struct work_struct *work)
649{
650 struct snd_soc_card *card =
651 container_of(work, struct snd_soc_card,
652 deferred_resume_work);
653 struct snd_soc_pcm_runtime *rtd;
654 struct snd_soc_component *component;
655 int i;
656
657 /*
658 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
659 * so userspace apps are blocked from touching us
660 */
661
662 dev_dbg(card->dev, "ASoC: starting resume work\n");
663
664 /* Bring us up into D2 so that DAPM starts enabling things */
665 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
666
667 snd_soc_card_resume_pre(card);
668
669 for_each_card_components(card, component) {
670 if (snd_soc_component_is_suspended(component))
671 snd_soc_component_resume(component);
672 }
673
674 for_each_card_rtds(card, rtd) {
675 int stream;
676
677 if (rtd->dai_link->ignore_suspend)
678 continue;
679
680 for_each_pcm_streams(stream)
681 snd_soc_dapm_stream_event(rtd, stream,
682 SND_SOC_DAPM_STREAM_RESUME);
683 }
684
685 /* unmute any active DACs */
686 for_each_card_rtds(card, rtd) {
687 struct snd_soc_dai *dai;
688 int playback = SNDRV_PCM_STREAM_PLAYBACK;
689
690 if (rtd->dai_link->ignore_suspend)
691 continue;
692
693 for_each_rtd_dais(rtd, i, dai) {
694 if (snd_soc_dai_stream_active(dai, playback))
695 snd_soc_dai_digital_mute(dai, 0, playback);
696 }
697 }
698
699 snd_soc_card_resume_post(card);
700
701 dev_dbg(card->dev, "ASoC: resume work completed\n");
702
703 /* Recheck all endpoints too, their state is affected by suspend */
704 dapm_mark_endpoints_dirty(card);
705 snd_soc_dapm_sync(&card->dapm);
706
707 /* userspace can access us now we are back as we were before */
708 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
709}
710
711/* powers up audio subsystem after a suspend */
712int snd_soc_resume(struct device *dev)
713{
714 struct snd_soc_card *card = dev_get_drvdata(dev);
715 struct snd_soc_component *component;
716
717 /* If the card is not initialized yet there is nothing to do */
718 if (!card->instantiated)
719 return 0;
720
721 /* activate pins from sleep state */
722 for_each_card_components(card, component)
723 if (snd_soc_component_active(component))
724 pinctrl_pm_select_default_state(component->dev);
725
726 dev_dbg(dev, "ASoC: Scheduling resume work\n");
727 if (!schedule_work(&card->deferred_resume_work))
728 dev_err(dev, "ASoC: resume work item may be lost\n");
729
730 return 0;
731}
732EXPORT_SYMBOL_GPL(snd_soc_resume);
733
734static void soc_resume_init(struct snd_soc_card *card)
735{
736 /* deferred resume work */
737 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
738}
739#else
740#define snd_soc_suspend NULL
741#define snd_soc_resume NULL
742static inline void soc_resume_init(struct snd_soc_card *card)
743{
744}
745#endif
746
747static struct device_node
748*soc_component_to_node(struct snd_soc_component *component)
749{
750 struct device_node *of_node;
751
752 of_node = component->dev->of_node;
753 if (!of_node && component->dev->parent)
754 of_node = component->dev->parent->of_node;
755
756 return of_node;
757}
758
759static int snd_soc_is_matching_component(
760 const struct snd_soc_dai_link_component *dlc,
761 struct snd_soc_component *component)
762{
763 struct device_node *component_of_node;
764
765 if (!dlc)
766 return 0;
767
768 component_of_node = soc_component_to_node(component);
769
770 if (dlc->of_node && component_of_node != dlc->of_node)
771 return 0;
772 if (dlc->name && strcmp(component->name, dlc->name))
773 return 0;
774
775 return 1;
776}
777
778static struct snd_soc_component *soc_find_component(
779 const struct snd_soc_dai_link_component *dlc)
780{
781 struct snd_soc_component *component;
782
783 lockdep_assert_held(&client_mutex);
784
785 /*
786 * NOTE
787 *
788 * It returns *1st* found component, but some driver
789 * has few components by same of_node/name
790 * ex)
791 * CPU component and generic DMAEngine component
792 */
793 for_each_component(component)
794 if (snd_soc_is_matching_component(dlc, component))
795 return component;
796
797 return NULL;
798}
799
800/**
801 * snd_soc_find_dai - Find a registered DAI
802 *
803 * @dlc: name of the DAI or the DAI driver and optional component info to match
804 *
805 * This function will search all registered components and their DAIs to
806 * find the DAI of the same name. The component's of_node and name
807 * should also match if being specified.
808 *
809 * Return: pointer of DAI, or NULL if not found.
810 */
811struct snd_soc_dai *snd_soc_find_dai(
812 const struct snd_soc_dai_link_component *dlc)
813{
814 struct snd_soc_component *component;
815 struct snd_soc_dai *dai;
816
817 lockdep_assert_held(&client_mutex);
818
819 /* Find CPU DAI from registered DAIs */
820 for_each_component(component) {
821 if (!snd_soc_is_matching_component(dlc, component))
822 continue;
823 for_each_component_dais(component, dai) {
824 if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
825 && (!dai->driver->name
826 || strcmp(dai->driver->name, dlc->dai_name)))
827 continue;
828
829 return dai;
830 }
831 }
832
833 return NULL;
834}
835EXPORT_SYMBOL_GPL(snd_soc_find_dai);
836
837struct snd_soc_dai *snd_soc_find_dai_with_mutex(
838 const struct snd_soc_dai_link_component *dlc)
839{
840 struct snd_soc_dai *dai;
841
842 mutex_lock(&client_mutex);
843 dai = snd_soc_find_dai(dlc);
844 mutex_unlock(&client_mutex);
845
846 return dai;
847}
848EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
849
850static int soc_dai_link_sanity_check(struct snd_soc_card *card,
851 struct snd_soc_dai_link *link)
852{
853 int i;
854 struct snd_soc_dai_link_component *cpu, *codec, *platform;
855
856 for_each_link_codecs(link, i, codec) {
857 /*
858 * Codec must be specified by 1 of name or OF node,
859 * not both or neither.
860 */
861 if (!!codec->name == !!codec->of_node) {
862 dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
863 link->name);
864 return -EINVAL;
865 }
866
867 /* Codec DAI name must be specified */
868 if (!codec->dai_name) {
869 dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
870 link->name);
871 return -EINVAL;
872 }
873
874 /*
875 * Defer card registration if codec component is not added to
876 * component list.
877 */
878 if (!soc_find_component(codec)) {
879 dev_dbg(card->dev,
880 "ASoC: codec component %s not found for link %s\n",
881 codec->name, link->name);
882 return -EPROBE_DEFER;
883 }
884 }
885
886 for_each_link_platforms(link, i, platform) {
887 /*
888 * Platform may be specified by either name or OF node, but it
889 * can be left unspecified, then no components will be inserted
890 * in the rtdcom list
891 */
892 if (!!platform->name == !!platform->of_node) {
893 dev_err(card->dev,
894 "ASoC: Neither/both platform name/of_node are set for %s\n",
895 link->name);
896 return -EINVAL;
897 }
898
899 /*
900 * Defer card registration if platform component is not added to
901 * component list.
902 */
903 if (!soc_find_component(platform)) {
904 dev_dbg(card->dev,
905 "ASoC: platform component %s not found for link %s\n",
906 platform->name, link->name);
907 return -EPROBE_DEFER;
908 }
909 }
910
911 for_each_link_cpus(link, i, cpu) {
912 /*
913 * CPU device may be specified by either name or OF node, but
914 * can be left unspecified, and will be matched based on DAI
915 * name alone..
916 */
917 if (cpu->name && cpu->of_node) {
918 dev_err(card->dev,
919 "ASoC: Neither/both cpu name/of_node are set for %s\n",
920 link->name);
921 return -EINVAL;
922 }
923
924 /*
925 * Defer card registration if cpu dai component is not added to
926 * component list.
927 */
928 if ((cpu->of_node || cpu->name) &&
929 !soc_find_component(cpu)) {
930 dev_dbg(card->dev,
931 "ASoC: cpu component %s not found for link %s\n",
932 cpu->name, link->name);
933 return -EPROBE_DEFER;
934 }
935
936 /*
937 * At least one of CPU DAI name or CPU device name/node must be
938 * specified
939 */
940 if (!cpu->dai_name &&
941 !(cpu->name || cpu->of_node)) {
942 dev_err(card->dev,
943 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
944 link->name);
945 return -EINVAL;
946 }
947 }
948
949 return 0;
950}
951
952/**
953 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
954 * @card: The ASoC card to which the pcm_runtime has
955 * @rtd: The pcm_runtime to remove
956 *
957 * This function removes a pcm_runtime from the ASoC card.
958 */
959void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
960 struct snd_soc_pcm_runtime *rtd)
961{
962 lockdep_assert_held(&client_mutex);
963
964 /* release machine specific resources */
965 snd_soc_link_exit(rtd);
966
967 /*
968 * Notify the machine driver for extra destruction
969 */
970 snd_soc_card_remove_dai_link(card, rtd->dai_link);
971
972 soc_free_pcm_runtime(rtd);
973}
974EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
975
976/**
977 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
978 * @card: The ASoC card to which the pcm_runtime is added
979 * @dai_link: The DAI link to find pcm_runtime
980 *
981 * This function adds a pcm_runtime ASoC card by using dai_link.
982 *
983 * Note: Topology can use this API to add pcm_runtime when probing the
984 * topology component. And machine drivers can still define static
985 * DAI links in dai_link array.
986 */
987int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
988 struct snd_soc_dai_link *dai_link)
989{
990 struct snd_soc_pcm_runtime *rtd;
991 struct snd_soc_dai_link_component *codec, *platform, *cpu;
992 struct snd_soc_component *component;
993 int i, ret;
994
995 lockdep_assert_held(&client_mutex);
996
997 /*
998 * Notify the machine driver for extra initialization
999 */
1000 ret = snd_soc_card_add_dai_link(card, dai_link);
1001 if (ret < 0)
1002 return ret;
1003
1004 if (dai_link->ignore)
1005 return 0;
1006
1007 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1008
1009 ret = soc_dai_link_sanity_check(card, dai_link);
1010 if (ret < 0)
1011 return ret;
1012
1013 rtd = soc_new_pcm_runtime(card, dai_link);
1014 if (!rtd)
1015 return -ENOMEM;
1016
1017 for_each_link_cpus(dai_link, i, cpu) {
1018 asoc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
1019 if (!asoc_rtd_to_cpu(rtd, i)) {
1020 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1021 cpu->dai_name);
1022 goto _err_defer;
1023 }
1024 snd_soc_rtd_add_component(rtd, asoc_rtd_to_cpu(rtd, i)->component);
1025 }
1026
1027 /* Find CODEC from registered CODECs */
1028 for_each_link_codecs(dai_link, i, codec) {
1029 asoc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1030 if (!asoc_rtd_to_codec(rtd, i)) {
1031 dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1032 codec->dai_name);
1033 goto _err_defer;
1034 }
1035
1036 snd_soc_rtd_add_component(rtd, asoc_rtd_to_codec(rtd, i)->component);
1037 }
1038
1039 /* Find PLATFORM from registered PLATFORMs */
1040 for_each_link_platforms(dai_link, i, platform) {
1041 for_each_component(component) {
1042 if (!snd_soc_is_matching_component(platform, component))
1043 continue;
1044
1045 snd_soc_rtd_add_component(rtd, component);
1046 }
1047 }
1048
1049 return 0;
1050
1051_err_defer:
1052 snd_soc_remove_pcm_runtime(card, rtd);
1053 return -EPROBE_DEFER;
1054}
1055EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtime);
1056
1057static int soc_init_pcm_runtime(struct snd_soc_card *card,
1058 struct snd_soc_pcm_runtime *rtd)
1059{
1060 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1061 struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
1062 struct snd_soc_component *component;
1063 int ret, num, i;
1064
1065 /* set default power off timeout */
1066 rtd->pmdown_time = pmdown_time;
1067
1068 /* do machine specific initialization */
1069 ret = snd_soc_link_init(rtd);
1070 if (ret < 0)
1071 return ret;
1072
1073 if (dai_link->dai_fmt) {
1074 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1075 if (ret)
1076 return ret;
1077 }
1078
1079 /* add DPCM sysfs entries */
1080 soc_dpcm_debugfs_add(rtd);
1081
1082 num = rtd->num;
1083
1084 /*
1085 * most drivers will register their PCMs using DAI link ordering but
1086 * topology based drivers can use the DAI link id field to set PCM
1087 * device number and then use rtd + a base offset of the BEs.
1088 */
1089 for_each_rtd_components(rtd, i, component) {
1090 if (!component->driver->use_dai_pcm_id)
1091 continue;
1092
1093 if (rtd->dai_link->no_pcm)
1094 num += component->driver->be_pcm_base;
1095 else
1096 num = rtd->dai_link->id;
1097 }
1098
1099 /* create compress_device if possible */
1100 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1101 if (ret != -ENOTSUPP) {
1102 if (ret < 0)
1103 dev_err(card->dev, "ASoC: can't create compress %s\n",
1104 dai_link->stream_name);
1105 return ret;
1106 }
1107
1108 /* create the pcm */
1109 ret = soc_new_pcm(rtd, num);
1110 if (ret < 0) {
1111 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1112 dai_link->stream_name, ret);
1113 return ret;
1114 }
1115
1116 return snd_soc_pcm_dai_new(rtd);
1117}
1118
1119static void soc_set_name_prefix(struct snd_soc_card *card,
1120 struct snd_soc_component *component)
1121{
1122 struct device_node *of_node = soc_component_to_node(component);
1123 const char *str;
1124 int ret, i;
1125
1126 for (i = 0; i < card->num_configs; i++) {
1127 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1128
1129 if (snd_soc_is_matching_component(&map->dlc, component)) {
1130 component->name_prefix = map->name_prefix;
1131 return;
1132 }
1133 }
1134
1135 /*
1136 * If there is no configuration table or no match in the table,
1137 * check if a prefix is provided in the node
1138 */
1139 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1140 if (ret < 0)
1141 return;
1142
1143 component->name_prefix = str;
1144}
1145
1146static void soc_remove_component(struct snd_soc_component *component,
1147 int probed)
1148{
1149
1150 if (!component->card)
1151 return;
1152
1153 if (probed)
1154 snd_soc_component_remove(component);
1155
1156 /* For framework level robustness */
1157 snd_soc_component_set_jack(component, NULL, NULL);
1158
1159 list_del_init(&component->card_list);
1160 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1161 soc_cleanup_component_debugfs(component);
1162 component->card = NULL;
1163 snd_soc_component_module_put_when_remove(component);
1164}
1165
1166static int soc_probe_component(struct snd_soc_card *card,
1167 struct snd_soc_component *component)
1168{
1169 struct snd_soc_dapm_context *dapm =
1170 snd_soc_component_get_dapm(component);
1171 struct snd_soc_dai *dai;
1172 int probed = 0;
1173 int ret;
1174
1175 if (!strcmp(component->name, "snd-soc-dummy"))
1176 return 0;
1177
1178 if (component->card) {
1179 if (component->card != card) {
1180 dev_err(component->dev,
1181 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1182 card->name, component->card->name);
1183 return -ENODEV;
1184 }
1185 return 0;
1186 }
1187
1188 ret = snd_soc_component_module_get_when_probe(component);
1189 if (ret < 0)
1190 return ret;
1191
1192 component->card = card;
1193 soc_set_name_prefix(card, component);
1194
1195 soc_init_component_debugfs(component);
1196
1197 snd_soc_dapm_init(dapm, card, component);
1198
1199 ret = snd_soc_dapm_new_controls(dapm,
1200 component->driver->dapm_widgets,
1201 component->driver->num_dapm_widgets);
1202
1203 if (ret != 0) {
1204 dev_err(component->dev,
1205 "Failed to create new controls %d\n", ret);
1206 goto err_probe;
1207 }
1208
1209 for_each_component_dais(component, dai) {
1210 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1211 if (ret != 0) {
1212 dev_err(component->dev,
1213 "Failed to create DAI widgets %d\n", ret);
1214 goto err_probe;
1215 }
1216 }
1217
1218 ret = snd_soc_component_probe(component);
1219 if (ret < 0) {
1220 dev_err(component->dev,
1221 "ASoC: failed to probe component %d\n", ret);
1222 goto err_probe;
1223 }
1224 WARN(dapm->idle_bias_off &&
1225 dapm->bias_level != SND_SOC_BIAS_OFF,
1226 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1227 component->name);
1228 probed = 1;
1229
1230 /*
1231 * machine specific init
1232 * see
1233 * snd_soc_component_set_aux()
1234 */
1235 ret = snd_soc_component_init(component);
1236 if (ret < 0)
1237 goto err_probe;
1238
1239 ret = snd_soc_add_component_controls(component,
1240 component->driver->controls,
1241 component->driver->num_controls);
1242 if (ret < 0)
1243 goto err_probe;
1244
1245 ret = snd_soc_dapm_add_routes(dapm,
1246 component->driver->dapm_routes,
1247 component->driver->num_dapm_routes);
1248 if (ret < 0) {
1249 if (card->disable_route_checks) {
1250 dev_info(card->dev,
1251 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1252 __func__);
1253 } else {
1254 dev_err(card->dev,
1255 "%s: snd_soc_dapm_add_routes failed: %d\n",
1256 __func__, ret);
1257 goto err_probe;
1258 }
1259 }
1260
1261 /* see for_each_card_components */
1262 list_add(&component->card_list, &card->component_dev_list);
1263
1264err_probe:
1265 if (ret < 0)
1266 soc_remove_component(component, probed);
1267
1268 return ret;
1269}
1270
1271static void soc_remove_link_dais(struct snd_soc_card *card)
1272{
1273 struct snd_soc_pcm_runtime *rtd;
1274 int order;
1275
1276 for_each_comp_order(order) {
1277 for_each_card_rtds(card, rtd) {
1278 /* remove all rtd connected DAIs in good order */
1279 snd_soc_pcm_dai_remove(rtd, order);
1280 }
1281 }
1282}
1283
1284static int soc_probe_link_dais(struct snd_soc_card *card)
1285{
1286 struct snd_soc_pcm_runtime *rtd;
1287 int order, ret;
1288
1289 for_each_comp_order(order) {
1290 for_each_card_rtds(card, rtd) {
1291
1292 dev_dbg(card->dev,
1293 "ASoC: probe %s dai link %d late %d\n",
1294 card->name, rtd->num, order);
1295
1296 /* probe all rtd connected DAIs in good order */
1297 ret = snd_soc_pcm_dai_probe(rtd, order);
1298 if (ret)
1299 return ret;
1300 }
1301 }
1302
1303 return 0;
1304}
1305
1306static void soc_remove_link_components(struct snd_soc_card *card)
1307{
1308 struct snd_soc_component *component;
1309 struct snd_soc_pcm_runtime *rtd;
1310 int i, order;
1311
1312 for_each_comp_order(order) {
1313 for_each_card_rtds(card, rtd) {
1314 for_each_rtd_components(rtd, i, component) {
1315 if (component->driver->remove_order != order)
1316 continue;
1317
1318 soc_remove_component(component, 1);
1319 }
1320 }
1321 }
1322}
1323
1324static int soc_probe_link_components(struct snd_soc_card *card)
1325{
1326 struct snd_soc_component *component;
1327 struct snd_soc_pcm_runtime *rtd;
1328 int i, ret, order;
1329
1330 for_each_comp_order(order) {
1331 for_each_card_rtds(card, rtd) {
1332 for_each_rtd_components(rtd, i, component) {
1333 if (component->driver->probe_order != order)
1334 continue;
1335
1336 ret = soc_probe_component(card, component);
1337 if (ret < 0)
1338 return ret;
1339 }
1340 }
1341 }
1342
1343 return 0;
1344}
1345
1346static void soc_unbind_aux_dev(struct snd_soc_card *card)
1347{
1348 struct snd_soc_component *component, *_component;
1349
1350 for_each_card_auxs_safe(card, component, _component) {
1351 /* for snd_soc_component_init() */
1352 snd_soc_component_set_aux(component, NULL);
1353 list_del(&component->card_aux_list);
1354 }
1355}
1356
1357static int soc_bind_aux_dev(struct snd_soc_card *card)
1358{
1359 struct snd_soc_component *component;
1360 struct snd_soc_aux_dev *aux;
1361 int i;
1362
1363 for_each_card_pre_auxs(card, i, aux) {
1364 /* codecs, usually analog devices */
1365 component = soc_find_component(&aux->dlc);
1366 if (!component)
1367 return -EPROBE_DEFER;
1368
1369 /* for snd_soc_component_init() */
1370 snd_soc_component_set_aux(component, aux);
1371 /* see for_each_card_auxs */
1372 list_add(&component->card_aux_list, &card->aux_comp_list);
1373 }
1374 return 0;
1375}
1376
1377static int soc_probe_aux_devices(struct snd_soc_card *card)
1378{
1379 struct snd_soc_component *component;
1380 int order;
1381 int ret;
1382
1383 for_each_comp_order(order) {
1384 for_each_card_auxs(card, component) {
1385 if (component->driver->probe_order != order)
1386 continue;
1387
1388 ret = soc_probe_component(card, component);
1389 if (ret < 0)
1390 return ret;
1391 }
1392 }
1393
1394 return 0;
1395}
1396
1397static void soc_remove_aux_devices(struct snd_soc_card *card)
1398{
1399 struct snd_soc_component *comp, *_comp;
1400 int order;
1401
1402 for_each_comp_order(order) {
1403 for_each_card_auxs_safe(card, comp, _comp) {
1404 if (comp->driver->remove_order == order)
1405 soc_remove_component(comp, 1);
1406 }
1407 }
1408}
1409
1410/**
1411 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1412 * @rtd: The runtime for which the DAI link format should be changed
1413 * @dai_fmt: The new DAI link format
1414 *
1415 * This function updates the DAI link format for all DAIs connected to the DAI
1416 * link for the specified runtime.
1417 *
1418 * Note: For setups with a static format set the dai_fmt field in the
1419 * corresponding snd_dai_link struct instead of using this function.
1420 *
1421 * Returns 0 on success, otherwise a negative error code.
1422 */
1423int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1424 unsigned int dai_fmt)
1425{
1426 struct snd_soc_dai *cpu_dai;
1427 struct snd_soc_dai *codec_dai;
1428 unsigned int inv_dai_fmt;
1429 unsigned int i;
1430 int ret;
1431
1432 for_each_rtd_codec_dais(rtd, i, codec_dai) {
1433 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1434 if (ret != 0 && ret != -ENOTSUPP) {
1435 dev_warn(codec_dai->dev,
1436 "ASoC: Failed to set DAI format: %d\n", ret);
1437 return ret;
1438 }
1439 }
1440
1441 /*
1442 * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1443 * the component which has non_legacy_dai_naming is Codec
1444 */
1445 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1446 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1447 case SND_SOC_DAIFMT_CBM_CFM:
1448 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1449 break;
1450 case SND_SOC_DAIFMT_CBM_CFS:
1451 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1452 break;
1453 case SND_SOC_DAIFMT_CBS_CFM:
1454 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1455 break;
1456 case SND_SOC_DAIFMT_CBS_CFS:
1457 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1458 break;
1459 }
1460 for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1461 unsigned int fmt = dai_fmt;
1462
1463 if (cpu_dai->component->driver->non_legacy_dai_naming)
1464 fmt = inv_dai_fmt;
1465
1466 ret = snd_soc_dai_set_fmt(cpu_dai, fmt);
1467 if (ret != 0 && ret != -ENOTSUPP) {
1468 dev_warn(cpu_dai->dev,
1469 "ASoC: Failed to set DAI format: %d\n", ret);
1470 return ret;
1471 }
1472 }
1473
1474 return 0;
1475}
1476EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1477
1478#ifdef CONFIG_DMI
1479/*
1480 * If a DMI filed contain strings in this blacklist (e.g.
1481 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1482 * as invalid and dropped when setting the card long name from DMI info.
1483 */
1484static const char * const dmi_blacklist[] = {
1485 "To be filled by OEM",
1486 "TBD by OEM",
1487 "Default String",
1488 "Board Manufacturer",
1489 "Board Vendor Name",
1490 "Board Product Name",
1491 NULL, /* terminator */
1492};
1493
1494/*
1495 * Trim special characters, and replace '-' with '_' since '-' is used to
1496 * separate different DMI fields in the card long name. Only number and
1497 * alphabet characters and a few separator characters are kept.
1498 */
1499static void cleanup_dmi_name(char *name)
1500{
1501 int i, j = 0;
1502
1503 for (i = 0; name[i]; i++) {
1504 if (isalnum(name[i]) || (name[i] == '.')
1505 || (name[i] == '_'))
1506 name[j++] = name[i];
1507 else if (name[i] == '-')
1508 name[j++] = '_';
1509 }
1510
1511 name[j] = '\0';
1512}
1513
1514/*
1515 * Check if a DMI field is valid, i.e. not containing any string
1516 * in the black list.
1517 */
1518static int is_dmi_valid(const char *field)
1519{
1520 int i = 0;
1521
1522 while (dmi_blacklist[i]) {
1523 if (strstr(field, dmi_blacklist[i]))
1524 return 0;
1525 i++;
1526 }
1527
1528 return 1;
1529}
1530
1531/*
1532 * Append a string to card->dmi_longname with character cleanups.
1533 */
1534static void append_dmi_string(struct snd_soc_card *card, const char *str)
1535{
1536 char *dst = card->dmi_longname;
1537 size_t dst_len = sizeof(card->dmi_longname);
1538 size_t len;
1539
1540 len = strlen(dst);
1541 snprintf(dst + len, dst_len - len, "-%s", str);
1542
1543 len++; /* skip the separator "-" */
1544 if (len < dst_len)
1545 cleanup_dmi_name(dst + len);
1546}
1547
1548/**
1549 * snd_soc_set_dmi_name() - Register DMI names to card
1550 * @card: The card to register DMI names
1551 * @flavour: The flavour "differentiator" for the card amongst its peers.
1552 *
1553 * An Intel machine driver may be used by many different devices but are
1554 * difficult for userspace to differentiate, since machine drivers ususally
1555 * use their own name as the card short name and leave the card long name
1556 * blank. To differentiate such devices and fix bugs due to lack of
1557 * device-specific configurations, this function allows DMI info to be used
1558 * as the sound card long name, in the format of
1559 * "vendor-product-version-board"
1560 * (Character '-' is used to separate different DMI fields here).
1561 * This will help the user space to load the device-specific Use Case Manager
1562 * (UCM) configurations for the card.
1563 *
1564 * Possible card long names may be:
1565 * DellInc.-XPS139343-01-0310JH
1566 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1567 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1568 *
1569 * This function also supports flavoring the card longname to provide
1570 * the extra differentiation, like "vendor-product-version-board-flavor".
1571 *
1572 * We only keep number and alphabet characters and a few separator characters
1573 * in the card long name since UCM in the user space uses the card long names
1574 * as card configuration directory names and AudoConf cannot support special
1575 * charactors like SPACE.
1576 *
1577 * Returns 0 on success, otherwise a negative error code.
1578 */
1579int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1580{
1581 const char *vendor, *product, *product_version, *board;
1582
1583 if (card->long_name)
1584 return 0; /* long name already set by driver or from DMI */
1585
1586 /* make up dmi long name as: vendor-product-version-board */
1587 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1588 if (!vendor || !is_dmi_valid(vendor)) {
1589 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1590 return 0;
1591 }
1592
1593 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1594 cleanup_dmi_name(card->dmi_longname);
1595
1596 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1597 if (product && is_dmi_valid(product)) {
1598 append_dmi_string(card, product);
1599
1600 /*
1601 * some vendors like Lenovo may only put a self-explanatory
1602 * name in the product version field
1603 */
1604 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1605 if (product_version && is_dmi_valid(product_version))
1606 append_dmi_string(card, product_version);
1607 }
1608
1609 board = dmi_get_system_info(DMI_BOARD_NAME);
1610 if (board && is_dmi_valid(board)) {
1611 if (!product || strcasecmp(board, product))
1612 append_dmi_string(card, board);
1613 } else if (!product) {
1614 /* fall back to using legacy name */
1615 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1616 return 0;
1617 }
1618
1619 /* Add flavour to dmi long name */
1620 if (flavour)
1621 append_dmi_string(card, flavour);
1622
1623 /* set the card long name */
1624 card->long_name = card->dmi_longname;
1625
1626 return 0;
1627}
1628EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1629#endif /* CONFIG_DMI */
1630
1631static void soc_check_tplg_fes(struct snd_soc_card *card)
1632{
1633 struct snd_soc_component *component;
1634 const struct snd_soc_component_driver *comp_drv;
1635 struct snd_soc_dai_link *dai_link;
1636 int i;
1637
1638 for_each_component(component) {
1639
1640 /* does this component override BEs ? */
1641 if (!component->driver->ignore_machine)
1642 continue;
1643
1644 /* for this machine ? */
1645 if (!strcmp(component->driver->ignore_machine,
1646 card->dev->driver->name))
1647 goto match;
1648 if (strcmp(component->driver->ignore_machine,
1649 dev_name(card->dev)))
1650 continue;
1651match:
1652 /* machine matches, so override the rtd data */
1653 for_each_card_prelinks(card, i, dai_link) {
1654
1655 /* ignore this FE */
1656 if (dai_link->dynamic) {
1657 dai_link->ignore = true;
1658 continue;
1659 }
1660
1661 dev_dbg(card->dev, "info: override BE DAI link %s\n",
1662 card->dai_link[i].name);
1663
1664 /* override platform component */
1665 if (!dai_link->platforms) {
1666 dev_err(card->dev, "init platform error");
1667 continue;
1668 }
1669 dai_link->platforms->name = component->name;
1670
1671 /* convert non BE into BE */
1672 if (!dai_link->no_pcm) {
1673 dai_link->no_pcm = 1;
1674
1675 if (dai_link->dpcm_playback)
1676 dev_warn(card->dev,
1677 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1678 dai_link->name);
1679 if (dai_link->dpcm_capture)
1680 dev_warn(card->dev,
1681 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1682 dai_link->name);
1683
1684 /* convert normal link into DPCM one */
1685 if (!(dai_link->dpcm_playback ||
1686 dai_link->dpcm_capture)) {
1687 dai_link->dpcm_playback = !dai_link->capture_only;
1688 dai_link->dpcm_capture = !dai_link->playback_only;
1689 }
1690 }
1691
1692 /*
1693 * override any BE fixups
1694 * see
1695 * snd_soc_link_be_hw_params_fixup()
1696 */
1697 dai_link->be_hw_params_fixup =
1698 component->driver->be_hw_params_fixup;
1699
1700 /*
1701 * most BE links don't set stream name, so set it to
1702 * dai link name if it's NULL to help bind widgets.
1703 */
1704 if (!dai_link->stream_name)
1705 dai_link->stream_name = dai_link->name;
1706 }
1707
1708 /* Inform userspace we are using alternate topology */
1709 if (component->driver->topology_name_prefix) {
1710
1711 /* topology shortname created? */
1712 if (!card->topology_shortname_created) {
1713 comp_drv = component->driver;
1714
1715 snprintf(card->topology_shortname, 32, "%s-%s",
1716 comp_drv->topology_name_prefix,
1717 card->name);
1718 card->topology_shortname_created = true;
1719 }
1720
1721 /* use topology shortname */
1722 card->name = card->topology_shortname;
1723 }
1724 }
1725}
1726
1727#define soc_setup_card_name(name, name1, name2, norm) \
1728 __soc_setup_card_name(name, sizeof(name), name1, name2, norm)
1729static void __soc_setup_card_name(char *name, int len,
1730 const char *name1, const char *name2,
1731 int normalization)
1732{
1733 int i;
1734
1735 snprintf(name, len, "%s", name1 ? name1 : name2);
1736
1737 if (!normalization)
1738 return;
1739
1740 /*
1741 * Name normalization
1742 *
1743 * The driver name is somewhat special, as it's used as a key for
1744 * searches in the user-space.
1745 *
1746 * ex)
1747 * "abcd??efg" -> "abcd__efg"
1748 */
1749 for (i = 0; i < len; i++) {
1750 switch (name[i]) {
1751 case '_':
1752 case '-':
1753 case '\0':
1754 break;
1755 default:
1756 if (!isalnum(name[i]))
1757 name[i] = '_';
1758 break;
1759 }
1760 }
1761}
1762
1763static void soc_cleanup_card_resources(struct snd_soc_card *card)
1764{
1765 struct snd_soc_pcm_runtime *rtd, *n;
1766
1767 if (card->snd_card)
1768 snd_card_disconnect_sync(card->snd_card);
1769
1770 snd_soc_dapm_shutdown(card);
1771
1772 /* remove and free each DAI */
1773 soc_remove_link_dais(card);
1774 soc_remove_link_components(card);
1775
1776 for_each_card_rtds_safe(card, rtd, n)
1777 snd_soc_remove_pcm_runtime(card, rtd);
1778
1779 /* remove auxiliary devices */
1780 soc_remove_aux_devices(card);
1781 soc_unbind_aux_dev(card);
1782
1783 snd_soc_dapm_free(&card->dapm);
1784 soc_cleanup_card_debugfs(card);
1785
1786 /* remove the card */
1787 snd_soc_card_remove(card);
1788
1789 if (card->snd_card) {
1790 snd_card_free(card->snd_card);
1791 card->snd_card = NULL;
1792 }
1793}
1794
1795static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1796{
1797 if (card->instantiated) {
1798 card->instantiated = false;
1799 snd_soc_flush_all_delayed_work(card);
1800
1801 soc_cleanup_card_resources(card);
1802 if (!unregister)
1803 list_add(&card->list, &unbind_card_list);
1804 } else {
1805 if (unregister)
1806 list_del(&card->list);
1807 }
1808}
1809
1810static int snd_soc_bind_card(struct snd_soc_card *card)
1811{
1812 struct snd_soc_pcm_runtime *rtd;
1813 struct snd_soc_component *component;
1814 struct snd_soc_dai_link *dai_link;
1815 int ret, i;
1816
1817 mutex_lock(&client_mutex);
1818 mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1819
1820 snd_soc_dapm_init(&card->dapm, card, NULL);
1821
1822 /* check whether any platform is ignore machine FE and using topology */
1823 soc_check_tplg_fes(card);
1824
1825 /* bind aux_devs too */
1826 ret = soc_bind_aux_dev(card);
1827 if (ret < 0)
1828 goto probe_end;
1829
1830 /* add predefined DAI links to the list */
1831 card->num_rtd = 0;
1832 for_each_card_prelinks(card, i, dai_link) {
1833 ret = snd_soc_add_pcm_runtime(card, dai_link);
1834 if (ret < 0)
1835 goto probe_end;
1836 }
1837
1838 /* card bind complete so register a sound card */
1839 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1840 card->owner, 0, &card->snd_card);
1841 if (ret < 0) {
1842 dev_err(card->dev,
1843 "ASoC: can't create sound card for card %s: %d\n",
1844 card->name, ret);
1845 goto probe_end;
1846 }
1847
1848 soc_init_card_debugfs(card);
1849
1850 soc_resume_init(card);
1851
1852 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1853 card->num_dapm_widgets);
1854 if (ret < 0)
1855 goto probe_end;
1856
1857 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1858 card->num_of_dapm_widgets);
1859 if (ret < 0)
1860 goto probe_end;
1861
1862 /* initialise the sound card only once */
1863 ret = snd_soc_card_probe(card);
1864 if (ret < 0)
1865 goto probe_end;
1866
1867 /* probe all components used by DAI links on this card */
1868 ret = soc_probe_link_components(card);
1869 if (ret < 0) {
1870 dev_err(card->dev,
1871 "ASoC: failed to instantiate card %d\n", ret);
1872 goto probe_end;
1873 }
1874
1875 /* probe auxiliary components */
1876 ret = soc_probe_aux_devices(card);
1877 if (ret < 0) {
1878 dev_err(card->dev,
1879 "ASoC: failed to probe aux component %d\n", ret);
1880 goto probe_end;
1881 }
1882
1883 /* probe all DAI links on this card */
1884 ret = soc_probe_link_dais(card);
1885 if (ret < 0) {
1886 dev_err(card->dev,
1887 "ASoC: failed to instantiate card %d\n", ret);
1888 goto probe_end;
1889 }
1890
1891 for_each_card_rtds(card, rtd) {
1892 ret = soc_init_pcm_runtime(card, rtd);
1893 if (ret < 0)
1894 goto probe_end;
1895 }
1896
1897 snd_soc_dapm_link_dai_widgets(card);
1898 snd_soc_dapm_connect_dai_link_widgets(card);
1899
1900 ret = snd_soc_add_card_controls(card, card->controls,
1901 card->num_controls);
1902 if (ret < 0)
1903 goto probe_end;
1904
1905 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
1906 card->num_dapm_routes);
1907 if (ret < 0) {
1908 if (card->disable_route_checks) {
1909 dev_info(card->dev,
1910 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1911 __func__);
1912 } else {
1913 dev_err(card->dev,
1914 "%s: snd_soc_dapm_add_routes failed: %d\n",
1915 __func__, ret);
1916 goto probe_end;
1917 }
1918 }
1919
1920 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
1921 card->num_of_dapm_routes);
1922 if (ret < 0)
1923 goto probe_end;
1924
1925 /* try to set some sane longname if DMI is available */
1926 snd_soc_set_dmi_name(card, NULL);
1927
1928 soc_setup_card_name(card->snd_card->shortname,
1929 card->name, NULL, 0);
1930 soc_setup_card_name(card->snd_card->longname,
1931 card->long_name, card->name, 0);
1932 soc_setup_card_name(card->snd_card->driver,
1933 card->driver_name, card->name, 1);
1934
1935 if (card->components) {
1936 /* the current implementation of snd_component_add() accepts */
1937 /* multiple components in the string separated by space, */
1938 /* but the string collision (identical string) check might */
1939 /* not work correctly */
1940 ret = snd_component_add(card->snd_card, card->components);
1941 if (ret < 0) {
1942 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
1943 card->name, ret);
1944 goto probe_end;
1945 }
1946 }
1947
1948 ret = snd_soc_card_late_probe(card);
1949 if (ret < 0)
1950 goto probe_end;
1951
1952 snd_soc_dapm_new_widgets(card);
1953
1954 ret = snd_card_register(card->snd_card);
1955 if (ret < 0) {
1956 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
1957 ret);
1958 goto probe_end;
1959 }
1960
1961 card->instantiated = 1;
1962 dapm_mark_endpoints_dirty(card);
1963 snd_soc_dapm_sync(&card->dapm);
1964
1965 /* deactivate pins to sleep state */
1966 for_each_card_components(card, component)
1967 if (!snd_soc_component_active(component))
1968 pinctrl_pm_select_sleep_state(component->dev);
1969
1970probe_end:
1971 if (ret < 0)
1972 soc_cleanup_card_resources(card);
1973
1974 mutex_unlock(&card->mutex);
1975 mutex_unlock(&client_mutex);
1976
1977 return ret;
1978}
1979
1980/* probes a new socdev */
1981static int soc_probe(struct platform_device *pdev)
1982{
1983 struct snd_soc_card *card = platform_get_drvdata(pdev);
1984
1985 /*
1986 * no card, so machine driver should be registering card
1987 * we should not be here in that case so ret error
1988 */
1989 if (!card)
1990 return -EINVAL;
1991
1992 dev_warn(&pdev->dev,
1993 "ASoC: machine %s should use snd_soc_register_card()\n",
1994 card->name);
1995
1996 /* Bodge while we unpick instantiation */
1997 card->dev = &pdev->dev;
1998
1999 return snd_soc_register_card(card);
2000}
2001
2002/* removes a socdev */
2003static int soc_remove(struct platform_device *pdev)
2004{
2005 struct snd_soc_card *card = platform_get_drvdata(pdev);
2006
2007 snd_soc_unregister_card(card);
2008 return 0;
2009}
2010
2011int snd_soc_poweroff(struct device *dev)
2012{
2013 struct snd_soc_card *card = dev_get_drvdata(dev);
2014 struct snd_soc_component *component;
2015
2016 if (!card->instantiated)
2017 return 0;
2018
2019 /*
2020 * Flush out pmdown_time work - we actually do want to run it
2021 * now, we're shutting down so no imminent restart.
2022 */
2023 snd_soc_flush_all_delayed_work(card);
2024
2025 snd_soc_dapm_shutdown(card);
2026
2027 /* deactivate pins to sleep state */
2028 for_each_card_components(card, component)
2029 pinctrl_pm_select_sleep_state(component->dev);
2030
2031 return 0;
2032}
2033EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2034
2035const struct dev_pm_ops snd_soc_pm_ops = {
2036 .suspend = snd_soc_suspend,
2037 .resume = snd_soc_resume,
2038 .freeze = snd_soc_suspend,
2039 .thaw = snd_soc_resume,
2040 .poweroff = snd_soc_poweroff,
2041 .restore = snd_soc_resume,
2042};
2043EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2044
2045/* ASoC platform driver */
2046static struct platform_driver soc_driver = {
2047 .driver = {
2048 .name = "soc-audio",
2049 .pm = &snd_soc_pm_ops,
2050 },
2051 .probe = soc_probe,
2052 .remove = soc_remove,
2053};
2054
2055/**
2056 * snd_soc_cnew - create new control
2057 * @_template: control template
2058 * @data: control private data
2059 * @long_name: control long name
2060 * @prefix: control name prefix
2061 *
2062 * Create a new mixer control from a template control.
2063 *
2064 * Returns 0 for success, else error.
2065 */
2066struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2067 void *data, const char *long_name,
2068 const char *prefix)
2069{
2070 struct snd_kcontrol_new template;
2071 struct snd_kcontrol *kcontrol;
2072 char *name = NULL;
2073
2074 memcpy(&template, _template, sizeof(template));
2075 template.index = 0;
2076
2077 if (!long_name)
2078 long_name = template.name;
2079
2080 if (prefix) {
2081 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2082 if (!name)
2083 return NULL;
2084
2085 template.name = name;
2086 } else {
2087 template.name = long_name;
2088 }
2089
2090 kcontrol = snd_ctl_new1(&template, data);
2091
2092 kfree(name);
2093
2094 return kcontrol;
2095}
2096EXPORT_SYMBOL_GPL(snd_soc_cnew);
2097
2098static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2099 const struct snd_kcontrol_new *controls, int num_controls,
2100 const char *prefix, void *data)
2101{
2102 int err, i;
2103
2104 for (i = 0; i < num_controls; i++) {
2105 const struct snd_kcontrol_new *control = &controls[i];
2106
2107 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2108 control->name, prefix));
2109 if (err < 0) {
2110 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2111 control->name, err);
2112 return err;
2113 }
2114 }
2115
2116 return 0;
2117}
2118
2119/**
2120 * snd_soc_add_component_controls - Add an array of controls to a component.
2121 *
2122 * @component: Component to add controls to
2123 * @controls: Array of controls to add
2124 * @num_controls: Number of elements in the array
2125 *
2126 * Return: 0 for success, else error.
2127 */
2128int snd_soc_add_component_controls(struct snd_soc_component *component,
2129 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2130{
2131 struct snd_card *card = component->card->snd_card;
2132
2133 return snd_soc_add_controls(card, component->dev, controls,
2134 num_controls, component->name_prefix, component);
2135}
2136EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2137
2138/**
2139 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2140 * Convenience function to add a list of controls.
2141 *
2142 * @soc_card: SoC card to add controls to
2143 * @controls: array of controls to add
2144 * @num_controls: number of elements in the array
2145 *
2146 * Return 0 for success, else error.
2147 */
2148int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2149 const struct snd_kcontrol_new *controls, int num_controls)
2150{
2151 struct snd_card *card = soc_card->snd_card;
2152
2153 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2154 NULL, soc_card);
2155}
2156EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2157
2158/**
2159 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2160 * Convienience function to add a list of controls.
2161 *
2162 * @dai: DAI to add controls to
2163 * @controls: array of controls to add
2164 * @num_controls: number of elements in the array
2165 *
2166 * Return 0 for success, else error.
2167 */
2168int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2169 const struct snd_kcontrol_new *controls, int num_controls)
2170{
2171 struct snd_card *card = dai->component->card->snd_card;
2172
2173 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2174 NULL, dai);
2175}
2176EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2177
2178/**
2179 * snd_soc_register_card - Register a card with the ASoC core
2180 *
2181 * @card: Card to register
2182 *
2183 */
2184int snd_soc_register_card(struct snd_soc_card *card)
2185{
2186 if (!card->name || !card->dev)
2187 return -EINVAL;
2188
2189 dev_set_drvdata(card->dev, card);
2190
2191 INIT_LIST_HEAD(&card->widgets);
2192 INIT_LIST_HEAD(&card->paths);
2193 INIT_LIST_HEAD(&card->dapm_list);
2194 INIT_LIST_HEAD(&card->aux_comp_list);
2195 INIT_LIST_HEAD(&card->component_dev_list);
2196 INIT_LIST_HEAD(&card->list);
2197 INIT_LIST_HEAD(&card->rtd_list);
2198 INIT_LIST_HEAD(&card->dapm_dirty);
2199 INIT_LIST_HEAD(&card->dobj_list);
2200
2201 card->instantiated = 0;
2202 mutex_init(&card->mutex);
2203 mutex_init(&card->dapm_mutex);
2204 mutex_init(&card->pcm_mutex);
2205 spin_lock_init(&card->dpcm_lock);
2206
2207 return snd_soc_bind_card(card);
2208}
2209EXPORT_SYMBOL_GPL(snd_soc_register_card);
2210
2211/**
2212 * snd_soc_unregister_card - Unregister a card with the ASoC core
2213 *
2214 * @card: Card to unregister
2215 *
2216 */
2217int snd_soc_unregister_card(struct snd_soc_card *card)
2218{
2219 mutex_lock(&client_mutex);
2220 snd_soc_unbind_card(card, true);
2221 mutex_unlock(&client_mutex);
2222 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2223
2224 return 0;
2225}
2226EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2227
2228/*
2229 * Simplify DAI link configuration by removing ".-1" from device names
2230 * and sanitizing names.
2231 */
2232static char *fmt_single_name(struct device *dev, int *id)
2233{
2234 char *found, name[NAME_SIZE];
2235 int id1, id2;
2236
2237 if (dev_name(dev) == NULL)
2238 return NULL;
2239
2240 strlcpy(name, dev_name(dev), NAME_SIZE);
2241
2242 /* are we a "%s.%d" name (platform and SPI components) */
2243 found = strstr(name, dev->driver->name);
2244 if (found) {
2245 /* get ID */
2246 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2247
2248 /* discard ID from name if ID == -1 */
2249 if (*id == -1)
2250 found[strlen(dev->driver->name)] = '\0';
2251 }
2252
2253 } else {
2254 /* I2C component devices are named "bus-addr" */
2255 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2256 char tmp[NAME_SIZE];
2257
2258 /* create unique ID number from I2C addr and bus */
2259 *id = ((id1 & 0xffff) << 16) + id2;
2260
2261 /* sanitize component name for DAI link creation */
2262 snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2263 name);
2264 strlcpy(name, tmp, NAME_SIZE);
2265 } else
2266 *id = 0;
2267 }
2268
2269 return devm_kstrdup(dev, name, GFP_KERNEL);
2270}
2271
2272/*
2273 * Simplify DAI link naming for single devices with multiple DAIs by removing
2274 * any ".-1" and using the DAI name (instead of device name).
2275 */
2276static inline char *fmt_multiple_name(struct device *dev,
2277 struct snd_soc_dai_driver *dai_drv)
2278{
2279 if (dai_drv->name == NULL) {
2280 dev_err(dev,
2281 "ASoC: error - multiple DAI %s registered with no name\n",
2282 dev_name(dev));
2283 return NULL;
2284 }
2285
2286 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2287}
2288
2289void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2290{
2291 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2292 list_del(&dai->list);
2293}
2294EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2295
2296/**
2297 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2298 *
2299 * @component: The component the DAIs are registered for
2300 * @dai_drv: DAI driver to use for the DAI
2301 * @legacy_dai_naming: if %true, use legacy single-name format;
2302 * if %false, use multiple-name format;
2303 *
2304 * Topology can use this API to register DAIs when probing a component.
2305 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2306 * will be freed in the component cleanup.
2307 */
2308struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2309 struct snd_soc_dai_driver *dai_drv,
2310 bool legacy_dai_naming)
2311{
2312 struct device *dev = component->dev;
2313 struct snd_soc_dai *dai;
2314
2315 dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2316
2317 lockdep_assert_held(&client_mutex);
2318
2319 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2320 if (dai == NULL)
2321 return NULL;
2322
2323 /*
2324 * Back in the old days when we still had component-less DAIs,
2325 * instead of having a static name, component-less DAIs would
2326 * inherit the name of the parent device so it is possible to
2327 * register multiple instances of the DAI. We still need to keep
2328 * the same naming style even though those DAIs are not
2329 * component-less anymore.
2330 */
2331 if (legacy_dai_naming &&
2332 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2333 dai->name = fmt_single_name(dev, &dai->id);
2334 } else {
2335 dai->name = fmt_multiple_name(dev, dai_drv);
2336 if (dai_drv->id)
2337 dai->id = dai_drv->id;
2338 else
2339 dai->id = component->num_dai;
2340 }
2341 if (!dai->name)
2342 return NULL;
2343
2344 dai->component = component;
2345 dai->dev = dev;
2346 dai->driver = dai_drv;
2347
2348 /* see for_each_component_dais */
2349 list_add_tail(&dai->list, &component->dai_list);
2350 component->num_dai++;
2351
2352 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2353 return dai;
2354}
2355
2356/**
2357 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2358 *
2359 * @component: The component for which the DAIs should be unregistered
2360 */
2361static void snd_soc_unregister_dais(struct snd_soc_component *component)
2362{
2363 struct snd_soc_dai *dai, *_dai;
2364
2365 for_each_component_dais_safe(component, dai, _dai)
2366 snd_soc_unregister_dai(dai);
2367}
2368
2369/**
2370 * snd_soc_register_dais - Register a DAI with the ASoC core
2371 *
2372 * @component: The component the DAIs are registered for
2373 * @dai_drv: DAI driver to use for the DAIs
2374 * @count: Number of DAIs
2375 */
2376static int snd_soc_register_dais(struct snd_soc_component *component,
2377 struct snd_soc_dai_driver *dai_drv,
2378 size_t count)
2379{
2380 struct snd_soc_dai *dai;
2381 unsigned int i;
2382 int ret;
2383
2384 for (i = 0; i < count; i++) {
2385 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2386 !component->driver->non_legacy_dai_naming);
2387 if (dai == NULL) {
2388 ret = -ENOMEM;
2389 goto err;
2390 }
2391 }
2392
2393 return 0;
2394
2395err:
2396 snd_soc_unregister_dais(component);
2397
2398 return ret;
2399}
2400
2401#define ENDIANNESS_MAP(name) \
2402 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2403static u64 endianness_format_map[] = {
2404 ENDIANNESS_MAP(S16_),
2405 ENDIANNESS_MAP(U16_),
2406 ENDIANNESS_MAP(S24_),
2407 ENDIANNESS_MAP(U24_),
2408 ENDIANNESS_MAP(S32_),
2409 ENDIANNESS_MAP(U32_),
2410 ENDIANNESS_MAP(S24_3),
2411 ENDIANNESS_MAP(U24_3),
2412 ENDIANNESS_MAP(S20_3),
2413 ENDIANNESS_MAP(U20_3),
2414 ENDIANNESS_MAP(S18_3),
2415 ENDIANNESS_MAP(U18_3),
2416 ENDIANNESS_MAP(FLOAT_),
2417 ENDIANNESS_MAP(FLOAT64_),
2418 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2419};
2420
2421/*
2422 * Fix up the DAI formats for endianness: codecs don't actually see
2423 * the endianness of the data but we're using the CPU format
2424 * definitions which do need to include endianness so we ensure that
2425 * codec DAIs always have both big and little endian variants set.
2426 */
2427static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2428{
2429 int i;
2430
2431 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2432 if (stream->formats & endianness_format_map[i])
2433 stream->formats |= endianness_format_map[i];
2434}
2435
2436static void snd_soc_try_rebind_card(void)
2437{
2438 struct snd_soc_card *card, *c;
2439
2440 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2441 if (!snd_soc_bind_card(card))
2442 list_del(&card->list);
2443}
2444
2445static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2446{
2447 struct snd_soc_card *card = component->card;
2448
2449 snd_soc_unregister_dais(component);
2450
2451 if (card)
2452 snd_soc_unbind_card(card, false);
2453
2454 list_del(&component->list);
2455}
2456
2457int snd_soc_component_initialize(struct snd_soc_component *component,
2458 const struct snd_soc_component_driver *driver,
2459 struct device *dev)
2460{
2461 INIT_LIST_HEAD(&component->dai_list);
2462 INIT_LIST_HEAD(&component->dobj_list);
2463 INIT_LIST_HEAD(&component->card_list);
2464 mutex_init(&component->io_mutex);
2465
2466 component->name = fmt_single_name(dev, &component->id);
2467 if (!component->name) {
2468 dev_err(dev, "ASoC: Failed to allocate name\n");
2469 return -ENOMEM;
2470 }
2471
2472 component->dev = dev;
2473 component->driver = driver;
2474
2475 return 0;
2476}
2477EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2478
2479int snd_soc_add_component(struct snd_soc_component *component,
2480 struct snd_soc_dai_driver *dai_drv,
2481 int num_dai)
2482{
2483 int ret;
2484 int i;
2485
2486 mutex_lock(&client_mutex);
2487
2488 if (component->driver->endianness) {
2489 for (i = 0; i < num_dai; i++) {
2490 convert_endianness_formats(&dai_drv[i].playback);
2491 convert_endianness_formats(&dai_drv[i].capture);
2492 }
2493 }
2494
2495 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2496 if (ret < 0) {
2497 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2498 ret);
2499 goto err_cleanup;
2500 }
2501
2502 if (!component->driver->write && !component->driver->read) {
2503 if (!component->regmap)
2504 component->regmap = dev_get_regmap(component->dev,
2505 NULL);
2506 if (component->regmap)
2507 snd_soc_component_setup_regmap(component);
2508 }
2509
2510 /* see for_each_component */
2511 list_add(&component->list, &component_list);
2512
2513err_cleanup:
2514 if (ret < 0)
2515 snd_soc_del_component_unlocked(component);
2516
2517 mutex_unlock(&client_mutex);
2518
2519 if (ret == 0)
2520 snd_soc_try_rebind_card();
2521
2522 return ret;
2523}
2524EXPORT_SYMBOL_GPL(snd_soc_add_component);
2525
2526int snd_soc_register_component(struct device *dev,
2527 const struct snd_soc_component_driver *component_driver,
2528 struct snd_soc_dai_driver *dai_drv,
2529 int num_dai)
2530{
2531 struct snd_soc_component *component;
2532 int ret;
2533
2534 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2535 if (!component)
2536 return -ENOMEM;
2537
2538 ret = snd_soc_component_initialize(component, component_driver, dev);
2539 if (ret < 0)
2540 return ret;
2541
2542 return snd_soc_add_component(component, dai_drv, num_dai);
2543}
2544EXPORT_SYMBOL_GPL(snd_soc_register_component);
2545
2546/**
2547 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2548 * from the ASoC core
2549 *
2550 * @dev: The device to unregister
2551 * @component_driver: The component driver to unregister
2552 */
2553void snd_soc_unregister_component_by_driver(struct device *dev,
2554 const struct snd_soc_component_driver *component_driver)
2555{
2556 struct snd_soc_component *component;
2557
2558 if (!component_driver)
2559 return;
2560
2561 mutex_lock(&client_mutex);
2562 component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2563 if (!component)
2564 goto out;
2565
2566 snd_soc_del_component_unlocked(component);
2567
2568out:
2569 mutex_unlock(&client_mutex);
2570}
2571EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2572
2573/**
2574 * snd_soc_unregister_component - Unregister all related component
2575 * from the ASoC core
2576 *
2577 * @dev: The device to unregister
2578 */
2579void snd_soc_unregister_component(struct device *dev)
2580{
2581 struct snd_soc_component *component;
2582
2583 mutex_lock(&client_mutex);
2584 while (1) {
2585 component = snd_soc_lookup_component_nolocked(dev, NULL);
2586 if (!component)
2587 break;
2588
2589 snd_soc_del_component_unlocked(component);
2590 }
2591 mutex_unlock(&client_mutex);
2592}
2593EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2594
2595/* Retrieve a card's name from device tree */
2596int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2597 const char *propname)
2598{
2599 struct device_node *np;
2600 int ret;
2601
2602 if (!card->dev) {
2603 pr_err("card->dev is not set before calling %s\n", __func__);
2604 return -EINVAL;
2605 }
2606
2607 np = card->dev->of_node;
2608
2609 ret = of_property_read_string_index(np, propname, 0, &card->name);
2610 /*
2611 * EINVAL means the property does not exist. This is fine providing
2612 * card->name was previously set, which is checked later in
2613 * snd_soc_register_card.
2614 */
2615 if (ret < 0 && ret != -EINVAL) {
2616 dev_err(card->dev,
2617 "ASoC: Property '%s' could not be read: %d\n",
2618 propname, ret);
2619 return ret;
2620 }
2621
2622 return 0;
2623}
2624EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2625
2626static const struct snd_soc_dapm_widget simple_widgets[] = {
2627 SND_SOC_DAPM_MIC("Microphone", NULL),
2628 SND_SOC_DAPM_LINE("Line", NULL),
2629 SND_SOC_DAPM_HP("Headphone", NULL),
2630 SND_SOC_DAPM_SPK("Speaker", NULL),
2631};
2632
2633int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2634 const char *propname)
2635{
2636 struct device_node *np = card->dev->of_node;
2637 struct snd_soc_dapm_widget *widgets;
2638 const char *template, *wname;
2639 int i, j, num_widgets, ret;
2640
2641 num_widgets = of_property_count_strings(np, propname);
2642 if (num_widgets < 0) {
2643 dev_err(card->dev,
2644 "ASoC: Property '%s' does not exist\n", propname);
2645 return -EINVAL;
2646 }
2647 if (num_widgets & 1) {
2648 dev_err(card->dev,
2649 "ASoC: Property '%s' length is not even\n", propname);
2650 return -EINVAL;
2651 }
2652
2653 num_widgets /= 2;
2654 if (!num_widgets) {
2655 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2656 propname);
2657 return -EINVAL;
2658 }
2659
2660 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2661 GFP_KERNEL);
2662 if (!widgets) {
2663 dev_err(card->dev,
2664 "ASoC: Could not allocate memory for widgets\n");
2665 return -ENOMEM;
2666 }
2667
2668 for (i = 0; i < num_widgets; i++) {
2669 ret = of_property_read_string_index(np, propname,
2670 2 * i, &template);
2671 if (ret) {
2672 dev_err(card->dev,
2673 "ASoC: Property '%s' index %d read error:%d\n",
2674 propname, 2 * i, ret);
2675 return -EINVAL;
2676 }
2677
2678 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2679 if (!strncmp(template, simple_widgets[j].name,
2680 strlen(simple_widgets[j].name))) {
2681 widgets[i] = simple_widgets[j];
2682 break;
2683 }
2684 }
2685
2686 if (j >= ARRAY_SIZE(simple_widgets)) {
2687 dev_err(card->dev,
2688 "ASoC: DAPM widget '%s' is not supported\n",
2689 template);
2690 return -EINVAL;
2691 }
2692
2693 ret = of_property_read_string_index(np, propname,
2694 (2 * i) + 1,
2695 &wname);
2696 if (ret) {
2697 dev_err(card->dev,
2698 "ASoC: Property '%s' index %d read error:%d\n",
2699 propname, (2 * i) + 1, ret);
2700 return -EINVAL;
2701 }
2702
2703 widgets[i].name = wname;
2704 }
2705
2706 card->of_dapm_widgets = widgets;
2707 card->num_of_dapm_widgets = num_widgets;
2708
2709 return 0;
2710}
2711EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2712
2713int snd_soc_of_get_slot_mask(struct device_node *np,
2714 const char *prop_name,
2715 unsigned int *mask)
2716{
2717 u32 val;
2718 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2719 int i;
2720
2721 if (!of_slot_mask)
2722 return 0;
2723 val /= sizeof(u32);
2724 for (i = 0; i < val; i++)
2725 if (be32_to_cpup(&of_slot_mask[i]))
2726 *mask |= (1 << i);
2727
2728 return val;
2729}
2730EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2731
2732int snd_soc_of_parse_tdm_slot(struct device_node *np,
2733 unsigned int *tx_mask,
2734 unsigned int *rx_mask,
2735 unsigned int *slots,
2736 unsigned int *slot_width)
2737{
2738 u32 val;
2739 int ret;
2740
2741 if (tx_mask)
2742 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2743 if (rx_mask)
2744 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2745
2746 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2747 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2748 if (ret)
2749 return ret;
2750
2751 if (slots)
2752 *slots = val;
2753 }
2754
2755 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2756 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2757 if (ret)
2758 return ret;
2759
2760 if (slot_width)
2761 *slot_width = val;
2762 }
2763
2764 return 0;
2765}
2766EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2767
2768void snd_soc_of_parse_node_prefix(struct device_node *np,
2769 struct snd_soc_codec_conf *codec_conf,
2770 struct device_node *of_node,
2771 const char *propname)
2772{
2773 const char *str;
2774 int ret;
2775
2776 ret = of_property_read_string(np, propname, &str);
2777 if (ret < 0) {
2778 /* no prefix is not error */
2779 return;
2780 }
2781
2782 codec_conf->dlc.of_node = of_node;
2783 codec_conf->name_prefix = str;
2784}
2785EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2786
2787int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2788 const char *propname)
2789{
2790 struct device_node *np = card->dev->of_node;
2791 int num_routes;
2792 struct snd_soc_dapm_route *routes;
2793 int i, ret;
2794
2795 num_routes = of_property_count_strings(np, propname);
2796 if (num_routes < 0 || num_routes & 1) {
2797 dev_err(card->dev,
2798 "ASoC: Property '%s' does not exist or its length is not even\n",
2799 propname);
2800 return -EINVAL;
2801 }
2802 num_routes /= 2;
2803 if (!num_routes) {
2804 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2805 propname);
2806 return -EINVAL;
2807 }
2808
2809 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2810 GFP_KERNEL);
2811 if (!routes) {
2812 dev_err(card->dev,
2813 "ASoC: Could not allocate DAPM route table\n");
2814 return -EINVAL;
2815 }
2816
2817 for (i = 0; i < num_routes; i++) {
2818 ret = of_property_read_string_index(np, propname,
2819 2 * i, &routes[i].sink);
2820 if (ret) {
2821 dev_err(card->dev,
2822 "ASoC: Property '%s' index %d could not be read: %d\n",
2823 propname, 2 * i, ret);
2824 return -EINVAL;
2825 }
2826 ret = of_property_read_string_index(np, propname,
2827 (2 * i) + 1, &routes[i].source);
2828 if (ret) {
2829 dev_err(card->dev,
2830 "ASoC: Property '%s' index %d could not be read: %d\n",
2831 propname, (2 * i) + 1, ret);
2832 return -EINVAL;
2833 }
2834 }
2835
2836 card->num_of_dapm_routes = num_routes;
2837 card->of_dapm_routes = routes;
2838
2839 return 0;
2840}
2841EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
2842
2843unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
2844 const char *prefix,
2845 struct device_node **bitclkmaster,
2846 struct device_node **framemaster)
2847{
2848 int ret, i;
2849 char prop[128];
2850 unsigned int format = 0;
2851 int bit, frame;
2852 const char *str;
2853 struct {
2854 char *name;
2855 unsigned int val;
2856 } of_fmt_table[] = {
2857 { "i2s", SND_SOC_DAIFMT_I2S },
2858 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
2859 { "left_j", SND_SOC_DAIFMT_LEFT_J },
2860 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
2861 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
2862 { "ac97", SND_SOC_DAIFMT_AC97 },
2863 { "pdm", SND_SOC_DAIFMT_PDM},
2864 { "msb", SND_SOC_DAIFMT_MSB },
2865 { "lsb", SND_SOC_DAIFMT_LSB },
2866 };
2867
2868 if (!prefix)
2869 prefix = "";
2870
2871 /*
2872 * check "dai-format = xxx"
2873 * or "[prefix]format = xxx"
2874 * SND_SOC_DAIFMT_FORMAT_MASK area
2875 */
2876 ret = of_property_read_string(np, "dai-format", &str);
2877 if (ret < 0) {
2878 snprintf(prop, sizeof(prop), "%sformat", prefix);
2879 ret = of_property_read_string(np, prop, &str);
2880 }
2881 if (ret == 0) {
2882 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
2883 if (strcmp(str, of_fmt_table[i].name) == 0) {
2884 format |= of_fmt_table[i].val;
2885 break;
2886 }
2887 }
2888 }
2889
2890 /*
2891 * check "[prefix]continuous-clock"
2892 * SND_SOC_DAIFMT_CLOCK_MASK area
2893 */
2894 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
2895 if (of_property_read_bool(np, prop))
2896 format |= SND_SOC_DAIFMT_CONT;
2897 else
2898 format |= SND_SOC_DAIFMT_GATED;
2899
2900 /*
2901 * check "[prefix]bitclock-inversion"
2902 * check "[prefix]frame-inversion"
2903 * SND_SOC_DAIFMT_INV_MASK area
2904 */
2905 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
2906 bit = !!of_get_property(np, prop, NULL);
2907
2908 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
2909 frame = !!of_get_property(np, prop, NULL);
2910
2911 switch ((bit << 4) + frame) {
2912 case 0x11:
2913 format |= SND_SOC_DAIFMT_IB_IF;
2914 break;
2915 case 0x10:
2916 format |= SND_SOC_DAIFMT_IB_NF;
2917 break;
2918 case 0x01:
2919 format |= SND_SOC_DAIFMT_NB_IF;
2920 break;
2921 default:
2922 /* SND_SOC_DAIFMT_NB_NF is default */
2923 break;
2924 }
2925
2926 /*
2927 * check "[prefix]bitclock-master"
2928 * check "[prefix]frame-master"
2929 * SND_SOC_DAIFMT_MASTER_MASK area
2930 */
2931 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
2932 bit = !!of_get_property(np, prop, NULL);
2933 if (bit && bitclkmaster)
2934 *bitclkmaster = of_parse_phandle(np, prop, 0);
2935
2936 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
2937 frame = !!of_get_property(np, prop, NULL);
2938 if (frame && framemaster)
2939 *framemaster = of_parse_phandle(np, prop, 0);
2940
2941 switch ((bit << 4) + frame) {
2942 case 0x11:
2943 format |= SND_SOC_DAIFMT_CBM_CFM;
2944 break;
2945 case 0x10:
2946 format |= SND_SOC_DAIFMT_CBM_CFS;
2947 break;
2948 case 0x01:
2949 format |= SND_SOC_DAIFMT_CBS_CFM;
2950 break;
2951 default:
2952 format |= SND_SOC_DAIFMT_CBS_CFS;
2953 break;
2954 }
2955
2956 return format;
2957}
2958EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
2959
2960int snd_soc_get_dai_id(struct device_node *ep)
2961{
2962 struct snd_soc_component *component;
2963 struct snd_soc_dai_link_component dlc;
2964 int ret;
2965
2966 dlc.of_node = of_graph_get_port_parent(ep);
2967 dlc.name = NULL;
2968 /*
2969 * For example HDMI case, HDMI has video/sound port,
2970 * but ALSA SoC needs sound port number only.
2971 * Thus counting HDMI DT port/endpoint doesn't work.
2972 * Then, it should have .of_xlate_dai_id
2973 */
2974 ret = -ENOTSUPP;
2975 mutex_lock(&client_mutex);
2976 component = soc_find_component(&dlc);
2977 if (component)
2978 ret = snd_soc_component_of_xlate_dai_id(component, ep);
2979 mutex_unlock(&client_mutex);
2980
2981 of_node_put(dlc.of_node);
2982
2983 return ret;
2984}
2985EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
2986
2987int snd_soc_get_dai_name(struct of_phandle_args *args,
2988 const char **dai_name)
2989{
2990 struct snd_soc_component *pos;
2991 struct device_node *component_of_node;
2992 int ret = -EPROBE_DEFER;
2993
2994 mutex_lock(&client_mutex);
2995 for_each_component(pos) {
2996 component_of_node = soc_component_to_node(pos);
2997
2998 if (component_of_node != args->np)
2999 continue;
3000
3001 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3002 if (ret == -ENOTSUPP) {
3003 struct snd_soc_dai *dai;
3004 int id = -1;
3005
3006 switch (args->args_count) {
3007 case 0:
3008 id = 0; /* same as dai_drv[0] */
3009 break;
3010 case 1:
3011 id = args->args[0];
3012 break;
3013 default:
3014 /* not supported */
3015 break;
3016 }
3017
3018 if (id < 0 || id >= pos->num_dai) {
3019 ret = -EINVAL;
3020 continue;
3021 }
3022
3023 ret = 0;
3024
3025 /* find target DAI */
3026 for_each_component_dais(pos, dai) {
3027 if (id == 0)
3028 break;
3029 id--;
3030 }
3031
3032 *dai_name = dai->driver->name;
3033 if (!*dai_name)
3034 *dai_name = pos->name;
3035 } else if (ret) {
3036 /*
3037 * if another error than ENOTSUPP is returned go on and
3038 * check if another component is provided with the same
3039 * node. This may happen if a device provides several
3040 * components
3041 */
3042 continue;
3043 }
3044
3045 break;
3046 }
3047 mutex_unlock(&client_mutex);
3048 return ret;
3049}
3050EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3051
3052int snd_soc_of_get_dai_name(struct device_node *of_node,
3053 const char **dai_name)
3054{
3055 struct of_phandle_args args;
3056 int ret;
3057
3058 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3059 "#sound-dai-cells", 0, &args);
3060 if (ret)
3061 return ret;
3062
3063 ret = snd_soc_get_dai_name(&args, dai_name);
3064
3065 of_node_put(args.np);
3066
3067 return ret;
3068}
3069EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3070
3071/*
3072 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3073 * @dai_link: DAI link
3074 *
3075 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3076 */
3077void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3078{
3079 struct snd_soc_dai_link_component *component;
3080 int index;
3081
3082 for_each_link_codecs(dai_link, index, component) {
3083 if (!component->of_node)
3084 break;
3085 of_node_put(component->of_node);
3086 component->of_node = NULL;
3087 }
3088}
3089EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3090
3091/*
3092 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3093 * @dev: Card device
3094 * @of_node: Device node
3095 * @dai_link: DAI link
3096 *
3097 * Builds an array of CODEC DAI components from the DAI link property
3098 * 'sound-dai'.
3099 * The array is set in the DAI link and the number of DAIs is set accordingly.
3100 * The device nodes in the array (of_node) must be dereferenced by calling
3101 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3102 *
3103 * Returns 0 for success
3104 */
3105int snd_soc_of_get_dai_link_codecs(struct device *dev,
3106 struct device_node *of_node,
3107 struct snd_soc_dai_link *dai_link)
3108{
3109 struct of_phandle_args args;
3110 struct snd_soc_dai_link_component *component;
3111 char *name;
3112 int index, num_codecs, ret;
3113
3114 /* Count the number of CODECs */
3115 name = "sound-dai";
3116 num_codecs = of_count_phandle_with_args(of_node, name,
3117 "#sound-dai-cells");
3118 if (num_codecs <= 0) {
3119 if (num_codecs == -ENOENT)
3120 dev_err(dev, "No 'sound-dai' property\n");
3121 else
3122 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3123 return num_codecs;
3124 }
3125 component = devm_kcalloc(dev,
3126 num_codecs, sizeof(*component),
3127 GFP_KERNEL);
3128 if (!component)
3129 return -ENOMEM;
3130 dai_link->codecs = component;
3131 dai_link->num_codecs = num_codecs;
3132
3133 /* Parse the list */
3134 for_each_link_codecs(dai_link, index, component) {
3135 ret = of_parse_phandle_with_args(of_node, name,
3136 "#sound-dai-cells",
3137 index, &args);
3138 if (ret)
3139 goto err;
3140 component->of_node = args.np;
3141 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3142 if (ret < 0)
3143 goto err;
3144 }
3145 return 0;
3146err:
3147 snd_soc_of_put_dai_link_codecs(dai_link);
3148 dai_link->codecs = NULL;
3149 dai_link->num_codecs = 0;
3150 return ret;
3151}
3152EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3153
3154static int __init snd_soc_init(void)
3155{
3156 snd_soc_debugfs_init();
3157 snd_soc_util_init();
3158
3159 return platform_driver_register(&soc_driver);
3160}
3161module_init(snd_soc_init);
3162
3163static void __exit snd_soc_exit(void)
3164{
3165 snd_soc_util_exit();
3166 snd_soc_debugfs_exit();
3167
3168 platform_driver_unregister(&soc_driver);
3169}
3170module_exit(snd_soc_exit);
3171
3172/* Module information */
3173MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3174MODULE_DESCRIPTION("ALSA SoC Core");
3175MODULE_LICENSE("GPL");
3176MODULE_ALIAS("platform:soc-audio");
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>
13//
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
19
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>
43
44#define CREATE_TRACE_POINTS
45#include <trace/events/asoc.h>
46
47static DEFINE_MUTEX(client_mutex);
48static LIST_HEAD(component_list);
49static LIST_HEAD(unbind_card_list);
50
51#define for_each_component(component) \
52 list_for_each_entry(component, &component_list, list)
53
54/*
55 * This is used if driver don't need to have CPU/Codec/Platform
56 * dai_link. see soc.h
57 */
58struct snd_soc_dai_link_component null_dailink_component[0];
59EXPORT_SYMBOL_GPL(null_dailink_component);
60
61/*
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.
65 */
66static int pmdown_time = 5000;
67module_param(pmdown_time, int, 0);
68MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
69
70static ssize_t pmdown_time_show(struct device *dev,
71 struct device_attribute *attr, char *buf)
72{
73 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
74
75 return sysfs_emit(buf, "%ld\n", rtd->pmdown_time);
76}
77
78static ssize_t pmdown_time_store(struct device *dev,
79 struct device_attribute *attr,
80 const char *buf, size_t count)
81{
82 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
83 int ret;
84
85 ret = kstrtol(buf, 10, &rtd->pmdown_time);
86 if (ret)
87 return ret;
88
89 return count;
90}
91
92static DEVICE_ATTR_RW(pmdown_time);
93
94static struct attribute *soc_dev_attrs[] = {
95 &dev_attr_pmdown_time.attr,
96 NULL
97};
98
99static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
100 struct attribute *attr, int idx)
101{
102 struct device *dev = kobj_to_dev(kobj);
103 struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
104
105 if (!rtd)
106 return 0;
107
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 */
111}
112
113static const struct attribute_group soc_dapm_dev_group = {
114 .attrs = soc_dapm_dev_attrs,
115 .is_visible = soc_dev_attr_is_visible,
116};
117
118static const struct attribute_group soc_dev_group = {
119 .attrs = soc_dev_attrs,
120 .is_visible = soc_dev_attr_is_visible,
121};
122
123static const struct attribute_group *soc_dev_attr_groups[] = {
124 &soc_dapm_dev_group,
125 &soc_dev_group,
126 NULL
127};
128
129#ifdef CONFIG_DEBUG_FS
130struct dentry *snd_soc_debugfs_root;
131EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
132
133static void soc_init_component_debugfs(struct snd_soc_component *component)
134{
135 if (!component->card->debugfs_card_root)
136 return;
137
138 if (component->debugfs_prefix) {
139 char *name;
140
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);
147 }
148 } else {
149 component->debugfs_root = debugfs_create_dir(component->name,
150 component->card->debugfs_card_root);
151 }
152
153 snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
154 component->debugfs_root);
155}
156
157static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
158{
159 if (!component->debugfs_root)
160 return;
161 debugfs_remove_recursive(component->debugfs_root);
162 component->debugfs_root = NULL;
163}
164
165static int dai_list_show(struct seq_file *m, void *v)
166{
167 struct snd_soc_component *component;
168 struct snd_soc_dai *dai;
169
170 mutex_lock(&client_mutex);
171
172 for_each_component(component)
173 for_each_component_dais(component, dai)
174 seq_printf(m, "%s\n", dai->name);
175
176 mutex_unlock(&client_mutex);
177
178 return 0;
179}
180DEFINE_SHOW_ATTRIBUTE(dai_list);
181
182static int component_list_show(struct seq_file *m, void *v)
183{
184 struct snd_soc_component *component;
185
186 mutex_lock(&client_mutex);
187
188 for_each_component(component)
189 seq_printf(m, "%s\n", component->name);
190
191 mutex_unlock(&client_mutex);
192
193 return 0;
194}
195DEFINE_SHOW_ATTRIBUTE(component_list);
196
197static void soc_init_card_debugfs(struct snd_soc_card *card)
198{
199 card->debugfs_card_root = debugfs_create_dir(card->name,
200 snd_soc_debugfs_root);
201
202 debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
203 &card->pop_time);
204
205 snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
206}
207
208static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
209{
210 debugfs_remove_recursive(card->debugfs_card_root);
211 card->debugfs_card_root = NULL;
212}
213
214static void snd_soc_debugfs_init(void)
215{
216 snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
217
218 debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
219 &dai_list_fops);
220
221 debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
222 &component_list_fops);
223}
224
225static void snd_soc_debugfs_exit(void)
226{
227 debugfs_remove_recursive(snd_soc_debugfs_root);
228}
229
230#else
231
232static inline void soc_init_component_debugfs(struct snd_soc_component *component) { }
233static inline void soc_cleanup_component_debugfs(struct snd_soc_component *component) { }
234static inline void soc_init_card_debugfs(struct snd_soc_card *card) { }
235static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card) { }
236static inline void snd_soc_debugfs_init(void) { }
237static inline void snd_soc_debugfs_exit(void) { }
238
239#endif
240
241static int snd_soc_is_match_dai_args(struct of_phandle_args *args1,
242 struct of_phandle_args *args2)
243{
244 if (!args1 || !args2)
245 return 0;
246
247 if (args1->np != args2->np)
248 return 0;
249
250 for (int i = 0; i < args1->args_count; i++)
251 if (args1->args[i] != args2->args[i])
252 return 0;
253
254 return 1;
255}
256
257static inline int snd_soc_dlc_component_is_empty(struct snd_soc_dai_link_component *dlc)
258{
259 return !(dlc->dai_args || dlc->name || dlc->of_node);
260}
261
262static inline int snd_soc_dlc_component_is_invalid(struct snd_soc_dai_link_component *dlc)
263{
264 return (dlc->name && dlc->of_node);
265}
266
267static inline int snd_soc_dlc_dai_is_empty(struct snd_soc_dai_link_component *dlc)
268{
269 return !(dlc->dai_args || dlc->dai_name);
270}
271
272static int snd_soc_is_matching_dai(const struct snd_soc_dai_link_component *dlc,
273 struct snd_soc_dai *dai)
274{
275 if (!dlc)
276 return 0;
277
278 if (dlc->dai_args)
279 return snd_soc_is_match_dai_args(dai->driver->dai_args, dlc->dai_args);
280
281 if (!dlc->dai_name)
282 return 1;
283
284 /* see snd_soc_dai_name_get() */
285
286 if (strcmp(dlc->dai_name, dai->name) == 0)
287 return 1;
288
289 if (dai->driver->name &&
290 strcmp(dai->driver->name, dlc->dai_name) == 0)
291 return 1;
292
293 if (dai->component->name &&
294 strcmp(dlc->dai_name, dai->component->name) == 0)
295 return 1;
296
297 return 0;
298}
299
300const char *snd_soc_dai_name_get(struct snd_soc_dai *dai)
301{
302 /* see snd_soc_is_matching_dai() */
303 if (dai->name)
304 return dai->name;
305
306 if (dai->driver->name)
307 return dai->driver->name;
308
309 if (dai->component->name)
310 return dai->component->name;
311
312 return NULL;
313}
314EXPORT_SYMBOL_GPL(snd_soc_dai_name_get);
315
316static int snd_soc_rtd_add_component(struct snd_soc_pcm_runtime *rtd,
317 struct snd_soc_component *component)
318{
319 struct snd_soc_component *comp;
320 int i;
321
322 for_each_rtd_components(rtd, i, comp) {
323 /* already connected */
324 if (comp == component)
325 return 0;
326 }
327
328 /* see for_each_rtd_components */
329 rtd->components[rtd->num_components] = component;
330 rtd->num_components++;
331
332 return 0;
333}
334
335struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
336 const char *driver_name)
337{
338 struct snd_soc_component *component;
339 int i;
340
341 if (!driver_name)
342 return NULL;
343
344 /*
345 * NOTE
346 *
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.
351 */
352 for_each_rtd_components(rtd, i, component) {
353 const char *component_name = component->driver->name;
354
355 if (!component_name)
356 continue;
357
358 if ((component_name == driver_name) ||
359 strcmp(component_name, driver_name) == 0)
360 return component;
361 }
362
363 return NULL;
364}
365EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
366
367struct snd_soc_component
368*snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
369{
370 struct snd_soc_component *component;
371 struct snd_soc_component *found_component;
372
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;
381 }
382 }
383
384 return found_component;
385}
386EXPORT_SYMBOL_GPL(snd_soc_lookup_component_nolocked);
387
388struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
389 const char *driver_name)
390{
391 struct snd_soc_component *component;
392
393 mutex_lock(&client_mutex);
394 component = snd_soc_lookup_component_nolocked(dev, driver_name);
395 mutex_unlock(&client_mutex);
396
397 return component;
398}
399EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
400
401struct snd_soc_pcm_runtime
402*snd_soc_get_pcm_runtime(struct snd_soc_card *card,
403 struct snd_soc_dai_link *dai_link)
404{
405 struct snd_soc_pcm_runtime *rtd;
406
407 for_each_card_rtds(card, rtd) {
408 if (rtd->dai_link == dai_link)
409 return rtd;
410 }
411 dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
412 return NULL;
413}
414EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
415
416/*
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.
420 */
421void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd)
422{
423 struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
424 int playback = SNDRV_PCM_STREAM_PLAYBACK;
425
426 snd_soc_dpcm_mutex_lock(rtd);
427
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");
434
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);
440 }
441
442 snd_soc_dpcm_mutex_unlock(rtd);
443}
444EXPORT_SYMBOL_GPL(snd_soc_close_delayed_work);
445
446static void soc_release_rtd_dev(struct device *dev)
447{
448 /* "dev" means "rtd->dev" */
449 kfree(dev);
450}
451
452static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
453{
454 if (!rtd)
455 return;
456
457 list_del(&rtd->list);
458
459 if (delayed_work_pending(&rtd->delayed_work))
460 flush_delayed_work(&rtd->delayed_work);
461 snd_soc_pcm_component_free(rtd);
462
463 /*
464 * we don't need to call kfree() for rtd->dev
465 * see
466 * soc_release_rtd_dev()
467 *
468 * We don't need rtd->dev NULL check, because
469 * it is alloced *before* rtd.
470 * see
471 * soc_new_pcm_runtime()
472 *
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()
477 *
478 * rtd = devm_kzalloc(dev, ...);
479 * rtd->dev = dev
480 */
481 device_unregister(rtd->dev);
482}
483
484static 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);
488
489 if (rtd->close_delayed_work_func)
490 rtd->close_delayed_work_func(rtd);
491}
492
493static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
494 struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
495{
496 struct snd_soc_pcm_runtime *rtd;
497 struct snd_soc_component *component;
498 struct device *dev;
499 int ret;
500 int stream;
501
502 /*
503 * for rtd->dev
504 */
505 dev = kzalloc(sizeof(struct device), GFP_KERNEL);
506 if (!dev)
507 return NULL;
508
509 dev->parent = card->dev;
510 dev->release = soc_release_rtd_dev;
511
512 dev_set_name(dev, "%s", dai_link->name);
513
514 ret = device_register(dev);
515 if (ret < 0) {
516 put_device(dev); /* soc_release_rtd_dev */
517 return NULL;
518 }
519
520 /*
521 * for rtd
522 */
523 rtd = devm_kzalloc(dev,
524 sizeof(*rtd) +
525 sizeof(component) * (dai_link->num_cpus +
526 dai_link->num_codecs +
527 dai_link->num_platforms),
528 GFP_KERNEL);
529 if (!rtd) {
530 device_unregister(dev);
531 return NULL;
532 }
533
534 rtd->dev = dev;
535 INIT_LIST_HEAD(&rtd->list);
536 for_each_pcm_streams(stream) {
537 INIT_LIST_HEAD(&rtd->dpcm[stream].be_clients);
538 INIT_LIST_HEAD(&rtd->dpcm[stream].fe_clients);
539 }
540 dev_set_drvdata(dev, rtd);
541 INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
542
543 /*
544 * for rtd->dais
545 */
546 rtd->dais = devm_kcalloc(dev, dai_link->num_cpus + dai_link->num_codecs,
547 sizeof(struct snd_soc_dai *),
548 GFP_KERNEL);
549 if (!rtd->dais)
550 goto free_rtd;
551
552 /*
553 * dais = [][][][][][][][][][][][][][][][][][]
554 * ^cpu_dais ^codec_dais
555 * |--- num_cpus ---|--- num_codecs --|
556 * see
557 * snd_soc_rtd_to_cpu()
558 * snd_soc_rtd_to_codec()
559 */
560 rtd->card = card;
561 rtd->dai_link = dai_link;
562 rtd->num = card->num_rtd++;
563 rtd->pmdown_time = pmdown_time; /* default power off timeout */
564
565 /* see for_each_card_rtds */
566 list_add_tail(&rtd->list, &card->rtd_list);
567
568 ret = device_add_groups(dev, soc_dev_attr_groups);
569 if (ret < 0)
570 goto free_rtd;
571
572 return rtd;
573
574free_rtd:
575 soc_free_pcm_runtime(rtd);
576 return NULL;
577}
578
579static void snd_soc_fill_dummy_dai(struct snd_soc_card *card)
580{
581 struct snd_soc_dai_link *dai_link;
582 int i;
583
584 /*
585 * COMP_DUMMY() creates size 0 array on dai_link.
586 * Fill it as dummy DAI in case of CPU/Codec here.
587 * Do nothing for Platform.
588 */
589 for_each_card_prelinks(card, i, dai_link) {
590 if (dai_link->num_cpus == 0 && dai_link->cpus) {
591 dai_link->num_cpus = 1;
592 dai_link->cpus = &snd_soc_dummy_dlc;
593 }
594 if (dai_link->num_codecs == 0 && dai_link->codecs) {
595 dai_link->num_codecs = 1;
596 dai_link->codecs = &snd_soc_dummy_dlc;
597 }
598 }
599}
600
601static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
602{
603 struct snd_soc_pcm_runtime *rtd;
604
605 for_each_card_rtds(card, rtd)
606 flush_delayed_work(&rtd->delayed_work);
607}
608
609#ifdef CONFIG_PM_SLEEP
610static void soc_playback_digital_mute(struct snd_soc_card *card, int mute)
611{
612 struct snd_soc_pcm_runtime *rtd;
613 struct snd_soc_dai *dai;
614 int playback = SNDRV_PCM_STREAM_PLAYBACK;
615 int i;
616
617 for_each_card_rtds(card, rtd) {
618
619 if (rtd->dai_link->ignore_suspend)
620 continue;
621
622 for_each_rtd_dais(rtd, i, dai) {
623 if (snd_soc_dai_stream_active(dai, playback))
624 snd_soc_dai_digital_mute(dai, mute, playback);
625 }
626 }
627}
628
629static void soc_dapm_suspend_resume(struct snd_soc_card *card, int event)
630{
631 struct snd_soc_pcm_runtime *rtd;
632 int stream;
633
634 for_each_card_rtds(card, rtd) {
635
636 if (rtd->dai_link->ignore_suspend)
637 continue;
638
639 for_each_pcm_streams(stream)
640 snd_soc_dapm_stream_event(rtd, stream, event);
641 }
642}
643
644/* powers down audio subsystem for suspend */
645int snd_soc_suspend(struct device *dev)
646{
647 struct snd_soc_card *card = dev_get_drvdata(dev);
648 struct snd_soc_component *component;
649 struct snd_soc_pcm_runtime *rtd;
650 int i;
651
652 /* If the card is not initialized yet there is nothing to do */
653 if (!snd_soc_card_is_instantiated(card))
654 return 0;
655
656 /*
657 * Due to the resume being scheduled into a workqueue we could
658 * suspend before that's finished - wait for it to complete.
659 */
660 snd_power_wait(card->snd_card);
661
662 /* we're going to block userspace touching us until resume completes */
663 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
664
665 /* mute any active DACs */
666 soc_playback_digital_mute(card, 1);
667
668 /* suspend all pcms */
669 for_each_card_rtds(card, rtd) {
670 if (rtd->dai_link->ignore_suspend)
671 continue;
672
673 snd_pcm_suspend_all(rtd->pcm);
674 }
675
676 snd_soc_card_suspend_pre(card);
677
678 /* close any waiting streams */
679 snd_soc_flush_all_delayed_work(card);
680
681 soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_SUSPEND);
682
683 /* Recheck all endpoints too, their state is affected by suspend */
684 dapm_mark_endpoints_dirty(card);
685 snd_soc_dapm_sync(&card->dapm);
686
687 /* suspend all COMPONENTs */
688 for_each_card_rtds(card, rtd) {
689
690 if (rtd->dai_link->ignore_suspend)
691 continue;
692
693 for_each_rtd_components(rtd, i, component) {
694 struct snd_soc_dapm_context *dapm =
695 snd_soc_component_get_dapm(component);
696
697 /*
698 * ignore if component was already suspended
699 */
700 if (snd_soc_component_is_suspended(component))
701 continue;
702
703 /*
704 * If there are paths active then the COMPONENT will be
705 * held with bias _ON and should not be suspended.
706 */
707 switch (snd_soc_dapm_get_bias_level(dapm)) {
708 case SND_SOC_BIAS_STANDBY:
709 /*
710 * If the COMPONENT is capable of idle
711 * bias off then being in STANDBY
712 * means it's doing something,
713 * otherwise fall through.
714 */
715 if (dapm->idle_bias_off) {
716 dev_dbg(component->dev,
717 "ASoC: idle_bias_off CODEC on over suspend\n");
718 break;
719 }
720 fallthrough;
721
722 case SND_SOC_BIAS_OFF:
723 snd_soc_component_suspend(component);
724 if (component->regmap)
725 regcache_mark_dirty(component->regmap);
726 /* deactivate pins to sleep state */
727 pinctrl_pm_select_sleep_state(component->dev);
728 break;
729 default:
730 dev_dbg(component->dev,
731 "ASoC: COMPONENT is on over suspend\n");
732 break;
733 }
734 }
735 }
736
737 snd_soc_card_suspend_post(card);
738
739 return 0;
740}
741EXPORT_SYMBOL_GPL(snd_soc_suspend);
742
743/*
744 * deferred resume work, so resume can complete before we finished
745 * setting our codec back up, which can be very slow on I2C
746 */
747static void soc_resume_deferred(struct work_struct *work)
748{
749 struct snd_soc_card *card =
750 container_of(work, struct snd_soc_card,
751 deferred_resume_work);
752 struct snd_soc_component *component;
753
754 /*
755 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
756 * so userspace apps are blocked from touching us
757 */
758
759 dev_dbg(card->dev, "ASoC: starting resume work\n");
760
761 /* Bring us up into D2 so that DAPM starts enabling things */
762 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
763
764 snd_soc_card_resume_pre(card);
765
766 for_each_card_components(card, component) {
767 if (snd_soc_component_is_suspended(component))
768 snd_soc_component_resume(component);
769 }
770
771 soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_RESUME);
772
773 /* unmute any active DACs */
774 soc_playback_digital_mute(card, 0);
775
776 snd_soc_card_resume_post(card);
777
778 dev_dbg(card->dev, "ASoC: resume work completed\n");
779
780 /* Recheck all endpoints too, their state is affected by suspend */
781 dapm_mark_endpoints_dirty(card);
782 snd_soc_dapm_sync(&card->dapm);
783
784 /* userspace can access us now we are back as we were before */
785 snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
786}
787
788/* powers up audio subsystem after a suspend */
789int snd_soc_resume(struct device *dev)
790{
791 struct snd_soc_card *card = dev_get_drvdata(dev);
792 struct snd_soc_component *component;
793
794 /* If the card is not initialized yet there is nothing to do */
795 if (!snd_soc_card_is_instantiated(card))
796 return 0;
797
798 /* activate pins from sleep state */
799 for_each_card_components(card, component)
800 if (snd_soc_component_active(component))
801 pinctrl_pm_select_default_state(component->dev);
802
803 dev_dbg(dev, "ASoC: Scheduling resume work\n");
804 if (!schedule_work(&card->deferred_resume_work))
805 dev_err(dev, "ASoC: resume work item may be lost\n");
806
807 return 0;
808}
809EXPORT_SYMBOL_GPL(snd_soc_resume);
810
811static void soc_resume_init(struct snd_soc_card *card)
812{
813 /* deferred resume work */
814 INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
815}
816#else
817#define snd_soc_suspend NULL
818#define snd_soc_resume NULL
819static inline void soc_resume_init(struct snd_soc_card *card) { }
820#endif
821
822static struct device_node
823*soc_component_to_node(struct snd_soc_component *component)
824{
825 struct device_node *of_node;
826
827 of_node = component->dev->of_node;
828 if (!of_node && component->dev->parent)
829 of_node = component->dev->parent->of_node;
830
831 return of_node;
832}
833
834struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev, struct of_phandle_args *args)
835{
836 struct of_phandle_args *ret = devm_kzalloc(dev, sizeof(*ret), GFP_KERNEL);
837
838 if (!ret)
839 return NULL;
840
841 *ret = *args;
842
843 return ret;
844}
845EXPORT_SYMBOL_GPL(snd_soc_copy_dai_args);
846
847static int snd_soc_is_matching_component(
848 const struct snd_soc_dai_link_component *dlc,
849 struct snd_soc_component *component)
850{
851 struct device_node *component_of_node;
852
853 if (!dlc)
854 return 0;
855
856 if (dlc->dai_args) {
857 struct snd_soc_dai *dai;
858
859 for_each_component_dais(component, dai)
860 if (snd_soc_is_matching_dai(dlc, dai))
861 return 1;
862 return 0;
863 }
864
865 component_of_node = soc_component_to_node(component);
866
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;
871
872 return 1;
873}
874
875static struct snd_soc_component *soc_find_component(
876 const struct snd_soc_dai_link_component *dlc)
877{
878 struct snd_soc_component *component;
879
880 lockdep_assert_held(&client_mutex);
881
882 /*
883 * NOTE
884 *
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
889 */
890 for_each_component(component)
891 if (snd_soc_is_matching_component(dlc, component))
892 return component;
893
894 return NULL;
895}
896
897/**
898 * snd_soc_find_dai - Find a registered DAI
899 *
900 * @dlc: name of the DAI or the DAI driver and optional component info to match
901 *
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.
905 *
906 * Return: pointer of DAI, or NULL if not found.
907 */
908struct snd_soc_dai *snd_soc_find_dai(
909 const struct snd_soc_dai_link_component *dlc)
910{
911 struct snd_soc_component *component;
912 struct snd_soc_dai *dai;
913
914 lockdep_assert_held(&client_mutex);
915
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;
922
923 return NULL;
924}
925EXPORT_SYMBOL_GPL(snd_soc_find_dai);
926
927struct snd_soc_dai *snd_soc_find_dai_with_mutex(
928 const struct snd_soc_dai_link_component *dlc)
929{
930 struct snd_soc_dai *dai;
931
932 mutex_lock(&client_mutex);
933 dai = snd_soc_find_dai(dlc);
934 mutex_unlock(&client_mutex);
935
936 return dai;
937}
938EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
939
940static int soc_dai_link_sanity_check(struct snd_soc_card *card,
941 struct snd_soc_dai_link *link)
942{
943 int i;
944 struct snd_soc_dai_link_component *dlc;
945
946 /* Codec check */
947 for_each_link_codecs(link, i, dlc) {
948 /*
949 * Codec must be specified by 1 of name or OF node,
950 * not both or neither.
951 */
952 if (snd_soc_dlc_component_is_invalid(dlc))
953 goto component_invalid;
954
955 if (snd_soc_dlc_component_is_empty(dlc))
956 goto component_empty;
957
958 /* Codec DAI name must be specified */
959 if (snd_soc_dlc_dai_is_empty(dlc))
960 goto dai_empty;
961
962 /*
963 * Defer card registration if codec component is not added to
964 * component list.
965 */
966 if (!soc_find_component(dlc))
967 goto component_not_found;
968 }
969
970 /* Platform check */
971 for_each_link_platforms(link, i, dlc) {
972 /*
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
976 */
977 if (snd_soc_dlc_component_is_invalid(dlc))
978 goto component_invalid;
979
980 if (snd_soc_dlc_component_is_empty(dlc))
981 goto component_empty;
982
983 /*
984 * Defer card registration if platform component is not added to
985 * component list.
986 */
987 if (!soc_find_component(dlc))
988 goto component_not_found;
989 }
990
991 /* CPU check */
992 for_each_link_cpus(link, i, dlc) {
993 /*
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..
997 */
998 if (snd_soc_dlc_component_is_invalid(dlc))
999 goto component_invalid;
1000
1001
1002 if (snd_soc_dlc_component_is_empty(dlc)) {
1003 /*
1004 * At least one of CPU DAI name or CPU device name/node must be specified
1005 */
1006 if (snd_soc_dlc_dai_is_empty(dlc))
1007 goto component_dai_empty;
1008 } else {
1009 /*
1010 * Defer card registration if Component is not added
1011 */
1012 if (!soc_find_component(dlc))
1013 goto component_not_found;
1014 }
1015 }
1016
1017 return 0;
1018
1019component_invalid:
1020 dev_err(card->dev, "ASoC: Both Component name/of_node are set for %s\n", link->name);
1021 return -EINVAL;
1022
1023component_empty:
1024 dev_err(card->dev, "ASoC: Neither Component name/of_node are set for %s\n", link->name);
1025 return -EINVAL;
1026
1027component_not_found:
1028 dev_dbg(card->dev, "ASoC: Component %s not found for link %s\n", dlc->name, link->name);
1029 return -EPROBE_DEFER;
1030
1031dai_empty:
1032 dev_err(card->dev, "ASoC: DAI name is not set for %s\n", link->name);
1033 return -EINVAL;
1034
1035component_dai_empty:
1036 dev_err(card->dev, "ASoC: Neither DAI/Component name/of_node are set for %s\n", link->name);
1037 return -EINVAL;
1038}
1039
1040#define MAX_DEFAULT_CH_MAP_SIZE 8
1041static 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 },
1050};
1051static 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 },
1060};
1061static 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 },
1070};
1071static int snd_soc_compensate_channel_connection_map(struct snd_soc_card *card,
1072 struct snd_soc_dai_link *dai_link)
1073{
1074 struct snd_soc_dai_link_ch_map *ch_maps;
1075 int i;
1076
1077 /*
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]
1082 */
1083
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;
1090 }
1091
1092 /* do nothing if it has own maps */
1093 if (dai_link->ch_maps)
1094 goto sanity_check;
1095
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;
1101 }
1102
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 */
1110
1111sanity_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))",
1118 i,
1119 ch_maps->cpu, dai_link->num_cpus,
1120 ch_maps->codec, dai_link->num_codecs);
1121 return -EINVAL;
1122 }
1123
1124 dev_dbg(card->dev, " [%d] cpu%d <-> codec%d\n",
1125 i, ch_maps->cpu, ch_maps->codec);
1126 }
1127
1128 return 0;
1129}
1130
1131/**
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
1135 *
1136 * This function removes a pcm_runtime from the ASoC card.
1137 */
1138void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1139 struct snd_soc_pcm_runtime *rtd)
1140{
1141 lockdep_assert_held(&client_mutex);
1142
1143 /*
1144 * Notify the machine driver for extra destruction
1145 */
1146 snd_soc_card_remove_dai_link(card, rtd->dai_link);
1147
1148 soc_free_pcm_runtime(rtd);
1149}
1150EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
1151
1152/**
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
1156 *
1157 * This function adds a pcm_runtime ASoC card by using dai_link.
1158 *
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.
1162 */
1163static int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1164 struct snd_soc_dai_link *dai_link)
1165{
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, ret;
1170
1171 lockdep_assert_held(&client_mutex);
1172
1173 /*
1174 * Notify the machine driver for extra initialization
1175 */
1176 ret = snd_soc_card_add_dai_link(card, dai_link);
1177 if (ret < 0)
1178 return ret;
1179
1180 if (dai_link->ignore)
1181 return 0;
1182
1183 dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1184
1185 ret = soc_dai_link_sanity_check(card, dai_link);
1186 if (ret < 0)
1187 return ret;
1188
1189 rtd = soc_new_pcm_runtime(card, dai_link);
1190 if (!rtd)
1191 return -ENOMEM;
1192
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;
1199 }
1200 snd_soc_rtd_add_component(rtd, snd_soc_rtd_to_cpu(rtd, i)->component);
1201 }
1202
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;
1210 }
1211
1212 snd_soc_rtd_add_component(rtd, snd_soc_rtd_to_codec(rtd, i)->component);
1213 }
1214
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;
1220
1221 snd_soc_rtd_add_component(rtd, component);
1222 }
1223 }
1224
1225 return 0;
1226
1227_err_defer:
1228 snd_soc_remove_pcm_runtime(card, rtd);
1229 return -EPROBE_DEFER;
1230}
1231
1232int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1233 struct snd_soc_dai_link *dai_link,
1234 int num_dai_link)
1235{
1236 for (int i = 0; i < num_dai_link; i++) {
1237 int ret;
1238
1239 ret = snd_soc_compensate_channel_connection_map(card, dai_link + i);
1240 if (ret < 0)
1241 return ret;
1242
1243 ret = snd_soc_add_pcm_runtime(card, dai_link + i);
1244 if (ret < 0)
1245 return ret;
1246 }
1247
1248 return 0;
1249}
1250EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtimes);
1251
1252static void snd_soc_runtime_get_dai_fmt(struct snd_soc_pcm_runtime *rtd)
1253{
1254 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1255 struct snd_soc_dai *dai, *not_used;
1256 u64 pos, possible_fmt;
1257 unsigned int mask = 0, dai_fmt = 0;
1258 int i, j, priority, pri, until;
1259
1260 /*
1261 * Get selectable format from each DAIs.
1262 *
1263 ****************************
1264 * NOTE
1265 * Using .auto_selectable_formats is not mandatory,
1266 * we can select format manually from Sound Card.
1267 * When use it, driver should list well tested format only.
1268 ****************************
1269 *
1270 * ex)
1271 * auto_selectable_formats (= SND_SOC_POSSIBLE_xxx)
1272 * (A) (B) (C)
1273 * DAI0_: { 0x000F, 0x00F0, 0x0F00 };
1274 * DAI1 : { 0xF000, 0x0F00 };
1275 * (X) (Y)
1276 *
1277 * "until" will be 3 in this case (MAX array size from DAI0 and DAI1)
1278 * Here is dev_dbg() message and comments
1279 *
1280 * priority = 1
1281 * DAI0: (pri, fmt) = (1, 000000000000000F) // 1st check (A) DAI1 is not selected
1282 * DAI1: (pri, fmt) = (0, 0000000000000000) // Necessary Waste
1283 * DAI0: (pri, fmt) = (1, 000000000000000F) // 2nd check (A)
1284 * DAI1: (pri, fmt) = (1, 000000000000F000) // (X)
1285 * priority = 2
1286 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 3rd check (A) + (B)
1287 * DAI1: (pri, fmt) = (1, 000000000000F000) // (X)
1288 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 4th check (A) + (B)
1289 * DAI1: (pri, fmt) = (2, 000000000000FF00) // (X) + (Y)
1290 * priority = 3
1291 * DAI0: (pri, fmt) = (3, 0000000000000FFF) // 5th check (A) + (B) + (C)
1292 * DAI1: (pri, fmt) = (2, 000000000000FF00) // (X) + (Y)
1293 * found auto selected format: 0000000000000F00
1294 */
1295 until = snd_soc_dai_get_fmt_max_priority(rtd);
1296 for (priority = 1; priority <= until; priority++) {
1297 for_each_rtd_dais(rtd, j, not_used) {
1298
1299 possible_fmt = ULLONG_MAX;
1300 for_each_rtd_dais(rtd, i, dai) {
1301 u64 fmt = 0;
1302
1303 pri = (j >= i) ? priority : priority - 1;
1304 fmt = snd_soc_dai_get_fmt(dai, pri);
1305 possible_fmt &= fmt;
1306 }
1307 if (possible_fmt)
1308 goto found;
1309 }
1310 }
1311 /* Not Found */
1312 return;
1313found:
1314 /*
1315 * convert POSSIBLE_DAIFMT to DAIFMT
1316 *
1317 * Some basic/default settings on each is defined as 0.
1318 * see
1319 * SND_SOC_DAIFMT_NB_NF
1320 * SND_SOC_DAIFMT_GATED
1321 *
1322 * SND_SOC_DAIFMT_xxx_MASK can't notice it if Sound Card specify
1323 * these value, and will be overwrite to auto selected value.
1324 *
1325 * To avoid such issue, loop from 63 to 0 here.
1326 * Small number of SND_SOC_POSSIBLE_xxx will be Hi priority.
1327 * Basic/Default settings of each part and above are defined
1328 * as Hi priority (= small number) of SND_SOC_POSSIBLE_xxx.
1329 */
1330 for (i = 63; i >= 0; i--) {
1331 pos = 1ULL << i;
1332 switch (possible_fmt & pos) {
1333 /*
1334 * for format
1335 */
1336 case SND_SOC_POSSIBLE_DAIFMT_I2S:
1337 case SND_SOC_POSSIBLE_DAIFMT_RIGHT_J:
1338 case SND_SOC_POSSIBLE_DAIFMT_LEFT_J:
1339 case SND_SOC_POSSIBLE_DAIFMT_DSP_A:
1340 case SND_SOC_POSSIBLE_DAIFMT_DSP_B:
1341 case SND_SOC_POSSIBLE_DAIFMT_AC97:
1342 case SND_SOC_POSSIBLE_DAIFMT_PDM:
1343 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_FORMAT_MASK) | i;
1344 break;
1345 /*
1346 * for clock
1347 */
1348 case SND_SOC_POSSIBLE_DAIFMT_CONT:
1349 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_CONT;
1350 break;
1351 case SND_SOC_POSSIBLE_DAIFMT_GATED:
1352 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_GATED;
1353 break;
1354 /*
1355 * for clock invert
1356 */
1357 case SND_SOC_POSSIBLE_DAIFMT_NB_NF:
1358 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_NF;
1359 break;
1360 case SND_SOC_POSSIBLE_DAIFMT_NB_IF:
1361 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_IF;
1362 break;
1363 case SND_SOC_POSSIBLE_DAIFMT_IB_NF:
1364 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_NF;
1365 break;
1366 case SND_SOC_POSSIBLE_DAIFMT_IB_IF:
1367 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_IF;
1368 break;
1369 /*
1370 * for clock provider / consumer
1371 */
1372 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFP:
1373 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFP;
1374 break;
1375 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFP:
1376 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFP;
1377 break;
1378 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFC:
1379 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFC;
1380 break;
1381 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFC:
1382 dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFC;
1383 break;
1384 }
1385 }
1386
1387 /*
1388 * Some driver might have very complex limitation.
1389 * In such case, user want to auto-select non-limitation part,
1390 * and want to manually specify complex part.
1391 *
1392 * Or for example, if both CPU and Codec can be clock provider,
1393 * but because of its quality, user want to specify it manually.
1394 *
1395 * Use manually specified settings if sound card did.
1396 */
1397 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK))
1398 mask |= SND_SOC_DAIFMT_FORMAT_MASK;
1399 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_MASK))
1400 mask |= SND_SOC_DAIFMT_CLOCK_MASK;
1401 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_INV_MASK))
1402 mask |= SND_SOC_DAIFMT_INV_MASK;
1403 if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK))
1404 mask |= SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
1405
1406 dai_link->dai_fmt |= (dai_fmt & mask);
1407}
1408
1409/**
1410 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1411 * @rtd: The runtime for which the DAI link format should be changed
1412 * @dai_fmt: The new DAI link format
1413 *
1414 * This function updates the DAI link format for all DAIs connected to the DAI
1415 * link for the specified runtime.
1416 *
1417 * Note: For setups with a static format set the dai_fmt field in the
1418 * corresponding snd_dai_link struct instead of using this function.
1419 *
1420 * Returns 0 on success, otherwise a negative error code.
1421 */
1422int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1423 unsigned int dai_fmt)
1424{
1425 struct snd_soc_dai *cpu_dai;
1426 struct snd_soc_dai *codec_dai;
1427 unsigned int i;
1428 int ret;
1429
1430 if (!dai_fmt)
1431 return 0;
1432
1433 for_each_rtd_codec_dais(rtd, i, codec_dai) {
1434 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1435 if (ret != 0 && ret != -ENOTSUPP)
1436 return ret;
1437 }
1438
1439 /* Flip the polarity for the "CPU" end of link */
1440 dai_fmt = snd_soc_daifmt_clock_provider_flipped(dai_fmt);
1441
1442 for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1443 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1444 if (ret != 0 && ret != -ENOTSUPP)
1445 return ret;
1446 }
1447
1448 return 0;
1449}
1450EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1451
1452static int soc_init_pcm_runtime(struct snd_soc_card *card,
1453 struct snd_soc_pcm_runtime *rtd)
1454{
1455 struct snd_soc_dai_link *dai_link = rtd->dai_link;
1456 struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0);
1457 struct snd_soc_component *component;
1458 int ret, num, i;
1459
1460 /* do machine specific initialization */
1461 ret = snd_soc_link_init(rtd);
1462 if (ret < 0)
1463 return ret;
1464
1465 snd_soc_runtime_get_dai_fmt(rtd);
1466 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1467 if (ret)
1468 goto err;
1469
1470 /* add DPCM sysfs entries */
1471 soc_dpcm_debugfs_add(rtd);
1472
1473 num = rtd->num;
1474
1475 /*
1476 * most drivers will register their PCMs using DAI link ordering but
1477 * topology based drivers can use the DAI link id field to set PCM
1478 * device number and then use rtd + a base offset of the BEs.
1479 */
1480 for_each_rtd_components(rtd, i, component) {
1481 if (!component->driver->use_dai_pcm_id)
1482 continue;
1483
1484 if (rtd->dai_link->no_pcm)
1485 num += component->driver->be_pcm_base;
1486 else
1487 num = rtd->dai_link->id;
1488 }
1489
1490 /* create compress_device if possible */
1491 ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1492 if (ret != -ENOTSUPP)
1493 goto err;
1494
1495 /* create the pcm */
1496 ret = soc_new_pcm(rtd, num);
1497 if (ret < 0) {
1498 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1499 dai_link->stream_name, ret);
1500 goto err;
1501 }
1502
1503 ret = snd_soc_pcm_dai_new(rtd);
1504 if (ret < 0)
1505 goto err;
1506
1507 rtd->initialized = true;
1508
1509 return 0;
1510err:
1511 snd_soc_link_exit(rtd);
1512 return ret;
1513}
1514
1515static void soc_set_name_prefix(struct snd_soc_card *card,
1516 struct snd_soc_component *component)
1517{
1518 struct device_node *of_node = soc_component_to_node(component);
1519 const char *str;
1520 int ret, i;
1521
1522 for (i = 0; i < card->num_configs; i++) {
1523 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1524
1525 if (snd_soc_is_matching_component(&map->dlc, component) &&
1526 map->name_prefix) {
1527 component->name_prefix = map->name_prefix;
1528 return;
1529 }
1530 }
1531
1532 /*
1533 * If there is no configuration table or no match in the table,
1534 * check if a prefix is provided in the node
1535 */
1536 ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1537 if (ret < 0)
1538 return;
1539
1540 component->name_prefix = str;
1541}
1542
1543static void soc_remove_component(struct snd_soc_component *component,
1544 int probed)
1545{
1546
1547 if (!component->card)
1548 return;
1549
1550 if (probed)
1551 snd_soc_component_remove(component);
1552
1553 list_del_init(&component->card_list);
1554 snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1555 soc_cleanup_component_debugfs(component);
1556 component->card = NULL;
1557 snd_soc_component_module_put_when_remove(component);
1558}
1559
1560static int soc_probe_component(struct snd_soc_card *card,
1561 struct snd_soc_component *component)
1562{
1563 struct snd_soc_dapm_context *dapm =
1564 snd_soc_component_get_dapm(component);
1565 struct snd_soc_dai *dai;
1566 int probed = 0;
1567 int ret;
1568
1569 if (snd_soc_component_is_dummy(component))
1570 return 0;
1571
1572 if (component->card) {
1573 if (component->card != card) {
1574 dev_err(component->dev,
1575 "Trying to bind component \"%s\" to card \"%s\" but is already bound to card \"%s\"\n",
1576 component->name, card->name, component->card->name);
1577 return -ENODEV;
1578 }
1579 return 0;
1580 }
1581
1582 ret = snd_soc_component_module_get_when_probe(component);
1583 if (ret < 0)
1584 return ret;
1585
1586 component->card = card;
1587 soc_set_name_prefix(card, component);
1588
1589 soc_init_component_debugfs(component);
1590
1591 snd_soc_dapm_init(dapm, card, component);
1592
1593 ret = snd_soc_dapm_new_controls(dapm,
1594 component->driver->dapm_widgets,
1595 component->driver->num_dapm_widgets);
1596
1597 if (ret != 0) {
1598 dev_err(component->dev,
1599 "Failed to create new controls %d\n", ret);
1600 goto err_probe;
1601 }
1602
1603 for_each_component_dais(component, dai) {
1604 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1605 if (ret != 0) {
1606 dev_err(component->dev,
1607 "Failed to create DAI widgets %d\n", ret);
1608 goto err_probe;
1609 }
1610 }
1611
1612 ret = snd_soc_component_probe(component);
1613 if (ret < 0)
1614 goto err_probe;
1615
1616 WARN(dapm->idle_bias_off &&
1617 dapm->bias_level != SND_SOC_BIAS_OFF,
1618 "codec %s can not start from non-off bias with idle_bias_off==1\n",
1619 component->name);
1620 probed = 1;
1621
1622 /*
1623 * machine specific init
1624 * see
1625 * snd_soc_component_set_aux()
1626 */
1627 ret = snd_soc_component_init(component);
1628 if (ret < 0)
1629 goto err_probe;
1630
1631 ret = snd_soc_add_component_controls(component,
1632 component->driver->controls,
1633 component->driver->num_controls);
1634 if (ret < 0)
1635 goto err_probe;
1636
1637 ret = snd_soc_dapm_add_routes(dapm,
1638 component->driver->dapm_routes,
1639 component->driver->num_dapm_routes);
1640 if (ret < 0) {
1641 if (card->disable_route_checks) {
1642 dev_info(card->dev,
1643 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1644 __func__);
1645 } else {
1646 dev_err(card->dev,
1647 "%s: snd_soc_dapm_add_routes failed: %d\n",
1648 __func__, ret);
1649 goto err_probe;
1650 }
1651 }
1652
1653 /* see for_each_card_components */
1654 list_add(&component->card_list, &card->component_dev_list);
1655
1656err_probe:
1657 if (ret < 0)
1658 soc_remove_component(component, probed);
1659
1660 return ret;
1661}
1662
1663static void soc_remove_link_dais(struct snd_soc_card *card)
1664{
1665 struct snd_soc_pcm_runtime *rtd;
1666 int order;
1667
1668 for_each_comp_order(order) {
1669 for_each_card_rtds(card, rtd) {
1670 /* remove all rtd connected DAIs in good order */
1671 snd_soc_pcm_dai_remove(rtd, order);
1672 }
1673 }
1674}
1675
1676static int soc_probe_link_dais(struct snd_soc_card *card)
1677{
1678 struct snd_soc_pcm_runtime *rtd;
1679 int order, ret;
1680
1681 for_each_comp_order(order) {
1682 for_each_card_rtds(card, rtd) {
1683 /* probe all rtd connected DAIs in good order */
1684 ret = snd_soc_pcm_dai_probe(rtd, order);
1685 if (ret)
1686 return ret;
1687 }
1688 }
1689
1690 return 0;
1691}
1692
1693static void soc_remove_link_components(struct snd_soc_card *card)
1694{
1695 struct snd_soc_component *component;
1696 struct snd_soc_pcm_runtime *rtd;
1697 int i, order;
1698
1699 for_each_comp_order(order) {
1700 for_each_card_rtds(card, rtd) {
1701 for_each_rtd_components(rtd, i, component) {
1702 if (component->driver->remove_order != order)
1703 continue;
1704
1705 soc_remove_component(component, 1);
1706 }
1707 }
1708 }
1709}
1710
1711static int soc_probe_link_components(struct snd_soc_card *card)
1712{
1713 struct snd_soc_component *component;
1714 struct snd_soc_pcm_runtime *rtd;
1715 int i, ret, order;
1716
1717 for_each_comp_order(order) {
1718 for_each_card_rtds(card, rtd) {
1719 for_each_rtd_components(rtd, i, component) {
1720 if (component->driver->probe_order != order)
1721 continue;
1722
1723 ret = soc_probe_component(card, component);
1724 if (ret < 0)
1725 return ret;
1726 }
1727 }
1728 }
1729
1730 return 0;
1731}
1732
1733static void soc_unbind_aux_dev(struct snd_soc_card *card)
1734{
1735 struct snd_soc_component *component, *_component;
1736
1737 for_each_card_auxs_safe(card, component, _component) {
1738 /* for snd_soc_component_init() */
1739 snd_soc_component_set_aux(component, NULL);
1740 list_del(&component->card_aux_list);
1741 }
1742}
1743
1744static int soc_bind_aux_dev(struct snd_soc_card *card)
1745{
1746 struct snd_soc_component *component;
1747 struct snd_soc_aux_dev *aux;
1748 int i;
1749
1750 for_each_card_pre_auxs(card, i, aux) {
1751 /* codecs, usually analog devices */
1752 component = soc_find_component(&aux->dlc);
1753 if (!component)
1754 return -EPROBE_DEFER;
1755
1756 /* for snd_soc_component_init() */
1757 snd_soc_component_set_aux(component, aux);
1758 /* see for_each_card_auxs */
1759 list_add(&component->card_aux_list, &card->aux_comp_list);
1760 }
1761 return 0;
1762}
1763
1764static int soc_probe_aux_devices(struct snd_soc_card *card)
1765{
1766 struct snd_soc_component *component;
1767 int order;
1768 int ret;
1769
1770 for_each_comp_order(order) {
1771 for_each_card_auxs(card, component) {
1772 if (component->driver->probe_order != order)
1773 continue;
1774
1775 ret = soc_probe_component(card, component);
1776 if (ret < 0)
1777 return ret;
1778 }
1779 }
1780
1781 return 0;
1782}
1783
1784static void soc_remove_aux_devices(struct snd_soc_card *card)
1785{
1786 struct snd_soc_component *comp, *_comp;
1787 int order;
1788
1789 for_each_comp_order(order) {
1790 for_each_card_auxs_safe(card, comp, _comp) {
1791 if (comp->driver->remove_order == order)
1792 soc_remove_component(comp, 1);
1793 }
1794 }
1795}
1796
1797#ifdef CONFIG_DMI
1798/*
1799 * If a DMI filed contain strings in this blacklist (e.g.
1800 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1801 * as invalid and dropped when setting the card long name from DMI info.
1802 */
1803static const char * const dmi_blacklist[] = {
1804 "To be filled by OEM",
1805 "TBD by OEM",
1806 "Default String",
1807 "Board Manufacturer",
1808 "Board Vendor Name",
1809 "Board Product Name",
1810 NULL, /* terminator */
1811};
1812
1813/*
1814 * Trim special characters, and replace '-' with '_' since '-' is used to
1815 * separate different DMI fields in the card long name. Only number and
1816 * alphabet characters and a few separator characters are kept.
1817 */
1818static void cleanup_dmi_name(char *name)
1819{
1820 int i, j = 0;
1821
1822 for (i = 0; name[i]; i++) {
1823 if (isalnum(name[i]) || (name[i] == '.')
1824 || (name[i] == '_'))
1825 name[j++] = name[i];
1826 else if (name[i] == '-')
1827 name[j++] = '_';
1828 }
1829
1830 name[j] = '\0';
1831}
1832
1833/*
1834 * Check if a DMI field is valid, i.e. not containing any string
1835 * in the black list.
1836 */
1837static int is_dmi_valid(const char *field)
1838{
1839 int i = 0;
1840
1841 while (dmi_blacklist[i]) {
1842 if (strstr(field, dmi_blacklist[i]))
1843 return 0;
1844 i++;
1845 }
1846
1847 return 1;
1848}
1849
1850/*
1851 * Append a string to card->dmi_longname with character cleanups.
1852 */
1853static void append_dmi_string(struct snd_soc_card *card, const char *str)
1854{
1855 char *dst = card->dmi_longname;
1856 size_t dst_len = sizeof(card->dmi_longname);
1857 size_t len;
1858
1859 len = strlen(dst);
1860 snprintf(dst + len, dst_len - len, "-%s", str);
1861
1862 len++; /* skip the separator "-" */
1863 if (len < dst_len)
1864 cleanup_dmi_name(dst + len);
1865}
1866
1867/**
1868 * snd_soc_set_dmi_name() - Register DMI names to card
1869 * @card: The card to register DMI names
1870 * @flavour: The flavour "differentiator" for the card amongst its peers.
1871 *
1872 * An Intel machine driver may be used by many different devices but are
1873 * difficult for userspace to differentiate, since machine drivers usually
1874 * use their own name as the card short name and leave the card long name
1875 * blank. To differentiate such devices and fix bugs due to lack of
1876 * device-specific configurations, this function allows DMI info to be used
1877 * as the sound card long name, in the format of
1878 * "vendor-product-version-board"
1879 * (Character '-' is used to separate different DMI fields here).
1880 * This will help the user space to load the device-specific Use Case Manager
1881 * (UCM) configurations for the card.
1882 *
1883 * Possible card long names may be:
1884 * DellInc.-XPS139343-01-0310JH
1885 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1886 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1887 *
1888 * This function also supports flavoring the card longname to provide
1889 * the extra differentiation, like "vendor-product-version-board-flavor".
1890 *
1891 * We only keep number and alphabet characters and a few separator characters
1892 * in the card long name since UCM in the user space uses the card long names
1893 * as card configuration directory names and AudoConf cannot support special
1894 * characters like SPACE.
1895 *
1896 * Returns 0 on success, otherwise a negative error code.
1897 */
1898int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1899{
1900 const char *vendor, *product, *board;
1901
1902 if (card->long_name)
1903 return 0; /* long name already set by driver or from DMI */
1904
1905 if (!dmi_available)
1906 return 0;
1907
1908 /* make up dmi long name as: vendor-product-version-board */
1909 vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1910 if (!vendor || !is_dmi_valid(vendor)) {
1911 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1912 return 0;
1913 }
1914
1915 snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1916 cleanup_dmi_name(card->dmi_longname);
1917
1918 product = dmi_get_system_info(DMI_PRODUCT_NAME);
1919 if (product && is_dmi_valid(product)) {
1920 const char *product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1921
1922 append_dmi_string(card, product);
1923
1924 /*
1925 * some vendors like Lenovo may only put a self-explanatory
1926 * name in the product version field
1927 */
1928 if (product_version && is_dmi_valid(product_version))
1929 append_dmi_string(card, product_version);
1930 }
1931
1932 board = dmi_get_system_info(DMI_BOARD_NAME);
1933 if (board && is_dmi_valid(board)) {
1934 if (!product || strcasecmp(board, product))
1935 append_dmi_string(card, board);
1936 } else if (!product) {
1937 /* fall back to using legacy name */
1938 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1939 return 0;
1940 }
1941
1942 /* Add flavour to dmi long name */
1943 if (flavour)
1944 append_dmi_string(card, flavour);
1945
1946 /* set the card long name */
1947 card->long_name = card->dmi_longname;
1948
1949 return 0;
1950}
1951EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1952#endif /* CONFIG_DMI */
1953
1954static void soc_check_tplg_fes(struct snd_soc_card *card)
1955{
1956 struct snd_soc_component *component;
1957 const struct snd_soc_component_driver *comp_drv;
1958 struct snd_soc_dai_link *dai_link;
1959 int i;
1960
1961 for_each_component(component) {
1962
1963 /* does this component override BEs ? */
1964 if (!component->driver->ignore_machine)
1965 continue;
1966
1967 /* for this machine ? */
1968 if (!strcmp(component->driver->ignore_machine,
1969 card->dev->driver->name))
1970 goto match;
1971 if (strcmp(component->driver->ignore_machine,
1972 dev_name(card->dev)))
1973 continue;
1974match:
1975 /* machine matches, so override the rtd data */
1976 for_each_card_prelinks(card, i, dai_link) {
1977
1978 /* ignore this FE */
1979 if (dai_link->dynamic) {
1980 dai_link->ignore = true;
1981 continue;
1982 }
1983
1984 dev_dbg(card->dev, "info: override BE DAI link %s\n",
1985 card->dai_link[i].name);
1986
1987 /* override platform component */
1988 if (!dai_link->platforms) {
1989 dev_err(card->dev, "init platform error");
1990 continue;
1991 }
1992
1993 if (component->dev->of_node)
1994 dai_link->platforms->of_node = component->dev->of_node;
1995 else
1996 dai_link->platforms->name = component->name;
1997
1998 /* convert non BE into BE */
1999 if (!dai_link->no_pcm) {
2000 dai_link->no_pcm = 1;
2001
2002 if (dai_link->dpcm_playback)
2003 dev_warn(card->dev,
2004 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
2005 dai_link->name);
2006 if (dai_link->dpcm_capture)
2007 dev_warn(card->dev,
2008 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
2009 dai_link->name);
2010
2011 /* convert normal link into DPCM one */
2012 if (!(dai_link->dpcm_playback ||
2013 dai_link->dpcm_capture)) {
2014 dai_link->dpcm_playback = !dai_link->capture_only;
2015 dai_link->dpcm_capture = !dai_link->playback_only;
2016 }
2017 }
2018
2019 /*
2020 * override any BE fixups
2021 * see
2022 * snd_soc_link_be_hw_params_fixup()
2023 */
2024 dai_link->be_hw_params_fixup =
2025 component->driver->be_hw_params_fixup;
2026
2027 /*
2028 * most BE links don't set stream name, so set it to
2029 * dai link name if it's NULL to help bind widgets.
2030 */
2031 if (!dai_link->stream_name)
2032 dai_link->stream_name = dai_link->name;
2033 }
2034
2035 /* Inform userspace we are using alternate topology */
2036 if (component->driver->topology_name_prefix) {
2037
2038 /* topology shortname created? */
2039 if (!card->topology_shortname_created) {
2040 comp_drv = component->driver;
2041
2042 snprintf(card->topology_shortname, 32, "%s-%s",
2043 comp_drv->topology_name_prefix,
2044 card->name);
2045 card->topology_shortname_created = true;
2046 }
2047
2048 /* use topology shortname */
2049 card->name = card->topology_shortname;
2050 }
2051 }
2052}
2053
2054#define soc_setup_card_name(card, name, name1, name2) \
2055 __soc_setup_card_name(card, name, sizeof(name), name1, name2)
2056static void __soc_setup_card_name(struct snd_soc_card *card,
2057 char *name, int len,
2058 const char *name1, const char *name2)
2059{
2060 const char *src = name1 ? name1 : name2;
2061 int i;
2062
2063 snprintf(name, len, "%s", src);
2064
2065 if (name != card->snd_card->driver)
2066 return;
2067
2068 /*
2069 * Name normalization (driver field)
2070 *
2071 * The driver name is somewhat special, as it's used as a key for
2072 * searches in the user-space.
2073 *
2074 * ex)
2075 * "abcd??efg" -> "abcd__efg"
2076 */
2077 for (i = 0; i < len; i++) {
2078 switch (name[i]) {
2079 case '_':
2080 case '-':
2081 case '\0':
2082 break;
2083 default:
2084 if (!isalnum(name[i]))
2085 name[i] = '_';
2086 break;
2087 }
2088 }
2089
2090 /*
2091 * The driver field should contain a valid string from the user view.
2092 * The wrapping usually does not work so well here. Set a smaller string
2093 * in the specific ASoC driver.
2094 */
2095 if (strlen(src) > len - 1)
2096 dev_err(card->dev, "ASoC: driver name too long '%s' -> '%s'\n", src, name);
2097}
2098
2099static void soc_cleanup_card_resources(struct snd_soc_card *card)
2100{
2101 struct snd_soc_pcm_runtime *rtd, *n;
2102
2103 if (card->snd_card)
2104 snd_card_disconnect_sync(card->snd_card);
2105
2106 snd_soc_dapm_shutdown(card);
2107
2108 /* release machine specific resources */
2109 for_each_card_rtds(card, rtd)
2110 if (rtd->initialized)
2111 snd_soc_link_exit(rtd);
2112 /* remove and free each DAI */
2113 soc_remove_link_dais(card);
2114 soc_remove_link_components(card);
2115
2116 for_each_card_rtds_safe(card, rtd, n)
2117 snd_soc_remove_pcm_runtime(card, rtd);
2118
2119 /* remove auxiliary devices */
2120 soc_remove_aux_devices(card);
2121 soc_unbind_aux_dev(card);
2122
2123 snd_soc_dapm_free(&card->dapm);
2124 soc_cleanup_card_debugfs(card);
2125
2126 /* remove the card */
2127 snd_soc_card_remove(card);
2128
2129 if (card->snd_card) {
2130 snd_card_free(card->snd_card);
2131 card->snd_card = NULL;
2132 }
2133}
2134
2135static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
2136{
2137 if (snd_soc_card_is_instantiated(card)) {
2138 card->instantiated = false;
2139 snd_soc_flush_all_delayed_work(card);
2140
2141 soc_cleanup_card_resources(card);
2142 if (!unregister)
2143 list_add(&card->list, &unbind_card_list);
2144 } else {
2145 if (unregister)
2146 list_del(&card->list);
2147 }
2148}
2149
2150static int snd_soc_bind_card(struct snd_soc_card *card)
2151{
2152 struct snd_soc_pcm_runtime *rtd;
2153 struct snd_soc_component *component;
2154 int ret;
2155
2156 mutex_lock(&client_mutex);
2157 snd_soc_card_mutex_lock_root(card);
2158
2159 snd_soc_fill_dummy_dai(card);
2160
2161 snd_soc_dapm_init(&card->dapm, card, NULL);
2162
2163 /* check whether any platform is ignore machine FE and using topology */
2164 soc_check_tplg_fes(card);
2165
2166 /* bind aux_devs too */
2167 ret = soc_bind_aux_dev(card);
2168 if (ret < 0)
2169 goto probe_end;
2170
2171 /* add predefined DAI links to the list */
2172 card->num_rtd = 0;
2173 ret = snd_soc_add_pcm_runtimes(card, card->dai_link, card->num_links);
2174 if (ret < 0)
2175 goto probe_end;
2176
2177 /* card bind complete so register a sound card */
2178 ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2179 card->owner, 0, &card->snd_card);
2180 if (ret < 0) {
2181 dev_err(card->dev,
2182 "ASoC: can't create sound card for card %s: %d\n",
2183 card->name, ret);
2184 goto probe_end;
2185 }
2186
2187 soc_init_card_debugfs(card);
2188
2189 soc_resume_init(card);
2190
2191 ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2192 card->num_dapm_widgets);
2193 if (ret < 0)
2194 goto probe_end;
2195
2196 ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2197 card->num_of_dapm_widgets);
2198 if (ret < 0)
2199 goto probe_end;
2200
2201 /* initialise the sound card only once */
2202 ret = snd_soc_card_probe(card);
2203 if (ret < 0)
2204 goto probe_end;
2205
2206 /* probe all components used by DAI links on this card */
2207 ret = soc_probe_link_components(card);
2208 if (ret < 0) {
2209 if (ret != -EPROBE_DEFER) {
2210 dev_err(card->dev,
2211 "ASoC: failed to instantiate card %d\n", ret);
2212 }
2213 goto probe_end;
2214 }
2215
2216 /* probe auxiliary components */
2217 ret = soc_probe_aux_devices(card);
2218 if (ret < 0) {
2219 dev_err(card->dev,
2220 "ASoC: failed to probe aux component %d\n", ret);
2221 goto probe_end;
2222 }
2223
2224 /* probe all DAI links on this card */
2225 ret = soc_probe_link_dais(card);
2226 if (ret < 0) {
2227 dev_err(card->dev,
2228 "ASoC: failed to instantiate card %d\n", ret);
2229 goto probe_end;
2230 }
2231
2232 for_each_card_rtds(card, rtd) {
2233 ret = soc_init_pcm_runtime(card, rtd);
2234 if (ret < 0)
2235 goto probe_end;
2236 }
2237
2238 snd_soc_dapm_link_dai_widgets(card);
2239 snd_soc_dapm_connect_dai_link_widgets(card);
2240
2241 ret = snd_soc_add_card_controls(card, card->controls,
2242 card->num_controls);
2243 if (ret < 0)
2244 goto probe_end;
2245
2246 ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2247 card->num_dapm_routes);
2248 if (ret < 0) {
2249 if (card->disable_route_checks) {
2250 dev_info(card->dev,
2251 "%s: disable_route_checks set, ignoring errors on add_routes\n",
2252 __func__);
2253 } else {
2254 dev_err(card->dev,
2255 "%s: snd_soc_dapm_add_routes failed: %d\n",
2256 __func__, ret);
2257 goto probe_end;
2258 }
2259 }
2260
2261 ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2262 card->num_of_dapm_routes);
2263 if (ret < 0)
2264 goto probe_end;
2265
2266 /* try to set some sane longname if DMI is available */
2267 snd_soc_set_dmi_name(card, NULL);
2268
2269 soc_setup_card_name(card, card->snd_card->shortname,
2270 card->name, NULL);
2271 soc_setup_card_name(card, card->snd_card->longname,
2272 card->long_name, card->name);
2273 soc_setup_card_name(card, card->snd_card->driver,
2274 card->driver_name, card->name);
2275
2276 if (card->components) {
2277 /* the current implementation of snd_component_add() accepts */
2278 /* multiple components in the string separated by space, */
2279 /* but the string collision (identical string) check might */
2280 /* not work correctly */
2281 ret = snd_component_add(card->snd_card, card->components);
2282 if (ret < 0) {
2283 dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
2284 card->name, ret);
2285 goto probe_end;
2286 }
2287 }
2288
2289 ret = snd_soc_card_late_probe(card);
2290 if (ret < 0)
2291 goto probe_end;
2292
2293 snd_soc_dapm_new_widgets(card);
2294 snd_soc_card_fixup_controls(card);
2295
2296 ret = snd_card_register(card->snd_card);
2297 if (ret < 0) {
2298 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2299 ret);
2300 goto probe_end;
2301 }
2302
2303 card->instantiated = 1;
2304 dapm_mark_endpoints_dirty(card);
2305 snd_soc_dapm_sync(&card->dapm);
2306
2307 /* deactivate pins to sleep state */
2308 for_each_card_components(card, component)
2309 if (!snd_soc_component_active(component))
2310 pinctrl_pm_select_sleep_state(component->dev);
2311
2312probe_end:
2313 if (ret < 0)
2314 soc_cleanup_card_resources(card);
2315
2316 snd_soc_card_mutex_unlock(card);
2317 mutex_unlock(&client_mutex);
2318
2319 return ret;
2320}
2321
2322/* probes a new socdev */
2323static int soc_probe(struct platform_device *pdev)
2324{
2325 struct snd_soc_card *card = platform_get_drvdata(pdev);
2326
2327 /*
2328 * no card, so machine driver should be registering card
2329 * we should not be here in that case so ret error
2330 */
2331 if (!card)
2332 return -EINVAL;
2333
2334 dev_warn(&pdev->dev,
2335 "ASoC: machine %s should use snd_soc_register_card()\n",
2336 card->name);
2337
2338 /* Bodge while we unpick instantiation */
2339 card->dev = &pdev->dev;
2340
2341 return devm_snd_soc_register_card(&pdev->dev, card);
2342}
2343
2344int snd_soc_poweroff(struct device *dev)
2345{
2346 struct snd_soc_card *card = dev_get_drvdata(dev);
2347 struct snd_soc_component *component;
2348
2349 if (!snd_soc_card_is_instantiated(card))
2350 return 0;
2351
2352 /*
2353 * Flush out pmdown_time work - we actually do want to run it
2354 * now, we're shutting down so no imminent restart.
2355 */
2356 snd_soc_flush_all_delayed_work(card);
2357
2358 snd_soc_dapm_shutdown(card);
2359
2360 /* deactivate pins to sleep state */
2361 for_each_card_components(card, component)
2362 pinctrl_pm_select_sleep_state(component->dev);
2363
2364 return 0;
2365}
2366EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2367
2368const struct dev_pm_ops snd_soc_pm_ops = {
2369 .suspend = snd_soc_suspend,
2370 .resume = snd_soc_resume,
2371 .freeze = snd_soc_suspend,
2372 .thaw = snd_soc_resume,
2373 .poweroff = snd_soc_poweroff,
2374 .restore = snd_soc_resume,
2375};
2376EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2377
2378/* ASoC platform driver */
2379static struct platform_driver soc_driver = {
2380 .driver = {
2381 .name = "soc-audio",
2382 .pm = &snd_soc_pm_ops,
2383 },
2384 .probe = soc_probe,
2385};
2386
2387/**
2388 * snd_soc_cnew - create new control
2389 * @_template: control template
2390 * @data: control private data
2391 * @long_name: control long name
2392 * @prefix: control name prefix
2393 *
2394 * Create a new mixer control from a template control.
2395 *
2396 * Returns 0 for success, else error.
2397 */
2398struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2399 void *data, const char *long_name,
2400 const char *prefix)
2401{
2402 struct snd_kcontrol_new template;
2403 struct snd_kcontrol *kcontrol;
2404 char *name = NULL;
2405
2406 memcpy(&template, _template, sizeof(template));
2407 template.index = 0;
2408
2409 if (!long_name)
2410 long_name = template.name;
2411
2412 if (prefix) {
2413 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2414 if (!name)
2415 return NULL;
2416
2417 template.name = name;
2418 } else {
2419 template.name = long_name;
2420 }
2421
2422 kcontrol = snd_ctl_new1(&template, data);
2423
2424 kfree(name);
2425
2426 return kcontrol;
2427}
2428EXPORT_SYMBOL_GPL(snd_soc_cnew);
2429
2430static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2431 const struct snd_kcontrol_new *controls, int num_controls,
2432 const char *prefix, void *data)
2433{
2434 int i;
2435
2436 for (i = 0; i < num_controls; i++) {
2437 const struct snd_kcontrol_new *control = &controls[i];
2438 int err = snd_ctl_add(card, snd_soc_cnew(control, data,
2439 control->name, prefix));
2440 if (err < 0) {
2441 dev_err(dev, "ASoC: Failed to add %s: %d\n",
2442 control->name, err);
2443 return err;
2444 }
2445 }
2446
2447 return 0;
2448}
2449
2450/**
2451 * snd_soc_add_component_controls - Add an array of controls to a component.
2452 *
2453 * @component: Component to add controls to
2454 * @controls: Array of controls to add
2455 * @num_controls: Number of elements in the array
2456 *
2457 * Return: 0 for success, else error.
2458 */
2459int snd_soc_add_component_controls(struct snd_soc_component *component,
2460 const struct snd_kcontrol_new *controls, unsigned int num_controls)
2461{
2462 struct snd_card *card = component->card->snd_card;
2463
2464 return snd_soc_add_controls(card, component->dev, controls,
2465 num_controls, component->name_prefix, component);
2466}
2467EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2468
2469/**
2470 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2471 * Convenience function to add a list of controls.
2472 *
2473 * @soc_card: SoC card to add controls to
2474 * @controls: array of controls to add
2475 * @num_controls: number of elements in the array
2476 *
2477 * Return 0 for success, else error.
2478 */
2479int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2480 const struct snd_kcontrol_new *controls, int num_controls)
2481{
2482 struct snd_card *card = soc_card->snd_card;
2483
2484 return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2485 NULL, soc_card);
2486}
2487EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2488
2489/**
2490 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2491 * Convenience function to add a list of controls.
2492 *
2493 * @dai: DAI to add controls to
2494 * @controls: array of controls to add
2495 * @num_controls: number of elements in the array
2496 *
2497 * Return 0 for success, else error.
2498 */
2499int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2500 const struct snd_kcontrol_new *controls, int num_controls)
2501{
2502 struct snd_card *card = dai->component->card->snd_card;
2503
2504 return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2505 NULL, dai);
2506}
2507EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2508
2509/**
2510 * snd_soc_register_card - Register a card with the ASoC core
2511 *
2512 * @card: Card to register
2513 *
2514 */
2515int snd_soc_register_card(struct snd_soc_card *card)
2516{
2517 if (!card->name || !card->dev)
2518 return -EINVAL;
2519
2520 dev_set_drvdata(card->dev, card);
2521
2522 INIT_LIST_HEAD(&card->widgets);
2523 INIT_LIST_HEAD(&card->paths);
2524 INIT_LIST_HEAD(&card->dapm_list);
2525 INIT_LIST_HEAD(&card->aux_comp_list);
2526 INIT_LIST_HEAD(&card->component_dev_list);
2527 INIT_LIST_HEAD(&card->list);
2528 INIT_LIST_HEAD(&card->rtd_list);
2529 INIT_LIST_HEAD(&card->dapm_dirty);
2530 INIT_LIST_HEAD(&card->dobj_list);
2531
2532 card->instantiated = 0;
2533 mutex_init(&card->mutex);
2534 mutex_init(&card->dapm_mutex);
2535 mutex_init(&card->pcm_mutex);
2536
2537 return snd_soc_bind_card(card);
2538}
2539EXPORT_SYMBOL_GPL(snd_soc_register_card);
2540
2541/**
2542 * snd_soc_unregister_card - Unregister a card with the ASoC core
2543 *
2544 * @card: Card to unregister
2545 *
2546 */
2547void snd_soc_unregister_card(struct snd_soc_card *card)
2548{
2549 mutex_lock(&client_mutex);
2550 snd_soc_unbind_card(card, true);
2551 mutex_unlock(&client_mutex);
2552 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2553}
2554EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2555
2556/*
2557 * Simplify DAI link configuration by removing ".-1" from device names
2558 * and sanitizing names.
2559 */
2560static char *fmt_single_name(struct device *dev, int *id)
2561{
2562 const char *devname = dev_name(dev);
2563 char *found, *name;
2564 unsigned int id1, id2;
2565
2566 if (devname == NULL)
2567 return NULL;
2568
2569 name = devm_kstrdup(dev, devname, GFP_KERNEL);
2570 if (!name)
2571 return NULL;
2572
2573 /* are we a "%s.%d" name (platform and SPI components) */
2574 found = strstr(name, dev->driver->name);
2575 if (found) {
2576 /* get ID */
2577 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2578
2579 /* discard ID from name if ID == -1 */
2580 if (*id == -1)
2581 found[strlen(dev->driver->name)] = '\0';
2582 }
2583
2584 /* I2C component devices are named "bus-addr" */
2585 } else if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2586
2587 /* create unique ID number from I2C addr and bus */
2588 *id = ((id1 & 0xffff) << 16) + id2;
2589
2590 devm_kfree(dev, name);
2591
2592 /* sanitize component name for DAI link creation */
2593 name = devm_kasprintf(dev, GFP_KERNEL, "%s.%s", dev->driver->name, devname);
2594 } else {
2595 *id = 0;
2596 }
2597
2598 return name;
2599}
2600
2601/*
2602 * Simplify DAI link naming for single devices with multiple DAIs by removing
2603 * any ".-1" and using the DAI name (instead of device name).
2604 */
2605static inline char *fmt_multiple_name(struct device *dev,
2606 struct snd_soc_dai_driver *dai_drv)
2607{
2608 if (dai_drv->name == NULL) {
2609 dev_err(dev,
2610 "ASoC: error - multiple DAI %s registered with no name\n",
2611 dev_name(dev));
2612 return NULL;
2613 }
2614
2615 return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2616}
2617
2618void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2619{
2620 dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2621 list_del(&dai->list);
2622}
2623EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2624
2625/**
2626 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2627 *
2628 * @component: The component the DAIs are registered for
2629 * @dai_drv: DAI driver to use for the DAI
2630 * @legacy_dai_naming: if %true, use legacy single-name format;
2631 * if %false, use multiple-name format;
2632 *
2633 * Topology can use this API to register DAIs when probing a component.
2634 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2635 * will be freed in the component cleanup.
2636 */
2637struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2638 struct snd_soc_dai_driver *dai_drv,
2639 bool legacy_dai_naming)
2640{
2641 struct device *dev = component->dev;
2642 struct snd_soc_dai *dai;
2643
2644 lockdep_assert_held(&client_mutex);
2645
2646 dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2647 if (dai == NULL)
2648 return NULL;
2649
2650 /*
2651 * Back in the old days when we still had component-less DAIs,
2652 * instead of having a static name, component-less DAIs would
2653 * inherit the name of the parent device so it is possible to
2654 * register multiple instances of the DAI. We still need to keep
2655 * the same naming style even though those DAIs are not
2656 * component-less anymore.
2657 */
2658 if (legacy_dai_naming &&
2659 (dai_drv->id == 0 || dai_drv->name == NULL)) {
2660 dai->name = fmt_single_name(dev, &dai->id);
2661 } else {
2662 dai->name = fmt_multiple_name(dev, dai_drv);
2663 if (dai_drv->id)
2664 dai->id = dai_drv->id;
2665 else
2666 dai->id = component->num_dai;
2667 }
2668 if (!dai->name)
2669 return NULL;
2670
2671 dai->component = component;
2672 dai->dev = dev;
2673 dai->driver = dai_drv;
2674
2675 /* see for_each_component_dais */
2676 list_add_tail(&dai->list, &component->dai_list);
2677 component->num_dai++;
2678
2679 dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2680 return dai;
2681}
2682EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2683
2684/**
2685 * snd_soc_unregister_dais - Unregister DAIs from the ASoC core
2686 *
2687 * @component: The component for which the DAIs should be unregistered
2688 */
2689static void snd_soc_unregister_dais(struct snd_soc_component *component)
2690{
2691 struct snd_soc_dai *dai, *_dai;
2692
2693 for_each_component_dais_safe(component, dai, _dai)
2694 snd_soc_unregister_dai(dai);
2695}
2696
2697/**
2698 * snd_soc_register_dais - Register a DAI with the ASoC core
2699 *
2700 * @component: The component the DAIs are registered for
2701 * @dai_drv: DAI driver to use for the DAIs
2702 * @count: Number of DAIs
2703 */
2704static int snd_soc_register_dais(struct snd_soc_component *component,
2705 struct snd_soc_dai_driver *dai_drv,
2706 size_t count)
2707{
2708 struct snd_soc_dai *dai;
2709 unsigned int i;
2710 int ret;
2711
2712 for (i = 0; i < count; i++) {
2713 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2714 component->driver->legacy_dai_naming);
2715 if (dai == NULL) {
2716 ret = -ENOMEM;
2717 goto err;
2718 }
2719 }
2720
2721 return 0;
2722
2723err:
2724 snd_soc_unregister_dais(component);
2725
2726 return ret;
2727}
2728
2729#define ENDIANNESS_MAP(name) \
2730 (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2731static u64 endianness_format_map[] = {
2732 ENDIANNESS_MAP(S16_),
2733 ENDIANNESS_MAP(U16_),
2734 ENDIANNESS_MAP(S24_),
2735 ENDIANNESS_MAP(U24_),
2736 ENDIANNESS_MAP(S32_),
2737 ENDIANNESS_MAP(U32_),
2738 ENDIANNESS_MAP(S24_3),
2739 ENDIANNESS_MAP(U24_3),
2740 ENDIANNESS_MAP(S20_3),
2741 ENDIANNESS_MAP(U20_3),
2742 ENDIANNESS_MAP(S18_3),
2743 ENDIANNESS_MAP(U18_3),
2744 ENDIANNESS_MAP(FLOAT_),
2745 ENDIANNESS_MAP(FLOAT64_),
2746 ENDIANNESS_MAP(IEC958_SUBFRAME_),
2747};
2748
2749/*
2750 * Fix up the DAI formats for endianness: codecs don't actually see
2751 * the endianness of the data but we're using the CPU format
2752 * definitions which do need to include endianness so we ensure that
2753 * codec DAIs always have both big and little endian variants set.
2754 */
2755static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2756{
2757 int i;
2758
2759 for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2760 if (stream->formats & endianness_format_map[i])
2761 stream->formats |= endianness_format_map[i];
2762}
2763
2764static void snd_soc_try_rebind_card(void)
2765{
2766 struct snd_soc_card *card, *c;
2767
2768 list_for_each_entry_safe(card, c, &unbind_card_list, list)
2769 if (!snd_soc_bind_card(card))
2770 list_del(&card->list);
2771}
2772
2773static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2774{
2775 struct snd_soc_card *card = component->card;
2776
2777 snd_soc_unregister_dais(component);
2778
2779 if (card)
2780 snd_soc_unbind_card(card, false);
2781
2782 list_del(&component->list);
2783}
2784
2785int snd_soc_component_initialize(struct snd_soc_component *component,
2786 const struct snd_soc_component_driver *driver,
2787 struct device *dev)
2788{
2789 INIT_LIST_HEAD(&component->dai_list);
2790 INIT_LIST_HEAD(&component->dobj_list);
2791 INIT_LIST_HEAD(&component->card_list);
2792 INIT_LIST_HEAD(&component->list);
2793 mutex_init(&component->io_mutex);
2794
2795 component->name = fmt_single_name(dev, &component->id);
2796 if (!component->name) {
2797 dev_err(dev, "ASoC: Failed to allocate name\n");
2798 return -ENOMEM;
2799 }
2800
2801 component->dev = dev;
2802 component->driver = driver;
2803
2804#ifdef CONFIG_DEBUG_FS
2805 if (!component->debugfs_prefix)
2806 component->debugfs_prefix = driver->debugfs_prefix;
2807#endif
2808
2809 return 0;
2810}
2811EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2812
2813int snd_soc_add_component(struct snd_soc_component *component,
2814 struct snd_soc_dai_driver *dai_drv,
2815 int num_dai)
2816{
2817 int ret;
2818 int i;
2819
2820 mutex_lock(&client_mutex);
2821
2822 if (component->driver->endianness) {
2823 for (i = 0; i < num_dai; i++) {
2824 convert_endianness_formats(&dai_drv[i].playback);
2825 convert_endianness_formats(&dai_drv[i].capture);
2826 }
2827 }
2828
2829 ret = snd_soc_register_dais(component, dai_drv, num_dai);
2830 if (ret < 0) {
2831 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2832 ret);
2833 goto err_cleanup;
2834 }
2835
2836 if (!component->driver->write && !component->driver->read) {
2837 if (!component->regmap)
2838 component->regmap = dev_get_regmap(component->dev,
2839 NULL);
2840 if (component->regmap)
2841 snd_soc_component_setup_regmap(component);
2842 }
2843
2844 /* see for_each_component */
2845 list_add(&component->list, &component_list);
2846
2847err_cleanup:
2848 if (ret < 0)
2849 snd_soc_del_component_unlocked(component);
2850
2851 mutex_unlock(&client_mutex);
2852
2853 if (ret == 0)
2854 snd_soc_try_rebind_card();
2855
2856 return ret;
2857}
2858EXPORT_SYMBOL_GPL(snd_soc_add_component);
2859
2860int snd_soc_register_component(struct device *dev,
2861 const struct snd_soc_component_driver *component_driver,
2862 struct snd_soc_dai_driver *dai_drv,
2863 int num_dai)
2864{
2865 struct snd_soc_component *component;
2866 int ret;
2867
2868 component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2869 if (!component)
2870 return -ENOMEM;
2871
2872 ret = snd_soc_component_initialize(component, component_driver, dev);
2873 if (ret < 0)
2874 return ret;
2875
2876 return snd_soc_add_component(component, dai_drv, num_dai);
2877}
2878EXPORT_SYMBOL_GPL(snd_soc_register_component);
2879
2880/**
2881 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2882 * from the ASoC core
2883 *
2884 * @dev: The device to unregister
2885 * @component_driver: The component driver to unregister
2886 */
2887void snd_soc_unregister_component_by_driver(struct device *dev,
2888 const struct snd_soc_component_driver *component_driver)
2889{
2890 struct snd_soc_component *component;
2891
2892 if (!component_driver)
2893 return;
2894
2895 mutex_lock(&client_mutex);
2896 component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2897 if (!component)
2898 goto out;
2899
2900 snd_soc_del_component_unlocked(component);
2901
2902out:
2903 mutex_unlock(&client_mutex);
2904}
2905EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2906
2907/**
2908 * snd_soc_unregister_component - Unregister all related component
2909 * from the ASoC core
2910 *
2911 * @dev: The device to unregister
2912 */
2913void snd_soc_unregister_component(struct device *dev)
2914{
2915 mutex_lock(&client_mutex);
2916 while (1) {
2917 struct snd_soc_component *component = snd_soc_lookup_component_nolocked(dev, NULL);
2918
2919 if (!component)
2920 break;
2921
2922 snd_soc_del_component_unlocked(component);
2923 }
2924 mutex_unlock(&client_mutex);
2925}
2926EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2927
2928/* Retrieve a card's name from device tree */
2929int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2930 const char *propname)
2931{
2932 struct device_node *np;
2933 int ret;
2934
2935 if (!card->dev) {
2936 pr_err("card->dev is not set before calling %s\n", __func__);
2937 return -EINVAL;
2938 }
2939
2940 np = card->dev->of_node;
2941
2942 ret = of_property_read_string_index(np, propname, 0, &card->name);
2943 /*
2944 * EINVAL means the property does not exist. This is fine providing
2945 * card->name was previously set, which is checked later in
2946 * snd_soc_register_card.
2947 */
2948 if (ret < 0 && ret != -EINVAL) {
2949 dev_err(card->dev,
2950 "ASoC: Property '%s' could not be read: %d\n",
2951 propname, ret);
2952 return ret;
2953 }
2954
2955 return 0;
2956}
2957EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2958
2959static const struct snd_soc_dapm_widget simple_widgets[] = {
2960 SND_SOC_DAPM_MIC("Microphone", NULL),
2961 SND_SOC_DAPM_LINE("Line", NULL),
2962 SND_SOC_DAPM_HP("Headphone", NULL),
2963 SND_SOC_DAPM_SPK("Speaker", NULL),
2964};
2965
2966int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2967 const char *propname)
2968{
2969 struct device_node *np = card->dev->of_node;
2970 struct snd_soc_dapm_widget *widgets;
2971 const char *template, *wname;
2972 int i, j, num_widgets;
2973
2974 num_widgets = of_property_count_strings(np, propname);
2975 if (num_widgets < 0) {
2976 dev_err(card->dev,
2977 "ASoC: Property '%s' does not exist\n", propname);
2978 return -EINVAL;
2979 }
2980 if (!num_widgets) {
2981 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2982 propname);
2983 return -EINVAL;
2984 }
2985 if (num_widgets & 1) {
2986 dev_err(card->dev,
2987 "ASoC: Property '%s' length is not even\n", propname);
2988 return -EINVAL;
2989 }
2990
2991 num_widgets /= 2;
2992
2993 widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2994 GFP_KERNEL);
2995 if (!widgets) {
2996 dev_err(card->dev,
2997 "ASoC: Could not allocate memory for widgets\n");
2998 return -ENOMEM;
2999 }
3000
3001 for (i = 0; i < num_widgets; i++) {
3002 int ret = of_property_read_string_index(np, propname,
3003 2 * i, &template);
3004 if (ret) {
3005 dev_err(card->dev,
3006 "ASoC: Property '%s' index %d read error:%d\n",
3007 propname, 2 * i, ret);
3008 return -EINVAL;
3009 }
3010
3011 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3012 if (!strncmp(template, simple_widgets[j].name,
3013 strlen(simple_widgets[j].name))) {
3014 widgets[i] = simple_widgets[j];
3015 break;
3016 }
3017 }
3018
3019 if (j >= ARRAY_SIZE(simple_widgets)) {
3020 dev_err(card->dev,
3021 "ASoC: DAPM widget '%s' is not supported\n",
3022 template);
3023 return -EINVAL;
3024 }
3025
3026 ret = of_property_read_string_index(np, propname,
3027 (2 * i) + 1,
3028 &wname);
3029 if (ret) {
3030 dev_err(card->dev,
3031 "ASoC: Property '%s' index %d read error:%d\n",
3032 propname, (2 * i) + 1, ret);
3033 return -EINVAL;
3034 }
3035
3036 widgets[i].name = wname;
3037 }
3038
3039 card->of_dapm_widgets = widgets;
3040 card->num_of_dapm_widgets = num_widgets;
3041
3042 return 0;
3043}
3044EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3045
3046int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop)
3047{
3048 const unsigned int nb_controls_max = 16;
3049 const char **strings, *control_name;
3050 struct snd_kcontrol_new *controls;
3051 struct device *dev = card->dev;
3052 unsigned int i, nb_controls;
3053 int ret;
3054
3055 if (!of_property_read_bool(dev->of_node, prop))
3056 return 0;
3057
3058 strings = devm_kcalloc(dev, nb_controls_max,
3059 sizeof(*strings), GFP_KERNEL);
3060 if (!strings)
3061 return -ENOMEM;
3062
3063 ret = of_property_read_string_array(dev->of_node, prop,
3064 strings, nb_controls_max);
3065 if (ret < 0)
3066 return ret;
3067
3068 nb_controls = (unsigned int)ret;
3069
3070 controls = devm_kcalloc(dev, nb_controls,
3071 sizeof(*controls), GFP_KERNEL);
3072 if (!controls)
3073 return -ENOMEM;
3074
3075 for (i = 0; i < nb_controls; i++) {
3076 control_name = devm_kasprintf(dev, GFP_KERNEL,
3077 "%s Switch", strings[i]);
3078 if (!control_name)
3079 return -ENOMEM;
3080
3081 controls[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
3082 controls[i].name = control_name;
3083 controls[i].info = snd_soc_dapm_info_pin_switch;
3084 controls[i].get = snd_soc_dapm_get_pin_switch;
3085 controls[i].put = snd_soc_dapm_put_pin_switch;
3086 controls[i].private_value = (unsigned long)strings[i];
3087 }
3088
3089 card->controls = controls;
3090 card->num_controls = nb_controls;
3091
3092 return 0;
3093}
3094EXPORT_SYMBOL_GPL(snd_soc_of_parse_pin_switches);
3095
3096int snd_soc_of_get_slot_mask(struct device_node *np,
3097 const char *prop_name,
3098 unsigned int *mask)
3099{
3100 u32 val;
3101 const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3102 int i;
3103
3104 if (!of_slot_mask)
3105 return 0;
3106 val /= sizeof(u32);
3107 for (i = 0; i < val; i++)
3108 if (be32_to_cpup(&of_slot_mask[i]))
3109 *mask |= (1 << i);
3110
3111 return val;
3112}
3113EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
3114
3115int snd_soc_of_parse_tdm_slot(struct device_node *np,
3116 unsigned int *tx_mask,
3117 unsigned int *rx_mask,
3118 unsigned int *slots,
3119 unsigned int *slot_width)
3120{
3121 u32 val;
3122 int ret;
3123
3124 if (tx_mask)
3125 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3126 if (rx_mask)
3127 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3128
3129 if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3130 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3131 if (ret)
3132 return ret;
3133
3134 if (slots)
3135 *slots = val;
3136 }
3137
3138 if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3139 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3140 if (ret)
3141 return ret;
3142
3143 if (slot_width)
3144 *slot_width = val;
3145 }
3146
3147 return 0;
3148}
3149EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3150
3151void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
3152 struct snd_soc_dai_link_component *cpus)
3153{
3154 platforms->of_node = cpus->of_node;
3155 platforms->dai_args = cpus->dai_args;
3156}
3157EXPORT_SYMBOL_GPL(snd_soc_dlc_use_cpu_as_platform);
3158
3159void snd_soc_of_parse_node_prefix(struct device_node *np,
3160 struct snd_soc_codec_conf *codec_conf,
3161 struct device_node *of_node,
3162 const char *propname)
3163{
3164 const char *str;
3165 int ret;
3166
3167 ret = of_property_read_string(np, propname, &str);
3168 if (ret < 0) {
3169 /* no prefix is not error */
3170 return;
3171 }
3172
3173 codec_conf->dlc.of_node = of_node;
3174 codec_conf->name_prefix = str;
3175}
3176EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
3177
3178int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3179 const char *propname)
3180{
3181 struct device_node *np = card->dev->of_node;
3182 int num_routes;
3183 struct snd_soc_dapm_route *routes;
3184 int i;
3185
3186 num_routes = of_property_count_strings(np, propname);
3187 if (num_routes < 0 || num_routes & 1) {
3188 dev_err(card->dev,
3189 "ASoC: Property '%s' does not exist or its length is not even\n",
3190 propname);
3191 return -EINVAL;
3192 }
3193 num_routes /= 2;
3194
3195 routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
3196 GFP_KERNEL);
3197 if (!routes) {
3198 dev_err(card->dev,
3199 "ASoC: Could not allocate DAPM route table\n");
3200 return -ENOMEM;
3201 }
3202
3203 for (i = 0; i < num_routes; i++) {
3204 int ret = of_property_read_string_index(np, propname,
3205 2 * i, &routes[i].sink);
3206 if (ret) {
3207 dev_err(card->dev,
3208 "ASoC: Property '%s' index %d could not be read: %d\n",
3209 propname, 2 * i, ret);
3210 return -EINVAL;
3211 }
3212 ret = of_property_read_string_index(np, propname,
3213 (2 * i) + 1, &routes[i].source);
3214 if (ret) {
3215 dev_err(card->dev,
3216 "ASoC: Property '%s' index %d could not be read: %d\n",
3217 propname, (2 * i) + 1, ret);
3218 return -EINVAL;
3219 }
3220 }
3221
3222 card->num_of_dapm_routes = num_routes;
3223 card->of_dapm_routes = routes;
3224
3225 return 0;
3226}
3227EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3228
3229int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname)
3230{
3231 struct device_node *node = card->dev->of_node;
3232 struct snd_soc_aux_dev *aux;
3233 int num, i;
3234
3235 num = of_count_phandle_with_args(node, propname, NULL);
3236 if (num == -ENOENT) {
3237 return 0;
3238 } else if (num < 0) {
3239 dev_err(card->dev, "ASOC: Property '%s' could not be read: %d\n",
3240 propname, num);
3241 return num;
3242 }
3243
3244 aux = devm_kcalloc(card->dev, num, sizeof(*aux), GFP_KERNEL);
3245 if (!aux)
3246 return -ENOMEM;
3247 card->aux_dev = aux;
3248 card->num_aux_devs = num;
3249
3250 for_each_card_pre_auxs(card, i, aux) {
3251 aux->dlc.of_node = of_parse_phandle(node, propname, i);
3252 if (!aux->dlc.of_node)
3253 return -EINVAL;
3254 }
3255
3256 return 0;
3257}
3258EXPORT_SYMBOL_GPL(snd_soc_of_parse_aux_devs);
3259
3260unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt)
3261{
3262 unsigned int inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
3263
3264 switch (dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
3265 case SND_SOC_DAIFMT_CBP_CFP:
3266 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
3267 break;
3268 case SND_SOC_DAIFMT_CBP_CFC:
3269 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
3270 break;
3271 case SND_SOC_DAIFMT_CBC_CFP:
3272 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
3273 break;
3274 case SND_SOC_DAIFMT_CBC_CFC:
3275 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
3276 break;
3277 }
3278
3279 return inv_dai_fmt;
3280}
3281EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_flipped);
3282
3283unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame)
3284{
3285 /*
3286 * bit_frame is return value from
3287 * snd_soc_daifmt_parse_clock_provider_raw()
3288 */
3289
3290 /* Codec base */
3291 switch (bit_frame) {
3292 case 0x11:
3293 return SND_SOC_DAIFMT_CBP_CFP;
3294 case 0x10:
3295 return SND_SOC_DAIFMT_CBP_CFC;
3296 case 0x01:
3297 return SND_SOC_DAIFMT_CBC_CFP;
3298 default:
3299 return SND_SOC_DAIFMT_CBC_CFC;
3300 }
3301
3302 return 0;
3303}
3304EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_from_bitmap);
3305
3306unsigned int snd_soc_daifmt_parse_format(struct device_node *np,
3307 const char *prefix)
3308{
3309 int ret;
3310 char prop[128];
3311 unsigned int format = 0;
3312 int bit, frame;
3313 const char *str;
3314 struct {
3315 char *name;
3316 unsigned int val;
3317 } of_fmt_table[] = {
3318 { "i2s", SND_SOC_DAIFMT_I2S },
3319 { "right_j", SND_SOC_DAIFMT_RIGHT_J },
3320 { "left_j", SND_SOC_DAIFMT_LEFT_J },
3321 { "dsp_a", SND_SOC_DAIFMT_DSP_A },
3322 { "dsp_b", SND_SOC_DAIFMT_DSP_B },
3323 { "ac97", SND_SOC_DAIFMT_AC97 },
3324 { "pdm", SND_SOC_DAIFMT_PDM},
3325 { "msb", SND_SOC_DAIFMT_MSB },
3326 { "lsb", SND_SOC_DAIFMT_LSB },
3327 };
3328
3329 if (!prefix)
3330 prefix = "";
3331
3332 /*
3333 * check "dai-format = xxx"
3334 * or "[prefix]format = xxx"
3335 * SND_SOC_DAIFMT_FORMAT_MASK area
3336 */
3337 ret = of_property_read_string(np, "dai-format", &str);
3338 if (ret < 0) {
3339 snprintf(prop, sizeof(prop), "%sformat", prefix);
3340 ret = of_property_read_string(np, prop, &str);
3341 }
3342 if (ret == 0) {
3343 int i;
3344
3345 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3346 if (strcmp(str, of_fmt_table[i].name) == 0) {
3347 format |= of_fmt_table[i].val;
3348 break;
3349 }
3350 }
3351 }
3352
3353 /*
3354 * check "[prefix]continuous-clock"
3355 * SND_SOC_DAIFMT_CLOCK_MASK area
3356 */
3357 snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3358 if (of_property_read_bool(np, prop))
3359 format |= SND_SOC_DAIFMT_CONT;
3360 else
3361 format |= SND_SOC_DAIFMT_GATED;
3362
3363 /*
3364 * check "[prefix]bitclock-inversion"
3365 * check "[prefix]frame-inversion"
3366 * SND_SOC_DAIFMT_INV_MASK area
3367 */
3368 snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3369 bit = !!of_get_property(np, prop, NULL);
3370
3371 snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3372 frame = !!of_get_property(np, prop, NULL);
3373
3374 switch ((bit << 4) + frame) {
3375 case 0x11:
3376 format |= SND_SOC_DAIFMT_IB_IF;
3377 break;
3378 case 0x10:
3379 format |= SND_SOC_DAIFMT_IB_NF;
3380 break;
3381 case 0x01:
3382 format |= SND_SOC_DAIFMT_NB_IF;
3383 break;
3384 default:
3385 /* SND_SOC_DAIFMT_NB_NF is default */
3386 break;
3387 }
3388
3389 return format;
3390}
3391EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_format);
3392
3393unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
3394 const char *prefix,
3395 struct device_node **bitclkmaster,
3396 struct device_node **framemaster)
3397{
3398 char prop[128];
3399 unsigned int bit, frame;
3400
3401 if (!prefix)
3402 prefix = "";
3403
3404 /*
3405 * check "[prefix]bitclock-master"
3406 * check "[prefix]frame-master"
3407 */
3408 snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3409 bit = !!of_get_property(np, prop, NULL);
3410 if (bit && bitclkmaster)
3411 *bitclkmaster = of_parse_phandle(np, prop, 0);
3412
3413 snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3414 frame = !!of_get_property(np, prop, NULL);
3415 if (frame && framemaster)
3416 *framemaster = of_parse_phandle(np, prop, 0);
3417
3418 /*
3419 * return bitmap.
3420 * It will be parameter of
3421 * snd_soc_daifmt_clock_provider_from_bitmap()
3422 */
3423 return (bit << 4) + frame;
3424}
3425EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_clock_provider_raw);
3426
3427int snd_soc_get_stream_cpu(struct snd_soc_dai_link *dai_link, int stream)
3428{
3429 /*
3430 * [Normal]
3431 *
3432 * Playback
3433 * CPU : SNDRV_PCM_STREAM_PLAYBACK
3434 * Codec: SNDRV_PCM_STREAM_PLAYBACK
3435 *
3436 * Capture
3437 * CPU : SNDRV_PCM_STREAM_CAPTURE
3438 * Codec: SNDRV_PCM_STREAM_CAPTURE
3439 */
3440 if (!dai_link->c2c_params)
3441 return stream;
3442
3443 /*
3444 * [Codec2Codec]
3445 *
3446 * Playback
3447 * CPU : SNDRV_PCM_STREAM_CAPTURE
3448 * Codec: SNDRV_PCM_STREAM_PLAYBACK
3449 *
3450 * Capture
3451 * CPU : SNDRV_PCM_STREAM_PLAYBACK
3452 * Codec: SNDRV_PCM_STREAM_CAPTURE
3453 */
3454 if (stream == SNDRV_PCM_STREAM_CAPTURE)
3455 return SNDRV_PCM_STREAM_PLAYBACK;
3456
3457 return SNDRV_PCM_STREAM_CAPTURE;
3458}
3459EXPORT_SYMBOL_GPL(snd_soc_get_stream_cpu);
3460
3461int snd_soc_get_dai_id(struct device_node *ep)
3462{
3463 struct snd_soc_component *component;
3464 struct snd_soc_dai_link_component dlc = {
3465 .of_node = of_graph_get_port_parent(ep),
3466 };
3467 int ret;
3468
3469
3470 /*
3471 * For example HDMI case, HDMI has video/sound port,
3472 * but ALSA SoC needs sound port number only.
3473 * Thus counting HDMI DT port/endpoint doesn't work.
3474 * Then, it should have .of_xlate_dai_id
3475 */
3476 ret = -ENOTSUPP;
3477 mutex_lock(&client_mutex);
3478 component = soc_find_component(&dlc);
3479 if (component)
3480 ret = snd_soc_component_of_xlate_dai_id(component, ep);
3481 mutex_unlock(&client_mutex);
3482
3483 of_node_put(dlc.of_node);
3484
3485 return ret;
3486}
3487EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3488
3489int snd_soc_get_dlc(const struct of_phandle_args *args, struct snd_soc_dai_link_component *dlc)
3490{
3491 struct snd_soc_component *pos;
3492 int ret = -EPROBE_DEFER;
3493
3494 mutex_lock(&client_mutex);
3495 for_each_component(pos) {
3496 struct device_node *component_of_node = soc_component_to_node(pos);
3497
3498 if (component_of_node != args->np || !pos->num_dai)
3499 continue;
3500
3501 ret = snd_soc_component_of_xlate_dai_name(pos, args, &dlc->dai_name);
3502 if (ret == -ENOTSUPP) {
3503 struct snd_soc_dai *dai;
3504 int id = -1;
3505
3506 switch (args->args_count) {
3507 case 0:
3508 id = 0; /* same as dai_drv[0] */
3509 break;
3510 case 1:
3511 id = args->args[0];
3512 break;
3513 default:
3514 /* not supported */
3515 break;
3516 }
3517
3518 if (id < 0 || id >= pos->num_dai) {
3519 ret = -EINVAL;
3520 continue;
3521 }
3522
3523 ret = 0;
3524
3525 /* find target DAI */
3526 for_each_component_dais(pos, dai) {
3527 if (id == 0)
3528 break;
3529 id--;
3530 }
3531
3532 dlc->dai_name = snd_soc_dai_name_get(dai);
3533 } else if (ret) {
3534 /*
3535 * if another error than ENOTSUPP is returned go on and
3536 * check if another component is provided with the same
3537 * node. This may happen if a device provides several
3538 * components
3539 */
3540 continue;
3541 }
3542
3543 break;
3544 }
3545
3546 if (ret == 0)
3547 dlc->of_node = args->np;
3548
3549 mutex_unlock(&client_mutex);
3550 return ret;
3551}
3552EXPORT_SYMBOL_GPL(snd_soc_get_dlc);
3553
3554int snd_soc_of_get_dlc(struct device_node *of_node,
3555 struct of_phandle_args *args,
3556 struct snd_soc_dai_link_component *dlc,
3557 int index)
3558{
3559 struct of_phandle_args __args;
3560 int ret;
3561
3562 if (!args)
3563 args = &__args;
3564
3565 ret = of_parse_phandle_with_args(of_node, "sound-dai",
3566 "#sound-dai-cells", index, args);
3567 if (ret)
3568 return ret;
3569
3570 return snd_soc_get_dlc(args, dlc);
3571}
3572EXPORT_SYMBOL_GPL(snd_soc_of_get_dlc);
3573
3574int snd_soc_get_dai_name(const struct of_phandle_args *args,
3575 const char **dai_name)
3576{
3577 struct snd_soc_dai_link_component dlc;
3578 int ret = snd_soc_get_dlc(args, &dlc);
3579
3580 if (ret == 0)
3581 *dai_name = dlc.dai_name;
3582
3583 return ret;
3584}
3585EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3586
3587int snd_soc_of_get_dai_name(struct device_node *of_node,
3588 const char **dai_name, int index)
3589{
3590 struct snd_soc_dai_link_component dlc;
3591 int ret = snd_soc_of_get_dlc(of_node, NULL, &dlc, index);
3592
3593 if (ret == 0)
3594 *dai_name = dlc.dai_name;
3595
3596 return ret;
3597}
3598EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3599
3600struct snd_soc_dai *snd_soc_get_dai_via_args(struct of_phandle_args *dai_args)
3601{
3602 struct snd_soc_dai *dai;
3603 struct snd_soc_component *component;
3604
3605 mutex_lock(&client_mutex);
3606 for_each_component(component) {
3607 for_each_component_dais(component, dai)
3608 if (snd_soc_is_match_dai_args(dai->driver->dai_args, dai_args))
3609 goto found;
3610 }
3611 dai = NULL;
3612found:
3613 mutex_unlock(&client_mutex);
3614 return dai;
3615}
3616EXPORT_SYMBOL_GPL(snd_soc_get_dai_via_args);
3617
3618static void __snd_soc_of_put_component(struct snd_soc_dai_link_component *component)
3619{
3620 if (component->of_node) {
3621 of_node_put(component->of_node);
3622 component->of_node = NULL;
3623 }
3624}
3625
3626static int __snd_soc_of_get_dai_link_component_alloc(
3627 struct device *dev, struct device_node *of_node,
3628 struct snd_soc_dai_link_component **ret_component,
3629 int *ret_num)
3630{
3631 struct snd_soc_dai_link_component *component;
3632 int num;
3633
3634 /* Count the number of CPUs/CODECs */
3635 num = of_count_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells");
3636 if (num <= 0) {
3637 if (num == -ENOENT)
3638 dev_err(dev, "No 'sound-dai' property\n");
3639 else
3640 dev_err(dev, "Bad phandle in 'sound-dai'\n");
3641 return num;
3642 }
3643 component = devm_kcalloc(dev, num, sizeof(*component), GFP_KERNEL);
3644 if (!component)
3645 return -ENOMEM;
3646
3647 *ret_component = component;
3648 *ret_num = num;
3649
3650 return 0;
3651}
3652
3653/*
3654 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3655 * @dai_link: DAI link
3656 *
3657 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3658 */
3659void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3660{
3661 struct snd_soc_dai_link_component *component;
3662 int index;
3663
3664 for_each_link_codecs(dai_link, index, component)
3665 __snd_soc_of_put_component(component);
3666}
3667EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3668
3669/*
3670 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3671 * @dev: Card device
3672 * @of_node: Device node
3673 * @dai_link: DAI link
3674 *
3675 * Builds an array of CODEC DAI components from the DAI link property
3676 * 'sound-dai'.
3677 * The array is set in the DAI link and the number of DAIs is set accordingly.
3678 * The device nodes in the array (of_node) must be dereferenced by calling
3679 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3680 *
3681 * Returns 0 for success
3682 */
3683int snd_soc_of_get_dai_link_codecs(struct device *dev,
3684 struct device_node *of_node,
3685 struct snd_soc_dai_link *dai_link)
3686{
3687 struct snd_soc_dai_link_component *component;
3688 int index, ret;
3689
3690 ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3691 &dai_link->codecs, &dai_link->num_codecs);
3692 if (ret < 0)
3693 return ret;
3694
3695 /* Parse the list */
3696 for_each_link_codecs(dai_link, index, component) {
3697 ret = snd_soc_of_get_dlc(of_node, NULL, component, index);
3698 if (ret)
3699 goto err;
3700 }
3701 return 0;
3702err:
3703 snd_soc_of_put_dai_link_codecs(dai_link);
3704 dai_link->codecs = NULL;
3705 dai_link->num_codecs = 0;
3706 return ret;
3707}
3708EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3709
3710/*
3711 * snd_soc_of_put_dai_link_cpus - Dereference device nodes in the codecs array
3712 * @dai_link: DAI link
3713 *
3714 * Dereference device nodes acquired by snd_soc_of_get_dai_link_cpus().
3715 */
3716void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link)
3717{
3718 struct snd_soc_dai_link_component *component;
3719 int index;
3720
3721 for_each_link_cpus(dai_link, index, component)
3722 __snd_soc_of_put_component(component);
3723}
3724EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_cpus);
3725
3726/*
3727 * snd_soc_of_get_dai_link_cpus - Parse a list of CPU DAIs in the devicetree
3728 * @dev: Card device
3729 * @of_node: Device node
3730 * @dai_link: DAI link
3731 *
3732 * Is analogous to snd_soc_of_get_dai_link_codecs but parses a list of CPU DAIs
3733 * instead.
3734 *
3735 * Returns 0 for success
3736 */
3737int snd_soc_of_get_dai_link_cpus(struct device *dev,
3738 struct device_node *of_node,
3739 struct snd_soc_dai_link *dai_link)
3740{
3741 struct snd_soc_dai_link_component *component;
3742 int index, ret;
3743
3744 /* Count the number of CPUs */
3745 ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3746 &dai_link->cpus, &dai_link->num_cpus);
3747 if (ret < 0)
3748 return ret;
3749
3750 /* Parse the list */
3751 for_each_link_cpus(dai_link, index, component) {
3752 ret = snd_soc_of_get_dlc(of_node, NULL, component, index);
3753 if (ret)
3754 goto err;
3755 }
3756 return 0;
3757err:
3758 snd_soc_of_put_dai_link_cpus(dai_link);
3759 dai_link->cpus = NULL;
3760 dai_link->num_cpus = 0;
3761 return ret;
3762}
3763EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_cpus);
3764
3765static int __init snd_soc_init(void)
3766{
3767 int ret;
3768
3769 snd_soc_debugfs_init();
3770 ret = snd_soc_util_init();
3771 if (ret)
3772 goto err_util_init;
3773
3774 ret = platform_driver_register(&soc_driver);
3775 if (ret)
3776 goto err_register;
3777 return 0;
3778
3779err_register:
3780 snd_soc_util_exit();
3781err_util_init:
3782 snd_soc_debugfs_exit();
3783 return ret;
3784}
3785module_init(snd_soc_init);
3786
3787static void __exit snd_soc_exit(void)
3788{
3789 snd_soc_util_exit();
3790 snd_soc_debugfs_exit();
3791
3792 platform_driver_unregister(&soc_driver);
3793}
3794module_exit(snd_soc_exit);
3795
3796/* Module information */
3797MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3798MODULE_DESCRIPTION("ALSA SoC Core");
3799MODULE_LICENSE("GPL");
3800MODULE_ALIAS("platform:soc-audio");