xref: /openbmc/linux/sound/soc/soc-topology.c (revision aeb64ff3)
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 	kfree(link->name);
552 	kfree(link->stream_name);
553 	kfree(link->cpus->dai_name);
554 
555 	list_del(&dobj->list);
556 	snd_soc_remove_dai_link(comp->card, link);
557 	kfree(link);
558 }
559 
560 /* unload dai link */
561 static void remove_backend_link(struct snd_soc_component *comp,
562 	struct snd_soc_dobj *dobj, int pass)
563 {
564 	if (pass != SOC_TPLG_PASS_LINK)
565 		return;
566 
567 	if (dobj->ops && dobj->ops->link_unload)
568 		dobj->ops->link_unload(comp, dobj);
569 
570 	/*
571 	 * We don't free the link here as what remove_link() do since BE
572 	 * links are not allocated by topology.
573 	 * We however need to reset the dobj type to its initial values
574 	 */
575 	dobj->type = SND_SOC_DOBJ_NONE;
576 	list_del(&dobj->list);
577 }
578 
579 /* bind a kcontrol to it's IO handlers */
580 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
581 	struct snd_kcontrol_new *k,
582 	const struct soc_tplg *tplg)
583 {
584 	const struct snd_soc_tplg_kcontrol_ops *ops;
585 	const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
586 	int num_ops, i;
587 
588 	if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
589 		&& k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
590 		&& k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
591 		&& k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
592 		struct soc_bytes_ext *sbe;
593 		struct snd_soc_tplg_bytes_control *be;
594 
595 		sbe = (struct soc_bytes_ext *)k->private_value;
596 		be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
597 
598 		/* TLV bytes controls need standard kcontrol info handler,
599 		 * TLV callback and extended put/get handlers.
600 		 */
601 		k->info = snd_soc_bytes_info_ext;
602 		k->tlv.c = snd_soc_bytes_tlv_callback;
603 
604 		ext_ops = tplg->bytes_ext_ops;
605 		num_ops = tplg->bytes_ext_ops_count;
606 		for (i = 0; i < num_ops; i++) {
607 			if (!sbe->put && ext_ops[i].id == be->ext_ops.put)
608 				sbe->put = ext_ops[i].put;
609 			if (!sbe->get && ext_ops[i].id == be->ext_ops.get)
610 				sbe->get = ext_ops[i].get;
611 		}
612 
613 		if (sbe->put && sbe->get)
614 			return 0;
615 		else
616 			return -EINVAL;
617 	}
618 
619 	/* try and map vendor specific kcontrol handlers first */
620 	ops = tplg->io_ops;
621 	num_ops = tplg->io_ops_count;
622 	for (i = 0; i < num_ops; i++) {
623 
624 		if (k->put == NULL && ops[i].id == hdr->ops.put)
625 			k->put = ops[i].put;
626 		if (k->get == NULL && ops[i].id == hdr->ops.get)
627 			k->get = ops[i].get;
628 		if (k->info == NULL && ops[i].id == hdr->ops.info)
629 			k->info = ops[i].info;
630 	}
631 
632 	/* vendor specific handlers found ? */
633 	if (k->put && k->get && k->info)
634 		return 0;
635 
636 	/* none found so try standard kcontrol handlers */
637 	ops = io_ops;
638 	num_ops = ARRAY_SIZE(io_ops);
639 	for (i = 0; i < num_ops; i++) {
640 
641 		if (k->put == NULL && ops[i].id == hdr->ops.put)
642 			k->put = ops[i].put;
643 		if (k->get == NULL && ops[i].id == hdr->ops.get)
644 			k->get = ops[i].get;
645 		if (k->info == NULL && ops[i].id == hdr->ops.info)
646 			k->info = ops[i].info;
647 	}
648 
649 	/* standard handlers found ? */
650 	if (k->put && k->get && k->info)
651 		return 0;
652 
653 	/* nothing to bind */
654 	return -EINVAL;
655 }
656 
657 /* bind a widgets to it's evnt handlers */
658 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
659 		const struct snd_soc_tplg_widget_events *events,
660 		int num_events, u16 event_type)
661 {
662 	int i;
663 
664 	w->event = NULL;
665 
666 	for (i = 0; i < num_events; i++) {
667 		if (event_type == events[i].type) {
668 
669 			/* found - so assign event */
670 			w->event = events[i].event_handler;
671 			return 0;
672 		}
673 	}
674 
675 	/* not found */
676 	return -EINVAL;
677 }
678 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
679 
680 /* optionally pass new dynamic kcontrol to component driver. */
681 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
682 	struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
683 {
684 	if (tplg->comp && tplg->ops && tplg->ops->control_load)
685 		return tplg->ops->control_load(tplg->comp, tplg->index, k,
686 			hdr);
687 
688 	return 0;
689 }
690 
691 
692 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
693 	struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
694 {
695 	unsigned int item_len = 2 * sizeof(unsigned int);
696 	unsigned int *p;
697 
698 	p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
699 	if (!p)
700 		return -ENOMEM;
701 
702 	p[0] = SNDRV_CTL_TLVT_DB_SCALE;
703 	p[1] = item_len;
704 	p[2] = le32_to_cpu(scale->min);
705 	p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
706 		| (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
707 
708 	kc->tlv.p = (void *)p;
709 	return 0;
710 }
711 
712 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
713 	struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
714 {
715 	struct snd_soc_tplg_ctl_tlv *tplg_tlv;
716 	u32 access = le32_to_cpu(tc->access);
717 
718 	if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
719 		return 0;
720 
721 	if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
722 		tplg_tlv = &tc->tlv;
723 		switch (le32_to_cpu(tplg_tlv->type)) {
724 		case SNDRV_CTL_TLVT_DB_SCALE:
725 			return soc_tplg_create_tlv_db_scale(tplg, kc,
726 					&tplg_tlv->scale);
727 
728 		/* TODO: add support for other TLV types */
729 		default:
730 			dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
731 					tplg_tlv->type);
732 			return -EINVAL;
733 		}
734 	}
735 
736 	return 0;
737 }
738 
739 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
740 	struct snd_kcontrol_new *kc)
741 {
742 	kfree(kc->tlv.p);
743 }
744 
745 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
746 	size_t size)
747 {
748 	struct snd_soc_tplg_bytes_control *be;
749 	struct soc_bytes_ext *sbe;
750 	struct snd_kcontrol_new kc;
751 	int i, err;
752 
753 	if (soc_tplg_check_elem_count(tplg,
754 		sizeof(struct snd_soc_tplg_bytes_control), count,
755 			size, "mixer bytes")) {
756 		dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
757 			count);
758 		return -EINVAL;
759 	}
760 
761 	for (i = 0; i < count; i++) {
762 		be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
763 
764 		/* validate kcontrol */
765 		if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
766 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
767 			return -EINVAL;
768 
769 		sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
770 		if (sbe == NULL)
771 			return -ENOMEM;
772 
773 		tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
774 			      le32_to_cpu(be->priv.size));
775 
776 		dev_dbg(tplg->dev,
777 			"ASoC: adding bytes kcontrol %s with access 0x%x\n",
778 			be->hdr.name, be->hdr.access);
779 
780 		memset(&kc, 0, sizeof(kc));
781 		kc.name = be->hdr.name;
782 		kc.private_value = (long)sbe;
783 		kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
784 		kc.access = le32_to_cpu(be->hdr.access);
785 
786 		sbe->max = le32_to_cpu(be->max);
787 		sbe->dobj.type = SND_SOC_DOBJ_BYTES;
788 		sbe->dobj.ops = tplg->ops;
789 		INIT_LIST_HEAD(&sbe->dobj.list);
790 
791 		/* map io handlers */
792 		err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
793 		if (err) {
794 			soc_control_err(tplg, &be->hdr, be->hdr.name);
795 			kfree(sbe);
796 			continue;
797 		}
798 
799 		/* pass control to driver for optional further init */
800 		err = soc_tplg_init_kcontrol(tplg, &kc,
801 			(struct snd_soc_tplg_ctl_hdr *)be);
802 		if (err < 0) {
803 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
804 				be->hdr.name);
805 			kfree(sbe);
806 			continue;
807 		}
808 
809 		/* register control here */
810 		err = soc_tplg_add_kcontrol(tplg, &kc,
811 			&sbe->dobj.control.kcontrol);
812 		if (err < 0) {
813 			dev_err(tplg->dev, "ASoC: failed to add %s\n",
814 				be->hdr.name);
815 			kfree(sbe);
816 			continue;
817 		}
818 
819 		list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
820 	}
821 	return 0;
822 
823 }
824 
825 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
826 	size_t size)
827 {
828 	struct snd_soc_tplg_mixer_control *mc;
829 	struct soc_mixer_control *sm;
830 	struct snd_kcontrol_new kc;
831 	int i, err;
832 
833 	if (soc_tplg_check_elem_count(tplg,
834 		sizeof(struct snd_soc_tplg_mixer_control),
835 		count, size, "mixers")) {
836 
837 		dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
838 			count);
839 		return -EINVAL;
840 	}
841 
842 	for (i = 0; i < count; i++) {
843 		mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
844 
845 		/* validate kcontrol */
846 		if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
847 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
848 			return -EINVAL;
849 
850 		sm = kzalloc(sizeof(*sm), GFP_KERNEL);
851 		if (sm == NULL)
852 			return -ENOMEM;
853 		tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
854 			      le32_to_cpu(mc->priv.size));
855 
856 		dev_dbg(tplg->dev,
857 			"ASoC: adding mixer kcontrol %s with access 0x%x\n",
858 			mc->hdr.name, mc->hdr.access);
859 
860 		memset(&kc, 0, sizeof(kc));
861 		kc.name = mc->hdr.name;
862 		kc.private_value = (long)sm;
863 		kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
864 		kc.access = le32_to_cpu(mc->hdr.access);
865 
866 		/* we only support FL/FR channel mapping atm */
867 		sm->reg = tplc_chan_get_reg(tplg, mc->channel,
868 			SNDRV_CHMAP_FL);
869 		sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
870 			SNDRV_CHMAP_FR);
871 		sm->shift = tplc_chan_get_shift(tplg, mc->channel,
872 			SNDRV_CHMAP_FL);
873 		sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
874 			SNDRV_CHMAP_FR);
875 
876 		sm->max = le32_to_cpu(mc->max);
877 		sm->min = le32_to_cpu(mc->min);
878 		sm->invert = le32_to_cpu(mc->invert);
879 		sm->platform_max = le32_to_cpu(mc->platform_max);
880 		sm->dobj.index = tplg->index;
881 		sm->dobj.ops = tplg->ops;
882 		sm->dobj.type = SND_SOC_DOBJ_MIXER;
883 		INIT_LIST_HEAD(&sm->dobj.list);
884 
885 		/* map io handlers */
886 		err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
887 		if (err) {
888 			soc_control_err(tplg, &mc->hdr, mc->hdr.name);
889 			kfree(sm);
890 			continue;
891 		}
892 
893 		/* create any TLV data */
894 		soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
895 
896 		/* pass control to driver for optional further init */
897 		err = soc_tplg_init_kcontrol(tplg, &kc,
898 			(struct snd_soc_tplg_ctl_hdr *) mc);
899 		if (err < 0) {
900 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
901 				mc->hdr.name);
902 			soc_tplg_free_tlv(tplg, &kc);
903 			kfree(sm);
904 			continue;
905 		}
906 
907 		/* register control here */
908 		err = soc_tplg_add_kcontrol(tplg, &kc,
909 			&sm->dobj.control.kcontrol);
910 		if (err < 0) {
911 			dev_err(tplg->dev, "ASoC: failed to add %s\n",
912 				mc->hdr.name);
913 			soc_tplg_free_tlv(tplg, &kc);
914 			kfree(sm);
915 			continue;
916 		}
917 
918 		list_add(&sm->dobj.list, &tplg->comp->dobj_list);
919 	}
920 
921 	return 0;
922 }
923 
924 static int soc_tplg_denum_create_texts(struct soc_enum *se,
925 	struct snd_soc_tplg_enum_control *ec)
926 {
927 	int i, ret;
928 
929 	se->dobj.control.dtexts =
930 		kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
931 	if (se->dobj.control.dtexts == NULL)
932 		return -ENOMEM;
933 
934 	for (i = 0; i < ec->items; i++) {
935 
936 		if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
937 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
938 			ret = -EINVAL;
939 			goto err;
940 		}
941 
942 		se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
943 		if (!se->dobj.control.dtexts[i]) {
944 			ret = -ENOMEM;
945 			goto err;
946 		}
947 	}
948 
949 	se->items = le32_to_cpu(ec->items);
950 	se->texts = (const char * const *)se->dobj.control.dtexts;
951 	return 0;
952 
953 err:
954 	se->items = i;
955 	soc_tplg_denum_remove_texts(se);
956 	return ret;
957 }
958 
959 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
960 {
961 	int i = se->items;
962 
963 	for (--i; i >= 0; i--)
964 		kfree(se->dobj.control.dtexts[i]);
965 	kfree(se->dobj.control.dtexts);
966 }
967 
968 static int soc_tplg_denum_create_values(struct soc_enum *se,
969 	struct snd_soc_tplg_enum_control *ec)
970 {
971 	int i;
972 
973 	if (le32_to_cpu(ec->items) > sizeof(*ec->values))
974 		return -EINVAL;
975 
976 	se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
977 					   sizeof(u32),
978 					   GFP_KERNEL);
979 	if (!se->dobj.control.dvalues)
980 		return -ENOMEM;
981 
982 	/* convert from little-endian */
983 	for (i = 0; i < le32_to_cpu(ec->items); i++) {
984 		se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
985 	}
986 
987 	return 0;
988 }
989 
990 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
991 {
992 	kfree(se->dobj.control.dvalues);
993 }
994 
995 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
996 	size_t size)
997 {
998 	struct snd_soc_tplg_enum_control *ec;
999 	struct soc_enum *se;
1000 	struct snd_kcontrol_new kc;
1001 	int i, ret, err;
1002 
1003 	if (soc_tplg_check_elem_count(tplg,
1004 		sizeof(struct snd_soc_tplg_enum_control),
1005 		count, size, "enums")) {
1006 
1007 		dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1008 			count);
1009 		return -EINVAL;
1010 	}
1011 
1012 	for (i = 0; i < count; i++) {
1013 		ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1014 
1015 		/* validate kcontrol */
1016 		if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1017 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1018 			return -EINVAL;
1019 
1020 		se = kzalloc((sizeof(*se)), GFP_KERNEL);
1021 		if (se == NULL)
1022 			return -ENOMEM;
1023 
1024 		tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1025 			      le32_to_cpu(ec->priv.size));
1026 
1027 		dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1028 			ec->hdr.name, ec->items);
1029 
1030 		memset(&kc, 0, sizeof(kc));
1031 		kc.name = ec->hdr.name;
1032 		kc.private_value = (long)se;
1033 		kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1034 		kc.access = le32_to_cpu(ec->hdr.access);
1035 
1036 		se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1037 		se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1038 			SNDRV_CHMAP_FL);
1039 		se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1040 			SNDRV_CHMAP_FL);
1041 
1042 		se->mask = le32_to_cpu(ec->mask);
1043 		se->dobj.index = tplg->index;
1044 		se->dobj.type = SND_SOC_DOBJ_ENUM;
1045 		se->dobj.ops = tplg->ops;
1046 		INIT_LIST_HEAD(&se->dobj.list);
1047 
1048 		switch (le32_to_cpu(ec->hdr.ops.info)) {
1049 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1050 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1051 			err = soc_tplg_denum_create_values(se, ec);
1052 			if (err < 0) {
1053 				dev_err(tplg->dev,
1054 					"ASoC: could not create values for %s\n",
1055 					ec->hdr.name);
1056 				kfree(se);
1057 				continue;
1058 			}
1059 			/* fall through */
1060 		case SND_SOC_TPLG_CTL_ENUM:
1061 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1062 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1063 			err = soc_tplg_denum_create_texts(se, ec);
1064 			if (err < 0) {
1065 				dev_err(tplg->dev,
1066 					"ASoC: could not create texts for %s\n",
1067 					ec->hdr.name);
1068 				kfree(se);
1069 				continue;
1070 			}
1071 			break;
1072 		default:
1073 			dev_err(tplg->dev,
1074 				"ASoC: invalid enum control type %d for %s\n",
1075 				ec->hdr.ops.info, ec->hdr.name);
1076 			kfree(se);
1077 			continue;
1078 		}
1079 
1080 		/* map io handlers */
1081 		err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1082 		if (err) {
1083 			soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1084 			kfree(se);
1085 			continue;
1086 		}
1087 
1088 		/* pass control to driver for optional further init */
1089 		err = soc_tplg_init_kcontrol(tplg, &kc,
1090 			(struct snd_soc_tplg_ctl_hdr *) ec);
1091 		if (err < 0) {
1092 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1093 				ec->hdr.name);
1094 			kfree(se);
1095 			continue;
1096 		}
1097 
1098 		/* register control here */
1099 		ret = soc_tplg_add_kcontrol(tplg,
1100 			&kc, &se->dobj.control.kcontrol);
1101 		if (ret < 0) {
1102 			dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1103 				ec->hdr.name);
1104 			kfree(se);
1105 			continue;
1106 		}
1107 
1108 		list_add(&se->dobj.list, &tplg->comp->dobj_list);
1109 	}
1110 
1111 	return 0;
1112 }
1113 
1114 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1115 	struct snd_soc_tplg_hdr *hdr)
1116 {
1117 	struct snd_soc_tplg_ctl_hdr *control_hdr;
1118 	int i;
1119 
1120 	if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1121 		tplg->pos += le32_to_cpu(hdr->size) +
1122 			le32_to_cpu(hdr->payload_size);
1123 		return 0;
1124 	}
1125 
1126 	dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1127 		soc_tplg_get_offset(tplg));
1128 
1129 	for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1130 
1131 		control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1132 
1133 		if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1134 			dev_err(tplg->dev, "ASoC: invalid control size\n");
1135 			return -EINVAL;
1136 		}
1137 
1138 		switch (le32_to_cpu(control_hdr->ops.info)) {
1139 		case SND_SOC_TPLG_CTL_VOLSW:
1140 		case SND_SOC_TPLG_CTL_STROBE:
1141 		case SND_SOC_TPLG_CTL_VOLSW_SX:
1142 		case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1143 		case SND_SOC_TPLG_CTL_RANGE:
1144 		case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1145 		case SND_SOC_TPLG_DAPM_CTL_PIN:
1146 			soc_tplg_dmixer_create(tplg, 1,
1147 					       le32_to_cpu(hdr->payload_size));
1148 			break;
1149 		case SND_SOC_TPLG_CTL_ENUM:
1150 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1151 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1152 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1153 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1154 			soc_tplg_denum_create(tplg, 1,
1155 					      le32_to_cpu(hdr->payload_size));
1156 			break;
1157 		case SND_SOC_TPLG_CTL_BYTES:
1158 			soc_tplg_dbytes_create(tplg, 1,
1159 					       le32_to_cpu(hdr->payload_size));
1160 			break;
1161 		default:
1162 			soc_bind_err(tplg, control_hdr, i);
1163 			return -EINVAL;
1164 		}
1165 	}
1166 
1167 	return 0;
1168 }
1169 
1170 /* optionally pass new dynamic kcontrol to component driver. */
1171 static int soc_tplg_add_route(struct soc_tplg *tplg,
1172 	struct snd_soc_dapm_route *route)
1173 {
1174 	if (tplg->comp && tplg->ops && tplg->ops->dapm_route_load)
1175 		return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1176 			route);
1177 
1178 	return 0;
1179 }
1180 
1181 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1182 	struct snd_soc_tplg_hdr *hdr)
1183 {
1184 	struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1185 	struct snd_soc_tplg_dapm_graph_elem *elem;
1186 	struct snd_soc_dapm_route **routes;
1187 	int count, i, j;
1188 	int ret = 0;
1189 
1190 	count = le32_to_cpu(hdr->count);
1191 
1192 	if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1193 		tplg->pos +=
1194 			le32_to_cpu(hdr->size) +
1195 			le32_to_cpu(hdr->payload_size);
1196 
1197 		return 0;
1198 	}
1199 
1200 	if (soc_tplg_check_elem_count(tplg,
1201 		sizeof(struct snd_soc_tplg_dapm_graph_elem),
1202 		count, le32_to_cpu(hdr->payload_size), "graph")) {
1203 
1204 		dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1205 			count);
1206 		return -EINVAL;
1207 	}
1208 
1209 	dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1210 		hdr->index);
1211 
1212 	/* allocate memory for pointer to array of dapm routes */
1213 	routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1214 			 GFP_KERNEL);
1215 	if (!routes)
1216 		return -ENOMEM;
1217 
1218 	/*
1219 	 * allocate memory for each dapm route in the array.
1220 	 * This needs to be done individually so that
1221 	 * each route can be freed when it is removed in remove_route().
1222 	 */
1223 	for (i = 0; i < count; i++) {
1224 		routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1225 		if (!routes[i]) {
1226 			/* free previously allocated memory */
1227 			for (j = 0; j < i; j++)
1228 				kfree(routes[j]);
1229 
1230 			kfree(routes);
1231 			return -ENOMEM;
1232 		}
1233 	}
1234 
1235 	for (i = 0; i < count; i++) {
1236 		elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1237 		tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1238 
1239 		/* validate routes */
1240 		if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1241 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1242 			ret = -EINVAL;
1243 			break;
1244 		}
1245 		if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1246 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1247 			ret = -EINVAL;
1248 			break;
1249 		}
1250 		if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1251 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1252 			ret = -EINVAL;
1253 			break;
1254 		}
1255 
1256 		routes[i]->source = elem->source;
1257 		routes[i]->sink = elem->sink;
1258 
1259 		/* set to NULL atm for tplg users */
1260 		routes[i]->connected = NULL;
1261 		if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1262 			routes[i]->control = NULL;
1263 		else
1264 			routes[i]->control = elem->control;
1265 
1266 		/* add route dobj to dobj_list */
1267 		routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1268 		routes[i]->dobj.ops = tplg->ops;
1269 		routes[i]->dobj.index = tplg->index;
1270 		list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1271 
1272 		soc_tplg_add_route(tplg, routes[i]);
1273 
1274 		/* add route, but keep going if some fail */
1275 		snd_soc_dapm_add_routes(dapm, routes[i], 1);
1276 	}
1277 
1278 	/* free memory allocated for all dapm routes in case of error */
1279 	if (ret < 0)
1280 		for (i = 0; i < count ; i++)
1281 			kfree(routes[i]);
1282 
1283 	/*
1284 	 * free pointer to array of dapm routes as this is no longer needed.
1285 	 * The memory allocated for each dapm route will be freed
1286 	 * when it is removed in remove_route().
1287 	 */
1288 	kfree(routes);
1289 
1290 	return ret;
1291 }
1292 
1293 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1294 	struct soc_tplg *tplg, int num_kcontrols)
1295 {
1296 	struct snd_kcontrol_new *kc;
1297 	struct soc_mixer_control *sm;
1298 	struct snd_soc_tplg_mixer_control *mc;
1299 	int i, err;
1300 
1301 	kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1302 	if (kc == NULL)
1303 		return NULL;
1304 
1305 	for (i = 0; i < num_kcontrols; i++) {
1306 		mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1307 
1308 		/* validate kcontrol */
1309 		if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1310 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1311 			goto err_sm;
1312 
1313 		sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1314 		if (sm == NULL)
1315 			goto err_sm;
1316 
1317 		tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1318 			      le32_to_cpu(mc->priv.size));
1319 
1320 		dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1321 			mc->hdr.name, i);
1322 
1323 		kc[i].private_value = (long)sm;
1324 		kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1325 		if (kc[i].name == NULL)
1326 			goto err_sm;
1327 		kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1328 		kc[i].access = mc->hdr.access;
1329 
1330 		/* we only support FL/FR channel mapping atm */
1331 		sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1332 			SNDRV_CHMAP_FL);
1333 		sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1334 			SNDRV_CHMAP_FR);
1335 		sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1336 			SNDRV_CHMAP_FL);
1337 		sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1338 			SNDRV_CHMAP_FR);
1339 
1340 		sm->max = mc->max;
1341 		sm->min = mc->min;
1342 		sm->invert = mc->invert;
1343 		sm->platform_max = mc->platform_max;
1344 		sm->dobj.index = tplg->index;
1345 		INIT_LIST_HEAD(&sm->dobj.list);
1346 
1347 		/* map io handlers */
1348 		err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1349 		if (err) {
1350 			soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1351 			goto err_sm;
1352 		}
1353 
1354 		/* create any TLV data */
1355 		soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1356 
1357 		/* pass control to driver for optional further init */
1358 		err = soc_tplg_init_kcontrol(tplg, &kc[i],
1359 			(struct snd_soc_tplg_ctl_hdr *)mc);
1360 		if (err < 0) {
1361 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1362 				mc->hdr.name);
1363 			soc_tplg_free_tlv(tplg, &kc[i]);
1364 			goto err_sm;
1365 		}
1366 	}
1367 	return kc;
1368 
1369 err_sm:
1370 	for (; i >= 0; i--) {
1371 		sm = (struct soc_mixer_control *)kc[i].private_value;
1372 		kfree(sm);
1373 		kfree(kc[i].name);
1374 	}
1375 	kfree(kc);
1376 
1377 	return NULL;
1378 }
1379 
1380 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1381 	struct soc_tplg *tplg, int num_kcontrols)
1382 {
1383 	struct snd_kcontrol_new *kc;
1384 	struct snd_soc_tplg_enum_control *ec;
1385 	struct soc_enum *se;
1386 	int i, err;
1387 
1388 	kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1389 	if (kc == NULL)
1390 		return NULL;
1391 
1392 	for (i = 0; i < num_kcontrols; i++) {
1393 		ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1394 		/* validate kcontrol */
1395 		if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1396 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1397 			goto err_se;
1398 
1399 		se = kzalloc(sizeof(*se), GFP_KERNEL);
1400 		if (se == NULL)
1401 			goto err_se;
1402 
1403 		tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1404 				ec->priv.size);
1405 
1406 		dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1407 			ec->hdr.name);
1408 
1409 		kc[i].private_value = (long)se;
1410 		kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1411 		if (kc[i].name == NULL)
1412 			goto err_se;
1413 		kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1414 		kc[i].access = ec->hdr.access;
1415 
1416 		/* we only support FL/FR channel mapping atm */
1417 		se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1418 		se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1419 						  SNDRV_CHMAP_FL);
1420 		se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1421 						  SNDRV_CHMAP_FR);
1422 
1423 		se->items = ec->items;
1424 		se->mask = ec->mask;
1425 		se->dobj.index = tplg->index;
1426 
1427 		switch (le32_to_cpu(ec->hdr.ops.info)) {
1428 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1429 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1430 			err = soc_tplg_denum_create_values(se, ec);
1431 			if (err < 0) {
1432 				dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1433 					ec->hdr.name);
1434 				goto err_se;
1435 			}
1436 			/* fall through */
1437 		case SND_SOC_TPLG_CTL_ENUM:
1438 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1439 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1440 			err = soc_tplg_denum_create_texts(se, ec);
1441 			if (err < 0) {
1442 				dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1443 					ec->hdr.name);
1444 				goto err_se;
1445 			}
1446 			break;
1447 		default:
1448 			dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1449 				ec->hdr.ops.info, ec->hdr.name);
1450 			goto err_se;
1451 		}
1452 
1453 		/* map io handlers */
1454 		err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1455 		if (err) {
1456 			soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1457 			goto err_se;
1458 		}
1459 
1460 		/* pass control to driver for optional further init */
1461 		err = soc_tplg_init_kcontrol(tplg, &kc[i],
1462 			(struct snd_soc_tplg_ctl_hdr *)ec);
1463 		if (err < 0) {
1464 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1465 				ec->hdr.name);
1466 			goto err_se;
1467 		}
1468 	}
1469 
1470 	return kc;
1471 
1472 err_se:
1473 	for (; i >= 0; i--) {
1474 		/* free values and texts */
1475 		se = (struct soc_enum *)kc[i].private_value;
1476 
1477 		if (se) {
1478 			soc_tplg_denum_remove_values(se);
1479 			soc_tplg_denum_remove_texts(se);
1480 		}
1481 
1482 		kfree(se);
1483 		kfree(kc[i].name);
1484 	}
1485 	kfree(kc);
1486 
1487 	return NULL;
1488 }
1489 
1490 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1491 	struct soc_tplg *tplg, int num_kcontrols)
1492 {
1493 	struct snd_soc_tplg_bytes_control *be;
1494 	struct soc_bytes_ext *sbe;
1495 	struct snd_kcontrol_new *kc;
1496 	int i, err;
1497 
1498 	kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1499 	if (!kc)
1500 		return NULL;
1501 
1502 	for (i = 0; i < num_kcontrols; i++) {
1503 		be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1504 
1505 		/* validate kcontrol */
1506 		if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1507 			SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1508 			goto err_sbe;
1509 
1510 		sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1511 		if (sbe == NULL)
1512 			goto err_sbe;
1513 
1514 		tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1515 			      le32_to_cpu(be->priv.size));
1516 
1517 		dev_dbg(tplg->dev,
1518 			"ASoC: adding bytes kcontrol %s with access 0x%x\n",
1519 			be->hdr.name, be->hdr.access);
1520 
1521 		kc[i].private_value = (long)sbe;
1522 		kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1523 		if (kc[i].name == NULL)
1524 			goto err_sbe;
1525 		kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1526 		kc[i].access = be->hdr.access;
1527 
1528 		sbe->max = be->max;
1529 		INIT_LIST_HEAD(&sbe->dobj.list);
1530 
1531 		/* map standard io handlers and check for external handlers */
1532 		err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1533 		if (err) {
1534 			soc_control_err(tplg, &be->hdr, be->hdr.name);
1535 			goto err_sbe;
1536 		}
1537 
1538 		/* pass control to driver for optional further init */
1539 		err = soc_tplg_init_kcontrol(tplg, &kc[i],
1540 			(struct snd_soc_tplg_ctl_hdr *)be);
1541 		if (err < 0) {
1542 			dev_err(tplg->dev, "ASoC: failed to init %s\n",
1543 				be->hdr.name);
1544 			goto err_sbe;
1545 		}
1546 	}
1547 
1548 	return kc;
1549 
1550 err_sbe:
1551 	for (; i >= 0; i--) {
1552 		sbe = (struct soc_bytes_ext *)kc[i].private_value;
1553 		kfree(sbe);
1554 		kfree(kc[i].name);
1555 	}
1556 	kfree(kc);
1557 
1558 	return NULL;
1559 }
1560 
1561 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1562 	struct snd_soc_tplg_dapm_widget *w)
1563 {
1564 	struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1565 	struct snd_soc_dapm_widget template, *widget;
1566 	struct snd_soc_tplg_ctl_hdr *control_hdr;
1567 	struct snd_soc_card *card = tplg->comp->card;
1568 	unsigned int kcontrol_type;
1569 	int ret = 0;
1570 
1571 	if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1572 		SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1573 		return -EINVAL;
1574 	if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1575 		SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1576 		return -EINVAL;
1577 
1578 	dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1579 		w->name, w->id);
1580 
1581 	memset(&template, 0, sizeof(template));
1582 
1583 	/* map user to kernel widget ID */
1584 	template.id = get_widget_id(le32_to_cpu(w->id));
1585 	if ((int)template.id < 0)
1586 		return template.id;
1587 
1588 	/* strings are allocated here, but used and freed by the widget */
1589 	template.name = kstrdup(w->name, GFP_KERNEL);
1590 	if (!template.name)
1591 		return -ENOMEM;
1592 	template.sname = kstrdup(w->sname, GFP_KERNEL);
1593 	if (!template.sname) {
1594 		ret = -ENOMEM;
1595 		goto err;
1596 	}
1597 	template.reg = le32_to_cpu(w->reg);
1598 	template.shift = le32_to_cpu(w->shift);
1599 	template.mask = le32_to_cpu(w->mask);
1600 	template.subseq = le32_to_cpu(w->subseq);
1601 	template.on_val = w->invert ? 0 : 1;
1602 	template.off_val = w->invert ? 1 : 0;
1603 	template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1604 	template.event_flags = le16_to_cpu(w->event_flags);
1605 	template.dobj.index = tplg->index;
1606 
1607 	tplg->pos +=
1608 		(sizeof(struct snd_soc_tplg_dapm_widget) +
1609 		 le32_to_cpu(w->priv.size));
1610 
1611 	if (w->num_kcontrols == 0) {
1612 		kcontrol_type = 0;
1613 		template.num_kcontrols = 0;
1614 		goto widget;
1615 	}
1616 
1617 	control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1618 	dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1619 		w->name, w->num_kcontrols, control_hdr->type);
1620 
1621 	switch (le32_to_cpu(control_hdr->ops.info)) {
1622 	case SND_SOC_TPLG_CTL_VOLSW:
1623 	case SND_SOC_TPLG_CTL_STROBE:
1624 	case SND_SOC_TPLG_CTL_VOLSW_SX:
1625 	case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1626 	case SND_SOC_TPLG_CTL_RANGE:
1627 	case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1628 		kcontrol_type = SND_SOC_TPLG_TYPE_MIXER;  /* volume mixer */
1629 		template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1630 		template.kcontrol_news =
1631 			soc_tplg_dapm_widget_dmixer_create(tplg,
1632 			template.num_kcontrols);
1633 		if (!template.kcontrol_news) {
1634 			ret = -ENOMEM;
1635 			goto hdr_err;
1636 		}
1637 		break;
1638 	case SND_SOC_TPLG_CTL_ENUM:
1639 	case SND_SOC_TPLG_CTL_ENUM_VALUE:
1640 	case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1641 	case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1642 	case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1643 		kcontrol_type = SND_SOC_TPLG_TYPE_ENUM;	/* enumerated mixer */
1644 		template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1645 		template.kcontrol_news =
1646 			soc_tplg_dapm_widget_denum_create(tplg,
1647 			template.num_kcontrols);
1648 		if (!template.kcontrol_news) {
1649 			ret = -ENOMEM;
1650 			goto hdr_err;
1651 		}
1652 		break;
1653 	case SND_SOC_TPLG_CTL_BYTES:
1654 		kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1655 		template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1656 		template.kcontrol_news =
1657 			soc_tplg_dapm_widget_dbytes_create(tplg,
1658 				template.num_kcontrols);
1659 		if (!template.kcontrol_news) {
1660 			ret = -ENOMEM;
1661 			goto hdr_err;
1662 		}
1663 		break;
1664 	default:
1665 		dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1666 			control_hdr->ops.get, control_hdr->ops.put,
1667 			le32_to_cpu(control_hdr->ops.info));
1668 		ret = -EINVAL;
1669 		goto hdr_err;
1670 	}
1671 
1672 widget:
1673 	ret = soc_tplg_widget_load(tplg, &template, w);
1674 	if (ret < 0)
1675 		goto hdr_err;
1676 
1677 	/* card dapm mutex is held by the core if we are loading topology
1678 	 * data during sound card init. */
1679 	if (card->instantiated)
1680 		widget = snd_soc_dapm_new_control(dapm, &template);
1681 	else
1682 		widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1683 	if (IS_ERR(widget)) {
1684 		ret = PTR_ERR(widget);
1685 		goto hdr_err;
1686 	}
1687 
1688 	widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1689 	widget->dobj.widget.kcontrol_type = kcontrol_type;
1690 	widget->dobj.ops = tplg->ops;
1691 	widget->dobj.index = tplg->index;
1692 	list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1693 
1694 	ret = soc_tplg_widget_ready(tplg, widget, w);
1695 	if (ret < 0)
1696 		goto ready_err;
1697 
1698 	kfree(template.sname);
1699 	kfree(template.name);
1700 
1701 	return 0;
1702 
1703 ready_err:
1704 	snd_soc_tplg_widget_remove(widget);
1705 	snd_soc_dapm_free_widget(widget);
1706 hdr_err:
1707 	kfree(template.sname);
1708 err:
1709 	kfree(template.name);
1710 	return ret;
1711 }
1712 
1713 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1714 	struct snd_soc_tplg_hdr *hdr)
1715 {
1716 	struct snd_soc_tplg_dapm_widget *widget;
1717 	int ret, count, i;
1718 
1719 	count = le32_to_cpu(hdr->count);
1720 
1721 	if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1722 		return 0;
1723 
1724 	dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1725 
1726 	for (i = 0; i < count; i++) {
1727 		widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1728 		if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1729 			dev_err(tplg->dev, "ASoC: invalid widget size\n");
1730 			return -EINVAL;
1731 		}
1732 
1733 		ret = soc_tplg_dapm_widget_create(tplg, widget);
1734 		if (ret < 0) {
1735 			dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1736 				widget->name);
1737 			return ret;
1738 		}
1739 	}
1740 
1741 	return 0;
1742 }
1743 
1744 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1745 {
1746 	struct snd_soc_card *card = tplg->comp->card;
1747 	int ret;
1748 
1749 	/* Card might not have been registered at this point.
1750 	 * If so, just return success.
1751 	*/
1752 	if (!card || !card->instantiated) {
1753 		dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1754 			" widget card binding deferred\n");
1755 		return 0;
1756 	}
1757 
1758 	ret = snd_soc_dapm_new_widgets(card);
1759 	if (ret < 0)
1760 		dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1761 			ret);
1762 
1763 	return 0;
1764 }
1765 
1766 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1767 	struct snd_soc_tplg_stream_caps *caps)
1768 {
1769 	stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1770 	stream->channels_min = le32_to_cpu(caps->channels_min);
1771 	stream->channels_max = le32_to_cpu(caps->channels_max);
1772 	stream->rates = le32_to_cpu(caps->rates);
1773 	stream->rate_min = le32_to_cpu(caps->rate_min);
1774 	stream->rate_max = le32_to_cpu(caps->rate_max);
1775 	stream->formats = le64_to_cpu(caps->formats);
1776 	stream->sig_bits = le32_to_cpu(caps->sig_bits);
1777 }
1778 
1779 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1780 			  unsigned int flag_mask, unsigned int flags)
1781 {
1782 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1783 		dai_drv->symmetric_rates =
1784 			flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1785 
1786 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1787 		dai_drv->symmetric_channels =
1788 			flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1789 			1 : 0;
1790 
1791 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1792 		dai_drv->symmetric_samplebits =
1793 			flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1794 			1 : 0;
1795 }
1796 
1797 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1798 	struct snd_soc_tplg_pcm *pcm)
1799 {
1800 	struct snd_soc_dai_driver *dai_drv;
1801 	struct snd_soc_pcm_stream *stream;
1802 	struct snd_soc_tplg_stream_caps *caps;
1803 	struct snd_soc_dai *dai;
1804 	struct snd_soc_dapm_context *dapm =
1805 		snd_soc_component_get_dapm(tplg->comp);
1806 	int ret;
1807 
1808 	dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1809 	if (dai_drv == NULL)
1810 		return -ENOMEM;
1811 
1812 	if (strlen(pcm->dai_name))
1813 		dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1814 	dai_drv->id = le32_to_cpu(pcm->dai_id);
1815 
1816 	if (pcm->playback) {
1817 		stream = &dai_drv->playback;
1818 		caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1819 		set_stream_info(stream, caps);
1820 	}
1821 
1822 	if (pcm->capture) {
1823 		stream = &dai_drv->capture;
1824 		caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1825 		set_stream_info(stream, caps);
1826 	}
1827 
1828 	if (pcm->compress)
1829 		dai_drv->compress_new = snd_soc_new_compress;
1830 
1831 	/* pass control to component driver for optional further init */
1832 	ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1833 	if (ret < 0) {
1834 		dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1835 		kfree(dai_drv->playback.stream_name);
1836 		kfree(dai_drv->capture.stream_name);
1837 		kfree(dai_drv->name);
1838 		kfree(dai_drv);
1839 		return ret;
1840 	}
1841 
1842 	dai_drv->dobj.index = tplg->index;
1843 	dai_drv->dobj.ops = tplg->ops;
1844 	dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1845 	list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1846 
1847 	/* register the DAI to the component */
1848 	dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1849 	if (!dai)
1850 		return -ENOMEM;
1851 
1852 	/* Create the DAI widgets here */
1853 	ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1854 	if (ret != 0) {
1855 		dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1856 		snd_soc_unregister_dai(dai);
1857 		return ret;
1858 	}
1859 
1860 	return ret;
1861 }
1862 
1863 static void set_link_flags(struct snd_soc_dai_link *link,
1864 		unsigned int flag_mask, unsigned int flags)
1865 {
1866 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1867 		link->symmetric_rates =
1868 			flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1869 
1870 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1871 		link->symmetric_channels =
1872 			flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1873 			1 : 0;
1874 
1875 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1876 		link->symmetric_samplebits =
1877 			flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1878 			1 : 0;
1879 
1880 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1881 		link->ignore_suspend =
1882 		flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1883 		1 : 0;
1884 }
1885 
1886 /* create the FE DAI link */
1887 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1888 	struct snd_soc_tplg_pcm *pcm)
1889 {
1890 	struct snd_soc_dai_link *link;
1891 	struct snd_soc_dai_link_component *dlc;
1892 	int ret;
1893 
1894 	/* link + cpu + codec + platform */
1895 	link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1896 	if (link == NULL)
1897 		return -ENOMEM;
1898 
1899 	dlc = (struct snd_soc_dai_link_component *)(link + 1);
1900 
1901 	link->cpus	= &dlc[0];
1902 	link->codecs	= &dlc[1];
1903 	link->platforms	= &dlc[2];
1904 
1905 	link->num_cpus	 = 1;
1906 	link->num_codecs = 1;
1907 	link->num_platforms = 1;
1908 
1909 	if (strlen(pcm->pcm_name)) {
1910 		link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1911 		link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1912 	}
1913 	link->id = le32_to_cpu(pcm->pcm_id);
1914 
1915 	if (strlen(pcm->dai_name))
1916 		link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1917 
1918 	link->codecs->name = "snd-soc-dummy";
1919 	link->codecs->dai_name = "snd-soc-dummy-dai";
1920 
1921 	link->platforms->name = "snd-soc-dummy";
1922 
1923 	/* enable DPCM */
1924 	link->dynamic = 1;
1925 	link->dpcm_playback = le32_to_cpu(pcm->playback);
1926 	link->dpcm_capture = le32_to_cpu(pcm->capture);
1927 	if (pcm->flag_mask)
1928 		set_link_flags(link,
1929 			       le32_to_cpu(pcm->flag_mask),
1930 			       le32_to_cpu(pcm->flags));
1931 
1932 	/* pass control to component driver for optional further init */
1933 	ret = soc_tplg_dai_link_load(tplg, link, NULL);
1934 	if (ret < 0) {
1935 		dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1936 		kfree(link->name);
1937 		kfree(link->stream_name);
1938 		kfree(link->cpus->dai_name);
1939 		kfree(link);
1940 		return ret;
1941 	}
1942 
1943 	link->dobj.index = tplg->index;
1944 	link->dobj.ops = tplg->ops;
1945 	link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1946 	list_add(&link->dobj.list, &tplg->comp->dobj_list);
1947 
1948 	snd_soc_add_dai_link(tplg->comp->card, link);
1949 	return 0;
1950 }
1951 
1952 /* create a FE DAI and DAI link from the PCM object */
1953 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1954 	struct snd_soc_tplg_pcm *pcm)
1955 {
1956 	int ret;
1957 
1958 	ret = soc_tplg_dai_create(tplg, pcm);
1959 	if (ret < 0)
1960 		return ret;
1961 
1962 	return  soc_tplg_fe_link_create(tplg, pcm);
1963 }
1964 
1965 /* copy stream caps from the old version 4 of source */
1966 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1967 				struct snd_soc_tplg_stream_caps_v4 *src)
1968 {
1969 	dest->size = cpu_to_le32(sizeof(*dest));
1970 	memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1971 	dest->formats = src->formats;
1972 	dest->rates = src->rates;
1973 	dest->rate_min = src->rate_min;
1974 	dest->rate_max = src->rate_max;
1975 	dest->channels_min = src->channels_min;
1976 	dest->channels_max = src->channels_max;
1977 	dest->periods_min = src->periods_min;
1978 	dest->periods_max = src->periods_max;
1979 	dest->period_size_min = src->period_size_min;
1980 	dest->period_size_max = src->period_size_max;
1981 	dest->buffer_size_min = src->buffer_size_min;
1982 	dest->buffer_size_max = src->buffer_size_max;
1983 }
1984 
1985 /**
1986  * pcm_new_ver - Create the new version of PCM from the old version.
1987  * @tplg: topology context
1988  * @src: older version of pcm as a source
1989  * @pcm: latest version of pcm created from the source
1990  *
1991  * Support from vesion 4. User should free the returned pcm manually.
1992  */
1993 static int pcm_new_ver(struct soc_tplg *tplg,
1994 		       struct snd_soc_tplg_pcm *src,
1995 		       struct snd_soc_tplg_pcm **pcm)
1996 {
1997 	struct snd_soc_tplg_pcm *dest;
1998 	struct snd_soc_tplg_pcm_v4 *src_v4;
1999 	int i;
2000 
2001 	*pcm = NULL;
2002 
2003 	if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2004 		dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2005 		return -EINVAL;
2006 	}
2007 
2008 	dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2009 	src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2010 	dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2011 	if (!dest)
2012 		return -ENOMEM;
2013 
2014 	dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2015 	memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2016 	memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2017 	dest->pcm_id = src_v4->pcm_id;
2018 	dest->dai_id = src_v4->dai_id;
2019 	dest->playback = src_v4->playback;
2020 	dest->capture = src_v4->capture;
2021 	dest->compress = src_v4->compress;
2022 	dest->num_streams = src_v4->num_streams;
2023 	for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2024 		memcpy(&dest->stream[i], &src_v4->stream[i],
2025 		       sizeof(struct snd_soc_tplg_stream));
2026 
2027 	for (i = 0; i < 2; i++)
2028 		stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2029 
2030 	*pcm = dest;
2031 	return 0;
2032 }
2033 
2034 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2035 	struct snd_soc_tplg_hdr *hdr)
2036 {
2037 	struct snd_soc_tplg_pcm *pcm, *_pcm;
2038 	int count;
2039 	int size;
2040 	int i;
2041 	bool abi_match;
2042 
2043 	count = le32_to_cpu(hdr->count);
2044 
2045 	if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
2046 		return 0;
2047 
2048 	/* check the element size and count */
2049 	pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2050 	size = le32_to_cpu(pcm->size);
2051 	if (size > sizeof(struct snd_soc_tplg_pcm)
2052 		|| size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2053 		dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2054 			size);
2055 		return -EINVAL;
2056 	}
2057 
2058 	if (soc_tplg_check_elem_count(tplg,
2059 				      size, count,
2060 				      le32_to_cpu(hdr->payload_size),
2061 				      "PCM DAI")) {
2062 		dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2063 			count);
2064 		return -EINVAL;
2065 	}
2066 
2067 	for (i = 0; i < count; i++) {
2068 		pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2069 		size = le32_to_cpu(pcm->size);
2070 
2071 		/* check ABI version by size, create a new version of pcm
2072 		 * if abi not match.
2073 		 */
2074 		if (size == sizeof(*pcm)) {
2075 			abi_match = true;
2076 			_pcm = pcm;
2077 		} else {
2078 			abi_match = false;
2079 			pcm_new_ver(tplg, pcm, &_pcm);
2080 		}
2081 
2082 		/* create the FE DAIs and DAI links */
2083 		soc_tplg_pcm_create(tplg, _pcm);
2084 
2085 		/* offset by version-specific struct size and
2086 		 * real priv data size
2087 		 */
2088 		tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2089 
2090 		if (!abi_match)
2091 			kfree(_pcm); /* free the duplicated one */
2092 	}
2093 
2094 	dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2095 
2096 	return 0;
2097 }
2098 
2099 /**
2100  * set_link_hw_format - Set the HW audio format of the physical DAI link.
2101  * @link: &snd_soc_dai_link which should be updated
2102  * @cfg: physical link configs.
2103  *
2104  * Topology context contains a list of supported HW formats (configs) and
2105  * a default format ID for the physical link. This function will use this
2106  * default ID to choose the HW format to set the link's DAI format for init.
2107  */
2108 static void set_link_hw_format(struct snd_soc_dai_link *link,
2109 			struct snd_soc_tplg_link_config *cfg)
2110 {
2111 	struct snd_soc_tplg_hw_config *hw_config;
2112 	unsigned char bclk_master, fsync_master;
2113 	unsigned char invert_bclk, invert_fsync;
2114 	int i;
2115 
2116 	for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2117 		hw_config = &cfg->hw_config[i];
2118 		if (hw_config->id != cfg->default_hw_config_id)
2119 			continue;
2120 
2121 		link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2122 			SND_SOC_DAIFMT_FORMAT_MASK;
2123 
2124 		/* clock gating */
2125 		switch (hw_config->clock_gated) {
2126 		case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2127 			link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2128 			break;
2129 
2130 		case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2131 			link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2132 			break;
2133 
2134 		default:
2135 			/* ignore the value */
2136 			break;
2137 		}
2138 
2139 		/* clock signal polarity */
2140 		invert_bclk = hw_config->invert_bclk;
2141 		invert_fsync = hw_config->invert_fsync;
2142 		if (!invert_bclk && !invert_fsync)
2143 			link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2144 		else if (!invert_bclk && invert_fsync)
2145 			link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2146 		else if (invert_bclk && !invert_fsync)
2147 			link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2148 		else
2149 			link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2150 
2151 		/* clock masters */
2152 		bclk_master = (hw_config->bclk_master ==
2153 			       SND_SOC_TPLG_BCLK_CM);
2154 		fsync_master = (hw_config->fsync_master ==
2155 				SND_SOC_TPLG_FSYNC_CM);
2156 		if (bclk_master && fsync_master)
2157 			link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2158 		else if (!bclk_master && fsync_master)
2159 			link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2160 		else if (bclk_master && !fsync_master)
2161 			link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2162 		else
2163 			link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2164 	}
2165 }
2166 
2167 /**
2168  * link_new_ver - Create a new physical link config from the old
2169  * version of source.
2170  * @tplg: topology context
2171  * @src: old version of phyical link config as a source
2172  * @link: latest version of physical link config created from the source
2173  *
2174  * Support from vesion 4. User need free the returned link config manually.
2175  */
2176 static int link_new_ver(struct soc_tplg *tplg,
2177 			struct snd_soc_tplg_link_config *src,
2178 			struct snd_soc_tplg_link_config **link)
2179 {
2180 	struct snd_soc_tplg_link_config *dest;
2181 	struct snd_soc_tplg_link_config_v4 *src_v4;
2182 	int i;
2183 
2184 	*link = NULL;
2185 
2186 	if (le32_to_cpu(src->size) !=
2187 	    sizeof(struct snd_soc_tplg_link_config_v4)) {
2188 		dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2189 		return -EINVAL;
2190 	}
2191 
2192 	dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2193 
2194 	src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2195 	dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2196 	if (!dest)
2197 		return -ENOMEM;
2198 
2199 	dest->size = cpu_to_le32(sizeof(*dest));
2200 	dest->id = src_v4->id;
2201 	dest->num_streams = src_v4->num_streams;
2202 	for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2203 		memcpy(&dest->stream[i], &src_v4->stream[i],
2204 		       sizeof(struct snd_soc_tplg_stream));
2205 
2206 	*link = dest;
2207 	return 0;
2208 }
2209 
2210 /* Find and configure an existing physical DAI link */
2211 static int soc_tplg_link_config(struct soc_tplg *tplg,
2212 	struct snd_soc_tplg_link_config *cfg)
2213 {
2214 	struct snd_soc_dai_link *link;
2215 	const char *name, *stream_name;
2216 	size_t len;
2217 	int ret;
2218 
2219 	len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2220 	if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2221 		return -EINVAL;
2222 	else if (len)
2223 		name = cfg->name;
2224 	else
2225 		name = NULL;
2226 
2227 	len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2228 	if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2229 		return -EINVAL;
2230 	else if (len)
2231 		stream_name = cfg->stream_name;
2232 	else
2233 		stream_name = NULL;
2234 
2235 	link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2236 				     name, stream_name);
2237 	if (!link) {
2238 		dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2239 			name, cfg->id);
2240 		return -EINVAL;
2241 	}
2242 
2243 	/* hw format */
2244 	if (cfg->num_hw_configs)
2245 		set_link_hw_format(link, cfg);
2246 
2247 	/* flags */
2248 	if (cfg->flag_mask)
2249 		set_link_flags(link,
2250 			       le32_to_cpu(cfg->flag_mask),
2251 			       le32_to_cpu(cfg->flags));
2252 
2253 	/* pass control to component driver for optional further init */
2254 	ret = soc_tplg_dai_link_load(tplg, link, cfg);
2255 	if (ret < 0) {
2256 		dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2257 		return ret;
2258 	}
2259 
2260 	/* for unloading it in snd_soc_tplg_component_remove */
2261 	link->dobj.index = tplg->index;
2262 	link->dobj.ops = tplg->ops;
2263 	link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2264 	list_add(&link->dobj.list, &tplg->comp->dobj_list);
2265 
2266 	return 0;
2267 }
2268 
2269 
2270 /* Load physical link config elements from the topology context */
2271 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2272 	struct snd_soc_tplg_hdr *hdr)
2273 {
2274 	struct snd_soc_tplg_link_config *link, *_link;
2275 	int count;
2276 	int size;
2277 	int i, ret;
2278 	bool abi_match;
2279 
2280 	count = le32_to_cpu(hdr->count);
2281 
2282 	if (tplg->pass != SOC_TPLG_PASS_LINK) {
2283 		tplg->pos += le32_to_cpu(hdr->size) +
2284 			le32_to_cpu(hdr->payload_size);
2285 		return 0;
2286 	};
2287 
2288 	/* check the element size and count */
2289 	link = (struct snd_soc_tplg_link_config *)tplg->pos;
2290 	size = le32_to_cpu(link->size);
2291 	if (size > sizeof(struct snd_soc_tplg_link_config)
2292 		|| size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2293 		dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2294 			size);
2295 		return -EINVAL;
2296 	}
2297 
2298 	if (soc_tplg_check_elem_count(tplg,
2299 				      size, count,
2300 				      le32_to_cpu(hdr->payload_size),
2301 				      "physical link config")) {
2302 		dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2303 			count);
2304 		return -EINVAL;
2305 	}
2306 
2307 	/* config physical DAI links */
2308 	for (i = 0; i < count; i++) {
2309 		link = (struct snd_soc_tplg_link_config *)tplg->pos;
2310 		size = le32_to_cpu(link->size);
2311 		if (size == sizeof(*link)) {
2312 			abi_match = true;
2313 			_link = link;
2314 		} else {
2315 			abi_match = false;
2316 			ret = link_new_ver(tplg, link, &_link);
2317 			if (ret < 0)
2318 				return ret;
2319 		}
2320 
2321 		ret = soc_tplg_link_config(tplg, _link);
2322 		if (ret < 0)
2323 			return ret;
2324 
2325 		/* offset by version-specific struct size and
2326 		 * real priv data size
2327 		 */
2328 		tplg->pos += size + le32_to_cpu(_link->priv.size);
2329 
2330 		if (!abi_match)
2331 			kfree(_link); /* free the duplicated one */
2332 	}
2333 
2334 	return 0;
2335 }
2336 
2337 /**
2338  * soc_tplg_dai_config - Find and configure an existing physical DAI.
2339  * @tplg: topology context
2340  * @d: physical DAI configs.
2341  *
2342  * The physical dai should already be registered by the platform driver.
2343  * The platform driver should specify the DAI name and ID for matching.
2344  */
2345 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2346 			       struct snd_soc_tplg_dai *d)
2347 {
2348 	struct snd_soc_dai_link_component dai_component;
2349 	struct snd_soc_dai *dai;
2350 	struct snd_soc_dai_driver *dai_drv;
2351 	struct snd_soc_pcm_stream *stream;
2352 	struct snd_soc_tplg_stream_caps *caps;
2353 	int ret;
2354 
2355 	memset(&dai_component, 0, sizeof(dai_component));
2356 
2357 	dai_component.dai_name = d->dai_name;
2358 	dai = snd_soc_find_dai(&dai_component);
2359 	if (!dai) {
2360 		dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2361 			d->dai_name);
2362 		return -EINVAL;
2363 	}
2364 
2365 	if (le32_to_cpu(d->dai_id) != dai->id) {
2366 		dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2367 			d->dai_name);
2368 		return -EINVAL;
2369 	}
2370 
2371 	dai_drv = dai->driver;
2372 	if (!dai_drv)
2373 		return -EINVAL;
2374 
2375 	if (d->playback) {
2376 		stream = &dai_drv->playback;
2377 		caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2378 		set_stream_info(stream, caps);
2379 	}
2380 
2381 	if (d->capture) {
2382 		stream = &dai_drv->capture;
2383 		caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2384 		set_stream_info(stream, caps);
2385 	}
2386 
2387 	if (d->flag_mask)
2388 		set_dai_flags(dai_drv,
2389 			      le32_to_cpu(d->flag_mask),
2390 			      le32_to_cpu(d->flags));
2391 
2392 	/* pass control to component driver for optional further init */
2393 	ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2394 	if (ret < 0) {
2395 		dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2396 		return ret;
2397 	}
2398 
2399 	return 0;
2400 }
2401 
2402 /* load physical DAI elements */
2403 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2404 				   struct snd_soc_tplg_hdr *hdr)
2405 {
2406 	struct snd_soc_tplg_dai *dai;
2407 	int count;
2408 	int i;
2409 
2410 	count = le32_to_cpu(hdr->count);
2411 
2412 	if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2413 		return 0;
2414 
2415 	/* config the existing BE DAIs */
2416 	for (i = 0; i < count; i++) {
2417 		dai = (struct snd_soc_tplg_dai *)tplg->pos;
2418 		if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2419 			dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2420 			return -EINVAL;
2421 		}
2422 
2423 		soc_tplg_dai_config(tplg, dai);
2424 		tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2425 	}
2426 
2427 	dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2428 	return 0;
2429 }
2430 
2431 /**
2432  * manifest_new_ver - Create a new version of manifest from the old version
2433  * of source.
2434  * @tplg: topology context
2435  * @src: old version of manifest as a source
2436  * @manifest: latest version of manifest created from the source
2437  *
2438  * Support from vesion 4. Users need free the returned manifest manually.
2439  */
2440 static int manifest_new_ver(struct soc_tplg *tplg,
2441 			    struct snd_soc_tplg_manifest *src,
2442 			    struct snd_soc_tplg_manifest **manifest)
2443 {
2444 	struct snd_soc_tplg_manifest *dest;
2445 	struct snd_soc_tplg_manifest_v4 *src_v4;
2446 	int size;
2447 
2448 	*manifest = NULL;
2449 
2450 	size = le32_to_cpu(src->size);
2451 	if (size != sizeof(*src_v4)) {
2452 		dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2453 			 size);
2454 		if (size)
2455 			return -EINVAL;
2456 		src->size = cpu_to_le32(sizeof(*src_v4));
2457 	}
2458 
2459 	dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2460 
2461 	src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2462 	dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2463 		       GFP_KERNEL);
2464 	if (!dest)
2465 		return -ENOMEM;
2466 
2467 	dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2468 	dest->control_elems = src_v4->control_elems;
2469 	dest->widget_elems = src_v4->widget_elems;
2470 	dest->graph_elems = src_v4->graph_elems;
2471 	dest->pcm_elems = src_v4->pcm_elems;
2472 	dest->dai_link_elems = src_v4->dai_link_elems;
2473 	dest->priv.size = src_v4->priv.size;
2474 	if (dest->priv.size)
2475 		memcpy(dest->priv.data, src_v4->priv.data,
2476 		       le32_to_cpu(src_v4->priv.size));
2477 
2478 	*manifest = dest;
2479 	return 0;
2480 }
2481 
2482 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2483 				  struct snd_soc_tplg_hdr *hdr)
2484 {
2485 	struct snd_soc_tplg_manifest *manifest, *_manifest;
2486 	bool abi_match;
2487 	int err;
2488 
2489 	if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2490 		return 0;
2491 
2492 	manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2493 
2494 	/* check ABI version by size, create a new manifest if abi not match */
2495 	if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2496 		abi_match = true;
2497 		_manifest = manifest;
2498 	} else {
2499 		abi_match = false;
2500 		err = manifest_new_ver(tplg, manifest, &_manifest);
2501 		if (err < 0)
2502 			return err;
2503 	}
2504 
2505 	/* pass control to component driver for optional further init */
2506 	if (tplg->comp && tplg->ops && tplg->ops->manifest)
2507 		return tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2508 
2509 	if (!abi_match)	/* free the duplicated one */
2510 		kfree(_manifest);
2511 
2512 	return 0;
2513 }
2514 
2515 /* validate header magic, size and type */
2516 static int soc_valid_header(struct soc_tplg *tplg,
2517 	struct snd_soc_tplg_hdr *hdr)
2518 {
2519 	if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2520 		return 0;
2521 
2522 	if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2523 		dev_err(tplg->dev,
2524 			"ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2525 			le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2526 			tplg->fw->size);
2527 		return -EINVAL;
2528 	}
2529 
2530 	/* big endian firmware objects not supported atm */
2531 	if (hdr->magic == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2532 		dev_err(tplg->dev,
2533 			"ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2534 			tplg->pass, hdr->magic,
2535 			soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2536 		return -EINVAL;
2537 	}
2538 
2539 	if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2540 		dev_err(tplg->dev,
2541 			"ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2542 			tplg->pass, hdr->magic,
2543 			soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2544 		return -EINVAL;
2545 	}
2546 
2547 	/* Support ABI from version 4 */
2548 	if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2549 	    le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2550 		dev_err(tplg->dev,
2551 			"ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2552 			tplg->pass, hdr->abi,
2553 			SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2554 			tplg->fw->size);
2555 		return -EINVAL;
2556 	}
2557 
2558 	if (hdr->payload_size == 0) {
2559 		dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2560 			soc_tplg_get_hdr_offset(tplg));
2561 		return -EINVAL;
2562 	}
2563 
2564 	if (tplg->pass == le32_to_cpu(hdr->type))
2565 		dev_dbg(tplg->dev,
2566 			"ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2567 			hdr->payload_size, hdr->type, hdr->version,
2568 			hdr->vendor_type, tplg->pass);
2569 
2570 	return 1;
2571 }
2572 
2573 /* check header type and call appropriate handler */
2574 static int soc_tplg_load_header(struct soc_tplg *tplg,
2575 	struct snd_soc_tplg_hdr *hdr)
2576 {
2577 	tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2578 
2579 	/* check for matching ID */
2580 	if (le32_to_cpu(hdr->index) != tplg->req_index &&
2581 		tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2582 		return 0;
2583 
2584 	tplg->index = le32_to_cpu(hdr->index);
2585 
2586 	switch (le32_to_cpu(hdr->type)) {
2587 	case SND_SOC_TPLG_TYPE_MIXER:
2588 	case SND_SOC_TPLG_TYPE_ENUM:
2589 	case SND_SOC_TPLG_TYPE_BYTES:
2590 		return soc_tplg_kcontrol_elems_load(tplg, hdr);
2591 	case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2592 		return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2593 	case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2594 		return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2595 	case SND_SOC_TPLG_TYPE_PCM:
2596 		return soc_tplg_pcm_elems_load(tplg, hdr);
2597 	case SND_SOC_TPLG_TYPE_DAI:
2598 		return soc_tplg_dai_elems_load(tplg, hdr);
2599 	case SND_SOC_TPLG_TYPE_DAI_LINK:
2600 	case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2601 		/* physical link configurations */
2602 		return soc_tplg_link_elems_load(tplg, hdr);
2603 	case SND_SOC_TPLG_TYPE_MANIFEST:
2604 		return soc_tplg_manifest_load(tplg, hdr);
2605 	default:
2606 		/* bespoke vendor data object */
2607 		return soc_tplg_vendor_load(tplg, hdr);
2608 	}
2609 
2610 	return 0;
2611 }
2612 
2613 /* process the topology file headers */
2614 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2615 {
2616 	struct snd_soc_tplg_hdr *hdr;
2617 	int ret;
2618 
2619 	tplg->pass = SOC_TPLG_PASS_START;
2620 
2621 	/* process the header types from start to end */
2622 	while (tplg->pass <= SOC_TPLG_PASS_END) {
2623 
2624 		tplg->hdr_pos = tplg->fw->data;
2625 		hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2626 
2627 		while (!soc_tplg_is_eof(tplg)) {
2628 
2629 			/* make sure header is valid before loading */
2630 			ret = soc_valid_header(tplg, hdr);
2631 			if (ret < 0)
2632 				return ret;
2633 			else if (ret == 0)
2634 				break;
2635 
2636 			/* load the header object */
2637 			ret = soc_tplg_load_header(tplg, hdr);
2638 			if (ret < 0)
2639 				return ret;
2640 
2641 			/* goto next header */
2642 			tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2643 				sizeof(struct snd_soc_tplg_hdr);
2644 			hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2645 		}
2646 
2647 		/* next data type pass */
2648 		tplg->pass++;
2649 	}
2650 
2651 	/* signal DAPM we are complete */
2652 	ret = soc_tplg_dapm_complete(tplg);
2653 	if (ret < 0)
2654 		dev_err(tplg->dev,
2655 			"ASoC: failed to initialise DAPM from Firmware\n");
2656 
2657 	return ret;
2658 }
2659 
2660 static int soc_tplg_load(struct soc_tplg *tplg)
2661 {
2662 	int ret;
2663 
2664 	ret = soc_tplg_process_headers(tplg);
2665 	if (ret == 0)
2666 		soc_tplg_complete(tplg);
2667 
2668 	return ret;
2669 }
2670 
2671 /* load audio component topology from "firmware" file */
2672 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2673 	struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2674 {
2675 	struct soc_tplg tplg;
2676 	int ret;
2677 
2678 	/* setup parsing context */
2679 	memset(&tplg, 0, sizeof(tplg));
2680 	tplg.fw = fw;
2681 	tplg.dev = comp->dev;
2682 	tplg.comp = comp;
2683 	tplg.ops = ops;
2684 	tplg.req_index = id;
2685 	tplg.io_ops = ops->io_ops;
2686 	tplg.io_ops_count = ops->io_ops_count;
2687 	tplg.bytes_ext_ops = ops->bytes_ext_ops;
2688 	tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2689 
2690 	ret = soc_tplg_load(&tplg);
2691 	/* free the created components if fail to load topology */
2692 	if (ret)
2693 		snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2694 
2695 	return ret;
2696 }
2697 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2698 
2699 /* remove this dynamic widget */
2700 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2701 {
2702 	/* make sure we are a widget */
2703 	if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2704 		return;
2705 
2706 	remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2707 }
2708 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2709 
2710 /* remove all dynamic widgets from this DAPM context */
2711 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2712 	u32 index)
2713 {
2714 	struct snd_soc_dapm_widget *w, *next_w;
2715 
2716 	list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2717 
2718 		/* make sure we are a widget with correct context */
2719 		if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2720 			continue;
2721 
2722 		/* match ID */
2723 		if (w->dobj.index != index &&
2724 			w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2725 			continue;
2726 		/* check and free and dynamic widget kcontrols */
2727 		snd_soc_tplg_widget_remove(w);
2728 		snd_soc_dapm_free_widget(w);
2729 	}
2730 	snd_soc_dapm_reset_cache(dapm);
2731 }
2732 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2733 
2734 /* remove dynamic controls from the component driver */
2735 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2736 {
2737 	struct snd_soc_dobj *dobj, *next_dobj;
2738 	int pass = SOC_TPLG_PASS_END;
2739 
2740 	/* process the header types from end to start */
2741 	while (pass >= SOC_TPLG_PASS_START) {
2742 
2743 		/* remove mixer controls */
2744 		list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2745 			list) {
2746 
2747 			/* match index */
2748 			if (dobj->index != index &&
2749 				index != SND_SOC_TPLG_INDEX_ALL)
2750 				continue;
2751 
2752 			switch (dobj->type) {
2753 			case SND_SOC_DOBJ_MIXER:
2754 				remove_mixer(comp, dobj, pass);
2755 				break;
2756 			case SND_SOC_DOBJ_ENUM:
2757 				remove_enum(comp, dobj, pass);
2758 				break;
2759 			case SND_SOC_DOBJ_BYTES:
2760 				remove_bytes(comp, dobj, pass);
2761 				break;
2762 			case SND_SOC_DOBJ_GRAPH:
2763 				remove_route(comp, dobj, pass);
2764 				break;
2765 			case SND_SOC_DOBJ_WIDGET:
2766 				remove_widget(comp, dobj, pass);
2767 				break;
2768 			case SND_SOC_DOBJ_PCM:
2769 				remove_dai(comp, dobj, pass);
2770 				break;
2771 			case SND_SOC_DOBJ_DAI_LINK:
2772 				remove_link(comp, dobj, pass);
2773 				break;
2774 			case SND_SOC_DOBJ_BACKEND_LINK:
2775 				/*
2776 				 * call link_unload ops if extra
2777 				 * deinitialization is needed.
2778 				 */
2779 				remove_backend_link(comp, dobj, pass);
2780 				break;
2781 			default:
2782 				dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2783 					dobj->type);
2784 				break;
2785 			}
2786 		}
2787 		pass--;
2788 	}
2789 
2790 	/* let caller know if FW can be freed when no objects are left */
2791 	return !list_empty(&comp->dobj_list);
2792 }
2793 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);
2794