sound/soc/soc-core.c

   1 /*
   2  * soc-core.c  --  ALSA SoC Audio Layer
   3  *
   4  * Copyright 2005 Wolfson Microelectronics PLC.
   5  * Copyright 2005 Openedhand Ltd.
   6  * Copyright (C) 2010 Slimlogic Ltd.
   7  * Copyright (C) 2010 Texas Instruments Inc.
   8  *
   9  * Author: Liam Girdwood <lrg@slimlogic.co.uk>
  10  *         with code, comments and ideas from :-
  11  *         Richard Purdie <richard@openedhand.com>
  12  *
  13  *  This program is free software; you can redistribute  it and/or modify it
  14  *  under  the terms of  the GNU General  Public License as published by the
  15  *  Free Software Foundation;  either version 2 of the  License, or (at your
  16  *  option) any later version.
  17  *
  18  *  TODO:
  19  *   o Add hw rules to enforce rates, etc.
  20  *   o More testing with other codecs/machines.
  21  *   o Add more codecs and platforms to ensure good API coverage.
  22  *   o Support TDM on PCM and I2S
  23  */
  24
  25 #include <linux/module.h>
  26 #include <linux/moduleparam.h>
  27 #include <linux/init.h>
  28 #include <linux/delay.h>
  29 #include <linux/pm.h>
  30 #include <linux/bitops.h>
  31 #include <linux/debugfs.h>
  32 #include <linux/platform_device.h>
  33 #include <linux/pinctrl/consumer.h>
  34 #include <linux/ctype.h>
  35 #include <linux/slab.h>
  36 #include <linux/of.h>
  37 #include <sound/core.h>
  38 #include <sound/jack.h>
  39 #include <sound/pcm.h>
  40 #include <sound/pcm_params.h>
  41 #include <sound/soc.h>
  42 #include <sound/soc-dpcm.h>
  43 #include <sound/soc-topology.h>
  44 #include <sound/initval.h>
  45
  46 #define CREATE_TRACE_POINTS
  47 #include <trace/events/asoc.h>
  48
  49 #define NAME_SIZE       32
  50
  51 #ifdef CONFIG_DEBUG_FS
  52 struct dentry *snd_soc_debugfs_root;
  53 EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
  54 #endif
  55
  56 static DEFINE_MUTEX(client_mutex);
  57 static LIST_HEAD(platform_list);
  58 static LIST_HEAD(codec_list);
  59 static LIST_HEAD(component_list);
  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 /* returns the minimum number of bytes needed to represent
  71  * a particular given value */
  72 static int min_bytes_needed(unsigned long val)
  73 {
  74         int c = 0;
  75         int i;
  76
  77         for (i = (sizeof val * 8) - 1; i >= 0; --i, ++c)
  78                 if (val & (1UL << i))
  79                         break;
  80         c = (sizeof val * 8) - c;
  81         if (!c || (c % 8))
  82                 c = (c + 8) / 8;
  83         else
  84                 c /= 8;
  85         return c;
  86 }
  87
  88 /* fill buf which is 'len' bytes with a formatted
  89  * string of the form 'reg: value\n' */
  90 static int format_register_str(struct snd_soc_codec *codec,
  91                                unsigned int reg, char *buf, size_t len)
  92 {
  93         int wordsize = min_bytes_needed(codec->driver->reg_cache_size) * 2;
  94         int regsize = codec->driver->reg_word_size * 2;
  95         int ret;
  96
  97         /* +2 for ': ' and + 1 for '\n' */
  98         if (wordsize + regsize + 2 + 1 != len)
  99                 return -EINVAL;
 100
 101         sprintf(buf, "%.*x: ", wordsize, reg);
 102         buf += wordsize + 2;
 103
 104         ret = snd_soc_read(codec, reg);
 105         if (ret < 0)
 106                 memset(buf, 'X', regsize);
 107         else
 108                 sprintf(buf, "%.*x", regsize, ret);
 109         buf[regsize] = '\n';
 110         /* no NUL-termination needed */
 111         return 0;
 112 }
 113
 114 /* codec register dump */
 115 static ssize_t soc_codec_reg_show(struct snd_soc_codec *codec, char *buf,
 116                                   size_t count, loff_t pos)
 117 {
 118         int i, step = 1;
 119         int wordsize, regsize;
 120         int len;
 121         size_t total = 0;
 122         loff_t p = 0;
 123
 124         wordsize = min_bytes_needed(codec->driver->reg_cache_size) * 2;
 125         regsize = codec->driver->reg_word_size * 2;
 126
 127         len = wordsize + regsize + 2 + 1;
 128
 129         if (!codec->driver->reg_cache_size)
 130                 return 0;
 131
 132         if (codec->driver->reg_cache_step)
 133                 step = codec->driver->reg_cache_step;
 134
 135         for (i = 0; i < codec->driver->reg_cache_size; i += step) {
 136                 /* only support larger than PAGE_SIZE bytes debugfs
 137                  * entries for the default case */
 138                 if (p >= pos) {
 139                         if (total + len >= count - 1)
 140                                 break;
 141                         format_register_str(codec, i, buf + total, len);
 142                         total += len;
 143                 }
 144                 p += len;
 145         }
 146
 147         total = min(total, count - 1);
 148
 149         return total;
 150 }
 151
 152 static ssize_t codec_reg_show(struct device *dev,
 153         struct device_attribute *attr, char *buf)
 154 {
 155         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 156
 157         return soc_codec_reg_show(rtd->codec, buf, PAGE_SIZE, 0);
 158 }
 159
 160 static DEVICE_ATTR(codec_reg, 0444, codec_reg_show, NULL);
 161
 162 static ssize_t pmdown_time_show(struct device *dev,
 163                                 struct device_attribute *attr, char *buf)
 164 {
 165         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 166
 167         return sprintf(buf, "%ld\n", rtd->pmdown_time);
 168 }
 169
 170 static ssize_t pmdown_time_set(struct device *dev,
 171                                struct device_attribute *attr,
 172                                const char *buf, size_t count)
 173 {
 174         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 175         int ret;
 176
 177         ret = kstrtol(buf, 10, &rtd->pmdown_time);
 178         if (ret)
 179                 return ret;
 180
 181         return count;
 182 }
 183
 184 static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
 185
 186 static struct attribute *soc_dev_attrs[] = {
 187         &dev_attr_codec_reg.attr,
 188         &dev_attr_pmdown_time.attr,
 189         NULL
 190 };
 191
 192 static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
 193                                        struct attribute *attr, int idx)
 194 {
 195         struct device *dev = kobj_to_dev(kobj);
 196         struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 197
 198         if (attr == &dev_attr_pmdown_time.attr)
 199                 return attr->mode; /* always visible */
 200         return rtd->codec ? attr->mode : 0; /* enabled only with codec */
 201 }
 202
 203 static const struct attribute_group soc_dapm_dev_group = {
 204         .attrs = soc_dapm_dev_attrs,
 205         .is_visible = soc_dev_attr_is_visible,
 206 };
 207
 208 static const struct attribute_group soc_dev_roup = {
 209         .attrs = soc_dev_attrs,
 210         .is_visible = soc_dev_attr_is_visible,
 211 };
 212
 213 static const struct attribute_group *soc_dev_attr_groups[] = {
 214         &soc_dapm_dev_group,
 215         &soc_dev_roup,
 216         NULL
 217 };
 218
 219 #ifdef CONFIG_DEBUG_FS
 220 static ssize_t codec_reg_read_file(struct file *file, char __user *user_buf,
 221                                    size_t count, loff_t *ppos)
 222 {
 223         ssize_t ret;
 224         struct snd_soc_codec *codec = file->private_data;
 225         char *buf;
 226
 227         if (*ppos < 0 || !count)
 228                 return -EINVAL;
 229
 230         buf = kmalloc(count, GFP_KERNEL);
 231         if (!buf)
 232                 return -ENOMEM;
 233
 234         ret = soc_codec_reg_show(codec, buf, count, *ppos);
 235         if (ret >= 0) {
 236                 if (copy_to_user(user_buf, buf, ret)) {
 237                         kfree(buf);
 238                         return -EFAULT;
 239                 }
 240                 *ppos += ret;
 241         }
 242
 243         kfree(buf);
 244         return ret;
 245 }
 246
 247 static ssize_t codec_reg_write_file(struct file *file,
 248                 const char __user *user_buf, size_t count, loff_t *ppos)
 249 {
 250         char buf[32];
 251         size_t buf_size;
 252         char *start = buf;
 253         unsigned long reg, value;
 254         struct snd_soc_codec *codec = file->private_data;
 255         int ret;
 256
 257         buf_size = min(count, (sizeof(buf)-1));
 258         if (copy_from_user(buf, user_buf, buf_size))
 259                 return -EFAULT;
 260         buf[buf_size] = 0;
 261
 262         while (*start == ' ')
 263                 start++;
 264         reg = simple_strtoul(start, &start, 16);
 265         while (*start == ' ')
 266                 start++;
 267         ret = kstrtoul(start, 16, &value);
 268         if (ret)
 269                 return ret;
 270
 271         /* Userspace has been fiddling around behind the kernel's back */
 272         add_taint(TAINT_USER, LOCKDEP_NOW_UNRELIABLE);
 273
 274         snd_soc_write(codec, reg, value);
 275         return buf_size;
 276 }
 277
 278 static const struct file_operations codec_reg_fops = {
 279         .open = simple_open,
 280         .read = codec_reg_read_file,
 281         .write = codec_reg_write_file,
 282         .llseek = default_llseek,
 283 };
 284
 285 static void soc_init_component_debugfs(struct snd_soc_component *component)
 286 {
 287         if (!component->card->debugfs_card_root)
 288                 return;
 289
 290         if (component->debugfs_prefix) {
 291                 char *name;
 292
 293                 name = kasprintf(GFP_KERNEL, "%s:%s",
 294                         component->debugfs_prefix, component->name);
 295                 if (name) {
 296                         component->debugfs_root = debugfs_create_dir(name,
 297                                 component->card->debugfs_card_root);
 298                         kfree(name);
 299                 }
 300         } else {
 301                 component->debugfs_root = debugfs_create_dir(component->name,
 302                                 component->card->debugfs_card_root);
 303         }
 304
 305         if (!component->debugfs_root) {
 306                 dev_warn(component->dev,
 307                         "ASoC: Failed to create component debugfs directory\n");
 308                 return;
 309         }
 310
 311         snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
 312                 component->debugfs_root);
 313
 314         if (component->init_debugfs)
 315                 component->init_debugfs(component);
 316 }
 317
 318 static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
 319 {
 320         debugfs_remove_recursive(component->debugfs_root);
 321 }
 322
 323 static void soc_init_codec_debugfs(struct snd_soc_component *component)
 324 {
 325         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
 326
 327         codec->debugfs_reg = debugfs_create_file("codec_reg", 0644,
 328                                                  codec->component.debugfs_root,
 329                                                  codec, &codec_reg_fops);
 330         if (!codec->debugfs_reg)
 331                 dev_warn(codec->dev,
 332                         "ASoC: Failed to create codec register debugfs file\n");
 333 }
 334
 335 static ssize_t codec_list_read_file(struct file *file, char __user *user_buf,
 336                                     size_t count, loff_t *ppos)
 337 {
 338         char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
 339         ssize_t len, ret = 0;
 340         struct snd_soc_codec *codec;
 341
 342         if (!buf)
 343                 return -ENOMEM;
 344
 345         mutex_lock(&client_mutex);
 346
 347         list_for_each_entry(codec, &codec_list, list) {
 348                 len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
 349                                codec->component.name);
 350                 if (len >= 0)
 351                         ret += len;
 352                 if (ret > PAGE_SIZE) {
 353                         ret = PAGE_SIZE;
 354                         break;
 355                 }
 356         }
 357
 358         mutex_unlock(&client_mutex);
 359
 360         if (ret >= 0)
 361                 ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
 362
 363         kfree(buf);
 364
 365         return ret;
 366 }
 367
 368 static const struct file_operations codec_list_fops = {
 369         .read = codec_list_read_file,
 370         .llseek = default_llseek,/* read accesses f_pos */
 371 };
 372
 373 static ssize_t dai_list_read_file(struct file *file, char __user *user_buf,
 374                                   size_t count, loff_t *ppos)
 375 {
 376         char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
 377         ssize_t len, ret = 0;
 378         struct snd_soc_component *component;
 379         struct snd_soc_dai *dai;
 380
 381         if (!buf)
 382                 return -ENOMEM;
 383
 384         mutex_lock(&client_mutex);
 385
 386         list_for_each_entry(component, &component_list, list) {
 387                 list_for_each_entry(dai, &component->dai_list, list) {
 388                         len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
 389                                 dai->name);
 390                         if (len >= 0)
 391                                 ret += len;
 392                         if (ret > PAGE_SIZE) {
 393                                 ret = PAGE_SIZE;
 394                                 break;
 395                         }
 396                 }
 397         }
 398
 399         mutex_unlock(&client_mutex);
 400
 401         ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
 402
 403         kfree(buf);
 404
 405         return ret;
 406 }
 407
 408 static const struct file_operations dai_list_fops = {
 409         .read = dai_list_read_file,
 410         .llseek = default_llseek,/* read accesses f_pos */
 411 };
 412
 413 static ssize_t platform_list_read_file(struct file *file,
 414                                        char __user *user_buf,
 415                                        size_t count, loff_t *ppos)
 416 {
 417         char *buf = kmalloc(PAGE_SIZE, GFP_KERNEL);
 418         ssize_t len, ret = 0;
 419         struct snd_soc_platform *platform;
 420
 421         if (!buf)
 422                 return -ENOMEM;
 423
 424         mutex_lock(&client_mutex);
 425
 426         list_for_each_entry(platform, &platform_list, list) {
 427                 len = snprintf(buf + ret, PAGE_SIZE - ret, "%s\n",
 428                                platform->component.name);
 429                 if (len >= 0)
 430                         ret += len;
 431                 if (ret > PAGE_SIZE) {
 432                         ret = PAGE_SIZE;
 433                         break;
 434                 }
 435         }
 436
 437         mutex_unlock(&client_mutex);
 438
 439         ret = simple_read_from_buffer(user_buf, count, ppos, buf, ret);
 440
 441         kfree(buf);
 442
 443         return ret;
 444 }
 445
 446 static const struct file_operations platform_list_fops = {
 447         .read = platform_list_read_file,
 448         .llseek = default_llseek,/* read accesses f_pos */
 449 };
 450
 451 static void soc_init_card_debugfs(struct snd_soc_card *card)
 452 {
 453         if (!snd_soc_debugfs_root)
 454                 return;
 455
 456         card->debugfs_card_root = debugfs_create_dir(card->name,
 457                                                      snd_soc_debugfs_root);
 458         if (!card->debugfs_card_root) {
 459                 dev_warn(card->dev,
 460                          "ASoC: Failed to create card debugfs directory\n");
 461                 return;
 462         }
 463
 464         card->debugfs_pop_time = debugfs_create_u32("dapm_pop_time", 0644,
 465                                                     card->debugfs_card_root,
 466                                                     &card->pop_time);
 467         if (!card->debugfs_pop_time)
 468                 dev_warn(card->dev,
 469                        "ASoC: Failed to create pop time debugfs file\n");
 470 }
 471
 472 static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 473 {
 474         debugfs_remove_recursive(card->debugfs_card_root);
 475 }
 476
 477
 478 static void snd_soc_debugfs_init(void)
 479 {
 480         snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
 481         if (IS_ERR(snd_soc_debugfs_root) || !snd_soc_debugfs_root) {
 482                 pr_warn("ASoC: Failed to create debugfs directory\n");
 483                 snd_soc_debugfs_root = NULL;
 484                 return;
 485         }
 486
 487         if (!debugfs_create_file("codecs", 0444, snd_soc_debugfs_root, NULL,
 488                                  &codec_list_fops))
 489                 pr_warn("ASoC: Failed to create CODEC list debugfs file\n");
 490
 491         if (!debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
 492                                  &dai_list_fops))
 493                 pr_warn("ASoC: Failed to create DAI list debugfs file\n");
 494
 495         if (!debugfs_create_file("platforms", 0444, snd_soc_debugfs_root, NULL,
 496                                  &platform_list_fops))
 497                 pr_warn("ASoC: Failed to create platform list debugfs file\n");
 498 }
 499
 500 static void snd_soc_debugfs_exit(void)
 501 {
 502         debugfs_remove_recursive(snd_soc_debugfs_root);
 503 }
 504
 505 #else
 506
 507 #define soc_init_codec_debugfs NULL
 508
 509 static inline void soc_init_component_debugfs(
 510         struct snd_soc_component *component)
 511 {
 512 }
 513
 514 static inline void soc_cleanup_component_debugfs(
 515         struct snd_soc_component *component)
 516 {
 517 }
 518
 519 static inline void soc_init_card_debugfs(struct snd_soc_card *card)
 520 {
 521 }
 522
 523 static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 524 {
 525 }
 526
 527 static inline void snd_soc_debugfs_init(void)
 528 {
 529 }
 530
 531 static inline void snd_soc_debugfs_exit(void)
 532 {
 533 }
 534
 535 #endif
 536
 537 struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 538                 const char *dai_link, int stream)
 539 {
 540         struct snd_soc_pcm_runtime *rtd;
 541
 542         list_for_each_entry(rtd, &card->rtd_list, list) {
 543                 if (rtd->dai_link->no_pcm &&
 544                         !strcmp(rtd->dai_link->name, dai_link))
 545                         return rtd->pcm->streams[stream].substream;
 546         }
 547         dev_dbg(card->dev, "ASoC: failed to find dai link %s\n", dai_link);
 548         return NULL;
 549 }
 550 EXPORT_SYMBOL_GPL(snd_soc_get_dai_substream);
 551
 552 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
 553         struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
 554 {
 555         struct snd_soc_pcm_runtime *rtd;
 556
 557         rtd = kzalloc(sizeof(struct snd_soc_pcm_runtime), GFP_KERNEL);
 558         if (!rtd)
 559                 return NULL;
 560
 561         rtd->card = card;
 562         rtd->dai_link = dai_link;
 563         rtd->codec_dais = kzalloc(sizeof(struct snd_soc_dai *) *
 564                                         dai_link->num_codecs,
 565                                         GFP_KERNEL);
 566         if (!rtd->codec_dais) {
 567                 kfree(rtd);
 568                 return NULL;
 569         }
 570
 571         return rtd;
 572 }
 573
 574 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
 575 {
 576         if (rtd && rtd->codec_dais)
 577                 kfree(rtd->codec_dais);
 578         kfree(rtd);
 579 }
 580
 581 static void soc_add_pcm_runtime(struct snd_soc_card *card,
 582                 struct snd_soc_pcm_runtime *rtd)
 583 {
 584         list_add_tail(&rtd->list, &card->rtd_list);
 585         rtd->num = card->num_rtd;
 586         card->num_rtd++;
 587 }
 588
 589 static void soc_remove_pcm_runtimes(struct snd_soc_card *card)
 590 {
 591         struct snd_soc_pcm_runtime *rtd, *_rtd;
 592
 593         list_for_each_entry_safe(rtd, _rtd, &card->rtd_list, list) {
 594                 list_del(&rtd->list);
 595                 soc_free_pcm_runtime(rtd);
 596         }
 597
 598         card->num_rtd = 0;
 599 }
 600
 601 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 602                 const char *dai_link)
 603 {
 604         struct snd_soc_pcm_runtime *rtd;
 605
 606         list_for_each_entry(rtd, &card->rtd_list, list) {
 607                 if (!strcmp(rtd->dai_link->name, dai_link))
 608                         return rtd;
 609         }
 610         dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link);
 611         return NULL;
 612 }
 613 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
 614
 615 static void codec2codec_close_delayed_work(struct work_struct *work)
 616 {
 617         /* Currently nothing to do for c2c links
 618          * Since c2c links are internal nodes in the DAPM graph and
 619          * don't interface with the outside world or application layer
 620          * we don't have to do any special handling on close.
 621          */
 622 }
 623
 624 #ifdef CONFIG_PM_SLEEP
 625 /* powers down audio subsystem for suspend */
 626 int snd_soc_suspend(struct device *dev)
 627 {
 628         struct snd_soc_card *card = dev_get_drvdata(dev);
 629         struct snd_soc_codec *codec;
 630         struct snd_soc_pcm_runtime *rtd;
 631         int i;
 632
 633         /* If the card is not initialized yet there is nothing to do */
 634         if (!card->instantiated)
 635                 return 0;
 636
 637         /* Due to the resume being scheduled into a workqueue we could
 638         * suspend before that's finished - wait for it to complete.
 639          */
 640         snd_power_lock(card->snd_card);
 641         snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
 642         snd_power_unlock(card->snd_card);
 643
 644         /* we're going to block userspace touching us until resume completes */
 645         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
 646
 647         /* mute any active DACs */
 648         list_for_each_entry(rtd, &card->rtd_list, list) {
 649
 650                 if (rtd->dai_link->ignore_suspend)
 651                         continue;
 652
 653                 for (i = 0; i < rtd->num_codecs; i++) {
 654                         struct snd_soc_dai *dai = rtd->codec_dais[i];
 655                         struct snd_soc_dai_driver *drv = dai->driver;
 656
 657                         if (drv->ops->digital_mute && dai->playback_active)
 658                                 drv->ops->digital_mute(dai, 1);
 659                 }
 660         }
 661
 662         /* suspend all pcms */
 663         list_for_each_entry(rtd, &card->rtd_list, list) {
 664                 if (rtd->dai_link->ignore_suspend)
 665                         continue;
 666
 667                 snd_pcm_suspend_all(rtd->pcm);
 668         }
 669
 670         if (card->suspend_pre)
 671                 card->suspend_pre(card);
 672
 673         list_for_each_entry(rtd, &card->rtd_list, list) {
 674                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 675
 676                 if (rtd->dai_link->ignore_suspend)
 677                         continue;
 678
 679                 if (cpu_dai->driver->suspend && !cpu_dai->driver->bus_control)
 680                         cpu_dai->driver->suspend(cpu_dai);
 681         }
 682
 683         /* close any waiting streams */
 684         list_for_each_entry(rtd, &card->rtd_list, list)
 685                 flush_delayed_work(&rtd->delayed_work);
 686
 687         list_for_each_entry(rtd, &card->rtd_list, list) {
 688
 689                 if (rtd->dai_link->ignore_suspend)
 690                         continue;
 691
 692                 snd_soc_dapm_stream_event(rtd,
 693                                           SNDRV_PCM_STREAM_PLAYBACK,
 694                                           SND_SOC_DAPM_STREAM_SUSPEND);
 695
 696                 snd_soc_dapm_stream_event(rtd,
 697                                           SNDRV_PCM_STREAM_CAPTURE,
 698                                           SND_SOC_DAPM_STREAM_SUSPEND);
 699         }
 700
 701         /* Recheck all endpoints too, their state is affected by suspend */
 702         dapm_mark_endpoints_dirty(card);
 703         snd_soc_dapm_sync(&card->dapm);
 704
 705         /* suspend all CODECs */
 706         list_for_each_entry(codec, &card->codec_dev_list, card_list) {
 707                 struct snd_soc_dapm_context *dapm = snd_soc_codec_get_dapm(codec);
 708
 709                 /* If there are paths active then the CODEC will be held with
 710                  * bias _ON and should not be suspended. */
 711                 if (!codec->suspended) {
 712                         switch (snd_soc_dapm_get_bias_level(dapm)) {
 713                         case SND_SOC_BIAS_STANDBY:
 714                                 /*
 715                                  * If the CODEC is capable of idle
 716                                  * bias off then being in STANDBY
 717                                  * means it's doing something,
 718                                  * otherwise fall through.
 719                                  */
 720                                 if (dapm->idle_bias_off) {
 721                                         dev_dbg(codec->dev,
 722                                                 "ASoC: idle_bias_off CODEC on over suspend\n");
 723                                         break;
 724                                 }
 725
 726                         case SND_SOC_BIAS_OFF:
 727                                 if (codec->driver->suspend)
 728                                         codec->driver->suspend(codec);
 729                                 codec->suspended = 1;
 730                                 if (codec->component.regmap)
 731                                         regcache_mark_dirty(codec->component.regmap);
 732                                 /* deactivate pins to sleep state */
 733                                 pinctrl_pm_select_sleep_state(codec->dev);
 734                                 break;
 735                         default:
 736                                 dev_dbg(codec->dev,
 737                                         "ASoC: CODEC is on over suspend\n");
 738                                 break;
 739                         }
 740                 }
 741         }
 742
 743         list_for_each_entry(rtd, &card->rtd_list, list) {
 744                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 745
 746                 if (rtd->dai_link->ignore_suspend)
 747                         continue;
 748
 749                 if (cpu_dai->driver->suspend && cpu_dai->driver->bus_control)
 750                         cpu_dai->driver->suspend(cpu_dai);
 751
 752                 /* deactivate pins to sleep state */
 753                 pinctrl_pm_select_sleep_state(cpu_dai->dev);
 754         }
 755
 756         if (card->suspend_post)
 757                 card->suspend_post(card);
 758
 759         return 0;
 760 }
 761 EXPORT_SYMBOL_GPL(snd_soc_suspend);
 762
 763 /* deferred resume work, so resume can complete before we finished
 764  * setting our codec back up, which can be very slow on I2C
 765  */
 766 static void soc_resume_deferred(struct work_struct *work)
 767 {
 768         struct snd_soc_card *card =
 769                         container_of(work, struct snd_soc_card, deferred_resume_work);
 770         struct snd_soc_pcm_runtime *rtd;
 771         struct snd_soc_codec *codec;
 772         int i;
 773
 774         /* our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
 775          * so userspace apps are blocked from touching us
 776          */
 777
 778         dev_dbg(card->dev, "ASoC: starting resume work\n");
 779
 780         /* Bring us up into D2 so that DAPM starts enabling things */
 781         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
 782
 783         if (card->resume_pre)
 784                 card->resume_pre(card);
 785
 786         /* resume control bus DAIs */
 787         list_for_each_entry(rtd, &card->rtd_list, list) {
 788                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 789
 790                 if (rtd->dai_link->ignore_suspend)
 791                         continue;
 792
 793                 if (cpu_dai->driver->resume && cpu_dai->driver->bus_control)
 794                         cpu_dai->driver->resume(cpu_dai);
 795         }
 796
 797         list_for_each_entry(codec, &card->codec_dev_list, card_list) {
 798                 if (codec->suspended) {
 799                         if (codec->driver->resume)
 800                                 codec->driver->resume(codec);
 801                         codec->suspended = 0;
 802                 }
 803         }
 804
 805         list_for_each_entry(rtd, &card->rtd_list, list) {
 806
 807                 if (rtd->dai_link->ignore_suspend)
 808                         continue;
 809
 810                 snd_soc_dapm_stream_event(rtd,
 811                                           SNDRV_PCM_STREAM_PLAYBACK,
 812                                           SND_SOC_DAPM_STREAM_RESUME);
 813
 814                 snd_soc_dapm_stream_event(rtd,
 815                                           SNDRV_PCM_STREAM_CAPTURE,
 816                                           SND_SOC_DAPM_STREAM_RESUME);
 817         }
 818
 819         /* unmute any active DACs */
 820         list_for_each_entry(rtd, &card->rtd_list, list) {
 821
 822                 if (rtd->dai_link->ignore_suspend)
 823                         continue;
 824
 825                 for (i = 0; i < rtd->num_codecs; i++) {
 826                         struct snd_soc_dai *dai = rtd->codec_dais[i];
 827                         struct snd_soc_dai_driver *drv = dai->driver;
 828
 829                         if (drv->ops->digital_mute && dai->playback_active)
 830                                 drv->ops->digital_mute(dai, 0);
 831                 }
 832         }
 833
 834         list_for_each_entry(rtd, &card->rtd_list, list) {
 835                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 836
 837                 if (rtd->dai_link->ignore_suspend)
 838                         continue;
 839
 840                 if (cpu_dai->driver->resume && !cpu_dai->driver->bus_control)
 841                         cpu_dai->driver->resume(cpu_dai);
 842         }
 843
 844         if (card->resume_post)
 845                 card->resume_post(card);
 846
 847         dev_dbg(card->dev, "ASoC: resume work completed\n");
 848
 849         /* Recheck all endpoints too, their state is affected by suspend */
 850         dapm_mark_endpoints_dirty(card);
 851         snd_soc_dapm_sync(&card->dapm);
 852
 853         /* userspace can access us now we are back as we were before */
 854         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
 855 }
 856
 857 /* powers up audio subsystem after a suspend */
 858 int snd_soc_resume(struct device *dev)
 859 {
 860         struct snd_soc_card *card = dev_get_drvdata(dev);
 861         bool bus_control = false;
 862         struct snd_soc_pcm_runtime *rtd;
 863
 864         /* If the card is not initialized yet there is nothing to do */
 865         if (!card->instantiated)
 866                 return 0;
 867
 868         /* activate pins from sleep state */
 869         list_for_each_entry(rtd, &card->rtd_list, list) {
 870                 struct snd_soc_dai **codec_dais = rtd->codec_dais;
 871                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 872                 int j;
 873
 874                 if (cpu_dai->active)
 875                         pinctrl_pm_select_default_state(cpu_dai->dev);
 876
 877                 for (j = 0; j < rtd->num_codecs; j++) {
 878                         struct snd_soc_dai *codec_dai = codec_dais[j];
 879                         if (codec_dai->active)
 880                                 pinctrl_pm_select_default_state(codec_dai->dev);
 881                 }
 882         }
 883
 884         /*
 885          * DAIs that also act as the control bus master might have other drivers
 886          * hanging off them so need to resume immediately. Other drivers don't
 887          * have that problem and may take a substantial amount of time to resume
 888          * due to I/O costs and anti-pop so handle them out of line.
 889          */
 890         list_for_each_entry(rtd, &card->rtd_list, list) {
 891                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 892                 bus_control |= cpu_dai->driver->bus_control;
 893         }
 894         if (bus_control) {
 895                 dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
 896                 soc_resume_deferred(&card->deferred_resume_work);
 897         } else {
 898                 dev_dbg(dev, "ASoC: Scheduling resume work\n");
 899                 if (!schedule_work(&card->deferred_resume_work))
 900                         dev_err(dev, "ASoC: resume work item may be lost\n");
 901         }
 902
 903         return 0;
 904 }
 905 EXPORT_SYMBOL_GPL(snd_soc_resume);
 906 #else
 907 #define snd_soc_suspend NULL
 908 #define snd_soc_resume NULL
 909 #endif
 910
 911 static const struct snd_soc_dai_ops null_dai_ops = {
 912 };
 913
 914 static struct snd_soc_component *soc_find_component(
 915         const struct device_node *of_node, const char *name)
 916 {
 917         struct snd_soc_component *component;
 918
 919         lockdep_assert_held(&client_mutex);
 920
 921         list_for_each_entry(component, &component_list, list) {
 922                 if (of_node) {
 923                         if (component->dev->of_node == of_node)
 924                                 return component;
 925                 } else if (strcmp(component->name, name) == 0) {
 926                         return component;
 927                 }
 928         }
 929
 930         return NULL;
 931 }
 932
 933 /**
 934  * snd_soc_find_dai - Find a registered DAI
 935  *
 936  * @dlc: name of the DAI and optional component info to match
 937  *
 938  * This function will search all regsitered components and their DAIs to
 939  * find the DAI of the same name. The component's of_node and name
 940  * should also match if being specified.
 941  *
 942  * Return: pointer of DAI, or NULL if not found.
 943  */
 944 struct snd_soc_dai *snd_soc_find_dai(
 945         const struct snd_soc_dai_link_component *dlc)
 946 {
 947         struct snd_soc_component *component;
 948         struct snd_soc_dai *dai;
 949         struct device_node *component_of_node;
 950
 951         lockdep_assert_held(&client_mutex);
 952
 953         /* Find CPU DAI from registered DAIs*/
 954         list_for_each_entry(component, &component_list, list) {
 955                 component_of_node = component->dev->of_node;
 956                 if (!component_of_node && component->dev->parent)
 957                         component_of_node = component->dev->parent->of_node;
 958
 959                 if (dlc->of_node && component_of_node != dlc->of_node)
 960                         continue;
 961                 if (dlc->name && strcmp(component->name, dlc->name))
 962                         continue;
 963                 list_for_each_entry(dai, &component->dai_list, list) {
 964                         if (dlc->dai_name && strcmp(dai->name, dlc->dai_name))
 965                                 continue;
 966
 967                         return dai;
 968                 }
 969         }
 970
 971         return NULL;
 972 }
 973 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
 974
 975 static bool soc_is_dai_link_bound(struct snd_soc_card *card,
 976                 struct snd_soc_dai_link *dai_link)
 977 {
 978         struct snd_soc_pcm_runtime *rtd;
 979
 980         list_for_each_entry(rtd, &card->rtd_list, list) {
 981                 if (rtd->dai_link == dai_link)
 982                         return true;
 983         }
 984
 985         return false;
 986 }
 987
 988 static int soc_bind_dai_link(struct snd_soc_card *card,
 989         struct snd_soc_dai_link *dai_link)
 990 {
 991         struct snd_soc_pcm_runtime *rtd;
 992         struct snd_soc_dai_link_component *codecs = dai_link->codecs;
 993         struct snd_soc_dai_link_component cpu_dai_component;
 994         struct snd_soc_dai **codec_dais;
 995         struct snd_soc_platform *platform;
 996         const char *platform_name;
 997         int i;
 998
 999         dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1000
1001         if (soc_is_dai_link_bound(card, dai_link)) {
1002                 dev_dbg(card->dev, "ASoC: dai link %s already bound\n",
1003                         dai_link->name);
1004                 return 0;
1005         }
1006
1007         rtd = soc_new_pcm_runtime(card, dai_link);
1008         if (!rtd)
1009                 return -ENOMEM;
1010
1011         cpu_dai_component.name = dai_link->cpu_name;
1012         cpu_dai_component.of_node = dai_link->cpu_of_node;
1013         cpu_dai_component.dai_name = dai_link->cpu_dai_name;
1014         rtd->cpu_dai = snd_soc_find_dai(&cpu_dai_component);
1015         if (!rtd->cpu_dai) {
1016                 dev_err(card->dev, "ASoC: CPU DAI %s not registered\n",
1017                         dai_link->cpu_dai_name);
1018                 goto _err_defer;
1019         }
1020
1021         rtd->num_codecs = dai_link->num_codecs;
1022
1023         /* Find CODEC from registered CODECs */
1024         codec_dais = rtd->codec_dais;
1025         for (i = 0; i < rtd->num_codecs; i++) {
1026                 codec_dais[i] = snd_soc_find_dai(&codecs[i]);
1027                 if (!codec_dais[i]) {
1028                         dev_err(card->dev, "ASoC: CODEC DAI %s not registered\n",
1029                                 codecs[i].dai_name);
1030                         goto _err_defer;
1031                 }
1032         }
1033
1034         /* Single codec links expect codec and codec_dai in runtime data */
1035         rtd->codec_dai = codec_dais[0];
1036         rtd->codec = rtd->codec_dai->codec;
1037
1038         /* if there's no platform we match on the empty platform */
1039         platform_name = dai_link->platform_name;
1040         if (!platform_name && !dai_link->platform_of_node)
1041                 platform_name = "snd-soc-dummy";
1042
1043         /* find one from the set of registered platforms */
1044         list_for_each_entry(platform, &platform_list, list) {
1045                 if (dai_link->platform_of_node) {
1046                         if (platform->dev->of_node !=
1047                             dai_link->platform_of_node)
1048                                 continue;
1049                 } else {
1050                         if (strcmp(platform->component.name, platform_name))
1051                                 continue;
1052                 }
1053
1054                 rtd->platform = platform;
1055         }
1056         if (!rtd->platform) {
1057                 dev_err(card->dev, "ASoC: platform %s not registered\n",
1058                         dai_link->platform_name);
1059                 return -EPROBE_DEFER;
1060         }
1061
1062         soc_add_pcm_runtime(card, rtd);
1063         return 0;
1064
1065 _err_defer:
1066         soc_free_pcm_runtime(rtd);
1067         return  -EPROBE_DEFER;
1068 }
1069
1070 static void soc_remove_component(struct snd_soc_component *component)
1071 {
1072         if (!component->card)
1073                 return;
1074
1075         /* This is a HACK and will be removed soon */
1076         if (component->codec)
1077                 list_del(&component->codec->card_list);
1078
1079         if (component->remove)
1080                 component->remove(component);
1081
1082         snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1083
1084         soc_cleanup_component_debugfs(component);
1085         component->card = NULL;
1086         module_put(component->dev->driver->owner);
1087 }
1088
1089 static void soc_remove_dai(struct snd_soc_dai *dai, int order)
1090 {
1091         int err;
1092
1093         if (dai && dai->probed &&
1094                         dai->driver->remove_order == order) {
1095                 if (dai->driver->remove) {
1096                         err = dai->driver->remove(dai);
1097                         if (err < 0)
1098                                 dev_err(dai->dev,
1099                                         "ASoC: failed to remove %s: %d\n",
1100                                         dai->name, err);
1101                 }
1102                 dai->probed = 0;
1103         }
1104 }
1105
1106 static void soc_remove_link_dais(struct snd_soc_card *card,
1107                 struct snd_soc_pcm_runtime *rtd, int order)
1108 {
1109         int i;
1110
1111         /* unregister the rtd device */
1112         if (rtd->dev_registered) {
1113                 device_unregister(rtd->dev);
1114                 rtd->dev_registered = 0;
1115         }
1116
1117         /* remove the CODEC DAI */
1118         for (i = 0; i < rtd->num_codecs; i++)
1119                 soc_remove_dai(rtd->codec_dais[i], order);
1120
1121         soc_remove_dai(rtd->cpu_dai, order);
1122 }
1123
1124 static void soc_remove_link_components(struct snd_soc_card *card,
1125         struct snd_soc_pcm_runtime *rtd, int order)
1126 {
1127         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1128         struct snd_soc_platform *platform = rtd->platform;
1129         struct snd_soc_component *component;
1130         int i;
1131
1132         /* remove the platform */
1133         if (platform && platform->component.driver->remove_order == order)
1134                 soc_remove_component(&platform->component);
1135
1136         /* remove the CODEC-side CODEC */
1137         for (i = 0; i < rtd->num_codecs; i++) {
1138                 component = rtd->codec_dais[i]->component;
1139                 if (component->driver->remove_order == order)
1140                         soc_remove_component(component);
1141         }
1142
1143         /* remove any CPU-side CODEC */
1144         if (cpu_dai) {
1145                 if (cpu_dai->component->driver->remove_order == order)
1146                         soc_remove_component(cpu_dai->component);
1147         }
1148 }
1149
1150 static void soc_remove_dai_links(struct snd_soc_card *card)
1151 {
1152         int order;
1153         struct snd_soc_pcm_runtime *rtd;
1154         struct snd_soc_dai_link *link, *_link;
1155
1156         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1157                         order++) {
1158                 list_for_each_entry(rtd, &card->rtd_list, list)
1159                         soc_remove_link_dais(card, rtd, order);
1160         }
1161
1162         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1163                         order++) {
1164                 list_for_each_entry(rtd, &card->rtd_list, list)
1165                         soc_remove_link_components(card, rtd, order);
1166         }
1167
1168         list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1169                 if (link->dobj.type == SND_SOC_DOBJ_DAI_LINK)
1170                         dev_warn(card->dev, "Topology forgot to remove link %s?\n",
1171                                 link->name);
1172
1173                 list_del(&link->list);
1174                 card->num_dai_links--;
1175         }
1176 }
1177
1178 static int snd_soc_init_multicodec(struct snd_soc_card *card,
1179                                    struct snd_soc_dai_link *dai_link)
1180 {
1181         /* Legacy codec/codec_dai link is a single entry in multicodec */
1182         if (dai_link->codec_name || dai_link->codec_of_node ||
1183             dai_link->codec_dai_name) {
1184                 dai_link->num_codecs = 1;
1185
1186                 dai_link->codecs = devm_kzalloc(card->dev,
1187                                 sizeof(struct snd_soc_dai_link_component),
1188                                 GFP_KERNEL);
1189                 if (!dai_link->codecs)
1190                         return -ENOMEM;
1191
1192                 dai_link->codecs[0].name = dai_link->codec_name;
1193                 dai_link->codecs[0].of_node = dai_link->codec_of_node;
1194                 dai_link->codecs[0].dai_name = dai_link->codec_dai_name;
1195         }
1196
1197         if (!dai_link->codecs) {
1198                 dev_err(card->dev, "ASoC: DAI link has no CODECs\n");
1199                 return -EINVAL;
1200         }
1201
1202         return 0;
1203 }
1204
1205 static int soc_init_dai_link(struct snd_soc_card *card,
1206                                    struct snd_soc_dai_link *link)
1207 {
1208         int i, ret;
1209
1210         ret = snd_soc_init_multicodec(card, link);
1211         if (ret) {
1212                 dev_err(card->dev, "ASoC: failed to init multicodec\n");
1213                 return ret;
1214         }
1215
1216         for (i = 0; i < link->num_codecs; i++) {
1217                 /*
1218                  * Codec must be specified by 1 of name or OF node,
1219                  * not both or neither.
1220                  */
1221                 if (!!link->codecs[i].name ==
1222                     !!link->codecs[i].of_node) {
1223                         dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
1224                                 link->name);
1225                         return -EINVAL;
1226                 }
1227                 /* Codec DAI name must be specified */
1228                 if (!link->codecs[i].dai_name) {
1229                         dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
1230                                 link->name);
1231                         return -EINVAL;
1232                 }
1233         }
1234
1235         /*
1236          * Platform may be specified by either name or OF node, but
1237          * can be left unspecified, and a dummy platform will be used.
1238          */
1239         if (link->platform_name && link->platform_of_node) {
1240                 dev_err(card->dev,
1241                         "ASoC: Both platform name/of_node are set for %s\n",
1242                         link->name);
1243                 return -EINVAL;
1244         }
1245
1246         /*
1247          * CPU device may be specified by either name or OF node, but
1248          * can be left unspecified, and will be matched based on DAI
1249          * name alone..
1250          */
1251         if (link->cpu_name && link->cpu_of_node) {
1252                 dev_err(card->dev,
1253                         "ASoC: Neither/both cpu name/of_node are set for %s\n",
1254                         link->name);
1255                 return -EINVAL;
1256         }
1257         /*
1258          * At least one of CPU DAI name or CPU device name/node must be
1259          * specified
1260          */
1261         if (!link->cpu_dai_name &&
1262             !(link->cpu_name || link->cpu_of_node)) {
1263                 dev_err(card->dev,
1264                         "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1265                         link->name);
1266                 return -EINVAL;
1267         }
1268
1269         return 0;
1270 }
1271
1272 /**
1273  * snd_soc_add_dai_link - Add a DAI link dynamically
1274  * @card: The ASoC card to which the DAI link is added
1275  * @dai_link: The new DAI link to add
1276  *
1277  * This function adds a DAI link to the ASoC card's link list.
1278  *
1279  * Note: Topology can use this API to add DAI links when probing the
1280  * topology component. And machine drivers can still define static
1281  * DAI links in dai_link array.
1282  */
1283 int snd_soc_add_dai_link(struct snd_soc_card *card,
1284                 struct snd_soc_dai_link *dai_link)
1285 {
1286         if (dai_link->dobj.type
1287             && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1288                 dev_err(card->dev, "Invalid dai link type %d\n",
1289                         dai_link->dobj.type);
1290                 return -EINVAL;
1291         }
1292
1293         lockdep_assert_held(&client_mutex);
1294         /* Notify the machine driver for extra initialization
1295          * on the link created by topology.
1296          */
1297         if (dai_link->dobj.type && card->add_dai_link)
1298                 card->add_dai_link(card, dai_link);
1299
1300         list_add_tail(&dai_link->list, &card->dai_link_list);
1301         card->num_dai_links++;
1302
1303         return 0;
1304 }
1305 EXPORT_SYMBOL_GPL(snd_soc_add_dai_link);
1306
1307 /**
1308  * snd_soc_remove_dai_link - Remove a DAI link from the list
1309  * @card: The ASoC card that owns the link
1310  * @dai_link: The DAI link to remove
1311  *
1312  * This function removes a DAI link from the ASoC card's link list.
1313  *
1314  * For DAI links previously added by topology, topology should
1315  * remove them by using the dobj embedded in the link.
1316  */
1317 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1318                              struct snd_soc_dai_link *dai_link)
1319 {
1320         struct snd_soc_dai_link *link, *_link;
1321
1322         if (dai_link->dobj.type
1323             && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1324                 dev_err(card->dev, "Invalid dai link type %d\n",
1325                         dai_link->dobj.type);
1326                 return;
1327         }
1328
1329         lockdep_assert_held(&client_mutex);
1330         /* Notify the machine driver for extra destruction
1331          * on the link created by topology.
1332          */
1333         if (dai_link->dobj.type && card->remove_dai_link)
1334                 card->remove_dai_link(card, dai_link);
1335
1336         list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1337                 if (link == dai_link) {
1338                         list_del(&link->list);
1339                         card->num_dai_links--;
1340                         return;
1341                 }
1342         }
1343 }
1344 EXPORT_SYMBOL_GPL(snd_soc_remove_dai_link);
1345
1346 static void soc_set_name_prefix(struct snd_soc_card *card,
1347                                 struct snd_soc_component *component)
1348 {
1349         int i;
1350
1351         if (card->codec_conf == NULL)
1352                 return;
1353
1354         for (i = 0; i < card->num_configs; i++) {
1355                 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1356                 if (map->of_node && component->dev->of_node != map->of_node)
1357                         continue;
1358                 if (map->dev_name && strcmp(component->name, map->dev_name))
1359                         continue;
1360                 component->name_prefix = map->name_prefix;
1361                 break;
1362         }
1363 }
1364
1365 static int soc_probe_component(struct snd_soc_card *card,
1366         struct snd_soc_component *component)
1367 {
1368         struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
1369         struct snd_soc_dai *dai;
1370         int ret;
1371
1372         if (!strcmp(component->name, "snd-soc-dummy"))
1373                 return 0;
1374
1375         if (component->card) {
1376                 if (component->card != card) {
1377                         dev_err(component->dev,
1378                                 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1379                                 card->name, component->card->name);
1380                         return -ENODEV;
1381                 }
1382                 return 0;
1383         }
1384
1385         if (!try_module_get(component->dev->driver->owner))
1386                 return -ENODEV;
1387
1388         component->card = card;
1389         dapm->card = card;
1390         soc_set_name_prefix(card, component);
1391
1392         soc_init_component_debugfs(component);
1393
1394         if (component->dapm_widgets) {
1395                 ret = snd_soc_dapm_new_controls(dapm, component->dapm_widgets,
1396                         component->num_dapm_widgets);
1397
1398                 if (ret != 0) {
1399                         dev_err(component->dev,
1400                                 "Failed to create new controls %d\n", ret);
1401                         goto err_probe;
1402                 }
1403         }
1404
1405         list_for_each_entry(dai, &component->dai_list, list) {
1406                 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1407                 if (ret != 0) {
1408                         dev_err(component->dev,
1409                                 "Failed to create DAI widgets %d\n", ret);
1410                         goto err_probe;
1411                 }
1412         }
1413
1414         if (component->probe) {
1415                 ret = component->probe(component);
1416                 if (ret < 0) {
1417                         dev_err(component->dev,
1418                                 "ASoC: failed to probe component %d\n", ret);
1419                         goto err_probe;
1420                 }
1421
1422                 WARN(dapm->idle_bias_off &&
1423                         dapm->bias_level != SND_SOC_BIAS_OFF,
1424                         "codec %s can not start from non-off bias with idle_bias_off==1\n",
1425                         component->name);
1426         }
1427
1428         /* machine specific init */
1429         if (component->init) {
1430                 ret = component->init(component);
1431                 if (ret < 0) {
1432                         dev_err(component->dev,
1433                                 "Failed to do machine specific init %d\n", ret);
1434                         goto err_probe;
1435                 }
1436         }
1437
1438         if (component->controls)
1439                 snd_soc_add_component_controls(component, component->controls,
1440                                      component->num_controls);
1441         if (component->dapm_routes)
1442                 snd_soc_dapm_add_routes(dapm, component->dapm_routes,
1443                                         component->num_dapm_routes);
1444
1445         list_add(&dapm->list, &card->dapm_list);
1446
1447         /* This is a HACK and will be removed soon */
1448         if (component->codec)
1449                 list_add(&component->codec->card_list, &card->codec_dev_list);
1450
1451         return 0;
1452
1453 err_probe:
1454         soc_cleanup_component_debugfs(component);
1455         component->card = NULL;
1456         module_put(component->dev->driver->owner);
1457
1458         return ret;
1459 }
1460
1461 static void rtd_release(struct device *dev)
1462 {
1463         kfree(dev);
1464 }
1465
1466 static int soc_post_component_init(struct snd_soc_pcm_runtime *rtd,
1467         const char *name)
1468 {
1469         int ret = 0;
1470
1471         /* register the rtd device */
1472         rtd->dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1473         if (!rtd->dev)
1474                 return -ENOMEM;
1475         device_initialize(rtd->dev);
1476         rtd->dev->parent = rtd->card->dev;
1477         rtd->dev->release = rtd_release;
1478         rtd->dev->groups = soc_dev_attr_groups;
1479         dev_set_name(rtd->dev, "%s", name);
1480         dev_set_drvdata(rtd->dev, rtd);
1481         mutex_init(&rtd->pcm_mutex);
1482         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
1483         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
1484         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
1485         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
1486         ret = device_add(rtd->dev);
1487         if (ret < 0) {
1488                 /* calling put_device() here to free the rtd->dev */
1489                 put_device(rtd->dev);
1490                 dev_err(rtd->card->dev,
1491                         "ASoC: failed to register runtime device: %d\n", ret);
1492                 return ret;
1493         }
1494         rtd->dev_registered = 1;
1495         return 0;
1496 }
1497
1498 static int soc_probe_link_components(struct snd_soc_card *card,
1499                         struct snd_soc_pcm_runtime *rtd,
1500                                      int order)
1501 {
1502         struct snd_soc_platform *platform = rtd->platform;
1503         struct snd_soc_component *component;
1504         int i, ret;
1505
1506         /* probe the CPU-side component, if it is a CODEC */
1507         component = rtd->cpu_dai->component;
1508         if (component->driver->probe_order == order) {
1509                 ret = soc_probe_component(card, component);
1510                 if (ret < 0)
1511                         return ret;
1512         }
1513
1514         /* probe the CODEC-side components */
1515         for (i = 0; i < rtd->num_codecs; i++) {
1516                 component = rtd->codec_dais[i]->component;
1517                 if (component->driver->probe_order == order) {
1518                         ret = soc_probe_component(card, component);
1519                         if (ret < 0)
1520                                 return ret;
1521                 }
1522         }
1523
1524         /* probe the platform */
1525         if (platform->component.driver->probe_order == order) {
1526                 ret = soc_probe_component(card, &platform->component);
1527                 if (ret < 0)
1528                         return ret;
1529         }
1530
1531         return 0;
1532 }
1533
1534 static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1535 {
1536         int ret;
1537
1538         if (!dai->probed && dai->driver->probe_order == order) {
1539                 if (dai->driver->probe) {
1540                         ret = dai->driver->probe(dai);
1541                         if (ret < 0) {
1542                                 dev_err(dai->dev,
1543                                         "ASoC: failed to probe DAI %s: %d\n",
1544                                         dai->name, ret);
1545                                 return ret;
1546                         }
1547                 }
1548
1549                 dai->probed = 1;
1550         }
1551
1552         return 0;
1553 }
1554
1555 static int soc_link_dai_widgets(struct snd_soc_card *card,
1556                                 struct snd_soc_dai_link *dai_link,
1557                                 struct snd_soc_pcm_runtime *rtd)
1558 {
1559         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1560         struct snd_soc_dai *codec_dai = rtd->codec_dai;
1561         struct snd_soc_dapm_widget *sink, *source;
1562         int ret;
1563
1564         if (rtd->num_codecs > 1)
1565                 dev_warn(card->dev, "ASoC: Multiple codecs not supported yet\n");
1566
1567         /* link the DAI widgets */
1568         sink = codec_dai->playback_widget;
1569         source = cpu_dai->capture_widget;
1570         if (sink && source) {
1571                 ret = snd_soc_dapm_new_pcm(card, dai_link->params,
1572                                            dai_link->num_params,
1573                                            source, sink);
1574                 if (ret != 0) {
1575                         dev_err(card->dev, "ASoC: Can't link %s to %s: %d\n",
1576                                 sink->name, source->name, ret);
1577                         return ret;
1578                 }
1579         }
1580
1581         sink = cpu_dai->playback_widget;
1582         source = codec_dai->capture_widget;
1583         if (sink && source) {
1584                 ret = snd_soc_dapm_new_pcm(card, dai_link->params,
1585                                            dai_link->num_params,
1586                                            source, sink);
1587                 if (ret != 0) {
1588                         dev_err(card->dev, "ASoC: Can't link %s to %s: %d\n",
1589                                 sink->name, source->name, ret);
1590                         return ret;
1591                 }
1592         }
1593
1594         return 0;
1595 }
1596
1597 static int soc_probe_link_dais(struct snd_soc_card *card,
1598                 struct snd_soc_pcm_runtime *rtd, int order)
1599 {
1600         struct snd_soc_dai_link *dai_link = rtd->dai_link;
1601         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1602         int i, ret;
1603
1604         dev_dbg(card->dev, "ASoC: probe %s dai link %d late %d\n",
1605                         card->name, rtd->num, order);
1606
1607         /* set default power off timeout */
1608         rtd->pmdown_time = pmdown_time;
1609
1610         ret = soc_probe_dai(cpu_dai, order);
1611         if (ret)
1612                 return ret;
1613
1614         /* probe the CODEC DAI */
1615         for (i = 0; i < rtd->num_codecs; i++) {
1616                 ret = soc_probe_dai(rtd->codec_dais[i], order);
1617                 if (ret)
1618                         return ret;
1619         }
1620
1621         /* complete DAI probe during last probe */
1622         if (order != SND_SOC_COMP_ORDER_LAST)
1623                 return 0;
1624
1625         /* do machine specific initialization */
1626         if (dai_link->init) {
1627                 ret = dai_link->init(rtd);
1628                 if (ret < 0) {
1629                         dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1630                                 dai_link->name, ret);
1631                         return ret;
1632                 }
1633         }
1634
1635         if (dai_link->dai_fmt)
1636                 snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1637
1638         ret = soc_post_component_init(rtd, dai_link->name);
1639         if (ret)
1640                 return ret;
1641
1642 #ifdef CONFIG_DEBUG_FS
1643         /* add DPCM sysfs entries */
1644         if (dai_link->dynamic)
1645                 soc_dpcm_debugfs_add(rtd);
1646 #endif
1647
1648         if (cpu_dai->driver->compress_new) {
1649                 /*create compress_device"*/
1650                 ret = cpu_dai->driver->compress_new(rtd, rtd->num);
1651                 if (ret < 0) {
1652                         dev_err(card->dev, "ASoC: can't create compress %s\n",
1653                                          dai_link->stream_name);
1654                         return ret;
1655                 }
1656         } else {
1657
1658                 if (!dai_link->params) {
1659                         /* create the pcm */
1660                         ret = soc_new_pcm(rtd, rtd->num);
1661                         if (ret < 0) {
1662                                 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1663                                        dai_link->stream_name, ret);
1664                                 return ret;
1665                         }
1666                 } else {
1667                         INIT_DELAYED_WORK(&rtd->delayed_work,
1668                                                 codec2codec_close_delayed_work);
1669
1670                         /* link the DAI widgets */
1671                         ret = soc_link_dai_widgets(card, dai_link, rtd);
1672                         if (ret)
1673                                 return ret;
1674                 }
1675         }
1676
1677         return 0;
1678 }
1679
1680 static int soc_bind_aux_dev(struct snd_soc_card *card, int num)
1681 {
1682         struct snd_soc_aux_dev *aux_dev = &card->aux_dev[num];
1683         struct snd_soc_component *component;
1684         const char *name;
1685         struct device_node *codec_of_node;
1686
1687         if (aux_dev->codec_of_node || aux_dev->codec_name) {
1688                 /* codecs, usually analog devices */
1689                 name = aux_dev->codec_name;
1690                 codec_of_node = aux_dev->codec_of_node;
1691                 component = soc_find_component(codec_of_node, name);
1692                 if (!component) {
1693                         if (codec_of_node)
1694                                 name = of_node_full_name(codec_of_node);
1695                         goto err_defer;
1696                 }
1697         } else if (aux_dev->name) {
1698                 /* generic components */
1699                 name = aux_dev->name;
1700                 component = soc_find_component(NULL, name);
1701                 if (!component)
1702                         goto err_defer;
1703         } else {
1704                 dev_err(card->dev, "ASoC: Invalid auxiliary device\n");
1705                 return -EINVAL;
1706         }
1707
1708         component->init = aux_dev->init;
1709         list_add(&component->list_aux, &card->aux_comp_list);
1710         return 0;
1711
1712 err_defer:
1713         dev_err(card->dev, "ASoC: %s not registered\n", name);
1714         return -EPROBE_DEFER;
1715 }
1716
1717 static int soc_probe_aux_devices(struct snd_soc_card *card)
1718 {
1719         struct snd_soc_component *comp;
1720         int order;
1721         int ret;
1722
1723         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1724                 order++) {
1725                 list_for_each_entry(comp, &card->aux_comp_list, list_aux) {
1726                         if (comp->driver->probe_order == order) {
1727                                 ret = soc_probe_component(card, comp);
1728                                 if (ret < 0) {
1729                                         dev_err(card->dev,
1730                                                 "ASoC: failed to probe aux component %s %d\n",
1731                                                 comp->name, ret);
1732                                         return ret;
1733                                 }
1734                         }
1735                 }
1736         }
1737
1738         return 0;
1739 }
1740
1741 static void soc_remove_aux_devices(struct snd_soc_card *card)
1742 {
1743         struct snd_soc_component *comp, *_comp;
1744         int order;
1745
1746         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1747                 order++) {
1748                 list_for_each_entry_safe(comp, _comp,
1749                         &card->aux_comp_list, list_aux) {
1750                         if (comp->driver->remove_order == order) {
1751                                 soc_remove_component(comp);
1752                                 /* remove it from the card's aux_comp_list */
1753                                 list_del(&comp->list_aux);
1754                         }
1755                 }
1756         }
1757 }
1758
1759 static int snd_soc_init_codec_cache(struct snd_soc_codec *codec)
1760 {
1761         int ret;
1762
1763         if (codec->cache_init)
1764                 return 0;
1765
1766         ret = snd_soc_cache_init(codec);
1767         if (ret < 0) {
1768                 dev_err(codec->dev,
1769                         "ASoC: Failed to set cache compression type: %d\n",
1770                         ret);
1771                 return ret;
1772         }
1773         codec->cache_init = 1;
1774         return 0;
1775 }
1776
1777 /**
1778  * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1779  * @rtd: The runtime for which the DAI link format should be changed
1780  * @dai_fmt: The new DAI link format
1781  *
1782  * This function updates the DAI link format for all DAIs connected to the DAI
1783  * link for the specified runtime.
1784  *
1785  * Note: For setups with a static format set the dai_fmt field in the
1786  * corresponding snd_dai_link struct instead of using this function.
1787  *
1788  * Returns 0 on success, otherwise a negative error code.
1789  */
1790 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1791         unsigned int dai_fmt)
1792 {
1793         struct snd_soc_dai **codec_dais = rtd->codec_dais;
1794         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1795         unsigned int i;
1796         int ret;
1797
1798         for (i = 0; i < rtd->num_codecs; i++) {
1799                 struct snd_soc_dai *codec_dai = codec_dais[i];
1800
1801                 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1802                 if (ret != 0 && ret != -ENOTSUPP) {
1803                         dev_warn(codec_dai->dev,
1804                                  "ASoC: Failed to set DAI format: %d\n", ret);
1805                         return ret;
1806                 }
1807         }
1808
1809         /* Flip the polarity for the "CPU" end of a CODEC<->CODEC link */
1810         if (cpu_dai->codec) {
1811                 unsigned int inv_dai_fmt;
1812
1813                 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1814                 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1815                 case SND_SOC_DAIFMT_CBM_CFM:
1816                         inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1817                         break;
1818                 case SND_SOC_DAIFMT_CBM_CFS:
1819                         inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1820                         break;
1821                 case SND_SOC_DAIFMT_CBS_CFM:
1822                         inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1823                         break;
1824                 case SND_SOC_DAIFMT_CBS_CFS:
1825                         inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1826                         break;
1827                 }
1828
1829                 dai_fmt = inv_dai_fmt;
1830         }
1831
1832         ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1833         if (ret != 0 && ret != -ENOTSUPP) {
1834                 dev_warn(cpu_dai->dev,
1835                          "ASoC: Failed to set DAI format: %d\n", ret);
1836                 return ret;
1837         }
1838
1839         return 0;
1840 }
1841 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1842
1843 static int snd_soc_instantiate_card(struct snd_soc_card *card)
1844 {
1845         struct snd_soc_codec *codec;
1846         struct snd_soc_pcm_runtime *rtd;
1847         struct snd_soc_dai_link *dai_link;
1848         int ret, i, order;
1849
1850         mutex_lock(&client_mutex);
1851         mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1852
1853         /* bind DAIs */
1854         for (i = 0; i < card->num_links; i++) {
1855                 ret = soc_bind_dai_link(card, &card->dai_link[i]);
1856                 if (ret != 0)
1857                         goto base_error;
1858         }
1859
1860         /* bind aux_devs too */
1861         for (i = 0; i < card->num_aux_devs; i++) {
1862                 ret = soc_bind_aux_dev(card, i);
1863                 if (ret != 0)
1864                         goto base_error;
1865         }
1866
1867         /* add predefined DAI links to the list */
1868         for (i = 0; i < card->num_links; i++)
1869                 snd_soc_add_dai_link(card, card->dai_link+i);
1870
1871         /* initialize the register cache for each available codec */
1872         list_for_each_entry(codec, &codec_list, list) {
1873                 if (codec->cache_init)
1874                         continue;
1875                 ret = snd_soc_init_codec_cache(codec);
1876                 if (ret < 0)
1877                         goto base_error;
1878         }
1879
1880         /* card bind complete so register a sound card */
1881         ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1882                         card->owner, 0, &card->snd_card);
1883         if (ret < 0) {
1884                 dev_err(card->dev,
1885                         "ASoC: can't create sound card for card %s: %d\n",
1886                         card->name, ret);
1887                 goto base_error;
1888         }
1889
1890         soc_init_card_debugfs(card);
1891
1892         card->dapm.bias_level = SND_SOC_BIAS_OFF;
1893         card->dapm.dev = card->dev;
1894         card->dapm.card = card;
1895         list_add(&card->dapm.list, &card->dapm_list);
1896
1897 #ifdef CONFIG_DEBUG_FS
1898         snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
1899 #endif
1900
1901 #ifdef CONFIG_PM_SLEEP
1902         /* deferred resume work */
1903         INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
1904 #endif
1905
1906         if (card->dapm_widgets)
1907                 snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
1908                                           card->num_dapm_widgets);
1909
1910         if (card->of_dapm_widgets)
1911                 snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
1912                                           card->num_of_dapm_widgets);
1913
1914         /* initialise the sound card only once */
1915         if (card->probe) {
1916                 ret = card->probe(card);
1917                 if (ret < 0)
1918                         goto card_probe_error;
1919         }
1920
1921         /* probe all components used by DAI links on this card */
1922         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1923                         order++) {
1924                 list_for_each_entry(rtd, &card->rtd_list, list) {
1925                         ret = soc_probe_link_components(card, rtd, order);
1926                         if (ret < 0) {
1927                                 dev_err(card->dev,
1928                                         "ASoC: failed to instantiate card %d\n",
1929                                         ret);
1930                                 goto probe_dai_err;
1931                         }
1932                 }
1933         }
1934
1935         /* probe auxiliary components */
1936         ret = soc_probe_aux_devices(card);
1937         if (ret < 0)
1938                 goto probe_dai_err;
1939
1940         /* Find new DAI links added during probing components and bind them.
1941          * Components with topology may bring new DAIs and DAI links.
1942          */
1943         list_for_each_entry(dai_link, &card->dai_link_list, list) {
1944                 if (soc_is_dai_link_bound(card, dai_link))
1945                         continue;
1946
1947                 ret = soc_init_dai_link(card, dai_link);
1948                 if (ret)
1949                         goto probe_dai_err;
1950                 ret = soc_bind_dai_link(card, dai_link);
1951                 if (ret)
1952                         goto probe_dai_err;
1953         }
1954
1955         /* probe all DAI links on this card */
1956         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1957                         order++) {
1958                 list_for_each_entry(rtd, &card->rtd_list, list) {
1959                         ret = soc_probe_link_dais(card, rtd, order);
1960                         if (ret < 0) {
1961                                 dev_err(card->dev,
1962                                         "ASoC: failed to instantiate card %d\n",
1963                                         ret);
1964                                 goto probe_dai_err;
1965                         }
1966                 }
1967         }
1968
1969         snd_soc_dapm_link_dai_widgets(card);
1970         snd_soc_dapm_connect_dai_link_widgets(card);
1971
1972         if (card->controls)
1973                 snd_soc_add_card_controls(card, card->controls, card->num_controls);
1974
1975         if (card->dapm_routes)
1976                 snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
1977                                         card->num_dapm_routes);
1978
1979         if (card->of_dapm_routes)
1980                 snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
1981                                         card->num_of_dapm_routes);
1982
1983         snprintf(card->snd_card->shortname, sizeof(card->snd_card->shortname),
1984                  "%s", card->name);
1985         snprintf(card->snd_card->longname, sizeof(card->snd_card->longname),
1986                  "%s", card->long_name ? card->long_name : card->name);
1987         snprintf(card->snd_card->driver, sizeof(card->snd_card->driver),
1988                  "%s", card->driver_name ? card->driver_name : card->name);
1989         for (i = 0; i < ARRAY_SIZE(card->snd_card->driver); i++) {
1990                 switch (card->snd_card->driver[i]) {
1991                 case '_':
1992                 case '-':
1993                 case '\0':
1994                         break;
1995                 default:
1996                         if (!isalnum(card->snd_card->driver[i]))
1997                                 card->snd_card->driver[i] = '_';
1998                         break;
1999                 }
2000         }
2001
2002         if (card->late_probe) {
2003                 ret = card->late_probe(card);
2004                 if (ret < 0) {
2005                         dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2006                                 card->name, ret);
2007                         goto probe_aux_dev_err;
2008                 }
2009         }
2010
2011         snd_soc_dapm_new_widgets(card);
2012
2013         ret = snd_card_register(card->snd_card);
2014         if (ret < 0) {
2015                 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2016                                 ret);
2017                 goto probe_aux_dev_err;
2018         }
2019
2020         card->instantiated = 1;
2021         snd_soc_dapm_sync(&card->dapm);
2022         mutex_unlock(&card->mutex);
2023         mutex_unlock(&client_mutex);
2024
2025         return 0;
2026
2027 probe_aux_dev_err:
2028         soc_remove_aux_devices(card);
2029
2030 probe_dai_err:
2031         soc_remove_dai_links(card);
2032
2033 card_probe_error:
2034         if (card->remove)
2035                 card->remove(card);
2036
2037         snd_soc_dapm_free(&card->dapm);
2038         soc_cleanup_card_debugfs(card);
2039         snd_card_free(card->snd_card);
2040
2041 base_error:
2042         soc_remove_pcm_runtimes(card);
2043         mutex_unlock(&card->mutex);
2044         mutex_unlock(&client_mutex);
2045
2046         return ret;
2047 }
2048
2049 /* probes a new socdev */
2050 static int soc_probe(struct platform_device *pdev)
2051 {
2052         struct snd_soc_card *card = platform_get_drvdata(pdev);
2053
2054         /*
2055          * no card, so machine driver should be registering card
2056          * we should not be here in that case so ret error
2057          */
2058         if (!card)
2059                 return -EINVAL;
2060
2061         dev_warn(&pdev->dev,
2062                  "ASoC: machine %s should use snd_soc_register_card()\n",
2063                  card->name);
2064
2065         /* Bodge while we unpick instantiation */
2066         card->dev = &pdev->dev;
2067
2068         return snd_soc_register_card(card);
2069 }
2070
2071 static int soc_cleanup_card_resources(struct snd_soc_card *card)
2072 {
2073         struct snd_soc_pcm_runtime *rtd;
2074
2075         /* make sure any delayed work runs */
2076         list_for_each_entry(rtd, &card->rtd_list, list)
2077                 flush_delayed_work(&rtd->delayed_work);
2078
2079         /* remove and free each DAI */
2080         soc_remove_dai_links(card);
2081         soc_remove_pcm_runtimes(card);
2082
2083         /* remove auxiliary devices */
2084         soc_remove_aux_devices(card);
2085
2086         soc_cleanup_card_debugfs(card);
2087
2088         /* remove the card */
2089         if (card->remove)
2090                 card->remove(card);
2091
2092         snd_soc_dapm_free(&card->dapm);
2093
2094         snd_card_free(card->snd_card);
2095         return 0;
2096
2097 }
2098
2099 /* removes a socdev */
2100 static int soc_remove(struct platform_device *pdev)
2101 {
2102         struct snd_soc_card *card = platform_get_drvdata(pdev);
2103
2104         snd_soc_unregister_card(card);
2105         return 0;
2106 }
2107
2108 int snd_soc_poweroff(struct device *dev)
2109 {
2110         struct snd_soc_card *card = dev_get_drvdata(dev);
2111         struct snd_soc_pcm_runtime *rtd;
2112
2113         if (!card->instantiated)
2114                 return 0;
2115
2116         /* Flush out pmdown_time work - we actually do want to run it
2117          * now, we're shutting down so no imminent restart. */
2118         list_for_each_entry(rtd, &card->rtd_list, list)
2119                 flush_delayed_work(&rtd->delayed_work);
2120
2121         snd_soc_dapm_shutdown(card);
2122
2123         /* deactivate pins to sleep state */
2124         list_for_each_entry(rtd, &card->rtd_list, list) {
2125                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2126                 int i;
2127
2128                 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2129                 for (i = 0; i < rtd->num_codecs; i++) {
2130                         struct snd_soc_dai *codec_dai = rtd->codec_dais[i];
2131                         pinctrl_pm_select_sleep_state(codec_dai->dev);
2132                 }
2133         }
2134
2135         return 0;
2136 }
2137 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2138
2139 const struct dev_pm_ops snd_soc_pm_ops = {
2140         .suspend = snd_soc_suspend,
2141         .resume = snd_soc_resume,
2142         .freeze = snd_soc_suspend,
2143         .thaw = snd_soc_resume,
2144         .poweroff = snd_soc_poweroff,
2145         .restore = snd_soc_resume,
2146 };
2147 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2148
2149 /* ASoC platform driver */
2150 static struct platform_driver soc_driver = {
2151         .driver         = {
2152                 .name           = "soc-audio",
2153                 .pm             = &snd_soc_pm_ops,
2154         },
2155         .probe          = soc_probe,
2156         .remove         = soc_remove,
2157 };
2158
2159 /**
2160  * snd_soc_cnew - create new control
2161  * @_template: control template
2162  * @data: control private data
2163  * @long_name: control long name
2164  * @prefix: control name prefix
2165  *
2166  * Create a new mixer control from a template control.
2167  *
2168  * Returns 0 for success, else error.
2169  */
2170 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2171                                   void *data, const char *long_name,
2172                                   const char *prefix)
2173 {
2174         struct snd_kcontrol_new template;
2175         struct snd_kcontrol *kcontrol;
2176         char *name = NULL;
2177
2178         memcpy(&template, _template, sizeof(template));
2179         template.index = 0;
2180
2181         if (!long_name)
2182                 long_name = template.name;
2183
2184         if (prefix) {
2185                 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2186                 if (!name)
2187                         return NULL;
2188
2189                 template.name = name;
2190         } else {
2191                 template.name = long_name;
2192         }
2193
2194         kcontrol = snd_ctl_new1(&template, data);
2195
2196         kfree(name);
2197
2198         return kcontrol;
2199 }
2200 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2201
2202 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2203         const struct snd_kcontrol_new *controls, int num_controls,
2204         const char *prefix, void *data)
2205 {
2206         int err, i;
2207
2208         for (i = 0; i < num_controls; i++) {
2209                 const struct snd_kcontrol_new *control = &controls[i];
2210                 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2211                                                      control->name, prefix));
2212                 if (err < 0) {
2213                         dev_err(dev, "ASoC: Failed to add %s: %d\n",
2214                                 control->name, err);
2215                         return err;
2216                 }
2217         }
2218
2219         return 0;
2220 }
2221
2222 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2223                                                const char *name)
2224 {
2225         struct snd_card *card = soc_card->snd_card;
2226         struct snd_kcontrol *kctl;
2227
2228         if (unlikely(!name))
2229                 return NULL;
2230
2231         list_for_each_entry(kctl, &card->controls, list)
2232                 if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2233                         return kctl;
2234         return NULL;
2235 }
2236 EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2237
2238 /**
2239  * snd_soc_add_component_controls - Add an array of controls to a component.
2240  *
2241  * @component: Component to add controls to
2242  * @controls: Array of controls to add
2243  * @num_controls: Number of elements in the array
2244  *
2245  * Return: 0 for success, else error.
2246  */
2247 int snd_soc_add_component_controls(struct snd_soc_component *component,
2248         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2249 {
2250         struct snd_card *card = component->card->snd_card;
2251
2252         return snd_soc_add_controls(card, component->dev, controls,
2253                         num_controls, component->name_prefix, component);
2254 }
2255 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2256
2257 /**
2258  * snd_soc_add_codec_controls - add an array of controls to a codec.
2259  * Convenience function to add a list of controls. Many codecs were
2260  * duplicating this code.
2261  *
2262  * @codec: codec to add controls to
2263  * @controls: array of controls to add
2264  * @num_controls: number of elements in the array
2265  *
2266  * Return 0 for success, else error.
2267  */
2268 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
2269         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2270 {
2271         return snd_soc_add_component_controls(&codec->component, controls,
2272                 num_controls);
2273 }
2274 EXPORT_SYMBOL_GPL(snd_soc_add_codec_controls);
2275
2276 /**
2277  * snd_soc_add_platform_controls - add an array of controls to a platform.
2278  * Convenience function to add a list of controls.
2279  *
2280  * @platform: platform to add controls to
2281  * @controls: array of controls to add
2282  * @num_controls: number of elements in the array
2283  *
2284  * Return 0 for success, else error.
2285  */
2286 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
2287         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2288 {
2289         return snd_soc_add_component_controls(&platform->component, controls,
2290                 num_controls);
2291 }
2292 EXPORT_SYMBOL_GPL(snd_soc_add_platform_controls);
2293
2294 /**
2295  * snd_soc_add_card_controls - add an array of controls to a SoC card.
2296  * Convenience function to add a list of controls.
2297  *
2298  * @soc_card: SoC card to add controls to
2299  * @controls: array of controls to add
2300  * @num_controls: number of elements in the array
2301  *
2302  * Return 0 for success, else error.
2303  */
2304 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2305         const struct snd_kcontrol_new *controls, int num_controls)
2306 {
2307         struct snd_card *card = soc_card->snd_card;
2308
2309         return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2310                         NULL, soc_card);
2311 }
2312 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2313
2314 /**
2315  * snd_soc_add_dai_controls - add an array of controls to a DAI.
2316  * Convienience function to add a list of controls.
2317  *
2318  * @dai: DAI to add controls to
2319  * @controls: array of controls to add
2320  * @num_controls: number of elements in the array
2321  *
2322  * Return 0 for success, else error.
2323  */
2324 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2325         const struct snd_kcontrol_new *controls, int num_controls)
2326 {
2327         struct snd_card *card = dai->component->card->snd_card;
2328
2329         return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2330                         NULL, dai);
2331 }
2332 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2333
2334 /**
2335  * snd_soc_dai_set_sysclk - configure DAI system or master clock.
2336  * @dai: DAI
2337  * @clk_id: DAI specific clock ID
2338  * @freq: new clock frequency in Hz
2339  * @dir: new clock direction - input/output.
2340  *
2341  * Configures the DAI master (MCLK) or system (SYSCLK) clocking.
2342  */
2343 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
2344         unsigned int freq, int dir)
2345 {
2346         if (dai->driver && dai->driver->ops->set_sysclk)
2347                 return dai->driver->ops->set_sysclk(dai, clk_id, freq, dir);
2348         else if (dai->codec && dai->codec->driver->set_sysclk)
2349                 return dai->codec->driver->set_sysclk(dai->codec, clk_id, 0,
2350                                                       freq, dir);
2351         else
2352                 return -ENOTSUPP;
2353 }
2354 EXPORT_SYMBOL_GPL(snd_soc_dai_set_sysclk);
2355
2356 /**
2357  * snd_soc_codec_set_sysclk - configure CODEC system or master clock.
2358  * @codec: CODEC
2359  * @clk_id: DAI specific clock ID
2360  * @source: Source for the clock
2361  * @freq: new clock frequency in Hz
2362  * @dir: new clock direction - input/output.
2363  *
2364  * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
2365  */
2366 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
2367                              int source, unsigned int freq, int dir)
2368 {
2369         if (codec->driver->set_sysclk)
2370                 return codec->driver->set_sysclk(codec, clk_id, source,
2371                                                  freq, dir);
2372         else
2373                 return -ENOTSUPP;
2374 }
2375 EXPORT_SYMBOL_GPL(snd_soc_codec_set_sysclk);
2376
2377 /**
2378  * snd_soc_dai_set_clkdiv - configure DAI clock dividers.
2379  * @dai: DAI
2380  * @div_id: DAI specific clock divider ID
2381  * @div: new clock divisor.
2382  *
2383  * Configures the clock dividers. This is used to derive the best DAI bit and
2384  * frame clocks from the system or master clock. It's best to set the DAI bit
2385  * and frame clocks as low as possible to save system power.
2386  */
2387 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
2388         int div_id, int div)
2389 {
2390         if (dai->driver && dai->driver->ops->set_clkdiv)
2391                 return dai->driver->ops->set_clkdiv(dai, div_id, div);
2392         else
2393                 return -EINVAL;
2394 }
2395 EXPORT_SYMBOL_GPL(snd_soc_dai_set_clkdiv);
2396
2397 /**
2398  * snd_soc_dai_set_pll - configure DAI PLL.
2399  * @dai: DAI
2400  * @pll_id: DAI specific PLL ID
2401  * @source: DAI specific source for the PLL
2402  * @freq_in: PLL input clock frequency in Hz
2403  * @freq_out: requested PLL output clock frequency in Hz
2404  *
2405  * Configures and enables PLL to generate output clock based on input clock.
2406  */
2407 int snd_soc_dai_set_pll(struct snd_soc_dai *dai, int pll_id, int source,
2408         unsigned int freq_in, unsigned int freq_out)
2409 {
2410         if (dai->driver && dai->driver->ops->set_pll)
2411                 return dai->driver->ops->set_pll(dai, pll_id, source,
2412                                          freq_in, freq_out);
2413         else if (dai->codec && dai->codec->driver->set_pll)
2414                 return dai->codec->driver->set_pll(dai->codec, pll_id, source,
2415                                                    freq_in, freq_out);
2416         else
2417                 return -EINVAL;
2418 }
2419 EXPORT_SYMBOL_GPL(snd_soc_dai_set_pll);
2420
2421 /*
2422  * snd_soc_codec_set_pll - configure codec PLL.
2423  * @codec: CODEC
2424  * @pll_id: DAI specific PLL ID
2425  * @source: DAI specific source for the PLL
2426  * @freq_in: PLL input clock frequency in Hz
2427  * @freq_out: requested PLL output clock frequency in Hz
2428  *
2429  * Configures and enables PLL to generate output clock based on input clock.
2430  */
2431 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
2432                           unsigned int freq_in, unsigned int freq_out)
2433 {
2434         if (codec->driver->set_pll)
2435                 return codec->driver->set_pll(codec, pll_id, source,
2436                                               freq_in, freq_out);
2437         else
2438                 return -EINVAL;
2439 }
2440 EXPORT_SYMBOL_GPL(snd_soc_codec_set_pll);
2441
2442 /**
2443  * snd_soc_dai_set_bclk_ratio - configure BCLK to sample rate ratio.
2444  * @dai: DAI
2445  * @ratio: Ratio of BCLK to Sample rate.
2446  *
2447  * Configures the DAI for a preset BCLK to sample rate ratio.
2448  */
2449 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio)
2450 {
2451         if (dai->driver && dai->driver->ops->set_bclk_ratio)
2452                 return dai->driver->ops->set_bclk_ratio(dai, ratio);
2453         else
2454                 return -EINVAL;
2455 }
2456 EXPORT_SYMBOL_GPL(snd_soc_dai_set_bclk_ratio);
2457
2458 /**
2459  * snd_soc_dai_set_fmt - configure DAI hardware audio format.
2460  * @dai: DAI
2461  * @fmt: SND_SOC_DAIFMT_ format value.
2462  *
2463  * Configures the DAI hardware format and clocking.
2464  */
2465 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
2466 {
2467         if (dai->driver == NULL)
2468                 return -EINVAL;
2469         if (dai->driver->ops->set_fmt == NULL)
2470                 return -ENOTSUPP;
2471         return dai->driver->ops->set_fmt(dai, fmt);
2472 }
2473 EXPORT_SYMBOL_GPL(snd_soc_dai_set_fmt);
2474
2475 /**
2476  * snd_soc_xlate_tdm_slot - generate tx/rx slot mask.
2477  * @slots: Number of slots in use.
2478  * @tx_mask: bitmask representing active TX slots.
2479  * @rx_mask: bitmask representing active RX slots.
2480  *
2481  * Generates the TDM tx and rx slot default masks for DAI.
2482  */
2483 static int snd_soc_xlate_tdm_slot_mask(unsigned int slots,
2484                                           unsigned int *tx_mask,
2485                                           unsigned int *rx_mask)
2486 {
2487         if (*tx_mask || *rx_mask)
2488                 return 0;
2489
2490         if (!slots)
2491                 return -EINVAL;
2492
2493         *tx_mask = (1 << slots) - 1;
2494         *rx_mask = (1 << slots) - 1;
2495
2496         return 0;
2497 }
2498
2499 /**
2500  * snd_soc_dai_set_tdm_slot() - Configures a DAI for TDM operation
2501  * @dai: The DAI to configure
2502  * @tx_mask: bitmask representing active TX slots.
2503  * @rx_mask: bitmask representing active RX slots.
2504  * @slots: Number of slots in use.
2505  * @slot_width: Width in bits for each slot.
2506  *
2507  * This function configures the specified DAI for TDM operation. @slot contains
2508  * the total number of slots of the TDM stream and @slot_with the width of each
2509  * slot in bit clock cycles. @tx_mask and @rx_mask are bitmasks specifying the
2510  * active slots of the TDM stream for the specified DAI, i.e. which slots the
2511  * DAI should write to or read from. If a bit is set the corresponding slot is
2512  * active, if a bit is cleared the corresponding slot is inactive. Bit 0 maps to
2513  * the first slot, bit 1 to the second slot and so on. The first active slot
2514  * maps to the first channel of the DAI, the second active slot to the second
2515  * channel and so on.
2516  *
2517  * TDM mode can be disabled by passing 0 for @slots. In this case @tx_mask,
2518  * @rx_mask and @slot_width will be ignored.
2519  *
2520  * Returns 0 on success, a negative error code otherwise.
2521  */
2522 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
2523         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width)
2524 {
2525         if (dai->driver && dai->driver->ops->xlate_tdm_slot_mask)
2526                 dai->driver->ops->xlate_tdm_slot_mask(slots,
2527                                                 &tx_mask, &rx_mask);
2528         else
2529                 snd_soc_xlate_tdm_slot_mask(slots, &tx_mask, &rx_mask);
2530
2531         dai->tx_mask = tx_mask;
2532         dai->rx_mask = rx_mask;
2533
2534         if (dai->driver && dai->driver->ops->set_tdm_slot)
2535                 return dai->driver->ops->set_tdm_slot(dai, tx_mask, rx_mask,
2536                                 slots, slot_width);
2537         else
2538                 return -ENOTSUPP;
2539 }
2540 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tdm_slot);
2541
2542 /**
2543  * snd_soc_dai_set_channel_map - configure DAI audio channel map
2544  * @dai: DAI
2545  * @tx_num: how many TX channels
2546  * @tx_slot: pointer to an array which imply the TX slot number channel
2547  *           0~num-1 uses
2548  * @rx_num: how many RX channels
2549  * @rx_slot: pointer to an array which imply the RX slot number channel
2550  *           0~num-1 uses
2551  *
2552  * configure the relationship between channel number and TDM slot number.
2553  */
2554 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
2555         unsigned int tx_num, unsigned int *tx_slot,
2556         unsigned int rx_num, unsigned int *rx_slot)
2557 {
2558         if (dai->driver && dai->driver->ops->set_channel_map)
2559                 return dai->driver->ops->set_channel_map(dai, tx_num, tx_slot,
2560                         rx_num, rx_slot);
2561         else
2562                 return -EINVAL;
2563 }
2564 EXPORT_SYMBOL_GPL(snd_soc_dai_set_channel_map);
2565
2566 /**
2567  * snd_soc_dai_set_tristate - configure DAI system or master clock.
2568  * @dai: DAI
2569  * @tristate: tristate enable
2570  *
2571  * Tristates the DAI so that others can use it.
2572  */
2573 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate)
2574 {
2575         if (dai->driver && dai->driver->ops->set_tristate)
2576                 return dai->driver->ops->set_tristate(dai, tristate);
2577         else
2578                 return -EINVAL;
2579 }
2580 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tristate);
2581
2582 /**
2583  * snd_soc_dai_digital_mute - configure DAI system or master clock.
2584  * @dai: DAI
2585  * @mute: mute enable
2586  * @direction: stream to mute
2587  *
2588  * Mutes the DAI DAC.
2589  */
2590 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
2591                              int direction)
2592 {
2593         if (!dai->driver)
2594                 return -ENOTSUPP;
2595
2596         if (dai->driver->ops->mute_stream)
2597                 return dai->driver->ops->mute_stream(dai, mute, direction);
2598         else if (direction == SNDRV_PCM_STREAM_PLAYBACK &&
2599                  dai->driver->ops->digital_mute)
2600                 return dai->driver->ops->digital_mute(dai, mute);
2601         else
2602                 return -ENOTSUPP;
2603 }
2604 EXPORT_SYMBOL_GPL(snd_soc_dai_digital_mute);
2605
2606 /**
2607  * snd_soc_register_card - Register a card with the ASoC core
2608  *
2609  * @card: Card to register
2610  *
2611  */
2612 int snd_soc_register_card(struct snd_soc_card *card)
2613 {
2614         int i, ret;
2615         struct snd_soc_pcm_runtime *rtd;
2616
2617         if (!card->name || !card->dev)
2618                 return -EINVAL;
2619
2620         for (i = 0; i < card->num_links; i++) {
2621                 struct snd_soc_dai_link *link = &card->dai_link[i];
2622
2623                 ret = soc_init_dai_link(card, link);
2624                 if (ret) {
2625                         dev_err(card->dev, "ASoC: failed to init link %s\n",
2626                                 link->name);
2627                         return ret;
2628                 }
2629         }
2630
2631         dev_set_drvdata(card->dev, card);
2632
2633         snd_soc_initialize_card_lists(card);
2634
2635         INIT_LIST_HEAD(&card->dai_link_list);
2636         card->num_dai_links = 0;
2637
2638         INIT_LIST_HEAD(&card->rtd_list);
2639         card->num_rtd = 0;
2640
2641         INIT_LIST_HEAD(&card->dapm_dirty);
2642         INIT_LIST_HEAD(&card->dobj_list);
2643         card->instantiated = 0;
2644         mutex_init(&card->mutex);
2645         mutex_init(&card->dapm_mutex);
2646
2647         ret = snd_soc_instantiate_card(card);
2648         if (ret != 0)
2649                 return ret;
2650
2651         /* deactivate pins to sleep state */
2652         list_for_each_entry(rtd, &card->rtd_list, list)  {
2653                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2654                 int j;
2655
2656                 for (j = 0; j < rtd->num_codecs; j++) {
2657                         struct snd_soc_dai *codec_dai = rtd->codec_dais[j];
2658                         if (!codec_dai->active)
2659                                 pinctrl_pm_select_sleep_state(codec_dai->dev);
2660                 }
2661
2662                 if (!cpu_dai->active)
2663                         pinctrl_pm_select_sleep_state(cpu_dai->dev);
2664         }
2665
2666         return ret;
2667 }
2668 EXPORT_SYMBOL_GPL(snd_soc_register_card);
2669
2670 /**
2671  * snd_soc_unregister_card - Unregister a card with the ASoC core
2672  *
2673  * @card: Card to unregister
2674  *
2675  */
2676 int snd_soc_unregister_card(struct snd_soc_card *card)
2677 {
2678         if (card->instantiated) {
2679                 card->instantiated = false;
2680                 snd_soc_dapm_shutdown(card);
2681                 soc_cleanup_card_resources(card);
2682                 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2683         }
2684
2685         return 0;
2686 }
2687 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2688
2689 /*
2690  * Simplify DAI link configuration by removing ".-1" from device names
2691  * and sanitizing names.
2692  */
2693 static char *fmt_single_name(struct device *dev, int *id)
2694 {
2695         char *found, name[NAME_SIZE];
2696         int id1, id2;
2697
2698         if (dev_name(dev) == NULL)
2699                 return NULL;
2700
2701         strlcpy(name, dev_name(dev), NAME_SIZE);
2702
2703         /* are we a "%s.%d" name (platform and SPI components) */
2704         found = strstr(name, dev->driver->name);
2705         if (found) {
2706                 /* get ID */
2707                 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2708
2709                         /* discard ID from name if ID == -1 */
2710                         if (*id == -1)
2711                                 found[strlen(dev->driver->name)] = '\0';
2712                 }
2713
2714         } else {
2715                 /* I2C component devices are named "bus-addr"  */
2716                 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2717                         char tmp[NAME_SIZE];
2718
2719                         /* create unique ID number from I2C addr and bus */
2720                         *id = ((id1 & 0xffff) << 16) + id2;
2721
2722                         /* sanitize component name for DAI link creation */
2723                         snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name, name);
2724                         strlcpy(name, tmp, NAME_SIZE);
2725                 } else
2726                         *id = 0;
2727         }
2728
2729         return kstrdup(name, GFP_KERNEL);
2730 }
2731
2732 /*
2733  * Simplify DAI link naming for single devices with multiple DAIs by removing
2734  * any ".-1" and using the DAI name (instead of device name).
2735  */
2736 static inline char *fmt_multiple_name(struct device *dev,
2737                 struct snd_soc_dai_driver *dai_drv)
2738 {
2739         if (dai_drv->name == NULL) {
2740                 dev_err(dev,
2741                         "ASoC: error - multiple DAI %s registered with no name\n",
2742                         dev_name(dev));
2743                 return NULL;
2744         }
2745
2746         return kstrdup(dai_drv->name, GFP_KERNEL);
2747 }
2748
2749 /**
2750  * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2751  *
2752  * @component: The component for which the DAIs should be unregistered
2753  */
2754 static void snd_soc_unregister_dais(struct snd_soc_component *component)
2755 {
2756         struct snd_soc_dai *dai, *_dai;
2757
2758         list_for_each_entry_safe(dai, _dai, &component->dai_list, list) {
2759                 dev_dbg(component->dev, "ASoC: Unregistered DAI '%s'\n",
2760                         dai->name);
2761                 list_del(&dai->list);
2762                 kfree(dai->name);
2763                 kfree(dai);
2764         }
2765 }
2766
2767 /* Create a DAI and add it to the component's DAI list */
2768 static struct snd_soc_dai *soc_add_dai(struct snd_soc_component *component,
2769         struct snd_soc_dai_driver *dai_drv,
2770         bool legacy_dai_naming)
2771 {
2772         struct device *dev = component->dev;
2773         struct snd_soc_dai *dai;
2774
2775         dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2776
2777         dai = kzalloc(sizeof(struct snd_soc_dai), GFP_KERNEL);
2778         if (dai == NULL)
2779                 return NULL;
2780
2781         /*
2782          * Back in the old days when we still had component-less DAIs,
2783          * instead of having a static name, component-less DAIs would
2784          * inherit the name of the parent device so it is possible to
2785          * register multiple instances of the DAI. We still need to keep
2786          * the same naming style even though those DAIs are not
2787          * component-less anymore.
2788          */
2789         if (legacy_dai_naming &&
2790            (dai_drv->id == 0 || dai_drv->name == NULL)) {
2791                 dai->name = fmt_single_name(dev, &dai->id);
2792         } else {
2793                 dai->name = fmt_multiple_name(dev, dai_drv);
2794                 if (dai_drv->id)
2795                         dai->id = dai_drv->id;
2796                 else
2797                         dai->id = component->num_dai;
2798         }
2799         if (dai->name == NULL) {
2800                 kfree(dai);
2801                 return NULL;
2802         }
2803
2804         dai->component = component;
2805         dai->dev = dev;
2806         dai->driver = dai_drv;
2807         if (!dai->driver->ops)
2808                 dai->driver->ops = &null_dai_ops;
2809
2810         list_add(&dai->list, &component->dai_list);
2811         component->num_dai++;
2812
2813         dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2814         return dai;
2815 }
2816
2817 /**
2818  * snd_soc_register_dais - Register a DAI with the ASoC core
2819  *
2820  * @component: The component the DAIs are registered for
2821  * @dai_drv: DAI driver to use for the DAIs
2822  * @count: Number of DAIs
2823  * @legacy_dai_naming: Use the legacy naming scheme and let the DAI inherit the
2824  *                     parent's name.
2825  */
2826 static int snd_soc_register_dais(struct snd_soc_component *component,
2827         struct snd_soc_dai_driver *dai_drv, size_t count,
2828         bool legacy_dai_naming)
2829 {
2830         struct device *dev = component->dev;
2831         struct snd_soc_dai *dai;
2832         unsigned int i;
2833         int ret;
2834
2835         dev_dbg(dev, "ASoC: dai register %s #%Zu\n", dev_name(dev), count);
2836
2837         component->dai_drv = dai_drv;
2838
2839         for (i = 0; i < count; i++) {
2840
2841                 dai = soc_add_dai(component, dai_drv + i,
2842                                 count == 1 && legacy_dai_naming);
2843                 if (dai == NULL) {
2844                         ret = -ENOMEM;
2845                         goto err;
2846                 }
2847         }
2848
2849         return 0;
2850
2851 err:
2852         snd_soc_unregister_dais(component);
2853
2854         return ret;
2855 }
2856
2857 /**
2858  * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2859  *
2860  * @component: The component the DAIs are registered for
2861  * @dai_drv: DAI driver to use for the DAI
2862  *
2863  * Topology can use this API to register DAIs when probing a component.
2864  * These DAIs's widgets will be freed in the card cleanup and the DAIs
2865  * will be freed in the component cleanup.
2866  */
2867 int snd_soc_register_dai(struct snd_soc_component *component,
2868         struct snd_soc_dai_driver *dai_drv)
2869 {
2870         struct snd_soc_dapm_context *dapm =
2871                 snd_soc_component_get_dapm(component);
2872         struct snd_soc_dai *dai;
2873         int ret;
2874
2875         if (dai_drv->dobj.type != SND_SOC_DOBJ_PCM) {
2876                 dev_err(component->dev, "Invalid dai type %d\n",
2877                         dai_drv->dobj.type);
2878                 return -EINVAL;
2879         }
2880
2881         lockdep_assert_held(&client_mutex);
2882         dai = soc_add_dai(component, dai_drv, false);
2883         if (!dai)
2884                 return -ENOMEM;
2885
2886         /* Create the DAI widgets here. After adding DAIs, topology may
2887          * also add routes that need these widgets as source or sink.
2888          */
2889         ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
2890         if (ret != 0) {
2891                 dev_err(component->dev,
2892                         "Failed to create DAI widgets %d\n", ret);
2893         }
2894
2895         return ret;
2896 }
2897 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2898
2899 static void snd_soc_component_seq_notifier(struct snd_soc_dapm_context *dapm,
2900         enum snd_soc_dapm_type type, int subseq)
2901 {
2902         struct snd_soc_component *component = dapm->component;
2903
2904         component->driver->seq_notifier(component, type, subseq);
2905 }
2906
2907 static int snd_soc_component_stream_event(struct snd_soc_dapm_context *dapm,
2908         int event)
2909 {
2910         struct snd_soc_component *component = dapm->component;
2911
2912         return component->driver->stream_event(component, event);
2913 }
2914
2915 static int snd_soc_component_initialize(struct snd_soc_component *component,
2916         const struct snd_soc_component_driver *driver, struct device *dev)
2917 {
2918         struct snd_soc_dapm_context *dapm;
2919
2920         component->name = fmt_single_name(dev, &component->id);
2921         if (!component->name) {
2922                 dev_err(dev, "ASoC: Failed to allocate name\n");
2923                 return -ENOMEM;
2924         }
2925
2926         component->dev = dev;
2927         component->driver = driver;
2928         component->probe = component->driver->probe;
2929         component->remove = component->driver->remove;
2930
2931         dapm = &component->dapm;
2932         dapm->dev = dev;
2933         dapm->component = component;
2934         dapm->bias_level = SND_SOC_BIAS_OFF;
2935         dapm->idle_bias_off = true;
2936         if (driver->seq_notifier)
2937                 dapm->seq_notifier = snd_soc_component_seq_notifier;
2938         if (driver->stream_event)
2939                 dapm->stream_event = snd_soc_component_stream_event;
2940
2941         component->controls = driver->controls;
2942         component->num_controls = driver->num_controls;
2943         component->dapm_widgets = driver->dapm_widgets;
2944         component->num_dapm_widgets = driver->num_dapm_widgets;
2945         component->dapm_routes = driver->dapm_routes;
2946         component->num_dapm_routes = driver->num_dapm_routes;
2947
2948         INIT_LIST_HEAD(&component->dai_list);
2949         mutex_init(&component->io_mutex);
2950
2951         return 0;
2952 }
2953
2954 static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
2955 {
2956         int val_bytes = regmap_get_val_bytes(component->regmap);
2957
2958         /* Errors are legitimate for non-integer byte multiples */
2959         if (val_bytes > 0)
2960                 component->val_bytes = val_bytes;
2961 }
2962
2963 #ifdef CONFIG_REGMAP
2964
2965 /**
2966  * snd_soc_component_init_regmap() - Initialize regmap instance for the component
2967  * @component: The component for which to initialize the regmap instance
2968  * @regmap: The regmap instance that should be used by the component
2969  *
2970  * This function allows deferred assignment of the regmap instance that is
2971  * associated with the component. Only use this if the regmap instance is not
2972  * yet ready when the component is registered. The function must also be called
2973  * before the first IO attempt of the component.
2974  */
2975 void snd_soc_component_init_regmap(struct snd_soc_component *component,
2976         struct regmap *regmap)
2977 {
2978         component->regmap = regmap;
2979         snd_soc_component_setup_regmap(component);
2980 }
2981 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
2982
2983 /**
2984  * snd_soc_component_exit_regmap() - De-initialize regmap instance for the component
2985  * @component: The component for which to de-initialize the regmap instance
2986  *
2987  * Calls regmap_exit() on the regmap instance associated to the component and
2988  * removes the regmap instance from the component.
2989  *
2990  * This function should only be used if snd_soc_component_init_regmap() was used
2991  * to initialize the regmap instance.
2992  */
2993 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
2994 {
2995         regmap_exit(component->regmap);
2996         component->regmap = NULL;
2997 }
2998 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
2999
3000 #endif
3001
3002 static void snd_soc_component_add_unlocked(struct snd_soc_component *component)
3003 {
3004         if (!component->write && !component->read) {
3005                 if (!component->regmap)
3006                         component->regmap = dev_get_regmap(component->dev, NULL);
3007                 if (component->regmap)
3008                         snd_soc_component_setup_regmap(component);
3009         }
3010
3011         list_add(&component->list, &component_list);
3012         INIT_LIST_HEAD(&component->dobj_list);
3013 }
3014
3015 static void snd_soc_component_add(struct snd_soc_component *component)
3016 {
3017         mutex_lock(&client_mutex);
3018         snd_soc_component_add_unlocked(component);
3019         mutex_unlock(&client_mutex);
3020 }
3021
3022 static void snd_soc_component_cleanup(struct snd_soc_component *component)
3023 {
3024         snd_soc_unregister_dais(component);
3025         kfree(component->name);
3026 }
3027
3028 static void snd_soc_component_del_unlocked(struct snd_soc_component *component)
3029 {
3030         list_del(&component->list);
3031 }
3032
3033 int snd_soc_register_component(struct device *dev,
3034                                const struct snd_soc_component_driver *cmpnt_drv,
3035                                struct snd_soc_dai_driver *dai_drv,
3036                                int num_dai)
3037 {
3038         struct snd_soc_component *cmpnt;
3039         int ret;
3040
3041         cmpnt = kzalloc(sizeof(*cmpnt), GFP_KERNEL);
3042         if (!cmpnt) {
3043                 dev_err(dev, "ASoC: Failed to allocate memory\n");
3044                 return -ENOMEM;
3045         }
3046
3047         ret = snd_soc_component_initialize(cmpnt, cmpnt_drv, dev);
3048         if (ret)
3049                 goto err_free;
3050
3051         cmpnt->ignore_pmdown_time = true;
3052         cmpnt->registered_as_component = true;
3053
3054         ret = snd_soc_register_dais(cmpnt, dai_drv, num_dai, true);
3055         if (ret < 0) {
3056                 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3057                 goto err_cleanup;
3058         }
3059
3060         snd_soc_component_add(cmpnt);
3061
3062         return 0;
3063
3064 err_cleanup:
3065         snd_soc_component_cleanup(cmpnt);
3066 err_free:
3067         kfree(cmpnt);
3068         return ret;
3069 }
3070 EXPORT_SYMBOL_GPL(snd_soc_register_component);
3071
3072 /**
3073  * snd_soc_unregister_component - Unregister a component from the ASoC core
3074  *
3075  * @dev: The device to unregister
3076  */
3077 void snd_soc_unregister_component(struct device *dev)
3078 {
3079         struct snd_soc_component *cmpnt;
3080
3081         mutex_lock(&client_mutex);
3082         list_for_each_entry(cmpnt, &component_list, list) {
3083                 if (dev == cmpnt->dev && cmpnt->registered_as_component)
3084                         goto found;
3085         }
3086         mutex_unlock(&client_mutex);
3087         return;
3088
3089 found:
3090         snd_soc_tplg_component_remove(cmpnt, SND_SOC_TPLG_INDEX_ALL);
3091         snd_soc_component_del_unlocked(cmpnt);
3092         mutex_unlock(&client_mutex);
3093         snd_soc_component_cleanup(cmpnt);
3094         kfree(cmpnt);
3095 }
3096 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
3097
3098 static int snd_soc_platform_drv_probe(struct snd_soc_component *component)
3099 {
3100         struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3101
3102         return platform->driver->probe(platform);
3103 }
3104
3105 static void snd_soc_platform_drv_remove(struct snd_soc_component *component)
3106 {
3107         struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3108
3109         platform->driver->remove(platform);
3110 }
3111
3112 /**
3113  * snd_soc_add_platform - Add a platform to the ASoC core
3114  * @dev: The parent device for the platform
3115  * @platform: The platform to add
3116  * @platform_drv: The driver for the platform
3117  */
3118 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
3119                 const struct snd_soc_platform_driver *platform_drv)
3120 {
3121         int ret;
3122
3123         ret = snd_soc_component_initialize(&platform->component,
3124                         &platform_drv->component_driver, dev);
3125         if (ret)
3126                 return ret;
3127
3128         platform->dev = dev;
3129         platform->driver = platform_drv;
3130
3131         if (platform_drv->probe)
3132                 platform->component.probe = snd_soc_platform_drv_probe;
3133         if (platform_drv->remove)
3134                 platform->component.remove = snd_soc_platform_drv_remove;
3135
3136 #ifdef CONFIG_DEBUG_FS
3137         platform->component.debugfs_prefix = "platform";
3138 #endif
3139
3140         mutex_lock(&client_mutex);
3141         snd_soc_component_add_unlocked(&platform->component);
3142         list_add(&platform->list, &platform_list);
3143         mutex_unlock(&client_mutex);
3144
3145         dev_dbg(dev, "ASoC: Registered platform '%s'\n",
3146                 platform->component.name);
3147
3148         return 0;
3149 }
3150 EXPORT_SYMBOL_GPL(snd_soc_add_platform);
3151
3152 /**
3153  * snd_soc_register_platform - Register a platform with the ASoC core
3154  *
3155  * @dev: The device for the platform
3156  * @platform_drv: The driver for the platform
3157  */
3158 int snd_soc_register_platform(struct device *dev,
3159                 const struct snd_soc_platform_driver *platform_drv)
3160 {
3161         struct snd_soc_platform *platform;
3162         int ret;
3163
3164         dev_dbg(dev, "ASoC: platform register %s\n", dev_name(dev));
3165
3166         platform = kzalloc(sizeof(struct snd_soc_platform), GFP_KERNEL);
3167         if (platform == NULL)
3168                 return -ENOMEM;
3169
3170         ret = snd_soc_add_platform(dev, platform, platform_drv);
3171         if (ret)
3172                 kfree(platform);
3173
3174         return ret;
3175 }
3176 EXPORT_SYMBOL_GPL(snd_soc_register_platform);
3177
3178 /**
3179  * snd_soc_remove_platform - Remove a platform from the ASoC core
3180  * @platform: the platform to remove
3181  */
3182 void snd_soc_remove_platform(struct snd_soc_platform *platform)
3183 {
3184
3185         mutex_lock(&client_mutex);
3186         list_del(&platform->list);
3187         snd_soc_component_del_unlocked(&platform->component);
3188         mutex_unlock(&client_mutex);
3189
3190         dev_dbg(platform->dev, "ASoC: Unregistered platform '%s'\n",
3191                 platform->component.name);
3192
3193         snd_soc_component_cleanup(&platform->component);
3194 }
3195 EXPORT_SYMBOL_GPL(snd_soc_remove_platform);
3196
3197 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev)
3198 {
3199         struct snd_soc_platform *platform;
3200
3201         mutex_lock(&client_mutex);
3202         list_for_each_entry(platform, &platform_list, list) {
3203                 if (dev == platform->dev) {
3204                         mutex_unlock(&client_mutex);
3205                         return platform;
3206                 }
3207         }
3208         mutex_unlock(&client_mutex);
3209
3210         return NULL;
3211 }
3212 EXPORT_SYMBOL_GPL(snd_soc_lookup_platform);
3213
3214 /**
3215  * snd_soc_unregister_platform - Unregister a platform from the ASoC core
3216  *
3217  * @dev: platform to unregister
3218  */
3219 void snd_soc_unregister_platform(struct device *dev)
3220 {
3221         struct snd_soc_platform *platform;
3222
3223         platform = snd_soc_lookup_platform(dev);
3224         if (!platform)
3225                 return;
3226
3227         snd_soc_remove_platform(platform);
3228         kfree(platform);
3229 }
3230 EXPORT_SYMBOL_GPL(snd_soc_unregister_platform);
3231
3232 static u64 codec_format_map[] = {
3233         SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S16_BE,
3234         SNDRV_PCM_FMTBIT_U16_LE | SNDRV_PCM_FMTBIT_U16_BE,
3235         SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S24_BE,
3236         SNDRV_PCM_FMTBIT_U24_LE | SNDRV_PCM_FMTBIT_U24_BE,
3237         SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S32_BE,
3238         SNDRV_PCM_FMTBIT_U32_LE | SNDRV_PCM_FMTBIT_U32_BE,
3239         SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_U24_3BE,
3240         SNDRV_PCM_FMTBIT_U24_3LE | SNDRV_PCM_FMTBIT_U24_3BE,
3241         SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE,
3242         SNDRV_PCM_FMTBIT_U20_3LE | SNDRV_PCM_FMTBIT_U20_3BE,
3243         SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE,
3244         SNDRV_PCM_FMTBIT_U18_3LE | SNDRV_PCM_FMTBIT_U18_3BE,
3245         SNDRV_PCM_FMTBIT_FLOAT_LE | SNDRV_PCM_FMTBIT_FLOAT_BE,
3246         SNDRV_PCM_FMTBIT_FLOAT64_LE | SNDRV_PCM_FMTBIT_FLOAT64_BE,
3247         SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE
3248         | SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_BE,
3249 };
3250
3251 /* Fix up the DAI formats for endianness: codecs don't actually see
3252  * the endianness of the data but we're using the CPU format
3253  * definitions which do need to include endianness so we ensure that
3254  * codec DAIs always have both big and little endian variants set.
3255  */
3256 static void fixup_codec_formats(struct snd_soc_pcm_stream *stream)
3257 {
3258         int i;
3259
3260         for (i = 0; i < ARRAY_SIZE(codec_format_map); i++)
3261                 if (stream->formats & codec_format_map[i])
3262                         stream->formats |= codec_format_map[i];
3263 }
3264
3265 static int snd_soc_codec_drv_probe(struct snd_soc_component *component)
3266 {
3267         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3268
3269         return codec->driver->probe(codec);
3270 }
3271
3272 static void snd_soc_codec_drv_remove(struct snd_soc_component *component)
3273 {
3274         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3275
3276         codec->driver->remove(codec);
3277 }
3278
3279 static int snd_soc_codec_drv_write(struct snd_soc_component *component,
3280         unsigned int reg, unsigned int val)
3281 {
3282         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3283
3284         return codec->driver->write(codec, reg, val);
3285 }
3286
3287 static int snd_soc_codec_drv_read(struct snd_soc_component *component,
3288         unsigned int reg, unsigned int *val)
3289 {
3290         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3291
3292         *val = codec->driver->read(codec, reg);
3293
3294         return 0;
3295 }
3296
3297 static int snd_soc_codec_set_bias_level(struct snd_soc_dapm_context *dapm,
3298         enum snd_soc_bias_level level)
3299 {
3300         struct snd_soc_codec *codec = snd_soc_dapm_to_codec(dapm);
3301
3302         return codec->driver->set_bias_level(codec, level);
3303 }
3304
3305 /**
3306  * snd_soc_register_codec - Register a codec with the ASoC core
3307  *
3308  * @dev: The parent device for this codec
3309  * @codec_drv: Codec driver
3310  * @dai_drv: The associated DAI driver
3311  * @num_dai: Number of DAIs
3312  */
3313 int snd_soc_register_codec(struct device *dev,
3314                            const struct snd_soc_codec_driver *codec_drv,
3315                            struct snd_soc_dai_driver *dai_drv,
3316                            int num_dai)
3317 {
3318         struct snd_soc_dapm_context *dapm;
3319         struct snd_soc_codec *codec;
3320         struct snd_soc_dai *dai;
3321         int ret, i;
3322
3323         dev_dbg(dev, "codec register %s\n", dev_name(dev));
3324
3325         codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
3326         if (codec == NULL)
3327                 return -ENOMEM;
3328
3329         codec->component.codec = codec;
3330
3331         ret = snd_soc_component_initialize(&codec->component,
3332                         &codec_drv->component_driver, dev);
3333         if (ret)
3334                 goto err_free;
3335
3336         if (codec_drv->controls) {
3337                 codec->component.controls = codec_drv->controls;
3338                 codec->component.num_controls = codec_drv->num_controls;
3339         }
3340         if (codec_drv->dapm_widgets) {
3341                 codec->component.dapm_widgets = codec_drv->dapm_widgets;
3342                 codec->component.num_dapm_widgets = codec_drv->num_dapm_widgets;
3343         }
3344         if (codec_drv->dapm_routes) {
3345                 codec->component.dapm_routes = codec_drv->dapm_routes;
3346                 codec->component.num_dapm_routes = codec_drv->num_dapm_routes;
3347         }
3348
3349         if (codec_drv->probe)
3350                 codec->component.probe = snd_soc_codec_drv_probe;
3351         if (codec_drv->remove)
3352                 codec->component.remove = snd_soc_codec_drv_remove;
3353         if (codec_drv->write)
3354                 codec->component.write = snd_soc_codec_drv_write;
3355         if (codec_drv->read)
3356                 codec->component.read = snd_soc_codec_drv_read;
3357         codec->component.ignore_pmdown_time = codec_drv->ignore_pmdown_time;
3358
3359         dapm = snd_soc_codec_get_dapm(codec);
3360         dapm->idle_bias_off = codec_drv->idle_bias_off;
3361         dapm->suspend_bias_off = codec_drv->suspend_bias_off;
3362         if (codec_drv->seq_notifier)
3363                 dapm->seq_notifier = codec_drv->seq_notifier;
3364         if (codec_drv->set_bias_level)
3365                 dapm->set_bias_level = snd_soc_codec_set_bias_level;
3366         codec->dev = dev;
3367         codec->driver = codec_drv;
3368         codec->component.val_bytes = codec_drv->reg_word_size;
3369
3370 #ifdef CONFIG_DEBUG_FS
3371         codec->component.init_debugfs = soc_init_codec_debugfs;
3372         codec->component.debugfs_prefix = "codec";
3373 #endif
3374
3375         if (codec_drv->get_regmap)
3376                 codec->component.regmap = codec_drv->get_regmap(dev);
3377
3378         for (i = 0; i < num_dai; i++) {
3379                 fixup_codec_formats(&dai_drv[i].playback);
3380                 fixup_codec_formats(&dai_drv[i].capture);
3381         }
3382
3383         ret = snd_soc_register_dais(&codec->component, dai_drv, num_dai, false);
3384         if (ret < 0) {
3385                 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3386                 goto err_cleanup;
3387         }
3388
3389         list_for_each_entry(dai, &codec->component.dai_list, list)
3390                 dai->codec = codec;
3391
3392         mutex_lock(&client_mutex);
3393         snd_soc_component_add_unlocked(&codec->component);
3394         list_add(&codec->list, &codec_list);
3395         mutex_unlock(&client_mutex);
3396
3397         dev_dbg(codec->dev, "ASoC: Registered codec '%s'\n",
3398                 codec->component.name);
3399         return 0;
3400
3401 err_cleanup:
3402         snd_soc_component_cleanup(&codec->component);
3403 err_free:
3404         kfree(codec);
3405         return ret;
3406 }
3407 EXPORT_SYMBOL_GPL(snd_soc_register_codec);
3408
3409 /**
3410  * snd_soc_unregister_codec - Unregister a codec from the ASoC core
3411  *
3412  * @dev: codec to unregister
3413  */
3414 void snd_soc_unregister_codec(struct device *dev)
3415 {
3416         struct snd_soc_codec *codec;
3417
3418         mutex_lock(&client_mutex);
3419         list_for_each_entry(codec, &codec_list, list) {
3420                 if (dev == codec->dev)
3421                         goto found;
3422         }
3423         mutex_unlock(&client_mutex);
3424         return;
3425
3426 found:
3427         list_del(&codec->list);
3428         snd_soc_component_del_unlocked(&codec->component);
3429         mutex_unlock(&client_mutex);
3430
3431         dev_dbg(codec->dev, "ASoC: Unregistered codec '%s'\n",
3432                         codec->component.name);
3433
3434         snd_soc_component_cleanup(&codec->component);
3435         snd_soc_cache_exit(codec);
3436         kfree(codec);
3437 }
3438 EXPORT_SYMBOL_GPL(snd_soc_unregister_codec);
3439
3440 /* Retrieve a card's name from device tree */
3441 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
3442                                const char *propname)
3443 {
3444         struct device_node *np;
3445         int ret;
3446
3447         if (!card->dev) {
3448                 pr_err("card->dev is not set before calling %s\n", __func__);
3449                 return -EINVAL;
3450         }
3451
3452         np = card->dev->of_node;
3453
3454         ret = of_property_read_string_index(np, propname, 0, &card->name);
3455         /*
3456          * EINVAL means the property does not exist. This is fine providing
3457          * card->name was previously set, which is checked later in
3458          * snd_soc_register_card.
3459          */
3460         if (ret < 0 && ret != -EINVAL) {
3461                 dev_err(card->dev,
3462                         "ASoC: Property '%s' could not be read: %d\n",
3463                         propname, ret);
3464                 return ret;
3465         }
3466
3467         return 0;
3468 }
3469 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
3470
3471 static const struct snd_soc_dapm_widget simple_widgets[] = {
3472         SND_SOC_DAPM_MIC("Microphone", NULL),
3473         SND_SOC_DAPM_LINE("Line", NULL),
3474         SND_SOC_DAPM_HP("Headphone", NULL),
3475         SND_SOC_DAPM_SPK("Speaker", NULL),
3476 };
3477
3478 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
3479                                           const char *propname)
3480 {
3481         struct device_node *np = card->dev->of_node;
3482         struct snd_soc_dapm_widget *widgets;
3483         const char *template, *wname;
3484         int i, j, num_widgets, ret;
3485
3486         num_widgets = of_property_count_strings(np, propname);
3487         if (num_widgets < 0) {
3488                 dev_err(card->dev,
3489                         "ASoC: Property '%s' does not exist\n", propname);
3490                 return -EINVAL;
3491         }
3492         if (num_widgets & 1) {
3493                 dev_err(card->dev,
3494                         "ASoC: Property '%s' length is not even\n", propname);
3495                 return -EINVAL;
3496         }
3497
3498         num_widgets /= 2;
3499         if (!num_widgets) {
3500                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3501                         propname);
3502                 return -EINVAL;
3503         }
3504
3505         widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
3506                                GFP_KERNEL);
3507         if (!widgets) {
3508                 dev_err(card->dev,
3509                         "ASoC: Could not allocate memory for widgets\n");
3510                 return -ENOMEM;
3511         }
3512
3513         for (i = 0; i < num_widgets; i++) {
3514                 ret = of_property_read_string_index(np, propname,
3515                         2 * i, &template);
3516                 if (ret) {
3517                         dev_err(card->dev,
3518                                 "ASoC: Property '%s' index %d read error:%d\n",
3519                                 propname, 2 * i, ret);
3520                         return -EINVAL;
3521                 }
3522
3523                 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3524                         if (!strncmp(template, simple_widgets[j].name,
3525                                      strlen(simple_widgets[j].name))) {
3526                                 widgets[i] = simple_widgets[j];
3527                                 break;
3528                         }
3529                 }
3530
3531                 if (j >= ARRAY_SIZE(simple_widgets)) {
3532                         dev_err(card->dev,
3533                                 "ASoC: DAPM widget '%s' is not supported\n",
3534                                 template);
3535                         return -EINVAL;
3536                 }
3537
3538                 ret = of_property_read_string_index(np, propname,
3539                                                     (2 * i) + 1,
3540                                                     &wname);
3541                 if (ret) {
3542                         dev_err(card->dev,
3543                                 "ASoC: Property '%s' index %d read error:%d\n",
3544                                 propname, (2 * i) + 1, ret);
3545                         return -EINVAL;
3546                 }
3547
3548                 widgets[i].name = wname;
3549         }
3550
3551         card->of_dapm_widgets = widgets;
3552         card->num_of_dapm_widgets = num_widgets;
3553
3554         return 0;
3555 }
3556 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3557
3558 static int snd_soc_of_get_slot_mask(struct device_node *np,
3559                                     const char *prop_name,
3560                                     unsigned int *mask)
3561 {
3562         u32 val;
3563         const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3564         int i;
3565
3566         if (!of_slot_mask)
3567                 return 0;
3568         val /= sizeof(u32);
3569         for (i = 0; i < val; i++)
3570                 if (be32_to_cpup(&of_slot_mask[i]))
3571                         *mask |= (1 << i);
3572
3573         return val;
3574 }
3575
3576 int snd_soc_of_parse_tdm_slot(struct device_node *np,
3577                               unsigned int *tx_mask,
3578                               unsigned int *rx_mask,
3579                               unsigned int *slots,
3580                               unsigned int *slot_width)
3581 {
3582         u32 val;
3583         int ret;
3584
3585         if (tx_mask)
3586                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3587         if (rx_mask)
3588                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3589
3590         if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3591                 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3592                 if (ret)
3593                         return ret;
3594
3595                 if (slots)
3596                         *slots = val;
3597         }
3598
3599         if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3600                 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3601                 if (ret)
3602                         return ret;
3603
3604                 if (slot_width)
3605                         *slot_width = val;
3606         }
3607
3608         return 0;
3609 }
3610 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3611
3612 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
3613                                    struct snd_soc_codec_conf *codec_conf,
3614                                    struct device_node *of_node,
3615                                    const char *propname)
3616 {
3617         struct device_node *np = card->dev->of_node;
3618         const char *str;
3619         int ret;
3620
3621         ret = of_property_read_string(np, propname, &str);
3622         if (ret < 0) {
3623                 /* no prefix is not error */
3624                 return;
3625         }
3626
3627         codec_conf->of_node     = of_node;
3628         codec_conf->name_prefix = str;
3629 }
3630 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_prefix);
3631
3632 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3633                                    const char *propname)
3634 {
3635         struct device_node *np = card->dev->of_node;
3636         int num_routes;
3637         struct snd_soc_dapm_route *routes;
3638         int i, ret;
3639
3640         num_routes = of_property_count_strings(np, propname);
3641         if (num_routes < 0 || num_routes & 1) {
3642                 dev_err(card->dev,
3643                         "ASoC: Property '%s' does not exist or its length is not even\n",
3644                         propname);
3645                 return -EINVAL;
3646         }
3647         num_routes /= 2;
3648         if (!num_routes) {
3649                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3650                         propname);
3651                 return -EINVAL;
3652         }
3653
3654         routes = devm_kzalloc(card->dev, num_routes * sizeof(*routes),
3655                               GFP_KERNEL);
3656         if (!routes) {
3657                 dev_err(card->dev,
3658                         "ASoC: Could not allocate DAPM route table\n");
3659                 return -EINVAL;
3660         }
3661
3662         for (i = 0; i < num_routes; i++) {
3663                 ret = of_property_read_string_index(np, propname,
3664                         2 * i, &routes[i].sink);
3665                 if (ret) {
3666                         dev_err(card->dev,
3667                                 "ASoC: Property '%s' index %d could not be read: %d\n",
3668                                 propname, 2 * i, ret);
3669                         return -EINVAL;
3670                 }
3671                 ret = of_property_read_string_index(np, propname,
3672                         (2 * i) + 1, &routes[i].source);
3673                 if (ret) {
3674                         dev_err(card->dev,
3675                                 "ASoC: Property '%s' index %d could not be read: %d\n",
3676                                 propname, (2 * i) + 1, ret);
3677                         return -EINVAL;
3678                 }
3679         }
3680
3681         card->num_of_dapm_routes = num_routes;
3682         card->of_dapm_routes = routes;
3683
3684         return 0;
3685 }
3686 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3687
3688 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
3689                                      const char *prefix,
3690                                      struct device_node **bitclkmaster,
3691                                      struct device_node **framemaster)
3692 {
3693         int ret, i;
3694         char prop[128];
3695         unsigned int format = 0;
3696         int bit, frame;
3697         const char *str;
3698         struct {
3699                 char *name;
3700                 unsigned int val;
3701         } of_fmt_table[] = {
3702                 { "i2s",        SND_SOC_DAIFMT_I2S },
3703                 { "right_j",    SND_SOC_DAIFMT_RIGHT_J },
3704                 { "left_j",     SND_SOC_DAIFMT_LEFT_J },
3705                 { "dsp_a",      SND_SOC_DAIFMT_DSP_A },
3706                 { "dsp_b",      SND_SOC_DAIFMT_DSP_B },
3707                 { "ac97",       SND_SOC_DAIFMT_AC97 },
3708                 { "pdm",        SND_SOC_DAIFMT_PDM},
3709                 { "msb",        SND_SOC_DAIFMT_MSB },
3710                 { "lsb",        SND_SOC_DAIFMT_LSB },
3711         };
3712
3713         if (!prefix)
3714                 prefix = "";
3715
3716         /*
3717          * check "[prefix]format = xxx"
3718          * SND_SOC_DAIFMT_FORMAT_MASK area
3719          */
3720         snprintf(prop, sizeof(prop), "%sformat", prefix);
3721         ret = of_property_read_string(np, prop, &str);
3722         if (ret == 0) {
3723                 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3724                         if (strcmp(str, of_fmt_table[i].name) == 0) {
3725                                 format |= of_fmt_table[i].val;
3726                                 break;
3727                         }
3728                 }
3729         }
3730
3731         /*
3732          * check "[prefix]continuous-clock"
3733          * SND_SOC_DAIFMT_CLOCK_MASK area
3734          */
3735         snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3736         if (of_get_property(np, prop, NULL))
3737                 format |= SND_SOC_DAIFMT_CONT;
3738         else
3739                 format |= SND_SOC_DAIFMT_GATED;
3740
3741         /*
3742          * check "[prefix]bitclock-inversion"
3743          * check "[prefix]frame-inversion"
3744          * SND_SOC_DAIFMT_INV_MASK area
3745          */
3746         snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3747         bit = !!of_get_property(np, prop, NULL);
3748
3749         snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3750         frame = !!of_get_property(np, prop, NULL);
3751
3752         switch ((bit << 4) + frame) {
3753         case 0x11:
3754                 format |= SND_SOC_DAIFMT_IB_IF;
3755                 break;
3756         case 0x10:
3757                 format |= SND_SOC_DAIFMT_IB_NF;
3758                 break;
3759         case 0x01:
3760                 format |= SND_SOC_DAIFMT_NB_IF;
3761                 break;
3762         default:
3763                 /* SND_SOC_DAIFMT_NB_NF is default */
3764                 break;
3765         }
3766
3767         /*
3768          * check "[prefix]bitclock-master"
3769          * check "[prefix]frame-master"
3770          * SND_SOC_DAIFMT_MASTER_MASK area
3771          */
3772         snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3773         bit = !!of_get_property(np, prop, NULL);
3774         if (bit && bitclkmaster)
3775                 *bitclkmaster = of_parse_phandle(np, prop, 0);
3776
3777         snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3778         frame = !!of_get_property(np, prop, NULL);
3779         if (frame && framemaster)
3780                 *framemaster = of_parse_phandle(np, prop, 0);
3781
3782         switch ((bit << 4) + frame) {
3783         case 0x11:
3784                 format |= SND_SOC_DAIFMT_CBM_CFM;
3785                 break;
3786         case 0x10:
3787                 format |= SND_SOC_DAIFMT_CBM_CFS;
3788                 break;
3789         case 0x01:
3790                 format |= SND_SOC_DAIFMT_CBS_CFM;
3791                 break;
3792         default:
3793                 format |= SND_SOC_DAIFMT_CBS_CFS;
3794                 break;
3795         }
3796
3797         return format;
3798 }
3799 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
3800
3801 static int snd_soc_get_dai_name(struct of_phandle_args *args,
3802                                 const char **dai_name)
3803 {
3804         struct snd_soc_component *pos;
3805         struct device_node *component_of_node;
3806         int ret = -EPROBE_DEFER;
3807
3808         mutex_lock(&client_mutex);
3809         list_for_each_entry(pos, &component_list, list) {
3810                 component_of_node = pos->dev->of_node;
3811                 if (!component_of_node && pos->dev->parent)
3812                         component_of_node = pos->dev->parent->of_node;
3813
3814                 if (component_of_node != args->np)
3815                         continue;
3816
3817                 if (pos->driver->of_xlate_dai_name) {
3818                         ret = pos->driver->of_xlate_dai_name(pos,
3819                                                              args,
3820                                                              dai_name);
3821                 } else {
3822                         int id = -1;
3823
3824                         switch (args->args_count) {
3825                         case 0:
3826                                 id = 0; /* same as dai_drv[0] */
3827                                 break;
3828                         case 1:
3829                                 id = args->args[0];
3830                                 break;
3831                         default:
3832                                 /* not supported */
3833                                 break;
3834                         }
3835
3836                         if (id < 0 || id >= pos->num_dai) {
3837                                 ret = -EINVAL;
3838                                 continue;
3839                         }
3840
3841                         ret = 0;
3842
3843                         *dai_name = pos->dai_drv[id].name;
3844                         if (!*dai_name)
3845                                 *dai_name = pos->name;
3846                 }
3847
3848                 break;
3849         }
3850         mutex_unlock(&client_mutex);
3851         return ret;
3852 }
3853
3854 int snd_soc_of_get_dai_name(struct device_node *of_node,
3855                             const char **dai_name)
3856 {
3857         struct of_phandle_args args;
3858         int ret;
3859
3860         ret = of_parse_phandle_with_args(of_node, "sound-dai",
3861                                          "#sound-dai-cells", 0, &args);
3862         if (ret)
3863                 return ret;
3864
3865         ret = snd_soc_get_dai_name(&args, dai_name);
3866
3867         of_node_put(args.np);
3868
3869         return ret;
3870 }
3871 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3872
3873 /*
3874  * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3875  * @dev: Card device
3876  * @of_node: Device node
3877  * @dai_link: DAI link
3878  *
3879  * Builds an array of CODEC DAI components from the DAI link property
3880  * 'sound-dai'.
3881  * The array is set in the DAI link and the number of DAIs is set accordingly.
3882  * The device nodes in the array (of_node) must be dereferenced by the caller.
3883  *
3884  * Returns 0 for success
3885  */
3886 int snd_soc_of_get_dai_link_codecs(struct device *dev,
3887                                    struct device_node *of_node,
3888                                    struct snd_soc_dai_link *dai_link)
3889 {
3890         struct of_phandle_args args;
3891         struct snd_soc_dai_link_component *component;
3892         char *name;
3893         int index, num_codecs, ret;
3894
3895         /* Count the number of CODECs */
3896         name = "sound-dai";
3897         num_codecs = of_count_phandle_with_args(of_node, name,
3898                                                 "#sound-dai-cells");
3899         if (num_codecs <= 0) {
3900                 if (num_codecs == -ENOENT)
3901                         dev_err(dev, "No 'sound-dai' property\n");
3902                 else
3903                         dev_err(dev, "Bad phandle in 'sound-dai'\n");
3904                 return num_codecs;
3905         }
3906         component = devm_kzalloc(dev,
3907                                  sizeof *component * num_codecs,
3908                                  GFP_KERNEL);
3909         if (!component)
3910                 return -ENOMEM;
3911         dai_link->codecs = component;
3912         dai_link->num_codecs = num_codecs;
3913
3914         /* Parse the list */
3915         for (index = 0, component = dai_link->codecs;
3916              index < dai_link->num_codecs;
3917              index++, component++) {
3918                 ret = of_parse_phandle_with_args(of_node, name,
3919                                                  "#sound-dai-cells",
3920                                                   index, &args);
3921                 if (ret)
3922                         goto err;
3923                 component->of_node = args.np;
3924                 ret = snd_soc_get_dai_name(&args, &component->dai_name);
3925                 if (ret < 0)
3926                         goto err;
3927         }
3928         return 0;
3929 err:
3930         for (index = 0, component = dai_link->codecs;
3931              index < dai_link->num_codecs;
3932              index++, component++) {
3933                 if (!component->of_node)
3934                         break;
3935                 of_node_put(component->of_node);
3936                 component->of_node = NULL;
3937         }
3938         dai_link->codecs = NULL;
3939         dai_link->num_codecs = 0;
3940         return ret;
3941 }
3942 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3943
3944 static int __init snd_soc_init(void)
3945 {
3946         snd_soc_debugfs_init();
3947         snd_soc_util_init();
3948
3949         return platform_driver_register(&soc_driver);
3950 }
3951 module_init(snd_soc_init);
3952
3953 static void __exit snd_soc_exit(void)
3954 {
3955         snd_soc_util_exit();
3956         snd_soc_debugfs_exit();
3957
3958 #ifdef CONFIG_DEBUG_FS
3959 #endif
3960         platform_driver_unregister(&soc_driver);
3961 }
3962 module_exit(snd_soc_exit);
3963
3964 /* Module information */
3965 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3966 MODULE_DESCRIPTION("ALSA SoC Core");
3967 MODULE_LICENSE("GPL");
3968 MODULE_ALIAS("platform:soc-audio");