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