sound/soc/soc-core.c

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