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,
159 if (ret && ret != -ENOTSUPP) {
160 dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
171 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
173 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
174 struct snd_soc_dai *codec = rtd->codec_dai;
175 struct snd_soc_dai *cpu = rtd->cpu_dai;
176 struct simple_dai_props *dai_props;
179 num = rtd - rtd->card->rtd;
180 dai_props = &priv->dai_props[num];
181 ret = __asoc_simple_card_dai_init(codec, &dai_props->codec_dai);
185 ret = __asoc_simple_card_dai_init(cpu, &dai_props->cpu_dai);
189 if (gpio_is_valid(priv->gpio_hp_det)) {
190 snd_soc_card_jack_new(rtd->card, "Headphones",
192 &simple_card_hp_jack,
193 simple_card_hp_jack_pins,
194 ARRAY_SIZE(simple_card_hp_jack_pins));
196 simple_card_hp_jack_gpio.gpio = priv->gpio_hp_det;
197 simple_card_hp_jack_gpio.invert = priv->gpio_hp_det_invert;
198 snd_soc_jack_add_gpios(&simple_card_hp_jack, 1,
199 &simple_card_hp_jack_gpio);
202 if (gpio_is_valid(priv->gpio_mic_det)) {
203 snd_soc_card_jack_new(rtd->card, "Mic Jack",
205 &simple_card_mic_jack,
206 simple_card_mic_jack_pins,
207 ARRAY_SIZE(simple_card_mic_jack_pins));
208 simple_card_mic_jack_gpio.gpio = priv->gpio_mic_det;
209 simple_card_mic_jack_gpio.invert = priv->gpio_mic_det_invert;
210 snd_soc_jack_add_gpios(&simple_card_mic_jack, 1,
211 &simple_card_mic_jack_gpio);
217 asoc_simple_card_sub_parse_of(struct device_node *np,
218 struct asoc_simple_dai *dai,
219 struct device_node **p_node,
223 struct of_phandle_args args;
229 * Get node via "sound-dai = <&phandle port>"
230 * it will be used as xxx_of_node on soc_bind_dai_link()
232 ret = of_parse_phandle_with_args(np, "sound-dai",
233 "#sound-dai-cells", 0, &args);
240 *args_count = args.args_count;
243 ret = snd_soc_of_get_dai_name(np, name);
248 ret = snd_soc_of_parse_tdm_slot(np, &dai->tx_slot_mask,
250 &dai->slots, &dai->slot_width);
255 * Parse dai->sysclk come from "clocks = <&xxx>"
256 * (if system has common clock)
257 * or "system-clock-frequency = <xxx>"
258 * or device's module clock.
260 if (of_property_read_bool(np, "clocks")) {
261 clk = of_clk_get(np, 0);
267 dai->sysclk = clk_get_rate(clk);
269 } else if (!of_property_read_u32(np, "system-clock-frequency", &val)) {
272 clk = of_clk_get(args.np, 0);
274 dai->sysclk = clk_get_rate(clk);
280 static int asoc_simple_card_parse_daifmt(struct device_node *node,
281 struct simple_card_data *priv,
282 struct device_node *codec,
283 char *prefix, int idx)
285 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
286 struct device *dev = simple_priv_to_dev(priv);
287 struct device_node *bitclkmaster = NULL;
288 struct device_node *framemaster = NULL;
291 daifmt = snd_soc_of_parse_daifmt(node, prefix,
292 &bitclkmaster, &framemaster);
293 daifmt &= ~SND_SOC_DAIFMT_MASTER_MASK;
295 if (strlen(prefix) && !bitclkmaster && !framemaster) {
297 * No dai-link level and master setting was not found from
298 * sound node level, revert back to legacy DT parsing and
299 * take the settings from codec node.
301 dev_dbg(dev, "Revert to legacy daifmt parsing\n");
303 daifmt = snd_soc_of_parse_daifmt(codec, NULL, NULL, NULL) |
304 (daifmt & ~SND_SOC_DAIFMT_CLOCK_MASK);
306 if (codec == bitclkmaster)
307 daifmt |= (codec == framemaster) ?
308 SND_SOC_DAIFMT_CBM_CFM : SND_SOC_DAIFMT_CBM_CFS;
310 daifmt |= (codec == framemaster) ?
311 SND_SOC_DAIFMT_CBS_CFM : SND_SOC_DAIFMT_CBS_CFS;
314 dai_link->dai_fmt = daifmt;
316 of_node_put(bitclkmaster);
317 of_node_put(framemaster);
322 static int asoc_simple_card_dai_link_of(struct device_node *node,
323 struct simple_card_data *priv,
325 bool is_top_level_node)
327 struct device *dev = simple_priv_to_dev(priv);
328 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
329 struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
330 struct device_node *cpu = NULL;
331 struct device_node *plat = NULL;
332 struct device_node *codec = NULL;
339 /* For single DAI link & old style of DT node */
340 if (is_top_level_node)
341 prefix = "simple-audio-card,";
343 snprintf(prop, sizeof(prop), "%scpu", prefix);
344 cpu = of_get_child_by_name(node, prop);
348 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
349 goto dai_link_of_err;
352 snprintf(prop, sizeof(prop), "%splat", prefix);
353 plat = of_get_child_by_name(node, prop);
355 snprintf(prop, sizeof(prop), "%scodec", prefix);
356 codec = of_get_child_by_name(node, prop);
360 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
361 goto dai_link_of_err;
364 ret = asoc_simple_card_parse_daifmt(node, priv,
367 goto dai_link_of_err;
369 if (!of_property_read_u32(node, "mclk-fs", &val))
370 dai_props->mclk_fs = val;
372 ret = asoc_simple_card_sub_parse_of(cpu, &dai_props->cpu_dai,
373 &dai_link->cpu_of_node,
374 &dai_link->cpu_dai_name,
377 goto dai_link_of_err;
379 ret = asoc_simple_card_sub_parse_of(codec, &dai_props->codec_dai,
380 &dai_link->codec_of_node,
381 &dai_link->codec_dai_name, NULL);
383 goto dai_link_of_err;
385 if (!dai_link->cpu_dai_name || !dai_link->codec_dai_name) {
387 goto dai_link_of_err;
391 struct of_phandle_args args;
393 ret = of_parse_phandle_with_args(plat, "sound-dai",
394 "#sound-dai-cells", 0, &args);
395 dai_link->platform_of_node = args.np;
397 /* Assumes platform == cpu */
398 dai_link->platform_of_node = dai_link->cpu_of_node;
401 /* DAI link name is created from CPU/CODEC dai name */
402 name = devm_kzalloc(dev,
403 strlen(dai_link->cpu_dai_name) +
404 strlen(dai_link->codec_dai_name) + 2,
408 goto dai_link_of_err;
411 sprintf(name, "%s-%s", dai_link->cpu_dai_name,
412 dai_link->codec_dai_name);
413 dai_link->name = dai_link->stream_name = name;
414 dai_link->ops = &asoc_simple_card_ops;
415 dai_link->init = asoc_simple_card_dai_init;
417 dev_dbg(dev, "\tname : %s\n", dai_link->stream_name);
418 dev_dbg(dev, "\tformat : %04x\n", dai_link->dai_fmt);
419 dev_dbg(dev, "\tcpu : %s / %d\n",
420 dai_link->cpu_dai_name,
421 dai_props->cpu_dai.sysclk);
422 dev_dbg(dev, "\tcodec : %s / %d\n",
423 dai_link->codec_dai_name,
424 dai_props->codec_dai.sysclk);
427 * In soc_bind_dai_link() will check cpu name after
428 * of_node matching if dai_link has cpu_dai_name.
429 * but, it will never match if name was created by
430 * fmt_single_name() remove cpu_dai_name if cpu_args
433 * fmt_multiple_name()
436 dai_link->cpu_dai_name = NULL;
445 static int asoc_simple_card_parse_of(struct device_node *node,
446 struct simple_card_data *priv)
448 struct device *dev = simple_priv_to_dev(priv);
449 enum of_gpio_flags flags;
456 /* Parse the card name from DT */
457 snd_soc_of_parse_card_name(&priv->snd_card, "simple-audio-card,name");
459 /* The off-codec widgets */
460 if (of_property_read_bool(node, "simple-audio-card,widgets")) {
461 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
462 "simple-audio-card,widgets");
468 if (of_property_read_bool(node, "simple-audio-card,routing")) {
469 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
470 "simple-audio-card,routing");
475 /* Factor to mclk, used in hw_params() */
476 ret = of_property_read_u32(node, "simple-audio-card,mclk-fs", &val);
480 dev_dbg(dev, "New simple-card: %s\n", priv->snd_card.name ?
481 priv->snd_card.name : "");
483 /* Single/Muti DAI link(s) & New style of DT node */
484 if (of_get_child_by_name(node, "simple-audio-card,dai-link")) {
485 struct device_node *np = NULL;
488 for_each_child_of_node(node, np) {
489 dev_dbg(dev, "\tlink %d:\n", i);
490 ret = asoc_simple_card_dai_link_of(np, priv,
499 /* For single DAI link & old style of DT node */
500 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
505 priv->gpio_hp_det = of_get_named_gpio_flags(node,
506 "simple-audio-card,hp-det-gpio", 0, &flags);
507 priv->gpio_hp_det_invert = !!(flags & OF_GPIO_ACTIVE_LOW);
508 if (priv->gpio_hp_det == -EPROBE_DEFER)
509 return -EPROBE_DEFER;
511 priv->gpio_mic_det = of_get_named_gpio_flags(node,
512 "simple-audio-card,mic-det-gpio", 0, &flags);
513 priv->gpio_mic_det_invert = !!(flags & OF_GPIO_ACTIVE_LOW);
514 if (priv->gpio_mic_det == -EPROBE_DEFER)
515 return -EPROBE_DEFER;
517 if (!priv->snd_card.name)
518 priv->snd_card.name = priv->snd_card.dai_link->name;
523 /* Decrease the reference count of the device nodes */
524 static int asoc_simple_card_unref(struct snd_soc_card *card)
526 struct snd_soc_dai_link *dai_link;
529 for (num_links = 0, dai_link = card->dai_link;
530 num_links < card->num_links;
531 num_links++, dai_link++) {
532 of_node_put(dai_link->cpu_of_node);
533 of_node_put(dai_link->codec_of_node);
538 static int asoc_simple_card_probe(struct platform_device *pdev)
540 struct simple_card_data *priv;
541 struct snd_soc_dai_link *dai_link;
542 struct device_node *np = pdev->dev.of_node;
543 struct device *dev = &pdev->dev;
546 /* Get the number of DAI links */
547 if (np && of_get_child_by_name(np, "simple-audio-card,dai-link"))
548 num_links = of_get_child_count(np);
552 /* Allocate the private data and the DAI link array */
553 priv = devm_kzalloc(dev,
554 sizeof(*priv) + sizeof(*dai_link) * num_links,
559 /* Init snd_soc_card */
560 priv->snd_card.owner = THIS_MODULE;
561 priv->snd_card.dev = dev;
562 dai_link = priv->dai_link;
563 priv->snd_card.dai_link = dai_link;
564 priv->snd_card.num_links = num_links;
566 priv->gpio_hp_det = -ENOENT;
567 priv->gpio_mic_det = -ENOENT;
569 /* Get room for the other properties */
570 priv->dai_props = devm_kzalloc(dev,
571 sizeof(*priv->dai_props) * num_links,
573 if (!priv->dai_props)
576 if (np && of_device_is_available(np)) {
578 ret = asoc_simple_card_parse_of(np, priv);
580 if (ret != -EPROBE_DEFER)
581 dev_err(dev, "parse error %d\n", ret);
586 struct asoc_simple_card_info *cinfo;
588 cinfo = dev->platform_data;
590 dev_err(dev, "no info for asoc-simple-card\n");
595 !cinfo->codec_dai.name ||
598 !cinfo->cpu_dai.name) {
599 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
603 priv->snd_card.name = (cinfo->card) ? cinfo->card : cinfo->name;
604 dai_link->name = cinfo->name;
605 dai_link->stream_name = cinfo->name;
606 dai_link->platform_name = cinfo->platform;
607 dai_link->codec_name = cinfo->codec;
608 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
609 dai_link->codec_dai_name = cinfo->codec_dai.name;
610 dai_link->dai_fmt = cinfo->daifmt;
611 dai_link->init = asoc_simple_card_dai_init;
612 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
613 sizeof(priv->dai_props->cpu_dai));
614 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
615 sizeof(priv->dai_props->codec_dai));
619 snd_soc_card_set_drvdata(&priv->snd_card, priv);
621 ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
626 asoc_simple_card_unref(&priv->snd_card);
630 static int asoc_simple_card_remove(struct platform_device *pdev)
632 struct snd_soc_card *card = platform_get_drvdata(pdev);
633 struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
635 if (gpio_is_valid(priv->gpio_hp_det))
636 snd_soc_jack_free_gpios(&simple_card_hp_jack, 1,
637 &simple_card_hp_jack_gpio);
638 if (gpio_is_valid(priv->gpio_mic_det))
639 snd_soc_jack_free_gpios(&simple_card_mic_jack, 1,
640 &simple_card_mic_jack_gpio);
642 return asoc_simple_card_unref(card);
645 static const struct of_device_id asoc_simple_of_match[] = {
646 { .compatible = "simple-audio-card", },
649 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
651 static struct platform_driver asoc_simple_card = {
653 .name = "asoc-simple-card",
654 .of_match_table = asoc_simple_of_match,
656 .probe = asoc_simple_card_probe,
657 .remove = asoc_simple_card_remove,
660 module_platform_driver(asoc_simple_card);
662 MODULE_ALIAS("platform:asoc-simple-card");
663 MODULE_LICENSE("GPL");
664 MODULE_DESCRIPTION("ASoC Simple Sound Card");
665 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");