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 static int graph_outdrv_event(struct snd_soc_dapm_widget *w,
26 struct snd_kcontrol *kcontrol,
29 struct snd_soc_dapm_context *dapm = w->dapm;
30 struct asoc_simple_priv *priv = snd_soc_card_get_drvdata(dapm->card);
33 case SND_SOC_DAPM_POST_PMU:
34 gpiod_set_value_cansleep(priv->pa_gpio, 1);
36 case SND_SOC_DAPM_PRE_PMD:
37 gpiod_set_value_cansleep(priv->pa_gpio, 0);
46 static const struct snd_soc_dapm_widget graph_dapm_widgets[] = {
47 SND_SOC_DAPM_OUT_DRV_E("Amplifier", SND_SOC_NOPM,
48 0, 0, NULL, 0, graph_outdrv_event,
49 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
52 static const struct snd_soc_ops graph_ops = {
53 .startup = asoc_simple_startup,
54 .shutdown = asoc_simple_shutdown,
55 .hw_params = asoc_simple_hw_params,
58 static int graph_get_dai_id(struct device_node *ep)
60 struct device_node *node;
61 struct device_node *endpoint;
62 struct of_endpoint info;
67 /* use driver specified DAI ID if exist */
68 ret = snd_soc_get_dai_id(ep);
72 /* use endpoint/port reg if exist */
73 ret = of_graph_parse_endpoint(ep, &info);
76 * Because it will count port/endpoint if it doesn't have "reg".
77 * But, we can't judge whether it has "no reg", or "reg = <0>"
78 * only of_graph_parse_endpoint().
79 * We need to check "reg" property
81 if (of_get_property(ep, "reg", NULL))
84 node = of_get_parent(ep);
85 reg = of_get_property(node, "reg", NULL);
90 node = of_graph_get_port_parent(ep);
93 * Non HDMI sound case, counting port/endpoint on its DT
94 * is enough. Let's count it.
98 for_each_endpoint_of_node(node, endpoint) {
112 static bool soc_component_is_pcm(struct snd_soc_dai_link_component *dlc)
114 struct snd_soc_dai *dai = snd_soc_find_dai_with_mutex(dlc);
116 if (dai && (dai->component->driver->pcm_construct ||
117 dai->driver->pcm_new))
123 static int asoc_simple_parse_dai(struct device_node *ep,
124 struct snd_soc_dai_link_component *dlc,
127 struct device_node *node;
128 struct of_phandle_args args;
134 node = of_graph_get_port_parent(ep);
138 args.args[0] = graph_get_dai_id(ep);
139 args.args_count = (of_graph_get_endpoint_count(node) > 1);
144 * Here, dlc->dai_name is pointer to CPU/Codec DAI name.
145 * If user unbinded CPU or Codec driver, but not for Sound Card,
146 * dlc->dai_name is keeping unbinded CPU or Codec
149 * If user re-bind CPU or Codec driver again, ALSA SoC will try
150 * to rebind Card via snd_soc_try_rebind_card(), but because of
151 * above reason, it might can't bind Sound Card.
152 * Because Sound Card is pointing to released dai_name pointer.
154 * To avoid this rebind Card issue,
155 * 1) It needs to alloc memory to keep dai_name eventhough
156 * CPU or Codec driver was unbinded, or
157 * 2) user need to rebind Sound Card everytime
158 * if he unbinded CPU or Codec.
160 ret = snd_soc_get_dai_name(&args, &dlc->dai_name);
167 *is_single_link = of_graph_get_endpoint_count(node) == 1;
172 static void graph_parse_convert(struct device *dev,
173 struct device_node *ep,
174 struct asoc_simple_data *adata)
176 struct device_node *top = dev->of_node;
177 struct device_node *port = of_get_parent(ep);
178 struct device_node *ports = of_get_parent(port);
179 struct device_node *node = of_graph_get_port_parent(ep);
181 asoc_simple_parse_convert(top, NULL, adata);
182 if (of_node_name_eq(ports, "ports"))
183 asoc_simple_parse_convert(ports, NULL, adata);
184 asoc_simple_parse_convert(port, NULL, adata);
185 asoc_simple_parse_convert(ep, NULL, adata);
192 static void graph_parse_mclk_fs(struct device_node *top,
193 struct device_node *ep,
194 struct simple_dai_props *props)
196 struct device_node *port = of_get_parent(ep);
197 struct device_node *ports = of_get_parent(port);
199 of_property_read_u32(top, "mclk-fs", &props->mclk_fs);
200 if (of_node_name_eq(ports, "ports"))
201 of_property_read_u32(ports, "mclk-fs", &props->mclk_fs);
202 of_property_read_u32(port, "mclk-fs", &props->mclk_fs);
203 of_property_read_u32(ep, "mclk-fs", &props->mclk_fs);
209 static int graph_parse_node(struct asoc_simple_priv *priv,
210 struct device_node *ep,
211 struct link_info *li,
214 struct device *dev = simple_priv_to_dev(priv);
215 struct device_node *top = dev->of_node;
216 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
217 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
218 struct snd_soc_dai_link_component *dlc;
219 struct asoc_simple_dai *dai;
223 dlc = asoc_link_to_cpu(dai_link, 0);
224 dai = simple_props_to_dai_cpu(dai_props, 0);
226 dlc = asoc_link_to_codec(dai_link, 0);
227 dai = simple_props_to_dai_codec(dai_props, 0);
230 graph_parse_mclk_fs(top, ep, dai_props);
232 ret = asoc_simple_parse_dai(ep, dlc, cpu);
236 ret = asoc_simple_parse_tdm(ep, dai);
240 ret = asoc_simple_parse_clk(dev, ep, dai, dlc);
247 static int graph_link_init(struct asoc_simple_priv *priv,
248 struct device_node *cpu_ep,
249 struct device_node *codec_ep,
250 struct link_info *li,
253 struct device *dev = simple_priv_to_dev(priv);
254 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
257 ret = asoc_simple_parse_daifmt(dev, cpu_ep, codec_ep,
258 NULL, &dai_link->dai_fmt);
262 dai_link->init = asoc_simple_dai_init;
263 dai_link->ops = &graph_ops;
265 dai_link->ops = priv->ops;
267 return asoc_simple_set_dailink_name(dev, dai_link, name);
270 static int graph_dai_link_of_dpcm(struct asoc_simple_priv *priv,
271 struct device_node *cpu_ep,
272 struct device_node *codec_ep,
273 struct link_info *li)
275 struct device *dev = simple_priv_to_dev(priv);
276 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
277 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
278 struct device_node *top = dev->of_node;
279 struct device_node *ep = li->cpu ? cpu_ep : codec_ep;
283 dev_dbg(dev, "link_of DPCM (%pOF)\n", ep);
286 struct snd_soc_card *card = simple_priv_to_card(priv);
287 struct snd_soc_dai_link_component *cpus = asoc_link_to_cpu(dai_link, 0);
288 struct snd_soc_dai_link_component *platforms = asoc_link_to_platform(dai_link, 0);
289 int is_single_links = 0;
294 dai_link->dynamic = 1;
295 dai_link->dpcm_merged_format = 1;
297 ret = graph_parse_node(priv, cpu_ep, li, &is_single_links);
301 snprintf(dai_name, sizeof(dai_name),
302 "fe.%pOFP.%s", cpus->of_node, cpus->dai_name);
304 * In BE<->BE connections it is not required to create
305 * PCM devices at CPU end of the dai link and thus 'no_pcm'
306 * flag needs to be set. It is useful when there are many
307 * BE components and some of these have to be connected to
308 * form a valid audio path.
310 * For example: FE <-> BE1 <-> BE2 <-> ... <-> BEn where
311 * there are 'n' BE components in the path.
313 if (card->component_chaining && !soc_component_is_pcm(cpus)) {
314 dai_link->no_pcm = 1;
315 dai_link->be_hw_params_fixup = asoc_simple_be_hw_params_fixup;
318 asoc_simple_canonicalize_cpu(cpus, is_single_links);
319 asoc_simple_canonicalize_platform(platforms, cpus);
321 struct snd_soc_codec_conf *cconf = simple_props_to_codec_conf(dai_props, 0);
322 struct snd_soc_dai_link_component *codecs = asoc_link_to_codec(dai_link, 0);
323 struct device_node *port;
324 struct device_node *ports;
329 dai_link->no_pcm = 1;
330 dai_link->be_hw_params_fixup = asoc_simple_be_hw_params_fixup;
332 ret = graph_parse_node(priv, codec_ep, li, NULL);
336 snprintf(dai_name, sizeof(dai_name),
337 "be.%pOFP.%s", codecs->of_node, codecs->dai_name);
339 /* check "prefix" from top node */
340 port = of_get_parent(ep);
341 ports = of_get_parent(port);
342 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node,
344 if (of_node_name_eq(ports, "ports"))
345 snd_soc_of_parse_node_prefix(ports, cconf, codecs->of_node, "prefix");
346 snd_soc_of_parse_node_prefix(port, cconf, codecs->of_node,
353 graph_parse_convert(dev, ep, &dai_props->adata);
355 snd_soc_dai_link_set_capabilities(dai_link);
357 ret = graph_link_init(priv, cpu_ep, codec_ep, li, dai_name);
364 static int graph_dai_link_of(struct asoc_simple_priv *priv,
365 struct device_node *cpu_ep,
366 struct device_node *codec_ep,
367 struct link_info *li)
369 struct device *dev = simple_priv_to_dev(priv);
370 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
371 struct snd_soc_dai_link_component *cpus = asoc_link_to_cpu(dai_link, 0);
372 struct snd_soc_dai_link_component *codecs = asoc_link_to_codec(dai_link, 0);
373 struct snd_soc_dai_link_component *platforms = asoc_link_to_platform(dai_link, 0);
375 int ret, is_single_links = 0;
377 dev_dbg(dev, "link_of (%pOF)\n", cpu_ep);
379 ret = graph_parse_node(priv, cpu_ep, li, &is_single_links);
383 ret = graph_parse_node(priv, codec_ep, li, NULL);
387 snprintf(dai_name, sizeof(dai_name),
388 "%s-%s", cpus->dai_name, codecs->dai_name);
390 asoc_simple_canonicalize_cpu(cpus, is_single_links);
391 asoc_simple_canonicalize_platform(platforms, cpus);
393 ret = graph_link_init(priv, cpu_ep, codec_ep, li, dai_name);
402 static inline bool parse_as_dpcm_link(struct asoc_simple_priv *priv,
403 struct device_node *codec_port,
404 struct asoc_simple_data *adata)
406 if (priv->force_dpcm)
409 if (!priv->dpcm_selectable)
414 * if Codec port has many endpoints,
415 * or has convert-xxx property
417 if ((of_get_child_count(codec_port) > 1) ||
418 (adata->convert_rate || adata->convert_channels))
424 static int __graph_for_each_link(struct asoc_simple_priv *priv,
425 struct link_info *li,
426 int (*func_noml)(struct asoc_simple_priv *priv,
427 struct device_node *cpu_ep,
428 struct device_node *codec_ep,
429 struct link_info *li),
430 int (*func_dpcm)(struct asoc_simple_priv *priv,
431 struct device_node *cpu_ep,
432 struct device_node *codec_ep,
433 struct link_info *li))
435 struct of_phandle_iterator it;
436 struct device *dev = simple_priv_to_dev(priv);
437 struct device_node *node = dev->of_node;
438 struct device_node *cpu_port;
439 struct device_node *cpu_ep;
440 struct device_node *codec_ep;
441 struct device_node *codec_port;
442 struct device_node *codec_port_old = NULL;
443 struct asoc_simple_data adata;
446 /* loop for all listed CPU port */
447 of_for_each_phandle(&it, rc, node, "dais", NULL, 0) {
451 /* loop for all CPU endpoint */
453 cpu_ep = of_get_next_child(cpu_port, cpu_ep);
458 codec_ep = of_graph_get_remote_endpoint(cpu_ep);
459 codec_port = of_get_parent(codec_ep);
461 /* get convert-xxx property */
462 memset(&adata, 0, sizeof(adata));
463 graph_parse_convert(dev, codec_ep, &adata);
464 graph_parse_convert(dev, cpu_ep, &adata);
466 /* check if link requires DPCM parsing */
467 if (parse_as_dpcm_link(priv, codec_port, &adata)) {
469 * Codec endpoint can be NULL for pluggable audio HW.
470 * Platform DT can populate the Codec endpoint depending on the
473 /* Do it all CPU endpoint, and 1st Codec endpoint */
475 ((codec_port_old != codec_port) && codec_ep))
476 ret = func_dpcm(priv, cpu_ep, codec_ep, li);
477 /* else normal sound */
480 ret = func_noml(priv, cpu_ep, codec_ep, li);
483 of_node_put(codec_ep);
484 of_node_put(codec_port);
489 codec_port_old = codec_port;
496 static int graph_for_each_link(struct asoc_simple_priv *priv,
497 struct link_info *li,
498 int (*func_noml)(struct asoc_simple_priv *priv,
499 struct device_node *cpu_ep,
500 struct device_node *codec_ep,
501 struct link_info *li),
502 int (*func_dpcm)(struct asoc_simple_priv *priv,
503 struct device_node *cpu_ep,
504 struct device_node *codec_ep,
505 struct link_info *li))
509 * Detect all CPU first, and Detect all Codec 2nd.
511 * In Normal sound case, all DAIs are detected
514 * In DPCM sound case,
515 * all CPUs are detected as "CPU-dummy", and
516 * all Codecs are detected as "dummy-Codec".
517 * To avoid random sub-device numbering,
518 * detect "dummy-Codec" in last;
520 for (li->cpu = 1; li->cpu >= 0; li->cpu--) {
521 ret = __graph_for_each_link(priv, li, func_noml, func_dpcm);
529 static int graph_get_dais_count(struct asoc_simple_priv *priv,
530 struct link_info *li);
532 int audio_graph_parse_of(struct asoc_simple_priv *priv, struct device *dev)
534 struct snd_soc_card *card = simple_priv_to_card(priv);
535 struct link_info *li;
538 li = devm_kzalloc(dev, sizeof(*li), GFP_KERNEL);
542 card->owner = THIS_MODULE;
545 ret = graph_get_dais_count(priv, li);
552 ret = asoc_simple_init_priv(priv, li);
556 priv->pa_gpio = devm_gpiod_get_optional(dev, "pa", GPIOD_OUT_LOW);
557 if (IS_ERR(priv->pa_gpio)) {
558 ret = PTR_ERR(priv->pa_gpio);
559 dev_err(dev, "failed to get amplifier gpio: %d\n", ret);
563 ret = asoc_simple_parse_widgets(card, NULL);
567 ret = asoc_simple_parse_routing(card, NULL);
571 memset(li, 0, sizeof(*li));
572 ret = graph_for_each_link(priv, li,
574 graph_dai_link_of_dpcm);
578 ret = asoc_simple_parse_card_name(card, NULL);
582 snd_soc_card_set_drvdata(card, priv);
584 asoc_simple_debug_info(priv);
586 ret = devm_snd_soc_register_card(dev, card);
594 asoc_simple_clean_reference(card);
596 return dev_err_probe(dev, ret, "parse error\n");
598 EXPORT_SYMBOL_GPL(audio_graph_parse_of);
600 static int graph_count_noml(struct asoc_simple_priv *priv,
601 struct device_node *cpu_ep,
602 struct device_node *codec_ep,
603 struct link_info *li)
605 struct device *dev = simple_priv_to_dev(priv);
607 if (li->link >= SNDRV_MAX_LINKS) {
608 dev_err(dev, "too many links\n");
612 li->num[li->link].cpus = 1;
613 li->num[li->link].codecs = 1;
614 li->num[li->link].platforms = 1;
616 li->link += 1; /* 1xCPU-Codec */
618 dev_dbg(dev, "Count As Normal\n");
623 static int graph_count_dpcm(struct asoc_simple_priv *priv,
624 struct device_node *cpu_ep,
625 struct device_node *codec_ep,
626 struct link_info *li)
628 struct device *dev = simple_priv_to_dev(priv);
630 if (li->link >= SNDRV_MAX_LINKS) {
631 dev_err(dev, "too many links\n");
636 li->num[li->link].cpus = 1;
637 li->num[li->link].platforms = 1;
639 li->link++; /* 1xCPU-dummy */
641 li->num[li->link].codecs = 1;
643 li->link++; /* 1xdummy-Codec */
646 dev_dbg(dev, "Count As DPCM\n");
651 static int graph_get_dais_count(struct asoc_simple_priv *priv,
652 struct link_info *li)
655 * link_num : number of links.
656 * CPU-Codec / CPU-dummy / dummy-Codec
657 * dais_num : number of DAIs
658 * ccnf_num : number of codec_conf
659 * same number for "dummy-Codec"
662 * CPU0 --- Codec0 link : 5
663 * CPU1 --- Codec1 dais : 7
667 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
668 * => 7 DAIs = 4xCPU + 3xCodec
669 * => 1 ccnf = 1xdummy-Codec
672 * CPU0 --- Codec0 link : 5
673 * CPU1 --- Codec1 dais : 6
677 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
678 * => 6 DAIs = 4xCPU + 2xCodec
679 * => 1 ccnf = 1xdummy-Codec
682 * CPU0 --- Codec0 link : 6
684 * CPU2 --- Codec1 ccnf : 2
687 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
688 * => 6 DAIs = 4xCPU + 2xCodec
689 * => 2 ccnf = 2xdummy-Codec
692 * CPU0 --- Codec0 (convert-rate) link : 3
693 * CPU1 --- Codec1 dais : 4
696 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
697 * => 4 DAIs = 2xCPU + 2xCodec
698 * => 1 ccnf = 1xdummy-Codec
700 return graph_for_each_link(priv, li,
705 static int graph_probe(struct platform_device *pdev)
707 struct asoc_simple_priv *priv;
708 struct device *dev = &pdev->dev;
709 struct snd_soc_card *card;
711 /* Allocate the private data and the DAI link array */
712 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
716 card = simple_priv_to_card(priv);
717 card->dapm_widgets = graph_dapm_widgets;
718 card->num_dapm_widgets = ARRAY_SIZE(graph_dapm_widgets);
719 card->probe = asoc_graph_card_probe;
721 if (of_device_get_match_data(dev))
722 priv->dpcm_selectable = 1;
724 return audio_graph_parse_of(priv, dev);
727 static const struct of_device_id graph_of_match[] = {
728 { .compatible = "audio-graph-card", },
729 { .compatible = "audio-graph-scu-card",
730 .data = (void *)DPCM_SELECTABLE },
733 MODULE_DEVICE_TABLE(of, graph_of_match);
735 static struct platform_driver graph_card = {
737 .name = "asoc-audio-graph-card",
738 .pm = &snd_soc_pm_ops,
739 .of_match_table = graph_of_match,
741 .probe = graph_probe,
742 .remove = asoc_simple_remove,
744 module_platform_driver(graph_card);
746 MODULE_ALIAS("platform:asoc-audio-graph-card");
747 MODULE_LICENSE("GPL v2");
748 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card");
749 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");