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