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