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