sound/soc/soc-core.c

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