ASoC: simple-card: Add DT documentation for multi-DAI links
[deliverable/linux.git] / sound / soc / generic / simple-card.c
CommitLineData
f2390880
KM
1/*
2 * ASoC simple sound card support
3 *
4 * Copyright (C) 2012 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6 *
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.
10 */
fa558c28 11#include <linux/clk.h>
6ff62eed 12#include <linux/device.h>
f2390880 13#include <linux/module.h>
fa558c28 14#include <linux/of.h>
f2390880 15#include <linux/platform_device.h>
ca919fe4 16#include <linux/string.h>
f2390880 17#include <sound/simple_card.h>
6ff62eed
XL
18#include <sound/soc-dai.h>
19#include <sound/soc.h>
f2390880 20
45fce594
JFM
21struct simple_card_data {
22 struct snd_soc_card snd_card;
cf7dc23c
JFM
23 struct simple_dai_props {
24 struct asoc_simple_dai cpu_dai;
25 struct asoc_simple_dai codec_dai;
26 } *dai_props;
27 struct snd_soc_dai_link dai_link[]; /* dynamically allocated */
45fce594
JFM
28};
29
a4a2992c 30static int __asoc_simple_card_dai_init(struct snd_soc_dai *dai,
30d0341e 31 struct asoc_simple_dai *set)
a4a2992c 32{
4763ebe2 33 int ret;
a4a2992c 34
30d0341e
XL
35 if (set->fmt) {
36 ret = snd_soc_dai_set_fmt(dai, set->fmt);
4763ebe2
XL
37 if (ret && ret != -ENOTSUPP) {
38 dev_err(dai->dev, "simple-card: set_fmt error\n");
39 goto err;
40 }
e244bb9b
KM
41 }
42
4763ebe2 43 if (set->sysclk) {
a4a2992c 44 ret = snd_soc_dai_set_sysclk(dai, 0, set->sysclk, 0);
4763ebe2
XL
45 if (ret && ret != -ENOTSUPP) {
46 dev_err(dai->dev, "simple-card: set_sysclk error\n");
47 goto err;
48 }
49 }
50
6ff62eed
XL
51 if (set->slots) {
52 ret = snd_soc_dai_set_tdm_slot(dai, 0, 0,
53 set->slots,
54 set->slot_width);
55 if (ret && ret != -ENOTSUPP) {
56 dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
57 goto err;
58 }
59 }
60
4763ebe2 61 ret = 0;
a4a2992c 62
4763ebe2 63err:
a4a2992c
KM
64 return ret;
65}
66
f2390880
KM
67static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
68{
b367a325 69 struct simple_card_data *priv =
ba194a4d 70 snd_soc_card_get_drvdata(rtd->card);
f2390880
KM
71 struct snd_soc_dai *codec = rtd->codec_dai;
72 struct snd_soc_dai *cpu = rtd->cpu_dai;
f2390880
KM
73 int ret;
74
cf7dc23c 75 ret = __asoc_simple_card_dai_init(codec, &priv->dai_props->codec_dai);
a4a2992c
KM
76 if (ret < 0)
77 return ret;
f2390880 78
cf7dc23c 79 ret = __asoc_simple_card_dai_init(cpu, &priv->dai_props->cpu_dai);
a4a2992c
KM
80 if (ret < 0)
81 return ret;
f2390880
KM
82
83 return 0;
84}
85
fa558c28
KM
86static int
87asoc_simple_card_sub_parse_of(struct device_node *np,
30d0341e 88 unsigned int daifmt,
fa558c28 89 struct asoc_simple_dai *dai,
52008472
JFM
90 const struct device_node **p_node,
91 const char **name)
fa558c28 92{
201a0eac 93 struct device_node *node;
fa558c28
KM
94 struct clk *clk;
95 int ret;
96
97 /*
98 * get node via "sound-dai = <&phandle port>"
99 * it will be used as xxx_of_node on soc_bind_dai_link()
100 */
201a0eac
JFM
101 node = of_parse_phandle(np, "sound-dai", 0);
102 if (!node)
fa558c28 103 return -ENODEV;
201a0eac 104 *p_node = node;
fa558c28
KM
105
106 /* get dai->name */
52008472 107 ret = snd_soc_of_get_dai_name(np, name);
fa558c28 108 if (ret < 0)
e512e001 109 return ret;
fa558c28 110
6ff62eed
XL
111 /* parse TDM slot */
112 ret = snd_soc_of_parse_tdm_slot(np, &dai->slots, &dai->slot_width);
113 if (ret)
e512e001 114 return ret;
6ff62eed 115
fa558c28
KM
116 /*
117 * bitclock-inversion, frame-inversion
118 * bitclock-master, frame-master
119 * and specific "format" if it has
120 */
121 dai->fmt = snd_soc_of_parse_daifmt(np, NULL);
30d0341e 122 dai->fmt |= daifmt;
fa558c28
KM
123
124 /*
125 * dai->sysclk come from
126 * "clocks = <&xxx>" (if system has common clock)
127 * or "system-clock-frequency = <xxx>"
71467e46 128 * or device's module clock.
fa558c28 129 */
71467e46
XL
130 if (of_property_read_bool(np, "clocks")) {
131 clk = of_clk_get(np, 0);
132 if (IS_ERR(clk)) {
133 ret = PTR_ERR(clk);
e512e001 134 return ret;
71467e46
XL
135 }
136
137 dai->sysclk = clk_get_rate(clk);
138 } else if (of_property_read_bool(np, "system-clock-frequency")) {
fa558c28
KM
139 of_property_read_u32(np,
140 "system-clock-frequency",
141 &dai->sysclk);
71467e46 142 } else {
201a0eac 143 clk = of_clk_get(node, 0);
e2a19ac6
XL
144 if (!IS_ERR(clk))
145 dai->sysclk = clk_get_rate(clk);
71467e46 146 }
fa558c28 147
e512e001 148 return 0;
fa558c28
KM
149}
150
151static int asoc_simple_card_parse_of(struct device_node *node,
b367a325 152 struct simple_card_data *priv,
201a0eac 153 struct device *dev)
fa558c28 154{
b367a325 155 struct snd_soc_dai_link *dai_link = priv->snd_card.dai_link;
cf7dc23c
JFM
156 struct asoc_simple_dai *codec_dai = &priv->dai_props->codec_dai;
157 struct asoc_simple_dai *cpu_dai = &priv->dai_props->cpu_dai;
fa558c28
KM
158 struct device_node *np;
159 char *name;
c56c4d74 160 unsigned int daifmt;
d4c22094 161 int ret;
fa558c28 162
2772555b
XL
163 /* parsing the card name from DT */
164 snd_soc_of_parse_card_name(&priv->snd_card, "simple-audio-card,name");
165
fa558c28 166 /* get CPU/CODEC common format via simple-audio-card,format */
c56c4d74 167 daifmt = snd_soc_of_parse_daifmt(node, "simple-audio-card,") &
fa558c28
KM
168 (SND_SOC_DAIFMT_FORMAT_MASK | SND_SOC_DAIFMT_INV_MASK);
169
9d681f5b
XL
170 /* off-codec widgets */
171 if (of_property_read_bool(node, "simple-audio-card,widgets")) {
172 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
173 "simple-audio-card,widgets");
174 if (ret)
175 return ret;
176 }
177
d4c22094 178 /* DAPM routes */
8c0b8230 179 if (of_property_read_bool(node, "simple-audio-card,routing")) {
b367a325 180 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
8c0b8230 181 "simple-audio-card,routing");
f87a3e82
XL
182 if (ret)
183 return ret;
184 }
d4c22094 185
fa558c28
KM
186 /* CPU sub-node */
187 ret = -EINVAL;
188 np = of_get_child_by_name(node, "simple-audio-card,cpu");
e512e001 189 if (np) {
c56c4d74 190 ret = asoc_simple_card_sub_parse_of(np, daifmt,
46c39cae 191 cpu_dai,
52008472
JFM
192 &dai_link->cpu_of_node,
193 &dai_link->cpu_dai_name);
e512e001
JFM
194 of_node_put(np);
195 }
fa558c28
KM
196 if (ret < 0)
197 return ret;
198
199 /* CODEC sub-node */
200 ret = -EINVAL;
201 np = of_get_child_by_name(node, "simple-audio-card,codec");
e512e001 202 if (np) {
c56c4d74 203 ret = asoc_simple_card_sub_parse_of(np, daifmt,
46c39cae 204 codec_dai,
52008472
JFM
205 &dai_link->codec_of_node,
206 &dai_link->codec_dai_name);
e512e001
JFM
207 of_node_put(np);
208 }
fa558c28
KM
209 if (ret < 0)
210 return ret;
211
46c39cae
NC
212 /*
213 * overwrite cpu_dai->fmt as its DAIFMT_MASTER bit is based on CODEC
214 * while the other bits should be identical unless buggy SW/HW design.
215 */
216 cpu_dai->fmt = codec_dai->fmt;
217
52008472 218 if (!dai_link->cpu_dai_name || !dai_link->codec_dai_name)
dd41e0c4
XL
219 return -EINVAL;
220
fa558c28
KM
221 /* card name is created from CPU/CODEC dai name */
222 name = devm_kzalloc(dev,
52008472
JFM
223 strlen(dai_link->cpu_dai_name) +
224 strlen(dai_link->codec_dai_name) + 2,
fa558c28 225 GFP_KERNEL);
52008472
JFM
226 sprintf(name, "%s-%s", dai_link->cpu_dai_name,
227 dai_link->codec_dai_name);
2772555b
XL
228 if (!priv->snd_card.name)
229 priv->snd_card.name = name;
5ca8ba41 230 dai_link->name = dai_link->stream_name = name;
fa558c28
KM
231
232 /* simple-card assumes platform == cpu */
5ca8ba41 233 dai_link->platform_of_node = dai_link->cpu_of_node;
fa558c28 234
2bee9914 235 dev_dbg(dev, "card-name : %s\n", name);
c56c4d74 236 dev_dbg(dev, "platform : %04x\n", daifmt);
fa558c28 237 dev_dbg(dev, "cpu : %s / %04x / %d\n",
52008472 238 dai_link->cpu_dai_name,
46c39cae
NC
239 cpu_dai->fmt,
240 cpu_dai->sysclk);
fa558c28 241 dev_dbg(dev, "codec : %s / %04x / %d\n",
52008472 242 dai_link->codec_dai_name,
46c39cae
NC
243 codec_dai->fmt,
244 codec_dai->sysclk);
fa558c28 245
f687d900
KM
246 /*
247 * soc_bind_dai_link() will check cpu name
248 * after of_node matching if dai_link has cpu_dai_name.
249 * but, it will never match if name was created by fmt_single_name()
250 * remove cpu_dai_name to escape name matching.
251 * see
252 * fmt_single_name()
253 * fmt_multiple_name()
254 */
255 dai_link->cpu_dai_name = NULL;
256
fa558c28
KM
257 return 0;
258}
259
e512e001
JFM
260/* update the reference count of the devices nodes at end of probe */
261static int asoc_simple_card_unref(struct platform_device *pdev)
262{
263 struct snd_soc_card *card = platform_get_drvdata(pdev);
264 struct snd_soc_dai_link *dai_link;
265 struct device_node *np;
266 int num_links;
267
268 for (num_links = 0, dai_link = card->dai_link;
269 num_links < card->num_links;
270 num_links++, dai_link++) {
271 np = (struct device_node *) dai_link->cpu_of_node;
272 if (np)
273 of_node_put(np);
274 np = (struct device_node *) dai_link->codec_of_node;
275 if (np)
276 of_node_put(np);
277 }
278 return 0;
279}
280
f2390880
KM
281static int asoc_simple_card_probe(struct platform_device *pdev)
282{
45fce594 283 struct simple_card_data *priv;
5ca8ba41 284 struct snd_soc_dai_link *dai_link;
fa558c28 285 struct device_node *np = pdev->dev.of_node;
f89983ef 286 struct device *dev = &pdev->dev;
ca919fe4 287 int ret;
f2390880 288
cf7dc23c
JFM
289 /* allocate the private data and the DAI link array */
290 priv = devm_kzalloc(dev,
291 sizeof(*priv) + sizeof(*dai_link),
292 GFP_KERNEL);
ca65b492 293 if (!priv)
ca919fe4
XL
294 return -ENOMEM;
295
201a0eac
JFM
296 /*
297 * init snd_soc_card
298 */
ca65b492
JFM
299 priv->snd_card.owner = THIS_MODULE;
300 priv->snd_card.dev = dev;
cf7dc23c 301 dai_link = priv->dai_link;
ca65b492
JFM
302 priv->snd_card.dai_link = dai_link;
303 priv->snd_card.num_links = 1;
201a0eac 304
cf7dc23c
JFM
305 /* get room for the other properties */
306 priv->dai_props = devm_kzalloc(dev,
307 sizeof(*priv->dai_props),
308 GFP_KERNEL);
309 if (!priv->dai_props)
310 return -ENOMEM;
311
fa558c28 312 if (np && of_device_is_available(np)) {
ca919fe4 313
ca65b492 314 ret = asoc_simple_card_parse_of(np, priv, dev);
ca919fe4
XL
315 if (ret < 0) {
316 if (ret != -EPROBE_DEFER)
317 dev_err(dev, "parse error %d\n", ret);
e512e001 318 goto err;
fa558c28
KM
319 }
320 } else {
ca65b492
JFM
321 struct asoc_simple_card_info *cinfo;
322
323 cinfo = dev->platform_data;
324 if (!cinfo) {
34787d0a
XL
325 dev_err(dev, "no info for asoc-simple-card\n");
326 return -EINVAL;
327 }
fa558c28 328
7722f830 329 if (!cinfo->name ||
7722f830
JFM
330 !cinfo->codec_dai.name ||
331 !cinfo->codec ||
332 !cinfo->platform ||
333 !cinfo->cpu_dai.name) {
334 dev_err(dev, "insufficient asoc_simple_card_info settings\n");
335 return -EINVAL;
336 }
2bee9914 337
12ffa6fc 338 priv->snd_card.name = (cinfo->card) ? cinfo->card : cinfo->name;
5ca8ba41
JFM
339 dai_link->name = cinfo->name;
340 dai_link->stream_name = cinfo->name;
341 dai_link->platform_name = cinfo->platform;
342 dai_link->codec_name = cinfo->codec;
52008472
JFM
343 dai_link->cpu_dai_name = cinfo->cpu_dai.name;
344 dai_link->codec_dai_name = cinfo->codec_dai.name;
cf7dc23c
JFM
345 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
346 sizeof(priv->dai_props->cpu_dai));
347 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
348 sizeof(priv->dai_props->codec_dai));
81985bd6 349
cf7dc23c
JFM
350 priv->dai_props->cpu_dai.fmt |= cinfo->daifmt;
351 priv->dai_props->codec_dai.fmt |= cinfo->daifmt;
f2390880
KM
352 }
353
354 /*
355 * init snd_soc_dai_link
356 */
5ca8ba41 357 dai_link->init = asoc_simple_card_dai_init;
f2390880 358
ca65b492 359 snd_soc_card_set_drvdata(&priv->snd_card, priv);
f2390880 360
e512e001
JFM
361 ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
362
363err:
364 asoc_simple_card_unref(pdev);
365 return ret;
f2390880
KM
366}
367
fa558c28
KM
368static const struct of_device_id asoc_simple_of_match[] = {
369 { .compatible = "simple-audio-card", },
370 {},
371};
372MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
373
f2390880
KM
374static struct platform_driver asoc_simple_card = {
375 .driver = {
376 .name = "asoc-simple-card",
c445be35 377 .owner = THIS_MODULE,
fa558c28 378 .of_match_table = asoc_simple_of_match,
f2390880
KM
379 },
380 .probe = asoc_simple_card_probe,
f2390880
KM
381};
382
383module_platform_driver(asoc_simple_card);
384
c445be35 385MODULE_ALIAS("platform:asoc-simple-card");
f2390880
KM
386MODULE_LICENSE("GPL");
387MODULE_DESCRIPTION("ASoC Simple Sound Card");
388MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
This page took 0.594148 seconds and 5 git commands to generate.