Linux Audio

Check our new training course

In-person Linux kernel drivers training

Jun 16-20, 2025
Register
Loading...
v5.4
   1// SPDX-License-Identifier: GPL-2.0+
   2//
   3// soc-core.c  --  ALSA SoC Audio Layer
   4//
   5// Copyright 2005 Wolfson Microelectronics PLC.
   6// Copyright 2005 Openedhand Ltd.
   7// Copyright (C) 2010 Slimlogic Ltd.
   8// Copyright (C) 2010 Texas Instruments Inc.
   9//
  10// Author: Liam Girdwood <lrg@slimlogic.co.uk>
  11//         with code, comments and ideas from :-
  12//         Richard Purdie <richard@openedhand.com>
  13//
  14//  TODO:
  15//   o Add hw rules to enforce rates, etc.
  16//   o More testing with other codecs/machines.
  17//   o Add more codecs and platforms to ensure good API coverage.
  18//   o Support TDM on PCM and I2S
  19
  20#include <linux/module.h>
  21#include <linux/moduleparam.h>
  22#include <linux/init.h>
  23#include <linux/delay.h>
  24#include <linux/pm.h>
  25#include <linux/bitops.h>
  26#include <linux/debugfs.h>
  27#include <linux/platform_device.h>
  28#include <linux/pinctrl/consumer.h>
  29#include <linux/ctype.h>
  30#include <linux/slab.h>
  31#include <linux/of.h>
  32#include <linux/of_graph.h>
  33#include <linux/dmi.h>
 
  34#include <sound/core.h>
  35#include <sound/jack.h>
  36#include <sound/pcm.h>
  37#include <sound/pcm_params.h>
  38#include <sound/soc.h>
  39#include <sound/soc-dpcm.h>
  40#include <sound/soc-topology.h>
 
  41#include <sound/initval.h>
  42
  43#define CREATE_TRACE_POINTS
  44#include <trace/events/asoc.h>
  45
  46#define NAME_SIZE	32
  47
  48#ifdef CONFIG_DEBUG_FS
  49struct dentry *snd_soc_debugfs_root;
  50EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
  51#endif
  52
  53static DEFINE_MUTEX(client_mutex);
  54static LIST_HEAD(component_list);
  55static LIST_HEAD(unbind_card_list);
  56
  57#define for_each_component(component)			\
  58	list_for_each_entry(component, &component_list, list)
  59
  60/*
  61 * This is used if driver don't need to have CPU/Codec/Platform
  62 * dai_link. see soc.h
  63 */
  64struct snd_soc_dai_link_component null_dailink_component[0];
  65EXPORT_SYMBOL_GPL(null_dailink_component);
  66
  67/*
  68 * This is a timeout to do a DAPM powerdown after a stream is closed().
  69 * It can be used to eliminate pops between different playback streams, e.g.
  70 * between two audio tracks.
  71 */
  72static int pmdown_time = 5000;
  73module_param(pmdown_time, int, 0);
  74MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
  75
  76#ifdef CONFIG_DMI
  77/*
  78 * If a DMI filed contain strings in this blacklist (e.g.
  79 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
  80 * as invalid and dropped when setting the card long name from DMI info.
  81 */
  82static const char * const dmi_blacklist[] = {
  83	"To be filled by OEM",
  84	"TBD by OEM",
  85	"Default String",
  86	"Board Manufacturer",
  87	"Board Vendor Name",
  88	"Board Product Name",
  89	NULL,	/* terminator */
  90};
  91#endif
  92
  93static ssize_t pmdown_time_show(struct device *dev,
  94				struct device_attribute *attr, char *buf)
  95{
  96	struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
  97
  98	return sprintf(buf, "%ld\n", rtd->pmdown_time);
  99}
 100
 101static ssize_t pmdown_time_set(struct device *dev,
 102			       struct device_attribute *attr,
 103			       const char *buf, size_t count)
 104{
 105	struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 106	int ret;
 107
 108	ret = kstrtol(buf, 10, &rtd->pmdown_time);
 109	if (ret)
 110		return ret;
 111
 112	return count;
 113}
 114
 115static DEVICE_ATTR(pmdown_time, 0644, pmdown_time_show, pmdown_time_set);
 116
 117static struct attribute *soc_dev_attrs[] = {
 118	&dev_attr_pmdown_time.attr,
 119	NULL
 120};
 121
 122static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
 123				       struct attribute *attr, int idx)
 124{
 125	struct device *dev = kobj_to_dev(kobj);
 126	struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 127
 
 
 
 128	if (attr == &dev_attr_pmdown_time.attr)
 129		return attr->mode; /* always visible */
 130	return rtd->num_codecs ? attr->mode : 0; /* enabled only with codec */
 131}
 132
 133static const struct attribute_group soc_dapm_dev_group = {
 134	.attrs = soc_dapm_dev_attrs,
 135	.is_visible = soc_dev_attr_is_visible,
 136};
 137
 138static const struct attribute_group soc_dev_group = {
 139	.attrs = soc_dev_attrs,
 140	.is_visible = soc_dev_attr_is_visible,
 141};
 142
 143static const struct attribute_group *soc_dev_attr_groups[] = {
 144	&soc_dapm_dev_group,
 145	&soc_dev_group,
 146	NULL
 147};
 148
 149#ifdef CONFIG_DEBUG_FS
 
 
 
 150static void soc_init_component_debugfs(struct snd_soc_component *component)
 151{
 152	if (!component->card->debugfs_card_root)
 153		return;
 154
 155	if (component->debugfs_prefix) {
 156		char *name;
 157
 158		name = kasprintf(GFP_KERNEL, "%s:%s",
 159			component->debugfs_prefix, component->name);
 160		if (name) {
 161			component->debugfs_root = debugfs_create_dir(name,
 162				component->card->debugfs_card_root);
 163			kfree(name);
 164		}
 165	} else {
 166		component->debugfs_root = debugfs_create_dir(component->name,
 167				component->card->debugfs_card_root);
 168	}
 169
 170	snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
 171		component->debugfs_root);
 172}
 173
 174static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
 175{
 176	if (!component->debugfs_root)
 177		return;
 178	debugfs_remove_recursive(component->debugfs_root);
 179	component->debugfs_root = NULL;
 180}
 181
 182static int dai_list_show(struct seq_file *m, void *v)
 183{
 184	struct snd_soc_component *component;
 185	struct snd_soc_dai *dai;
 186
 187	mutex_lock(&client_mutex);
 188
 189	for_each_component(component)
 190		for_each_component_dais(component, dai)
 191			seq_printf(m, "%s\n", dai->name);
 192
 193	mutex_unlock(&client_mutex);
 194
 195	return 0;
 196}
 197DEFINE_SHOW_ATTRIBUTE(dai_list);
 198
 199static int component_list_show(struct seq_file *m, void *v)
 200{
 201	struct snd_soc_component *component;
 202
 203	mutex_lock(&client_mutex);
 204
 205	for_each_component(component)
 206		seq_printf(m, "%s\n", component->name);
 207
 208	mutex_unlock(&client_mutex);
 209
 210	return 0;
 211}
 212DEFINE_SHOW_ATTRIBUTE(component_list);
 213
 214static void soc_init_card_debugfs(struct snd_soc_card *card)
 215{
 216	card->debugfs_card_root = debugfs_create_dir(card->name,
 217						     snd_soc_debugfs_root);
 218
 219	debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
 220			   &card->pop_time);
 221
 222	snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
 223}
 224
 225static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 226{
 227	debugfs_remove_recursive(card->debugfs_card_root);
 228	card->debugfs_card_root = NULL;
 229}
 230
 231static void snd_soc_debugfs_init(void)
 232{
 233	snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
 234
 235	debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
 236			    &dai_list_fops);
 237
 238	debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
 239			    &component_list_fops);
 240}
 241
 242static void snd_soc_debugfs_exit(void)
 243{
 244	debugfs_remove_recursive(snd_soc_debugfs_root);
 245}
 246
 247#else
 248
 249static inline void soc_init_component_debugfs(
 250	struct snd_soc_component *component)
 251{
 252}
 
 
 253
 254static inline void soc_cleanup_component_debugfs(
 255	struct snd_soc_component *component)
 
 
 256{
 
 
 
 
 
 
 
 
 
 
 
 257}
 258
 259static inline void soc_init_card_debugfs(struct snd_soc_card *card)
 260{
 
 261}
 262
 263static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 264{
 
 265}
 266
 267static inline void snd_soc_debugfs_init(void)
 268{
 
 269}
 270
 271static inline void snd_soc_debugfs_exit(void)
 
 272{
 273}
 
 274
 275#endif
 
 276
 277static int snd_soc_rtdcom_add(struct snd_soc_pcm_runtime *rtd,
 278			      struct snd_soc_component *component)
 279{
 280	struct snd_soc_rtdcom_list *rtdcom;
 281
 282	for_each_rtdcom(rtd, rtdcom) {
 283		/* already connected */
 284		if (rtdcom->component == component)
 285			return 0;
 286	}
 287
 288	rtdcom = kmalloc(sizeof(*rtdcom), GFP_KERNEL);
 289	if (!rtdcom)
 290		return -ENOMEM;
 291
 292	rtdcom->component = component;
 293	INIT_LIST_HEAD(&rtdcom->list);
 
 294
 295	list_add_tail(&rtdcom->list, &rtd->component_list);
 
 
 296
 297	return 0;
 298}
 299
 300static void snd_soc_rtdcom_del_all(struct snd_soc_pcm_runtime *rtd)
 301{
 302	struct snd_soc_rtdcom_list *rtdcom1, *rtdcom2;
 
 
 303
 304	for_each_rtdcom_safe(rtd, rtdcom1, rtdcom2)
 305		kfree(rtdcom1);
 306
 307	INIT_LIST_HEAD(&rtd->component_list);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 308}
 309
 310struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 311						const char *driver_name)
 312{
 313	struct snd_soc_rtdcom_list *rtdcom;
 
 314
 315	if (!driver_name)
 316		return NULL;
 317
 318	/*
 319	 * NOTE
 320	 *
 321	 * snd_soc_rtdcom_lookup() will find component from rtd by using
 322	 * specified driver name.
 323	 * But, if many components which have same driver name are connected
 324	 * to 1 rtd, this function will return 1st found component.
 325	 */
 326	for_each_rtdcom(rtd, rtdcom) {
 327		const char *component_name = rtdcom->component->driver->name;
 328
 329		if (!component_name)
 330			continue;
 331
 332		if ((component_name == driver_name) ||
 333		    strcmp(component_name, driver_name) == 0)
 334			return rtdcom->component;
 335	}
 336
 337	return NULL;
 338}
 339EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
 340
 341struct snd_pcm_substream *snd_soc_get_dai_substream(struct snd_soc_card *card,
 342		const char *dai_link, int stream)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 343{
 344	struct snd_soc_pcm_runtime *rtd;
 345
 346	for_each_card_rtds(card, rtd) {
 347		if (rtd->dai_link->no_pcm &&
 348			!strcmp(rtd->dai_link->name, dai_link))
 349			return rtd->pcm->streams[stream].substream;
 350	}
 351	dev_dbg(card->dev, "ASoC: failed to find dai link %s\n", dai_link);
 352	return NULL;
 353}
 354EXPORT_SYMBOL_GPL(snd_soc_get_dai_substream);
 355
 356static const struct snd_soc_ops null_snd_soc_ops;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 357
 358static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
 359	struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
 360{
 361	struct snd_soc_pcm_runtime *rtd;
 
 
 
 
 362
 363	rtd = kzalloc(sizeof(struct snd_soc_pcm_runtime), GFP_KERNEL);
 364	if (!rtd)
 
 
 
 365		return NULL;
 366
 367	INIT_LIST_HEAD(&rtd->component_list);
 368	rtd->card = card;
 369	rtd->dai_link = dai_link;
 370	if (!rtd->dai_link->ops)
 371		rtd->dai_link->ops = &null_snd_soc_ops;
 372
 373	rtd->codec_dais = kcalloc(dai_link->num_codecs,
 374					sizeof(struct snd_soc_dai *),
 375					GFP_KERNEL);
 376	if (!rtd->codec_dais) {
 377		kfree(rtd);
 378		return NULL;
 379	}
 380
 381	return rtd;
 382}
 
 
 
 
 
 
 
 
 
 
 
 383
 384static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
 385{
 386	kfree(rtd->codec_dais);
 387	snd_soc_rtdcom_del_all(rtd);
 388	kfree(rtd);
 389}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 390
 391static void soc_add_pcm_runtime(struct snd_soc_card *card,
 392		struct snd_soc_pcm_runtime *rtd)
 393{
 394	/* see for_each_card_rtds */
 395	list_add_tail(&rtd->list, &card->rtd_list);
 396	rtd->num = card->num_rtd;
 397	card->num_rtd++;
 
 
 
 
 
 
 
 
 398}
 399
 400static void soc_remove_pcm_runtimes(struct snd_soc_card *card)
 401{
 402	struct snd_soc_pcm_runtime *rtd, *_rtd;
 
 403
 404	for_each_card_rtds_safe(card, rtd, _rtd) {
 405		list_del(&rtd->list);
 406		soc_free_pcm_runtime(rtd);
 
 
 
 
 
 
 
 
 
 
 
 407	}
 
 408
 409	card->num_rtd = 0;
 
 
 
 
 
 410}
 411
 412struct snd_soc_pcm_runtime *snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 413		const char *dai_link)
 414{
 415	struct snd_soc_pcm_runtime *rtd;
 
 
 
 416
 417	for_each_card_rtds(card, rtd) {
 418		if (!strcmp(rtd->dai_link->name, dai_link))
 419			return rtd;
 
 
 
 
 
 
 420	}
 421	dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link);
 422	return NULL;
 423}
 424EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
 425
 426static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
 427{
 428	struct snd_soc_pcm_runtime *rtd;
 
 429
 430	for_each_card_rtds(card, rtd)
 431		flush_delayed_work(&rtd->delayed_work);
 
 
 
 
 
 
 432}
 433
 434#ifdef CONFIG_PM_SLEEP
 435/* powers down audio subsystem for suspend */
 436int snd_soc_suspend(struct device *dev)
 437{
 438	struct snd_soc_card *card = dev_get_drvdata(dev);
 439	struct snd_soc_component *component;
 440	struct snd_soc_pcm_runtime *rtd;
 441	int i;
 442
 443	/* If the card is not initialized yet there is nothing to do */
 444	if (!card->instantiated)
 445		return 0;
 446
 447	/*
 448	 * Due to the resume being scheduled into a workqueue we could
 449	 * suspend before that's finished - wait for it to complete.
 450	 */
 451	snd_power_wait(card->snd_card, SNDRV_CTL_POWER_D0);
 452
 453	/* we're going to block userspace touching us until resume completes */
 454	snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
 455
 456	/* mute any active DACs */
 457	for_each_card_rtds(card, rtd) {
 458		struct snd_soc_dai *dai;
 459
 460		if (rtd->dai_link->ignore_suspend)
 461			continue;
 462
 463		for_each_rtd_codec_dai(rtd, i, dai) {
 464			if (dai->playback_active)
 465				snd_soc_dai_digital_mute(dai, 1,
 466						SNDRV_PCM_STREAM_PLAYBACK);
 467		}
 468	}
 469
 470	/* suspend all pcms */
 471	for_each_card_rtds(card, rtd) {
 472		if (rtd->dai_link->ignore_suspend)
 473			continue;
 474
 475		snd_pcm_suspend_all(rtd->pcm);
 476	}
 477
 478	if (card->suspend_pre)
 479		card->suspend_pre(card);
 480
 481	for_each_card_rtds(card, rtd) {
 482		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 483
 484		if (rtd->dai_link->ignore_suspend)
 485			continue;
 486
 487		if (!cpu_dai->driver->bus_control)
 488			snd_soc_dai_suspend(cpu_dai);
 489	}
 490
 491	/* close any waiting streams */
 492	snd_soc_flush_all_delayed_work(card);
 493
 494	for_each_card_rtds(card, rtd) {
 495
 496		if (rtd->dai_link->ignore_suspend)
 497			continue;
 498
 499		snd_soc_dapm_stream_event(rtd,
 500					  SNDRV_PCM_STREAM_PLAYBACK,
 501					  SND_SOC_DAPM_STREAM_SUSPEND);
 502
 503		snd_soc_dapm_stream_event(rtd,
 504					  SNDRV_PCM_STREAM_CAPTURE,
 505					  SND_SOC_DAPM_STREAM_SUSPEND);
 506	}
 507
 508	/* Recheck all endpoints too, their state is affected by suspend */
 509	dapm_mark_endpoints_dirty(card);
 510	snd_soc_dapm_sync(&card->dapm);
 511
 512	/* suspend all COMPONENTs */
 513	for_each_card_components(card, component) {
 514		struct snd_soc_dapm_context *dapm =
 
 
 
 
 
 515				snd_soc_component_get_dapm(component);
 516
 517		/*
 518		 * If there are paths active then the COMPONENT will be held
 519		 * with bias _ON and should not be suspended.
 520		 */
 521		if (!snd_soc_component_is_suspended(component)) {
 
 
 
 
 
 522			switch (snd_soc_dapm_get_bias_level(dapm)) {
 523			case SND_SOC_BIAS_STANDBY:
 524				/*
 525				 * If the COMPONENT is capable of idle
 526				 * bias off then being in STANDBY
 527				 * means it's doing something,
 528				 * otherwise fall through.
 529				 */
 530				if (dapm->idle_bias_off) {
 531					dev_dbg(component->dev,
 532						"ASoC: idle_bias_off CODEC on over suspend\n");
 533					break;
 534				}
 535				/* fall through */
 536
 537			case SND_SOC_BIAS_OFF:
 538				snd_soc_component_suspend(component);
 539				if (component->regmap)
 540					regcache_mark_dirty(component->regmap);
 541				/* deactivate pins to sleep state */
 542				pinctrl_pm_select_sleep_state(component->dev);
 543				break;
 544			default:
 545				dev_dbg(component->dev,
 546					"ASoC: COMPONENT is on over suspend\n");
 547				break;
 548			}
 549		}
 550	}
 551
 552	for_each_card_rtds(card, rtd) {
 553		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 554
 555		if (rtd->dai_link->ignore_suspend)
 556			continue;
 557
 558		if (cpu_dai->driver->bus_control)
 559			snd_soc_dai_suspend(cpu_dai);
 560
 561		/* deactivate pins to sleep state */
 562		pinctrl_pm_select_sleep_state(cpu_dai->dev);
 563	}
 564
 565	if (card->suspend_post)
 566		card->suspend_post(card);
 567
 568	return 0;
 569}
 570EXPORT_SYMBOL_GPL(snd_soc_suspend);
 571
 572/*
 573 * deferred resume work, so resume can complete before we finished
 574 * setting our codec back up, which can be very slow on I2C
 575 */
 576static void soc_resume_deferred(struct work_struct *work)
 577{
 578	struct snd_soc_card *card =
 579			container_of(work, struct snd_soc_card,
 580				     deferred_resume_work);
 581	struct snd_soc_pcm_runtime *rtd;
 582	struct snd_soc_component *component;
 583	int i;
 584
 585	/*
 586	 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
 587	 * so userspace apps are blocked from touching us
 588	 */
 589
 590	dev_dbg(card->dev, "ASoC: starting resume work\n");
 591
 592	/* Bring us up into D2 so that DAPM starts enabling things */
 593	snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
 594
 595	if (card->resume_pre)
 596		card->resume_pre(card);
 597
 598	/* resume control bus DAIs */
 599	for_each_card_rtds(card, rtd) {
 600		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 601
 602		if (rtd->dai_link->ignore_suspend)
 603			continue;
 604
 605		if (cpu_dai->driver->bus_control)
 606			snd_soc_dai_resume(cpu_dai);
 607	}
 608
 609	for_each_card_components(card, component) {
 610		if (snd_soc_component_is_suspended(component))
 611			snd_soc_component_resume(component);
 612	}
 613
 614	for_each_card_rtds(card, rtd) {
 615
 616		if (rtd->dai_link->ignore_suspend)
 617			continue;
 618
 619		snd_soc_dapm_stream_event(rtd,
 620					  SNDRV_PCM_STREAM_PLAYBACK,
 621					  SND_SOC_DAPM_STREAM_RESUME);
 622
 623		snd_soc_dapm_stream_event(rtd,
 624					  SNDRV_PCM_STREAM_CAPTURE,
 625					  SND_SOC_DAPM_STREAM_RESUME);
 626	}
 627
 628	/* unmute any active DACs */
 629	for_each_card_rtds(card, rtd) {
 630		struct snd_soc_dai *dai;
 631
 632		if (rtd->dai_link->ignore_suspend)
 633			continue;
 634
 635		for_each_rtd_codec_dai(rtd, i, dai) {
 636			if (dai->playback_active)
 637				snd_soc_dai_digital_mute(dai, 0,
 638						SNDRV_PCM_STREAM_PLAYBACK);
 639		}
 640	}
 641
 642	for_each_card_rtds(card, rtd) {
 643		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 644
 645		if (rtd->dai_link->ignore_suspend)
 646			continue;
 647
 648		if (!cpu_dai->driver->bus_control)
 649			snd_soc_dai_resume(cpu_dai);
 650	}
 651
 652	if (card->resume_post)
 653		card->resume_post(card);
 654
 655	dev_dbg(card->dev, "ASoC: resume work completed\n");
 656
 657	/* Recheck all endpoints too, their state is affected by suspend */
 658	dapm_mark_endpoints_dirty(card);
 659	snd_soc_dapm_sync(&card->dapm);
 660
 661	/* userspace can access us now we are back as we were before */
 662	snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
 663}
 664
 665/* powers up audio subsystem after a suspend */
 666int snd_soc_resume(struct device *dev)
 667{
 668	struct snd_soc_card *card = dev_get_drvdata(dev);
 669	bool bus_control = false;
 670	struct snd_soc_pcm_runtime *rtd;
 671	struct snd_soc_dai *codec_dai;
 672	int i;
 673
 674	/* If the card is not initialized yet there is nothing to do */
 675	if (!card->instantiated)
 676		return 0;
 677
 678	/* activate pins from sleep state */
 679	for_each_card_rtds(card, rtd) {
 680		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 681
 682		if (cpu_dai->active)
 683			pinctrl_pm_select_default_state(cpu_dai->dev);
 684
 685		for_each_rtd_codec_dai(rtd, i, codec_dai) {
 686			if (codec_dai->active)
 687				pinctrl_pm_select_default_state(codec_dai->dev);
 688		}
 689	}
 690
 691	/*
 692	 * DAIs that also act as the control bus master might have other drivers
 693	 * hanging off them so need to resume immediately. Other drivers don't
 694	 * have that problem and may take a substantial amount of time to resume
 695	 * due to I/O costs and anti-pop so handle them out of line.
 696	 */
 697	for_each_card_rtds(card, rtd) {
 698		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 699
 700		bus_control |= cpu_dai->driver->bus_control;
 701	}
 702	if (bus_control) {
 703		dev_dbg(dev, "ASoC: Resuming control bus master immediately\n");
 704		soc_resume_deferred(&card->deferred_resume_work);
 705	} else {
 706		dev_dbg(dev, "ASoC: Scheduling resume work\n");
 707		if (!schedule_work(&card->deferred_resume_work))
 708			dev_err(dev, "ASoC: resume work item may be lost\n");
 709	}
 710
 711	return 0;
 712}
 713EXPORT_SYMBOL_GPL(snd_soc_resume);
 714
 715static void soc_resume_init(struct snd_soc_card *card)
 716{
 717	/* deferred resume work */
 718	INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
 719}
 720#else
 721#define snd_soc_suspend NULL
 722#define snd_soc_resume NULL
 723static inline void soc_resume_init(struct snd_soc_card *card)
 724{
 725}
 726#endif
 727
 728static const struct snd_soc_dai_ops null_dai_ops = {
 729};
 730
 731static struct device_node
 732*soc_component_to_node(struct snd_soc_component *component)
 733{
 734	struct device_node *of_node;
 735
 736	of_node = component->dev->of_node;
 737	if (!of_node && component->dev->parent)
 738		of_node = component->dev->parent->of_node;
 739
 740	return of_node;
 741}
 742
 
 
 
 
 
 
 
 
 
 
 
 
 
 743static int snd_soc_is_matching_component(
 744	const struct snd_soc_dai_link_component *dlc,
 745	struct snd_soc_component *component)
 746{
 747	struct device_node *component_of_node;
 748
 749	if (!dlc)
 750		return 0;
 751
 
 
 
 
 
 
 
 
 
 752	component_of_node = soc_component_to_node(component);
 753
 754	if (dlc->of_node && component_of_node != dlc->of_node)
 755		return 0;
 756	if (dlc->name && strcmp(component->name, dlc->name))
 757		return 0;
 758
 759	return 1;
 760}
 761
 762static struct snd_soc_component *soc_find_component(
 763	const struct snd_soc_dai_link_component *dlc)
 764{
 765	struct snd_soc_component *component;
 766
 767	lockdep_assert_held(&client_mutex);
 768
 769	/*
 770	 * NOTE
 771	 *
 772	 * It returns *1st* found component, but some driver
 773	 * has few components by same of_node/name
 774	 * ex)
 775	 *	CPU component and generic DMAEngine component
 776	 */
 777	for_each_component(component)
 778		if (snd_soc_is_matching_component(dlc, component))
 779			return component;
 780
 781	return NULL;
 782}
 783
 784/**
 785 * snd_soc_find_dai - Find a registered DAI
 786 *
 787 * @dlc: name of the DAI or the DAI driver and optional component info to match
 788 *
 789 * This function will search all registered components and their DAIs to
 790 * find the DAI of the same name. The component's of_node and name
 791 * should also match if being specified.
 792 *
 793 * Return: pointer of DAI, or NULL if not found.
 794 */
 795struct snd_soc_dai *snd_soc_find_dai(
 796	const struct snd_soc_dai_link_component *dlc)
 797{
 798	struct snd_soc_component *component;
 799	struct snd_soc_dai *dai;
 800
 801	lockdep_assert_held(&client_mutex);
 802
 803	/* Find CPU DAI from registered DAIs */
 804	for_each_component(component) {
 805		if (!snd_soc_is_matching_component(dlc, component))
 806			continue;
 807		for_each_component_dais(component, dai) {
 808			if (dlc->dai_name && strcmp(dai->name, dlc->dai_name)
 809			    && (!dai->driver->name
 810				|| strcmp(dai->driver->name, dlc->dai_name)))
 811				continue;
 812
 813			return dai;
 814		}
 815	}
 816
 817	return NULL;
 818}
 819EXPORT_SYMBOL_GPL(snd_soc_find_dai);
 820
 821/**
 822 * snd_soc_find_dai_link - Find a DAI link
 823 *
 824 * @card: soc card
 825 * @id: DAI link ID to match
 826 * @name: DAI link name to match, optional
 827 * @stream_name: DAI link stream name to match, optional
 828 *
 829 * This function will search all existing DAI links of the soc card to
 830 * find the link of the same ID. Since DAI links may not have their
 831 * unique ID, so name and stream name should also match if being
 832 * specified.
 833 *
 834 * Return: pointer of DAI link, or NULL if not found.
 835 */
 836struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
 837					       int id, const char *name,
 838					       const char *stream_name)
 839{
 840	struct snd_soc_dai_link *link;
 841
 842	lockdep_assert_held(&client_mutex);
 
 
 843
 844	for_each_card_links(card, link) {
 845		if (link->id != id)
 846			continue;
 847
 848		if (name && (!link->name || strcmp(name, link->name)))
 849			continue;
 
 
 
 850
 851		if (stream_name && (!link->stream_name
 852			|| strcmp(stream_name, link->stream_name)))
 853			continue;
 
 
 
 
 
 854
 855		return link;
 
 
 
 
 
 
 
 
 
 
 
 
 856	}
 857
 858	return NULL;
 859}
 860EXPORT_SYMBOL_GPL(snd_soc_find_dai_link);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 861
 862static bool soc_is_dai_link_bound(struct snd_soc_card *card,
 863		struct snd_soc_dai_link *dai_link)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 864{
 865	struct snd_soc_pcm_runtime *rtd;
 
 866
 867	for_each_card_rtds(card, rtd) {
 868		if (rtd->dai_link == dai_link)
 869			return true;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 870	}
 871
 872	return false;
 873}
 874
 875static int soc_bind_dai_link(struct snd_soc_card *card,
 876	struct snd_soc_dai_link *dai_link)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 877{
 878	struct snd_soc_pcm_runtime *rtd;
 879	struct snd_soc_dai_link_component *codec, *platform;
 880	struct snd_soc_component *component;
 881	int i;
 
 
 
 
 
 
 
 
 
 882
 883	if (dai_link->ignore)
 884		return 0;
 885
 886	dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
 887
 888	if (soc_is_dai_link_bound(card, dai_link)) {
 889		dev_dbg(card->dev, "ASoC: dai link %s already bound\n",
 890			dai_link->name);
 891		return 0;
 892	}
 893
 894	rtd = soc_new_pcm_runtime(card, dai_link);
 895	if (!rtd)
 896		return -ENOMEM;
 897
 898	/* FIXME: we need multi CPU support in the future */
 899	rtd->cpu_dai = snd_soc_find_dai(dai_link->cpus);
 900	if (!rtd->cpu_dai) {
 901		dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
 902			 dai_link->cpus->dai_name);
 903		goto _err_defer;
 
 
 904	}
 905	snd_soc_rtdcom_add(rtd, rtd->cpu_dai->component);
 906
 907	/* Find CODEC from registered CODECs */
 908	rtd->num_codecs = dai_link->num_codecs;
 909	for_each_link_codecs(dai_link, i, codec) {
 910		rtd->codec_dais[i] = snd_soc_find_dai(codec);
 911		if (!rtd->codec_dais[i]) {
 912			dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
 913				 codec->dai_name);
 914			goto _err_defer;
 915		}
 916
 917		snd_soc_rtdcom_add(rtd, rtd->codec_dais[i]->component);
 918	}
 919
 920	/* Single codec links expect codec and codec_dai in runtime data */
 921	rtd->codec_dai = rtd->codec_dais[0];
 922
 923	/* Find PLATFORM from registered PLATFORMs */
 924	for_each_link_platforms(dai_link, i, platform) {
 925		for_each_component(component) {
 926			if (!snd_soc_is_matching_component(platform, component))
 927				continue;
 928
 929			snd_soc_rtdcom_add(rtd, component);
 930		}
 931	}
 932
 933	soc_add_pcm_runtime(card, rtd);
 934	return 0;
 935
 936_err_defer:
 937	soc_free_pcm_runtime(rtd);
 938	return -EPROBE_DEFER;
 939}
 940
 941static void soc_set_of_name_prefix(struct snd_soc_component *component)
 
 
 942{
 943	struct device_node *of_node = soc_component_to_node(component);
 944	const char *str;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 945	int ret;
 946
 947	ret = of_property_read_string(of_node, "sound-name-prefix", &str);
 948	if (!ret)
 949		component->name_prefix = str;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 950}
 951
 952static void soc_set_name_prefix(struct snd_soc_card *card,
 953				struct snd_soc_component *component)
 954{
 955	int i;
 
 
 956
 957	for (i = 0; i < card->num_configs && card->codec_conf; i++) {
 958		struct snd_soc_codec_conf *map = &card->codec_conf[i];
 959		struct device_node *of_node = soc_component_to_node(component);
 960
 961		if (map->of_node && of_node != map->of_node)
 962			continue;
 963		if (map->dev_name && strcmp(component->name, map->dev_name))
 964			continue;
 965		component->name_prefix = map->name_prefix;
 966		return;
 967	}
 968
 969	/*
 970	 * If there is no configuration table or no match in the table,
 971	 * check if a prefix is provided in the node
 972	 */
 973	soc_set_of_name_prefix(component);
 
 
 
 
 974}
 975
 976static void soc_cleanup_component(struct snd_soc_component *component)
 
 977{
 978	/* For framework level robustness */
 979	snd_soc_component_set_jack(component, NULL, NULL);
 
 
 
 
 980
 981	list_del_init(&component->card_list);
 982	snd_soc_dapm_free(snd_soc_component_get_dapm(component));
 983	soc_cleanup_component_debugfs(component);
 984	component->card = NULL;
 985	snd_soc_component_module_put_when_remove(component);
 986}
 987
 988static void soc_remove_component(struct snd_soc_component *component)
 989{
 990	if (!component->card)
 991		return;
 992
 993	snd_soc_component_remove(component);
 994
 995	soc_cleanup_component(component);
 996}
 997
 998static int soc_probe_component(struct snd_soc_card *card,
 999			       struct snd_soc_component *component)
