sound/soc/soc-core.c

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