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 asoc_simple_jack
{
25 struct snd_soc_jack jack
;
26 struct snd_soc_jack_pin pin
;
27 struct snd_soc_jack_gpio gpio
;
30 struct simple_card_data
{
31 struct snd_soc_card snd_card
;
32 struct simple_dai_props
{
33 struct asoc_simple_dai cpu_dai
;
34 struct asoc_simple_dai codec_dai
;
38 struct asoc_simple_jack hp_jack
;
39 struct asoc_simple_jack mic_jack
;
40 struct snd_soc_dai_link dai_link
[]; /* dynamically allocated */
43 #define simple_priv_to_dev(priv) ((priv)->snd_card.dev)
44 #define simple_priv_to_link(priv, i) ((priv)->snd_card.dai_link + i)
45 #define simple_priv_to_props(priv, i) ((priv)->dai_props + i)
47 #define PREFIX "simple-audio-card,"
49 #define asoc_simple_card_init_hp(card, sjack, prefix)\
50 asoc_simple_card_init_jack(card, sjack, 1, prefix)
51 #define asoc_simple_card_init_mic(card, sjack, prefix)\
52 asoc_simple_card_init_jack(card, sjack, 0, prefix)
53 static int asoc_simple_card_init_jack(struct snd_soc_card
*card
,
54 struct asoc_simple_jack
*sjack
,
55 int is_hp
, char *prefix
)
57 struct device
*dev
= card
->dev
;
58 enum of_gpio_flags flags
;
65 sjack
->gpio
.gpio
= -ENOENT
;
68 snprintf(prop
, sizeof(prop
), "%shp-det-gpio", prefix
);
69 pin_name
= "Headphones";
70 gpio_name
= "Headphone detection";
71 mask
= SND_JACK_HEADPHONE
;
73 snprintf(prop
, sizeof(prop
), "%smic-det-gpio", prefix
);
74 pin_name
= "Mic Jack";
75 gpio_name
= "Mic detection";
76 mask
= SND_JACK_MICROPHONE
;
79 det
= of_get_named_gpio_flags(dev
->of_node
, prop
, 0, &flags
);
80 if (det
== -EPROBE_DEFER
)
83 if (gpio_is_valid(det
)) {
84 sjack
->pin
.pin
= pin_name
;
85 sjack
->pin
.mask
= mask
;
87 sjack
->gpio
.name
= gpio_name
;
88 sjack
->gpio
.report
= mask
;
89 sjack
->gpio
.gpio
= det
;
90 sjack
->gpio
.invert
= !!(flags
& OF_GPIO_ACTIVE_LOW
);
91 sjack
->gpio
.debounce_time
= 150;
93 snd_soc_card_jack_new(card
, pin_name
, mask
,
97 snd_soc_jack_add_gpios(&sjack
->jack
, 1,
104 static void asoc_simple_card_remove_jack(struct asoc_simple_jack
*sjack
)
106 if (gpio_is_valid(sjack
->gpio
.gpio
))
107 snd_soc_jack_free_gpios(&sjack
->jack
, 1, &sjack
->gpio
);
110 static int asoc_simple_card_startup(struct snd_pcm_substream
*substream
)
112 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
113 struct simple_card_data
*priv
= snd_soc_card_get_drvdata(rtd
->card
);
114 struct simple_dai_props
*dai_props
=
115 &priv
->dai_props
[rtd
->num
];
118 ret
= clk_prepare_enable(dai_props
->cpu_dai
.clk
);
122 ret
= clk_prepare_enable(dai_props
->codec_dai
.clk
);
124 clk_disable_unprepare(dai_props
->cpu_dai
.clk
);
129 static void asoc_simple_card_shutdown(struct snd_pcm_substream
*substream
)
131 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
132 struct simple_card_data
*priv
= snd_soc_card_get_drvdata(rtd
->card
);
133 struct simple_dai_props
*dai_props
=
134 &priv
->dai_props
[rtd
->num
];
136 clk_disable_unprepare(dai_props
->cpu_dai
.clk
);
138 clk_disable_unprepare(dai_props
->codec_dai
.clk
);
141 static int asoc_simple_card_hw_params(struct snd_pcm_substream
*substream
,
142 struct snd_pcm_hw_params
*params
)
144 struct snd_soc_pcm_runtime
*rtd
= substream
->private_data
;
145 struct snd_soc_dai
*codec_dai
= rtd
->codec_dai
;
146 struct snd_soc_dai
*cpu_dai
= rtd
->cpu_dai
;
147 struct simple_card_data
*priv
= snd_soc_card_get_drvdata(rtd
->card
);
148 struct simple_dai_props
*dai_props
= &priv
->dai_props
[rtd
->num
];
149 unsigned int mclk
, mclk_fs
= 0;
153 mclk_fs
= priv
->mclk_fs
;
154 else if (dai_props
->mclk_fs
)
155 mclk_fs
= dai_props
->mclk_fs
;
158 mclk
= params_rate(params
) * mclk_fs
;
159 ret
= snd_soc_dai_set_sysclk(codec_dai
, 0, mclk
,
161 if (ret
&& ret
!= -ENOTSUPP
)
164 ret
= snd_soc_dai_set_sysclk(cpu_dai
, 0, mclk
,
166 if (ret
&& ret
!= -ENOTSUPP
)
174 static struct snd_soc_ops asoc_simple_card_ops
= {
175 .startup
= asoc_simple_card_startup
,
176 .shutdown
= asoc_simple_card_shutdown
,
177 .hw_params
= asoc_simple_card_hw_params
,
180 static int __asoc_simple_card_dai_init(struct snd_soc_dai
*dai
,
181 struct asoc_simple_dai
*set
)
186 ret
= snd_soc_dai_set_sysclk(dai
, 0, set
->sysclk
, 0);
187 if (ret
&& ret
!= -ENOTSUPP
) {
188 dev_err(dai
->dev
, "simple-card: set_sysclk error\n");
194 ret
= snd_soc_dai_set_tdm_slot(dai
,
199 if (ret
&& ret
!= -ENOTSUPP
) {
200 dev_err(dai
->dev
, "simple-card: set_tdm_slot error\n");
211 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime
*rtd
)
213 struct simple_card_data
*priv
= snd_soc_card_get_drvdata(rtd
->card
);
214 struct snd_soc_dai
*codec
= rtd
->codec_dai
;
215 struct snd_soc_dai
*cpu
= rtd
->cpu_dai
;
216 struct simple_dai_props
*dai_props
;
219 dai_props
= &priv
->dai_props
[rtd
->num
];
220 ret
= __asoc_simple_card_dai_init(codec
, &dai_props
->codec_dai
);
224 ret
= __asoc_simple_card_dai_init(cpu
, &dai_props
->cpu_dai
);
228 ret
= asoc_simple_card_init_hp(rtd
->card
, &priv
->hp_jack
, PREFIX
);
232 ret
= asoc_simple_card_init_mic(rtd
->card
, &priv
->hp_jack
, PREFIX
);
240 asoc_simple_card_sub_parse_of(struct device_node
*np
,
241 struct asoc_simple_dai
*dai
,
242 struct device_node
**p_node
,
246 struct of_phandle_args args
;
255 * Get node via "sound-dai = <&phandle port>"
256 * it will be used as xxx_of_node on soc_bind_dai_link()
258 ret
= of_parse_phandle_with_args(np
, "sound-dai",
259 "#sound-dai-cells", 0, &args
);
266 *args_count
= args
.args_count
;
270 ret
= snd_soc_of_get_dai_name(np
, name
);
279 ret
= snd_soc_of_parse_tdm_slot(np
, &dai
->tx_slot_mask
,
281 &dai
->slots
, &dai
->slot_width
);
286 * Parse dai->sysclk come from "clocks = <&xxx>"
287 * (if system has common clock)
288 * or "system-clock-frequency = <xxx>"
289 * or device's module clock.
291 if (of_property_read_bool(np
, "clocks")) {
292 clk
= of_clk_get(np
, 0);
298 dai
->sysclk
= clk_get_rate(clk
);
300 } else if (!of_property_read_u32(np
, "system-clock-frequency", &val
)) {
303 clk
= of_clk_get(args
.np
, 0);
305 dai
->sysclk
= clk_get_rate(clk
);
311 static int asoc_simple_card_parse_daifmt(struct device_node
*node
,
312 struct simple_card_data
*priv
,
313 struct device_node
*codec
,
314 char *prefix
, int idx
)
316 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, idx
);
317 struct device
*dev
= simple_priv_to_dev(priv
);
318 struct device_node
*bitclkmaster
= NULL
;
319 struct device_node
*framemaster
= NULL
;
322 daifmt
= snd_soc_of_parse_daifmt(node
, prefix
,
323 &bitclkmaster
, &framemaster
);
324 daifmt
&= ~SND_SOC_DAIFMT_MASTER_MASK
;
326 if (strlen(prefix
) && !bitclkmaster
&& !framemaster
) {
328 * No dai-link level and master setting was not found from
329 * sound node level, revert back to legacy DT parsing and
330 * take the settings from codec node.
332 dev_dbg(dev
, "Revert to legacy daifmt parsing\n");
334 daifmt
= snd_soc_of_parse_daifmt(codec
, NULL
, NULL
, NULL
) |
335 (daifmt
& ~SND_SOC_DAIFMT_CLOCK_MASK
);
337 if (codec
== bitclkmaster
)
338 daifmt
|= (codec
== framemaster
) ?
339 SND_SOC_DAIFMT_CBM_CFM
: SND_SOC_DAIFMT_CBM_CFS
;
341 daifmt
|= (codec
== framemaster
) ?
342 SND_SOC_DAIFMT_CBS_CFM
: SND_SOC_DAIFMT_CBS_CFS
;
345 dai_link
->dai_fmt
= daifmt
;
347 of_node_put(bitclkmaster
);
348 of_node_put(framemaster
);
353 static int asoc_simple_card_dai_link_of(struct device_node
*node
,
354 struct simple_card_data
*priv
,
356 bool is_top_level_node
)
358 struct device
*dev
= simple_priv_to_dev(priv
);
359 struct snd_soc_dai_link
*dai_link
= simple_priv_to_link(priv
, idx
);
360 struct simple_dai_props
*dai_props
= simple_priv_to_props(priv
, idx
);
361 struct device_node
*cpu
= NULL
;
362 struct device_node
*plat
= NULL
;
363 struct device_node
*codec
= NULL
;
370 /* For single DAI link & old style of DT node */
371 if (is_top_level_node
)
374 snprintf(prop
, sizeof(prop
), "%scpu", prefix
);
375 cpu
= of_get_child_by_name(node
, prop
);
377 snprintf(prop
, sizeof(prop
), "%splat", prefix
);
378 plat
= of_get_child_by_name(node
, prop
);
380 snprintf(prop
, sizeof(prop
), "%scodec", prefix
);
381 codec
= of_get_child_by_name(node
, prop
);
383 if (!cpu
|| !codec
) {
385 dev_err(dev
, "%s: Can't find %s DT node\n", __func__
, prop
);
386 goto dai_link_of_err
;
389 ret
= asoc_simple_card_parse_daifmt(node
, priv
,
392 goto dai_link_of_err
;
394 if (!of_property_read_u32(node
, "mclk-fs", &val
))
395 dai_props
->mclk_fs
= val
;
397 ret
= asoc_simple_card_sub_parse_of(cpu
, &dai_props
->cpu_dai
,
398 &dai_link
->cpu_of_node
,
399 &dai_link
->cpu_dai_name
,
402 goto dai_link_of_err
;
404 ret
= asoc_simple_card_sub_parse_of(codec
, &dai_props
->codec_dai
,
405 &dai_link
->codec_of_node
,
406 &dai_link
->codec_dai_name
, NULL
);
408 goto dai_link_of_err
;
410 ret
= asoc_simple_card_sub_parse_of(plat
, NULL
,
411 &dai_link
->platform_of_node
,
414 goto dai_link_of_err
;
416 if (!dai_link
->cpu_dai_name
|| !dai_link
->codec_dai_name
) {
418 goto dai_link_of_err
;
421 /* Assumes platform == cpu */
422 if (!dai_link
->platform_of_node
)
423 dai_link
->platform_of_node
= dai_link
->cpu_of_node
;
425 /* DAI link name is created from CPU/CODEC dai name */
426 name
= devm_kzalloc(dev
,
427 strlen(dai_link
->cpu_dai_name
) +
428 strlen(dai_link
->codec_dai_name
) + 2,
432 goto dai_link_of_err
;
435 sprintf(name
, "%s-%s", dai_link
->cpu_dai_name
,
436 dai_link
->codec_dai_name
);
437 dai_link
->name
= dai_link
->stream_name
= name
;
438 dai_link
->ops
= &asoc_simple_card_ops
;
439 dai_link
->init
= asoc_simple_card_dai_init
;
441 dev_dbg(dev
, "\tname : %s\n", dai_link
->stream_name
);
442 dev_dbg(dev
, "\tformat : %04x\n", dai_link
->dai_fmt
);
443 dev_dbg(dev
, "\tcpu : %s / %d\n",
444 dai_link
->cpu_dai_name
,
445 dai_props
->cpu_dai
.sysclk
);
446 dev_dbg(dev
, "\tcodec : %s / %d\n",
447 dai_link
->codec_dai_name
,
448 dai_props
->codec_dai
.sysclk
);
451 * In soc_bind_dai_link() will check cpu name after
452 * of_node matching if dai_link has cpu_dai_name.
453 * but, it will never match if name was created by
454 * fmt_single_name() remove cpu_dai_name if cpu_args
457 * fmt_multiple_name()
460 dai_link
->cpu_dai_name
= NULL
;
469 static int asoc_simple_card_parse_of(struct device_node
*node
,
470 struct simple_card_data
*priv
)
472 struct device
*dev
= simple_priv_to_dev(priv
);
479 /* Parse the card name from DT */
480 snd_soc_of_parse_card_name(&priv
->snd_card
, PREFIX
"name");
482 /* The off-codec widgets */
483 if (of_property_read_bool(node
, PREFIX
"widgets")) {
484 ret
= snd_soc_of_parse_audio_simple_widgets(&priv
->snd_card
,
491 if (of_property_read_bool(node
, PREFIX
"routing")) {
492 ret
= snd_soc_of_parse_audio_routing(&priv
->snd_card
,
498 /* Factor to mclk, used in hw_params() */
499 ret
= of_property_read_u32(node
, PREFIX
"mclk-fs", &val
);
503 dev_dbg(dev
, "New simple-card: %s\n", priv
->snd_card
.name
?
504 priv
->snd_card
.name
: "");
506 /* Single/Muti DAI link(s) & New style of DT node */
507 if (of_get_child_by_name(node
, PREFIX
"dai-link")) {
508 struct device_node
*np
= NULL
;
511 for_each_child_of_node(node
, np
) {
512 dev_dbg(dev
, "\tlink %d:\n", i
);
513 ret
= asoc_simple_card_dai_link_of(np
, priv
,
522 /* For single DAI link & old style of DT node */
523 ret
= asoc_simple_card_dai_link_of(node
, priv
, 0, true);
528 if (!priv
->snd_card
.name
)
529 priv
->snd_card
.name
= priv
->snd_card
.dai_link
->name
;
534 /* Decrease the reference count of the device nodes */
535 static int asoc_simple_card_unref(struct snd_soc_card
*card
)
537 struct snd_soc_dai_link
*dai_link
;
540 for (num_links
= 0, dai_link
= card
->dai_link
;
541 num_links
< card
->num_links
;
542 num_links
++, dai_link
++) {
543 of_node_put(dai_link
->cpu_of_node
);
544 of_node_put(dai_link
->codec_of_node
);
549 static int asoc_simple_card_probe(struct platform_device
*pdev
)
551 struct simple_card_data
*priv
;
552 struct snd_soc_dai_link
*dai_link
;
553 struct device_node
*np
= pdev
->dev
.of_node
;
554 struct device
*dev
= &pdev
->dev
;
557 /* Get the number of DAI links */
558 if (np
&& of_get_child_by_name(np
, PREFIX
"dai-link"))
559 num_links
= of_get_child_count(np
);
563 /* Allocate the private data and the DAI link array */
564 priv
= devm_kzalloc(dev
,
565 sizeof(*priv
) + sizeof(*dai_link
) * num_links
,
570 /* Init snd_soc_card */
571 priv
->snd_card
.owner
= THIS_MODULE
;
572 priv
->snd_card
.dev
= dev
;
573 dai_link
= priv
->dai_link
;
574 priv
->snd_card
.dai_link
= dai_link
;
575 priv
->snd_card
.num_links
= num_links
;
577 /* Get room for the other properties */
578 priv
->dai_props
= devm_kzalloc(dev
,
579 sizeof(*priv
->dai_props
) * num_links
,
581 if (!priv
->dai_props
)
584 if (np
&& of_device_is_available(np
)) {
586 ret
= asoc_simple_card_parse_of(np
, priv
);
588 if (ret
!= -EPROBE_DEFER
)
589 dev_err(dev
, "parse error %d\n", ret
);
594 struct asoc_simple_card_info
*cinfo
;
596 cinfo
= dev
->platform_data
;
598 dev_err(dev
, "no info for asoc-simple-card\n");
603 !cinfo
->codec_dai
.name
||
606 !cinfo
->cpu_dai
.name
) {
607 dev_err(dev
, "insufficient asoc_simple_card_info settings\n");
611 priv
->snd_card
.name
= (cinfo
->card
) ? cinfo
->card
: cinfo
->name
;
612 dai_link
->name
= cinfo
->name
;
613 dai_link
->stream_name
= cinfo
->name
;
614 dai_link
->platform_name
= cinfo
->platform
;
615 dai_link
->codec_name
= cinfo
->codec
;
616 dai_link
->cpu_dai_name
= cinfo
->cpu_dai
.name
;
617 dai_link
->codec_dai_name
= cinfo
->codec_dai
.name
;
618 dai_link
->dai_fmt
= cinfo
->daifmt
;
619 dai_link
->init
= asoc_simple_card_dai_init
;
620 memcpy(&priv
->dai_props
->cpu_dai
, &cinfo
->cpu_dai
,
621 sizeof(priv
->dai_props
->cpu_dai
));
622 memcpy(&priv
->dai_props
->codec_dai
, &cinfo
->codec_dai
,
623 sizeof(priv
->dai_props
->codec_dai
));
627 snd_soc_card_set_drvdata(&priv
->snd_card
, priv
);
629 ret
= devm_snd_soc_register_card(&pdev
->dev
, &priv
->snd_card
);
634 asoc_simple_card_unref(&priv
->snd_card
);
638 static int asoc_simple_card_remove(struct platform_device
*pdev
)
640 struct snd_soc_card
*card
= platform_get_drvdata(pdev
);
641 struct simple_card_data
*priv
= snd_soc_card_get_drvdata(card
);
643 asoc_simple_card_remove_jack(&priv
->hp_jack
);
644 asoc_simple_card_remove_jack(&priv
->mic_jack
);
646 return asoc_simple_card_unref(card
);
649 static const struct of_device_id asoc_simple_of_match
[] = {
650 { .compatible
= "simple-audio-card", },
653 MODULE_DEVICE_TABLE(of
, asoc_simple_of_match
);
655 static struct platform_driver asoc_simple_card
= {
657 .name
= "asoc-simple-card",
658 .pm
= &snd_soc_pm_ops
,
659 .of_match_table
= asoc_simple_of_match
,
661 .probe
= asoc_simple_card_probe
,
662 .remove
= asoc_simple_card_remove
,
665 module_platform_driver(asoc_simple_card
);
667 MODULE_ALIAS("platform:asoc-simple-card");
668 MODULE_LICENSE("GPL");
669 MODULE_DESCRIPTION("ASoC Simple Sound Card");
670 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");