1000{
1001	struct snd_soc_dapm_context *dapm =
1002		snd_soc_component_get_dapm(component);
1003	struct snd_soc_dai *dai;
 
1004	int ret;
1005
1006	if (!strcmp(component->name, "snd-soc-dummy"))
1007		return 0;
1008
1009	if (component->card) {
1010		if (component->card != card) {
1011			dev_err(component->dev,
1012				"Trying to bind component to card \"%s\" but is already bound to card \"%s\"\n",
1013				card->name, component->card->name);
1014			return -ENODEV;
1015		}
1016		return 0;
1017	}
1018
1019	ret = snd_soc_component_module_get_when_probe(component);
1020	if (ret < 0)
1021		return ret;
1022
1023	component->card = card;
1024	soc_set_name_prefix(card, component);
1025
1026	soc_init_component_debugfs(component);
1027
1028	snd_soc_dapm_init(dapm, card, component);
1029
1030	ret = snd_soc_dapm_new_controls(dapm,
1031					component->driver->dapm_widgets,
1032					component->driver->num_dapm_widgets);
1033
1034	if (ret != 0) {
1035		dev_err(component->dev,
1036			"Failed to create new controls %d\n", ret);
1037		goto err_probe;
1038	}
1039
1040	for_each_component_dais(component, dai) {
1041		ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1042		if (ret != 0) {
1043			dev_err(component->dev,
1044				"Failed to create DAI widgets %d\n", ret);
1045			goto err_probe;
1046		}
1047	}
1048
1049	ret = snd_soc_component_probe(component);
1050	if (ret < 0) {
1051		dev_err(component->dev,
1052			"ASoC: failed to probe component %d\n", ret);
1053		goto err_probe;
1054	}
1055	WARN(dapm->idle_bias_off &&
1056	     dapm->bias_level != SND_SOC_BIAS_OFF,
1057	     "codec %s can not start from non-off bias with idle_bias_off==1\n",
1058	     component->name);
 
1059
1060	/* machine specific init */
1061	if (component->init) {
1062		ret = component->init(component);
1063		if (ret < 0) {
1064			dev_err(component->dev,
1065				"Failed to do machine specific init %d\n", ret);
1066			goto err_probe;
1067		}
1068	}
1069
1070	ret = snd_soc_add_component_controls(component,
1071					     component->driver->controls,
1072					     component->driver->num_controls);
1073	if (ret < 0)
1074		goto err_probe;
1075
1076	ret = snd_soc_dapm_add_routes(dapm,
1077				      component->driver->dapm_routes,
1078				      component->driver->num_dapm_routes);
1079	if (ret < 0)
1080		goto err_probe;
 
 
 
 
 
 
 
 
 
 
1081
1082	/* see for_each_card_components */
1083	list_add(&component->card_list, &card->component_dev_list);
1084
1085err_probe:
1086	if (ret < 0)
1087		soc_cleanup_component(component);
1088
1089	return ret;
1090}
1091
1092static void soc_remove_dai(struct snd_soc_dai *dai, int order)
1093{
1094	int err;
1095
1096	if (!dai || !dai->probed || !dai->driver ||
1097	    dai->driver->remove_order != order)
1098		return;
1099
1100	err = snd_soc_dai_remove(dai);
1101	if (err < 0)
1102		dev_err(dai->dev,
1103			"ASoC: failed to remove %s: %d\n",
1104			dai->name, err);
1105
1106	dai->probed = 0;
1107}
1108
1109static int soc_probe_dai(struct snd_soc_dai *dai, int order)
1110{
1111	int ret;
1112
1113	if (dai->probed ||
1114	    dai->driver->probe_order != order)
1115		return 0;
1116
1117	ret = snd_soc_dai_probe(dai);
1118	if (ret < 0) {
1119		dev_err(dai->dev, "ASoC: failed to probe DAI %s: %d\n",
1120			dai->name, ret);
1121		return ret;
1122	}
1123
1124	dai->probed = 1;
1125
1126	return 0;
1127}
1128
1129static void soc_rtd_free(struct snd_soc_pcm_runtime *rtd); /* remove me */
1130static void soc_remove_link_dais(struct snd_soc_card *card)
1131{
1132	int i;
1133	struct snd_soc_dai *codec_dai;
1134	struct snd_soc_pcm_runtime *rtd;
1135	int order;
1136
1137	for_each_comp_order(order) {
1138		for_each_card_rtds(card, rtd) {
1139
1140			/* finalize rtd device */
1141			soc_rtd_free(rtd);
1142
1143			/* remove the CODEC DAI */
1144			for_each_rtd_codec_dai(rtd, i, codec_dai)
1145				soc_remove_dai(codec_dai, order);
1146
1147			soc_remove_dai(rtd->cpu_dai, order);
1148		}
1149	}
1150}
1151
1152static int soc_probe_link_dais(struct snd_soc_card *card)
1153{
1154	struct snd_soc_dai *codec_dai;
1155	struct snd_soc_pcm_runtime *rtd;
1156	int i, order, ret;
1157
1158	for_each_comp_order(order) {
1159		for_each_card_rtds(card, rtd) {
1160
1161			dev_dbg(card->dev,
1162				"ASoC: probe %s dai link %d late %d\n",
1163				card->name, rtd->num, order);
1164
1165			ret = soc_probe_dai(rtd->cpu_dai, order);
1166			if (ret)
1167				return ret;
1168
1169			/* probe the CODEC DAI */
1170			for_each_rtd_codec_dai(rtd, i, codec_dai) {
1171				ret = soc_probe_dai(codec_dai, order);
1172				if (ret)
1173					return ret;
1174			}
1175		}
1176	}
1177
1178	return 0;
1179}
1180
1181static void soc_remove_link_components(struct snd_soc_card *card)
1182{
1183	struct snd_soc_component *component;
1184	struct snd_soc_pcm_runtime *rtd;
1185	struct snd_soc_rtdcom_list *rtdcom;
1186	int order;
1187
1188	for_each_comp_order(order) {
1189		for_each_card_rtds(card, rtd) {
1190			for_each_rtdcom(rtd, rtdcom) {
1191				component = rtdcom->component;
1192
1193				if (component->driver->remove_order != order)
1194					continue;
1195
1196				soc_remove_component(component);
1197			}
1198		}
1199	}
1200}
1201
1202static int soc_probe_link_components(struct snd_soc_card *card)
1203{
1204	struct snd_soc_component *component;
1205	struct snd_soc_pcm_runtime *rtd;
1206	struct snd_soc_rtdcom_list *rtdcom;
1207	int ret, order;
1208
1209	for_each_comp_order(order) {
1210		for_each_card_rtds(card, rtd) {
1211			for_each_rtdcom(rtd, rtdcom) {
1212				component = rtdcom->component;
1213
1214				if (component->driver->probe_order != order)
1215					continue;
1216
1217				ret = soc_probe_component(card, component);
1218				if (ret < 0)
1219					return ret;
1220			}
1221		}
1222	}
1223
1224	return 0;
1225}
1226
1227static void soc_remove_dai_links(struct snd_soc_card *card)
1228{
1229	struct snd_soc_dai_link *link, *_link;
1230
1231	soc_remove_link_dais(card);
1232
1233	soc_remove_link_components(card);
1234
1235	for_each_card_links_safe(card, link, _link) {
1236		if (link->dobj.type == SND_SOC_DOBJ_DAI_LINK)
1237			dev_warn(card->dev, "Topology forgot to remove link %s?\n",
1238				link->name);
1239
1240		list_del(&link->list);
1241	}
1242}
1243
1244static int soc_init_dai_link(struct snd_soc_card *card,
1245			     struct snd_soc_dai_link *link)
1246{
1247	int i;
1248	struct snd_soc_dai_link_component *codec, *platform;
1249
1250	for_each_link_codecs(link, i, codec) {
1251		/*
1252		 * Codec must be specified by 1 of name or OF node,
1253		 * not both or neither.
1254		 */
1255		if (!!codec->name == !!codec->of_node) {
1256			dev_err(card->dev, "ASoC: Neither/both codec name/of_node are set for %s\n",
1257				link->name);
1258			return -EINVAL;
1259		}
1260
1261		/* Codec DAI name must be specified */
1262		if (!codec->dai_name) {
1263			dev_err(card->dev, "ASoC: codec_dai_name not set for %s\n",
1264				link->name);
1265			return -EINVAL;
1266		}
1267
1268		/*
1269		 * Defer card registration if codec component is not added to
1270		 * component list.
1271		 */
1272		if (!soc_find_component(codec))
1273			return -EPROBE_DEFER;
1274	}
1275
1276	for_each_link_platforms(link, i, platform) {
1277		/*
1278		 * Platform may be specified by either name or OF node, but it
1279		 * can be left unspecified, then no components will be inserted
1280		 * in the rtdcom list
1281		 */
1282		if (!!platform->name == !!platform->of_node) {
1283			dev_err(card->dev,
1284				"ASoC: Neither/both platform name/of_node are set for %s\n",
1285				link->name);
1286			return -EINVAL;
1287		}
1288
1289		/*
1290		 * Defer card registration if platform component is not added to
1291		 * component list.
1292		 */
1293		if (!soc_find_component(platform))
1294			return -EPROBE_DEFER;
1295	}
1296
1297	/* FIXME */
1298	if (link->num_cpus > 1) {
1299		dev_err(card->dev,
1300			"ASoC: multi cpu is not yet supported %s\n",
1301			link->name);
1302		return -EINVAL;
1303	}
1304
1305	/*
1306	 * CPU device may be specified by either name or OF node, but
1307	 * can be left unspecified, and will be matched based on DAI
1308	 * name alone..
1309	 */
1310	if (link->cpus->name && link->cpus->of_node) {
1311		dev_err(card->dev,
1312			"ASoC: Neither/both cpu name/of_node are set for %s\n",
1313			link->name);
1314		return -EINVAL;
1315	}
1316
1317	/*
1318	 * Defer card registartion if cpu dai component is not added to
1319	 * component list.
1320	 */
1321	if ((link->cpus->of_node || link->cpus->name) &&
1322	    !soc_find_component(link->cpus))
1323		return -EPROBE_DEFER;
1324
1325	/*
1326	 * At least one of CPU DAI name or CPU device name/node must be
1327	 * specified
1328	 */
1329	if (!link->cpus->dai_name &&
1330	    !(link->cpus->name || link->cpus->of_node)) {
1331		dev_err(card->dev,
1332			"ASoC: Neither cpu_dai_name nor cpu_name/of_node are set for %s\n",
1333			link->name);
1334		return -EINVAL;
1335	}
1336
1337	return 0;
1338}
1339
1340void snd_soc_disconnect_sync(struct device *dev)
1341{
1342	struct snd_soc_component *component =
1343			snd_soc_lookup_component(dev, NULL);
1344
1345	if (!component || !component->card)
1346		return;
1347
1348	snd_card_disconnect_sync(component->card->snd_card);
1349}
1350EXPORT_SYMBOL_GPL(snd_soc_disconnect_sync);
1351
1352/**
1353 * snd_soc_add_dai_link - Add a DAI link dynamically
1354 * @card: The ASoC card to which the DAI link is added
1355 * @dai_link: The new DAI link to add
1356 *
1357 * This function adds a DAI link to the ASoC card's link list.
1358 *
1359 * Note: Topology can use this API to add DAI links when probing the
1360 * topology component. And machine drivers can still define static
1361 * DAI links in dai_link array.
1362 */
1363int snd_soc_add_dai_link(struct snd_soc_card *card,
1364		struct snd_soc_dai_link *dai_link)
1365{
1366	if (dai_link->dobj.type
1367	    && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1368		dev_err(card->dev, "Invalid dai link type %d\n",
1369			dai_link->dobj.type);
1370		return -EINVAL;
1371	}
1372
1373	lockdep_assert_held(&client_mutex);
1374	/*
1375	 * Notify the machine driver for extra initialization
1376	 * on the link created by topology.
1377	 */
1378	if (dai_link->dobj.type && card->add_dai_link)
1379		card->add_dai_link(card, dai_link);
1380
1381	/* see for_each_card_links */
1382	list_add_tail(&dai_link->list, &card->dai_link_list);
1383
1384	return 0;
1385}
1386EXPORT_SYMBOL_GPL(snd_soc_add_dai_link);
1387
1388/**
1389 * snd_soc_remove_dai_link - Remove a DAI link from the list
1390 * @card: The ASoC card that owns the link
1391 * @dai_link: The DAI link to remove
1392 *
1393 * This function removes a DAI link from the ASoC card's link list.
1394 *
1395 * For DAI links previously added by topology, topology should
1396 * remove them by using the dobj embedded in the link.
1397 */
1398void snd_soc_remove_dai_link(struct snd_soc_card *card,
1399			     struct snd_soc_dai_link *dai_link)
1400{
1401	if (dai_link->dobj.type
1402	    && dai_link->dobj.type != SND_SOC_DOBJ_DAI_LINK) {
1403		dev_err(card->dev, "Invalid dai link type %d\n",
1404			dai_link->dobj.type);
1405		return;
1406	}
1407
1408	lockdep_assert_held(&client_mutex);
1409	/*
1410	 * Notify the machine driver for extra destruction
1411	 * on the link created by topology.
1412	 */
1413	if (dai_link->dobj.type && card->remove_dai_link)
1414		card->remove_dai_link(card, dai_link);
1415
1416	list_del(&dai_link->list);
1417}
1418EXPORT_SYMBOL_GPL(snd_soc_remove_dai_link);
1419
1420static void soc_rtd_free(struct snd_soc_pcm_runtime *rtd)
1421{
1422	if (rtd->dev_registered) {
1423		/* we don't need to call kfree() for rtd->dev */
1424		device_unregister(rtd->dev);
1425		rtd->dev_registered = 0;
1426	}
1427}
1428
1429static void soc_rtd_release(struct device *dev)
1430{
1431	kfree(dev);
1432}
1433
1434static int soc_rtd_init(struct snd_soc_pcm_runtime *rtd, const char *name)
1435{
1436	int ret = 0;
1437
1438	/* register the rtd device */
1439	rtd->dev = kzalloc(sizeof(struct device), GFP_KERNEL);
1440	if (!rtd->dev)
1441		return -ENOMEM;
1442	rtd->dev->parent = rtd->card->dev;
1443	rtd->dev->release = soc_rtd_release;
1444	rtd->dev->groups = soc_dev_attr_groups;
1445	dev_set_name(rtd->dev, "%s", name);
1446	dev_set_drvdata(rtd->dev, rtd);
1447	INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].be_clients);
1448	INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].be_clients);
1449	INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_PLAYBACK].fe_clients);
1450	INIT_LIST_HEAD(&rtd->dpcm[SNDRV_PCM_STREAM_CAPTURE].fe_clients);
1451	ret = device_register(rtd->dev);
1452	if (ret < 0) {
1453		/* calling put_device() here to free the rtd->dev */
1454		put_device(rtd->dev);
1455		dev_err(rtd->card->dev,
1456			"ASoC: failed to register runtime device: %d\n", ret);
1457		return ret;
1458	}
1459	rtd->dev_registered = 1;
1460	return 0;
1461}
1462
1463static int soc_link_dai_pcm_new(struct snd_soc_dai **dais, int num_dais,
1464				struct snd_soc_pcm_runtime *rtd)
1465{
1466	int i, ret = 0;
1467
1468	for (i = 0; i < num_dais; ++i) {
1469		struct snd_soc_dai_driver *drv = dais[i]->driver;
1470
1471		if (drv->pcm_new)
1472			ret = drv->pcm_new(rtd, dais[i]);
1473		if (ret < 0) {
1474			dev_err(dais[i]->dev,
1475				"ASoC: Failed to bind %s with pcm device\n",
1476				dais[i]->name);
1477			return ret;
1478		}
1479	}
1480
1481	return 0;
1482}
1483
1484static int soc_link_init(struct snd_soc_card *card,
1485			 struct snd_soc_pcm_runtime *rtd)
1486{
1487	struct snd_soc_dai_link *dai_link = rtd->dai_link;
1488	struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1489	struct snd_soc_rtdcom_list *rtdcom;
1490	struct snd_soc_component *component;
1491	int ret, num;
1492
1493	/* set default power off timeout */
1494	rtd->pmdown_time = pmdown_time;
1495
1496	/* do machine specific initialization */
1497	if (dai_link->init) {
1498		ret = dai_link->init(rtd);
1499		if (ret < 0) {
1500			dev_err(card->dev, "ASoC: failed to init %s: %d\n",
1501				dai_link->name, ret);
1502			return ret;
1503		}
1504	}
1505
1506	if (dai_link->dai_fmt) {
1507		ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1508		if (ret)
1509			return ret;
1510	}
1511
1512	ret = soc_rtd_init(rtd, dai_link->name);
1513	if (ret)
1514		return ret;
1515
1516	/* add DPCM sysfs entries */
1517	soc_dpcm_debugfs_add(rtd);
1518
1519	num = rtd->num;
1520
1521	/*
1522	 * most drivers will register their PCMs using DAI link ordering but
1523	 * topology based drivers can use the DAI link id field to set PCM
1524	 * device number and then use rtd + a base offset of the BEs.
1525	 */
1526	for_each_rtdcom(rtd, rtdcom) {
1527		component = rtdcom->component;
1528
1529		if (!component->driver->use_dai_pcm_id)
1530			continue;
1531
1532		if (rtd->dai_link->no_pcm)
1533			num += component->driver->be_pcm_base;
1534		else
1535			num = rtd->dai_link->id;
1536	}
1537
1538	/* create compress_device if possible */
1539	ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1540	if (ret != -ENOTSUPP) {
1541		if (ret < 0)
1542			dev_err(card->dev, "ASoC: can't create compress %s\n",
1543					 dai_link->stream_name);
1544		return ret;
1545	}
1546
1547	/* create the pcm */
1548	ret = soc_new_pcm(rtd, num);
1549	if (ret < 0) {
1550		dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1551			dai_link->stream_name, ret);
1552		return ret;
1553	}
1554	ret = soc_link_dai_pcm_new(&cpu_dai, 1, rtd);
1555	if (ret < 0)
1556		return ret;
1557	ret = soc_link_dai_pcm_new(rtd->codec_dais,
1558				   rtd->num_codecs, rtd);
1559	return ret;
1560}
1561
1562static void soc_unbind_aux_dev(struct snd_soc_card *card)
1563{
1564	struct snd_soc_component *component, *_component;
1565
1566	for_each_card_auxs_safe(card, component, _component) {
1567		component->init = NULL;
 
1568		list_del(&component->card_aux_list);
1569	}
1570}
1571
1572static int soc_bind_aux_dev(struct snd_soc_card *card)
1573{
1574	struct snd_soc_component *component;
1575	struct snd_soc_aux_dev *aux;
1576	int i;
1577
1578	for_each_card_pre_auxs(card, i, aux) {
1579		/* codecs, usually analog devices */
1580		component = soc_find_component(&aux->dlc);
1581		if (!component)
1582			return -EPROBE_DEFER;
1583
1584		component->init = aux->init;
 
1585		/* see for_each_card_auxs */
1586		list_add(&component->card_aux_list, &card->aux_comp_list);
1587	}
1588	return 0;
1589}
1590
1591static int soc_probe_aux_devices(struct snd_soc_card *card)
1592{
1593	struct snd_soc_component *comp;
1594	int order;
1595	int ret;
1596
1597	for_each_comp_order(order) {
1598		for_each_card_auxs(card, comp) {
1599			if (comp->driver->probe_order == order) {
1600				ret = soc_probe_component(card,	comp);
1601				if (ret < 0) {
1602					dev_err(card->dev,
1603						"ASoC: failed to probe aux component %s %d\n",
1604						comp->name, ret);
1605					return ret;
1606				}
1607			}
1608		}
1609	}
1610
1611	return 0;
1612}
1613
1614static void soc_remove_aux_devices(struct snd_soc_card *card)
1615{
1616	struct snd_soc_component *comp, *_comp;
1617	int order;
1618
1619	for_each_comp_order(order) {
1620		for_each_card_auxs_safe(card, comp, _comp) {
1621			if (comp->driver->remove_order == order)
1622				soc_remove_component(comp);
1623		}
1624	}
1625}
1626
1627/**
1628 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1629 * @rtd: The runtime for which the DAI link format should be changed
1630 * @dai_fmt: The new DAI link format
1631 *
1632 * This function updates the DAI link format for all DAIs connected to the DAI
1633 * link for the specified runtime.
1634 *
1635 * Note: For setups with a static format set the dai_fmt field in the
1636 * corresponding snd_dai_link struct instead of using this function.
1637 *
1638 * Returns 0 on success, otherwise a negative error code.
1639 */
1640int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1641	unsigned int dai_fmt)
1642{
1643	struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
1644	struct snd_soc_dai *codec_dai;
1645	unsigned int i;
1646	int ret;
1647
1648	for_each_rtd_codec_dai(rtd, i, codec_dai) {
1649		ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1650		if (ret != 0 && ret != -ENOTSUPP) {
1651			dev_warn(codec_dai->dev,
1652				 "ASoC: Failed to set DAI format: %d\n", ret);
1653			return ret;
1654		}
1655	}
1656
1657	/*
1658	 * Flip the polarity for the "CPU" end of a CODEC<->CODEC link
1659	 * the component which has non_legacy_dai_naming is Codec
1660	 */
1661	if (cpu_dai->component->driver->non_legacy_dai_naming) {
1662		unsigned int inv_dai_fmt;
1663
1664		inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_MASTER_MASK;
1665		switch (dai_fmt & SND_SOC_DAIFMT_MASTER_MASK) {
1666		case SND_SOC_DAIFMT_CBM_CFM:
1667			inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1668			break;
1669		case SND_SOC_DAIFMT_CBM_CFS:
1670			inv_dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1671			break;
1672		case SND_SOC_DAIFMT_CBS_CFM:
1673			inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1674			break;
1675		case SND_SOC_DAIFMT_CBS_CFS:
1676			inv_dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1677			break;
1678		}
1679
1680		dai_fmt = inv_dai_fmt;
1681	}
1682
1683	ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1684	if (ret != 0 && ret != -ENOTSUPP) {
1685		dev_warn(cpu_dai->dev,
1686			 "ASoC: Failed to set DAI format: %d\n", ret);
1687		return ret;
1688	}
1689
1690	return 0;
1691}
1692EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1693
1694#ifdef CONFIG_DMI
1695/*
1696 * Trim special characters, and replace '-' with '_' since '-' is used to
1697 * separate different DMI fields in the card long name. Only number and
1698 * alphabet characters and a few separator characters are kept.
1699 */
1700static void cleanup_dmi_name(char *name)
1701{
1702	int i, j = 0;
1703
1704	for (i = 0; name[i]; i++) {
1705		if (isalnum(name[i]) || (name[i] == '.')
1706		    || (name[i] == '_'))
1707			name[j++] = name[i];
1708		else if (name[i] == '-')
1709			name[j++] = '_';
1710	}
1711
1712	name[j] = '\0';
1713}
1714
1715/*
1716 * Check if a DMI field is valid, i.e. not containing any string
1717 * in the black list.
1718 */
1719static int is_dmi_valid(const char *field)
1720{
1721	int i = 0;
1722
1723	while (dmi_blacklist[i]) {
1724		if (strstr(field, dmi_blacklist[i]))
1725			return 0;
1726		i++;
1727	}
1728
1729	return 1;
1730}
1731
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1732/**
1733 * snd_soc_set_dmi_name() - Register DMI names to card
1734 * @card: The card to register DMI names
1735 * @flavour: The flavour "differentiator" for the card amongst its peers.
1736 *
1737 * An Intel machine driver may be used by many different devices but are
1738 * difficult for userspace to differentiate, since machine drivers ususally
1739 * use their own name as the card short name and leave the card long name
1740 * blank. To differentiate such devices and fix bugs due to lack of
1741 * device-specific configurations, this function allows DMI info to be used
1742 * as the sound card long name, in the format of
1743 * "vendor-product-version-board"
1744 * (Character '-' is used to separate different DMI fields here).
1745 * This will help the user space to load the device-specific Use Case Manager
1746 * (UCM) configurations for the card.
1747 *
1748 * Possible card long names may be:
1749 * DellInc.-XPS139343-01-0310JH
1750 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1751 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1752 *
1753 * This function also supports flavoring the card longname to provide
1754 * the extra differentiation, like "vendor-product-version-board-flavor".
1755 *
1756 * We only keep number and alphabet characters and a few separator characters
1757 * in the card long name since UCM in the user space uses the card long names
1758 * as card configuration directory names and AudoConf cannot support special
1759 * charactors like SPACE.
1760 *
1761 * Returns 0 on success, otherwise a negative error code.
1762 */
1763int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1764{
1765	const char *vendor, *product, *product_version, *board;
1766	size_t longname_buf_size = sizeof(card->snd_card->longname);
1767	size_t len;
1768
1769	if (card->long_name)
1770		return 0; /* long name already set by driver or from DMI */
1771
1772	/* make up dmi long name as: vendor.product.version.board */
 
 
 
1773	vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1774	if (!vendor || !is_dmi_valid(vendor)) {
1775		dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1776		return 0;
1777	}
1778
1779	snprintf(card->dmi_longname, sizeof(card->snd_card->longname),
1780			 "%s", vendor);
1781	cleanup_dmi_name(card->dmi_longname);
1782
1783	product = dmi_get_system_info(DMI_PRODUCT_NAME);
1784	if (product && is_dmi_valid(product)) {
1785		len = strlen(card->dmi_longname);
1786		snprintf(card->dmi_longname + len,
1787			 longname_buf_size - len,
1788			 "-%s", product);
1789
1790		len++;	/* skip the separator "-" */
1791		if (len < longname_buf_size)
1792			cleanup_dmi_name(card->dmi_longname + len);
1793
1794		/*
1795		 * some vendors like Lenovo may only put a self-explanatory
1796		 * name in the product version field
1797		 */
1798		product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1799		if (product_version && is_dmi_valid(product_version)) {
1800			len = strlen(card->dmi_longname);
1801			snprintf(card->dmi_longname + len,
1802				 longname_buf_size - len,
1803				 "-%s", product_version);
1804
1805			len++;
1806			if (len < longname_buf_size)
1807				cleanup_dmi_name(card->dmi_longname + len);
1808		}
1809	}
1810
1811	board = dmi_get_system_info(DMI_BOARD_NAME);
1812	if (board && is_dmi_valid(board)) {
1813		len = strlen(card->dmi_longname);
1814		snprintf(card->dmi_longname + len,
1815			 longname_buf_size - len,
1816			 "-%s", board);
1817
1818		len++;
1819		if (len < longname_buf_size)
1820			cleanup_dmi_name(card->dmi_longname + len);
1821	} else if (!product) {
1822		/* fall back to using legacy name */
1823		dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1824		return 0;
1825	}
1826
1827	/* Add flavour to dmi long name */
1828	if (flavour) {
1829		len = strlen(card->dmi_longname);
1830		snprintf(card->dmi_longname + len,
1831			 longname_buf_size - len,
1832			 "-%s", flavour);
1833
1834		len++;
1835		if (len < longname_buf_size)
1836			cleanup_dmi_name(card->dmi_longname + len);
1837	}
1838
1839	/* set the card long name */
1840	card->long_name = card->dmi_longname;
1841
1842	return 0;
1843}
1844EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1845#endif /* CONFIG_DMI */
1846
1847static void soc_check_tplg_fes(struct snd_soc_card *card)
1848{
1849	struct snd_soc_component *component;
1850	const struct snd_soc_component_driver *comp_drv;
1851	struct snd_soc_dai_link *dai_link;
1852	int i;
1853
1854	for_each_component(component) {
1855
1856		/* does this component override FEs ? */
1857		if (!component->driver->ignore_machine)
1858			continue;
1859
1860		/* for this machine ? */
1861		if (!strcmp(component->driver->ignore_machine,
1862			    card->dev->driver->name))
1863			goto match;
1864		if (strcmp(component->driver->ignore_machine,
1865			   dev_name(card->dev)))
1866			continue;
1867match:
1868		/* machine matches, so override the rtd data */
1869		for_each_card_prelinks(card, i, dai_link) {
1870
1871			/* ignore this FE */
1872			if (dai_link->dynamic) {
1873				dai_link->ignore = true;
1874				continue;
1875			}
1876
1877			dev_info(card->dev, "info: override FE DAI link %s\n",
1878				 card->dai_link[i].name);
1879
1880			/* override platform component */
1881			if (!dai_link->platforms) {
1882				dev_err(card->dev, "init platform error");
1883				continue;
1884			}
1885			dai_link->platforms->name = component->name;
 
 
 
 
1886
1887			/* convert non BE into BE */
1888			dai_link->no_pcm = 1;
 
1889
1890			/* override any BE fixups */
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1891			dai_link->be_hw_params_fixup =
1892				component->driver->be_hw_params_fixup;
1893
1894			/*
1895			 * most BE links don't set stream name, so set it to
1896			 * dai link name if it's NULL to help bind widgets.
1897			 */
1898			if (!dai_link->stream_name)
1899				dai_link->stream_name = dai_link->name;
1900		}
1901
1902		/* Inform userspace we are using alternate topology */
1903		if (component->driver->topology_name_prefix) {
1904
1905			/* topology shortname created? */
1906			if (!card->topology_shortname_created) {
1907				comp_drv = component->driver;
1908
1909				snprintf(card->topology_shortname, 32, "%s-%s",
1910					 comp_drv->topology_name_prefix,
1911					 card->name);
1912				card->topology_shortname_created = true;
1913			}
1914
1915			/* use topology shortname */
1916			card->name = card->topology_shortname;
1917		}
1918	}
1919}
1920
1921static void soc_cleanup_card_resources(struct snd_soc_card *card)
 
 
 
 
1922{
1923	/* free the ALSA card at first; this syncs with pending operations */
1924	if (card->snd_card) {
1925		snd_card_free(card->snd_card);
1926		card->snd_card = NULL;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1927	}
1928
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1929	/* remove and free each DAI */
1930	soc_remove_dai_links(card);
1931	soc_remove_pcm_runtimes(card);
 
 
 
1932
1933	/* remove auxiliary devices */
1934	soc_remove_aux_devices(card);
1935	soc_unbind_aux_dev(card);
1936
1937	snd_soc_dapm_free(&card->dapm);
1938	soc_cleanup_card_debugfs(card);
1939
1940	/* remove the card */
1941	if (card->remove)
1942		card->remove(card);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1943}
1944
1945static int snd_soc_instantiate_card(struct snd_soc_card *card)
1946{
1947	struct snd_soc_pcm_runtime *rtd;
1948	struct snd_soc_dai_link *dai_link;
1949	int ret, i;
1950
1951	mutex_lock(&client_mutex);
1952	for_each_card_prelinks(card, i, dai_link) {
1953		ret = soc_init_dai_link(card, dai_link);
1954		if (ret) {
1955			dev_err(card->dev, "ASoC: failed to init link %s: %d\n",
1956				dai_link->name, ret);
1957			mutex_unlock(&client_mutex);
1958			return ret;
1959		}
1960	}
1961	mutex_lock_nested(&card->mutex, SND_SOC_CARD_CLASS_INIT);
1962
1963	snd_soc_dapm_init(&card->dapm, card, NULL);
1964
1965	/* check whether any platform is ignore machine FE and using topology */
1966	soc_check_tplg_fes(card);
1967
1968	/* bind DAIs */
1969	for_each_card_prelinks(card, i, dai_link) {
1970		ret = soc_bind_dai_link(card, dai_link);
1971		if (ret != 0)
1972			goto probe_end;
1973	}
1974
1975	/* bind aux_devs too */
1976	ret = soc_bind_aux_dev(card);
1977	if (ret < 0)
1978		goto probe_end;
1979
1980	/* add predefined DAI links to the list */
1981	for_each_card_prelinks(card, i, dai_link) {
1982		ret = snd_soc_add_dai_link(card, dai_link);
1983		if (ret < 0)
1984			goto probe_end;
1985	}
1986
1987	/* card bind complete so register a sound card */
1988	ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
1989			card->owner, 0, &card->snd_card);
1990	if (ret < 0) {
1991		dev_err(card->dev,
1992			"ASoC: can't create sound card for card %s: %d\n",
1993			card->name, ret);
1994		goto probe_end;
1995	}
1996
1997	soc_init_card_debugfs(card);
1998
1999	soc_resume_init(card);
2000
2001	ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2002					card->num_dapm_widgets);
2003	if (ret < 0)
2004		goto probe_end;
2005
2006	ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2007					card->num_of_dapm_widgets);
2008	if (ret < 0)
2009		goto probe_end;
2010
2011	/* initialise the sound card only once */
2012	if (card->probe) {
2013		ret = card->probe(card);
2014		if (ret < 0)
2015			goto probe_end;
2016	}
2017
2018	/* probe all components used by DAI links on this card */
2019	ret = soc_probe_link_components(card);
2020	if (ret < 0) {
2021		dev_err(card->dev,
2022			"ASoC: failed to instantiate card %d\n", ret);
 
 
2023		goto probe_end;
2024	}
2025
2026	/* probe auxiliary components */
2027	ret = soc_probe_aux_devices(card);
2028	if (ret < 0)
 
 
2029		goto probe_end;
2030
2031	/*
2032	 * Find new DAI links added during probing components and bind them.
2033	 * Components with topology may bring new DAIs and DAI links.
2034	 */
2035	for_each_card_links(card, dai_link) {
2036		if (soc_is_dai_link_bound(card, dai_link))
2037			continue;
2038
2039		ret = soc_init_dai_link(card, dai_link);
2040		if (ret)
2041			goto probe_end;
2042		ret = soc_bind_dai_link(card, dai_link);
2043		if (ret)
2044			goto probe_end;
2045	}
2046
2047	/* probe all DAI links on this card */
2048	ret = soc_probe_link_dais(card);
2049	if (ret < 0) {
2050		dev_err(card->dev,
2051			"ASoC: failed to instantiate card %d\n", ret);
2052		goto probe_end;
2053	}
2054
2055	for_each_card_rtds(card, rtd)
2056		soc_link_init(card, rtd);
 
 
 
