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 <sound/core.h>
  35 #include <sound/jack.h>
  36 #include <sound/pcm.h>
  37 #include <sound/pcm_params.h>
  38 #include <sound/soc.h>
  39 #include <sound/soc-dpcm.h>
  40 #include <sound/soc-topology.h>
  41 #include <sound/initval.h>
  42
  43 #define CREATE_TRACE_POINTS
  44 #include <trace/events/asoc.h>
  45
  46 #define NAME_SIZE       32
  47
  48 #ifdef CONFIG_DEBUG_FS
  49 struct dentry *snd_soc_debugfs_root;
  50 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
  51 #endif
  52
  53 static DEFINE_MUTEX(client_mutex);
  54 static LIST_HEAD(component_list);
  55 static LIST_HEAD(unbind_card_list);
  56
  57 #define for_each_component(component)                   \
  58         list_for_each_entry(component, &component_list, list)
  59
  60 /*
  61  * This is a timeout to do a DAPM powerdown after a stream is closed().
  62  * It can be used to eliminate pops between different playback streams, e.g.
  63  * between two audio tracks.
  64  */
  65 static int pmdown_time = 5000;
  66 module_param(pmdown_time, int, 0);
  67 MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
  68
  69 /*
  70  * If a DMI filed contain strings in this blacklist (e.g.
  71  * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
  72  * as invalid and dropped when setting the card long name from DMI info.
  73  */
  74 static const char * const dmi_blacklist[] = {
  75         "To be filled by OEM",
  76         "TBD by OEM",
  77         "Default String",
  78         "Board Manufacturer",
  79         "Board Vendor Name",
  80         "Board Product Name",
  81         NULL,   /* terminator */
  82 };
  83
  84 static ssize_t pmdown_time_show(struct device *dev,
  85                                 struct device_attribute *attr, char *buf)
  86 {
  87         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
  88
  89         return sprintf(buf, "%ld\n", rtd->pmdown_time);
  90 }
  91
  92 static ssize_t pmdown_time_set(struct device *dev,
  93                                struct device_attribute *attr,
  94                                const char *buf, size_t count)
  95 {
  96         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
  97         int ret;
  98
  99         ret = kstrtol(buf, 10, &rtd->pmdown_time);
 100         if (ret)
 101                 return ret;
 102
 103         return count;
 104 }
 105
 106 static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
 107
 108 static struct attribute *soc_dev_attrs[] = {
 109         &dev_attr_pmdown_time.attr,
 110         NULL
 111 };
 112
 113 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
 114                                        struct attribute *attr, int idx)
 115 {
 116         struct device *dev = kobj_to_dev(kobj);
 117         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 118
 119         if (attr == &dev_attr_pmdown_time.attr)
 120                 return attr->mode; /* always visible */
 121         return rtd->num_codecs ? attr->mode : 0; /* enabled only with codec */
 122 }
 123
 124 static const struct attribute_group soc_dapm_dev_group = {
 125         .attrs = soc_dapm_dev_attrs,
 126         .is_visible = soc_dev_attr_is_visible,
 127 };
 128
 129 static const struct attribute_group soc_dev_group = {
 130         .attrs = soc_dev_attrs,
 131         .is_visible = soc_dev_attr_is_visible,
 132 };
 133
 134 static const struct attribute_group *soc_dev_attr_groups[] = {
 135         &soc_dapm_dev_group,
 136         &soc_dev_group,
 137         NULL
 138 };
 139
 140 #ifdef CONFIG_DEBUG_FS
 141 static void soc_init_component_debugfs(struct snd_soc_component *component)
 142 {
 143         if (!component->card->debugfs_card_root)
 144                 return;
 145
 146         if (component->debugfs_prefix) {
 147                 char *name;
 148
 149                 name = kasprintf(GFP_KERNEL, "%s:%s",
 150                         component->debugfs_prefix, component->name);
 151                 if (name) {
 152                         component->debugfs_root = debugfs_create_dir(name,
 153                                 component->card->debugfs_card_root);
 154                         kfree(name);
 155                 }
 156         } else {
 157                 component->debugfs_root = debugfs_create_dir(component->name,
 158                                 component->card->debugfs_card_root);
 159         }
 160
 161         if (!component->debugfs_root) {
 162                 dev_warn(component->dev,
 163                         "ASoC: Failed to create component debugfs directory\n");
 164                 return;
 165         }
 166
 167         snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
 168                 component->debugfs_root);
 169 }
 170
 171 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
 172 {
 173         debugfs_remove_recursive(component->debugfs_root);
 174 }
 175
 176 static int dai_list_show(struct seq_file *m, void *v)
 177 {
 178         struct snd_soc_component *component;
 179         struct snd_soc_dai *dai;
 180
 181         mutex_lock(&client_mutex);
 182
 183         for_each_component(component)
 184                 for_each_component_dais(component, dai)
 185                         seq_printf(m, "%s\n", dai->name);
 186
 187         mutex_unlock(&client_mutex);
 188
 189         return 0;
 190 }
 191 DEFINE_SHOW_ATTRIBUTE(dai_list);
 192
 193 static int component_list_show(struct seq_file *m, void *v)
 194 {
 195         struct snd_soc_component *component;
 196
 197         mutex_lock(&client_mutex);
 198
 199         for_each_component(component)
 200                 seq_printf(m, "%s\n", component->name);
 201
 202         mutex_unlock(&client_mutex);
 203
 204         return 0;
 205 }
 206 DEFINE_SHOW_ATTRIBUTE(component_list);
 207
 208 static void soc_init_card_debugfs(struct snd_soc_card *card)
 209 {
 210         if (!snd_soc_debugfs_root)
 211                 return;
 212
 213         card->debugfs_card_root = debugfs_create_dir(card->name,
 214                                                      snd_soc_debugfs_root);
 215         if (!card->debugfs_card_root) {
 216                 dev_warn(card->dev,
 217                          "ASoC: Failed to create card debugfs directory\n");
 218                 return;
 219         }
 220
 221         card->debugfs_pop_time = debugfs_create_u32("dapm_pop_time", 0644,
 222                                                     card->debugfs_card_root,
 223                                                     &card->pop_time);
 224         if (!card->debugfs_pop_time)
 225                 dev_warn(card->dev,
 226                          "ASoC: Failed to create pop time debugfs file\n");
 227 }
 228
 229 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 230 {
 231         debugfs_remove_recursive(card->debugfs_card_root);
 232 }
 233
 234 static void snd_soc_debugfs_init(void)
 235 {
 236         snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
 237         if (IS_ERR_OR_NULL(snd_soc_debugfs_root)) {
 238                 pr_warn("ASoC: Failed to create debugfs directory\n");
 239                 snd_soc_debugfs_root = NULL;
 240                 return;
 241         }
 242
 243         if (!debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
 244                                  &dai_list_fops))
 245                 pr_warn("ASoC: Failed to create DAI list debugfs file\n");
 246
 247         if (!debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
 248                                  &component_list_fops))
 249                 pr_warn("ASoC: Failed to create component list debugfs file\n");
 250 }
 251
 252 static void snd_soc_debugfs_exit(void)
 253 {
 254         debugfs_remove_recursive(snd_soc_debugfs_root);
 255 }
 256
 257 #else
 258
 259 static inline void soc_init_component_debugfs(
 260         struct snd_soc_component *component)
 261 {
 262 }
 263
 264 static inline void soc_cleanup_component_debugfs(
 265         struct snd_soc_component *component)
 266 {
 267 }
 268
 269 static inline void soc_init_card_debugfs(struct snd_soc_card *card)
 270 {
 271 }
 272
 273 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 274 {
 275 }
 276
 277 static inline void snd_soc_debugfs_init(void)
 278 {
 279 }
 280
 281 static inline void snd_soc_debugfs_exit(void)
 282 {
 283 }
 284
 285 #endif
 286
 287 static int snd_soc_rtdcom_add(struct snd_soc_pcm_runtime *rtd,
 288                               struct snd_soc_component *component)
 289 {
 290         struct snd_soc_rtdcom_list *rtdcom;
 291         struct snd_soc_rtdcom_list *new_rtdcom;
 292
 293         for_each_rtdcom(rtd, rtdcom) {
 294                 /* already connected */
 295                 if (rtdcom->component == component)
 296                         return 0;
 297         }
 298
 299         new_rtdcom = kmalloc(sizeof(*new_rtdcom), GFP_KERNEL);
 300         if (!new_rtdcom)
 301                 return -ENOMEM;
 302
 303         new_rtdcom->component = component;
 304         INIT_LIST_HEAD(&new_rtdcom->list);
 305
 306         list_add_tail(&new_rtdcom->list, &rtd->component_list);
 307
 308         return 0;
 309 }
 310
 311 static void snd_soc_rtdcom_del_all(struct snd_soc_pcm_runtime *rtd)
 312 {
 313         struct snd_soc_rtdcom_list *rtdcom1, *rtdcom2;
 314
 315         for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2)
 316                 kfree(rtdcom1);
 317
 318         INIT_LIST_HEAD(&rtd->component_list);
 319 }
 320
 321 struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 322                                                 const char *driver_name)
 323 {
 324         struct snd_soc_rtdcom_list *rtdcom;
 325
 326         if (!driver_name)
 327                 return NULL;
 328
 329         for_each_rtdcom(rtd, rtdcom) {
 330                 const char *component_name = rtdcom->component->driver->name;
 331
 332                 if (!component_name)
 333                         continue;
 334
 335                 if ((component_name == driver_name) ||
 336                     strcmp(component_name, driver_name) == 0)
 337                         return rtdcom->component;
 338         }
 339
 340         return NULL;
 341 }
 342 EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
 343
 344 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 345                 const char *dai_link, int stream)
 346 {
 347         struct snd_soc_pcm_runtime *rtd;
 348
 349         for_each_card_rtds(card, rtd) {
 350                 if (rtd->dai_link->no_pcm &&
 351                         !strcmp(rtd->dai_link->name, dai_link))
 352                         return rtd->pcm->streams[stream].substream;
 353         }
 354         dev_dbg(card->dev, "ASoC: failed to find dai link %s\n", dai_link);
 355         return NULL;
 356 }
 357 EXPORT_SYMBOL_GPL(snd_soc_get_dai_substream);
 358
 359 static const struct snd_soc_ops null_snd_soc_ops;
 360
 361 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
 362         struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
 363 {
 364         struct snd_soc_pcm_runtime *rtd;
 365
 366         rtd = kzalloc(sizeof(struct snd_soc_pcm_runtime), GFP_KERNEL);
 367         if (!rtd)
 368                 return NULL;
 369
 370         INIT_LIST_HEAD(&rtd->component_list);
 371         rtd->card = card;
 372         rtd->dai_link = dai_link;
 373         if (!rtd->dai_link->ops)
 374                 rtd->dai_link->ops = &null_snd_soc_ops;
 375
 376         rtd->codec_dais = kcalloc(dai_link->num_codecs,
 377                                         sizeof(struct snd_soc_dai *),
 378                                         GFP_KERNEL);
 379         if (!rtd->codec_dais) {
 380                 kfree(rtd);
 381                 return NULL;
 382         }
 383
 384         return rtd;
 385 }
 386
 387 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
 388 {
 389         kfree(rtd->codec_dais);
 390         snd_soc_rtdcom_del_all(rtd);
 391         kfree(rtd);
 392 }
 393
 394 static void soc_add_pcm_runtime(struct snd_soc_card *card,
 395                 struct snd_soc_pcm_runtime *rtd)
 396 {
 397         list_add_tail(&rtd->list, &card->rtd_list);
 398         rtd->num = card->num_rtd;
 399         card->num_rtd++;
 400 }
 401
 402 static void soc_remove_pcm_runtimes(struct snd_soc_card *card)
 403 {
 404         struct snd_soc_pcm_runtime *rtd, *_rtd;
 405
 406         for_each_card_rtds_safe(card, rtd, _rtd) {
 407                 list_del(&rtd->list);
 408                 soc_free_pcm_runtime(rtd);
 409         }
 410
 411         card->num_rtd = 0;
 412 }
 413
 414 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 415                 const char *dai_link)
 416 {
 417         struct snd_soc_pcm_runtime *rtd;
 418
 419         for_each_card_rtds(card, rtd) {
 420                 if (!strcmp(rtd->dai_link->name, dai_link))
 421                         return rtd;
 422         }
 423         dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link);
 424         return NULL;
 425 }
 426 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
 427
 428 static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
 429 {
 430         struct snd_soc_pcm_runtime *rtd;
 431
 432         for_each_card_rtds(card, rtd)
 433                 flush_delayed_work(&rtd->delayed_work);
 434 }
 435
 436 static void codec2codec_close_delayed_work(struct work_struct *work)
 437 {
 438         /*
 439          * Currently nothing to do for c2c links
 440          * Since c2c links are internal nodes in the DAPM graph and
 441          * don't interface with the outside world or application layer
 442          * we don't have to do any special handling on close.
 443          */
 444 }
 445
 446 #ifdef CONFIG_PM_SLEEP
 447 /* powers down audio subsystem for suspend */
 448 int snd_soc_suspend(struct device *dev)
 449 {
 450         struct snd_soc_card *card = dev_get_drvdata(dev);
 451         struct snd_soc_component *component;
 452         struct snd_soc_pcm_runtime *rtd;
 453         int i;
 454
 455         /* If the card is not initialized yet there is nothing to do */
 456         if (!card->instantiated)
 457                 return 0;
 458
 459         /*
 460          * Due to the resume being scheduled into a workqueue we could
 461          * suspend before that's finished - wait for it to complete.
 462          */
 463         snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
 464
 465         /* we're going to block userspace touching us until resume completes */
 466         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
 467
 468         /* mute any active DACs */
 469         for_each_card_rtds(card, rtd) {
 470                 struct snd_soc_dai *dai;
 471
 472                 if (rtd->dai_link->ignore_suspend)
 473                         continue;
 474
 475                 for_each_rtd_codec_dai(rtd, i, dai) {
 476                         struct snd_soc_dai_driver *drv = dai->driver;
 477
 478                         if (drv->ops->digital_mute && dai->playback_active)
 479                                 drv->ops->digital_mute(dai, 1);
 480                 }
 481         }
 482
 483         /* suspend all pcms */
 484         for_each_card_rtds(card, rtd) {
 485                 if (rtd->dai_link->ignore_suspend)
 486                         continue;
 487
 488                 snd_pcm_suspend_all(rtd->pcm);
 489         }
 490
 491         if (card->suspend_pre)
 492                 card->suspend_pre(card);
 493
 494         for_each_card_rtds(card, rtd) {
 495                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 496
 497                 if (rtd->dai_link->ignore_suspend)
 498                         continue;
 499
 500                 if (cpu_dai->driver->suspend && !cpu_dai->driver->bus_control)
 501                         cpu_dai->driver->suspend(cpu_dai);
 502         }
 503
 504         /* close any waiting streams */
 505         snd_soc_flush_all_delayed_work(card);
 506
 507         for_each_card_rtds(card, rtd) {
 508
 509                 if (rtd->dai_link->ignore_suspend)
 510                         continue;
 511
 512                 snd_soc_dapm_stream_event(rtd,
 513                                           SNDRV_PCM_STREAM_PLAYBACK,
 514                                           SND_SOC_DAPM_STREAM_SUSPEND);
 515
 516                 snd_soc_dapm_stream_event(rtd,
 517                                           SNDRV_PCM_STREAM_CAPTURE,
 518                                           SND_SOC_DAPM_STREAM_SUSPEND);
 519         }
 520
 521         /* Recheck all endpoints too, their state is affected by suspend */
 522         dapm_mark_endpoints_dirty(card);
 523         snd_soc_dapm_sync(&card->dapm);
 524
 525         /* suspend all COMPONENTs */
 526         for_each_card_components(card, component) {
 527                 struct snd_soc_dapm_context *dapm =
 528                                 snd_soc_component_get_dapm(component);
 529
 530                 /*
 531                  * If there are paths active then the COMPONENT will be held
 532                  * with bias _ON and should not be suspended.
 533                  */
 534                 if (!component->suspended) {
 535                         switch (snd_soc_dapm_get_bias_level(dapm)) {
 536                         case SND_SOC_BIAS_STANDBY:
 537                                 /*
 538                                  * If the COMPONENT is capable of idle
 539                                  * bias off then being in STANDBY
 540                                  * means it's doing something,
 541                                  * otherwise fall through.
 542                                  */
 543                                 if (dapm->idle_bias_off) {
 544                                         dev_dbg(component->dev,
 545                                                 "ASoC: idle_bias_off CODEC on over suspend\n");
 546                                         break;
 547                                 }
 548                                 /* fall through */
 549
 550                         case SND_SOC_BIAS_OFF:
 551                                 if (component->driver->suspend)
 552                                         component->driver->suspend(component);
 553                                 component->suspended = 1;
 554                                 if (component->regmap)
 555                                         regcache_mark_dirty(component->regmap);
 556                                 /* deactivate pins to sleep state */
 557                                 pinctrl_pm_select_sleep_state(component->dev);
 558                                 break;
 559                         default:
 560                                 dev_dbg(component->dev,
 561                                         "ASoC: COMPONENT is on over suspend\n");
 562                                 break;
 563                         }
 564                 }
 565         }
 566
 567         for_each_card_rtds(card, rtd) {
 568                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 569
 570                 if (rtd->dai_link->ignore_suspend)
 571                         continue;
 572
 573                 if (cpu_dai->driver->suspend && cpu_dai->driver->bus_control)
 574                         cpu_dai->driver->suspend(cpu_dai);
 575
 576                 /* deactivate pins to sleep state */
 577                 pinctrl_pm_select_sleep_state(cpu_dai->dev);
 578         }
 579
 580         if (card->suspend_post)
 581                 card->suspend_post(card);
 582
 583         return 0;
 584 }
 585 EXPORT_SYMBOL_GPL(snd_soc_suspend);
 586
 587 /*
 588  * deferred resume work, so resume can complete before we finished
 589  * setting our codec back up, which can be very slow on I2C
 590  */
 591 static void soc_resume_deferred(struct work_struct *work)
 592 {
 593         struct snd_soc_card *card =
 594                         container_of(work, struct snd_soc_card,
 595                                      deferred_resume_work);
 596         struct snd_soc_pcm_runtime *rtd;
 597         struct snd_soc_component *component;
 598         int i;
 599
 600         /*
 601          * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
 602          * so userspace apps are blocked from touching us
 603          */
 604
 605         dev_dbg(card->dev, "ASoC: starting resume work\n");
 606
 607         /* Bring us up into D2 so that DAPM starts enabling things */
 608         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
 609
 610         if (card->resume_pre)
 611                 card->resume_pre(card);
 612
 613         /* resume control bus DAIs */
 614         for_each_card_rtds(card, rtd) {
 615                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 616
 617                 if (rtd->dai_link->ignore_suspend)
 618                         continue;
 619
 620                 if (cpu_dai->driver->resume && cpu_dai->driver->bus_control)
 621                         cpu_dai->driver->resume(cpu_dai);
 622         }
 623
 624         for_each_card_components(card, component) {
 625                 if (component->suspended) {
 626                         if (component->driver->resume)
 627                                 component->driver->resume(component);
 628                         component->suspended = 0;
 629                 }
 630         }
 631
 632         for_each_card_rtds(card, rtd) {
 633
 634                 if (rtd->dai_link->ignore_suspend)
 635                         continue;
 636
 637                 snd_soc_dapm_stream_event(rtd,
 638                                           SNDRV_PCM_STREAM_PLAYBACK,
 639                                           SND_SOC_DAPM_STREAM_RESUME);
 640
 641                 snd_soc_dapm_stream_event(rtd,
 642                                           SNDRV_PCM_STREAM_CAPTURE,
 643                                           SND_SOC_DAPM_STREAM_RESUME);
 644         }
 645
 646         /* unmute any active DACs */
 647         for_each_card_rtds(card, rtd) {
 648                 struct snd_soc_dai *dai;
 649
 650                 if (rtd->dai_link->ignore_suspend)
 651                         continue;
 652
 653                 for_each_rtd_codec_dai(rtd, i, dai) {
 654                         struct snd_soc_dai_driver *drv = dai->driver;
 655
 656                         if (drv->ops->digital_mute && dai->playback_active)
 657                                 drv->ops->digital_mute(dai, 0);
 658                 }
 659         }
 660
 661         for_each_card_rtds(card, rtd) {
 662                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 663
 664                 if (rtd->dai_link->ignore_suspend)
 665                         continue;
 666
 667                 if (cpu_dai->driver->resume && !cpu_dai->driver->bus_control)
 668                         cpu_dai->driver->resume(cpu_dai);
 669         }
 670
 671         if (card->resume_post)
 672                 card->resume_post(card);
 673
 674         dev_dbg(card->dev, "ASoC: resume work completed\n");
 675
 676         /* Recheck all endpoints too, their state is affected by suspend */
 677         dapm_mark_endpoints_dirty(card);
 678         snd_soc_dapm_sync(&card->dapm);
 679
 680         /* userspace can access us now we are back as we were before */
 681         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
 682 }
 683
 684 /* powers up audio subsystem after a suspend */
 685 int snd_soc_resume(struct device *dev)
 686 {
 687         struct snd_soc_card *card = dev_get_drvdata(dev);
 688         bool bus_control = false;
 689         struct snd_soc_pcm_runtime *rtd;
 690         struct snd_soc_dai *codec_dai;
 691         int i;
 692
 693         /* If the card is not initialized yet there is nothing to do */
 694         if (!card->instantiated)
 695                 return 0;
 696
 697         /* activate pins from sleep state */
 698         for_each_card_rtds(card, rtd) {
 699                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 700
 701                 if (cpu_dai->active)
 702                         pinctrl_pm_select_default_state(cpu_dai->dev);
 703
 704                 for_each_rtd_codec_dai(rtd, i, codec_dai) {
 705                         if (codec_dai->active)
 706                                 pinctrl_pm_select_default_state(codec_dai->dev);
 707                 }
 708         }
 709
 710         /*
 711          * DAIs that also act as the control bus master might have other drivers
 712          * hanging off them so need to resume immediately. Other drivers don't
 713          * have that problem and may take a substantial amount of time to resume
 714          * due to I/O costs and anti-pop so handle them out of line.
 715          */
 716         for_each_card_rtds(card, rtd) {
 717                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 718
 719                 bus_control |= cpu_dai->driver->bus_control;
 720         }
 721         if (bus_control) {
 722                 dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
 723                 soc_resume_deferred(&card->deferred_resume_work);
 724         } else {
 725                 dev_dbg(dev, "ASoC: Scheduling resume work\n");
 726                 if (!schedule_work(&card->deferred_resume_work))
 727                         dev_err(dev, "ASoC: resume work item may be lost\n");
 728         }
 729
 730         return 0;
 731 }
 732 EXPORT_SYMBOL_GPL(snd_soc_resume);
 733 #else
 734 #define snd_soc_suspend NULL
 735 #define snd_soc_resume NULL
 736 #endif
 737
 738 static const struct snd_soc_dai_ops null_dai_ops = {
 739 };
 740
 741 static struct device_node
 742 *soc_component_to_node(struct snd_soc_component *component)
 743 {
 744         struct device_node *of_node;
 745
 746         of_node = component->dev->of_node;
 747         if (!of_node && component->dev->parent)
 748                 of_node = component->dev->parent->of_node;
 749
 750         return of_node;
 751 }
 752
 753 static struct snd_soc_component *soc_find_component(
 754         const struct device_node *of_node, const char *name)
 755 {
 756         struct snd_soc_component *component;
 757         struct device_node *component_of_node;
 758
 759         lockdep_assert_held(&client_mutex);
 760
 761         for_each_component(component) {
 762                 if (of_node) {
 763                         component_of_node = soc_component_to_node(component);
 764
 765                         if (component_of_node == of_node)
 766                                 return component;
 767                 } else if (name && strcmp(component->name, name) == 0) {
 768                         return component;
 769                 }
 770         }
 771
 772         return NULL;
 773 }
 774
 775 static int snd_soc_is_matching_component(
 776         const struct snd_soc_dai_link_component *dlc,
 777         struct snd_soc_component *component)
 778 {
 779         struct device_node *component_of_node;
 780
 781         component_of_node = soc_component_to_node(component);
 782
 783         if (dlc->of_node && component_of_node != dlc->of_node)
 784                 return 0;
 785         if (dlc->name && strcmp(component->name, dlc->name))
 786                 return 0;
 787
 788         return 1;
 789 }
 790
 791 /**
 792  * snd_soc_find_dai - Find a registered DAI
 793  *
 794  * @dlc: name of the DAI or the DAI driver and optional component info to match
 795  *
 796  * This function will search all registered components and their DAIs to
 797  * find the DAI of the same name. The component's of_node and name
 798  * should also match if being specified.
 799  *
 800  * Return: pointer of DAI, or NULL if not found.
 801  */
 802 struct snd_soc_dai *snd_soc_find_dai(
 803         const struct snd_soc_dai_link_component *dlc)
 804 {
 805         struct snd_soc_component *component;
 806         struct snd_soc_dai *dai;
 807
 808         lockdep_assert_held(&client_mutex);
 809
 810         /* Find CPU DAI from registered DAIs */
 811         for_each_component(component) {
 812                 if (!snd_soc_is_matching_component(dlc, component))
 813                         continue;
 814                 for_each_component_dais(component, dai) {
 815                         if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
 816                             && (!dai->driver->name
 817                                 || strcmp(dai->driver->name, dlc->dai_name)))
 818                                 continue;
 819
 820                         return dai;
 821                 }
 822         }
 823
 824         return NULL;
 825 }
 826 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
 827
 828 /**
 829  * snd_soc_find_dai_link - Find a DAI link
 830  *
 831  * @card: soc card
 832  * @id: DAI link ID to match
 833  * @name: DAI link name to match, optional
 834  * @stream_name: DAI link stream name to match, optional
 835  *
 836  * This function will search all existing DAI links of the soc card to
 837  * find the link of the same ID. Since DAI links may not have their
 838  * unique ID, so name and stream name should also match if being
 839  * specified.
 840  *
 841  * Return: pointer of DAI link, or NULL if not found.
 842  */
 843 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
 844                                                int id, const char *name,
 845                                                const char *stream_name)
 846 {
 847         struct snd_soc_dai_link *link, *_link;
 848
 849         lockdep_assert_held(&client_mutex);
 850
 851         for_each_card_links_safe(card, link, _link) {
 852                 if (link->id != id)
 853                         continue;
 854
 855                 if (name && (!link->name || strcmp(name, link->name)))
 856                         continue;
 857
 858                 if (stream_name && (!link->stream_name
 859                         || strcmp(stream_name, link->stream_name)))
 860                         continue;
 861
 862                 return link;
 863         }
 864
 865         return NULL;
 866 }
 867 EXPORT_SYMBOL_GPL(snd_soc_find_dai_link);
 868
 869 static bool soc_is_dai_link_bound(struct snd_soc_card *card,
 870                 struct snd_soc_dai_link *dai_link)
 871 {
 872         struct snd_soc_pcm_runtime *rtd;
 873
 874         for_each_card_rtds(card, rtd) {
 875                 if (rtd->dai_link == dai_link)
 876                         return true;
 877         }
 878
 879         return false;
 880 }
 881
 882 static int soc_bind_dai_link(struct snd_soc_card *card,
 883         struct snd_soc_dai_link *dai_link)
 884 {
 885         struct snd_soc_pcm_runtime *rtd;
 886         struct snd_soc_dai_link_component *codecs;
 887         struct snd_soc_dai_link_component cpu_dai_component;
 888         struct snd_soc_component *component;
 889         int i;
 890
 891         if (dai_link->ignore)
 892                 return 0;
 893
 894         dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
 895
 896         if (soc_is_dai_link_bound(card, dai_link)) {
 897                 dev_dbg(card->dev, "ASoC: dai link %s already bound\n",
 898                         dai_link->name);
 899                 return 0;
 900         }
 901
 902         rtd = soc_new_pcm_runtime(card, dai_link);
 903         if (!rtd)
 904                 return -ENOMEM;
 905
 906         cpu_dai_component.name = dai_link->cpu_name;
 907         cpu_dai_component.of_node = dai_link->cpu_of_node;
 908         cpu_dai_component.dai_name = dai_link->cpu_dai_name;
 909         rtd->cpu_dai = snd_soc_find_dai(&cpu_dai_component);
 910         if (!rtd->cpu_dai) {
 911                 dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
 912                          dai_link->cpu_dai_name);
 913                 goto _err_defer;
 914         }
 915         snd_soc_rtdcom_add(rtd, rtd->cpu_dai->component);
 916
 917         /* Find CODEC from registered CODECs */
 918         rtd->num_codecs = dai_link->num_codecs;
 919         for_each_link_codecs(dai_link, i, codecs) {
 920                 rtd->codec_dais[i] = snd_soc_find_dai(codecs);
 921                 if (!rtd->codec_dais[i]) {
 922                         dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
 923                                  codecs->dai_name);
 924                         goto _err_defer;
 925                 }
 926                 snd_soc_rtdcom_add(rtd, rtd->codec_dais[i]->component);
 927         }
 928
 929         /* Single codec links expect codec and codec_dai in runtime data */
 930         rtd->codec_dai = rtd->codec_dais[0];
 931
 932         /* Find PLATFORM from registered PLATFORMs */
 933         for_each_component(component) {
 934                 if (!snd_soc_is_matching_component(dai_link->platforms,
 935                                                    component))
 936                         continue;
 937
 938                 snd_soc_rtdcom_add(rtd, component);
 939         }
 940
 941         soc_add_pcm_runtime(card, rtd);
 942         return 0;
 943
 944 _err_defer:
 945         soc_free_pcm_runtime(rtd);
 946         return -EPROBE_DEFER;
 947 }
 948
 949 static void soc_cleanup_component(struct snd_soc_component *component)
 950 {
 951         list_del(&component->card_list);
 952         snd_soc_dapm_free(snd_soc_component_get_dapm(component));
 953         soc_cleanup_component_debugfs(component);
 954         component->card = NULL;
 955         if (!component->driver->module_get_upon_open)
 956                 module_put(component->dev->driver->owner);
 957 }
 958
 959 static void soc_remove_component(struct snd_soc_component *component)
 960 {
 961         if (!component->card)
 962                 return;
 963
 964         if (component->driver->remove)
 965                 component->driver->remove(component);
 966
 967         soc_cleanup_component(component);
 968 }
 969
 970 static void soc_remove_dai(struct snd_soc_dai *dai, int order)
 971 {
 972         int err;
 973
 974         if (!dai || !dai->probed || !dai->driver ||
 975             dai->driver->remove_order != order)
 976                 return;
 977
 978         if (dai->driver->remove) {
 979                 err = dai->driver->remove(dai);
 980                 if (err < 0)
 981                         dev_err(dai->dev,
 982                                 "ASoC: failed to remove %s: %d\n",
 983                                 dai->name, err);
 984         }
 985         dai->probed = 0;
 986 }
 987
 988 static void soc_remove_link_dais(struct snd_soc_card *card,
 989                 struct snd_soc_pcm_runtime *rtd, int order)
 990 {
 991         int i;
 992         struct snd_soc_dai *codec_dai;
 993
 994         /* unregister the rtd device */
 995         if (rtd->dev_registered) {
 996                 device_unregister(rtd->dev);
 997                 rtd->dev_registered = 0;
 998         }
 999
1000         /* remove the CODEC DAI */
1001         for_each_rtd_codec_dai(rtd, i, codec_dai)
1002                 soc_remove_dai(codec_dai, order);
1003
1004         soc_remove_dai(rtd->cpu_dai, order);
1005 }
1006
1007 static void soc_remove_link_components(struct snd_soc_card *card,
1008         struct snd_soc_pcm_runtime *rtd, int order)
1009 {
1010         struct snd_soc_component *component;
1011         struct snd_soc_rtdcom_list *rtdcom;
1012
1013         for_each_rtdcom(rtd, rtdcom) {
1014                 component = rtdcom->component;
1015
1016                 if (component->driver->remove_order == order)
1017                         soc_remove_component(component);
1018         }
1019 }
1020
1021 static void soc_remove_dai_links(struct snd_soc_card *card)
1022 {
1023         int order;
1024         struct snd_soc_pcm_runtime *rtd;
1025         struct snd_soc_dai_link *link, *_link;
1026
1027         for_each_comp_order(order) {
1028                 for_each_card_rtds(card, rtd)
1029                         soc_remove_link_dais(card, rtd, order);
1030         }
1031
1032         for_each_comp_order(order) {
1033                 for_each_card_rtds(card, rtd)
1034                         soc_remove_link_components(card, rtd, order);
1035         }
1036
1037         for_each_card_links_safe(card, link, _link) {
1038                 if (link->dobj.type == SND_SOC_DOBJ_DAI_LINK)
1039                         dev_warn(card->dev, "Topology forgot to remove link %s?\n",
1040                                 link->name);
1041
1042                 list_del(&link->list);
1043         }
1044 }
1045
1046 static int snd_soc_init_platform(struct snd_soc_card *card,
1047                                  struct snd_soc_dai_link *dai_link)
1048 {
1049         struct snd_soc_dai_link_component *platform = dai_link->platforms;
1050
1051         /*
1052          * REMOVE ME
1053          *
1054          * This is glue code for Legacy vs Modern dai_link.
1055          * This function will be removed if all derivers are switched to
1056          * modern style dai_link.
1057          * Driver shouldn't use both legacy and modern style in the same time.
1058          * see
1059          *      soc.h :: struct snd_soc_dai_link
1060          */
1061         /* convert Legacy platform link */
1062         if (!platform) {
1063                 platform = devm_kzalloc(card->dev,
1064                                 sizeof(struct snd_soc_dai_link_component),
1065                                 GFP_KERNEL);
1066                 if (!platform)
1067                         return -ENOMEM;
1068
1069                 dai_link->platforms       = platform;
1070                 dai_link->num_platforms   = 1;
1071                 dai_link->legacy_platform = 1;
1072                 platform->name            = dai_link->platform_name;
1073                 platform->of_node         = dai_link->platform_of_node;
1074                 platform->dai_name        = NULL;
1075         }
1076
1077         /* if there's no platform we match on the empty platform */
1078         if (!platform->name &&
1079             !platform->of_node)
1080                 platform->name = "snd-soc-dummy";
1081
1082         return 0;
1083 }
1084
1085 static void soc_cleanup_platform(struct snd_soc_card *card)
1086 {
1087         struct snd_soc_dai_link *link;
1088         int i;
1089         /*
1090          * FIXME
1091          *
1092          * this function should be removed with snd_soc_init_platform
1093          */
1094
1095         for_each_card_prelinks(card, i, link) {
1096                 if (link->legacy_platform) {
1097                         link->legacy_platform = 0;
1098                         link->platforms       = NULL;
1099                 }
1100         }
1101 }
1102
1103 static int snd_soc_init_multicodec(struct snd_soc_card *card,
1104                                    struct snd_soc_dai_link *dai_link)
1105 {
1106         /*
1107          * REMOVE ME
1108          *
1109          * This is glue code for Legacy vs Modern dai_link.
1110          * This function will be removed if all derivers are switched to
1111          * modern style dai_link.
1112          * Driver shouldn't use both legacy and modern style in the same time.
1113          * see
1114          *      soc.h :: struct snd_soc_dai_link
1115          */
1116
1117         /* Legacy codec/codec_dai link is a single entry in multicodec */
1118         if (dai_link->codec_name || dai_link->codec_of_node ||
1119             dai_link->codec_dai_name) {
1120                 dai_link->num_codecs = 1;
1121
1122                 dai_link->codecs = devm_kzalloc(card->dev,
1123                                 sizeof(struct snd_soc_dai_link_component),
1124                                 GFP_KERNEL);
1125                 if (!dai_link->codecs)
1126                         return -ENOMEM;
1127
1128                 dai_link->codecs[0].name = dai_link->codec_name;
1129                 dai_link->codecs[0].of_node = dai_link->codec_of_node;
1130                 dai_link->codecs[0].dai_name = dai_link->codec_dai_name;
1131         }
1132
1133         if (!dai_link->codecs) {
1134                 dev_err(card->dev, "ASoC: DAI link has no CODECs\n");
1135                 return -EINVAL;
1136         }
1137
1138         return 0;
1139 }
1140
1141 static int soc_init_dai_link(struct snd_soc_card *card,
1142                              struct snd_soc_dai_link *link)
1143 {
1144         int i, ret;
1145         struct snd_soc_dai_link_component *codec;
1146
1147         ret = snd_soc_init_platform(card, link);
1148         if (ret) {
1149                 dev_err(card->dev, "ASoC: failed to init multiplatform\n");
1150                 return ret;
1151         }
1152
1153         ret = snd_soc_init_multicodec(card, link);
1154         if (ret) {
1155                 dev_err(card->dev, "ASoC: failed to init multicodec\n");
1156                 return ret;
1157         }
1158
1159         for_each_link_codecs(link, i, codec) {
1160                 /*
1161                  * Codec must be specified by 1 of name or OF node,
1162                  * not both or neither.
1163                  */
1164                 if (!!codec->name ==
1165                     !!codec->of_node) {
1166                         dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
1167                                 link->name);
1168                         return -EINVAL;
1169                 }
1170                 /* Codec DAI name must be specified */
1171                 if (!codec->dai_name) {
1172                         dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
1173                                 link->name);
1174                         return -EINVAL;
1175                 }
1176         }
1177
1178         /* FIXME */
1179         if (link->num_platforms > 1) {
1180                 dev_err(card->dev,
1181                         "ASoC: multi platform is not yet supported %s\n",
1182                         link->name);
1183                 return -EINVAL;
1184         }
1185
1186         /*
1187          * Platform may be specified by either name or OF node, but
1188          * can be left unspecified, and a dummy platform will be used.
1189          */
1190         if (link->platforms->name && link->platforms->of_node) {
1191                 dev_err(card->dev,
1192                         "ASoC: Both platform name/of_node are set for %s\n",
1193                         link->name);
1194                 return -EINVAL;
1195         }
1196
1197         /*
1198          * Defer card registartion if platform dai component is not added to
1199          * component list.
1200          */
1201         if ((link->platforms->of_node || link->platforms->name) &&
1202             !soc_find_component(link->platforms->of_node, link->platforms->name))
1203                 return -EPROBE_DEFER;
1204
1205         /*
1206          * CPU device may be specified by either name or OF node, but
1207          * can be left unspecified, and will be matched based on DAI
1208          * name alone..
1209          */
1210         if (link->cpu_name && link->cpu_of_node) {
1211                 dev_err(card->dev,
1212                         "ASoC: Neither/both cpu name/of_node are set for %s\n",
1213                         link->name);
1214                 return -EINVAL;
1215         }
1216
1217         /*
1218          * Defer card registartion if cpu dai component is not added to
1219          * component list.
1220          */
1221         if ((link->cpu_of_node || link->cpu_name) &&
1222             !soc_find_component(link->cpu_of_node, link->cpu_name))
1223                 return -EPROBE_DEFER;
1224
1225         /*
1226          * At least one of CPU DAI name or CPU device name/node must be
1227          * specified
1228          */
1229         if (!link->cpu_dai_name &&
1230             !(link->cpu_name || link->cpu_of_node)) {
1231                 dev_err(card->dev,
1232                         "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1233                         link->name);
1234                 return -EINVAL;
1235         }
1236
1237         return 0;
1238 }
1239
1240 void snd_soc_disconnect_sync(struct device *dev)
1241 {
1242         struct snd_soc_component *component =
1243                         snd_soc_lookup_component(dev, NULL);
1244
1245         if (!component || !component->card)
1246                 return;
1247
1248         snd_card_disconnect_sync(component->card->snd_card);
1249 }
1250 EXPORT_SYMBOL_GPL(snd_soc_disconnect_sync);
1251
1252 /**
1253  * snd_soc_add_dai_link - Add a DAI link dynamically
1254  * @card: The ASoC card to which the DAI link is added
1255  * @dai_link: The new DAI link to add
1256  *
1257  * This function adds a DAI link to the ASoC card's link list.
1258  *
1259  * Note: Topology can use this API to add DAI links when probing the
1260  * topology component. And machine drivers can still define static
1261  * DAI links in dai_link array.
1262  */
1263 int snd_soc_add_dai_link(struct snd_soc_card *card,
1264                 struct snd_soc_dai_link *dai_link)
1265 {
1266         if (dai_link->dobj.type
1267             && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1268                 dev_err(card->dev, "Invalid dai link type %d\n",
1269                         dai_link->dobj.type);
1270                 return -EINVAL;
1271         }
1272
1273         lockdep_assert_held(&client_mutex);
1274         /*
1275          * Notify the machine driver for extra initialization
1276          * on the link created by topology.
1277          */
1278         if (dai_link->dobj.type && card->add_dai_link)
1279                 card->add_dai_link(card, dai_link);
1280
1281         list_add_tail(&dai_link->list, &card->dai_link_list);
1282
1283         return 0;
1284 }
1285 EXPORT_SYMBOL_GPL(snd_soc_add_dai_link);
1286
1287 /**
1288  * snd_soc_remove_dai_link - Remove a DAI link from the list
1289  * @card: The ASoC card that owns the link
1290  * @dai_link: The DAI link to remove
1291  *
1292  * This function removes a DAI link from the ASoC card's link list.
1293  *
1294  * For DAI links previously added by topology, topology should
1295  * remove them by using the dobj embedded in the link.
1296  */
1297 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1298                              struct snd_soc_dai_link *dai_link)
1299 {
1300         struct snd_soc_dai_link *link, *_link;
1301
1302         if (dai_link->dobj.type
1303             && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1304                 dev_err(card->dev, "Invalid dai link type %d\n",
1305                         dai_link->dobj.type);
1306                 return;
1307         }
1308
1309         lockdep_assert_held(&client_mutex);
1310         /*
1311          * Notify the machine driver for extra destruction
1312          * on the link created by topology.
1313          */
1314         if (dai_link->dobj.type && card->remove_dai_link)
1315                 card->remove_dai_link(card, dai_link);
1316
1317         for_each_card_links_safe(card, link, _link) {
1318                 if (link == dai_link) {
1319                         list_del(&link->list);
1320                         return;
1321                 }
1322         }
1323 }
1324 EXPORT_SYMBOL_GPL(snd_soc_remove_dai_link);
1325
1326 static void soc_set_of_name_prefix(struct snd_soc_component *component)
1327 {
1328         struct device_node *component_of_node = soc_component_to_node(component);
1329         const char *str;
1330         int ret;
1331
1332         ret = of_property_read_string(component_of_node, "sound-name-prefix",
1333                                       &str);
1334         if (!ret)
1335                 component->name_prefix = str;
1336 }
1337
1338 static void soc_set_name_prefix(struct snd_soc_card *card,
1339                                 struct snd_soc_component *component)
1340 {
1341         int i;
1342
1343         for (i = 0; i < card->num_configs && card->codec_conf; i++) {
1344                 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1345                 struct device_node *component_of_node = soc_component_to_node(component);
1346
1347                 if (map->of_node && component_of_node != map->of_node)
1348                         continue;
1349                 if (map->dev_name && strcmp(component->name, map->dev_name))
1350                         continue;
1351                 component->name_prefix = map->name_prefix;
1352                 return;
1353         }
1354
1355         /*
1356          * If there is no configuration table or no match in the table,
1357          * check if a prefix is provided in the node
1358          */
1359         soc_set_of_name_prefix(component);
1360 }
1361
1362 static int soc_probe_component(struct snd_soc_card *card,
1363         struct snd_soc_component *component)
1364 {
1365         struct snd_soc_dapm_context *dapm =
1366                         snd_soc_component_get_dapm(component);
1367         struct snd_soc_dai *dai;
1368         int ret;
1369
1370         if (!strcmp(component->name, "snd-soc-dummy"))
1371                 return 0;
1372
1373         if (component->card) {
1374                 if (component->card != card) {
1375                         dev_err(component->dev,
1376                                 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1377                                 card->name, component->card->name);
1378                         return -ENODEV;
1379                 }
1380                 return 0;
1381         }
1382
1383         if (!component->driver->module_get_upon_open &&
1384             !try_module_get(component->dev->driver->owner))
1385                 return -ENODEV;
1386
1387         component->card = card;
1388         dapm->card = card;
1389         INIT_LIST_HEAD(&component->card_list);
1390         INIT_LIST_HEAD(&dapm->list);
1391         soc_set_name_prefix(card, component);
1392
1393         soc_init_component_debugfs(component);
1394
1395         if (component->driver->dapm_widgets) {
1396                 ret = snd_soc_dapm_new_controls(dapm,
1397                                         component->driver->dapm_widgets,
1398                                         component->driver->num_dapm_widgets);
1399
1400                 if (ret != 0) {
1401                         dev_err(component->dev,
1402                                 "Failed to create new controls %d\n", ret);
1403                         goto err_probe;
1404                 }
1405         }
1406
1407         for_each_component_dais(component, dai) {
1408                 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1409                 if (ret != 0) {
1410                         dev_err(component->dev,
1411                                 "Failed to create DAI widgets %d\n", ret);
1412                         goto err_probe;
1413                 }
1414         }
1415
1416         if (component->driver->probe) {
1417                 ret = component->driver->probe(component);
1418                 if (ret < 0) {
1419                         dev_err(component->dev,
1420                                 "ASoC: failed to probe component %d\n", ret);
1421                         goto err_probe;
1422                 }
1423         }
1424         WARN(dapm->idle_bias_off &&
1425              dapm->bias_level != SND_SOC_BIAS_OFF,
1426              "codec %s can not start from non-off bias with idle_bias_off==1\n",
1427              component->name);
1428
1429         /* machine specific init */
1430         if (component->init) {
1431                 ret = component->init(component);
1432                 if (ret < 0) {
1433                         dev_err(component->dev,
1434                                 "Failed to do machine specific init %d\n", ret);
1435                         goto err_probe;
1436                 }
1437         }
1438
1439         if (component->driver->controls)
1440                 snd_soc_add_component_controls(component,
1441                                                component->driver->controls,
1442                                                component->driver->num_controls);
1443         if (component->driver->dapm_routes)
1444                 snd_soc_dapm_add_routes(dapm,
1445                                         component->driver->dapm_routes,
1446                                         component->driver->num_dapm_routes);
1447
1448         list_add(&dapm->list, &card->dapm_list);
1449         /* see for_each_card_components */
1450         list_add(&component->card_list, &card->component_dev_list);
1451
1452 err_probe:
1453         if (ret < 0)
1454                 soc_cleanup_component(component);
1455
1456         return ret;
1457 }
1458
1459 static void rtd_release(struct device *dev)
1460 {
1461         kfree(dev);
1462 }
1463
1464 static int soc_post_component_init(struct snd_soc_pcm_runtime *rtd,
1465         const char *name)
1466 {
1467         int ret = 0;
1468
1469         /* register the rtd device */
1470         rtd->dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1471         if (!rtd->dev)
1472                 return -ENOMEM;
1473         device_initialize(rtd->dev);
1474         rtd->dev->parent = rtd->card->dev;
1475         rtd->dev->release = rtd_release;
1476         rtd->dev->groups = soc_dev_attr_groups;
1477         dev_set_name(rtd->dev, "%s", name);
1478         dev_set_drvdata(rtd->dev, rtd);
1479         mutex_init(&rtd->pcm_mutex);
1480         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
1481         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
1482         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
1483         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
1484         ret = device_add(rtd->dev);
1485         if (ret < 0) {
1486                 /* calling put_device() here to free the rtd->dev */
1487                 put_device(rtd->dev);
1488                 dev_err(rtd->card->dev,
1489                         "ASoC: failed to register runtime device: %d\n", ret);
1490                 return ret;
1491         }
1492         rtd->dev_registered = 1;
1493         return 0;
1494 }
1495
1496 static int soc_probe_link_components(struct snd_soc_card *card,
1497                                      struct snd_soc_pcm_runtime *rtd, int order)
1498 {
1499         struct snd_soc_component *component;
1500         struct snd_soc_rtdcom_list *rtdcom;
1501         int ret;
1502
1503         for_each_rtdcom(rtd, rtdcom) {
1504                 component = rtdcom->component;
1505
1506                 if (component->driver->probe_order == order) {
1507                         ret = soc_probe_component(card, component);
1508                         if (ret < 0)
1509                                 return ret;
1510                 }
1511         }
1512
1513         return 0;
1514 }
1515
1516 static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1517 {
1518         if (dai->probed ||
1519             dai->driver->probe_order != order)
1520                 return 0;
1521
1522         if (dai->driver->probe) {
1523                 int ret = dai->driver->probe(dai);
1524
1525                 if (ret < 0) {
1526                         dev_err(dai->dev, "ASoC: failed to probe DAI %s: %d\n",
1527                                 dai->name, ret);
1528                         return ret;
1529                 }
1530         }
1531
1532         dai->probed = 1;
1533
1534         return 0;
1535 }
1536
1537 static int soc_link_dai_pcm_new(struct snd_soc_dai **dais, int num_dais,
1538                                 struct snd_soc_pcm_runtime *rtd)
1539 {
1540         int i, ret = 0;
1541
1542         for (i = 0; i < num_dais; ++i) {
1543                 struct snd_soc_dai_driver *drv = dais[i]->driver;
1544
1545                 if (drv->pcm_new)
1546                         ret = drv->pcm_new(rtd, dais[i]);
1547                 if (ret < 0) {
1548                         dev_err(dais[i]->dev,
1549                                 "ASoC: Failed to bind %s with pcm device\n",
1550                                 dais[i]->name);
1551                         return ret;
1552                 }
1553         }
1554
1555         return 0;
1556 }
1557
1558 static int soc_probe_link_dais(struct snd_soc_card *card,
1559                 struct snd_soc_pcm_runtime *rtd, int order)
1560 {
1561         struct snd_soc_dai_link *dai_link = rtd->dai_link;
1562         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1563         struct snd_soc_rtdcom_list *rtdcom;
1564         struct snd_soc_component *component;
1565         struct snd_soc_dai *codec_dai;
1566         int i, ret, num;
1567
1568         dev_dbg(card->dev, "ASoC: probe %s dai link %d late %d\n",
1569                         card->name, rtd->num, order);
1570
1571         /* set default power off timeout */
1572         rtd->pmdown_time = pmdown_time;
1573
1574         ret = soc_probe_dai(cpu_dai, order);
1575         if (ret)
1576                 return ret;
1577
1578         /* probe the CODEC DAI */
1579         for_each_rtd_codec_dai(rtd, i, codec_dai) {
1580                 ret = soc_probe_dai(codec_dai, order);
1581                 if (ret)
1582                         return ret;
1583         }
1584
1585         /* complete DAI probe during last probe */
1586         if (order != SND_SOC_COMP_ORDER_LAST)
1587                 return 0;
1588
1589         /* do machine specific initialization */
1590         if (dai_link->init) {
1591                 ret = dai_link->init(rtd);
1592                 if (ret < 0) {
1593                         dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1594                                 dai_link->name, ret);
1595                         return ret;
1596                 }
1597         }
1598
1599         if (dai_link->dai_fmt)
1600                 snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1601
1602         ret = soc_post_component_init(rtd, dai_link->name);
1603         if (ret)
1604                 return ret;
1605
1606 #ifdef CONFIG_DEBUG_FS
1607         /* add DPCM sysfs entries */
1608         if (dai_link->dynamic)
1609                 soc_dpcm_debugfs_add(rtd);
1610 #endif
1611
1612         num = rtd->num;
1613
1614         /*
1615          * most drivers will register their PCMs using DAI link ordering but
1616          * topology based drivers can use the DAI link id field to set PCM
1617          * device number and then use rtd + a base offset of the BEs.
1618          */
1619         for_each_rtdcom(rtd, rtdcom) {
1620                 component = rtdcom->component;
1621
1622                 if (!component->driver->use_dai_pcm_id)
1623                         continue;
1624
1625                 if (rtd->dai_link->no_pcm)
1626                         num += component->driver->be_pcm_base;
1627                 else
1628                         num = rtd->dai_link->id;
1629         }
1630
1631         if (cpu_dai->driver->compress_new) {
1632                 /* create compress_device" */
1633                 ret = cpu_dai->driver->compress_new(rtd, num);
1634                 if (ret < 0) {
1635                         dev_err(card->dev, "ASoC: can't create compress %s\n",
1636                                          dai_link->stream_name);
1637                         return ret;
1638                 }
1639         } else if (!dai_link->params) {
1640                 /* create the pcm */
1641                 ret = soc_new_pcm(rtd, num);
1642                 if (ret < 0) {
1643                         dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1644                                 dai_link->stream_name, ret);
1645                         return ret;
1646                 }
1647                 ret = soc_link_dai_pcm_new(&cpu_dai, 1, rtd);
1648                 if (ret < 0)
1649                         return ret;
1650                 ret = soc_link_dai_pcm_new(rtd->codec_dais,
1651                                            rtd->num_codecs, rtd);
1652                 if (ret < 0)
1653                         return ret;
1654         } else {
1655                 INIT_DELAYED_WORK(&rtd->delayed_work,
1656                                   codec2codec_close_delayed_work);
1657         }
1658
1659         return 0;
1660 }
1661
1662 static int soc_bind_aux_dev(struct snd_soc_card *card, int num)
1663 {
1664         struct snd_soc_aux_dev *aux_dev = &card->aux_dev[num];
1665         struct snd_soc_component *component;
1666         const char *name;
1667         struct device_node *codec_of_node;
1668
1669         if (aux_dev->codec_of_node || aux_dev->codec_name) {
1670                 /* codecs, usually analog devices */
1671                 name = aux_dev->codec_name;
1672                 codec_of_node = aux_dev->codec_of_node;
1673                 component = soc_find_component(codec_of_node, name);
1674                 if (!component) {
1675                         if (codec_of_node)
1676                                 name = of_node_full_name(codec_of_node);
1677                         goto err_defer;
1678                 }
1679         } else if (aux_dev->name) {
1680                 /* generic components */
1681                 name = aux_dev->name;
1682                 component = soc_find_component(NULL, name);
1683                 if (!component)
1684                         goto err_defer;
1685         } else {
1686                 dev_err(card->dev, "ASoC: Invalid auxiliary device\n");
1687                 return -EINVAL;
1688         }
1689
1690         component->init = aux_dev->init;
1691         list_add(&component->card_aux_list, &card->aux_comp_list);
1692
1693         return 0;
1694
1695 err_defer:
1696         dev_err(card->dev, "ASoC: %s not registered\n", name);
1697         return -EPROBE_DEFER;
1698 }
1699
1700 static int soc_probe_aux_devices(struct snd_soc_card *card)
1701 {
1702         struct snd_soc_component *comp;
1703         int order;
1704         int ret;
1705
1706         for_each_comp_order(order) {
1707                 list_for_each_entry(comp, &card->aux_comp_list, card_aux_list) {
1708                         if (comp->driver->probe_order == order) {
1709                                 ret = soc_probe_component(card, comp);
1710                                 if (ret < 0) {
1711                                         dev_err(card->dev,
1712                                                 "ASoC: failed to probe aux component %s %d\n",
1713                                                 comp->name, ret);
1714                                         return ret;
1715                                 }
1716                         }
1717                 }
1718         }
1719
1720         return 0;
1721 }
1722
1723 static void soc_remove_aux_devices(struct snd_soc_card *card)
1724 {
1725         struct snd_soc_component *comp, *_comp;
1726         int order;
1727
1728         for_each_comp_order(order) {
1729                 list_for_each_entry_safe(comp, _comp,
1730                         &card->aux_comp_list, card_aux_list) {
1731
1732                         if (comp->driver->remove_order == order) {
1733                                 soc_remove_component(comp);
1734                                 /* remove it from the card's aux_comp_list */
1735                                 list_del(&comp->card_aux_list);
1736                         }
1737                 }
1738         }
1739 }
1740
1741 /**
1742  * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1743  * @rtd: The runtime for which the DAI link format should be changed
1744  * @dai_fmt: The new DAI link format
1745  *
1746  * This function updates the DAI link format for all DAIs connected to the DAI
1747  * link for the specified runtime.
1748  *
1749  * Note: For setups with a static format set the dai_fmt field in the
1750  * corresponding snd_dai_link struct instead of using this function.
1751  *
1752  * Returns 0 on success, otherwise a negative error code.
1753  */
1754 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1755         unsigned int dai_fmt)
1756 {
1757         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1758         struct snd_soc_dai *codec_dai;
1759         unsigned int i;
1760         int ret;
1761
1762         for_each_rtd_codec_dai(rtd, i, codec_dai) {
1763                 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1764                 if (ret != 0 && ret != -ENOTSUPP) {
1765                         dev_warn(codec_dai->dev,
1766                                  "ASoC: Failed to set DAI format: %d\n", ret);
1767                         return ret;
1768                 }
1769         }
1770
1771         /*
1772          * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1773          * the component which has non_legacy_dai_naming is Codec
1774          */
1775         if (cpu_dai->component->driver->non_legacy_dai_naming) {
1776                 unsigned int inv_dai_fmt;
1777
1778                 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1779                 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1780                 case SND_SOC_DAIFMT_CBM_CFM:
1781                         inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1782                         break;
1783                 case SND_SOC_DAIFMT_CBM_CFS:
1784                         inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1785                         break;
1786                 case SND_SOC_DAIFMT_CBS_CFM:
1787                         inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1788                         break;
1789                 case SND_SOC_DAIFMT_CBS_CFS:
1790                         inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1791                         break;
1792                 }
1793
1794                 dai_fmt = inv_dai_fmt;
1795         }
1796
1797         ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1798         if (ret != 0 && ret != -ENOTSUPP) {
1799                 dev_warn(cpu_dai->dev,
1800                          "ASoC: Failed to set DAI format: %d\n", ret);
1801                 return ret;
1802         }
1803
1804         return 0;
1805 }
1806 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1807
1808 #ifdef CONFIG_DMI
1809 /*
1810  * Trim special characters, and replace '-' with '_' since '-' is used to
1811  * separate different DMI fields in the card long name. Only number and
1812  * alphabet characters and a few separator characters are kept.
1813  */
1814 static void cleanup_dmi_name(char *name)
1815 {
1816         int i, j = 0;
1817
1818         for (i = 0; name[i]; i++) {
1819                 if (isalnum(name[i]) || (name[i] == '.')
1820                     || (name[i] == '_'))
1821                         name[j++] = name[i];
1822                 else if (name[i] == '-')
1823                         name[j++] = '_';
1824         }
1825
1826         name[j] = '\0';
1827 }
1828
1829 /*
1830  * Check if a DMI field is valid, i.e. not containing any string
1831  * in the black list.
1832  */
1833 static int is_dmi_valid(const char *field)
1834 {
1835         int i = 0;
1836
1837         while (dmi_blacklist[i]) {
1838                 if (strstr(field, dmi_blacklist[i]))
1839                         return 0;
1840                 i++;
1841         }
1842
1843         return 1;
1844 }
1845
1846 /**
1847  * snd_soc_set_dmi_name() - Register DMI names to card
1848  * @card: The card to register DMI names
1849  * @flavour: The flavour "differentiator" for the card amongst its peers.
1850  *
1851  * An Intel machine driver may be used by many different devices but are
1852  * difficult for userspace to differentiate, since machine drivers ususally
1853  * use their own name as the card short name and leave the card long name
1854  * blank. To differentiate such devices and fix bugs due to lack of
1855  * device-specific configurations, this function allows DMI info to be used
1856  * as the sound card long name, in the format of
1857  * "vendor-product-version-board"
1858  * (Character '-' is used to separate different DMI fields here).
1859  * This will help the user space to load the device-specific Use Case Manager
1860  * (UCM) configurations for the card.
1861  *
1862  * Possible card long names may be:
1863  * DellInc.-XPS139343-01-0310JH
1864  * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1865  * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1866  *
1867  * This function also supports flavoring the card longname to provide
1868  * the extra differentiation, like "vendor-product-version-board-flavor".
1869  *
1870  * We only keep number and alphabet characters and a few separator characters
1871  * in the card long name since UCM in the user space uses the card long names
1872  * as card configuration directory names and AudoConf cannot support special
1873  * charactors like SPACE.
1874  *
1875  * Returns 0 on success, otherwise a negative error code.
1876  */
1877 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1878 {
1879         const char *vendor, *product, *product_version, *board;
1880         size_t longname_buf_size = sizeof(card->snd_card->longname);
1881         size_t len;
1882
1883         if (card->long_name)
1884                 return 0; /* long name already set by driver or from DMI */
1885
1886         /* make up dmi long name as: vendor.product.version.board */
1887         vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1888         if (!vendor || !is_dmi_valid(vendor)) {
1889                 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1890                 return 0;
1891         }
1892
1893         snprintf(card->dmi_longname, sizeof(card->snd_card->longname),
1894                          "%s", vendor);
1895         cleanup_dmi_name(card->dmi_longname);
1896
1897         product = dmi_get_system_info(DMI_PRODUCT_NAME);
1898         if (product && is_dmi_valid(product)) {
1899                 len = strlen(card->dmi_longname);
1900                 snprintf(card->dmi_longname + len,
1901                          longname_buf_size - len,
1902                          "-%s", product);
1903
1904                 len++;  /* skip the separator "-" */
1905                 if (len < longname_buf_size)
1906                         cleanup_dmi_name(card->dmi_longname + len);
1907
1908                 /*
1909                  * some vendors like Lenovo may only put a self-explanatory
1910                  * name in the product version field
1911                  */
1912                 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1913                 if (product_version && is_dmi_valid(product_version)) {
1914                         len = strlen(card->dmi_longname);
1915                         snprintf(card->dmi_longname + len,
1916                                  longname_buf_size - len,
1917                                  "-%s", product_version);
1918
1919                         len++;
1920                         if (len < longname_buf_size)
1921                                 cleanup_dmi_name(card->dmi_longname + len);
1922                 }
1923         }
1924
1925         board = dmi_get_system_info(DMI_BOARD_NAME);
1926         if (board && is_dmi_valid(board)) {
1927                 len = strlen(card->dmi_longname);
1928                 snprintf(card->dmi_longname + len,
1929                          longname_buf_size - len,
1930                          "-%s", board);
1931
1932                 len++;
1933                 if (len < longname_buf_size)
1934                         cleanup_dmi_name(card->dmi_longname + len);
1935         } else if (!product) {
1936                 /* fall back to using legacy name */
1937                 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1938                 return 0;
1939         }
1940
1941         /* Add flavour to dmi long name */
1942         if (flavour) {
1943                 len = strlen(card->dmi_longname);
1944                 snprintf(card->dmi_longname + len,
1945                          longname_buf_size - len,
1946                          "-%s", flavour);
1947
1948                 len++;
1949                 if (len < longname_buf_size)
1950                         cleanup_dmi_name(card->dmi_longname + len);
1951         }
1952
1953         /* set the card long name */
1954         card->long_name = card->dmi_longname;
1955
1956         return 0;
1957 }
1958 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1959 #endif /* CONFIG_DMI */
1960
1961 static void soc_check_tplg_fes(struct snd_soc_card *card)
1962 {
1963         struct snd_soc_component *component;
1964         const struct snd_soc_component_driver *comp_drv;
1965         struct snd_soc_dai_link *dai_link;
1966         int i;
1967
1968         for_each_component(component) {
1969
1970                 /* does this component override FEs ? */
1971                 if (!component->driver->ignore_machine)
1972                         continue;
1973
1974                 /* for this machine ? */
1975                 if (!strcmp(component->driver->ignore_machine,
1976                             card->dev->driver->name))
1977                         goto match;
1978                 if (strcmp(component->driver->ignore_machine,
1979                            dev_name(card->dev)))
1980                         continue;
1981 match:
1982                 /* machine matches, so override the rtd data */
1983                 for_each_card_prelinks(card, i, dai_link) {
1984
1985                         /* ignore this FE */
1986                         if (dai_link->dynamic) {
1987                                 dai_link->ignore = true;
1988                                 continue;
1989                         }
1990
1991                         dev_info(card->dev, "info: override FE DAI link %s\n",
1992                                  card->dai_link[i].name);
1993
1994                         /* override platform component */
1995                         if (snd_soc_init_platform(card, dai_link) < 0) {
1996                                 dev_err(card->dev, "init platform error");
1997                                 continue;
1998                         }
1999                         dai_link->platforms->name = component->name;
2000
2001                         /* convert non BE into BE */
2002                         dai_link->no_pcm = 1;
2003
2004                         /* override any BE fixups */
2005                         dai_link->be_hw_params_fixup =
2006                                 component->driver->be_hw_params_fixup;
2007
2008                         /*
2009                          * most BE links don't set stream name, so set it to
2010                          * dai link name if it's NULL to help bind widgets.
2011                          */
2012                         if (!dai_link->stream_name)
2013                                 dai_link->stream_name = dai_link->name;
2014                 }
2015
2016                 /* Inform userspace we are using alternate topology */
2017                 if (component->driver->topology_name_prefix) {
2018
2019                         /* topology shortname created? */
2020                         if (!card->topology_shortname_created) {
2021                                 comp_drv = component->driver;
2022
2023                                 snprintf(card->topology_shortname, 32, "%s-%s",
2024                                          comp_drv->topology_name_prefix,
2025                                          card->name);
2026                                 card->topology_shortname_created = true;
2027                         }
2028
2029                         /* use topology shortname */
2030                         card->name = card->topology_shortname;
2031                 }
2032         }
2033 }
2034
2035 static int soc_cleanup_card_resources(struct snd_soc_card *card)
2036 {
2037         /* free the ALSA card at first; this syncs with pending operations */
2038         if (card->snd_card)
2039                 snd_card_free(card->snd_card);
2040
2041         /* remove and free each DAI */
2042         soc_remove_dai_links(card);
2043         soc_remove_pcm_runtimes(card);
2044         soc_cleanup_platform(card);
2045
2046         /* remove auxiliary devices */
2047         soc_remove_aux_devices(card);
2048
2049         snd_soc_dapm_free(&card->dapm);
2050         soc_cleanup_card_debugfs(card);
2051
2052         /* remove the card */
2053         if (card->remove)
2054                 card->remove(card);
2055
2056         return 0;
2057 }
2058
2059 static int snd_soc_instantiate_card(struct snd_soc_card *card)
2060 {
2061         struct snd_soc_pcm_runtime *rtd;
2062         struct snd_soc_dai_link *dai_link;
2063         int ret, i, order;
2064
2065         mutex_lock(&client_mutex);
2066         mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
2067
2068         card->dapm.bias_level = SND_SOC_BIAS_OFF;
2069         card->dapm.dev = card->dev;
2070         card->dapm.card = card;
2071         list_add(&card->dapm.list, &card->dapm_list);
2072
2073         /* check whether any platform is ignore machine FE and using topology */
2074         soc_check_tplg_fes(card);
2075
2076         /* bind DAIs */
2077         for_each_card_prelinks(card, i, dai_link) {
2078                 ret = soc_bind_dai_link(card, dai_link);
2079                 if (ret != 0)
2080                         goto probe_end;
2081         }
2082
2083         /* bind aux_devs too */
2084         for (i = 0; i < card->num_aux_devs; i++) {
2085                 ret = soc_bind_aux_dev(card, i);
2086                 if (ret != 0)
2087                         goto probe_end;
2088         }
2089
2090         /* add predefined DAI links to the list */
2091         for_each_card_prelinks(card, i, dai_link)
2092                 snd_soc_add_dai_link(card, dai_link);
2093
2094         /* card bind complete so register a sound card */
2095         ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2096                         card->owner, 0, &card->snd_card);
2097         if (ret < 0) {
2098                 dev_err(card->dev,
2099                         "ASoC: can't create sound card for card %s: %d\n",
2100                         card->name, ret);
2101                 goto probe_end;
2102         }
2103
2104         soc_init_card_debugfs(card);
2105
2106 #ifdef CONFIG_DEBUG_FS
2107         snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
2108 #endif
2109
2110 #ifdef CONFIG_PM_SLEEP
2111         /* deferred resume work */
2112         INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
2113 #endif
2114
2115         if (card->dapm_widgets)
2116                 snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2117                                           card->num_dapm_widgets);
2118
2119         if (card->of_dapm_widgets)
2120                 snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2121                                           card->num_of_dapm_widgets);
2122
2123         /* initialise the sound card only once */
2124         if (card->probe) {
2125                 ret = card->probe(card);
2126                 if (ret < 0)
2127                         goto probe_end;
2128         }
2129
2130         /* probe all components used by DAI links on this card */
2131         for_each_comp_order(order) {
2132                 for_each_card_rtds(card, rtd) {
2133                         ret = soc_probe_link_components(card, rtd, order);
2134                         if (ret < 0) {
2135                                 dev_err(card->dev,
2136                                         "ASoC: failed to instantiate card %d\n",
2137                                         ret);
2138                                 goto probe_end;
2139                         }
2140                 }
2141         }
2142
2143         /* probe auxiliary components */
2144         ret = soc_probe_aux_devices(card);
2145         if (ret < 0)
2146                 goto probe_end;
2147
2148         /*
2149          * Find new DAI links added during probing components and bind them.
2150          * Components with topology may bring new DAIs and DAI links.
2151          */
2152         for_each_card_links(card, dai_link) {
2153                 if (soc_is_dai_link_bound(card, dai_link))
2154                         continue;
2155
2156                 ret = soc_init_dai_link(card, dai_link);
2157                 if (ret)
2158                         goto probe_end;
2159                 ret = soc_bind_dai_link(card, dai_link);
2160                 if (ret)
2161                         goto probe_end;
2162         }
2163
2164         /* probe all DAI links on this card */
2165         for_each_comp_order(order) {
2166                 for_each_card_rtds(card, rtd) {
2167                         ret = soc_probe_link_dais(card, rtd, order);
2168                         if (ret < 0) {
2169                                 dev_err(card->dev,
2170                                         "ASoC: failed to instantiate card %d\n",
2171                                         ret);
2172                                 goto probe_end;
2173                         }
2174                 }
2175         }
2176
2177         snd_soc_dapm_link_dai_widgets(card);
2178         snd_soc_dapm_connect_dai_link_widgets(card);
2179
2180         if (card->controls)
2181                 snd_soc_add_card_controls(card, card->controls,
2182                                           card->num_controls);
2183
2184         if (card->dapm_routes)
2185                 snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2186                                         card->num_dapm_routes);
2187
2188         if (card->of_dapm_routes)
2189                 snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2190                                         card->num_of_dapm_routes);
2191
2192         /* try to set some sane longname if DMI is available */
2193         snd_soc_set_dmi_name(card, NULL);
2194
2195         snprintf(card->snd_card->shortname, sizeof(card->snd_card->shortname),
2196                  "%s", card->name);
2197         snprintf(card->snd_card->longname, sizeof(card->snd_card->longname),
2198                  "%s", card->long_name ? card->long_name : card->name);
2199         snprintf(card->snd_card->driver, sizeof(card->snd_card->driver),
2200                  "%s", card->driver_name ? card->driver_name : card->name);
2201         for (i = 0; i < ARRAY_SIZE(card->snd_card->driver); i++) {
2202                 switch (card->snd_card->driver[i]) {
2203                 case '_':
2204                 case '-':
2205                 case '\0':
2206                         break;
2207                 default:
2208                         if (!isalnum(card->snd_card->driver[i]))
2209                                 card->snd_card->driver[i] = '_';
2210                         break;
2211                 }
2212         }
2213
2214         if (card->late_probe) {
2215                 ret = card->late_probe(card);
2216                 if (ret < 0) {
2217                         dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2218                                 card->name, ret);
2219                         goto probe_end;
2220                 }
2221         }
2222
2223         snd_soc_dapm_new_widgets(card);
2224
2225         ret = snd_card_register(card->snd_card);
2226         if (ret < 0) {
2227                 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2228                                 ret);
2229                 goto probe_end;
2230         }
2231
2232         card->instantiated = 1;
2233         dapm_mark_endpoints_dirty(card);
2234         snd_soc_dapm_sync(&card->dapm);
2235
2236 probe_end:
2237         if (ret < 0)
2238                 soc_cleanup_card_resources(card);
2239
2240         mutex_unlock(&card->mutex);
2241         mutex_unlock(&client_mutex);
2242
2243         return ret;
2244 }
2245
2246 /* probes a new socdev */
2247 static int soc_probe(struct platform_device *pdev)
2248 {
2249         struct snd_soc_card *card = platform_get_drvdata(pdev);
2250
2251         /*
2252          * no card, so machine driver should be registering card
2253          * we should not be here in that case so ret error
2254          */
2255         if (!card)
2256                 return -EINVAL;
2257
2258         dev_warn(&pdev->dev,
2259                  "ASoC: machine %s should use snd_soc_register_card()\n",
2260                  card->name);
2261
2262         /* Bodge while we unpick instantiation */
2263         card->dev = &pdev->dev;
2264
2265         return snd_soc_register_card(card);
2266 }
2267
2268 /* removes a socdev */
2269 static int soc_remove(struct platform_device *pdev)
2270 {
2271         struct snd_soc_card *card = platform_get_drvdata(pdev);
2272
2273         snd_soc_unregister_card(card);
2274         return 0;
2275 }
2276
2277 int snd_soc_poweroff(struct device *dev)
2278 {
2279         struct snd_soc_card *card = dev_get_drvdata(dev);
2280         struct snd_soc_pcm_runtime *rtd;
2281
2282         if (!card->instantiated)
2283                 return 0;
2284
2285         /*
2286          * Flush out pmdown_time work - we actually do want to run it
2287          * now, we're shutting down so no imminent restart.
2288          */
2289         snd_soc_flush_all_delayed_work(card);
2290
2291         snd_soc_dapm_shutdown(card);
2292
2293         /* deactivate pins to sleep state */
2294         for_each_card_rtds(card, rtd) {
2295                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2296                 struct snd_soc_dai *codec_dai;
2297                 int i;
2298
2299                 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2300                 for_each_rtd_codec_dai(rtd, i, codec_dai) {
2301                         pinctrl_pm_select_sleep_state(codec_dai->dev);
2302                 }
2303         }
2304
2305         return 0;
2306 }
2307 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2308
2309 const struct dev_pm_ops snd_soc_pm_ops = {
2310         .suspend = snd_soc_suspend,
2311         .resume = snd_soc_resume,
2312         .freeze = snd_soc_suspend,
2313         .thaw = snd_soc_resume,
2314         .poweroff = snd_soc_poweroff,
2315         .restore = snd_soc_resume,
2316 };
2317 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2318
2319 /* ASoC platform driver */
2320 static struct platform_driver soc_driver = {
2321         .driver         = {
2322                 .name           = "soc-audio",
2323                 .pm             = &snd_soc_pm_ops,
2324         },
2325         .probe          = soc_probe,
2326         .remove         = soc_remove,
2327 };
2328
2329 /**
2330  * snd_soc_cnew - create new control
2331  * @_template: control template
2332  * @data: control private data
2333  * @long_name: control long name
2334  * @prefix: control name prefix
2335  *
2336  * Create a new mixer control from a template control.
2337  *
2338  * Returns 0 for success, else error.
2339  */
2340 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2341                                   void *data, const char *long_name,
2342                                   const char *prefix)
2343 {
2344         struct snd_kcontrol_new template;
2345         struct snd_kcontrol *kcontrol;
2346         char *name = NULL;
2347
2348         memcpy(&template, _template, sizeof(template));
2349         template.index = 0;
2350
2351         if (!long_name)
2352                 long_name = template.name;
2353
2354         if (prefix) {
2355                 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2356                 if (!name)
2357                         return NULL;
2358
2359                 template.name = name;
2360         } else {
2361                 template.name = long_name;
2362         }
2363
2364         kcontrol = snd_ctl_new1(&template, data);
2365
2366         kfree(name);
2367
2368         return kcontrol;
2369 }
2370 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2371
2372 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2373         const struct snd_kcontrol_new *controls, int num_controls,
2374         const char *prefix, void *data)
2375 {
2376         int err, i;
2377
2378         for (i = 0; i < num_controls; i++) {
2379                 const struct snd_kcontrol_new *control = &controls[i];
2380
2381                 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2382                                                      control->name, prefix));
2383                 if (err < 0) {
2384                         dev_err(dev, "ASoC: Failed to add %s: %d\n",
2385                                 control->name, err);
2386                         return err;
2387                 }
2388         }
2389
2390         return 0;
2391 }
2392
2393 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2394                                                const char *name)
2395 {
2396         struct snd_card *card = soc_card->snd_card;
2397         struct snd_kcontrol *kctl;
2398
2399         if (unlikely(!name))
2400                 return NULL;
2401
2402         list_for_each_entry(kctl, &card->controls, list)
2403                 if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2404                         return kctl;
2405         return NULL;
2406 }
2407 EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2408
2409 /**
2410  * snd_soc_add_component_controls - Add an array of controls to a component.
2411  *
2412  * @component: Component to add controls to
2413  * @controls: Array of controls to add
2414  * @num_controls: Number of elements in the array
2415  *
2416  * Return: 0 for success, else error.
2417  */
2418 int snd_soc_add_component_controls(struct snd_soc_component *component,
2419         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2420 {
2421         struct snd_card *card = component->card->snd_card;
2422
2423         return snd_soc_add_controls(card, component->dev, controls,
2424                         num_controls, component->name_prefix, component);
2425 }
2426 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2427
2428 /**
2429  * snd_soc_add_card_controls - add an array of controls to a SoC card.
2430  * Convenience function to add a list of controls.
2431  *
2432  * @soc_card: SoC card to add controls to
2433  * @controls: array of controls to add
2434  * @num_controls: number of elements in the array
2435  *
2436  * Return 0 for success, else error.
2437  */
2438 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2439         const struct snd_kcontrol_new *controls, int num_controls)
2440 {
2441         struct snd_card *card = soc_card->snd_card;
2442
2443         return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2444                         NULL, soc_card);
2445 }
2446 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2447
2448 /**
2449  * snd_soc_add_dai_controls - add an array of controls to a DAI.
2450  * Convienience function to add a list of controls.
2451  *
2452  * @dai: DAI to add controls to
2453  * @controls: array of controls to add
2454  * @num_controls: number of elements in the array
2455  *
2456  * Return 0 for success, else error.
2457  */
2458 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2459         const struct snd_kcontrol_new *controls, int num_controls)
2460 {
2461         struct snd_card *card = dai->component->card->snd_card;
2462
2463         return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2464                         NULL, dai);
2465 }
2466 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2467
2468 /**
2469  * snd_soc_dai_set_sysclk - configure DAI system or master clock.
2470  * @dai: DAI
2471  * @clk_id: DAI specific clock ID
2472  * @freq: new clock frequency in Hz
2473  * @dir: new clock direction - input/output.
2474  *
2475  * Configures the DAI master (MCLK) or system (SYSCLK) clocking.
2476  */
2477 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
2478         unsigned int freq, int dir)
2479 {
2480         if (dai->driver->ops->set_sysclk)
2481                 return dai->driver->ops->set_sysclk(dai, clk_id, freq, dir);
2482
2483         return snd_soc_component_set_sysclk(dai->component, clk_id, 0,
2484                                             freq, dir);
2485 }
2486 EXPORT_SYMBOL_GPL(snd_soc_dai_set_sysclk);
2487
2488 /**
2489  * snd_soc_component_set_sysclk - configure COMPONENT system or master clock.
2490  * @component: COMPONENT
2491  * @clk_id: DAI specific clock ID
2492  * @source: Source for the clock
2493  * @freq: new clock frequency in Hz
2494  * @dir: new clock direction - input/output.
2495  *
2496  * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
2497  */
2498 int snd_soc_component_set_sysclk(struct snd_soc_component *component,
2499                                  int clk_id, int source, unsigned int freq,
2500                                  int dir)
2501 {
2502         if (component->driver->set_sysclk)
2503                 return component->driver->set_sysclk(component, clk_id, source,
2504                                                  freq, dir);
2505
2506         return -ENOTSUPP;
2507 }
2508 EXPORT_SYMBOL_GPL(snd_soc_component_set_sysclk);
2509
2510 /**
2511  * snd_soc_dai_set_clkdiv - configure DAI clock dividers.
2512  * @dai: DAI
2513  * @div_id: DAI specific clock divider ID
2514  * @div: new clock divisor.
2515  *
2516  * Configures the clock dividers. This is used to derive the best DAI bit and
2517  * frame clocks from the system or master clock. It's best to set the DAI bit
2518  * and frame clocks as low as possible to save system power.
2519  */
2520 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
2521         int div_id, int div)
2522 {
2523         if (dai->driver->ops->set_clkdiv)
2524                 return dai->driver->ops->set_clkdiv(dai, div_id, div);
2525         else
2526                 return -EINVAL;
2527 }
2528 EXPORT_SYMBOL_GPL(snd_soc_dai_set_clkdiv);
2529
2530 /**
2531  * snd_soc_dai_set_pll - configure DAI PLL.
2532  * @dai: DAI
2533  * @pll_id: DAI specific PLL ID
2534  * @source: DAI specific source for the PLL
2535  * @freq_in: PLL input clock frequency in Hz
2536  * @freq_out: requested PLL output clock frequency in Hz
2537  *
2538  * Configures and enables PLL to generate output clock based on input clock.
2539  */
2540 int snd_soc_dai_set_pll(struct snd_soc_dai *dai, int pll_id, int source,
2541         unsigned int freq_in, unsigned int freq_out)
2542 {
2543         if (dai->driver->ops->set_pll)
2544                 return dai->driver->ops->set_pll(dai, pll_id, source,
2545                                          freq_in, freq_out);
2546
2547         return snd_soc_component_set_pll(dai->component, pll_id, source,
2548                                          freq_in, freq_out);
2549 }
2550 EXPORT_SYMBOL_GPL(snd_soc_dai_set_pll);
2551
2552 /*
2553  * snd_soc_component_set_pll - configure component PLL.
2554  * @component: COMPONENT
2555  * @pll_id: DAI specific PLL ID
2556  * @source: DAI specific source for the PLL
2557  * @freq_in: PLL input clock frequency in Hz
2558  * @freq_out: requested PLL output clock frequency in Hz
2559  *
2560  * Configures and enables PLL to generate output clock based on input clock.
2561  */
2562 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
2563                               int source, unsigned int freq_in,
2564                               unsigned int freq_out)
2565 {
2566         if (component->driver->set_pll)
2567                 return component->driver->set_pll(component, pll_id, source,
2568                                                   freq_in, freq_out);
2569
2570         return -EINVAL;
2571 }
2572 EXPORT_SYMBOL_GPL(snd_soc_component_set_pll);
2573
2574 /**
2575  * snd_soc_dai_set_bclk_ratio - configure BCLK to sample rate ratio.
2576  * @dai: DAI
2577  * @ratio: Ratio of BCLK to Sample rate.
2578  *
2579  * Configures the DAI for a preset BCLK to sample rate ratio.
2580  */
2581 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio)
2582 {
2583         if (dai->driver->ops->set_bclk_ratio)
2584                 return dai->driver->ops->set_bclk_ratio(dai, ratio);
2585         else
2586                 return -EINVAL;
2587 }
2588 EXPORT_SYMBOL_GPL(snd_soc_dai_set_bclk_ratio);
2589
2590 /**
2591  * snd_soc_dai_set_fmt - configure DAI hardware audio format.
2592  * @dai: DAI
2593  * @fmt: SND_SOC_DAIFMT_* format value.
2594  *
2595  * Configures the DAI hardware format and clocking.
2596  */
2597 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
2598 {
2599         if (dai->driver->ops->set_fmt == NULL)
2600                 return -ENOTSUPP;
2601         return dai->driver->ops->set_fmt(dai, fmt);
2602 }
2603 EXPORT_SYMBOL_GPL(snd_soc_dai_set_fmt);
2604
2605 /**
2606  * snd_soc_xlate_tdm_slot - generate tx/rx slot mask.
2607  * @slots: Number of slots in use.
2608  * @tx_mask: bitmask representing active TX slots.
2609  * @rx_mask: bitmask representing active RX slots.
2610  *
2611  * Generates the TDM tx and rx slot default masks for DAI.
2612  */
2613 static int snd_soc_xlate_tdm_slot_mask(unsigned int slots,
2614                                        unsigned int *tx_mask,
2615                                        unsigned int *rx_mask)
2616 {
2617         if (*tx_mask || *rx_mask)
2618                 return 0;
2619
2620         if (!slots)
2621                 return -EINVAL;
2622
2623         *tx_mask = (1 << slots) - 1;
2624         *rx_mask = (1 << slots) - 1;
2625
2626         return 0;
2627 }
2628
2629 /**
2630  * snd_soc_dai_set_tdm_slot() - Configures a DAI for TDM operation
2631  * @dai: The DAI to configure
2632  * @tx_mask: bitmask representing active TX slots.
2633  * @rx_mask: bitmask representing active RX slots.
2634  * @slots: Number of slots in use.
2635  * @slot_width: Width in bits for each slot.
2636  *
2637  * This function configures the specified DAI for TDM operation. @slot contains
2638  * the total number of slots of the TDM stream and @slot_with the width of each
2639  * slot in bit clock cycles. @tx_mask and @rx_mask are bitmasks specifying the
2640  * active slots of the TDM stream for the specified DAI, i.e. which slots the
2641  * DAI should write to or read from. If a bit is set the corresponding slot is
2642  * active, if a bit is cleared the corresponding slot is inactive. Bit 0 maps to
2643  * the first slot, bit 1 to the second slot and so on. The first active slot
2644  * maps to the first channel of the DAI, the second active slot to the second
2645  * channel and so on.
2646  *
2647  * TDM mode can be disabled by passing 0 for @slots. In this case @tx_mask,
2648  * @rx_mask and @slot_width will be ignored.
2649  *
2650  * Returns 0 on success, a negative error code otherwise.
2651  */
2652 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
2653         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width)
2654 {
2655         if (dai->driver->ops->xlate_tdm_slot_mask)
2656                 dai->driver->ops->xlate_tdm_slot_mask(slots,
2657                                                 &tx_mask, &rx_mask);
2658         else
2659                 snd_soc_xlate_tdm_slot_mask(slots, &tx_mask, &rx_mask);
2660
2661         dai->tx_mask = tx_mask;
2662         dai->rx_mask = rx_mask;
2663
2664         if (dai->driver->ops->set_tdm_slot)
2665                 return dai->driver->ops->set_tdm_slot(dai, tx_mask, rx_mask,
2666                                 slots, slot_width);
2667         else
2668                 return -ENOTSUPP;
2669 }
2670 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tdm_slot);
2671
2672 /**
2673  * snd_soc_dai_set_channel_map - configure DAI audio channel map
2674  * @dai: DAI
2675  * @tx_num: how many TX channels
2676  * @tx_slot: pointer to an array which imply the TX slot number channel
2677  *           0~num-1 uses
2678  * @rx_num: how many RX channels
2679  * @rx_slot: pointer to an array which imply the RX slot number channel
2680  *           0~num-1 uses
2681  *
2682  * configure the relationship between channel number and TDM slot number.
2683  */
2684 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
2685         unsigned int tx_num, unsigned int *tx_slot,
2686         unsigned int rx_num, unsigned int *rx_slot)
2687 {
2688         if (dai->driver->ops->set_channel_map)
2689                 return dai->driver->ops->set_channel_map(dai, tx_num, tx_slot,
2690                         rx_num, rx_slot);
2691         else
2692                 return -EINVAL;
2693 }
2694 EXPORT_SYMBOL_GPL(snd_soc_dai_set_channel_map);
2695
2696 /**
2697  * snd_soc_dai_get_channel_map - Get DAI audio channel map
2698  * @dai: DAI
2699  * @tx_num: how many TX channels
2700  * @tx_slot: pointer to an array which imply the TX slot number channel
2701  *           0~num-1 uses
2702  * @rx_num: how many RX channels
2703  * @rx_slot: pointer to an array which imply the RX slot number channel
2704  *           0~num-1 uses
2705  */
2706 int snd_soc_dai_get_channel_map(struct snd_soc_dai *dai,
2707         unsigned int *tx_num, unsigned int *tx_slot,
2708         unsigned int *rx_num, unsigned int *rx_slot)
2709 {
2710         if (dai->driver->ops->get_channel_map)
2711                 return dai->driver->ops->get_channel_map(dai, tx_num, tx_slot,
2712                         rx_num, rx_slot);
2713         else
2714                 return -ENOTSUPP;
2715 }
2716 EXPORT_SYMBOL_GPL(snd_soc_dai_get_channel_map);
2717
2718 /**
2719  * snd_soc_dai_set_tristate - configure DAI system or master clock.
2720  * @dai: DAI
2721  * @tristate: tristate enable
2722  *
2723  * Tristates the DAI so that others can use it.
2724  */
2725 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate)
2726 {
2727         if (dai->driver->ops->set_tristate)
2728                 return dai->driver->ops->set_tristate(dai, tristate);
2729         else
2730                 return -EINVAL;
2731 }
2732 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tristate);
2733
2734 /**
2735  * snd_soc_dai_digital_mute - configure DAI system or master clock.
2736  * @dai: DAI
2737  * @mute: mute enable
2738  * @direction: stream to mute
2739  *
2740  * Mutes the DAI DAC.
2741  */
2742 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
2743                              int direction)
2744 {
2745         if (dai->driver->ops->mute_stream)
2746                 return dai->driver->ops->mute_stream(dai, mute, direction);
2747         else if (direction == SNDRV_PCM_STREAM_PLAYBACK &&
2748                  dai->driver->ops->digital_mute)
2749                 return dai->driver->ops->digital_mute(dai, mute);
2750         else
2751                 return -ENOTSUPP;
2752 }
2753 EXPORT_SYMBOL_GPL(snd_soc_dai_digital_mute);
2754
2755 static int snd_soc_bind_card(struct snd_soc_card *card)
2756 {
2757         struct snd_soc_pcm_runtime *rtd;
2758         int ret;
2759
2760         ret = snd_soc_instantiate_card(card);
2761         if (ret != 0)
2762                 return ret;
2763
2764         /* deactivate pins to sleep state */
2765         for_each_card_rtds(card, rtd) {
2766                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2767                 struct snd_soc_dai *codec_dai;
2768                 int j;
2769
2770                 for_each_rtd_codec_dai(rtd, j, codec_dai) {
2771                         if (!codec_dai->active)
2772                                 pinctrl_pm_select_sleep_state(codec_dai->dev);
2773                 }
2774
2775                 if (!cpu_dai->active)
2776                         pinctrl_pm_select_sleep_state(cpu_dai->dev);
2777         }
2778
2779         return ret;
2780 }
2781
2782 /**
2783  * snd_soc_register_card - Register a card with the ASoC core
2784  *
2785  * @card: Card to register
2786  *
2787  */
2788 int snd_soc_register_card(struct snd_soc_card *card)
2789 {
2790         int i, ret;
2791         struct snd_soc_dai_link *link;
2792
2793         if (!card->name || !card->dev)
2794                 return -EINVAL;
2795
2796         mutex_lock(&client_mutex);
2797         for_each_card_prelinks(card, i, link) {
2798
2799                 ret = soc_init_dai_link(card, link);
2800                 if (ret) {
2801                         soc_cleanup_platform(card);
2802                         dev_err(card->dev, "ASoC: failed to init link %s\n",
2803                                 link->name);
2804                         mutex_unlock(&client_mutex);
2805                         return ret;
2806                 }
2807         }
2808         mutex_unlock(&client_mutex);
2809
2810         dev_set_drvdata(card->dev, card);
2811
2812         snd_soc_initialize_card_lists(card);
2813
2814         INIT_LIST_HEAD(&card->dai_link_list);
2815
2816         INIT_LIST_HEAD(&card->rtd_list);
2817         card->num_rtd = 0;
2818
2819         INIT_LIST_HEAD(&card->dapm_dirty);
2820         INIT_LIST_HEAD(&card->dobj_list);
2821         card->instantiated = 0;
2822         mutex_init(&card->mutex);
2823         mutex_init(&card->dapm_mutex);
2824         spin_lock_init(&card->dpcm_lock);
2825
2826         return snd_soc_bind_card(card);
2827 }
2828 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2829
2830 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
2831 {
2832         struct snd_soc_pcm_runtime *rtd;
2833         int order;
2834
2835         if (card->instantiated) {
2836                 card->instantiated = false;
2837                 snd_soc_dapm_shutdown(card);
2838                 snd_soc_flush_all_delayed_work(card);
2839
2840                 /* remove all components used by DAI links on this card */
2841                 for_each_comp_order(order) {
2842                         for_each_card_rtds(card, rtd) {
2843                                 soc_remove_link_components(card, rtd, order);
2844                         }
2845                 }
2846
2847                 soc_cleanup_card_resources(card);
2848                 if (!unregister)
2849                         list_add(&card->list, &unbind_card_list);
2850         } else {
2851                 if (unregister)
2852                         list_del(&card->list);
2853         }
2854 }
2855
2856 /**
2857  * snd_soc_unregister_card - Unregister a card with the ASoC core
2858  *
2859  * @card: Card to unregister
2860  *
2861  */
2862 int snd_soc_unregister_card(struct snd_soc_card *card)
2863 {
2864         snd_soc_unbind_card(card, true);
2865         dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2866
2867         return 0;
2868 }
2869 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2870
2871 /*
2872  * Simplify DAI link configuration by removing ".-1" from device names
2873  * and sanitizing names.
2874  */
2875 static char *fmt_single_name(struct device *dev, int *id)
2876 {
2877         char *found, name[NAME_SIZE];
2878         int id1, id2;
2879
2880         if (dev_name(dev) == NULL)
2881                 return NULL;
2882
2883         strlcpy(name, dev_name(dev), NAME_SIZE);
2884
2885         /* are we a "%s.%d" name (platform and SPI components) */
2886         found = strstr(name, dev->driver->name);
2887         if (found) {
2888                 /* get ID */
2889                 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2890
2891                         /* discard ID from name if ID == -1 */
2892                         if (*id == -1)
2893                                 found[strlen(dev->driver->name)] = '\0';
2894                 }
2895
2896         } else {
2897                 /* I2C component devices are named "bus-addr" */
2898                 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2899                         char tmp[NAME_SIZE];
2900
2901                         /* create unique ID number from I2C addr and bus */
2902                         *id = ((id1 & 0xffff) << 16) + id2;
2903
2904                         /* sanitize component name for DAI link creation */
2905                         snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2906                                  name);
2907                         strlcpy(name, tmp, NAME_SIZE);
2908                 } else
2909                         *id = 0;
2910         }
2911
2912         return kstrdup(name, GFP_KERNEL);
2913 }
2914
2915 /*
2916  * Simplify DAI link naming for single devices with multiple DAIs by removing
2917  * any ".-1" and using the DAI name (instead of device name).
2918  */
2919 static inline char *fmt_multiple_name(struct device *dev,
2920                 struct snd_soc_dai_driver *dai_drv)
2921 {
2922         if (dai_drv->name == NULL) {
2923                 dev_err(dev,
2924                         "ASoC: error - multiple DAI %s registered with no name\n",
2925                         dev_name(dev));
2926                 return NULL;
2927         }
2928
2929         return kstrdup(dai_drv->name, GFP_KERNEL);
2930 }
2931
2932 /**
2933  * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2934  *
2935  * @component: The component for which the DAIs should be unregistered
2936  */
2937 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2938 {
2939         struct snd_soc_dai *dai, *_dai;
2940
2941         for_each_component_dais_safe(component, dai, _dai) {
2942                 dev_dbg(component->dev, "ASoC: Unregistered DAI '%s'\n",
2943                         dai->name);
2944                 list_del(&dai->list);
2945                 kfree(dai->name);
2946                 kfree(dai);
2947         }
2948 }
2949
2950 /* Create a DAI and add it to the component's DAI list */
2951 static struct snd_soc_dai *soc_add_dai(struct snd_soc_component *component,
2952         struct snd_soc_dai_driver *dai_drv,
2953         bool legacy_dai_naming)
2954 {
2955         struct device *dev = component->dev;
2956         struct snd_soc_dai *dai;
2957
2958         dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2959
2960         dai = kzalloc(sizeof(struct snd_soc_dai), GFP_KERNEL);
2961         if (dai == NULL)
2962                 return NULL;
2963
2964         /*
2965          * Back in the old days when we still had component-less DAIs,
2966          * instead of having a static name, component-less DAIs would
2967          * inherit the name of the parent device so it is possible to
2968          * register multiple instances of the DAI. We still need to keep
2969          * the same naming style even though those DAIs are not
2970          * component-less anymore.
2971          */
2972         if (legacy_dai_naming &&
2973             (dai_drv->id == 0 || dai_drv->name == NULL)) {
2974                 dai->name = fmt_single_name(dev, &dai->id);
2975         } else {
2976                 dai->name = fmt_multiple_name(dev, dai_drv);
2977                 if (dai_drv->id)
2978                         dai->id = dai_drv->id;
2979                 else
2980                         dai->id = component->num_dai;
2981         }
2982         if (dai->name == NULL) {
2983                 kfree(dai);
2984                 return NULL;
2985         }
2986
2987         dai->component = component;
2988         dai->dev = dev;
2989         dai->driver = dai_drv;
2990         if (!dai->driver->ops)
2991                 dai->driver->ops = &null_dai_ops;
2992
2993         /* see for_each_component_dais */
2994         list_add_tail(&dai->list, &component->dai_list);
2995         component->num_dai++;
2996
2997         dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2998         return dai;
2999 }
3000
3001 /**
3002  * snd_soc_register_dais - Register a DAI with the ASoC core
3003  *
3004  * @component: The component the DAIs are registered for
3005  * @dai_drv: DAI driver to use for the DAIs
3006  * @count: Number of DAIs
3007  */
3008 static int snd_soc_register_dais(struct snd_soc_component *component,
3009                                  struct snd_soc_dai_driver *dai_drv,
3010                                  size_t count)
3011 {
3012         struct device *dev = component->dev;
3013         struct snd_soc_dai *dai;
3014         unsigned int i;
3015         int ret;
3016
3017         dev_dbg(dev, "ASoC: dai register %s #%zu\n", dev_name(dev), count);
3018
3019         for (i = 0; i < count; i++) {
3020
3021                 dai = soc_add_dai(component, dai_drv + i, count == 1 &&
3022                                   !component->driver->non_legacy_dai_naming);
3023                 if (dai == NULL) {
3024                         ret = -ENOMEM;
3025                         goto err;
3026                 }
3027         }
3028
3029         return 0;
3030
3031 err:
3032         snd_soc_unregister_dais(component);
3033
3034         return ret;
3035 }
3036
3037 /**
3038  * snd_soc_register_dai - Register a DAI dynamically & create its widgets
3039  *
3040  * @component: The component the DAIs are registered for
3041  * @dai_drv: DAI driver to use for the DAI
3042  *
3043  * Topology can use this API to register DAIs when probing a component.
3044  * These DAIs's widgets will be freed in the card cleanup and the DAIs
3045  * will be freed in the component cleanup.
3046  */
3047 int snd_soc_register_dai(struct snd_soc_component *component,
3048         struct snd_soc_dai_driver *dai_drv)
3049 {
3050         struct snd_soc_dapm_context *dapm =
3051                 snd_soc_component_get_dapm(component);
3052         struct snd_soc_dai *dai;
3053         int ret;
3054
3055         if (dai_drv->dobj.type != SND_SOC_DOBJ_PCM) {
3056                 dev_err(component->dev, "Invalid dai type %d\n",
3057                         dai_drv->dobj.type);
3058                 return -EINVAL;
3059         }
3060
3061         lockdep_assert_held(&client_mutex);
3062         dai = soc_add_dai(component, dai_drv, false);
3063         if (!dai)
3064                 return -ENOMEM;
3065
3066         /*
3067          * Create the DAI widgets here. After adding DAIs, topology may
3068          * also add routes that need these widgets as source or sink.
3069          */
3070         ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
3071         if (ret != 0) {
3072                 dev_err(component->dev,
3073                         "Failed to create DAI widgets %d\n", ret);
3074         }
3075
3076         return ret;
3077 }
3078 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
3079
3080 static void snd_soc_component_seq_notifier(struct snd_soc_dapm_context *dapm,
3081         enum snd_soc_dapm_type type, int subseq)
3082 {
3083         struct snd_soc_component *component = dapm->component;
3084
3085         component->driver->seq_notifier(component, type, subseq);
3086 }
3087
3088 static int snd_soc_component_stream_event(struct snd_soc_dapm_context *dapm,
3089         int event)
3090 {
3091         struct snd_soc_component *component = dapm->component;
3092
3093         return component->driver->stream_event(component, event);
3094 }
3095
3096 static int snd_soc_component_set_bias_level(struct snd_soc_dapm_context *dapm,
3097                                         enum snd_soc_bias_level level)
3098 {
3099         struct snd_soc_component *component = dapm->component;
3100
3101         return component->driver->set_bias_level(component, level);
3102 }
3103
3104 static int snd_soc_component_initialize(struct snd_soc_component *component,
3105         const struct snd_soc_component_driver *driver, struct device *dev)
3106 {
3107         struct snd_soc_dapm_context *dapm;
3108
3109         component->name = fmt_single_name(dev, &component->id);
3110         if (!component->name) {
3111                 dev_err(dev, "ASoC: Failed to allocate name\n");
3112                 return -ENOMEM;
3113         }
3114
3115         component->dev = dev;
3116         component->driver = driver;
3117
3118         dapm = snd_soc_component_get_dapm(component);
3119         dapm->dev = dev;
3120         dapm->component = component;
3121         dapm->bias_level = SND_SOC_BIAS_OFF;
3122         dapm->idle_bias_off = !driver->idle_bias_on;
3123         dapm->suspend_bias_off = driver->suspend_bias_off;
3124         if (driver->seq_notifier)
3125                 dapm->seq_notifier = snd_soc_component_seq_notifier;
3126         if (driver->stream_event)
3127                 dapm->stream_event = snd_soc_component_stream_event;
3128         if (driver->set_bias_level)
3129                 dapm->set_bias_level = snd_soc_component_set_bias_level;
3130
3131         INIT_LIST_HEAD(&component->dai_list);
3132         mutex_init(&component->io_mutex);
3133
3134         return 0;
3135 }
3136
3137 static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
3138 {
3139         int val_bytes = regmap_get_val_bytes(component->regmap);
3140
3141         /* Errors are legitimate for non-integer byte multiples */
3142         if (val_bytes > 0)
3143                 component->val_bytes = val_bytes;
3144 }
3145
3146 #ifdef CONFIG_REGMAP
3147
3148 /**
3149  * snd_soc_component_init_regmap() - Initialize regmap instance for the
3150  *                                   component
3151  * @component: The component for which to initialize the regmap instance
3152  * @regmap: The regmap instance that should be used by the component
3153  *
3154  * This function allows deferred assignment of the regmap instance that is
3155  * associated with the component. Only use this if the regmap instance is not
3156  * yet ready when the component is registered. The function must also be called
3157  * before the first IO attempt of the component.
3158  */
3159 void snd_soc_component_init_regmap(struct snd_soc_component *component,
3160         struct regmap *regmap)
3161 {
3162         component->regmap = regmap;
3163         snd_soc_component_setup_regmap(component);
3164 }
3165 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
3166
3167 /**
3168  * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
3169  *                                   component
3170  * @component: The component for which to de-initialize the regmap instance
3171  *
3172  * Calls regmap_exit() on the regmap instance associated to the component and
3173  * removes the regmap instance from the component.
3174  *
3175  * This function should only be used if snd_soc_component_init_regmap() was used
3176  * to initialize the regmap instance.
3177  */
3178 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
3179 {
3180         regmap_exit(component->regmap);
3181         component->regmap = NULL;
3182 }
3183 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
3184
3185 #endif
3186
3187 static void snd_soc_component_add(struct snd_soc_component *component)
3188 {
3189         mutex_lock(&client_mutex);
3190
3191         if (!component->driver->write && !component->driver->read) {
3192                 if (!component->regmap)
3193                         component->regmap = dev_get_regmap(component->dev,
3194                                                            NULL);
3195                 if (component->regmap)
3196                         snd_soc_component_setup_regmap(component);
3197         }
3198
3199         /* see for_each_component */
3200         list_add(&component->list, &component_list);
3201         INIT_LIST_HEAD(&component->dobj_list);
3202
3203         mutex_unlock(&client_mutex);
3204 }
3205
3206 static void snd_soc_component_cleanup(struct snd_soc_component *component)
3207 {
3208         snd_soc_unregister_dais(component);
3209         kfree(component->name);
3210 }
3211
3212 static void snd_soc_component_del_unlocked(struct snd_soc_component *component)
3213 {
3214         struct snd_soc_card *card = component->card;
3215
3216         if (card)
3217                 snd_soc_unbind_card(card, false);
3218
3219         list_del(&component->list);
3220 }
3221
3222 #define ENDIANNESS_MAP(name) \
3223         (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
3224 static u64 endianness_format_map[] = {
3225         ENDIANNESS_MAP(S16_),
3226         ENDIANNESS_MAP(U16_),
3227         ENDIANNESS_MAP(S24_),
3228         ENDIANNESS_MAP(U24_),
3229         ENDIANNESS_MAP(S32_),
3230         ENDIANNESS_MAP(U32_),
3231         ENDIANNESS_MAP(S24_3),
3232         ENDIANNESS_MAP(U24_3),
3233         ENDIANNESS_MAP(S20_3),
3234         ENDIANNESS_MAP(U20_3),
3235         ENDIANNESS_MAP(S18_3),
3236         ENDIANNESS_MAP(U18_3),
3237         ENDIANNESS_MAP(FLOAT_),
3238         ENDIANNESS_MAP(FLOAT64_),
3239         ENDIANNESS_MAP(IEC958_SUBFRAME_),
3240 };
3241
3242 /*
3243  * Fix up the DAI formats for endianness: codecs don't actually see
3244  * the endianness of the data but we're using the CPU format
3245  * definitions which do need to include endianness so we ensure that
3246  * codec DAIs always have both big and little endian variants set.
3247  */
3248 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
3249 {
3250         int i;
3251
3252         for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
3253                 if (stream->formats & endianness_format_map[i])
3254                         stream->formats |= endianness_format_map[i];
3255 }
3256
3257 static void snd_soc_try_rebind_card(void)
3258 {
3259         struct snd_soc_card *card, *c;
3260
3261         if (!list_empty(&unbind_card_list)) {
3262                 list_for_each_entry_safe(card, c, &unbind_card_list, list) {
3263                         if (!snd_soc_bind_card(card))
3264                                 list_del(&card->list);
3265                 }
3266         }
3267 }
3268
3269 int snd_soc_add_component(struct device *dev,
3270                         struct snd_soc_component *component,
3271                         const struct snd_soc_component_driver *component_driver,
3272                         struct snd_soc_dai_driver *dai_drv,
3273                         int num_dai)
3274 {
3275         int ret;
3276         int i;
3277
3278         ret = snd_soc_component_initialize(component, component_driver, dev);
3279         if (ret)
3280                 goto err_free;
3281
3282         if (component_driver->endianness) {
3283                 for (i = 0; i < num_dai; i++) {
3284                         convert_endianness_formats(&dai_drv[i].playback);
3285                         convert_endianness_formats(&dai_drv[i].capture);
3286                 }
3287         }
3288
3289         ret = snd_soc_register_dais(component, dai_drv, num_dai);
3290         if (ret < 0) {
3291                 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3292                 goto err_cleanup;
3293         }
3294
3295         snd_soc_component_add(component);
3296         snd_soc_try_rebind_card();
3297
3298         return 0;
3299
3300 err_cleanup:
3301         snd_soc_component_cleanup(component);
3302 err_free:
3303         return ret;
3304 }
3305 EXPORT_SYMBOL_GPL(snd_soc_add_component);
3306
3307 int snd_soc_register_component(struct device *dev,
3308                         const struct snd_soc_component_driver *component_driver,
3309                         struct snd_soc_dai_driver *dai_drv,
3310                         int num_dai)
3311 {
3312         struct snd_soc_component *component;
3313
3314         component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
3315         if (!component)
3316                 return -ENOMEM;
3317
3318         return snd_soc_add_component(dev, component, component_driver,
3319                                      dai_drv, num_dai);
3320 }
3321 EXPORT_SYMBOL_GPL(snd_soc_register_component);
3322
3323 /**
3324  * snd_soc_unregister_component - Unregister all related component
3325  * from the ASoC core
3326  *
3327  * @dev: The device to unregister
3328  */
3329 static int __snd_soc_unregister_component(struct device *dev)
3330 {
3331         struct snd_soc_component *component;
3332         int found = 0;
3333
3334         mutex_lock(&client_mutex);
3335         for_each_component(component) {
3336                 if (dev != component->dev)
3337                         continue;
3338
3339                 snd_soc_tplg_component_remove(component,
3340                                               SND_SOC_TPLG_INDEX_ALL);
3341                 snd_soc_component_del_unlocked(component);
3342                 found = 1;
3343                 break;
3344         }
3345         mutex_unlock(&client_mutex);
3346
3347         if (found)
3348                 snd_soc_component_cleanup(component);
3349
3350         return found;
3351 }
3352
3353 void snd_soc_unregister_component(struct device *dev)
3354 {
3355         while (__snd_soc_unregister_component(dev))
3356                 ;
3357 }
3358 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
3359
3360 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
3361                                                    const char *driver_name)
3362 {
3363         struct snd_soc_component *component;
3364         struct snd_soc_component *ret;
3365
3366         ret = NULL;
3367         mutex_lock(&client_mutex);
3368         for_each_component(component) {
3369                 if (dev != component->dev)
3370                         continue;
3371
3372                 if (driver_name &&
3373                     (driver_name != component->driver->name) &&
3374                     (strcmp(component->driver->name, driver_name) != 0))
3375                         continue;
3376
3377                 ret = component;
3378                 break;
3379         }
3380         mutex_unlock(&client_mutex);
3381
3382         return ret;
3383 }
3384 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
3385
3386 /* Retrieve a card's name from device tree */
3387 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
3388                                const char *propname)
3389 {
3390         struct device_node *np;
3391         int ret;
3392
3393         if (!card->dev) {
3394                 pr_err("card->dev is not set before calling %s\n", __func__);
3395                 return -EINVAL;
3396         }
3397
3398         np = card->dev->of_node;
3399
3400         ret = of_property_read_string_index(np, propname, 0, &card->name);
3401         /*
3402          * EINVAL means the property does not exist. This is fine providing
3403          * card->name was previously set, which is checked later in
3404          * snd_soc_register_card.
3405          */
3406         if (ret < 0 && ret != -EINVAL) {
3407                 dev_err(card->dev,
3408                         "ASoC: Property '%s' could not be read: %d\n",
3409                         propname, ret);
3410                 return ret;
3411         }
3412
3413         return 0;
3414 }
3415 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
3416
3417 static const struct snd_soc_dapm_widget simple_widgets[] = {
3418         SND_SOC_DAPM_MIC("Microphone", NULL),
3419         SND_SOC_DAPM_LINE("Line", NULL),
3420         SND_SOC_DAPM_HP("Headphone", NULL),
3421         SND_SOC_DAPM_SPK("Speaker", NULL),
3422 };
3423
3424 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
3425                                           const char *propname)
3426 {
3427         struct device_node *np = card->dev->of_node;
3428         struct snd_soc_dapm_widget *widgets;
3429         const char *template, *wname;
3430         int i, j, num_widgets, ret;
3431
3432         num_widgets = of_property_count_strings(np, propname);
3433         if (num_widgets < 0) {
3434                 dev_err(card->dev,
3435                         "ASoC: Property '%s' does not exist\n", propname);
3436                 return -EINVAL;
3437         }
3438         if (num_widgets & 1) {
3439                 dev_err(card->dev,
3440                         "ASoC: Property '%s' length is not even\n", propname);
3441                 return -EINVAL;
3442         }
3443
3444         num_widgets /= 2;
3445         if (!num_widgets) {
3446                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3447                         propname);
3448                 return -EINVAL;
3449         }
3450
3451         widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
3452                                GFP_KERNEL);
3453         if (!widgets) {
3454                 dev_err(card->dev,
3455                         "ASoC: Could not allocate memory for widgets\n");
3456                 return -ENOMEM;
3457         }
3458
3459         for (i = 0; i < num_widgets; i++) {
3460                 ret = of_property_read_string_index(np, propname,
3461                         2 * i, &template);
3462                 if (ret) {
3463                         dev_err(card->dev,
3464                                 "ASoC: Property '%s' index %d read error:%d\n",
3465                                 propname, 2 * i, ret);
3466                         return -EINVAL;
3467                 }
3468
3469                 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3470                         if (!strncmp(template, simple_widgets[j].name,
3471                                      strlen(simple_widgets[j].name))) {
3472                                 widgets[i] = simple_widgets[j];
3473                                 break;
3474                         }
3475                 }
3476
3477                 if (j >= ARRAY_SIZE(simple_widgets)) {
3478                         dev_err(card->dev,
3479                                 "ASoC: DAPM widget '%s' is not supported\n",
3480                                 template);
3481                         return -EINVAL;
3482                 }
3483
3484                 ret = of_property_read_string_index(np, propname,
3485                                                     (2 * i) + 1,
3486                                                     &wname);
3487                 if (ret) {
3488                         dev_err(card->dev,
3489                                 "ASoC: Property '%s' index %d read error:%d\n",
3490                                 propname, (2 * i) + 1, ret);
3491                         return -EINVAL;
3492                 }
3493
3494                 widgets[i].name = wname;
3495         }
3496
3497         card->of_dapm_widgets = widgets;
3498         card->num_of_dapm_widgets = num_widgets;
3499
3500         return 0;
3501 }
3502 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3503
3504 int snd_soc_of_get_slot_mask(struct device_node *np,
3505                              const char *prop_name,
3506                              unsigned int *mask)
3507 {
3508         u32 val;
3509         const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3510         int i;
3511
3512         if (!of_slot_mask)
3513                 return 0;
3514         val /= sizeof(u32);
3515         for (i = 0; i < val; i++)
3516                 if (be32_to_cpup(&of_slot_mask[i]))
3517                         *mask |= (1 << i);
3518
3519         return val;
3520 }
3521 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
3522
3523 int snd_soc_of_parse_tdm_slot(struct device_node *np,
3524                               unsigned int *tx_mask,
3525                               unsigned int *rx_mask,
3526                               unsigned int *slots,
3527                               unsigned int *slot_width)
3528 {
3529         u32 val;
3530         int ret;
3531
3532         if (tx_mask)
3533                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3534         if (rx_mask)
3535                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3536
3537         if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3538                 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3539                 if (ret)
3540                         return ret;
3541
3542                 if (slots)
3543                         *slots = val;
3544         }
3545
3546         if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3547                 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3548                 if (ret)
3549                         return ret;
3550
3551                 if (slot_width)
3552                         *slot_width = val;
3553         }
3554
3555         return 0;
3556 }
3557 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3558
3559 void snd_soc_of_parse_node_prefix(struct device_node *np,
3560                                   struct snd_soc_codec_conf *codec_conf,
3561                                   struct device_node *of_node,
3562                                   const char *propname)
3563 {
3564         const char *str;
3565         int ret;
3566
3567         ret = of_property_read_string(np, propname, &str);
3568         if (ret < 0) {
3569                 /* no prefix is not error */
3570                 return;
3571         }
3572
3573         codec_conf->of_node     = of_node;
3574         codec_conf->name_prefix = str;
3575 }
3576 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
3577
3578 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3579                                    const char *propname)
3580 {
3581         struct device_node *np = card->dev->of_node;
3582         int num_routes;
3583         struct snd_soc_dapm_route *routes;
3584         int i, ret;
3585
3586         num_routes = of_property_count_strings(np, propname);
3587         if (num_routes < 0 || num_routes & 1) {
3588                 dev_err(card->dev,
3589                         "ASoC: Property '%s' does not exist or its length is not even\n",
3590                         propname);
3591                 return -EINVAL;
3592         }
3593         num_routes /= 2;
3594         if (!num_routes) {
3595                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3596                         propname);
3597                 return -EINVAL;
3598         }
3599
3600         routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
3601                               GFP_KERNEL);
3602         if (!routes) {
3603                 dev_err(card->dev,
3604                         "ASoC: Could not allocate DAPM route table\n");
3605                 return -EINVAL;
3606         }
3607
3608         for (i = 0; i < num_routes; i++) {
3609                 ret = of_property_read_string_index(np, propname,
3610                         2 * i, &routes[i].sink);
3611                 if (ret) {
3612                         dev_err(card->dev,
3613                                 "ASoC: Property '%s' index %d could not be read: %d\n",
3614                                 propname, 2 * i, ret);
3615                         return -EINVAL;
3616                 }
3617                 ret = of_property_read_string_index(np, propname,
3618                         (2 * i) + 1, &routes[i].source);
3619                 if (ret) {
3620                         dev_err(card->dev,
3621                                 "ASoC: Property '%s' index %d could not be read: %d\n",
3622                                 propname, (2 * i) + 1, ret);
3623                         return -EINVAL;
3624                 }
3625         }
3626
3627         card->num_of_dapm_routes = num_routes;
3628         card->of_dapm_routes = routes;
3629
3630         return 0;
3631 }
3632 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3633
3634 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
3635                                      const char *prefix,
3636                                      struct device_node **bitclkmaster,
3637                                      struct device_node **framemaster)
3638 {
3639         int ret, i;
3640         char prop[128];
3641         unsigned int format = 0;
3642         int bit, frame;
3643         const char *str;
3644         struct {
3645                 char *name;
3646                 unsigned int val;
3647         } of_fmt_table[] = {
3648                 { "i2s",        SND_SOC_DAIFMT_I2S },
3649                 { "right_j",    SND_SOC_DAIFMT_RIGHT_J },
3650                 { "left_j",     SND_SOC_DAIFMT_LEFT_J },
3651                 { "dsp_a",      SND_SOC_DAIFMT_DSP_A },
3652                 { "dsp_b",      SND_SOC_DAIFMT_DSP_B },
3653                 { "ac97",       SND_SOC_DAIFMT_AC97 },
3654                 { "pdm",        SND_SOC_DAIFMT_PDM},
3655                 { "msb",        SND_SOC_DAIFMT_MSB },
3656                 { "lsb",        SND_SOC_DAIFMT_LSB },
3657         };
3658
3659         if (!prefix)
3660                 prefix = "";
3661
3662         /*
3663          * check "dai-format = xxx"
3664          * or    "[prefix]format = xxx"
3665          * SND_SOC_DAIFMT_FORMAT_MASK area
3666          */
3667         ret = of_property_read_string(np, "dai-format", &str);
3668         if (ret < 0) {
3669                 snprintf(prop, sizeof(prop), "%sformat", prefix);
3670                 ret = of_property_read_string(np, prop, &str);
3671         }
3672         if (ret == 0) {
3673                 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3674                         if (strcmp(str, of_fmt_table[i].name) == 0) {
3675                                 format |= of_fmt_table[i].val;
3676                                 break;
3677                         }
3678                 }
3679         }
3680
3681         /*
3682          * check "[prefix]continuous-clock"
3683          * SND_SOC_DAIFMT_CLOCK_MASK area
3684          */
3685         snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3686         if (of_property_read_bool(np, prop))
3687                 format |= SND_SOC_DAIFMT_CONT;
3688         else
3689                 format |= SND_SOC_DAIFMT_GATED;
3690
3691         /*
3692          * check "[prefix]bitclock-inversion"
3693          * check "[prefix]frame-inversion"
3694          * SND_SOC_DAIFMT_INV_MASK area
3695          */
3696         snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3697         bit = !!of_get_property(np, prop, NULL);
3698
3699         snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3700         frame = !!of_get_property(np, prop, NULL);
3701
3702         switch ((bit << 4) + frame) {
3703         case 0x11:
3704                 format |= SND_SOC_DAIFMT_IB_IF;
3705                 break;
3706         case 0x10:
3707                 format |= SND_SOC_DAIFMT_IB_NF;
3708                 break;
3709         case 0x01:
3710                 format |= SND_SOC_DAIFMT_NB_IF;
3711                 break;
3712         default:
3713                 /* SND_SOC_DAIFMT_NB_NF is default */
3714                 break;
3715         }
3716
3717         /*
3718          * check "[prefix]bitclock-master"
3719          * check "[prefix]frame-master"
3720          * SND_SOC_DAIFMT_MASTER_MASK area
3721          */
3722         snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3723         bit = !!of_get_property(np, prop, NULL);
3724         if (bit && bitclkmaster)
3725                 *bitclkmaster = of_parse_phandle(np, prop, 0);
3726
3727         snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3728         frame = !!of_get_property(np, prop, NULL);
3729         if (frame && framemaster)
3730                 *framemaster = of_parse_phandle(np, prop, 0);
3731
3732         switch ((bit << 4) + frame) {
3733         case 0x11:
3734                 format |= SND_SOC_DAIFMT_CBM_CFM;
3735                 break;
3736         case 0x10:
3737                 format |= SND_SOC_DAIFMT_CBM_CFS;
3738                 break;
3739         case 0x01:
3740                 format |= SND_SOC_DAIFMT_CBS_CFM;
3741                 break;
3742         default:
3743                 format |= SND_SOC_DAIFMT_CBS_CFS;
3744                 break;
3745         }
3746
3747         return format;
3748 }
3749 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
3750
3751 int snd_soc_get_dai_id(struct device_node *ep)
3752 {
3753         struct snd_soc_component *component;
3754         struct device_node *node;
3755         int ret;
3756
3757         node = of_graph_get_port_parent(ep);
3758
3759         /*
3760          * For example HDMI case, HDMI has video/sound port,
3761          * but ALSA SoC needs sound port number only.
3762          * Thus counting HDMI DT port/endpoint doesn't work.
3763          * Then, it should have .of_xlate_dai_id
3764          */
3765         ret = -ENOTSUPP;
3766         mutex_lock(&client_mutex);
3767         component = soc_find_component(node, NULL);
3768         if (component &&
3769             component->driver->of_xlate_dai_id)
3770                 ret = component->driver->of_xlate_dai_id(component, ep);
3771         mutex_unlock(&client_mutex);
3772
3773         of_node_put(node);
3774
3775         return ret;
3776 }
3777 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3778
3779 int snd_soc_get_dai_name(struct of_phandle_args *args,
3780                                 const char **dai_name)
3781 {
3782         struct snd_soc_component *pos;
3783         struct device_node *component_of_node;
3784         int ret = -EPROBE_DEFER;
3785
3786         mutex_lock(&client_mutex);
3787         for_each_component(pos) {
3788                 component_of_node = soc_component_to_node(pos);
3789
3790                 if (component_of_node != args->np)
3791                         continue;
3792
3793                 if (pos->driver->of_xlate_dai_name) {
3794                         ret = pos->driver->of_xlate_dai_name(pos,
3795                                                              args,
3796                                                              dai_name);
3797                 } else {
3798                         struct snd_soc_dai *dai;
3799                         int id = -1;
3800
3801                         switch (args->args_count) {
3802                         case 0:
3803                                 id = 0; /* same as dai_drv[0] */
3804                                 break;
3805                         case 1:
3806                                 id = args->args[0];
3807                                 break;
3808                         default:
3809                                 /* not supported */
3810                                 break;
3811                         }
3812
3813                         if (id < 0 || id >= pos->num_dai) {
3814                                 ret = -EINVAL;
3815                                 continue;
3816                         }
3817
3818                         ret = 0;
3819
3820                         /* find target DAI */
3821                         for_each_component_dais(pos, dai) {
3822                                 if (id == 0)
3823                                         break;
3824                                 id--;
3825                         }
3826
3827                         *dai_name = dai->driver->name;
3828                         if (!*dai_name)
3829                                 *dai_name = pos->name;
3830                 }
3831
3832                 break;
3833         }
3834         mutex_unlock(&client_mutex);
3835         return ret;
3836 }
3837 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3838
3839 int snd_soc_of_get_dai_name(struct device_node *of_node,
3840                             const char **dai_name)
3841 {
3842         struct of_phandle_args args;
3843         int ret;
3844
3845         ret = of_parse_phandle_with_args(of_node, "sound-dai",
3846                                          "#sound-dai-cells", 0, &args);
3847         if (ret)
3848                 return ret;
3849
3850         ret = snd_soc_get_dai_name(&args, dai_name);
3851
3852         of_node_put(args.np);
3853
3854         return ret;
3855 }
3856 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3857
3858 /*
3859  * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3860  * @dai_link: DAI link
3861  *
3862  * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3863  */
3864 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3865 {
3866         struct snd_soc_dai_link_component *component;
3867         int index;
3868
3869         for_each_link_codecs(dai_link, index, component) {
3870                 if (!component->of_node)
3871                         break;
3872                 of_node_put(component->of_node);
3873                 component->of_node = NULL;
3874         }
3875 }
3876 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3877
3878 /*
3879  * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3880  * @dev: Card device
3881  * @of_node: Device node
3882  * @dai_link: DAI link
3883  *
3884  * Builds an array of CODEC DAI components from the DAI link property
3885  * 'sound-dai'.
3886  * The array is set in the DAI link and the number of DAIs is set accordingly.
3887  * The device nodes in the array (of_node) must be dereferenced by calling
3888  * snd_soc_of_put_dai_link_codecs() on @dai_link.
3889  *
3890  * Returns 0 for success
3891  */
3892 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3893                                    struct device_node *of_node,
3894                                    struct snd_soc_dai_link *dai_link)
3895 {
3896         struct of_phandle_args args;
3897         struct snd_soc_dai_link_component *component;
3898         char *name;
3899         int index, num_codecs, ret;
3900
3901         /* Count the number of CODECs */
3902         name = "sound-dai";
3903         num_codecs = of_count_phandle_with_args(of_node, name,
3904                                                 "#sound-dai-cells");
3905         if (num_codecs <= 0) {
3906                 if (num_codecs == -ENOENT)
3907                         dev_err(dev, "No 'sound-dai' property\n");
3908                 else
3909                         dev_err(dev, "Bad phandle in 'sound-dai'\n");
3910                 return num_codecs;
3911         }
3912         component = devm_kcalloc(dev,
3913                                  num_codecs, sizeof(*component),
3914                                  GFP_KERNEL);
3915         if (!component)
3916                 return -ENOMEM;
3917         dai_link->codecs = component;
3918         dai_link->num_codecs = num_codecs;
3919
3920         /* Parse the list */
3921         for_each_link_codecs(dai_link, index, component) {
3922                 ret = of_parse_phandle_with_args(of_node, name,
3923                                                  "#sound-dai-cells",
3924                                                  index, &args);
3925                 if (ret)
3926                         goto err;
3927                 component->of_node = args.np;
3928                 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3929                 if (ret < 0)
3930                         goto err;
3931         }
3932         return 0;
3933 err:
3934         snd_soc_of_put_dai_link_codecs(dai_link);
3935         dai_link->codecs = NULL;
3936         dai_link->num_codecs = 0;
3937         return ret;
3938 }
3939 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3940
3941 static int __init snd_soc_init(void)
3942 {
3943         snd_soc_debugfs_init();
3944         snd_soc_util_init();
3945
3946         return platform_driver_register(&soc_driver);
3947 }
3948 module_init(snd_soc_init);
3949
3950 static void __exit snd_soc_exit(void)
3951 {
3952         snd_soc_util_exit();
3953         snd_soc_debugfs_exit();
3954
3955         platform_driver_unregister(&soc_driver);
3956 }
3957 module_exit(snd_soc_exit);
3958
3959 /* Module information */
3960 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3961 MODULE_DESCRIPTION("ALSA SoC Core");
3962 MODULE_LICENSE("GPL");
3963 MODULE_ALIAS("platform:soc-audio");