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