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>
24 struct snd_soc_card snd_card;
25 struct graph_dai_props {
26 struct asoc_simple_dai *cpu_dai;
27 struct asoc_simple_dai *codec_dai;
28 struct snd_soc_dai_link_component codecs; /* single codec */
29 struct snd_soc_dai_link_component platforms;
30 struct asoc_simple_card_data adata;
31 struct snd_soc_codec_conf *codec_conf;
34 struct asoc_simple_jack hp_jack;
35 struct asoc_simple_jack mic_jack;
36 struct snd_soc_dai_link *dai_link;
37 struct asoc_simple_dai *dais;
38 struct snd_soc_codec_conf *codec_conf;
39 struct gpio_desc *pa_gpio;
43 int dais; /* number of dai */
44 int link; /* number of link */
45 int conf; /* number of codec_conf */
46 int cpu; /* turn for CPU / Codec */
49 #define graph_priv_to_card(priv) (&(priv)->snd_card)
50 #define graph_priv_to_props(priv, i) ((priv)->dai_props + (i))
51 #define graph_priv_to_dev(priv) (graph_priv_to_card(priv)->dev)
52 #define graph_priv_to_link(priv, i) (graph_priv_to_card(priv)->dai_link + (i))
54 #define PREFIX "audio-graph-card,"
56 static int graph_outdrv_event(struct snd_soc_dapm_widget *w,
57 struct snd_kcontrol *kcontrol,
60 struct snd_soc_dapm_context *dapm = w->dapm;
61 struct graph_priv *priv = snd_soc_card_get_drvdata(dapm->card);
64 case SND_SOC_DAPM_POST_PMU:
65 gpiod_set_value_cansleep(priv->pa_gpio, 1);
67 case SND_SOC_DAPM_PRE_PMD:
68 gpiod_set_value_cansleep(priv->pa_gpio, 0);
77 static const struct snd_soc_dapm_widget graph_dapm_widgets[] = {
78 SND_SOC_DAPM_OUT_DRV_E("Amplifier", SND_SOC_NOPM,
79 0, 0, NULL, 0, graph_outdrv_event,
80 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD),
83 static int graph_startup(struct snd_pcm_substream *substream)
85 struct snd_soc_pcm_runtime *rtd = substream->private_data;
86 struct graph_priv *priv = snd_soc_card_get_drvdata(rtd->card);
87 struct graph_dai_props *dai_props = graph_priv_to_props(priv, rtd->num);
90 ret = asoc_simple_card_clk_enable(dai_props->cpu_dai);
94 ret = asoc_simple_card_clk_enable(dai_props->codec_dai);
96 asoc_simple_card_clk_disable(dai_props->cpu_dai);
101 static void graph_shutdown(struct snd_pcm_substream *substream)
103 struct snd_soc_pcm_runtime *rtd = substream->private_data;
104 struct graph_priv *priv = snd_soc_card_get_drvdata(rtd->card);
105 struct graph_dai_props *dai_props = graph_priv_to_props(priv, rtd->num);
107 asoc_simple_card_clk_disable(dai_props->cpu_dai);
109 asoc_simple_card_clk_disable(dai_props->codec_dai);
112 static int graph_hw_params(struct snd_pcm_substream *substream,
113 struct snd_pcm_hw_params *params)
115 struct snd_soc_pcm_runtime *rtd = substream->private_data;
116 struct snd_soc_dai *codec_dai = rtd->codec_dai;
117 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
118 struct graph_priv *priv = snd_soc_card_get_drvdata(rtd->card);
119 struct graph_dai_props *dai_props = graph_priv_to_props(priv, rtd->num);
120 unsigned int mclk, mclk_fs = 0;
123 if (dai_props->mclk_fs)
124 mclk_fs = dai_props->mclk_fs;
127 mclk = params_rate(params) * mclk_fs;
128 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
130 if (ret && ret != -ENOTSUPP)
133 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
135 if (ret && ret != -ENOTSUPP)
143 static const struct snd_soc_ops graph_ops = {
144 .startup = graph_startup,
145 .shutdown = graph_shutdown,
146 .hw_params = graph_hw_params,
149 static int graph_dai_init(struct snd_soc_pcm_runtime *rtd)
151 struct graph_priv *priv = snd_soc_card_get_drvdata(rtd->card);
152 struct graph_dai_props *dai_props = graph_priv_to_props(priv, rtd->num);
155 ret = asoc_simple_card_init_dai(rtd->codec_dai,
156 dai_props->codec_dai);
160 ret = asoc_simple_card_init_dai(rtd->cpu_dai,
168 static int graph_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
169 struct snd_pcm_hw_params *params)
171 struct graph_priv *priv = snd_soc_card_get_drvdata(rtd->card);
172 struct graph_dai_props *dai_props = graph_priv_to_props(priv, rtd->num);
174 asoc_simple_card_convert_fixup(&dai_props->adata, params);
179 static void graph_get_conversion(struct device *dev,
180 struct device_node *ep,
181 struct asoc_simple_card_data *adata)
183 struct device_node *top = dev->of_node;
184 struct device_node *port = of_get_parent(ep);
185 struct device_node *ports = of_get_parent(port);
186 struct device_node *node = of_graph_get_port_parent(ep);
188 asoc_simple_card_parse_convert(dev, top, NULL, adata);
189 asoc_simple_card_parse_convert(dev, node, PREFIX, adata);
190 asoc_simple_card_parse_convert(dev, ports, NULL, adata);
191 asoc_simple_card_parse_convert(dev, port, NULL, adata);
192 asoc_simple_card_parse_convert(dev, ep, NULL, adata);
195 static int graph_dai_link_of_dpcm(struct graph_priv *priv,
196 struct device_node *cpu_ep,
197 struct device_node *codec_ep,
198 struct link_info *li,
201 struct device *dev = graph_priv_to_dev(priv);
202 struct snd_soc_dai_link *dai_link = graph_priv_to_link(priv, li->link);
203 struct graph_dai_props *dai_props = graph_priv_to_props(priv, li->link);
204 struct device_node *top = dev->of_node;
205 struct device_node *ep = li->cpu ? cpu_ep : codec_ep;
206 struct device_node *port;
207 struct device_node *ports;
208 struct device_node *node;
209 struct asoc_simple_dai *dai;
210 struct snd_soc_dai_link_component *codecs = dai_link->codecs;
213 /* Do it all CPU endpoint, and 1st Codec endpoint */
214 if (!li->cpu && dup_codec)
217 port = of_get_parent(ep);
218 ports = of_get_parent(port);
219 node = of_graph_get_port_parent(ep);
223 dev_dbg(dev, "link_of DPCM (%pOF)\n", ep);
225 of_property_read_u32(top, "mclk-fs", &dai_props->mclk_fs);
226 of_property_read_u32(ports, "mclk-fs", &dai_props->mclk_fs);
227 of_property_read_u32(port, "mclk-fs", &dai_props->mclk_fs);
228 of_property_read_u32(ep, "mclk-fs", &dai_props->mclk_fs);
230 graph_get_conversion(dev, ep, &dai_props->adata);
239 codecs->of_node = NULL;
240 codecs->dai_name = "snd-soc-dummy-dai";
241 codecs->name = "snd-soc-dummy";
244 dai_link->dynamic = 1;
245 dai_link->dpcm_merged_format = 1;
248 dai_props->cpu_dai = &priv->dais[li->dais++];
250 ret = asoc_simple_card_parse_graph_cpu(ep, dai_link);
254 ret = asoc_simple_card_parse_clk_cpu(dev, ep, dai_link, dai);
258 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
260 dai_link->cpu_dai_name);
264 /* card->num_links includes Codec */
265 asoc_simple_card_canonicalize_cpu(dai_link,
266 of_graph_get_endpoint_count(dai_link->cpu_of_node) == 1);
268 struct snd_soc_codec_conf *cconf;
271 dai_link->cpu_of_node = NULL;
272 dai_link->cpu_dai_name = "snd-soc-dummy-dai";
273 dai_link->cpu_name = "snd-soc-dummy";
276 dai_link->no_pcm = 1;
277 dai_link->be_hw_params_fixup = graph_be_hw_params_fixup;
280 dai_props->codec_dai = &priv->dais[li->dais++];
283 dai_props->codec_conf = &priv->codec_conf[li->conf++];
285 ret = asoc_simple_card_parse_graph_codec(ep, dai_link);
289 ret = asoc_simple_card_parse_clk_codec(dev, ep, dai_link, dai);
293 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
299 /* check "prefix" from top node */
300 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node,
302 snd_soc_of_parse_node_prefix(node, cconf, codecs->of_node,
304 snd_soc_of_parse_node_prefix(ports, cconf, codecs->of_node,
306 snd_soc_of_parse_node_prefix(port, cconf, codecs->of_node,
310 asoc_simple_card_canonicalize_platform(dai_link);
312 ret = asoc_simple_card_of_parse_tdm(ep, dai);
316 ret = asoc_simple_card_parse_daifmt(dev, cpu_ep, codec_ep,
317 NULL, &dai_link->dai_fmt);
321 dai_link->dpcm_playback = 1;
322 dai_link->dpcm_capture = 1;
323 dai_link->ops = &graph_ops;
324 dai_link->init = graph_dai_init;
329 static int graph_dai_link_of(struct graph_priv *priv,
330 struct device_node *cpu_ep,
331 struct device_node *codec_ep,
332 struct link_info *li)
334 struct device *dev = graph_priv_to_dev(priv);
335 struct snd_soc_dai_link *dai_link = graph_priv_to_link(priv, li->link);
336 struct graph_dai_props *dai_props = graph_priv_to_props(priv, li->link);
337 struct device_node *top = dev->of_node;
338 struct device_node *cpu_port;
339 struct device_node *cpu_ports;
340 struct device_node *codec_port;
341 struct device_node *codec_ports;
342 struct asoc_simple_dai *cpu_dai;
343 struct asoc_simple_dai *codec_dai;
346 /* Do it only CPU turn */
350 cpu_port = of_get_parent(cpu_ep);
351 cpu_ports = of_get_parent(cpu_port);
352 codec_port = of_get_parent(codec_ep);
353 codec_ports = of_get_parent(codec_port);
355 dev_dbg(dev, "link_of (%pOF)\n", cpu_ep);
360 dai_props->cpu_dai = &priv->dais[li->dais++];
362 dai_props->codec_dai = &priv->dais[li->dais++];
364 /* Factor to mclk, used in hw_params() */
365 of_property_read_u32(top, "mclk-fs", &dai_props->mclk_fs);
366 of_property_read_u32(cpu_ports, "mclk-fs", &dai_props->mclk_fs);
367 of_property_read_u32(codec_ports, "mclk-fs", &dai_props->mclk_fs);
368 of_property_read_u32(cpu_port, "mclk-fs", &dai_props->mclk_fs);
369 of_property_read_u32(codec_port, "mclk-fs", &dai_props->mclk_fs);
370 of_property_read_u32(cpu_ep, "mclk-fs", &dai_props->mclk_fs);
371 of_property_read_u32(codec_ep, "mclk-fs", &dai_props->mclk_fs);
372 of_node_put(cpu_port);
373 of_node_put(cpu_ports);
374 of_node_put(codec_port);
375 of_node_put(codec_ports);
377 ret = asoc_simple_card_parse_daifmt(dev, cpu_ep, codec_ep,
378 NULL, &dai_link->dai_fmt);
382 ret = asoc_simple_card_parse_graph_cpu(cpu_ep, dai_link);
386 ret = asoc_simple_card_parse_graph_codec(codec_ep, dai_link);
390 ret = asoc_simple_card_of_parse_tdm(cpu_ep, cpu_dai);
394 ret = asoc_simple_card_of_parse_tdm(codec_ep, codec_dai);
398 ret = asoc_simple_card_parse_clk_cpu(dev, cpu_ep, dai_link, cpu_dai);
402 ret = asoc_simple_card_parse_clk_codec(dev, codec_ep, dai_link, codec_dai);
406 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
408 dai_link->cpu_dai_name,
409 dai_link->codecs->dai_name);
413 dai_link->ops = &graph_ops;
414 dai_link->init = graph_dai_init;
416 asoc_simple_card_canonicalize_platform(dai_link);
417 asoc_simple_card_canonicalize_cpu(dai_link,
418 of_graph_get_endpoint_count(dai_link->cpu_of_node) == 1);
423 static int graph_for_each_link(struct graph_priv *priv,
424 struct link_info *li,
425 int (*func_noml)(struct graph_priv *priv,
426 struct device_node *cpu_ep,
427 struct device_node *codec_ep,
428 struct link_info *li),
429 int (*func_dpcm)(struct graph_priv *priv,
430 struct device_node *cpu_ep,
431 struct device_node *codec_ep,
432 struct link_info *li, int dup_codec))
434 struct of_phandle_iterator it;
435 struct device *dev = graph_priv_to_dev(priv);
436 struct device_node *node = dev->of_node;
437 struct device_node *cpu_port;
438 struct device_node *cpu_ep;
439 struct device_node *codec_ep;
440 struct device_node *codec_port;
441 struct device_node *codec_port_old = NULL;
442 struct asoc_simple_card_data adata;
445 /* loop for all listed CPU port */
446 of_for_each_phandle(&it, rc, node, "dais", NULL, 0) {
450 /* loop for all CPU endpoint */
452 cpu_ep = of_get_next_child(cpu_port, cpu_ep);
457 codec_ep = of_graph_get_remote_endpoint(cpu_ep);
458 codec_port = of_get_parent(codec_ep);
460 of_node_put(codec_ep);
461 of_node_put(codec_port);
463 /* get convert-xxx property */
464 memset(&adata, 0, sizeof(adata));
465 graph_get_conversion(dev, codec_ep, &adata);
466 graph_get_conversion(dev, cpu_ep, &adata);
470 * if Codec port has many endpoints,
471 * or has convert-xxx property
473 if ((of_get_child_count(codec_port) > 1) ||
474 adata.convert_rate || adata.convert_channels)
475 ret = func_dpcm(priv, cpu_ep, codec_ep, li,
476 (codec_port_old == codec_port));
477 /* else normal sound */
479 ret = func_noml(priv, cpu_ep, codec_ep, li);
484 codec_port_old = codec_port;
491 static int graph_parse_of(struct graph_priv *priv)
493 struct snd_soc_card *card = graph_priv_to_card(priv);
497 ret = asoc_simple_card_of_parse_widgets(card, NULL);
501 ret = asoc_simple_card_of_parse_routing(card, NULL);
505 memset(&li, 0, sizeof(li));
506 for (li.cpu = 1; li.cpu >= 0; li.cpu--) {
508 * Detect all CPU first, and Detect all Codec 2nd.
510 * In Normal sound case, all DAIs are detected
513 * In DPCM sound case,
514 * all CPUs are detected as "CPU-dummy", and
515 * all Codecs are detected as "dummy-Codec".
516 * To avoid random sub-device numbering,
517 * detect "dummy-Codec" in last;
519 ret = graph_for_each_link(priv, &li,
521 graph_dai_link_of_dpcm);
526 return asoc_simple_card_parse_card_name(card, NULL);
529 static int graph_count_noml(struct graph_priv *priv,
530 struct device_node *cpu_ep,
531 struct device_node *codec_ep,
532 struct link_info *li)
534 struct device *dev = graph_priv_to_dev(priv);
536 li->link += 1; /* 1xCPU-Codec */
537 li->dais += 2; /* 1xCPU + 1xCodec */
539 dev_dbg(dev, "Count As Normal\n");
544 static int graph_count_dpcm(struct graph_priv *priv,
545 struct device_node *cpu_ep,
546 struct device_node *codec_ep,
547 struct link_info *li,
550 struct device *dev = graph_priv_to_dev(priv);
552 li->link++; /* 1xCPU-dummy */
553 li->dais++; /* 1xCPU */
556 li->link++; /* 1xdummy-Codec */
557 li->conf++; /* 1xdummy-Codec */
558 li->dais++; /* 1xCodec */
561 dev_dbg(dev, "Count As DPCM\n");
566 static void graph_get_dais_count(struct graph_priv *priv,
567 struct link_info *li)
569 struct device *dev = graph_priv_to_dev(priv);
572 * link_num : number of links.
573 * CPU-Codec / CPU-dummy / dummy-Codec
574 * dais_num : number of DAIs
575 * ccnf_num : number of codec_conf
576 * same number for "dummy-Codec"
579 * CPU0 --- Codec0 link : 5
580 * CPU1 --- Codec1 dais : 7
584 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
585 * => 7 DAIs = 4xCPU + 3xCodec
586 * => 1 ccnf = 1xdummy-Codec
589 * CPU0 --- Codec0 link : 5
590 * CPU1 --- Codec1 dais : 6
594 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
595 * => 6 DAIs = 4xCPU + 2xCodec
596 * => 1 ccnf = 1xdummy-Codec
599 * CPU0 --- Codec0 link : 6
601 * CPU2 --- Codec1 ccnf : 2
604 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
605 * => 6 DAIs = 4xCPU + 2xCodec
606 * => 2 ccnf = 2xdummy-Codec
609 * CPU0 --- Codec0 (convert-rate) link : 3
610 * CPU1 --- Codec1 dais : 4
613 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
614 * => 4 DAIs = 2xCPU + 2xCodec
615 * => 1 ccnf = 1xdummy-Codec
617 graph_for_each_link(priv, li,
620 dev_dbg(dev, "link %d, dais %d, ccnf %d\n",
621 li->link, li->dais, li->conf);
624 static int graph_card_probe(struct snd_soc_card *card)
626 struct graph_priv *priv = snd_soc_card_get_drvdata(card);
629 ret = asoc_simple_card_init_hp(card, &priv->hp_jack, NULL);
633 ret = asoc_simple_card_init_mic(card, &priv->mic_jack, NULL);
640 static int graph_probe(struct platform_device *pdev)
642 struct graph_priv *priv;
643 struct snd_soc_dai_link *dai_link;
644 struct graph_dai_props *dai_props;
645 struct asoc_simple_dai *dais;
646 struct device *dev = &pdev->dev;
647 struct snd_soc_card *card;
648 struct snd_soc_codec_conf *cconf;
652 /* Allocate the private data and the DAI link array */
653 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
657 card = graph_priv_to_card(priv);
658 card->owner = THIS_MODULE;
660 card->dapm_widgets = graph_dapm_widgets;
661 card->num_dapm_widgets = ARRAY_SIZE(graph_dapm_widgets);
662 card->probe = graph_card_probe;
664 memset(&li, 0, sizeof(li));
665 graph_get_dais_count(priv, &li);
666 if (!li.link || !li.dais)
669 dai_props = devm_kcalloc(dev, li.link, sizeof(*dai_props), GFP_KERNEL);
670 dai_link = devm_kcalloc(dev, li.link, sizeof(*dai_link), GFP_KERNEL);
671 dais = devm_kcalloc(dev, li.dais, sizeof(*dais), GFP_KERNEL);
672 cconf = devm_kcalloc(dev, li.conf, sizeof(*cconf), GFP_KERNEL);
673 if (!dai_props || !dai_link || !dais)
677 * Use snd_soc_dai_link_component instead of legacy style
678 * It is codec only. but cpu/platform will be supported in the future.
680 * soc-core.c :: snd_soc_init_multicodec()
682 for (i = 0; i < li.link; i++) {
683 dai_link[i].codecs = &dai_props[i].codecs;
684 dai_link[i].num_codecs = 1;
685 dai_link[i].platforms = &dai_props[i].platforms;
686 dai_link[i].num_platforms = 1;
689 priv->pa_gpio = devm_gpiod_get_optional(dev, "pa", GPIOD_OUT_LOW);
690 if (IS_ERR(priv->pa_gpio)) {
691 ret = PTR_ERR(priv->pa_gpio);
692 dev_err(dev, "failed to get amplifier gpio: %d\n", ret);
696 priv->dai_props = dai_props;
697 priv->dai_link = dai_link;
699 priv->codec_conf = cconf;
701 card->dai_link = dai_link;
702 card->num_links = li.link;
703 card->codec_conf = cconf;
704 card->num_configs = li.conf;
706 ret = graph_parse_of(priv);
708 if (ret != -EPROBE_DEFER)
709 dev_err(dev, "parse error %d\n", ret);
713 snd_soc_card_set_drvdata(card, priv);
715 ret = devm_snd_soc_register_card(dev, card);
721 asoc_simple_card_clean_reference(card);
726 static int graph_remove(struct platform_device *pdev)
728 struct snd_soc_card *card = platform_get_drvdata(pdev);
730 return asoc_simple_card_clean_reference(card);
733 static const struct of_device_id graph_of_match[] = {
734 { .compatible = "audio-graph-card", },
735 { .compatible = "audio-graph-scu-card", },
738 MODULE_DEVICE_TABLE(of, graph_of_match);
740 static struct platform_driver graph_card = {
742 .name = "asoc-audio-graph-card",
743 .pm = &snd_soc_pm_ops,
744 .of_match_table = graph_of_match,
746 .probe = graph_probe,
747 .remove = graph_remove,
749 module_platform_driver(graph_card);
751 MODULE_ALIAS("platform:asoc-audio-graph-card");
752 MODULE_LICENSE("GPL v2");
753 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card");
754 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");