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