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