xref: /openbmc/linux/sound/soc/soc-topology.c (revision 76ce0265)
1 // SPDX-License-Identifier: GPL-2.0+
2 //
3 // soc-topology.c  --  ALSA SoC Topology
4 //
5 // Copyright (C) 2012 Texas Instruments Inc.
6 // Copyright (C) 2015 Intel Corporation.
7 //
8 // Authors: Liam Girdwood <liam.r.girdwood@linux.intel.com>
9 //		K, Mythri P <mythri.p.k@intel.com>
10 //		Prusty, Subhransu S <subhransu.s.prusty@intel.com>
11 //		B, Jayachandran <jayachandran.b@intel.com>
12 //		Abdullah, Omair M <omair.m.abdullah@intel.com>
13 //		Jin, Yao <yao.jin@intel.com>
14 //		Lin, Mengdong <mengdong.lin@intel.com>
15 //
16 //  Add support to read audio firmware topology alongside firmware text. The
17 //  topology data can contain kcontrols, DAPM graphs, widgets, DAIs, DAI links,
18 //  equalizers, firmware, coefficients etc.
19 //
20 //  This file only manages the core ALSA and ASoC components, all other bespoke
21 //  firmware topology data is passed to component drivers for bespoke handling.
22 
23 #include <linux/kernel.h>
24 #include <linux/export.h>
25 #include <linux/list.h>
26 #include <linux/firmware.h>
27 #include <linux/slab.h>
28 #include <sound/soc.h>
29 #include <sound/soc-dapm.h>
30 #include <sound/soc-topology.h>
31 #include <sound/tlv.h>
32 
33 #define SOC_TPLG_MAGIC_BIG_ENDIAN            0x436F5341 /* ASoC in reverse */
34 
35 /*
36  * We make several passes over the data (since it wont necessarily be ordered)
37  * and process objects in the following order. This guarantees the component
38  * drivers will be ready with any vendor data before the mixers and DAPM objects
39  * are loaded (that may make use of the vendor data).
40  */
41 #define SOC_TPLG_PASS_MANIFEST		0
42 #define SOC_TPLG_PASS_VENDOR		1
43 #define SOC_TPLG_PASS_MIXER		2
44 #define SOC_TPLG_PASS_WIDGET		3
45 #define SOC_TPLG_PASS_PCM_DAI		4
46 #define SOC_TPLG_PASS_GRAPH		5
47 #define SOC_TPLG_PASS_PINS		6
48 #define SOC_TPLG_PASS_BE_DAI		7
49 #define SOC_TPLG_PASS_LINK		8
50 
51 #define SOC_TPLG_PASS_START	SOC_TPLG_PASS_MANIFEST
52 #define SOC_TPLG_PASS_END	SOC_TPLG_PASS_LINK
53 
54 /* topology context */
55 struct soc_tplg {
56 	const struct firmware *fw;
57 
58 	/* runtime FW parsing */
59 	const u8 *pos;		/* read postion */
60 	const u8 *hdr_pos;	/* header position */
61 	unsigned int pass;	/* pass number */
62 
63 	/* component caller */
64 	struct device *dev;
65 	struct snd_soc_component *comp;
66 	u32 index;	/* current block index */
67 	u32 req_index;	/* required index, only loaded/free matching blocks */
68 
69 	/* vendor specific kcontrol operations */
70 	const struct snd_soc_tplg_kcontrol_ops *io_ops;
71 	int io_ops_count;
72 
73 	/* vendor specific bytes ext handlers, for TLV bytes controls */
74 	const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
75 	int bytes_ext_ops_count;
76 
77 	/* optional fw loading callbacks to component drivers */
78 	struct snd_soc_tplg_ops *ops;
79 };
80 
81 static int soc_tplg_process_headers(struct soc_tplg *tplg);
82 static void soc_tplg_complete(struct soc_tplg *tplg);
83 static void soc_tplg_denum_remove_texts(struct soc_enum *se);
84 static void soc_tplg_denum_remove_values(struct soc_enum *se);
85 
86 /* check we dont overflow the data for this control chunk */
87 static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
88 	unsigned int count, size_t bytes, const char *elem_type)
89 {
90 	const u8 *end = tplg->pos + elem_size * count;
91 
92 	if (end > tplg->fw->data + tplg->fw->size) {
93 		dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
94 			elem_type);
95 		return -EINVAL;
96 	}
97 
98 	/* check there is enough room in chunk for control.
99 	   extra bytes at the end of control are for vendor data here  */
100 	if (elem_size * count > bytes) {
101 		dev_err(tplg->dev,
102 			"ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
103 			elem_type, count, elem_size, bytes);
104 		return -EINVAL;
105 	}
106 
107 	return 0;
108 }
109 
110 static inline int soc_tplg_is_eof(struct soc_tplg *tplg)
111 {
112 	const u8 *end = tplg->hdr_pos;
113 
114 	if (end >= tplg->fw->data + tplg->fw->size)
115 		return 1;
116 	return 0;
117 }
118 
119 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
120 {
121 	return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
122 }
123 
124 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
125 {
126 	return (unsigned long)(tplg->pos - tplg->fw->data);
127 }
128 
129 /* mapping of Kcontrol types and associated operations. */
130 static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
131 	{SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
132 		snd_soc_put_volsw, snd_soc_info_volsw},
133 	{SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
134 		snd_soc_put_volsw_sx, NULL},
135 	{SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
136 		snd_soc_put_enum_double, snd_soc_info_enum_double},
137 	{SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
138 		snd_soc_put_enum_double, NULL},
139 	{SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
140 		snd_soc_bytes_put, snd_soc_bytes_info},
141 	{SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw_range,
142 		snd_soc_put_volsw_range, snd_soc_info_volsw_range},
143 	{SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
144 		snd_soc_put_xr_sx, snd_soc_info_xr_sx},
145 	{SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
146 		snd_soc_put_strobe, NULL},
147 	{SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
148 		snd_soc_dapm_put_volsw, snd_soc_info_volsw},
149 	{SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
150 		snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
151 	{SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
152 		snd_soc_dapm_put_enum_double, NULL},
153 	{SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
154 		snd_soc_dapm_put_enum_double, NULL},
155 	{SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
156 		snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
157 };
158 
159 struct soc_tplg_map {
160 	int uid;
161 	int kid;
162 };
163 
164 /* mapping of widget types from UAPI IDs to kernel IDs */
165 static const struct soc_tplg_map dapm_map[] = {
166 	{SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
167 	{SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
168 	{SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
169 	{SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
170 	{SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
171 	{SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
172 	{SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
173 	{SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
174 	{SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
175 	{SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
176 	{SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
177 	{SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
178 	{SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
179 	{SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
180 	{SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
181 	{SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
182 	{SND_SOC_TPLG_DAPM_BUFFER, snd_soc_dapm_buffer},
183 	{SND_SOC_TPLG_DAPM_SCHEDULER, snd_soc_dapm_scheduler},
184 	{SND_SOC_TPLG_DAPM_EFFECT, snd_soc_dapm_effect},
185 	{SND_SOC_TPLG_DAPM_SIGGEN, snd_soc_dapm_siggen},
186 	{SND_SOC_TPLG_DAPM_SRC, snd_soc_dapm_src},
187 	{SND_SOC_TPLG_DAPM_ASRC, snd_soc_dapm_asrc},
188 	{SND_SOC_TPLG_DAPM_ENCODER, snd_soc_dapm_encoder},
189 	{SND_SOC_TPLG_DAPM_DECODER, snd_soc_dapm_decoder},
190 };
191 
192 static int tplc_chan_get_reg(struct soc_tplg *tplg,
193 	struct snd_soc_tplg_channel *chan, int map)
194 {
195 	int i;
196 
197 	for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
198 		if (le32_to_cpu(chan[i].id) == map)
199 			return le32_to_cpu(chan[i].reg);
200 	}
201 
202 	return -EINVAL;
203 }
204 
205 static int tplc_chan_get_shift(struct soc_tplg *tplg,
206 	struct snd_soc_tplg_channel *chan, int map)
207 {
208 	int i;
209 
210 	for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
211 		if (le32_to_cpu(chan[i].id) == map)
212 			return le32_to_cpu(chan[i].shift);
213 	}
214 
215 	return -EINVAL;
216 }
217 
218 static int get_widget_id(int tplg_type)
219 {
220 	int i;
221 
222 	for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
223 		if (tplg_type == dapm_map[i].uid)
224 			return dapm_map[i].kid;
225 	}
226 
227 	return -EINVAL;
228 }
229 
230 static inline void soc_bind_err(struct soc_tplg *tplg,
231 	struct snd_soc_tplg_ctl_hdr *hdr, int index)
232 {
233 	dev_err(tplg->dev,
234 		"ASoC: invalid control type (g,p,i) %d:%d:%d index %d at 0x%lx\n",
235 		hdr->ops.get, hdr->ops.put, hdr->ops.info, index,
236 		soc_tplg_get_offset(tplg));
237 }
238 
239 static inline void soc_control_err(struct soc_tplg *tplg,
240 	struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
241 {
242 	dev_err(tplg->dev,
243 		"ASoC: no complete mixer IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
244 		name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
245 		soc_tplg_get_offset(tplg));
246 }
247 
248 /* pass vendor data to component driver for processing */
249 static int soc_tplg_vendor_load_(struct soc_tplg *tplg,
250 	struct snd_soc_tplg_hdr *hdr)
251 {
252 	int ret = 0;
253 
254 	if (tplg->comp && tplg->ops && tplg->ops->vendor_load)
255 		ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
256 	else {
257 		dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
258 			hdr->vendor_type);
259 		return -EINVAL;
260 	}
261 
262 	if (ret < 0)
263 		dev_err(tplg->dev,
264 			"ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
265 			soc_tplg_get_hdr_offset(tplg),
266 			soc_tplg_get_hdr_offset(tplg),
267 			hdr->type, hdr->vendor_type);
268 	return ret;
269 }
270 
271 /* pass vendor data to component driver for processing */
272 static int soc_tplg_vendor_load(struct soc_tplg *tplg,
273 	struct snd_soc_tplg_hdr *hdr)
274 {
275 	if (tplg->pass != SOC_TPLG_PASS_VENDOR)
276 		return 0;
277 
278 	return soc_tplg_vendor_load_(tplg, hdr);
279 }
280 
281 /* optionally pass new dynamic widget to component driver. This is mainly for
282  * external widgets where we can assign private data/ops */
283 static int soc_tplg_widget_load(struct soc_tplg *tplg,
284 	struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
285 {
286 	if (tplg->comp && tplg->ops && tplg->ops->widget_load)
287 		return tplg->ops->widget_load(tplg->comp, tplg->index, w,
288 			tplg_w);
289 
290 	return 0;
291 }
292 
293 /* optionally pass new dynamic widget to component driver. This is mainly for
294  * external widgets where we can assign private data/ops */
295 static int soc_tplg_widget_ready(struct soc_tplg *tplg,
296 	struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
297 {
298 	if (tplg->comp && tplg->ops && tplg->ops->widget_ready)
299 		return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
300 			tplg_w);
301 
302 	return 0;
303 }
304 
305 /* pass DAI configurations to component driver for extra initialization */
306 static int soc_tplg_dai_load(struct soc_tplg *tplg,
307 	struct snd_soc_dai_driver *dai_drv,
308 	struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
309 {
310 	if (tplg->comp && tplg->ops && tplg->ops->dai_load)
311 		return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
312 			pcm, dai);
313 
314 	return 0;
315 }
316 
317 /* pass link configurations to component driver for extra initialization */
318 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
319 	struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
320 {
321 	if (tplg->comp && tplg->ops && tplg->ops->link_load)
322 		return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
323 
324 	return 0;
325 }
326 
327 /* tell the component driver that all firmware has been loaded in this request */
328 static void soc_tplg_complete(struct soc_tplg *tplg)
329 {
330 	if (tplg->comp && tplg->ops && tplg->ops->complete)
331 		tplg->ops->complete(tplg->comp);
332 }
333 
334 /* add a dynamic kcontrol */
335 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
336 	const struct snd_kcontrol_new *control_new, const char *prefix,
337 	void *data, struct snd_kcontrol **kcontrol)
338 {
339 	int err;
340 
341 	*kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
342 	if (*kcontrol == NULL) {
343 		dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
344 		control_new->name);
345 		return -ENOMEM;
346 	}
347 
348 	err = snd_ctl_add(card, *kcontrol);
349 	if (err < 0) {
350 		dev_err(dev, "ASoC: Failed to add %s: %d\n",
351 			control_new->name, err);
352 		return err;
353 	}
354 
355 	return 0;
356 }
357 
358 /* add a dynamic kcontrol for component driver */
359 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
360 	struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
361 {
362 	struct snd_soc_component *comp = tplg->comp;
363 
364 	return soc_tplg_add_dcontrol(comp->card->snd_card,
365 				comp->dev, k, NULL, comp, kcontrol);
366 }
367 
368 /* remove a mixer kcontrol */
369 static void remove_mixer(struct snd_soc_component *comp,
370 	struct snd_soc_dobj *dobj, int pass)
371 {
372 	struct snd_card *card = comp->card->snd_card;
373 	struct soc_mixer_control *sm =
374 		container_of(dobj, struct soc_mixer_control, dobj);
375 	const unsigned int *p = NULL;
376 
377 	if (pass != SOC_TPLG_PASS_MIXER)
378 		return;
379 
380 	if (dobj->ops && dobj->ops->control_unload)
381 		dobj->ops->control_unload(comp, dobj);
382 
383 	if (dobj->control.kcontrol->tlv.p)
384 		p = dobj->control.kcontrol->tlv.p;
385 	snd_ctl_remove(card, dobj->control.kcontrol);
386 	list_del(&dobj->list);
387 	kfree(sm);
388 	kfree(p);
389 }
390 
391 /* remove an enum kcontrol */
392 static void remove_enum(struct snd_soc_component *comp,
393 	struct snd_soc_dobj *dobj, int pass)
394 {
395 	struct snd_card *card = comp->card->snd_card;
396 	struct soc_enum *se = container_of(dobj, struct soc_enum, dobj);
397 
398 	if (pass != SOC_TPLG_PASS_MIXER)
399 		return;
400 
401 	if (dobj->ops && dobj->ops->control_unload)
402 		dobj->ops->control_unload(comp, dobj);
403 
404 	snd_ctl_remove(card, dobj->control.kcontrol);
405 	list_del(&dobj->list);
406 
407 	soc_tplg_denum_remove_values(se);
408 	soc_tplg_denum_remove_texts(se);
409 	kfree(se);
410 }
411 
412 /* remove a byte kcontrol */
413 static void remove_bytes(struct snd_soc_component *comp,
414 	struct snd_soc_dobj *dobj, int pass)
415 {
416 	struct snd_card *card = comp->card->snd_card;
417 	struct soc_bytes_ext *sb =
418 		container_of(dobj, struct soc_bytes_ext, dobj);
419 
420 	if (pass != SOC_TPLG_PASS_MIXER)
421 		return;
422 
423 	if (dobj->ops && dobj->ops->control_unload)
424 		dobj->ops->control_unload(comp, dobj);
425 
426 	snd_ctl_remove(card, dobj->control.kcontrol);
427 	list_del(&dobj->list);
428 	kfree(sb);
429 }
430 
431 /* remove a route */
432 static void remove_route(struct snd_soc_component *comp,
433 			 struct snd_soc_dobj *dobj, int pass)
434 {
435 	struct snd_soc_dapm_route *route =
436 		container_of(dobj, struct snd_soc_dapm_route, dobj);
437 
438 	if (pass != SOC_TPLG_PASS_GRAPH)
439 		return;
440 
441 	if (dobj->ops && dobj->ops->dapm_route_unload)
442 		dobj->ops->dapm_route_unload(comp, dobj);
443 
444 	list_del(&dobj->list);
445 	kfree(route);
446 }
447 
448 /* remove a widget and it's kcontrols - routes must be removed first */
449 static void remove_widget(struct snd_soc_component *comp,
450 	struct snd_soc_dobj *dobj, int pass)
451 {
452 	struct snd_card *card = comp->card->snd_card;
453 	struct snd_soc_dapm_widget *w =
454 		container_of(dobj, struct snd_soc_dapm_widget, dobj);
455 	int i;
456 
457 	if (pass != SOC_TPLG_PASS_WIDGET)
458 		return;
459 
460 	if (dobj->ops && dobj->ops->widget_unload)
461 		dobj->ops->widget_unload(comp, dobj);
462 
463 	if (!w->kcontrols)
464 		goto free_news;
465 
466 	/*
467 	 * Dynamic Widgets either have 1..N enum kcontrols or mixers.
468 	 * The enum may either have an array of values or strings.
469 	 */
470 	if (dobj->widget.kcontrol_type == SND_SOC_TPLG_TYPE_ENUM) {
471 		/* enumerated widget mixer */
472 		for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
473 			struct snd_kcontrol *kcontrol = w->kcontrols[i];
474 			struct soc_enum *se =
475 				(struct soc_enum *)kcontrol->private_value;
476 
477 			snd_ctl_remove(card, kcontrol);
478 
479 			/* free enum kcontrol's dvalues and dtexts */
480 			soc_tplg_denum_remove_values(se);
481 			soc_tplg_denum_remove_texts(se);
482 
483 			kfree(se);
484 			kfree(w->kcontrol_news[i].name);
485 		}
486 	} else {
487 		/* volume mixer or bytes controls */
488 		for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
489 			struct snd_kcontrol *kcontrol = w->kcontrols[i];
490 
491 			if (dobj->widget.kcontrol_type
492 			    == SND_SOC_TPLG_TYPE_MIXER)
493 				kfree(kcontrol->tlv.p);
494 
495 			/* Private value is used as struct soc_mixer_control
496 			 * for volume mixers or soc_bytes_ext for bytes
497 			 * controls.
498 			 */
499 			kfree((void *)kcontrol->private_value);
500 			snd_ctl_remove(card, kcontrol);
501 			kfree(w->kcontrol_news[i].name);
502 		}
503 	}
504 
505 free_news:
506 	kfree(w->kcontrol_news);
507 
508 	list_del(&dobj->list);
509 
510 	/* widget w is freed by soc-dapm.c */
511 }
512 
513 /* remove DAI configurations */
514 static void remove_dai(struct snd_soc_component *comp,
515 	struct snd_soc_dobj *dobj, int pass)
516 {
517 	struct snd_soc_dai_driver *dai_drv =
518 		container_of(dobj, struct snd_soc_dai_driver, dobj);
519 	struct snd_soc_dai *dai;
520 
521 	if (pass != SOC_TPLG_PASS_PCM_DAI)
522 		return;
523 
524 	if (dobj->ops && dobj->ops->dai_unload)
525 		dobj->ops->dai_unload(comp, dobj);
526 
527 	for_each_component_dais(comp, dai)
528 		if (dai->driver == dai_drv)
529 			dai->driver = NULL;
530 
531 	kfree(dai_drv->playback.stream_name);
532 	kfree(dai_drv->capture.stream_name);
533 	kfree(dai_drv->name);
534 	list_del(&dobj->list);
535 	kfree(dai_drv);
536 }
537 
538 /* remove link configurations */
539 static void remove_link(struct snd_soc_component *comp,
540 	struct snd_soc_dobj *dobj, int pass)
541 {
542 	struct snd_soc_dai_link *link =
543 		container_of(dobj, struct snd_soc_dai_link, dobj);
544 
545 	if (pass != SOC_TPLG_PASS_PCM_DAI)
546 		return;
547 
548 	if (dobj->ops && dobj->ops->link_unload)
549 		dobj->ops->link_unload(comp, dobj);
550 
551 	list_del(&dobj->list);
552 	snd_soc_remove_pcm_runtime(comp->card,
553 			snd_soc_get_pcm_runtime(comp->card, link));
554 
555 	kfree(link->name);
556 	kfree(link->stream_name);
557 	kfree(link->cpus->dai_name);
558 	kfree(link);
559 }
560 
561 /* unload dai link */
562 static void remove_backend_link(struct snd_soc_component *comp,
563 	struct snd_soc_dobj *dobj, int pass)
564 {
565 	if (pass != SOC_TPLG_PASS_LINK)
566 		return;
567 
568 	if (dobj->ops && dobj->ops->link_unload)
569 		dobj->ops->link_unload(comp, dobj);
570 
571 	/*
572 	 * We don't free the link here as what remove_link() do since BE
573 	 * links are not allocated by topology.
574 	 * We however need to reset the dobj type to its initial values
575 	 */
576 	dobj->type = SND_SOC_DOBJ_NONE;
577 	list_del(&dobj->list);
578 }
579 
580 /* bind a kcontrol to it's IO handlers */
581 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
582 	struct snd_kcontrol_new *k,
583 	const struct soc_tplg *tplg)
584 {
585 	const struct snd_soc_tplg_kcontrol_ops *ops;
586 	const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
587 	int num_ops, i;
588 
589 	if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
590 		&& k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
591 		&& k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
592 		&& k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
593 		struct soc_bytes_ext *sbe;
594 		struct snd_soc_tplg_bytes_control *be;
595 
596 		sbe = (struct soc_bytes_ext *)k->private_value;
597 		be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
598 
599 		/* TLV bytes controls need standard kcontrol info handler,
600 		 * TLV callback and extended put/get handlers.
601 		 */
602 		k->info = snd_soc_bytes_info_ext;
603 		k->tlv.c = snd_soc_bytes_tlv_callback;
604 
605 		ext_ops = tplg->bytes_ext_ops;
606 		num_ops = tplg->bytes_ext_ops_count;
607 		for (i = 0; i < num_ops; i++) {
608 			if (!sbe->put &&
609 			    ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
610 				sbe->put = ext_ops[i].put;
611 			if (!sbe->get &&
612 			    ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
613 				sbe->get = ext_ops[i].get;
614 		}
615 
616 		if (sbe->put && sbe->get)
617 			return 0;
618 		else
619 			return -EINVAL;
620 	}
621 
622 	/* try and map vendor specific kcontrol handlers first */
623 	ops = tplg->io_ops;
624 	num_ops = tplg->io_ops_count;
625 	for (i = 0; i < num_ops; i++) {
626 
627 		if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
628 			k->put = ops[i].put;
629 		if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
630 			k->get = ops[i].get;
631 		if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
632 			k->info = ops[i].info;
633 	}
634 
635 	/* vendor specific handlers found ? */
636 	if (k->put && k->get && k->info)
637 		return 0;
638 
639 	/* none found so try standard kcontrol handlers */
640 	ops = io_ops;
641 	num_ops = ARRAY_SIZE(io_ops);
642 	for (i = 0; i < num_ops; i++) {
643 
644 		if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
645 			k->put = ops[i].put;
646 		if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
647 			k->get = ops[i].get;
648 		if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
649 			k->info = ops[i].info;
650 	}
651 
652 	/* standard handlers found ? */
653 	if (k->put && k->get && k->info)
654 		return 0;
655 
656 	/* nothing to bind */
657 	return -EINVAL;
658 }
659 
660 /* bind a widgets to it's evnt handlers */
661 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
662 		const struct snd_soc_tplg_widget_events *events,
663 		int num_events, u16 event_type)
664 {
665 	int i;
666 
667 	w->event = NULL;
668 
669 	for (i = 0; i < num_events; i++) {
670 		if (event_type == events[i].type) {
671 
672 			/* found - so assign event */
673 			w->event = events[i].event_handler;
674 			return 0;
675 		}
676 	}
677 
678 	/* not found */
679 	return -EINVAL;
680 }
681 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
682 
683 /* optionally pass new dynamic kcontrol to component driver. */
684 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
685 	struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
686 {
687 	if (tplg->comp && tplg->ops && tplg->ops->control_load)
688 		return tplg->ops->control_load(tplg->comp, tplg->index, k,
689 			hdr);
690 
691 	return 0;
692 }
693 
694 
695 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
696 	struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
697 {
698 	unsigned int item_len = 2 * sizeof(unsigned int);
699 	unsigned int *p;
700 
701 	p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
702 	if (!p)
703 		return -ENOMEM;
704 
705 	p[0] = SNDRV_CTL_TLVT_DB_SCALE;
706 	p[1] = item_len;
707 	p[2] = le32_to_cpu(scale->min);
708 	p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
709 		| (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
710 
711 	kc->tlv.p = (void *)p;
712 	return 0;
713 }
714 
715 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
716 	struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
717 {
718 	struct snd_soc_tplg_ctl_tlv *tplg_tlv;
719 	u32 access = le32_to_cpu(tc->access);
720 
721 	if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
722 		return 0;
723 
724 	if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
725 		tplg_tlv = &tc->tlv;
726 		switch (le32_to_cpu(tplg_tlv->type)) {
727 		case SNDRV_CTL_TLVT_DB_SCALE:
728 			return soc_tplg_create_tlv_db_scale(tplg, kc,
729 					&tplg_tlv->scale);
730 
731 		/* TODO: add support for other TLV types */
732 		default:
733 			dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
734 					tplg_tlv->type);
735 			return -EINVAL;
736 		}
737 	}
738 
739 	return 0;
740 }
741 
742 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
743 	struct snd_kcontrol_new *kc)
744 {
745 	kfree(kc->tlv.p);
746 }
747 
748 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
749 	size_t size)
750 {
751 	struct snd_soc_tplg_bytes_control *be;
752 	struct soc_bytes_ext *sbe;
753 	struct snd_kcontrol_new kc;
754 	int i, err;
755 
756 	if (soc_tplg_check_elem_count(tplg,
757 		sizeof(struct snd_soc_tplg_bytes_control), count,
758 			size, "mixer bytes")) {
759 		dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
760 			count);
761 		return -EINVAL;
762 	}
763 
764 	for (i = 0; i < count; i++) {
765 		be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
766 
767 		/* validate kcontrol */
768 		if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
769 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
770 			return -EINVAL;
771 
772 		sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
773 		if (sbe == NULL)
774 			return -ENOMEM;
775 
776 		tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
777 			      le32_to_cpu(be->priv.size));
778 
779 		dev_dbg(tplg->dev,
780 			"ASoC: adding bytes kcontrol %s with access 0x%x\n",
781 			be->hdr.name, be->hdr.access);
782 
783 		memset(&kc, 0, sizeof(kc));
784 		kc.name = be->hdr.name;
785 		kc.private_value = (long)sbe;
786 		kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
787 		kc.access = le32_to_cpu(be->hdr.access);
788 
789 		sbe->max = le32_to_cpu(be->max);
790 		sbe->dobj.type = SND_SOC_DOBJ_BYTES;
791 		sbe->dobj.ops = tplg->ops;
792 		INIT_LIST_HEAD(&sbe->dobj.list);
793 
794 		/* map io handlers */
795 		err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
796 		if (err) {
797 			soc_control_err(tplg, &be->hdr, be->hdr.name);
798 			kfree(sbe);
799 			continue;
800 		}
801 
802 		/* pass control to driver for optional further init */
803 		err = soc_tplg_init_kcontrol(tplg, &kc,
804 			(struct snd_soc_tplg_ctl_hdr *)be);
805 		if (err < 0) {
806 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
807 				be->hdr.name);
808 			kfree(sbe);
809 			continue;
810 		}
811 
812 		/* register control here */
813 		err = soc_tplg_add_kcontrol(tplg, &kc,
814 			&sbe->dobj.control.kcontrol);
815 		if (err < 0) {
816 			dev_err(tplg->dev, "ASoC: failed to add %s\n",
817 				be->hdr.name);
818 			kfree(sbe);
819 			continue;
820 		}
821 
822 		list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
823 	}
824 	return 0;
825 
826 }
827 
828 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
829 	size_t size)
830 {
831 	struct snd_soc_tplg_mixer_control *mc;
832 	struct soc_mixer_control *sm;
833 	struct snd_kcontrol_new kc;
834 	int i, err;
835 
836 	if (soc_tplg_check_elem_count(tplg,
837 		sizeof(struct snd_soc_tplg_mixer_control),
838 		count, size, "mixers")) {
839 
840 		dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
841 			count);
842 		return -EINVAL;
843 	}
844 
845 	for (i = 0; i < count; i++) {
846 		mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
847 
848 		/* validate kcontrol */
849 		if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
850 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
851 			return -EINVAL;
852 
853 		sm = kzalloc(sizeof(*sm), GFP_KERNEL);
854 		if (sm == NULL)
855 			return -ENOMEM;
856 		tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
857 			      le32_to_cpu(mc->priv.size));
858 
859 		dev_dbg(tplg->dev,
860 			"ASoC: adding mixer kcontrol %s with access 0x%x\n",
861 			mc->hdr.name, mc->hdr.access);
862 
863 		memset(&kc, 0, sizeof(kc));
864 		kc.name = mc->hdr.name;
865 		kc.private_value = (long)sm;
866 		kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
867 		kc.access = le32_to_cpu(mc->hdr.access);
868 
869 		/* we only support FL/FR channel mapping atm */
870 		sm->reg = tplc_chan_get_reg(tplg, mc->channel,
871 			SNDRV_CHMAP_FL);
872 		sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
873 			SNDRV_CHMAP_FR);
874 		sm->shift = tplc_chan_get_shift(tplg, mc->channel,
875 			SNDRV_CHMAP_FL);
876 		sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
877 			SNDRV_CHMAP_FR);
878 
879 		sm->max = le32_to_cpu(mc->max);
880 		sm->min = le32_to_cpu(mc->min);
881 		sm->invert = le32_to_cpu(mc->invert);
882 		sm->platform_max = le32_to_cpu(mc->platform_max);
883 		sm->dobj.index = tplg->index;
884 		sm->dobj.ops = tplg->ops;
885 		sm->dobj.type = SND_SOC_DOBJ_MIXER;
886 		INIT_LIST_HEAD(&sm->dobj.list);
887 
888 		/* map io handlers */
889 		err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
890 		if (err) {
891 			soc_control_err(tplg, &mc->hdr, mc->hdr.name);
892 			kfree(sm);
893 			continue;
894 		}
895 
896 		/* create any TLV data */
897 		soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
898 
899 		/* pass control to driver for optional further init */
900 		err = soc_tplg_init_kcontrol(tplg, &kc,
901 			(struct snd_soc_tplg_ctl_hdr *) mc);
902 		if (err < 0) {
903 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
904 				mc->hdr.name);
905 			soc_tplg_free_tlv(tplg, &kc);
906 			kfree(sm);
907 			continue;
908 		}
909 
910 		/* register control here */
911 		err = soc_tplg_add_kcontrol(tplg, &kc,
912 			&sm->dobj.control.kcontrol);
913 		if (err < 0) {
914 			dev_err(tplg->dev, "ASoC: failed to add %s\n",
915 				mc->hdr.name);
916 			soc_tplg_free_tlv(tplg, &kc);
917 			kfree(sm);
918 			continue;
919 		}
920 
921 		list_add(&sm->dobj.list, &tplg->comp->dobj_list);
922 	}
923 
924 	return 0;
925 }
926 
927 static int soc_tplg_denum_create_texts(struct soc_enum *se,
928 	struct snd_soc_tplg_enum_control *ec)
929 {
930 	int i, ret;
931 
932 	se->dobj.control.dtexts =
933 		kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
934 	if (se->dobj.control.dtexts == NULL)
935 		return -ENOMEM;
936 
937 	for (i = 0; i < le32_to_cpu(ec->items); i++) {
938 
939 		if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
940 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
941 			ret = -EINVAL;
942 			goto err;
943 		}
944 
945 		se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
946 		if (!se->dobj.control.dtexts[i]) {
947 			ret = -ENOMEM;
948 			goto err;
949 		}
950 	}
951 
952 	se->items = le32_to_cpu(ec->items);
953 	se->texts = (const char * const *)se->dobj.control.dtexts;
954 	return 0;
955 
956 err:
957 	se->items = i;
958 	soc_tplg_denum_remove_texts(se);
959 	return ret;
960 }
961 
962 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
963 {
964 	int i = se->items;
965 
966 	for (--i; i >= 0; i--)
967 		kfree(se->dobj.control.dtexts[i]);
968 	kfree(se->dobj.control.dtexts);
969 }
970 
971 static int soc_tplg_denum_create_values(struct soc_enum *se,
972 	struct snd_soc_tplg_enum_control *ec)
973 {
974 	int i;
975 
976 	if (le32_to_cpu(ec->items) > sizeof(*ec->values))
977 		return -EINVAL;
978 
979 	se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
980 					   sizeof(u32),
981 					   GFP_KERNEL);
982 	if (!se->dobj.control.dvalues)
983 		return -ENOMEM;
984 
985 	/* convert from little-endian */
986 	for (i = 0; i < le32_to_cpu(ec->items); i++) {
987 		se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
988 	}
989 
990 	return 0;
991 }
992 
993 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
994 {
995 	kfree(se->dobj.control.dvalues);
996 }
997 
998 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
999 	size_t size)
1000 {
1001 	struct snd_soc_tplg_enum_control *ec;
1002 	struct soc_enum *se;
1003 	struct snd_kcontrol_new kc;
1004 	int i, ret, err;
1005 
1006 	if (soc_tplg_check_elem_count(tplg,
1007 		sizeof(struct snd_soc_tplg_enum_control),
1008 		count, size, "enums")) {
1009 
1010 		dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1011 			count);
1012 		return -EINVAL;
1013 	}
1014 
1015 	for (i = 0; i < count; i++) {
1016 		ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1017 
1018 		/* validate kcontrol */
1019 		if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1020 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1021 			return -EINVAL;
1022 
1023 		se = kzalloc((sizeof(*se)), GFP_KERNEL);
1024 		if (se == NULL)
1025 			return -ENOMEM;
1026 
1027 		tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1028 			      le32_to_cpu(ec->priv.size));
1029 
1030 		dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1031 			ec->hdr.name, ec->items);
1032 
1033 		memset(&kc, 0, sizeof(kc));
1034 		kc.name = ec->hdr.name;
1035 		kc.private_value = (long)se;
1036 		kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1037 		kc.access = le32_to_cpu(ec->hdr.access);
1038 
1039 		se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1040 		se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1041 			SNDRV_CHMAP_FL);
1042 		se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1043 			SNDRV_CHMAP_FL);
1044 
1045 		se->mask = le32_to_cpu(ec->mask);
1046 		se->dobj.index = tplg->index;
1047 		se->dobj.type = SND_SOC_DOBJ_ENUM;
1048 		se->dobj.ops = tplg->ops;
1049 		INIT_LIST_HEAD(&se->dobj.list);
1050 
1051 		switch (le32_to_cpu(ec->hdr.ops.info)) {
1052 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1053 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1054 			err = soc_tplg_denum_create_values(se, ec);
1055 			if (err < 0) {
1056 				dev_err(tplg->dev,
1057 					"ASoC: could not create values for %s\n",
1058 					ec->hdr.name);
1059 				kfree(se);
1060 				continue;
1061 			}
1062 			/* fall through */
1063 		case SND_SOC_TPLG_CTL_ENUM:
1064 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1065 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1066 			err = soc_tplg_denum_create_texts(se, ec);
1067 			if (err < 0) {
1068 				dev_err(tplg->dev,
1069 					"ASoC: could not create texts for %s\n",
1070 					ec->hdr.name);
1071 				kfree(se);
1072 				continue;
1073 			}
1074 			break;
1075 		default:
1076 			dev_err(tplg->dev,
1077 				"ASoC: invalid enum control type %d for %s\n",
1078 				ec->hdr.ops.info, ec->hdr.name);
1079 			kfree(se);
1080 			continue;
1081 		}
1082 
1083 		/* map io handlers */
1084 		err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1085 		if (err) {
1086 			soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1087 			kfree(se);
1088 			continue;
1089 		}
1090 
1091 		/* pass control to driver for optional further init */
1092 		err = soc_tplg_init_kcontrol(tplg, &kc,
1093 			(struct snd_soc_tplg_ctl_hdr *) ec);
1094 		if (err < 0) {
1095 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1096 				ec->hdr.name);
1097 			kfree(se);
1098 			continue;
1099 		}
1100 
1101 		/* register control here */
1102 		ret = soc_tplg_add_kcontrol(tplg,
1103 			&kc, &se->dobj.control.kcontrol);
1104 		if (ret < 0) {
1105 			dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1106 				ec->hdr.name);
1107 			kfree(se);
1108 			continue;
1109 		}
1110 
1111 		list_add(&se->dobj.list, &tplg->comp->dobj_list);
1112 	}
1113 
1114 	return 0;
1115 }
1116 
1117 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1118 	struct snd_soc_tplg_hdr *hdr)
1119 {
1120 	struct snd_soc_tplg_ctl_hdr *control_hdr;
1121 	int i;
1122 
1123 	if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1124 		tplg->pos += le32_to_cpu(hdr->size) +
1125 			le32_to_cpu(hdr->payload_size);
1126 		return 0;
1127 	}
1128 
1129 	dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1130 		soc_tplg_get_offset(tplg));
1131 
1132 	for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1133 
1134 		control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1135 
1136 		if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1137 			dev_err(tplg->dev, "ASoC: invalid control size\n");
1138 			return -EINVAL;
1139 		}
1140 
1141 		switch (le32_to_cpu(control_hdr->ops.info)) {
1142 		case SND_SOC_TPLG_CTL_VOLSW:
1143 		case SND_SOC_TPLG_CTL_STROBE:
1144 		case SND_SOC_TPLG_CTL_VOLSW_SX:
1145 		case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1146 		case SND_SOC_TPLG_CTL_RANGE:
1147 		case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1148 		case SND_SOC_TPLG_DAPM_CTL_PIN:
1149 			soc_tplg_dmixer_create(tplg, 1,
1150 					       le32_to_cpu(hdr->payload_size));
1151 			break;
1152 		case SND_SOC_TPLG_CTL_ENUM:
1153 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1154 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1155 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1156 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1157 			soc_tplg_denum_create(tplg, 1,
1158 					      le32_to_cpu(hdr->payload_size));
1159 			break;
1160 		case SND_SOC_TPLG_CTL_BYTES:
1161 			soc_tplg_dbytes_create(tplg, 1,
1162 					       le32_to_cpu(hdr->payload_size));
1163 			break;
1164 		default:
1165 			soc_bind_err(tplg, control_hdr, i);
1166 			return -EINVAL;
1167 		}
1168 	}
1169 
1170 	return 0;
1171 }
1172 
1173 /* optionally pass new dynamic kcontrol to component driver. */
1174 static int soc_tplg_add_route(struct soc_tplg *tplg,
1175 	struct snd_soc_dapm_route *route)
1176 {
1177 	if (tplg->comp && tplg->ops && tplg->ops->dapm_route_load)
1178 		return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1179 			route);
1180 
1181 	return 0;
1182 }
1183 
1184 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1185 	struct snd_soc_tplg_hdr *hdr)
1186 {
1187 	struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1188 	struct snd_soc_tplg_dapm_graph_elem *elem;
1189 	struct snd_soc_dapm_route **routes;
1190 	int count, i, j;
1191 	int ret = 0;
1192 
1193 	count = le32_to_cpu(hdr->count);
1194 
1195 	if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1196 		tplg->pos +=
1197 			le32_to_cpu(hdr->size) +
1198 			le32_to_cpu(hdr->payload_size);
1199 
1200 		return 0;
1201 	}
1202 
1203 	if (soc_tplg_check_elem_count(tplg,
1204 		sizeof(struct snd_soc_tplg_dapm_graph_elem),
1205 		count, le32_to_cpu(hdr->payload_size), "graph")) {
1206 
1207 		dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1208 			count);
1209 		return -EINVAL;
1210 	}
1211 
1212 	dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1213 		hdr->index);
1214 
1215 	/* allocate memory for pointer to array of dapm routes */
1216 	routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1217 			 GFP_KERNEL);
1218 	if (!routes)
1219 		return -ENOMEM;
1220 
1221 	/*
1222 	 * allocate memory for each dapm route in the array.
1223 	 * This needs to be done individually so that
1224 	 * each route can be freed when it is removed in remove_route().
1225 	 */
1226 	for (i = 0; i < count; i++) {
1227 		routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1228 		if (!routes[i]) {
1229 			/* free previously allocated memory */
1230 			for (j = 0; j < i; j++)
1231 				kfree(routes[j]);
1232 
1233 			kfree(routes);
1234 			return -ENOMEM;
1235 		}
1236 	}
1237 
1238 	for (i = 0; i < count; i++) {
1239 		elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1240 		tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1241 
1242 		/* validate routes */
1243 		if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1244 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1245 			ret = -EINVAL;
1246 			break;
1247 		}
1248 		if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1249 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1250 			ret = -EINVAL;
1251 			break;
1252 		}
1253 		if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1254 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1255 			ret = -EINVAL;
1256 			break;
1257 		}
1258 
1259 		routes[i]->source = elem->source;
1260 		routes[i]->sink = elem->sink;
1261 
1262 		/* set to NULL atm for tplg users */
1263 		routes[i]->connected = NULL;
1264 		if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1265 			routes[i]->control = NULL;
1266 		else
1267 			routes[i]->control = elem->control;
1268 
1269 		/* add route dobj to dobj_list */
1270 		routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1271 		routes[i]->dobj.ops = tplg->ops;
1272 		routes[i]->dobj.index = tplg->index;
1273 		list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1274 
1275 		soc_tplg_add_route(tplg, routes[i]);
1276 
1277 		/* add route, but keep going if some fail */
1278 		snd_soc_dapm_add_routes(dapm, routes[i], 1);
1279 	}
1280 
1281 	/* free memory allocated for all dapm routes in case of error */
1282 	if (ret < 0)
1283 		for (i = 0; i < count ; i++)
1284 			kfree(routes[i]);
1285 
1286 	/*
1287 	 * free pointer to array of dapm routes as this is no longer needed.
1288 	 * The memory allocated for each dapm route will be freed
1289 	 * when it is removed in remove_route().
1290 	 */
1291 	kfree(routes);
1292 
1293 	return ret;
1294 }
1295 
1296 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1297 	struct soc_tplg *tplg, int num_kcontrols)
1298 {
1299 	struct snd_kcontrol_new *kc;
1300 	struct soc_mixer_control *sm;
1301 	struct snd_soc_tplg_mixer_control *mc;
1302 	int i, err;
1303 
1304 	kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1305 	if (kc == NULL)
1306 		return NULL;
1307 
1308 	for (i = 0; i < num_kcontrols; i++) {
1309 		mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1310 
1311 		/* validate kcontrol */
1312 		if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1313 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1314 			goto err_sm;
1315 
1316 		sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1317 		if (sm == NULL)
1318 			goto err_sm;
1319 
1320 		tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1321 			      le32_to_cpu(mc->priv.size));
1322 
1323 		dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1324 			mc->hdr.name, i);
1325 
1326 		kc[i].private_value = (long)sm;
1327 		kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1328 		if (kc[i].name == NULL)
1329 			goto err_sm;
1330 		kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1331 		kc[i].access = le32_to_cpu(mc->hdr.access);
1332 
1333 		/* we only support FL/FR channel mapping atm */
1334 		sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1335 			SNDRV_CHMAP_FL);
1336 		sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1337 			SNDRV_CHMAP_FR);
1338 		sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1339 			SNDRV_CHMAP_FL);
1340 		sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1341 			SNDRV_CHMAP_FR);
1342 
1343 		sm->max = le32_to_cpu(mc->max);
1344 		sm->min = le32_to_cpu(mc->min);
1345 		sm->invert = le32_to_cpu(mc->invert);
1346 		sm->platform_max = le32_to_cpu(mc->platform_max);
1347 		sm->dobj.index = tplg->index;
1348 		INIT_LIST_HEAD(&sm->dobj.list);
1349 
1350 		/* map io handlers */
1351 		err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1352 		if (err) {
1353 			soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1354 			goto err_sm;
1355 		}
1356 
1357 		/* create any TLV data */
1358 		soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1359 
1360 		/* pass control to driver for optional further init */
1361 		err = soc_tplg_init_kcontrol(tplg, &kc[i],
1362 			(struct snd_soc_tplg_ctl_hdr *)mc);
1363 		if (err < 0) {
1364 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1365 				mc->hdr.name);
1366 			soc_tplg_free_tlv(tplg, &kc[i]);
1367 			goto err_sm;
1368 		}
1369 	}
1370 	return kc;
1371 
1372 err_sm:
1373 	for (; i >= 0; i--) {
1374 		sm = (struct soc_mixer_control *)kc[i].private_value;
1375 		kfree(sm);
1376 		kfree(kc[i].name);
1377 	}
1378 	kfree(kc);
1379 
1380 	return NULL;
1381 }
1382 
1383 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1384 	struct soc_tplg *tplg, int num_kcontrols)
1385 {
1386 	struct snd_kcontrol_new *kc;
1387 	struct snd_soc_tplg_enum_control *ec;
1388 	struct soc_enum *se;
1389 	int i, err;
1390 
1391 	kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1392 	if (kc == NULL)
1393 		return NULL;
1394 
1395 	for (i = 0; i < num_kcontrols; i++) {
1396 		ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1397 		/* validate kcontrol */
1398 		if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1399 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1400 			goto err_se;
1401 
1402 		se = kzalloc(sizeof(*se), GFP_KERNEL);
1403 		if (se == NULL)
1404 			goto err_se;
1405 
1406 		tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1407 			      le32_to_cpu(ec->priv.size));
1408 
1409 		dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1410 			ec->hdr.name);
1411 
1412 		kc[i].private_value = (long)se;
1413 		kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1414 		if (kc[i].name == NULL)
1415 			goto err_se;
1416 		kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1417 		kc[i].access = le32_to_cpu(ec->hdr.access);
1418 
1419 		/* we only support FL/FR channel mapping atm */
1420 		se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1421 		se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1422 						  SNDRV_CHMAP_FL);
1423 		se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1424 						  SNDRV_CHMAP_FR);
1425 
1426 		se->items = le32_to_cpu(ec->items);
1427 		se->mask = le32_to_cpu(ec->mask);
1428 		se->dobj.index = tplg->index;
1429 
1430 		switch (le32_to_cpu(ec->hdr.ops.info)) {
1431 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1432 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1433 			err = soc_tplg_denum_create_values(se, ec);
1434 			if (err < 0) {
1435 				dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1436 					ec->hdr.name);
1437 				goto err_se;
1438 			}
1439 			/* fall through */
1440 		case SND_SOC_TPLG_CTL_ENUM:
1441 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1442 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1443 			err = soc_tplg_denum_create_texts(se, ec);
1444 			if (err < 0) {
1445 				dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1446 					ec->hdr.name);
1447 				goto err_se;
1448 			}
1449 			break;
1450 		default:
1451 			dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1452 				ec->hdr.ops.info, ec->hdr.name);
1453 			goto err_se;
1454 		}
1455 
1456 		/* map io handlers */
1457 		err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1458 		if (err) {
1459 			soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1460 			goto err_se;
1461 		}
1462 
1463 		/* pass control to driver for optional further init */
1464 		err = soc_tplg_init_kcontrol(tplg, &kc[i],
1465 			(struct snd_soc_tplg_ctl_hdr *)ec);
1466 		if (err < 0) {
1467 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1468 				ec->hdr.name);
1469 			goto err_se;
1470 		}
1471 	}
1472 
1473 	return kc;
1474 
1475 err_se:
1476 	for (; i >= 0; i--) {
1477 		/* free values and texts */
1478 		se = (struct soc_enum *)kc[i].private_value;
1479 
1480 		if (se) {
1481 			soc_tplg_denum_remove_values(se);
1482 			soc_tplg_denum_remove_texts(se);
1483 		}
1484 
1485 		kfree(se);
1486 		kfree(kc[i].name);
1487 	}
1488 	kfree(kc);
1489 
1490 	return NULL;
1491 }
1492 
1493 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1494 	struct soc_tplg *tplg, int num_kcontrols)
1495 {
1496 	struct snd_soc_tplg_bytes_control *be;
1497 	struct soc_bytes_ext *sbe;
1498 	struct snd_kcontrol_new *kc;
1499 	int i, err;
1500 
1501 	kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1502 	if (!kc)
1503 		return NULL;
1504 
1505 	for (i = 0; i < num_kcontrols; i++) {
1506 		be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1507 
1508 		/* validate kcontrol */
1509 		if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1510 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1511 			goto err_sbe;
1512 
1513 		sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1514 		if (sbe == NULL)
1515 			goto err_sbe;
1516 
1517 		tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1518 			      le32_to_cpu(be->priv.size));
1519 
1520 		dev_dbg(tplg->dev,
1521 			"ASoC: adding bytes kcontrol %s with access 0x%x\n",
1522 			be->hdr.name, be->hdr.access);
1523 
1524 		kc[i].private_value = (long)sbe;
1525 		kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1526 		if (kc[i].name == NULL)
1527 			goto err_sbe;
1528 		kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1529 		kc[i].access = le32_to_cpu(be->hdr.access);
1530 
1531 		sbe->max = le32_to_cpu(be->max);
1532 		INIT_LIST_HEAD(&sbe->dobj.list);
1533 
1534 		/* map standard io handlers and check for external handlers */
1535 		err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1536 		if (err) {
1537 			soc_control_err(tplg, &be->hdr, be->hdr.name);
1538 			goto err_sbe;
1539 		}
1540 
1541 		/* pass control to driver for optional further init */
1542 		err = soc_tplg_init_kcontrol(tplg, &kc[i],
1543 			(struct snd_soc_tplg_ctl_hdr *)be);
1544 		if (err < 0) {
1545 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1546 				be->hdr.name);
1547 			goto err_sbe;
1548 		}
1549 	}
1550 
1551 	return kc;
1552 
1553 err_sbe:
1554 	for (; i >= 0; i--) {
1555 		sbe = (struct soc_bytes_ext *)kc[i].private_value;
1556 		kfree(sbe);
1557 		kfree(kc[i].name);
1558 	}
1559 	kfree(kc);
1560 
1561 	return NULL;
1562 }
1563 
1564 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1565 	struct snd_soc_tplg_dapm_widget *w)
1566 {
1567 	struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1568 	struct snd_soc_dapm_widget template, *widget;
1569 	struct snd_soc_tplg_ctl_hdr *control_hdr;
1570 	struct snd_soc_card *card = tplg->comp->card;
1571 	unsigned int kcontrol_type;
1572 	int ret = 0;
1573 
1574 	if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1575 		SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1576 		return -EINVAL;
1577 	if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1578 		SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1579 		return -EINVAL;
1580 
1581 	dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1582 		w->name, w->id);
1583 
1584 	memset(&template, 0, sizeof(template));
1585 
1586 	/* map user to kernel widget ID */
1587 	template.id = get_widget_id(le32_to_cpu(w->id));
1588 	if ((int)template.id < 0)
1589 		return template.id;
1590 
1591 	/* strings are allocated here, but used and freed by the widget */
1592 	template.name = kstrdup(w->name, GFP_KERNEL);
1593 	if (!template.name)
1594 		return -ENOMEM;
1595 	template.sname = kstrdup(w->sname, GFP_KERNEL);
1596 	if (!template.sname) {
1597 		ret = -ENOMEM;
1598 		goto err;
1599 	}
1600 	template.reg = le32_to_cpu(w->reg);
1601 	template.shift = le32_to_cpu(w->shift);
1602 	template.mask = le32_to_cpu(w->mask);
1603 	template.subseq = le32_to_cpu(w->subseq);
1604 	template.on_val = w->invert ? 0 : 1;
1605 	template.off_val = w->invert ? 1 : 0;
1606 	template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1607 	template.event_flags = le16_to_cpu(w->event_flags);
1608 	template.dobj.index = tplg->index;
1609 
1610 	tplg->pos +=
1611 		(sizeof(struct snd_soc_tplg_dapm_widget) +
1612 		 le32_to_cpu(w->priv.size));
1613 
1614 	if (w->num_kcontrols == 0) {
1615 		kcontrol_type = 0;
1616 		template.num_kcontrols = 0;
1617 		goto widget;
1618 	}
1619 
1620 	control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1621 	dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1622 		w->name, w->num_kcontrols, control_hdr->type);
1623 
1624 	switch (le32_to_cpu(control_hdr->ops.info)) {
1625 	case SND_SOC_TPLG_CTL_VOLSW:
1626 	case SND_SOC_TPLG_CTL_STROBE:
1627 	case SND_SOC_TPLG_CTL_VOLSW_SX:
1628 	case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1629 	case SND_SOC_TPLG_CTL_RANGE:
1630 	case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1631 		kcontrol_type = SND_SOC_TPLG_TYPE_MIXER;  /* volume mixer */
1632 		template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1633 		template.kcontrol_news =
1634 			soc_tplg_dapm_widget_dmixer_create(tplg,
1635 			template.num_kcontrols);
1636 		if (!template.kcontrol_news) {
1637 			ret = -ENOMEM;
1638 			goto hdr_err;
1639 		}
1640 		break;
1641 	case SND_SOC_TPLG_CTL_ENUM:
1642 	case SND_SOC_TPLG_CTL_ENUM_VALUE:
1643 	case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1644 	case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1645 	case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1646 		kcontrol_type = SND_SOC_TPLG_TYPE_ENUM;	/* enumerated mixer */
1647 		template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1648 		template.kcontrol_news =
1649 			soc_tplg_dapm_widget_denum_create(tplg,
1650 			template.num_kcontrols);
1651 		if (!template.kcontrol_news) {
1652 			ret = -ENOMEM;
1653 			goto hdr_err;
1654 		}
1655 		break;
1656 	case SND_SOC_TPLG_CTL_BYTES:
1657 		kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1658 		template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1659 		template.kcontrol_news =
1660 			soc_tplg_dapm_widget_dbytes_create(tplg,
1661 				template.num_kcontrols);
1662 		if (!template.kcontrol_news) {
1663 			ret = -ENOMEM;
1664 			goto hdr_err;
1665 		}
1666 		break;
1667 	default:
1668 		dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1669 			control_hdr->ops.get, control_hdr->ops.put,
1670 			le32_to_cpu(control_hdr->ops.info));
1671 		ret = -EINVAL;
1672 		goto hdr_err;
1673 	}
1674 
1675 widget:
1676 	ret = soc_tplg_widget_load(tplg, &template, w);
1677 	if (ret < 0)
1678 		goto hdr_err;
1679 
1680 	/* card dapm mutex is held by the core if we are loading topology
1681 	 * data during sound card init. */
1682 	if (card->instantiated)
1683 		widget = snd_soc_dapm_new_control(dapm, &template);
1684 	else
1685 		widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1686 	if (IS_ERR(widget)) {
1687 		ret = PTR_ERR(widget);
1688 		goto hdr_err;
1689 	}
1690 
1691 	widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1692 	widget->dobj.widget.kcontrol_type = kcontrol_type;
1693 	widget->dobj.ops = tplg->ops;
1694 	widget->dobj.index = tplg->index;
1695 	list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1696 
1697 	ret = soc_tplg_widget_ready(tplg, widget, w);
1698 	if (ret < 0)
1699 		goto ready_err;
1700 
1701 	kfree(template.sname);
1702 	kfree(template.name);
1703 
1704 	return 0;
1705 
1706 ready_err:
1707 	snd_soc_tplg_widget_remove(widget);
1708 	snd_soc_dapm_free_widget(widget);
1709 hdr_err:
1710 	kfree(template.sname);
1711 err:
1712 	kfree(template.name);
1713 	return ret;
1714 }
1715 
1716 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1717 	struct snd_soc_tplg_hdr *hdr)
1718 {
1719 	struct snd_soc_tplg_dapm_widget *widget;
1720 	int ret, count, i;
1721 
1722 	count = le32_to_cpu(hdr->count);
1723 
1724 	if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1725 		return 0;
1726 
1727 	dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1728 
1729 	for (i = 0; i < count; i++) {
1730 		widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1731 		if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1732 			dev_err(tplg->dev, "ASoC: invalid widget size\n");
1733 			return -EINVAL;
1734 		}
1735 
1736 		ret = soc_tplg_dapm_widget_create(tplg, widget);
1737 		if (ret < 0) {
1738 			dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1739 				widget->name);
1740 			return ret;
1741 		}
1742 	}
1743 
1744 	return 0;
1745 }
1746 
1747 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1748 {
1749 	struct snd_soc_card *card = tplg->comp->card;
1750 	int ret;
1751 
1752 	/* Card might not have been registered at this point.
1753 	 * If so, just return success.
1754 	*/
1755 	if (!card || !card->instantiated) {
1756 		dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1757 			" widget card binding deferred\n");
1758 		return 0;
1759 	}
1760 
1761 	ret = snd_soc_dapm_new_widgets(card);
1762 	if (ret < 0)
1763 		dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1764 			ret);
1765 
1766 	return 0;
1767 }
1768 
1769 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1770 	struct snd_soc_tplg_stream_caps *caps)
1771 {
1772 	stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1773 	stream->channels_min = le32_to_cpu(caps->channels_min);
1774 	stream->channels_max = le32_to_cpu(caps->channels_max);
1775 	stream->rates = le32_to_cpu(caps->rates);
1776 	stream->rate_min = le32_to_cpu(caps->rate_min);
1777 	stream->rate_max = le32_to_cpu(caps->rate_max);
1778 	stream->formats = le64_to_cpu(caps->formats);
1779 	stream->sig_bits = le32_to_cpu(caps->sig_bits);
1780 }
1781 
1782 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1783 			  unsigned int flag_mask, unsigned int flags)
1784 {
1785 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1786 		dai_drv->symmetric_rates =
1787 			flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1788 
1789 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1790 		dai_drv->symmetric_channels =
1791 			flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1792 			1 : 0;
1793 
1794 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1795 		dai_drv->symmetric_samplebits =
1796 			flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1797 			1 : 0;
1798 }
1799 
1800 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1801 	struct snd_soc_tplg_pcm *pcm)
1802 {
1803 	struct snd_soc_dai_driver *dai_drv;
1804 	struct snd_soc_pcm_stream *stream;
1805 	struct snd_soc_tplg_stream_caps *caps;
1806 	struct snd_soc_dai *dai;
1807 	struct snd_soc_dapm_context *dapm =
1808 		snd_soc_component_get_dapm(tplg->comp);
1809 	int ret;
1810 
1811 	dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1812 	if (dai_drv == NULL)
1813 		return -ENOMEM;
1814 
1815 	if (strlen(pcm->dai_name))
1816 		dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1817 	dai_drv->id = le32_to_cpu(pcm->dai_id);
1818 
1819 	if (pcm->playback) {
1820 		stream = &dai_drv->playback;
1821 		caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1822 		set_stream_info(stream, caps);
1823 	}
1824 
1825 	if (pcm->capture) {
1826 		stream = &dai_drv->capture;
1827 		caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1828 		set_stream_info(stream, caps);
1829 	}
1830 
1831 	if (pcm->compress)
1832 		dai_drv->compress_new = snd_soc_new_compress;
1833 
1834 	/* pass control to component driver for optional further init */
1835 	ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1836 	if (ret < 0) {
1837 		dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1838 		kfree(dai_drv->playback.stream_name);
1839 		kfree(dai_drv->capture.stream_name);
1840 		kfree(dai_drv->name);
1841 		kfree(dai_drv);
1842 		return ret;
1843 	}
1844 
1845 	dai_drv->dobj.index = tplg->index;
1846 	dai_drv->dobj.ops = tplg->ops;
1847 	dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1848 	list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1849 
1850 	/* register the DAI to the component */
1851 	dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1852 	if (!dai)
1853 		return -ENOMEM;
1854 
1855 	/* Create the DAI widgets here */
1856 	ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1857 	if (ret != 0) {
1858 		dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1859 		snd_soc_unregister_dai(dai);
1860 		return ret;
1861 	}
1862 
1863 	return ret;
1864 }
1865 
1866 static void set_link_flags(struct snd_soc_dai_link *link,
1867 		unsigned int flag_mask, unsigned int flags)
1868 {
1869 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1870 		link->symmetric_rates =
1871 			flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1872 
1873 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1874 		link->symmetric_channels =
1875 			flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1876 			1 : 0;
1877 
1878 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1879 		link->symmetric_samplebits =
1880 			flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1881 			1 : 0;
1882 
1883 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1884 		link->ignore_suspend =
1885 		flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1886 		1 : 0;
1887 }
1888 
1889 /* create the FE DAI link */
1890 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1891 	struct snd_soc_tplg_pcm *pcm)
1892 {
1893 	struct snd_soc_dai_link *link;
1894 	struct snd_soc_dai_link_component *dlc;
1895 	int ret;
1896 
1897 	/* link + cpu + codec + platform */
1898 	link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1899 	if (link == NULL)
1900 		return -ENOMEM;
1901 
1902 	dlc = (struct snd_soc_dai_link_component *)(link + 1);
1903 
1904 	link->cpus	= &dlc[0];
1905 	link->codecs	= &dlc[1];
1906 	link->platforms	= &dlc[2];
1907 
1908 	link->num_cpus	 = 1;
1909 	link->num_codecs = 1;
1910 	link->num_platforms = 1;
1911 
1912 	link->dobj.index = tplg->index;
1913 	link->dobj.ops = tplg->ops;
1914 	link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1915 
1916 	if (strlen(pcm->pcm_name)) {
1917 		link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1918 		link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1919 	}
1920 	link->id = le32_to_cpu(pcm->pcm_id);
1921 
1922 	if (strlen(pcm->dai_name))
1923 		link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1924 
1925 	link->codecs->name = "snd-soc-dummy";
1926 	link->codecs->dai_name = "snd-soc-dummy-dai";
1927 
1928 	link->platforms->name = "snd-soc-dummy";
1929 
1930 	/* enable DPCM */
1931 	link->dynamic = 1;
1932 	link->dpcm_playback = le32_to_cpu(pcm->playback);
1933 	link->dpcm_capture = le32_to_cpu(pcm->capture);
1934 	if (pcm->flag_mask)
1935 		set_link_flags(link,
1936 			       le32_to_cpu(pcm->flag_mask),
1937 			       le32_to_cpu(pcm->flags));
1938 
1939 	/* pass control to component driver for optional further init */
1940 	ret = soc_tplg_dai_link_load(tplg, link, NULL);
1941 	if (ret < 0) {
1942 		dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1943 		goto err;
1944 	}
1945 
1946 	ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1947 	if (ret < 0) {
1948 		dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1949 		goto err;
1950 	}
1951 
1952 	list_add(&link->dobj.list, &tplg->comp->dobj_list);
1953 
1954 	return 0;
1955 err:
1956 	kfree(link->name);
1957 	kfree(link->stream_name);
1958 	kfree(link->cpus->dai_name);
1959 	kfree(link);
1960 	return ret;
1961 }
1962 
1963 /* create a FE DAI and DAI link from the PCM object */
1964 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1965 	struct snd_soc_tplg_pcm *pcm)
1966 {
1967 	int ret;
1968 
1969 	ret = soc_tplg_dai_create(tplg, pcm);
1970 	if (ret < 0)
1971 		return ret;
1972 
1973 	return  soc_tplg_fe_link_create(tplg, pcm);
1974 }
1975 
1976 /* copy stream caps from the old version 4 of source */
1977 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1978 				struct snd_soc_tplg_stream_caps_v4 *src)
1979 {
1980 	dest->size = cpu_to_le32(sizeof(*dest));
1981 	memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1982 	dest->formats = src->formats;
1983 	dest->rates = src->rates;
1984 	dest->rate_min = src->rate_min;
1985 	dest->rate_max = src->rate_max;
1986 	dest->channels_min = src->channels_min;
1987 	dest->channels_max = src->channels_max;
1988 	dest->periods_min = src->periods_min;
1989 	dest->periods_max = src->periods_max;
1990 	dest->period_size_min = src->period_size_min;
1991 	dest->period_size_max = src->period_size_max;
1992 	dest->buffer_size_min = src->buffer_size_min;
1993 	dest->buffer_size_max = src->buffer_size_max;
1994 }
1995 
1996 /**
1997  * pcm_new_ver - Create the new version of PCM from the old version.
1998  * @tplg: topology context
1999  * @src: older version of pcm as a source
2000  * @pcm: latest version of pcm created from the source
2001  *
2002  * Support from vesion 4. User should free the returned pcm manually.
2003  */
2004 static int pcm_new_ver(struct soc_tplg *tplg,
2005 		       struct snd_soc_tplg_pcm *src,
2006 		       struct snd_soc_tplg_pcm **pcm)
2007 {
2008 	struct snd_soc_tplg_pcm *dest;
2009 	struct snd_soc_tplg_pcm_v4 *src_v4;
2010 	int i;
2011 
2012 	*pcm = NULL;
2013 
2014 	if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2015 		dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2016 		return -EINVAL;
2017 	}
2018 
2019 	dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2020 	src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2021 	dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2022 	if (!dest)
2023 		return -ENOMEM;
2024 
2025 	dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2026 	memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2027 	memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2028 	dest->pcm_id = src_v4->pcm_id;
2029 	dest->dai_id = src_v4->dai_id;
2030 	dest->playback = src_v4->playback;
2031 	dest->capture = src_v4->capture;
2032 	dest->compress = src_v4->compress;
2033 	dest->num_streams = src_v4->num_streams;
2034 	for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2035 		memcpy(&dest->stream[i], &src_v4->stream[i],
2036 		       sizeof(struct snd_soc_tplg_stream));
2037 
2038 	for (i = 0; i < 2; i++)
2039 		stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2040 
2041 	*pcm = dest;
2042 	return 0;
2043 }
2044 
2045 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2046 	struct snd_soc_tplg_hdr *hdr)
2047 {
2048 	struct snd_soc_tplg_pcm *pcm, *_pcm;
2049 	int count;
2050 	int size;
2051 	int i;
2052 	bool abi_match;
2053 	int ret;
2054 
2055 	count = le32_to_cpu(hdr->count);
2056 
2057 	if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
2058 		return 0;
2059 
2060 	/* check the element size and count */
2061 	pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2062 	size = le32_to_cpu(pcm->size);
2063 	if (size > sizeof(struct snd_soc_tplg_pcm)
2064 		|| size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2065 		dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2066 			size);
2067 		return -EINVAL;
2068 	}
2069 
2070 	if (soc_tplg_check_elem_count(tplg,
2071 				      size, count,
2072 				      le32_to_cpu(hdr->payload_size),
2073 				      "PCM DAI")) {
2074 		dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2075 			count);
2076 		return -EINVAL;
2077 	}
2078 
2079 	for (i = 0; i < count; i++) {
2080 		pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2081 		size = le32_to_cpu(pcm->size);
2082 
2083 		/* check ABI version by size, create a new version of pcm
2084 		 * if abi not match.
2085 		 */
2086 		if (size == sizeof(*pcm)) {
2087 			abi_match = true;
2088 			_pcm = pcm;
2089 		} else {
2090 			abi_match = false;
2091 			pcm_new_ver(tplg, pcm, &_pcm);
2092 		}
2093 
2094 		/* create the FE DAIs and DAI links */
2095 		ret = soc_tplg_pcm_create(tplg, _pcm);
2096 		if (ret < 0) {
2097 			if (!abi_match)
2098 				kfree(_pcm);
2099 			return ret;
2100 		}
2101 
2102 		/* offset by version-specific struct size and
2103 		 * real priv data size
2104 		 */
2105 		tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2106 
2107 		if (!abi_match)
2108 			kfree(_pcm); /* free the duplicated one */
2109 	}
2110 
2111 	dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2112 
2113 	return 0;
2114 }
2115 
2116 /**
2117  * set_link_hw_format - Set the HW audio format of the physical DAI link.
2118  * @link: &snd_soc_dai_link which should be updated
2119  * @cfg: physical link configs.
2120  *
2121  * Topology context contains a list of supported HW formats (configs) and
2122  * a default format ID for the physical link. This function will use this
2123  * default ID to choose the HW format to set the link's DAI format for init.
2124  */
2125 static void set_link_hw_format(struct snd_soc_dai_link *link,
2126 			struct snd_soc_tplg_link_config *cfg)
2127 {
2128 	struct snd_soc_tplg_hw_config *hw_config;
2129 	unsigned char bclk_master, fsync_master;
2130 	unsigned char invert_bclk, invert_fsync;
2131 	int i;
2132 
2133 	for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2134 		hw_config = &cfg->hw_config[i];
2135 		if (hw_config->id != cfg->default_hw_config_id)
2136 			continue;
2137 
2138 		link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2139 			SND_SOC_DAIFMT_FORMAT_MASK;
2140 
2141 		/* clock gating */
2142 		switch (hw_config->clock_gated) {
2143 		case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2144 			link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2145 			break;
2146 
2147 		case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2148 			link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2149 			break;
2150 
2151 		default:
2152 			/* ignore the value */
2153 			break;
2154 		}
2155 
2156 		/* clock signal polarity */
2157 		invert_bclk = hw_config->invert_bclk;
2158 		invert_fsync = hw_config->invert_fsync;
2159 		if (!invert_bclk && !invert_fsync)
2160 			link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2161 		else if (!invert_bclk && invert_fsync)
2162 			link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2163 		else if (invert_bclk && !invert_fsync)
2164 			link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2165 		else
2166 			link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2167 
2168 		/* clock masters */
2169 		bclk_master = (hw_config->bclk_master ==
2170 			       SND_SOC_TPLG_BCLK_CM);
2171 		fsync_master = (hw_config->fsync_master ==
2172 				SND_SOC_TPLG_FSYNC_CM);
2173 		if (bclk_master && fsync_master)
2174 			link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2175 		else if (!bclk_master && fsync_master)
2176 			link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2177 		else if (bclk_master && !fsync_master)
2178 			link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2179 		else
2180 			link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2181 	}
2182 }
2183 
2184 /**
2185  * link_new_ver - Create a new physical link config from the old
2186  * version of source.
2187  * @tplg: topology context
2188  * @src: old version of phyical link config as a source
2189  * @link: latest version of physical link config created from the source
2190  *
2191  * Support from vesion 4. User need free the returned link config manually.
2192  */
2193 static int link_new_ver(struct soc_tplg *tplg,
2194 			struct snd_soc_tplg_link_config *src,
2195 			struct snd_soc_tplg_link_config **link)
2196 {
2197 	struct snd_soc_tplg_link_config *dest;
2198 	struct snd_soc_tplg_link_config_v4 *src_v4;
2199 	int i;
2200 
2201 	*link = NULL;
2202 
2203 	if (le32_to_cpu(src->size) !=
2204 	    sizeof(struct snd_soc_tplg_link_config_v4)) {
2205 		dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2206 		return -EINVAL;
2207 	}
2208 
2209 	dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2210 
2211 	src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2212 	dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2213 	if (!dest)
2214 		return -ENOMEM;
2215 
2216 	dest->size = cpu_to_le32(sizeof(*dest));
2217 	dest->id = src_v4->id;
2218 	dest->num_streams = src_v4->num_streams;
2219 	for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2220 		memcpy(&dest->stream[i], &src_v4->stream[i],
2221 		       sizeof(struct snd_soc_tplg_stream));
2222 
2223 	*link = dest;
2224 	return 0;
2225 }
2226 
2227 /**
2228  * snd_soc_find_dai_link - Find a DAI link
2229  *
2230  * @card: soc card
2231  * @id: DAI link ID to match
2232  * @name: DAI link name to match, optional
2233  * @stream_name: DAI link stream name to match, optional
2234  *
2235  * This function will search all existing DAI links of the soc card to
2236  * find the link of the same ID. Since DAI links may not have their
2237  * unique ID, so name and stream name should also match if being
2238  * specified.
2239  *
2240  * Return: pointer of DAI link, or NULL if not found.
2241  */
2242 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2243 						      int id, const char *name,
2244 						      const char *stream_name)
2245 {
2246 	struct snd_soc_pcm_runtime *rtd;
2247 	struct snd_soc_dai_link *link;
2248 
2249 	for_each_card_rtds(card, rtd) {
2250 		link = rtd->dai_link;
2251 
2252 		if (link->id != id)
2253 			continue;
2254 
2255 		if (name && (!link->name || strcmp(name, link->name)))
2256 			continue;
2257 
2258 		if (stream_name && (!link->stream_name
2259 				    || strcmp(stream_name, link->stream_name)))
2260 			continue;
2261 
2262 		return link;
2263 	}
2264 
2265 	return NULL;
2266 }
2267 
2268 /* Find and configure an existing physical DAI link */
2269 static int soc_tplg_link_config(struct soc_tplg *tplg,
2270 	struct snd_soc_tplg_link_config *cfg)
2271 {
2272 	struct snd_soc_dai_link *link;
2273 	const char *name, *stream_name;
2274 	size_t len;
2275 	int ret;
2276 
2277 	len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2278 	if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2279 		return -EINVAL;
2280 	else if (len)
2281 		name = cfg->name;
2282 	else
2283 		name = NULL;
2284 
2285 	len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2286 	if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2287 		return -EINVAL;
2288 	else if (len)
2289 		stream_name = cfg->stream_name;
2290 	else
2291 		stream_name = NULL;
2292 
2293 	link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2294 				     name, stream_name);
2295 	if (!link) {
2296 		dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2297 			name, cfg->id);
2298 		return -EINVAL;
2299 	}
2300 
2301 	/* hw format */
2302 	if (cfg->num_hw_configs)
2303 		set_link_hw_format(link, cfg);
2304 
2305 	/* flags */
2306 	if (cfg->flag_mask)
2307 		set_link_flags(link,
2308 			       le32_to_cpu(cfg->flag_mask),
2309 			       le32_to_cpu(cfg->flags));
2310 
2311 	/* pass control to component driver for optional further init */
2312 	ret = soc_tplg_dai_link_load(tplg, link, cfg);
2313 	if (ret < 0) {
2314 		dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2315 		return ret;
2316 	}
2317 
2318 	/* for unloading it in snd_soc_tplg_component_remove */
2319 	link->dobj.index = tplg->index;
2320 	link->dobj.ops = tplg->ops;
2321 	link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2322 	list_add(&link->dobj.list, &tplg->comp->dobj_list);
2323 
2324 	return 0;
2325 }
2326 
2327 
2328 /* Load physical link config elements from the topology context */
2329 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2330 	struct snd_soc_tplg_hdr *hdr)
2331 {
2332 	struct snd_soc_tplg_link_config *link, *_link;
2333 	int count;
2334 	int size;
2335 	int i, ret;
2336 	bool abi_match;
2337 
2338 	count = le32_to_cpu(hdr->count);
2339 
2340 	if (tplg->pass != SOC_TPLG_PASS_LINK) {
2341 		tplg->pos += le32_to_cpu(hdr->size) +
2342 			le32_to_cpu(hdr->payload_size);
2343 		return 0;
2344 	};
2345 
2346 	/* check the element size and count */
2347 	link = (struct snd_soc_tplg_link_config *)tplg->pos;
2348 	size = le32_to_cpu(link->size);
2349 	if (size > sizeof(struct snd_soc_tplg_link_config)
2350 		|| size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2351 		dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2352 			size);
2353 		return -EINVAL;
2354 	}
2355 
2356 	if (soc_tplg_check_elem_count(tplg,
2357 				      size, count,
2358 				      le32_to_cpu(hdr->payload_size),
2359 				      "physical link config")) {
2360 		dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2361 			count);
2362 		return -EINVAL;
2363 	}
2364 
2365 	/* config physical DAI links */
2366 	for (i = 0; i < count; i++) {
2367 		link = (struct snd_soc_tplg_link_config *)tplg->pos;
2368 		size = le32_to_cpu(link->size);
2369 		if (size == sizeof(*link)) {
2370 			abi_match = true;
2371 			_link = link;
2372 		} else {
2373 			abi_match = false;
2374 			ret = link_new_ver(tplg, link, &_link);
2375 			if (ret < 0)
2376 				return ret;
2377 		}
2378 
2379 		ret = soc_tplg_link_config(tplg, _link);
2380 		if (ret < 0)
2381 			return ret;
2382 
2383 		/* offset by version-specific struct size and
2384 		 * real priv data size
2385 		 */
2386 		tplg->pos += size + le32_to_cpu(_link->priv.size);
2387 
2388 		if (!abi_match)
2389 			kfree(_link); /* free the duplicated one */
2390 	}
2391 
2392 	return 0;
2393 }
2394 
2395 /**
2396  * soc_tplg_dai_config - Find and configure an existing physical DAI.
2397  * @tplg: topology context
2398  * @d: physical DAI configs.
2399  *
2400  * The physical dai should already be registered by the platform driver.
2401  * The platform driver should specify the DAI name and ID for matching.
2402  */
2403 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2404 			       struct snd_soc_tplg_dai *d)
2405 {
2406 	struct snd_soc_dai_link_component dai_component;
2407 	struct snd_soc_dai *dai;
2408 	struct snd_soc_dai_driver *dai_drv;
2409 	struct snd_soc_pcm_stream *stream;
2410 	struct snd_soc_tplg_stream_caps *caps;
2411 	int ret;
2412 
2413 	memset(&dai_component, 0, sizeof(dai_component));
2414 
2415 	dai_component.dai_name = d->dai_name;
2416 	dai = snd_soc_find_dai(&dai_component);
2417 	if (!dai) {
2418 		dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2419 			d->dai_name);
2420 		return -EINVAL;
2421 	}
2422 
2423 	if (le32_to_cpu(d->dai_id) != dai->id) {
2424 		dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2425 			d->dai_name);
2426 		return -EINVAL;
2427 	}
2428 
2429 	dai_drv = dai->driver;
2430 	if (!dai_drv)
2431 		return -EINVAL;
2432 
2433 	if (d->playback) {
2434 		stream = &dai_drv->playback;
2435 		caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2436 		set_stream_info(stream, caps);
2437 	}
2438 
2439 	if (d->capture) {
2440 		stream = &dai_drv->capture;
2441 		caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2442 		set_stream_info(stream, caps);
2443 	}
2444 
2445 	if (d->flag_mask)
2446 		set_dai_flags(dai_drv,
2447 			      le32_to_cpu(d->flag_mask),
2448 			      le32_to_cpu(d->flags));
2449 
2450 	/* pass control to component driver for optional further init */
2451 	ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2452 	if (ret < 0) {
2453 		dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2454 		return ret;
2455 	}
2456 
2457 	return 0;
2458 }
2459 
2460 /* load physical DAI elements */
2461 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2462 				   struct snd_soc_tplg_hdr *hdr)
2463 {
2464 	struct snd_soc_tplg_dai *dai;
2465 	int count;
2466 	int i;
2467 
2468 	count = le32_to_cpu(hdr->count);
2469 
2470 	if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2471 		return 0;
2472 
2473 	/* config the existing BE DAIs */
2474 	for (i = 0; i < count; i++) {
2475 		dai = (struct snd_soc_tplg_dai *)tplg->pos;
2476 		if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2477 			dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2478 			return -EINVAL;
2479 		}
2480 
2481 		soc_tplg_dai_config(tplg, dai);
2482 		tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2483 	}
2484 
2485 	dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2486 	return 0;
2487 }
2488 
2489 /**
2490  * manifest_new_ver - Create a new version of manifest from the old version
2491  * of source.
2492  * @tplg: topology context
2493  * @src: old version of manifest as a source
2494  * @manifest: latest version of manifest created from the source
2495  *
2496  * Support from vesion 4. Users need free the returned manifest manually.
2497  */
2498 static int manifest_new_ver(struct soc_tplg *tplg,
2499 			    struct snd_soc_tplg_manifest *src,
2500 			    struct snd_soc_tplg_manifest **manifest)
2501 {
2502 	struct snd_soc_tplg_manifest *dest;
2503 	struct snd_soc_tplg_manifest_v4 *src_v4;
2504 	int size;
2505 
2506 	*manifest = NULL;
2507 
2508 	size = le32_to_cpu(src->size);
2509 	if (size != sizeof(*src_v4)) {
2510 		dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2511 			 size);
2512 		if (size)
2513 			return -EINVAL;
2514 		src->size = cpu_to_le32(sizeof(*src_v4));
2515 	}
2516 
2517 	dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2518 
2519 	src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2520 	dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2521 		       GFP_KERNEL);
2522 	if (!dest)
2523 		return -ENOMEM;
2524 
2525 	dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2526 	dest->control_elems = src_v4->control_elems;
2527 	dest->widget_elems = src_v4->widget_elems;
2528 	dest->graph_elems = src_v4->graph_elems;
2529 	dest->pcm_elems = src_v4->pcm_elems;
2530 	dest->dai_link_elems = src_v4->dai_link_elems;
2531 	dest->priv.size = src_v4->priv.size;
2532 	if (dest->priv.size)
2533 		memcpy(dest->priv.data, src_v4->priv.data,
2534 		       le32_to_cpu(src_v4->priv.size));
2535 
2536 	*manifest = dest;
2537 	return 0;
2538 }
2539 
2540 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2541 				  struct snd_soc_tplg_hdr *hdr)
2542 {
2543 	struct snd_soc_tplg_manifest *manifest, *_manifest;
2544 	bool abi_match;
2545 	int err;
2546 
2547 	if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2548 		return 0;
2549 
2550 	manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2551 
2552 	/* check ABI version by size, create a new manifest if abi not match */
2553 	if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2554 		abi_match = true;
2555 		_manifest = manifest;
2556 	} else {
2557 		abi_match = false;
2558 		err = manifest_new_ver(tplg, manifest, &_manifest);
2559 		if (err < 0)
2560 			return err;
2561 	}
2562 
2563 	/* pass control to component driver for optional further init */
2564 	if (tplg->comp && tplg->ops && tplg->ops->manifest)
2565 		return tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2566 
2567 	if (!abi_match)	/* free the duplicated one */
2568 		kfree(_manifest);
2569 
2570 	return 0;
2571 }
2572 
2573 /* validate header magic, size and type */
2574 static int soc_valid_header(struct soc_tplg *tplg,
2575 	struct snd_soc_tplg_hdr *hdr)
2576 {
2577 	if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2578 		return 0;
2579 
2580 	if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2581 		dev_err(tplg->dev,
2582 			"ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2583 			le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2584 			tplg->fw->size);
2585 		return -EINVAL;
2586 	}
2587 
2588 	/* big endian firmware objects not supported atm */
2589 	if (hdr->magic == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2590 		dev_err(tplg->dev,
2591 			"ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2592 			tplg->pass, hdr->magic,
2593 			soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2594 		return -EINVAL;
2595 	}
2596 
2597 	if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2598 		dev_err(tplg->dev,
2599 			"ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2600 			tplg->pass, hdr->magic,
2601 			soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2602 		return -EINVAL;
2603 	}
2604 
2605 	/* Support ABI from version 4 */
2606 	if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2607 	    le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2608 		dev_err(tplg->dev,
2609 			"ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2610 			tplg->pass, hdr->abi,
2611 			SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2612 			tplg->fw->size);
2613 		return -EINVAL;
2614 	}
2615 
2616 	if (hdr->payload_size == 0) {
2617 		dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2618 			soc_tplg_get_hdr_offset(tplg));
2619 		return -EINVAL;
2620 	}
2621 
2622 	if (tplg->pass == le32_to_cpu(hdr->type))
2623 		dev_dbg(tplg->dev,
2624 			"ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2625 			hdr->payload_size, hdr->type, hdr->version,
2626 			hdr->vendor_type, tplg->pass);
2627 
2628 	return 1;
2629 }
2630 
2631 /* check header type and call appropriate handler */
2632 static int soc_tplg_load_header(struct soc_tplg *tplg,
2633 	struct snd_soc_tplg_hdr *hdr)
2634 {
2635 	tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2636 
2637 	/* check for matching ID */
2638 	if (le32_to_cpu(hdr->index) != tplg->req_index &&
2639 		tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2640 		return 0;
2641 
2642 	tplg->index = le32_to_cpu(hdr->index);
2643 
2644 	switch (le32_to_cpu(hdr->type)) {
2645 	case SND_SOC_TPLG_TYPE_MIXER:
2646 	case SND_SOC_TPLG_TYPE_ENUM:
2647 	case SND_SOC_TPLG_TYPE_BYTES:
2648 		return soc_tplg_kcontrol_elems_load(tplg, hdr);
2649 	case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2650 		return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2651 	case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2652 		return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2653 	case SND_SOC_TPLG_TYPE_PCM:
2654 		return soc_tplg_pcm_elems_load(tplg, hdr);
2655 	case SND_SOC_TPLG_TYPE_DAI:
2656 		return soc_tplg_dai_elems_load(tplg, hdr);
2657 	case SND_SOC_TPLG_TYPE_DAI_LINK:
2658 	case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2659 		/* physical link configurations */
2660 		return soc_tplg_link_elems_load(tplg, hdr);
2661 	case SND_SOC_TPLG_TYPE_MANIFEST:
2662 		return soc_tplg_manifest_load(tplg, hdr);
2663 	default:
2664 		/* bespoke vendor data object */
2665 		return soc_tplg_vendor_load(tplg, hdr);
2666 	}
2667 
2668 	return 0;
2669 }
2670 
2671 /* process the topology file headers */
2672 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2673 {
2674 	struct snd_soc_tplg_hdr *hdr;
2675 	int ret;
2676 
2677 	tplg->pass = SOC_TPLG_PASS_START;
2678 
2679 	/* process the header types from start to end */
2680 	while (tplg->pass <= SOC_TPLG_PASS_END) {
2681 
2682 		tplg->hdr_pos = tplg->fw->data;
2683 		hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2684 
2685 		while (!soc_tplg_is_eof(tplg)) {
2686 
2687 			/* make sure header is valid before loading */
2688 			ret = soc_valid_header(tplg, hdr);
2689 			if (ret < 0)
2690 				return ret;
2691 			else if (ret == 0)
2692 				break;
2693 
2694 			/* load the header object */
2695 			ret = soc_tplg_load_header(tplg, hdr);
2696 			if (ret < 0)
2697 				return ret;
2698 
2699 			/* goto next header */
2700 			tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2701 				sizeof(struct snd_soc_tplg_hdr);
2702 			hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2703 		}
2704 
2705 		/* next data type pass */
2706 		tplg->pass++;
2707 	}
2708 
2709 	/* signal DAPM we are complete */
2710 	ret = soc_tplg_dapm_complete(tplg);
2711 	if (ret < 0)
2712 		dev_err(tplg->dev,
2713 			"ASoC: failed to initialise DAPM from Firmware\n");
2714 
2715 	return ret;
2716 }
2717 
2718 static int soc_tplg_load(struct soc_tplg *tplg)
2719 {
2720 	int ret;
2721 
2722 	ret = soc_tplg_process_headers(tplg);
2723 	if (ret == 0)
2724 		soc_tplg_complete(tplg);
2725 
2726 	return ret;
2727 }
2728 
2729 /* load audio component topology from "firmware" file */
2730 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2731 	struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2732 {
2733 	struct soc_tplg tplg;
2734 	int ret;
2735 
2736 	/* setup parsing context */
2737 	memset(&tplg, 0, sizeof(tplg));
2738 	tplg.fw = fw;
2739 	tplg.dev = comp->dev;
2740 	tplg.comp = comp;
2741 	tplg.ops = ops;
2742 	tplg.req_index = id;
2743 	tplg.io_ops = ops->io_ops;
2744 	tplg.io_ops_count = ops->io_ops_count;
2745 	tplg.bytes_ext_ops = ops->bytes_ext_ops;
2746 	tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2747 
2748 	ret = soc_tplg_load(&tplg);
2749 	/* free the created components if fail to load topology */
2750 	if (ret)
2751 		snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2752 
2753 	return ret;
2754 }
2755 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2756 
2757 /* remove this dynamic widget */
2758 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2759 {
2760 	/* make sure we are a widget */
2761 	if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2762 		return;
2763 
2764 	remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2765 }
2766 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2767 
2768 /* remove all dynamic widgets from this DAPM context */
2769 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2770 	u32 index)
2771 {
2772 	struct snd_soc_dapm_widget *w, *next_w;
2773 
2774 	list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2775 
2776 		/* make sure we are a widget with correct context */
2777 		if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2778 			continue;
2779 
2780 		/* match ID */
2781 		if (w->dobj.index != index &&
2782 			w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2783 			continue;
2784 		/* check and free and dynamic widget kcontrols */
2785 		snd_soc_tplg_widget_remove(w);
2786 		snd_soc_dapm_free_widget(w);
2787 	}
2788 	snd_soc_dapm_reset_cache(dapm);
2789 }
2790 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2791 
2792 /* remove dynamic controls from the component driver */
2793 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2794 {
2795 	struct snd_soc_dobj *dobj, *next_dobj;
2796 	int pass = SOC_TPLG_PASS_END;
2797 
2798 	/* process the header types from end to start */
2799 	while (pass >= SOC_TPLG_PASS_START) {
2800 
2801 		/* remove mixer controls */
2802 		list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2803 			list) {
2804 
2805 			/* match index */
2806 			if (dobj->index != index &&
2807 				index != SND_SOC_TPLG_INDEX_ALL)
2808 				continue;
2809 
2810 			switch (dobj->type) {
2811 			case SND_SOC_DOBJ_MIXER:
2812 				remove_mixer(comp, dobj, pass);
2813 				break;
2814 			case SND_SOC_DOBJ_ENUM:
2815 				remove_enum(comp, dobj, pass);
2816 				break;
2817 			case SND_SOC_DOBJ_BYTES:
2818 				remove_bytes(comp, dobj, pass);
2819 				break;
2820 			case SND_SOC_DOBJ_GRAPH:
2821 				remove_route(comp, dobj, pass);
2822 				break;
2823 			case SND_SOC_DOBJ_WIDGET:
2824 				remove_widget(comp, dobj, pass);
2825 				break;
2826 			case SND_SOC_DOBJ_PCM:
2827 				remove_dai(comp, dobj, pass);
2828 				break;
2829 			case SND_SOC_DOBJ_DAI_LINK:
2830 				remove_link(comp, dobj, pass);
2831 				break;
2832 			case SND_SOC_DOBJ_BACKEND_LINK:
2833 				/*
2834 				 * call link_unload ops if extra
2835 				 * deinitialization is needed.
2836 				 */
2837 				remove_backend_link(comp, dobj, pass);
2838 				break;
2839 			default:
2840 				dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2841 					dobj->type);
2842 				break;
2843 			}
2844 		}
2845 		pass--;
2846 	}
2847 
2848 	/* let caller know if FW can be freed when no objects are left */
2849 	return !list_empty(&comp->dobj_list);
2850 }
2851 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);
2852