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                                 fallthrough;
 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 struct snd_soc_dai *snd_soc_find_dai_with_mutex(
 838         const struct snd_soc_dai_link_component *dlc)
 839 {
 840         struct snd_soc_dai *dai;
 841
 842         mutex_lock(&client_mutex);
 843         dai = snd_soc_find_dai(dlc);
 844         mutex_unlock(&client_mutex);
 845
 846         return dai;
 847 }
 848 EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
 849
 850 static int soc_dai_link_sanity_check(struct snd_soc_card *card,
 851                                      struct snd_soc_dai_link *link)
 852 {
 853         int i;
 854         struct snd_soc_dai_link_component *cpu, *codec, *platform;
 855
 856         for_each_link_codecs(link, i, codec) {
 857                 /*
 858                  * Codec must be specified by 1 of name or OF node,
 859                  * not both or neither.
 860                  */
 861                 if (!!codec->name == !!codec->of_node) {
 862                         dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
 863                                 link->name);
 864                         return -EINVAL;
 865                 }
 866
 867                 /* Codec DAI name must be specified */
 868                 if (!codec->dai_name) {
 869                         dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
 870                                 link->name);
 871                         return -EINVAL;
 872                 }
 873
 874                 /*
 875                  * Defer card registration if codec component is not added to
 876                  * component list.
 877                  */
 878                 if (!soc_find_component(codec)) {
 879                         dev_dbg(card->dev,
 880                                 "ASoC: codec component %s not found for link %s\n",
 881                                 codec->name, link->name);
 882                         return -EPROBE_DEFER;
 883                 }
 884         }
 885
 886         for_each_link_platforms(link, i, platform) {
 887                 /*
 888                  * Platform may be specified by either name or OF node, but it
 889                  * can be left unspecified, then no components will be inserted
 890                  * in the rtdcom list
 891                  */
 892                 if (!!platform->name == !!platform->of_node) {
 893                         dev_err(card->dev,
 894                                 "ASoC: Neither/both platform name/of_node are set for %s\n",
 895                                 link->name);
 896                         return -EINVAL;
 897                 }
 898
 899                 /*
 900                  * Defer card registration if platform component is not added to
 901                  * component list.
 902                  */
 903                 if (!soc_find_component(platform)) {
 904                         dev_dbg(card->dev,
 905                                 "ASoC: platform component %s not found for link %s\n",
 906                                 platform->name, link->name);
 907                         return -EPROBE_DEFER;
 908                 }
 909         }
 910
 911         for_each_link_cpus(link, i, cpu) {
 912                 /*
 913                  * CPU device may be specified by either name or OF node, but
 914                  * can be left unspecified, and will be matched based on DAI
 915                  * name alone..
 916                  */
 917                 if (cpu->name && cpu->of_node) {
 918                         dev_err(card->dev,
 919                                 "ASoC: Neither/both cpu name/of_node are set for %s\n",
 920                                 link->name);
 921                         return -EINVAL;
 922                 }
 923
 924                 /*
 925                  * Defer card registration if cpu dai component is not added to
 926                  * component list.
 927                  */
 928                 if ((cpu->of_node || cpu->name) &&
 929                     !soc_find_component(cpu)) {
 930                         dev_dbg(card->dev,
 931                                 "ASoC: cpu component %s not found for link %s\n",
 932                                 cpu->name, link->name);
 933                         return -EPROBE_DEFER;
 934                 }
 935
 936                 /*
 937                  * At least one of CPU DAI name or CPU device name/node must be
 938                  * specified
 939                  */
 940                 if (!cpu->dai_name &&
 941                     !(cpu->name || cpu->of_node)) {
 942                         dev_err(card->dev,
 943                                 "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
 944                                 link->name);
 945                         return -EINVAL;
 946                 }
 947         }
 948
 949         return 0;
 950 }
 951
 952 /**
 953  * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
 954  * @card: The ASoC card to which the pcm_runtime has
 955  * @rtd: The pcm_runtime to remove
 956  *
 957  * This function removes a pcm_runtime from the ASoC card.
 958  */
 959 void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
 960                                 struct snd_soc_pcm_runtime *rtd)
 961 {
 962         lockdep_assert_held(&client_mutex);
 963
 964         /* release machine specific resources */
 965         snd_soc_link_exit(rtd);
 966
 967         /*
 968          * Notify the machine driver for extra destruction
 969          */
 970         snd_soc_card_remove_dai_link(card, rtd->dai_link);
 971
 972         soc_free_pcm_runtime(rtd);
 973 }
 974 EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
 975
 976 /**
 977  * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
 978  * @card: The ASoC card to which the pcm_runtime is added
 979  * @dai_link: The DAI link to find pcm_runtime
 980  *
 981  * This function adds a pcm_runtime ASoC card by using dai_link.
 982  *
 983  * Note: Topology can use this API to add pcm_runtime when probing the
 984  * topology component. And machine drivers can still define static
 985  * DAI links in dai_link array.
 986  */
 987 int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
 988                             struct snd_soc_dai_link *dai_link)
 989 {
 990         struct snd_soc_pcm_runtime *rtd;
 991         struct snd_soc_dai_link_component *codec, *platform, *cpu;
 992         struct snd_soc_component *component;
 993         int i, ret;
 994
 995         lockdep_assert_held(&client_mutex);
 996
 997         /*
 998          * Notify the machine driver for extra initialization
 999          */
1000         ret = snd_soc_card_add_dai_link(card, dai_link);
1001         if (ret < 0)
1002                 return ret;
1003
1004         if (dai_link->ignore)
1005                 return 0;
1006
1007         dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1008
1009         ret = soc_dai_link_sanity_check(card, dai_link);
1010         if (ret < 0)
1011                 return ret;
1012
1013         rtd = soc_new_pcm_runtime(card, dai_link);
1014         if (!rtd)
1015                 return -ENOMEM;
1016
1017         for_each_link_cpus(dai_link, i, cpu) {
1018                 asoc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
1019                 if (!asoc_rtd_to_cpu(rtd, i)) {
1020                         dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1021                                  cpu->dai_name);
1022                         goto _err_defer;
1023                 }
1024                 snd_soc_rtd_add_component(rtd, asoc_rtd_to_cpu(rtd, i)->component);
1025         }
1026
1027         /* Find CODEC from registered CODECs */
1028         for_each_link_codecs(dai_link, i, codec) {
1029                 asoc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1030                 if (!asoc_rtd_to_codec(rtd, i)) {
1031                         dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1032                                  codec->dai_name);
1033                         goto _err_defer;
1034                 }
1035
1036                 snd_soc_rtd_add_component(rtd, asoc_rtd_to_codec(rtd, i)->component);
1037         }
1038
1039         /* Find PLATFORM from registered PLATFORMs */
1040         for_each_link_platforms(dai_link, i, platform) {
1041                 for_each_component(component) {
1042                         if (!snd_soc_is_matching_component(platform, component))
1043                                 continue;
1044
1045                         snd_soc_rtd_add_component(rtd, component);
1046                 }
1047         }
1048
1049         return 0;
1050
1051 _err_defer:
1052         snd_soc_remove_pcm_runtime(card, rtd);
1053         return -EPROBE_DEFER;
1054 }
1055 EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtime);
1056
1057 static int soc_init_pcm_runtime(struct snd_soc_card *card,
1058                                 struct snd_soc_pcm_runtime *rtd)
1059 {
1060         struct snd_soc_dai_link *dai_link = rtd->dai_link;
1061         struct snd_soc_dai *cpu_dai = asoc_rtd_to_cpu(rtd, 0);
1062         struct snd_soc_component *component;
1063         int ret, num, i;
1064
1065         /* set default power off timeout */
1066         rtd->pmdown_time = pmdown_time;
1067
1068         /* do machine specific initialization */
1069         ret = snd_soc_link_init(rtd);
1070         if (ret < 0)
1071                 return ret;
1072
1073         if (dai_link->dai_fmt) {
1074                 ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1075                 if (ret)
1076                         return ret;
1077         }
1078
1079         /* add DPCM sysfs entries */
1080         soc_dpcm_debugfs_add(rtd);
1081
1082         num = rtd->num;
1083
1084         /*
1085          * most drivers will register their PCMs using DAI link ordering but
1086          * topology based drivers can use the DAI link id field to set PCM
1087          * device number and then use rtd + a base offset of the BEs.
1088          */
1089         for_each_rtd_components(rtd, i, component) {
1090                 if (!component->driver->use_dai_pcm_id)
1091                         continue;
1092
1093                 if (rtd->dai_link->no_pcm)
1094                         num += component->driver->be_pcm_base;
1095                 else
1096                         num = rtd->dai_link->id;
1097         }
1098
1099         /* create compress_device if possible */
1100         ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1101         if (ret != -ENOTSUPP) {
1102                 if (ret < 0)
1103                         dev_err(card->dev, "ASoC: can't create compress %s\n",
1104                                 dai_link->stream_name);
1105                 return ret;
1106         }
1107
1108         /* create the pcm */
1109         ret = soc_new_pcm(rtd, num);
1110         if (ret < 0) {
1111                 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1112                         dai_link->stream_name, ret);
1113                 return ret;
1114         }
1115
1116         return snd_soc_pcm_dai_new(rtd);
1117 }
1118
1119 static void soc_set_name_prefix(struct snd_soc_card *card,
1120                                 struct snd_soc_component *component)
1121 {
1122         struct device_node *of_node = soc_component_to_node(component);
1123         const char *str;
1124         int ret, i;
1125
1126         for (i = 0; i < card->num_configs; i++) {
1127                 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1128
1129                 if (snd_soc_is_matching_component(&map->dlc, component)) {
1130                         component->name_prefix = map->name_prefix;
1131                         return;
1132                 }
1133         }
1134
1135         /*
1136          * If there is no configuration table or no match in the table,
1137          * check if a prefix is provided in the node
1138          */
1139         ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1140         if (ret < 0)
1141                 return;
1142
1143         component->name_prefix = str;
1144 }
1145
1146 static void soc_remove_component(struct snd_soc_component *component,
1147                                  int probed)
1148 {
1149
1150         if (!component->card)
1151                 return;
1152
1153         if (probed)
1154                 snd_soc_component_remove(component);
1155
1156         /* For framework level robustness */
1157         snd_soc_component_set_jack(component, NULL, NULL);
1158
1159         list_del_init(&component->card_list);
1160         snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1161         soc_cleanup_component_debugfs(component);
1162         component->card = NULL;
1163         snd_soc_component_module_put_when_remove(component);
1164 }
1165
1166 static int soc_probe_component(struct snd_soc_card *card,
1167                                struct snd_soc_component *component)
1168 {
1169         struct snd_soc_dapm_context *dapm =
1170                 snd_soc_component_get_dapm(component);
1171         struct snd_soc_dai *dai;
1172         int probed = 0;
1173         int ret;
1174
1175         if (!strcmp(component->name, "snd-soc-dummy"))
1176                 return 0;
1177
1178         if (component->card) {
1179                 if (component->card != card) {
1180                         dev_err(component->dev,
1181                                 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1182                                 card->name, component->card->name);
1183                         return -ENODEV;
1184                 }
1185                 return 0;
1186         }
1187
1188         ret = snd_soc_component_module_get_when_probe(component);
1189         if (ret < 0)
1190                 return ret;
1191
1192         component->card = card;
1193         soc_set_name_prefix(card, component);
1194
1195         soc_init_component_debugfs(component);
1196
1197         snd_soc_dapm_init(dapm, card, component);
1198
1199         ret = snd_soc_dapm_new_controls(dapm,
1200                                         component->driver->dapm_widgets,
1201                                         component->driver->num_dapm_widgets);
1202
1203         if (ret != 0) {
1204                 dev_err(component->dev,
1205                         "Failed to create new controls %d\n", ret);
1206                 goto err_probe;
1207         }
1208
1209         for_each_component_dais(component, dai) {
1210                 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1211                 if (ret != 0) {
1212                         dev_err(component->dev,
1213                                 "Failed to create DAI widgets %d\n", ret);
1214                         goto err_probe;
1215                 }
1216         }
1217
1218         ret = snd_soc_component_probe(component);
1219         if (ret < 0) {
1220                 dev_err(component->dev,
1221                         "ASoC: failed to probe component %d\n", ret);
1222                 goto err_probe;
1223         }
1224         WARN(dapm->idle_bias_off &&
1225              dapm->bias_level != SND_SOC_BIAS_OFF,
1226              "codec %s can not start from non-off bias with idle_bias_off==1\n",
1227              component->name);
1228         probed = 1;
1229
1230         /*
1231          * machine specific init
1232          * see
1233          *      snd_soc_component_set_aux()
1234          */
1235         ret = snd_soc_component_init(component);
1236         if (ret < 0)
1237                 goto err_probe;
1238
1239         ret = snd_soc_add_component_controls(component,
1240                                              component->driver->controls,
1241                                              component->driver->num_controls);
1242         if (ret < 0)
1243                 goto err_probe;
1244
1245         ret = snd_soc_dapm_add_routes(dapm,
1246                                       component->driver->dapm_routes,
1247                                       component->driver->num_dapm_routes);
1248         if (ret < 0) {
1249                 if (card->disable_route_checks) {
1250                         dev_info(card->dev,
1251                                  "%s: disable_route_checks set, ignoring errors on add_routes\n",
1252                                  __func__);
1253                 } else {
1254                         dev_err(card->dev,
1255                                 "%s: snd_soc_dapm_add_routes failed: %d\n",
1256                                 __func__, ret);
1257                         goto err_probe;
1258                 }
1259         }
1260
1261         /* see for_each_card_components */
1262         list_add(&component->card_list, &card->component_dev_list);
1263
1264 err_probe:
1265         if (ret < 0)
1266                 soc_remove_component(component, probed);
1267
1268         return ret;
1269 }
1270
1271 static void soc_remove_link_dais(struct snd_soc_card *card)
1272 {
1273         struct snd_soc_pcm_runtime *rtd;
1274         int order;
1275
1276         for_each_comp_order(order) {
1277                 for_each_card_rtds(card, rtd) {
1278                         /* remove all rtd connected DAIs in good order */
1279                         snd_soc_pcm_dai_remove(rtd, order);
1280                 }
1281         }
1282 }
1283
1284 static int soc_probe_link_dais(struct snd_soc_card *card)
1285 {
1286         struct snd_soc_pcm_runtime *rtd;
1287         int order, ret;
1288
1289         for_each_comp_order(order) {
1290                 for_each_card_rtds(card, rtd) {
1291
1292                         dev_dbg(card->dev,
1293                                 "ASoC: probe %s dai link %d late %d\n",
1294                                 card->name, rtd->num, order);
1295
1296                         /* probe all rtd connected DAIs in good order */
1297                         ret = snd_soc_pcm_dai_probe(rtd, order);
1298                         if (ret)
1299                                 return ret;
1300                 }
1301         }
1302
1303         return 0;
1304 }
1305
1306 static void soc_remove_link_components(struct snd_soc_card *card)
1307 {
1308         struct snd_soc_component *component;
1309         struct snd_soc_pcm_runtime *rtd;
1310         int i, order;
1311
1312         for_each_comp_order(order) {
1313                 for_each_card_rtds(card, rtd) {
1314                         for_each_rtd_components(rtd, i, component) {
1315                                 if (component->driver->remove_order != order)
1316                                         continue;
1317
1318                                 soc_remove_component(component, 1);
1319                         }
1320                 }
1321         }
1322 }
1323
1324 static int soc_probe_link_components(struct snd_soc_card *card)
1325 {
1326         struct snd_soc_component *component;
1327         struct snd_soc_pcm_runtime *rtd;
1328         int i, ret, order;
1329
1330         for_each_comp_order(order) {
1331                 for_each_card_rtds(card, rtd) {
1332                         for_each_rtd_components(rtd, i, component) {
1333                                 if (component->driver->probe_order != order)
1334                                         continue;
1335
1336                                 ret = soc_probe_component(card, component);
1337                                 if (ret < 0)
1338                                         return ret;
1339                         }
1340                 }
1341         }
1342
1343         return 0;
1344 }
1345
1346 static void soc_unbind_aux_dev(struct snd_soc_card *card)
1347 {
1348         struct snd_soc_component *component, *_component;
1349
1350         for_each_card_auxs_safe(card, component, _component) {
1351                 /* for snd_soc_component_init() */
1352                 snd_soc_component_set_aux(component, NULL);
1353                 list_del(&component->card_aux_list);
1354         }
1355 }
1356
1357 static int soc_bind_aux_dev(struct snd_soc_card *card)
1358 {
1359         struct snd_soc_component *component;
1360         struct snd_soc_aux_dev *aux;
1361         int i;
1362
1363         for_each_card_pre_auxs(card, i, aux) {
1364                 /* codecs, usually analog devices */
1365                 component = soc_find_component(&aux->dlc);
1366                 if (!component)
1367                         return -EPROBE_DEFER;
1368
1369                 /* for snd_soc_component_init() */
1370                 snd_soc_component_set_aux(component, aux);
1371                 /* see for_each_card_auxs */
1372                 list_add(&component->card_aux_list, &card->aux_comp_list);
1373         }
1374         return 0;
1375 }
1376
1377 static int soc_probe_aux_devices(struct snd_soc_card *card)
1378 {
1379         struct snd_soc_component *component;
1380         int order;
1381         int ret;
1382
1383         for_each_comp_order(order) {
1384                 for_each_card_auxs(card, component) {
1385                         if (component->driver->probe_order != order)
1386                                 continue;
1387
1388                         ret = soc_probe_component(card, component);
1389                         if (ret < 0)
1390                                 return ret;
1391                 }
1392         }
1393
1394         return 0;
1395 }
1396
1397 static void soc_remove_aux_devices(struct snd_soc_card *card)
1398 {
1399         struct snd_soc_component *comp, *_comp;
1400         int order;
1401
1402         for_each_comp_order(order) {
1403                 for_each_card_auxs_safe(card, comp, _comp) {
1404                         if (comp->driver->remove_order == order)
1405                                 soc_remove_component(comp, 1);
1406                 }
1407         }
1408 }
1409
1410 /**
1411  * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1412  * @rtd: The runtime for which the DAI link format should be changed
1413  * @dai_fmt: The new DAI link format
1414  *
1415  * This function updates the DAI link format for all DAIs connected to the DAI
1416  * link for the specified runtime.
1417  *
1418  * Note: For setups with a static format set the dai_fmt field in the
1419  * corresponding snd_dai_link struct instead of using this function.
1420  *
1421  * Returns 0 on success, otherwise a negative error code.
1422  */
1423 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1424         unsigned int dai_fmt)
1425 {
1426         struct snd_soc_dai *cpu_dai;
1427         struct snd_soc_dai *codec_dai;
1428         unsigned int inv_dai_fmt;
1429         unsigned int i;
1430         int ret;
1431
1432         for_each_rtd_codec_dais(rtd, i, codec_dai) {
1433                 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1434                 if (ret != 0 && ret != -ENOTSUPP) {
1435                         dev_warn(codec_dai->dev,
1436                                  "ASoC: Failed to set DAI format: %d\n", ret);
1437                         return ret;
1438                 }
1439         }
1440
1441         /*
1442          * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1443          * the component which has non_legacy_dai_naming is Codec
1444          */
1445         inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1446         switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1447         case SND_SOC_DAIFMT_CBM_CFM:
1448                 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1449                 break;
1450         case SND_SOC_DAIFMT_CBM_CFS:
1451                 inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1452                 break;
1453         case SND_SOC_DAIFMT_CBS_CFM:
1454                 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1455                 break;
1456         case SND_SOC_DAIFMT_CBS_CFS:
1457                 inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1458                 break;
1459         }
1460         for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1461                 unsigned int fmt = dai_fmt;
1462
1463                 if (cpu_dai->component->driver->non_legacy_dai_naming)
1464                         fmt = inv_dai_fmt;
1465
1466                 ret = snd_soc_dai_set_fmt(cpu_dai, fmt);
1467                 if (ret != 0 && ret != -ENOTSUPP) {
1468                         dev_warn(cpu_dai->dev,
1469                                  "ASoC: Failed to set DAI format: %d\n", ret);
1470                         return ret;
1471                 }
1472         }
1473
1474         return 0;
1475 }
1476 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1477
1478 #ifdef CONFIG_DMI
1479 /*
1480  * If a DMI filed contain strings in this blacklist (e.g.
1481  * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1482  * as invalid and dropped when setting the card long name from DMI info.
1483  */
1484 static const char * const dmi_blacklist[] = {
1485         "To be filled by OEM",
1486         "TBD by OEM",
1487         "Default String",
1488         "Board Manufacturer",
1489         "Board Vendor Name",
1490         "Board Product Name",
1491         NULL,   /* terminator */
1492 };
1493
1494 /*
1495  * Trim special characters, and replace '-' with '_' since '-' is used to
1496  * separate different DMI fields in the card long name. Only number and
1497  * alphabet characters and a few separator characters are kept.
1498  */
1499 static void cleanup_dmi_name(char *name)
1500 {
1501         int i, j = 0;
1502
1503         for (i = 0; name[i]; i++) {
1504                 if (isalnum(name[i]) || (name[i] == '.')
1505                     || (name[i] == '_'))
1506                         name[j++] = name[i];
1507                 else if (name[i] == '-')
1508                         name[j++] = '_';
1509         }
1510
1511         name[j] = '\0';
1512 }
1513
1514 /*
1515  * Check if a DMI field is valid, i.e. not containing any string
1516  * in the black list.
1517  */
1518 static int is_dmi_valid(const char *field)
1519 {
1520         int i = 0;
1521
1522         while (dmi_blacklist[i]) {
1523                 if (strstr(field, dmi_blacklist[i]))
1524                         return 0;
1525                 i++;
1526         }
1527
1528         return 1;
1529 }
1530
1531 /*
1532  * Append a string to card->dmi_longname with character cleanups.
1533  */
1534 static void append_dmi_string(struct snd_soc_card *card, const char *str)
1535 {
1536         char *dst = card->dmi_longname;
1537         size_t dst_len = sizeof(card->dmi_longname);
1538         size_t len;
1539
1540         len = strlen(dst);
1541         snprintf(dst + len, dst_len - len, "-%s", str);
1542
1543         len++;  /* skip the separator "-" */
1544         if (len < dst_len)
1545                 cleanup_dmi_name(dst + len);
1546 }
1547
1548 /**
1549  * snd_soc_set_dmi_name() - Register DMI names to card
1550  * @card: The card to register DMI names
1551  * @flavour: The flavour "differentiator" for the card amongst its peers.
1552  *
1553  * An Intel machine driver may be used by many different devices but are
1554  * difficult for userspace to differentiate, since machine drivers ususally
1555  * use their own name as the card short name and leave the card long name
1556  * blank. To differentiate such devices and fix bugs due to lack of
1557  * device-specific configurations, this function allows DMI info to be used
1558  * as the sound card long name, in the format of
1559  * "vendor-product-version-board"
1560  * (Character '-' is used to separate different DMI fields here).
1561  * This will help the user space to load the device-specific Use Case Manager
1562  * (UCM) configurations for the card.
1563  *
1564  * Possible card long names may be:
1565  * DellInc.-XPS139343-01-0310JH
1566  * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1567  * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1568  *
1569  * This function also supports flavoring the card longname to provide
1570  * the extra differentiation, like "vendor-product-version-board-flavor".
1571  *
1572  * We only keep number and alphabet characters and a few separator characters
1573  * in the card long name since UCM in the user space uses the card long names
1574  * as card configuration directory names and AudoConf cannot support special
1575  * charactors like SPACE.
1576  *
1577  * Returns 0 on success, otherwise a negative error code.
1578  */
1579 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1580 {
1581         const char *vendor, *product, *product_version, *board;
1582
1583         if (card->long_name)
1584                 return 0; /* long name already set by driver or from DMI */
1585
1586         /* make up dmi long name as: vendor-product-version-board */
1587         vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1588         if (!vendor || !is_dmi_valid(vendor)) {
1589                 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1590                 return 0;
1591         }
1592
1593         snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
1594         cleanup_dmi_name(card->dmi_longname);
1595
1596         product = dmi_get_system_info(DMI_PRODUCT_NAME);
1597         if (product && is_dmi_valid(product)) {
1598                 append_dmi_string(card, product);
1599
1600                 /*
1601                  * some vendors like Lenovo may only put a self-explanatory
1602                  * name in the product version field
1603                  */
1604                 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1605                 if (product_version && is_dmi_valid(product_version))
1606                         append_dmi_string(card, product_version);
1607         }
1608
1609         board = dmi_get_system_info(DMI_BOARD_NAME);
1610         if (board && is_dmi_valid(board)) {
1611                 if (!product || strcasecmp(board, product))
1612                         append_dmi_string(card, board);
1613         } else if (!product) {
1614                 /* fall back to using legacy name */
1615                 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1616                 return 0;
1617         }
1618
1619         /* Add flavour to dmi long name */
1620         if (flavour)
1621                 append_dmi_string(card, flavour);
1622
1623         /* set the card long name */
1624         card->long_name = card->dmi_longname;
1625
1626         return 0;
1627 }
1628 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1629 #endif /* CONFIG_DMI */
1630
1631 static void soc_check_tplg_fes(struct snd_soc_card *card)
1632 {
1633         struct snd_soc_component *component;
1634         const struct snd_soc_component_driver *comp_drv;
1635         struct snd_soc_dai_link *dai_link;
1636         int i;
1637
1638         for_each_component(component) {
1639
1640                 /* does this component override BEs ? */
1641                 if (!component->driver->ignore_machine)
1642                         continue;
1643
1644                 /* for this machine ? */
1645                 if (!strcmp(component->driver->ignore_machine,
1646                             card->dev->driver->name))
1647                         goto match;
1648                 if (strcmp(component->driver->ignore_machine,
1649                            dev_name(card->dev)))
1650                         continue;
1651 match:
1652                 /* machine matches, so override the rtd data */
1653                 for_each_card_prelinks(card, i, dai_link) {
1654
1655                         /* ignore this FE */
1656                         if (dai_link->dynamic) {
1657                                 dai_link->ignore = true;
1658                                 continue;
1659                         }
1660
1661                         dev_dbg(card->dev, "info: override BE DAI link %s\n",
1662                                 card->dai_link[i].name);
1663
1664                         /* override platform component */
1665                         if (!dai_link->platforms) {
1666                                 dev_err(card->dev, "init platform error");
1667                                 continue;
1668                         }
1669                         dai_link->platforms->name = component->name;
1670
1671                         /* convert non BE into BE */
1672                         if (!dai_link->no_pcm) {
1673                                 dai_link->no_pcm = 1;
1674
1675                                 if (dai_link->dpcm_playback)
1676                                         dev_warn(card->dev,
1677                                                  "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
1678                                                  dai_link->name);
1679                                 if (dai_link->dpcm_capture)
1680                                         dev_warn(card->dev,
1681                                                  "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
1682                                                  dai_link->name);
1683
1684                                 /* convert normal link into DPCM one */
1685                                 if (!(dai_link->dpcm_playback ||
1686                                       dai_link->dpcm_capture)) {
1687                                         dai_link->dpcm_playback = !dai_link->capture_only;
1688                                         dai_link->dpcm_capture = !dai_link->playback_only;
1689                                 }
1690                         }
1691
1692                         /*
1693                          * override any BE fixups
1694                          * see
1695                          *      snd_soc_link_be_hw_params_fixup()
1696                          */
1697                         dai_link->be_hw_params_fixup =
1698                                 component->driver->be_hw_params_fixup;
1699
1700                         /*
1701                          * most BE links don't set stream name, so set it to
1702                          * dai link name if it's NULL to help bind widgets.
1703                          */
1704                         if (!dai_link->stream_name)
1705                                 dai_link->stream_name = dai_link->name;
1706                 }
1707
1708                 /* Inform userspace we are using alternate topology */
1709                 if (component->driver->topology_name_prefix) {
1710
1711                         /* topology shortname created? */
1712                         if (!card->topology_shortname_created) {
1713                                 comp_drv = component->driver;
1714
1715                                 snprintf(card->topology_shortname, 32, "%s-%s",
1716                                          comp_drv->topology_name_prefix,
1717                                          card->name);
1718                                 card->topology_shortname_created = true;
1719                         }
1720
1721                         /* use topology shortname */
1722                         card->name = card->topology_shortname;
1723                 }
1724         }
1725 }
1726
1727 #define soc_setup_card_name(name, name1, name2, norm)           \
1728         __soc_setup_card_name(name, sizeof(name), name1, name2, norm)
1729 static void __soc_setup_card_name(char *name, int len,
1730                                   const char *name1, const char *name2,
1731                                   int normalization)
1732 {
1733         int i;
1734
1735         snprintf(name, len, "%s", name1 ? name1 : name2);
1736
1737         if (!normalization)
1738                 return;
1739
1740         /*
1741          * Name normalization
1742          *
1743          * The driver name is somewhat special, as it's used as a key for
1744          * searches in the user-space.
1745          *
1746          * ex)
1747          *      "abcd??efg" -> "abcd__efg"
1748          */
1749         for (i = 0; i < len; i++) {
1750                 switch (name[i]) {
1751                 case '_':
1752                 case '-':
1753                 case '\0':
1754                         break;
1755                 default:
1756                         if (!isalnum(name[i]))
1757                                 name[i] = '_';
1758                         break;
1759                 }
1760         }
1761 }
1762
1763 static void soc_cleanup_card_resources(struct snd_soc_card *card)
1764 {
1765         struct snd_soc_pcm_runtime *rtd, *n;
1766
1767         if (card->snd_card)
1768                 snd_card_disconnect_sync(card->snd_card);
1769
1770         snd_soc_dapm_shutdown(card);
1771
1772         /* remove and free each DAI */
1773         soc_remove_link_dais(card);
1774         soc_remove_link_components(card);
1775
1776         for_each_card_rtds_safe(card, rtd, n)
1777                 snd_soc_remove_pcm_runtime(card, rtd);
1778
1779         /* remove auxiliary devices */
1780         soc_remove_aux_devices(card);
1781         soc_unbind_aux_dev(card);
1782
1783         snd_soc_dapm_free(&card->dapm);
1784         soc_cleanup_card_debugfs(card);
1785
1786         /* remove the card */
1787         snd_soc_card_remove(card);
1788
1789         if (card->snd_card) {
1790                 snd_card_free(card->snd_card);
1791                 card->snd_card = NULL;
1792         }
1793 }
1794
1795 static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
1796 {
1797         if (card->instantiated) {
1798                 card->instantiated = false;
1799                 snd_soc_flush_all_delayed_work(card);
1800
1801                 soc_cleanup_card_resources(card);
1802                 if (!unregister)
1803                         list_add(&card->list, &unbind_card_list);
1804         } else {
1805                 if (unregister)
1806                         list_del(&card->list);
1807         }
1808 }
1809
1810 static int snd_soc_bind_card(struct snd_soc_card *card)
1811 {
1812         struct snd_soc_pcm_runtime *rtd;
1813         struct snd_soc_component *component;
1814         struct snd_soc_dai_link *dai_link;
1815         int ret, i;
1816
1817         mutex_lock(&client_mutex);
1818         mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1819
1820         snd_soc_dapm_init(&card->dapm, card, NULL);
1821
1822         /* check whether any platform is ignore machine FE and using topology */
1823         soc_check_tplg_fes(card);
1824
1825         /* bind aux_devs too */
1826         ret = soc_bind_aux_dev(card);
1827         if (ret < 0)
1828                 goto probe_end;
1829
1830         /* add predefined DAI links to the list */
1831         card->num_rtd = 0;
1832         for_each_card_prelinks(card, i, dai_link) {
1833                 ret = snd_soc_add_pcm_runtime(card, dai_link);
1834                 if (ret < 0)
1835                         goto probe_end;
1836         }
1837
1838         /* card bind complete so register a sound card */
1839         ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1840                         card->owner, 0, &card->snd_card);
1841         if (ret < 0) {
1842                 dev_err(card->dev,
1843                         "ASoC: can't create sound card for card %s: %d\n",
1844                         card->name, ret);
1845                 goto probe_end;
1846         }
1847
1848         soc_init_card_debugfs(card);
1849
1850         soc_resume_init(card);
1851
1852         ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1853                                         card->num_dapm_widgets);
1854         if (ret < 0)
1855                 goto probe_end;
1856
1857         ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1858                                         card->num_of_dapm_widgets);
1859         if (ret < 0)
1860                 goto probe_end;
1861
1862         /* initialise the sound card only once */
1863         ret = snd_soc_card_probe(card);
1864         if (ret < 0)
1865                 goto probe_end;
1866
1867         /* probe all components used by DAI links on this card */
1868         ret = soc_probe_link_components(card);
1869         if (ret < 0) {
1870                 dev_err(card->dev,
1871                         "ASoC: failed to instantiate card %d\n", ret);
1872                 goto probe_end;
1873         }
1874
1875         /* probe auxiliary components */
1876         ret = soc_probe_aux_devices(card);
1877         if (ret < 0) {
1878                 dev_err(card->dev,
1879                         "ASoC: failed to probe aux component %d\n", ret);
1880                 goto probe_end;
1881         }
1882
1883         /* probe all DAI links on this card */
1884         ret = soc_probe_link_dais(card);
1885         if (ret < 0) {
1886                 dev_err(card->dev,
1887                         "ASoC: failed to instantiate card %d\n", ret);
1888                 goto probe_end;
1889         }
1890
1891         for_each_card_rtds(card, rtd) {
1892                 ret = soc_init_pcm_runtime(card, rtd);
1893                 if (ret < 0)
1894                         goto probe_end;
1895         }
1896
1897         snd_soc_dapm_link_dai_widgets(card);
1898         snd_soc_dapm_connect_dai_link_widgets(card);
1899
1900         ret = snd_soc_add_card_controls(card, card->controls,
1901                                         card->num_controls);
1902         if (ret < 0)
1903                 goto probe_end;
1904
1905         ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
1906                                       card->num_dapm_routes);
1907         if (ret < 0) {
1908                 if (card->disable_route_checks) {
1909                         dev_info(card->dev,
1910                                  "%s: disable_route_checks set, ignoring errors on add_routes\n",
1911                                  __func__);
1912                 } else {
1913                         dev_err(card->dev,
1914                                  "%s: snd_soc_dapm_add_routes failed: %d\n",
1915                                  __func__, ret);
1916                         goto probe_end;
1917                 }
1918         }
1919
1920         ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
1921                                       card->num_of_dapm_routes);
1922         if (ret < 0)
1923                 goto probe_end;
1924
1925         /* try to set some sane longname if DMI is available */
1926         snd_soc_set_dmi_name(card, NULL);
1927
1928         soc_setup_card_name(card->snd_card->shortname,
1929                             card->name, NULL, 0);
1930         soc_setup_card_name(card->snd_card->longname,
1931                             card->long_name, card->name, 0);
1932         soc_setup_card_name(card->snd_card->driver,
1933                             card->driver_name, card->name, 1);
1934
1935         if (card->components) {
1936                 /* the current implementation of snd_component_add() accepts */
1937                 /* multiple components in the string separated by space, */
1938                 /* but the string collision (identical string) check might */
1939                 /* not work correctly */
1940                 ret = snd_component_add(card->snd_card, card->components);
1941                 if (ret < 0) {
1942                         dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
1943                                 card->name, ret);
1944                         goto probe_end;
1945                 }
1946         }
1947
1948         ret = snd_soc_card_late_probe(card);
1949         if (ret < 0)
1950                 goto probe_end;
1951
1952         snd_soc_dapm_new_widgets(card);
1953
1954         ret = snd_card_register(card->snd_card);
1955         if (ret < 0) {
1956                 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
1957                                 ret);
1958                 goto probe_end;
1959         }
1960
1961         card->instantiated = 1;
1962         dapm_mark_endpoints_dirty(card);
1963         snd_soc_dapm_sync(&card->dapm);
1964
1965         /* deactivate pins to sleep state */
1966         for_each_card_components(card, component)
1967                 if (!snd_soc_component_active(component))
1968                         pinctrl_pm_select_sleep_state(component->dev);
1969
1970 probe_end:
1971         if (ret < 0)
1972                 soc_cleanup_card_resources(card);
1973
1974         mutex_unlock(&card->mutex);
1975         mutex_unlock(&client_mutex);
1976
1977         return ret;
1978 }
1979
1980 /* probes a new socdev */
1981 static int soc_probe(struct platform_device *pdev)
1982 {
1983         struct snd_soc_card *card = platform_get_drvdata(pdev);
1984
1985         /*
1986          * no card, so machine driver should be registering card
1987          * we should not be here in that case so ret error
1988          */
1989         if (!card)
1990                 return -EINVAL;
1991
1992         dev_warn(&pdev->dev,
1993                  "ASoC: machine %s should use snd_soc_register_card()\n",
1994                  card->name);
1995
1996         /* Bodge while we unpick instantiation */
1997         card->dev = &pdev->dev;
1998
1999         return snd_soc_register_card(card);
2000 }
2001
2002 /* removes a socdev */
2003 static int soc_remove(struct platform_device *pdev)
2004 {
2005         struct snd_soc_card *card = platform_get_drvdata(pdev);
2006
2007         snd_soc_unregister_card(card);
2008         return 0;
2009 }
2010
2011 int snd_soc_poweroff(struct device *dev)
2012 {
2013         struct snd_soc_card *card = dev_get_drvdata(dev);
2014         struct snd_soc_component *component;
2015
2016         if (!card->instantiated)
2017                 return 0;
2018
2019         /*
2020          * Flush out pmdown_time work - we actually do want to run it
2021          * now, we're shutting down so no imminent restart.
2022          */
2023         snd_soc_flush_all_delayed_work(card);
2024
2025         snd_soc_dapm_shutdown(card);
2026
2027         /* deactivate pins to sleep state */
2028         for_each_card_components(card, component)
2029                 pinctrl_pm_select_sleep_state(component->dev);
2030
2031         return 0;
2032 }
2033 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2034
2035 const struct dev_pm_ops snd_soc_pm_ops = {
2036         .suspend = snd_soc_suspend,
2037         .resume = snd_soc_resume,
2038         .freeze = snd_soc_suspend,
2039         .thaw = snd_soc_resume,
2040         .poweroff = snd_soc_poweroff,
2041         .restore = snd_soc_resume,
2042 };
2043 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2044
2045 /* ASoC platform driver */
2046 static struct platform_driver soc_driver = {
2047         .driver         = {
2048                 .name           = "soc-audio",
2049                 .pm             = &snd_soc_pm_ops,
2050         },
2051         .probe          = soc_probe,
2052         .remove         = soc_remove,
2053 };
2054
2055 /**
2056  * snd_soc_cnew - create new control
2057  * @_template: control template
2058  * @data: control private data
2059  * @long_name: control long name
2060  * @prefix: control name prefix
2061  *
2062  * Create a new mixer control from a template control.
2063  *
2064  * Returns 0 for success, else error.
2065  */
2066 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2067                                   void *data, const char *long_name,
2068                                   const char *prefix)
2069 {
2070         struct snd_kcontrol_new template;
2071         struct snd_kcontrol *kcontrol;
2072         char *name = NULL;
2073
2074         memcpy(&template, _template, sizeof(template));
2075         template.index = 0;
2076
2077         if (!long_name)
2078                 long_name = template.name;
2079
2080         if (prefix) {
2081                 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2082                 if (!name)
2083                         return NULL;
2084
2085                 template.name = name;
2086         } else {
2087                 template.name = long_name;
2088         }
2089
2090         kcontrol = snd_ctl_new1(&template, data);
2091
2092         kfree(name);
2093
2094         return kcontrol;
2095 }
2096 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2097
2098 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2099         const struct snd_kcontrol_new *controls, int num_controls,
2100         const char *prefix, void *data)
2101 {
2102         int err, i;
2103
2104         for (i = 0; i < num_controls; i++) {
2105                 const struct snd_kcontrol_new *control = &controls[i];
2106
2107                 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2108                                                      control->name, prefix));
2109                 if (err < 0) {
2110                         dev_err(dev, "ASoC: Failed to add %s: %d\n",
2111                                 control->name, err);
2112                         return err;
2113                 }
2114         }
2115
2116         return 0;
2117 }
2118
2119 /**
2120  * snd_soc_add_component_controls - Add an array of controls to a component.
2121  *
2122  * @component: Component to add controls to
2123  * @controls: Array of controls to add
2124  * @num_controls: Number of elements in the array
2125  *
2126  * Return: 0 for success, else error.
2127  */
2128 int snd_soc_add_component_controls(struct snd_soc_component *component,
2129         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2130 {
2131         struct snd_card *card = component->card->snd_card;
2132
2133         return snd_soc_add_controls(card, component->dev, controls,
2134                         num_controls, component->name_prefix, component);
2135 }
2136 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2137
2138 /**
2139  * snd_soc_add_card_controls - add an array of controls to a SoC card.
2140  * Convenience function to add a list of controls.
2141  *
2142  * @soc_card: SoC card to add controls to
2143  * @controls: array of controls to add
2144  * @num_controls: number of elements in the array
2145  *
2146  * Return 0 for success, else error.
2147  */
2148 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2149         const struct snd_kcontrol_new *controls, int num_controls)
2150 {
2151         struct snd_card *card = soc_card->snd_card;
2152
2153         return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2154                         NULL, soc_card);
2155 }
2156 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2157
2158 /**
2159  * snd_soc_add_dai_controls - add an array of controls to a DAI.
2160  * Convienience function to add a list of controls.
2161  *
2162  * @dai: DAI to add controls to
2163  * @controls: array of controls to add
2164  * @num_controls: number of elements in the array
2165  *
2166  * Return 0 for success, else error.
2167  */
2168 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2169         const struct snd_kcontrol_new *controls, int num_controls)
2170 {
2171         struct snd_card *card = dai->component->card->snd_card;
2172
2173         return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2174                         NULL, dai);
2175 }
2176 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2177
2178 /**
2179  * snd_soc_register_card - Register a card with the ASoC core
2180  *
2181  * @card: Card to register
2182  *
2183  */
2184 int snd_soc_register_card(struct snd_soc_card *card)
2185 {
2186         if (!card->name || !card->dev)
2187                 return -EINVAL;
2188
2189         dev_set_drvdata(card->dev, card);
2190
2191         INIT_LIST_HEAD(&card->widgets);
2192         INIT_LIST_HEAD(&card->paths);
2193         INIT_LIST_HEAD(&card->dapm_list);
2194         INIT_LIST_HEAD(&card->aux_comp_list);
2195         INIT_LIST_HEAD(&card->component_dev_list);
2196         INIT_LIST_HEAD(&card->list);
2197         INIT_LIST_HEAD(&card->rtd_list);
2198         INIT_LIST_HEAD(&card->dapm_dirty);
2199         INIT_LIST_HEAD(&card->dobj_list);
2200
2201         card->instantiated = 0;
2202         mutex_init(&card->mutex);
2203         mutex_init(&card->dapm_mutex);
2204         mutex_init(&card->pcm_mutex);
2205         spin_lock_init(&card->dpcm_lock);
2206
2207         return snd_soc_bind_card(card);
2208 }
2209 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2210
2211 /**
2212  * snd_soc_unregister_card - Unregister a card with the ASoC core
2213  *
2214  * @card: Card to unregister
2215  *
2216  */
2217 int snd_soc_unregister_card(struct snd_soc_card *card)
2218 {
2219         mutex_lock(&client_mutex);
2220         snd_soc_unbind_card(card, true);
2221         mutex_unlock(&client_mutex);
2222         dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2223
2224         return 0;
2225 }
2226 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2227
2228 /*
2229  * Simplify DAI link configuration by removing ".-1" from device names
2230  * and sanitizing names.
2231  */
2232 static char *fmt_single_name(struct device *dev, int *id)
2233 {
2234         char *found, name[NAME_SIZE];
2235         int id1, id2;
2236
2237         if (dev_name(dev) == NULL)
2238                 return NULL;
2239
2240         strlcpy(name, dev_name(dev), NAME_SIZE);
2241
2242         /* are we a "%s.%d" name (platform and SPI components) */
2243         found = strstr(name, dev->driver->name);
2244         if (found) {
2245                 /* get ID */
2246                 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2247
2248                         /* discard ID from name if ID == -1 */
2249                         if (*id == -1)
2250                                 found[strlen(dev->driver->name)] = '\0';
2251                 }
2252
2253         } else {
2254                 /* I2C component devices are named "bus-addr" */
2255                 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2256                         char tmp[NAME_SIZE];
2257
2258                         /* create unique ID number from I2C addr and bus */
2259                         *id = ((id1 & 0xffff) << 16) + id2;
2260
2261                         /* sanitize component name for DAI link creation */
2262                         snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2263                                  name);
2264                         strlcpy(name, tmp, NAME_SIZE);
2265                 } else
2266                         *id = 0;
2267         }
2268
2269         return devm_kstrdup(dev, name, GFP_KERNEL);
2270 }
2271
2272 /*
2273  * Simplify DAI link naming for single devices with multiple DAIs by removing
2274  * any ".-1" and using the DAI name (instead of device name).
2275  */
2276 static inline char *fmt_multiple_name(struct device *dev,
2277                 struct snd_soc_dai_driver *dai_drv)
2278 {
2279         if (dai_drv->name == NULL) {
2280                 dev_err(dev,
2281                         "ASoC: error - multiple DAI %s registered with no name\n",
2282                         dev_name(dev));
2283                 return NULL;
2284         }
2285
2286         return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2287 }
2288
2289 void snd_soc_unregister_dai(struct snd_soc_dai *dai)
2290 {
2291         dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2292         list_del(&dai->list);
2293 }
2294 EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2295
2296 /**
2297  * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2298  *
2299  * @component: The component the DAIs are registered for
2300  * @dai_drv: DAI driver to use for the DAI
2301  * @legacy_dai_naming: if %true, use legacy single-name format;
2302  *      if %false, use multiple-name format;
2303  *
2304  * Topology can use this API to register DAIs when probing a component.
2305  * These DAIs's widgets will be freed in the card cleanup and the DAIs
2306  * will be freed in the component cleanup.
2307  */
2308 struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2309                                          struct snd_soc_dai_driver *dai_drv,
2310                                          bool legacy_dai_naming)
2311 {
2312         struct device *dev = component->dev;
2313         struct snd_soc_dai *dai;
2314
2315         dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2316
2317         lockdep_assert_held(&client_mutex);
2318
2319         dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2320         if (dai == NULL)
2321                 return NULL;
2322
2323         /*
2324          * Back in the old days when we still had component-less DAIs,
2325          * instead of having a static name, component-less DAIs would
2326          * inherit the name of the parent device so it is possible to
2327          * register multiple instances of the DAI. We still need to keep
2328          * the same naming style even though those DAIs are not
2329          * component-less anymore.
2330          */
2331         if (legacy_dai_naming &&
2332             (dai_drv->id == 0 || dai_drv->name == NULL)) {
2333                 dai->name = fmt_single_name(dev, &dai->id);
2334         } else {
2335                 dai->name = fmt_multiple_name(dev, dai_drv);
2336                 if (dai_drv->id)
2337                         dai->id = dai_drv->id;
2338                 else
2339                         dai->id = component->num_dai;
2340         }
2341         if (!dai->name)
2342                 return NULL;
2343
2344         dai->component = component;
2345         dai->dev = dev;
2346         dai->driver = dai_drv;
2347
2348         /* see for_each_component_dais */
2349         list_add_tail(&dai->list, &component->dai_list);
2350         component->num_dai++;
2351
2352         dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2353         return dai;
2354 }
2355
2356 /**
2357  * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2358  *
2359  * @component: The component for which the DAIs should be unregistered
2360  */
2361 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2362 {
2363         struct snd_soc_dai *dai, *_dai;
2364
2365         for_each_component_dais_safe(component, dai, _dai)
2366                 snd_soc_unregister_dai(dai);
2367 }
2368
2369 /**
2370  * snd_soc_register_dais - Register a DAI with the ASoC core
2371  *
2372  * @component: The component the DAIs are registered for
2373  * @dai_drv: DAI driver to use for the DAIs
2374  * @count: Number of DAIs
2375  */
2376 static int snd_soc_register_dais(struct snd_soc_component *component,
2377                                  struct snd_soc_dai_driver *dai_drv,
2378                                  size_t count)
2379 {
2380         struct snd_soc_dai *dai;
2381         unsigned int i;
2382         int ret;
2383
2384         for (i = 0; i < count; i++) {
2385                 dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2386                                   !component->driver->non_legacy_dai_naming);
2387                 if (dai == NULL) {
2388                         ret = -ENOMEM;
2389                         goto err;
2390                 }
2391         }
2392
2393         return 0;
2394
2395 err:
2396         snd_soc_unregister_dais(component);
2397
2398         return ret;
2399 }
2400
2401 #define ENDIANNESS_MAP(name) \
2402         (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2403 static u64 endianness_format_map[] = {
2404         ENDIANNESS_MAP(S16_),
2405         ENDIANNESS_MAP(U16_),
2406         ENDIANNESS_MAP(S24_),
2407         ENDIANNESS_MAP(U24_),
2408         ENDIANNESS_MAP(S32_),
2409         ENDIANNESS_MAP(U32_),
2410         ENDIANNESS_MAP(S24_3),
2411         ENDIANNESS_MAP(U24_3),
2412         ENDIANNESS_MAP(S20_3),
2413         ENDIANNESS_MAP(U20_3),
2414         ENDIANNESS_MAP(S18_3),
2415         ENDIANNESS_MAP(U18_3),
2416         ENDIANNESS_MAP(FLOAT_),
2417         ENDIANNESS_MAP(FLOAT64_),
2418         ENDIANNESS_MAP(IEC958_SUBFRAME_),
2419 };
2420
2421 /*
2422  * Fix up the DAI formats for endianness: codecs don't actually see
2423  * the endianness of the data but we're using the CPU format
2424  * definitions which do need to include endianness so we ensure that
2425  * codec DAIs always have both big and little endian variants set.
2426  */
2427 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2428 {
2429         int i;
2430
2431         for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2432                 if (stream->formats & endianness_format_map[i])
2433                         stream->formats |= endianness_format_map[i];
2434 }
2435
2436 static void snd_soc_try_rebind_card(void)
2437 {
2438         struct snd_soc_card *card, *c;
2439
2440         list_for_each_entry_safe(card, c, &unbind_card_list, list)
2441                 if (!snd_soc_bind_card(card))
2442                         list_del(&card->list);
2443 }
2444
2445 static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2446 {
2447         struct snd_soc_card *card = component->card;
2448
2449         snd_soc_unregister_dais(component);
2450
2451         if (card)
2452                 snd_soc_unbind_card(card, false);
2453
2454         list_del(&component->list);
2455 }
2456
2457 int snd_soc_component_initialize(struct snd_soc_component *component,
2458                                  const struct snd_soc_component_driver *driver,
2459                                  struct device *dev)
2460 {
2461         INIT_LIST_HEAD(&component->dai_list);
2462         INIT_LIST_HEAD(&component->dobj_list);
2463         INIT_LIST_HEAD(&component->card_list);
2464         mutex_init(&component->io_mutex);
2465
2466         component->name = fmt_single_name(dev, &component->id);
2467         if (!component->name) {
2468                 dev_err(dev, "ASoC: Failed to allocate name\n");
2469                 return -ENOMEM;
2470         }
2471
2472         component->dev          = dev;
2473         component->driver       = driver;
2474
2475         return 0;
2476 }
2477 EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2478
2479 int snd_soc_add_component(struct snd_soc_component *component,
2480                           struct snd_soc_dai_driver *dai_drv,
2481                           int num_dai)
2482 {
2483         int ret;
2484         int i;
2485
2486         mutex_lock(&client_mutex);
2487
2488         if (component->driver->endianness) {
2489                 for (i = 0; i < num_dai; i++) {
2490                         convert_endianness_formats(&dai_drv[i].playback);
2491                         convert_endianness_formats(&dai_drv[i].capture);
2492                 }
2493         }
2494
2495         ret = snd_soc_register_dais(component, dai_drv, num_dai);
2496         if (ret < 0) {
2497                 dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2498                         ret);
2499                 goto err_cleanup;
2500         }
2501
2502         if (!component->driver->write && !component->driver->read) {
2503                 if (!component->regmap)
2504                         component->regmap = dev_get_regmap(component->dev,
2505                                                            NULL);
2506                 if (component->regmap)
2507                         snd_soc_component_setup_regmap(component);
2508         }
2509
2510         /* see for_each_component */
2511         list_add(&component->list, &component_list);
2512
2513 err_cleanup:
2514         if (ret < 0)
2515                 snd_soc_del_component_unlocked(component);
2516
2517         mutex_unlock(&client_mutex);
2518
2519         if (ret == 0)
2520                 snd_soc_try_rebind_card();
2521
2522         return ret;
2523 }
2524 EXPORT_SYMBOL_GPL(snd_soc_add_component);
2525
2526 int snd_soc_register_component(struct device *dev,
2527                         const struct snd_soc_component_driver *component_driver,
2528                         struct snd_soc_dai_driver *dai_drv,
2529                         int num_dai)
2530 {
2531         struct snd_soc_component *component;
2532         int ret;
2533
2534         component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2535         if (!component)
2536                 return -ENOMEM;
2537
2538         ret = snd_soc_component_initialize(component, component_driver, dev);
2539         if (ret < 0)
2540                 return ret;
2541
2542         return snd_soc_add_component(component, dai_drv, num_dai);
2543 }
2544 EXPORT_SYMBOL_GPL(snd_soc_register_component);
2545
2546 /**
2547  * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2548  * from the ASoC core
2549  *
2550  * @dev: The device to unregister
2551  * @component_driver: The component driver to unregister
2552  */
2553 void snd_soc_unregister_component_by_driver(struct device *dev,
2554                                             const struct snd_soc_component_driver *component_driver)
2555 {
2556         struct snd_soc_component *component;
2557
2558         if (!component_driver)
2559                 return;
2560
2561         mutex_lock(&client_mutex);
2562         component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2563         if (!component)
2564                 goto out;
2565
2566         snd_soc_del_component_unlocked(component);
2567
2568 out:
2569         mutex_unlock(&client_mutex);
2570 }
2571 EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2572
2573 /**
2574  * snd_soc_unregister_component - Unregister all related component
2575  * from the ASoC core
2576  *
2577  * @dev: The device to unregister
2578  */
2579 void snd_soc_unregister_component(struct device *dev)
2580 {
2581         struct snd_soc_component *component;
2582
2583         mutex_lock(&client_mutex);
2584         while (1) {
2585                 component = snd_soc_lookup_component_nolocked(dev, NULL);
2586                 if (!component)
2587                         break;
2588
2589                 snd_soc_del_component_unlocked(component);
2590         }
2591         mutex_unlock(&client_mutex);
2592 }
2593 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2594
2595 /* Retrieve a card's name from device tree */
2596 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2597                                const char *propname)
2598 {
2599         struct device_node *np;
2600         int ret;
2601
2602         if (!card->dev) {
2603                 pr_err("card->dev is not set before calling %s\n", __func__);
2604                 return -EINVAL;
2605         }
2606
2607         np = card->dev->of_node;
2608
2609         ret = of_property_read_string_index(np, propname, 0, &card->name);
2610         /*
2611          * EINVAL means the property does not exist. This is fine providing
2612          * card->name was previously set, which is checked later in
2613          * snd_soc_register_card.
2614          */
2615         if (ret < 0 && ret != -EINVAL) {
2616                 dev_err(card->dev,
2617                         "ASoC: Property '%s' could not be read: %d\n",
2618                         propname, ret);
2619                 return ret;
2620         }
2621
2622         return 0;
2623 }
2624 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2625
2626 static const struct snd_soc_dapm_widget simple_widgets[] = {
2627         SND_SOC_DAPM_MIC("Microphone", NULL),
2628         SND_SOC_DAPM_LINE("Line", NULL),
2629         SND_SOC_DAPM_HP("Headphone", NULL),
2630         SND_SOC_DAPM_SPK("Speaker", NULL),
2631 };
2632
2633 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2634                                           const char *propname)
2635 {
2636         struct device_node *np = card->dev->of_node;
2637         struct snd_soc_dapm_widget *widgets;
2638         const char *template, *wname;
2639         int i, j, num_widgets, ret;
2640
2641         num_widgets = of_property_count_strings(np, propname);
2642         if (num_widgets < 0) {
2643                 dev_err(card->dev,
2644                         "ASoC: Property '%s' does not exist\n", propname);
2645                 return -EINVAL;
2646         }
2647         if (num_widgets & 1) {
2648                 dev_err(card->dev,
2649                         "ASoC: Property '%s' length is not even\n", propname);
2650                 return -EINVAL;
2651         }
2652
2653         num_widgets /= 2;
2654         if (!num_widgets) {
2655                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2656                         propname);
2657                 return -EINVAL;
2658         }
2659
2660         widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2661                                GFP_KERNEL);
2662         if (!widgets) {
2663                 dev_err(card->dev,
2664                         "ASoC: Could not allocate memory for widgets\n");
2665                 return -ENOMEM;
2666         }
2667
2668         for (i = 0; i < num_widgets; i++) {
2669                 ret = of_property_read_string_index(np, propname,
2670                         2 * i, &template);
2671                 if (ret) {
2672                         dev_err(card->dev,
2673                                 "ASoC: Property '%s' index %d read error:%d\n",
2674                                 propname, 2 * i, ret);
2675                         return -EINVAL;
2676                 }
2677
2678                 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
2679                         if (!strncmp(template, simple_widgets[j].name,
2680                                      strlen(simple_widgets[j].name))) {
2681                                 widgets[i] = simple_widgets[j];
2682                                 break;
2683                         }
2684                 }
2685
2686                 if (j >= ARRAY_SIZE(simple_widgets)) {
2687                         dev_err(card->dev,
2688                                 "ASoC: DAPM widget '%s' is not supported\n",
2689                                 template);
2690                         return -EINVAL;
2691                 }
2692
2693                 ret = of_property_read_string_index(np, propname,
2694                                                     (2 * i) + 1,
2695                                                     &wname);
2696                 if (ret) {
2697                         dev_err(card->dev,
2698                                 "ASoC: Property '%s' index %d read error:%d\n",
2699                                 propname, (2 * i) + 1, ret);
2700                         return -EINVAL;
2701                 }
2702
2703                 widgets[i].name = wname;
2704         }
2705
2706         card->of_dapm_widgets = widgets;
2707         card->num_of_dapm_widgets = num_widgets;
2708
2709         return 0;
2710 }
2711 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
2712
2713 int snd_soc_of_get_slot_mask(struct device_node *np,
2714                              const char *prop_name,
2715                              unsigned int *mask)
2716 {
2717         u32 val;
2718         const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
2719         int i;
2720
2721         if (!of_slot_mask)
2722                 return 0;
2723         val /= sizeof(u32);
2724         for (i = 0; i < val; i++)
2725                 if (be32_to_cpup(&of_slot_mask[i]))
2726                         *mask |= (1 << i);
2727
2728         return val;
2729 }
2730 EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
2731
2732 int snd_soc_of_parse_tdm_slot(struct device_node *np,
2733                               unsigned int *tx_mask,
2734                               unsigned int *rx_mask,
2735                               unsigned int *slots,
2736                               unsigned int *slot_width)
2737 {
2738         u32 val;
2739         int ret;
2740
2741         if (tx_mask)
2742                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
2743         if (rx_mask)
2744                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
2745
2746         if (of_property_read_bool(np, "dai-tdm-slot-num")) {
2747                 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
2748                 if (ret)
2749                         return ret;
2750
2751                 if (slots)
2752                         *slots = val;
2753         }
2754
2755         if (of_property_read_bool(np, "dai-tdm-slot-width")) {
2756                 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
2757                 if (ret)
2758                         return ret;
2759
2760                 if (slot_width)
2761                         *slot_width = val;
2762         }
2763
2764         return 0;
2765 }
2766 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
2767
2768 void snd_soc_of_parse_node_prefix(struct device_node *np,
2769                                   struct snd_soc_codec_conf *codec_conf,
2770                                   struct device_node *of_node,
2771                                   const char *propname)
2772 {
2773         const char *str;
2774         int ret;
2775
2776         ret = of_property_read_string(np, propname, &str);
2777         if (ret < 0) {
2778                 /* no prefix is not error */
2779                 return;
2780         }
2781
2782         codec_conf->dlc.of_node = of_node;
2783         codec_conf->name_prefix = str;
2784 }
2785 EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
2786
2787 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
2788                                    const char *propname)
2789 {
2790         struct device_node *np = card->dev->of_node;
2791         int num_routes;
2792         struct snd_soc_dapm_route *routes;
2793         int i, ret;
2794
2795         num_routes = of_property_count_strings(np, propname);
2796         if (num_routes < 0 || num_routes & 1) {
2797                 dev_err(card->dev,
2798                         "ASoC: Property '%s' does not exist or its length is not even\n",
2799                         propname);
2800                 return -EINVAL;
2801         }
2802         num_routes /= 2;
2803         if (!num_routes) {
2804                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2805                         propname);
2806                 return -EINVAL;
2807         }
2808
2809         routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
2810                               GFP_KERNEL);
2811         if (!routes) {
2812                 dev_err(card->dev,
2813                         "ASoC: Could not allocate DAPM route table\n");
2814                 return -EINVAL;
2815         }
2816
2817         for (i = 0; i < num_routes; i++) {
2818                 ret = of_property_read_string_index(np, propname,
2819                         2 * i, &routes[i].sink);
2820                 if (ret) {
2821                         dev_err(card->dev,
2822                                 "ASoC: Property '%s' index %d could not be read: %d\n",
2823                                 propname, 2 * i, ret);
2824                         return -EINVAL;
2825                 }
2826                 ret = of_property_read_string_index(np, propname,
2827                         (2 * i) + 1, &routes[i].source);
2828                 if (ret) {
2829                         dev_err(card->dev,
2830                                 "ASoC: Property '%s' index %d could not be read: %d\n",
2831                                 propname, (2 * i) + 1, ret);
2832                         return -EINVAL;
2833                 }
2834         }
2835
2836         card->num_of_dapm_routes = num_routes;
2837         card->of_dapm_routes = routes;
2838
2839         return 0;
2840 }
2841 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
2842
2843 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
2844                                      const char *prefix,
2845                                      struct device_node **bitclkmaster,
2846                                      struct device_node **framemaster)
2847 {
2848         int ret, i;
2849         char prop[128];
2850         unsigned int format = 0;
2851         int bit, frame;
2852         const char *str;
2853         struct {
2854                 char *name;
2855                 unsigned int val;
2856         } of_fmt_table[] = {
2857                 { "i2s",        SND_SOC_DAIFMT_I2S },
2858                 { "right_j",    SND_SOC_DAIFMT_RIGHT_J },
2859                 { "left_j",     SND_SOC_DAIFMT_LEFT_J },
2860                 { "dsp_a",      SND_SOC_DAIFMT_DSP_A },
2861                 { "dsp_b",      SND_SOC_DAIFMT_DSP_B },
2862                 { "ac97",       SND_SOC_DAIFMT_AC97 },
2863                 { "pdm",        SND_SOC_DAIFMT_PDM},
2864                 { "msb",        SND_SOC_DAIFMT_MSB },
2865                 { "lsb",        SND_SOC_DAIFMT_LSB },
2866         };
2867
2868         if (!prefix)
2869                 prefix = "";
2870
2871         /*
2872          * check "dai-format = xxx"
2873          * or    "[prefix]format = xxx"
2874          * SND_SOC_DAIFMT_FORMAT_MASK area
2875          */
2876         ret = of_property_read_string(np, "dai-format", &str);
2877         if (ret < 0) {
2878                 snprintf(prop, sizeof(prop), "%sformat", prefix);
2879                 ret = of_property_read_string(np, prop, &str);
2880         }
2881         if (ret == 0) {
2882                 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
2883                         if (strcmp(str, of_fmt_table[i].name) == 0) {
2884                                 format |= of_fmt_table[i].val;
2885                                 break;
2886                         }
2887                 }
2888         }
2889
2890         /*
2891          * check "[prefix]continuous-clock"
2892          * SND_SOC_DAIFMT_CLOCK_MASK area
2893          */
2894         snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
2895         if (of_property_read_bool(np, prop))
2896                 format |= SND_SOC_DAIFMT_CONT;
2897         else
2898                 format |= SND_SOC_DAIFMT_GATED;
2899
2900         /*
2901          * check "[prefix]bitclock-inversion"
2902          * check "[prefix]frame-inversion"
2903          * SND_SOC_DAIFMT_INV_MASK area
2904          */
2905         snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
2906         bit = !!of_get_property(np, prop, NULL);
2907
2908         snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
2909         frame = !!of_get_property(np, prop, NULL);
2910
2911         switch ((bit << 4) + frame) {
2912         case 0x11:
2913                 format |= SND_SOC_DAIFMT_IB_IF;
2914                 break;
2915         case 0x10:
2916                 format |= SND_SOC_DAIFMT_IB_NF;
2917                 break;
2918         case 0x01:
2919                 format |= SND_SOC_DAIFMT_NB_IF;
2920                 break;
2921         default:
2922                 /* SND_SOC_DAIFMT_NB_NF is default */
2923                 break;
2924         }
2925
2926         /*
2927          * check "[prefix]bitclock-master"
2928          * check "[prefix]frame-master"
2929          * SND_SOC_DAIFMT_MASTER_MASK area
2930          */
2931         snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
2932         bit = !!of_get_property(np, prop, NULL);
2933         if (bit && bitclkmaster)
2934                 *bitclkmaster = of_parse_phandle(np, prop, 0);
2935
2936         snprintf(prop, sizeof(prop), "%sframe-master", prefix);
2937         frame = !!of_get_property(np, prop, NULL);
2938         if (frame && framemaster)
2939                 *framemaster = of_parse_phandle(np, prop, 0);
2940
2941         switch ((bit << 4) + frame) {
2942         case 0x11:
2943                 format |= SND_SOC_DAIFMT_CBM_CFM;
2944                 break;
2945         case 0x10:
2946                 format |= SND_SOC_DAIFMT_CBM_CFS;
2947                 break;
2948         case 0x01:
2949                 format |= SND_SOC_DAIFMT_CBS_CFM;
2950                 break;
2951         default:
2952                 format |= SND_SOC_DAIFMT_CBS_CFS;
2953                 break;
2954         }
2955
2956         return format;
2957 }
2958 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
2959
2960 int snd_soc_get_dai_id(struct device_node *ep)
2961 {
2962         struct snd_soc_component *component;
2963         struct snd_soc_dai_link_component dlc;
2964         int ret;
2965
2966         dlc.of_node     = of_graph_get_port_parent(ep);
2967         dlc.name        = NULL;
2968         /*
2969          * For example HDMI case, HDMI has video/sound port,
2970          * but ALSA SoC needs sound port number only.
2971          * Thus counting HDMI DT port/endpoint doesn't work.
2972          * Then, it should have .of_xlate_dai_id
2973          */
2974         ret = -ENOTSUPP;
2975         mutex_lock(&client_mutex);
2976         component = soc_find_component(&dlc);
2977         if (component)
2978                 ret = snd_soc_component_of_xlate_dai_id(component, ep);
2979         mutex_unlock(&client_mutex);
2980
2981         of_node_put(dlc.of_node);
2982
2983         return ret;
2984 }
2985 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
2986
2987 int snd_soc_get_dai_name(struct of_phandle_args *args,
2988                                 const char **dai_name)
2989 {
2990         struct snd_soc_component *pos;
2991         struct device_node *component_of_node;
2992         int ret = -EPROBE_DEFER;
2993
2994         mutex_lock(&client_mutex);
2995         for_each_component(pos) {
2996                 component_of_node = soc_component_to_node(pos);
2997
2998                 if (component_of_node != args->np)
2999                         continue;
3000
3001                 ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3002                 if (ret == -ENOTSUPP) {
3003                         struct snd_soc_dai *dai;
3004                         int id = -1;
3005
3006                         switch (args->args_count) {
3007                         case 0:
3008                                 id = 0; /* same as dai_drv[0] */
3009                                 break;
3010                         case 1:
3011                                 id = args->args[0];
3012                                 break;
3013                         default:
3014                                 /* not supported */
3015                                 break;
3016                         }
3017
3018                         if (id < 0 || id >= pos->num_dai) {
3019                                 ret = -EINVAL;
3020                                 continue;
3021                         }
3022
3023                         ret = 0;
3024
3025                         /* find target DAI */
3026                         for_each_component_dais(pos, dai) {
3027                                 if (id == 0)
3028                                         break;
3029                                 id--;
3030                         }
3031
3032                         *dai_name = dai->driver->name;
3033                         if (!*dai_name)
3034                                 *dai_name = pos->name;
3035                 } else if (ret) {
3036                         /*
3037                          * if another error than ENOTSUPP is returned go on and
3038                          * check if another component is provided with the same
3039                          * node. This may happen if a device provides several
3040                          * components
3041                          */
3042                         continue;
3043                 }
3044
3045                 break;
3046         }
3047         mutex_unlock(&client_mutex);
3048         return ret;
3049 }
3050 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3051
3052 int snd_soc_of_get_dai_name(struct device_node *of_node,
3053                             const char **dai_name)
3054 {
3055         struct of_phandle_args args;
3056         int ret;
3057
3058         ret = of_parse_phandle_with_args(of_node, "sound-dai",
3059                                          "#sound-dai-cells", 0, &args);
3060         if (ret)
3061                 return ret;
3062
3063         ret = snd_soc_get_dai_name(&args, dai_name);
3064
3065         of_node_put(args.np);
3066
3067         return ret;
3068 }
3069 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3070
3071 /*
3072  * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3073  * @dai_link: DAI link
3074  *
3075  * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3076  */
3077 void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3078 {
3079         struct snd_soc_dai_link_component *component;
3080         int index;
3081
3082         for_each_link_codecs(dai_link, index, component) {
3083                 if (!component->of_node)
3084                         break;
3085                 of_node_put(component->of_node);
3086                 component->of_node = NULL;
3087         }
3088 }
3089 EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3090
3091 /*
3092  * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3093  * @dev: Card device
3094  * @of_node: Device node
3095  * @dai_link: DAI link
3096  *
3097  * Builds an array of CODEC DAI components from the DAI link property
3098  * 'sound-dai'.
3099  * The array is set in the DAI link and the number of DAIs is set accordingly.
3100  * The device nodes in the array (of_node) must be dereferenced by calling
3101  * snd_soc_of_put_dai_link_codecs() on @dai_link.
3102  *
3103  * Returns 0 for success
3104  */
3105 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3106                                    struct device_node *of_node,
3107                                    struct snd_soc_dai_link *dai_link)
3108 {
3109         struct of_phandle_args args;
3110         struct snd_soc_dai_link_component *component;
3111         char *name;
3112         int index, num_codecs, ret;
3113
3114         /* Count the number of CODECs */
3115         name = "sound-dai";
3116         num_codecs = of_count_phandle_with_args(of_node, name,
3117                                                 "#sound-dai-cells");
3118         if (num_codecs <= 0) {
3119                 if (num_codecs == -ENOENT)
3120                         dev_err(dev, "No 'sound-dai' property\n");
3121                 else
3122                         dev_err(dev, "Bad phandle in 'sound-dai'\n");
3123                 return num_codecs;
3124         }
3125         component = devm_kcalloc(dev,
3126                                  num_codecs, sizeof(*component),
3127                                  GFP_KERNEL);
3128         if (!component)
3129                 return -ENOMEM;
3130         dai_link->codecs = component;
3131         dai_link->num_codecs = num_codecs;
3132
3133         /* Parse the list */
3134         for_each_link_codecs(dai_link, index, component) {
3135                 ret = of_parse_phandle_with_args(of_node, name,
3136                                                  "#sound-dai-cells",
3137                                                  index, &args);
3138                 if (ret)
3139                         goto err;
3140                 component->of_node = args.np;
3141                 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3142                 if (ret < 0)
3143                         goto err;
3144         }
3145         return 0;
3146 err:
3147         snd_soc_of_put_dai_link_codecs(dai_link);
3148         dai_link->codecs = NULL;
3149         dai_link->num_codecs = 0;
3150         return ret;
3151 }
3152 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3153
3154 static int __init snd_soc_init(void)
3155 {
3156         snd_soc_debugfs_init();
3157         snd_soc_util_init();
3158
3159         return platform_driver_register(&soc_driver);
3160 }
3161 module_init(snd_soc_init);
3162
3163 static void __exit snd_soc_exit(void)
3164 {
3165         snd_soc_util_exit();
3166         snd_soc_debugfs_exit();
3167
3168         platform_driver_unregister(&soc_driver);
3169 }
3170 module_exit(snd_soc_exit);
3171
3172 /* Module information */
3173 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3174 MODULE_DESCRIPTION("ALSA SoC Core");
3175 MODULE_LICENSE("GPL");
3176 MODULE_ALIAS("platform:soc-audio");