1 // SPDX-License-Identifier: GPL-2.0
3 // ASoC audio graph sound card support
5 // Copyright (C) 2016 Renesas Solutions Corp.
6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
8 // based on ${LINUX}/sound/soc/generic/simple-card.c
10 #include <linux/clk.h>
11 #include <linux/device.h>
12 #include <linux/gpio.h>
13 #include <linux/gpio/consumer.h>
14 #include <linux/module.h>
16 #include <linux/of_device.h>
17 #include <linux/of_gpio.h>
18 #include <linux/of_graph.h>
19 #include <linux/platform_device.h>
20 #include <linux/string.h>
21 #include <sound/graph_card.h>
23 #define DPCM_SELECTABLE 1
25 #define PREFIX "audio-graph-card,"
27 static int graph_outdrv_event(struct snd_soc_dapm_widget *w,
28 struct snd_kcontrol *kcontrol,
31 struct snd_soc_dapm_context *dapm = w->dapm;
32 struct asoc_simple_priv *priv = snd_soc_card_get_drvdata(dapm->card);
35 case SND_SOC_DAPM_POST_PMU:
36 gpiod_set_value_cansleep(priv->pa_gpio, 1);
38 case SND_SOC_DAPM_PRE_PMD:
39 gpiod_set_value_cansleep(priv->pa_gpio, 0);
48 static const struct snd_soc_dapm_widget graph_dapm_widgets[] = {
49 SND_SOC_DAPM_OUT_DRV_E("Amplifier", SND_SOC_NOPM,
50 0, 0, NULL, 0, graph_outdrv_event,
51 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
54 static const struct snd_soc_ops graph_ops = {
55 .startup = asoc_simple_startup,
56 .shutdown = asoc_simple_shutdown,
57 .hw_params = asoc_simple_hw_params,
60 static int graph_get_dai_id(struct device_node *ep)
62 struct device_node *node;
63 struct device_node *endpoint;
64 struct of_endpoint info;
69 /* use driver specified DAI ID if exist */
70 ret = snd_soc_get_dai_id(ep);
74 /* use endpoint/port reg if exist */
75 ret = of_graph_parse_endpoint(ep, &info);
78 * Because it will count port/endpoint if it doesn't have "reg".
79 * But, we can't judge whether it has "no reg", or "reg = <0>"
80 * only of_graph_parse_endpoint().
81 * We need to check "reg" property
83 if (of_get_property(ep, "reg", NULL))
86 node = of_get_parent(ep);
87 reg = of_get_property(node, "reg", NULL);
92 node = of_graph_get_port_parent(ep);
95 * Non HDMI sound case, counting port/endpoint on its DT
96 * is enough. Let's count it.
100 for_each_endpoint_of_node(node, endpoint) {
114 static bool soc_component_is_pcm(struct snd_soc_dai_link_component *dlc)
116 struct snd_soc_dai *dai = snd_soc_find_dai_with_mutex(dlc);
118 if (dai && (dai->component->driver->pcm_construct ||
119 dai->driver->pcm_new))
125 static int asoc_simple_parse_dai(struct device_node *ep,
126 struct snd_soc_dai_link_component *dlc,
129 struct device_node *node;
130 struct of_phandle_args args;
136 node = of_graph_get_port_parent(ep);
140 args.args[0] = graph_get_dai_id(ep);
141 args.args_count = (of_graph_get_endpoint_count(node) > 1);
146 * Here, dlc->dai_name is pointer to CPU/Codec DAI name.
147 * If user unbinded CPU or Codec driver, but not for Sound Card,
148 * dlc->dai_name is keeping unbinded CPU or Codec
151 * If user re-bind CPU or Codec driver again, ALSA SoC will try
152 * to rebind Card via snd_soc_try_rebind_card(), but because of
153 * above reason, it might can't bind Sound Card.
154 * Because Sound Card is pointing to released dai_name pointer.
156 * To avoid this rebind Card issue,
157 * 1) It needs to alloc memory to keep dai_name eventhough
158 * CPU or Codec driver was unbinded, or
159 * 2) user need to rebind Sound Card everytime
160 * if he unbinded CPU or Codec.
162 ret = snd_soc_get_dai_name(&args, &dlc->dai_name);
169 *is_single_link = of_graph_get_endpoint_count(node) == 1;
174 static void graph_parse_convert(struct device *dev,
175 struct device_node *ep,
176 struct asoc_simple_data *adata)
178 struct device_node *top = dev->of_node;
179 struct device_node *port = of_get_parent(ep);
180 struct device_node *ports = of_get_parent(port);
181 struct device_node *node = of_graph_get_port_parent(ep);
183 asoc_simple_parse_convert(dev, top, NULL, adata);
184 asoc_simple_parse_convert(dev, node, PREFIX, adata);
185 asoc_simple_parse_convert(dev, ports, NULL, adata);
186 asoc_simple_parse_convert(dev, port, NULL, adata);
187 asoc_simple_parse_convert(dev, ep, NULL, adata);
194 static void graph_parse_mclk_fs(struct device_node *top,
195 struct device_node *ep,
196 struct simple_dai_props *props)
198 struct device_node *port = of_get_parent(ep);
199 struct device_node *ports = of_get_parent(port);
200 struct device_node *node = of_graph_get_port_parent(ep);
202 of_property_read_u32(top, "mclk-fs", &props->mclk_fs);
203 of_property_read_u32(ports, "mclk-fs", &props->mclk_fs);
204 of_property_read_u32(port, "mclk-fs", &props->mclk_fs);
205 of_property_read_u32(ep, "mclk-fs", &props->mclk_fs);
212 static int graph_dai_link_of_dpcm(struct asoc_simple_priv *priv,
213 struct device_node *cpu_ep,
214 struct device_node *codec_ep,
215 struct link_info *li)
217 struct device *dev = simple_priv_to_dev(priv);
218 struct snd_soc_card *card = simple_priv_to_card(priv);
219 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
220 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
221 struct device_node *top = dev->of_node;
222 struct device_node *ep = li->cpu ? cpu_ep : codec_ep;
223 struct device_node *port;
224 struct device_node *ports;
225 struct device_node *node;
226 struct asoc_simple_dai *dai;
227 struct snd_soc_dai_link_component *cpus = dai_link->cpus;
228 struct snd_soc_dai_link_component *codecs = dai_link->codecs;
231 port = of_get_parent(ep);
232 ports = of_get_parent(port);
233 node = of_graph_get_port_parent(ep);
237 dev_dbg(dev, "link_of DPCM (%pOF)\n", ep);
240 int is_single_links = 0;
245 dai_link->dynamic = 1;
246 dai_link->dpcm_merged_format = 1;
249 dai_props->cpu_dai = &priv->dais[li->dais++];
251 ret = asoc_simple_parse_cpu(ep, dai_link, &is_single_links);
255 ret = asoc_simple_parse_clk_cpu(dev, ep, dai_link, dai);
259 ret = asoc_simple_set_dailink_name(dev, dai_link,
267 * In BE<->BE connections it is not required to create
268 * PCM devices at CPU end of the dai link and thus 'no_pcm'
269 * flag needs to be set. It is useful when there are many
270 * BE components and some of these have to be connected to
271 * form a valid audio path.
273 * For example: FE <-> BE1 <-> BE2 <-> ... <-> BEn where
274 * there are 'n' BE components in the path.
276 if (card->component_chaining && !soc_component_is_pcm(cpus))
277 dai_link->no_pcm = 1;
279 /* card->num_links includes Codec */
280 asoc_simple_canonicalize_cpu(dai_link, is_single_links);
281 asoc_simple_canonicalize_platform(dai_link);
283 struct snd_soc_codec_conf *cconf;
288 dai_link->no_pcm = 1;
289 dai_link->be_hw_params_fixup = asoc_simple_be_hw_params_fixup;
292 dai_props->codec_dai = &priv->dais[li->dais++];
295 dai_props->codec_conf = &priv->codec_conf[li->conf++];
297 ret = asoc_simple_parse_codec(ep, dai_link);
301 ret = asoc_simple_parse_clk_codec(dev, ep, dai_link, dai);
305 ret = asoc_simple_set_dailink_name(dev, dai_link,
312 /* check "prefix" from top node */
313 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node,
315 snd_soc_of_parse_node_prefix(node, cconf, codecs->of_node,
317 snd_soc_of_parse_node_prefix(ports, cconf, codecs->of_node,
319 snd_soc_of_parse_node_prefix(port, cconf, codecs->of_node,
323 graph_parse_convert(dev, ep, &dai_props->adata);
324 graph_parse_mclk_fs(top, ep, dai_props);
326 ret = asoc_simple_parse_tdm(ep, dai);
330 ret = asoc_simple_parse_daifmt(dev, cpu_ep, codec_ep,
331 NULL, &dai_link->dai_fmt);
335 snd_soc_dai_link_set_capabilities(dai_link);
337 dai_link->ops = &graph_ops;
339 /* Use custom snd_soc_ops callbacks if available */
341 dai_link->ops = priv->ops;
343 dai_link->init = asoc_simple_dai_init;
352 static int graph_dai_link_of(struct asoc_simple_priv *priv,
353 struct device_node *cpu_ep,
354 struct device_node *codec_ep,
355 struct link_info *li)
357 struct device *dev = simple_priv_to_dev(priv);
358 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
359 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
360 struct device_node *top = dev->of_node;
361 struct asoc_simple_dai *cpu_dai;
362 struct asoc_simple_dai *codec_dai;
363 int ret, single_cpu = 0;
365 dev_dbg(dev, "link_of (%pOF)\n", cpu_ep);
370 dai_props->cpu_dai = &priv->dais[li->dais++];
372 dai_props->codec_dai = &priv->dais[li->dais++];
374 /* Factor to mclk, used in hw_params() */
375 graph_parse_mclk_fs(top, cpu_ep, dai_props);
376 graph_parse_mclk_fs(top, codec_ep, dai_props);
378 ret = asoc_simple_parse_daifmt(dev, cpu_ep, codec_ep,
379 NULL, &dai_link->dai_fmt);
383 ret = asoc_simple_parse_cpu(cpu_ep, dai_link, &single_cpu);
387 ret = asoc_simple_parse_codec(codec_ep, dai_link);
391 ret = asoc_simple_parse_tdm(cpu_ep, cpu_dai);
395 ret = asoc_simple_parse_tdm(codec_ep, codec_dai);
399 ret = asoc_simple_parse_clk_cpu(dev, cpu_ep, dai_link, cpu_dai);
403 ret = asoc_simple_parse_clk_codec(dev, codec_ep, dai_link, codec_dai);
407 ret = asoc_simple_set_dailink_name(dev, dai_link,
409 dai_link->cpus->dai_name,
410 dai_link->codecs->dai_name);
414 dai_link->ops = &graph_ops;
415 dai_link->init = asoc_simple_dai_init;
417 asoc_simple_canonicalize_cpu(dai_link, single_cpu);
418 asoc_simple_canonicalize_platform(dai_link);
423 static inline bool parse_as_dpcm_link(struct asoc_simple_priv *priv,
424 struct device_node *codec_port,
425 struct asoc_simple_data *adata)
427 if (priv->force_dpcm)
430 if (!priv->dpcm_selectable)
435 * if Codec port has many endpoints,
436 * or has convert-xxx property
438 if ((of_get_child_count(codec_port) > 1) ||
439 (adata->convert_rate || adata->convert_channels))
445 static int __graph_for_each_link(struct asoc_simple_priv *priv,
446 struct link_info *li,
447 int (*func_noml)(struct asoc_simple_priv *priv,
448 struct device_node *cpu_ep,
449 struct device_node *codec_ep,
450 struct link_info *li),
451 int (*func_dpcm)(struct asoc_simple_priv *priv,
452 struct device_node *cpu_ep,
453 struct device_node *codec_ep,
454 struct link_info *li))
456 struct of_phandle_iterator it;
457 struct device *dev = simple_priv_to_dev(priv);
458 struct device_node *node = dev->of_node;
459 struct device_node *cpu_port;
460 struct device_node *cpu_ep;
461 struct device_node *codec_ep;
462 struct device_node *codec_port;
463 struct device_node *codec_port_old = NULL;
464 struct asoc_simple_data adata;
467 /* loop for all listed CPU port */
468 of_for_each_phandle(&it, rc, node, "dais", NULL, 0) {
472 /* loop for all CPU endpoint */
474 cpu_ep = of_get_next_child(cpu_port, cpu_ep);
479 codec_ep = of_graph_get_remote_endpoint(cpu_ep);
480 codec_port = of_get_parent(codec_ep);
482 /* get convert-xxx property */
483 memset(&adata, 0, sizeof(adata));
484 graph_parse_convert(dev, codec_ep, &adata);
485 graph_parse_convert(dev, cpu_ep, &adata);
487 /* check if link requires DPCM parsing */
488 if (parse_as_dpcm_link(priv, codec_port, &adata)) {
490 * Codec endpoint can be NULL for pluggable audio HW.
491 * Platform DT can populate the Codec endpoint depending on the
494 /* Do it all CPU endpoint, and 1st Codec endpoint */
496 ((codec_port_old != codec_port) && codec_ep))
497 ret = func_dpcm(priv, cpu_ep, codec_ep, li);
498 /* else normal sound */
501 ret = func_noml(priv, cpu_ep, codec_ep, li);
504 of_node_put(codec_ep);
505 of_node_put(codec_port);
510 codec_port_old = codec_port;
517 static int graph_for_each_link(struct asoc_simple_priv *priv,
518 struct link_info *li,
519 int (*func_noml)(struct asoc_simple_priv *priv,
520 struct device_node *cpu_ep,
521 struct device_node *codec_ep,
522 struct link_info *li),
523 int (*func_dpcm)(struct asoc_simple_priv *priv,
524 struct device_node *cpu_ep,
525 struct device_node *codec_ep,
526 struct link_info *li))
530 * Detect all CPU first, and Detect all Codec 2nd.
532 * In Normal sound case, all DAIs are detected
535 * In DPCM sound case,
536 * all CPUs are detected as "CPU-dummy", and
537 * all Codecs are detected as "dummy-Codec".
538 * To avoid random sub-device numbering,
539 * detect "dummy-Codec" in last;
541 for (li->cpu = 1; li->cpu >= 0; li->cpu--) {
542 ret = __graph_for_each_link(priv, li, func_noml, func_dpcm);
550 static void graph_get_dais_count(struct asoc_simple_priv *priv,
551 struct link_info *li);
553 int audio_graph_parse_of(struct asoc_simple_priv *priv, struct device *dev)
555 struct snd_soc_card *card = simple_priv_to_card(priv);
559 card->owner = THIS_MODULE;
562 memset(&li, 0, sizeof(li));
563 graph_get_dais_count(priv, &li);
564 if (!li.link || !li.dais)
567 ret = asoc_simple_init_priv(priv, &li);
571 priv->pa_gpio = devm_gpiod_get_optional(dev, "pa", GPIOD_OUT_LOW);
572 if (IS_ERR(priv->pa_gpio)) {
573 ret = PTR_ERR(priv->pa_gpio);
574 dev_err(dev, "failed to get amplifier gpio: %d\n", ret);
578 ret = asoc_simple_parse_widgets(card, NULL);
582 ret = asoc_simple_parse_routing(card, NULL);
586 memset(&li, 0, sizeof(li));
587 ret = graph_for_each_link(priv, &li,
589 graph_dai_link_of_dpcm);
593 ret = asoc_simple_parse_card_name(card, NULL);
597 snd_soc_card_set_drvdata(card, priv);
599 asoc_simple_debug_info(priv);
601 ret = devm_snd_soc_register_card(dev, card);
608 asoc_simple_clean_reference(card);
610 if (ret != -EPROBE_DEFER)
611 dev_err(dev, "parse error %d\n", ret);
615 EXPORT_SYMBOL_GPL(audio_graph_parse_of);
617 static int graph_count_noml(struct asoc_simple_priv *priv,
618 struct device_node *cpu_ep,
619 struct device_node *codec_ep,
620 struct link_info *li)
622 struct device *dev = simple_priv_to_dev(priv);
624 if (li->link >= SNDRV_MINOR_DEVICES) {
625 dev_err(dev, "too many links\n");
629 li->num[li->link].cpus = 1;
630 li->num[li->link].codecs = 1;
631 li->num[li->link].platforms = 1;
633 li->link += 1; /* 1xCPU-Codec */
634 li->dais += 2; /* 1xCPU + 1xCodec */
636 dev_dbg(dev, "Count As Normal\n");
641 static int graph_count_dpcm(struct asoc_simple_priv *priv,
642 struct device_node *cpu_ep,
643 struct device_node *codec_ep,
644 struct link_info *li)
646 struct device *dev = simple_priv_to_dev(priv);
648 if (li->link >= SNDRV_MINOR_DEVICES) {
649 dev_err(dev, "too many links\n");
654 li->num[li->link].cpus = 1;
655 li->num[li->link].platforms = 1;
657 li->link++; /* 1xCPU-dummy */
658 li->dais++; /* 1xCPU */
660 li->num[li->link].codecs = 1;
662 li->link++; /* 1xdummy-Codec */
663 li->conf++; /* 1xdummy-Codec */
664 li->dais++; /* 1xCodec */
667 dev_dbg(dev, "Count As DPCM\n");
672 static void graph_get_dais_count(struct asoc_simple_priv *priv,
673 struct link_info *li)
675 struct device *dev = simple_priv_to_dev(priv);
678 * link_num : number of links.
679 * CPU-Codec / CPU-dummy / dummy-Codec
680 * dais_num : number of DAIs
681 * ccnf_num : number of codec_conf
682 * same number for "dummy-Codec"
685 * CPU0 --- Codec0 link : 5
686 * CPU1 --- Codec1 dais : 7
690 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
691 * => 7 DAIs = 4xCPU + 3xCodec
692 * => 1 ccnf = 1xdummy-Codec
695 * CPU0 --- Codec0 link : 5
696 * CPU1 --- Codec1 dais : 6
700 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
701 * => 6 DAIs = 4xCPU + 2xCodec
702 * => 1 ccnf = 1xdummy-Codec
705 * CPU0 --- Codec0 link : 6
707 * CPU2 --- Codec1 ccnf : 2
710 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
711 * => 6 DAIs = 4xCPU + 2xCodec
712 * => 2 ccnf = 2xdummy-Codec
715 * CPU0 --- Codec0 (convert-rate) link : 3
716 * CPU1 --- Codec1 dais : 4
719 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
720 * => 4 DAIs = 2xCPU + 2xCodec
721 * => 1 ccnf = 1xdummy-Codec
723 graph_for_each_link(priv, li,
726 dev_dbg(dev, "link %d, dais %d, ccnf %d\n",
727 li->link, li->dais, li->conf);
730 int audio_graph_card_probe(struct snd_soc_card *card)
732 struct asoc_simple_priv *priv = snd_soc_card_get_drvdata(card);
735 ret = asoc_simple_init_hp(card, &priv->hp_jack, NULL);
739 ret = asoc_simple_init_mic(card, &priv->mic_jack, NULL);
745 EXPORT_SYMBOL_GPL(audio_graph_card_probe);
747 static int graph_probe(struct platform_device *pdev)
749 struct asoc_simple_priv *priv;
750 struct device *dev = &pdev->dev;
751 struct snd_soc_card *card;
753 /* Allocate the private data and the DAI link array */
754 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
758 card = simple_priv_to_card(priv);
759 card->dapm_widgets = graph_dapm_widgets;
760 card->num_dapm_widgets = ARRAY_SIZE(graph_dapm_widgets);
761 card->probe = audio_graph_card_probe;
763 if (of_device_get_match_data(dev))
764 priv->dpcm_selectable = 1;
766 return audio_graph_parse_of(priv, dev);
769 int audio_graph_remove(struct platform_device *pdev)
771 struct snd_soc_card *card = platform_get_drvdata(pdev);
773 return asoc_simple_clean_reference(card);
775 EXPORT_SYMBOL_GPL(audio_graph_remove);
777 static const struct of_device_id graph_of_match[] = {
778 { .compatible = "audio-graph-card", },
779 { .compatible = "audio-graph-scu-card",
780 .data = (void *)DPCM_SELECTABLE },
783 MODULE_DEVICE_TABLE(of, graph_of_match);
785 static struct platform_driver graph_card = {
787 .name = "asoc-audio-graph-card",
788 .pm = &snd_soc_pm_ops,
789 .of_match_table = graph_of_match,
791 .probe = graph_probe,
792 .remove = audio_graph_remove,
794 module_platform_driver(graph_card);
796 MODULE_ALIAS("platform:asoc-audio-graph-card");
797 MODULE_LICENSE("GPL v2");
798 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card");
799 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");