2057
2058	snd_soc_dapm_link_dai_widgets(card);
2059	snd_soc_dapm_connect_dai_link_widgets(card);
2060
2061	ret = snd_soc_add_card_controls(card, card->controls,
2062					card->num_controls);
2063	if (ret < 0)
2064		goto probe_end;
2065
2066	ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2067				      card->num_dapm_routes);
2068	if (ret < 0)
2069		goto probe_end;
 
 
 
 
 
 
 
 
 
 
2070
2071	ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2072				      card->num_of_dapm_routes);
2073	if (ret < 0)
2074		goto probe_end;
2075
2076	/* try to set some sane longname if DMI is available */
2077	snd_soc_set_dmi_name(card, NULL);
2078
2079	snprintf(card->snd_card->shortname, sizeof(card->snd_card->shortname),
2080		 "%s", card->name);
2081	snprintf(card->snd_card->longname, sizeof(card->snd_card->longname),
2082		 "%s", card->long_name ? card->long_name : card->name);
2083	snprintf(card->snd_card->driver, sizeof(card->snd_card->driver),
2084		 "%s", card->driver_name ? card->driver_name : card->name);
2085	for (i = 0; i < ARRAY_SIZE(card->snd_card->driver); i++) {
2086		switch (card->snd_card->driver[i]) {
2087		case '_':
2088		case '-':
2089		case '\0':
2090			break;
2091		default:
2092			if (!isalnum(card->snd_card->driver[i]))
2093				card->snd_card->driver[i] = '_';
2094			break;
2095		}
2096	}
2097
2098	if (card->late_probe) {
2099		ret = card->late_probe(card);
2100		if (ret < 0) {
2101			dev_err(card->dev, "ASoC: %s late_probe() failed: %d\n",
2102				card->name, ret);
2103			goto probe_end;
2104		}
2105	}
2106
 
 
 
 
2107	snd_soc_dapm_new_widgets(card);
 
2108
2109	ret = snd_card_register(card->snd_card);
2110	if (ret < 0) {
2111		dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2112				ret);
2113		goto probe_end;
2114	}
2115
2116	card->instantiated = 1;
2117	dapm_mark_endpoints_dirty(card);
2118	snd_soc_dapm_sync(&card->dapm);
2119
 
 
 
 
 
2120probe_end:
2121	if (ret < 0)
2122		soc_cleanup_card_resources(card);
2123
2124	mutex_unlock(&card->mutex);
2125	mutex_unlock(&client_mutex);
2126
2127	return ret;
2128}
2129
2130/* probes a new socdev */
2131static int soc_probe(struct platform_device *pdev)
2132{
2133	struct snd_soc_card *card = platform_get_drvdata(pdev);
2134
2135	/*
2136	 * no card, so machine driver should be registering card
2137	 * we should not be here in that case so ret error
2138	 */
2139	if (!card)
2140		return -EINVAL;
2141
2142	dev_warn(&pdev->dev,
2143		 "ASoC: machine %s should use snd_soc_register_card()\n",
2144		 card->name);
2145
2146	/* Bodge while we unpick instantiation */
2147	card->dev = &pdev->dev;
2148
2149	return snd_soc_register_card(card);
2150}
2151
2152/* removes a socdev */
2153static int soc_remove(struct platform_device *pdev)
2154{
2155	struct snd_soc_card *card = platform_get_drvdata(pdev);
2156
2157	snd_soc_unregister_card(card);
2158	return 0;
2159}
2160
2161int snd_soc_poweroff(struct device *dev)
2162{
2163	struct snd_soc_card *card = dev_get_drvdata(dev);
2164	struct snd_soc_pcm_runtime *rtd;
2165
2166	if (!card->instantiated)
2167		return 0;
2168
2169	/*
2170	 * Flush out pmdown_time work - we actually do want to run it
2171	 * now, we're shutting down so no imminent restart.
2172	 */
2173	snd_soc_flush_all_delayed_work(card);
2174
2175	snd_soc_dapm_shutdown(card);
2176
2177	/* deactivate pins to sleep state */
2178	for_each_card_rtds(card, rtd) {
2179		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2180		struct snd_soc_dai *codec_dai;
2181		int i;
2182
2183		pinctrl_pm_select_sleep_state(cpu_dai->dev);
2184		for_each_rtd_codec_dai(rtd, i, codec_dai) {
2185			pinctrl_pm_select_sleep_state(codec_dai->dev);
2186		}
2187	}
2188
2189	return 0;
2190}
2191EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2192
2193const struct dev_pm_ops snd_soc_pm_ops = {
2194	.suspend = snd_soc_suspend,
2195	.resume = snd_soc_resume,
2196	.freeze = snd_soc_suspend,
2197	.thaw = snd_soc_resume,
2198	.poweroff = snd_soc_poweroff,
2199	.restore = snd_soc_resume,
2200};
2201EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2202
2203/* ASoC platform driver */
2204static struct platform_driver soc_driver = {
2205	.driver		= {
2206		.name		= "soc-audio",
2207		.pm		= &snd_soc_pm_ops,
2208	},
2209	.probe		= soc_probe,
2210	.remove		= soc_remove,
2211};
2212
2213/**
2214 * snd_soc_cnew - create new control
2215 * @_template: control template
2216 * @data: control private data
2217 * @long_name: control long name
2218 * @prefix: control name prefix
2219 *
2220 * Create a new mixer control from a template control.
2221 *
2222 * Returns 0 for success, else error.
2223 */
2224struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2225				  void *data, const char *long_name,
2226				  const char *prefix)
2227{
2228	struct snd_kcontrol_new template;
2229	struct snd_kcontrol *kcontrol;
2230	char *name = NULL;
2231
2232	memcpy(&template, _template, sizeof(template));
2233	template.index = 0;
2234
2235	if (!long_name)
2236		long_name = template.name;
2237
2238	if (prefix) {
2239		name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2240		if (!name)
2241			return NULL;
2242
2243		template.name = name;
2244	} else {
2245		template.name = long_name;
2246	}
2247
2248	kcontrol = snd_ctl_new1(&template, data);
2249
2250	kfree(name);
2251
2252	return kcontrol;
2253}
2254EXPORT_SYMBOL_GPL(snd_soc_cnew);
2255
2256static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2257	const struct snd_kcontrol_new *controls, int num_controls,
2258	const char *prefix, void *data)
2259{
2260	int err, i;
2261
2262	for (i = 0; i < num_controls; i++) {
2263		const struct snd_kcontrol_new *control = &controls[i];
2264
2265		err = snd_ctl_add(card, snd_soc_cnew(control, data,
2266						     control->name, prefix));
2267		if (err < 0) {
2268			dev_err(dev, "ASoC: Failed to add %s: %d\n",
2269				control->name, err);
2270			return err;
2271		}
2272	}
2273
2274	return 0;
2275}
2276
2277struct snd_kcontrol *snd_soc_card_get_kcontrol(struct snd_soc_card *soc_card,
2278					       const char *name)
2279{
2280	struct snd_card *card = soc_card->snd_card;
2281	struct snd_kcontrol *kctl;
2282
2283	if (unlikely(!name))
2284		return NULL;
2285
2286	list_for_each_entry(kctl, &card->controls, list)
2287		if (!strncmp(kctl->id.name, name, sizeof(kctl->id.name)))
2288			return kctl;
2289	return NULL;
2290}
2291EXPORT_SYMBOL_GPL(snd_soc_card_get_kcontrol);
2292
2293/**
2294 * snd_soc_add_component_controls - Add an array of controls to a component.
2295 *
2296 * @component: Component to add controls to
2297 * @controls: Array of controls to add
2298 * @num_controls: Number of elements in the array
2299 *
2300 * Return: 0 for success, else error.
2301 */
2302int snd_soc_add_component_controls(struct snd_soc_component *component,
2303	const struct snd_kcontrol_new *controls, unsigned int num_controls)
2304{
2305	struct snd_card *card = component->card->snd_card;
2306
2307	return snd_soc_add_controls(card, component->dev, controls,
2308			num_controls, component->name_prefix, component);
2309}
2310EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2311
2312/**
2313 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2314 * Convenience function to add a list of controls.
2315 *
2316 * @soc_card: SoC card to add controls to
2317 * @controls: array of controls to add
2318 * @num_controls: number of elements in the array
2319 *
2320 * Return 0 for success, else error.
2321 */
2322int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2323	const struct snd_kcontrol_new *controls, int num_controls)
2324{
2325	struct snd_card *card = soc_card->snd_card;
2326
2327	return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2328			NULL, soc_card);
2329}
2330EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2331
2332/**
2333 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2334 * Convienience function to add a list of controls.
2335 *
2336 * @dai: DAI to add controls to
2337 * @controls: array of controls to add
2338 * @num_controls: number of elements in the array
2339 *
2340 * Return 0 for success, else error.
2341 */
2342int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2343	const struct snd_kcontrol_new *controls, int num_controls)
2344{
2345	struct snd_card *card = dai->component->card->snd_card;
2346
2347	return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2348			NULL, dai);
2349}
2350EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2351
2352static int snd_soc_bind_card(struct snd_soc_card *card)
2353{
2354	struct snd_soc_pcm_runtime *rtd;
2355	int ret;
2356
2357	ret = snd_soc_instantiate_card(card);
2358	if (ret != 0)
2359		return ret;
2360
2361	/* deactivate pins to sleep state */
2362	for_each_card_rtds(card, rtd) {
2363		struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
2364		struct snd_soc_dai *codec_dai;
2365		int j;
2366
2367		for_each_rtd_codec_dai(rtd, j, codec_dai) {
2368			if (!codec_dai->active)
2369				pinctrl_pm_select_sleep_state(codec_dai->dev);
2370		}
2371
2372		if (!cpu_dai->active)
2373			pinctrl_pm_select_sleep_state(cpu_dai->dev);
2374	}
2375
2376	return ret;
2377}
2378
2379/**
2380 * snd_soc_register_card - Register a card with the ASoC core
2381 *
2382 * @card: Card to register
2383 *
2384 */
2385int snd_soc_register_card(struct snd_soc_card *card)
2386{
2387	if (!card->name || !card->dev)
2388		return -EINVAL;
2389
2390	dev_set_drvdata(card->dev, card);
2391
2392	INIT_LIST_HEAD(&card->widgets);
2393	INIT_LIST_HEAD(&card->paths);
2394	INIT_LIST_HEAD(&card->dapm_list);
2395	INIT_LIST_HEAD(&card->aux_comp_list);
2396	INIT_LIST_HEAD(&card->component_dev_list);
2397	INIT_LIST_HEAD(&card->list);
2398	INIT_LIST_HEAD(&card->dai_link_list);
2399	INIT_LIST_HEAD(&card->rtd_list);
2400	INIT_LIST_HEAD(&card->dapm_dirty);
2401	INIT_LIST_HEAD(&card->dobj_list);
2402
2403	card->num_rtd = 0;
2404	card->instantiated = 0;
2405	mutex_init(&card->mutex);
2406	mutex_init(&card->dapm_mutex);
2407	mutex_init(&card->pcm_mutex);
2408	spin_lock_init(&card->dpcm_lock);
2409
2410	return snd_soc_bind_card(card);
2411}
2412EXPORT_SYMBOL_GPL(snd_soc_register_card);
2413
2414static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
2415{
2416	if (card->instantiated) {
2417		card->instantiated = false;
2418		snd_soc_dapm_shutdown(card);
2419		snd_soc_flush_all_delayed_work(card);
2420
2421		/* remove all components used by DAI links on this card */
2422		soc_remove_link_components(card);
2423
2424		soc_cleanup_card_resources(card);
2425		if (!unregister)
2426			list_add(&card->list, &unbind_card_list);
2427	} else {
2428		if (unregister)
2429			list_del(&card->list);
2430	}
2431}
2432
2433/**
2434 * snd_soc_unregister_card - Unregister a card with the ASoC core
2435 *
2436 * @card: Card to unregister
2437 *
2438 */
2439int snd_soc_unregister_card(struct snd_soc_card *card)
2440{
2441	mutex_lock(&client_mutex);
2442	snd_soc_unbind_card(card, true);
2443	mutex_unlock(&client_mutex);
2444	dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
2445
2446	return 0;
2447}
2448EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2449
2450/*
2451 * Simplify DAI link configuration by removing ".-1" from device names
2452 * and sanitizing names.
2453 */
2454static char *fmt_single_name(struct device *dev, int *id)
2455{
2456	char *found, name[NAME_SIZE];
2457	int id1, id2;
 
2458
2459	if (dev_name(dev) == NULL)
2460		return NULL;
2461
2462	strlcpy(name, dev_name(dev), NAME_SIZE);
 
 
2463
2464	/* are we a "%s.%d" name (platform and SPI components) */
2465	found = strstr(name, dev->driver->name);
2466	if (found) {
2467		/* get ID */
2468		if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2469
2470			/* discard ID from name if ID == -1 */
2471			if (*id == -1)
2472				found[strlen(dev->driver->name)] = '\0';
2473		}
2474
 
 
 
 
 
 
 
 
 
 
2475	} else {
2476		/* I2C component devices are named "bus-addr" */
2477		if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2478			char tmp[NAME_SIZE];
2479
2480			/* create unique ID number from I2C addr and bus */
2481			*id = ((id1 & 0xffff) << 16) + id2;
2482
2483			/* sanitize component name for DAI link creation */
2484			snprintf(tmp, NAME_SIZE, "%s.%s", dev->driver->name,
2485				 name);
2486			strlcpy(name, tmp, NAME_SIZE);
2487		} else
2488			*id = 0;
2489	}
2490
2491	return kstrdup(name, GFP_KERNEL);
2492}
2493
2494/*
2495 * Simplify DAI link naming for single devices with multiple DAIs by removing
2496 * any ".-1" and using the DAI name (instead of device name).
2497 */
2498static inline char *fmt_multiple_name(struct device *dev,
2499		struct snd_soc_dai_driver *dai_drv)
2500{
2501	if (dai_drv->name == NULL) {
2502		dev_err(dev,
2503			"ASoC: error - multiple DAI %s registered with no name\n",
2504			dev_name(dev));
2505		return NULL;
2506	}
2507
2508	return kstrdup(dai_drv->name, GFP_KERNEL);
2509}
2510
2511/**
2512 * snd_soc_unregister_dai - Unregister DAIs from the ASoC core
2513 *
2514 * @component: The component for which the DAIs should be unregistered
2515 */
2516static void snd_soc_unregister_dais(struct snd_soc_component *component)
2517{
2518	struct snd_soc_dai *dai, *_dai;
2519
2520	for_each_component_dais_safe(component, dai, _dai) {
2521		dev_dbg(component->dev, "ASoC: Unregistered DAI '%s'\n",
2522			dai->name);
2523		list_del(&dai->list);
2524		kfree(dai->name);
2525		kfree(dai);
2526	}
2527}
 
2528
2529/* Create a DAI and add it to the component's DAI list */
2530static struct snd_soc_dai *soc_add_dai(struct snd_soc_component *component,
2531	struct snd_soc_dai_driver *dai_drv,
2532	bool legacy_dai_naming)
 
 
 
 
 
 
 
 
 
 
 
