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 DAI "sound-dai"
48 #define CELL "#sound-dai-cells"
49 #define PREFIX "simple-audio-card,"
51 #define asoc_simple_card_init_hp(card, sjack, prefix)\
52 asoc_simple_card_init_jack(card, sjack, 1, prefix)
53 #define asoc_simple_card_init_mic(card, sjack, prefix)\
54 asoc_simple_card_init_jack(card, sjack, 0, prefix)
55 static int asoc_simple_card_init_jack(struct snd_soc_card *card,
56 struct asoc_simple_jack *sjack,
57 int is_hp, char *prefix)
59 struct device *dev = card->dev;
60 enum of_gpio_flags flags;
67 sjack->gpio.gpio = -ENOENT;
70 snprintf(prop, sizeof(prop), "%shp-det-gpio", prefix);
71 pin_name = "Headphones";
72 gpio_name = "Headphone detection";
73 mask = SND_JACK_HEADPHONE;
75 snprintf(prop, sizeof(prop), "%smic-det-gpio", prefix);
76 pin_name = "Mic Jack";
77 gpio_name = "Mic detection";
78 mask = SND_JACK_MICROPHONE;
81 det = of_get_named_gpio_flags(dev->of_node, prop, 0, &flags);
82 if (det == -EPROBE_DEFER)
85 if (gpio_is_valid(det)) {
86 sjack->pin.pin = pin_name;
87 sjack->pin.mask = mask;
89 sjack->gpio.name = gpio_name;
90 sjack->gpio.report = mask;
91 sjack->gpio.gpio = det;
92 sjack->gpio.invert = !!(flags & OF_GPIO_ACTIVE_LOW);
93 sjack->gpio.debounce_time = 150;
95 snd_soc_card_jack_new(card, pin_name, mask,
99 snd_soc_jack_add_gpios(&sjack->jack, 1,
106 static void asoc_simple_card_remove_jack(struct asoc_simple_jack *sjack)
108 if (gpio_is_valid(sjack->gpio.gpio))
109 snd_soc_jack_free_gpios(&sjack->jack, 1, &sjack->gpio);
112 static int asoc_simple_card_startup(struct snd_pcm_substream *substream)
114 struct snd_soc_pcm_runtime *rtd = substream->private_data;
115 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
116 struct simple_dai_props *dai_props =
117 &priv->dai_props[rtd->num];
120 ret = clk_prepare_enable(dai_props->cpu_dai.clk);
124 ret = clk_prepare_enable(dai_props->codec_dai.clk);
126 clk_disable_unprepare(dai_props->cpu_dai.clk);
131 static void asoc_simple_card_shutdown(struct snd_pcm_substream *substream)
133 struct snd_soc_pcm_runtime *rtd = substream->private_data;
134 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
135 struct simple_dai_props *dai_props =
136 &priv->dai_props[rtd->num];
138 clk_disable_unprepare(dai_props->cpu_dai.clk);
140 clk_disable_unprepare(dai_props->codec_dai.clk);
143 static int asoc_simple_card_hw_params(struct snd_pcm_substream *substream,
144 struct snd_pcm_hw_params *params)
146 struct snd_soc_pcm_runtime *rtd = substream->private_data;
147 struct snd_soc_dai *codec_dai = rtd->codec_dai;
148 struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
149 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
150 struct simple_dai_props *dai_props = &priv->dai_props[rtd->num];
151 unsigned int mclk, mclk_fs = 0;
155 mclk_fs = priv->mclk_fs;
156 else if (dai_props->mclk_fs)
157 mclk_fs = dai_props->mclk_fs;
160 mclk = params_rate(params) * mclk_fs;
161 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
163 if (ret && ret != -ENOTSUPP)
166 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
168 if (ret && ret != -ENOTSUPP)
176 static struct snd_soc_ops asoc_simple_card_ops = {
177 .startup = asoc_simple_card_startup,
178 .shutdown = asoc_simple_card_shutdown,
179 .hw_params = asoc_simple_card_hw_params,
182 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
184 struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
185 struct snd_soc_dai *codec = rtd->codec_dai;
186 struct snd_soc_dai *cpu = rtd->cpu_dai;
187 struct simple_dai_props *dai_props = &priv->dai_props[rtd->num];
190 ret = asoc_simple_card_init_dai(codec, &dai_props->codec_dai);
194 ret = asoc_simple_card_init_dai(cpu, &dai_props->cpu_dai);
198 ret = asoc_simple_card_init_hp(rtd->card, &priv->hp_jack, PREFIX);
202 ret = asoc_simple_card_init_mic(rtd->card, &priv->hp_jack, PREFIX);
209 static int asoc_simple_card_dai_link_of(struct device_node *node,
210 struct simple_card_data *priv,
212 bool is_top_level_node)
214 struct device *dev = simple_priv_to_dev(priv);
215 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
216 struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
217 struct asoc_simple_dai *cpu_dai = &dai_props->cpu_dai;
218 struct asoc_simple_dai *codec_dai = &dai_props->codec_dai;
219 struct device_node *cpu = NULL;
220 struct device_node *plat = NULL;
221 struct device_node *codec = NULL;
227 /* For single DAI link & old style of DT node */
228 if (is_top_level_node)
231 snprintf(prop, sizeof(prop), "%scpu", prefix);
232 cpu = of_get_child_by_name(node, prop);
234 snprintf(prop, sizeof(prop), "%splat", prefix);
235 plat = of_get_child_by_name(node, prop);
237 snprintf(prop, sizeof(prop), "%scodec", prefix);
238 codec = of_get_child_by_name(node, prop);
240 if (!cpu || !codec) {
242 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
243 goto dai_link_of_err;
246 ret = asoc_simple_card_parse_daifmt(dev, node, codec,
247 prefix, &dai_link->dai_fmt);
249 goto dai_link_of_err;
251 if (!of_property_read_u32(node, "mclk-fs", &val))
252 dai_props->mclk_fs = val;
254 ret = asoc_simple_card_parse_cpu(cpu, dai_link,
255 DAI, CELL, &single_cpu);
257 goto dai_link_of_err;
259 ret = asoc_simple_card_parse_codec(codec, dai_link, DAI, CELL);
261 goto dai_link_of_err;
263 ret = asoc_simple_card_parse_platform(plat, dai_link, DAI, CELL);
265 goto dai_link_of_err;
267 ret = snd_soc_of_parse_tdm_slot(cpu, &cpu_dai->tx_slot_mask,
268 &cpu_dai->rx_slot_mask,
270 &cpu_dai->slot_width);
272 goto dai_link_of_err;
274 ret = snd_soc_of_parse_tdm_slot(codec, &codec_dai->tx_slot_mask,
275 &codec_dai->rx_slot_mask,
277 &codec_dai->slot_width);
279 goto dai_link_of_err;
281 ret = asoc_simple_card_parse_clk_cpu(cpu, dai_link, cpu_dai);
283 goto dai_link_of_err;
285 ret = asoc_simple_card_parse_clk_codec(codec, dai_link, codec_dai);
287 goto dai_link_of_err;
289 ret = asoc_simple_card_canonicalize_dailink(dai_link);
291 goto dai_link_of_err;
293 ret = asoc_simple_card_set_dailink_name(dev, dai_link,
295 dai_link->cpu_dai_name,
296 dai_link->codec_dai_name);
298 goto dai_link_of_err;
300 dai_link->ops = &asoc_simple_card_ops;
301 dai_link->init = asoc_simple_card_dai_init;
303 dev_dbg(dev, "\tname : %s\n", dai_link->stream_name);
304 dev_dbg(dev, "\tformat : %04x\n", dai_link->dai_fmt);
305 dev_dbg(dev, "\tcpu : %s / %d\n",
306 dai_link->cpu_dai_name,
307 dai_props->cpu_dai.sysclk);
308 dev_dbg(dev, "\tcodec : %s / %d\n",
309 dai_link->codec_dai_name,
310 dai_props->codec_dai.sysclk);
312 asoc_simple_card_canonicalize_cpu(dai_link, single_cpu);
321 static int asoc_simple_card_parse_of(struct device_node *node,
322 struct simple_card_data *priv)
324 struct device *dev = simple_priv_to_dev(priv);
331 /* The off-codec widgets */
332 if (of_property_read_bool(node, PREFIX "widgets")) {
333 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
340 if (of_property_read_bool(node, PREFIX "routing")) {
341 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
347 /* Factor to mclk, used in hw_params() */
348 ret = of_property_read_u32(node, PREFIX "mclk-fs", &val);
352 /* Single/Muti DAI link(s) & New style of DT node */
353 if (of_get_child_by_name(node, PREFIX "dai-link")) {
354 struct device_node *np = NULL;
357 for_each_child_of_node(node, np) {
358 dev_dbg(dev, "\tlink %d:\n", i);
359 ret = asoc_simple_card_dai_link_of(np, priv,
368 /* For single DAI link & old style of DT node */
369 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
374 ret = asoc_simple_card_parse_card_name(&priv->snd_card, PREFIX);
381 static int asoc_simple_card_probe(struct platform_device *pdev)
383 struct simple_card_data *priv;
384 struct snd_soc_dai_link *dai_link;
385 struct device_node *np = pdev->dev.of_node;
386 struct device *dev = &pdev->dev;
389 /* Get the number of DAI links */
390 if (np && of_get_child_by_name(np, PREFIX "dai-link"))
391 num_links = of_get_child_count(np);
395 /* Allocate the private data and the DAI link array */
396 priv = devm_kzalloc(dev,
397 sizeof(*priv) + sizeof(*dai_link) * num_links,
402 /* Init snd_soc_card */
403 priv->snd_card.owner = THIS_MODULE;
404 priv->snd_card.dev = dev;
405 dai_link = priv->dai_link;
406 priv->snd_card.dai_link = dai_link;
407 priv->snd_card.num_links = num_links;
409 /* Get room for the other properties */
410 priv->dai_props = devm_kzalloc(dev,
411 sizeof(*priv->dai_props) * num_links,
413 if (!priv->dai_props)
416 if (np && of_device_is_available(np)) {
418 ret = asoc_simple_card_parse_of(np, priv);
420 if (ret != -EPROBE_DEFER)
421 dev_err(dev, "parse error %d\n", ret);
426 struct asoc_simple_card_info *cinfo;
428 cinfo = dev->platform_data;
430 dev_err(dev, "no info for asoc-simple-card\n");
435 !cinfo->codec_dai.name ||
438 !cinfo->cpu_dai.name) {
439 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
443 priv->snd_card.name = (cinfo->card) ? cinfo->card : cinfo->name;
444 dai_link->name = cinfo->name;
445 dai_link->stream_name = cinfo->name;
446 dai_link->platform_name = cinfo->platform;
447 dai_link->codec_name = cinfo->codec;
448 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
449 dai_link->codec_dai_name = cinfo->codec_dai.name;
450 dai_link->dai_fmt = cinfo->daifmt;
451 dai_link->init = asoc_simple_card_dai_init;
452 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
453 sizeof(priv->dai_props->cpu_dai));
454 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
455 sizeof(priv->dai_props->codec_dai));
459 snd_soc_card_set_drvdata(&priv->snd_card, priv);
461 ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
466 asoc_simple_card_clean_reference(&priv->snd_card);
470 static int asoc_simple_card_remove(struct platform_device *pdev)
472 struct snd_soc_card *card = platform_get_drvdata(pdev);
473 struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
475 asoc_simple_card_remove_jack(&priv->hp_jack);
476 asoc_simple_card_remove_jack(&priv->mic_jack);
478 return asoc_simple_card_clean_reference(card);
481 static const struct of_device_id asoc_simple_of_match[] = {
482 { .compatible = "simple-audio-card", },
485 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
487 static struct platform_driver asoc_simple_card = {
489 .name = "asoc-simple-card",
490 .pm = &snd_soc_pm_ops,
491 .of_match_table = asoc_simple_of_match,
493 .probe = asoc_simple_card_probe,
494 .remove = asoc_simple_card_remove,
497 module_platform_driver(asoc_simple_card);
499 MODULE_ALIAS("platform:asoc-simple-card");
500 MODULE_LICENSE("GPL");
501 MODULE_DESCRIPTION("ASoC Simple Sound Card");
502 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");