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