2533{
2534	struct device *dev = component->dev;
2535	struct snd_soc_dai *dai;
2536
2537	dev_dbg(dev, "ASoC: dynamically register DAI %s\n", dev_name(dev));
2538
2539	dai = kzalloc(sizeof(struct snd_soc_dai), GFP_KERNEL);
2540	if (dai == NULL)
2541		return NULL;
2542
2543	/*
2544	 * Back in the old days when we still had component-less DAIs,
2545	 * instead of having a static name, component-less DAIs would
2546	 * inherit the name of the parent device so it is possible to
2547	 * register multiple instances of the DAI. We still need to keep
2548	 * the same naming style even though those DAIs are not
2549	 * component-less anymore.
2550	 */
2551	if (legacy_dai_naming &&
2552	    (dai_drv->id == 0 || dai_drv->name == NULL)) {
2553		dai->name = fmt_single_name(dev, &dai->id);
2554	} else {
2555		dai->name = fmt_multiple_name(dev, dai_drv);
2556		if (dai_drv->id)
2557			dai->id = dai_drv->id;
2558		else
2559			dai->id = component->num_dai;
2560	}
2561	if (dai->name == NULL) {
2562		kfree(dai);
2563		return NULL;
2564	}
2565
2566	dai->component = component;
2567	dai->dev = dev;
2568	dai->driver = dai_drv;
2569	if (!dai->driver->ops)
2570		dai->driver->ops = &null_dai_ops;
2571
2572	/* see for_each_component_dais */
2573	list_add_tail(&dai->list, &component->dai_list);
2574	component->num_dai++;
2575
2576	dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2577	return dai;
2578}
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2579
2580/**
2581 * snd_soc_register_dais - Register a DAI with the ASoC core
2582 *
2583 * @component: The component the DAIs are registered for
2584 * @dai_drv: DAI driver to use for the DAIs
2585 * @count: Number of DAIs
2586 */
2587static int snd_soc_register_dais(struct snd_soc_component *component,
2588				 struct snd_soc_dai_driver *dai_drv,
2589				 size_t count)
2590{
2591	struct device *dev = component->dev;
2592	struct snd_soc_dai *dai;
2593	unsigned int i;
2594	int ret;
2595
2596	dev_dbg(dev, "ASoC: dai register %s #%zu\n", dev_name(dev), count);
2597
2598	for (i = 0; i < count; i++) {
2599
2600		dai = soc_add_dai(component, dai_drv + i, count == 1 &&
2601				  !component->driver->non_legacy_dai_naming);
2602		if (dai == NULL) {
2603			ret = -ENOMEM;
2604			goto err;
2605		}
2606	}
2607
2608	return 0;
2609
2610err:
2611	snd_soc_unregister_dais(component);
2612
2613	return ret;
2614}
2615
2616/**
2617 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2618 *
2619 * @component: The component the DAIs are registered for
2620 * @dai_drv: DAI driver to use for the DAI
2621 *
2622 * Topology can use this API to register DAIs when probing a component.
2623 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2624 * will be freed in the component cleanup.
2625 */
2626int snd_soc_register_dai(struct snd_soc_component *component,
2627	struct snd_soc_dai_driver *dai_drv)
2628{
2629	struct snd_soc_dapm_context *dapm =
2630		snd_soc_component_get_dapm(component);
2631	struct snd_soc_dai *dai;
2632	int ret;
2633
2634	if (dai_drv->dobj.type != SND_SOC_DOBJ_PCM) {
2635		dev_err(component->dev, "Invalid dai type %d\n",
2636			dai_drv->dobj.type);
2637		return -EINVAL;
2638	}
2639
2640	lockdep_assert_held(&client_mutex);
2641	dai = soc_add_dai(component, dai_drv, false);
2642	if (!dai)
2643		return -ENOMEM;
2644
2645	/*
2646	 * Create the DAI widgets here. After adding DAIs, topology may
2647	 * also add routes that need these widgets as source or sink.
2648	 */
2649	ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
2650	if (ret != 0) {
2651		dev_err(component->dev,
2652			"Failed to create DAI widgets %d\n", ret);
2653	}
2654
2655	return ret;
2656}
2657EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2658
2659static int snd_soc_component_initialize(struct snd_soc_component *component,
2660	const struct snd_soc_component_driver *driver, struct device *dev)
2661{
2662	INIT_LIST_HEAD(&component->dai_list);
2663	INIT_LIST_HEAD(&component->dobj_list);
2664	INIT_LIST_HEAD(&component->card_list);
2665	mutex_init(&component->io_mutex);
2666
2667	component->name = fmt_single_name(dev, &component->id);
2668	if (!component->name) {
2669		dev_err(dev, "ASoC: Failed to allocate name\n");
2670		return -ENOMEM;
2671	}
2672
2673	component->dev = dev;
2674	component->driver = driver;
2675
2676	return 0;
2677}
2678
2679static void snd_soc_component_setup_regmap(struct snd_soc_component *component)
2680{
2681	int val_bytes = regmap_get_val_bytes(component->regmap);
2682
2683	/* Errors are legitimate for non-integer byte multiples */
2684	if (val_bytes > 0)
2685		component->val_bytes = val_bytes;
2686}
2687
2688#ifdef CONFIG_REGMAP
2689
2690/**
2691 * snd_soc_component_init_regmap() - Initialize regmap instance for the
2692 *                                   component
2693 * @component: The component for which to initialize the regmap instance
2694 * @regmap: The regmap instance that should be used by the component
2695 *
2696 * This function allows deferred assignment of the regmap instance that is
2697 * associated with the component. Only use this if the regmap instance is not
2698 * yet ready when the component is registered. The function must also be called
2699 * before the first IO attempt of the component.
2700 */
2701void snd_soc_component_init_regmap(struct snd_soc_component *component,
2702	struct regmap *regmap)
2703{
2704	component->regmap = regmap;
2705	snd_soc_component_setup_regmap(component);
2706}
2707EXPORT_SYMBOL_GPL(snd_soc_component_init_regmap);
2708
2709/**
2710 * snd_soc_component_exit_regmap() - De-initialize regmap instance for the
2711 *                                   component
2712 * @component: The component for which to de-initialize the regmap instance
2713 *
2714 * Calls regmap_exit() on the regmap instance associated to the component and
2715 * removes the regmap instance from the component.
2716 *
2717 * This function should only be used if snd_soc_component_init_regmap() was used
2718 * to initialize the regmap instance.
2719 */
2720void snd_soc_component_exit_regmap(struct snd_soc_component *component)
2721{
2722	regmap_exit(component->regmap);
2723	component->regmap = NULL;
2724}
2725EXPORT_SYMBOL_GPL(snd_soc_component_exit_regmap);
2726
2727#endif
2728
2729static void snd_soc_component_add(struct snd_soc_component *component)
2730{
2731	mutex_lock(&client_mutex);
2732
2733	if (!component->driver->write && !component->driver->read) {
2734		if (!component->regmap)
2735			component->regmap = dev_get_regmap(component->dev,
2736							   NULL);
2737		if (component->regmap)
2738			snd_soc_component_setup_regmap(component);
2739	}
2740
2741	/* see for_each_component */
2742	list_add(&component->list, &component_list);
2743
2744	mutex_unlock(&client_mutex);
2745}
2746
2747static void snd_soc_component_cleanup(struct snd_soc_component *component)
2748{
2749	snd_soc_unregister_dais(component);
2750	kfree(component->name);
2751}
2752
2753static void snd_soc_component_del_unlocked(struct snd_soc_component *component)
2754{
2755	struct snd_soc_card *card = component->card;
2756
2757	if (card)
2758		snd_soc_unbind_card(card, false);
2759
2760	list_del(&component->list);
2761}
2762
2763#define ENDIANNESS_MAP(name) \
2764	(SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2765static u64 endianness_format_map[] = {
2766	ENDIANNESS_MAP(S16_),
2767	ENDIANNESS_MAP(U16_),
2768	ENDIANNESS_MAP(S24_),
2769	ENDIANNESS_MAP(U24_),
2770	ENDIANNESS_MAP(S32_),
2771	ENDIANNESS_MAP(U32_),
2772	ENDIANNESS_MAP(S24_3),
2773	ENDIANNESS_MAP(U24_3),
2774	ENDIANNESS_MAP(S20_3),
2775	ENDIANNESS_MAP(U20_3),
2776	ENDIANNESS_MAP(S18_3),
2777	ENDIANNESS_MAP(U18_3),
2778	ENDIANNESS_MAP(FLOAT_),
2779	ENDIANNESS_MAP(FLOAT64_),
2780	ENDIANNESS_MAP(IEC958_SUBFRAME_),
2781};
2782
2783/*
2784 * Fix up the DAI formats for endianness: codecs don't actually see
2785 * the endianness of the data but we're using the CPU format
2786 * definitions which do need to include endianness so we ensure that
2787 * codec DAIs always have both big and little endian variants set.
2788 */
2789static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2790{
2791	int i;
2792
2793	for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2794		if (stream->formats & endianness_format_map[i])
2795			stream->formats |= endianness_format_map[i];
2796}
2797
2798static void snd_soc_try_rebind_card(void)
2799{
2800	struct snd_soc_card *card, *c;
2801
2802	list_for_each_entry_safe(card, c, &unbind_card_list, list)
2803		if (!snd_soc_bind_card(card))
2804			list_del(&card->list);
2805}
2806
2807int snd_soc_add_component(struct device *dev,
2808			struct snd_soc_component *component,
2809			const struct snd_soc_component_driver *component_driver,
2810			struct snd_soc_dai_driver *dai_drv,
2811			int num_dai)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2812{
2813	int ret;
2814	int i;
2815
2816	ret = snd_soc_component_initialize(component, component_driver, dev);
2817	if (ret)
2818		goto err_free;
2819
2820	if (component_driver->endianness) {
2821		for (i = 0; i < num_dai; i++) {
2822			convert_endianness_formats(&dai_drv[i].playback);
2823			convert_endianness_formats(&dai_drv[i].capture);
2824		}
2825	}
2826
2827	ret = snd_soc_register_dais(component, dai_drv, num_dai);
2828	if (ret < 0) {
2829		dev_err(dev, "ASoC: Failed to register DAIs: %d\n", ret);
 
2830		goto err_cleanup;
2831	}
2832
2833	snd_soc_component_add(component);
2834	snd_soc_try_rebind_card();
 
 
 
 
 
2835
2836	return 0;
 
2837
2838err_cleanup:
2839	snd_soc_component_cleanup(component);
2840err_free:
 
 
 
 
 
 
2841	return ret;
2842}
2843EXPORT_SYMBOL_GPL(snd_soc_add_component);
2844
2845int snd_soc_register_component(struct device *dev,
2846			const struct snd_soc_component_driver *component_driver,
2847			struct snd_soc_dai_driver *dai_drv,
2848			int num_dai)
2849{
2850	struct snd_soc_component *component;
 
2851
2852	component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2853	if (!component)
2854		return -ENOMEM;
2855
2856	return snd_soc_add_component(dev, component, component_driver,
2857				     dai_drv, num_dai);
 
 
 
2858}
2859EXPORT_SYMBOL_GPL(snd_soc_register_component);
2860
2861/**
2862 * snd_soc_unregister_component - Unregister all related component
2863 * from the ASoC core
2864 *
2865 * @dev: The device to unregister
 
2866 */
2867static int __snd_soc_unregister_component(struct device *dev)
 
2868{
2869	struct snd_soc_component *component;
2870	int found = 0;
2871
2872	mutex_lock(&client_mutex);
2873	for_each_component(component) {
2874		if (dev != component->dev)
2875			continue;
2876
2877		snd_soc_tplg_component_remove(component,
2878					      SND_SOC_TPLG_INDEX_ALL);
2879		snd_soc_component_del_unlocked(component);
2880		found = 1;
2881		break;
2882	}
2883	mutex_unlock(&client_mutex);
2884
2885	if (found)
2886		snd_soc_component_cleanup(component);
2887
2888	return found;
 
2889}
 
2890
 
 
 
 
 
 
2891void snd_soc_unregister_component(struct device *dev)
2892{
2893	while (__snd_soc_unregister_component(dev))
2894		;
2895}
2896EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2897
2898struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
2899						   const char *driver_name)
2900{
2901	struct snd_soc_component *component;
2902	struct snd_soc_component *ret;
2903
2904	ret = NULL;
2905	mutex_lock(&client_mutex);
2906	for_each_component(component) {
2907		if (dev != component->dev)
2908			continue;
2909
2910		if (driver_name &&
2911		    (driver_name != component->driver->name) &&
2912		    (strcmp(component->driver->name, driver_name) != 0))
2913			continue;
2914
2915		ret = component;
2916		break;
2917	}
2918	mutex_unlock(&client_mutex);
2919
2920	return ret;
2921}
2922EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
2923
2924/* Retrieve a card's name from device tree */
2925int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2926			       const char *propname)
2927{
2928	struct device_node *np;
2929	int ret;
2930
2931	if (!card->dev) {
2932		pr_err("card->dev is not set before calling %s\n", __func__);
2933		return -EINVAL;
2934	}
2935
2936	np = card->dev->of_node;
2937
2938	ret = of_property_read_string_index(np, propname, 0, &card->name);
2939	/*
2940	 * EINVAL means the property does not exist. This is fine providing
2941	 * card->name was previously set, which is checked later in
2942	 * snd_soc_register_card.
2943	 */
2944	if (ret < 0 && ret != -EINVAL) {
2945		dev_err(card->dev,
2946			"ASoC: Property '%s' could not be read: %d\n",
2947			propname, ret);
2948		return ret;
2949	}
2950
2951	return 0;
2952}
2953EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2954
2955static const struct snd_soc_dapm_widget simple_widgets[] = {
2956	SND_SOC_DAPM_MIC("Microphone", NULL),
2957	SND_SOC_DAPM_LINE("Line", NULL),
2958	SND_SOC_DAPM_HP("Headphone", NULL),
2959	SND_SOC_DAPM_SPK("Speaker", NULL),
2960};
2961
2962int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2963					  const char *propname)
2964{
2965	struct device_node *np = card->dev->of_node;
2966	struct snd_soc_dapm_widget *widgets;
2967	const char *template, *wname;
2968	int i, j, num_widgets, ret;
2969
2970	num_widgets = of_property_count_strings(np, propname);
2971	if (num_widgets < 0) {
2972		dev_err(card->dev,
2973			"ASoC: Property '%s' does not exist\n",	propname);
2974		return -EINVAL;
2975	}
 
 
 
 
 
2976	if (num_widgets & 1) {
2977		dev_err(card->dev,
2978			"ASoC: Property '%s' length is not even\n", propname);
2979		return -EINVAL;
2980	}
2981
2982	num_widgets /= 2;
2983	if (!num_widgets) {
2984		dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2985			propname);
2986		return -EINVAL;
2987	}
2988
2989	widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2990			       GFP_KERNEL);
2991	if (!widgets) {
2992		dev_err(card->dev,
2993			"ASoC: Could not allocate memory for widgets\n");
2994		return -ENOMEM;
2995	}
2996
2997	for (i = 0; i < num_widgets; i++) {
2998		ret = of_property_read_string_index(np, propname,
2999			2 * i, &template);
3000		if (ret) {
3001			dev_err(card->dev,
3002				"ASoC: Property '%s' index %d read error:%d\n",
3003				propname, 2 * i, ret);
3004			return -EINVAL;
3005		}
3006
3007		for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3008			if (!strncmp(template, simple_widgets[j].name,
3009				     strlen(simple_widgets[j].name))) {
3010				widgets[i] = simple_widgets[j];
3011				break;
3012			}
3013		}
3014
3015		if (j >= ARRAY_SIZE(simple_widgets)) {
3016			dev_err(card->dev,
3017				"ASoC: DAPM widget '%s' is not supported\n",
3018				template);
3019			return -EINVAL;
3020		}
3021
3022		ret = of_property_read_string_index(np, propname,
3023						    (2 * i) + 1,
3024						    &wname);
3025		if (ret) {
3026			dev_err(card->dev,
3027				"ASoC: Property '%s' index %d read error:%d\n",
3028				propname, (2 * i) + 1, ret);
3029			return -EINVAL;
3030		}
3031
3032		widgets[i].name = wname;
3033	}
3034
3035	card->of_dapm_widgets = widgets;
3036	card->num_of_dapm_widgets = num_widgets;
3037
3038	return 0;
3039}
3040EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3041
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3042int snd_soc_of_get_slot_mask(struct device_node *np,
3043			     const char *prop_name,
3044			     unsigned int *mask)
3045{
3046	u32 val;
3047	const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3048	int i;
3049
3050	if (!of_slot_mask)
3051		return 0;
3052	val /= sizeof(u32);
3053	for (i = 0; i < val; i++)
3054		if (be32_to_cpup(&of_slot_mask[i]))
3055			*mask |= (1 << i);
3056
3057	return val;
3058}
3059EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
3060
3061int snd_soc_of_parse_tdm_slot(struct device_node *np,
3062			      unsigned int *tx_mask,
3063			      unsigned int *rx_mask,
3064			      unsigned int *slots,
3065			      unsigned int *slot_width)
3066{
3067	u32 val;
3068	int ret;
3069
3070	if (tx_mask)
3071		snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3072	if (rx_mask)
3073		snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3074
3075	if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3076		ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3077		if (ret)
3078			return ret;
3079
3080		if (slots)
3081			*slots = val;
3082	}
3083
3084	if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3085		ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3086		if (ret)
3087			return ret;
3088
3089		if (slot_width)
3090			*slot_width = val;
3091	}
3092
3093	return 0;
3094}
3095EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3096
 
 
 
 
 
 
 
 
3097void snd_soc_of_parse_node_prefix(struct device_node *np,
3098				  struct snd_soc_codec_conf *codec_conf,
3099				  struct device_node *of_node,
3100				  const char *propname)
3101{
3102	const char *str;
3103	int ret;
3104
3105	ret = of_property_read_string(np, propname, &str);
3106	if (ret < 0) {
3107		/* no prefix is not error */
3108		return;
3109	}
3110
3111	codec_conf->of_node	= of_node;
3112	codec_conf->name_prefix	= str;
3113}
3114EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
3115
3116int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3117				   const char *propname)
3118{
3119	struct device_node *np = card->dev->of_node;
3120	int num_routes;
3121	struct snd_soc_dapm_route *routes;
3122	int i, ret;
3123
3124	num_routes = of_property_count_strings(np, propname);
3125	if (num_routes < 0 || num_routes & 1) {
3126		dev_err(card->dev,
3127			"ASoC: Property '%s' does not exist or its length is not even\n",
3128			propname);
3129		return -EINVAL;
3130	}
3131	num_routes /= 2;
3132	if (!num_routes) {
3133		dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
3134			propname);
3135		return -EINVAL;
3136	}
3137
3138	routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
3139			      GFP_KERNEL);
3140	if (!routes) {
3141		dev_err(card->dev,
3142			"ASoC: Could not allocate DAPM route table\n");
3143		return -EINVAL;
3144	}
3145
3146	for (i = 0; i < num_routes; i++) {
3147		ret = of_property_read_string_index(np, propname,
3148			2 * i, &routes[i].sink);
3149		if (ret) {
3150			dev_err(card->dev,
3151				"ASoC: Property '%s' index %d could not be read: %d\n",
3152				propname, 2 * i, ret);
3153			return -EINVAL;
3154		}
3155		ret = of_property_read_string_index(np, propname,
3156			(2 * i) + 1, &routes[i].source);
3157		if (ret) {
3158			dev_err(card->dev,
3159				"ASoC: Property '%s' index %d could not be read: %d\n",
3160				propname, (2 * i) + 1, ret);
3161			return -EINVAL;
3162		}
3163	}
3164
3165	card->num_of_dapm_routes = num_routes;
3166	card->of_dapm_routes = routes;
3167
3168	return 0;
3169}
3170EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3171
3172unsigned int snd_soc_of_parse_daifmt(struct device_node *np,
3173				     const char *prefix,
3174				     struct device_node **bitclkmaster,
3175				     struct device_node **framemaster)
3176{
3177	int ret, i;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3178	char prop[128];
3179	unsigned int format = 0;
3180	int bit, frame;
3181	const char *str;
3182	struct {
3183		char *name;
3184		unsigned int val;
3185	} of_fmt_table[] = {
3186		{ "i2s",	SND_SOC_DAIFMT_I2S },
3187		{ "right_j",	SND_SOC_DAIFMT_RIGHT_J },
3188		{ "left_j",	SND_SOC_DAIFMT_LEFT_J },
3189		{ "dsp_a",	SND_SOC_DAIFMT_DSP_A },
3190		{ "dsp_b",	SND_SOC_DAIFMT_DSP_B },
3191		{ "ac97",	SND_SOC_DAIFMT_AC97 },
3192		{ "pdm",	SND_SOC_DAIFMT_PDM},
3193		{ "msb",	SND_SOC_DAIFMT_MSB },
3194		{ "lsb",	SND_SOC_DAIFMT_LSB },
3195	};
3196
3197	if (!prefix)
3198		prefix = "";
3199
3200	/*
3201	 * check "dai-format = xxx"
3202	 * or    "[prefix]format = xxx"
3203	 * SND_SOC_DAIFMT_FORMAT_MASK area
3204	 */
3205	ret = of_property_read_string(np, "dai-format", &str);
3206	if (ret < 0) {
3207		snprintf(prop, sizeof(prop), "%sformat", prefix);
3208		ret = of_property_read_string(np, prop, &str);
3209	}
3210	if (ret == 0) {
 
 
3211		for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3212			if (strcmp(str, of_fmt_table[i].name) == 0) {
3213				format |= of_fmt_table[i].val;
3214				break;
3215			}
3216		}
3217	}
3218
3219	/*
3220	 * check "[prefix]continuous-clock"
3221	 * SND_SOC_DAIFMT_CLOCK_MASK area
3222	 */
3223	snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3224	if (of_property_read_bool(np, prop))
3225		format |= SND_SOC_DAIFMT_CONT;
3226	else
3227		format |= SND_SOC_DAIFMT_GATED;
3228
3229	/*
3230	 * check "[prefix]bitclock-inversion"
3231	 * check "[prefix]frame-inversion"
3232	 * SND_SOC_DAIFMT_INV_MASK area
3233	 */
3234	snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3235	bit = !!of_get_property(np, prop, NULL);
3236
3237	snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3238	frame = !!of_get_property(np, prop, NULL);
3239
3240	switch ((bit << 4) + frame) {
3241	case 0x11:
3242		format |= SND_SOC_DAIFMT_IB_IF;
3243		break;
3244	case 0x10:
3245		format |= SND_SOC_DAIFMT_IB_NF;
3246		break;
3247	case 0x01:
3248		format |= SND_SOC_DAIFMT_NB_IF;
3249		break;
3250	default:
3251		/* SND_SOC_DAIFMT_NB_NF is default */
3252		break;
3253	}
3254
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3255	/*
3256	 * check "[prefix]bitclock-master"
3257	 * check "[prefix]frame-master"
3258	 * SND_SOC_DAIFMT_MASTER_MASK area
3259	 */
3260	snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3261	bit = !!of_get_property(np, prop, NULL);
3262	if (bit && bitclkmaster)
3263		*bitclkmaster = of_parse_phandle(np, prop, 0);
3264
3265	snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3266	frame = !!of_get_property(np, prop, NULL);
3267	if (frame && framemaster)
3268		*framemaster = of_parse_phandle(np, prop, 0);
3269
3270	switch ((bit << 4) + frame) {
3271	case 0x11:
3272		format |= SND_SOC_DAIFMT_CBM_CFM;
3273		break;
3274	case 0x10:
3275		format |= SND_SOC_DAIFMT_CBM_CFS;
3276		break;
3277	case 0x01:
3278		format |= SND_SOC_DAIFMT_CBS_CFM;
3279		break;
3280	default:
3281		format |= SND_SOC_DAIFMT_CBS_CFS;
3282		break;
3283	}
3284
3285	return format;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3286}
3287EXPORT_SYMBOL_GPL(snd_soc_of_parse_daifmt);
3288
3289int snd_soc_get_dai_id(struct device_node *ep)
3290{
3291	struct snd_soc_component *component;
3292	struct snd_soc_dai_link_component dlc;
 
 
3293	int ret;
3294
3295	dlc.of_node	= of_graph_get_port_parent(ep);
3296	dlc.name	= NULL;
3297	/*
3298	 * For example HDMI case, HDMI has video/sound port,
3299	 * but ALSA SoC needs sound port number only.
3300	 * Thus counting HDMI DT port/endpoint doesn't work.
3301	 * Then, it should have .of_xlate_dai_id
3302	 */
3303	ret = -ENOTSUPP;
3304	mutex_lock(&client_mutex);
3305	component = soc_find_component(&dlc);
3306	if (component)
3307		ret = snd_soc_component_of_xlate_dai_id(component, ep);
3308	mutex_unlock(&client_mutex);
3309
3310	of_node_put(dlc.of_node);
3311
3312	return ret;
3313}
3314EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3315
3316int snd_soc_get_dai_name(struct of_phandle_args *args,
3317				const char **dai_name)
3318{
3319	struct snd_soc_component *pos;
3320	struct device_node *component_of_node;
3321	int ret = -EPROBE_DEFER;
3322
3323	mutex_lock(&client_mutex);
3324	for_each_component(pos) {
3325		component_of_node = soc_component_to_node(pos);
3326
3327		if (component_of_node != args->np)
3328			continue;
3329
3330		ret = snd_soc_component_of_xlate_dai_name(pos, args, dai_name);
3331		if (ret == -ENOTSUPP) {
3332			struct snd_soc_dai *dai;
3333			int id = -1;
3334
3335			switch (args->args_count) {
3336			case 0:
3337				id = 0; /* same as dai_drv[0] */
3338				break;
3339			case 1:
3340				id = args->args[0];
3341				break;
3342			default:
3343				/* not supported */
3344				break;
3345			}
3346
3347			if (id < 0 || id >= pos->num_dai) {
3348				ret = -EINVAL;
3349				continue;
3350			}
3351
3352			ret = 0;
3353
3354			/* find target DAI */
3355			for_each_component_dais(pos, dai) {
3356				if (id == 0)
3357					break;
3358				id--;
3359			}
3360
3361			*dai_name = dai->driver->name;
3362			if (!*dai_name)
3363				*dai_name = pos->name;
 
 
 
 
 
 
3364		}
3365
3366		break;
3367	}
 
 
 
 
3368	mutex_unlock(&client_mutex);
3369	return ret;
3370}
3371EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3372
3373int snd_soc_of_get_dai_name(struct device_node *of_node,
3374			    const char **dai_name)
 
 
3375{
3376	struct of_phandle_args args;
3377	int ret;
3378
 
 
 
3379	ret = of_parse_phandle_with_args(of_node, "sound-dai",
3380					 "#sound-dai-cells", 0, &args);
3381	if (ret)
3382		return ret;
3383
3384	ret = snd_soc_get_dai_name(&args, dai_name);
 
 
 
 
 
 
 
 
 
 
 
3385
3386	of_node_put(args.np);
 
 
 
 
 
 
 
 
 
 
 
3387
3388	return ret;
3389}
3390EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3391
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3392/*
3393 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3394 * @dai_link: DAI link
3395 *
3396 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3397 */
3398void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3399{
3400	struct snd_soc_dai_link_component *component;
3401	int index;
3402
3403	for_each_link_codecs(dai_link, index, component) {
3404		if (!component->of_node)
3405			break;
3406		of_node_put(component->of_node);
3407		component->of_node = NULL;
3408	}
3409}
3410EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3411
3412/*
3413 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3414 * @dev: Card device
3415 * @of_node: Device node
3416 * @dai_link: DAI link
3417 *
3418 * Builds an array of CODEC DAI components from the DAI link property
3419 * 'sound-dai'.
3420 * The array is set in the DAI link and the number of DAIs is set accordingly.
3421 * The device nodes in the array (of_node) must be dereferenced by calling
3422 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3423 *
3424 * Returns 0 for success
3425 */
3426int snd_soc_of_get_dai_link_codecs(struct device *dev,
3427				   struct device_node *of_node,
3428				   struct snd_soc_dai_link *dai_link)
3429{
3430	struct of_phandle_args args;
3431	struct snd_soc_dai_link_component *component;
3432	char *name;
3433	int index, num_codecs, ret;
3434
3435	/* Count the number of CODECs */
3436	name = "sound-dai";
3437	num_codecs = of_count_phandle_with_args(of_node, name,
3438						"#sound-dai-cells");
3439	if (num_codecs <= 0) {
3440		if (num_codecs == -ENOENT)
3441			dev_err(dev, "No 'sound-dai' property\n");
3442		else
3443			dev_err(dev, "Bad phandle in 'sound-dai'\n");
3444		return num_codecs;
3445	}
3446	component = devm_kcalloc(dev,
3447				 num_codecs, sizeof(*component),
3448				 GFP_KERNEL);
3449	if (!component)
3450		return -ENOMEM;
3451	dai_link->codecs = component;
3452	dai_link->num_codecs = num_codecs;
3453
3454	/* Parse the list */
3455	for_each_link_codecs(dai_link, index, component) {
3456		ret = of_parse_phandle_with_args(of_node, name,
3457						 "#sound-dai-cells",
3458						 index, &args);
3459		if (ret)
3460			goto err;
3461		component->of_node = args.np;
3462		ret = snd_soc_get_dai_name(&args, &component->dai_name);
3463		if (ret < 0)
3464			goto err;
3465	}
3466	return 0;
3467err:
3468	snd_soc_of_put_dai_link_codecs(dai_link);
3469	dai_link->codecs = NULL;
3470	dai_link->num_codecs = 0;
3471	return ret;
3472}
3473EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3474
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3475static int __init snd_soc_init(void)
3476{
 
 
3477	snd_soc_debugfs_init();
3478	snd_soc_util_init();
 
 
 
 
 
 
 
3479
3480	return platform_driver_register(&soc_driver);
 
 
 
 
3481}
3482module_init(snd_soc_init);
3483
3484static void __exit snd_soc_exit(void)
3485{
3486	snd_soc_util_exit();
3487	snd_soc_debugfs_exit();
3488
3489	platform_driver_unregister(&soc_driver);
3490}
3491module_exit(snd_soc_exit);
3492
3493/* Module information */
3494MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3495MODULE_DESCRIPTION("ALSA SoC Core");
3496MODULE_LICENSE("GPL");
3497MODULE_ALIAS("platform:soc-audio");
v6.8
   1// SPDX-License-Identifier: GPL-2.0+
   2//
   3// soc-core.c  --  ALSA SoC Audio Layer
   4//
   5// Copyright 2005 Wolfson Microelectronics PLC.
   6// Copyright 2005 Openedhand Ltd.
   7// Copyright (C) 2010 Slimlogic Ltd.
   8// Copyright (C) 2010 Texas Instruments Inc.
   9//
  10// Author: Liam Girdwood <lrg@slimlogic.co.uk>
  11//         with code, comments and ideas from :-
  12//         Richard Purdie <richard@openedhand.com>
  13//
  14//  TODO:
  15//   o Add hw rules to enforce rates, etc.
  16//   o More testing with other codecs/machines.
  17//   o Add more codecs and platforms to ensure good API coverage.
  18//   o Support TDM on PCM and I2S
  19
  20#include <linux/module.h>
  21#include <linux/moduleparam.h>
  22#include <linux/init.h>
  23#include <linux/delay.h>
  24#include <linux/pm.h>
  25#include <linux/bitops.h>
  26#include <linux/debugfs.h>
  27#include <linux/platform_device.h>
  28#include <linux/pinctrl/consumer.h>
  29#include <linux/ctype.h>
  30#include <linux/slab.h>
  31#include <linux/of.h>
  32#include <linux/of_graph.h>
  33#include <linux/dmi.h>
  34#include <linux/acpi.h>
  35#include <sound/core.h>
 
  36#include <sound/pcm.h>
  37#include <sound/pcm_params.h>
  38#include <sound/soc.h>
  39#include <sound/soc-dpcm.h>
  40#include <sound/soc-topology.h>
  41#include <sound/soc-link.h>
  42#include <sound/initval.h>
  43
  44#define CREATE_TRACE_POINTS
  45#include <trace/events/asoc.h>
  46
 
 
 
 
 
 
 
  47static DEFINE_MUTEX(client_mutex);
  48static LIST_HEAD(component_list);
  49static LIST_HEAD(unbind_card_list);
  50
  51#define for_each_component(component)			\
  52	list_for_each_entry(component, &component_list, list)
  53
  54/*
  55 * This is used if driver don't need to have CPU/Codec/Platform
  56 * dai_link. see soc.h
  57 */
  58struct snd_soc_dai_link_component null_dailink_component[0];
  59EXPORT_SYMBOL_GPL(null_dailink_component);
  60
  61/*
  62 * This is a timeout to do a DAPM powerdown after a stream is closed().
  63 * It can be used to eliminate pops between different playback streams, e.g.
  64 * between two audio tracks.
  65 */
  66static int pmdown_time = 5000;
  67module_param(pmdown_time, int, 0);
  68MODULE_PARM_DESC(pmdown_time, "DAPM stream powerdown time (msecs)");
  69
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  70static ssize_t pmdown_time_show(struct device *dev,
  71				struct device_attribute *attr, char *buf)
  72{
  73	struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
  74
  75	return sysfs_emit(buf, "%ld\n", rtd->pmdown_time);
  76}
  77
  78static ssize_t pmdown_time_store(struct device *dev,
  79				 struct device_attribute *attr,
  80				 const char *buf, size_t count)
  81{
  82	struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
  83	int ret;
  84
  85	ret = kstrtol(buf, 10, &rtd->pmdown_time);
  86	if (ret)
  87		return ret;
  88
  89	return count;
  90}
  91
  92static DEVICE_ATTR_RW(pmdown_time);
  93
  94static struct attribute *soc_dev_attrs[] = {
  95	&dev_attr_pmdown_time.attr,
  96	NULL
  97};
  98
  99static umode_t soc_dev_attr_is_visible(struct kobject *kobj,
 100				       struct attribute *attr, int idx)
 101{
 102	struct device *dev = kobj_to_dev(kobj);
 103	struct snd_soc_pcm_runtime *rtd = dev_get_drvdata(dev);
 104
 105	if (!rtd)
 106		return 0;
 107
 108	if (attr == &dev_attr_pmdown_time.attr)
 109		return attr->mode; /* always visible */
 110	return rtd->dai_link->num_codecs ? attr->mode : 0; /* enabled only with codec */
 111}
 112
 113static const struct attribute_group soc_dapm_dev_group = {
 114	.attrs = soc_dapm_dev_attrs,
 115	.is_visible = soc_dev_attr_is_visible,
 116};
 117
 118static const struct attribute_group soc_dev_group = {
 119	.attrs = soc_dev_attrs,
 120	.is_visible = soc_dev_attr_is_visible,
 121};
 122
 123static const struct attribute_group *soc_dev_attr_groups[] = {
 124	&soc_dapm_dev_group,
 125	&soc_dev_group,
 126	NULL
 127};
 128
 129#ifdef CONFIG_DEBUG_FS
 130struct dentry *snd_soc_debugfs_root;
 131EXPORT_SYMBOL_GPL(snd_soc_debugfs_root);
 132
 133static void soc_init_component_debugfs(struct snd_soc_component *component)
 134{
 135	if (!component->card->debugfs_card_root)
 136		return;
 137
 138	if (component->debugfs_prefix) {
 139		char *name;
 140
 141		name = kasprintf(GFP_KERNEL, "%s:%s",
 142			component->debugfs_prefix, component->name);
 143		if (name) {
 144			component->debugfs_root = debugfs_create_dir(name,
 145				component->card->debugfs_card_root);
 146			kfree(name);
 147		}
 148	} else {
 149		component->debugfs_root = debugfs_create_dir(component->name,
 150				component->card->debugfs_card_root);
 151	}
 152
 153	snd_soc_dapm_debugfs_init(snd_soc_component_get_dapm(component),
 154		component->debugfs_root);
 155}
 156
 157static void soc_cleanup_component_debugfs(struct snd_soc_component *component)
 158{
 159	if (!component->debugfs_root)
 160		return;
 161	debugfs_remove_recursive(component->debugfs_root);
 162	component->debugfs_root = NULL;
 163}
 164
 165static int dai_list_show(struct seq_file *m, void *v)
 166{
 167	struct snd_soc_component *component;
 168	struct snd_soc_dai *dai;
 169
 170	mutex_lock(&client_mutex);
 171
 172	for_each_component(component)
 173		for_each_component_dais(component, dai)
 174			seq_printf(m, "%s\n", dai->name);
 175
 176	mutex_unlock(&client_mutex);
 177
 178	return 0;
 179}
 180DEFINE_SHOW_ATTRIBUTE(dai_list);
 181
 182static int component_list_show(struct seq_file *m, void *v)
 183{
 184	struct snd_soc_component *component;
 185
 186	mutex_lock(&client_mutex);
 187
 188	for_each_component(component)
 189		seq_printf(m, "%s\n", component->name);
 190
 191	mutex_unlock(&client_mutex);
 192
 193	return 0;
 194}
 195DEFINE_SHOW_ATTRIBUTE(component_list);
 196
 197static void soc_init_card_debugfs(struct snd_soc_card *card)
 198{
 199	card->debugfs_card_root = debugfs_create_dir(card->name,
 200						     snd_soc_debugfs_root);
 201
 202	debugfs_create_u32("dapm_pop_time", 0644, card->debugfs_card_root,
 203			   &card->pop_time);
 204
 205	snd_soc_dapm_debugfs_init(&card->dapm, card->debugfs_card_root);
 206}
 207
 208static void soc_cleanup_card_debugfs(struct snd_soc_card *card)
 209{
 210	debugfs_remove_recursive(card->debugfs_card_root);
 211	card->debugfs_card_root = NULL;
 212}
 213
 214static void snd_soc_debugfs_init(void)
 215{
 216	snd_soc_debugfs_root = debugfs_create_dir("asoc", NULL);
 217
 218	debugfs_create_file("dais", 0444, snd_soc_debugfs_root, NULL,
 219			    &dai_list_fops);
 220
 221	debugfs_create_file("components", 0444, snd_soc_debugfs_root, NULL,
 222			    &component_list_fops);
 223}
 224
 225static void snd_soc_debugfs_exit(void)
 226{
 227	debugfs_remove_recursive(snd_soc_debugfs_root);
 228}
 229
 230#else
 231
 232static inline void soc_init_component_debugfs(struct snd_soc_component *component) { }
 233static inline void soc_cleanup_component_debugfs(struct snd_soc_component *component) { }
 234static inline void soc_init_card_debugfs(struct snd_soc_card *card) { }
 235static inline void soc_cleanup_card_debugfs(struct snd_soc_card *card) { }
 236static inline void snd_soc_debugfs_init(void) { }
 237static inline void snd_soc_debugfs_exit(void) { }
 238
 239#endif
 240
 241static int snd_soc_is_match_dai_args(struct of_phandle_args *args1,
 242				     struct of_phandle_args *args2)
 243{
 244	if (!args1 || !args2)
 245		return 0;
 246
 247	if (args1->np != args2->np)
 248		return 0;
 249
 250	for (int i = 0; i < args1->args_count; i++)
 251		if (args1->args[i] != args2->args[i])
 252			return 0;
 253
 254	return 1;
 255}
 256
 257static inline int snd_soc_dlc_component_is_empty(struct snd_soc_dai_link_component *dlc)
 258{
 259	return !(dlc->dai_args || dlc->name || dlc->of_node);
 260}
 261
 262static inline int snd_soc_dlc_component_is_invalid(struct snd_soc_dai_link_component *dlc)
 263{
 264	return (dlc->name && dlc->of_node);
 265}
 266
 267static inline int snd_soc_dlc_dai_is_empty(struct snd_soc_dai_link_component *dlc)
 268{
 269	return !(dlc->dai_args || dlc->dai_name);
 270}
 271
 272static int snd_soc_is_matching_dai(const struct snd_soc_dai_link_component *dlc,
 273				   struct snd_soc_dai *dai)
 274{
 275	if (!dlc)
 276		return 0;
 277
 278	if (dlc->dai_args)
 279		return snd_soc_is_match_dai_args(dai->driver->dai_args, dlc->dai_args);
 280
 281	if (!dlc->dai_name)
 282		return 1;
 
 
 283
 284	/* see snd_soc_dai_name_get() */
 
 
 
 
 285
 286	if (strcmp(dlc->dai_name, dai->name) == 0)
 287		return 1;
 
 288
 289	if (dai->driver->name &&
 290	    strcmp(dai->driver->name, dlc->dai_name) == 0)
 291		return 1;
 292
 293	if (dai->component->name &&
 294	    strcmp(dlc->dai_name, dai->component->name) == 0)
 295		return 1;
 296
 297	return 0;
 298}
 299
 300const char *snd_soc_dai_name_get(struct snd_soc_dai *dai)
 301{
 302	/* see snd_soc_is_matching_dai() */
 303	if (dai->name)
 304		return dai->name;
 305
 306	if (dai->driver->name)
 307		return dai->driver->name;
 308
 309	if (dai->component->name)
 310		return dai->component->name;
 311
 312	return NULL;
 313}
 314EXPORT_SYMBOL_GPL(snd_soc_dai_name_get);
 315
 316static int snd_soc_rtd_add_component(struct snd_soc_pcm_runtime *rtd,
 317				     struct snd_soc_component *component)
 318{
 319	struct snd_soc_component *comp;
 320	int i;
 321
 322	for_each_rtd_components(rtd, i, comp) {
 323		/* already connected */
 324		if (comp == component)
 325			return 0;
 326	}
 327
 328	/* see for_each_rtd_components */
 329	rtd->components[rtd->num_components] = component;
 330	rtd->num_components++;
 331
 332	return 0;
 333}
 334
 335struct snd_soc_component *snd_soc_rtdcom_lookup(struct snd_soc_pcm_runtime *rtd,
 336						const char *driver_name)
 337{
 338	struct snd_soc_component *component;
 339	int i;
 340
 341	if (!driver_name)
 342		return NULL;
 343
 344	/*
 345	 * NOTE
 346	 *
 347	 * snd_soc_rtdcom_lookup() will find component from rtd by using
 348	 * specified driver name.
 349	 * But, if many components which have same driver name are connected
 350	 * to 1 rtd, this function will return 1st found component.
 351	 */
 352	for_each_rtd_components(rtd, i, component) {
 353		const char *component_name = component->driver->name;
 354
 355		if (!component_name)
 356			continue;
 357
 358		if ((component_name == driver_name) ||
 359		    strcmp(component_name, driver_name) == 0)
 360			return component;
 361	}
 362
 363	return NULL;
 364}
 365EXPORT_SYMBOL_GPL(snd_soc_rtdcom_lookup);
 366
 367struct snd_soc_component
 368*snd_soc_lookup_component_nolocked(struct device *dev, const char *driver_name)
 369{
 370	struct snd_soc_component *component;
 371	struct snd_soc_component *found_component;
 372
 373	found_component = NULL;
 374	for_each_component(component) {
 375		if ((dev == component->dev) &&
 376		    (!driver_name ||
 377		     (driver_name == component->driver->name) ||
 378		     (strcmp(component->driver->name, driver_name) == 0))) {
 379			found_component = component;
 380			break;
 381		}
 382	}
 383
 384	return found_component;
 385}
 386EXPORT_SYMBOL_GPL(snd_soc_lookup_component_nolocked);
 387
 388struct snd_soc_component *snd_soc_lookup_component(struct device *dev,
 389						   const char *driver_name)
 390{
 391	struct snd_soc_component *component;
 392
 393	mutex_lock(&client_mutex);
 394	component = snd_soc_lookup_component_nolocked(dev, driver_name);
 395	mutex_unlock(&client_mutex);
 396
 397	return component;
 398}
 399EXPORT_SYMBOL_GPL(snd_soc_lookup_component);
 400
 401struct snd_soc_pcm_runtime
 402*snd_soc_get_pcm_runtime(struct snd_soc_card *card,
 403			 struct snd_soc_dai_link *dai_link)
 404{
 405	struct snd_soc_pcm_runtime *rtd;
 406
 407	for_each_card_rtds(card, rtd) {
 408		if (rtd->dai_link == dai_link)
 409			return rtd;
 
 410	}
 411	dev_dbg(card->dev, "ASoC: failed to find rtd %s\n", dai_link->name);
 412	return NULL;
 413}
 414EXPORT_SYMBOL_GPL(snd_soc_get_pcm_runtime);
 415
 416/*
 417 * Power down the audio subsystem pmdown_time msecs after close is called.
 418 * This is to ensure there are no pops or clicks in between any music tracks
 419 * due to DAPM power cycling.
 420 */
 421void snd_soc_close_delayed_work(struct snd_soc_pcm_runtime *rtd)
 422{
 423	struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, 0);
 424	int playback = SNDRV_PCM_STREAM_PLAYBACK;
 425
 426	snd_soc_dpcm_mutex_lock(rtd);
 427
 428	dev_dbg(rtd->dev,
 429		"ASoC: pop wq checking: %s status: %s waiting: %s\n",
 430		codec_dai->driver->playback.stream_name,
 431		snd_soc_dai_stream_active(codec_dai, playback) ?
 432		"active" : "inactive",
 433		rtd->pop_wait ? "yes" : "no");
 434
 435	/* are we waiting on this codec DAI stream */
 436	if (rtd->pop_wait == 1) {
 437		rtd->pop_wait = 0;
 438		snd_soc_dapm_stream_event(rtd, playback,
 439					  SND_SOC_DAPM_STREAM_STOP);
 440	}
 441
 442	snd_soc_dpcm_mutex_unlock(rtd);
 443}
 444EXPORT_SYMBOL_GPL(snd_soc_close_delayed_work);
 445
 446static void soc_release_rtd_dev(struct device *dev)
 447{
 448	/* "dev" means "rtd->dev" */
 449	kfree(dev);
 450}
 451
 452static void soc_free_pcm_runtime(struct snd_soc_pcm_runtime *rtd)
 453{
 454	if (!rtd)
 455		return;
 456
 457	list_del(&rtd->list);
 458
 459	if (delayed_work_pending(&rtd->delayed_work))
 460		flush_delayed_work(&rtd->delayed_work);
 461	snd_soc_pcm_component_free(rtd);
 462
 463	/*
 464	 * we don't need to call kfree() for rtd->dev
 465	 * see
 466	 *	soc_release_rtd_dev()
 467	 *
 468	 * We don't need rtd->dev NULL check, because
 469	 * it is alloced *before* rtd.
 470	 * see
 471	 *	soc_new_pcm_runtime()
 472	 *
 473	 * We don't need to mind freeing for rtd,
 474	 * because it was created from dev (= rtd->dev)
 475	 * see
 476	 *	soc_new_pcm_runtime()
 477	 *
 478	 *		rtd = devm_kzalloc(dev, ...);
 479	 *		rtd->dev = dev
 480	 */
 481	device_unregister(rtd->dev);
 482}
 483
 484static void close_delayed_work(struct work_struct *work) {
 485	struct snd_soc_pcm_runtime *rtd =
 486			container_of(work, struct snd_soc_pcm_runtime,
 487				     delayed_work.work);
 488
 489	if (rtd->close_delayed_work_func)
 490		rtd->close_delayed_work_func(rtd);
 491}
 492
 493static struct snd_soc_pcm_runtime *soc_new_pcm_runtime(
 494	struct snd_soc_card *card, struct snd_soc_dai_link *dai_link)
 495{
 496	struct snd_soc_pcm_runtime *rtd;
 497	struct snd_soc_component *component;
 498	struct device *dev;
 499	int ret;
 500	int stream;
 501
 502	/*
 503	 * for rtd->dev
 504	 */
 505	dev = kzalloc(sizeof(struct device), GFP_KERNEL);
 506	if (!dev)
 507		return NULL;
 508
 509	dev->parent	= card->dev;
 510	dev->release	= soc_release_rtd_dev;
 
 
 
 511
 512	dev_set_name(dev, "%s", dai_link->name);
 513
 514	ret = device_register(dev);
 515	if (ret < 0) {
 516		put_device(dev); /* soc_release_rtd_dev */
 517		return NULL;
 518	}
 519
 520	/*
 521	 * for rtd
 522	 */
 523	rtd = devm_kzalloc(dev,
 524			   sizeof(*rtd) +
 525			   sizeof(component) * (dai_link->num_cpus +
 526						 dai_link->num_codecs +
 527						 dai_link->num_platforms),
 528			   GFP_KERNEL);
 529	if (!rtd) {
 530		device_unregister(dev);
 531		return NULL;
 532	}
 533
 534	rtd->dev = dev;
 535	INIT_LIST_HEAD(&rtd->list);
 536	for_each_pcm_streams(stream) {
 537		INIT_LIST_HEAD(&rtd->dpcm[stream].be_clients);
 538		INIT_LIST_HEAD(&rtd->dpcm[stream].fe_clients);
 539	}
 540	dev_set_drvdata(dev, rtd);
 541	INIT_DELAYED_WORK(&rtd->delayed_work, close_delayed_work);
 542
 543	/*
 544	 * for rtd->dais
 545	 */
 546	rtd->dais = devm_kcalloc(dev, dai_link->num_cpus + dai_link->num_codecs,
 547					sizeof(struct snd_soc_dai *),
 548					GFP_KERNEL);
 549	if (!rtd->dais)
 550		goto free_rtd;
 551
 552	/*
 553	 * dais = [][][][][][][][][][][][][][][][][][]
 554	 *	  ^cpu_dais         ^codec_dais
 555	 *	  |--- num_cpus ---|--- num_codecs --|
 556	 * see
 557	 *	snd_soc_rtd_to_cpu()
 558	 *	snd_soc_rtd_to_codec()
 559	 */
 560	rtd->card	= card;
 561	rtd->dai_link	= dai_link;
 562	rtd->num	= card->num_rtd++;
 563	rtd->pmdown_time = pmdown_time;			/* default power off timeout */
 564
 
 
 
 565	/* see for_each_card_rtds */
 566	list_add_tail(&rtd->list, &card->rtd_list);
 567
 568	ret = device_add_groups(dev, soc_dev_attr_groups);
 569	if (ret < 0)
 570		goto free_rtd;
 571
 572	return rtd;
 573
 574free_rtd:
 575	soc_free_pcm_runtime(rtd);
 576	return NULL;
 577}
 578
 579static void snd_soc_fill_dummy_dai(struct snd_soc_card *card)
 580{
 581	struct snd_soc_dai_link *dai_link;
 582	int i;
 583
 584	/*
 585	 * COMP_DUMMY() creates size 0 array on dai_link.
 586	 * Fill it as dummy DAI in case of CPU/Codec here.
 587	 * Do nothing for Platform.
 588	 */
 589	for_each_card_prelinks(card, i, dai_link) {
 590		if (dai_link->num_cpus == 0 && dai_link->cpus) {
 591			dai_link->num_cpus	= 1;
 592			dai_link->cpus		= &snd_soc_dummy_dlc;
 593		}
 594		if (dai_link->num_codecs == 0 && dai_link->codecs) {
 595			dai_link->num_codecs	= 1;
 596			dai_link->codecs	= &snd_soc_dummy_dlc;
 597		}
 598	}
 599}
 600
 601static void snd_soc_flush_all_delayed_work(struct snd_soc_card *card)
 602{
 603	struct snd_soc_pcm_runtime *rtd;
 604
 605	for_each_card_rtds(card, rtd)
 606		flush_delayed_work(&rtd->delayed_work);
 607}
 608
 609#ifdef CONFIG_PM_SLEEP
 610static void soc_playback_digital_mute(struct snd_soc_card *card, int mute)
 611{
 612	struct snd_soc_pcm_runtime *rtd;
 613	struct snd_soc_dai *dai;
 614	int playback = SNDRV_PCM_STREAM_PLAYBACK;
 615	int i;
 616
 617	for_each_card_rtds(card, rtd) {
 618
 619		if (rtd->dai_link->ignore_suspend)
 620			continue;
 621
 622		for_each_rtd_dais(rtd, i, dai) {
 623			if (snd_soc_dai_stream_active(dai, playback))
 624				snd_soc_dai_digital_mute(dai, mute, playback);
 625		}
 626	}
 
 
 627}
 
 628
 629static void soc_dapm_suspend_resume(struct snd_soc_card *card, int event)
 630{
 631	struct snd_soc_pcm_runtime *rtd;
 632	int stream;
 633
 634	for_each_card_rtds(card, rtd) {
 635
 636		if (rtd->dai_link->ignore_suspend)
 637			continue;
 638
 639		for_each_pcm_streams(stream)
 640			snd_soc_dapm_stream_event(rtd, stream, event);
 641	}
 642}
 643
 
 644/* powers down audio subsystem for suspend */
 645int snd_soc_suspend(struct device *dev)
 646{
 647	struct snd_soc_card *card = dev_get_drvdata(dev);
 648	struct snd_soc_component *component;
 649	struct snd_soc_pcm_runtime *rtd;
 650	int i;
 651
 652	/* If the card is not initialized yet there is nothing to do */
 653	if (!snd_soc_card_is_instantiated(card))
 654		return 0;
 655
 656	/*
 657	 * Due to the resume being scheduled into a workqueue we could
 658	 * suspend before that's finished - wait for it to complete.
 659	 */
 660	snd_power_wait(card->snd_card);
 661
 662	/* we're going to block userspace touching us until resume completes */
 663	snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D3hot);
 664
 665	/* mute any active DACs */
 666	soc_playback_digital_mute(card, 1);
 
 
 
 
 
 
 
 
 
 
 
 667
 668	/* suspend all pcms */
 669	for_each_card_rtds(card, rtd) {
 670		if (rtd->dai_link->ignore_suspend)
 671			continue;
 672
 673		snd_pcm_suspend_all(rtd->pcm);
 674	}
 675
 676	snd_soc_card_suspend_pre(card);
 
 
 
 
 
 
 
 
 
 
 
 677
 678	/* close any waiting streams */
 679	snd_soc_flush_all_delayed_work(card);
 680
 681	soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_SUSPEND);
 
 
 
 
 
 
 
 
 
 
 
 
 682
 683	/* Recheck all endpoints too, their state is affected by suspend */
 684	dapm_mark_endpoints_dirty(card);
 685	snd_soc_dapm_sync(&card->dapm);
 686
 687	/* suspend all COMPONENTs */
 688	for_each_card_rtds(card, rtd) {
 689
 690		if (rtd->dai_link->ignore_suspend)
 691			continue;
 692
 693		for_each_rtd_components(rtd, i, component) {
 694			struct snd_soc_dapm_context *dapm =
 695				snd_soc_component_get_dapm(component);
 696
 697			/*
 698			 * ignore if component was already suspended
 699			 */
 700			if (snd_soc_component_is_suspended(component))
 701				continue;
 702
 703			/*
 704			 * If there are paths active then the COMPONENT will be
 705			 * held with bias _ON and should not be suspended.
 706			 */
 707			switch (snd_soc_dapm_get_bias_level(dapm)) {
 708			case SND_SOC_BIAS_STANDBY:
 709				/*
 710				 * If the COMPONENT is capable of idle
 711				 * bias off then being in STANDBY
 712				 * means it's doing something,
 713				 * otherwise fall through.
 714				 */
 715				if (dapm->idle_bias_off) {
 716					dev_dbg(component->dev,
 717						"ASoC: idle_bias_off CODEC on over suspend\n");
 718					break;
 719				}
 720				fallthrough;
 721
 722			case SND_SOC_BIAS_OFF:
 723				snd_soc_component_suspend(component);
 724				if (component->regmap)
 725					regcache_mark_dirty(component->regmap);
 726				/* deactivate pins to sleep state */
 727				pinctrl_pm_select_sleep_state(component->dev);
 728				break;
 729			default:
 730				dev_dbg(component->dev,
 731					"ASoC: COMPONENT is on over suspend\n");
 732				break;
 733			}
 734		}
 735	}
 736
 737	snd_soc_card_suspend_post(card);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 738
 739	return 0;
 740}
 741EXPORT_SYMBOL_GPL(snd_soc_suspend);
 742
 743/*
 744 * deferred resume work, so resume can complete before we finished
 745 * setting our codec back up, which can be very slow on I2C
 746 */
 747static void soc_resume_deferred(struct work_struct *work)
 748{
 749	struct snd_soc_card *card =
 750			container_of(work, struct snd_soc_card,
 751				     deferred_resume_work);
 
 752	struct snd_soc_component *component;
 
 753
 754	/*
 755	 * our power state is still SNDRV_CTL_POWER_D3hot from suspend time,
 756	 * so userspace apps are blocked from touching us
 757	 */
 758
 759	dev_dbg(card->dev, "ASoC: starting resume work\n");
 760
 761	/* Bring us up into D2 so that DAPM starts enabling things */
 762	snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D2);
 763
 764	snd_soc_card_resume_pre(card);
 
 
 
 
 
 
 
 
 
 
 
 
 765
 766	for_each_card_components(card, component) {
 767		if (snd_soc_component_is_suspended(component))
 768			snd_soc_component_resume(component);
 769	}
 770
 771	soc_dapm_suspend_resume(card, SND_SOC_DAPM_STREAM_RESUME);
 
 
 
 
 
 
 
 
 
 
 
 
 772
 773	/* unmute any active DACs */
 774	soc_playback_digital_mute(card, 0);
 
 
 
 
 775
 776	snd_soc_card_resume_post(card);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 777
 778	dev_dbg(card->dev, "ASoC: resume work completed\n");
 779
 780	/* Recheck all endpoints too, their state is affected by suspend */
 781	dapm_mark_endpoints_dirty(card);
 782	snd_soc_dapm_sync(&card->dapm);
 783
 784	/* userspace can access us now we are back as we were before */
 785	snd_power_change_state(card->snd_card, SNDRV_CTL_POWER_D0);
 786}
 787
 788/* powers up audio subsystem after a suspend */
 789int snd_soc_resume(struct device *dev)
 790{
 791	struct snd_soc_card *card = dev_get_drvdata(dev);
 792	struct snd_soc_component *component;
 
 
 
 793
 794	/* If the card is not initialized yet there is nothing to do */
 795	if (!snd_soc_card_is_instantiated(card))
 796		return 0;
 797
 798	/* activate pins from sleep state */
 799	for_each_card_components(card, component)
 800		if (snd_soc_component_active(component))
 801			pinctrl_pm_select_default_state(component->dev);
 802
 803	dev_dbg(dev, "ASoC: Scheduling resume work\n");
 804	if (!schedule_work(&card->deferred_resume_work))
 805		dev_err(dev, "ASoC: resume work item may be lost\n");
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 806
 807	return 0;
 808}
 809EXPORT_SYMBOL_GPL(snd_soc_resume);
 810
 811static void soc_resume_init(struct snd_soc_card *card)
 812{
 813	/* deferred resume work */
 814	INIT_WORK(&card->deferred_resume_work, soc_resume_deferred);
 815}
 816#else
 817#define snd_soc_suspend NULL
 818#define snd_soc_resume NULL
 819static inline void soc_resume_init(struct snd_soc_card *card) { }
 
 
 820#endif
 821
 
 
 
 822static struct device_node
 823*soc_component_to_node(struct snd_soc_component *component)
 824{
 825	struct device_node *of_node;
 826
 827	of_node = component->dev->of_node;
 828	if (!of_node && component->dev->parent)
 829		of_node = component->dev->parent->of_node;
 830
 831	return of_node;
 832}
 833
 834struct of_phandle_args *snd_soc_copy_dai_args(struct device *dev, struct of_phandle_args *args)
 835{
 836	struct of_phandle_args *ret = devm_kzalloc(dev, sizeof(*ret), GFP_KERNEL);
 837
 838	if (!ret)
 839		return NULL;
 840
 841	*ret = *args;
 842
 843	return ret;
 844}
 845EXPORT_SYMBOL_GPL(snd_soc_copy_dai_args);
 846
 847static int snd_soc_is_matching_component(
 848	const struct snd_soc_dai_link_component *dlc,
 849	struct snd_soc_component *component)
 850{
 851	struct device_node *component_of_node;
 852
 853	if (!dlc)
 854		return 0;
 855
 856	if (dlc->dai_args) {
 857		struct snd_soc_dai *dai;
 858
 859		for_each_component_dais(component, dai)
 860			if (snd_soc_is_matching_dai(dlc, dai))
 861				return 1;
 862		return 0;
 863	}
 864
 865	component_of_node = soc_component_to_node(component);
 866
 867	if (dlc->of_node && component_of_node != dlc->of_node)
 868		return 0;
 869	if (dlc->name && strcmp(component->name, dlc->name))
 870		return 0;
 871
 872	return 1;
 873}
 874
 875static struct snd_soc_component *soc_find_component(
 876	const struct snd_soc_dai_link_component *dlc)
 877{
 878	struct snd_soc_component *component;
 879
 880	lockdep_assert_held(&client_mutex);
 881
 882	/*
 883	 * NOTE
 884	 *
 885	 * It returns *1st* found component, but some driver
 886	 * has few components by same of_node/name
 887	 * ex)
 888	 *	CPU component and generic DMAEngine component
 889	 */
 890	for_each_component(component)
 891		if (snd_soc_is_matching_component(dlc, component))
 892			return component;
 893
 894	return NULL;
 895}
 896
 897/**
 898 * snd_soc_find_dai - Find a registered DAI
 899 *
 900 * @dlc: name of the DAI or the DAI driver and optional component info to match
 901 *
 902 * This function will search all registered components and their DAIs to
 903 * find the DAI of the same name. The component's of_node and name
 904 * should also match if being specified.
 905 *
 906 * Return: pointer of DAI, or NULL if not found.
 907 */
 908struct snd_soc_dai *snd_soc_find_dai(
 909	const struct snd_soc_dai_link_component *dlc)
 910{
 911	struct snd_soc_component *component;
 912	struct snd_soc_dai *dai;
 913
 914	lockdep_assert_held(&client_mutex);
 915
 916	/* Find CPU DAI from registered DAIs */
 917	for_each_component(component)
 918		if (snd_soc_is_matching_component(dlc, component))
 919			for_each_component_dais(component, dai)
 920				if (snd_soc_is_matching_dai(dlc, dai))
 921					return dai;
 
 
 
 
 
 
 
 922
 923	return NULL;
 924}
 925EXPORT_SYMBOL_GPL(snd_soc_find_dai);
 926
 927struct snd_soc_dai *snd_soc_find_dai_with_mutex(
 928	const struct snd_soc_dai_link_component *dlc)
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 929{
 930	struct snd_soc_dai *dai;
 931
 932	mutex_lock(&client_mutex);
 933	dai = snd_soc_find_dai(dlc);
 934	mutex_unlock(&client_mutex);
 935
 936	return dai;
 937}
 938EXPORT_SYMBOL_GPL(snd_soc_find_dai_with_mutex);
 939
 940static int soc_dai_link_sanity_check(struct snd_soc_card *card,
 941				     struct snd_soc_dai_link *link)
 942{
 943	int i;
 944	struct snd_soc_dai_link_component *dlc;
 945
 946	/* Codec check */
 947	for_each_link_codecs(link, i, dlc) {
 948		/*
 949		 * Codec must be specified by 1 of name or OF node,
 950		 * not both or neither.
 951		 */
 952		if (snd_soc_dlc_component_is_invalid(dlc))
 953			goto component_invalid;
 954
 955		if (snd_soc_dlc_component_is_empty(dlc))
 956			goto component_empty;
 957
 958		/* Codec DAI name must be specified */
 959		if (snd_soc_dlc_dai_is_empty(dlc))
 960			goto dai_empty;
 961
 962		/*
 963		 * Defer card registration if codec component is not added to
 964		 * component list.
 965		 */
 966		if (!soc_find_component(dlc))
 967			goto component_not_found;
 968	}
 969
 970	/* Platform check */
 971	for_each_link_platforms(link, i, dlc) {
 972		/*
 973		 * Platform may be specified by either name or OF node, but it
 974		 * can be left unspecified, then no components will be inserted
 975		 * in the rtdcom list
 976		 */
 977		if (snd_soc_dlc_component_is_invalid(dlc))
 978			goto component_invalid;
 979
 980		if (snd_soc_dlc_component_is_empty(dlc))
 981			goto component_empty;
 982
 983		/*
 984		 * Defer card registration if platform component is not added to
 985		 * component list.
 986		 */
 987		if (!soc_find_component(dlc))
 988			goto component_not_found;
 989	}
 990
 991	/* CPU check */
 992	for_each_link_cpus(link, i, dlc) {
 993		/*
 994		 * CPU device may be specified by either name or OF node, but
 995		 * can be left unspecified, and will be matched based on DAI
 996		 * name alone..
 997		 */
 998		if (snd_soc_dlc_component_is_invalid(dlc))
 999			goto component_invalid;
1000
1001
1002		if (snd_soc_dlc_component_is_empty(dlc)) {
1003			/*
1004			 * At least one of CPU DAI name or CPU device name/node must be specified
1005			 */
1006			if (snd_soc_dlc_dai_is_empty(dlc))
1007				goto component_dai_empty;
1008		} else {
1009			/*
1010			 * Defer card registration if Component is not added
1011			 */
1012			if (!soc_find_component(dlc))
1013				goto component_not_found;
1014		}
1015	}
1016
1017	return 0;
1018
1019component_invalid:
1020	dev_err(card->dev, "ASoC: Both Component name/of_node are set for %s\n", link->name);
1021	return -EINVAL;
1022
1023component_empty:
1024	dev_err(card->dev, "ASoC: Neither Component name/of_node are set for %s\n", link->name);
1025	return -EINVAL;
1026
1027component_not_found:
1028	dev_dbg(card->dev, "ASoC: Component %s not found for link %s\n", dlc->name, link->name);
1029	return -EPROBE_DEFER;
1030
1031dai_empty:
1032	dev_err(card->dev, "ASoC: DAI name is not set for %s\n", link->name);
1033	return -EINVAL;
1034
1035component_dai_empty:
1036	dev_err(card->dev, "ASoC: Neither DAI/Component name/of_node are set for %s\n", link->name);
1037	return -EINVAL;
1038}
1039
1040#define MAX_DEFAULT_CH_MAP_SIZE 8
1041static struct snd_soc_dai_link_ch_map default_ch_map_sync[MAX_DEFAULT_CH_MAP_SIZE] = {
1042	{ .cpu = 0, .codec = 0 },
1043	{ .cpu = 1, .codec = 1 },
1044	{ .cpu = 2, .codec = 2 },
1045	{ .cpu = 3, .codec = 3 },
1046	{ .cpu = 4, .codec = 4 },
1047	{ .cpu = 5, .codec = 5 },
1048	{ .cpu = 6, .codec = 6 },
1049	{ .cpu = 7, .codec = 7 },
1050};
1051static struct snd_soc_dai_link_ch_map default_ch_map_1cpu[MAX_DEFAULT_CH_MAP_SIZE] = {
1052	{ .cpu = 0, .codec = 0 },
1053	{ .cpu = 0, .codec = 1 },
1054	{ .cpu = 0, .codec = 2 },
1055	{ .cpu = 0, .codec = 3 },
1056	{ .cpu = 0, .codec = 4 },
1057	{ .cpu = 0, .codec = 5 },
1058	{ .cpu = 0, .codec = 6 },
1059	{ .cpu = 0, .codec = 7 },
1060};
1061static struct snd_soc_dai_link_ch_map default_ch_map_1codec[MAX_DEFAULT_CH_MAP_SIZE] = {
1062	{ .cpu = 0, .codec = 0 },
1063	{ .cpu = 1, .codec = 0 },
1064	{ .cpu = 2, .codec = 0 },
1065	{ .cpu = 3, .codec = 0 },
1066	{ .cpu = 4, .codec = 0 },
1067	{ .cpu = 5, .codec = 0 },
1068	{ .cpu = 6, .codec = 0 },
1069	{ .cpu = 7, .codec = 0 },
1070};
1071static int snd_soc_compensate_channel_connection_map(struct snd_soc_card *card,
1072						     struct snd_soc_dai_link *dai_link)
1073{
1074	struct snd_soc_dai_link_ch_map *ch_maps;
1075	int i;
1076
1077	/*
1078	 * dai_link->ch_maps indicates how CPU/Codec are connected.
1079	 * It will be a map seen from a larger number of DAI.
1080	 * see
1081	 *	soc.h :: [dai_link->ch_maps Image sample]
1082	 */
1083
1084	/* it should have ch_maps if connection was N:M */
1085	if (dai_link->num_cpus > 1 && dai_link->num_codecs > 1 &&
1086	    dai_link->num_cpus != dai_link->num_codecs && !dai_link->ch_maps) {
1087		dev_err(card->dev, "need to have ch_maps when N:M connection (%s)",
1088			dai_link->name);
1089		return -EINVAL;
1090	}
1091
1092	/* do nothing if it has own maps */
1093	if (dai_link->ch_maps)
1094		goto sanity_check;
1095
1096	/* check default map size */
1097	if (dai_link->num_cpus   > MAX_DEFAULT_CH_MAP_SIZE ||
1098	    dai_link->num_codecs > MAX_DEFAULT_CH_MAP_SIZE) {
1099		dev_err(card->dev, "soc-core.c needs update default_connection_maps");
1100		return -EINVAL;
1101	}
1102
1103	/* Compensate missing map for ... */
1104	if (dai_link->num_cpus == dai_link->num_codecs)
1105		dai_link->ch_maps = default_ch_map_sync;	/* for 1:1 or N:N */
1106	else if (dai_link->num_cpus <  dai_link->num_codecs)
1107		dai_link->ch_maps = default_ch_map_1cpu;	/* for 1:N */
1108	else
1109		dai_link->ch_maps = default_ch_map_1codec;	/* for N:1 */
1110
1111sanity_check:
1112	dev_dbg(card->dev, "dai_link %s\n", dai_link->stream_name);
1113	for_each_link_ch_maps(dai_link, i, ch_maps) {
1114		if ((ch_maps->cpu   >= dai_link->num_cpus) ||
1115		    (ch_maps->codec >= dai_link->num_codecs)) {
1116			dev_err(card->dev,
1117				"unexpected dai_link->ch_maps[%d] index (cpu(%d/%d) codec(%d/%d))",
1118				i,
1119				ch_maps->cpu,	dai_link->num_cpus,
1120				ch_maps->codec,	dai_link->num_codecs);
1121			return -EINVAL;
1122		}
1123
1124		dev_dbg(card->dev, "  [%d] cpu%d <-> codec%d\n",
1125			i, ch_maps->cpu, ch_maps->codec);
1126	}
1127
1128	return 0;
1129}
1130
1131/**
1132 * snd_soc_remove_pcm_runtime - Remove a pcm_runtime from card
1133 * @card: The ASoC card to which the pcm_runtime has
1134 * @rtd: The pcm_runtime to remove
1135 *
1136 * This function removes a pcm_runtime from the ASoC card.
1137 */
1138void snd_soc_remove_pcm_runtime(struct snd_soc_card *card,
1139				struct snd_soc_pcm_runtime *rtd)
1140{
1141	lockdep_assert_held(&client_mutex);
1142
1143	/*
1144	 * Notify the machine driver for extra destruction
1145	 */
1146	snd_soc_card_remove_dai_link(card, rtd->dai_link);
1147
1148	soc_free_pcm_runtime(rtd);
1149}
1150EXPORT_SYMBOL_GPL(snd_soc_remove_pcm_runtime);
1151
1152/**
1153 * snd_soc_add_pcm_runtime - Add a pcm_runtime dynamically via dai_link
1154 * @card: The ASoC card to which the pcm_runtime is added
1155 * @dai_link: The DAI link to find pcm_runtime
1156 *
1157 * This function adds a pcm_runtime ASoC card by using dai_link.
1158 *
1159 * Note: Topology can use this API to add pcm_runtime when probing the
1160 * topology component. And machine drivers can still define static
1161 * DAI links in dai_link array.
1162 */
1163static int snd_soc_add_pcm_runtime(struct snd_soc_card *card,
1164				   struct snd_soc_dai_link *dai_link)
1165{
1166	struct snd_soc_pcm_runtime *rtd;
1167	struct snd_soc_dai_link_component *codec, *platform, *cpu;
1168	struct snd_soc_component *component;
1169	int i, ret;
1170
1171	lockdep_assert_held(&client_mutex);
1172
1173	/*
1174	 * Notify the machine driver for extra initialization
1175	 */
1176	ret = snd_soc_card_add_dai_link(card, dai_link);
1177	if (ret < 0)
1178		return ret;
1179
1180	if (dai_link->ignore)
1181		return 0;
1182
1183	dev_dbg(card->dev, "ASoC: binding %s\n", dai_link->name);
1184
1185	ret = soc_dai_link_sanity_check(card, dai_link);
1186	if (ret < 0)
1187		return ret;
 
 
1188
1189	rtd = soc_new_pcm_runtime(card, dai_link);
1190	if (!rtd)
1191		return -ENOMEM;
1192
1193	for_each_link_cpus(dai_link, i, cpu) {
1194		snd_soc_rtd_to_cpu(rtd, i) = snd_soc_find_dai(cpu);
1195		if (!snd_soc_rtd_to_cpu(rtd, i)) {
1196			dev_info(card->dev, "ASoC: CPU DAI %s not registered\n",
1197				 cpu->dai_name);
1198			goto _err_defer;
1199		}
1200		snd_soc_rtd_add_component(rtd, snd_soc_rtd_to_cpu(rtd, i)->component);
1201	}
 
1202
1203	/* Find CODEC from registered CODECs */
 
1204	for_each_link_codecs(dai_link, i, codec) {
1205		snd_soc_rtd_to_codec(rtd, i) = snd_soc_find_dai(codec);
1206		if (!snd_soc_rtd_to_codec(rtd, i)) {
1207			dev_info(card->dev, "ASoC: CODEC DAI %s not registered\n",
1208				 codec->dai_name);
1209			goto _err_defer;
1210		}
1211
1212		snd_soc_rtd_add_component(rtd, snd_soc_rtd_to_codec(rtd, i)->component);
1213	}
1214
 
 
 
1215	/* Find PLATFORM from registered PLATFORMs */
1216	for_each_link_platforms(dai_link, i, platform) {
1217		for_each_component(component) {
1218			if (!snd_soc_is_matching_component(platform, component))
1219				continue;
1220
1221			snd_soc_rtd_add_component(rtd, component);
1222		}
1223	}
1224
 
1225	return 0;
1226
1227_err_defer:
1228	snd_soc_remove_pcm_runtime(card, rtd);
1229	return -EPROBE_DEFER;
1230}
1231
1232int snd_soc_add_pcm_runtimes(struct snd_soc_card *card,
1233			     struct snd_soc_dai_link *dai_link,
1234			     int num_dai_link)
1235{
1236	for (int i = 0; i < num_dai_link; i++) {
1237		int ret;
1238
1239		ret = snd_soc_compensate_channel_connection_map(card, dai_link + i);
1240		if (ret < 0)
1241			return ret;
1242
1243		ret = snd_soc_add_pcm_runtime(card, dai_link + i);
1244		if (ret < 0)
1245			return ret;
1246	}
1247
1248	return 0;
1249}
1250EXPORT_SYMBOL_GPL(snd_soc_add_pcm_runtimes);
1251
1252static void snd_soc_runtime_get_dai_fmt(struct snd_soc_pcm_runtime *rtd)
1253{
1254	struct snd_soc_dai_link *dai_link = rtd->dai_link;
1255	struct snd_soc_dai *dai, *not_used;
1256	u64 pos, possible_fmt;
1257	unsigned int mask = 0, dai_fmt = 0;
1258	int i, j, priority, pri, until;
1259
1260	/*
1261	 * Get selectable format from each DAIs.
1262	 *
1263	 ****************************
1264	 *            NOTE
1265	 * Using .auto_selectable_formats is not mandatory,
1266	 * we can select format manually from Sound Card.
1267	 * When use it, driver should list well tested format only.
1268	 ****************************
1269	 *
1270	 * ex)
1271	 *	auto_selectable_formats (= SND_SOC_POSSIBLE_xxx)
1272	 *		 (A)	 (B)	 (C)
1273	 *	DAI0_: { 0x000F, 0x00F0, 0x0F00 };
1274	 *	DAI1 : { 0xF000, 0x0F00 };
1275	 *		 (X)	 (Y)
1276	 *
1277	 * "until" will be 3 in this case (MAX array size from DAI0 and DAI1)
1278	 * Here is dev_dbg() message and comments
1279	 *
1280	 * priority = 1
1281	 * DAI0: (pri, fmt) = (1, 000000000000000F) // 1st check (A) DAI1 is not selected
1282	 * DAI1: (pri, fmt) = (0, 0000000000000000) //               Necessary Waste
1283	 * DAI0: (pri, fmt) = (1, 000000000000000F) // 2nd check (A)
1284	 * DAI1: (pri, fmt) = (1, 000000000000F000) //           (X)
1285	 * priority = 2
1286	 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 3rd check (A) + (B)
1287	 * DAI1: (pri, fmt) = (1, 000000000000F000) //           (X)
1288	 * DAI0: (pri, fmt) = (2, 00000000000000FF) // 4th check (A) + (B)
1289	 * DAI1: (pri, fmt) = (2, 000000000000FF00) //           (X) + (Y)
1290	 * priority = 3
1291	 * DAI0: (pri, fmt) = (3, 0000000000000FFF) // 5th check (A) + (B) + (C)
1292	 * DAI1: (pri, fmt) = (2, 000000000000FF00) //           (X) + (Y)
1293	 * found auto selected format: 0000000000000F00
1294	 */
1295	until = snd_soc_dai_get_fmt_max_priority(rtd);
1296	for (priority = 1; priority <= until; priority++) {
1297		for_each_rtd_dais(rtd, j, not_used) {
1298
1299			possible_fmt = ULLONG_MAX;
1300			for_each_rtd_dais(rtd, i, dai) {
1301				u64 fmt = 0;
1302
1303				pri = (j >= i) ? priority : priority - 1;
1304				fmt = snd_soc_dai_get_fmt(dai, pri);
1305				possible_fmt &= fmt;
1306			}
1307			if (possible_fmt)
1308				goto found;
1309		}
1310	}
1311	/* Not Found */
1312	return;
1313found:
1314	/*
1315	 * convert POSSIBLE_DAIFMT to DAIFMT
1316	 *
1317	 * Some basic/default settings on each is defined as 0.
1318	 * see
1319	 *	SND_SOC_DAIFMT_NB_NF
1320	 *	SND_SOC_DAIFMT_GATED
1321	 *
1322	 * SND_SOC_DAIFMT_xxx_MASK can't notice it if Sound Card specify
1323	 * these value, and will be overwrite to auto selected value.
1324	 *
1325	 * To avoid such issue, loop from 63 to 0 here.
1326	 * Small number of SND_SOC_POSSIBLE_xxx will be Hi priority.
1327	 * Basic/Default settings of each part and above are defined
1328	 * as Hi priority (= small number) of SND_SOC_POSSIBLE_xxx.
1329	 */
1330	for (i = 63; i >= 0; i--) {
1331		pos = 1ULL << i;
1332		switch (possible_fmt & pos) {
1333		/*
1334		 * for format
1335		 */
1336		case SND_SOC_POSSIBLE_DAIFMT_I2S:
1337		case SND_SOC_POSSIBLE_DAIFMT_RIGHT_J:
1338		case SND_SOC_POSSIBLE_DAIFMT_LEFT_J:
1339		case SND_SOC_POSSIBLE_DAIFMT_DSP_A:
1340		case SND_SOC_POSSIBLE_DAIFMT_DSP_B:
1341		case SND_SOC_POSSIBLE_DAIFMT_AC97:
1342		case SND_SOC_POSSIBLE_DAIFMT_PDM:
1343			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_FORMAT_MASK) | i;
1344			break;
1345		/*
1346		 * for clock
1347		 */
1348		case SND_SOC_POSSIBLE_DAIFMT_CONT:
1349			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_CONT;
1350			break;
1351		case SND_SOC_POSSIBLE_DAIFMT_GATED:
1352			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_MASK) | SND_SOC_DAIFMT_GATED;
1353			break;
1354		/*
1355		 * for clock invert
1356		 */
1357		case SND_SOC_POSSIBLE_DAIFMT_NB_NF:
1358			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_NF;
1359			break;
1360		case SND_SOC_POSSIBLE_DAIFMT_NB_IF:
1361			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_NB_IF;
1362			break;
1363		case SND_SOC_POSSIBLE_DAIFMT_IB_NF:
1364			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_NF;
1365			break;
1366		case SND_SOC_POSSIBLE_DAIFMT_IB_IF:
1367			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_INV_MASK) | SND_SOC_DAIFMT_IB_IF;
1368			break;
1369		/*
1370		 * for clock provider / consumer
1371		 */
1372		case SND_SOC_POSSIBLE_DAIFMT_CBP_CFP:
1373			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFP;
1374			break;
1375		case SND_SOC_POSSIBLE_DAIFMT_CBC_CFP:
1376			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFP;
1377			break;
1378		case SND_SOC_POSSIBLE_DAIFMT_CBP_CFC:
1379			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBP_CFC;
1380			break;
1381		case SND_SOC_POSSIBLE_DAIFMT_CBC_CFC:
1382			dai_fmt = (dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) | SND_SOC_DAIFMT_CBC_CFC;
1383			break;
1384		}
1385	}
1386
1387	/*
1388	 * Some driver might have very complex limitation.
1389	 * In such case, user want to auto-select non-limitation part,
1390	 * and want to manually specify complex part.
1391	 *
1392	 * Or for example, if both CPU and Codec can be clock provider,
1393	 * but because of its quality, user want to specify it manually.
1394	 *
1395	 * Use manually specified settings if sound card did.
1396	 */
1397	if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_FORMAT_MASK))
1398		mask |= SND_SOC_DAIFMT_FORMAT_MASK;
1399	if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_MASK))
1400		mask |= SND_SOC_DAIFMT_CLOCK_MASK;
1401	if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_INV_MASK))
1402		mask |= SND_SOC_DAIFMT_INV_MASK;
1403	if (!(dai_link->dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK))
1404		mask |= SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
1405
1406	dai_link->dai_fmt |= (dai_fmt & mask);
1407}
1408
1409/**
1410 * snd_soc_runtime_set_dai_fmt() - Change DAI link format for a ASoC runtime
1411 * @rtd: The runtime for which the DAI link format should be changed
1412 * @dai_fmt: The new DAI link format
1413 *
1414 * This function updates the DAI link format for all DAIs connected to the DAI
1415 * link for the specified runtime.
1416 *
1417 * Note: For setups with a static format set the dai_fmt field in the
1418 * corresponding snd_dai_link struct instead of using this function.
1419 *
1420 * Returns 0 on success, otherwise a negative error code.
1421 */
1422int snd_soc_runtime_set_dai_fmt(struct snd_soc_pcm_runtime *rtd,
1423				unsigned int dai_fmt)
1424{
1425	struct snd_soc_dai *cpu_dai;
1426	struct snd_soc_dai *codec_dai;
1427	unsigned int i;
1428	int ret;
1429
1430	if (!dai_fmt)
1431		return 0;
1432
1433	for_each_rtd_codec_dais(rtd, i, codec_dai) {
1434		ret = snd_soc_dai_set_fmt(codec_dai, dai_fmt);
1435		if (ret != 0 && ret != -ENOTSUPP)
1436			return ret;
1437	}
1438
1439	/* Flip the polarity for the "CPU" end of link */
1440	dai_fmt = snd_soc_daifmt_clock_provider_flipped(dai_fmt);
1441
1442	for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1443		ret = snd_soc_dai_set_fmt(cpu_dai, dai_fmt);
1444		if (ret != 0 && ret != -ENOTSUPP)
1445			return ret;
1446	}
1447
1448	return 0;
1449}
1450EXPORT_SYMBOL_GPL(snd_soc_runtime_set_dai_fmt);
1451
1452static int soc_init_pcm_runtime(struct snd_soc_card *card,
1453				struct snd_soc_pcm_runtime *rtd)
1454{
1455	struct snd_soc_dai_link *dai_link = rtd->dai_link;
1456	struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, 0);
1457	struct snd_soc_component *component;
1458	int ret, num, i;
1459
1460	/* do machine specific initialization */
1461	ret = snd_soc_link_init(rtd);
1462	if (ret < 0)
1463		return ret;
1464
1465	snd_soc_runtime_get_dai_fmt(rtd);
1466	ret = snd_soc_runtime_set_dai_fmt(rtd, dai_link->dai_fmt);
1467	if (ret)
1468		goto err;
1469
1470	/* add DPCM sysfs entries */
1471	soc_dpcm_debugfs_add(rtd);
1472
1473	num = rtd->num;
1474
1475	/*
1476	 * most drivers will register their PCMs using DAI link ordering but
1477	 * topology based drivers can use the DAI link id field to set PCM
1478	 * device number and then use rtd + a base offset of the BEs.
1479	 */
1480	for_each_rtd_components(rtd, i, component) {
1481		if (!component->driver->use_dai_pcm_id)
1482			continue;
1483
1484		if (rtd->dai_link->no_pcm)
1485			num += component->driver->be_pcm_base;
1486		else
1487			num = rtd->dai_link->id;
1488	}
1489
1490	/* create compress_device if possible */
1491	ret = snd_soc_dai_compress_new(cpu_dai, rtd, num);
1492	if (ret != -ENOTSUPP)
1493		goto err;
1494
1495	/* create the pcm */
1496	ret = soc_new_pcm(rtd, num);
1497	if (ret < 0) {
1498		dev_err(card->dev, "ASoC: can't create pcm %s :%d\n",
1499			dai_link->stream_name, ret);
1500		goto err;
1501	}
1502
1503	ret = snd_soc_pcm_dai_new(rtd);
1504	if (ret < 0)
1505		goto err;
1506
1507	rtd->initialized = true;
1508
1509	return 0;
1510err:
1511	snd_soc_link_exit(rtd);
1512	return ret;
1513}
1514
1515static void soc_set_name_prefix(struct snd_soc_card *card,
1516				struct snd_soc_component *component)
1517{
1518	struct device_node *of_node = soc_component_to_node(component);
1519	const char *str;
1520	int ret, i;
1521
1522	for (i = 0; i < card->num_configs; i++) {
1523		struct snd_soc_codec_conf *map = &card->codec_conf[i];
 
1524
1525		if (snd_soc_is_matching_component(&map->dlc, component) &&
1526		    map->name_prefix) {
1527			component->name_prefix = map->name_prefix;
1528			return;
1529		}
 
1530	}
1531
1532	/*
1533	 * If there is no configuration table or no match in the table,
1534	 * check if a prefix is provided in the node
1535	 */
1536	ret = of_property_read_string(of_node, "sound-name-prefix", &str);
1537	if (ret < 0)
1538		return;
1539
1540	component->name_prefix = str;
1541}
1542
1543static void soc_remove_component(struct snd_soc_component *component,
1544				 int probed)
1545{
1546
1547	if (!component->card)
1548		return;
1549
1550	if (probed)
1551		snd_soc_component_remove(component);
1552
1553	list_del_init(&component->card_list);
1554	snd_soc_dapm_free(snd_soc_component_get_dapm(component));
1555	soc_cleanup_component_debugfs(component);
1556	component->card = NULL;
1557	snd_soc_component_module_put_when_remove(component);
1558}
1559
 
 
 
 
 
 
 
 
 
 
1560static int soc_probe_component(struct snd_soc_card *card,
1561			       struct snd_soc_component *component)
1562{
1563	struct snd_soc_dapm_context *dapm =
1564		snd_soc_component_get_dapm(component);
1565	struct snd_soc_dai *dai;
1566	int probed = 0;
1567	int ret;
1568
1569	if (snd_soc_component_is_dummy(component))
1570		return 0;
1571
1572	if (component->card) {
1573		if (component->card != card) {
1574			dev_err(component->dev,
1575				"Trying to bind component \"%s\" to card \"%s\" but is already bound to card \"%s\"\n",
1576				component->name, card->name, component->card->name);
1577			return -ENODEV;
1578		}
1579		return 0;
1580	}
1581
1582	ret = snd_soc_component_module_get_when_probe(component);
1583	if (ret < 0)
1584		return ret;
1585
1586	component->card = card;
1587	soc_set_name_prefix(card, component);
1588
1589	soc_init_component_debugfs(component);
1590
1591	snd_soc_dapm_init(dapm, card, component);
1592
1593	ret = snd_soc_dapm_new_controls(dapm,
1594					component->driver->dapm_widgets,
1595					component->driver->num_dapm_widgets);
1596
1597	if (ret != 0) {
1598		dev_err(component->dev,
1599			"Failed to create new controls %d\n", ret);
1600		goto err_probe;
1601	}
1602
1603	for_each_component_dais(component, dai) {
1604		ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1605		if (ret != 0) {
1606			dev_err(component->dev,
1607				"Failed to create DAI widgets %d\n", ret);
1608			goto err_probe;
1609		}
1610	}
1611
1612	ret = snd_soc_component_probe(component);
1613	if (ret < 0)
 
 
1614		goto err_probe;
1615
1616	WARN(dapm->idle_bias_off &&
1617	     dapm->bias_level != SND_SOC_BIAS_OFF,
1618	     "codec %s can not start from non-off bias with idle_bias_off==1\n",
1619	     component->name);
1620	probed = 1;
1621
1622	/*
1623	 * machine specific init
1624	 * see
1625	 *	snd_soc_component_set_aux()
1626	 */
1627	ret = snd_soc_component_init(component);
1628	if (ret < 0)
1629		goto err_probe;
 
1630
1631	ret = snd_soc_add_component_controls(component,
1632					     component->driver->controls,
1633					     component->driver->num_controls);
1634	if (ret < 0)
1635		goto err_probe;
1636
1637	ret = snd_soc_dapm_add_routes(dapm,
1638				      component->driver->dapm_routes,
1639				      component->driver->num_dapm_routes);
1640	if (ret < 0) {
1641		if (card->disable_route_checks) {
1642			dev_info(card->dev,
1643				 "%s: disable_route_checks set, ignoring errors on add_routes\n",
1644				 __func__);
1645		} else {
1646			dev_err(card->dev,
1647				"%s: snd_soc_dapm_add_routes failed: %d\n",
1648				__func__, ret);
1649			goto err_probe;
1650		}
1651	}
1652
1653	/* see for_each_card_components */
1654	list_add(&component->card_list, &card->component_dev_list);
1655
1656err_probe:
1657	if (ret < 0)
1658		soc_remove_component(component, probed);
1659
1660	return ret;
1661}
1662
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1663static void soc_remove_link_dais(struct snd_soc_card *card)
1664{
 
 
1665	struct snd_soc_pcm_runtime *rtd;
1666	int order;
1667
1668	for_each_comp_order(order) {
1669		for_each_card_rtds(card, rtd) {
1670			/* remove all rtd connected DAIs in good order */
1671			snd_soc_pcm_dai_remove(rtd, order);
 
 
 
 
 
 
 
1672		}
1673	}
1674}
1675
1676static int soc_probe_link_dais(struct snd_soc_card *card)
1677{
 
1678	struct snd_soc_pcm_runtime *rtd;
1679	int order, ret;
1680
1681	for_each_comp_order(order) {
1682		for_each_card_rtds(card, rtd) {
1683			/* probe all rtd connected DAIs in good order */
1684			ret = snd_soc_pcm_dai_probe(rtd, order);
 
 
 
 
1685			if (ret)
1686				return ret;
 
 
 
 
 
 
 
1687		}
1688	}
1689
1690	return 0;
1691}
1692
1693static void soc_remove_link_components(struct snd_soc_card *card)
1694{
1695	struct snd_soc_component *component;
1696	struct snd_soc_pcm_runtime *rtd;
1697	int i, order;
 
1698
1699	for_each_comp_order(order) {
1700		for_each_card_rtds(card, rtd) {
1701			for_each_rtd_components(rtd, i, component) {
 
 
1702				if (component->driver->remove_order != order)
1703					continue;
1704
1705				soc_remove_component(component, 1);
1706			}
1707		}
1708	}
1709}
1710
1711static int soc_probe_link_components(struct snd_soc_card *card)
1712{
1713	struct snd_soc_component *component;
1714	struct snd_soc_pcm_runtime *rtd;
1715	int i, ret, order;
 
1716
1717	for_each_comp_order(order) {
1718		for_each_card_rtds(card, rtd) {
1719			for_each_rtd_components(rtd, i, component) {
 
 
1720				if (component->driver->probe_order != order)
1721					continue;
1722
1723				ret = soc_probe_component(card, component);
1724				if (ret < 0)
1725					return ret;
1726			}
1727		}
1728	}
1729
1730	return 0;
1731}
1732
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1733static void soc_unbind_aux_dev(struct snd_soc_card *card)
1734{
1735	struct snd_soc_component *component, *_component;
1736
1737	for_each_card_auxs_safe(card, component, _component) {
1738		/* for snd_soc_component_init() */
1739		snd_soc_component_set_aux(component, NULL);
1740		list_del(&component->card_aux_list);
1741	}
1742}
1743
1744static int soc_bind_aux_dev(struct snd_soc_card *card)
1745{
1746	struct snd_soc_component *component;
1747	struct snd_soc_aux_dev *aux;
1748	int i;
1749
1750	for_each_card_pre_auxs(card, i, aux) {
1751		/* codecs, usually analog devices */
1752		component = soc_find_component(&aux->dlc);
1753		if (!component)
1754			return -EPROBE_DEFER;
1755
1756		/* for snd_soc_component_init() */
1757		snd_soc_component_set_aux(component, aux);
1758		/* see for_each_card_auxs */
1759		list_add(&component->card_aux_list, &card->aux_comp_list);
1760	}
1761	return 0;
1762}
1763
1764static int soc_probe_aux_devices(struct snd_soc_card *card)
1765{
1766	struct snd_soc_component *component;
1767	int order;
1768	int ret;
1769
1770	for_each_comp_order(order) {
1771		for_each_card_auxs(card, component) {
1772			if (component->driver->probe_order != order)
1773				continue;
1774
1775			ret = soc_probe_component(card,	component);
1776			if (ret < 0)
1777				return ret;
 
 
 
1778		}
1779	}
1780
1781	return 0;
1782}
1783
1784static void soc_remove_aux_devices(struct snd_soc_card *card)
1785{
1786	struct snd_soc_component *comp, *_comp;
1787	int order;
1788
1789	for_each_comp_order(order) {
1790		for_each_card_auxs_safe(card, comp, _comp) {
1791			if (comp->driver->remove_order == order)
1792				soc_remove_component(comp, 1);
1793		}
1794	}
1795}
1796
1797#ifdef CONFIG_DMI
1798/*
1799 * If a DMI filed contain strings in this blacklist (e.g.
1800 * "Type2 - Board Manufacturer" or "Type1 - TBD by OEM"), it will be taken
1801 * as invalid and dropped when setting the card long name from DMI info.
 
 
 
 
 
 
 
1802 */
1803static const char * const dmi_blacklist[] = {
1804	"To be filled by OEM",
1805	"TBD by OEM",
1806	"Default String",
1807	"Board Manufacturer",
1808	"Board Vendor Name",
1809	"Board Product Name",
1810	NULL,	/* terminator */
1811};
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
1812
 
