sound/soc/soc-core.c

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