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>
18 struct simple_card_data {
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 platform;
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;
36 #define simple_priv_to_card(priv) (&(priv)->snd_card)
37 #define simple_priv_to_props(priv, i) ((priv)->dai_props + (i))
38 #define simple_priv_to_dev(priv) (simple_priv_to_card(priv)->dev)
39 #define simple_priv_to_link(priv, i) (simple_priv_to_card(priv)->dai_link + (i))
41 #define DAI "sound-dai"
42 #define CELL "#sound-dai-cells"
43 #define PREFIX "simple-audio-card,"
45 static int asoc_simple_card_startup(struct snd_pcm_substream *substream)
47 struct snd_soc_pcm_runtime *rtd = substream->private_data;
48 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
49 struct simple_dai_props *dai_props =
50 simple_priv_to_props(priv, rtd->num);
53 ret = asoc_simple_card_clk_enable(dai_props->cpu_dai);
57 ret = asoc_simple_card_clk_enable(dai_props->codec_dai);
59 asoc_simple_card_clk_disable(dai_props->cpu_dai);
64 static void asoc_simple_card_shutdown(struct snd_pcm_substream *substream)
66 struct snd_soc_pcm_runtime *rtd = substream->private_data;
67 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
68 struct simple_dai_props *dai_props =
69 simple_priv_to_props(priv, rtd->num);
71 asoc_simple_card_clk_disable(dai_props->cpu_dai);
73 asoc_simple_card_clk_disable(dai_props->codec_dai);
76 static int asoc_simple_set_clk_rate(struct asoc_simple_dai *simple_dai,
85 if (clk_get_rate(simple_dai->clk) == rate)
88 return clk_set_rate(simple_dai->clk, rate);
91 static int asoc_simple_card_hw_params(struct snd_pcm_substream *substream,
92 struct snd_pcm_hw_params *params)
94 struct snd_soc_pcm_runtime *rtd = substream->private_data;
95 struct snd_soc_dai *codec_dai = rtd->codec_dai;
96 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
97 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
98 struct simple_dai_props *dai_props =
99 simple_priv_to_props(priv, rtd->num);
100 unsigned int mclk, mclk_fs = 0;
103 if (dai_props->mclk_fs)
104 mclk_fs = dai_props->mclk_fs;
107 mclk = params_rate(params) * mclk_fs;
109 ret = asoc_simple_set_clk_rate(dai_props->codec_dai, mclk);
113 ret = asoc_simple_set_clk_rate(dai_props->cpu_dai, mclk);
117 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
119 if (ret && ret != -ENOTSUPP)
122 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
124 if (ret && ret != -ENOTSUPP)
132 static const struct snd_soc_ops asoc_simple_card_ops = {
133 .startup = asoc_simple_card_startup,
134 .shutdown = asoc_simple_card_shutdown,
135 .hw_params = asoc_simple_card_hw_params,
138 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
140 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
141 struct simple_dai_props *dai_props = simple_priv_to_props(priv, rtd->num);
144 ret = asoc_simple_card_init_dai(rtd->codec_dai,
145 dai_props->codec_dai);
149 ret = asoc_simple_card_init_dai(rtd->cpu_dai,
157 static int asoc_simple_card_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
158 struct snd_pcm_hw_params *params)
160 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
161 struct simple_dai_props *dai_props = simple_priv_to_props(priv, rtd->num);
163 asoc_simple_card_convert_fixup(&dai_props->adata, params);
168 static int asoc_simple_card_dai_link_of_dpcm(struct device_node *top,
169 struct device_node *node,
170 struct device_node *np,
171 struct device_node *codec,
172 struct simple_card_data *priv,
173 int *dai_idx, int link_idx,
174 int *conf_idx, int is_fe,
175 bool is_top_level_node)
177 struct device *dev = simple_priv_to_dev(priv);
178 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, link_idx);
179 struct simple_dai_props *dai_props = simple_priv_to_props(priv, link_idx);
180 struct asoc_simple_dai *dai;
181 struct snd_soc_dai_link_component *codecs = dai_link->codecs;
187 /* For single DAI link & old style of DT node */
188 if (is_top_level_node)
192 int is_single_links = 0;
195 codecs->of_node = NULL;
196 codecs->dai_name = "snd-soc-dummy-dai";
197 codecs->name = "snd-soc-dummy";
200 dai_link->dynamic = 1;
201 dai_link->dpcm_merged_format = 1;
204 dai_props->cpu_dai = &priv->dais[(*dai_idx)++];
206 ret = asoc_simple_card_parse_cpu(np, dai_link, DAI, CELL,
211 ret = asoc_simple_card_parse_clk_cpu(dev, np, dai_link, dai);
215 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
217 dai_link->cpu_dai_name);
221 asoc_simple_card_canonicalize_cpu(dai_link, is_single_links);
223 struct snd_soc_codec_conf *cconf;
226 dai_link->cpu_of_node = NULL;
227 dai_link->cpu_dai_name = "snd-soc-dummy-dai";
228 dai_link->cpu_name = "snd-soc-dummy";
231 dai_link->no_pcm = 1;
232 dai_link->be_hw_params_fixup = asoc_simple_card_be_hw_params_fixup;
235 dai_props->codec_dai = &priv->dais[(*dai_idx)++];
238 dai_props->codec_conf = &priv->codec_conf[(*conf_idx)++];
240 ret = asoc_simple_card_parse_codec(np, dai_link, DAI, CELL);
244 ret = asoc_simple_card_parse_clk_codec(dev, np, dai_link, dai);
248 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
254 /* check "prefix" from top node */
255 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node,
257 snd_soc_of_parse_node_prefix(node, cconf, codecs->of_node,
259 snd_soc_of_parse_node_prefix(np, cconf, codecs->of_node,
263 asoc_simple_card_parse_convert(dev, top, PREFIX, &dai_props->adata);
264 asoc_simple_card_parse_convert(dev, node, prefix, &dai_props->adata);
265 asoc_simple_card_parse_convert(dev, np, NULL, &dai_props->adata);
267 ret = asoc_simple_card_of_parse_tdm(np, dai);
271 ret = asoc_simple_card_canonicalize_dailink(dai_link);
275 snprintf(prop, sizeof(prop), "%smclk-fs", prefix);
276 of_property_read_u32(top, PREFIX "mclk-fs", &dai_props->mclk_fs);
277 of_property_read_u32(node, prop, &dai_props->mclk_fs);
278 of_property_read_u32(np, prop, &dai_props->mclk_fs);
280 ret = asoc_simple_card_parse_daifmt(dev, node, codec,
281 prefix, &dai_link->dai_fmt);
285 dai_link->dpcm_playback = 1;
286 dai_link->dpcm_capture = 1;
287 dai_link->ops = &asoc_simple_card_ops;
288 dai_link->init = asoc_simple_card_dai_init;
293 static int asoc_simple_card_dai_link_of(struct device_node *top,
294 struct device_node *node,
295 struct simple_card_data *priv,
296 int *dai_idx, int link_idx,
297 bool is_top_level_node)
299 struct device *dev = simple_priv_to_dev(priv);
300 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, link_idx);
301 struct simple_dai_props *dai_props = simple_priv_to_props(priv, link_idx);
302 struct asoc_simple_dai *cpu_dai;
303 struct asoc_simple_dai *codec_dai;
304 struct device_node *cpu = NULL;
305 struct device_node *plat = NULL;
306 struct device_node *codec = NULL;
311 /* For single DAI link & old style of DT node */
312 if (is_top_level_node)
315 snprintf(prop, sizeof(prop), "%scpu", prefix);
316 cpu = of_get_child_by_name(node, prop);
320 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
321 goto dai_link_of_err;
324 snprintf(prop, sizeof(prop), "%splat", prefix);
325 plat = of_get_child_by_name(node, prop);
327 snprintf(prop, sizeof(prop), "%scodec", prefix);
328 codec = of_get_child_by_name(node, prop);
332 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
333 goto dai_link_of_err;
337 dai_props->cpu_dai = &priv->dais[(*dai_idx)++];
339 dai_props->codec_dai = &priv->dais[(*dai_idx)++];
341 ret = asoc_simple_card_parse_daifmt(dev, node, codec,
342 prefix, &dai_link->dai_fmt);
344 goto dai_link_of_err;
346 snprintf(prop, sizeof(prop), "%smclk-fs", prefix);
347 of_property_read_u32(top, PREFIX "mclk-fs", &dai_props->mclk_fs);
348 of_property_read_u32(node, prop, &dai_props->mclk_fs);
349 of_property_read_u32(cpu, prop, &dai_props->mclk_fs);
350 of_property_read_u32(codec, prop, &dai_props->mclk_fs);
352 ret = asoc_simple_card_parse_cpu(cpu, dai_link,
353 DAI, CELL, &single_cpu);
355 goto dai_link_of_err;
357 ret = asoc_simple_card_parse_codec(codec, dai_link, DAI, CELL);
359 goto dai_link_of_err;
361 ret = asoc_simple_card_parse_platform(plat, dai_link, DAI, CELL);
363 goto dai_link_of_err;
365 ret = asoc_simple_card_of_parse_tdm(cpu, cpu_dai);
367 goto dai_link_of_err;
369 ret = asoc_simple_card_of_parse_tdm(codec, codec_dai);
371 goto dai_link_of_err;
373 ret = asoc_simple_card_parse_clk_cpu(dev, cpu, dai_link, cpu_dai);
375 goto dai_link_of_err;
377 ret = asoc_simple_card_parse_clk_codec(dev, codec, dai_link, codec_dai);
379 goto dai_link_of_err;
381 ret = asoc_simple_card_canonicalize_dailink(dai_link);
383 goto dai_link_of_err;
385 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
387 dai_link->cpu_dai_name,
388 dai_link->codecs->dai_name);
390 goto dai_link_of_err;
392 dai_link->ops = &asoc_simple_card_ops;
393 dai_link->init = asoc_simple_card_dai_init;
395 asoc_simple_card_canonicalize_cpu(dai_link, single_cpu);
404 static int asoc_simple_card_parse_aux_devs(struct device_node *node,
405 struct simple_card_data *priv)
407 struct device *dev = simple_priv_to_dev(priv);
408 struct device_node *aux_node;
409 struct snd_soc_card *card = simple_priv_to_card(priv);
412 if (!of_find_property(node, PREFIX "aux-devs", &len))
413 return 0; /* Ok to have no aux-devs */
415 n = len / sizeof(__be32);
419 card->aux_dev = devm_kcalloc(dev,
420 n, sizeof(*card->aux_dev), GFP_KERNEL);
424 for (i = 0; i < n; i++) {
425 aux_node = of_parse_phandle(node, PREFIX "aux-devs", i);
428 card->aux_dev[i].codec_of_node = aux_node;
431 card->num_aux_devs = n;
435 static int asoc_simple_card_parse_of(struct simple_card_data *priv)
437 struct device *dev = simple_priv_to_dev(priv);
438 struct device_node *top = dev->of_node;
439 struct snd_soc_card *card = simple_priv_to_card(priv);
440 struct device_node *node;
441 struct device_node *np;
442 struct device_node *codec;
445 int dai_idx, link_idx, conf_idx;
450 ret = asoc_simple_card_of_parse_widgets(card, PREFIX);
454 ret = asoc_simple_card_of_parse_routing(card, PREFIX);
458 /* Single/Muti DAI link(s) & New style of DT node */
463 node = of_get_child_by_name(top, PREFIX "dai-link");
471 if (of_get_child_count(node) > 2) {
472 for_each_child_of_node(node, np) {
473 codec = of_get_child_by_name(node,
479 is_fe = (np != codec);
481 ret = asoc_simple_card_dai_link_of_dpcm(
482 top, node, np, codec, priv,
483 &dai_idx, link_idx++, &conf_idx,
487 ret = asoc_simple_card_dai_link_of(
489 &dai_idx, link_idx++, !loop);
494 node = of_get_next_child(top, node);
495 } while (loop && node);
497 ret = asoc_simple_card_parse_card_name(card, PREFIX);
501 ret = asoc_simple_card_parse_aux_devs(top, priv);
506 static void asoc_simple_card_get_dais_count(struct device *dev,
511 struct device_node *top = dev->of_node;
512 struct device_node *node;
517 * link_num : number of links.
518 * CPU-Codec / CPU-dummy / dummy-Codec
519 * dais_num : number of DAIs
520 * ccnf_num : number of codec_conf
521 * same number for "dummy-Codec"
524 * CPU0 --- Codec0 link : 5
525 * CPU1 --- Codec1 dais : 7
529 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec
530 * => 7 DAIs = 4xCPU + 3xCodec
531 * => 1 ccnf = 1xdummy-Codec
534 * CPU0 --- Codec0 link : 5
535 * CPU1 --- Codec1 dais : 6
539 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec
540 * => 6 DAIs = 4xCPU + 2xCodec
541 * => 1 ccnf = 1xdummy-Codec
544 * CPU0 --- Codec0 link : 6
546 * CPU2 --- Codec1 ccnf : 2
549 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec
550 * => 6 DAIs = 4xCPU + 2xCodec
551 * => 2 ccnf = 2xdummy-Codec
561 node = of_get_child_by_name(top, PREFIX "dai-link");
568 num = of_get_child_count(node);
576 node = of_get_next_child(top, node);
577 } while (loop && node);
580 static int asoc_simple_soc_card_probe(struct snd_soc_card *card)
582 struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
585 ret = asoc_simple_card_init_hp(card, &priv->hp_jack, PREFIX);
589 ret = asoc_simple_card_init_mic(card, &priv->mic_jack, PREFIX);
596 static int asoc_simple_card_probe(struct platform_device *pdev)
598 struct simple_card_data *priv;
599 struct snd_soc_dai_link *dai_link;
600 struct simple_dai_props *dai_props;
601 struct asoc_simple_dai *dais;
602 struct device *dev = &pdev->dev;
603 struct device_node *np = dev->of_node;
604 struct snd_soc_card *card;
605 struct snd_soc_codec_conf *cconf;
606 int lnum = 0, dnum = 0, cnum = 0;
609 /* Allocate the private data and the DAI link array */
610 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
614 asoc_simple_card_get_dais_count(dev, &lnum, &dnum, &cnum);
618 dai_props = devm_kcalloc(dev, lnum, sizeof(*dai_props), GFP_KERNEL);
619 dai_link = devm_kcalloc(dev, lnum, sizeof(*dai_link), GFP_KERNEL);
620 dais = devm_kcalloc(dev, dnum, sizeof(*dais), GFP_KERNEL);
621 cconf = devm_kcalloc(dev, cnum, sizeof(*cconf), GFP_KERNEL);
622 if (!dai_props || !dai_link || !dais)
626 * Use snd_soc_dai_link_component instead of legacy style
627 * It is codec only. but cpu/platform will be supported in the future.
629 * soc-core.c :: snd_soc_init_multicodec()
631 for (i = 0; i < lnum; i++) {
632 dai_link[i].codecs = &dai_props[i].codecs;
633 dai_link[i].num_codecs = 1;
634 dai_link[i].platform = &dai_props[i].platform;
637 priv->dai_props = dai_props;
638 priv->dai_link = dai_link;
640 priv->codec_conf = cconf;
642 /* Init snd_soc_card */
643 card = simple_priv_to_card(priv);
644 card->owner = THIS_MODULE;
646 card->dai_link = priv->dai_link;
647 card->num_links = lnum;
648 card->codec_conf = cconf;
649 card->num_configs = cnum;
650 card->probe = asoc_simple_soc_card_probe;
652 if (np && of_device_is_available(np)) {
654 ret = asoc_simple_card_parse_of(priv);
656 if (ret != -EPROBE_DEFER)
657 dev_err(dev, "parse error %d\n", ret);
662 struct asoc_simple_card_info *cinfo;
663 struct snd_soc_dai_link_component *codecs;
664 struct snd_soc_dai_link_component *platform;
667 cinfo = dev->platform_data;
669 dev_err(dev, "no info for asoc-simple-card\n");
674 !cinfo->codec_dai.name ||
677 !cinfo->cpu_dai.name) {
678 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
682 dai_props->cpu_dai = &priv->dais[dai_idx++];
683 dai_props->codec_dai = &priv->dais[dai_idx++];
685 codecs = dai_link->codecs;
686 codecs->name = cinfo->codec;
687 codecs->dai_name = cinfo->codec_dai.name;
689 platform = dai_link->platform;
690 platform->name = cinfo->platform;
692 card->name = (cinfo->card) ? cinfo->card : cinfo->name;
693 dai_link->name = cinfo->name;
694 dai_link->stream_name = cinfo->name;
695 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
696 dai_link->dai_fmt = cinfo->daifmt;
697 dai_link->init = asoc_simple_card_dai_init;
698 memcpy(priv->dai_props->cpu_dai, &cinfo->cpu_dai,
699 sizeof(*priv->dai_props->cpu_dai));
700 memcpy(priv->dai_props->codec_dai, &cinfo->codec_dai,
701 sizeof(*priv->dai_props->codec_dai));
704 snd_soc_card_set_drvdata(card, priv);
706 ret = devm_snd_soc_register_card(dev, card);
712 asoc_simple_card_clean_reference(card);
717 static int asoc_simple_card_remove(struct platform_device *pdev)
719 struct snd_soc_card *card = platform_get_drvdata(pdev);
721 return asoc_simple_card_clean_reference(card);
724 static const struct of_device_id asoc_simple_of_match[] = {
725 { .compatible = "simple-audio-card", },
726 { .compatible = "simple-scu-audio-card", },
729 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
731 static struct platform_driver asoc_simple_card = {
733 .name = "asoc-simple-card",
734 .pm = &snd_soc_pm_ops,
735 .of_match_table = asoc_simple_of_match,
737 .probe = asoc_simple_card_probe,
738 .remove = asoc_simple_card_remove,
741 module_platform_driver(asoc_simple_card);
743 MODULE_ALIAS("platform:asoc-simple-card");
744 MODULE_LICENSE("GPL v2");
745 MODULE_DESCRIPTION("ASoC Simple Sound Card");
746 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");