1813/*
1814 * Trim special characters, and replace '-' with '_' since '-' is used to
1815 * separate different DMI fields in the card long name. Only number and
1816 * alphabet characters and a few separator characters are kept.
1817 */
1818static void cleanup_dmi_name(char *name)
1819{
1820	int i, j = 0;
1821
1822	for (i = 0; name[i]; i++) {
1823		if (isalnum(name[i]) || (name[i] == '.')
1824		    || (name[i] == '_'))
1825			name[j++] = name[i];
1826		else if (name[i] == '-')
1827			name[j++] = '_';
1828	}
1829
1830	name[j] = '\0';
1831}
1832
1833/*
1834 * Check if a DMI field is valid, i.e. not containing any string
1835 * in the black list.
1836 */
1837static int is_dmi_valid(const char *field)
1838{
1839	int i = 0;
1840
1841	while (dmi_blacklist[i]) {
1842		if (strstr(field, dmi_blacklist[i]))
1843			return 0;
1844		i++;
1845	}
1846
1847	return 1;
1848}
1849
1850/*
1851 * Append a string to card->dmi_longname with character cleanups.
1852 */
1853static void append_dmi_string(struct snd_soc_card *card, const char *str)
1854{
1855	char *dst = card->dmi_longname;
1856	size_t dst_len = sizeof(card->dmi_longname);
1857	size_t len;
1858
1859	len = strlen(dst);
1860	snprintf(dst + len, dst_len - len, "-%s", str);
1861
1862	len++;	/* skip the separator "-" */
1863	if (len < dst_len)
1864		cleanup_dmi_name(dst + len);
1865}
1866
1867/**
1868 * snd_soc_set_dmi_name() - Register DMI names to card
1869 * @card: The card to register DMI names
1870 * @flavour: The flavour "differentiator" for the card amongst its peers.
1871 *
1872 * An Intel machine driver may be used by many different devices but are
1873 * difficult for userspace to differentiate, since machine drivers usually
1874 * use their own name as the card short name and leave the card long name
1875 * blank. To differentiate such devices and fix bugs due to lack of
1876 * device-specific configurations, this function allows DMI info to be used
1877 * as the sound card long name, in the format of
1878 * "vendor-product-version-board"
1879 * (Character '-' is used to separate different DMI fields here).
1880 * This will help the user space to load the device-specific Use Case Manager
1881 * (UCM) configurations for the card.
1882 *
1883 * Possible card long names may be:
1884 * DellInc.-XPS139343-01-0310JH
1885 * ASUSTeKCOMPUTERINC.-T100TA-1.0-T100TA
1886 * Circuitco-MinnowboardMaxD0PLATFORM-D0-MinnowBoardMAX
1887 *
1888 * This function also supports flavoring the card longname to provide
1889 * the extra differentiation, like "vendor-product-version-board-flavor".
1890 *
1891 * We only keep number and alphabet characters and a few separator characters
1892 * in the card long name since UCM in the user space uses the card long names
1893 * as card configuration directory names and AudoConf cannot support special
1894 * characters like SPACE.
1895 *
1896 * Returns 0 on success, otherwise a negative error code.
1897 */
1898int snd_soc_set_dmi_name(struct snd_soc_card *card, const char *flavour)
1899{
1900	const char *vendor, *product, *board;
 
 
1901
1902	if (card->long_name)
1903		return 0; /* long name already set by driver or from DMI */
1904
1905	if (!dmi_available)
1906		return 0;
1907
1908	/* make up dmi long name as: vendor-product-version-board */
1909	vendor = dmi_get_system_info(DMI_BOARD_VENDOR);
1910	if (!vendor || !is_dmi_valid(vendor)) {
1911		dev_warn(card->dev, "ASoC: no DMI vendor name!\n");
1912		return 0;
1913	}
1914
1915	snprintf(card->dmi_longname, sizeof(card->dmi_longname), "%s", vendor);
 
1916	cleanup_dmi_name(card->dmi_longname);
1917
1918	product = dmi_get_system_info(DMI_PRODUCT_NAME);
1919	if (product && is_dmi_valid(product)) {
1920		const char *product_version = dmi_get_system_info(DMI_PRODUCT_VERSION);
1921
1922		append_dmi_string(card, product);
 
 
 
 
 
1923
1924		/*
1925		 * some vendors like Lenovo may only put a self-explanatory
1926		 * name in the product version field
1927		 */
1928		if (product_version && is_dmi_valid(product_version))
1929			append_dmi_string(card, product_version);
 
 
 
 
 
 
 
 
 
1930	}
1931
1932	board = dmi_get_system_info(DMI_BOARD_NAME);
1933	if (board && is_dmi_valid(board)) {
1934		if (!product || strcasecmp(board, product))
1935			append_dmi_string(card, board);
 
 
 
 
 
 
1936	} else if (!product) {
1937		/* fall back to using legacy name */
1938		dev_warn(card->dev, "ASoC: no DMI board/product name!\n");
1939		return 0;
1940	}
1941
1942	/* Add flavour to dmi long name */
1943	if (flavour)
1944		append_dmi_string(card, flavour);
 
 
 
 
 
 
 
 
1945
1946	/* set the card long name */
1947	card->long_name = card->dmi_longname;
1948
1949	return 0;
1950}
1951EXPORT_SYMBOL_GPL(snd_soc_set_dmi_name);
1952#endif /* CONFIG_DMI */
1953
1954static void soc_check_tplg_fes(struct snd_soc_card *card)
1955{
1956	struct snd_soc_component *component;
1957	const struct snd_soc_component_driver *comp_drv;
1958	struct snd_soc_dai_link *dai_link;
1959	int i;
1960
1961	for_each_component(component) {
1962
1963		/* does this component override BEs ? */
1964		if (!component->driver->ignore_machine)
1965			continue;
1966
1967		/* for this machine ? */
1968		if (!strcmp(component->driver->ignore_machine,
1969			    card->dev->driver->name))
1970			goto match;
1971		if (strcmp(component->driver->ignore_machine,
1972			   dev_name(card->dev)))
1973			continue;
1974match:
1975		/* machine matches, so override the rtd data */
1976		for_each_card_prelinks(card, i, dai_link) {
1977
1978			/* ignore this FE */
1979			if (dai_link->dynamic) {
1980				dai_link->ignore = true;
1981				continue;
1982			}
1983
1984			dev_dbg(card->dev, "info: override BE DAI link %s\n",
1985				card->dai_link[i].name);
1986
1987			/* override platform component */
1988			if (!dai_link->platforms) {
1989				dev_err(card->dev, "init platform error");
1990				continue;
1991			}
1992
1993			if (component->dev->of_node)
1994				dai_link->platforms->of_node = component->dev->of_node;
1995			else
1996				dai_link->platforms->name = component->name;
1997
1998			/* convert non BE into BE */
1999			if (!dai_link->no_pcm) {
2000				dai_link->no_pcm = 1;
2001
2002				if (dai_link->dpcm_playback)
2003					dev_warn(card->dev,
2004						 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_playback=1\n",
2005						 dai_link->name);
2006				if (dai_link->dpcm_capture)
2007					dev_warn(card->dev,
2008						 "invalid configuration, dailink %s has flags no_pcm=0 and dpcm_capture=1\n",
2009						 dai_link->name);
2010
2011				/* convert normal link into DPCM one */
2012				if (!(dai_link->dpcm_playback ||
2013				      dai_link->dpcm_capture)) {
2014					dai_link->dpcm_playback = !dai_link->capture_only;
2015					dai_link->dpcm_capture = !dai_link->playback_only;
2016				}
2017			}
2018
2019			/*
2020			 * override any BE fixups
2021			 * see
2022			 *	snd_soc_link_be_hw_params_fixup()
2023			 */
2024			dai_link->be_hw_params_fixup =
2025				component->driver->be_hw_params_fixup;
2026
2027			/*
2028			 * most BE links don't set stream name, so set it to
2029			 * dai link name if it's NULL to help bind widgets.
2030			 */
2031			if (!dai_link->stream_name)
2032				dai_link->stream_name = dai_link->name;
2033		}
2034
2035		/* Inform userspace we are using alternate topology */
2036		if (component->driver->topology_name_prefix) {
2037
2038			/* topology shortname created? */
2039			if (!card->topology_shortname_created) {
2040				comp_drv = component->driver;
2041
2042				snprintf(card->topology_shortname, 32, "%s-%s",
2043					 comp_drv->topology_name_prefix,
2044					 card->name);
2045				card->topology_shortname_created = true;
2046			}
2047
2048			/* use topology shortname */
2049			card->name = card->topology_shortname;
2050		}
2051	}
2052}
2053
2054#define soc_setup_card_name(card, name, name1, name2) \
2055	__soc_setup_card_name(card, name, sizeof(name), name1, name2)
2056static void __soc_setup_card_name(struct snd_soc_card *card,
2057				  char *name, int len,
2058				  const char *name1, const char *name2)
2059{
2060	const char *src = name1 ? name1 : name2;
2061	int i;
2062
2063	snprintf(name, len, "%s", src);
2064
2065	if (name != card->snd_card->driver)
2066		return;
2067
2068	/*
2069	 * Name normalization (driver field)
2070	 *
2071	 * The driver name is somewhat special, as it's used as a key for
2072	 * searches in the user-space.
2073	 *
2074	 * ex)
2075	 *	"abcd??efg" -> "abcd__efg"
2076	 */
2077	for (i = 0; i < len; i++) {
2078		switch (name[i]) {
2079		case '_':
2080		case '-':
2081		case '\0':
2082			break;
2083		default:
2084			if (!isalnum(name[i]))
2085				name[i] = '_';
2086			break;
2087		}
2088	}
2089
2090	/*
2091	 * The driver field should contain a valid string from the user view.
2092	 * The wrapping usually does not work so well here. Set a smaller string
2093	 * in the specific ASoC driver.
2094	 */
2095	if (strlen(src) > len - 1)
2096		dev_err(card->dev, "ASoC: driver name too long '%s' -> '%s'\n", src, name);
2097}
2098
2099static void soc_cleanup_card_resources(struct snd_soc_card *card)
2100{
2101	struct snd_soc_pcm_runtime *rtd, *n;
2102
2103	if (card->snd_card)
2104		snd_card_disconnect_sync(card->snd_card);
2105
2106	snd_soc_dapm_shutdown(card);
2107
2108	/* release machine specific resources */
2109	for_each_card_rtds(card, rtd)
2110		if (rtd->initialized)
2111			snd_soc_link_exit(rtd);
2112	/* remove and free each DAI */
2113	soc_remove_link_dais(card);
2114	soc_remove_link_components(card);
2115
2116	for_each_card_rtds_safe(card, rtd, n)
2117		snd_soc_remove_pcm_runtime(card, rtd);
2118
2119	/* remove auxiliary devices */
2120	soc_remove_aux_devices(card);
2121	soc_unbind_aux_dev(card);
2122
2123	snd_soc_dapm_free(&card->dapm);
2124	soc_cleanup_card_debugfs(card);
2125
2126	/* remove the card */
2127	snd_soc_card_remove(card);
2128
2129	if (card->snd_card) {
2130		snd_card_free(card->snd_card);
2131		card->snd_card = NULL;
2132	}
2133}
2134
2135static void snd_soc_unbind_card(struct snd_soc_card *card, bool unregister)
2136{
2137	if (snd_soc_card_is_instantiated(card)) {
2138		card->instantiated = false;
2139		snd_soc_flush_all_delayed_work(card);
2140
2141		soc_cleanup_card_resources(card);
2142		if (!unregister)
2143			list_add(&card->list, &unbind_card_list);
2144	} else {
2145		if (unregister)
2146			list_del(&card->list);
2147	}
2148}
2149
2150static int snd_soc_bind_card(struct snd_soc_card *card)
2151{
2152	struct snd_soc_pcm_runtime *rtd;
2153	struct snd_soc_component *component;
2154	int ret;
2155
2156	mutex_lock(&client_mutex);
2157	snd_soc_card_mutex_lock_root(card);
2158
2159	snd_soc_fill_dummy_dai(card);
 
 
 
 
 
 
 
2160
2161	snd_soc_dapm_init(&card->dapm, card, NULL);
2162
2163	/* check whether any platform is ignore machine FE and using topology */
2164	soc_check_tplg_fes(card);
2165
 
 
 
 
 
 
 
2166	/* bind aux_devs too */
2167	ret = soc_bind_aux_dev(card);
2168	if (ret < 0)
2169		goto probe_end;
2170
2171	/* add predefined DAI links to the list */
2172	card->num_rtd = 0;
2173	ret = snd_soc_add_pcm_runtimes(card, card->dai_link, card->num_links);
2174	if (ret < 0)
2175		goto probe_end;
 
2176
2177	/* card bind complete so register a sound card */
2178	ret = snd_card_new(card->dev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
2179			card->owner, 0, &card->snd_card);
2180	if (ret < 0) {
2181		dev_err(card->dev,
2182			"ASoC: can't create sound card for card %s: %d\n",
2183			card->name, ret);
2184		goto probe_end;
2185	}
2186
2187	soc_init_card_debugfs(card);
2188
2189	soc_resume_init(card);
2190
2191	ret = snd_soc_dapm_new_controls(&card->dapm, card->dapm_widgets,
2192					card->num_dapm_widgets);
2193	if (ret < 0)
2194		goto probe_end;
2195
2196	ret = snd_soc_dapm_new_controls(&card->dapm, card->of_dapm_widgets,
2197					card->num_of_dapm_widgets);
2198	if (ret < 0)
2199		goto probe_end;
2200
2201	/* initialise the sound card only once */
2202	ret = snd_soc_card_probe(card);
2203	if (ret < 0)
2204		goto probe_end;
 
 
2205
2206	/* probe all components used by DAI links on this card */
2207	ret = soc_probe_link_components(card);
2208	if (ret < 0) {
2209		if (ret != -EPROBE_DEFER) {
2210			dev_err(card->dev,
2211				"ASoC: failed to instantiate card %d\n", ret);
2212		}
2213		goto probe_end;
2214	}
2215
2216	/* probe auxiliary components */
2217	ret = soc_probe_aux_devices(card);
2218	if (ret < 0) {
2219		dev_err(card->dev,
2220			"ASoC: failed to probe aux component %d\n", ret);
2221		goto probe_end;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2222	}
2223
2224	/* probe all DAI links on this card */
2225	ret = soc_probe_link_dais(card);
2226	if (ret < 0) {
2227		dev_err(card->dev,
2228			"ASoC: failed to instantiate card %d\n", ret);
2229		goto probe_end;
2230	}
2231
2232	for_each_card_rtds(card, rtd) {
2233		ret = soc_init_pcm_runtime(card, rtd);
2234		if (ret < 0)
2235			goto probe_end;
2236	}
2237
2238	snd_soc_dapm_link_dai_widgets(card);
2239	snd_soc_dapm_connect_dai_link_widgets(card);
2240
2241	ret = snd_soc_add_card_controls(card, card->controls,
2242					card->num_controls);
2243	if (ret < 0)
2244		goto probe_end;
2245
2246	ret = snd_soc_dapm_add_routes(&card->dapm, card->dapm_routes,
2247				      card->num_dapm_routes);
2248	if (ret < 0) {
2249		if (card->disable_route_checks) {
2250			dev_info(card->dev,
2251				 "%s: disable_route_checks set, ignoring errors on add_routes\n",
2252				 __func__);
2253		} else {
2254			dev_err(card->dev,
2255				 "%s: snd_soc_dapm_add_routes failed: %d\n",
2256				 __func__, ret);
2257			goto probe_end;
2258		}
2259	}
2260
2261	ret = snd_soc_dapm_add_routes(&card->dapm, card->of_dapm_routes,
2262				      card->num_of_dapm_routes);
2263	if (ret < 0)
2264		goto probe_end;
2265
2266	/* try to set some sane longname if DMI is available */
2267	snd_soc_set_dmi_name(card, NULL);
2268
2269	soc_setup_card_name(card, card->snd_card->shortname,
2270			    card->name, NULL);
2271	soc_setup_card_name(card, card->snd_card->longname,
2272			    card->long_name, card->name);
2273	soc_setup_card_name(card, card->snd_card->driver,
2274			    card->driver_name, card->name);
2275
2276	if (card->components) {
2277		/* the current implementation of snd_component_add() accepts */
2278		/* multiple components in the string separated by space, */
2279		/* but the string collision (identical string) check might */
2280		/* not work correctly */
2281		ret = snd_component_add(card->snd_card, card->components);
 
 
 
 
 
 
 
 
2282		if (ret < 0) {
2283			dev_err(card->dev, "ASoC: %s snd_component_add() failed: %d\n",
2284				card->name, ret);
2285			goto probe_end;
2286		}
2287	}
2288
2289	ret = snd_soc_card_late_probe(card);
2290	if (ret < 0)
2291		goto probe_end;
2292
2293	snd_soc_dapm_new_widgets(card);
2294	snd_soc_card_fixup_controls(card);
2295
2296	ret = snd_card_register(card->snd_card);
2297	if (ret < 0) {
2298		dev_err(card->dev, "ASoC: failed to register soundcard %d\n",
2299				ret);
2300		goto probe_end;
2301	}
2302
2303	card->instantiated = 1;
2304	dapm_mark_endpoints_dirty(card);
2305	snd_soc_dapm_sync(&card->dapm);
2306
2307	/* deactivate pins to sleep state */
2308	for_each_card_components(card, component)
2309		if (!snd_soc_component_active(component))
2310			pinctrl_pm_select_sleep_state(component->dev);
2311
2312probe_end:
2313	if (ret < 0)
2314		soc_cleanup_card_resources(card);
2315
2316	snd_soc_card_mutex_unlock(card);
2317	mutex_unlock(&client_mutex);
2318
2319	return ret;
2320}
2321
2322/* probes a new socdev */
2323static int soc_probe(struct platform_device *pdev)
2324{
2325	struct snd_soc_card *card = platform_get_drvdata(pdev);
2326
2327	/*
2328	 * no card, so machine driver should be registering card
2329	 * we should not be here in that case so ret error
2330	 */
2331	if (!card)
2332		return -EINVAL;
2333
2334	dev_warn(&pdev->dev,
2335		 "ASoC: machine %s should use snd_soc_register_card()\n",
2336		 card->name);
2337
2338	/* Bodge while we unpick instantiation */
2339	card->dev = &pdev->dev;
2340
2341	return devm_snd_soc_register_card(&pdev->dev, card);
 
 
 
 
 
 
 
 
 
2342}
2343
2344int snd_soc_poweroff(struct device *dev)
2345{
2346	struct snd_soc_card *card = dev_get_drvdata(dev);
2347	struct snd_soc_component *component;
2348
2349	if (!snd_soc_card_is_instantiated(card))
2350		return 0;
2351
2352	/*
2353	 * Flush out pmdown_time work - we actually do want to run it
2354	 * now, we're shutting down so no imminent restart.
2355	 */
2356	snd_soc_flush_all_delayed_work(card);
2357
2358	snd_soc_dapm_shutdown(card);
2359
2360	/* deactivate pins to sleep state */
2361	for_each_card_components(card, component)
2362		pinctrl_pm_select_sleep_state(component->dev);
 
 
 
 
 
 
 
 
2363
2364	return 0;
2365}
2366EXPORT_SYMBOL_GPL(snd_soc_poweroff);
2367
2368const struct dev_pm_ops snd_soc_pm_ops = {
2369	.suspend = snd_soc_suspend,
2370	.resume = snd_soc_resume,
2371	.freeze = snd_soc_suspend,
2372	.thaw = snd_soc_resume,
2373	.poweroff = snd_soc_poweroff,
2374	.restore = snd_soc_resume,
2375};
2376EXPORT_SYMBOL_GPL(snd_soc_pm_ops);
2377
2378/* ASoC platform driver */
2379static struct platform_driver soc_driver = {
2380	.driver		= {
2381		.name		= "soc-audio",
2382		.pm		= &snd_soc_pm_ops,
2383	},
2384	.probe		= soc_probe,
 
2385};
2386
2387/**
2388 * snd_soc_cnew - create new control
2389 * @_template: control template
2390 * @data: control private data
2391 * @long_name: control long name
2392 * @prefix: control name prefix
2393 *
2394 * Create a new mixer control from a template control.
2395 *
2396 * Returns 0 for success, else error.
2397 */
2398struct snd_kcontrol *snd_soc_cnew(const struct snd_kcontrol_new *_template,
2399				  void *data, const char *long_name,
2400				  const char *prefix)
2401{
2402	struct snd_kcontrol_new template;
2403	struct snd_kcontrol *kcontrol;
2404	char *name = NULL;
2405
2406	memcpy(&template, _template, sizeof(template));
2407	template.index = 0;
2408
2409	if (!long_name)
2410		long_name = template.name;
2411
2412	if (prefix) {
2413		name = kasprintf(GFP_KERNEL, "%s %s", prefix, long_name);
2414		if (!name)
2415			return NULL;
2416
2417		template.name = name;
2418	} else {
2419		template.name = long_name;
2420	}
2421
2422	kcontrol = snd_ctl_new1(&template, data);
2423
2424	kfree(name);
2425
2426	return kcontrol;
2427}
2428EXPORT_SYMBOL_GPL(snd_soc_cnew);
2429
2430static int snd_soc_add_controls(struct snd_card *card, struct device *dev,
2431	const struct snd_kcontrol_new *controls, int num_controls,
2432	const char *prefix, void *data)
2433{
2434	int i;
2435
2436	for (i = 0; i < num_controls; i++) {
2437		const struct snd_kcontrol_new *control = &controls[i];
2438		int err = snd_ctl_add(card, snd_soc_cnew(control, data,
2439							 control->name, prefix));
 
2440		if (err < 0) {
2441			dev_err(dev, "ASoC: Failed to add %s: %d\n",
2442				control->name, err);
2443			return err;
2444		}
2445	}
2446
2447	return 0;
2448}
2449
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2450/**
2451 * snd_soc_add_component_controls - Add an array of controls to a component.
2452 *
2453 * @component: Component to add controls to
2454 * @controls: Array of controls to add
2455 * @num_controls: Number of elements in the array
2456 *
2457 * Return: 0 for success, else error.
2458 */
2459int snd_soc_add_component_controls(struct snd_soc_component *component,
2460	const struct snd_kcontrol_new *controls, unsigned int num_controls)
2461{
2462	struct snd_card *card = component->card->snd_card;
2463
2464	return snd_soc_add_controls(card, component->dev, controls,
2465			num_controls, component->name_prefix, component);
2466}
2467EXPORT_SYMBOL_GPL(snd_soc_add_component_controls);
2468
2469/**
2470 * snd_soc_add_card_controls - add an array of controls to a SoC card.
2471 * Convenience function to add a list of controls.
2472 *
2473 * @soc_card: SoC card to add controls to
2474 * @controls: array of controls to add
2475 * @num_controls: number of elements in the array
2476 *
2477 * Return 0 for success, else error.
2478 */
2479int snd_soc_add_card_controls(struct snd_soc_card *soc_card,
2480	const struct snd_kcontrol_new *controls, int num_controls)
2481{
2482	struct snd_card *card = soc_card->snd_card;
2483
2484	return snd_soc_add_controls(card, soc_card->dev, controls, num_controls,
2485			NULL, soc_card);
2486}
2487EXPORT_SYMBOL_GPL(snd_soc_add_card_controls);
2488
2489/**
2490 * snd_soc_add_dai_controls - add an array of controls to a DAI.
2491 * Convenience function to add a list of controls.
2492 *
2493 * @dai: DAI to add controls to
2494 * @controls: array of controls to add
2495 * @num_controls: number of elements in the array
2496 *
2497 * Return 0 for success, else error.
2498 */
2499int snd_soc_add_dai_controls(struct snd_soc_dai *dai,
2500	const struct snd_kcontrol_new *controls, int num_controls)
2501{
2502	struct snd_card *card = dai->component->card->snd_card;
2503
2504	return snd_soc_add_controls(card, dai->dev, controls, num_controls,
2505			NULL, dai);
2506}
2507EXPORT_SYMBOL_GPL(snd_soc_add_dai_controls);
2508
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2509/**
2510 * snd_soc_register_card - Register a card with the ASoC core
2511 *
2512 * @card: Card to register
2513 *
2514 */
2515int snd_soc_register_card(struct snd_soc_card *card)
2516{
2517	if (!card->name || !card->dev)
2518		return -EINVAL;
2519
2520	dev_set_drvdata(card->dev, card);
2521
2522	INIT_LIST_HEAD(&card->widgets);
2523	INIT_LIST_HEAD(&card->paths);
2524	INIT_LIST_HEAD(&card->dapm_list);
2525	INIT_LIST_HEAD(&card->aux_comp_list);
2526	INIT_LIST_HEAD(&card->component_dev_list);
2527	INIT_LIST_HEAD(&card->list);
 
2528	INIT_LIST_HEAD(&card->rtd_list);
2529	INIT_LIST_HEAD(&card->dapm_dirty);
2530	INIT_LIST_HEAD(&card->dobj_list);
2531
 
2532	card->instantiated = 0;
2533	mutex_init(&card->mutex);
2534	mutex_init(&card->dapm_mutex);
2535	mutex_init(&card->pcm_mutex);
 
2536
2537	return snd_soc_bind_card(card);
2538}
2539EXPORT_SYMBOL_GPL(snd_soc_register_card);
2540
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2541/**
2542 * snd_soc_unregister_card - Unregister a card with the ASoC core
2543 *
2544 * @card: Card to unregister
2545 *
2546 */
2547void snd_soc_unregister_card(struct snd_soc_card *card)
2548{
2549	mutex_lock(&client_mutex);
2550	snd_soc_unbind_card(card, true);
2551	mutex_unlock(&client_mutex);
2552	dev_dbg(card->dev, "ASoC: Unregistered card '%s'\n", card->name);
 
 
2553}
2554EXPORT_SYMBOL_GPL(snd_soc_unregister_card);
2555
2556/*
2557 * Simplify DAI link configuration by removing ".-1" from device names
2558 * and sanitizing names.
2559 */
2560static char *fmt_single_name(struct device *dev, int *id)
2561{
2562	const char *devname = dev_name(dev);
2563	char *found, *name;
2564	unsigned int id1, id2;
2565
2566	if (devname == NULL)
2567		return NULL;
2568
2569	name = devm_kstrdup(dev, devname, GFP_KERNEL);
2570	if (!name)
2571		return NULL;
2572
2573	/* are we a "%s.%d" name (platform and SPI components) */
2574	found = strstr(name, dev->driver->name);
2575	if (found) {
2576		/* get ID */
2577		if (sscanf(&found[strlen(dev->driver->name)], ".%d", id) == 1) {
2578
2579			/* discard ID from name if ID == -1 */
2580			if (*id == -1)
2581				found[strlen(dev->driver->name)] = '\0';
2582		}
2583
2584	/* I2C component devices are named "bus-addr" */
2585	} else if (sscanf(name, "%x-%x", &id1, &id2) == 2) {
2586
2587		/* create unique ID number from I2C addr and bus */
2588		*id = ((id1 & 0xffff) << 16) + id2;
2589
2590		devm_kfree(dev, name);
2591
2592		/* sanitize component name for DAI link creation */
2593		name = devm_kasprintf(dev, GFP_KERNEL, "%s.%s", dev->driver->name, devname);
2594	} else {
2595		*id = 0;
 
 
 
 
 
 
 
 
 
 
 
 
2596	}
2597
2598	return name;
2599}
2600
2601/*
2602 * Simplify DAI link naming for single devices with multiple DAIs by removing
2603 * any ".-1" and using the DAI name (instead of device name).
2604 */
2605static inline char *fmt_multiple_name(struct device *dev,
2606		struct snd_soc_dai_driver *dai_drv)
2607{
2608	if (dai_drv->name == NULL) {
2609		dev_err(dev,
2610			"ASoC: error - multiple DAI %s registered with no name\n",
2611			dev_name(dev));
2612		return NULL;
2613	}
2614
2615	return devm_kstrdup(dev, dai_drv->name, GFP_KERNEL);
2616}
2617
2618void snd_soc_unregister_dai(struct snd_soc_dai *dai)
 
 
 
 
 
