sound/soc/soc-core.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 //
   3 // soc-core.c  --  ALSA SoC Audio Layer
   4 //
   5 // Copyright 2005 Wolfson Microelectronics PLC.
   6 // Copyright 2005 Openedhand Ltd.
   7 // Copyright (C) 2010 Slimlogic Ltd.
   8 // Copyright (C) 2010 Texas Instruments Inc.
   9 //
  10 // Author: Liam Girdwood <lrg@slimlogic.co.uk>
  11 //         with code, comments and ideas from :-
  12 //         Richard Purdie <richard@openedhand.com>
  13 //
  14 //  TODO:
  15 //   o Add hw rules to enforce rates, etc.
  16 //   o More testing with other codecs/machines.
  17 //   o Add more codecs and platforms to ensure good API coverage.
  18 //   o Support TDM on PCM and I2S
  19
  20 #include <linux/module.h>
  21 #include <linux/moduleparam.h>
  22 #include <linux/init.h>
  23 #include <linux/delay.h>
  24 #include <linux/pm.h>
  25 #include <linux/bitops.h>
  26 #include <linux/debugfs.h>
  27 #include <linux/platform_device.h>
  28 #include <linux/pinctrl/consumer.h>
  29 #include <linux/ctype.h>
  30 #include <linux/slab.h>
  31 #include <linux/of.h>
  32 #include <linux/of_graph.h>
  33 #include <linux/dmi.h>
  34 #include <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                         if (snd_soc_component_is_dummy(component) && component->num_dai)
