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->num_codecs ? 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 const struct snd_soc_ops null_snd_soc_ops;
 618
 619 static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
 620         struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
 621 {
 622         struct snd_soc_pcm_runtime *rtd;
 623
 624         rtd = kzalloc(sizeof(struct snd_soc_pcm_runtime), GFP_KERNEL);
 625         if (!rtd)
 626                 return NULL;
 627
 628         INIT_LIST_HEAD(&rtd->component_list);
 629         rtd->card = card;
 630         rtd->dai_link = dai_link;
 631         if (!rtd->dai_link->ops)
 632                 rtd->dai_link->ops = &null_snd_soc_ops;
 633
 634         rtd->codec_dais = kzalloc(sizeof(struct snd_soc_dai *) *
 635                                         dai_link->num_codecs,
 636                                         GFP_KERNEL);
 637         if (!rtd->codec_dais) {
 638                 kfree(rtd);
 639                 return NULL;
 640         }
 641
 642         return rtd;
 643 }
 644
 645 static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
 646 {
 647         kfree(rtd->codec_dais);
 648         snd_soc_rtdcom_del_all(rtd);
 649         kfree(rtd);
 650 }
 651
 652 static void soc_add_pcm_runtime(struct snd_soc_card *card,
 653                 struct snd_soc_pcm_runtime *rtd)
 654 {
 655         list_add_tail(&rtd->list, &card->rtd_list);
 656         rtd->num = card->num_rtd;
 657         card->num_rtd++;
 658 }
 659
 660 static void soc_remove_pcm_runtimes(struct snd_soc_card *card)
 661 {
 662         struct snd_soc_pcm_runtime *rtd, *_rtd;
 663
 664         list_for_each_entry_safe(rtd, _rtd, &card->rtd_list, list) {
 665                 list_del(&rtd->list);
 666                 soc_free_pcm_runtime(rtd);
 667         }
 668
 669         card->num_rtd = 0;
 670 }
 671
 672 struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 673                 const char *dai_link)
 674 {
 675         struct snd_soc_pcm_runtime *rtd;
 676
 677         list_for_each_entry(rtd, &card->rtd_list, list) {
 678                 if (!strcmp(rtd->dai_link->name, dai_link))
 679                         return rtd;
 680         }
 681         dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link);
 682         return NULL;
 683 }
 684 EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
 685
 686 static void codec2codec_close_delayed_work(struct work_struct *work)
 687 {
 688         /* Currently nothing to do for c2c links
 689          * Since c2c links are internal nodes in the DAPM graph and
 690          * don't interface with the outside world or application layer
 691          * we don't have to do any special handling on close.
 692          */
 693 }
 694
 695 #ifdef CONFIG_PM_SLEEP
 696 /* powers down audio subsystem for suspend */
 697 int snd_soc_suspend(struct device *dev)
 698 {
 699         struct snd_soc_card *card = dev_get_drvdata(dev);
 700         struct snd_soc_component *component;
 701         struct snd_soc_pcm_runtime *rtd;
 702         int i;
 703
 704         /* If the card is not initialized yet there is nothing to do */
 705         if (!card->instantiated)
 706                 return 0;
 707
 708         /* Due to the resume being scheduled into a workqueue we could
 709         * suspend before that's finished - wait for it to complete.
 710          */
 711         snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
 712
 713         /* we're going to block userspace touching us until resume completes */
 714         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
 715
 716         /* mute any active DACs */
 717         list_for_each_entry(rtd, &card->rtd_list, list) {
 718
 719                 if (rtd->dai_link->ignore_suspend)
 720                         continue;
 721
 722                 for (i = 0; i < rtd->num_codecs; i++) {
 723                         struct snd_soc_dai *dai = rtd->codec_dais[i];
 724                         struct snd_soc_dai_driver *drv = dai->driver;
 725
 726                         if (drv->ops->digital_mute && dai->playback_active)
 727                                 drv->ops->digital_mute(dai, 1);
 728                 }
 729         }
 730
 731         /* suspend all pcms */
 732         list_for_each_entry(rtd, &card->rtd_list, list) {
 733                 if (rtd->dai_link->ignore_suspend)
 734                         continue;
 735
 736                 snd_pcm_suspend_all(rtd->pcm);
 737         }
 738
 739         if (card->suspend_pre)
 740                 card->suspend_pre(card);
 741
 742         list_for_each_entry(rtd, &card->rtd_list, list) {
 743                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 744
 745                 if (rtd->dai_link->ignore_suspend)
 746                         continue;
 747
 748                 if (cpu_dai->driver->suspend && !cpu_dai->driver->bus_control)
 749                         cpu_dai->driver->suspend(cpu_dai);
 750         }
 751
 752         /* close any waiting streams */
 753         list_for_each_entry(rtd, &card->rtd_list, list)
 754                 flush_delayed_work(&rtd->delayed_work);
 755
 756         list_for_each_entry(rtd, &card->rtd_list, list) {
 757
 758                 if (rtd->dai_link->ignore_suspend)
 759                         continue;
 760
 761                 snd_soc_dapm_stream_event(rtd,
 762                                           SNDRV_PCM_STREAM_PLAYBACK,
 763                                           SND_SOC_DAPM_STREAM_SUSPEND);
 764
 765                 snd_soc_dapm_stream_event(rtd,
 766                                           SNDRV_PCM_STREAM_CAPTURE,
 767                                           SND_SOC_DAPM_STREAM_SUSPEND);
 768         }
 769
 770         /* Recheck all endpoints too, their state is affected by suspend */
 771         dapm_mark_endpoints_dirty(card);
 772         snd_soc_dapm_sync(&card->dapm);
 773
 774         /* suspend all COMPONENTs */
 775         list_for_each_entry(component, &card->component_dev_list, card_list) {
 776                 struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
 777
 778                 /* If there are paths active then the COMPONENT will be held with
 779                  * bias _ON and should not be suspended. */
 780                 if (!component->suspended) {
 781                         switch (snd_soc_dapm_get_bias_level(dapm)) {
 782                         case SND_SOC_BIAS_STANDBY:
 783                                 /*
 784                                  * If the COMPONENT is capable of idle
 785                                  * bias off then being in STANDBY
 786                                  * means it's doing something,
 787                                  * otherwise fall through.
 788                                  */
 789                                 if (dapm->idle_bias_off) {
 790                                         dev_dbg(component->dev,
 791                                                 "ASoC: idle_bias_off CODEC on over suspend\n");
 792                                         break;
 793                                 }
 794
 795                         case SND_SOC_BIAS_OFF:
 796                                 if (component->suspend)
 797                                         component->suspend(component);
 798                                 component->suspended = 1;
 799                                 if (component->regmap)
 800                                         regcache_mark_dirty(component->regmap);
 801                                 /* deactivate pins to sleep state */
 802                                 pinctrl_pm_select_sleep_state(component->dev);
 803                                 break;
 804                         default:
 805                                 dev_dbg(component->dev,
 806                                         "ASoC: COMPONENT is on over suspend\n");
 807                                 break;
 808                         }
 809                 }
 810         }
 811
 812         list_for_each_entry(rtd, &card->rtd_list, list) {
 813                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 814
 815                 if (rtd->dai_link->ignore_suspend)
 816                         continue;
 817
 818                 if (cpu_dai->driver->suspend && cpu_dai->driver->bus_control)
 819                         cpu_dai->driver->suspend(cpu_dai);
 820
 821                 /* deactivate pins to sleep state */
 822                 pinctrl_pm_select_sleep_state(cpu_dai->dev);
 823         }
 824
 825         if (card->suspend_post)
 826                 card->suspend_post(card);
 827
 828         return 0;
 829 }
 830 EXPORT_SYMBOL_GPL(snd_soc_suspend);
 831
 832 /* deferred resume work, so resume can complete before we finished
 833  * setting our codec back up, which can be very slow on I2C
 834  */
 835 static void soc_resume_deferred(struct work_struct *work)
 836 {
 837         struct snd_soc_card *card =
 838                         container_of(work, struct snd_soc_card, deferred_resume_work);
 839         struct snd_soc_pcm_runtime *rtd;
 840         struct snd_soc_component *component;
 841         int i;
 842
 843         /* our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
 844          * so userspace apps are blocked from touching us
 845          */
 846
 847         dev_dbg(card->dev, "ASoC: starting resume work\n");
 848
 849         /* Bring us up into D2 so that DAPM starts enabling things */
 850         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
 851
 852         if (card->resume_pre)
 853                 card->resume_pre(card);
 854
 855         /* resume control bus DAIs */
 856         list_for_each_entry(rtd, &card->rtd_list, list) {
 857                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 858
 859                 if (rtd->dai_link->ignore_suspend)
 860                         continue;
 861
 862                 if (cpu_dai->driver->resume && cpu_dai->driver->bus_control)
 863                         cpu_dai->driver->resume(cpu_dai);
 864         }
 865
 866         list_for_each_entry(component, &card->component_dev_list, card_list) {
 867                 if (component->suspended) {
 868                         if (component->resume)
 869                                 component->resume(component);
 870                         component->suspended = 0;
 871                 }
 872         }
 873
 874         list_for_each_entry(rtd, &card->rtd_list, list) {
 875
 876                 if (rtd->dai_link->ignore_suspend)
 877                         continue;
 878
 879                 snd_soc_dapm_stream_event(rtd,
 880                                           SNDRV_PCM_STREAM_PLAYBACK,
 881                                           SND_SOC_DAPM_STREAM_RESUME);
 882
 883                 snd_soc_dapm_stream_event(rtd,
 884                                           SNDRV_PCM_STREAM_CAPTURE,
 885                                           SND_SOC_DAPM_STREAM_RESUME);
 886         }
 887
 888         /* unmute any active DACs */
 889         list_for_each_entry(rtd, &card->rtd_list, list) {
 890
 891                 if (rtd->dai_link->ignore_suspend)
 892                         continue;
 893
 894                 for (i = 0; i < rtd->num_codecs; i++) {
 895                         struct snd_soc_dai *dai = rtd->codec_dais[i];
 896                         struct snd_soc_dai_driver *drv = dai->driver;
 897
 898                         if (drv->ops->digital_mute && dai->playback_active)
 899                                 drv->ops->digital_mute(dai, 0);
 900                 }
 901         }
 902
 903         list_for_each_entry(rtd, &card->rtd_list, list) {
 904                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 905
 906                 if (rtd->dai_link->ignore_suspend)
 907                         continue;
 908
 909                 if (cpu_dai->driver->resume && !cpu_dai->driver->bus_control)
 910                         cpu_dai->driver->resume(cpu_dai);
 911         }
 912
 913         if (card->resume_post)
 914                 card->resume_post(card);
 915
 916         dev_dbg(card->dev, "ASoC: resume work completed\n");
 917
 918         /* Recheck all endpoints too, their state is affected by suspend */
 919         dapm_mark_endpoints_dirty(card);
 920         snd_soc_dapm_sync(&card->dapm);
 921
 922         /* userspace can access us now we are back as we were before */
 923         snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
 924 }
 925
 926 /* powers up audio subsystem after a suspend */
 927 int snd_soc_resume(struct device *dev)
 928 {
 929         struct snd_soc_card *card = dev_get_drvdata(dev);
 930         bool bus_control = false;
 931         struct snd_soc_pcm_runtime *rtd;
 932
 933         /* If the card is not initialized yet there is nothing to do */
 934         if (!card->instantiated)
 935                 return 0;
 936
 937         /* activate pins from sleep state */
 938         list_for_each_entry(rtd, &card->rtd_list, list) {
 939                 struct snd_soc_dai **codec_dais = rtd->codec_dais;
 940                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 941                 int j;
 942
 943                 if (cpu_dai->active)
 944                         pinctrl_pm_select_default_state(cpu_dai->dev);
 945
 946                 for (j = 0; j < rtd->num_codecs; j++) {
 947                         struct snd_soc_dai *codec_dai = codec_dais[j];
 948                         if (codec_dai->active)
 949                                 pinctrl_pm_select_default_state(codec_dai->dev);
 950                 }
 951         }
 952
 953         /*
 954          * DAIs that also act as the control bus master might have other drivers
 955          * hanging off them so need to resume immediately. Other drivers don't
 956          * have that problem and may take a substantial amount of time to resume
 957          * due to I/O costs and anti-pop so handle them out of line.
 958          */
 959         list_for_each_entry(rtd, &card->rtd_list, list) {
 960                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 961                 bus_control |= cpu_dai->driver->bus_control;
 962         }
 963         if (bus_control) {
 964                 dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
 965                 soc_resume_deferred(&card->deferred_resume_work);
 966         } else {
 967                 dev_dbg(dev, "ASoC: Scheduling resume work\n");
 968                 if (!schedule_work(&card->deferred_resume_work))
 969                         dev_err(dev, "ASoC: resume work item may be lost\n");
 970         }
 971
 972         return 0;
 973 }
 974 EXPORT_SYMBOL_GPL(snd_soc_resume);
 975 #else
 976 #define snd_soc_suspend NULL
 977 #define snd_soc_resume NULL
 978 #endif
 979
 980 static const struct snd_soc_dai_ops null_dai_ops = {
 981 };
 982
 983 static struct snd_soc_component *soc_find_component(
 984         const struct device_node *of_node, const char *name)
 985 {
 986         struct snd_soc_component *component;
 987
 988         lockdep_assert_held(&client_mutex);
 989
 990         list_for_each_entry(component, &component_list, list) {
 991                 if (of_node) {
 992                         if (component->dev->of_node == of_node)
 993                                 return component;
 994                 } else if (strcmp(component->name, name) == 0) {
 995                         return component;
 996                 }
 997         }
 998
 999         return NULL;
1000 }
1001
1002 /**
1003  * snd_soc_find_dai - Find a registered DAI
1004  *
1005  * @dlc: name of the DAI or the DAI driver and optional component info to match
1006  *
1007  * This function will search all registered components and their DAIs to
1008  * find the DAI of the same name. The component's of_node and name
1009  * should also match if being specified.
1010  *
1011  * Return: pointer of DAI, or NULL if not found.
1012  */
1013 struct snd_soc_dai *snd_soc_find_dai(
1014         const struct snd_soc_dai_link_component *dlc)
1015 {
1016         struct snd_soc_component *component;
1017         struct snd_soc_dai *dai;
1018         struct device_node *component_of_node;
1019
1020         lockdep_assert_held(&client_mutex);
1021
1022         /* Find CPU DAI from registered DAIs*/
1023         list_for_each_entry(component, &component_list, list) {
1024                 component_of_node = component->dev->of_node;
1025                 if (!component_of_node && component->dev->parent)
1026                         component_of_node = component->dev->parent->of_node;
1027
1028                 if (dlc->of_node && component_of_node != dlc->of_node)
1029                         continue;
1030                 if (dlc->name && strcmp(component->name, dlc->name))
1031                         continue;
1032                 list_for_each_entry(dai, &component->dai_list, list) {
1033                         if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
1034                             && (!dai->driver->name
1035                                 || strcmp(dai->driver->name, dlc->dai_name)))
1036                                 continue;
1037
1038                         return dai;
1039                 }
1040         }
1041
1042         return NULL;
1043 }
1044 EXPORT_SYMBOL_GPL(snd_soc_find_dai);
1045
1046
1047 /**
1048  * snd_soc_find_dai_link - Find a DAI link
1049  *
1050  * @card: soc card
1051  * @id: DAI link ID to match
1052  * @name: DAI link name to match, optional
1053  * @stream_name: DAI link stream name to match, optional
1054  *
1055  * This function will search all existing DAI links of the soc card to
1056  * find the link of the same ID. Since DAI links may not have their
1057  * unique ID, so name and stream name should also match if being
1058  * specified.
1059  *
1060  * Return: pointer of DAI link, or NULL if not found.
1061  */
1062 struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1063                                                int id, const char *name,
1064                                                const char *stream_name)
1065 {
1066         struct snd_soc_dai_link *link, *_link;
1067
1068         lockdep_assert_held(&client_mutex);
1069
1070         list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1071                 if (link->id != id)
1072                         continue;
1073
1074                 if (name && (!link->name || strcmp(name, link->name)))
1075                         continue;
1076
1077                 if (stream_name && (!link->stream_name
1078                         || strcmp(stream_name, link->stream_name)))
1079                         continue;
1080
1081                 return link;
1082         }
1083
1084         return NULL;
1085 }
1086 EXPORT_SYMBOL_GPL(snd_soc_find_dai_link);
1087
1088 static bool soc_is_dai_link_bound(struct snd_soc_card *card,
1089                 struct snd_soc_dai_link *dai_link)
1090 {
1091         struct snd_soc_pcm_runtime *rtd;
1092
1093         list_for_each_entry(rtd, &card->rtd_list, list) {
1094                 if (rtd->dai_link == dai_link)
1095                         return true;
1096         }
1097
1098         return false;
1099 }
1100
1101 static int soc_bind_dai_link(struct snd_soc_card *card,
1102         struct snd_soc_dai_link *dai_link)
1103 {
1104         struct snd_soc_pcm_runtime *rtd;
1105         struct snd_soc_dai_link_component *codecs = dai_link->codecs;
1106         struct snd_soc_dai_link_component cpu_dai_component;
1107         struct snd_soc_component *component;
1108         struct snd_soc_dai **codec_dais;
1109         struct snd_soc_platform *platform;
1110         struct device_node *platform_of_node;
1111         const char *platform_name;
1112         int i;
1113
1114         dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1115
1116         if (soc_is_dai_link_bound(card, dai_link)) {
1117                 dev_dbg(card->dev, "ASoC: dai link %s already bound\n",
1118                         dai_link->name);
1119                 return 0;
1120         }
1121
1122         rtd = soc_new_pcm_runtime(card, dai_link);
1123         if (!rtd)
1124                 return -ENOMEM;
1125
1126         cpu_dai_component.name = dai_link->cpu_name;
1127         cpu_dai_component.of_node = dai_link->cpu_of_node;
1128         cpu_dai_component.dai_name = dai_link->cpu_dai_name;
1129         rtd->cpu_dai = snd_soc_find_dai(&cpu_dai_component);
1130         if (!rtd->cpu_dai) {
1131                 dev_err(card->dev, "ASoC: CPU DAI %s not registered\n",
1132                         dai_link->cpu_dai_name);
1133                 goto _err_defer;
1134         }
1135         snd_soc_rtdcom_add(rtd, rtd->cpu_dai->component);
1136
1137         rtd->num_codecs = dai_link->num_codecs;
1138
1139         /* Find CODEC from registered CODECs */
1140         codec_dais = rtd->codec_dais;
1141         for (i = 0; i < rtd->num_codecs; i++) {
1142                 codec_dais[i] = snd_soc_find_dai(&codecs[i]);
1143                 if (!codec_dais[i]) {
1144                         dev_err(card->dev, "ASoC: CODEC DAI %s not registered\n",
1145                                 codecs[i].dai_name);
1146                         goto _err_defer;
1147                 }
1148                 snd_soc_rtdcom_add(rtd, codec_dais[i]->component);
1149         }
1150
1151         /* Single codec links expect codec and codec_dai in runtime data */
1152         rtd->codec_dai = codec_dais[0];
1153         rtd->codec = rtd->codec_dai->codec;
1154
1155         /* if there's no platform we match on the empty platform */
1156         platform_name = dai_link->platform_name;
1157         if (!platform_name && !dai_link->platform_of_node)
1158                 platform_name = "snd-soc-dummy";
1159
1160         /* find one from the set of registered platforms */
1161         list_for_each_entry(component, &component_list, list) {
1162                 platform_of_node = component->dev->of_node;
1163                 if (!platform_of_node && component->dev->parent->of_node)
1164                         platform_of_node = component->dev->parent->of_node;
1165
1166                 if (dai_link->platform_of_node) {
1167                         if (platform_of_node != dai_link->platform_of_node)
1168                                 continue;
1169                 } else {
1170                         if (strcmp(component->name, platform_name))
1171                                 continue;
1172                 }
1173
1174                 snd_soc_rtdcom_add(rtd, component);
1175         }
1176
1177         /* find one from the set of registered platforms */
1178         list_for_each_entry(platform, &platform_list, list) {
1179                 platform_of_node = platform->dev->of_node;
1180                 if (!platform_of_node && platform->dev->parent->of_node)
1181                         platform_of_node = platform->dev->parent->of_node;
1182
1183                 if (dai_link->platform_of_node) {
1184                         if (platform_of_node != dai_link->platform_of_node)
1185                                 continue;
1186                 } else {
1187                         if (strcmp(platform->component.name, platform_name))
1188                                 continue;
1189                 }
1190
1191                 rtd->platform = platform;
1192         }
1193         if (!rtd->platform) {
1194                 dev_err(card->dev, "ASoC: platform %s not registered\n",
1195                         dai_link->platform_name);
1196                 goto _err_defer;
1197         }
1198
1199         soc_add_pcm_runtime(card, rtd);
1200         return 0;
1201
1202 _err_defer:
1203         soc_free_pcm_runtime(rtd);
1204         return  -EPROBE_DEFER;
1205 }
1206
1207 static void soc_remove_component(struct snd_soc_component *component)
1208 {
1209         if (!component->card)
1210                 return;
1211
1212         list_del(&component->card_list);
1213
1214         if (component->remove)
1215                 component->remove(component);
1216
1217         snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1218
1219         soc_cleanup_component_debugfs(component);
1220         component->card = NULL;
1221         module_put(component->dev->driver->owner);
1222 }
1223
1224 static void soc_remove_dai(struct snd_soc_dai *dai, int order)
1225 {
1226         int err;
1227
1228         if (dai && dai->probed &&
1229                         dai->driver->remove_order == order) {
1230                 if (dai->driver->remove) {
1231                         err = dai->driver->remove(dai);
1232                         if (err < 0)
1233                                 dev_err(dai->dev,
1234                                         "ASoC: failed to remove %s: %d\n",
1235                                         dai->name, err);
1236                 }
1237                 dai->probed = 0;
1238         }
1239 }
1240
1241 static void soc_remove_link_dais(struct snd_soc_card *card,
1242                 struct snd_soc_pcm_runtime *rtd, int order)
1243 {
1244         int i;
1245
1246         /* unregister the rtd device */
1247         if (rtd->dev_registered) {
1248                 device_unregister(rtd->dev);
1249                 rtd->dev_registered = 0;
1250         }
1251
1252         /* remove the CODEC DAI */
1253         for (i = 0; i < rtd->num_codecs; i++)
1254                 soc_remove_dai(rtd->codec_dais[i], order);
1255
1256         soc_remove_dai(rtd->cpu_dai, order);
1257 }
1258
1259 static void soc_remove_link_components(struct snd_soc_card *card,
1260         struct snd_soc_pcm_runtime *rtd, int order)
1261 {
1262         struct snd_soc_component *component;
1263         struct snd_soc_rtdcom_list *rtdcom;
1264
1265         for_each_rtdcom(rtd, rtdcom) {
1266                 component = rtdcom->component;
1267
1268                 if (component->driver->remove_order == order)
1269                         soc_remove_component(component);
1270         }
1271 }
1272
1273 static void soc_remove_dai_links(struct snd_soc_card *card)
1274 {
1275         int order;
1276         struct snd_soc_pcm_runtime *rtd;
1277         struct snd_soc_dai_link *link, *_link;
1278
1279         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1280                         order++) {
1281                 list_for_each_entry(rtd, &card->rtd_list, list)
1282                         soc_remove_link_dais(card, rtd, order);
1283         }
1284
1285         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1286                         order++) {
1287                 list_for_each_entry(rtd, &card->rtd_list, list)
1288                         soc_remove_link_components(card, rtd, order);
1289         }
1290
1291         list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1292                 if (link->dobj.type == SND_SOC_DOBJ_DAI_LINK)
1293                         dev_warn(card->dev, "Topology forgot to remove link %s?\n",
1294                                 link->name);
1295
1296                 list_del(&link->list);
1297                 card->num_dai_links--;
1298         }
1299 }
1300
1301 static int snd_soc_init_multicodec(struct snd_soc_card *card,
1302                                    struct snd_soc_dai_link *dai_link)
1303 {
1304         /* Legacy codec/codec_dai link is a single entry in multicodec */
1305         if (dai_link->codec_name || dai_link->codec_of_node ||
1306             dai_link->codec_dai_name) {
1307                 dai_link->num_codecs = 1;
1308
1309                 dai_link->codecs = devm_kzalloc(card->dev,
1310                                 sizeof(struct snd_soc_dai_link_component),
1311                                 GFP_KERNEL);
1312                 if (!dai_link->codecs)
1313                         return -ENOMEM;
1314
1315                 dai_link->codecs[0].name = dai_link->codec_name;
1316                 dai_link->codecs[0].of_node = dai_link->codec_of_node;
1317                 dai_link->codecs[0].dai_name = dai_link->codec_dai_name;
1318         }
1319
1320         if (!dai_link->codecs) {
1321                 dev_err(card->dev, "ASoC: DAI link has no CODECs\n");
1322                 return -EINVAL;
1323         }
1324
1325         return 0;
1326 }
1327
1328 static int soc_init_dai_link(struct snd_soc_card *card,
1329                                    struct snd_soc_dai_link *link)
1330 {
1331         int i, ret;
1332
1333         ret = snd_soc_init_multicodec(card, link);
1334         if (ret) {
1335                 dev_err(card->dev, "ASoC: failed to init multicodec\n");
1336                 return ret;
1337         }
1338
1339         for (i = 0; i < link->num_codecs; i++) {
1340                 /*
1341                  * Codec must be specified by 1 of name or OF node,
1342                  * not both or neither.
1343                  */
1344                 if (!!link->codecs[i].name ==
1345                     !!link->codecs[i].of_node) {
1346                         dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
1347                                 link->name);
1348                         return -EINVAL;
1349                 }
1350                 /* Codec DAI name must be specified */
1351                 if (!link->codecs[i].dai_name) {
1352                         dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
1353                                 link->name);
1354                         return -EINVAL;
1355                 }
1356         }
1357
1358         /*
1359          * Platform may be specified by either name or OF node, but
1360          * can be left unspecified, and a dummy platform will be used.
1361          */
1362         if (link->platform_name && link->platform_of_node) {
1363                 dev_err(card->dev,
1364                         "ASoC: Both platform name/of_node are set for %s\n",
1365                         link->name);
1366                 return -EINVAL;
1367         }
1368
1369         /*
1370          * CPU device may be specified by either name or OF node, but
1371          * can be left unspecified, and will be matched based on DAI
1372          * name alone..
1373          */
1374         if (link->cpu_name && link->cpu_of_node) {
1375                 dev_err(card->dev,
1376                         "ASoC: Neither/both cpu name/of_node are set for %s\n",
1377                         link->name);
1378                 return -EINVAL;
1379         }
1380         /*
1381          * At least one of CPU DAI name or CPU device name/node must be
1382          * specified
1383          */
1384         if (!link->cpu_dai_name &&
1385             !(link->cpu_name || link->cpu_of_node)) {
1386                 dev_err(card->dev,
1387                         "ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1388                         link->name);
1389                 return -EINVAL;
1390         }
1391
1392         return 0;
1393 }
1394
1395 void snd_soc_disconnect_sync(struct device *dev)
1396 {
1397         struct snd_soc_component *component = snd_soc_lookup_component(dev, NULL);
1398
1399         if (!component || !component->card)
1400                 return;
1401
1402         snd_card_disconnect_sync(component->card->snd_card);
1403 }
1404 EXPORT_SYMBOL_GPL(snd_soc_disconnect_sync);
1405
1406 /**
1407  * snd_soc_add_dai_link - Add a DAI link dynamically
1408  * @card: The ASoC card to which the DAI link is added
1409  * @dai_link: The new DAI link to add
1410  *
1411  * This function adds a DAI link to the ASoC card's link list.
1412  *
1413  * Note: Topology can use this API to add DAI links when probing the
1414  * topology component. And machine drivers can still define static
1415  * DAI links in dai_link array.
1416  */
1417 int snd_soc_add_dai_link(struct snd_soc_card *card,
1418                 struct snd_soc_dai_link *dai_link)
1419 {
1420         if (dai_link->dobj.type
1421             && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1422                 dev_err(card->dev, "Invalid dai link type %d\n",
1423                         dai_link->dobj.type);
1424                 return -EINVAL;
1425         }
1426
1427         lockdep_assert_held(&client_mutex);
1428         /* Notify the machine driver for extra initialization
1429          * on the link created by topology.
1430          */
1431         if (dai_link->dobj.type && card->add_dai_link)
1432                 card->add_dai_link(card, dai_link);
1433
1434         list_add_tail(&dai_link->list, &card->dai_link_list);
1435         card->num_dai_links++;
1436
1437         return 0;
1438 }
1439 EXPORT_SYMBOL_GPL(snd_soc_add_dai_link);
1440
1441 /**
1442  * snd_soc_remove_dai_link - Remove a DAI link from the list
1443  * @card: The ASoC card that owns the link
1444  * @dai_link: The DAI link to remove
1445  *
1446  * This function removes a DAI link from the ASoC card's link list.
1447  *
1448  * For DAI links previously added by topology, topology should
1449  * remove them by using the dobj embedded in the link.
1450  */
1451 void snd_soc_remove_dai_link(struct snd_soc_card *card,
1452                              struct snd_soc_dai_link *dai_link)
1453 {
1454         struct snd_soc_dai_link *link, *_link;
1455
1456         if (dai_link->dobj.type
1457             && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1458                 dev_err(card->dev, "Invalid dai link type %d\n",
1459                         dai_link->dobj.type);
1460                 return;
1461         }
1462
1463         lockdep_assert_held(&client_mutex);
1464         /* Notify the machine driver for extra destruction
1465          * on the link created by topology.
1466          */
1467         if (dai_link->dobj.type && card->remove_dai_link)
1468                 card->remove_dai_link(card, dai_link);
1469
1470         list_for_each_entry_safe(link, _link, &card->dai_link_list, list) {
1471                 if (link == dai_link) {
1472                         list_del(&link->list);
1473                         card->num_dai_links--;
1474                         return;
1475                 }
1476         }
1477 }
1478 EXPORT_SYMBOL_GPL(snd_soc_remove_dai_link);
1479
1480 static void soc_set_name_prefix(struct snd_soc_card *card,
1481                                 struct snd_soc_component *component)
1482 {
1483         int i;
1484
1485         if (card->codec_conf == NULL)
1486                 return;
1487
1488         for (i = 0; i < card->num_configs; i++) {
1489                 struct snd_soc_codec_conf *map = &card->codec_conf[i];
1490                 if (map->of_node && component->dev->of_node != map->of_node)
1491                         continue;
1492                 if (map->dev_name && strcmp(component->name, map->dev_name))
1493                         continue;
1494                 component->name_prefix = map->name_prefix;
1495                 break;
1496         }
1497 }
1498
1499 static int soc_probe_component(struct snd_soc_card *card,
1500         struct snd_soc_component *component)
1501 {
1502         struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
1503         struct snd_soc_dai *dai;
1504         int ret;
1505
1506         if (!strcmp(component->name, "snd-soc-dummy"))
1507                 return 0;
1508
1509         if (component->card) {
1510                 if (component->card != card) {
1511                         dev_err(component->dev,
1512                                 "Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1513                                 card->name, component->card->name);
1514                         return -ENODEV;
1515                 }
1516                 return 0;
1517         }
1518
1519         if (!try_module_get(component->dev->driver->owner))
1520                 return -ENODEV;
1521
1522         component->card = card;
1523         dapm->card = card;
1524         soc_set_name_prefix(card, component);
1525
1526         soc_init_component_debugfs(component);
1527
1528         if (component->driver->dapm_widgets) {
1529                 ret = snd_soc_dapm_new_controls(dapm,
1530                                         component->driver->dapm_widgets,
1531                                         component->driver->num_dapm_widgets);
1532
1533                 if (ret != 0) {
1534                         dev_err(component->dev,
1535                                 "Failed to create new controls %d\n", ret);
1536                         goto err_probe;
1537                 }
1538         }
1539
1540         list_for_each_entry(dai, &component->dai_list, list) {
1541                 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1542                 if (ret != 0) {
1543                         dev_err(component->dev,
1544                                 "Failed to create DAI widgets %d\n", ret);
1545                         goto err_probe;
1546                 }
1547         }
1548
1549         if (component->probe) {
1550                 ret = component->probe(component);
1551                 if (ret < 0) {
1552                         dev_err(component->dev,
1553                                 "ASoC: failed to probe component %d\n", ret);
1554                         goto err_probe;
1555                 }
1556
1557                 WARN(dapm->idle_bias_off &&
1558                         dapm->bias_level != SND_SOC_BIAS_OFF,
1559                         "codec %s can not start from non-off bias with idle_bias_off==1\n",
1560                         component->name);
1561         }
1562
1563         /* machine specific init */
1564         if (component->init) {
1565                 ret = component->init(component);
1566                 if (ret < 0) {
1567                         dev_err(component->dev,
1568                                 "Failed to do machine specific init %d\n", ret);
1569                         goto err_probe;
1570                 }
1571         }
1572
1573         if (component->driver->controls)
1574                 snd_soc_add_component_controls(component,
1575                                                component->driver->controls,
1576                                                component->driver->num_controls);
1577         if (component->driver->dapm_routes)
1578                 snd_soc_dapm_add_routes(dapm,
1579                                         component->driver->dapm_routes,
1580                                         component->driver->num_dapm_routes);
1581
1582         list_add(&dapm->list, &card->dapm_list);
1583         list_add(&component->card_list, &card->component_dev_list);
1584
1585         return 0;
1586
1587 err_probe:
1588         soc_cleanup_component_debugfs(component);
1589         component->card = NULL;
1590         module_put(component->dev->driver->owner);
1591
1592         return ret;
1593 }
1594
1595 static void rtd_release(struct device *dev)
1596 {
1597         kfree(dev);
1598 }
1599
1600 static int soc_post_component_init(struct snd_soc_pcm_runtime *rtd,
1601         const char *name)
1602 {
1603         int ret = 0;
1604
1605         /* register the rtd device */
1606         rtd->dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1607         if (!rtd->dev)
1608                 return -ENOMEM;
1609         device_initialize(rtd->dev);
1610         rtd->dev->parent = rtd->card->dev;
1611         rtd->dev->release = rtd_release;
1612         rtd->dev->groups = soc_dev_attr_groups;
1613         dev_set_name(rtd->dev, "%s", name);
1614         dev_set_drvdata(rtd->dev, rtd);
1615         mutex_init(&rtd->pcm_mutex);
1616         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
1617         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
1618         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
1619         INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
1620         ret = device_add(rtd->dev);
1621         if (ret < 0) {
1622                 /* calling put_device() here to free the rtd->dev */
1623                 put_device(rtd->dev);
1624                 dev_err(rtd->card->dev,
1625                         "ASoC: failed to register runtime device: %d\n", ret);
1626                 return ret;
1627         }
1628         rtd->dev_registered = 1;
1629         return 0;
1630 }
1631
1632 static int soc_probe_link_components(struct snd_soc_card *card,
1633                         struct snd_soc_pcm_runtime *rtd,
1634                                      int order)
1635 {
1636         struct snd_soc_component *component;
1637         struct snd_soc_rtdcom_list *rtdcom;
1638         int ret;
1639
1640         for_each_rtdcom(rtd, rtdcom) {
1641                 component = rtdcom->component;
1642
1643                 if (component->driver->probe_order == order) {
1644                         ret = soc_probe_component(card, component);
1645                         if (ret < 0)
1646                                 return ret;
1647                 }
1648         }
1649
1650         return 0;
1651 }
1652
1653 static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1654 {
1655         int ret;
1656
1657         if (!dai->probed && dai->driver->probe_order == order) {
1658                 if (dai->driver->probe) {
1659                         ret = dai->driver->probe(dai);
1660                         if (ret < 0) {
1661                                 dev_err(dai->dev,
1662                                         "ASoC: failed to probe DAI %s: %d\n",
1663                                         dai->name, ret);
1664                                 return ret;
1665                         }
1666                 }
1667
1668                 dai->probed = 1;
1669         }
1670
1671         return 0;
1672 }
1673
1674 static int soc_link_dai_pcm_new(struct snd_soc_dai **dais, int num_dais,
1675                                 struct snd_soc_pcm_runtime *rtd)
1676 {
1677         int i, ret = 0;
1678
1679         for (i = 0; i < num_dais; ++i) {
1680                 struct snd_soc_dai_driver *drv = dais[i]->driver;
1681
1682                 if (!rtd->dai_link->no_pcm && drv->pcm_new)
1683                         ret = drv->pcm_new(rtd, dais[i]);
1684                 if (ret < 0) {
1685                         dev_err(dais[i]->dev,
1686                                 "ASoC: Failed to bind %s with pcm device\n",
1687                                 dais[i]->name);
1688                         return ret;
1689                 }
1690         }
1691
1692         return 0;
1693 }
1694
1695 static int soc_link_dai_widgets(struct snd_soc_card *card,
1696                                 struct snd_soc_dai_link *dai_link,
1697                                 struct snd_soc_pcm_runtime *rtd)
1698 {
1699         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1700         struct snd_soc_dai *codec_dai = rtd->codec_dai;
1701         struct snd_soc_dapm_widget *sink, *source;
1702         int ret;
1703
1704         if (rtd->num_codecs > 1)
1705                 dev_warn(card->dev, "ASoC: Multiple codecs not supported yet\n");
1706
1707         /* link the DAI widgets */
1708         sink = codec_dai->playback_widget;
1709         source = cpu_dai->capture_widget;
1710         if (sink && source) {
1711                 ret = snd_soc_dapm_new_pcm(card, dai_link->params,
1712                                            dai_link->num_params,
1713                                            source, sink);
1714                 if (ret != 0) {
1715                         dev_err(card->dev, "ASoC: Can't link %s to %s: %d\n",
1716                                 sink->name, source->name, ret);
1717                         return ret;
1718                 }
1719         }
1720
1721         sink = cpu_dai->playback_widget;
1722         source = codec_dai->capture_widget;
1723         if (sink && source) {
1724                 ret = snd_soc_dapm_new_pcm(card, dai_link->params,
1725                                            dai_link->num_params,
1726                                            source, sink);
1727                 if (ret != 0) {
1728                         dev_err(card->dev, "ASoC: Can't link %s to %s: %d\n",
1729                                 sink->name, source->name, ret);
1730                         return ret;
1731                 }
1732         }
1733
1734         return 0;
1735 }
1736
1737 static int soc_probe_link_dais(struct snd_soc_card *card,
1738                 struct snd_soc_pcm_runtime *rtd, int order)
1739 {
1740         struct snd_soc_dai_link *dai_link = rtd->dai_link;
1741         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1742         int i, ret;
1743
1744         dev_dbg(card->dev, "ASoC: probe %s dai link %d late %d\n",
1745                         card->name, rtd->num, order);
1746
1747         /* set default power off timeout */
1748         rtd->pmdown_time = pmdown_time;
1749
1750         ret = soc_probe_dai(cpu_dai, order);
1751         if (ret)
1752                 return ret;
1753
1754         /* probe the CODEC DAI */
1755         for (i = 0; i < rtd->num_codecs; i++) {
1756                 ret = soc_probe_dai(rtd->codec_dais[i], order);
1757                 if (ret)
1758                         return ret;
1759         }
1760
1761         /* complete DAI probe during last probe */
1762         if (order != SND_SOC_COMP_ORDER_LAST)
1763                 return 0;
1764
1765         /* do machine specific initialization */
1766         if (dai_link->init) {
1767                 ret = dai_link->init(rtd);
1768                 if (ret < 0) {
1769                         dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1770                                 dai_link->name, ret);
1771                         return ret;
1772                 }
1773         }
1774
1775         if (dai_link->dai_fmt)
1776                 snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1777
1778         ret = soc_post_component_init(rtd, dai_link->name);
1779         if (ret)
1780                 return ret;
1781
1782 #ifdef CONFIG_DEBUG_FS
1783         /* add DPCM sysfs entries */
1784         if (dai_link->dynamic)
1785                 soc_dpcm_debugfs_add(rtd);
1786 #endif
1787
1788         if (cpu_dai->driver->compress_new) {
1789                 /*create compress_device"*/
1790                 ret = cpu_dai->driver->compress_new(rtd, rtd->num);
1791                 if (ret < 0) {
1792                         dev_err(card->dev, "ASoC: can't create compress %s\n",
1793                                          dai_link->stream_name);
1794                         return ret;
1795                 }
1796         } else {
1797
1798                 if (!dai_link->params) {
1799                         /* create the pcm */
1800                         ret = soc_new_pcm(rtd, rtd->num);
1801                         if (ret < 0) {
1802                                 dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1803                                        dai_link->stream_name, ret);
1804                                 return ret;
1805                         }
1806                         ret = soc_link_dai_pcm_new(&cpu_dai, 1, rtd);
1807                         if (ret < 0)
1808                                 return ret;
1809                         ret = soc_link_dai_pcm_new(rtd->codec_dais,
1810                                                    rtd->num_codecs, rtd);
1811                         if (ret < 0)
1812                                 return ret;
1813                 } else {
1814                         INIT_DELAYED_WORK(&rtd->delayed_work,
1815                                                 codec2codec_close_delayed_work);
1816
1817                         /* link the DAI widgets */
1818                         ret = soc_link_dai_widgets(card, dai_link, rtd);
1819                         if (ret)
1820                                 return ret;
1821                 }
1822         }
1823
1824         return 0;
1825 }
1826
1827 static int soc_bind_aux_dev(struct snd_soc_card *card, int num)
1828 {
1829         struct snd_soc_aux_dev *aux_dev = &card->aux_dev[num];
1830         struct snd_soc_component *component;
1831         const char *name;
1832         struct device_node *codec_of_node;
1833
1834         if (aux_dev->codec_of_node || aux_dev->codec_name) {
1835                 /* codecs, usually analog devices */
1836                 name = aux_dev->codec_name;
1837                 codec_of_node = aux_dev->codec_of_node;
1838                 component = soc_find_component(codec_of_node, name);
1839                 if (!component) {
1840                         if (codec_of_node)
1841                                 name = of_node_full_name(codec_of_node);
1842                         goto err_defer;
1843                 }
1844         } else if (aux_dev->name) {
1845                 /* generic components */
1846                 name = aux_dev->name;
1847                 component = soc_find_component(NULL, name);
1848                 if (!component)
1849                         goto err_defer;
1850         } else {
1851                 dev_err(card->dev, "ASoC: Invalid auxiliary device\n");
1852                 return -EINVAL;
1853         }
1854
1855         component->init = aux_dev->init;
1856         list_add(&component->card_aux_list, &card->aux_comp_list);
1857
1858         return 0;
1859
1860 err_defer:
1861         dev_err(card->dev, "ASoC: %s not registered\n", name);
1862         return -EPROBE_DEFER;
1863 }
1864
1865 static int soc_probe_aux_devices(struct snd_soc_card *card)
1866 {
1867         struct snd_soc_component *comp;
1868         int order;
1869         int ret;
1870
1871         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1872                 order++) {
1873                 list_for_each_entry(comp, &card->aux_comp_list, card_aux_list) {
1874                         if (comp->driver->probe_order == order) {
1875                                 ret = soc_probe_component(card, comp);
1876                                 if (ret < 0) {
1877                                         dev_err(card->dev,
1878                                                 "ASoC: failed to probe aux component %s %d\n",
1879                                                 comp->name, ret);
1880                                         return ret;
1881                                 }
1882                         }
1883                 }
1884         }
1885
1886         return 0;
1887 }
1888
1889 static void soc_remove_aux_devices(struct snd_soc_card *card)
1890 {
1891         struct snd_soc_component *comp, *_comp;
1892         int order;
1893
1894         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
1895                 order++) {
1896                 list_for_each_entry_safe(comp, _comp,
1897                         &card->aux_comp_list, card_aux_list) {
1898
1899                         if (comp->driver->remove_order == order) {
1900                                 soc_remove_component(comp);
1901                                 /* remove it from the card's aux_comp_list */
1902                                 list_del(&comp->card_aux_list);
1903                         }
1904                 }
1905         }
1906 }
1907
1908 static int snd_soc_init_codec_cache(struct snd_soc_codec *codec)
1909 {
1910         int ret;
1911
1912         if (codec->cache_init)
1913                 return 0;
1914
1915         ret = snd_soc_cache_init(codec);
1916         if (ret < 0) {
1917                 dev_err(codec->dev,
1918                         "ASoC: Failed to set cache compression type: %d\n",
1919                         ret);
1920                 return ret;
1921         }
1922         codec->cache_init = 1;
1923         return 0;
1924 }
1925
1926 /**
1927  * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1928  * @rtd: The runtime for which the DAI link format should be changed
1929  * @dai_fmt: The new DAI link format
1930  *
1931  * This function updates the DAI link format for all DAIs connected to the DAI
1932  * link for the specified runtime.
1933  *
1934  * Note: For setups with a static format set the dai_fmt field in the
1935  * corresponding snd_dai_link struct instead of using this function.
1936  *
1937  * Returns 0 on success, otherwise a negative error code.
1938  */
1939 int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1940         unsigned int dai_fmt)
1941 {
1942         struct snd_soc_dai **codec_dais = rtd->codec_dais;
1943         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1944         unsigned int i;
1945         int ret;
1946
1947         for (i = 0; i < rtd->num_codecs; i++) {
1948                 struct snd_soc_dai *codec_dai = codec_dais[i];
1949
1950                 ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1951                 if (ret != 0 && ret != -ENOTSUPP) {
1952                         dev_warn(codec_dai->dev,
1953                                  "ASoC: Failed to set DAI format: %d\n", ret);
1954                         return ret;
1955                 }
1956         }
1957
1958         /* Flip the polarity for the "CPU" end of a CODEC<->CODEC link */
1959         /* the component which has non_legacy_dai_naming is Codec */
1960         if (cpu_dai->codec ||
1961             cpu_dai->component->driver->non_legacy_dai_naming) {
1962                 unsigned int inv_dai_fmt;
1963
1964                 inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1965                 switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1966                 case SND_SOC_DAIFMT_CBM_CFM:
1967                         inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1968                         break;
1969                 case SND_SOC_DAIFMT_CBM_CFS:
1970                         inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1971                         break;
1972                 case SND_SOC_DAIFMT_CBS_CFM:
1973                         inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1974                         break;
1975                 case SND_SOC_DAIFMT_CBS_CFS:
1976                         inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1977                         break;
1978                 }
1979
1980                 dai_fmt = inv_dai_fmt;
1981         }
1982
1983         ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1984         if (ret != 0 && ret != -ENOTSUPP) {
1985                 dev_warn(cpu_dai->dev,
1986                          "ASoC: Failed to set DAI format: %d\n", ret);
1987                 return ret;
1988         }
1989
1990         return 0;
1991 }
1992 EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1993
1994
1995 #ifdef CONFIG_DMI
1996 /* Trim special characters, and replace '-' with '_' since '-' is used to
1997  * separate different DMI fields in the card long name. Only number and
1998  * alphabet characters and a few separator characters are kept.
1999  */
2000 static void cleanup_dmi_name(char *name)
2001 {
2002         int i, j = 0;
2003
2004         for (i = 0; name[i]; i++) {
2005                 if (isalnum(name[i]) || (name[i] == '.')
2006                     || (name[i] == '_'))
2007                         name[j++] = name[i];
2008                 else if (name[i] == '-')
2009                         name[j++] = '_';
2010         }
2011
2012         name[j] = '\0';
2013 }
2014
2015 /* Check if a DMI field is valid, i.e. not containing any string
2016  * in the black list.
2017  */
2018 static int is_dmi_valid(const char *field)
2019 {
2020         int i = 0;
2021
2022         while (dmi_blacklist[i]) {
2023                 if (strstr(field, dmi_blacklist[i]))
2024                         return 0;
2025                 i++;
2026         }
2027
2028         return 1;
2029 }
2030
2031 /**
2032  * snd_soc_set_dmi_name() - Register DMI names to card
2033  * @card: The card to register DMI names
2034  * @flavour: The flavour "differentiator" for the card amongst its peers.
2035  *
2036  * An Intel machine driver may be used by many different devices but are
2037  * difficult for userspace to differentiate, since machine drivers ususally
2038  * use their own name as the card short name and leave the card long name
2039  * blank. To differentiate such devices and fix bugs due to lack of
2040  * device-specific configurations, this function allows DMI info to be used
2041  * as the sound card long name, in the format of
2042  * "vendor-product-version-board"
2043  * (Character '-' is used to separate different DMI fields here).
2044  * This will help the user space to load the device-specific Use Case Manager
2045  * (UCM) configurations for the card.
2046  *
2047  * Possible card long names may be:
2048  * DellInc.-XPS139343-01-0310JH
2049  * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
2050  * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
2051  *
2052  * This function also supports flavoring the card longname to provide
2053  * the extra differentiation, like "vendor-product-version-board-flavor".
2054  *
2055  * We only keep number and alphabet characters and a few separator characters
2056  * in the card long name since UCM in the user space uses the card long names
2057  * as card configuration directory names and AudoConf cannot support special
2058  * charactors like SPACE.
2059  *
2060  * Returns 0 on success, otherwise a negative error code.
2061  */
2062 int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
2063 {
2064         const char *vendor, *product, *product_version, *board;
2065         size_t longname_buf_size = sizeof(card->snd_card->longname);
2066         size_t len;
2067
2068         if (card->long_name)
2069                 return 0; /* long name already set by driver or from DMI */
2070
2071         /* make up dmi long name as: vendor.product.version.board */
2072         vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
2073         if (!vendor || !is_dmi_valid(vendor)) {
2074                 dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
2075                 return 0;
2076         }
2077
2078
2079         snprintf(card->dmi_longname, sizeof(card->snd_card->longname),
2080                          "%s", vendor);
2081         cleanup_dmi_name(card->dmi_longname);
2082
2083         product = dmi_get_system_info(DMI_PRODUCT_NAME);
2084         if (product && is_dmi_valid(product)) {
2085                 len = strlen(card->dmi_longname);
2086                 snprintf(card->dmi_longname + len,
2087                          longname_buf_size - len,
2088                          "-%s", product);
2089
2090                 len++;  /* skip the separator "-" */
2091                 if (len < longname_buf_size)
2092                         cleanup_dmi_name(card->dmi_longname + len);
2093
2094                 /* some vendors like Lenovo may only put a self-explanatory
2095                  * name in the product version field
2096                  */
2097                 product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
2098                 if (product_version && is_dmi_valid(product_version)) {
2099                         len = strlen(card->dmi_longname);
2100                         snprintf(card->dmi_longname + len,
2101                                  longname_buf_size - len,
2102                                  "-%s", product_version);
2103
2104                         len++;
2105                         if (len < longname_buf_size)
2106                                 cleanup_dmi_name(card->dmi_longname + len);
2107                 }
2108         }
2109
2110         board = dmi_get_system_info(DMI_BOARD_NAME);
2111         if (board && is_dmi_valid(board)) {
2112                 len = strlen(card->dmi_longname);
2113                 snprintf(card->dmi_longname + len,
2114                          longname_buf_size - len,
2115                          "-%s", board);
2116
2117                 len++;
2118                 if (len < longname_buf_size)
2119                         cleanup_dmi_name(card->dmi_longname + len);
2120         } else if (!product) {
2121                 /* fall back to using legacy name */
2122                 dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
2123                 return 0;
2124         }
2125
2126         /* Add flavour to dmi long name */
2127         if (flavour) {
2128                 len = strlen(card->dmi_longname);
2129                 snprintf(card->dmi_longname + len,
2130                          longname_buf_size - len,
2131                          "-%s", flavour);
2132
2133                 len++;
2134                 if (len < longname_buf_size)
2135                         cleanup_dmi_name(card->dmi_longname + len);
2136         }
2137
2138         /* set the card long name */
2139         card->long_name = card->dmi_longname;
2140
2141         return 0;
2142 }
2143 EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
2144 #endif /* CONFIG_DMI */
2145
2146 static int snd_soc_instantiate_card(struct snd_soc_card *card)
2147 {
2148         struct snd_soc_codec *codec;
2149         struct snd_soc_pcm_runtime *rtd;
2150         struct snd_soc_dai_link *dai_link;
2151         int ret, i, order;
2152
2153         mutex_lock(&client_mutex);
2154         mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
2155
2156         /* bind DAIs */
2157         for (i = 0; i < card->num_links; i++) {
2158                 ret = soc_bind_dai_link(card, &card->dai_link[i]);
2159                 if (ret != 0)
2160                         goto base_error;
2161         }
2162
2163         /* bind aux_devs too */
2164         for (i = 0; i < card->num_aux_devs; i++) {
2165                 ret = soc_bind_aux_dev(card, i);
2166                 if (ret != 0)
2167                         goto base_error;
2168         }
2169
2170         /* add predefined DAI links to the list */
2171         for (i = 0; i < card->num_links; i++)
2172                 snd_soc_add_dai_link(card, card->dai_link+i);
2173
2174         /* initialize the register cache for each available codec */
2175         list_for_each_entry(codec, &codec_list, list) {
2176                 if (codec->cache_init)
2177                         continue;
2178                 ret = snd_soc_init_codec_cache(codec);
2179                 if (ret < 0)
2180                         goto base_error;
2181         }
2182
2183         /* card bind complete so register a sound card */
2184         ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2185                         card->owner, 0, &card->snd_card);
2186         if (ret < 0) {
2187                 dev_err(card->dev,
2188                         "ASoC: can't create sound card for card %s: %d\n",
2189                         card->name, ret);
2190                 goto base_error;
2191         }
2192
2193         soc_init_card_debugfs(card);
2194
2195         card->dapm.bias_level = SND_SOC_BIAS_OFF;
2196         card->dapm.dev = card->dev;
2197         card->dapm.card = card;
2198         list_add(&card->dapm.list, &card->dapm_list);
2199
2200 #ifdef CONFIG_DEBUG_FS
2201         snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
2202 #endif
2203
2204 #ifdef CONFIG_PM_SLEEP
2205         /* deferred resume work */
2206         INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
2207 #endif
2208
2209         if (card->dapm_widgets)
2210                 snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2211                                           card->num_dapm_widgets);
2212
2213         if (card->of_dapm_widgets)
2214                 snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2215                                           card->num_of_dapm_widgets);
2216
2217         /* initialise the sound card only once */
2218         if (card->probe) {
2219                 ret = card->probe(card);
2220                 if (ret < 0)
2221                         goto card_probe_error;
2222         }
2223
2224         /* probe all components used by DAI links on this card */
2225         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
2226                         order++) {
2227                 list_for_each_entry(rtd, &card->rtd_list, list) {
2228                         ret = soc_probe_link_components(card, rtd, order);
2229                         if (ret < 0) {
2230                                 dev_err(card->dev,
2231                                         "ASoC: failed to instantiate card %d\n",
2232                                         ret);
2233                                 goto probe_dai_err;
2234                         }
2235                 }
2236         }
2237
2238         /* probe auxiliary components */
2239         ret = soc_probe_aux_devices(card);
2240         if (ret < 0)
2241                 goto probe_dai_err;
2242
2243         /* Find new DAI links added during probing components and bind them.
2244          * Components with topology may bring new DAIs and DAI links.
2245          */
2246         list_for_each_entry(dai_link, &card->dai_link_list, list) {
2247                 if (soc_is_dai_link_bound(card, dai_link))
2248                         continue;
2249
2250                 ret = soc_init_dai_link(card, dai_link);
2251                 if (ret)
2252                         goto probe_dai_err;
2253                 ret = soc_bind_dai_link(card, dai_link);
2254                 if (ret)
2255                         goto probe_dai_err;
2256         }
2257
2258         /* probe all DAI links on this card */
2259         for (order = SND_SOC_COMP_ORDER_FIRST; order <= SND_SOC_COMP_ORDER_LAST;
2260                         order++) {
2261                 list_for_each_entry(rtd, &card->rtd_list, list) {
2262                         ret = soc_probe_link_dais(card, rtd, order);
2263                         if (ret < 0) {
2264                                 dev_err(card->dev,
2265                                         "ASoC: failed to instantiate card %d\n",
2266                                         ret);
2267                                 goto probe_dai_err;
2268                         }
2269                 }
2270         }
2271
2272         snd_soc_dapm_link_dai_widgets(card);
2273         snd_soc_dapm_connect_dai_link_widgets(card);
2274
2275         if (card->controls)
2276                 snd_soc_add_card_controls(card, card->controls, card->num_controls);
2277
2278         if (card->dapm_routes)
2279                 snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2280                                         card->num_dapm_routes);
2281
2282         if (card->of_dapm_routes)
2283                 snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2284                                         card->num_of_dapm_routes);
2285
2286         /* try to set some sane longname if DMI is available */
2287         snd_soc_set_dmi_name(card, NULL);
2288
2289         snprintf(card->snd_card->shortname, sizeof(card->snd_card->shortname),
2290                  "%s", card->name);
2291         snprintf(card->snd_card->longname, sizeof(card->snd_card->longname),
2292                  "%s", card->long_name ? card->long_name : card->name);
2293         snprintf(card->snd_card->driver, sizeof(card->snd_card->driver),
2294                  "%s", card->driver_name ? card->driver_name : card->name);
2295         for (i = 0; i < ARRAY_SIZE(card->snd_card->driver); i++) {
2296                 switch (card->snd_card->driver[i]) {
2297                 case '_':
2298                 case '-':
2299                 case '\0':
2300                         break;
2301                 default:
2302                         if (!isalnum(card->snd_card->driver[i]))
2303                                 card->snd_card->driver[i] = '_';
2304                         break;
2305                 }
2306         }
2307
2308         if (card->late_probe) {
2309                 ret = card->late_probe(card);
2310                 if (ret < 0) {
2311                         dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2312                                 card->name, ret);
2313                         goto probe_aux_dev_err;
2314                 }
2315         }
2316
2317         snd_soc_dapm_new_widgets(card);
2318
2319         ret = snd_card_register(card->snd_card);
2320         if (ret < 0) {
2321                 dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2322                                 ret);
2323                 goto probe_aux_dev_err;
2324         }
2325
2326         card->instantiated = 1;
2327         snd_soc_dapm_sync(&card->dapm);
2328         mutex_unlock(&card->mutex);
2329         mutex_unlock(&client_mutex);
2330
2331         return 0;
2332
2333 probe_aux_dev_err:
2334         soc_remove_aux_devices(card);
2335
2336 probe_dai_err:
2337         soc_remove_dai_links(card);
2338
2339 card_probe_error:
2340         if (card->remove)
2341                 card->remove(card);
2342
2343         snd_soc_dapm_free(&card->dapm);
2344         soc_cleanup_card_debugfs(card);
2345         snd_card_free(card->snd_card);
2346
2347 base_error:
2348         soc_remove_pcm_runtimes(card);
2349         mutex_unlock(&card->mutex);
2350         mutex_unlock(&client_mutex);
2351
2352         return ret;
2353 }
2354
2355 /* probes a new socdev */
2356 static int soc_probe(struct platform_device *pdev)
2357 {
2358         struct snd_soc_card *card = platform_get_drvdata(pdev);
2359
2360         /*
2361          * no card, so machine driver should be registering card
2362          * we should not be here in that case so ret error
2363          */
2364         if (!card)
2365                 return -EINVAL;
2366
2367         dev_warn(&pdev->dev,
2368                  "ASoC: machine %s should use snd_soc_register_card()\n",
2369                  card->name);
2370
2371         /* Bodge while we unpick instantiation */
2372         card->dev = &pdev->dev;
2373
2374         return snd_soc_register_card(card);
2375 }
2376
2377 static int soc_cleanup_card_resources(struct snd_soc_card *card)
2378 {
2379         struct snd_soc_pcm_runtime *rtd;
2380
2381         /* make sure any delayed work runs */
2382         list_for_each_entry(rtd, &card->rtd_list, list)
2383                 flush_delayed_work(&rtd->delayed_work);
2384
2385         /* free the ALSA card at first; this syncs with pending operations */
2386         snd_card_free(card->snd_card);
2387
2388         /* remove and free each DAI */
2389         soc_remove_dai_links(card);
2390         soc_remove_pcm_runtimes(card);
2391
2392         /* remove auxiliary devices */
2393         soc_remove_aux_devices(card);
2394
2395         snd_soc_dapm_free(&card->dapm);
2396         soc_cleanup_card_debugfs(card);
2397
2398         /* remove the card */
2399         if (card->remove)
2400                 card->remove(card);
2401
2402         return 0;
2403 }
2404
2405 /* removes a socdev */
2406 static int soc_remove(struct platform_device *pdev)
2407 {
2408         struct snd_soc_card *card = platform_get_drvdata(pdev);
2409
2410         snd_soc_unregister_card(card);
2411         return 0;
2412 }
2413
2414 int snd_soc_poweroff(struct device *dev)
2415 {
2416         struct snd_soc_card *card = dev_get_drvdata(dev);
2417         struct snd_soc_pcm_runtime *rtd;
2418
2419         if (!card->instantiated)
2420                 return 0;
2421
2422         /* Flush out pmdown_time work - we actually do want to run it
2423          * now, we're shutting down so no imminent restart. */
2424         list_for_each_entry(rtd, &card->rtd_list, list)
2425                 flush_delayed_work(&rtd->delayed_work);
2426
2427         snd_soc_dapm_shutdown(card);
2428
2429         /* deactivate pins to sleep state */
2430         list_for_each_entry(rtd, &card->rtd_list, list) {
2431                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2432                 int i;
2433
2434                 pinctrl_pm_select_sleep_state(cpu_dai->dev);
2435                 for (i = 0; i < rtd->num_codecs; i++) {
2436                         struct snd_soc_dai *codec_dai = rtd->codec_dais[i];
2437                         pinctrl_pm_select_sleep_state(codec_dai->dev);
2438                 }
2439         }
2440
2441         return 0;
2442 }
2443 EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2444
2445 const struct dev_pm_ops snd_soc_pm_ops = {
2446         .suspend = snd_soc_suspend,
2447         .resume = snd_soc_resume,
2448         .freeze = snd_soc_suspend,
2449         .thaw = snd_soc_resume,
2450         .poweroff = snd_soc_poweroff,
2451         .restore = snd_soc_resume,
2452 };
2453 EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2454
2455 /* ASoC platform driver */
2456 static struct platform_driver soc_driver = {
2457         .driver         = {
2458                 .name           = "soc-audio",
2459                 .pm             = &snd_soc_pm_ops,
2460         },
2461         .probe          = soc_probe,
2462         .remove         = soc_remove,
2463 };
2464
2465 /**
2466  * snd_soc_cnew - create new control
2467  * @_template: control template
2468  * @data: control private data
2469  * @long_name: control long name
2470  * @prefix: control name prefix
2471  *
2472  * Create a new mixer control from a template control.
2473  *
2474  * Returns 0 for success, else error.
2475  */
2476 struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2477                                   void *data, const char *long_name,
2478                                   const char *prefix)
2479 {
2480         struct snd_kcontrol_new template;
2481         struct snd_kcontrol *kcontrol;
2482         char *name = NULL;
2483
2484         memcpy(&template, _template, sizeof(template));
2485         template.index = 0;
2486
2487         if (!long_name)
2488                 long_name = template.name;
2489
2490         if (prefix) {
2491                 name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2492                 if (!name)
2493                         return NULL;
2494
2495                 template.name = name;
2496         } else {
2497                 template.name = long_name;
2498         }
2499
2500         kcontrol = snd_ctl_new1(&template, data);
2501
2502         kfree(name);
2503
2504         return kcontrol;
2505 }
2506 EXPORT_SYMBOL_GPL(snd_soc_cnew);
2507
2508 static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2509         const struct snd_kcontrol_new *controls, int num_controls,
2510         const char *prefix, void *data)
2511 {
2512         int err, i;
2513
2514         for (i = 0; i < num_controls; i++) {
2515                 const struct snd_kcontrol_new *control = &controls[i];
2516                 err = snd_ctl_add(card, snd_soc_cnew(control, data,
2517                                                      control->name, prefix));
2518                 if (err < 0) {
2519                         dev_err(dev, "ASoC: Failed to add %s: %d\n",
2520                                 control->name, err);
2521                         return err;
2522                 }
2523         }
2524
2525         return 0;
2526 }
2527
2528 struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2529                                                const char *name)
2530 {
2531         struct snd_card *card = soc_card->snd_card;
2532         struct snd_kcontrol *kctl;
2533
2534         if (unlikely(!name))
2535                 return NULL;
2536
2537         list_for_each_entry(kctl, &card->controls, list)
2538                 if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2539                         return kctl;
2540         return NULL;
2541 }
2542 EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2543
2544 /**
2545  * snd_soc_add_component_controls - Add an array of controls to a component.
2546  *
2547  * @component: Component to add controls to
2548  * @controls: Array of controls to add
2549  * @num_controls: Number of elements in the array
2550  *
2551  * Return: 0 for success, else error.
2552  */
2553 int snd_soc_add_component_controls(struct snd_soc_component *component,
2554         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2555 {
2556         struct snd_card *card = component->card->snd_card;
2557
2558         return snd_soc_add_controls(card, component->dev, controls,
2559                         num_controls, component->name_prefix, component);
2560 }
2561 EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2562
2563 /**
2564  * snd_soc_add_codec_controls - add an array of controls to a codec.
2565  * Convenience function to add a list of controls. Many codecs were
2566  * duplicating this code.
2567  *
2568  * @codec: codec to add controls to
2569  * @controls: array of controls to add
2570  * @num_controls: number of elements in the array
2571  *
2572  * Return 0 for success, else error.
2573  */
2574 int snd_soc_add_codec_controls(struct snd_soc_codec *codec,
2575         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2576 {
2577         return snd_soc_add_component_controls(&codec->component, controls,
2578                 num_controls);
2579 }
2580 EXPORT_SYMBOL_GPL(snd_soc_add_codec_controls);
2581
2582 /**
2583  * snd_soc_add_platform_controls - add an array of controls to a platform.
2584  * Convenience function to add a list of controls.
2585  *
2586  * @platform: platform to add controls to
2587  * @controls: array of controls to add
2588  * @num_controls: number of elements in the array
2589  *
2590  * Return 0 for success, else error.
2591  */
2592 int snd_soc_add_platform_controls(struct snd_soc_platform *platform,
2593         const struct snd_kcontrol_new *controls, unsigned int num_controls)
2594 {
2595         return snd_soc_add_component_controls(&platform->component, controls,
2596                 num_controls);
2597 }
2598 EXPORT_SYMBOL_GPL(snd_soc_add_platform_controls);
2599
2600 /**
2601  * snd_soc_add_card_controls - add an array of controls to a SoC card.
2602  * Convenience function to add a list of controls.
2603  *
2604  * @soc_card: SoC card to add controls to
2605  * @controls: array of controls to add
2606  * @num_controls: number of elements in the array
2607  *
2608  * Return 0 for success, else error.
2609  */
2610 int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2611         const struct snd_kcontrol_new *controls, int num_controls)
2612 {
2613         struct snd_card *card = soc_card->snd_card;
2614
2615         return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2616                         NULL, soc_card);
2617 }
2618 EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2619
2620 /**
2621  * snd_soc_add_dai_controls - add an array of controls to a DAI.
2622  * Convienience function to add a list of controls.
2623  *
2624  * @dai: DAI to add controls to
2625  * @controls: array of controls to add
2626  * @num_controls: number of elements in the array
2627  *
2628  * Return 0 for success, else error.
2629  */
2630 int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2631         const struct snd_kcontrol_new *controls, int num_controls)
2632 {
2633         struct snd_card *card = dai->component->card->snd_card;
2634
2635         return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2636                         NULL, dai);
2637 }
2638 EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2639
2640 /**
2641  * snd_soc_dai_set_sysclk - configure DAI system or master clock.
2642  * @dai: DAI
2643  * @clk_id: DAI specific clock ID
2644  * @freq: new clock frequency in Hz
2645  * @dir: new clock direction - input/output.
2646  *
2647  * Configures the DAI master (MCLK) or system (SYSCLK) clocking.
2648  */
2649 int snd_soc_dai_set_sysclk(struct snd_soc_dai *dai, int clk_id,
2650         unsigned int freq, int dir)
2651 {
2652         if (dai->driver->ops->set_sysclk)
2653                 return dai->driver->ops->set_sysclk(dai, clk_id, freq, dir);
2654
2655         return snd_soc_component_set_sysclk(dai->component, clk_id, 0,
2656                                             freq, dir);
2657 }
2658 EXPORT_SYMBOL_GPL(snd_soc_dai_set_sysclk);
2659
2660 /**
2661  * snd_soc_codec_set_sysclk - configure CODEC system or master clock.
2662  * @codec: CODEC
2663  * @clk_id: DAI specific clock ID
2664  * @source: Source for the clock
2665  * @freq: new clock frequency in Hz
2666  * @dir: new clock direction - input/output.
2667  *
2668  * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
2669  */
2670 int snd_soc_codec_set_sysclk(struct snd_soc_codec *codec, int clk_id,
2671                              int source, unsigned int freq, int dir)
2672 {
2673         if (codec->driver->set_sysclk)
2674                 return codec->driver->set_sysclk(codec, clk_id, source,
2675                                                  freq, dir);
2676         else
2677                 return -ENOTSUPP;
2678 }
2679 EXPORT_SYMBOL_GPL(snd_soc_codec_set_sysclk);
2680
2681 /**
2682  * snd_soc_component_set_sysclk - configure COMPONENT system or master clock.
2683  * @component: COMPONENT
2684  * @clk_id: DAI specific clock ID
2685  * @source: Source for the clock
2686  * @freq: new clock frequency in Hz
2687  * @dir: new clock direction - input/output.
2688  *
2689  * Configures the CODEC master (MCLK) or system (SYSCLK) clocking.
2690  */
2691 int snd_soc_component_set_sysclk(struct snd_soc_component *component, int clk_id,
2692                              int source, unsigned int freq, int dir)
2693 {
2694         /* will be removed */
2695         if (component->set_sysclk)
2696                 return component->set_sysclk(component, clk_id, source,
2697                                              freq, dir);
2698
2699         if (component->driver->set_sysclk)
2700                 return component->driver->set_sysclk(component, clk_id, source,
2701                                                  freq, dir);
2702
2703         return -ENOTSUPP;
2704 }
2705 EXPORT_SYMBOL_GPL(snd_soc_component_set_sysclk);
2706
2707 /**
2708  * snd_soc_dai_set_clkdiv - configure DAI clock dividers.
2709  * @dai: DAI
2710  * @div_id: DAI specific clock divider ID
2711  * @div: new clock divisor.
2712  *
2713  * Configures the clock dividers. This is used to derive the best DAI bit and
2714  * frame clocks from the system or master clock. It's best to set the DAI bit
2715  * and frame clocks as low as possible to save system power.
2716  */
2717 int snd_soc_dai_set_clkdiv(struct snd_soc_dai *dai,
2718         int div_id, int div)
2719 {
2720         if (dai->driver->ops->set_clkdiv)
2721                 return dai->driver->ops->set_clkdiv(dai, div_id, div);
2722         else
2723                 return -EINVAL;
2724 }
2725 EXPORT_SYMBOL_GPL(snd_soc_dai_set_clkdiv);
2726
2727 /**
2728  * snd_soc_dai_set_pll - configure DAI PLL.
2729  * @dai: DAI
2730  * @pll_id: DAI specific PLL ID
2731  * @source: DAI specific source for the PLL
2732  * @freq_in: PLL input clock frequency in Hz
2733  * @freq_out: requested PLL output clock frequency in Hz
2734  *
2735  * Configures and enables PLL to generate output clock based on input clock.
2736  */
2737 int snd_soc_dai_set_pll(struct snd_soc_dai *dai, int pll_id, int source,
2738         unsigned int freq_in, unsigned int freq_out)
2739 {
2740         if (dai->driver->ops->set_pll)
2741                 return dai->driver->ops->set_pll(dai, pll_id, source,
2742                                          freq_in, freq_out);
2743
2744         return snd_soc_component_set_pll(dai->component, pll_id, source,
2745                                          freq_in, freq_out);
2746 }
2747 EXPORT_SYMBOL_GPL(snd_soc_dai_set_pll);
2748
2749 /*
2750  * snd_soc_codec_set_pll - configure codec PLL.
2751  * @codec: CODEC
2752  * @pll_id: DAI specific PLL ID
2753  * @source: DAI specific source for the PLL
2754  * @freq_in: PLL input clock frequency in Hz
2755  * @freq_out: requested PLL output clock frequency in Hz
2756  *
2757  * Configures and enables PLL to generate output clock based on input clock.
2758  */
2759 int snd_soc_codec_set_pll(struct snd_soc_codec *codec, int pll_id, int source,
2760                           unsigned int freq_in, unsigned int freq_out)
2761 {
2762         if (codec->driver->set_pll)
2763                 return codec->driver->set_pll(codec, pll_id, source,
2764                                               freq_in, freq_out);
2765         else
2766                 return -EINVAL;
2767 }
2768 EXPORT_SYMBOL_GPL(snd_soc_codec_set_pll);
2769
2770 /*
2771  * snd_soc_component_set_pll - configure component PLL.
2772  * @component: COMPONENT
2773  * @pll_id: DAI specific PLL ID
2774  * @source: DAI specific source for the PLL
2775  * @freq_in: PLL input clock frequency in Hz
2776  * @freq_out: requested PLL output clock frequency in Hz
2777  *
2778  * Configures and enables PLL to generate output clock based on input clock.
2779  */
2780 int snd_soc_component_set_pll(struct snd_soc_component *component, int pll_id,
2781                               int source, unsigned int freq_in,
2782                               unsigned int freq_out)
2783 {
2784         /* will be removed */
2785         if (component->set_pll)
2786                 return component->set_pll(component, pll_id, source,
2787                                               freq_in, freq_out);
2788
2789         if (component->driver->set_pll)
2790                 return component->driver->set_pll(component, pll_id, source,
2791                                               freq_in, freq_out);
2792
2793         return -EINVAL;
2794 }
2795 EXPORT_SYMBOL_GPL(snd_soc_component_set_pll);
2796
2797 /**
2798  * snd_soc_dai_set_bclk_ratio - configure BCLK to sample rate ratio.
2799  * @dai: DAI
2800  * @ratio: Ratio of BCLK to Sample rate.
2801  *
2802  * Configures the DAI for a preset BCLK to sample rate ratio.
2803  */
2804 int snd_soc_dai_set_bclk_ratio(struct snd_soc_dai *dai, unsigned int ratio)
2805 {
2806         if (dai->driver->ops->set_bclk_ratio)
2807                 return dai->driver->ops->set_bclk_ratio(dai, ratio);
2808         else
2809                 return -EINVAL;
2810 }
2811 EXPORT_SYMBOL_GPL(snd_soc_dai_set_bclk_ratio);
2812
2813 /**
2814  * snd_soc_dai_set_fmt - configure DAI hardware audio format.
2815  * @dai: DAI
2816  * @fmt: SND_SOC_DAIFMT_* format value.
2817  *
2818  * Configures the DAI hardware format and clocking.
2819  */
2820 int snd_soc_dai_set_fmt(struct snd_soc_dai *dai, unsigned int fmt)
2821 {
2822         if (dai->driver == NULL)
2823                 return -EINVAL;
2824         if (dai->driver->ops->set_fmt == NULL)
2825                 return -ENOTSUPP;
2826         return dai->driver->ops->set_fmt(dai, fmt);
2827 }
2828 EXPORT_SYMBOL_GPL(snd_soc_dai_set_fmt);
2829
2830 /**
2831  * snd_soc_xlate_tdm_slot - generate tx/rx slot mask.
2832  * @slots: Number of slots in use.
2833  * @tx_mask: bitmask representing active TX slots.
2834  * @rx_mask: bitmask representing active RX slots.
2835  *
2836  * Generates the TDM tx and rx slot default masks for DAI.
2837  */
2838 static int snd_soc_xlate_tdm_slot_mask(unsigned int slots,
2839                                           unsigned int *tx_mask,
2840                                           unsigned int *rx_mask)
2841 {
2842         if (*tx_mask || *rx_mask)
2843                 return 0;
2844
2845         if (!slots)
2846                 return -EINVAL;
2847
2848         *tx_mask = (1 << slots) - 1;
2849         *rx_mask = (1 << slots) - 1;
2850
2851         return 0;
2852 }
2853
2854 /**
2855  * snd_soc_dai_set_tdm_slot() - Configures a DAI for TDM operation
2856  * @dai: The DAI to configure
2857  * @tx_mask: bitmask representing active TX slots.
2858  * @rx_mask: bitmask representing active RX slots.
2859  * @slots: Number of slots in use.
2860  * @slot_width: Width in bits for each slot.
2861  *
2862  * This function configures the specified DAI for TDM operation. @slot contains
2863  * the total number of slots of the TDM stream and @slot_with the width of each
2864  * slot in bit clock cycles. @tx_mask and @rx_mask are bitmasks specifying the
2865  * active slots of the TDM stream for the specified DAI, i.e. which slots the
2866  * DAI should write to or read from. If a bit is set the corresponding slot is
2867  * active, if a bit is cleared the corresponding slot is inactive. Bit 0 maps to
2868  * the first slot, bit 1 to the second slot and so on. The first active slot
2869  * maps to the first channel of the DAI, the second active slot to the second
2870  * channel and so on.
2871  *
2872  * TDM mode can be disabled by passing 0 for @slots. In this case @tx_mask,
2873  * @rx_mask and @slot_width will be ignored.
2874  *
2875  * Returns 0 on success, a negative error code otherwise.
2876  */
2877 int snd_soc_dai_set_tdm_slot(struct snd_soc_dai *dai,
2878         unsigned int tx_mask, unsigned int rx_mask, int slots, int slot_width)
2879 {
2880         if (dai->driver->ops->xlate_tdm_slot_mask)
2881                 dai->driver->ops->xlate_tdm_slot_mask(slots,
2882                                                 &tx_mask, &rx_mask);
2883         else
2884                 snd_soc_xlate_tdm_slot_mask(slots, &tx_mask, &rx_mask);
2885
2886         dai->tx_mask = tx_mask;
2887         dai->rx_mask = rx_mask;
2888
2889         if (dai->driver->ops->set_tdm_slot)
2890                 return dai->driver->ops->set_tdm_slot(dai, tx_mask, rx_mask,
2891                                 slots, slot_width);
2892         else
2893                 return -ENOTSUPP;
2894 }
2895 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tdm_slot);
2896
2897 /**
2898  * snd_soc_dai_set_channel_map - configure DAI audio channel map
2899  * @dai: DAI
2900  * @tx_num: how many TX channels
2901  * @tx_slot: pointer to an array which imply the TX slot number channel
2902  *           0~num-1 uses
2903  * @rx_num: how many RX channels
2904  * @rx_slot: pointer to an array which imply the RX slot number channel
2905  *           0~num-1 uses
2906  *
2907  * configure the relationship between channel number and TDM slot number.
2908  */
2909 int snd_soc_dai_set_channel_map(struct snd_soc_dai *dai,
2910         unsigned int tx_num, unsigned int *tx_slot,
2911         unsigned int rx_num, unsigned int *rx_slot)
2912 {
2913         if (dai->driver->ops->set_channel_map)
2914                 return dai->driver->ops->set_channel_map(dai, tx_num, tx_slot,
2915                         rx_num, rx_slot);
2916         else
2917                 return -EINVAL;
2918 }
2919 EXPORT_SYMBOL_GPL(snd_soc_dai_set_channel_map);
2920
2921 /**
2922  * snd_soc_dai_set_tristate - configure DAI system or master clock.
2923  * @dai: DAI
2924  * @tristate: tristate enable
2925  *
2926  * Tristates the DAI so that others can use it.
2927  */
2928 int snd_soc_dai_set_tristate(struct snd_soc_dai *dai, int tristate)
2929 {
2930         if (dai->driver->ops->set_tristate)
2931                 return dai->driver->ops->set_tristate(dai, tristate);
2932         else
2933                 return -EINVAL;
2934 }
2935 EXPORT_SYMBOL_GPL(snd_soc_dai_set_tristate);
2936
2937 /**
2938  * snd_soc_dai_digital_mute - configure DAI system or master clock.
2939  * @dai: DAI
2940  * @mute: mute enable
2941  * @direction: stream to mute
2942  *
2943  * Mutes the DAI DAC.
2944  */
2945 int snd_soc_dai_digital_mute(struct snd_soc_dai *dai, int mute,
2946                              int direction)
2947 {
2948         if (!dai->driver)
2949                 return -ENOTSUPP;
2950
2951         if (dai->driver->ops->mute_stream)
2952                 return dai->driver->ops->mute_stream(dai, mute, direction);
2953         else if (direction == SNDRV_PCM_STREAM_PLAYBACK &&
2954                  dai->driver->ops->digital_mute)
2955                 return dai->driver->ops->digital_mute(dai, mute);
2956         else
2957                 return -ENOTSUPP;
2958 }
2959 EXPORT_SYMBOL_GPL(snd_soc_dai_digital_mute);
2960
2961 /**
2962  * snd_soc_register_card - Register a card with the ASoC core
2963  *
2964  * @card: Card to register
2965  *
2966  */
2967 int snd_soc_register_card(struct snd_soc_card *card)
2968 {
2969         int i, ret;
2970         struct snd_soc_pcm_runtime *rtd;
2971
2972         if (!card->name || !card->dev)
2973                 return -EINVAL;
2974
2975         for (i = 0; i < card->num_links; i++) {
2976                 struct snd_soc_dai_link *link = &card->dai_link[i];
2977
2978                 ret = soc_init_dai_link(card, link);
2979                 if (ret) {
2980                         dev_err(card->dev, "ASoC: failed to init link %s\n",
2981                                 link->name);
2982                         return ret;
2983                 }
2984         }
2985
2986         dev_set_drvdata(card->dev, card);
2987
2988         snd_soc_initialize_card_lists(card);
2989
2990         INIT_LIST_HEAD(&card->dai_link_list);
2991         card->num_dai_links = 0;
2992
2993         INIT_LIST_HEAD(&card->rtd_list);
2994         card->num_rtd = 0;
2995
2996         INIT_LIST_HEAD(&card->dapm_dirty);
2997         INIT_LIST_HEAD(&card->dobj_list);
2998         card->instantiated = 0;
2999         mutex_init(&card->mutex);
3000         mutex_init(&card->dapm_mutex);
3001
3002         ret = snd_soc_instantiate_card(card);
3003         if (ret != 0)
3004                 return ret;
3005
3006         /* deactivate pins to sleep state */
3007         list_for_each_entry(rtd, &card->rtd_list, list)  {
3008                 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
3009                 int j;
3010
3011                 for (j = 0; j < rtd->num_codecs; j++) {
3012                         struct snd_soc_dai *codec_dai = rtd->codec_dais[j];
3013                         if (!codec_dai->active)
3014                                 pinctrl_pm_select_sleep_state(codec_dai->dev);
3015                 }
3016
3017                 if (!cpu_dai->active)
3018                         pinctrl_pm_select_sleep_state(cpu_dai->dev);
3019         }
3020
3021         return ret;
3022 }
3023 EXPORT_SYMBOL_GPL(snd_soc_register_card);
3024
3025 /**
3026  * snd_soc_unregister_card - Unregister a card with the ASoC core
3027  *
3028  * @card: Card to unregister
3029  *
3030  */
3031 int snd_soc_unregister_card(struct snd_soc_card *card)
3032 {
3033         if (card->instantiated) {
3034                 card->instantiated = false;
3035                 snd_soc_dapm_shutdown(card);
3036                 soc_cleanup_card_resources(card);
3037                 dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
3038         }
3039
3040         return 0;
3041 }
3042 EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
3043
3044 /*
3045  * Simplify DAI link configuration by removing ".-1" from device names
3046  * and sanitizing names.
3047  */
3048 static char *fmt_single_name(struct device *dev, int *id)
3049 {
3050         char *found, name[NAME_SIZE];
3051         int id1, id2;
3052
3053         if (dev_name(dev) == NULL)
3054                 return NULL;
3055
3056         strlcpy(name, dev_name(dev), NAME_SIZE);
3057
3058         /* are we a "%s.%d" name (platform and SPI components) */
3059         found = strstr(name, dev->driver->name);
3060         if (found) {
3061                 /* get ID */
3062                 if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
3063
3064                         /* discard ID from name if ID == -1 */
3065                         if (*id == -1)
3066                                 found[strlen(dev->driver->name)] = '\0';
3067                 }
3068
3069         } else {
3070                 /* I2C component devices are named "bus-addr"  */
3071                 if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
3072                         char tmp[NAME_SIZE];
3073
3074                         /* create unique ID number from I2C addr and bus */
3075                         *id = ((id1 & 0xffff) << 16) + id2;
3076
3077                         /* sanitize component name for DAI link creation */
3078                         snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name, name);
3079                         strlcpy(name, tmp, NAME_SIZE);
3080                 } else
3081                         *id = 0;
3082         }
3083
3084         return kstrdup(name, GFP_KERNEL);
3085 }
3086
3087 /*
3088  * Simplify DAI link naming for single devices with multiple DAIs by removing
3089  * any ".-1" and using the DAI name (instead of device name).
3090  */
3091 static inline char *fmt_multiple_name(struct device *dev,
3092                 struct snd_soc_dai_driver *dai_drv)
3093 {
3094         if (dai_drv->name == NULL) {
3095                 dev_err(dev,
3096                         "ASoC: error - multiple DAI %s registered with no name\n",
3097                         dev_name(dev));
3098                 return NULL;
3099         }
3100
3101         return kstrdup(dai_drv->name, GFP_KERNEL);
3102 }
3103
3104 /**
3105  * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
3106  *
3107  * @component: The component for which the DAIs should be unregistered
3108  */
3109 static void snd_soc_unregister_dais(struct snd_soc_component *component)
3110 {
3111         struct snd_soc_dai *dai, *_dai;
3112
3113         list_for_each_entry_safe(dai, _dai, &component->dai_list, list) {
3114                 dev_dbg(component->dev, "ASoC: Unregistered DAI '%s'\n",
3115                         dai->name);
3116                 list_del(&dai->list);
3117                 kfree(dai->name);
3118                 kfree(dai);
3119         }
3120 }
3121
3122 /* Create a DAI and add it to the component's DAI list */
3123 static struct snd_soc_dai *soc_add_dai(struct snd_soc_component *component,
3124         struct snd_soc_dai_driver *dai_drv,
3125         bool legacy_dai_naming)
3126 {
3127         struct device *dev = component->dev;
3128         struct snd_soc_dai *dai;
3129
3130         dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
3131
3132         dai = kzalloc(sizeof(struct snd_soc_dai), GFP_KERNEL);
3133         if (dai == NULL)
3134                 return NULL;
3135
3136         /*
3137          * Back in the old days when we still had component-less DAIs,
3138          * instead of having a static name, component-less DAIs would
3139          * inherit the name of the parent device so it is possible to
3140          * register multiple instances of the DAI. We still need to keep
3141          * the same naming style even though those DAIs are not
3142          * component-less anymore.
3143          */
3144         if (legacy_dai_naming &&
3145            (dai_drv->id == 0 || dai_drv->name == NULL)) {
3146                 dai->name = fmt_single_name(dev, &dai->id);
3147         } else {
3148                 dai->name = fmt_multiple_name(dev, dai_drv);
3149                 if (dai_drv->id)
3150                         dai->id = dai_drv->id;
3151                 else
3152                         dai->id = component->num_dai;
3153         }
3154         if (dai->name == NULL) {
3155                 kfree(dai);
3156                 return NULL;
3157         }
3158
3159         dai->component = component;
3160         dai->dev = dev;
3161         dai->driver = dai_drv;
3162         if (!dai->driver->ops)
3163                 dai->driver->ops = &null_dai_ops;
3164
3165         list_add_tail(&dai->list, &component->dai_list);
3166         component->num_dai++;
3167
3168         dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
3169         return dai;
3170 }
3171
3172 /**
3173  * snd_soc_register_dais - Register a DAI with the ASoC core
3174  *
3175  * @component: The component the DAIs are registered for
3176  * @dai_drv: DAI driver to use for the DAIs
3177  * @count: Number of DAIs
3178  * @legacy_dai_naming: Use the legacy naming scheme and let the DAI inherit the
3179  *                     parent's name.
3180  */
3181 static int snd_soc_register_dais(struct snd_soc_component *component,
3182         struct snd_soc_dai_driver *dai_drv, size_t count,
3183         bool legacy_dai_naming)
3184 {
3185         struct device *dev = component->dev;
3186         struct snd_soc_dai *dai;
3187         unsigned int i;
3188         int ret;
3189
3190         dev_dbg(dev, "ASoC: dai register %s #%zu\n", dev_name(dev), count);
3191
3192         for (i = 0; i < count; i++) {
3193
3194                 dai = soc_add_dai(component, dai_drv + i,
3195                                 count == 1 && legacy_dai_naming);
3196                 if (dai == NULL) {
3197                         ret = -ENOMEM;
3198                         goto err;
3199                 }
3200         }
3201
3202         return 0;
3203
3204 err:
3205         snd_soc_unregister_dais(component);
3206
3207         return ret;
3208 }
3209
3210 /**
3211  * snd_soc_register_dai - Register a DAI dynamically & create its widgets
3212  *
3213  * @component: The component the DAIs are registered for
3214  * @dai_drv: DAI driver to use for the DAI
3215  *
3216  * Topology can use this API to register DAIs when probing a component.
3217  * These DAIs's widgets will be freed in the card cleanup and the DAIs
3218  * will be freed in the component cleanup.
3219  */
3220 int snd_soc_register_dai(struct snd_soc_component *component,
3221         struct snd_soc_dai_driver *dai_drv)
3222 {
3223         struct snd_soc_dapm_context *dapm =
3224                 snd_soc_component_get_dapm(component);
3225         struct snd_soc_dai *dai;
3226         int ret;
3227
3228         if (dai_drv->dobj.type != SND_SOC_DOBJ_PCM) {
3229                 dev_err(component->dev, "Invalid dai type %d\n",
3230                         dai_drv->dobj.type);
3231                 return -EINVAL;
3232         }
3233
3234         lockdep_assert_held(&client_mutex);
3235         dai = soc_add_dai(component, dai_drv, false);
3236         if (!dai)
3237                 return -ENOMEM;
3238
3239         /* Create the DAI widgets here. After adding DAIs, topology may
3240          * also add routes that need these widgets as source or sink.
3241          */
3242         ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
3243         if (ret != 0) {
3244                 dev_err(component->dev,
3245                         "Failed to create DAI widgets %d\n", ret);
3246         }
3247
3248         return ret;
3249 }
3250 EXPORT_SYMBOL_GPL(snd_soc_register_dai);
3251
3252 static void snd_soc_component_seq_notifier(struct snd_soc_dapm_context *dapm,
3253         enum snd_soc_dapm_type type, int subseq)
3254 {
3255         struct snd_soc_component *component = dapm->component;
3256
3257         component->driver->seq_notifier(component, type, subseq);
3258 }
3259
3260 static int snd_soc_component_stream_event(struct snd_soc_dapm_context *dapm,
3261         int event)
3262 {
3263         struct snd_soc_component *component = dapm->component;
3264
3265         return component->driver->stream_event(component, event);
3266 }
3267
3268 static int snd_soc_component_drv_pcm_new(struct snd_soc_component *component,
3269                                         struct snd_soc_pcm_runtime *rtd)
3270 {
3271         if (component->driver->pcm_new)
3272                 return component->driver->pcm_new(rtd);
3273
3274         return 0;
3275 }
3276
3277 static void snd_soc_component_drv_pcm_free(struct snd_soc_component *component,
3278                                           struct snd_pcm *pcm)
3279 {
3280         if (component->driver->pcm_free)
3281                 component->driver->pcm_free(pcm);
3282 }
3283
3284 static int snd_soc_component_set_bias_level(struct snd_soc_dapm_context *dapm,
3285                                         enum snd_soc_bias_level level)
3286 {
3287         struct snd_soc_component *component = dapm->component;
3288
3289         return component->driver->set_bias_level(component, level);
3290 }
3291
3292 static int snd_soc_component_initialize(struct snd_soc_component *component,
3293         const struct snd_soc_component_driver *driver, struct device *dev)
3294 {
3295         struct snd_soc_dapm_context *dapm;
3296
3297         component->name = fmt_single_name(dev, &component->id);
3298         if (!component->name) {
3299                 dev_err(dev, "ASoC: Failed to allocate name\n");
3300                 return -ENOMEM;
3301         }
3302
3303         component->dev = dev;
3304         component->driver = driver;
3305         component->probe = component->driver->probe;
3306         component->remove = component->driver->remove;
3307         component->suspend = component->driver->suspend;
3308         component->resume = component->driver->resume;
3309         component->set_sysclk = component->driver->set_sysclk;
3310         component->set_pll = component->driver->set_pll;
3311         component->set_jack = component->driver->set_jack;
3312         component->pcm_new = snd_soc_component_drv_pcm_new;
3313         component->pcm_free = snd_soc_component_drv_pcm_free;
3314
3315         dapm = snd_soc_component_get_dapm(component);
3316         dapm->dev = dev;
3317         dapm->component = component;
3318         dapm->bias_level = SND_SOC_BIAS_OFF;
3319         dapm->idle_bias_off = !driver->idle_bias_on;
3320         dapm->suspend_bias_off = driver->suspend_bias_off;
3321         if (driver->seq_notifier)
3322                 dapm->seq_notifier = snd_soc_component_seq_notifier;
3323         if (driver->stream_event)
3324                 dapm->stream_event = snd_soc_component_stream_event;
3325         if (driver->set_bias_level)
3326                 dapm->set_bias_level = snd_soc_component_set_bias_level;
3327
3328         INIT_LIST_HEAD(&component->dai_list);
3329         mutex_init(&component->io_mutex);
3330
3331         return 0;
3332 }
3333
3334 static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
3335 {
3336         int val_bytes = regmap_get_val_bytes(component->regmap);
3337
3338         /* Errors are legitimate for non-integer byte multiples */
3339         if (val_bytes > 0)
3340                 component->val_bytes = val_bytes;
3341 }
3342
3343 #ifdef CONFIG_REGMAP
3344
3345 /**
3346  * snd_soc_component_init_regmap() - Initialize regmap instance for the component
3347  * @component: The component for which to initialize the regmap instance
3348  * @regmap: The regmap instance that should be used by the component
3349  *
3350  * This function allows deferred assignment of the regmap instance that is
3351  * associated with the component. Only use this if the regmap instance is not
3352  * yet ready when the component is registered. The function must also be called
3353  * before the first IO attempt of the component.
3354  */
3355 void snd_soc_component_init_regmap(struct snd_soc_component *component,
3356         struct regmap *regmap)
3357 {
3358         component->regmap = regmap;
3359         snd_soc_component_setup_regmap(component);
3360 }
3361 EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
3362
3363 /**
3364  * snd_soc_component_exit_regmap() - De-initialize regmap instance for the component
3365  * @component: The component for which to de-initialize the regmap instance
3366  *
3367  * Calls regmap_exit() on the regmap instance associated to the component and
3368  * removes the regmap instance from the component.
3369  *
3370  * This function should only be used if snd_soc_component_init_regmap() was used
3371  * to initialize the regmap instance.
3372  */
3373 void snd_soc_component_exit_regmap(struct snd_soc_component *component)
3374 {
3375         regmap_exit(component->regmap);
3376         component->regmap = NULL;
3377 }
3378 EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
3379
3380 #endif
3381
3382 static void snd_soc_component_add_unlocked(struct snd_soc_component *component)
3383 {
3384         if (!component->write && !component->read) {
3385                 if (!component->regmap)
3386                         component->regmap = dev_get_regmap(component->dev, NULL);
3387                 if (component->regmap)
3388                         snd_soc_component_setup_regmap(component);
3389         }
3390
3391         list_add(&component->list, &component_list);
3392         INIT_LIST_HEAD(&component->dobj_list);
3393 }
3394
3395 static void snd_soc_component_add(struct snd_soc_component *component)
3396 {
3397         mutex_lock(&client_mutex);
3398         snd_soc_component_add_unlocked(component);
3399         mutex_unlock(&client_mutex);
3400 }
3401
3402 static void snd_soc_component_cleanup(struct snd_soc_component *component)
3403 {
3404         snd_soc_unregister_dais(component);
3405         kfree(component->name);
3406 }
3407
3408 static void snd_soc_component_del_unlocked(struct snd_soc_component *component)
3409 {
3410         struct snd_soc_card *card = component->card;
3411
3412         if (card)
3413                 snd_soc_unregister_card(card);
3414
3415         list_del(&component->list);
3416 }
3417
3418 #define ENDIANNESS_MAP(name) \
3419         (SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
3420 static u64 endianness_format_map[] = {
3421         ENDIANNESS_MAP(S16_),
3422         ENDIANNESS_MAP(U16_),
3423         ENDIANNESS_MAP(S24_),
3424         ENDIANNESS_MAP(U24_),
3425         ENDIANNESS_MAP(S32_),
3426         ENDIANNESS_MAP(U32_),
3427         ENDIANNESS_MAP(S24_3),
3428         ENDIANNESS_MAP(U24_3),
3429         ENDIANNESS_MAP(S20_3),
3430         ENDIANNESS_MAP(U20_3),
3431         ENDIANNESS_MAP(S18_3),
3432         ENDIANNESS_MAP(U18_3),
3433         ENDIANNESS_MAP(FLOAT_),
3434         ENDIANNESS_MAP(FLOAT64_),
3435         ENDIANNESS_MAP(IEC958_SUBFRAME_),
3436 };
3437
3438 /*
3439  * Fix up the DAI formats for endianness: codecs don't actually see
3440  * the endianness of the data but we're using the CPU format
3441  * definitions which do need to include endianness so we ensure that
3442  * codec DAIs always have both big and little endian variants set.
3443  */
3444 static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
3445 {
3446         int i;
3447
3448         for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
3449                 if (stream->formats & endianness_format_map[i])
3450                         stream->formats |= endianness_format_map[i];
3451 }
3452
3453 int snd_soc_add_component(struct device *dev,
3454                         struct snd_soc_component *component,
3455                         const struct snd_soc_component_driver *component_driver,
3456                         struct snd_soc_dai_driver *dai_drv,
3457                         int num_dai)
3458 {
3459         int ret;
3460         int i;
3461
3462         ret = snd_soc_component_initialize(component, component_driver, dev);
3463         if (ret)
3464                 goto err_free;
3465
3466         component->ignore_pmdown_time = true;
3467         component->registered_as_component = true;
3468
3469         if (component_driver->endianness) {
3470                 for (i = 0; i < num_dai; i++) {
3471                         convert_endianness_formats(&dai_drv[i].playback);
3472                         convert_endianness_formats(&dai_drv[i].capture);
3473                 }
3474         }
3475
3476         ret = snd_soc_register_dais(component, dai_drv, num_dai,
3477                                     !component_driver->non_legacy_dai_naming);
3478         if (ret < 0) {
3479                 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3480                 goto err_cleanup;
3481         }
3482
3483         snd_soc_component_add(component);
3484
3485         return 0;
3486
3487 err_cleanup:
3488         snd_soc_component_cleanup(component);
3489 err_free:
3490         kfree(component);
3491         return ret;
3492 }
3493 EXPORT_SYMBOL_GPL(snd_soc_add_component);
3494
3495 int snd_soc_register_component(struct device *dev,
3496                         const struct snd_soc_component_driver *component_driver,
3497                         struct snd_soc_dai_driver *dai_drv,
3498                         int num_dai)
3499 {
3500         struct snd_soc_component *component;
3501
3502         component = kzalloc(sizeof(*component), GFP_KERNEL);
3503         if (!component)
3504                 return -ENOMEM;
3505
3506         return snd_soc_add_component(dev, component, component_driver,
3507                                      dai_drv, num_dai);
3508 }
3509 EXPORT_SYMBOL_GPL(snd_soc_register_component);
3510
3511 /**
3512  * snd_soc_unregister_component - Unregister all related component
3513  * from the ASoC core
3514  *
3515  * @dev: The device to unregister
3516  */
3517 static int __snd_soc_unregister_component(struct device *dev)
3518 {
3519         struct snd_soc_component *component;
3520         int found = 0;
3521
3522         mutex_lock(&client_mutex);
3523         list_for_each_entry(component, &component_list, list) {
3524                 if (dev != component->dev ||
3525                     !component->registered_as_component)
3526                         continue;
3527
3528                 snd_soc_tplg_component_remove(component, SND_SOC_TPLG_INDEX_ALL);
3529                 snd_soc_component_del_unlocked(component);
3530                 found = 1;
3531                 break;
3532         }
3533         mutex_unlock(&client_mutex);
3534
3535         if (found) {
3536                 snd_soc_component_cleanup(component);
3537                 kfree(component);
3538         }
3539
3540         return found;
3541 }
3542
3543 void snd_soc_unregister_component(struct device *dev)
3544 {
3545         while (__snd_soc_unregister_component(dev));
3546 }
3547 EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
3548
3549 struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
3550                                                    const char *driver_name)
3551 {
3552         struct snd_soc_component *component;
3553         struct snd_soc_component *ret;
3554
3555         ret = NULL;
3556         mutex_lock(&client_mutex);
3557         list_for_each_entry(component, &component_list, list) {
3558                 if (dev != component->dev)
3559                         continue;
3560
3561                 if (driver_name &&
3562                     (driver_name != component->driver->name) &&
3563                     (strcmp(component->driver->name, driver_name) != 0))
3564                         continue;
3565
3566                 ret = component;
3567                 break;
3568         }
3569         mutex_unlock(&client_mutex);
3570
3571         return ret;
3572 }
3573 EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
3574
3575 static int snd_soc_platform_drv_probe(struct snd_soc_component *component)
3576 {
3577         struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3578
3579         return platform->driver->probe(platform);
3580 }
3581
3582 static void snd_soc_platform_drv_remove(struct snd_soc_component *component)
3583 {
3584         struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3585
3586         platform->driver->remove(platform);
3587 }
3588
3589 static int snd_soc_platform_drv_pcm_new(struct snd_soc_component *component,
3590                                         struct snd_soc_pcm_runtime *rtd)
3591 {
3592         struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3593
3594         if (platform->driver->pcm_new)
3595                 return platform->driver->pcm_new(rtd);
3596
3597         return 0;
3598 }
3599
3600 static void snd_soc_platform_drv_pcm_free(struct snd_soc_component *component,
3601                                           struct snd_pcm *pcm)
3602 {
3603         struct snd_soc_platform *platform = snd_soc_component_to_platform(component);
3604
3605         if (platform->driver->pcm_free)
3606                 platform->driver->pcm_free(pcm);
3607 }
3608
3609 /**
3610  * snd_soc_add_platform - Add a platform to the ASoC core
3611  * @dev: The parent device for the platform
3612  * @platform: The platform to add
3613  * @platform_drv: The driver for the platform
3614  */
3615 int snd_soc_add_platform(struct device *dev, struct snd_soc_platform *platform,
3616                 const struct snd_soc_platform_driver *platform_drv)
3617 {
3618         int ret;
3619
3620         ret = snd_soc_component_initialize(&platform->component,
3621                         &platform_drv->component_driver, dev);
3622         if (ret)
3623                 return ret;
3624
3625         platform->dev = dev;
3626         platform->driver = platform_drv;
3627
3628         if (platform_drv->probe)
3629                 platform->component.probe = snd_soc_platform_drv_probe;
3630         if (platform_drv->remove)
3631                 platform->component.remove = snd_soc_platform_drv_remove;
3632         if (platform_drv->pcm_new)
3633                 platform->component.pcm_new = snd_soc_platform_drv_pcm_new;
3634         if (platform_drv->pcm_free)
3635                 platform->component.pcm_free = snd_soc_platform_drv_pcm_free;
3636
3637 #ifdef CONFIG_DEBUG_FS
3638         platform->component.debugfs_prefix = "platform";
3639 #endif
3640
3641         mutex_lock(&client_mutex);
3642         snd_soc_component_add_unlocked(&platform->component);
3643         list_add(&platform->list, &platform_list);
3644         mutex_unlock(&client_mutex);
3645
3646         dev_dbg(dev, "ASoC: Registered platform '%s'\n",
3647                 platform->component.name);
3648
3649         return 0;
3650 }
3651 EXPORT_SYMBOL_GPL(snd_soc_add_platform);
3652
3653 /**
3654  * snd_soc_register_platform - Register a platform with the ASoC core
3655  *
3656  * @dev: The device for the platform
3657  * @platform_drv: The driver for the platform
3658  */
3659 int snd_soc_register_platform(struct device *dev,
3660                 const struct snd_soc_platform_driver *platform_drv)
3661 {
3662         struct snd_soc_platform *platform;
3663         int ret;
3664
3665         dev_dbg(dev, "ASoC: platform register %s\n", dev_name(dev));
3666
3667         platform = kzalloc(sizeof(struct snd_soc_platform), GFP_KERNEL);
3668         if (platform == NULL)
3669                 return -ENOMEM;
3670
3671         ret = snd_soc_add_platform(dev, platform, platform_drv);
3672         if (ret)
3673                 kfree(platform);
3674
3675         return ret;
3676 }
3677 EXPORT_SYMBOL_GPL(snd_soc_register_platform);
3678
3679 /**
3680  * snd_soc_remove_platform - Remove a platform from the ASoC core
3681  * @platform: the platform to remove
3682  */
3683 void snd_soc_remove_platform(struct snd_soc_platform *platform)
3684 {
3685
3686         mutex_lock(&client_mutex);
3687         list_del(&platform->list);
3688         snd_soc_component_del_unlocked(&platform->component);
3689         mutex_unlock(&client_mutex);
3690
3691         dev_dbg(platform->dev, "ASoC: Unregistered platform '%s'\n",
3692                 platform->component.name);
3693
3694         snd_soc_component_cleanup(&platform->component);
3695 }
3696 EXPORT_SYMBOL_GPL(snd_soc_remove_platform);
3697
3698 struct snd_soc_platform *snd_soc_lookup_platform(struct device *dev)
3699 {
3700         struct snd_soc_platform *platform;
3701
3702         mutex_lock(&client_mutex);
3703         list_for_each_entry(platform, &platform_list, list) {
3704                 if (dev == platform->dev) {
3705                         mutex_unlock(&client_mutex);
3706                         return platform;
3707                 }
3708         }
3709         mutex_unlock(&client_mutex);
3710
3711         return NULL;
3712 }
3713 EXPORT_SYMBOL_GPL(snd_soc_lookup_platform);
3714
3715 /**
3716  * snd_soc_unregister_platform - Unregister a platform from the ASoC core
3717  *
3718  * @dev: platform to unregister
3719  */
3720 void snd_soc_unregister_platform(struct device *dev)
3721 {
3722         struct snd_soc_platform *platform;
3723
3724         platform = snd_soc_lookup_platform(dev);
3725         if (!platform)
3726                 return;
3727
3728         snd_soc_remove_platform(platform);
3729         kfree(platform);
3730 }
3731 EXPORT_SYMBOL_GPL(snd_soc_unregister_platform);
3732
3733 static int snd_soc_codec_drv_probe(struct snd_soc_component *component)
3734 {
3735         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3736
3737         return codec->driver->probe(codec);
3738 }
3739
3740 static void snd_soc_codec_drv_remove(struct snd_soc_component *component)
3741 {
3742         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3743
3744         codec->driver->remove(codec);
3745 }
3746
3747 static int snd_soc_codec_drv_suspend(struct snd_soc_component *component)
3748 {
3749         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3750
3751         return codec->driver->suspend(codec);
3752 }
3753
3754 static int snd_soc_codec_drv_resume(struct snd_soc_component *component)
3755 {
3756         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3757
3758         return codec->driver->resume(codec);
3759 }
3760
3761 static int snd_soc_codec_drv_write(struct snd_soc_component *component,
3762         unsigned int reg, unsigned int val)
3763 {
3764         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3765
3766         return codec->driver->write(codec, reg, val);
3767 }
3768
3769 static int snd_soc_codec_drv_read(struct snd_soc_component *component,
3770         unsigned int reg, unsigned int *val)
3771 {
3772         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3773
3774         *val = codec->driver->read(codec, reg);
3775
3776         return 0;
3777 }
3778
3779 static int snd_soc_codec_set_sysclk_(struct snd_soc_component *component,
3780                           int clk_id, int source, unsigned int freq, int dir)
3781 {
3782         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3783
3784         return snd_soc_codec_set_sysclk(codec, clk_id, source, freq, dir);
3785 }
3786
3787 static int snd_soc_codec_set_pll_(struct snd_soc_component *component,
3788                                   int pll_id, int source, unsigned int freq_in,
3789                                   unsigned int freq_out)
3790 {
3791         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3792
3793         return snd_soc_codec_set_pll(codec, pll_id, source, freq_in, freq_out);
3794 }
3795
3796 static int snd_soc_codec_set_jack_(struct snd_soc_component *component,
3797                                struct snd_soc_jack *jack, void *data)
3798 {
3799         struct snd_soc_codec *codec = snd_soc_component_to_codec(component);
3800
3801         return snd_soc_codec_set_jack(codec, jack, data);
3802 }
3803
3804 static int snd_soc_codec_set_bias_level(struct snd_soc_dapm_context *dapm,
3805         enum snd_soc_bias_level level)
3806 {
3807         struct snd_soc_codec *codec = snd_soc_dapm_to_codec(dapm);
3808
3809         return codec->driver->set_bias_level(codec, level);
3810 }
3811
3812 /**
3813  * snd_soc_register_codec - Register a codec with the ASoC core
3814  *
3815  * @dev: The parent device for this codec
3816  * @codec_drv: Codec driver
3817  * @dai_drv: The associated DAI driver
3818  * @num_dai: Number of DAIs
3819  */
3820 int snd_soc_register_codec(struct device *dev,
3821                            const struct snd_soc_codec_driver *codec_drv,
3822                            struct snd_soc_dai_driver *dai_drv,
3823                            int num_dai)
3824 {
3825         struct snd_soc_dapm_context *dapm;
3826         struct snd_soc_codec *codec;
3827         struct snd_soc_dai *dai;
3828         int ret, i;
3829
3830         dev_dbg(dev, "codec register %s\n", dev_name(dev));
3831
3832         codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
3833         if (codec == NULL)
3834                 return -ENOMEM;
3835
3836         codec->component.codec = codec;
3837
3838         ret = snd_soc_component_initialize(&codec->component,
3839                         &codec_drv->component_driver, dev);
3840         if (ret)
3841                 goto err_free;
3842
3843         if (codec_drv->probe)
3844                 codec->component.probe = snd_soc_codec_drv_probe;
3845         if (codec_drv->remove)
3846                 codec->component.remove = snd_soc_codec_drv_remove;
3847         if (codec_drv->suspend)
3848                 codec->component.suspend = snd_soc_codec_drv_suspend;
3849         if (codec_drv->resume)
3850                 codec->component.resume = snd_soc_codec_drv_resume;
3851         if (codec_drv->write)
3852                 codec->component.write = snd_soc_codec_drv_write;
3853         if (codec_drv->read)
3854                 codec->component.read = snd_soc_codec_drv_read;
3855         if (codec_drv->set_sysclk)
3856                 codec->component.set_sysclk = snd_soc_codec_set_sysclk_;
3857         if (codec_drv->set_pll)
3858                 codec->component.set_pll = snd_soc_codec_set_pll_;
3859         if (codec_drv->set_jack)
3860                 codec->component.set_jack = snd_soc_codec_set_jack_;
3861         codec->component.ignore_pmdown_time = codec_drv->ignore_pmdown_time;
3862
3863         dapm = snd_soc_codec_get_dapm(codec);
3864         dapm->idle_bias_off = codec_drv->idle_bias_off;
3865         dapm->suspend_bias_off = codec_drv->suspend_bias_off;
3866         if (codec_drv->seq_notifier)
3867                 dapm->seq_notifier = codec_drv->seq_notifier;
3868         if (codec_drv->set_bias_level)
3869                 dapm->set_bias_level = snd_soc_codec_set_bias_level;
3870         codec->dev = dev;
3871         codec->driver = codec_drv;
3872         codec->component.val_bytes = codec_drv->reg_word_size;
3873
3874 #ifdef CONFIG_DEBUG_FS
3875         codec->component.init_debugfs = soc_init_codec_debugfs;
3876         codec->component.debugfs_prefix = "codec";
3877 #endif
3878
3879         if (codec_drv->get_regmap)
3880                 codec->component.regmap = codec_drv->get_regmap(dev);
3881
3882         for (i = 0; i < num_dai; i++) {
3883                 convert_endianness_formats(&dai_drv[i].playback);
3884                 convert_endianness_formats(&dai_drv[i].capture);
3885         }
3886
3887         ret = snd_soc_register_dais(&codec->component, dai_drv, num_dai, false);
3888         if (ret < 0) {
3889                 dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
3890                 goto err_cleanup;
3891         }
3892
3893         list_for_each_entry(dai, &codec->component.dai_list, list)
3894                 dai->codec = codec;
3895
3896         mutex_lock(&client_mutex);
3897         snd_soc_component_add_unlocked(&codec->component);
3898         list_add(&codec->list, &codec_list);
3899         mutex_unlock(&client_mutex);
3900
3901         dev_dbg(codec->dev, "ASoC: Registered codec '%s'\n",
3902                 codec->component.name);
3903         return 0;
3904
3905 err_cleanup:
3906         snd_soc_component_cleanup(&codec->component);
3907 err_free:
3908         kfree(codec);
3909         return ret;
3910 }
3911 EXPORT_SYMBOL_GPL(snd_soc_register_codec);
3912
3913 /**
3914  * snd_soc_unregister_codec - Unregister a codec from the ASoC core
3915  *
3916  * @dev: codec to unregister
3917  */
3918 void snd_soc_unregister_codec(struct device *dev)
3919 {
3920         struct snd_soc_codec *codec;
3921
3922         mutex_lock(&client_mutex);
3923         list_for_each_entry(codec, &codec_list, list) {
3924                 if (dev == codec->dev)
3925                         goto found;
3926         }
3927         mutex_unlock(&client_mutex);
3928         return;
3929
3930 found:
3931         list_del(&codec->list);
3932         snd_soc_component_del_unlocked(&codec->component);
3933         mutex_unlock(&client_mutex);
3934
3935         dev_dbg(codec->dev, "ASoC: Unregistered codec '%s'\n",
3936                         codec->component.name);
3937
3938         snd_soc_component_cleanup(&codec->component);
3939         snd_soc_cache_exit(codec);
3940         kfree(codec);
3941 }
3942 EXPORT_SYMBOL_GPL(snd_soc_unregister_codec);
3943
3944 /* Retrieve a card's name from device tree */
3945 int snd_soc_of_parse_card_name(struct snd_soc_card *card,
3946                                const char *propname)
3947 {
3948         struct device_node *np;
3949         int ret;
3950
3951         if (!card->dev) {
3952                 pr_err("card->dev is not set before calling %s\n", __func__);
3953                 return -EINVAL;
3954         }
3955
3956         np = card->dev->of_node;
3957
3958         ret = of_property_read_string_index(np, propname, 0, &card->name);
3959         /*
3960          * EINVAL means the property does not exist. This is fine providing
3961          * card->name was previously set, which is checked later in
3962          * snd_soc_register_card.
3963          */
3964         if (ret < 0 && ret != -EINVAL) {
3965                 dev_err(card->dev,
3966                         "ASoC: Property '%s' could not be read: %d\n",
3967                         propname, ret);
3968                 return ret;
3969         }
3970
3971         return 0;
3972 }
3973 EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
3974
3975 static const struct snd_soc_dapm_widget simple_widgets[] = {
3976         SND_SOC_DAPM_MIC("Microphone", NULL),
3977         SND_SOC_DAPM_LINE("Line", NULL),
3978         SND_SOC_DAPM_HP("Headphone", NULL),
3979         SND_SOC_DAPM_SPK("Speaker", NULL),
3980 };
3981
3982 int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
3983                                           const char *propname)
3984 {
3985         struct device_node *np = card->dev->of_node;
3986         struct snd_soc_dapm_widget *widgets;
3987         const char *template, *wname;
3988         int i, j, num_widgets, ret;
3989
3990         num_widgets = of_property_count_strings(np, propname);
3991         if (num_widgets < 0) {
3992                 dev_err(card->dev,
3993                         "ASoC: Property '%s' does not exist\n", propname);
3994                 return -EINVAL;
3995         }
3996         if (num_widgets & 1) {
3997                 dev_err(card->dev,
3998                         "ASoC: Property '%s' length is not even\n", propname);
3999                 return -EINVAL;
4000         }
4001
4002         num_widgets /= 2;
4003         if (!num_widgets) {
4004                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
4005                         propname);
4006                 return -EINVAL;
4007         }
4008
4009         widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
4010                                GFP_KERNEL);
4011         if (!widgets) {
4012                 dev_err(card->dev,
4013                         "ASoC: Could not allocate memory for widgets\n");
4014                 return -ENOMEM;
4015         }
4016
4017         for (i = 0; i < num_widgets; i++) {
4018                 ret = of_property_read_string_index(np, propname,
4019                         2 * i, &template);
4020                 if (ret) {
4021                         dev_err(card->dev,
4022                                 "ASoC: Property '%s' index %d read error:%d\n",
4023                                 propname, 2 * i, ret);
4024                         return -EINVAL;
4025                 }
4026
4027                 for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
4028                         if (!strncmp(template, simple_widgets[j].name,
4029                                      strlen(simple_widgets[j].name))) {
4030                                 widgets[i] = simple_widgets[j];
4031                                 break;
4032                         }
4033                 }
4034
4035                 if (j >= ARRAY_SIZE(simple_widgets)) {
4036                         dev_err(card->dev,
4037                                 "ASoC: DAPM widget '%s' is not supported\n",
4038                                 template);
4039                         return -EINVAL;
4040                 }
4041
4042                 ret = of_property_read_string_index(np, propname,
4043                                                     (2 * i) + 1,
4044                                                     &wname);
4045                 if (ret) {
4046                         dev_err(card->dev,
4047                                 "ASoC: Property '%s' index %d read error:%d\n",
4048                                 propname, (2 * i) + 1, ret);
4049                         return -EINVAL;
4050                 }
4051
4052                 widgets[i].name = wname;
4053         }
4054
4055         card->of_dapm_widgets = widgets;
4056         card->num_of_dapm_widgets = num_widgets;
4057
4058         return 0;
4059 }
4060 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
4061
4062 static int snd_soc_of_get_slot_mask(struct device_node *np,
4063                                     const char *prop_name,
4064                                     unsigned int *mask)
4065 {
4066         u32 val;
4067         const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
4068         int i;
4069
4070         if (!of_slot_mask)
4071                 return 0;
4072         val /= sizeof(u32);
4073         for (i = 0; i < val; i++)
4074                 if (be32_to_cpup(&of_slot_mask[i]))
4075                         *mask |= (1 << i);
4076
4077         return val;
4078 }
4079
4080 int snd_soc_of_parse_tdm_slot(struct device_node *np,
4081                               unsigned int *tx_mask,
4082                               unsigned int *rx_mask,
4083                               unsigned int *slots,
4084                               unsigned int *slot_width)
4085 {
4086         u32 val;
4087         int ret;
4088
4089         if (tx_mask)
4090                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
4091         if (rx_mask)
4092                 snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
4093
4094         if (of_property_read_bool(np, "dai-tdm-slot-num")) {
4095                 ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
4096                 if (ret)
4097                         return ret;
4098
4099                 if (slots)
4100                         *slots = val;
4101         }
4102
4103         if (of_property_read_bool(np, "dai-tdm-slot-width")) {
4104                 ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
4105                 if (ret)
4106                         return ret;
4107
4108                 if (slot_width)
4109                         *slot_width = val;
4110         }
4111
4112         return 0;
4113 }
4114 EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
4115
4116 void snd_soc_of_parse_audio_prefix(struct snd_soc_card *card,
4117                                    struct snd_soc_codec_conf *codec_conf,
4118                                    struct device_node *of_node,
4119                                    const char *propname)
4120 {
4121         struct device_node *np = card->dev->of_node;
4122         const char *str;
4123         int ret;
4124
4125         ret = of_property_read_string(np, propname, &str);
4126         if (ret < 0) {
4127                 /* no prefix is not error */
4128                 return;
4129         }
4130
4131         codec_conf->of_node     = of_node;
4132         codec_conf->name_prefix = str;
4133 }
4134 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_prefix);
4135
4136 int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
4137                                    const char *propname)
4138 {
4139         struct device_node *np = card->dev->of_node;
4140         int num_routes;
4141         struct snd_soc_dapm_route *routes;
4142         int i, ret;
4143
4144         num_routes = of_property_count_strings(np, propname);
4145         if (num_routes < 0 || num_routes & 1) {
4146                 dev_err(card->dev,
4147                         "ASoC: Property '%s' does not exist or its length is not even\n",
4148                         propname);
4149                 return -EINVAL;
4150         }
4151         num_routes /= 2;
4152         if (!num_routes) {
4153                 dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
4154                         propname);
4155                 return -EINVAL;
4156         }
4157
4158         routes = devm_kzalloc(card->dev, num_routes * sizeof(*routes),
4159                               GFP_KERNEL);
4160         if (!routes) {
4161                 dev_err(card->dev,
4162                         "ASoC: Could not allocate DAPM route table\n");
4163                 return -EINVAL;
4164         }
4165
4166         for (i = 0; i < num_routes; i++) {
4167                 ret = of_property_read_string_index(np, propname,
4168                         2 * i, &routes[i].sink);
4169                 if (ret) {
4170                         dev_err(card->dev,
4171                                 "ASoC: Property '%s' index %d could not be read: %d\n",
4172                                 propname, 2 * i, ret);
4173                         return -EINVAL;
4174                 }
4175                 ret = of_property_read_string_index(np, propname,
4176                         (2 * i) + 1, &routes[i].source);
4177                 if (ret) {
4178                         dev_err(card->dev,
4179                                 "ASoC: Property '%s' index %d could not be read: %d\n",
4180                                 propname, (2 * i) + 1, ret);
4181                         return -EINVAL;
4182                 }
4183         }
4184
4185         card->num_of_dapm_routes = num_routes;
4186         card->of_dapm_routes = routes;
4187
4188         return 0;
4189 }
4190 EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
4191
4192 unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
4193                                      const char *prefix,
4194                                      struct device_node **bitclkmaster,
4195                                      struct device_node **framemaster)
4196 {
4197         int ret, i;
4198         char prop[128];
4199         unsigned int format = 0;
4200         int bit, frame;
4201         const char *str;
4202         struct {
4203                 char *name;
4204                 unsigned int val;
4205         } of_fmt_table[] = {
4206                 { "i2s",        SND_SOC_DAIFMT_I2S },
4207                 { "right_j",    SND_SOC_DAIFMT_RIGHT_J },
4208                 { "left_j",     SND_SOC_DAIFMT_LEFT_J },
4209                 { "dsp_a",      SND_SOC_DAIFMT_DSP_A },
4210                 { "dsp_b",      SND_SOC_DAIFMT_DSP_B },
4211                 { "ac97",       SND_SOC_DAIFMT_AC97 },
4212                 { "pdm",        SND_SOC_DAIFMT_PDM},
4213                 { "msb",        SND_SOC_DAIFMT_MSB },
4214                 { "lsb",        SND_SOC_DAIFMT_LSB },
4215         };
4216
4217         if (!prefix)
4218                 prefix = "";
4219
4220         /*
4221          * check "dai-format = xxx"
4222          * or    "[prefix]format = xxx"
4223          * SND_SOC_DAIFMT_FORMAT_MASK area
4224          */
4225         ret = of_property_read_string(np, "dai-format", &str);
4226         if (ret < 0) {
4227                 snprintf(prop, sizeof(prop), "%sformat", prefix);
4228                 ret = of_property_read_string(np, prop, &str);
4229         }
4230         if (ret == 0) {
4231                 for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
4232                         if (strcmp(str, of_fmt_table[i].name) == 0) {
4233                                 format |= of_fmt_table[i].val;
4234                                 break;
4235                         }
4236                 }
4237         }
4238
4239         /*
4240          * check "[prefix]continuous-clock"
4241          * SND_SOC_DAIFMT_CLOCK_MASK area
4242          */
4243         snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
4244         if (of_property_read_bool(np, prop))
4245                 format |= SND_SOC_DAIFMT_CONT;
4246         else
4247                 format |= SND_SOC_DAIFMT_GATED;
4248
4249         /*
4250          * check "[prefix]bitclock-inversion"
4251          * check "[prefix]frame-inversion"
4252          * SND_SOC_DAIFMT_INV_MASK area
4253          */
4254         snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
4255         bit = !!of_get_property(np, prop, NULL);
4256
4257         snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
4258         frame = !!of_get_property(np, prop, NULL);
4259
4260         switch ((bit << 4) + frame) {
4261         case 0x11:
4262                 format |= SND_SOC_DAIFMT_IB_IF;
4263                 break;
4264         case 0x10:
4265                 format |= SND_SOC_DAIFMT_IB_NF;
4266                 break;
4267         case 0x01:
4268                 format |= SND_SOC_DAIFMT_NB_IF;
4269                 break;
4270         default:
4271                 /* SND_SOC_DAIFMT_NB_NF is default */
4272                 break;
4273         }
4274
4275         /*
4276          * check "[prefix]bitclock-master"
4277          * check "[prefix]frame-master"
4278          * SND_SOC_DAIFMT_MASTER_MASK area
4279          */
4280         snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
4281         bit = !!of_get_property(np, prop, NULL);
4282         if (bit && bitclkmaster)
4283                 *bitclkmaster = of_parse_phandle(np, prop, 0);
4284
4285         snprintf(prop, sizeof(prop), "%sframe-master", prefix);
4286         frame = !!of_get_property(np, prop, NULL);
4287         if (frame && framemaster)
4288                 *framemaster = of_parse_phandle(np, prop, 0);
4289
4290         switch ((bit << 4) + frame) {
4291         case 0x11:
4292                 format |= SND_SOC_DAIFMT_CBM_CFM;
4293                 break;
4294         case 0x10:
4295                 format |= SND_SOC_DAIFMT_CBM_CFS;
4296                 break;
4297         case 0x01:
4298                 format |= SND_SOC_DAIFMT_CBS_CFM;
4299                 break;
4300         default:
4301                 format |= SND_SOC_DAIFMT_CBS_CFS;
4302                 break;
4303         }
4304
4305         return format;
4306 }
4307 EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
4308
4309 int snd_soc_get_dai_id(struct device_node *ep)
4310 {
4311         struct snd_soc_component *pos;
4312         struct device_node *node;
4313         int ret;
4314
4315         node = of_graph_get_port_parent(ep);
4316
4317         /*
4318          * For example HDMI case, HDMI has video/sound port,
4319          * but ALSA SoC needs sound port number only.
4320          * Thus counting HDMI DT port/endpoint doesn't work.
4321          * Then, it should have .of_xlate_dai_id
4322          */
4323         ret = -ENOTSUPP;
4324         mutex_lock(&client_mutex);
4325         list_for_each_entry(pos, &component_list, list) {
4326                 struct device_node *component_of_node = pos->dev->of_node;
4327
4328                 if (!component_of_node && pos->dev->parent)
4329                         component_of_node = pos->dev->parent->of_node;
4330
4331                 if (component_of_node != node)
4332                         continue;
4333
4334                 if (pos->driver->of_xlate_dai_id)
4335                         ret = pos->driver->of_xlate_dai_id(pos, ep);
4336
4337                 break;
4338         }
4339         mutex_unlock(&client_mutex);
4340
4341         of_node_put(node);
4342
4343         return ret;
4344 }
4345 EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
4346
4347 int snd_soc_get_dai_name(struct of_phandle_args *args,
4348                                 const char **dai_name)
4349 {
4350         struct snd_soc_component *pos;
4351         struct device_node *component_of_node;
4352         int ret = -EPROBE_DEFER;
4353
4354         mutex_lock(&client_mutex);
4355         list_for_each_entry(pos, &component_list, list) {
4356                 component_of_node = pos->dev->of_node;
4357                 if (!component_of_node && pos->dev->parent)
4358                         component_of_node = pos->dev->parent->of_node;
4359
4360                 if (component_of_node != args->np)
4361                         continue;
4362
4363                 if (pos->driver->of_xlate_dai_name) {
4364                         ret = pos->driver->of_xlate_dai_name(pos,
4365                                                              args,
4366                                                              dai_name);
4367                 } else {
4368                         struct snd_soc_dai *dai;
4369                         int id = -1;
4370
4371                         switch (args->args_count) {
4372                         case 0:
4373                                 id = 0; /* same as dai_drv[0] */
4374                                 break;
4375                         case 1:
4376                                 id = args->args[0];
4377                                 break;
4378                         default:
4379                                 /* not supported */
4380                                 break;
4381                         }
4382
4383                         if (id < 0 || id >= pos->num_dai) {
4384                                 ret = -EINVAL;
4385                                 continue;
4386                         }
4387
4388                         ret = 0;
4389
4390                         /* find target DAI */
4391                         list_for_each_entry(dai, &pos->dai_list, list) {
4392                                 if (id == 0)
4393                                         break;
4394                                 id--;
4395                         }
4396
4397                         *dai_name = dai->driver->name;
4398                         if (!*dai_name)
4399                                 *dai_name = pos->name;
4400                 }
4401
4402                 break;
4403         }
4404         mutex_unlock(&client_mutex);
4405         return ret;
4406 }
4407 EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
4408
4409 int snd_soc_of_get_dai_name(struct device_node *of_node,
4410                             const char **dai_name)
4411 {
4412         struct of_phandle_args args;
4413         int ret;
4414
4415         ret = of_parse_phandle_with_args(of_node, "sound-dai",
4416                                          "#sound-dai-cells", 0, &args);
4417         if (ret)
4418                 return ret;
4419
4420         ret = snd_soc_get_dai_name(&args, dai_name);
4421
4422         of_node_put(args.np);
4423
4424         return ret;
4425 }
4426 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
4427
4428 /*
4429  * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
4430  * @dev: Card device
4431  * @of_node: Device node
4432  * @dai_link: DAI link
4433  *
4434  * Builds an array of CODEC DAI components from the DAI link property
4435  * 'sound-dai'.
4436  * The array is set in the DAI link and the number of DAIs is set accordingly.
4437  * The device nodes in the array (of_node) must be dereferenced by the caller.
4438  *
4439  * Returns 0 for success
4440  */
4441 int snd_soc_of_get_dai_link_codecs(struct device *dev,
4442                                    struct device_node *of_node,
4443                                    struct snd_soc_dai_link *dai_link)
4444 {
4445         struct of_phandle_args args;
4446         struct snd_soc_dai_link_component *component;
4447         char *name;
4448         int index, num_codecs, ret;
4449
4450         /* Count the number of CODECs */
4451         name = "sound-dai";
4452         num_codecs = of_count_phandle_with_args(of_node, name,
4453                                                 "#sound-dai-cells");
4454         if (num_codecs <= 0) {
4455                 if (num_codecs == -ENOENT)
4456                         dev_err(dev, "No 'sound-dai' property\n");
4457                 else
4458                         dev_err(dev, "Bad phandle in 'sound-dai'\n");
4459                 return num_codecs;
4460         }
4461         component = devm_kzalloc(dev,
4462                                  sizeof *component * num_codecs,
4463                                  GFP_KERNEL);
4464         if (!component)
4465                 return -ENOMEM;
4466         dai_link->codecs = component;
4467         dai_link->num_codecs = num_codecs;
4468
4469         /* Parse the list */
4470         for (index = 0, component = dai_link->codecs;
4471              index < dai_link->num_codecs;
4472              index++, component++) {
4473                 ret = of_parse_phandle_with_args(of_node, name,
4474                                                  "#sound-dai-cells",
4475                                                   index, &args);
4476                 if (ret)
4477                         goto err;
4478                 component->of_node = args.np;
4479                 ret = snd_soc_get_dai_name(&args, &component->dai_name);
4480                 if (ret < 0)
4481                         goto err;
4482         }
4483         return 0;
4484 err:
4485         for (index = 0, component = dai_link->codecs;
4486              index < dai_link->num_codecs;
4487              index++, component++) {
4488                 if (!component->of_node)
4489                         break;
4490                 of_node_put(component->of_node);
4491                 component->of_node = NULL;
4492         }
4493         dai_link->codecs = NULL;
4494         dai_link->num_codecs = 0;
4495         return ret;
4496 }
4497 EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
4498
4499 static int __init snd_soc_init(void)
4500 {
4501         snd_soc_debugfs_init();
4502         snd_soc_util_init();
4503
4504         return platform_driver_register(&soc_driver);
4505 }
4506 module_init(snd_soc_init);
4507
4508 static void __exit snd_soc_exit(void)
4509 {
4510         snd_soc_util_exit();
4511         snd_soc_debugfs_exit();
4512
4513         platform_driver_unregister(&soc_driver);
4514 }
4515 module_exit(snd_soc_exit);
4516
4517 /* Module information */
4518 MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
4519 MODULE_DESCRIPTION("ALSA SoC Core");
4520 MODULE_LICENSE("GPL");
4521 MODULE_ALIAS("platform:soc-audio");