2619{
2620	dev_dbg(dai->dev, "ASoC: Unregistered DAI '%s'\n", dai->name);
2621	list_del(&dai->list);
 
 
 
 
 
 
 
2622}
2623EXPORT_SYMBOL_GPL(snd_soc_unregister_dai);
2624
2625/**
2626 * snd_soc_register_dai - Register a DAI dynamically & create its widgets
2627 *
2628 * @component: The component the DAIs are registered for
2629 * @dai_drv: DAI driver to use for the DAI
2630 * @legacy_dai_naming: if %true, use legacy single-name format;
2631 * 	if %false, use multiple-name format;
2632 *
2633 * Topology can use this API to register DAIs when probing a component.
2634 * These DAIs's widgets will be freed in the card cleanup and the DAIs
2635 * will be freed in the component cleanup.
2636 */
2637struct snd_soc_dai *snd_soc_register_dai(struct snd_soc_component *component,
2638					 struct snd_soc_dai_driver *dai_drv,
2639					 bool legacy_dai_naming)
2640{
2641	struct device *dev = component->dev;
2642	struct snd_soc_dai *dai;
2643
2644	lockdep_assert_held(&client_mutex);
2645
2646	dai = devm_kzalloc(dev, sizeof(*dai), GFP_KERNEL);
2647	if (dai == NULL)
2648		return NULL;
2649
2650	/*
2651	 * Back in the old days when we still had component-less DAIs,
2652	 * instead of having a static name, component-less DAIs would
2653	 * inherit the name of the parent device so it is possible to
2654	 * register multiple instances of the DAI. We still need to keep
2655	 * the same naming style even though those DAIs are not
2656	 * component-less anymore.
2657	 */
2658	if (legacy_dai_naming &&
2659	    (dai_drv->id == 0 || dai_drv->name == NULL)) {
2660		dai->name = fmt_single_name(dev, &dai->id);
2661	} else {
2662		dai->name = fmt_multiple_name(dev, dai_drv);
2663		if (dai_drv->id)
2664			dai->id = dai_drv->id;
2665		else
2666			dai->id = component->num_dai;
2667	}
2668	if (!dai->name)
 
2669		return NULL;
 
2670
2671	dai->component = component;
2672	dai->dev = dev;
2673	dai->driver = dai_drv;
 
 
2674
2675	/* see for_each_component_dais */
2676	list_add_tail(&dai->list, &component->dai_list);
2677	component->num_dai++;
2678
2679	dev_dbg(dev, "ASoC: Registered DAI '%s'\n", dai->name);
2680	return dai;
2681}
2682EXPORT_SYMBOL_GPL(snd_soc_register_dai);
2683
2684/**
2685 * snd_soc_unregister_dais - Unregister DAIs from the ASoC core
2686 *
2687 * @component: The component for which the DAIs should be unregistered
2688 */
2689static void snd_soc_unregister_dais(struct snd_soc_component *component)
2690{
2691	struct snd_soc_dai *dai, *_dai;
2692
2693	for_each_component_dais_safe(component, dai, _dai)
2694		snd_soc_unregister_dai(dai);
2695}
2696
2697/**
2698 * snd_soc_register_dais - Register a DAI with the ASoC core
2699 *
2700 * @component: The component the DAIs are registered for
2701 * @dai_drv: DAI driver to use for the DAIs
2702 * @count: Number of DAIs
2703 */
2704static int snd_soc_register_dais(struct snd_soc_component *component,
2705				 struct snd_soc_dai_driver *dai_drv,
2706				 size_t count)
2707{
 
2708	struct snd_soc_dai *dai;
2709	unsigned int i;
2710	int ret;
2711
 
 
2712	for (i = 0; i < count; i++) {
2713		dai = snd_soc_register_dai(component, dai_drv + i, count == 1 &&
2714					   component->driver->legacy_dai_naming);
 
2715		if (dai == NULL) {
2716			ret = -ENOMEM;
2717			goto err;
2718		}
2719	}
2720
2721	return 0;
2722
2723err:
2724	snd_soc_unregister_dais(component);
2725
2726	return ret;
2727}
2728
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
2729#define ENDIANNESS_MAP(name) \
2730	(SNDRV_PCM_FMTBIT_##name##LE | SNDRV_PCM_FMTBIT_##name##BE)
2731static u64 endianness_format_map[] = {
2732	ENDIANNESS_MAP(S16_),
2733	ENDIANNESS_MAP(U16_),
2734	ENDIANNESS_MAP(S24_),
2735	ENDIANNESS_MAP(U24_),
2736	ENDIANNESS_MAP(S32_),
2737	ENDIANNESS_MAP(U32_),
2738	ENDIANNESS_MAP(S24_3),
2739	ENDIANNESS_MAP(U24_3),
2740	ENDIANNESS_MAP(S20_3),
2741	ENDIANNESS_MAP(U20_3),
2742	ENDIANNESS_MAP(S18_3),
2743	ENDIANNESS_MAP(U18_3),
2744	ENDIANNESS_MAP(FLOAT_),
2745	ENDIANNESS_MAP(FLOAT64_),
2746	ENDIANNESS_MAP(IEC958_SUBFRAME_),
2747};
2748
2749/*
2750 * Fix up the DAI formats for endianness: codecs don't actually see
2751 * the endianness of the data but we're using the CPU format
2752 * definitions which do need to include endianness so we ensure that
2753 * codec DAIs always have both big and little endian variants set.
2754 */
2755static void convert_endianness_formats(struct snd_soc_pcm_stream *stream)
2756{
2757	int i;
2758
2759	for (i = 0; i < ARRAY_SIZE(endianness_format_map); i++)
2760		if (stream->formats & endianness_format_map[i])
2761			stream->formats |= endianness_format_map[i];
2762}
2763
2764static void snd_soc_try_rebind_card(void)
2765{
2766	struct snd_soc_card *card, *c;
2767
2768	list_for_each_entry_safe(card, c, &unbind_card_list, list)
2769		if (!snd_soc_bind_card(card))
2770			list_del(&card->list);
2771}
2772
2773static void snd_soc_del_component_unlocked(struct snd_soc_component *component)
2774{
2775	struct snd_soc_card *card = component->card;
2776
2777	snd_soc_unregister_dais(component);
2778
2779	if (card)
2780		snd_soc_unbind_card(card, false);
2781
2782	list_del(&component->list);
2783}
2784
2785int snd_soc_component_initialize(struct snd_soc_component *component,
2786				 const struct snd_soc_component_driver *driver,
2787				 struct device *dev)
2788{
2789	INIT_LIST_HEAD(&component->dai_list);
2790	INIT_LIST_HEAD(&component->dobj_list);
2791	INIT_LIST_HEAD(&component->card_list);
2792	INIT_LIST_HEAD(&component->list);
2793	mutex_init(&component->io_mutex);
2794
2795	component->name = fmt_single_name(dev, &component->id);
2796	if (!component->name) {
2797		dev_err(dev, "ASoC: Failed to allocate name\n");
2798		return -ENOMEM;
2799	}
2800
2801	component->dev		= dev;
2802	component->driver	= driver;
2803
2804#ifdef CONFIG_DEBUG_FS
2805	if (!component->debugfs_prefix)
2806		component->debugfs_prefix = driver->debugfs_prefix;
2807#endif
2808
2809	return 0;
2810}
2811EXPORT_SYMBOL_GPL(snd_soc_component_initialize);
2812
2813int snd_soc_add_component(struct snd_soc_component *component,
2814			  struct snd_soc_dai_driver *dai_drv,
2815			  int num_dai)
2816{
2817	int ret;
2818	int i;
2819
2820	mutex_lock(&client_mutex);
 
 
2821
2822	if (component->driver->endianness) {
2823		for (i = 0; i < num_dai; i++) {
2824			convert_endianness_formats(&dai_drv[i].playback);
2825			convert_endianness_formats(&dai_drv[i].capture);
2826		}
2827	}
2828
2829	ret = snd_soc_register_dais(component, dai_drv, num_dai);
2830	if (ret < 0) {
2831		dev_err(component->dev, "ASoC: Failed to register DAIs: %d\n",
2832			ret);
2833		goto err_cleanup;
2834	}
2835
2836	if (!component->driver->write && !component->driver->read) {
2837		if (!component->regmap)
2838			component->regmap = dev_get_regmap(component->dev,
2839							   NULL);
2840		if (component->regmap)
2841			snd_soc_component_setup_regmap(component);
2842	}
2843
2844	/* see for_each_component */
2845	list_add(&component->list, &component_list);
2846
2847err_cleanup:
2848	if (ret < 0)
2849		snd_soc_del_component_unlocked(component);
2850
2851	mutex_unlock(&client_mutex);
2852
2853	if (ret == 0)
2854		snd_soc_try_rebind_card();
2855
2856	return ret;
2857}
2858EXPORT_SYMBOL_GPL(snd_soc_add_component);
2859
2860int snd_soc_register_component(struct device *dev,
2861			const struct snd_soc_component_driver *component_driver,
2862			struct snd_soc_dai_driver *dai_drv,
2863			int num_dai)
2864{
2865	struct snd_soc_component *component;
2866	int ret;
2867
2868	component = devm_kzalloc(dev, sizeof(*component), GFP_KERNEL);
2869	if (!component)
2870		return -ENOMEM;
2871
2872	ret = snd_soc_component_initialize(component, component_driver, dev);
2873	if (ret < 0)
2874		return ret;
2875
2876	return snd_soc_add_component(component, dai_drv, num_dai);
2877}
2878EXPORT_SYMBOL_GPL(snd_soc_register_component);
2879
2880/**
2881 * snd_soc_unregister_component_by_driver - Unregister component using a given driver
2882 * from the ASoC core
2883 *
2884 * @dev: The device to unregister
2885 * @component_driver: The component driver to unregister
2886 */
2887void snd_soc_unregister_component_by_driver(struct device *dev,
2888					    const struct snd_soc_component_driver *component_driver)
2889{
2890	struct snd_soc_component *component;
 
2891
2892	if (!component_driver)
2893		return;
 
 
2894
2895	mutex_lock(&client_mutex);
2896	component = snd_soc_lookup_component_nolocked(dev, component_driver->name);
2897	if (!component)
2898		goto out;
 
 
 
2899
2900	snd_soc_del_component_unlocked(component);
 
2901
2902out:
2903	mutex_unlock(&client_mutex);
2904}
2905EXPORT_SYMBOL_GPL(snd_soc_unregister_component_by_driver);
2906
2907/**
2908 * snd_soc_unregister_component - Unregister all related component
2909 * from the ASoC core
2910 *
2911 * @dev: The device to unregister
2912 */
2913void snd_soc_unregister_component(struct device *dev)
2914{
 
 
 
 
 
 
 
 
 
 
 
 
2915	mutex_lock(&client_mutex);
2916	while (1) {
2917		struct snd_soc_component *component = snd_soc_lookup_component_nolocked(dev, NULL);
 
2918
2919		if (!component)
2920			break;
 
 
2921
2922		snd_soc_del_component_unlocked(component);
 
2923	}
2924	mutex_unlock(&client_mutex);
 
 
2925}
2926EXPORT_SYMBOL_GPL(snd_soc_unregister_component);
2927
2928/* Retrieve a card's name from device tree */
2929int snd_soc_of_parse_card_name(struct snd_soc_card *card,
2930			       const char *propname)
2931{
2932	struct device_node *np;
2933	int ret;
2934
2935	if (!card->dev) {
2936		pr_err("card->dev is not set before calling %s\n", __func__);
2937		return -EINVAL;
2938	}
2939
2940	np = card->dev->of_node;
2941
2942	ret = of_property_read_string_index(np, propname, 0, &card->name);
2943	/*
2944	 * EINVAL means the property does not exist. This is fine providing
2945	 * card->name was previously set, which is checked later in
2946	 * snd_soc_register_card.
2947	 */
2948	if (ret < 0 && ret != -EINVAL) {
2949		dev_err(card->dev,
2950			"ASoC: Property '%s' could not be read: %d\n",
2951			propname, ret);
2952		return ret;
2953	}
2954
2955	return 0;
2956}
2957EXPORT_SYMBOL_GPL(snd_soc_of_parse_card_name);
2958
2959static const struct snd_soc_dapm_widget simple_widgets[] = {
2960	SND_SOC_DAPM_MIC("Microphone", NULL),
2961	SND_SOC_DAPM_LINE("Line", NULL),
2962	SND_SOC_DAPM_HP("Headphone", NULL),
2963	SND_SOC_DAPM_SPK("Speaker", NULL),
2964};
2965
2966int snd_soc_of_parse_audio_simple_widgets(struct snd_soc_card *card,
2967					  const char *propname)
2968{
2969	struct device_node *np = card->dev->of_node;
2970	struct snd_soc_dapm_widget *widgets;
2971	const char *template, *wname;
2972	int i, j, num_widgets;
2973
2974	num_widgets = of_property_count_strings(np, propname);
2975	if (num_widgets < 0) {
2976		dev_err(card->dev,
2977			"ASoC: Property '%s' does not exist\n",	propname);
2978		return -EINVAL;
2979	}
2980	if (!num_widgets) {
2981		dev_err(card->dev, "ASoC: Property '%s's length is zero\n",
2982			propname);
2983		return -EINVAL;
2984	}
2985	if (num_widgets & 1) {
2986		dev_err(card->dev,
2987			"ASoC: Property '%s' length is not even\n", propname);
2988		return -EINVAL;
2989	}
2990
2991	num_widgets /= 2;
 
 
 
 
 
2992
2993	widgets = devm_kcalloc(card->dev, num_widgets, sizeof(*widgets),
2994			       GFP_KERNEL);
2995	if (!widgets) {
2996		dev_err(card->dev,
2997			"ASoC: Could not allocate memory for widgets\n");
2998		return -ENOMEM;
2999	}
3000
3001	for (i = 0; i < num_widgets; i++) {
3002		int ret = of_property_read_string_index(np, propname,
3003							2 * i, &template);
3004		if (ret) {
3005			dev_err(card->dev,
3006				"ASoC: Property '%s' index %d read error:%d\n",
3007				propname, 2 * i, ret);
3008			return -EINVAL;
3009		}
3010
3011		for (j = 0; j < ARRAY_SIZE(simple_widgets); j++) {
3012			if (!strncmp(template, simple_widgets[j].name,
3013				     strlen(simple_widgets[j].name))) {
3014				widgets[i] = simple_widgets[j];
3015				break;
3016			}
3017		}
3018
3019		if (j >= ARRAY_SIZE(simple_widgets)) {
3020			dev_err(card->dev,
3021				"ASoC: DAPM widget '%s' is not supported\n",
3022				template);
3023			return -EINVAL;
3024		}
3025
3026		ret = of_property_read_string_index(np, propname,
3027						    (2 * i) + 1,
3028						    &wname);
3029		if (ret) {
3030			dev_err(card->dev,
3031				"ASoC: Property '%s' index %d read error:%d\n",
3032				propname, (2 * i) + 1, ret);
3033			return -EINVAL;
3034		}
3035
3036		widgets[i].name = wname;
3037	}
3038
3039	card->of_dapm_widgets = widgets;
3040	card->num_of_dapm_widgets = num_widgets;
3041
3042	return 0;
3043}
3044EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_simple_widgets);
3045
3046int snd_soc_of_parse_pin_switches(struct snd_soc_card *card, const char *prop)
3047{
3048	const unsigned int nb_controls_max = 16;
3049	const char **strings, *control_name;
3050	struct snd_kcontrol_new *controls;
3051	struct device *dev = card->dev;
3052	unsigned int i, nb_controls;
3053	int ret;
3054
3055	if (!of_property_read_bool(dev->of_node, prop))
3056		return 0;
3057
3058	strings = devm_kcalloc(dev, nb_controls_max,
3059			       sizeof(*strings), GFP_KERNEL);
3060	if (!strings)
3061		return -ENOMEM;
3062
3063	ret = of_property_read_string_array(dev->of_node, prop,
3064					    strings, nb_controls_max);
3065	if (ret < 0)
3066		return ret;
3067
3068	nb_controls = (unsigned int)ret;
3069
3070	controls = devm_kcalloc(dev, nb_controls,
3071				sizeof(*controls), GFP_KERNEL);
3072	if (!controls)
3073		return -ENOMEM;
3074
3075	for (i = 0; i < nb_controls; i++) {
3076		control_name = devm_kasprintf(dev, GFP_KERNEL,
3077					      "%s Switch", strings[i]);
3078		if (!control_name)
3079			return -ENOMEM;
3080
3081		controls[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
3082		controls[i].name = control_name;
3083		controls[i].info = snd_soc_dapm_info_pin_switch;
3084		controls[i].get = snd_soc_dapm_get_pin_switch;
3085		controls[i].put = snd_soc_dapm_put_pin_switch;
3086		controls[i].private_value = (unsigned long)strings[i];
3087	}
3088
3089	card->controls = controls;
3090	card->num_controls = nb_controls;
3091
3092	return 0;
3093}
3094EXPORT_SYMBOL_GPL(snd_soc_of_parse_pin_switches);
3095
3096int snd_soc_of_get_slot_mask(struct device_node *np,
3097			     const char *prop_name,
3098			     unsigned int *mask)
3099{
3100	u32 val;
3101	const __be32 *of_slot_mask = of_get_property(np, prop_name, &val);
3102	int i;
3103
3104	if (!of_slot_mask)
3105		return 0;
3106	val /= sizeof(u32);
3107	for (i = 0; i < val; i++)
3108		if (be32_to_cpup(&of_slot_mask[i]))
3109			*mask |= (1 << i);
3110
3111	return val;
3112}
3113EXPORT_SYMBOL_GPL(snd_soc_of_get_slot_mask);
3114
3115int snd_soc_of_parse_tdm_slot(struct device_node *np,
3116			      unsigned int *tx_mask,
3117			      unsigned int *rx_mask,
3118			      unsigned int *slots,
3119			      unsigned int *slot_width)
3120{
3121	u32 val;
3122	int ret;
3123
3124	if (tx_mask)
3125		snd_soc_of_get_slot_mask(np, "dai-tdm-slot-tx-mask", tx_mask);
3126	if (rx_mask)
3127		snd_soc_of_get_slot_mask(np, "dai-tdm-slot-rx-mask", rx_mask);
3128
3129	if (of_property_read_bool(np, "dai-tdm-slot-num")) {
3130		ret = of_property_read_u32(np, "dai-tdm-slot-num", &val);
3131		if (ret)
3132			return ret;
3133
3134		if (slots)
3135			*slots = val;
3136	}
3137
3138	if (of_property_read_bool(np, "dai-tdm-slot-width")) {
3139		ret = of_property_read_u32(np, "dai-tdm-slot-width", &val);
3140		if (ret)
3141			return ret;
3142
3143		if (slot_width)
3144			*slot_width = val;
3145	}
3146
3147	return 0;
3148}
3149EXPORT_SYMBOL_GPL(snd_soc_of_parse_tdm_slot);
3150
3151void snd_soc_dlc_use_cpu_as_platform(struct snd_soc_dai_link_component *platforms,
3152				     struct snd_soc_dai_link_component *cpus)
3153{
3154	platforms->of_node	= cpus->of_node;
3155	platforms->dai_args	= cpus->dai_args;
3156}
3157EXPORT_SYMBOL_GPL(snd_soc_dlc_use_cpu_as_platform);
3158
3159void snd_soc_of_parse_node_prefix(struct device_node *np,
3160				  struct snd_soc_codec_conf *codec_conf,
3161				  struct device_node *of_node,
3162				  const char *propname)
3163{
3164	const char *str;
3165	int ret;
3166
3167	ret = of_property_read_string(np, propname, &str);
3168	if (ret < 0) {
3169		/* no prefix is not error */
3170		return;
3171	}
3172
3173	codec_conf->dlc.of_node	= of_node;
3174	codec_conf->name_prefix	= str;
3175}
3176EXPORT_SYMBOL_GPL(snd_soc_of_parse_node_prefix);
3177
3178int snd_soc_of_parse_audio_routing(struct snd_soc_card *card,
3179				   const char *propname)
3180{
3181	struct device_node *np = card->dev->of_node;
3182	int num_routes;
3183	struct snd_soc_dapm_route *routes;
3184	int i;
3185
3186	num_routes = of_property_count_strings(np, propname);
3187	if (num_routes < 0 || num_routes & 1) {
3188		dev_err(card->dev,
3189			"ASoC: Property '%s' does not exist or its length is not even\n",
3190			propname);
3191		return -EINVAL;
3192	}
3193	num_routes /= 2;
 
 
 
 
 
3194
3195	routes = devm_kcalloc(card->dev, num_routes, sizeof(*routes),
3196			      GFP_KERNEL);
3197	if (!routes) {
3198		dev_err(card->dev,
3199			"ASoC: Could not allocate DAPM route table\n");
3200		return -ENOMEM;
3201	}
3202
3203	for (i = 0; i < num_routes; i++) {
3204		int ret = of_property_read_string_index(np, propname,
3205							2 * i, &routes[i].sink);
3206		if (ret) {
3207			dev_err(card->dev,
3208				"ASoC: Property '%s' index %d could not be read: %d\n",
3209				propname, 2 * i, ret);
3210			return -EINVAL;
3211		}
3212		ret = of_property_read_string_index(np, propname,
3213			(2 * i) + 1, &routes[i].source);
3214		if (ret) {
3215			dev_err(card->dev,
3216				"ASoC: Property '%s' index %d could not be read: %d\n",
3217				propname, (2 * i) + 1, ret);
3218			return -EINVAL;
3219		}
3220	}
3221
3222	card->num_of_dapm_routes = num_routes;
3223	card->of_dapm_routes = routes;
3224
3225	return 0;
3226}
3227EXPORT_SYMBOL_GPL(snd_soc_of_parse_audio_routing);
3228
3229int snd_soc_of_parse_aux_devs(struct snd_soc_card *card, const char *propname)
 
 
 
3230{
3231	struct device_node *node = card->dev->of_node;
3232	struct snd_soc_aux_dev *aux;
3233	int num, i;
3234
3235	num = of_count_phandle_with_args(node, propname, NULL);
3236	if (num == -ENOENT) {
3237		return 0;
3238	} else if (num < 0) {
3239		dev_err(card->dev, "ASOC: Property '%s' could not be read: %d\n",
3240			propname, num);
3241		return num;
3242	}
3243
3244	aux = devm_kcalloc(card->dev, num, sizeof(*aux), GFP_KERNEL);
3245	if (!aux)
3246		return -ENOMEM;
3247	card->aux_dev = aux;
3248	card->num_aux_devs = num;
3249
3250	for_each_card_pre_auxs(card, i, aux) {
3251		aux->dlc.of_node = of_parse_phandle(node, propname, i);
3252		if (!aux->dlc.of_node)
3253			return -EINVAL;
3254	}
3255
3256	return 0;
3257}
3258EXPORT_SYMBOL_GPL(snd_soc_of_parse_aux_devs);
3259
3260unsigned int snd_soc_daifmt_clock_provider_flipped(unsigned int dai_fmt)
3261{
3262	unsigned int inv_dai_fmt = dai_fmt & ~SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK;
3263
3264	switch (dai_fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) {
3265	case SND_SOC_DAIFMT_CBP_CFP:
3266		inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
3267		break;
3268	case SND_SOC_DAIFMT_CBP_CFC:
3269		inv_dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
3270		break;
3271	case SND_SOC_DAIFMT_CBC_CFP:
3272		inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
3273		break;
3274	case SND_SOC_DAIFMT_CBC_CFC:
3275		inv_dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
3276		break;
3277	}
3278
3279	return inv_dai_fmt;
3280}
3281EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_flipped);
3282
3283unsigned int snd_soc_daifmt_clock_provider_from_bitmap(unsigned int bit_frame)
3284{
3285	/*
3286	 * bit_frame is return value from
3287	 *	snd_soc_daifmt_parse_clock_provider_raw()
3288	 */
3289
3290	/* Codec base */
3291	switch (bit_frame) {
3292	case 0x11:
3293		return SND_SOC_DAIFMT_CBP_CFP;
3294	case 0x10:
3295		return SND_SOC_DAIFMT_CBP_CFC;
3296	case 0x01:
3297		return SND_SOC_DAIFMT_CBC_CFP;
3298	default:
3299		return SND_SOC_DAIFMT_CBC_CFC;
3300	}
3301
3302	return 0;
3303}
3304EXPORT_SYMBOL_GPL(snd_soc_daifmt_clock_provider_from_bitmap);
3305
3306unsigned int snd_soc_daifmt_parse_format(struct device_node *np,
3307					 const char *prefix)
3308{
3309	int ret;
3310	char prop[128];
3311	unsigned int format = 0;
3312	int bit, frame;
3313	const char *str;
3314	struct {
3315		char *name;
3316		unsigned int val;
3317	} of_fmt_table[] = {
3318		{ "i2s",	SND_SOC_DAIFMT_I2S },
3319		{ "right_j",	SND_SOC_DAIFMT_RIGHT_J },
3320		{ "left_j",	SND_SOC_DAIFMT_LEFT_J },
3321		{ "dsp_a",	SND_SOC_DAIFMT_DSP_A },
3322		{ "dsp_b",	SND_SOC_DAIFMT_DSP_B },
3323		{ "ac97",	SND_SOC_DAIFMT_AC97 },
3324		{ "pdm",	SND_SOC_DAIFMT_PDM},
3325		{ "msb",	SND_SOC_DAIFMT_MSB },
3326		{ "lsb",	SND_SOC_DAIFMT_LSB },
3327	};
3328
3329	if (!prefix)
3330		prefix = "";
3331
3332	/*
3333	 * check "dai-format = xxx"
3334	 * or    "[prefix]format = xxx"
3335	 * SND_SOC_DAIFMT_FORMAT_MASK area
3336	 */
3337	ret = of_property_read_string(np, "dai-format", &str);
3338	if (ret < 0) {
3339		snprintf(prop, sizeof(prop), "%sformat", prefix);
3340		ret = of_property_read_string(np, prop, &str);
3341	}
3342	if (ret == 0) {
3343		int i;
3344
3345		for (i = 0; i < ARRAY_SIZE(of_fmt_table); i++) {
3346			if (strcmp(str, of_fmt_table[i].name) == 0) {
3347				format |= of_fmt_table[i].val;
3348				break;
3349			}
3350		}
3351	}
3352
3353	/*
3354	 * check "[prefix]continuous-clock"
3355	 * SND_SOC_DAIFMT_CLOCK_MASK area
3356	 */
3357	snprintf(prop, sizeof(prop), "%scontinuous-clock", prefix);
3358	if (of_property_read_bool(np, prop))
3359		format |= SND_SOC_DAIFMT_CONT;
3360	else
3361		format |= SND_SOC_DAIFMT_GATED;
3362
3363	/*
3364	 * check "[prefix]bitclock-inversion"
3365	 * check "[prefix]frame-inversion"
3366	 * SND_SOC_DAIFMT_INV_MASK area
3367	 */
3368	snprintf(prop, sizeof(prop), "%sbitclock-inversion", prefix);
3369	bit = !!of_get_property(np, prop, NULL);
3370
3371	snprintf(prop, sizeof(prop), "%sframe-inversion", prefix);
3372	frame = !!of_get_property(np, prop, NULL);
3373
3374	switch ((bit << 4) + frame) {
3375	case 0x11:
3376		format |= SND_SOC_DAIFMT_IB_IF;
3377		break;
3378	case 0x10:
3379		format |= SND_SOC_DAIFMT_IB_NF;
3380		break;
3381	case 0x01:
3382		format |= SND_SOC_DAIFMT_NB_IF;
3383		break;
3384	default:
3385		/* SND_SOC_DAIFMT_NB_NF is default */
3386		break;
3387	}
3388
3389	return format;
3390}
3391EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_format);
3392
3393unsigned int snd_soc_daifmt_parse_clock_provider_raw(struct device_node *np,
3394						     const char *prefix,
3395						     struct device_node **bitclkmaster,
3396						     struct device_node **framemaster)
3397{
3398	char prop[128];
3399	unsigned int bit, frame;
3400
3401	if (!prefix)
3402		prefix = "";
3403
3404	/*
3405	 * check "[prefix]bitclock-master"
3406	 * check "[prefix]frame-master"
 
3407	 */
3408	snprintf(prop, sizeof(prop), "%sbitclock-master", prefix);
3409	bit = !!of_get_property(np, prop, NULL);
3410	if (bit && bitclkmaster)
3411		*bitclkmaster = of_parse_phandle(np, prop, 0);
3412
3413	snprintf(prop, sizeof(prop), "%sframe-master", prefix);
3414	frame = !!of_get_property(np, prop, NULL);
3415	if (frame && framemaster)
3416		*framemaster = of_parse_phandle(np, prop, 0);
3417
3418	/*
3419	 * return bitmap.
3420	 * It will be parameter of
3421	 *	snd_soc_daifmt_clock_provider_from_bitmap()
3422	 */
3423	return (bit << 4) + frame;
3424}
3425EXPORT_SYMBOL_GPL(snd_soc_daifmt_parse_clock_provider_raw);
 
 
 
 
 
 
3426
3427int snd_soc_get_stream_cpu(struct snd_soc_dai_link *dai_link, int stream)
3428{
3429	/*
3430	 * [Normal]
3431	 *
3432	 * Playback
3433	 *	CPU  : SNDRV_PCM_STREAM_PLAYBACK
3434	 *	Codec: SNDRV_PCM_STREAM_PLAYBACK
3435	 *
3436	 * Capture
3437	 *	CPU  : SNDRV_PCM_STREAM_CAPTURE
3438	 *	Codec: SNDRV_PCM_STREAM_CAPTURE
3439	 */
3440	if (!dai_link->c2c_params)
3441		return stream;
3442
3443	/*
3444	 * [Codec2Codec]
3445	 *
3446	 * Playback
3447	 *	CPU  : SNDRV_PCM_STREAM_CAPTURE
3448	 *	Codec: SNDRV_PCM_STREAM_PLAYBACK
3449	 *
3450	 * Capture
3451	 *	CPU  : SNDRV_PCM_STREAM_PLAYBACK
3452	 *	Codec: SNDRV_PCM_STREAM_CAPTURE
3453	 */
3454	if (stream == SNDRV_PCM_STREAM_CAPTURE)
3455		return SNDRV_PCM_STREAM_PLAYBACK;
3456
3457	return SNDRV_PCM_STREAM_CAPTURE;
3458}
3459EXPORT_SYMBOL_GPL(snd_soc_get_stream_cpu);
3460
3461int snd_soc_get_dai_id(struct device_node *ep)
3462{
3463	struct snd_soc_component *component;
3464	struct snd_soc_dai_link_component dlc = {
3465		.of_node = of_graph_get_port_parent(ep),
3466	};
3467	int ret;
3468
3469
 
3470	/*
3471	 * For example HDMI case, HDMI has video/sound port,
3472	 * but ALSA SoC needs sound port number only.
3473	 * Thus counting HDMI DT port/endpoint doesn't work.
3474	 * Then, it should have .of_xlate_dai_id
3475	 */
3476	ret = -ENOTSUPP;
3477	mutex_lock(&client_mutex);
3478	component = soc_find_component(&dlc);
3479	if (component)
3480		ret = snd_soc_component_of_xlate_dai_id(component, ep);
3481	mutex_unlock(&client_mutex);
3482
3483	of_node_put(dlc.of_node);
3484
3485	return ret;
3486}
3487EXPORT_SYMBOL_GPL(snd_soc_get_dai_id);
3488
3489int snd_soc_get_dlc(const struct of_phandle_args *args, struct snd_soc_dai_link_component *dlc)
 
