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