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;
32 int gpio_hp_det_invert;
34 int gpio_mic_det_invert;
35 struct snd_soc_dai_link dai_link[]; /* dynamically allocated */
38 #define simple_priv_to_dev(priv) ((priv)->snd_card.dev)
39 #define simple_priv_to_link(priv, i) ((priv)->snd_card.dai_link + i)
40 #define simple_priv_to_props(priv, i) ((priv)->dai_props + i)
42 static int asoc_simple_card_startup(struct snd_pcm_substream *substream)
44 struct snd_soc_pcm_runtime *rtd = substream->private_data;
45 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
46 struct simple_dai_props *dai_props =
47 &priv->dai_props[rtd - rtd->card->rtd];
50 ret = clk_prepare_enable(dai_props->cpu_dai.clk);
54 ret = clk_prepare_enable(dai_props->codec_dai.clk);
56 clk_disable_unprepare(dai_props->cpu_dai.clk);
61 static void asoc_simple_card_shutdown(struct snd_pcm_substream *substream)
63 struct snd_soc_pcm_runtime *rtd = substream->private_data;
64 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
65 struct simple_dai_props *dai_props =
66 &priv->dai_props[rtd - rtd->card->rtd];
68 clk_disable_unprepare(dai_props->cpu_dai.clk);
70 clk_disable_unprepare(dai_props->codec_dai.clk);
73 static int asoc_simple_card_hw_params(struct snd_pcm_substream *substream,
74 struct snd_pcm_hw_params *params)
76 struct snd_soc_pcm_runtime *rtd = substream->private_data;
77 struct snd_soc_dai *codec_dai = rtd->codec_dai;
78 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
83 mclk = params_rate(params) * priv->mclk_fs;
84 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
91 static struct snd_soc_ops asoc_simple_card_ops = {
92 .startup = asoc_simple_card_startup,
93 .shutdown = asoc_simple_card_shutdown,
94 .hw_params = asoc_simple_card_hw_params,
97 static struct snd_soc_jack simple_card_hp_jack;
98 static struct snd_soc_jack_pin simple_card_hp_jack_pins[] = {
101 .mask = SND_JACK_HEADPHONE,
104 static struct snd_soc_jack_gpio simple_card_hp_jack_gpio = {
105 .name = "Headphone detection",
106 .report = SND_JACK_HEADPHONE,
107 .debounce_time = 150,
110 static struct snd_soc_jack simple_card_mic_jack;
111 static struct snd_soc_jack_pin simple_card_mic_jack_pins[] = {
114 .mask = SND_JACK_MICROPHONE,
117 static struct snd_soc_jack_gpio simple_card_mic_jack_gpio = {
118 .name = "Mic detection",
119 .report = SND_JACK_MICROPHONE,
120 .debounce_time = 150,
123 static int __asoc_simple_card_dai_init(struct snd_soc_dai *dai,
124 struct asoc_simple_dai *set)
129 ret = snd_soc_dai_set_fmt(dai, set->fmt);
130 if (ret && ret != -ENOTSUPP) {
131 dev_err(dai->dev, "simple-card: set_fmt error\n");
137 ret = snd_soc_dai_set_sysclk(dai, 0, set->sysclk, 0);
138 if (ret && ret != -ENOTSUPP) {
139 dev_err(dai->dev, "simple-card: set_sysclk error\n");
145 ret = snd_soc_dai_set_tdm_slot(dai, 0, 0,
148 if (ret && ret != -ENOTSUPP) {
149 dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
160 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
162 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
163 struct snd_soc_dai *codec = rtd->codec_dai;
164 struct snd_soc_dai *cpu = rtd->cpu_dai;
165 struct simple_dai_props *dai_props;
168 num = rtd - rtd->card->rtd;
169 dai_props = &priv->dai_props[num];
170 ret = __asoc_simple_card_dai_init(codec, &dai_props->codec_dai);
174 ret = __asoc_simple_card_dai_init(cpu, &dai_props->cpu_dai);
178 if (gpio_is_valid(priv->gpio_hp_det)) {
179 snd_soc_jack_new(codec->codec, "Headphones", SND_JACK_HEADPHONE,
180 &simple_card_hp_jack);
181 snd_soc_jack_add_pins(&simple_card_hp_jack,
182 ARRAY_SIZE(simple_card_hp_jack_pins),
183 simple_card_hp_jack_pins);
185 simple_card_hp_jack_gpio.gpio = priv->gpio_hp_det;
186 simple_card_hp_jack_gpio.invert = priv->gpio_hp_det_invert;
187 snd_soc_jack_add_gpios(&simple_card_hp_jack, 1,
188 &simple_card_hp_jack_gpio);
191 if (gpio_is_valid(priv->gpio_mic_det)) {
192 snd_soc_jack_new(codec->codec, "Mic Jack", SND_JACK_MICROPHONE,
193 &simple_card_mic_jack);
194 snd_soc_jack_add_pins(&simple_card_mic_jack,
195 ARRAY_SIZE(simple_card_mic_jack_pins),
196 simple_card_mic_jack_pins);
197 simple_card_mic_jack_gpio.gpio = priv->gpio_mic_det;
198 simple_card_mic_jack_gpio.invert = priv->gpio_mic_det_invert;
199 snd_soc_jack_add_gpios(&simple_card_mic_jack, 1,
200 &simple_card_mic_jack_gpio);
206 asoc_simple_card_sub_parse_of(struct device_node *np,
207 struct asoc_simple_dai *dai,
208 struct device_node **p_node,
212 struct of_phandle_args args;
218 * Get node via "sound-dai = <&phandle port>"
219 * it will be used as xxx_of_node on soc_bind_dai_link()
221 ret = of_parse_phandle_with_args(np, "sound-dai",
222 "#sound-dai-cells", 0, &args);
229 *args_count = args.args_count;
232 ret = snd_soc_of_get_dai_name(np, name);
237 ret = snd_soc_of_parse_tdm_slot(np, &dai->slots, &dai->slot_width);
242 * Parse dai->sysclk come from "clocks = <&xxx>"
243 * (if system has common clock)
244 * or "system-clock-frequency = <xxx>"
245 * or device's module clock.
247 if (of_property_read_bool(np, "clocks")) {
248 clk = of_clk_get(np, 0);
254 dai->sysclk = clk_get_rate(clk);
256 } else if (!of_property_read_u32(np, "system-clock-frequency", &val)) {
259 clk = of_clk_get(args.np, 0);
261 dai->sysclk = clk_get_rate(clk);
267 static int asoc_simple_card_parse_daifmt(struct device_node *node,
268 struct simple_card_data *priv,
269 struct device_node *codec,
270 char *prefix, int idx)
272 struct device *dev = simple_priv_to_dev(priv);
273 struct device_node *bitclkmaster = NULL;
274 struct device_node *framemaster = NULL;
275 struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
276 struct asoc_simple_dai *cpu_dai = &dai_props->cpu_dai;
277 struct asoc_simple_dai *codec_dai = &dai_props->codec_dai;
280 daifmt = snd_soc_of_parse_daifmt(node, prefix,
281 &bitclkmaster, &framemaster);
282 daifmt &= ~SND_SOC_DAIFMT_MASTER_MASK;
284 if (strlen(prefix) && !bitclkmaster && !framemaster) {
286 * No dai-link level and master setting was not found from
287 * sound node level, revert back to legacy DT parsing and
288 * take the settings from codec node.
290 dev_dbg(dev, "Revert to legacy daifmt parsing\n");
292 cpu_dai->fmt = codec_dai->fmt =
293 snd_soc_of_parse_daifmt(codec, NULL, NULL, NULL) |
294 (daifmt & ~SND_SOC_DAIFMT_CLOCK_MASK);
296 if (codec == bitclkmaster)
297 daifmt |= (codec == framemaster) ?
298 SND_SOC_DAIFMT_CBM_CFM : SND_SOC_DAIFMT_CBM_CFS;
300 daifmt |= (codec == framemaster) ?
301 SND_SOC_DAIFMT_CBS_CFM : SND_SOC_DAIFMT_CBS_CFS;
303 cpu_dai->fmt = daifmt;
304 codec_dai->fmt = daifmt;
307 of_node_put(bitclkmaster);
308 of_node_put(framemaster);
313 static int asoc_simple_card_dai_link_of(struct device_node *node,
314 struct simple_card_data *priv,
316 bool is_top_level_node)
318 struct device *dev = simple_priv_to_dev(priv);
319 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
320 struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
321 struct device_node *cpu = NULL;
322 struct device_node *codec = NULL;
328 /* For single DAI link & old style of DT node */
329 if (is_top_level_node)
330 prefix = "simple-audio-card,";
332 snprintf(prop, sizeof(prop), "%scpu", prefix);
333 cpu = of_get_child_by_name(node, prop);
335 snprintf(prop, sizeof(prop), "%scodec", prefix);
336 codec = of_get_child_by_name(node, prop);
338 if (!cpu || !codec) {
340 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
341 goto dai_link_of_err;
344 ret = asoc_simple_card_parse_daifmt(node, priv,
347 goto dai_link_of_err;
349 ret = asoc_simple_card_sub_parse_of(cpu, &dai_props->cpu_dai,
350 &dai_link->cpu_of_node,
351 &dai_link->cpu_dai_name,
354 goto dai_link_of_err;
356 ret = asoc_simple_card_sub_parse_of(codec, &dai_props->codec_dai,
357 &dai_link->codec_of_node,
358 &dai_link->codec_dai_name, NULL);
360 goto dai_link_of_err;
362 if (!dai_link->cpu_dai_name || !dai_link->codec_dai_name) {
364 goto dai_link_of_err;
367 /* Simple Card assumes platform == cpu */
368 dai_link->platform_of_node = dai_link->cpu_of_node;
370 /* DAI link name is created from CPU/CODEC dai name */
371 name = devm_kzalloc(dev,
372 strlen(dai_link->cpu_dai_name) +
373 strlen(dai_link->codec_dai_name) + 2,
375 sprintf(name, "%s-%s", dai_link->cpu_dai_name,
376 dai_link->codec_dai_name);
377 dai_link->name = dai_link->stream_name = name;
378 dai_link->ops = &asoc_simple_card_ops;
379 dai_link->init = asoc_simple_card_dai_init;
381 dev_dbg(dev, "\tname : %s\n", dai_link->stream_name);
382 dev_dbg(dev, "\tcpu : %s / %04x / %d\n",
383 dai_link->cpu_dai_name,
384 dai_props->cpu_dai.fmt,
385 dai_props->cpu_dai.sysclk);
386 dev_dbg(dev, "\tcodec : %s / %04x / %d\n",
387 dai_link->codec_dai_name,
388 dai_props->codec_dai.fmt,
389 dai_props->codec_dai.sysclk);
392 * In soc_bind_dai_link() will check cpu name after
393 * of_node matching if dai_link has cpu_dai_name.
394 * but, it will never match if name was created by
395 * fmt_single_name() remove cpu_dai_name if cpu_args
398 * fmt_multiple_name()
401 dai_link->cpu_dai_name = NULL;
410 static int asoc_simple_card_parse_of(struct device_node *node,
411 struct simple_card_data *priv)
413 struct device *dev = simple_priv_to_dev(priv);
414 enum of_gpio_flags flags;
421 /* Parse the card name from DT */
422 snd_soc_of_parse_card_name(&priv->snd_card, "simple-audio-card,name");
424 /* The off-codec widgets */
425 if (of_property_read_bool(node, "simple-audio-card,widgets")) {
426 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
427 "simple-audio-card,widgets");
433 if (of_property_read_bool(node, "simple-audio-card,routing")) {
434 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
435 "simple-audio-card,routing");
440 /* Factor to mclk, used in hw_params() */
441 ret = of_property_read_u32(node, "simple-audio-card,mclk-fs", &val);
445 dev_dbg(dev, "New simple-card: %s\n", priv->snd_card.name ?
446 priv->snd_card.name : "");
448 /* Single/Muti DAI link(s) & New style of DT node */
449 if (of_get_child_by_name(node, "simple-audio-card,dai-link")) {
450 struct device_node *np = NULL;
453 for_each_child_of_node(node, np) {
454 dev_dbg(dev, "\tlink %d:\n", i);
455 ret = asoc_simple_card_dai_link_of(np, priv,
464 /* For single DAI link & old style of DT node */
465 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
470 priv->gpio_hp_det = of_get_named_gpio_flags(node,
471 "simple-audio-card,hp-det-gpio", 0, &flags);
472 priv->gpio_hp_det_invert = !!(flags & OF_GPIO_ACTIVE_LOW);
473 if (priv->gpio_hp_det == -EPROBE_DEFER)
474 return -EPROBE_DEFER;
476 priv->gpio_mic_det = of_get_named_gpio_flags(node,
477 "simple-audio-card,mic-det-gpio", 0, &flags);
478 priv->gpio_mic_det_invert = !!(flags & OF_GPIO_ACTIVE_LOW);
479 if (priv->gpio_mic_det == -EPROBE_DEFER)
480 return -EPROBE_DEFER;
482 if (!priv->snd_card.name)
483 priv->snd_card.name = priv->snd_card.dai_link->name;
488 /* Decrease the reference count of the device nodes */
489 static int asoc_simple_card_unref(struct snd_soc_card *card)
491 struct snd_soc_dai_link *dai_link;
494 for (num_links = 0, dai_link = card->dai_link;
495 num_links < card->num_links;
496 num_links++, dai_link++) {
497 of_node_put(dai_link->cpu_of_node);
498 of_node_put(dai_link->codec_of_node);
503 static int asoc_simple_card_probe(struct platform_device *pdev)
505 struct simple_card_data *priv;
506 struct snd_soc_dai_link *dai_link;
507 struct device_node *np = pdev->dev.of_node;
508 struct device *dev = &pdev->dev;
511 /* Get the number of DAI links */
512 if (np && of_get_child_by_name(np, "simple-audio-card,dai-link"))
513 num_links = of_get_child_count(np);
517 /* Allocate the private data and the DAI link array */
518 priv = devm_kzalloc(dev,
519 sizeof(*priv) + sizeof(*dai_link) * num_links,
524 /* Init snd_soc_card */
525 priv->snd_card.owner = THIS_MODULE;
526 priv->snd_card.dev = dev;
527 dai_link = priv->dai_link;
528 priv->snd_card.dai_link = dai_link;
529 priv->snd_card.num_links = num_links;
531 priv->gpio_hp_det = -ENOENT;
532 priv->gpio_mic_det = -ENOENT;
534 /* Get room for the other properties */
535 priv->dai_props = devm_kzalloc(dev,
536 sizeof(*priv->dai_props) * num_links,
538 if (!priv->dai_props)
541 if (np && of_device_is_available(np)) {
543 ret = asoc_simple_card_parse_of(np, priv);
545 if (ret != -EPROBE_DEFER)
546 dev_err(dev, "parse error %d\n", ret);
551 struct asoc_simple_card_info *cinfo;
553 cinfo = dev->platform_data;
555 dev_err(dev, "no info for asoc-simple-card\n");
560 !cinfo->codec_dai.name ||
563 !cinfo->cpu_dai.name) {
564 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
568 priv->snd_card.name = (cinfo->card) ? cinfo->card : cinfo->name;
569 dai_link->name = cinfo->name;
570 dai_link->stream_name = cinfo->name;
571 dai_link->platform_name = cinfo->platform;
572 dai_link->codec_name = cinfo->codec;
573 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
574 dai_link->codec_dai_name = cinfo->codec_dai.name;
575 dai_link->init = asoc_simple_card_dai_init;
576 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
577 sizeof(priv->dai_props->cpu_dai));
578 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
579 sizeof(priv->dai_props->codec_dai));
581 priv->dai_props->cpu_dai.fmt |= cinfo->daifmt;
582 priv->dai_props->codec_dai.fmt |= cinfo->daifmt;
585 snd_soc_card_set_drvdata(&priv->snd_card, priv);
587 ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
592 asoc_simple_card_unref(&priv->snd_card);
596 static int asoc_simple_card_remove(struct platform_device *pdev)
598 struct snd_soc_card *card = platform_get_drvdata(pdev);
599 struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
601 if (gpio_is_valid(priv->gpio_hp_det))
602 snd_soc_jack_free_gpios(&simple_card_hp_jack, 1,
603 &simple_card_hp_jack_gpio);
604 if (gpio_is_valid(priv->gpio_mic_det))
605 snd_soc_jack_free_gpios(&simple_card_mic_jack, 1,
606 &simple_card_mic_jack_gpio);
608 return asoc_simple_card_unref(card);
611 static const struct of_device_id asoc_simple_of_match[] = {
612 { .compatible = "simple-audio-card", },
615 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
617 static struct platform_driver asoc_simple_card = {
619 .name = "asoc-simple-card",
620 .of_match_table = asoc_simple_of_match,
622 .probe = asoc_simple_card_probe,
623 .remove = asoc_simple_card_remove,
626 module_platform_driver(asoc_simple_card);
628 MODULE_ALIAS("platform:asoc-simple-card");
629 MODULE_LICENSE("GPL");
630 MODULE_DESCRIPTION("ASoC Simple Sound Card");
631 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");