1 // SPDX-License-Identifier: GPL-2.0
3 // ASoC simple sound card support
5 // Copyright (C) 2012 Renesas Solutions Corp.
6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
9 #include <linux/device.h>
10 #include <linux/module.h>
12 #include <linux/platform_device.h>
13 #include <linux/string.h>
14 #include <sound/simple_card.h>
15 #include <sound/soc-dai.h>
16 #include <sound/soc.h>
19 struct snd_soc_card snd_card;
20 struct simple_dai_props {
21 struct asoc_simple_dai *cpu_dai;
22 struct asoc_simple_dai *codec_dai;
23 struct snd_soc_dai_link_component codecs; /* single codec */
24 struct snd_soc_dai_link_component platforms;
25 struct asoc_simple_card_data adata;
26 struct snd_soc_codec_conf *codec_conf;
29 struct asoc_simple_jack hp_jack;
30 struct asoc_simple_jack mic_jack;
31 struct snd_soc_dai_link *dai_link;
32 struct asoc_simple_dai *dais;
33 struct snd_soc_codec_conf *codec_conf;
37 int dais; /* number of dai */
38 int link; /* number of link */
39 int conf; /* number of codec_conf */
40 int cpu; /* turn for CPU / Codec */
43 #define simple_priv_to_card(priv) (&(priv)->snd_card)
44 #define simple_priv_to_props(priv, i) ((priv)->dai_props + (i))
45 #define simple_priv_to_dev(priv) (simple_priv_to_card(priv)->dev)
46 #define simple_priv_to_link(priv, i) (simple_priv_to_card(priv)->dai_link + (i))
48 #define DAI "sound-dai"
49 #define CELL "#sound-dai-cells"
50 #define PREFIX "simple-audio-card,"
52 static int simple_startup(struct snd_pcm_substream *substream)
54 struct snd_soc_pcm_runtime *rtd = substream->private_data;
55 struct simple_priv *priv = snd_soc_card_get_drvdata(rtd->card);
56 struct simple_dai_props *dai_props =
57 simple_priv_to_props(priv, rtd->num);
60 ret = asoc_simple_card_clk_enable(dai_props->cpu_dai);
64 ret = asoc_simple_card_clk_enable(dai_props->codec_dai);
66 asoc_simple_card_clk_disable(dai_props->cpu_dai);
71 static void simple_shutdown(struct snd_pcm_substream *substream)
73 struct snd_soc_pcm_runtime *rtd = substream->private_data;
74 struct simple_priv *priv = snd_soc_card_get_drvdata(rtd->card);
75 struct simple_dai_props *dai_props =
76 simple_priv_to_props(priv, rtd->num);
78 asoc_simple_card_clk_disable(dai_props->cpu_dai);
80 asoc_simple_card_clk_disable(dai_props->codec_dai);
83 static int simple_set_clk_rate(struct asoc_simple_dai *simple_dai,
92 if (clk_get_rate(simple_dai->clk) == rate)
95 return clk_set_rate(simple_dai->clk, rate);
98 static int simple_hw_params(struct snd_pcm_substream *substream,
99 struct snd_pcm_hw_params *params)
101 struct snd_soc_pcm_runtime *rtd = substream->private_data;
102 struct snd_soc_dai *codec_dai = rtd->codec_dai;
103 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
104 struct simple_priv *priv = snd_soc_card_get_drvdata(rtd->card);
105 struct simple_dai_props *dai_props =
106 simple_priv_to_props(priv, rtd->num);
107 unsigned int mclk, mclk_fs = 0;
110 if (dai_props->mclk_fs)
111 mclk_fs = dai_props->mclk_fs;
114 mclk = params_rate(params) * mclk_fs;
116 ret = simple_set_clk_rate(dai_props->codec_dai, mclk);
120 ret = simple_set_clk_rate(dai_props->cpu_dai, mclk);
124 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
126 if (ret && ret != -ENOTSUPP)
129 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
131 if (ret && ret != -ENOTSUPP)
139 static const struct snd_soc_ops simple_ops = {
140 .startup = simple_startup,
141 .shutdown = simple_shutdown,
142 .hw_params = simple_hw_params,
145 static int simple_dai_init(struct snd_soc_pcm_runtime *rtd)
147 struct simple_priv *priv = snd_soc_card_get_drvdata(rtd->card);
148 struct simple_dai_props *dai_props = simple_priv_to_props(priv, rtd->num);
151 ret = asoc_simple_card_init_dai(rtd->codec_dai,
152 dai_props->codec_dai);
156 ret = asoc_simple_card_init_dai(rtd->cpu_dai,
164 static int simple_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
165 struct snd_pcm_hw_params *params)
167 struct simple_priv *priv = snd_soc_card_get_drvdata(rtd->card);
168 struct simple_dai_props *dai_props = simple_priv_to_props(priv, rtd->num);
170 asoc_simple_card_convert_fixup(&dai_props->adata, params);
175 static void simple_get_conversion(struct device *dev,
176 struct device_node *np,
177 struct asoc_simple_card_data *adata)
179 struct device_node *top = dev->of_node;
180 struct device_node *node = of_get_parent(np);
182 asoc_simple_card_parse_convert(dev, top, PREFIX, adata);
183 asoc_simple_card_parse_convert(dev, node, PREFIX, adata);
184 asoc_simple_card_parse_convert(dev, node, NULL, adata);
185 asoc_simple_card_parse_convert(dev, np, NULL, adata);
190 static int simple_dai_link_of_dpcm(struct simple_priv *priv,
191 struct device_node *np,
192 struct device_node *codec,
193 struct link_info *li,
196 struct device *dev = simple_priv_to_dev(priv);
197 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
198 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
199 struct asoc_simple_dai *dai;
200 struct snd_soc_dai_link_component *codecs = dai_link->codecs;
201 struct device_node *top = dev->of_node;
202 struct device_node *node = of_get_parent(np);
213 if (li->cpu == (np == codec))
216 dev_dbg(dev, "link_of DPCM (%pOF)\n", np);
222 /* For single DAI link & old style of DT node */
227 int is_single_links = 0;
230 codecs->of_node = NULL;
231 codecs->dai_name = "snd-soc-dummy-dai";
232 codecs->name = "snd-soc-dummy";
235 dai_link->dynamic = 1;
236 dai_link->dpcm_merged_format = 1;
239 dai_props->cpu_dai = &priv->dais[li->dais++];
241 ret = asoc_simple_card_parse_cpu(np, dai_link, DAI, CELL,
246 ret = asoc_simple_card_parse_clk_cpu(dev, np, dai_link, dai);
250 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
252 dai_link->cpu_dai_name);
256 asoc_simple_card_canonicalize_cpu(dai_link, is_single_links);
258 struct snd_soc_codec_conf *cconf;
261 dai_link->cpu_of_node = NULL;
262 dai_link->cpu_dai_name = "snd-soc-dummy-dai";
263 dai_link->cpu_name = "snd-soc-dummy";
266 dai_link->no_pcm = 1;
267 dai_link->be_hw_params_fixup = simple_be_hw_params_fixup;
270 dai_props->codec_dai = &priv->dais[li->dais++];
273 dai_props->codec_conf = &priv->codec_conf[li->conf++];
275 ret = asoc_simple_card_parse_codec(np, dai_link, DAI, CELL);
279 ret = asoc_simple_card_parse_clk_codec(dev, np, dai_link, dai);
283 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
289 /* check "prefix" from top node */
290 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node,
292 snd_soc_of_parse_node_prefix(node, cconf, codecs->of_node,
294 snd_soc_of_parse_node_prefix(np, cconf, codecs->of_node,
298 simple_get_conversion(dev, np, &dai_props->adata);
300 asoc_simple_card_canonicalize_platform(dai_link);
302 ret = asoc_simple_card_of_parse_tdm(np, dai);
306 snprintf(prop, sizeof(prop), "%smclk-fs", prefix);
307 of_property_read_u32(top, PREFIX "mclk-fs", &dai_props->mclk_fs);
308 of_property_read_u32(node, prop, &dai_props->mclk_fs);
309 of_property_read_u32(np, prop, &dai_props->mclk_fs);
311 ret = asoc_simple_card_parse_daifmt(dev, node, codec,
312 prefix, &dai_link->dai_fmt);
316 dai_link->dpcm_playback = 1;
317 dai_link->dpcm_capture = 1;
318 dai_link->ops = &simple_ops;
319 dai_link->init = simple_dai_init;
324 static int simple_dai_link_of(struct simple_priv *priv,
325 struct device_node *np,
326 struct device_node *codec,
327 struct link_info *li,
330 struct device *dev = simple_priv_to_dev(priv);
331 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link);
332 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link);
333 struct asoc_simple_dai *cpu_dai;
334 struct asoc_simple_dai *codec_dai;
335 struct device_node *top = dev->of_node;
336 struct device_node *cpu = NULL;
337 struct device_node *node = NULL;
338 struct device_node *plat = NULL;
346 * Codec |return|return
349 if (!li->cpu || np == codec)
353 node = of_get_parent(np);
356 dev_dbg(dev, "link_of (%pOF)\n", node);
358 /* For single DAI link & old style of DT node */
362 snprintf(prop, sizeof(prop), "%splat", prefix);
363 plat = of_get_child_by_name(node, prop);
366 dai_props->cpu_dai = &priv->dais[li->dais++];
368 dai_props->codec_dai = &priv->dais[li->dais++];
370 ret = asoc_simple_card_parse_daifmt(dev, node, codec,
371 prefix, &dai_link->dai_fmt);
373 goto dai_link_of_err;
375 snprintf(prop, sizeof(prop), "%smclk-fs", prefix);
376 of_property_read_u32(top, PREFIX "mclk-fs", &dai_props->mclk_fs);
377 of_property_read_u32(node, prop, &dai_props->mclk_fs);
378 of_property_read_u32(cpu, prop, &dai_props->mclk_fs);
379 of_property_read_u32(codec, prop, &dai_props->mclk_fs);
381 ret = asoc_simple_card_parse_cpu(cpu, dai_link,
382 DAI, CELL, &single_cpu);
384 goto dai_link_of_err;
386 ret = asoc_simple_card_parse_codec(codec, dai_link, DAI, CELL);
388 goto dai_link_of_err;
390 ret = asoc_simple_card_parse_platform(plat, dai_link, DAI, CELL);
392 goto dai_link_of_err;
394 ret = asoc_simple_card_of_parse_tdm(cpu, cpu_dai);
396 goto dai_link_of_err;
398 ret = asoc_simple_card_of_parse_tdm(codec, codec_dai);
400 goto dai_link_of_err;
402 ret = asoc_simple_card_parse_clk_cpu(dev, cpu, dai_link, cpu_dai);
404 goto dai_link_of_err;
406 ret = asoc_simple_card_parse_clk_codec(dev, codec, dai_link, codec_dai);
408 goto dai_link_of_err;
410 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
412 dai_link->cpu_dai_name,
413 dai_link->codecs->dai_name);
415 goto dai_link_of_err;
417 dai_link->ops = &simple_ops;
418 dai_link->init = simple_dai_init;
420 asoc_simple_card_canonicalize_cpu(dai_link, single_cpu);
421 asoc_simple_card_canonicalize_platform(dai_link);
430 static int simple_for_each_link(struct simple_priv *priv,
431 struct link_info *li,
432 int (*func_noml)(struct simple_priv *priv,
433 struct device_node *np,
434 struct device_node *codec,
435 struct link_info *li, bool is_top),
436 int (*func_dpcm)(struct simple_priv *priv,
437 struct device_node *np,
438 struct device_node *codec,
439 struct link_info *li, bool is_top))
441 struct device *dev = simple_priv_to_dev(priv);
442 struct device_node *top = dev->of_node;
443 struct device_node *node;
446 /* Check if it has dai-link */
447 node = of_get_child_by_name(top, PREFIX "dai-link");
449 node = of_node_get(top);
453 /* loop for all dai-link */
455 struct asoc_simple_card_data adata;
456 struct device_node *codec;
457 struct device_node *np;
458 int num = of_get_child_count(node);
462 codec = of_get_child_by_name(node, is_top ?
463 PREFIX "codec" : "codec");
469 /* get convert-xxx property */
470 memset(&adata, 0, sizeof(adata));
471 for_each_child_of_node(node, np)
472 simple_get_conversion(dev, np, &adata);
474 /* loop for all CPU/Codec node */
475 for_each_child_of_node(node, np) {
478 * if it has many CPUs,
479 * or has convert-xxx property
482 adata.convert_rate || adata.convert_channels)
483 ret = func_dpcm(priv, np, codec, li, is_top);
484 /* else normal sound */
486 ret = func_noml(priv, np, codec, li, is_top);
492 node = of_get_next_child(top, node);
493 } while (!is_top && node);
498 static int simple_parse_aux_devs(struct device_node *node,
499 struct simple_priv *priv)
501 struct device *dev = simple_priv_to_dev(priv);
502 struct device_node *aux_node;
503 struct snd_soc_card *card = simple_priv_to_card(priv);
506 if (!of_find_property(node, PREFIX "aux-devs", &len))
507 return 0; /* Ok to have no aux-devs */
509 n = len / sizeof(__be32);
513 card->aux_dev = devm_kcalloc(dev,
514 n, sizeof(*card->aux_dev), GFP_KERNEL);
518 for (i = 0; i < n; i++) {
519 aux_node = of_parse_phandle(node, PREFIX "aux-devs", i);
522 card->aux_dev[i].codec_of_node = aux_node;
525 card->num_aux_devs = n;
529 static int simple_parse_of(struct simple_priv *priv)
531 struct device *dev = simple_priv_to_dev(priv);
532 struct device_node *top = dev->of_node;
533 struct snd_soc_card *card = simple_priv_to_card(priv);
540 ret = asoc_simple_card_of_parse_widgets(card, PREFIX);
544 ret = asoc_simple_card_of_parse_routing(card, PREFIX);
548 /* Single/Muti DAI link(s) & New style of DT node */
549 memset(&li, 0, sizeof(li));
550 for (li.cpu = 1; li.cpu >= 0; li.cpu--) {
552 * Detect all CPU first, and Detect all Codec 2nd.
554 * In Normal sound case, all DAIs are detected
557 * In DPCM sound case,
558 * all CPUs are detected as "CPU-dummy", and
559 * all Codecs are detected as "dummy-Codec".
560 * To avoid random sub-device numbering,
561 * detect "dummy-Codec" in last;
563 ret = simple_for_each_link(priv, &li,
565 simple_dai_link_of_dpcm);
570 ret = asoc_simple_card_parse_card_name(card, PREFIX);
574 ret = simple_parse_aux_devs(top, priv);
579 static int simple_count_noml(struct simple_priv *priv,
580 struct device_node *np,
581 struct device_node *codec,
582 struct link_info *li, bool is_top)
584 li->dais++; /* CPU or Codec */
586 li->link++; /* CPU-Codec */
591 static int simple_count_dpcm(struct simple_priv *priv,
592 struct device_node *np,
593 struct device_node *codec,
594 struct link_info *li, bool is_top)
596 li->dais++; /* CPU or Codec */
597 li->link++; /* CPU-dummy or dummy-Codec */
604 static void simple_get_dais_count(struct simple_priv *priv,
605 struct link_info *li)
607 struct device *dev = simple_priv_to_dev(priv);
608 struct device_node *top = dev->of_node;
611 * link_num : number of links.
612 * CPU-Codec / CPU-dummy / dummy-Codec
613 * dais_num : number of DAIs
614 * ccnf_num : number of codec_conf
615 * same number for "dummy-Codec"
618 * CPU0 --- Codec0 link : 5
619 * CPU1 --- Codec1 dais : 7
623 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
624 * => 7 DAIs = 4xCPU + 3xCodec
625 * => 1 ccnf = 1xdummy-Codec
628 * CPU0 --- Codec0 link : 5
629 * CPU1 --- Codec1 dais : 6
633 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
634 * => 6 DAIs = 4xCPU + 2xCodec
635 * => 1 ccnf = 1xdummy-Codec
638 * CPU0 --- Codec0 link : 6
640 * CPU2 --- Codec1 ccnf : 2
643 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
644 * => 6 DAIs = 4xCPU + 2xCodec
645 * => 2 ccnf = 2xdummy-Codec
648 * CPU0 --- Codec0 (convert-rate) link : 3
649 * CPU1 --- Codec1 dais : 4
652 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec
653 * => 4 DAIs = 2xCPU + 2xCodec
654 * => 1 ccnf = 1xdummy-Codec
663 simple_for_each_link(priv, li,
667 dev_dbg(dev, "link %d, dais %d, ccnf %d\n",
668 li->link, li->dais, li->conf);
671 static int simple_soc_probe(struct snd_soc_card *card)
673 struct simple_priv *priv = snd_soc_card_get_drvdata(card);
676 ret = asoc_simple_card_init_hp(card, &priv->hp_jack, PREFIX);
680 ret = asoc_simple_card_init_mic(card, &priv->mic_jack, PREFIX);
687 static int simple_probe(struct platform_device *pdev)
689 struct simple_priv *priv;
690 struct snd_soc_dai_link *dai_link;
691 struct simple_dai_props *dai_props;
692 struct asoc_simple_dai *dais;
693 struct device *dev = &pdev->dev;
694 struct device_node *np = dev->of_node;
695 struct snd_soc_card *card;
696 struct snd_soc_codec_conf *cconf;
700 /* Allocate the private data and the DAI link array */
701 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
705 card = simple_priv_to_card(priv);
706 card->owner = THIS_MODULE;
708 card->probe = simple_soc_probe;
710 memset(&li, 0, sizeof(li));
711 simple_get_dais_count(priv, &li);
712 if (!li.link || !li.dais)
715 dai_props = devm_kcalloc(dev, li.link, sizeof(*dai_props), GFP_KERNEL);
716 dai_link = devm_kcalloc(dev, li.link, sizeof(*dai_link), GFP_KERNEL);
717 dais = devm_kcalloc(dev, li.dais, sizeof(*dais), GFP_KERNEL);
718 cconf = devm_kcalloc(dev, li.conf, sizeof(*cconf), GFP_KERNEL);
719 if (!dai_props || !dai_link || !dais)
723 * Use snd_soc_dai_link_component instead of legacy style
724 * It is codec only. but cpu/platform will be supported in the future.
726 * soc-core.c :: snd_soc_init_multicodec()
728 for (i = 0; i < li.link; i++) {
729 dai_link[i].codecs = &dai_props[i].codecs;
730 dai_link[i].num_codecs = 1;
731 dai_link[i].platforms = &dai_props[i].platforms;
732 dai_link[i].num_platforms = 1;
735 priv->dai_props = dai_props;
736 priv->dai_link = dai_link;
738 priv->codec_conf = cconf;
740 card->dai_link = priv->dai_link;
741 card->num_links = li.link;
742 card->codec_conf = cconf;
743 card->num_configs = li.conf;
745 if (np && of_device_is_available(np)) {
747 ret = simple_parse_of(priv);
749 if (ret != -EPROBE_DEFER)
750 dev_err(dev, "parse error %d\n", ret);
755 struct asoc_simple_card_info *cinfo;
756 struct snd_soc_dai_link_component *codecs;
757 struct snd_soc_dai_link_component *platform;
760 cinfo = dev->platform_data;
762 dev_err(dev, "no info for asoc-simple-card\n");
767 !cinfo->codec_dai.name ||
770 !cinfo->cpu_dai.name) {
771 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
775 dai_props->cpu_dai = &priv->dais[dai_idx++];
776 dai_props->codec_dai = &priv->dais[dai_idx++];
778 codecs = dai_link->codecs;
779 codecs->name = cinfo->codec;
780 codecs->dai_name = cinfo->codec_dai.name;
782 platform = dai_link->platforms;
783 platform->name = cinfo->platform;
785 card->name = (cinfo->card) ? cinfo->card : cinfo->name;
786 dai_link->name = cinfo->name;
787 dai_link->stream_name = cinfo->name;
788 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
789 dai_link->dai_fmt = cinfo->daifmt;
790 dai_link->init = simple_dai_init;
791 memcpy(priv->dai_props->cpu_dai, &cinfo->cpu_dai,
792 sizeof(*priv->dai_props->cpu_dai));
793 memcpy(priv->dai_props->codec_dai, &cinfo->codec_dai,
794 sizeof(*priv->dai_props->codec_dai));
797 snd_soc_card_set_drvdata(card, priv);
799 ret = devm_snd_soc_register_card(dev, card);
805 asoc_simple_card_clean_reference(card);
810 static int simple_remove(struct platform_device *pdev)
812 struct snd_soc_card *card = platform_get_drvdata(pdev);
814 return asoc_simple_card_clean_reference(card);
817 static const struct of_device_id simple_of_match[] = {
818 { .compatible = "simple-audio-card", },
819 { .compatible = "simple-scu-audio-card", },
822 MODULE_DEVICE_TABLE(of, simple_of_match);
824 static struct platform_driver asoc_simple_card = {
826 .name = "asoc-simple-card",
827 .pm = &snd_soc_pm_ops,
828 .of_match_table = simple_of_match,
830 .probe = simple_probe,
831 .remove = simple_remove,
834 module_platform_driver(asoc_simple_card);
836 MODULE_ALIAS("platform:asoc-simple-card");
837 MODULE_LICENSE("GPL v2");
838 MODULE_DESCRIPTION("ASoC Simple Sound Card");
839 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");