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/simple_card_utils.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 int asoc_simple_parse_dai(struct device_node *ep,
115 struct snd_soc_dai_link_component *dlc,
118 struct device_node *node;
119 struct of_phandle_args args;
125 node = of_graph_get_port_parent(ep);
129 args.args[0] = graph_get_dai_id(ep);
130 args.args_count = (of_graph_get_endpoint_count(node) > 1);
132 ret = snd_soc_get_dai_name(&args, &dlc->dai_name);
139 *is_single_link = of_graph_get_endpoint_count(node) == 1;
144 static void graph_parse_convert(struct device *dev,
145 struct device_node *ep,
146 struct asoc_simple_data *adata)
148 struct device_node *top = dev->of_node;
149 struct device_node *port = of_get_parent(ep);
150 struct device_node *ports = of_get_parent(port);
151 struct device_node *node = of_graph_get_port_parent(ep);
153 asoc_simple_parse_convert(dev, top, NULL, adata);
154 asoc_simple_parse_convert(dev, node, PREFIX, adata);
155 asoc_simple_parse_convert(dev, ports, NULL, adata);
156 asoc_simple_parse_convert(dev, port, NULL, adata);
157 asoc_simple_parse_convert(dev, ep, NULL, adata);
164 static void graph_parse_mclk_fs(struct device_node *top,
165 struct device_node *ep,
166 struct simple_dai_props *props)
168 struct device_node *port = of_get_parent(ep);
169 struct device_node *ports = of_get_parent(port);
170 struct device_node *node = of_graph_get_port_parent(ep);
172 of_property_read_u32(top, "mclk-fs", &props->mclk_fs);
173 of_property_read_u32(ports, "mclk-fs", &props->mclk_fs);
174 of_property_read_u32(port, "mclk-fs", &props->mclk_fs);
175 of_property_read_u32(ep, "mclk-fs", &props->mclk_fs);
182 static int graph_dai_link_of_dpcm(struct asoc_simple_priv *priv,
183 struct device_node *cpu_ep,
184 struct device_node *codec_ep,
185 struct link_info *li,
188 struct device *dev = simple_priv_to_dev(priv);
189 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
190 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
191 struct device_node *top = dev->of_node;
192 struct device_node *ep = li->cpu ? cpu_ep : codec_ep;
193 struct device_node *port;
194 struct device_node *ports;
195 struct device_node *node;
196 struct asoc_simple_dai *dai;
197 struct snd_soc_dai_link_component *cpus = dai_link->cpus;
198 struct snd_soc_dai_link_component *codecs = dai_link->codecs;
201 /* Do it all CPU endpoint, and 1st Codec endpoint */
202 if (!li->cpu && dup_codec)
205 port = of_get_parent(ep);
206 ports = of_get_parent(port);
207 node = of_graph_get_port_parent(ep);
211 dev_dbg(dev, "link_of DPCM (%pOF)\n", ep);
214 int is_single_links = 0;
217 codecs->of_node = NULL;
218 codecs->dai_name = "snd-soc-dummy-dai";
219 codecs->name = "snd-soc-dummy";
222 dai_link->dynamic = 1;
223 dai_link->dpcm_merged_format = 1;
226 dai_props->cpu_dai = &priv->dais[li->dais++];
228 ret = asoc_simple_parse_cpu(ep, dai_link, &is_single_links);
232 ret = asoc_simple_parse_clk_cpu(dev, ep, dai_link, dai);
236 ret = asoc_simple_set_dailink_name(dev, dai_link,
242 /* card->num_links includes Codec */
243 asoc_simple_canonicalize_cpu(dai_link, is_single_links);
245 struct snd_soc_codec_conf *cconf;
248 cpus->of_node = NULL;
249 cpus->dai_name = "snd-soc-dummy-dai";
250 cpus->name = "snd-soc-dummy";
253 dai_link->no_pcm = 1;
254 dai_link->be_hw_params_fixup = asoc_simple_be_hw_params_fixup;
257 dai_props->codec_dai = &priv->dais[li->dais++];
260 dai_props->codec_conf = &priv->codec_conf[li->conf++];
262 ret = asoc_simple_parse_codec(ep, dai_link);
266 ret = asoc_simple_parse_clk_codec(dev, ep, dai_link, dai);
270 ret = asoc_simple_set_dailink_name(dev, dai_link,
276 /* check "prefix" from top node */
277 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node,
279 snd_soc_of_parse_node_prefix(node, cconf, codecs->of_node,
281 snd_soc_of_parse_node_prefix(ports, cconf, codecs->of_node,
283 snd_soc_of_parse_node_prefix(port, cconf, codecs->of_node,
287 graph_parse_convert(dev, ep, &dai_props->adata);
288 graph_parse_mclk_fs(top, ep, dai_props);
290 asoc_simple_canonicalize_platform(dai_link);
292 ret = asoc_simple_parse_tdm(ep, dai);
296 ret = asoc_simple_parse_daifmt(dev, cpu_ep, codec_ep,
297 NULL, &dai_link->dai_fmt);
301 dai_link->dpcm_playback = 1;
302 dai_link->dpcm_capture = 1;
303 dai_link->ops = &graph_ops;
304 dai_link->init = asoc_simple_dai_init;
313 static int graph_dai_link_of(struct asoc_simple_priv *priv,
314 struct device_node *cpu_ep,
315 struct device_node *codec_ep,
316 struct link_info *li)
318 struct device *dev = simple_priv_to_dev(priv);
319 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
320 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
321 struct device_node *top = dev->of_node;
322 struct asoc_simple_dai *cpu_dai;
323 struct asoc_simple_dai *codec_dai;
326 /* Do it only CPU turn */
330 dev_dbg(dev, "link_of (%pOF)\n", cpu_ep);
335 dai_props->cpu_dai = &priv->dais[li->dais++];
337 dai_props->codec_dai = &priv->dais[li->dais++];
339 /* Factor to mclk, used in hw_params() */
340 graph_parse_mclk_fs(top, cpu_ep, dai_props);
341 graph_parse_mclk_fs(top, codec_ep, dai_props);
343 ret = asoc_simple_parse_daifmt(dev, cpu_ep, codec_ep,
344 NULL, &dai_link->dai_fmt);
348 ret = asoc_simple_parse_cpu(cpu_ep, dai_link, &single_cpu);
352 ret = asoc_simple_parse_codec(codec_ep, dai_link);
356 ret = asoc_simple_parse_tdm(cpu_ep, cpu_dai);
360 ret = asoc_simple_parse_tdm(codec_ep, codec_dai);
364 ret = asoc_simple_parse_clk_cpu(dev, cpu_ep, dai_link, cpu_dai);
368 ret = asoc_simple_parse_clk_codec(dev, codec_ep, dai_link, codec_dai);
372 ret = asoc_simple_set_dailink_name(dev, dai_link,
374 dai_link->cpus->dai_name,
375 dai_link->codecs->dai_name);
379 dai_link->ops = &graph_ops;
380 dai_link->init = asoc_simple_dai_init;
382 asoc_simple_canonicalize_cpu(dai_link, single_cpu);
383 asoc_simple_canonicalize_platform(dai_link);
388 static int graph_for_each_link(struct asoc_simple_priv *priv,
389 struct link_info *li,
390 int (*func_noml)(struct asoc_simple_priv *priv,
391 struct device_node *cpu_ep,
392 struct device_node *codec_ep,
393 struct link_info *li),
394 int (*func_dpcm)(struct asoc_simple_priv *priv,
395 struct device_node *cpu_ep,
396 struct device_node *codec_ep,
397 struct link_info *li, int dup_codec))
399 struct of_phandle_iterator it;
400 struct device *dev = simple_priv_to_dev(priv);
401 struct device_node *node = dev->of_node;
402 struct device_node *cpu_port;
403 struct device_node *cpu_ep;
404 struct device_node *codec_ep;
405 struct device_node *codec_port;
406 struct device_node *codec_port_old = NULL;
407 struct asoc_simple_data adata;
408 uintptr_t dpcm_selectable = (uintptr_t)of_device_get_match_data(dev);
411 /* loop for all listed CPU port */
412 of_for_each_phandle(&it, rc, node, "dais", NULL, 0) {
416 /* loop for all CPU endpoint */
418 cpu_ep = of_get_next_child(cpu_port, cpu_ep);
423 codec_ep = of_graph_get_remote_endpoint(cpu_ep);
424 codec_port = of_get_parent(codec_ep);
426 /* get convert-xxx property */
427 memset(&adata, 0, sizeof(adata));
428 graph_parse_convert(dev, codec_ep, &adata);
429 graph_parse_convert(dev, cpu_ep, &adata);
433 * if Codec port has many endpoints,
434 * or has convert-xxx property
436 if (dpcm_selectable &&
437 ((of_get_child_count(codec_port) > 1) ||
438 adata.convert_rate || adata.convert_channels))
439 ret = func_dpcm(priv, cpu_ep, codec_ep, li,
440 (codec_port_old == codec_port));
441 /* else normal sound */
443 ret = func_noml(priv, cpu_ep, codec_ep, li);
445 of_node_put(codec_ep);
446 of_node_put(codec_port);
451 codec_port_old = codec_port;
458 static int graph_parse_of(struct asoc_simple_priv *priv)
460 struct snd_soc_card *card = simple_priv_to_card(priv);
464 ret = asoc_simple_parse_widgets(card, NULL);
468 ret = asoc_simple_parse_routing(card, NULL);
472 memset(&li, 0, sizeof(li));
473 for (li.cpu = 1; li.cpu >= 0; li.cpu--) {
475 * Detect all CPU first, and Detect all Codec 2nd.
477 * In Normal sound case, all DAIs are detected
480 * In DPCM sound case,
481 * all CPUs are detected as "CPU-dummy", and
482 * all Codecs are detected as "dummy-Codec".
483 * To avoid random sub-device numbering,
484 * detect "dummy-Codec" in last;
486 ret = graph_for_each_link(priv, &li,
488 graph_dai_link_of_dpcm);
493 return asoc_simple_parse_card_name(card, NULL);
496 static int graph_count_noml(struct asoc_simple_priv *priv,
497 struct device_node *cpu_ep,
498 struct device_node *codec_ep,
499 struct link_info *li)
501 struct device *dev = simple_priv_to_dev(priv);
503 li->link += 1; /* 1xCPU-Codec */
504 li->dais += 2; /* 1xCPU + 1xCodec */
506 dev_dbg(dev, "Count As Normal\n");
511 static int graph_count_dpcm(struct asoc_simple_priv *priv,
512 struct device_node *cpu_ep,
513 struct device_node *codec_ep,
514 struct link_info *li,
517 struct device *dev = simple_priv_to_dev(priv);
519 li->link++; /* 1xCPU-dummy */
520 li->dais++; /* 1xCPU */
523 li->link++; /* 1xdummy-Codec */
524 li->conf++; /* 1xdummy-Codec */
525 li->dais++; /* 1xCodec */
528 dev_dbg(dev, "Count As DPCM\n");
533 static void graph_get_dais_count(struct asoc_simple_priv *priv,
534 struct link_info *li)
536 struct device *dev = simple_priv_to_dev(priv);
539 * link_num : number of links.
540 * CPU-Codec / CPU-dummy / dummy-Codec
541 * dais_num : number of DAIs
542 * ccnf_num : number of codec_conf
543 * same number for "dummy-Codec"
546 * CPU0 --- Codec0 link : 5
547 * CPU1 --- Codec1 dais : 7
551 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
552 * => 7 DAIs = 4xCPU + 3xCodec
553 * => 1 ccnf = 1xdummy-Codec
556 * CPU0 --- Codec0 link : 5
557 * CPU1 --- Codec1 dais : 6
561 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
562 * => 6 DAIs = 4xCPU + 2xCodec
563 * => 1 ccnf = 1xdummy-Codec
566 * CPU0 --- Codec0 link : 6
568 * CPU2 --- Codec1 ccnf : 2
571 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
572 * => 6 DAIs = 4xCPU + 2xCodec
573 * => 2 ccnf = 2xdummy-Codec
576 * CPU0 --- Codec0 (convert-rate) link : 3
577 * CPU1 --- Codec1 dais : 4
580 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
581 * => 4 DAIs = 2xCPU + 2xCodec
582 * => 1 ccnf = 1xdummy-Codec
584 graph_for_each_link(priv, li,
587 dev_dbg(dev, "link %d, dais %d, ccnf %d\n",
588 li->link, li->dais, li->conf);
591 static int graph_card_probe(struct snd_soc_card *card)
593 struct asoc_simple_priv *priv = snd_soc_card_get_drvdata(card);
596 ret = asoc_simple_init_hp(card, &priv->hp_jack, NULL);
600 ret = asoc_simple_init_mic(card, &priv->mic_jack, NULL);
607 static int graph_probe(struct platform_device *pdev)
609 struct asoc_simple_priv *priv;
610 struct device *dev = &pdev->dev;
611 struct snd_soc_card *card;
615 /* Allocate the private data and the DAI link array */
616 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
620 card = simple_priv_to_card(priv);
621 card->owner = THIS_MODULE;
623 card->dapm_widgets = graph_dapm_widgets;
624 card->num_dapm_widgets = ARRAY_SIZE(graph_dapm_widgets);
625 card->probe = graph_card_probe;
627 memset(&li, 0, sizeof(li));
628 graph_get_dais_count(priv, &li);
629 if (!li.link || !li.dais)
632 ret = asoc_simple_init_priv(priv, &li);
636 priv->pa_gpio = devm_gpiod_get_optional(dev, "pa", GPIOD_OUT_LOW);
637 if (IS_ERR(priv->pa_gpio)) {
638 ret = PTR_ERR(priv->pa_gpio);
639 dev_err(dev, "failed to get amplifier gpio: %d\n", ret);
643 ret = graph_parse_of(priv);
645 if (ret != -EPROBE_DEFER)
646 dev_err(dev, "parse error %d\n", ret);
650 snd_soc_card_set_drvdata(card, priv);
652 asoc_simple_debug_info(priv);
654 ret = devm_snd_soc_register_card(dev, card);
660 asoc_simple_clean_reference(card);
665 static int graph_remove(struct platform_device *pdev)
667 struct snd_soc_card *card = platform_get_drvdata(pdev);
669 return asoc_simple_clean_reference(card);
672 static const struct of_device_id graph_of_match[] = {
673 { .compatible = "audio-graph-card", },
674 { .compatible = "audio-graph-scu-card",
675 .data = (void *)DPCM_SELECTABLE },
678 MODULE_DEVICE_TABLE(of, graph_of_match);
680 static struct platform_driver graph_card = {
682 .name = "asoc-audio-graph-card",
683 .pm = &snd_soc_pm_ops,
684 .of_match_table = graph_of_match,
686 .probe = graph_probe,
687 .remove = graph_remove,
689 module_platform_driver(graph_card);
691 MODULE_ALIAS("platform:asoc-audio-graph-card");
692 MODULE_LICENSE("GPL v2");
693 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card");
694 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");