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