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