2 * ASoC simple sound card support
4 * Copyright (C) 2012 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License version 2 as
9 * published by the Free Software Foundation.
11 #include <linux/clk.h>
12 #include <linux/device.h>
13 #include <linux/gpio.h>
14 #include <linux/module.h>
16 #include <linux/of_gpio.h>
17 #include <linux/platform_device.h>
18 #include <linux/string.h>
19 #include <sound/jack.h>
20 #include <sound/simple_card.h>
21 #include <sound/soc-dai.h>
22 #include <sound/soc.h>
24 struct simple_card_data {
25 struct snd_soc_card snd_card;
26 struct simple_dai_props {
27 struct asoc_simple_dai cpu_dai;
28 struct asoc_simple_dai codec_dai;
33 int gpio_hp_det_invert;
35 int gpio_mic_det_invert;
36 struct snd_soc_dai_link dai_link[]; /* dynamically allocated */
39 #define simple_priv_to_dev(priv) ((priv)->snd_card.dev)
40 #define simple_priv_to_link(priv, i) ((priv)->snd_card.dai_link + i)
41 #define simple_priv_to_props(priv, i) ((priv)->dai_props + i)
43 static int asoc_simple_card_startup(struct snd_pcm_substream *substream)
45 struct snd_soc_pcm_runtime *rtd = substream->private_data;
46 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
47 struct simple_dai_props *dai_props =
48 &priv->dai_props[rtd - rtd->card->rtd];
51 ret = clk_prepare_enable(dai_props->cpu_dai.clk);
55 ret = clk_prepare_enable(dai_props->codec_dai.clk);
57 clk_disable_unprepare(dai_props->cpu_dai.clk);
62 static void asoc_simple_card_shutdown(struct snd_pcm_substream *substream)
64 struct snd_soc_pcm_runtime *rtd = substream->private_data;
65 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
66 struct simple_dai_props *dai_props =
67 &priv->dai_props[rtd - rtd->card->rtd];
69 clk_disable_unprepare(dai_props->cpu_dai.clk);
71 clk_disable_unprepare(dai_props->codec_dai.clk);
74 static int asoc_simple_card_hw_params(struct snd_pcm_substream *substream,
75 struct snd_pcm_hw_params *params)
77 struct snd_soc_pcm_runtime *rtd = substream->private_data;
78 struct snd_soc_dai *codec_dai = rtd->codec_dai;
79 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
80 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
81 struct simple_dai_props *dai_props =
82 &priv->dai_props[rtd - rtd->card->rtd];
83 unsigned int mclk, mclk_fs = 0;
87 mclk_fs = priv->mclk_fs;
88 else if (dai_props->mclk_fs)
89 mclk_fs = dai_props->mclk_fs;
92 mclk = params_rate(params) * mclk_fs;
93 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
95 if (ret && ret != -ENOTSUPP)
98 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
100 if (ret && ret != -ENOTSUPP)
108 static struct snd_soc_ops asoc_simple_card_ops = {
109 .startup = asoc_simple_card_startup,
110 .shutdown = asoc_simple_card_shutdown,
111 .hw_params = asoc_simple_card_hw_params,
114 static struct snd_soc_jack simple_card_hp_jack;
115 static struct snd_soc_jack_pin simple_card_hp_jack_pins[] = {
118 .mask = SND_JACK_HEADPHONE,
121 static struct snd_soc_jack_gpio simple_card_hp_jack_gpio = {
122 .name = "Headphone detection",
123 .report = SND_JACK_HEADPHONE,
124 .debounce_time = 150,
127 static struct snd_soc_jack simple_card_mic_jack;
128 static struct snd_soc_jack_pin simple_card_mic_jack_pins[] = {
131 .mask = SND_JACK_MICROPHONE,
134 static struct snd_soc_jack_gpio simple_card_mic_jack_gpio = {
135 .name = "Mic detection",
136 .report = SND_JACK_MICROPHONE,
137 .debounce_time = 150,
140 static int __asoc_simple_card_dai_init(struct snd_soc_dai *dai,
141 struct asoc_simple_dai *set)
146 ret = snd_soc_dai_set_sysclk(dai, 0, set->sysclk, 0);
147 if (ret && ret != -ENOTSUPP) {
148 dev_err(dai->dev, "simple-card: set_sysclk error\n");
154 ret = snd_soc_dai_set_tdm_slot(dai, 0, 0,
157 if (ret && ret != -ENOTSUPP) {
158 dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
169 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
171 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
172 struct snd_soc_dai *codec = rtd->codec_dai;
173 struct snd_soc_dai *cpu = rtd->cpu_dai;
174 struct simple_dai_props *dai_props;
177 num = rtd - rtd->card->rtd;
178 dai_props = &priv->dai_props[num];
179 ret = __asoc_simple_card_dai_init(codec, &dai_props->codec_dai);
183 ret = __asoc_simple_card_dai_init(cpu, &dai_props->cpu_dai);
187 if (gpio_is_valid(priv->gpio_hp_det)) {
188 snd_soc_card_jack_new(rtd->card, "Headphones",
190 &simple_card_hp_jack,
191 simple_card_hp_jack_pins,
192 ARRAY_SIZE(simple_card_hp_jack_pins));
194 simple_card_hp_jack_gpio.gpio = priv->gpio_hp_det;
195 simple_card_hp_jack_gpio.invert = priv->gpio_hp_det_invert;
196 snd_soc_jack_add_gpios(&simple_card_hp_jack, 1,
197 &simple_card_hp_jack_gpio);
200 if (gpio_is_valid(priv->gpio_mic_det)) {
201 snd_soc_card_jack_new(rtd->card, "Mic Jack",
203 &simple_card_mic_jack,
204 simple_card_mic_jack_pins,
205 ARRAY_SIZE(simple_card_mic_jack_pins));
206 simple_card_mic_jack_gpio.gpio = priv->gpio_mic_det;
207 simple_card_mic_jack_gpio.invert = priv->gpio_mic_det_invert;
208 snd_soc_jack_add_gpios(&simple_card_mic_jack, 1,
209 &simple_card_mic_jack_gpio);
215 asoc_simple_card_sub_parse_of(struct device_node *np,
216 struct asoc_simple_dai *dai,
217 struct device_node **p_node,
221 struct of_phandle_args args;
227 * Get node via "sound-dai = <&phandle port>"
228 * it will be used as xxx_of_node on soc_bind_dai_link()
230 ret = of_parse_phandle_with_args(np, "sound-dai",
231 "#sound-dai-cells", 0, &args);
238 *args_count = args.args_count;
241 ret = snd_soc_of_get_dai_name(np, name);
246 ret = snd_soc_of_parse_tdm_slot(np, &dai->slots, &dai->slot_width);
251 * Parse dai->sysclk come from "clocks = <&xxx>"
252 * (if system has common clock)
253 * or "system-clock-frequency = <xxx>"
254 * or device's module clock.
256 if (of_property_read_bool(np, "clocks")) {
257 clk = of_clk_get(np, 0);
263 dai->sysclk = clk_get_rate(clk);
265 } else if (!of_property_read_u32(np, "system-clock-frequency", &val)) {
268 clk = of_clk_get(args.np, 0);
270 dai->sysclk = clk_get_rate(clk);
276 static int asoc_simple_card_parse_daifmt(struct device_node *node,
277 struct simple_card_data *priv,
278 struct device_node *codec,
279 char *prefix, int idx)
281 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
282 struct device *dev = simple_priv_to_dev(priv);
283 struct device_node *bitclkmaster = NULL;
284 struct device_node *framemaster = NULL;
287 daifmt = snd_soc_of_parse_daifmt(node, prefix,
288 &bitclkmaster, &framemaster);
289 daifmt &= ~SND_SOC_DAIFMT_MASTER_MASK;
291 if (strlen(prefix) && !bitclkmaster && !framemaster) {
293 * No dai-link level and master setting was not found from
294 * sound node level, revert back to legacy DT parsing and
295 * take the settings from codec node.
297 dev_dbg(dev, "Revert to legacy daifmt parsing\n");
299 daifmt = snd_soc_of_parse_daifmt(codec, NULL, NULL, NULL) |
300 (daifmt & ~SND_SOC_DAIFMT_CLOCK_MASK);
302 if (codec == bitclkmaster)
303 daifmt |= (codec == framemaster) ?
304 SND_SOC_DAIFMT_CBM_CFM : SND_SOC_DAIFMT_CBM_CFS;
306 daifmt |= (codec == framemaster) ?
307 SND_SOC_DAIFMT_CBS_CFM : SND_SOC_DAIFMT_CBS_CFS;
310 dai_link->dai_fmt = daifmt;
312 of_node_put(bitclkmaster);
313 of_node_put(framemaster);
318 static int asoc_simple_card_dai_link_of(struct device_node *node,
319 struct simple_card_data *priv,
321 bool is_top_level_node)
323 struct device *dev = simple_priv_to_dev(priv);
324 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
325 struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
326 struct device_node *cpu = NULL;
327 struct device_node *plat = NULL;
328 struct device_node *codec = NULL;
335 /* For single DAI link & old style of DT node */
336 if (is_top_level_node)
337 prefix = "simple-audio-card,";
339 snprintf(prop, sizeof(prop), "%scpu", prefix);
340 cpu = of_get_child_by_name(node, prop);
342 snprintf(prop, sizeof(prop), "%splat", prefix);
343 plat = of_get_child_by_name(node, prop);
345 snprintf(prop, sizeof(prop), "%scodec", prefix);
346 codec = of_get_child_by_name(node, prop);
348 if (!cpu || !codec) {
350 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
351 goto dai_link_of_err;
354 ret = asoc_simple_card_parse_daifmt(node, priv,
357 goto dai_link_of_err;
359 if (!of_property_read_u32(node, "mclk-fs", &val))
360 dai_props->mclk_fs = val;
362 ret = asoc_simple_card_sub_parse_of(cpu, &dai_props->cpu_dai,
363 &dai_link->cpu_of_node,
364 &dai_link->cpu_dai_name,
367 goto dai_link_of_err;
369 ret = asoc_simple_card_sub_parse_of(codec, &dai_props->codec_dai,
370 &dai_link->codec_of_node,
371 &dai_link->codec_dai_name, NULL);
373 goto dai_link_of_err;
375 if (!dai_link->cpu_dai_name || !dai_link->codec_dai_name) {
377 goto dai_link_of_err;
381 struct of_phandle_args args;
383 ret = of_parse_phandle_with_args(plat, "sound-dai",
384 "#sound-dai-cells", 0, &args);
385 dai_link->platform_of_node = args.np;
387 /* Assumes platform == cpu */
388 dai_link->platform_of_node = dai_link->cpu_of_node;
391 /* DAI link name is created from CPU/CODEC dai name */
392 name = devm_kzalloc(dev,
393 strlen(dai_link->cpu_dai_name) +
394 strlen(dai_link->codec_dai_name) + 2,
398 goto dai_link_of_err;
401 sprintf(name, "%s-%s", dai_link->cpu_dai_name,
402 dai_link->codec_dai_name);
403 dai_link->name = dai_link->stream_name = name;
404 dai_link->ops = &asoc_simple_card_ops;
405 dai_link->init = asoc_simple_card_dai_init;
407 dev_dbg(dev, "\tname : %s\n", dai_link->stream_name);
408 dev_dbg(dev, "\tformat : %04x\n", dai_link->dai_fmt);
409 dev_dbg(dev, "\tcpu : %s / %d\n",
410 dai_link->cpu_dai_name,
411 dai_props->cpu_dai.sysclk);
412 dev_dbg(dev, "\tcodec : %s / %d\n",
413 dai_link->codec_dai_name,
414 dai_props->codec_dai.sysclk);
417 * In soc_bind_dai_link() will check cpu name after
418 * of_node matching if dai_link has cpu_dai_name.
419 * but, it will never match if name was created by
420 * fmt_single_name() remove cpu_dai_name if cpu_args
423 * fmt_multiple_name()
426 dai_link->cpu_dai_name = NULL;
435 static int asoc_simple_card_parse_of(struct device_node *node,
436 struct simple_card_data *priv)
438 struct device *dev = simple_priv_to_dev(priv);
439 enum of_gpio_flags flags;
446 /* Parse the card name from DT */
447 snd_soc_of_parse_card_name(&priv->snd_card, "simple-audio-card,name");
449 /* The off-codec widgets */
450 if (of_property_read_bool(node, "simple-audio-card,widgets")) {
451 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
452 "simple-audio-card,widgets");
458 if (of_property_read_bool(node, "simple-audio-card,routing")) {
459 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
460 "simple-audio-card,routing");
465 /* Factor to mclk, used in hw_params() */
466 ret = of_property_read_u32(node, "simple-audio-card,mclk-fs", &val);
470 dev_dbg(dev, "New simple-card: %s\n", priv->snd_card.name ?
471 priv->snd_card.name : "");
473 /* Single/Muti DAI link(s) & New style of DT node */
474 if (of_get_child_by_name(node, "simple-audio-card,dai-link")) {
475 struct device_node *np = NULL;
478 for_each_child_of_node(node, np) {
479 dev_dbg(dev, "\tlink %d:\n", i);
480 ret = asoc_simple_card_dai_link_of(np, priv,
489 /* For single DAI link & old style of DT node */
490 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
495 priv->gpio_hp_det = of_get_named_gpio_flags(node,
496 "simple-audio-card,hp-det-gpio", 0, &flags);
497 priv->gpio_hp_det_invert = !!(flags & OF_GPIO_ACTIVE_LOW);
498 if (priv->gpio_hp_det == -EPROBE_DEFER)
499 return -EPROBE_DEFER;
501 priv->gpio_mic_det = of_get_named_gpio_flags(node,
502 "simple-audio-card,mic-det-gpio", 0, &flags);
503 priv->gpio_mic_det_invert = !!(flags & OF_GPIO_ACTIVE_LOW);
504 if (priv->gpio_mic_det == -EPROBE_DEFER)
505 return -EPROBE_DEFER;
507 if (!priv->snd_card.name)
508 priv->snd_card.name = priv->snd_card.dai_link->name;
513 /* Decrease the reference count of the device nodes */
514 static int asoc_simple_card_unref(struct snd_soc_card *card)
516 struct snd_soc_dai_link *dai_link;
519 for (num_links = 0, dai_link = card->dai_link;
520 num_links < card->num_links;
521 num_links++, dai_link++) {
522 of_node_put(dai_link->cpu_of_node);
523 of_node_put(dai_link->codec_of_node);
528 static int asoc_simple_card_probe(struct platform_device *pdev)
530 struct simple_card_data *priv;
531 struct snd_soc_dai_link *dai_link;
532 struct device_node *np = pdev->dev.of_node;
533 struct device *dev = &pdev->dev;
536 /* Get the number of DAI links */
537 if (np && of_get_child_by_name(np, "simple-audio-card,dai-link"))
538 num_links = of_get_child_count(np);
542 /* Allocate the private data and the DAI link array */
543 priv = devm_kzalloc(dev,
544 sizeof(*priv) + sizeof(*dai_link) * num_links,
549 /* Init snd_soc_card */
550 priv->snd_card.owner = THIS_MODULE;
551 priv->snd_card.dev = dev;
552 dai_link = priv->dai_link;
553 priv->snd_card.dai_link = dai_link;
554 priv->snd_card.num_links = num_links;
556 priv->gpio_hp_det = -ENOENT;
557 priv->gpio_mic_det = -ENOENT;
559 /* Get room for the other properties */
560 priv->dai_props = devm_kzalloc(dev,
561 sizeof(*priv->dai_props) * num_links,
563 if (!priv->dai_props)
566 if (np && of_device_is_available(np)) {
568 ret = asoc_simple_card_parse_of(np, priv);
570 if (ret != -EPROBE_DEFER)
571 dev_err(dev, "parse error %d\n", ret);
576 struct asoc_simple_card_info *cinfo;
578 cinfo = dev->platform_data;
580 dev_err(dev, "no info for asoc-simple-card\n");
585 !cinfo->codec_dai.name ||
588 !cinfo->cpu_dai.name) {
589 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
593 priv->snd_card.name = (cinfo->card) ? cinfo->card : cinfo->name;
594 dai_link->name = cinfo->name;
595 dai_link->stream_name = cinfo->name;
596 dai_link->platform_name = cinfo->platform;
597 dai_link->codec_name = cinfo->codec;
598 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
599 dai_link->codec_dai_name = cinfo->codec_dai.name;
600 dai_link->dai_fmt = cinfo->daifmt;
601 dai_link->init = asoc_simple_card_dai_init;
602 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
603 sizeof(priv->dai_props->cpu_dai));
604 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
605 sizeof(priv->dai_props->codec_dai));
609 snd_soc_card_set_drvdata(&priv->snd_card, priv);
611 ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
616 asoc_simple_card_unref(&priv->snd_card);
620 static int asoc_simple_card_remove(struct platform_device *pdev)
622 struct snd_soc_card *card = platform_get_drvdata(pdev);
623 struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
625 if (gpio_is_valid(priv->gpio_hp_det))
626 snd_soc_jack_free_gpios(&simple_card_hp_jack, 1,
627 &simple_card_hp_jack_gpio);
628 if (gpio_is_valid(priv->gpio_mic_det))
629 snd_soc_jack_free_gpios(&simple_card_mic_jack, 1,
630 &simple_card_mic_jack_gpio);
632 return asoc_simple_card_unref(card);
635 static const struct of_device_id asoc_simple_of_match[] = {
636 { .compatible = "simple-audio-card", },
639 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
641 static struct platform_driver asoc_simple_card = {
643 .name = "asoc-simple-card",
644 .of_match_table = asoc_simple_of_match,
646 .probe = asoc_simple_card_probe,
647 .remove = asoc_simple_card_remove,
650 module_platform_driver(asoc_simple_card);
652 MODULE_ALIAS("platform:asoc-simple-card");
653 MODULE_LICENSE("GPL");
654 MODULE_DESCRIPTION("ASoC Simple Sound Card");
655 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");