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