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);
135 * Here, dlc->dai_name is pointer to CPU/Codec DAI name.
136 * If user unbinded CPU or Codec driver, but not for Sound Card,
137 * dlc->dai_name is keeping unbinded CPU or Codec
140 * If user re-bind CPU or Codec driver again, ALSA SoC will try
141 * to rebind Card via snd_soc_try_rebind_card(), but because of
142 * above reason, it might can't bind Sound Card.
143 * Because Sound Card is pointing to released dai_name pointer.
145 * To avoid this rebind Card issue,
146 * 1) It needs to alloc memory to keep dai_name eventhough
147 * CPU or Codec driver was unbinded, or
148 * 2) user need to rebind Sound Card everytime
149 * if he unbinded CPU or Codec.
151 ret
= snd_soc_get_dai_name(&args
, &dlc
->dai_name
);
158 *is_single_link
= of_graph_get_endpoint_count(node
) == 1;
163 static void graph_parse_convert(struct device
*dev
,
164 struct device_node
*ep
,
165 struct asoc_simple_data
*adata
)
167 struct device_node
*top
= dev
->of_node
;
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 asoc_simple_parse_convert(dev
, top
, NULL
, adata
);
173 asoc_simple_parse_convert(dev
, node
, PREFIX
, adata
);
174 asoc_simple_parse_convert(dev
, ports
, NULL
, adata
);
175 asoc_simple_parse_convert(dev
, port
, NULL
, adata
);
176 asoc_simple_parse_convert(dev
, ep
, NULL
, adata
);
183 static void graph_parse_mclk_fs(struct device_node
*top
,
184 struct device_node
*ep
,
185 struct simple_dai_props
*props
)
187 struct device_node
*port
= of_get_parent(ep
);
188 struct device_node
*ports
= of_get_parent(port
);
189 struct device_node
*node
= of_graph_get_port_parent(ep
);
191 of_property_read_u32(top
, "mclk-fs", &props
->mclk_fs
);
192 of_property_read_u32(ports
, "mclk-fs", &props
->mclk_fs
);
193 of_property_read_u32(port
, "mclk-fs", &props
->mclk_fs
);
194 of_property_read_u32(ep
, "mclk-fs", &props
->mclk_fs
);
201 static int graph_dai_link_of_dpcm(struct asoc_simple_priv
*priv
,
202 struct device_node
*cpu_ep
,
203 struct device_node
*codec_ep
,
204 struct link_info
*li
,
207 struct device
*dev
= simple_priv_to_dev(priv
);
208 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, li
->link
);
209 struct simple_dai_props
*dai_props
= simple_priv_to_props(priv
, li
->link
);
210 struct device_node
*top
= dev
->of_node
;
211 struct device_node
*ep
= li
->cpu
? cpu_ep
: codec_ep
;
212 struct device_node
*port
;
213 struct device_node
*ports
;
214 struct device_node
*node
;
215 struct asoc_simple_dai
*dai
;
216 struct snd_soc_dai_link_component
*cpus
= dai_link
->cpus
;
217 struct snd_soc_dai_link_component
*codecs
= dai_link
->codecs
;
220 /* Do it all CPU endpoint, and 1st Codec endpoint */
221 if (!li
->cpu
&& dup_codec
)
224 port
= of_get_parent(ep
);
225 ports
= of_get_parent(port
);
226 node
= of_graph_get_port_parent(ep
);
230 dev_dbg(dev
, "link_of DPCM (%pOF)\n", ep
);
233 int is_single_links
= 0;
236 codecs
->of_node
= NULL
;
237 codecs
->dai_name
= "snd-soc-dummy-dai";
238 codecs
->name
= "snd-soc-dummy";
241 dai_link
->dynamic
= 1;
242 dai_link
->dpcm_merged_format
= 1;
245 dai_props
->cpu_dai
= &priv
->dais
[li
->dais
++];
247 ret
= asoc_simple_parse_cpu(ep
, dai_link
, &is_single_links
);
251 ret
= asoc_simple_parse_clk_cpu(dev
, ep
, dai_link
, dai
);
255 ret
= asoc_simple_set_dailink_name(dev
, dai_link
,
261 /* card->num_links includes Codec */
262 asoc_simple_canonicalize_cpu(dai_link
, is_single_links
);
264 struct snd_soc_codec_conf
*cconf
;
267 cpus
->of_node
= NULL
;
268 cpus
->dai_name
= "snd-soc-dummy-dai";
269 cpus
->name
= "snd-soc-dummy";
272 dai_link
->no_pcm
= 1;
273 dai_link
->be_hw_params_fixup
= asoc_simple_be_hw_params_fixup
;
276 dai_props
->codec_dai
= &priv
->dais
[li
->dais
++];
279 dai_props
->codec_conf
= &priv
->codec_conf
[li
->conf
++];
281 ret
= asoc_simple_parse_codec(ep
, dai_link
);
285 ret
= asoc_simple_parse_clk_codec(dev
, ep
, dai_link
, dai
);
289 ret
= asoc_simple_set_dailink_name(dev
, dai_link
,
295 /* check "prefix" from top node */
296 snd_soc_of_parse_node_prefix(top
, cconf
, codecs
->of_node
,
298 snd_soc_of_parse_node_prefix(node
, cconf
, codecs
->of_node
,
300 snd_soc_of_parse_node_prefix(ports
, cconf
, codecs
->of_node
,
302 snd_soc_of_parse_node_prefix(port
, cconf
, codecs
->of_node
,
306 graph_parse_convert(dev
, ep
, &dai_props
->adata
);
307 graph_parse_mclk_fs(top
, ep
, dai_props
);
309 asoc_simple_canonicalize_platform(dai_link
);
311 ret
= asoc_simple_parse_tdm(ep
, dai
);
315 ret
= asoc_simple_parse_daifmt(dev
, cpu_ep
, codec_ep
,
316 NULL
, &dai_link
->dai_fmt
);
320 dai_link
->dpcm_playback
= 1;
321 dai_link
->dpcm_capture
= 1;
322 dai_link
->ops
= &graph_ops
;
323 dai_link
->init
= asoc_simple_dai_init
;
332 static int graph_dai_link_of(struct asoc_simple_priv
*priv
,
333 struct device_node
*cpu_ep
,
334 struct device_node
*codec_ep
,
335 struct link_info
*li
)
337 struct device
*dev
= simple_priv_to_dev(priv
);
338 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, li
->link
);
339 struct simple_dai_props
*dai_props
= simple_priv_to_props(priv
, li
->link
);
340 struct device_node
*top
= dev
->of_node
;
341 struct asoc_simple_dai
*cpu_dai
;
342 struct asoc_simple_dai
*codec_dai
;
345 /* Do it only CPU turn */
349 dev_dbg(dev
, "link_of (%pOF)\n", cpu_ep
);
354 dai_props
->cpu_dai
= &priv
->dais
[li
->dais
++];
356 dai_props
->codec_dai
= &priv
->dais
[li
->dais
++];
358 /* Factor to mclk, used in hw_params() */
359 graph_parse_mclk_fs(top
, cpu_ep
, dai_props
);
360 graph_parse_mclk_fs(top
, codec_ep
, dai_props
);
362 ret
= asoc_simple_parse_daifmt(dev
, cpu_ep
, codec_ep
,
363 NULL
, &dai_link
->dai_fmt
);
367 ret
= asoc_simple_parse_cpu(cpu_ep
, dai_link
, &single_cpu
);
371 ret
= asoc_simple_parse_codec(codec_ep
, dai_link
);
375 ret
= asoc_simple_parse_tdm(cpu_ep
, cpu_dai
);
379 ret
= asoc_simple_parse_tdm(codec_ep
, codec_dai
);
383 ret
= asoc_simple_parse_clk_cpu(dev
, cpu_ep
, dai_link
, cpu_dai
);
387 ret
= asoc_simple_parse_clk_codec(dev
, codec_ep
, dai_link
, codec_dai
);
391 ret
= asoc_simple_set_dailink_name(dev
, dai_link
,
393 dai_link
->cpus
->dai_name
,
394 dai_link
->codecs
->dai_name
);
398 dai_link
->ops
= &graph_ops
;
399 dai_link
->init
= asoc_simple_dai_init
;
401 asoc_simple_canonicalize_cpu(dai_link
, single_cpu
);
402 asoc_simple_canonicalize_platform(dai_link
);
407 static int graph_for_each_link(struct asoc_simple_priv
*priv
,
408 struct link_info
*li
,
409 int (*func_noml
)(struct asoc_simple_priv
*priv
,
410 struct device_node
*cpu_ep
,
411 struct device_node
*codec_ep
,
412 struct link_info
*li
),
413 int (*func_dpcm
)(struct asoc_simple_priv
*priv
,
414 struct device_node
*cpu_ep
,
415 struct device_node
*codec_ep
,
416 struct link_info
*li
, int dup_codec
))
418 struct of_phandle_iterator it
;
419 struct device
*dev
= simple_priv_to_dev(priv
);
420 struct device_node
*node
= dev
->of_node
;
421 struct device_node
*cpu_port
;
422 struct device_node
*cpu_ep
;
423 struct device_node
*codec_ep
;
424 struct device_node
*codec_port
;
425 struct device_node
*codec_port_old
= NULL
;
426 struct asoc_simple_data adata
;
427 uintptr_t dpcm_selectable
= (uintptr_t)of_device_get_match_data(dev
);
430 /* loop for all listed CPU port */
431 of_for_each_phandle(&it
, rc
, node
, "dais", NULL
, 0) {
435 /* loop for all CPU endpoint */
437 cpu_ep
= of_get_next_child(cpu_port
, cpu_ep
);
442 codec_ep
= of_graph_get_remote_endpoint(cpu_ep
);
443 codec_port
= of_get_parent(codec_ep
);
445 /* get convert-xxx property */
446 memset(&adata
, 0, sizeof(adata
));
447 graph_parse_convert(dev
, codec_ep
, &adata
);
448 graph_parse_convert(dev
, cpu_ep
, &adata
);
452 * if Codec port has many endpoints,
453 * or has convert-xxx property
455 if (dpcm_selectable
&&
456 ((of_get_child_count(codec_port
) > 1) ||
457 adata
.convert_rate
|| adata
.convert_channels
))
458 ret
= func_dpcm(priv
, cpu_ep
, codec_ep
, li
,
459 (codec_port_old
== codec_port
));
460 /* else normal sound */
462 ret
= func_noml(priv
, cpu_ep
, codec_ep
, li
);
464 of_node_put(codec_ep
);
465 of_node_put(codec_port
);
470 codec_port_old
= codec_port
;
477 static int graph_parse_of(struct asoc_simple_priv
*priv
)
479 struct snd_soc_card
*card
= simple_priv_to_card(priv
);
483 ret
= asoc_simple_parse_widgets(card
, NULL
);
487 ret
= asoc_simple_parse_routing(card
, NULL
);
491 memset(&li
, 0, sizeof(li
));
492 for (li
.cpu
= 1; li
.cpu
>= 0; li
.cpu
--) {
494 * Detect all CPU first, and Detect all Codec 2nd.
496 * In Normal sound case, all DAIs are detected
499 * In DPCM sound case,
500 * all CPUs are detected as "CPU-dummy", and
501 * all Codecs are detected as "dummy-Codec".
502 * To avoid random sub-device numbering,
503 * detect "dummy-Codec" in last;
505 ret
= graph_for_each_link(priv
, &li
,
507 graph_dai_link_of_dpcm
);
512 return asoc_simple_parse_card_name(card
, NULL
);
515 static int graph_count_noml(struct asoc_simple_priv
*priv
,
516 struct device_node
*cpu_ep
,
517 struct device_node
*codec_ep
,
518 struct link_info
*li
)
520 struct device
*dev
= simple_priv_to_dev(priv
);
522 li
->link
+= 1; /* 1xCPU-Codec */
523 li
->dais
+= 2; /* 1xCPU + 1xCodec */
525 dev_dbg(dev
, "Count As Normal\n");
530 static int graph_count_dpcm(struct asoc_simple_priv
*priv
,
531 struct device_node
*cpu_ep
,
532 struct device_node
*codec_ep
,
533 struct link_info
*li
,
536 struct device
*dev
= simple_priv_to_dev(priv
);
538 li
->link
++; /* 1xCPU-dummy */
539 li
->dais
++; /* 1xCPU */
542 li
->link
++; /* 1xdummy-Codec */
543 li
->conf
++; /* 1xdummy-Codec */
544 li
->dais
++; /* 1xCodec */
547 dev_dbg(dev
, "Count As DPCM\n");
552 static void graph_get_dais_count(struct asoc_simple_priv
*priv
,
553 struct link_info
*li
)
555 struct device
*dev
= simple_priv_to_dev(priv
);
558 * link_num : number of links.
559 * CPU-Codec / CPU-dummy / dummy-Codec
560 * dais_num : number of DAIs
561 * ccnf_num : number of codec_conf
562 * same number for "dummy-Codec"
565 * CPU0 --- Codec0 link : 5
566 * CPU1 --- Codec1 dais : 7
570 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
571 * => 7 DAIs = 4xCPU + 3xCodec
572 * => 1 ccnf = 1xdummy-Codec
575 * CPU0 --- Codec0 link : 5
576 * CPU1 --- Codec1 dais : 6
580 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
581 * => 6 DAIs = 4xCPU + 2xCodec
582 * => 1 ccnf = 1xdummy-Codec
585 * CPU0 --- Codec0 link : 6
587 * CPU2 --- Codec1 ccnf : 2
590 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
591 * => 6 DAIs = 4xCPU + 2xCodec
592 * => 2 ccnf = 2xdummy-Codec
595 * CPU0 --- Codec0 (convert-rate) link : 3
596 * CPU1 --- Codec1 dais : 4
599 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
600 * => 4 DAIs = 2xCPU + 2xCodec
601 * => 1 ccnf = 1xdummy-Codec
603 graph_for_each_link(priv
, li
,
606 dev_dbg(dev
, "link %d, dais %d, ccnf %d\n",
607 li
->link
, li
->dais
, li
->conf
);
610 static int graph_card_probe(struct snd_soc_card
*card
)
612 struct asoc_simple_priv
*priv
= snd_soc_card_get_drvdata(card
);
615 ret
= asoc_simple_init_hp(card
, &priv
->hp_jack
, NULL
);
619 ret
= asoc_simple_init_mic(card
, &priv
->mic_jack
, NULL
);
626 static int graph_probe(struct platform_device
*pdev
)
628 struct asoc_simple_priv
*priv
;
629 struct device
*dev
= &pdev
->dev
;
630 struct snd_soc_card
*card
;
634 /* Allocate the private data and the DAI link array */
635 priv
= devm_kzalloc(dev
, sizeof(*priv
), GFP_KERNEL
);
639 card
= simple_priv_to_card(priv
);
640 card
->owner
= THIS_MODULE
;
642 card
->dapm_widgets
= graph_dapm_widgets
;
643 card
->num_dapm_widgets
= ARRAY_SIZE(graph_dapm_widgets
);
644 card
->probe
= graph_card_probe
;
646 memset(&li
, 0, sizeof(li
));
647 graph_get_dais_count(priv
, &li
);
648 if (!li
.link
|| !li
.dais
)
651 ret
= asoc_simple_init_priv(priv
, &li
);
655 priv
->pa_gpio
= devm_gpiod_get_optional(dev
, "pa", GPIOD_OUT_LOW
);
656 if (IS_ERR(priv
->pa_gpio
)) {
657 ret
= PTR_ERR(priv
->pa_gpio
);
658 dev_err(dev
, "failed to get amplifier gpio: %d\n", ret
);
662 ret
= graph_parse_of(priv
);
664 if (ret
!= -EPROBE_DEFER
)
665 dev_err(dev
, "parse error %d\n", ret
);
669 snd_soc_card_set_drvdata(card
, priv
);
671 asoc_simple_debug_info(priv
);
673 ret
= devm_snd_soc_register_card(dev
, card
);
679 asoc_simple_clean_reference(card
);
684 static int graph_remove(struct platform_device
*pdev
)
686 struct snd_soc_card
*card
= platform_get_drvdata(pdev
);
688 return asoc_simple_clean_reference(card
);
691 static const struct of_device_id graph_of_match
[] = {
692 { .compatible
= "audio-graph-card", },
693 { .compatible
= "audio-graph-scu-card",
694 .data
= (void *)DPCM_SELECTABLE
},
697 MODULE_DEVICE_TABLE(of
, graph_of_match
);
699 static struct platform_driver graph_card
= {
701 .name
= "asoc-audio-graph-card",
702 .pm
= &snd_soc_pm_ops
,
703 .of_match_table
= graph_of_match
,
705 .probe
= graph_probe
,
706 .remove
= graph_remove
,
708 module_platform_driver(graph_card
);
710 MODULE_ALIAS("platform:asoc-audio-graph-card");
711 MODULE_LICENSE("GPL v2");
712 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card");
713 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");