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 simple_card_data
*priv
= snd_soc_card_get_drvdata(rtd
->card
);
80 struct simple_dai_props
*dai_props
=
81 &priv
->dai_props
[rtd
- rtd
->card
->rtd
];
82 unsigned int mclk
, mclk_fs
= 0;
86 mclk_fs
= priv
->mclk_fs
;
87 else if (dai_props
->mclk_fs
)
88 mclk_fs
= dai_props
->mclk_fs
;
91 mclk
= params_rate(params
) * mclk_fs
;
92 ret
= snd_soc_dai_set_sysclk(codec_dai
, 0, mclk
,
99 static struct snd_soc_ops asoc_simple_card_ops
= {
100 .startup
= asoc_simple_card_startup
,
101 .shutdown
= asoc_simple_card_shutdown
,
102 .hw_params
= asoc_simple_card_hw_params
,
105 static struct snd_soc_jack simple_card_hp_jack
;
106 static struct snd_soc_jack_pin simple_card_hp_jack_pins
[] = {
109 .mask
= SND_JACK_HEADPHONE
,
112 static struct snd_soc_jack_gpio simple_card_hp_jack_gpio
= {
113 .name
= "Headphone detection",
114 .report
= SND_JACK_HEADPHONE
,
115 .debounce_time
= 150,
118 static struct snd_soc_jack simple_card_mic_jack
;
119 static struct snd_soc_jack_pin simple_card_mic_jack_pins
[] = {
122 .mask
= SND_JACK_MICROPHONE
,
125 static struct snd_soc_jack_gpio simple_card_mic_jack_gpio
= {
126 .name
= "Mic detection",
127 .report
= SND_JACK_MICROPHONE
,
128 .debounce_time
= 150,
131 static int __asoc_simple_card_dai_init(struct snd_soc_dai
*dai
,
132 struct asoc_simple_dai
*set
)
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_card_jack_new(rtd
->card
, "Headphones",
181 &simple_card_hp_jack
,
182 simple_card_hp_jack_pins
,
183 ARRAY_SIZE(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_card_jack_new(rtd
->card
, "Mic Jack",
194 &simple_card_mic_jack
,
195 simple_card_mic_jack_pins
,
196 ARRAY_SIZE(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 snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, idx
);
273 struct device
*dev
= simple_priv_to_dev(priv
);
274 struct device_node
*bitclkmaster
= NULL
;
275 struct device_node
*framemaster
= NULL
;
278 daifmt
= snd_soc_of_parse_daifmt(node
, prefix
,
279 &bitclkmaster
, &framemaster
);
280 daifmt
&= ~SND_SOC_DAIFMT_MASTER_MASK
;
282 if (strlen(prefix
) && !bitclkmaster
&& !framemaster
) {
284 * No dai-link level and master setting was not found from
285 * sound node level, revert back to legacy DT parsing and
286 * take the settings from codec node.
288 dev_dbg(dev
, "Revert to legacy daifmt parsing\n");
290 daifmt
= snd_soc_of_parse_daifmt(codec
, NULL
, NULL
, NULL
) |
291 (daifmt
& ~SND_SOC_DAIFMT_CLOCK_MASK
);
293 if (codec
== bitclkmaster
)
294 daifmt
|= (codec
== framemaster
) ?
295 SND_SOC_DAIFMT_CBM_CFM
: SND_SOC_DAIFMT_CBM_CFS
;
297 daifmt
|= (codec
== framemaster
) ?
298 SND_SOC_DAIFMT_CBS_CFM
: SND_SOC_DAIFMT_CBS_CFS
;
301 dai_link
->dai_fmt
= daifmt
;
303 of_node_put(bitclkmaster
);
304 of_node_put(framemaster
);
309 static int asoc_simple_card_dai_link_of(struct device_node
*node
,
310 struct simple_card_data
*priv
,
312 bool is_top_level_node
)
314 struct device
*dev
= simple_priv_to_dev(priv
);
315 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, idx
);
316 struct simple_dai_props
*dai_props
= simple_priv_to_props(priv
, idx
);
317 struct device_node
*cpu
= NULL
;
318 struct device_node
*plat
= NULL
;
319 struct device_node
*codec
= NULL
;
326 /* For single DAI link & old style of DT node */
327 if (is_top_level_node
)
328 prefix
= "simple-audio-card,";
330 snprintf(prop
, sizeof(prop
), "%scpu", prefix
);
331 cpu
= of_get_child_by_name(node
, prop
);
333 snprintf(prop
, sizeof(prop
), "%splat", prefix
);
334 plat
= of_get_child_by_name(node
, prop
);
336 snprintf(prop
, sizeof(prop
), "%scodec", prefix
);
337 codec
= of_get_child_by_name(node
, prop
);
339 if (!cpu
|| !codec
) {
341 dev_err(dev
, "%s: Can't find %s DT node\n", __func__
, prop
);
342 goto dai_link_of_err
;
345 ret
= asoc_simple_card_parse_daifmt(node
, priv
,
348 goto dai_link_of_err
;
350 if (!of_property_read_u32(node
, "mclk-fs", &val
))
351 dai_props
->mclk_fs
= val
;
353 ret
= asoc_simple_card_sub_parse_of(cpu
, &dai_props
->cpu_dai
,
354 &dai_link
->cpu_of_node
,
355 &dai_link
->cpu_dai_name
,
358 goto dai_link_of_err
;
360 ret
= asoc_simple_card_sub_parse_of(codec
, &dai_props
->codec_dai
,
361 &dai_link
->codec_of_node
,
362 &dai_link
->codec_dai_name
, NULL
);
364 goto dai_link_of_err
;
366 if (!dai_link
->cpu_dai_name
|| !dai_link
->codec_dai_name
) {
368 goto dai_link_of_err
;
372 struct of_phandle_args args
;
374 ret
= of_parse_phandle_with_args(plat
, "sound-dai",
375 "#sound-dai-cells", 0, &args
);
376 dai_link
->platform_of_node
= args
.np
;
378 /* Assumes platform == cpu */
379 dai_link
->platform_of_node
= dai_link
->cpu_of_node
;
382 /* DAI link name is created from CPU/CODEC dai name */
383 name
= devm_kzalloc(dev
,
384 strlen(dai_link
->cpu_dai_name
) +
385 strlen(dai_link
->codec_dai_name
) + 2,
389 goto dai_link_of_err
;
392 sprintf(name
, "%s-%s", dai_link
->cpu_dai_name
,
393 dai_link
->codec_dai_name
);
394 dai_link
->name
= dai_link
->stream_name
= name
;
395 dai_link
->ops
= &asoc_simple_card_ops
;
396 dai_link
->init
= asoc_simple_card_dai_init
;
398 dev_dbg(dev
, "\tname : %s\n", dai_link
->stream_name
);
399 dev_dbg(dev
, "\tformat : %04x\n", dai_link
->dai_fmt
);
400 dev_dbg(dev
, "\tcpu : %s / %d\n",
401 dai_link
->cpu_dai_name
,
402 dai_props
->cpu_dai
.sysclk
);
403 dev_dbg(dev
, "\tcodec : %s / %d\n",
404 dai_link
->codec_dai_name
,
405 dai_props
->codec_dai
.sysclk
);
408 * In soc_bind_dai_link() will check cpu name after
409 * of_node matching if dai_link has cpu_dai_name.
410 * but, it will never match if name was created by
411 * fmt_single_name() remove cpu_dai_name if cpu_args
414 * fmt_multiple_name()
417 dai_link
->cpu_dai_name
= NULL
;
426 static int asoc_simple_card_parse_of(struct device_node
*node
,
427 struct simple_card_data
*priv
)
429 struct device
*dev
= simple_priv_to_dev(priv
);
430 enum of_gpio_flags flags
;
437 /* Parse the card name from DT */
438 snd_soc_of_parse_card_name(&priv
->snd_card
, "simple-audio-card,name");
440 /* The off-codec widgets */
441 if (of_property_read_bool(node
, "simple-audio-card,widgets")) {
442 ret
= snd_soc_of_parse_audio_simple_widgets(&priv
->snd_card
,
443 "simple-audio-card,widgets");
449 if (of_property_read_bool(node
, "simple-audio-card,routing")) {
450 ret
= snd_soc_of_parse_audio_routing(&priv
->snd_card
,
451 "simple-audio-card,routing");
456 /* Factor to mclk, used in hw_params() */
457 ret
= of_property_read_u32(node
, "simple-audio-card,mclk-fs", &val
);
461 dev_dbg(dev
, "New simple-card: %s\n", priv
->snd_card
.name
?
462 priv
->snd_card
.name
: "");
464 /* Single/Muti DAI link(s) & New style of DT node */
465 if (of_get_child_by_name(node
, "simple-audio-card,dai-link")) {
466 struct device_node
*np
= NULL
;
469 for_each_child_of_node(node
, np
) {
470 dev_dbg(dev
, "\tlink %d:\n", i
);
471 ret
= asoc_simple_card_dai_link_of(np
, priv
,
480 /* For single DAI link & old style of DT node */
481 ret
= asoc_simple_card_dai_link_of(node
, priv
, 0, true);
486 priv
->gpio_hp_det
= of_get_named_gpio_flags(node
,
487 "simple-audio-card,hp-det-gpio", 0, &flags
);
488 priv
->gpio_hp_det_invert
= !!(flags
& OF_GPIO_ACTIVE_LOW
);
489 if (priv
->gpio_hp_det
== -EPROBE_DEFER
)
490 return -EPROBE_DEFER
;
492 priv
->gpio_mic_det
= of_get_named_gpio_flags(node
,
493 "simple-audio-card,mic-det-gpio", 0, &flags
);
494 priv
->gpio_mic_det_invert
= !!(flags
& OF_GPIO_ACTIVE_LOW
);
495 if (priv
->gpio_mic_det
== -EPROBE_DEFER
)
496 return -EPROBE_DEFER
;
498 if (!priv
->snd_card
.name
)
499 priv
->snd_card
.name
= priv
->snd_card
.dai_link
->name
;
504 /* Decrease the reference count of the device nodes */
505 static int asoc_simple_card_unref(struct snd_soc_card
*card
)
507 struct snd_soc_dai_link
*dai_link
;
510 for (num_links
= 0, dai_link
= card
->dai_link
;
511 num_links
< card
->num_links
;
512 num_links
++, dai_link
++) {
513 of_node_put(dai_link
->cpu_of_node
);
514 of_node_put(dai_link
->codec_of_node
);
519 static int asoc_simple_card_probe(struct platform_device
*pdev
)
521 struct simple_card_data
*priv
;
522 struct snd_soc_dai_link
*dai_link
;
523 struct device_node
*np
= pdev
->dev
.of_node
;
524 struct device
*dev
= &pdev
->dev
;
527 /* Get the number of DAI links */
528 if (np
&& of_get_child_by_name(np
, "simple-audio-card,dai-link"))
529 num_links
= of_get_child_count(np
);
533 /* Allocate the private data and the DAI link array */
534 priv
= devm_kzalloc(dev
,
535 sizeof(*priv
) + sizeof(*dai_link
) * num_links
,
540 /* Init snd_soc_card */
541 priv
->snd_card
.owner
= THIS_MODULE
;
542 priv
->snd_card
.dev
= dev
;
543 dai_link
= priv
->dai_link
;
544 priv
->snd_card
.dai_link
= dai_link
;
545 priv
->snd_card
.num_links
= num_links
;
547 priv
->gpio_hp_det
= -ENOENT
;
548 priv
->gpio_mic_det
= -ENOENT
;
550 /* Get room for the other properties */
551 priv
->dai_props
= devm_kzalloc(dev
,
552 sizeof(*priv
->dai_props
) * num_links
,
554 if (!priv
->dai_props
)
557 if (np
&& of_device_is_available(np
)) {
559 ret
= asoc_simple_card_parse_of(np
, priv
);
561 if (ret
!= -EPROBE_DEFER
)
562 dev_err(dev
, "parse error %d\n", ret
);
567 struct asoc_simple_card_info
*cinfo
;
569 cinfo
= dev
->platform_data
;
571 dev_err(dev
, "no info for asoc-simple-card\n");
576 !cinfo
->codec_dai
.name
||
579 !cinfo
->cpu_dai
.name
) {
580 dev_err(dev
, "insufficient asoc_simple_card_info settings\n");
584 priv
->snd_card
.name
= (cinfo
->card
) ? cinfo
->card
: cinfo
->name
;
585 dai_link
->name
= cinfo
->name
;
586 dai_link
->stream_name
= cinfo
->name
;
587 dai_link
->platform_name
= cinfo
->platform
;
588 dai_link
->codec_name
= cinfo
->codec
;
589 dai_link
->cpu_dai_name
= cinfo
->cpu_dai
.name
;
590 dai_link
->codec_dai_name
= cinfo
->codec_dai
.name
;
591 dai_link
->dai_fmt
= cinfo
->daifmt
;
592 dai_link
->init
= asoc_simple_card_dai_init
;
593 memcpy(&priv
->dai_props
->cpu_dai
, &cinfo
->cpu_dai
,
594 sizeof(priv
->dai_props
->cpu_dai
));
595 memcpy(&priv
->dai_props
->codec_dai
, &cinfo
->codec_dai
,
596 sizeof(priv
->dai_props
->codec_dai
));
600 snd_soc_card_set_drvdata(&priv
->snd_card
, priv
);
602 ret
= devm_snd_soc_register_card(&pdev
->dev
, &priv
->snd_card
);
607 asoc_simple_card_unref(&priv
->snd_card
);
611 static int asoc_simple_card_remove(struct platform_device
*pdev
)
613 struct snd_soc_card
*card
= platform_get_drvdata(pdev
);
614 struct simple_card_data
*priv
= snd_soc_card_get_drvdata(card
);
616 if (gpio_is_valid(priv
->gpio_hp_det
))
617 snd_soc_jack_free_gpios(&simple_card_hp_jack
, 1,
618 &simple_card_hp_jack_gpio
);
619 if (gpio_is_valid(priv
->gpio_mic_det
))
620 snd_soc_jack_free_gpios(&simple_card_mic_jack
, 1,
621 &simple_card_mic_jack_gpio
);
623 return asoc_simple_card_unref(card
);
626 static const struct of_device_id asoc_simple_of_match
[] = {
627 { .compatible
= "simple-audio-card", },
630 MODULE_DEVICE_TABLE(of
, asoc_simple_of_match
);
632 static struct platform_driver asoc_simple_card
= {
634 .name
= "asoc-simple-card",
635 .of_match_table
= asoc_simple_of_match
,
637 .probe
= asoc_simple_card_probe
,
638 .remove
= asoc_simple_card_remove
,
641 module_platform_driver(asoc_simple_card
);
643 MODULE_ALIAS("platform:asoc-simple-card");
644 MODULE_LICENSE("GPL");
645 MODULE_DESCRIPTION("ASoC Simple Sound Card");
646 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");