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