3490{
3491	struct snd_soc_component *pos;
 
3492	int ret = -EPROBE_DEFER;
3493
3494	mutex_lock(&client_mutex);
3495	for_each_component(pos) {
3496		struct device_node *component_of_node = soc_component_to_node(pos);
3497
3498		if (component_of_node != args->np || !pos->num_dai)
3499			continue;
3500
3501		ret = snd_soc_component_of_xlate_dai_name(pos, args, &dlc->dai_name);
3502		if (ret == -ENOTSUPP) {
3503			struct snd_soc_dai *dai;
3504			int id = -1;
3505
3506			switch (args->args_count) {
3507			case 0:
3508				id = 0; /* same as dai_drv[0] */
3509				break;
3510			case 1:
3511				id = args->args[0];
3512				break;
3513			default:
3514				/* not supported */
3515				break;
3516			}
3517
3518			if (id < 0 || id >= pos->num_dai) {
3519				ret = -EINVAL;
3520				continue;
3521			}
3522
3523			ret = 0;
3524
3525			/* find target DAI */
3526			for_each_component_dais(pos, dai) {
3527				if (id == 0)
3528					break;
3529				id--;
3530			}
3531
3532			dlc->dai_name	= snd_soc_dai_name_get(dai);
3533		} else if (ret) {
3534			/*
3535			 * if another error than ENOTSUPP is returned go on and
3536			 * check if another component is provided with the same
3537			 * node. This may happen if a device provides several
3538			 * components
3539			 */
3540			continue;
3541		}
3542
3543		break;
3544	}
3545
3546	if (ret == 0)
3547		dlc->of_node = args->np;
3548
3549	mutex_unlock(&client_mutex);
3550	return ret;
3551}
3552EXPORT_SYMBOL_GPL(snd_soc_get_dlc);
3553
3554int snd_soc_of_get_dlc(struct device_node *of_node,
3555		       struct of_phandle_args *args,
3556		       struct snd_soc_dai_link_component *dlc,
3557		       int index)
3558{
3559	struct of_phandle_args __args;
3560	int ret;
3561
3562	if (!args)
3563		args = &__args;
3564
3565	ret = of_parse_phandle_with_args(of_node, "sound-dai",
3566					 "#sound-dai-cells", index, args);
3567	if (ret)
3568		return ret;
3569
3570	return snd_soc_get_dlc(args, dlc);
3571}
3572EXPORT_SYMBOL_GPL(snd_soc_of_get_dlc);
3573
3574int snd_soc_get_dai_name(const struct of_phandle_args *args,
3575			 const char **dai_name)
3576{
3577	struct snd_soc_dai_link_component dlc;
3578	int ret = snd_soc_get_dlc(args, &dlc);
3579
3580	if (ret == 0)
3581		*dai_name = dlc.dai_name;
3582
3583	return ret;
3584}
3585EXPORT_SYMBOL_GPL(snd_soc_get_dai_name);
3586
3587int snd_soc_of_get_dai_name(struct device_node *of_node,
3588			    const char **dai_name, int index)
3589{
3590	struct snd_soc_dai_link_component dlc;
3591	int ret = snd_soc_of_get_dlc(of_node, NULL, &dlc, index);
3592
3593	if (ret == 0)
3594		*dai_name = dlc.dai_name;
3595
3596	return ret;
3597}
3598EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_name);
3599
3600struct snd_soc_dai *snd_soc_get_dai_via_args(struct of_phandle_args *dai_args)
3601{
3602	struct snd_soc_dai *dai;
3603	struct snd_soc_component *component;
3604
3605	mutex_lock(&client_mutex);
3606	for_each_component(component) {
3607		for_each_component_dais(component, dai)
3608			if (snd_soc_is_match_dai_args(dai->driver->dai_args, dai_args))
3609				goto found;
3610	}
3611	dai = NULL;
3612found:
3613	mutex_unlock(&client_mutex);
3614	return dai;
3615}
3616EXPORT_SYMBOL_GPL(snd_soc_get_dai_via_args);
3617
3618static void __snd_soc_of_put_component(struct snd_soc_dai_link_component *component)
3619{
3620	if (component->of_node) {
3621		of_node_put(component->of_node);
3622		component->of_node = NULL;
3623	}
3624}
3625
3626static int __snd_soc_of_get_dai_link_component_alloc(
3627	struct device *dev, struct device_node *of_node,
3628	struct snd_soc_dai_link_component **ret_component,
3629	int *ret_num)
3630{
3631	struct snd_soc_dai_link_component *component;
3632	int num;
3633
3634	/* Count the number of CPUs/CODECs */
3635	num = of_count_phandle_with_args(of_node, "sound-dai", "#sound-dai-cells");
3636	if (num <= 0) {
3637		if (num == -ENOENT)
3638			dev_err(dev, "No 'sound-dai' property\n");
3639		else
3640			dev_err(dev, "Bad phandle in 'sound-dai'\n");
3641		return num;
3642	}
3643	component = devm_kcalloc(dev, num, sizeof(*component), GFP_KERNEL);
3644	if (!component)
3645		return -ENOMEM;
3646
3647	*ret_component	= component;
3648	*ret_num	= num;
3649
3650	return 0;
3651}
3652
3653/*
3654 * snd_soc_of_put_dai_link_codecs - Dereference device nodes in the codecs array
3655 * @dai_link: DAI link
3656 *
3657 * Dereference device nodes acquired by snd_soc_of_get_dai_link_codecs().
3658 */
3659void snd_soc_of_put_dai_link_codecs(struct snd_soc_dai_link *dai_link)
3660{
3661	struct snd_soc_dai_link_component *component;
3662	int index;
3663
3664	for_each_link_codecs(dai_link, index, component)
3665		__snd_soc_of_put_component(component);
 
 
 
 
3666}
3667EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_codecs);
3668
3669/*
3670 * snd_soc_of_get_dai_link_codecs - Parse a list of CODECs in the devicetree
3671 * @dev: Card device
3672 * @of_node: Device node
3673 * @dai_link: DAI link
3674 *
3675 * Builds an array of CODEC DAI components from the DAI link property
3676 * 'sound-dai'.
3677 * The array is set in the DAI link and the number of DAIs is set accordingly.
3678 * The device nodes in the array (of_node) must be dereferenced by calling
3679 * snd_soc_of_put_dai_link_codecs() on @dai_link.
3680 *
3681 * Returns 0 for success
3682 */
3683int snd_soc_of_get_dai_link_codecs(struct device *dev,
3684				   struct device_node *of_node,
3685				   struct snd_soc_dai_link *dai_link)
3686{
 
3687	struct snd_soc_dai_link_component *component;
3688	int index, ret;
 
3689
3690	ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3691					 &dai_link->codecs, &dai_link->num_codecs);
3692	if (ret < 0)
3693		return ret;
 
 
 
 
 
 
 
 
 
 
 
 
 
 
3694
3695	/* Parse the list */
3696	for_each_link_codecs(dai_link, index, component) {
3697		ret = snd_soc_of_get_dlc(of_node, NULL, component, index);
 
 
3698		if (ret)
3699			goto err;
 
 
 
 
3700	}
3701	return 0;
3702err:
3703	snd_soc_of_put_dai_link_codecs(dai_link);
3704	dai_link->codecs = NULL;
3705	dai_link->num_codecs = 0;
3706	return ret;
3707}
3708EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_codecs);
3709
3710/*
3711 * snd_soc_of_put_dai_link_cpus - Dereference device nodes in the codecs array
3712 * @dai_link: DAI link
3713 *
3714 * Dereference device nodes acquired by snd_soc_of_get_dai_link_cpus().
3715 */
3716void snd_soc_of_put_dai_link_cpus(struct snd_soc_dai_link *dai_link)
3717{
3718	struct snd_soc_dai_link_component *component;
3719	int index;
3720
3721	for_each_link_cpus(dai_link, index, component)
3722		__snd_soc_of_put_component(component);
3723}
3724EXPORT_SYMBOL_GPL(snd_soc_of_put_dai_link_cpus);
3725
3726/*
3727 * snd_soc_of_get_dai_link_cpus - Parse a list of CPU DAIs in the devicetree
3728 * @dev: Card device
3729 * @of_node: Device node
3730 * @dai_link: DAI link
3731 *
3732 * Is analogous to snd_soc_of_get_dai_link_codecs but parses a list of CPU DAIs
3733 * instead.
3734 *
3735 * Returns 0 for success
3736 */
3737int snd_soc_of_get_dai_link_cpus(struct device *dev,
3738				 struct device_node *of_node,
3739				 struct snd_soc_dai_link *dai_link)
3740{
3741	struct snd_soc_dai_link_component *component;
3742	int index, ret;
3743
3744	/* Count the number of CPUs */
3745	ret = __snd_soc_of_get_dai_link_component_alloc(dev, of_node,
3746					 &dai_link->cpus, &dai_link->num_cpus);
3747	if (ret < 0)
3748		return ret;
3749
3750	/* Parse the list */
3751	for_each_link_cpus(dai_link, index, component) {
3752		ret = snd_soc_of_get_dlc(of_node, NULL, component, index);
3753		if (ret)
3754			goto err;
3755	}
3756	return 0;
3757err:
3758	snd_soc_of_put_dai_link_cpus(dai_link);
3759	dai_link->cpus = NULL;
3760	dai_link->num_cpus = 0;
3761	return ret;
3762}
3763EXPORT_SYMBOL_GPL(snd_soc_of_get_dai_link_cpus);
3764
3765static int __init snd_soc_init(void)
3766{
3767	int ret;
3768
3769	snd_soc_debugfs_init();
3770	ret = snd_soc_util_init();
3771	if (ret)
3772		goto err_util_init;
3773
3774	ret = platform_driver_register(&soc_driver);
3775	if (ret)
3776		goto err_register;
3777	return 0;
3778
3779err_register:
3780	snd_soc_util_exit();
3781err_util_init:
3782	snd_soc_debugfs_exit();
3783	return ret;
3784}
3785module_init(snd_soc_init);
3786
3787static void __exit snd_soc_exit(void)
3788{
3789	snd_soc_util_exit();
3790	snd_soc_debugfs_exit();
3791
3792	platform_driver_unregister(&soc_driver);
3793}
3794module_exit(snd_soc_exit);
3795
3796/* Module information */
3797MODULE_AUTHOR("Liam Girdwood, lrg@slimlogic.co.uk");
3798MODULE_DESCRIPTION("ALSA SoC Core");
3799MODULE_LICENSE("GPL");
3800MODULE_ALIAS("platform:soc-audio");