1024                                 continue;
1025
1026                         snd_soc_rtd_add_component(rtd, component);
1027                 }
1028         }
1029
1030         return 0;
1031
1032 _err_defer:
1033         snd_soc_remove_pcm_runtime(card, rtd);
1034         return -EPROBE_DEFER;
1035 }
1036 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtime);
1037
1038 static void snd_soc_runtime_get_dai_fmt(struct snd_soc_pcm_runtime *rtd)
1039 {
1040         struct snd_soc_dai_link *dai_link = rtd->dai_link;
1041         struct snd_soc_dai *dai, *not_used;
1042         struct device *dev = rtd->dev;
1043         u64 pos, possible_fmt;
1044         unsigned int mask = 0, dai_fmt = 0;
1045         int i, j, priority, pri, until;
1046
1047         /*
1048          * Get selectable format from each DAIs.
1049          *
1050          ****************************
1051          *            NOTE
1052          * Using .auto_selectable_formats is not mandatory,
1053          * we can select format manually from Sound Card.
1054          * When use it, driver should list well tested format only.
1055          ****************************
1056          *
1057          * ex)
1058          *      auto_selectable_formats (= SND_SOC_POSSIBLE_xxx)
1059          *               (A)     (B)     (C)
1060          *      DAI0_: { 0x000F, 0x00F0, 0x0F00 };
1061          *      DAI1 : { 0xF000, 0x0F00 };
1062          *               (X)     (Y)
1063          *
1064          * "until" will be 3 in this case (MAX array size from DAI0 and DAI1)
1065          * Here is dev_dbg() message and comments
1066          *
1067          * priority = 1
1068          * DAI0: (pri, fmt) = (1, 000000000000000F) // 1st check (A) DAI1 is not selected
1069          * DAI1: (pri, fmt) = (0, 0000000000000000) //               Necessary Waste
1070          * DAI0: (pri, fmt) = (1, 000000000000000F) // 2nd check (A)
1071          * DAI1: (pri, fmt) = (1, 000000000000F000) //           (X)
1072          * priority = 2
1073          * DAI0: (pri, fmt) = (2, 00000000000000FF) // 3rd check (A) + (B)
1074          * DAI1: (pri, fmt) = (1, 000000000000F000) //           (X)
1075          * DAI0: (pri, fmt) = (2, 00000000000000FF) // 4th check (A) + (B)
1076          * DAI1: (pri, fmt) = (2, 000000000000FF00) //           (X) + (Y)
1077          * priority = 3
1078          * DAI0: (pri, fmt) = (3, 0000000000000FFF) // 5th check (A) + (B) + (C)
1079          * DAI1: (pri, fmt) = (2, 000000000000FF00) //           (X) + (Y)
1080          * found auto selected format: 0000000000000F00
1081          */
1082         until = snd_soc_dai_get_fmt_max_priority(rtd);
1083         for (priority = 1; priority <= until; priority++) {
1084
1085                 dev_dbg(dev, "priority = %d\n", priority);
1086                 for_each_rtd_dais(rtd, j, not_used) {
1087
1088                         possible_fmt = ULLONG_MAX;
1089                         for_each_rtd_dais(rtd, i, dai) {
1090                                 u64 fmt = 0;
1091
1092                                 pri = (j >= i) ? priority : priority - 1;
1093                                 fmt = snd_soc_dai_get_fmt(dai, pri);
1094                                 dev_dbg(dev, "%s: (pri, fmt) = (%d, %016llX)\n", dai->name, pri, fmt);
1095                                 possible_fmt &= fmt;
1096                         }
1097                         if (possible_fmt)
1098                                 goto found;
1099                 }
1100         }
1101         /* Not Found */
1102         return;
1103 found:
1104         dev_dbg(dev, "found auto selected format: %016llX\n", possible_fmt);
1105
1106         /*
1107          * convert POSSIBLE_DAIFMT to DAIFMT
1108          *
1109          * Some basic/default settings on each is defined as 0.
1110          * see
1111          *      SND_SOC_DAIFMT_NB_NF
1112          *      SND_SOC_DAIFMT_GATED
1113          *
1114          * SND_SOC_DAIFMT_xxx_MASK can't notice it if Sound Card specify
1115          * these value, and will be overwrite to auto selected value.
1116          *
1117          * To avoid such issue, loop from 63 to 0 here.
1118          * Small number of SND_SOC_POSSIBLE_xxx will be Hi priority.
1119          * Basic/Default settings of each part and aboves are defined
1120          * as Hi priority (= small number) of SND_SOC_POSSIBLE_xxx.
1121          */
1122         for (i = 63; i >= 0; i--) {
1123                 pos = 1ULL << i;
1124                 switch (possible_fmt & pos) {
1125                 /*
1126                  * for format
1127                  */
1128                 case SND_SOC_POSSIBLE_DAIFMT_I2S:
1129                 case SND_SOC_POSSIBLE_DAIFMT_RIGHT_J:
1130                 case SND_SOC_POSSIBLE_DAIFMT_LEFT_J:
1131                 case SND_SOC_POSSIBLE_DAIFMT_DSP_A:
1132                 case SND_SOC_POSSIBLE_DAIFMT_DSP_B:
1133                 case SND_SOC_POSSIBLE_DAIFMT_AC97:
1134                 case SND_SOC_POSSIBLE_DAIFMT_PDM:
1135                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_FORMAT_MASK) | i;
1136                         break;
1137                 /*
1138                  * for clock
1139                  */
1140                 case SND_SOC_POSSIBLE_DAIFMT_CONT:
1141                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_CONT;
1142                         break;
1143                 case SND_SOC_POSSIBLE_DAIFMT_GATED:
1144                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_GATED;
1145                         break;
1146                 /*
1147                  * for clock invert
1148                  */
1149                 case SND_SOC_POSSIBLE_DAIFMT_NB_NF:
1150                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_NF;
1151                         break;
1152                 case SND_SOC_POSSIBLE_DAIFMT_NB_IF:
1153                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_IF;
1154                         break;
1155                 case SND_SOC_POSSIBLE_DAIFMT_IB_NF:
1156                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_NF;
1157                         break;
1158                 case SND_SOC_POSSIBLE_DAIFMT_IB_IF:
1159                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_IF;
1160                         break;
1161                 /*
1162                  * for clock provider / consumer
1163                  */
1164                 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFP:
1165                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFP;
1166                         break;
1167                 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFP:
1168                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFP;
1169                         break;
1170                 case SND_SOC_POSSIBLE_DAIFMT_CBP_CFC:
1171                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFC;
1172                         break;
1173                 case SND_SOC_POSSIBLE_DAIFMT_CBC_CFC:
1174                         dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFC;
1175                         break;
1176                 }
1177         }
1178
1179         /*
1180          * Some driver might have very complex limitation.
1181          * In such case, user want to auto-select non-limitation part,
1182          * and want to manually specify complex part.
1183          *
1184          * Or for example, if both CPU and Codec can be clock provider,
1185          * but because of its quality, user want to specify it manually.
1186          *
1187          * Use manually specified settings if sound card did.
1188          */
1189         if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK))
1190                 mask |= SND_SOC_DAIFMT_FORMAT_MASK;
1191         if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_MASK))
1192                 mask |= SND_SOC_DAIFMT_CLOCK_MASK;
1193         if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_INV_MASK))
1194                 mask |= SND_SOC_DAIFMT_INV_MASK;
1195         if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK))
1196                 mask |= SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
1197
1198         dai_link->dai_fmt |= (dai_fmt & mask);
1199 }
1200
1201 /**
1202  * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1203  * @rtd: The runtime for which the DAI link format should be changed
1204  * @dai_fmt: The new DAI link format
1205  *
1206  * This function updates the DAI link format for all DAIs connected to the DAI
1207  * link for the specified runtime.
1208  *
1209  * Note: For setups with a static format set the dai_fmt field in the
1210  * corresponding snd_dai_link struct instead of using this function.
1211  *
1212  * Returns 0 on success, otherwise a negative error code.
1213  */
1214 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1215                                 unsigned int dai_fmt)
1216 {
1217         struct snd_soc_dai *cpu_dai;
1218         struct snd_soc_dai *codec_dai;
1219         unsigned int i;
1220         int ret;
1221
1222         if (!dai_fmt)
1223                 return 0;
1224
1225         for_each_rtd_codec_dais(rtd, i, codec_dai) {
1226                 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1227                 if (ret != 0 && ret != -ENOTSUPP)
1228                         return ret;
1229         }
1230
1231         /* Flip the polarity for the "CPU" end of link */
1232         dai_fmt = snd_soc_daifmt_clock_provider_flipped(dai_fmt);
1233
1234         for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1235                 ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1236                 if (ret != 0 && ret != -ENOTSUPP)
1237                         return ret;
1238         }
1239
1240         return 0;
1241 }
1242 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1243
1244 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1245                                 struct snd_soc_pcm_runtime *rtd)
1246 {
1247         struct snd_soc_dai_link *dai_link = rtd->dai_link;
1248         struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
1249         struct snd_soc_component *component;
1250         int ret, num, i;
1251
1252         /* do machine specific initialization */
1253         ret = snd_soc_link_init(rtd);
1254         if (ret < 0)
1255                 return ret;
1256
1257         snd_soc_runtime_get_dai_fmt(rtd);
1258         ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1259         if (ret)
1260                 return ret;
1261
1262         /* add DPCM sysfs entries */
1263         soc_dpcm_debugfs_add(rtd);
1264
1265         num = rtd->num;
1266
1267         /*
1268          * most drivers will register their PCMs using DAI link ordering but
1269          * topology based drivers can use the DAI link id field to set PCM
1270          * device number and then use rtd + a base offset of the BEs.
1271          */
1272         for_each_rtd_components(rtd, i, component) {
1273                 if (!component->driver->use_dai_pcm_id)
1274                         continue;
1275
1276                 if (rtd->dai_link->no_pcm)
1277                         num += component->driver->be_pcm_base;
1278                 else
1279                         num = rtd->dai_link->id;
1280         }
1281
1282         /* create compress_device if possible */
1283         ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1284         if (ret != -ENOTSUPP)
1285                 return ret;
1286
1287         /* create the pcm */
1288         ret = soc_new_pcm(rtd, num);
1289         if (ret < 0) {
1290                 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1291                         dai_link->stream_name, ret);
1292                 return ret;
1293         }
1294
1295         return snd_soc_pcm_dai_new(rtd);
1296 }
1297
1298 static void soc_set_name_prefix(struct snd_soc_card *card,
1299                                 struct snd_soc_component *component)
1300 {
1301         struct device_node *of_node = soc_component_to_node(component);
1302         const char *str;
1303         int ret, i;
1304
1305         for (i = 0; i < card->num_configs; i++) {
1306                 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1307
1308                 if (snd_soc_is_matching_component(&map->dlc, component) &&
1309                     map->name_prefix) {
1310                         component->name_prefix = map->name_prefix;
1311                         return;
1312                 }
1313         }
1314
1315         /*
1316          * If there is no configuration table or no match in the table,
1317          * check if a prefix is provided in the node
1318          */
1319         ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1320         if (ret < 0)
1321                 return;
1322
1323         component->name_prefix = str;
1324 }
1325
1326 static void soc_remove_component(struct snd_soc_component *component,
1327                                  int probed)
1328 {
1329
1330         if (!component->card)
1331                 return;
1332
1333         if (probed)
1334                 snd_soc_component_remove(component);
1335
1336         list_del_init(&component->card_list);
1337         snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1338         soc_cleanup_component_debugfs(component);
1339         component->card = NULL;
1340         snd_soc_component_module_put_when_remove(component);
1341 }
1342
1343 static int soc_probe_component(struct snd_soc_card *card,
1344                                struct snd_soc_component *component)
1345 {
1346         struct snd_soc_dapm_context *dapm =
1347                 snd_soc_component_get_dapm(component);
1348         struct snd_soc_dai *dai;
1349         int probed = 0;
1350         int ret;
1351
1352         if (snd_soc_component_is_dummy(component))
1353                 return 0;
1354
1355         if (component->card) {
1356                 if (component->card != card) {
1357                         dev_err(component->dev,
1358                                 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1359                                 card->name, component->card->name);
1360                         return -ENODEV;
1361                 }
1362                 return 0;
1363         }
1364
1365         ret = snd_soc_component_module_get_when_probe(component);
1366         if (ret < 0)
1367                 return ret;
1368
1369         component->card = card;
1370         soc_set_name_prefix(card, component);
1371
1372         soc_init_component_debugfs(component);
1373
1374         snd_soc_dapm_init(dapm, card, component);
1375
1376         ret = snd_soc_dapm_new_controls(dapm,
1377                                         component->driver->dapm_widgets,
1378                                         component->driver->num_dapm_widgets);
1379
1380         if (ret != 0) {
1381                 dev_err(component->dev,
1382                         "Failed to create new controls %d\n", ret);
1383                 goto err_probe;
1384         }
1385
1386         for_each_component_dais(component, dai) {
1387                 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1388                 if (ret != 0) {
1389                         dev_err(component->dev,
1390                                 "Failed to create DAI widgets %d\n", ret);
1391                         goto err_probe;
1392                 }
1393         }
1394
1395         ret = snd_soc_component_probe(component);
1396         if (ret < 0)
1397                 goto err_probe;
1398
1399         WARN(dapm->idle_bias_off &&
1400              dapm->bias_level != SND_SOC_BIAS_OFF,
1401              "codec %s can not start from non-off bias with idle_bias_off==1\n",
1402              component->name);
1403         probed = 1;
1404
1405         /*
1406          * machine specific init
1407          * see
1408          *      snd_soc_component_set_aux()
1409          */
1410         ret = snd_soc_component_init(component);
1411         if (ret < 0)
1412                 goto err_probe;
1413
1414         ret = snd_soc_add_component_controls(component,
1415                                              component->driver->controls,
1416                                              component->driver->num_controls);
1417         if (ret < 0)
1418                 goto err_probe;
1419
1420         ret = snd_soc_dapm_add_routes(dapm,
1421                                       component->driver->dapm_routes,
1422                                       component->driver->num_dapm_routes);
1423         if (ret < 0) {
1424                 if (card->disable_route_checks) {
1425                         dev_info(card->dev,
1426                                  "%s: disable_route_checks set, ignoring errors on add_routes\n",
1427                                  __func__);
1428                 } else {
1429                         dev_err(card->dev,
1430                                 "%s: snd_soc_dapm_add_routes failed: %d\n",
1431                                 __func__, ret);
1432                         goto err_probe;
1433                 }
1434         }
1435
1436         /* see for_each_card_components */
1437         list_add(&component->card_list, &card->component_dev_list);
1438
1439 err_probe:
1440         if (ret < 0)
1441                 soc_remove_component(component, probed);
1442
1443         return ret;
1444 }
1445
1446 static void soc_remove_link_dais(struct snd_soc_card *card)
1447 {
1448         struct snd_soc_pcm_runtime *rtd;
1449         int order;
1450
1451         for_each_comp_order(order) {
1452                 for_each_card_rtds(card, rtd) {
1453                         /* remove all rtd connected DAIs in good order */
1454                         snd_soc_pcm_dai_remove(rtd, order);
1455                 }
1456         }
1457 }
1458
1459 static int soc_probe_link_dais(struct snd_soc_card *card)
1460 {
1461         struct snd_soc_pcm_runtime *rtd;
1462         int order, ret;
1463
1464         for_each_comp_order(order) {
1465                 for_each_card_rtds(card, rtd) {
1466
1467                         dev_dbg(card->dev,
1468                                 "ASoC: probe %s dai link %d late %d\n",
1469                                 card->name, rtd->num, order);
1470
1471                         /* probe all rtd connected DAIs in good order */
1472                         ret = snd_soc_pcm_dai_probe(rtd, order);
1473                         if (ret)
1474                                 return ret;
1475                 }
1476         }
1477
1478         return 0;
1479 }
1480
1481 static void soc_remove_link_components(struct snd_soc_card *card)
1482 {
1483         struct snd_soc_component *component;
1484         struct snd_soc_pcm_runtime *rtd;
1485         int i, order;
1486
1487         for_each_comp_order(order) {
1488                 for_each_card_rtds(card, rtd) {
1489                         for_each_rtd_components(rtd, i, component) {
1490                                 if (component->driver->remove_order != order)
1491                                         continue;
1492
1493                                 soc_remove_component(component, 1);
1494                         }
1495                 }
1496         }
1497 }
1498
1499 static int soc_probe_link_components(struct snd_soc_card *card)
1500 {
1501         struct snd_soc_component *component;
1502         struct snd_soc_pcm_runtime *rtd;
1503         int i, ret, order;
1504
1505         for_each_comp_order(order) {
1506                 for_each_card_rtds(card, rtd) {
1507                         for_each_rtd_components(rtd, i, component) {
1508                                 if (component->driver->probe_order != order)
1509                                         continue;
1510
1511                                 ret = soc_probe_component(card, component);
1512                                 if (ret < 0)
1513                                         return ret;
1514                         }
1515                 }
1516         }
1517
1518         return 0;
1519 }
1520
1521 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1522 {
1523         struct snd_soc_component *component, *_component;
1524
1525         for_each_card_auxs_safe(card, component, _component) {
1526                 /* for snd_soc_component_init() */
1527                 snd_soc_component_set_aux(component, NULL);
1528                 list_del(&component->card_aux_list);
1529         }
1530 }
1531
1532 static int soc_bind_aux_dev(struct snd_soc_card *card)
1533 {
1534         struct snd_soc_component *component;
1535         struct snd_soc_aux_dev *aux;
1536         int i;
1537
1538         for_each_card_pre_auxs(card, i, aux) {
1539                 /* codecs, usually analog devices */
1540                 component = soc_find_component(&aux->dlc);
1541                 if (!component)
1542                         return -EPROBE_DEFER;
1543
1544                 /* for snd_soc_component_init() */
1545                 snd_soc_component_set_aux(component, aux);
1546                 /* see for_each_card_auxs */
1547                 list_add(&component->card_aux_list, &card->aux_comp_list);
1548         }
1549         return 0;
1550 }
1551
1552 static int soc_probe_aux_devices(struct snd_soc_card *card)
1553 {
1554         struct snd_soc_component *component;
1555         int order;
1556         int ret;
1557
1558         for_each_comp_order(order) {
1559                 for_each_card_auxs(card, component) {
1560                         if (component->driver->probe_order != order)
1561                                 continue;
1562
1563                         ret = soc_probe_component(card, component);
1564                         if (ret < 0)
1565                                 return ret;
1566                 }
1567         }
1568
1569         return 0;
1570 }
1571
1572 static void soc_remove_aux_devices(struct snd_soc_card *card)
1573 {
1574         struct snd_soc_component *comp, *_comp;
1575         int order;
1576
1577         for_each_comp_order(order) {
1578                 for_each_card_auxs_safe(card, comp, _comp) {
1579                         if (comp->driver->remove_order == order)
1580                                 soc_remove_component(comp, 1);
1581                 }
1582         }
1583 }
1584
1585 #ifdef CONFIG_DMI
1586 /*
1587  * If a DMI filed contain strings in this blacklist (e.g.
1588  * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1589  * as invalid and dropped when setting the card long name from DMI info.
1590  */
1591 static const char * const dmi_blacklist[] = {
1592         "To be filled by OEM",
1593         "TBD by OEM",
1594         "Default String",
1595         "Board Manufacturer",
1596         "Board Vendor Name",
1597         "Board Product Name",
1598         NULL,   /* terminator */
1599 };
1600
1601 /*
1602  * Trim special characters, and replace '-' with '_' since '-' is used to
1603  * separate different DMI fields in the card long name. Only number and
1604  * alphabet characters and a few separator characters are kept.
1605  */
1606 static void cleanup_dmi_name(char *name)
1607 {
1608         int i, j = 0;
1609
1610         for (i = 0; name[i]; i++) {
1611                 if (isalnum(name[i]) || (name[i] == '.')
1612                     || (name[i] == '_'))
1613                         name[j++] = name[i];
1614                 else if (name[i] == '-')
1615                         name[j++] = '_';
1616         }
1617
1618         name[j] = '\0';
1619 }
1620
1621 /*
1622  * Check if a DMI field is valid, i.e. not containing any string
1623  * in the black list.
1624  */
1625 static int is_dmi_valid(const char *field)
1626 {
1627         int i = 0;
1628
1629         while (dmi_blacklist[i]) {
1630                 if (strstr(field, dmi_blacklist[i]))
1631                         return 0;
1632                 i++;
1633         }
1634
1635         return 1;
1636 }
1637
1638 /*
1639  * Append a string to card->dmi_longname with character cleanups.
1640  */
1641 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1642 {
1643         char *dst = card->dmi_longname;
1644         size_t dst_len = sizeof(card->dmi_longname);
1645         size_t len;
1646
1647         len = strlen(dst);
1648         snprintf(dst + len, dst_len - len, "-%s", str);
1649
1650         len++;  /* skip the separator "-" */
1651         if (len < dst_len)
1652                 cleanup_dmi_name(dst + len);
1653 }
1654
1655 /**
1656  * snd_soc_set_dmi_name() - Register DMI names to card
1657  * @card: The card to register DMI names
1658  * @flavour: The flavour "differentiator" for the card amongst its peers.
1659  *
1660  * An Intel machine driver may be used by many different devices but are
1661  * difficult for userspace to differentiate, since machine drivers ususally
1662  * use their own name as the card short name and leave the card long name
1663  * blank. To differentiate such devices and fix bugs due to lack of
1664  * device-specific configurations, this function allows DMI info to be used
1665  * as the sound card long name, in the format of
1666  * "vendor-product-version-board"
1667  * (Character '-' is used to separate different DMI fields here).
1668  * This will help the user space to load the device-specific Use Case Manager
1669  * (UCM) configurations for the card.
1670  *
1671  * Possible card long names may be:
1672  * DellInc.-XPS139343-01-0310JH
1673  * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1674  * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1675  *
1676  * This function also supports flavoring the card longname to provide
1677  * the extra differentiation, like "vendor-product-version-board-flavor".
1678  *
1679  * We only keep number and alphabet characters and a few separator characters
1680  * in the card long name since UCM in the user space uses the card long names
1681  * as card configuration directory names and AudoConf cannot support special
1682  * charactors like SPACE.
1683  *
1684  * Returns 0 on success, otherwise a negative error code.
1685  */
1686 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1687 {
1688         const char *vendor, *product, *board;
1689
1690         if (card->long_name)
1691                 return 0; /* long name already set by driver or from DMI */
1692
1693         if (!dmi_available)
1694                 return 0;
1695
1696         /* make up dmi long name as: vendor-product-version-board */
1697         vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1698         if (!vendor || !is_dmi_valid(vendor)) {
1699                 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1700                 return 0;
1701         }
1702
1703         snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1704         cleanup_dmi_name(card->dmi_longname);
1705
1706         product = dmi_get_system_info(DMI_PRODUCT_NAME);
1707         if (product && is_dmi_valid(product)) {
1708                 const char *product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1709
1710                 append_dmi_string(card, product);
1711
1712                 /*
1713                  * some vendors like Lenovo may only put a self-explanatory
1714                  * name in the product version field
1715                  */
1716                 if (product_version && is_dmi_valid(product_version))
1717                         append_dmi_string(card, product_version);
1718         }
1719
1720         board = dmi_get_system_info(DMI_BOARD_NAME);
1721         if (board && is_dmi_valid(board)) {
1722                 if (!product || strcasecmp(board, product))
1723                         append_dmi_string(card, board);
1724         } else if (!product) {
1725                 /* fall back to using legacy name */
1726                 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1727                 return 0;
1728         }
1729
1730         /* Add flavour to dmi long name */
1731         if (flavour)
1732                 append_dmi_string(card, flavour);
1733
1734         /* set the card long name */
1735         card->long_name = card->dmi_longname;
1736
1737         return 0;
1738 }
1739 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1740 #endif /* CONFIG_DMI */
1741
1742 static void soc_check_tplg_fes(struct snd_soc_card *card)
1743 {
1744         struct snd_soc_component *component;
1745         const struct snd_soc_component_driver *comp_drv;
1746         struct snd_soc_dai_link *dai_link;
1747         int i;
1748
1749         for_each_component(component) {
1750
1751                 /* does this component override BEs ? */
1752                 if (!component->driver->ignore_machine)
1753                         continue;
1754
1755                 /* for this machine ? */
1756                 if (!strcmp(component->driver->ignore_machine,
1757                             card->dev->driver->name))
1758                         goto match;
1759                 if (strcmp(component->driver->ignore_machine,
1760                            dev_name(card->dev)))
1761                         continue;
1762 match:
1763                 /* machine matches, so override the rtd data */
1764                 for_each_card_prelinks(card, i, dai_link) {
1765
1766                         /* ignore this FE */
1767                         if (dai_link->dynamic) {
1768                                 dai_link->ignore = true;
1769                                 continue;
1770                         }
1771
1772                         dev_dbg(card->dev, "info: override BE DAI link %s\n",
1773                                 card->dai_link[i].name);
1774
1775                         /* override platform component */
1776                         if (!dai_link->platforms) {
1777                                 dev_err(card->dev, "init platform error");
1778                                 continue;
1779                         }
1780
1781                         if (component->dev->of_node)
1782                                 dai_link->platforms->of_node = component->dev->of_node;
1783                         else
1784                                 dai_link->platforms->name = component->name;
1785
1786                         /* convert non BE into BE */
1787                         if (!dai_link->no_pcm) {
1788                                 dai_link->no_pcm = 1;
1789
1790                                 if (dai_link->dpcm_playback)
1791                                         dev_warn(card->dev,
1792                                                  "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1793                                                  dai_link->name);
1794                                 if (dai_link->dpcm_capture)
1795                                         dev_warn(card->dev,
1796                                                  "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1797                                                  dai_link->name);
1798
1799                                 /* convert normal link into DPCM one */
1800                                 if (!(dai_link->dpcm_playback ||
1801                                       dai_link->dpcm_capture)) {
1802                                         dai_link->dpcm_playback = !dai_link->capture_only;
1803                                         dai_link->dpcm_capture = !dai_link->playback_only;
1804                                 }
1805                         }
1806
1807                         /*
1808                          * override any BE fixups
1809                          * see
1810                          *      snd_soc_link_be_hw_params_fixup()
1811                          */
1812                         dai_link->be_hw_params_fixup =
1813                                 component->driver->be_hw_params_fixup;
1814
1815                         /*
1816                          * most BE links don't set stream name, so set it to
1817                          * dai link name if it's NULL to help bind widgets.
1818                          */
1819                         if (!dai_link->stream_name)
1820                                 dai_link->stream_name = dai_link->name;
1821                 }
1822
1823                 /* Inform userspace we are using alternate topology */
1824                 if (component->driver->topology_name_prefix) {
1825
1826                         /* topology shortname created? */
1827                         if (!card->topology_shortname_created) {
1828                                 comp_drv = component->driver;
1829
1830                                 snprintf(card->topology_shortname, 32, "%s-%s",
1831                                          comp_drv->topology_name_prefix,
1832                                          card->name);
1833                                 card->topology_shortname_created = true;
1834                         }
1835
1836                         /* use topology shortname */
1837                         card->name = card->topology_shortname;
1838                 }
1839         }
1840 }
1841
1842 #define soc_setup_card_name(card, name, name1, name2) \
1843         __soc_setup_card_name(card, name, sizeof(name), name1, name2)
1844 static void __soc_setup_card_name(struct snd_soc_card *card,
1845                                   char *name, int len,
1846                                   const char *name1, const char *name2)
1847 {
1848         const char *src = name1 ? name1 : name2;
1849         int i;
1850
1851         snprintf(name, len, "%s", src);
1852
1853         if (name != card->snd_card->driver)
1854                 return;
1855
1856         /*
1857          * Name normalization (driver field)
1858          *
1859          * The driver name is somewhat special, as it's used as a key for
1860          * searches in the user-space.
1861          *
1862          * ex)
1863          *      "abcd??efg" -> "abcd__efg"
1864          */
1865         for (i = 0; i < len; i++) {
1866                 switch (name[i]) {
1867                 case '_':
1868                 case '-':
1869                 case '\0':
1870                         break;
1871                 default:
1872                         if (!isalnum(name[i]))
1873                                 name[i] = '_';
1874                         break;
1875                 }
1876         }
1877
1878         /*
1879          * The driver field should contain a valid string from the user view.
1880          * The wrapping usually does not work so well here. Set a smaller string
1881          * in the specific ASoC driver.
1882          */
1883         if (strlen(src) > len - 1)
1884                 dev_err(card->dev, "ASoC: driver name too long '%s' -> '%s'\n", src, name);
1885 }
1886
1887 static void soc_cleanup_card_resources(struct snd_soc_card *card)
1888 {
1889         struct snd_soc_pcm_runtime *rtd, *n;
1890
1891         if (card->snd_card)
1892                 snd_card_disconnect_sync(card->snd_card);
1893
1894         snd_soc_dapm_shutdown(card);
1895
1896         /* remove and free each DAI */
1897         soc_remove_link_dais(card);
1898         soc_remove_link_components(card);
1899
1900         for_each_card_rtds_safe(card, rtd, n)
1901                 snd_soc_remove_pcm_runtime(card, rtd);
1902
1903         /* remove auxiliary devices */
1904         soc_remove_aux_devices(card);
1905         soc_unbind_aux_dev(card);
1906
1907         snd_soc_dapm_free(&card->dapm);
1908         soc_cleanup_card_debugfs(card);
1909
1910         /* remove the card */
1911         snd_soc_card_remove(card);
1912
1913         if (card->snd_card) {
1914                 snd_card_free(card->snd_card);
1915                 card->snd_card = NULL;
1916         }
1917 }
1918
1919 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1920 {
1921         if (card->instantiated) {
1922                 card->instantiated = false;
1923                 snd_soc_flush_all_delayed_work(card);
1924
1925                 soc_cleanup_card_resources(card);
1926                 if (!unregister)
1927                         list_add(&card->list, &unbind_card_list);
1928         } else {
1929                 if (unregister)
1930                         list_del(&card->list);
1931         }
1932 }
1933
1934 static int snd_soc_bind_card(struct snd_soc_card *card)
1935 {
1936         struct snd_soc_pcm_runtime *rtd;
1937         struct snd_soc_component *component;
1938         struct snd_soc_dai_link *dai_link;
1939         int ret, i;
1940
1941         mutex_lock(&client_mutex);
1942         mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1943
1944         snd_soc_dapm_init(&card->dapm, card, NULL);
1945
1946         /* check whether any platform is ignore machine FE and using topology */
1947         soc_check_tplg_fes(card);
1948
1949         /* bind aux_devs too */
1950         ret = soc_bind_aux_dev(card);
1951         if (ret < 0)
1952                 goto probe_end;
1953
1954         /* add predefined DAI links to the list */
1955         card->num_rtd = 0;
1956         for_each_card_prelinks(card, i, dai_link) {
1957                 ret = snd_soc_add_pcm_runtime(card, dai_link);
1958                 if (ret < 0)
1959                         goto probe_end;
1960         }
1961
1962         /* card bind complete so register a sound card */
1963         ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1964                         card->owner, 0, &card->snd_card);
1965         if (ret < 0) {
1966                 dev_err(card->dev,
1967                         "ASoC: can't create sound card for card %s: %d\n",
1968                         card->name, ret);
1969                 goto probe_end;
1970         }
1971
1972         soc_init_card_debugfs(card);
1973
1974         soc_resume_init(card);
1975
1976         ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1977                                         card->num_dapm_widgets);
1978         if (ret < 0)
1979                 goto probe_end;
1980
1981         ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1982                                         card->num_of_dapm_widgets);
1983         if (ret < 0)
1984                 goto probe_end;
1985
1986         /* initialise the sound card only once */
1987         ret = snd_soc_card_probe(card);
1988         if (ret < 0)
1989                 goto probe_end;
1990
1991         /* probe all components used by DAI links on this card */
1992         ret = soc_probe_link_components(card);
1993         if (ret < 0) {
1994                 dev_err(card->dev,
1995                         "ASoC: failed to instantiate card %d\n", ret);
1996                 goto probe_end;
1997         }
1998
1999         /* probe auxiliary components */
2000         ret = soc_probe_aux_devices(card);
2001         if (ret < 0) {
2002                 dev_err(card->dev,
2003                         "ASoC: failed to probe aux component %d\n", ret);
2004                 goto probe_end;
2005         }
2006
2007         /* probe all DAI links on this card */
2008         ret = soc_probe_link_dais(card);
2009         if (ret < 0) {
2010                 dev_err(card->dev,
2011                         "ASoC: failed to instantiate card %d\n", ret);
2012                 goto probe_end;
2013         }
2014
2015         for_each_card_rtds(card, rtd) {
2016                 ret = soc_init_pcm_runtime(card, rtd);
2017                 if (ret < 0)
2018                         goto probe_end;
2019         }
2020
2021         snd_soc_dapm_link_dai_widgets(card);
2022         snd_soc_dapm_connect_dai_link_widgets(card);
2023
2024         ret = snd_soc_add_card_controls(card, card->controls,
2025                                         card->num_controls);
2026         if (ret < 0)
2027                 goto probe_end;
2028
2029         ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2030                                       card->num_dapm_routes);
2031         if (ret < 0) {
2032                 if (card->disable_route_checks) {
2033                         dev_info(card->dev,
2034                                  "%s: disable_route_checks set, ignoring errors on add_routes\n",
2035                                  __func__);
2036                 } else {
2037                         dev_err(card->dev,
2038                                  "%s: snd_soc_dapm_add_routes failed: %d\n",
2039                                  __func__, ret);
2040                         goto probe_end;
2041                 }
2042         }
2043
2044         ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2045                                       card->num_of_dapm_routes);
2046         if (ret < 0)
2047                 goto probe_end;
2048
2049         /* try to set some sane longname if DMI is available */
2050         snd_soc_set_dmi_name(card, NULL);
2051
2052         soc_setup_card_name(card, card->snd_card->shortname,
2053                             card->name, NULL);
2054         soc_setup_card_name(card, card->snd_card->longname,
2055                             card->long_name, card->name);
2056         soc_setup_card_name(card, card->snd_card->driver,
2057                             card->driver_name, card->name);
2058
2059         if (card->components) {
2060                 /* the current implementation of snd_component_add() accepts */
2061                 /* multiple components in the string separated by space, */
2062                 /* but the string collision (identical string) check might */
2063                 /* not work correctly */
2064                 ret = snd_component_add(card->snd_card, card->components);
2065                 if (ret < 0) {
2066                         dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
2067                                 card->name, ret);
2068                         goto probe_end;
2069                 }
2070         }
2071
2072         ret = snd_soc_card_late_probe(card);
2073         if (ret < 0)
2074                 goto probe_end;
2075
2076         snd_soc_dapm_new_widgets(card);
2077         snd_soc_card_fixup_controls(card);
2078
2079         ret = snd_card_register(card->snd_card);
2080         if (ret < 0) {
2081                 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2082                                 ret);
2083                 goto probe_end;
2084         }
2085
2086         card->instantiated = 1;
2087         dapm_mark_endpoints_dirty(card);
2088         snd_soc_dapm_sync(&card->dapm);
2089
2090         /* deactivate pins to sleep state */
2091         for_each_card_components(card, component)
2092                 if (!snd_soc_component_active(component))
2093                         pinctrl_pm_select_sleep_state(component->dev);
2094
2095 probe_end:
2096         if (ret < 0)
2097                 soc_cleanup_card_resources(card);
2098
2099         mutex_unlock(&card->mutex);
2100         mutex_unlock(&client_mutex);
2101
2102         return ret;
2103 }
2104
2105 /* probes a new socdev */
2106 static int soc_probe(struct platform_device *pdev)
2107 {
2108         struct snd_soc_card *card = platform_get_drvdata(pdev);
2109
2110         /*
2111          * no card, so machine driver should be registering card
2112          * we should not be here in that case so ret error
2113          */
2114         if (!card)
2115                 return -EINVAL;
2116
2117         dev_warn(&pdev->dev,
2118                  "ASoC: machine %s should use snd_soc_register_card()\n",
2119                  card->name);
2120
2121         /* Bodge while we unpick instantiation */
2122         card->dev = &pdev->dev;
2123
2124         return devm_snd_soc_register_card(&pdev->dev, card);
2125 }
2126
2127 int snd_soc_poweroff(struct device *dev)
2128 {
2129         struct snd_soc_card *card = dev_get_drvdata(dev);
2130         struct snd_soc_component *component;
2131
2132         if (!card->instantiated)
2133                 return 0;
2134
2135         /*
2136          * Flush out pmdown_time work - we actually do want to run it
2137          * now, we're shutting down so no imminent restart.
2138          */
2139         snd_soc_flush_all_delayed_work(card);
2140
2141         snd_soc_dapm_shutdown(card);
2142
2143         /* deactivate pins to sleep state */
2144         for_each_card_components(card, component)
2145                 pinctrl_pm_select_sleep_state(component->dev);
2146
2147         return 0;
2148 }
2149 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2150
2151 const struct dev_pm_ops snd_soc_pm_ops = {
2152         .suspend = snd_soc_suspend,
2153         .resume = snd_soc_resume,
2154         .freeze = snd_soc_suspend,
2155         .thaw = snd_soc_resume,
2156         .poweroff = snd_soc_poweroff,
2157         .restore = snd_soc_resume,
2158 };
2159 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2160
2161 /* ASoC platform driver */
2162 static struct platform_driver soc_driver = {
2163         .driver         = {
2164                 .name           = "soc-audio",
2165                 .pm             = &snd_soc_pm_ops,
2166         },
2167         .probe          = soc_probe,
2168 };
2169
2170 /**
2171  * snd_soc_cnew - create new control
2172  * @_template: control template
2173  * @data: control private data
2174  * @long_name: control long name
2175  * @prefix: control name prefix
2176  *
2177  * Create a new mixer control from a template control.
2178  *
2179  * Returns 0 for success, else error.
2180  */
2181 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2182                                   void *data, const char *long_name,
2183                                   const char *prefix)
2184 {
2185         struct snd_kcontrol_new template;
2186         struct snd_kcontrol *kcontrol;
2187         char *name = NULL;
2188
2189         memcpy(&template, _template, sizeof(template));
2190         template.index = 0;
2191
2192         if (!long_name)
2193                 long_name = template.name;
2194
2195         if (prefix) {
2196                 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2197                 if (!name)
2198                         return NULL;
2199
2200                 template.name = name;
2201         } else {
2202                 template.name = long_name;
2203         }
2204
2205         kcontrol = snd_ctl_new1(&template, data);
2206
2207         kfree(name);
2208
2209         return kcontrol;
2210 }
2211 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2212
2213 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2214         const struct snd_kcontrol_new *controls, int num_controls,
2215         const char *prefix, void *data)
2216 {
2217         int i;
2218
2219         for (i = 0; i < num_controls; i++) {
2220                 const struct snd_kcontrol_new *control = &controls[i];
2221                 int err = snd_ctl_add(card, snd_soc_cnew(control, data,
2222                                                          control->name, prefix));
2223                 if (err < 0) {
2224                         dev_err(dev, "ASoC: Failed to add %s: %d\n",
2225                                 control->name, err);
2226                         return err;
2227                 }
2228         }
2229
2230         return 0;
2231 }
2232
2233 /**
2234  * snd_soc_add_component_controls - Add an array of controls to a component.
2235  *
2236  * @component: Component to add controls to
2237  * @controls: Array of controls to add
2238  * @num_controls: Number of elements in the array
2239  *
2240  * Return: 0 for success, else error.
2241  */
2242 int snd_soc_add_component_controls(struct snd_soc_component *component,
2243         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2244 {
2245         struct snd_card *card = component->card->snd_card;
2246
2247         return snd_soc_add_controls(card, component->dev, controls,
2248                         num_controls, component->name_prefix, component);
2249 }
2250 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2251
2252 /**
2253  * snd_soc_add_card_controls - add an array of controls to a SoC card.
2254  * Convenience function to add a list of controls.
2255  *
2256  * @soc_card: SoC card to add controls to
2257  * @controls: array of controls to add
2258  * @num_controls: number of elements in the array
2259  *
2260  * Return 0 for success, else error.
2261  */
2262 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2263         const struct snd_kcontrol_new *controls, int num_controls)
2264 {
2265         struct snd_card *card = soc_card->snd_card;
2266
2267         return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2268                         NULL, soc_card);
2269 }
2270 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2271
2272 /**
2273  * snd_soc_add_dai_controls - add an array of controls to a DAI.
2274  * Convienience function to add a list of controls.
2275  *
2276  * @dai: DAI to add controls to
2277  * @controls: array of controls to add
2278  * @num_controls: number of elements in the array
2279  *
2280  * Return 0 for success, else error.
2281  */
2282 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2283         const struct snd_kcontrol_new *controls, int num_controls)
2284 {
2285         struct snd_card *card = dai->component->card->snd_card;
2286
2287         return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2288                         NULL, dai);
2289 }
2290 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2291
2292 /**
2293  * snd_soc_register_card - Register a card with the ASoC core
2294  *
2295  * @card: Card to register
2296  *
2297  */
2298 int snd_soc_register_card(struct snd_soc_card *card)
2299 {
2300         if (!card->name || !card->dev)
2301                 return -EINVAL;
2302
2303         dev_set_drvdata(card->dev, card);
2304
2305         INIT_LIST_HEAD(&card->widgets);
2306         INIT_LIST_HEAD(&card->paths);
2307         INIT_LIST_HEAD(&card->dapm_list);
2308         INIT_LIST_HEAD(&card->aux_comp_list);
2309         INIT_LIST_HEAD(&card->component_dev_list);
2310         INIT_LIST_HEAD(&card->list);
2311         INIT_LIST_HEAD(&card->rtd_list);
2312         INIT_LIST_HEAD(&card->dapm_dirty);
2313         INIT_LIST_HEAD(&card->dobj_list);
2314
2315         card->instantiated = 0;
2316         mutex_init(&card->mutex);
2317         mutex_init(&card->dapm_mutex);
2318         mutex_init(&card->pcm_mutex);
2319
2320         return snd_soc_bind_card(card);
2321 }
2322 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2323
2324 /**
2325  * snd_soc_unregister_card - Unregister a card with the ASoC core
2326  *
2327  * @card: Card to unregister
2328  *
2329  */
2330 void snd_soc_unregister_card(struct snd_soc_card *card)
2331 {
2332         mutex_lock(&client_mutex);
2333         snd_soc_unbind_card(card, true);
2334         mutex_unlock(&client_mutex);
2335         dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2336 }
2337 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2338
2339 /*
2340  * Simplify DAI link configuration by removing ".-1" from device names
2341  * and sanitizing names.
2342  */
2343 static char *fmt_single_name(struct device *dev, int *id)
2344 {
2345         const char *devname = dev_name(dev);
2346         char *found, *name;
2347         unsigned int id1, id2;
2348
2349         if (devname == NULL)
2350                 return NULL;
2351
2352         name = devm_kstrdup(dev, devname, GFP_KERNEL);
2353         if (!name)
2354                 return NULL;
2355
2356         /* are we a "%s.%d" name (platform and SPI components) */
2357         found = strstr(name, dev->driver->name);
2358         if (found) {
2359                 /* get ID */
2360                 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2361
2362                         /* discard ID from name if ID == -1 */
2363                         if (*id == -1)
2364                                 found[strlen(dev->driver->name)] = '\0';
2365                 }
2366
2367         /* I2C component devices are named "bus-addr" */
2368         } else if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2369
2370                 /* create unique ID number from I2C addr and bus */
2371                 *id = ((id1 & 0xffff) << 16) + id2;
2372
2373                 devm_kfree(dev, name);
2374
2375                 /* sanitize component name for DAI link creation */
2376                 name = devm_kasprintf(dev, GFP_KERNEL, "%s.%s", dev->driver->name, devname);
2377         } else {
2378                 *id = 0;
2379         }
2380
2381         return name;
2382 }
2383
2384 /*
2385  * Simplify DAI link naming for single devices with multiple DAIs by removing
2386  * any ".-1" and using the DAI name (instead of device name).
2387  */
2388 static inline char *fmt_multiple_name(struct device *dev,
2389                 struct snd_soc_dai_driver *dai_drv)
2390 {
2391         if (dai_drv->name == NULL) {
2392                 dev_err(dev,
2393                         "ASoC: error - multiple DAI %s registered with no name\n",
2394                         dev_name(dev));
2395                 return NULL;
2396         }
2397
2398         return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2399 }
2400
2401 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2402 {
2403         dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2404         list_del(&dai->list);
2405 }
2406 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2407
2408 /**
2409  * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2410  *
2411  * @component: The component the DAIs are registered for
2412  * @dai_drv: DAI driver to use for the DAI
2413  * @legacy_dai_naming: if %true, use legacy single-name format;
2414  *      if %false, use multiple-name format;
2415  *
2416  * Topology can use this API to register DAIs when probing a component.
2417  * These DAIs's widgets will be freed in the card cleanup and the DAIs
2418  * will be freed in the component cleanup.
2419  */
2420 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2421                                          struct snd_soc_dai_driver *dai_drv,
2422                                          bool legacy_dai_naming)
2423 {
2424         struct device *dev = component->dev;
2425         struct snd_soc_dai *dai;
2426
2427         dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2428
2429         lockdep_assert_held(&client_mutex);
2430
2431         dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2432         if (dai == NULL)
2433                 return NULL;
2434
2435         /*
2436          * Back in the old days when we still had component-less DAIs,
2437          * instead of having a static name, component-less DAIs would
2438          * inherit the name of the parent device so it is possible to
2439          * register multiple instances of the DAI. We still need to keep
2440          * the same naming style even though those DAIs are not
2441          * component-less anymore.
2442          */
2443         if (legacy_dai_naming &&
2444             (dai_drv->id == 0 || dai_drv->name == NULL)) {
2445                 dai->name = fmt_single_name(dev, &dai->id);
2446         } else {
2447                 dai->name = fmt_multiple_name(dev, dai_drv);
2448                 if (dai_drv->id)
2449                         dai->id = dai_drv->id;
2450                 else
2451                         dai->id = component->num_dai;
2452         }
2453         if (!dai->name)
2454                 return NULL;
2455
2456         dai->component = component;
2457         dai->dev = dev;
2458         dai->driver = dai_drv;
2459
2460         /* see for_each_component_dais */
2461         list_add_tail(&dai->list, &component->dai_list);
2462         component->num_dai++;
2463
2464         dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2465         return dai;
2466 }
2467 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2468
2469 /**
2470  * snd_soc_unregister_dais - Unregister DAIs from the ASoC core
2471  *
2472  * @component: The component for which the DAIs should be unregistered
2473  */
2474 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2475 {
2476         struct snd_soc_dai *dai, *_dai;
2477
2478         for_each_component_dais_safe(component, dai, _dai)
2479                 snd_soc_unregister_dai(dai);
2480 }
2481
2482 /**
2483  * snd_soc_register_dais - Register a DAI with the ASoC core
2484  *
2485  * @component: The component the DAIs are registered for
2486  * @dai_drv: DAI driver to use for the DAIs
2487  * @count: Number of DAIs
2488  */
2489 static int snd_soc_register_dais(struct snd_soc_component *component,
2490                                  struct snd_soc_dai_driver *dai_drv,
2491                                  size_t count)
2492 {
2493         struct snd_soc_dai *dai;
2494         unsigned int i;
2495         int ret;
2496
2497         for (i = 0; i < count; i++) {
2498                 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2499                                            component->driver->legacy_dai_naming);
2500                 if (dai == NULL) {
2501                         ret = -ENOMEM;
2502                         goto err;
2503                 }
2504         }
2505
2506         return 0;
2507
2508 err:
2509         snd_soc_unregister_dais(component);
2510
2511         return ret;
2512 }
2513
2514 #define ENDIANNESS_MAP(name) \
2515         (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2516 static u64 endianness_format_map[] = {
2517         ENDIANNESS_MAP(S16_),
2518         ENDIANNESS_MAP(U16_),
2519         ENDIANNESS_MAP(S24_),
2520         ENDIANNESS_MAP(U24_),
2521         ENDIANNESS_MAP(S32_),
2522         ENDIANNESS_MAP(U32_),
2523         ENDIANNESS_MAP(S24_3),
2524         ENDIANNESS_MAP(U24_3),
2525         ENDIANNESS_MAP(S20_3),
2526         ENDIANNESS_MAP(U20_3),
2527         ENDIANNESS_MAP(S18_3),
2528         ENDIANNESS_MAP(U18_3),
2529         ENDIANNESS_MAP(FLOAT_),
2530         ENDIANNESS_MAP(FLOAT64_),
2531         ENDIANNESS_MAP(IEC958_SUBFRAME_),
2532 };
2533
2534 /*
2535  * Fix up the DAI formats for endianness: codecs don't actually see
2536  * the endianness of the data but we're using the CPU format
2537  * definitions which do need to include endianness so we ensure that
2538  * codec DAIs always have both big and little endian variants set.
2539  */
2540 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2541 {
2542         int i;
2543
2544         for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2545                 if (stream->formats & endianness_format_map[i])
2546                         stream->formats |= endianness_format_map[i];
2547 }
2548
2549 static void snd_soc_try_rebind_card(void)
2550 {
2551         struct snd_soc_card *card, *c;
2552
2553         list_for_each_entry_safe(card, c, &unbind_card_list, list)
2554                 if (!snd_soc_bind_card(card))
2555                         list_del(&card->list);
2556 }
2557
2558 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2559 {
2560         struct snd_soc_card *card = component->card;
2561
2562         snd_soc_unregister_dais(component);
2563
2564         if (card)
2565                 snd_soc_unbind_card(card, false);
2566
2567         list_del(&component->list);
2568 }
2569
2570 int snd_soc_component_initialize(struct snd_soc_component *component,
2571                                  const struct snd_soc_component_driver *driver,
2572                                  struct device *dev)
2573 {
2574         INIT_LIST_HEAD(&component->dai_list);
2575         INIT_LIST_HEAD(&component->dobj_list);
2576         INIT_LIST_HEAD(&component->card_list);
2577         INIT_LIST_HEAD(&component->list);
2578         mutex_init(&component->io_mutex);
2579
2580         component->name = fmt_single_name(dev, &component->id);
2581         if (!component->name) {
2582                 dev_err(dev, "ASoC: Failed to allocate name\n");
2583                 return -ENOMEM;
2584         }
2585
2586         component->dev          = dev;
2587         component->driver       = driver;
2588
2589 #ifdef CONFIG_DEBUG_FS
2590         if (!component->debugfs_prefix)
2591                 component->debugfs_prefix = driver->debugfs_prefix;
2592 #endif
2593
2594         return 0;
2595 }
2596 EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2597
2598 int snd_soc_add_component(struct snd_soc_component *component,
2599                           struct snd_soc_dai_driver *dai_drv,
2600                           int num_dai)
2601 {
2602         int ret;
2603         int i;
2604
2605         mutex_lock(&client_mutex);
2606
2607         if (component->driver->endianness) {
2608                 for (i = 0; i < num_dai; i++) {
2609                         convert_endianness_formats(&dai_drv[i].playback);
2610                         convert_endianness_formats(&dai_drv[i].capture);
2611                 }
2612         }
2613
2614         ret = snd_soc_register_dais(component, dai_drv, num_dai);
2615         if (ret < 0) {
2616                 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2617                         ret);
2618                 goto err_cleanup;
2619         }
2620
2621         if (!component->driver->write && !component->driver->read) {
2622                 if (!component->regmap)
2623                         component->regmap = dev_get_regmap(component->dev,
2624                                                            NULL);
2625                 if (component->regmap)
2626                         snd_soc_component_setup_regmap(component);
2627         }
2628
2629         /* see for_each_component */
2630         list_add(&component->list, &component_list);
2631
2632 err_cleanup:
2633         if (ret < 0)
2634                 snd_soc_del_component_unlocked(component);
2635
2636         mutex_unlock(&client_mutex);
2637
2638         if (ret == 0)
2639                 snd_soc_try_rebind_card();
2640
2641         return ret;
2642 }
2643 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2644
2645 int snd_soc_register_component(struct device *dev,
2646                         const struct snd_soc_component_driver *component_driver,
2647                         struct snd_soc_dai_driver *dai_drv,
2648                         int num_dai)
2649 {
2650         struct snd_soc_component *component;
2651         int ret;
2652
2653         component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2654         if (!component)
2655                 return -ENOMEM;
2656
2657         ret = snd_soc_component_initialize(component, component_driver, dev);
2658         if (ret < 0)
2659                 return ret;
2660
2661         return snd_soc_add_component(component, dai_drv, num_dai);
2662 }
2663 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2664
2665 /**
2666  * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2667  * from the ASoC core
2668  *
2669  * @dev: The device to unregister
2670  * @component_driver: The component driver to unregister
2671  */
2672 void snd_soc_unregister_component_by_driver(struct device *dev,
2673                                             const struct snd_soc_component_driver *component_driver)
2674 {
2675         struct snd_soc_component *component;
2676
2677         if (!component_driver)
2678                 return;
2679
2680         mutex_lock(&client_mutex);
2681         component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2682         if (!component)
2683                 goto out;
2684
2685         snd_soc_del_component_unlocked(component);
2686
2687 out:
2688         mutex_unlock(&client_mutex);
2689 }
2690 EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2691
2692 /**
2693  * snd_soc_unregister_component - Unregister all related component
2694  * from the ASoC core
2695  *
2696  * @dev: The device to unregister
2697  */
2698 void snd_soc_unregister_component(struct device *dev)
2699 {
2700         mutex_lock(&client_mutex);
2701         while (1) {
2702                 struct snd_soc_component *component = snd_soc_lookup_component_nolocked(dev, NULL);
2703
2704                 if (!component)
2705                         break;
2706
2707                 snd_soc_del_component_unlocked(component);
2708         }
2709         mutex_unlock(&client_mutex);
2710 }
2711 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2712
2713 /* Retrieve a card's name from device tree */
2714 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2715                                const char *propname)
2716 {
2717         struct device_node *np;
2718         int ret;
2719
2720         if (!card->dev) {
2721                 pr_err("card->dev is not set before calling %s\n", __func__);
2722                 return -EINVAL;
2723         }
2724
2725         np = card->dev->of_node;
2726
2727         ret = of_property_read_string_index(np, propname, 0, &card->name);
2728         /*
2729          * EINVAL means the property does not exist. This is fine providing
2730          * card->name was previously set, which is checked later in
2731          * snd_soc_register_card.
2732          */
2733         if (ret < 0 && ret != -EINVAL) {
2734                 dev_err(card->dev,
2735                         "ASoC: Property '%s' could not be read: %d\n",
2736                         propname, ret);
2737                 return ret;
2738         }
2739
2740         return 0;
2741 }
2742 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2743
2744 static const struct snd_soc_dapm_widget simple_widgets[] = {
2745         SND_SOC_DAPM_MIC("Microphone", NULL),
2746         SND_SOC_DAPM_LINE("Line", NULL),
2747         SND_SOC_DAPM_HP("Headphone", NULL),
2748         SND_SOC_DAPM_SPK("Speaker", NULL),
2749 };
2750
2751 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2752                                           const char *propname)
2753 {
2754         struct device_node *np = card->dev->of_node;
2755         struct snd_soc_dapm_widget *widgets;
2756         const char *template, *wname;
2757         int i, j, num_widgets;
2758
2759         num_widgets = of_property_count_strings(np, propname);
2760         if (num_widgets < 0) {
2761                 dev_err(card->dev,
2762                         "ASoC: Property '%s' does not exist\n", propname);
2763                 return -EINVAL;
2764         }
2765         if (!num_widgets) {
2766                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2767                         propname);
2768                 return -EINVAL;
2769         }
2770         if (num_widgets & 1) {
2771                 dev_err(card->dev,
2772                         "ASoC: Property '%s' length is not even\n", propname);
2773                 return -EINVAL;
2774         }
2775
2776         num_widgets /= 2;
2777
2778         widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2779                                GFP_KERNEL);
2780         if (!widgets) {
2781                 dev_err(card->dev,
2782                         "ASoC: Could not allocate memory for widgets\n");
2783                 return -ENOMEM;
2784         }
2785
2786         for (i = 0; i < num_widgets; i++) {
2787                 int ret = of_property_read_string_index(np, propname,
2788                                                         2 * i, &template);
2789                 if (ret) {
2790                         dev_err(card->dev,
2791                                 "ASoC: Property '%s' index %d read error:%d\n",
2792                                 propname, 2 * i, ret);
2793                         return -EINVAL;
2794                 }
2795
2796                 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2797                         if (!strncmp(template, simple_widgets[j].name,
2798                                      strlen(simple_widgets[j].name))) {
2799                                 widgets[i] = simple_widgets[j];
2800                                 break;
2801                         }
2802                 }
2803
2804                 if (j >= ARRAY_SIZE(simple_widgets)) {
2805                         dev_err(card->dev,
2806                                 "ASoC: DAPM widget '%s' is not supported\n",
2807                                 template);
2808                         return -EINVAL;
2809                 }
2810
2811                 ret = of_property_read_string_index(np, propname,
2812                                                     (2 * i) + 1,
2813                                                     &wname);
2814                 if (ret) {
2815                         dev_err(card->dev,
2816                                 "ASoC: Property '%s' index %d read error:%d\n",
2817                                 propname, (2 * i) + 1, ret);
2818                         return -EINVAL;
2819                 }
2820
2821                 widgets[i].name = wname;
2822         }
2823
2824         card->of_dapm_widgets = widgets;
2825         card->num_of_dapm_widgets = num_widgets;
2826
2827         return 0;
2828 }
2829 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2830
2831 int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop)
2832 {
2833         const unsigned int nb_controls_max = 16;
2834         const char **strings, *control_name;
2835         struct snd_kcontrol_new *controls;
2836         struct device *dev = card->dev;
2837         unsigned int i, nb_controls;
2838         int ret;
2839
2840         if (!of_property_read_bool(dev->of_node, prop))
2841                 return 0;
2842
2843         strings = devm_kcalloc(dev, nb_controls_max,
2844                                sizeof(*strings), GFP_KERNEL);
2845         if (!strings)
2846                 return -ENOMEM;
2847
2848         ret = of_property_read_string_array(dev->of_node, prop,
2849                                             strings, nb_controls_max);
2850         if (ret < 0)
2851                 return ret;
2852
2853         nb_controls = (unsigned int)ret;
2854
2855         controls = devm_kcalloc(dev, nb_controls,
2856                                 sizeof(*controls), GFP_KERNEL);
2857         if (!controls)
2858                 return -ENOMEM;
2859
2860         for (i = 0; i < nb_controls; i++) {
2861                 control_name = devm_kasprintf(dev, GFP_KERNEL,
2862                                               "%s Switch", strings[i]);
2863                 if (!control_name)
2864                         return -ENOMEM;
2865
2866                 controls[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
2867                 controls[i].name = control_name;
2868                 controls[i].info = snd_soc_dapm_info_pin_switch;
2869                 controls[i].get = snd_soc_dapm_get_pin_switch;
2870                 controls[i].put = snd_soc_dapm_put_pin_switch;
2871                 controls[i].private_value = (unsigned long)strings[i];
2872         }
2873
2874         card->controls = controls;
2875         card->num_controls = nb_controls;
2876
2877         return 0;
2878 }
2879 EXPORT_SYMBOL_GPL(snd_soc_of_parse_pin_switches);
2880
2881 int snd_soc_of_get_slot_mask(struct device_node *np,
2882                              const char *prop_name,
2883                              unsigned int *mask)
2884 {
2885         u32 val;
2886         const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2887         int i;
2888
2889         if (!of_slot_mask)
2890                 return 0;
2891         val /= sizeof(u32);
2892         for (i = 0; i < val; i++)
2893                 if (be32_to_cpup(&of_slot_mask[i]))
2894                         *mask |= (1 << i);
2895
2896         return val;
2897 }
2898 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2899
2900 int snd_soc_of_parse_tdm_slot(struct device_node *np,
2901                               unsigned int *tx_mask,
2902                               unsigned int *rx_mask,
2903                               unsigned int *slots,
2904                               unsigned int *slot_width)
2905 {
2906         u32 val;
2907         int ret;
2908
2909         if (tx_mask)
2910                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2911         if (rx_mask)
2912                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2913
2914         if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2915                 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2916                 if (ret)
2917                         return ret;
2918
2919                 if (slots)
2920                         *slots = val;
2921         }
2922
2923         if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2924                 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2925                 if (ret)
2926                         return ret;
2927
2928                 if (slot_width)
2929                         *slot_width = val;
2930         }
2931
2932         return 0;
2933 }
2934 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2935
2936 void snd_soc_of_parse_node_prefix(struct device_node *np,
2937                                   struct snd_soc_codec_conf *codec_conf,
2938                                   struct device_node *of_node,
2939                                   const char *propname)
2940 {
2941         const char *str;
2942         int ret;
2943
2944         ret = of_property_read_string(np, propname, &str);
2945         if (ret < 0) {
2946                 /* no prefix is not error */
2947                 return;
2948         }
2949
2950         codec_conf->dlc.of_node = of_node;
2951         codec_conf->name_prefix = str;
2952 }
2953 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2954
2955 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2956                                    const char *propname)
2957 {
2958         struct device_node *np = card->dev->of_node;
2959         int num_routes;
2960         struct snd_soc_dapm_route *routes;
2961         int i;
2962
2963         num_routes = of_property_count_strings(np, propname);
2964         if (num_routes < 0 || num_routes & 1) {
2965                 dev_err(card->dev,
2966                         "ASoC: Property '%s' does not exist or its length is not even\n",
2967                         propname);
2968                 return -EINVAL;
2969         }
2970         num_routes /= 2;
2971
2972         routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2973                               GFP_KERNEL);
2974         if (!routes) {
2975                 dev_err(card->dev,
2976                         "ASoC: Could not allocate DAPM route table\n");
2977                 return -ENOMEM;
2978         }
2979
2980         for (i = 0; i < num_routes; i++) {
2981                 int ret = of_property_read_string_index(np, propname,
2982                                                         2 * i, &routes[i].sink);
2983                 if (ret) {
2984                         dev_err(card->dev,
2985                                 "ASoC: Property '%s' index %d could not be read: %d\n",
2986                                 propname, 2 * i, ret);
2987                         return -EINVAL;
2988                 }
2989                 ret = of_property_read_string_index(np, propname,
2990                         (2 * i) + 1, &routes[i].source);
2991                 if (ret) {
2992                         dev_err(card->dev,
2993                                 "ASoC: Property '%s' index %d could not be read: %d\n",
2994                                 propname, (2 * i) + 1, ret);
2995                         return -EINVAL;
2996                 }
2997         }
2998
2999         card->num_of_dapm_routes = num_routes;
3000         card->of_dapm_routes = routes;
3001
3002         return 0;
3003 }
3004 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3005
3006 int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname)
3007 {
3008         struct device_node *node = card->dev->of_node;
3009         struct snd_soc_aux_dev *aux;
3010         int num, i;
3011
3012         num = of_count_phandle_with_args(node, propname, NULL);
3013         if (num == -ENOENT) {
3014                 return 0;
3015         } else if (num < 0) {
3016                 dev_err(card->dev, "ASOC: Property '%s' could not be read: %d\n",
3017                         propname, num);
3018                 return num;
3019         }
3020
3021         aux = devm_kcalloc(card->dev, num, sizeof(*aux), GFP_KERNEL);
3022         if (!aux)
3023                 return -ENOMEM;
3024         card->aux_dev = aux;
3025         card->num_aux_devs = num;
3026
3027         for_each_card_pre_auxs(card, i, aux) {
3028                 aux->dlc.of_node = of_parse_phandle(node, propname, i);
3029                 if (!aux->dlc.of_node)
3030                         return -EINVAL;
3031         }
3032
3033         return 0;
3034 }
3035 EXPORT_SYMBOL_GPL(snd_soc_of_parse_aux_devs);
3036
3037 unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt)
3038 {
3039         unsigned int inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
3040
3041         switch (dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
3042         case SND_SOC_DAIFMT_CBP_CFP:
3043                 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
3044                 break;
3045         case SND_SOC_DAIFMT_CBP_CFC:
3046                 inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
3047                 break;
3048         case SND_SOC_DAIFMT_CBC_CFP:
3049                 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
3050                 break;
3051         case SND_SOC_DAIFMT_CBC_CFC:
3052                 inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
3053                 break;
3054         }
3055
3056         return inv_dai_fmt;
3057 }
3058 EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_flipped);
3059
3060 unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame)
3061 {
3062         /*
3063          * bit_frame is return value from
3064          *      snd_soc_daifmt_parse_clock_provider_raw()
3065          */
3066
3067         /* Codec base */
3068         switch (bit_frame) {
3069         case 0x11:
3070                 return SND_SOC_DAIFMT_CBP_CFP;
3071         case 0x10:
3072                 return SND_SOC_DAIFMT_CBP_CFC;
3073         case 0x01:
3074                 return SND_SOC_DAIFMT_CBC_CFP;
3075         default:
3076                 return SND_SOC_DAIFMT_CBC_CFC;
3077         }
3078
3079         return 0;
3080 }
3081 EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_from_bitmap);
3082
3083 unsigned int snd_soc_daifmt_parse_format(struct device_node *np,
3084                                          const char *prefix)
3085 {
3086         int ret;
3087         char prop[128];
3088         unsigned int format = 0;
3089         int bit, frame;
3090         const char *str;
3091         struct {
3092                 char *name;
3093                 unsigned int val;
3094         } of_fmt_table[] = {
3095                 { "i2s",        SND_SOC_DAIFMT_I2S },
3096                 { "right_j",    SND_SOC_DAIFMT_RIGHT_J },
3097                 { "left_j",     SND_SOC_DAIFMT_LEFT_J },
3098                 { "dsp_a",      SND_SOC_DAIFMT_DSP_A },
3099                 { "dsp_b",      SND_SOC_DAIFMT_DSP_B },
3100                 { "ac97",       SND_SOC_DAIFMT_AC97 },
3101                 { "pdm",        SND_SOC_DAIFMT_PDM},
3102                 { "msb",        SND_SOC_DAIFMT_MSB },
3103                 { "lsb",        SND_SOC_DAIFMT_LSB },
3104         };
3105
3106         if (!prefix)
3107                 prefix = "";
3108
3109         /*
3110          * check "dai-format = xxx"
3111          * or    "[prefix]format = xxx"
3112          * SND_SOC_DAIFMT_FORMAT_MASK area
3113          */
3114         ret = of_property_read_string(np, "dai-format", &str);
3115         if (ret < 0) {
3116                 snprintf(prop, sizeof(prop), "%sformat", prefix);
3117                 ret = of_property_read_string(np, prop, &str);
3118         }
3119         if (ret == 0) {
3120                 int i;
3121
3122                 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3123                         if (strcmp(str, of_fmt_table[i].name) == 0) {
3124                                 format |= of_fmt_table[i].val;
3125                                 break;
3126                         }
3127                 }
3128         }
3129
3130         /*
3131          * check "[prefix]continuous-clock"
3132          * SND_SOC_DAIFMT_CLOCK_MASK area
3133          */
3134         snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3135         if (of_property_read_bool(np, prop))
3136                 format |= SND_SOC_DAIFMT_CONT;
3137         else
3138                 format |= SND_SOC_DAIFMT_GATED;
3139
3140         /*
3141          * check "[prefix]bitclock-inversion"
3142          * check "[prefix]frame-inversion"
3143          * SND_SOC_DAIFMT_INV_MASK area
3144          */
3145         snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3146         bit = !!of_get_property(np, prop, NULL);
3147
3148         snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3149         frame = !!of_get_property(np, prop, NULL);
3150
3151         switch ((bit << 4) + frame) {
3152         case 0x11:
3153                 format |= SND_SOC_DAIFMT_IB_IF;
3154                 break;
3155         case 0x10:
3156                 format |= SND_SOC_DAIFMT_IB_NF;
3157                 break;
3158         case 0x01:
3159                 format |= SND_SOC_DAIFMT_NB_IF;
3160                 break;
3161         default:
3162                 /* SND_SOC_DAIFMT_NB_NF is default */
3163                 break;
3164         }
3165
3166         return format;
3167 }
3168 EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_format);
3169
3170 unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
3171                                                      const char *prefix,
3172                                                      struct device_node **bitclkmaster,
3173                                                      struct device_node **framemaster)
3174 {
3175         char prop[128];
3176         unsigned int bit, frame;
3177
3178         if (!prefix)
3179                 prefix = "";
3180
3181         /*
3182          * check "[prefix]bitclock-master"
3183          * check "[prefix]frame-master"
3184          */
3185         snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3186         bit = !!of_get_property(np, prop, NULL);
3187         if (bit && bitclkmaster)
3188                 *bitclkmaster = of_parse_phandle(np, prop, 0);
3189
3190         snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3191         frame = !!of_get_property(np, prop, NULL);
3192         if (frame && framemaster)
3193                 *framemaster = of_parse_phandle(np, prop, 0);
3194
3195         /*
3196          * return bitmap.
3197          * It will be parameter of
3198          *      snd_soc_daifmt_clock_provider_from_bitmap()
3199          */
3200         return (bit << 4) + frame;
3201 }
3202 EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_clock_provider_raw);
3203
3204 int snd_soc_get_dai_id(struct device_node *ep)
3205 {
3206         struct snd_soc_component *component;
3207         struct snd_soc_dai_link_component dlc;
3208         int ret;
3209
3210         dlc.of_node     = of_graph_get_port_parent(ep);
3211         dlc.name        = NULL;
3212         /*
3213          * For example HDMI case, HDMI has video/sound port,
3214          * but ALSA SoC needs sound port number only.
3215          * Thus counting HDMI DT port/endpoint doesn't work.
3216          * Then, it should have .of_xlate_dai_id
3217          */
3218         ret = -ENOTSUPP;
3219         mutex_lock(&client_mutex);
3220         component = soc_find_component(&dlc);
3221         if (component)
3222                 ret = snd_soc_component_of_xlate_dai_id(component, ep);
3223         mutex_unlock(&client_mutex);
3224
3225         of_node_put(dlc.of_node);
3226
3227         return ret;
3228 }
3229 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3230
3231 int snd_soc_get_dai_name(const struct of_phandle_args *args,
3232                                 const char **dai_name)
3233 {
3234         struct snd_soc_component *pos;
3235         int ret = -EPROBE_DEFER;
3236
3237         mutex_lock(&client_mutex);
3238         for_each_component(pos) {
3239                 struct device_node *component_of_node = soc_component_to_node(pos);
3240
3241                 if (component_of_node != args->np || !pos->num_dai)
3242                         continue;
3243
3244                 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3245                 if (ret == -ENOTSUPP) {
3246                         struct snd_soc_dai *dai;
3247                         int id = -1;
3248
3249                         switch (args->args_count) {
3250                         case 0:
3251                                 id = 0; /* same as dai_drv[0] */
3252                                 break;
3253                         case 1:
3254                                 id = args->args[0];
3255                                 break;
3256                         default:
3257                                 /* not supported */
3258                                 break;
3259                         }
3260
3261                         if (id < 0 || id >= pos->num_dai) {
3262                                 ret = -EINVAL;
3263                                 continue;
3264                         }
3265
3266                         ret = 0;
3267
3268                         /* find target DAI */
3269                         for_each_component_dais(pos, dai) {
3270                                 if (id == 0)
3271                                         break;
3272                                 id--;
3273                         }
3274
3275                         *dai_name = dai->driver->name;
3276                         if (!*dai_name)
3277                                 *dai_name = pos->name;
3278                 } else if (ret) {
3279                         /*
3280                          * if another error than ENOTSUPP is returned go on and
3281                          * check if another component is provided with the same
3282                          * node. This may happen if a device provides several
3283                          * components
3284                          */
3285                         continue;
3286                 }
3287
3288                 break;
3289         }
3290         mutex_unlock(&client_mutex);
3291         return ret;
3292 }
3293 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3294
3295 int snd_soc_of_get_dai_name(struct device_node *of_node,
3296                             const char **dai_name)
3297 {
3298         struct of_phandle_args args;
3299         int ret;
3300
3301         ret = of_parse_phandle_with_args(of_node, "sound-dai",
3302                                          "#sound-dai-cells", 0, &args);
3303         if (ret)
3304                 return ret;
3305
3306         ret = snd_soc_get_dai_name(&args, dai_name);
3307
3308         of_node_put(args.np);
3309
3310         return ret;
3311 }
3312 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3313
3314 static void __snd_soc_of_put_component(struct snd_soc_dai_link_component *component)
3315 {
3316         if (component->of_node) {
3317                 of_node_put(component->of_node);
3318                 component->of_node = NULL;
3319         }
3320 }
3321
3322 static int __snd_soc_of_get_dai_link_component_alloc(
3323         struct device *dev, struct device_node *of_node,
3324         struct snd_soc_dai_link_component **ret_component,
3325         int *ret_num)
3326 {
3327         struct snd_soc_dai_link_component *component;
3328         int num;
3329
3330         /* Count the number of CPUs/CODECs */
3331         num = of_count_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells");
3332         if (num <= 0) {
3333                 if (num == -ENOENT)
3334                         dev_err(dev, "No 'sound-dai' property\n");
3335                 else
3336                         dev_err(dev, "Bad phandle in 'sound-dai'\n");
3337                 return num;
3338         }
3339         component = devm_kcalloc(dev, num, sizeof(*component), GFP_KERNEL);
3340         if (!component)
3341                 return -ENOMEM;
3342
3343         *ret_component  = component;
3344         *ret_num        = num;
3345
3346         return 0;
3347 }
3348
3349 static int __snd_soc_of_get_dai_link_component_parse(
3350         struct device_node *of_node,
3351         struct snd_soc_dai_link_component *component, int index)
3352 {
3353         struct of_phandle_args args;
3354         int ret;
3355
3356         ret = of_parse_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells",
3357                                          index, &args);
3358         if (ret)
3359                 return ret;
3360
3361         ret = snd_soc_get_dai_name(&args, &component->dai_name);
3362         if (ret < 0)
3363                 return ret;
3364
3365         component->of_node = args.np;
3366         return 0;
3367 }
3368
3369 /*
3370  * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3371  * @dai_link: DAI link
3372  *
3373  * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3374  */
3375 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3376 {
3377         struct snd_soc_dai_link_component *component;
3378         int index;
3379
3380         for_each_link_codecs(dai_link, index, component)
3381                 __snd_soc_of_put_component(component);
3382 }
3383 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3384
3385 /*
3386  * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3387  * @dev: Card device
3388  * @of_node: Device node
3389  * @dai_link: DAI link
3390  *
3391  * Builds an array of CODEC DAI components from the DAI link property
3392  * 'sound-dai'.
3393  * The array is set in the DAI link and the number of DAIs is set accordingly.
3394  * The device nodes in the array (of_node) must be dereferenced by calling
3395  * snd_soc_of_put_dai_link_codecs() on @dai_link.
3396  *
3397  * Returns 0 for success
3398  */
3399 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3400                                    struct device_node *of_node,
3401                                    struct snd_soc_dai_link *dai_link)
3402 {
3403         struct snd_soc_dai_link_component *component;
3404         int index, ret;
3405
3406         ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3407                                          &dai_link->codecs, &dai_link->num_codecs);
3408         if (ret < 0)
3409                 return ret;
3410
3411         /* Parse the list */
3412         for_each_link_codecs(dai_link, index, component) {
3413                 ret = __snd_soc_of_get_dai_link_component_parse(of_node, component, index);
3414                 if (ret)
3415                         goto err;
3416         }
3417         return 0;
3418 err:
3419         snd_soc_of_put_dai_link_codecs(dai_link);
3420         dai_link->codecs = NULL;
3421         dai_link->num_codecs = 0;
3422         return ret;
3423 }
3424 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3425
3426 /*
3427  * snd_soc_of_put_dai_link_cpus - Dereference device nodes in the codecs array
3428  * @dai_link: DAI link
3429  *
3430  * Dereference device nodes acquired by snd_soc_of_get_dai_link_cpus().
3431  */
3432 void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link)
3433 {
3434         struct snd_soc_dai_link_component *component;
3435         int index;
3436
3437         for_each_link_cpus(dai_link, index, component)
3438                 __snd_soc_of_put_component(component);
3439 }
3440 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_cpus);
3441
3442 /*
3443  * snd_soc_of_get_dai_link_cpus - Parse a list of CPU DAIs in the devicetree
3444  * @dev: Card device
3445  * @of_node: Device node
3446  * @dai_link: DAI link
3447  *
3448  * Is analogous to snd_soc_of_get_dai_link_codecs but parses a list of CPU DAIs
3449  * instead.
3450  *
3451  * Returns 0 for success
3452  */
3453 int snd_soc_of_get_dai_link_cpus(struct device *dev,
3454                                  struct device_node *of_node,
3455                                  struct snd_soc_dai_link *dai_link)
3456 {
3457         struct snd_soc_dai_link_component *component;
3458         int index, ret;
3459
3460         /* Count the number of CPUs */
3461         ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3462                                          &dai_link->cpus, &dai_link->num_cpus);
3463         if (ret < 0)
3464                 return ret;
3465
3466         /* Parse the list */
3467         for_each_link_cpus(dai_link, index, component) {
3468                 ret = __snd_soc_of_get_dai_link_component_parse(of_node, component, index);
3469                 if (ret)
3470                         goto err;
3471         }
3472         return 0;
3473 err:
3474         snd_soc_of_put_dai_link_cpus(dai_link);
3475         dai_link->cpus = NULL;
3476         dai_link->num_cpus = 0;
3477         return ret;
3478 }
3479 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_cpus);
3480
3481 static int __init snd_soc_init(void)
3482 {
3483         int ret;
3484
3485         snd_soc_debugfs_init();
3486         ret = snd_soc_util_init();
3487         if (ret)
3488                 goto err_util_init;
3489
3490         ret = platform_driver_register(&soc_driver);
3491         if (ret)
3492                 goto err_register;
3493         return 0;
3494
3495 err_register:
3496         snd_soc_util_exit();
3497 err_util_init:
3498         snd_soc_debugfs_exit();
3499         return ret;
3500 }
3501 module_init(snd_soc_init);
3502
3503 static void __exit snd_soc_exit(void)
3504 {
3505         snd_soc_util_exit();
3506         snd_soc_debugfs_exit();
3507
3508         platform_driver_unregister(&soc_driver);
3509 }
3510 module_exit(snd_soc_exit);
3511
3512 /* Module information */
3513 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3514 MODULE_DESCRIPTION("ALSA SoC Core");
3515 MODULE_LICENSE("GPL");
3516 MODULE_ALIAS("platform:soc-audio");