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
,
218 struct device
*dev
= simple_priv_to_dev(priv
);
219 struct snd_soc_card
*card
= simple_priv_to_card(priv
);
220 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, li
->link
);
221 struct simple_dai_props
*dai_props
= simple_priv_to_props(priv
, li
->link
);
222 struct device_node
*top
= dev
->of_node
;
223 struct device_node
*ep
= li
->cpu
? cpu_ep
: codec_ep
;
224 struct device_node
*port
;
225 struct device_node
*ports
;
226 struct device_node
*node
;
227 struct asoc_simple_dai
*dai
;
228 struct snd_soc_dai_link_component
*cpus
= dai_link
->cpus
;
229 struct snd_soc_dai_link_component
*codecs
= dai_link
->codecs
;
233 * Codec endpoint can be NULL for pluggable audio HW.
234 * Platform DT can populate the Codec endpoint depending on the
237 if (!li
->cpu
&& !codec_ep
)
240 /* Do it all CPU endpoint, and 1st Codec endpoint */
241 if (!li
->cpu
&& dup_codec
)
244 port
= of_get_parent(ep
);
245 ports
= of_get_parent(port
);
246 node
= of_graph_get_port_parent(ep
);
250 dev_dbg(dev
, "link_of DPCM (%pOF)\n", ep
);
253 int is_single_links
= 0;
256 codecs
->of_node
= NULL
;
257 codecs
->dai_name
= "snd-soc-dummy-dai";
258 codecs
->name
= "snd-soc-dummy";
261 dai_link
->dynamic
= 1;
262 dai_link
->dpcm_merged_format
= 1;
265 dai_props
->cpu_dai
= &priv
->dais
[li
->dais
++];
267 ret
= asoc_simple_parse_cpu(ep
, dai_link
, &is_single_links
);
271 ret
= asoc_simple_parse_clk_cpu(dev
, ep
, dai_link
, dai
);
275 ret
= asoc_simple_set_dailink_name(dev
, dai_link
,
283 * In BE<->BE connections it is not required to create
284 * PCM devices at CPU end of the dai link and thus 'no_pcm'
285 * flag needs to be set. It is useful when there are many
286 * BE components and some of these have to be connected to
287 * form a valid audio path.
289 * For example: FE <-> BE1 <-> BE2 <-> ... <-> BEn where
290 * there are 'n' BE components in the path.
292 if (card
->component_chaining
&& !soc_component_is_pcm(cpus
))
293 dai_link
->no_pcm
= 1;
295 /* card->num_links includes Codec */
296 asoc_simple_canonicalize_cpu(dai_link
, is_single_links
);
298 struct snd_soc_codec_conf
*cconf
;
301 cpus
->of_node
= NULL
;
302 cpus
->dai_name
= "snd-soc-dummy-dai";
303 cpus
->name
= "snd-soc-dummy";
306 dai_link
->no_pcm
= 1;
307 dai_link
->be_hw_params_fixup
= asoc_simple_be_hw_params_fixup
;
310 dai_props
->codec_dai
= &priv
->dais
[li
->dais
++];
313 dai_props
->codec_conf
= &priv
->codec_conf
[li
->conf
++];
315 ret
= asoc_simple_parse_codec(ep
, dai_link
);
319 ret
= asoc_simple_parse_clk_codec(dev
, ep
, dai_link
, dai
);
323 ret
= asoc_simple_set_dailink_name(dev
, dai_link
,
330 /* check "prefix" from top node */
331 snd_soc_of_parse_node_prefix(top
, cconf
, codecs
->of_node
,
333 snd_soc_of_parse_node_prefix(node
, cconf
, codecs
->of_node
,
335 snd_soc_of_parse_node_prefix(ports
, cconf
, codecs
->of_node
,
337 snd_soc_of_parse_node_prefix(port
, cconf
, codecs
->of_node
,
341 graph_parse_convert(dev
, ep
, &dai_props
->adata
);
342 graph_parse_mclk_fs(top
, ep
, dai_props
);
344 asoc_simple_canonicalize_platform(dai_link
);
346 ret
= asoc_simple_parse_tdm(ep
, dai
);
350 ret
= asoc_simple_parse_daifmt(dev
, cpu_ep
, codec_ep
,
351 NULL
, &dai_link
->dai_fmt
);
355 snd_soc_dai_link_set_capabilities(dai_link
);
357 dai_link
->ops
= &graph_ops
;
359 /* Use custom snd_soc_ops callbacks if available */
361 dai_link
->ops
= priv
->ops
;
363 dai_link
->init
= asoc_simple_dai_init
;
372 static int graph_dai_link_of(struct asoc_simple_priv
*priv
,
373 struct device_node
*cpu_ep
,
374 struct device_node
*codec_ep
,
375 struct link_info
*li
)
377 struct device
*dev
= simple_priv_to_dev(priv
);
378 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, li
->link
);
379 struct simple_dai_props
*dai_props
= simple_priv_to_props(priv
, li
->link
);
380 struct device_node
*top
= dev
->of_node
;
381 struct asoc_simple_dai
*cpu_dai
;
382 struct asoc_simple_dai
*codec_dai
;
385 /* Do it only CPU turn */
389 dev_dbg(dev
, "link_of (%pOF)\n", cpu_ep
);
394 dai_props
->cpu_dai
= &priv
->dais
[li
->dais
++];
396 dai_props
->codec_dai
= &priv
->dais
[li
->dais
++];
398 /* Factor to mclk, used in hw_params() */
399 graph_parse_mclk_fs(top
, cpu_ep
, dai_props
);
400 graph_parse_mclk_fs(top
, codec_ep
, dai_props
);
402 ret
= asoc_simple_parse_daifmt(dev
, cpu_ep
, codec_ep
,
403 NULL
, &dai_link
->dai_fmt
);
407 ret
= asoc_simple_parse_cpu(cpu_ep
, dai_link
, &single_cpu
);
411 ret
= asoc_simple_parse_codec(codec_ep
, dai_link
);
415 ret
= asoc_simple_parse_tdm(cpu_ep
, cpu_dai
);
419 ret
= asoc_simple_parse_tdm(codec_ep
, codec_dai
);
423 ret
= asoc_simple_parse_clk_cpu(dev
, cpu_ep
, dai_link
, cpu_dai
);
427 ret
= asoc_simple_parse_clk_codec(dev
, codec_ep
, dai_link
, codec_dai
);
431 ret
= asoc_simple_set_dailink_name(dev
, dai_link
,
433 dai_link
->cpus
->dai_name
,
434 dai_link
->codecs
->dai_name
);
438 dai_link
->ops
= &graph_ops
;
439 dai_link
->init
= asoc_simple_dai_init
;
441 asoc_simple_canonicalize_cpu(dai_link
, single_cpu
);
442 asoc_simple_canonicalize_platform(dai_link
);
447 static inline bool parse_as_dpcm_link(struct asoc_simple_priv
*priv
,
448 struct device_node
*codec_port
,
449 struct asoc_simple_data
*adata
)
451 if (priv
->force_dpcm
)
454 if (!priv
->dpcm_selectable
)
459 * if Codec port has many endpoints,
460 * or has convert-xxx property
462 if ((of_get_child_count(codec_port
) > 1) ||
463 (adata
->convert_rate
|| adata
->convert_channels
))
469 static int graph_for_each_link(struct asoc_simple_priv
*priv
,
470 struct link_info
*li
,
471 int (*func_noml
)(struct asoc_simple_priv
*priv
,
472 struct device_node
*cpu_ep
,
473 struct device_node
*codec_ep
,
474 struct link_info
*li
),
475 int (*func_dpcm
)(struct asoc_simple_priv
*priv
,
476 struct device_node
*cpu_ep
,
477 struct device_node
*codec_ep
,
478 struct link_info
*li
, int dup_codec
))
480 struct of_phandle_iterator it
;
481 struct device
*dev
= simple_priv_to_dev(priv
);
482 struct device_node
*node
= dev
->of_node
;
483 struct device_node
*cpu_port
;
484 struct device_node
*cpu_ep
;
485 struct device_node
*codec_ep
;
486 struct device_node
*codec_port
;
487 struct device_node
*codec_port_old
= NULL
;
488 struct asoc_simple_data adata
;
491 /* loop for all listed CPU port */
492 of_for_each_phandle(&it
, rc
, node
, "dais", NULL
, 0) {
496 /* loop for all CPU endpoint */
498 cpu_ep
= of_get_next_child(cpu_port
, cpu_ep
);
503 codec_ep
= of_graph_get_remote_endpoint(cpu_ep
);
504 codec_port
= of_get_parent(codec_ep
);
506 /* get convert-xxx property */
507 memset(&adata
, 0, sizeof(adata
));
508 graph_parse_convert(dev
, codec_ep
, &adata
);
509 graph_parse_convert(dev
, cpu_ep
, &adata
);
511 /* check if link requires DPCM parsing */
512 if (parse_as_dpcm_link(priv
, codec_port
, &adata
))
513 ret
= func_dpcm(priv
, cpu_ep
, codec_ep
, li
,
514 (codec_port_old
== codec_port
));
515 /* else normal sound */
517 ret
= func_noml(priv
, cpu_ep
, codec_ep
, li
);
519 of_node_put(codec_ep
);
520 of_node_put(codec_port
);
525 codec_port_old
= codec_port
;
532 static void graph_get_dais_count(struct asoc_simple_priv
*priv
,
533 struct link_info
*li
);
535 int graph_parse_of(struct asoc_simple_priv
*priv
, struct device
*dev
)
537 struct snd_soc_card
*card
= simple_priv_to_card(priv
);
541 card
->owner
= THIS_MODULE
;
544 memset(&li
, 0, sizeof(li
));
545 graph_get_dais_count(priv
, &li
);
546 if (!li
.link
|| !li
.dais
)
549 ret
= asoc_simple_init_priv(priv
, &li
);
553 priv
->pa_gpio
= devm_gpiod_get_optional(dev
, "pa", GPIOD_OUT_LOW
);
554 if (IS_ERR(priv
->pa_gpio
)) {
555 ret
= PTR_ERR(priv
->pa_gpio
);
556 dev_err(dev
, "failed to get amplifier gpio: %d\n", ret
);
560 ret
= asoc_simple_parse_widgets(card
, NULL
);
564 ret
= asoc_simple_parse_routing(card
, NULL
);
568 memset(&li
, 0, sizeof(li
));
569 for (li
.cpu
= 1; li
.cpu
>= 0; li
.cpu
--) {
571 * Detect all CPU first, and Detect all Codec 2nd.
573 * In Normal sound case, all DAIs are detected
576 * In DPCM sound case,
577 * all CPUs are detected as "CPU-dummy", and
578 * all Codecs are detected as "dummy-Codec".
579 * To avoid random sub-device numbering,
580 * detect "dummy-Codec" in last;
582 ret
= graph_for_each_link(priv
, &li
,
584 graph_dai_link_of_dpcm
);
589 ret
= asoc_simple_parse_card_name(card
, NULL
);
593 snd_soc_card_set_drvdata(card
, priv
);
595 asoc_simple_debug_info(priv
);
597 ret
= devm_snd_soc_register_card(dev
, card
);
604 asoc_simple_clean_reference(card
);
606 if (ret
!= -EPROBE_DEFER
)
607 dev_err(dev
, "parse error %d\n", ret
);
611 EXPORT_SYMBOL_GPL(graph_parse_of
);
613 static int graph_count_noml(struct asoc_simple_priv
*priv
,
614 struct device_node
*cpu_ep
,
615 struct device_node
*codec_ep
,
616 struct link_info
*li
)
618 struct device
*dev
= simple_priv_to_dev(priv
);
620 li
->link
+= 1; /* 1xCPU-Codec */
621 li
->dais
+= 2; /* 1xCPU + 1xCodec */
623 dev_dbg(dev
, "Count As Normal\n");
628 static int graph_count_dpcm(struct asoc_simple_priv
*priv
,
629 struct device_node
*cpu_ep
,
630 struct device_node
*codec_ep
,
631 struct link_info
*li
,
634 struct device
*dev
= simple_priv_to_dev(priv
);
636 li
->link
++; /* 1xCPU-dummy */
637 li
->dais
++; /* 1xCPU */
639 if (!dup_codec
&& codec_ep
) {
640 li
->link
++; /* 1xdummy-Codec */
641 li
->conf
++; /* 1xdummy-Codec */
642 li
->dais
++; /* 1xCodec */
645 dev_dbg(dev
, "Count As DPCM\n");
650 static void graph_get_dais_count(struct asoc_simple_priv
*priv
,
651 struct link_info
*li
)
653 struct device
*dev
= simple_priv_to_dev(priv
);
656 * link_num : number of links.
657 * CPU-Codec / CPU-dummy / dummy-Codec
658 * dais_num : number of DAIs
659 * ccnf_num : number of codec_conf
660 * same number for "dummy-Codec"
663 * CPU0 --- Codec0 link : 5
664 * CPU1 --- Codec1 dais : 7
668 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
669 * => 7 DAIs = 4xCPU + 3xCodec
670 * => 1 ccnf = 1xdummy-Codec
673 * CPU0 --- Codec0 link : 5
674 * CPU1 --- Codec1 dais : 6
678 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
679 * => 6 DAIs = 4xCPU + 2xCodec
680 * => 1 ccnf = 1xdummy-Codec
683 * CPU0 --- Codec0 link : 6
685 * CPU2 --- Codec1 ccnf : 2
688 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
689 * => 6 DAIs = 4xCPU + 2xCodec
690 * => 2 ccnf = 2xdummy-Codec
693 * CPU0 --- Codec0 (convert-rate) link : 3
694 * CPU1 --- Codec1 dais : 4
697 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
698 * => 4 DAIs = 2xCPU + 2xCodec
699 * => 1 ccnf = 1xdummy-Codec
701 graph_for_each_link(priv
, li
,
704 dev_dbg(dev
, "link %d, dais %d, ccnf %d\n",
705 li
->link
, li
->dais
, li
->conf
);
708 int graph_card_probe(struct snd_soc_card
*card
)
710 struct asoc_simple_priv
*priv
= snd_soc_card_get_drvdata(card
);
713 ret
= asoc_simple_init_hp(card
, &priv
->hp_jack
, NULL
);
717 ret
= asoc_simple_init_mic(card
, &priv
->mic_jack
, NULL
);
723 EXPORT_SYMBOL_GPL(graph_card_probe
);
725 static int graph_probe(struct platform_device
*pdev
)
727 struct asoc_simple_priv
*priv
;
728 struct device
*dev
= &pdev
->dev
;
729 struct snd_soc_card
*card
;
731 /* Allocate the private data and the DAI link array */
732 priv
= devm_kzalloc(dev
, sizeof(*priv
), GFP_KERNEL
);
736 card
= simple_priv_to_card(priv
);
737 card
->dapm_widgets
= graph_dapm_widgets
;
738 card
->num_dapm_widgets
= ARRAY_SIZE(graph_dapm_widgets
);
739 card
->probe
= graph_card_probe
;
741 if (of_device_get_match_data(dev
))
742 priv
->dpcm_selectable
= 1;
744 return graph_parse_of(priv
, dev
);
747 static int graph_remove(struct platform_device
*pdev
)
749 struct snd_soc_card
*card
= platform_get_drvdata(pdev
);
751 return asoc_simple_clean_reference(card
);
754 static const struct of_device_id graph_of_match
[] = {
755 { .compatible
= "audio-graph-card", },
756 { .compatible
= "audio-graph-scu-card",
757 .data
= (void *)DPCM_SELECTABLE
},
760 MODULE_DEVICE_TABLE(of
, graph_of_match
);
762 static struct platform_driver graph_card
= {
764 .name
= "asoc-audio-graph-card",
765 .pm
= &snd_soc_pm_ops
,
766 .of_match_table
= graph_of_match
,
768 .probe
= graph_probe
,
769 .remove
= graph_remove
,
771 module_platform_driver(graph_card
);
773 MODULE_ALIAS("platform:asoc-audio-graph-card");
774 MODULE_LICENSE("GPL v2");
775 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card");
776 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");