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