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