sh_eth: fix EESIPR values for SH77{34|63}
[linux/fpc-iii.git] / sound / soc / soc-topology.c
blob65670b2b408cca0d4bffb2931cb7443cd4ba75b1
1 /*
2 * soc-topology.c -- ALSA SoC Topology
4 * Copyright (C) 2012 Texas Instruments Inc.
5 * Copyright (C) 2015 Intel Corporation.
7 * Authors: Liam Girdwood <liam.r.girdwood@linux.intel.com>
8 * K, Mythri P <mythri.p.k@intel.com>
9 * Prusty, Subhransu S <subhransu.s.prusty@intel.com>
10 * B, Jayachandran <jayachandran.b@intel.com>
11 * Abdullah, Omair M <omair.m.abdullah@intel.com>
12 * Jin, Yao <yao.jin@intel.com>
13 * Lin, Mengdong <mengdong.lin@intel.com>
15 * This program is free software; you can redistribute it and/or modify it
16 * under the terms of the GNU General Public License as published by the
17 * Free Software Foundation; either version 2 of the License, or (at your
18 * option) any later version.
20 * Add support to read audio firmware topology alongside firmware text. The
21 * topology data can contain kcontrols, DAPM graphs, widgets, DAIs, DAI links,
22 * equalizers, firmware, coefficients etc.
24 * This file only manages the core ALSA and ASoC components, all other bespoke
25 * firmware topology data is passed to component drivers for bespoke handling.
28 #include <linux/kernel.h>
29 #include <linux/export.h>
30 #include <linux/list.h>
31 #include <linux/firmware.h>
32 #include <linux/slab.h>
33 #include <sound/soc.h>
34 #include <sound/soc-dapm.h>
35 #include <sound/soc-topology.h>
36 #include <sound/tlv.h>
39 * We make several passes over the data (since it wont necessarily be ordered)
40 * and process objects in the following order. This guarantees the component
41 * drivers will be ready with any vendor data before the mixers and DAPM objects
42 * are loaded (that may make use of the vendor data).
44 #define SOC_TPLG_PASS_MANIFEST 0
45 #define SOC_TPLG_PASS_VENDOR 1
46 #define SOC_TPLG_PASS_MIXER 2
47 #define SOC_TPLG_PASS_WIDGET 3
48 #define SOC_TPLG_PASS_PCM_DAI 4
49 #define SOC_TPLG_PASS_GRAPH 5
50 #define SOC_TPLG_PASS_PINS 6
51 #define SOC_TPLG_PASS_BE_DAI 7
52 #define SOC_TPLG_PASS_LINK 8
54 #define SOC_TPLG_PASS_START SOC_TPLG_PASS_MANIFEST
55 #define SOC_TPLG_PASS_END SOC_TPLG_PASS_LINK
58 * Old version of ABI structs, supported for backward compatibility.
61 /* Manifest v4 */
62 struct snd_soc_tplg_manifest_v4 {
63 __le32 size; /* in bytes of this structure */
64 __le32 control_elems; /* number of control elements */
65 __le32 widget_elems; /* number of widget elements */
66 __le32 graph_elems; /* number of graph elements */
67 __le32 pcm_elems; /* number of PCM elements */
68 __le32 dai_link_elems; /* number of DAI link elements */
69 struct snd_soc_tplg_private priv;
70 } __packed;
72 /* Stream Capabilities v4 */
73 struct snd_soc_tplg_stream_caps_v4 {
74 __le32 size; /* in bytes of this structure */
75 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
76 __le64 formats; /* supported formats SNDRV_PCM_FMTBIT_* */
77 __le32 rates; /* supported rates SNDRV_PCM_RATE_* */
78 __le32 rate_min; /* min rate */
79 __le32 rate_max; /* max rate */
80 __le32 channels_min; /* min channels */
81 __le32 channels_max; /* max channels */
82 __le32 periods_min; /* min number of periods */
83 __le32 periods_max; /* max number of periods */
84 __le32 period_size_min; /* min period size bytes */
85 __le32 period_size_max; /* max period size bytes */
86 __le32 buffer_size_min; /* min buffer size bytes */
87 __le32 buffer_size_max; /* max buffer size bytes */
88 } __packed;
90 /* PCM v4 */
91 struct snd_soc_tplg_pcm_v4 {
92 __le32 size; /* in bytes of this structure */
93 char pcm_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
94 char dai_name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
95 __le32 pcm_id; /* unique ID - used to match with DAI link */
96 __le32 dai_id; /* unique ID - used to match */
97 __le32 playback; /* supports playback mode */
98 __le32 capture; /* supports capture mode */
99 __le32 compress; /* 1 = compressed; 0 = PCM */
100 struct snd_soc_tplg_stream stream[SND_SOC_TPLG_STREAM_CONFIG_MAX]; /* for DAI link */
101 __le32 num_streams; /* number of streams */
102 struct snd_soc_tplg_stream_caps_v4 caps[2]; /* playback and capture for DAI */
103 } __packed;
105 /* Physical link config v4 */
106 struct snd_soc_tplg_link_config_v4 {
107 __le32 size; /* in bytes of this structure */
108 __le32 id; /* unique ID - used to match */
109 struct snd_soc_tplg_stream stream[SND_SOC_TPLG_STREAM_CONFIG_MAX]; /* supported configs playback and captrure */
110 __le32 num_streams; /* number of streams */
111 } __packed;
113 /* topology context */
114 struct soc_tplg {
115 const struct firmware *fw;
117 /* runtime FW parsing */
118 const u8 *pos; /* read postion */
119 const u8 *hdr_pos; /* header position */
120 unsigned int pass; /* pass number */
122 /* component caller */
123 struct device *dev;
124 struct snd_soc_component *comp;
125 u32 index; /* current block index */
126 u32 req_index; /* required index, only loaded/free matching blocks */
128 /* vendor specific kcontrol operations */
129 const struct snd_soc_tplg_kcontrol_ops *io_ops;
130 int io_ops_count;
132 /* vendor specific bytes ext handlers, for TLV bytes controls */
133 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
134 int bytes_ext_ops_count;
136 /* optional fw loading callbacks to component drivers */
137 struct snd_soc_tplg_ops *ops;
140 static int soc_tplg_process_headers(struct soc_tplg *tplg);
141 static void soc_tplg_complete(struct soc_tplg *tplg);
142 struct snd_soc_dapm_widget *
143 snd_soc_dapm_new_control_unlocked(struct snd_soc_dapm_context *dapm,
144 const struct snd_soc_dapm_widget *widget);
145 struct snd_soc_dapm_widget *
146 snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
147 const struct snd_soc_dapm_widget *widget);
149 /* check we dont overflow the data for this control chunk */
150 static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
151 unsigned int count, size_t bytes, const char *elem_type)
153 const u8 *end = tplg->pos + elem_size * count;
155 if (end > tplg->fw->data + tplg->fw->size) {
156 dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
157 elem_type);
158 return -EINVAL;
161 /* check there is enough room in chunk for control.
162 extra bytes at the end of control are for vendor data here */
163 if (elem_size * count > bytes) {
164 dev_err(tplg->dev,
165 "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
166 elem_type, count, elem_size, bytes);
167 return -EINVAL;
170 return 0;
173 static inline int soc_tplg_is_eof(struct soc_tplg *tplg)
175 const u8 *end = tplg->hdr_pos;
177 if (end >= tplg->fw->data + tplg->fw->size)
178 return 1;
179 return 0;
182 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
184 return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
187 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
189 return (unsigned long)(tplg->pos - tplg->fw->data);
192 /* mapping of Kcontrol types and associated operations. */
193 static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
194 {SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
195 snd_soc_put_volsw, snd_soc_info_volsw},
196 {SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
197 snd_soc_put_volsw_sx, NULL},
198 {SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
199 snd_soc_put_enum_double, snd_soc_info_enum_double},
200 {SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
201 snd_soc_put_enum_double, NULL},
202 {SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
203 snd_soc_bytes_put, snd_soc_bytes_info},
204 {SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw_range,
205 snd_soc_put_volsw_range, snd_soc_info_volsw_range},
206 {SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
207 snd_soc_put_xr_sx, snd_soc_info_xr_sx},
208 {SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
209 snd_soc_put_strobe, NULL},
210 {SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
211 snd_soc_dapm_put_volsw, snd_soc_info_volsw},
212 {SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
213 snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
214 {SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
215 snd_soc_dapm_put_enum_double, NULL},
216 {SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
217 snd_soc_dapm_put_enum_double, NULL},
218 {SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
219 snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
222 struct soc_tplg_map {
223 int uid;
224 int kid;
227 /* mapping of widget types from UAPI IDs to kernel IDs */
228 static const struct soc_tplg_map dapm_map[] = {
229 {SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
230 {SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
231 {SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
232 {SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
233 {SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
234 {SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
235 {SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
236 {SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
237 {SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
238 {SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
239 {SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
240 {SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
241 {SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
242 {SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
243 {SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
244 {SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
247 static int tplc_chan_get_reg(struct soc_tplg *tplg,
248 struct snd_soc_tplg_channel *chan, int map)
250 int i;
252 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
253 if (chan[i].id == map)
254 return chan[i].reg;
257 return -EINVAL;
260 static int tplc_chan_get_shift(struct soc_tplg *tplg,
261 struct snd_soc_tplg_channel *chan, int map)
263 int i;
265 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
266 if (chan[i].id == map)
267 return chan[i].shift;
270 return -EINVAL;
273 static int get_widget_id(int tplg_type)
275 int i;
277 for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
278 if (tplg_type == dapm_map[i].uid)
279 return dapm_map[i].kid;
282 return -EINVAL;
285 static inline void soc_bind_err(struct soc_tplg *tplg,
286 struct snd_soc_tplg_ctl_hdr *hdr, int index)
288 dev_err(tplg->dev,
289 "ASoC: invalid control type (g,p,i) %d:%d:%d index %d at 0x%lx\n",
290 hdr->ops.get, hdr->ops.put, hdr->ops.info, index,
291 soc_tplg_get_offset(tplg));
294 static inline void soc_control_err(struct soc_tplg *tplg,
295 struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
297 dev_err(tplg->dev,
298 "ASoC: no complete mixer IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
299 name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
300 soc_tplg_get_offset(tplg));
303 /* pass vendor data to component driver for processing */
304 static int soc_tplg_vendor_load_(struct soc_tplg *tplg,
305 struct snd_soc_tplg_hdr *hdr)
307 int ret = 0;
309 if (tplg->comp && tplg->ops && tplg->ops->vendor_load)
310 ret = tplg->ops->vendor_load(tplg->comp, hdr);
311 else {
312 dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
313 hdr->vendor_type);
314 return -EINVAL;
317 if (ret < 0)
318 dev_err(tplg->dev,
319 "ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
320 soc_tplg_get_hdr_offset(tplg),
321 soc_tplg_get_hdr_offset(tplg),
322 hdr->type, hdr->vendor_type);
323 return ret;
326 /* pass vendor data to component driver for processing */
327 static int soc_tplg_vendor_load(struct soc_tplg *tplg,
328 struct snd_soc_tplg_hdr *hdr)
330 if (tplg->pass != SOC_TPLG_PASS_VENDOR)
331 return 0;
333 return soc_tplg_vendor_load_(tplg, hdr);
336 /* optionally pass new dynamic widget to component driver. This is mainly for
337 * external widgets where we can assign private data/ops */
338 static int soc_tplg_widget_load(struct soc_tplg *tplg,
339 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
341 if (tplg->comp && tplg->ops && tplg->ops->widget_load)
342 return tplg->ops->widget_load(tplg->comp, w, tplg_w);
344 return 0;
347 /* pass DAI configurations to component driver for extra intialization */
348 static int soc_tplg_dai_load(struct soc_tplg *tplg,
349 struct snd_soc_dai_driver *dai_drv)
351 if (tplg->comp && tplg->ops && tplg->ops->dai_load)
352 return tplg->ops->dai_load(tplg->comp, dai_drv);
354 return 0;
357 /* pass link configurations to component driver for extra intialization */
358 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
359 struct snd_soc_dai_link *link)
361 if (tplg->comp && tplg->ops && tplg->ops->link_load)
362 return tplg->ops->link_load(tplg->comp, link);
364 return 0;
367 /* tell the component driver that all firmware has been loaded in this request */
368 static void soc_tplg_complete(struct soc_tplg *tplg)
370 if (tplg->comp && tplg->ops && tplg->ops->complete)
371 tplg->ops->complete(tplg->comp);
374 /* add a dynamic kcontrol */
375 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
376 const struct snd_kcontrol_new *control_new, const char *prefix,
377 void *data, struct snd_kcontrol **kcontrol)
379 int err;
381 *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
382 if (*kcontrol == NULL) {
383 dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
384 control_new->name);
385 return -ENOMEM;
388 err = snd_ctl_add(card, *kcontrol);
389 if (err < 0) {
390 dev_err(dev, "ASoC: Failed to add %s: %d\n",
391 control_new->name, err);
392 return err;
395 return 0;
398 /* add a dynamic kcontrol for component driver */
399 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
400 struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
402 struct snd_soc_component *comp = tplg->comp;
404 return soc_tplg_add_dcontrol(comp->card->snd_card,
405 comp->dev, k, NULL, comp, kcontrol);
408 /* remove a mixer kcontrol */
409 static void remove_mixer(struct snd_soc_component *comp,
410 struct snd_soc_dobj *dobj, int pass)
412 struct snd_card *card = comp->card->snd_card;
413 struct soc_mixer_control *sm =
414 container_of(dobj, struct soc_mixer_control, dobj);
415 const unsigned int *p = NULL;
417 if (pass != SOC_TPLG_PASS_MIXER)
418 return;
420 if (dobj->ops && dobj->ops->control_unload)
421 dobj->ops->control_unload(comp, dobj);
423 if (sm->dobj.control.kcontrol->tlv.p)
424 p = sm->dobj.control.kcontrol->tlv.p;
425 snd_ctl_remove(card, sm->dobj.control.kcontrol);
426 list_del(&sm->dobj.list);
427 kfree(sm);
428 kfree(p);
431 /* remove an enum kcontrol */
432 static void remove_enum(struct snd_soc_component *comp,
433 struct snd_soc_dobj *dobj, int pass)
435 struct snd_card *card = comp->card->snd_card;
436 struct soc_enum *se = container_of(dobj, struct soc_enum, dobj);
437 int i;
439 if (pass != SOC_TPLG_PASS_MIXER)
440 return;
442 if (dobj->ops && dobj->ops->control_unload)
443 dobj->ops->control_unload(comp, dobj);
445 snd_ctl_remove(card, se->dobj.control.kcontrol);
446 list_del(&se->dobj.list);
448 kfree(se->dobj.control.dvalues);
449 for (i = 0; i < se->items; i++)
450 kfree(se->dobj.control.dtexts[i]);
451 kfree(se);
454 /* remove a byte kcontrol */
455 static void remove_bytes(struct snd_soc_component *comp,
456 struct snd_soc_dobj *dobj, int pass)
458 struct snd_card *card = comp->card->snd_card;
459 struct soc_bytes_ext *sb =
460 container_of(dobj, struct soc_bytes_ext, dobj);
462 if (pass != SOC_TPLG_PASS_MIXER)
463 return;
465 if (dobj->ops && dobj->ops->control_unload)
466 dobj->ops->control_unload(comp, dobj);
468 snd_ctl_remove(card, sb->dobj.control.kcontrol);
469 list_del(&sb->dobj.list);
470 kfree(sb);
473 /* remove a widget and it's kcontrols - routes must be removed first */
474 static void remove_widget(struct snd_soc_component *comp,
475 struct snd_soc_dobj *dobj, int pass)
477 struct snd_card *card = comp->card->snd_card;
478 struct snd_soc_dapm_widget *w =
479 container_of(dobj, struct snd_soc_dapm_widget, dobj);
480 int i;
482 if (pass != SOC_TPLG_PASS_WIDGET)
483 return;
485 if (dobj->ops && dobj->ops->widget_unload)
486 dobj->ops->widget_unload(comp, dobj);
489 * Dynamic Widgets either have 1..N enum kcontrols or mixers.
490 * The enum may either have an array of values or strings.
492 if (dobj->widget.kcontrol_type == SND_SOC_TPLG_TYPE_ENUM) {
493 /* enumerated widget mixer */
494 for (i = 0; i < w->num_kcontrols; i++) {
495 struct snd_kcontrol *kcontrol = w->kcontrols[i];
496 struct soc_enum *se =
497 (struct soc_enum *)kcontrol->private_value;
499 snd_ctl_remove(card, kcontrol);
501 kfree(se->dobj.control.dvalues);
502 for (i = 0; i < se->items; i++)
503 kfree(se->dobj.control.dtexts[i]);
505 kfree(se);
507 kfree(w->kcontrol_news);
508 } else {
509 /* volume mixer or bytes controls */
510 for (i = 0; i < w->num_kcontrols; i++) {
511 struct snd_kcontrol *kcontrol = w->kcontrols[i];
513 if (dobj->widget.kcontrol_type
514 == SND_SOC_TPLG_TYPE_MIXER)
515 kfree(kcontrol->tlv.p);
517 snd_ctl_remove(card, kcontrol);
519 /* Private value is used as struct soc_mixer_control
520 * for volume mixers or soc_bytes_ext for bytes
521 * controls.
523 kfree((void *)kcontrol->private_value);
525 kfree(w->kcontrol_news);
527 /* widget w is freed by soc-dapm.c */
530 /* remove DAI configurations */
531 static void remove_dai(struct snd_soc_component *comp,
532 struct snd_soc_dobj *dobj, int pass)
534 struct snd_soc_dai_driver *dai_drv =
535 container_of(dobj, struct snd_soc_dai_driver, dobj);
537 if (pass != SOC_TPLG_PASS_PCM_DAI)
538 return;
540 if (dobj->ops && dobj->ops->dai_unload)
541 dobj->ops->dai_unload(comp, dobj);
543 kfree(dai_drv->name);
544 list_del(&dobj->list);
545 kfree(dai_drv);
548 /* remove link configurations */
549 static void remove_link(struct snd_soc_component *comp,
550 struct snd_soc_dobj *dobj, int pass)
552 struct snd_soc_dai_link *link =
553 container_of(dobj, struct snd_soc_dai_link, dobj);
555 if (pass != SOC_TPLG_PASS_PCM_DAI)
556 return;
558 if (dobj->ops && dobj->ops->link_unload)
559 dobj->ops->link_unload(comp, dobj);
561 kfree(link->name);
562 kfree(link->stream_name);
563 kfree(link->cpu_dai_name);
565 list_del(&dobj->list);
566 snd_soc_remove_dai_link(comp->card, link);
567 kfree(link);
570 /* bind a kcontrol to it's IO handlers */
571 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
572 struct snd_kcontrol_new *k,
573 const struct soc_tplg *tplg)
575 const struct snd_soc_tplg_kcontrol_ops *ops;
576 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
577 int num_ops, i;
579 if (hdr->ops.info == SND_SOC_TPLG_CTL_BYTES
580 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
581 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
582 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
583 struct soc_bytes_ext *sbe;
584 struct snd_soc_tplg_bytes_control *be;
586 sbe = (struct soc_bytes_ext *)k->private_value;
587 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
589 /* TLV bytes controls need standard kcontrol info handler,
590 * TLV callback and extended put/get handlers.
592 k->info = snd_soc_bytes_info_ext;
593 k->tlv.c = snd_soc_bytes_tlv_callback;
595 ext_ops = tplg->bytes_ext_ops;
596 num_ops = tplg->bytes_ext_ops_count;
597 for (i = 0; i < num_ops; i++) {
598 if (!sbe->put && ext_ops[i].id == be->ext_ops.put)
599 sbe->put = ext_ops[i].put;
600 if (!sbe->get && ext_ops[i].id == be->ext_ops.get)
601 sbe->get = ext_ops[i].get;
604 if (sbe->put && sbe->get)
605 return 0;
606 else
607 return -EINVAL;
610 /* try and map vendor specific kcontrol handlers first */
611 ops = tplg->io_ops;
612 num_ops = tplg->io_ops_count;
613 for (i = 0; i < num_ops; i++) {
615 if (k->put == NULL && ops[i].id == hdr->ops.put)
616 k->put = ops[i].put;
617 if (k->get == NULL && ops[i].id == hdr->ops.get)
618 k->get = ops[i].get;
619 if (k->info == NULL && ops[i].id == hdr->ops.info)
620 k->info = ops[i].info;
623 /* vendor specific handlers found ? */
624 if (k->put && k->get && k->info)
625 return 0;
627 /* none found so try standard kcontrol handlers */
628 ops = io_ops;
629 num_ops = ARRAY_SIZE(io_ops);
630 for (i = 0; i < num_ops; i++) {
632 if (k->put == NULL && ops[i].id == hdr->ops.put)
633 k->put = ops[i].put;
634 if (k->get == NULL && ops[i].id == hdr->ops.get)
635 k->get = ops[i].get;
636 if (k->info == NULL && ops[i].id == hdr->ops.info)
637 k->info = ops[i].info;
640 /* standard handlers found ? */
641 if (k->put && k->get && k->info)
642 return 0;
644 /* nothing to bind */
645 return -EINVAL;
648 /* bind a widgets to it's evnt handlers */
649 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
650 const struct snd_soc_tplg_widget_events *events,
651 int num_events, u16 event_type)
653 int i;
655 w->event = NULL;
657 for (i = 0; i < num_events; i++) {
658 if (event_type == events[i].type) {
660 /* found - so assign event */
661 w->event = events[i].event_handler;
662 return 0;
666 /* not found */
667 return -EINVAL;
669 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
671 /* optionally pass new dynamic kcontrol to component driver. */
672 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
673 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
675 if (tplg->comp && tplg->ops && tplg->ops->control_load)
676 return tplg->ops->control_load(tplg->comp, k, hdr);
678 return 0;
682 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
683 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
685 unsigned int item_len = 2 * sizeof(unsigned int);
686 unsigned int *p;
688 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
689 if (!p)
690 return -ENOMEM;
692 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
693 p[1] = item_len;
694 p[2] = scale->min;
695 p[3] = (scale->step & TLV_DB_SCALE_MASK)
696 | (scale->mute ? TLV_DB_SCALE_MUTE : 0);
698 kc->tlv.p = (void *)p;
699 return 0;
702 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
703 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
705 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
707 if (!(tc->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
708 return 0;
710 if (!(tc->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
711 tplg_tlv = &tc->tlv;
712 switch (tplg_tlv->type) {
713 case SNDRV_CTL_TLVT_DB_SCALE:
714 return soc_tplg_create_tlv_db_scale(tplg, kc,
715 &tplg_tlv->scale);
717 /* TODO: add support for other TLV types */
718 default:
719 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
720 tplg_tlv->type);
721 return -EINVAL;
725 return 0;
728 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
729 struct snd_kcontrol_new *kc)
731 kfree(kc->tlv.p);
734 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
735 size_t size)
737 struct snd_soc_tplg_bytes_control *be;
738 struct soc_bytes_ext *sbe;
739 struct snd_kcontrol_new kc;
740 int i, err;
742 if (soc_tplg_check_elem_count(tplg,
743 sizeof(struct snd_soc_tplg_bytes_control), count,
744 size, "mixer bytes")) {
745 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
746 count);
747 return -EINVAL;
750 for (i = 0; i < count; i++) {
751 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
753 /* validate kcontrol */
754 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
755 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
756 return -EINVAL;
758 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
759 if (sbe == NULL)
760 return -ENOMEM;
762 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
763 be->priv.size);
765 dev_dbg(tplg->dev,
766 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
767 be->hdr.name, be->hdr.access);
769 memset(&kc, 0, sizeof(kc));
770 kc.name = be->hdr.name;
771 kc.private_value = (long)sbe;
772 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
773 kc.access = be->hdr.access;
775 sbe->max = be->max;
776 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
777 sbe->dobj.ops = tplg->ops;
778 INIT_LIST_HEAD(&sbe->dobj.list);
780 /* map io handlers */
781 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
782 if (err) {
783 soc_control_err(tplg, &be->hdr, be->hdr.name);
784 kfree(sbe);
785 continue;
788 /* pass control to driver for optional further init */
789 err = soc_tplg_init_kcontrol(tplg, &kc,
790 (struct snd_soc_tplg_ctl_hdr *)be);
791 if (err < 0) {
792 dev_err(tplg->dev, "ASoC: failed to init %s\n",
793 be->hdr.name);
794 kfree(sbe);
795 continue;
798 /* register control here */
799 err = soc_tplg_add_kcontrol(tplg, &kc,
800 &sbe->dobj.control.kcontrol);
801 if (err < 0) {
802 dev_err(tplg->dev, "ASoC: failed to add %s\n",
803 be->hdr.name);
804 kfree(sbe);
805 continue;
808 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
810 return 0;
814 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
815 size_t size)
817 struct snd_soc_tplg_mixer_control *mc;
818 struct soc_mixer_control *sm;
819 struct snd_kcontrol_new kc;
820 int i, err;
822 if (soc_tplg_check_elem_count(tplg,
823 sizeof(struct snd_soc_tplg_mixer_control),
824 count, size, "mixers")) {
826 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
827 count);
828 return -EINVAL;
831 for (i = 0; i < count; i++) {
832 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
834 /* validate kcontrol */
835 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
836 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
837 return -EINVAL;
839 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
840 if (sm == NULL)
841 return -ENOMEM;
842 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
843 mc->priv.size);
845 dev_dbg(tplg->dev,
846 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
847 mc->hdr.name, mc->hdr.access);
849 memset(&kc, 0, sizeof(kc));
850 kc.name = mc->hdr.name;
851 kc.private_value = (long)sm;
852 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
853 kc.access = mc->hdr.access;
855 /* we only support FL/FR channel mapping atm */
856 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
857 SNDRV_CHMAP_FL);
858 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
859 SNDRV_CHMAP_FR);
860 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
861 SNDRV_CHMAP_FL);
862 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
863 SNDRV_CHMAP_FR);
865 sm->max = mc->max;
866 sm->min = mc->min;
867 sm->invert = mc->invert;
868 sm->platform_max = mc->platform_max;
869 sm->dobj.index = tplg->index;
870 sm->dobj.ops = tplg->ops;
871 sm->dobj.type = SND_SOC_DOBJ_MIXER;
872 INIT_LIST_HEAD(&sm->dobj.list);
874 /* map io handlers */
875 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
876 if (err) {
877 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
878 kfree(sm);
879 continue;
882 /* pass control to driver for optional further init */
883 err = soc_tplg_init_kcontrol(tplg, &kc,
884 (struct snd_soc_tplg_ctl_hdr *) mc);
885 if (err < 0) {
886 dev_err(tplg->dev, "ASoC: failed to init %s\n",
887 mc->hdr.name);
888 kfree(sm);
889 continue;
892 /* create any TLV data */
893 soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
895 /* register control here */
896 err = soc_tplg_add_kcontrol(tplg, &kc,
897 &sm->dobj.control.kcontrol);
898 if (err < 0) {
899 dev_err(tplg->dev, "ASoC: failed to add %s\n",
900 mc->hdr.name);
901 soc_tplg_free_tlv(tplg, &kc);
902 kfree(sm);
903 continue;
906 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
909 return 0;
912 static int soc_tplg_denum_create_texts(struct soc_enum *se,
913 struct snd_soc_tplg_enum_control *ec)
915 int i, ret;
917 se->dobj.control.dtexts =
918 kzalloc(sizeof(char *) * ec->items, GFP_KERNEL);
919 if (se->dobj.control.dtexts == NULL)
920 return -ENOMEM;
922 for (i = 0; i < ec->items; i++) {
924 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
925 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
926 ret = -EINVAL;
927 goto err;
930 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
931 if (!se->dobj.control.dtexts[i]) {
932 ret = -ENOMEM;
933 goto err;
937 return 0;
939 err:
940 for (--i; i >= 0; i--)
941 kfree(se->dobj.control.dtexts[i]);
942 kfree(se->dobj.control.dtexts);
943 return ret;
946 static int soc_tplg_denum_create_values(struct soc_enum *se,
947 struct snd_soc_tplg_enum_control *ec)
949 if (ec->items > sizeof(*ec->values))
950 return -EINVAL;
952 se->dobj.control.dvalues = kmemdup(ec->values,
953 ec->items * sizeof(u32),
954 GFP_KERNEL);
955 if (!se->dobj.control.dvalues)
956 return -ENOMEM;
958 return 0;
961 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
962 size_t size)
964 struct snd_soc_tplg_enum_control *ec;
965 struct soc_enum *se;
966 struct snd_kcontrol_new kc;
967 int i, ret, err;
969 if (soc_tplg_check_elem_count(tplg,
970 sizeof(struct snd_soc_tplg_enum_control),
971 count, size, "enums")) {
973 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
974 count);
975 return -EINVAL;
978 for (i = 0; i < count; i++) {
979 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
980 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
981 ec->priv.size);
983 /* validate kcontrol */
984 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
985 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
986 return -EINVAL;
988 se = kzalloc((sizeof(*se)), GFP_KERNEL);
989 if (se == NULL)
990 return -ENOMEM;
992 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
993 ec->hdr.name, ec->items);
995 memset(&kc, 0, sizeof(kc));
996 kc.name = ec->hdr.name;
997 kc.private_value = (long)se;
998 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
999 kc.access = ec->hdr.access;
1001 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1002 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1003 SNDRV_CHMAP_FL);
1004 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1005 SNDRV_CHMAP_FL);
1007 se->items = ec->items;
1008 se->mask = ec->mask;
1009 se->dobj.index = tplg->index;
1010 se->dobj.type = SND_SOC_DOBJ_ENUM;
1011 se->dobj.ops = tplg->ops;
1012 INIT_LIST_HEAD(&se->dobj.list);
1014 switch (ec->hdr.ops.info) {
1015 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1016 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1017 err = soc_tplg_denum_create_values(se, ec);
1018 if (err < 0) {
1019 dev_err(tplg->dev,
1020 "ASoC: could not create values for %s\n",
1021 ec->hdr.name);
1022 kfree(se);
1023 continue;
1025 /* fall through and create texts */
1026 case SND_SOC_TPLG_CTL_ENUM:
1027 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1028 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1029 err = soc_tplg_denum_create_texts(se, ec);
1030 if (err < 0) {
1031 dev_err(tplg->dev,
1032 "ASoC: could not create texts for %s\n",
1033 ec->hdr.name);
1034 kfree(se);
1035 continue;
1037 break;
1038 default:
1039 dev_err(tplg->dev,
1040 "ASoC: invalid enum control type %d for %s\n",
1041 ec->hdr.ops.info, ec->hdr.name);
1042 kfree(se);
1043 continue;
1046 /* map io handlers */
1047 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1048 if (err) {
1049 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1050 kfree(se);
1051 continue;
1054 /* pass control to driver for optional further init */
1055 err = soc_tplg_init_kcontrol(tplg, &kc,
1056 (struct snd_soc_tplg_ctl_hdr *) ec);
1057 if (err < 0) {
1058 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1059 ec->hdr.name);
1060 kfree(se);
1061 continue;
1064 /* register control here */
1065 ret = soc_tplg_add_kcontrol(tplg,
1066 &kc, &se->dobj.control.kcontrol);
1067 if (ret < 0) {
1068 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1069 ec->hdr.name);
1070 kfree(se);
1071 continue;
1074 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1077 return 0;
1080 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1081 struct snd_soc_tplg_hdr *hdr)
1083 struct snd_soc_tplg_ctl_hdr *control_hdr;
1084 int i;
1086 if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1087 tplg->pos += hdr->size + hdr->payload_size;
1088 return 0;
1091 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1092 soc_tplg_get_offset(tplg));
1094 for (i = 0; i < hdr->count; i++) {
1096 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1098 if (control_hdr->size != sizeof(*control_hdr)) {
1099 dev_err(tplg->dev, "ASoC: invalid control size\n");
1100 return -EINVAL;
1103 switch (control_hdr->ops.info) {
1104 case SND_SOC_TPLG_CTL_VOLSW:
1105 case SND_SOC_TPLG_CTL_STROBE:
1106 case SND_SOC_TPLG_CTL_VOLSW_SX:
1107 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1108 case SND_SOC_TPLG_CTL_RANGE:
1109 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1110 case SND_SOC_TPLG_DAPM_CTL_PIN:
1111 soc_tplg_dmixer_create(tplg, 1, hdr->payload_size);
1112 break;
1113 case SND_SOC_TPLG_CTL_ENUM:
1114 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1115 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1116 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1117 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1118 soc_tplg_denum_create(tplg, 1, hdr->payload_size);
1119 break;
1120 case SND_SOC_TPLG_CTL_BYTES:
1121 soc_tplg_dbytes_create(tplg, 1, hdr->payload_size);
1122 break;
1123 default:
1124 soc_bind_err(tplg, control_hdr, i);
1125 return -EINVAL;
1129 return 0;
1132 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1133 struct snd_soc_tplg_hdr *hdr)
1135 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1136 struct snd_soc_dapm_route route;
1137 struct snd_soc_tplg_dapm_graph_elem *elem;
1138 int count = hdr->count, i;
1140 if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1141 tplg->pos += hdr->size + hdr->payload_size;
1142 return 0;
1145 if (soc_tplg_check_elem_count(tplg,
1146 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1147 count, hdr->payload_size, "graph")) {
1149 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1150 count);
1151 return -EINVAL;
1154 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes\n", count);
1156 for (i = 0; i < count; i++) {
1157 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1158 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1160 /* validate routes */
1161 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1162 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1163 return -EINVAL;
1164 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1165 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1166 return -EINVAL;
1167 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1168 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1169 return -EINVAL;
1171 route.source = elem->source;
1172 route.sink = elem->sink;
1173 route.connected = NULL; /* set to NULL atm for tplg users */
1174 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1175 route.control = NULL;
1176 else
1177 route.control = elem->control;
1179 /* add route, but keep going if some fail */
1180 snd_soc_dapm_add_routes(dapm, &route, 1);
1183 return 0;
1186 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1187 struct soc_tplg *tplg, int num_kcontrols)
1189 struct snd_kcontrol_new *kc;
1190 struct soc_mixer_control *sm;
1191 struct snd_soc_tplg_mixer_control *mc;
1192 int i, err;
1194 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1195 if (kc == NULL)
1196 return NULL;
1198 for (i = 0; i < num_kcontrols; i++) {
1199 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1200 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1201 if (sm == NULL)
1202 goto err;
1204 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1205 mc->priv.size);
1207 /* validate kcontrol */
1208 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1209 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1210 goto err_str;
1212 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1213 mc->hdr.name, i);
1215 kc[i].name = mc->hdr.name;
1216 kc[i].private_value = (long)sm;
1217 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1218 kc[i].access = mc->hdr.access;
1220 /* we only support FL/FR channel mapping atm */
1221 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1222 SNDRV_CHMAP_FL);
1223 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1224 SNDRV_CHMAP_FR);
1225 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1226 SNDRV_CHMAP_FL);
1227 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1228 SNDRV_CHMAP_FR);
1230 sm->max = mc->max;
1231 sm->min = mc->min;
1232 sm->invert = mc->invert;
1233 sm->platform_max = mc->platform_max;
1234 sm->dobj.index = tplg->index;
1235 INIT_LIST_HEAD(&sm->dobj.list);
1237 /* map io handlers */
1238 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1239 if (err) {
1240 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1241 kfree(sm);
1242 continue;
1245 /* pass control to driver for optional further init */
1246 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1247 (struct snd_soc_tplg_ctl_hdr *)mc);
1248 if (err < 0) {
1249 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1250 mc->hdr.name);
1251 kfree(sm);
1252 continue;
1255 return kc;
1257 err_str:
1258 kfree(sm);
1259 err:
1260 for (--i; i >= 0; i--)
1261 kfree((void *)kc[i].private_value);
1262 kfree(kc);
1263 return NULL;
1266 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1267 struct soc_tplg *tplg, int num_kcontrols)
1269 struct snd_kcontrol_new *kc;
1270 struct snd_soc_tplg_enum_control *ec;
1271 struct soc_enum *se;
1272 int i, j, err;
1274 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1275 if (kc == NULL)
1276 return NULL;
1278 for (i = 0; i < num_kcontrols; i++) {
1279 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1280 /* validate kcontrol */
1281 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1282 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1283 return NULL;
1285 se = kzalloc(sizeof(*se), GFP_KERNEL);
1286 if (se == NULL)
1287 goto err;
1289 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1290 ec->hdr.name);
1292 kc[i].name = ec->hdr.name;
1293 kc[i].private_value = (long)se;
1294 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1295 kc[i].access = ec->hdr.access;
1297 /* we only support FL/FR channel mapping atm */
1298 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1299 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1300 SNDRV_CHMAP_FL);
1301 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1302 SNDRV_CHMAP_FR);
1304 se->items = ec->items;
1305 se->mask = ec->mask;
1306 se->dobj.index = tplg->index;
1308 switch (ec->hdr.ops.info) {
1309 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1310 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1311 err = soc_tplg_denum_create_values(se, ec);
1312 if (err < 0) {
1313 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1314 ec->hdr.name);
1315 goto err_se;
1317 /* fall through to create texts */
1318 case SND_SOC_TPLG_CTL_ENUM:
1319 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1320 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1321 err = soc_tplg_denum_create_texts(se, ec);
1322 if (err < 0) {
1323 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1324 ec->hdr.name);
1325 goto err_se;
1327 break;
1328 default:
1329 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1330 ec->hdr.ops.info, ec->hdr.name);
1331 goto err_se;
1334 /* map io handlers */
1335 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1336 if (err) {
1337 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1338 goto err_se;
1341 /* pass control to driver for optional further init */
1342 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1343 (struct snd_soc_tplg_ctl_hdr *)ec);
1344 if (err < 0) {
1345 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1346 ec->hdr.name);
1347 goto err_se;
1350 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1351 ec->priv.size);
1354 return kc;
1356 err_se:
1357 for (; i >= 0; i--) {
1358 /* free values and texts */
1359 se = (struct soc_enum *)kc[i].private_value;
1360 kfree(se->dobj.control.dvalues);
1361 for (j = 0; j < ec->items; j++)
1362 kfree(se->dobj.control.dtexts[j]);
1364 kfree(se);
1366 err:
1367 kfree(kc);
1369 return NULL;
1372 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1373 struct soc_tplg *tplg, int count)
1375 struct snd_soc_tplg_bytes_control *be;
1376 struct soc_bytes_ext *sbe;
1377 struct snd_kcontrol_new *kc;
1378 int i, err;
1380 kc = kcalloc(count, sizeof(*kc), GFP_KERNEL);
1381 if (!kc)
1382 return NULL;
1384 for (i = 0; i < count; i++) {
1385 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1387 /* validate kcontrol */
1388 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1389 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1390 goto err;
1392 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1393 if (sbe == NULL)
1394 goto err;
1396 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1397 be->priv.size);
1399 dev_dbg(tplg->dev,
1400 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1401 be->hdr.name, be->hdr.access);
1403 kc[i].name = be->hdr.name;
1404 kc[i].private_value = (long)sbe;
1405 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1406 kc[i].access = be->hdr.access;
1408 sbe->max = be->max;
1409 INIT_LIST_HEAD(&sbe->dobj.list);
1411 /* map standard io handlers and check for external handlers */
1412 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1413 if (err) {
1414 soc_control_err(tplg, &be->hdr, be->hdr.name);
1415 kfree(sbe);
1416 continue;
1419 /* pass control to driver for optional further init */
1420 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1421 (struct snd_soc_tplg_ctl_hdr *)be);
1422 if (err < 0) {
1423 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1424 be->hdr.name);
1425 kfree(sbe);
1426 continue;
1430 return kc;
1432 err:
1433 for (--i; i >= 0; i--)
1434 kfree((void *)kc[i].private_value);
1436 kfree(kc);
1437 return NULL;
1440 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1441 struct snd_soc_tplg_dapm_widget *w)
1443 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1444 struct snd_soc_dapm_widget template, *widget;
1445 struct snd_soc_tplg_ctl_hdr *control_hdr;
1446 struct snd_soc_card *card = tplg->comp->card;
1447 unsigned int kcontrol_type;
1448 int ret = 0;
1450 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1451 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1452 return -EINVAL;
1453 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1454 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1455 return -EINVAL;
1457 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1458 w->name, w->id);
1460 memset(&template, 0, sizeof(template));
1462 /* map user to kernel widget ID */
1463 template.id = get_widget_id(w->id);
1464 if (template.id < 0)
1465 return template.id;
1467 template.name = kstrdup(w->name, GFP_KERNEL);
1468 if (!template.name)
1469 return -ENOMEM;
1470 template.sname = kstrdup(w->sname, GFP_KERNEL);
1471 if (!template.sname) {
1472 ret = -ENOMEM;
1473 goto err;
1475 template.reg = w->reg;
1476 template.shift = w->shift;
1477 template.mask = w->mask;
1478 template.subseq = w->subseq;
1479 template.on_val = w->invert ? 0 : 1;
1480 template.off_val = w->invert ? 1 : 0;
1481 template.ignore_suspend = w->ignore_suspend;
1482 template.event_flags = w->event_flags;
1483 template.dobj.index = tplg->index;
1485 tplg->pos +=
1486 (sizeof(struct snd_soc_tplg_dapm_widget) + w->priv.size);
1487 if (w->num_kcontrols == 0) {
1488 kcontrol_type = 0;
1489 template.num_kcontrols = 0;
1490 goto widget;
1493 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1494 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1495 w->name, w->num_kcontrols, control_hdr->type);
1497 switch (control_hdr->ops.info) {
1498 case SND_SOC_TPLG_CTL_VOLSW:
1499 case SND_SOC_TPLG_CTL_STROBE:
1500 case SND_SOC_TPLG_CTL_VOLSW_SX:
1501 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1502 case SND_SOC_TPLG_CTL_RANGE:
1503 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1504 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1505 template.num_kcontrols = w->num_kcontrols;
1506 template.kcontrol_news =
1507 soc_tplg_dapm_widget_dmixer_create(tplg,
1508 template.num_kcontrols);
1509 if (!template.kcontrol_news) {
1510 ret = -ENOMEM;
1511 goto hdr_err;
1513 break;
1514 case SND_SOC_TPLG_CTL_ENUM:
1515 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1516 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1517 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1518 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1519 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1520 template.num_kcontrols = w->num_kcontrols;
1521 template.kcontrol_news =
1522 soc_tplg_dapm_widget_denum_create(tplg,
1523 template.num_kcontrols);
1524 if (!template.kcontrol_news) {
1525 ret = -ENOMEM;
1526 goto hdr_err;
1528 break;
1529 case SND_SOC_TPLG_CTL_BYTES:
1530 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1531 template.num_kcontrols = w->num_kcontrols;
1532 template.kcontrol_news =
1533 soc_tplg_dapm_widget_dbytes_create(tplg,
1534 template.num_kcontrols);
1535 if (!template.kcontrol_news) {
1536 ret = -ENOMEM;
1537 goto hdr_err;
1539 break;
1540 default:
1541 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1542 control_hdr->ops.get, control_hdr->ops.put,
1543 control_hdr->ops.info);
1544 ret = -EINVAL;
1545 goto hdr_err;
1548 widget:
1549 ret = soc_tplg_widget_load(tplg, &template, w);
1550 if (ret < 0)
1551 goto hdr_err;
1553 /* card dapm mutex is held by the core if we are loading topology
1554 * data during sound card init. */
1555 if (card->instantiated)
1556 widget = snd_soc_dapm_new_control(dapm, &template);
1557 else
1558 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1559 if (widget == NULL) {
1560 dev_err(tplg->dev, "ASoC: failed to create widget %s controls\n",
1561 w->name);
1562 ret = -ENOMEM;
1563 goto hdr_err;
1566 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1567 widget->dobj.widget.kcontrol_type = kcontrol_type;
1568 widget->dobj.ops = tplg->ops;
1569 widget->dobj.index = tplg->index;
1570 kfree(template.sname);
1571 kfree(template.name);
1572 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1573 return 0;
1575 hdr_err:
1576 kfree(template.sname);
1577 err:
1578 kfree(template.name);
1579 return ret;
1582 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1583 struct snd_soc_tplg_hdr *hdr)
1585 struct snd_soc_tplg_dapm_widget *widget;
1586 int ret, count = hdr->count, i;
1588 if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1589 return 0;
1591 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1593 for (i = 0; i < count; i++) {
1594 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1595 if (widget->size != sizeof(*widget)) {
1596 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1597 return -EINVAL;
1600 ret = soc_tplg_dapm_widget_create(tplg, widget);
1601 if (ret < 0) {
1602 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1603 widget->name);
1604 return ret;
1608 return 0;
1611 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1613 struct snd_soc_card *card = tplg->comp->card;
1614 int ret;
1616 /* Card might not have been registered at this point.
1617 * If so, just return success.
1619 if (!card || !card->instantiated) {
1620 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1621 "Do not add new widgets now\n");
1622 return 0;
1625 ret = snd_soc_dapm_new_widgets(card);
1626 if (ret < 0)
1627 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1628 ret);
1630 return 0;
1633 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1634 struct snd_soc_tplg_stream_caps *caps)
1636 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1637 stream->channels_min = caps->channels_min;
1638 stream->channels_max = caps->channels_max;
1639 stream->rates = caps->rates;
1640 stream->rate_min = caps->rate_min;
1641 stream->rate_max = caps->rate_max;
1642 stream->formats = caps->formats;
1643 stream->sig_bits = caps->sig_bits;
1646 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1647 unsigned int flag_mask, unsigned int flags)
1649 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1650 dai_drv->symmetric_rates =
1651 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1653 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1654 dai_drv->symmetric_channels =
1655 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1656 1 : 0;
1658 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1659 dai_drv->symmetric_samplebits =
1660 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1661 1 : 0;
1664 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1665 struct snd_soc_tplg_pcm *pcm)
1667 struct snd_soc_dai_driver *dai_drv;
1668 struct snd_soc_pcm_stream *stream;
1669 struct snd_soc_tplg_stream_caps *caps;
1670 int ret;
1672 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1673 if (dai_drv == NULL)
1674 return -ENOMEM;
1676 if (strlen(pcm->dai_name))
1677 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1678 dai_drv->id = pcm->dai_id;
1680 if (pcm->playback) {
1681 stream = &dai_drv->playback;
1682 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1683 set_stream_info(stream, caps);
1686 if (pcm->capture) {
1687 stream = &dai_drv->capture;
1688 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1689 set_stream_info(stream, caps);
1692 /* pass control to component driver for optional further init */
1693 ret = soc_tplg_dai_load(tplg, dai_drv);
1694 if (ret < 0) {
1695 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1696 kfree(dai_drv);
1697 return ret;
1700 dai_drv->dobj.index = tplg->index;
1701 dai_drv->dobj.ops = tplg->ops;
1702 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1703 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1705 /* register the DAI to the component */
1706 return snd_soc_register_dai(tplg->comp, dai_drv);
1709 static void set_link_flags(struct snd_soc_dai_link *link,
1710 unsigned int flag_mask, unsigned int flags)
1712 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1713 link->symmetric_rates =
1714 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1716 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1717 link->symmetric_channels =
1718 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1719 1 : 0;
1721 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1722 link->symmetric_samplebits =
1723 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1724 1 : 0;
1726 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1727 link->ignore_suspend =
1728 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1729 1 : 0;
1732 /* create the FE DAI link */
1733 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1734 struct snd_soc_tplg_pcm *pcm)
1736 struct snd_soc_dai_link *link;
1737 int ret;
1739 link = kzalloc(sizeof(struct snd_soc_dai_link), GFP_KERNEL);
1740 if (link == NULL)
1741 return -ENOMEM;
1743 if (strlen(pcm->pcm_name)) {
1744 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1745 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1747 link->id = pcm->pcm_id;
1749 if (strlen(pcm->dai_name))
1750 link->cpu_dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1752 link->codec_name = "snd-soc-dummy";
1753 link->codec_dai_name = "snd-soc-dummy-dai";
1755 /* enable DPCM */
1756 link->dynamic = 1;
1757 link->dpcm_playback = pcm->playback;
1758 link->dpcm_capture = pcm->capture;
1759 if (pcm->flag_mask)
1760 set_link_flags(link, pcm->flag_mask, pcm->flags);
1762 /* pass control to component driver for optional further init */
1763 ret = soc_tplg_dai_link_load(tplg, link);
1764 if (ret < 0) {
1765 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1766 kfree(link);
1767 return ret;
1770 link->dobj.index = tplg->index;
1771 link->dobj.ops = tplg->ops;
1772 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1773 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1775 snd_soc_add_dai_link(tplg->comp->card, link);
1776 return 0;
1779 /* create a FE DAI and DAI link from the PCM object */
1780 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1781 struct snd_soc_tplg_pcm *pcm)
1783 int ret;
1785 ret = soc_tplg_dai_create(tplg, pcm);
1786 if (ret < 0)
1787 return ret;
1789 return soc_tplg_fe_link_create(tplg, pcm);
1792 /* copy stream caps from the old version 4 of source */
1793 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1794 struct snd_soc_tplg_stream_caps_v4 *src)
1796 dest->size = sizeof(*dest);
1797 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1798 dest->formats = src->formats;
1799 dest->rates = src->rates;
1800 dest->rate_min = src->rate_min;
1801 dest->rate_max = src->rate_max;
1802 dest->channels_min = src->channels_min;
1803 dest->channels_max = src->channels_max;
1804 dest->periods_min = src->periods_min;
1805 dest->periods_max = src->periods_max;
1806 dest->period_size_min = src->period_size_min;
1807 dest->period_size_max = src->period_size_max;
1808 dest->buffer_size_min = src->buffer_size_min;
1809 dest->buffer_size_max = src->buffer_size_max;
1813 * pcm_new_ver - Create the new version of PCM from the old version.
1814 * @tplg: topology context
1815 * @src: older version of pcm as a source
1816 * @pcm: latest version of pcm created from the source
1818 * Support from vesion 4. User should free the returned pcm manually.
1820 static int pcm_new_ver(struct soc_tplg *tplg,
1821 struct snd_soc_tplg_pcm *src,
1822 struct snd_soc_tplg_pcm **pcm)
1824 struct snd_soc_tplg_pcm *dest;
1825 struct snd_soc_tplg_pcm_v4 *src_v4;
1826 int i;
1828 *pcm = NULL;
1830 if (src->size != sizeof(*src_v4)) {
1831 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
1832 return -EINVAL;
1835 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
1836 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
1837 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
1838 if (!dest)
1839 return -ENOMEM;
1841 dest->size = sizeof(*dest); /* size of latest abi version */
1842 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1843 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1844 dest->pcm_id = src_v4->pcm_id;
1845 dest->dai_id = src_v4->dai_id;
1846 dest->playback = src_v4->playback;
1847 dest->capture = src_v4->capture;
1848 dest->compress = src_v4->compress;
1849 dest->num_streams = src_v4->num_streams;
1850 for (i = 0; i < dest->num_streams; i++)
1851 memcpy(&dest->stream[i], &src_v4->stream[i],
1852 sizeof(struct snd_soc_tplg_stream));
1854 for (i = 0; i < 2; i++)
1855 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
1857 *pcm = dest;
1858 return 0;
1861 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
1862 struct snd_soc_tplg_hdr *hdr)
1864 struct snd_soc_tplg_pcm *pcm, *_pcm;
1865 int count = hdr->count;
1866 int i, err;
1867 bool abi_match;
1869 if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
1870 return 0;
1872 /* check the element size and count */
1873 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1874 if (pcm->size > sizeof(struct snd_soc_tplg_pcm)
1875 || pcm->size < sizeof(struct snd_soc_tplg_pcm_v4)) {
1876 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
1877 pcm->size);
1878 return -EINVAL;
1881 if (soc_tplg_check_elem_count(tplg,
1882 pcm->size, count,
1883 hdr->payload_size, "PCM DAI")) {
1884 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
1885 count);
1886 return -EINVAL;
1889 for (i = 0; i < count; i++) {
1890 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1892 /* check ABI version by size, create a new version of pcm
1893 * if abi not match.
1895 if (pcm->size == sizeof(*pcm)) {
1896 abi_match = true;
1897 _pcm = pcm;
1898 } else {
1899 abi_match = false;
1900 err = pcm_new_ver(tplg, pcm, &_pcm);
1903 /* create the FE DAIs and DAI links */
1904 soc_tplg_pcm_create(tplg, _pcm);
1906 /* offset by version-specific struct size and
1907 * real priv data size
1909 tplg->pos += pcm->size + _pcm->priv.size;
1911 if (!abi_match)
1912 kfree(_pcm); /* free the duplicated one */
1915 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
1917 return 0;
1921 * set_link_hw_format - Set the HW audio format of the physical DAI link.
1922 * @tplg: topology context
1923 * @cfg: physical link configs.
1925 * Topology context contains a list of supported HW formats (configs) and
1926 * a default format ID for the physical link. This function will use this
1927 * default ID to choose the HW format to set the link's DAI format for init.
1929 static void set_link_hw_format(struct snd_soc_dai_link *link,
1930 struct snd_soc_tplg_link_config *cfg)
1932 struct snd_soc_tplg_hw_config *hw_config;
1933 unsigned char bclk_master, fsync_master;
1934 unsigned char invert_bclk, invert_fsync;
1935 int i;
1937 for (i = 0; i < cfg->num_hw_configs; i++) {
1938 hw_config = &cfg->hw_config[i];
1939 if (hw_config->id != cfg->default_hw_config_id)
1940 continue;
1942 link->dai_fmt = hw_config->fmt & SND_SOC_DAIFMT_FORMAT_MASK;
1944 /* clock signal polarity */
1945 invert_bclk = hw_config->invert_bclk;
1946 invert_fsync = hw_config->invert_fsync;
1947 if (!invert_bclk && !invert_fsync)
1948 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
1949 else if (!invert_bclk && invert_fsync)
1950 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
1951 else if (invert_bclk && !invert_fsync)
1952 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
1953 else
1954 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
1956 /* clock masters */
1957 bclk_master = hw_config->bclk_master;
1958 fsync_master = hw_config->fsync_master;
1959 if (!bclk_master && !fsync_master)
1960 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
1961 else if (bclk_master && !fsync_master)
1962 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
1963 else if (!bclk_master && fsync_master)
1964 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
1965 else
1966 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
1971 * link_new_ver - Create a new physical link config from the old
1972 * version of source.
1973 * @toplogy: topology context
1974 * @src: old version of phyical link config as a source
1975 * @link: latest version of physical link config created from the source
1977 * Support from vesion 4. User need free the returned link config manually.
1979 static int link_new_ver(struct soc_tplg *tplg,
1980 struct snd_soc_tplg_link_config *src,
1981 struct snd_soc_tplg_link_config **link)
1983 struct snd_soc_tplg_link_config *dest;
1984 struct snd_soc_tplg_link_config_v4 *src_v4;
1985 int i;
1987 *link = NULL;
1989 if (src->size != sizeof(struct snd_soc_tplg_link_config_v4)) {
1990 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
1991 return -EINVAL;
1994 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
1996 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
1997 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
1998 if (!dest)
1999 return -ENOMEM;
2001 dest->size = sizeof(*dest);
2002 dest->id = src_v4->id;
2003 dest->num_streams = src_v4->num_streams;
2004 for (i = 0; i < dest->num_streams; i++)
2005 memcpy(&dest->stream[i], &src_v4->stream[i],
2006 sizeof(struct snd_soc_tplg_stream));
2008 *link = dest;
2009 return 0;
2012 /* Find and configure an existing physical DAI link */
2013 static int soc_tplg_link_config(struct soc_tplg *tplg,
2014 struct snd_soc_tplg_link_config *cfg)
2016 struct snd_soc_dai_link *link;
2017 const char *name, *stream_name;
2018 size_t len;
2019 int ret;
2021 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2022 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2023 return -EINVAL;
2024 else if (len)
2025 name = cfg->name;
2026 else
2027 name = NULL;
2029 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2030 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2031 return -EINVAL;
2032 else if (len)
2033 stream_name = cfg->stream_name;
2034 else
2035 stream_name = NULL;
2037 link = snd_soc_find_dai_link(tplg->comp->card, cfg->id,
2038 name, stream_name);
2039 if (!link) {
2040 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2041 name, cfg->id);
2042 return -EINVAL;
2045 /* hw format */
2046 if (cfg->num_hw_configs)
2047 set_link_hw_format(link, cfg);
2049 /* flags */
2050 if (cfg->flag_mask)
2051 set_link_flags(link, cfg->flag_mask, cfg->flags);
2053 /* pass control to component driver for optional further init */
2054 ret = soc_tplg_dai_link_load(tplg, link);
2055 if (ret < 0) {
2056 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2057 return ret;
2060 return 0;
2064 /* Load physical link config elements from the topology context */
2065 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2066 struct snd_soc_tplg_hdr *hdr)
2068 struct snd_soc_tplg_link_config *link, *_link;
2069 int count = hdr->count;
2070 int i, ret;
2071 bool abi_match;
2073 if (tplg->pass != SOC_TPLG_PASS_LINK) {
2074 tplg->pos += hdr->size + hdr->payload_size;
2075 return 0;
2078 /* check the element size and count */
2079 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2080 if (link->size > sizeof(struct snd_soc_tplg_link_config)
2081 || link->size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2082 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2083 link->size);
2084 return -EINVAL;
2087 if (soc_tplg_check_elem_count(tplg,
2088 link->size, count,
2089 hdr->payload_size, "physical link config")) {
2090 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2091 count);
2092 return -EINVAL;
2095 /* config physical DAI links */
2096 for (i = 0; i < count; i++) {
2097 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2098 if (link->size == sizeof(*link)) {
2099 abi_match = true;
2100 _link = link;
2101 } else {
2102 abi_match = false;
2103 ret = link_new_ver(tplg, link, &_link);
2104 if (ret < 0)
2105 return ret;
2108 ret = soc_tplg_link_config(tplg, _link);
2109 if (ret < 0)
2110 return ret;
2112 /* offset by version-specific struct size and
2113 * real priv data size
2115 tplg->pos += link->size + _link->priv.size;
2117 if (!abi_match)
2118 kfree(_link); /* free the duplicated one */
2121 return 0;
2125 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2126 * @tplg: topology context
2127 * @d: physical DAI configs.
2129 * The physical dai should already be registered by the platform driver.
2130 * The platform driver should specify the DAI name and ID for matching.
2132 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2133 struct snd_soc_tplg_dai *d)
2135 struct snd_soc_dai_link_component dai_component = {0};
2136 struct snd_soc_dai *dai;
2137 struct snd_soc_dai_driver *dai_drv;
2138 struct snd_soc_pcm_stream *stream;
2139 struct snd_soc_tplg_stream_caps *caps;
2140 int ret;
2142 dai_component.dai_name = d->dai_name;
2143 dai = snd_soc_find_dai(&dai_component);
2144 if (!dai) {
2145 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2146 d->dai_name);
2147 return -EINVAL;
2150 if (d->dai_id != dai->id) {
2151 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2152 d->dai_name);
2153 return -EINVAL;
2156 dai_drv = dai->driver;
2157 if (!dai_drv)
2158 return -EINVAL;
2160 if (d->playback) {
2161 stream = &dai_drv->playback;
2162 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2163 set_stream_info(stream, caps);
2166 if (d->capture) {
2167 stream = &dai_drv->capture;
2168 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2169 set_stream_info(stream, caps);
2172 if (d->flag_mask)
2173 set_dai_flags(dai_drv, d->flag_mask, d->flags);
2175 /* pass control to component driver for optional further init */
2176 ret = soc_tplg_dai_load(tplg, dai_drv);
2177 if (ret < 0) {
2178 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2179 return ret;
2182 return 0;
2185 /* load physical DAI elements */
2186 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2187 struct snd_soc_tplg_hdr *hdr)
2189 struct snd_soc_tplg_dai *dai;
2190 int count = hdr->count;
2191 int i;
2193 if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2194 return 0;
2196 /* config the existing BE DAIs */
2197 for (i = 0; i < count; i++) {
2198 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2199 if (dai->size != sizeof(*dai)) {
2200 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2201 return -EINVAL;
2204 soc_tplg_dai_config(tplg, dai);
2205 tplg->pos += (sizeof(*dai) + dai->priv.size);
2208 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2209 return 0;
2213 * manifest_new_ver - Create a new version of manifest from the old version
2214 * of source.
2215 * @toplogy: topology context
2216 * @src: old version of manifest as a source
2217 * @manifest: latest version of manifest created from the source
2219 * Support from vesion 4. Users need free the returned manifest manually.
2221 static int manifest_new_ver(struct soc_tplg *tplg,
2222 struct snd_soc_tplg_manifest *src,
2223 struct snd_soc_tplg_manifest **manifest)
2225 struct snd_soc_tplg_manifest *dest;
2226 struct snd_soc_tplg_manifest_v4 *src_v4;
2228 *manifest = NULL;
2230 if (src->size != sizeof(*src_v4)) {
2231 dev_err(tplg->dev, "ASoC: invalid manifest size\n");
2232 return -EINVAL;
2235 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2237 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2238 dest = kzalloc(sizeof(*dest) + src_v4->priv.size, GFP_KERNEL);
2239 if (!dest)
2240 return -ENOMEM;
2242 dest->size = sizeof(*dest); /* size of latest abi version */
2243 dest->control_elems = src_v4->control_elems;
2244 dest->widget_elems = src_v4->widget_elems;
2245 dest->graph_elems = src_v4->graph_elems;
2246 dest->pcm_elems = src_v4->pcm_elems;
2247 dest->dai_link_elems = src_v4->dai_link_elems;
2248 dest->priv.size = src_v4->priv.size;
2249 if (dest->priv.size)
2250 memcpy(dest->priv.data, src_v4->priv.data,
2251 src_v4->priv.size);
2253 *manifest = dest;
2254 return 0;
2257 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2258 struct snd_soc_tplg_hdr *hdr)
2260 struct snd_soc_tplg_manifest *manifest, *_manifest;
2261 bool abi_match;
2262 int err;
2264 if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2265 return 0;
2267 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2269 /* check ABI version by size, create a new manifest if abi not match */
2270 if (manifest->size == sizeof(*manifest)) {
2271 abi_match = true;
2272 _manifest = manifest;
2273 } else {
2274 abi_match = false;
2275 err = manifest_new_ver(tplg, manifest, &_manifest);
2276 if (err < 0)
2277 return err;
2280 /* pass control to component driver for optional further init */
2281 if (tplg->comp && tplg->ops && tplg->ops->manifest)
2282 return tplg->ops->manifest(tplg->comp, _manifest);
2284 if (!abi_match) /* free the duplicated one */
2285 kfree(_manifest);
2287 return 0;
2290 /* validate header magic, size and type */
2291 static int soc_valid_header(struct soc_tplg *tplg,
2292 struct snd_soc_tplg_hdr *hdr)
2294 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2295 return 0;
2297 if (hdr->size != sizeof(*hdr)) {
2298 dev_err(tplg->dev,
2299 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2300 hdr->type, soc_tplg_get_hdr_offset(tplg),
2301 tplg->fw->size);
2302 return -EINVAL;
2305 /* big endian firmware objects not supported atm */
2306 if (hdr->magic == cpu_to_be32(SND_SOC_TPLG_MAGIC)) {
2307 dev_err(tplg->dev,
2308 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2309 tplg->pass, hdr->magic,
2310 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2311 return -EINVAL;
2314 if (hdr->magic != SND_SOC_TPLG_MAGIC) {
2315 dev_err(tplg->dev,
2316 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2317 tplg->pass, hdr->magic,
2318 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2319 return -EINVAL;
2322 /* Support ABI from version 4 */
2323 if (hdr->abi > SND_SOC_TPLG_ABI_VERSION
2324 || hdr->abi < SND_SOC_TPLG_ABI_VERSION_MIN) {
2325 dev_err(tplg->dev,
2326 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2327 tplg->pass, hdr->abi,
2328 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2329 tplg->fw->size);
2330 return -EINVAL;
2333 if (hdr->payload_size == 0) {
2334 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2335 soc_tplg_get_hdr_offset(tplg));
2336 return -EINVAL;
2339 if (tplg->pass == hdr->type)
2340 dev_dbg(tplg->dev,
2341 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2342 hdr->payload_size, hdr->type, hdr->version,
2343 hdr->vendor_type, tplg->pass);
2345 return 1;
2348 /* check header type and call appropriate handler */
2349 static int soc_tplg_load_header(struct soc_tplg *tplg,
2350 struct snd_soc_tplg_hdr *hdr)
2352 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2354 /* check for matching ID */
2355 if (hdr->index != tplg->req_index &&
2356 hdr->index != SND_SOC_TPLG_INDEX_ALL)
2357 return 0;
2359 tplg->index = hdr->index;
2361 switch (hdr->type) {
2362 case SND_SOC_TPLG_TYPE_MIXER:
2363 case SND_SOC_TPLG_TYPE_ENUM:
2364 case SND_SOC_TPLG_TYPE_BYTES:
2365 return soc_tplg_kcontrol_elems_load(tplg, hdr);
2366 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2367 return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2368 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2369 return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2370 case SND_SOC_TPLG_TYPE_PCM:
2371 return soc_tplg_pcm_elems_load(tplg, hdr);
2372 case SND_SOC_TPLG_TYPE_DAI:
2373 return soc_tplg_dai_elems_load(tplg, hdr);
2374 case SND_SOC_TPLG_TYPE_DAI_LINK:
2375 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2376 /* physical link configurations */
2377 return soc_tplg_link_elems_load(tplg, hdr);
2378 case SND_SOC_TPLG_TYPE_MANIFEST:
2379 return soc_tplg_manifest_load(tplg, hdr);
2380 default:
2381 /* bespoke vendor data object */
2382 return soc_tplg_vendor_load(tplg, hdr);
2385 return 0;
2388 /* process the topology file headers */
2389 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2391 struct snd_soc_tplg_hdr *hdr;
2392 int ret;
2394 tplg->pass = SOC_TPLG_PASS_START;
2396 /* process the header types from start to end */
2397 while (tplg->pass <= SOC_TPLG_PASS_END) {
2399 tplg->hdr_pos = tplg->fw->data;
2400 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2402 while (!soc_tplg_is_eof(tplg)) {
2404 /* make sure header is valid before loading */
2405 ret = soc_valid_header(tplg, hdr);
2406 if (ret < 0)
2407 return ret;
2408 else if (ret == 0)
2409 break;
2411 /* load the header object */
2412 ret = soc_tplg_load_header(tplg, hdr);
2413 if (ret < 0)
2414 return ret;
2416 /* goto next header */
2417 tplg->hdr_pos += hdr->payload_size +
2418 sizeof(struct snd_soc_tplg_hdr);
2419 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2422 /* next data type pass */
2423 tplg->pass++;
2426 /* signal DAPM we are complete */
2427 ret = soc_tplg_dapm_complete(tplg);
2428 if (ret < 0)
2429 dev_err(tplg->dev,
2430 "ASoC: failed to initialise DAPM from Firmware\n");
2432 return ret;
2435 static int soc_tplg_load(struct soc_tplg *tplg)
2437 int ret;
2439 ret = soc_tplg_process_headers(tplg);
2440 if (ret == 0)
2441 soc_tplg_complete(tplg);
2443 return ret;
2446 /* load audio component topology from "firmware" file */
2447 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2448 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2450 struct soc_tplg tplg;
2452 /* setup parsing context */
2453 memset(&tplg, 0, sizeof(tplg));
2454 tplg.fw = fw;
2455 tplg.dev = comp->dev;
2456 tplg.comp = comp;
2457 tplg.ops = ops;
2458 tplg.req_index = id;
2459 tplg.io_ops = ops->io_ops;
2460 tplg.io_ops_count = ops->io_ops_count;
2461 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2462 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2464 return soc_tplg_load(&tplg);
2466 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2468 /* remove this dynamic widget */
2469 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2471 /* make sure we are a widget */
2472 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2473 return;
2475 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2477 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2479 /* remove all dynamic widgets from this DAPM context */
2480 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2481 u32 index)
2483 struct snd_soc_dapm_widget *w, *next_w;
2485 list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2487 /* make sure we are a widget with correct context */
2488 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2489 continue;
2491 /* match ID */
2492 if (w->dobj.index != index &&
2493 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2494 continue;
2495 /* check and free and dynamic widget kcontrols */
2496 snd_soc_tplg_widget_remove(w);
2497 snd_soc_dapm_free_widget(w);
2499 snd_soc_dapm_reset_cache(dapm);
2501 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2503 /* remove dynamic controls from the component driver */
2504 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2506 struct snd_soc_dobj *dobj, *next_dobj;
2507 int pass = SOC_TPLG_PASS_END;
2509 /* process the header types from end to start */
2510 while (pass >= SOC_TPLG_PASS_START) {
2512 /* remove mixer controls */
2513 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2514 list) {
2516 /* match index */
2517 if (dobj->index != index &&
2518 dobj->index != SND_SOC_TPLG_INDEX_ALL)
2519 continue;
2521 switch (dobj->type) {
2522 case SND_SOC_DOBJ_MIXER:
2523 remove_mixer(comp, dobj, pass);
2524 break;
2525 case SND_SOC_DOBJ_ENUM:
2526 remove_enum(comp, dobj, pass);
2527 break;
2528 case SND_SOC_DOBJ_BYTES:
2529 remove_bytes(comp, dobj, pass);
2530 break;
2531 case SND_SOC_DOBJ_WIDGET:
2532 remove_widget(comp, dobj, pass);
2533 break;
2534 case SND_SOC_DOBJ_PCM:
2535 remove_dai(comp, dobj, pass);
2536 break;
2537 case SND_SOC_DOBJ_DAI_LINK:
2538 remove_link(comp, dobj, pass);
2539 break;
2540 default:
2541 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2542 dobj->type);
2543 break;
2546 pass--;
2549 /* let caller know if FW can be freed when no objects are left */
2550 return !list_empty(&comp->dobj_list);
2552 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);