xref: /linux/sound/soc/soc-topology.c (revision 3f41368fbfe1b3d5922d317fe1a0a0cab6846802)
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 	struct snd_soc_tplg_dapm_graph_elem *elem;
1025 	struct snd_soc_dapm_route *route;
1026 	int count, i;
1027 	int ret = 0;
1028 
1029 	count = le32_to_cpu(hdr->count);
1030 
1031 	if (soc_tplg_check_elem_count(tplg,
1032 				      sizeof(struct snd_soc_tplg_dapm_graph_elem),
1033 				      count, le32_to_cpu(hdr->payload_size), "graph"))
1034 		return -EINVAL;
1035 
1036 	dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1037 		hdr->index);
1038 
1039 	for (i = 0; i < count; i++) {
1040 		route = devm_kzalloc(tplg->dev, sizeof(*route), GFP_KERNEL);
1041 		if (!route)
1042 			return -ENOMEM;
1043 		elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1044 		tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1045 
1046 		/* validate routes */
1047 		if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1048 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1049 			ret = -EINVAL;
1050 			break;
1051 		}
1052 		if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1053 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1054 			ret = -EINVAL;
1055 			break;
1056 		}
1057 		if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1058 			    SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1059 			ret = -EINVAL;
1060 			break;
1061 		}
1062 
1063 		route->source = elem->source;
1064 		route->sink = elem->sink;
1065 
1066 		/* set to NULL atm for tplg users */
1067 		route->connected = NULL;
1068 		if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1069 			route->control = NULL;
1070 		else
1071 			route->control = elem->control;
1072 
1073 		/* add route dobj to dobj_list */
1074 		route->dobj.type = SND_SOC_DOBJ_GRAPH;
1075 		if (tplg->ops)
1076 			route->dobj.unload = tplg->ops->dapm_route_unload;
1077 		route->dobj.index = tplg->index;
1078 		list_add(&route->dobj.list, &tplg->comp->dobj_list);
1079 
1080 		ret = soc_tplg_add_route(tplg, route);
1081 		if (ret < 0) {
1082 			dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1083 			break;
1084 		}
1085 
1086 		ret = snd_soc_dapm_add_routes(dapm, route, 1);
1087 		if (ret) {
1088 			if (!dapm->card->disable_route_checks) {
1089 				dev_err(tplg->dev, "ASoC: dapm_add_routes failed: %d\n", ret);
1090 				break;
1091 			}
1092 			dev_info(tplg->dev,
1093 				 "ASoC: disable_route_checks set, ignoring dapm_add_routes errors\n");
1094 		}
1095 	}
1096 
1097 	return ret;
1098 }
1099 
1100 static int soc_tplg_dapm_widget_dmixer_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1101 {
1102 	struct soc_mixer_control *sm;
1103 	struct snd_soc_tplg_mixer_control *mc;
1104 	int err;
1105 
1106 	mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1107 
1108 	/* validate kcontrol */
1109 	if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1110 	    SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1111 		return -EINVAL;
1112 
1113 	sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
1114 	if (!sm)
1115 		return -ENOMEM;
1116 
1117 	tplg->pos += sizeof(struct snd_soc_tplg_mixer_control) +
1118 		le32_to_cpu(mc->priv.size);
1119 
1120 	dev_dbg(tplg->dev, " adding DAPM widget mixer control %s\n",
1121 		mc->hdr.name);
1122 
1123 	kc->private_value = (long)sm;
1124 	kc->name = devm_kstrdup(tplg->dev, mc->hdr.name, GFP_KERNEL);
1125 	if (!kc->name)
1126 		return -ENOMEM;
1127 	kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1128 	kc->access = le32_to_cpu(mc->hdr.access);
1129 
1130 	/* we only support FL/FR channel mapping atm */
1131 	sm->reg = tplg_chan_get_reg(tplg, mc->channel,
1132 				    SNDRV_CHMAP_FL);
1133 	sm->rreg = tplg_chan_get_reg(tplg, mc->channel,
1134 				     SNDRV_CHMAP_FR);
1135 	sm->shift = tplg_chan_get_shift(tplg, mc->channel,
1136 					SNDRV_CHMAP_FL);
1137 	sm->rshift = tplg_chan_get_shift(tplg, mc->channel,
1138 					 SNDRV_CHMAP_FR);
1139 
1140 	sm->max = le32_to_cpu(mc->max);
1141 	sm->min = le32_to_cpu(mc->min);
1142 	sm->invert = le32_to_cpu(mc->invert);
1143 	sm->platform_max = le32_to_cpu(mc->platform_max);
1144 	sm->dobj.index = tplg->index;
1145 	INIT_LIST_HEAD(&sm->dobj.list);
1146 
1147 	/* map io handlers */
1148 	err = soc_tplg_kcontrol_bind_io(&mc->hdr, kc, tplg);
1149 	if (err) {
1150 		soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1151 		return err;
1152 	}
1153 
1154 	/* create any TLV data */
1155 	err = soc_tplg_create_tlv(tplg, kc, &mc->hdr);
1156 	if (err < 0) {
1157 		dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1158 			mc->hdr.name);
1159 		return err;
1160 	}
1161 
1162 	/* pass control to driver for optional further init */
1163 	err = soc_tplg_control_load(tplg, kc, &mc->hdr);
1164 	if (err < 0)
1165 		return err;
1166 
1167 	return 0;
1168 }
1169 
1170 static int soc_tplg_dapm_widget_denum_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1171 {
1172 	struct snd_soc_tplg_enum_control *ec;
1173 	struct soc_enum *se;
1174 	int err;
1175 
1176 	ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1177 	/* validate kcontrol */
1178 	if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1179 	    SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1180 		return -EINVAL;
1181 
1182 	se = devm_kzalloc(tplg->dev, sizeof(*se), GFP_KERNEL);
1183 	if (!se)
1184 		return -ENOMEM;
1185 
1186 	tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1187 		      le32_to_cpu(ec->priv.size));
1188 
1189 	dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1190 		ec->hdr.name);
1191 
1192 	kc->private_value = (long)se;
1193 	kc->name = devm_kstrdup(tplg->dev, ec->hdr.name, GFP_KERNEL);
1194 	if (!kc->name)
1195 		return -ENOMEM;
1196 	kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1197 	kc->access = le32_to_cpu(ec->hdr.access);
1198 
1199 	/* we only support FL/FR channel mapping atm */
1200 	se->reg = tplg_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1201 	se->shift_l = tplg_chan_get_shift(tplg, ec->channel,
1202 					  SNDRV_CHMAP_FL);
1203 	se->shift_r = tplg_chan_get_shift(tplg, ec->channel,
1204 					  SNDRV_CHMAP_FR);
1205 
1206 	se->items = le32_to_cpu(ec->items);
1207 	se->mask = le32_to_cpu(ec->mask);
1208 	se->dobj.index = tplg->index;
1209 
1210 	switch (le32_to_cpu(ec->hdr.ops.info)) {
1211 	case SND_SOC_TPLG_CTL_ENUM_VALUE:
1212 	case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1213 		err = soc_tplg_denum_create_values(tplg, se, ec);
1214 		if (err < 0) {
1215 			dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1216 				ec->hdr.name);
1217 			return err;
1218 		}
1219 		fallthrough;
1220 	case SND_SOC_TPLG_CTL_ENUM:
1221 	case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1222 	case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1223 		err = soc_tplg_denum_create_texts(tplg, se, ec);
1224 		if (err < 0) {
1225 			dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1226 				ec->hdr.name);
1227 			return err;
1228 		}
1229 		break;
1230 	default:
1231 		dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1232 			ec->hdr.ops.info, ec->hdr.name);
1233 		return -EINVAL;
1234 	}
1235 
1236 	/* map io handlers */
1237 	err = soc_tplg_kcontrol_bind_io(&ec->hdr, kc, tplg);
1238 	if (err) {
1239 		soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1240 		return err;
1241 	}
1242 
1243 	/* pass control to driver for optional further init */
1244 	err = soc_tplg_control_load(tplg, kc, &ec->hdr);
1245 	if (err < 0)
1246 		return err;
1247 
1248 	return 0;
1249 }
1250 
1251 static int soc_tplg_dapm_widget_dbytes_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1252 {
1253 	struct snd_soc_tplg_bytes_control *be;
1254 	struct soc_bytes_ext *sbe;
1255 	int err;
1256 
1257 	be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1258 
1259 	/* validate kcontrol */
1260 	if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1261 	    SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1262 		return -EINVAL;
1263 
1264 	sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
1265 	if (!sbe)
1266 		return -ENOMEM;
1267 
1268 	tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1269 		      le32_to_cpu(be->priv.size));
1270 
1271 	dev_dbg(tplg->dev,
1272 		"ASoC: adding bytes kcontrol %s with access 0x%x\n",
1273 		be->hdr.name, be->hdr.access);
1274 
1275 	kc->private_value = (long)sbe;
1276 	kc->name = devm_kstrdup(tplg->dev, be->hdr.name, GFP_KERNEL);
1277 	if (!kc->name)
1278 		return -ENOMEM;
1279 	kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1280 	kc->access = le32_to_cpu(be->hdr.access);
1281 
1282 	sbe->max = le32_to_cpu(be->max);
1283 	INIT_LIST_HEAD(&sbe->dobj.list);
1284 
1285 	/* map standard io handlers and check for external handlers */
1286 	err = soc_tplg_kcontrol_bind_io(&be->hdr, kc, tplg);
1287 	if (err) {
1288 		soc_control_err(tplg, &be->hdr, be->hdr.name);
1289 		return err;
1290 	}
1291 
1292 	/* pass control to driver for optional further init */
1293 	err = soc_tplg_control_load(tplg, kc, &be->hdr);
1294 	if (err < 0)
1295 		return err;
1296 
1297 	return 0;
1298 }
1299 
1300 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1301 	struct snd_soc_tplg_dapm_widget *w)
1302 {
1303 	struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1304 	struct snd_soc_dapm_widget template, *widget;
1305 	struct snd_soc_tplg_ctl_hdr *control_hdr;
1306 	struct snd_soc_card *card = tplg->comp->card;
1307 	unsigned int *kcontrol_type = NULL;
1308 	struct snd_kcontrol_new *kc;
1309 	int mixer_count = 0;
1310 	int bytes_count = 0;
1311 	int enum_count = 0;
1312 	int ret = 0;
1313 	int i;
1314 
1315 	if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1316 		SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1317 		return -EINVAL;
1318 	if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1319 		SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1320 		return -EINVAL;
1321 
1322 	dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1323 		w->name, w->id);
1324 
1325 	memset(&template, 0, sizeof(template));
1326 
1327 	/* map user to kernel widget ID */
1328 	template.id = get_widget_id(le32_to_cpu(w->id));
1329 	if ((int)template.id < 0)
1330 		return template.id;
1331 
1332 	/* strings are allocated here, but used and freed by the widget */
1333 	template.name = kstrdup(w->name, GFP_KERNEL);
1334 	if (!template.name)
1335 		return -ENOMEM;
1336 	template.sname = kstrdup(w->sname, GFP_KERNEL);
1337 	if (!template.sname) {
1338 		ret = -ENOMEM;
1339 		goto err;
1340 	}
1341 	template.reg = le32_to_cpu(w->reg);
1342 	template.shift = le32_to_cpu(w->shift);
1343 	template.mask = le32_to_cpu(w->mask);
1344 	template.subseq = le32_to_cpu(w->subseq);
1345 	template.on_val = w->invert ? 0 : 1;
1346 	template.off_val = w->invert ? 1 : 0;
1347 	template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1348 	template.event_flags = le16_to_cpu(w->event_flags);
1349 	template.dobj.index = tplg->index;
1350 
1351 	tplg->pos +=
1352 		(sizeof(struct snd_soc_tplg_dapm_widget) +
1353 		 le32_to_cpu(w->priv.size));
1354 
1355 	if (w->num_kcontrols == 0) {
1356 		template.num_kcontrols = 0;
1357 		goto widget;
1358 	}
1359 
1360 	template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1361 	kc = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(*kc), GFP_KERNEL);
1362 	if (!kc) {
1363 		ret = -ENOMEM;
1364 		goto hdr_err;
1365 	}
1366 
1367 	kcontrol_type = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(unsigned int),
1368 				     GFP_KERNEL);
1369 	if (!kcontrol_type) {
1370 		ret = -ENOMEM;
1371 		goto hdr_err;
1372 	}
1373 
1374 	for (i = 0; i < le32_to_cpu(w->num_kcontrols); i++) {
1375 		control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1376 		switch (le32_to_cpu(control_hdr->ops.info)) {
1377 		case SND_SOC_TPLG_CTL_VOLSW:
1378 		case SND_SOC_TPLG_CTL_STROBE:
1379 		case SND_SOC_TPLG_CTL_VOLSW_SX:
1380 		case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1381 		case SND_SOC_TPLG_CTL_RANGE:
1382 		case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1383 			/* volume mixer */
1384 			kc[i].index = mixer_count;
1385 			kcontrol_type[i] = SND_SOC_TPLG_TYPE_MIXER;
1386 			mixer_count++;
1387 			ret = soc_tplg_dapm_widget_dmixer_create(tplg, &kc[i]);
1388 			if (ret < 0)
1389 				goto hdr_err;
1390 			break;
1391 		case SND_SOC_TPLG_CTL_ENUM:
1392 		case SND_SOC_TPLG_CTL_ENUM_VALUE:
1393 		case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1394 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1395 		case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1396 			/* enumerated mixer */
1397 			kc[i].index = enum_count;
1398 			kcontrol_type[i] = SND_SOC_TPLG_TYPE_ENUM;
1399 			enum_count++;
1400 			ret = soc_tplg_dapm_widget_denum_create(tplg, &kc[i]);
1401 			if (ret < 0)
1402 				goto hdr_err;
1403 			break;
1404 		case SND_SOC_TPLG_CTL_BYTES:
1405 			/* bytes control */
1406 			kc[i].index = bytes_count;
1407 			kcontrol_type[i] = SND_SOC_TPLG_TYPE_BYTES;
1408 			bytes_count++;
1409 			ret = soc_tplg_dapm_widget_dbytes_create(tplg, &kc[i]);
1410 			if (ret < 0)
1411 				goto hdr_err;
1412 			break;
1413 		default:
1414 			dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1415 				control_hdr->ops.get, control_hdr->ops.put,
1416 				le32_to_cpu(control_hdr->ops.info));
1417 			ret = -EINVAL;
1418 			goto hdr_err;
1419 		}
1420 	}
1421 
1422 	template.kcontrol_news = kc;
1423 	dev_dbg(tplg->dev, "ASoC: template %s with %d/%d/%d (mixer/enum/bytes) control\n",
1424 		w->name, mixer_count, enum_count, bytes_count);
1425 
1426 widget:
1427 	ret = soc_tplg_widget_load(tplg, &template, w);
1428 	if (ret < 0)
1429 		goto hdr_err;
1430 
1431 	/* card dapm mutex is held by the core if we are loading topology
1432 	 * data during sound card init. */
1433 	if (snd_soc_card_is_instantiated(card))
1434 		widget = snd_soc_dapm_new_control(dapm, &template);
1435 	else
1436 		widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1437 	if (IS_ERR(widget)) {
1438 		ret = PTR_ERR(widget);
1439 		goto hdr_err;
1440 	}
1441 
1442 	widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1443 	widget->dobj.widget.kcontrol_type = kcontrol_type;
1444 	if (tplg->ops)
1445 		widget->dobj.unload = tplg->ops->widget_unload;
1446 	widget->dobj.index = tplg->index;
1447 	list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1448 
1449 	ret = soc_tplg_widget_ready(tplg, widget, w);
1450 	if (ret < 0)
1451 		goto ready_err;
1452 
1453 	kfree(template.sname);
1454 	kfree(template.name);
1455 
1456 	return 0;
1457 
1458 ready_err:
1459 	soc_tplg_remove_widget(widget->dapm->component, &widget->dobj, SOC_TPLG_PASS_WIDGET);
1460 	snd_soc_dapm_free_widget(widget);
1461 hdr_err:
1462 	kfree(template.sname);
1463 err:
1464 	kfree(template.name);
1465 	return ret;
1466 }
1467 
1468 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1469 	struct snd_soc_tplg_hdr *hdr)
1470 {
1471 	int count, i;
1472 
1473 	count = le32_to_cpu(hdr->count);
1474 
1475 	dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1476 
1477 	for (i = 0; i < count; i++) {
1478 		struct snd_soc_tplg_dapm_widget *widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1479 		int ret;
1480 
1481 		/*
1482 		 * check if widget itself fits within topology file
1483 		 * use sizeof instead of widget->size, as we can't be sure
1484 		 * it is set properly yet (file may end before it is present)
1485 		 */
1486 		if (soc_tplg_get_offset(tplg) + sizeof(*widget) >= tplg->fw->size) {
1487 			dev_err(tplg->dev, "ASoC: invalid widget data size\n");
1488 			return -EINVAL;
1489 		}
1490 
1491 		/* check if widget has proper size */
1492 		if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1493 			dev_err(tplg->dev, "ASoC: invalid widget size\n");
1494 			return -EINVAL;
1495 		}
1496 
1497 		/* check if widget private data fits within topology file */
1498 		if (soc_tplg_get_offset(tplg) + le32_to_cpu(widget->priv.size) >= tplg->fw->size) {
1499 			dev_err(tplg->dev, "ASoC: invalid widget private data size\n");
1500 			return -EINVAL;
1501 		}
1502 
1503 		ret = soc_tplg_dapm_widget_create(tplg, widget);
1504 		if (ret < 0) {
1505 			dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1506 				widget->name);
1507 			return ret;
1508 		}
1509 	}
1510 
1511 	return 0;
1512 }
1513 
1514 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1515 {
1516 	struct snd_soc_card *card = tplg->comp->card;
1517 	int ret;
1518 
1519 	/* Card might not have been registered at this point.
1520 	 * If so, just return success.
1521 	*/
1522 	if (!snd_soc_card_is_instantiated(card)) {
1523 		dev_warn(tplg->dev, "ASoC: Parent card not yet available, widget card binding deferred\n");
1524 		return 0;
1525 	}
1526 
1527 	ret = snd_soc_dapm_new_widgets(card);
1528 	if (ret < 0)
1529 		dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n", ret);
1530 
1531 	return ret;
1532 }
1533 
1534 static int set_stream_info(struct soc_tplg *tplg, struct snd_soc_pcm_stream *stream,
1535 			   struct snd_soc_tplg_stream_caps *caps)
1536 {
1537 	stream->stream_name = devm_kstrdup(tplg->dev, caps->name, GFP_KERNEL);
1538 	if (!stream->stream_name)
1539 		return -ENOMEM;
1540 
1541 	stream->channels_min = le32_to_cpu(caps->channels_min);
1542 	stream->channels_max = le32_to_cpu(caps->channels_max);
1543 	stream->rates = le32_to_cpu(caps->rates);
1544 	stream->rate_min = le32_to_cpu(caps->rate_min);
1545 	stream->rate_max = le32_to_cpu(caps->rate_max);
1546 	stream->formats = le64_to_cpu(caps->formats);
1547 	stream->sig_bits = le32_to_cpu(caps->sig_bits);
1548 
1549 	return 0;
1550 }
1551 
1552 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1553 			  unsigned int flag_mask, unsigned int flags)
1554 {
1555 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1556 		dai_drv->symmetric_rate =
1557 			(flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;
1558 
1559 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1560 		dai_drv->symmetric_channels =
1561 			(flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS) ?
1562 			1 : 0;
1563 
1564 	if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1565 		dai_drv->symmetric_sample_bits =
1566 			(flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
1567 			1 : 0;
1568 }
1569 
1570 static const struct snd_soc_dai_ops tplg_dai_ops = {
1571 	.compress_new	= snd_soc_new_compress,
1572 };
1573 
1574 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1575 	struct snd_soc_tplg_pcm *pcm)
1576 {
1577 	struct snd_soc_dai_driver *dai_drv;
1578 	struct snd_soc_pcm_stream *stream;
1579 	struct snd_soc_tplg_stream_caps *caps;
1580 	struct snd_soc_dai *dai;
1581 	struct snd_soc_dapm_context *dapm =
1582 		snd_soc_component_get_dapm(tplg->comp);
1583 	int ret;
1584 
1585 	dai_drv = devm_kzalloc(tplg->dev, sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1586 	if (dai_drv == NULL)
1587 		return -ENOMEM;
1588 
1589 	if (strlen(pcm->dai_name)) {
1590 		dai_drv->name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1591 		if (!dai_drv->name) {
1592 			ret = -ENOMEM;
1593 			goto err;
1594 		}
1595 	}
1596 	dai_drv->id = le32_to_cpu(pcm->dai_id);
1597 
1598 	if (pcm->playback) {
1599 		stream = &dai_drv->playback;
1600 		caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1601 		ret = set_stream_info(tplg, stream, caps);
1602 		if (ret < 0)
1603 			goto err;
1604 	}
1605 
1606 	if (pcm->capture) {
1607 		stream = &dai_drv->capture;
1608 		caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1609 		ret = set_stream_info(tplg, stream, caps);
1610 		if (ret < 0)
1611 			goto err;
1612 	}
1613 
1614 	if (pcm->compress)
1615 		dai_drv->ops = &tplg_dai_ops;
1616 
1617 	/* pass control to component driver for optional further init */
1618 	ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1619 	if (ret < 0) {
1620 		dev_err(tplg->dev, "ASoC: DAI loading failed\n");
1621 		goto err;
1622 	}
1623 
1624 	dai_drv->dobj.index = tplg->index;
1625 	dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1626 	if (tplg->ops)
1627 		dai_drv->dobj.unload = tplg->ops->dai_unload;
1628 	list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1629 
1630 	/* register the DAI to the component */
1631 	dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1632 	if (!dai)
1633 		return -ENOMEM;
1634 
1635 	/* Create the DAI widgets here */
1636 	ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1637 	if (ret != 0) {
1638 		dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1639 		snd_soc_unregister_dai(dai);
1640 		return ret;
1641 	}
1642 
1643 	return 0;
1644 
1645 err:
1646 	return ret;
1647 }
1648 
1649 static void set_link_flags(struct snd_soc_dai_link *link,
1650 		unsigned int flag_mask, unsigned int flags)
1651 {
1652 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1653 		link->symmetric_rate =
1654 			(flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;
1655 
1656 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1657 		link->symmetric_channels =
1658 			(flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS) ?
1659 			1 : 0;
1660 
1661 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1662 		link->symmetric_sample_bits =
1663 			(flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
1664 			1 : 0;
1665 
1666 	if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1667 		link->ignore_suspend =
1668 			(flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP) ?
1669 			1 : 0;
1670 }
1671 
1672 /* create the FE DAI link */
1673 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1674 	struct snd_soc_tplg_pcm *pcm)
1675 {
1676 	struct snd_soc_dai_link *link;
1677 	struct snd_soc_dai_link_component *dlc;
1678 	int ret;
1679 
1680 	/* link + cpu + codec + platform */
1681 	link = devm_kzalloc(tplg->dev, sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1682 	if (link == NULL)
1683 		return -ENOMEM;
1684 
1685 	dlc = (struct snd_soc_dai_link_component *)(link + 1);
1686 
1687 	link->cpus	= &dlc[0];
1688 	link->num_cpus	 = 1;
1689 
1690 	link->dobj.index = tplg->index;
1691 	link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1692 	if (tplg->ops)
1693 		link->dobj.unload = tplg->ops->link_unload;
1694 
1695 	if (strlen(pcm->pcm_name)) {
1696 		link->name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1697 		link->stream_name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1698 		if (!link->name || !link->stream_name) {
1699 			ret = -ENOMEM;
1700 			goto err;
1701 		}
1702 	}
1703 	link->id = le32_to_cpu(pcm->pcm_id);
1704 
1705 	if (strlen(pcm->dai_name)) {
1706 		link->cpus->dai_name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1707 		if (!link->cpus->dai_name) {
1708 			ret = -ENOMEM;
1709 			goto err;
1710 		}
1711 	}
1712 
1713 	/*
1714 	 * Many topology are assuming link has Codec / Platform, and
1715 	 * these might be overwritten at soc_tplg_dai_link_load().
1716 	 * Don't use &snd_soc_dummy_dlc here.
1717 	 */
1718 	link->codecs		= &dlc[1];	/* Don't use &snd_soc_dummy_dlc here */
1719 	link->codecs->name	= "snd-soc-dummy";
1720 	link->codecs->dai_name	= "snd-soc-dummy-dai";
1721 	link->num_codecs	= 1;
1722 
1723 	link->platforms		= &dlc[2];	/* Don't use &snd_soc_dummy_dlc here */
1724 	link->platforms->name	= "snd-soc-dummy";
1725 	link->num_platforms	= 1;
1726 
1727 	/* enable DPCM */
1728 	link->dynamic = 1;
1729 	link->ignore_pmdown_time = 1;
1730 	link->dpcm_playback = le32_to_cpu(pcm->playback);
1731 	link->dpcm_capture = le32_to_cpu(pcm->capture);
1732 	if (pcm->flag_mask)
1733 		set_link_flags(link,
1734 			       le32_to_cpu(pcm->flag_mask),
1735 			       le32_to_cpu(pcm->flags));
1736 
1737 	/* pass control to component driver for optional further init */
1738 	ret = soc_tplg_dai_link_load(tplg, link, NULL);
1739 	if (ret < 0) {
1740 		dev_err(tplg->dev, "ASoC: FE link loading failed\n");
1741 		goto err;
1742 	}
1743 
1744 	ret = snd_soc_add_pcm_runtimes(tplg->comp->card, link, 1);
1745 	if (ret < 0) {
1746 		if (ret != -EPROBE_DEFER)
1747 			dev_err(tplg->dev, "ASoC: adding FE link failed\n");
1748 		goto err;
1749 	}
1750 
1751 	list_add(&link->dobj.list, &tplg->comp->dobj_list);
1752 
1753 	return 0;
1754 err:
1755 	return ret;
1756 }
1757 
1758 /* create a FE DAI and DAI link from the PCM object */
1759 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1760 	struct snd_soc_tplg_pcm *pcm)
1761 {
1762 	int ret;
1763 
1764 	ret = soc_tplg_dai_create(tplg, pcm);
1765 	if (ret < 0)
1766 		return ret;
1767 
1768 	return  soc_tplg_fe_link_create(tplg, pcm);
1769 }
1770 
1771 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
1772 	struct snd_soc_tplg_hdr *hdr)
1773 {
1774 	struct snd_soc_tplg_pcm *pcm;
1775 	int count;
1776 	int size;
1777 	int i;
1778 	int ret;
1779 
1780 	count = le32_to_cpu(hdr->count);
1781 
1782 	/* check the element size and count */
1783 	pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1784 	size = le32_to_cpu(pcm->size);
1785 	if (size > sizeof(struct snd_soc_tplg_pcm)) {
1786 		dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
1787 			size);
1788 		return -EINVAL;
1789 	}
1790 
1791 	if (soc_tplg_check_elem_count(tplg,
1792 				      size, count,
1793 				      le32_to_cpu(hdr->payload_size),
1794 				      "PCM DAI"))
1795 		return -EINVAL;
1796 
1797 	for (i = 0; i < count; i++) {
1798 		pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1799 		size = le32_to_cpu(pcm->size);
1800 
1801 		/* check ABI version by size, create a new version of pcm
1802 		 * if abi not match.
1803 		 */
1804 		if (size != sizeof(*pcm))
1805 			return -EINVAL;
1806 
1807 		/* create the FE DAIs and DAI links */
1808 		ret = soc_tplg_pcm_create(tplg, pcm);
1809 		if (ret < 0)
1810 			return ret;
1811 
1812 		/* offset by version-specific struct size and
1813 		 * real priv data size
1814 		 */
1815 		tplg->pos += size + le32_to_cpu(pcm->priv.size);
1816 	}
1817 
1818 	dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
1819 
1820 	return 0;
1821 }
1822 
1823 /**
1824  * set_link_hw_format - Set the HW audio format of the physical DAI link.
1825  * @link: &snd_soc_dai_link which should be updated
1826  * @cfg: physical link configs.
1827  *
1828  * Topology context contains a list of supported HW formats (configs) and
1829  * a default format ID for the physical link. This function will use this
1830  * default ID to choose the HW format to set the link's DAI format for init.
1831  */
1832 static void set_link_hw_format(struct snd_soc_dai_link *link,
1833 			struct snd_soc_tplg_link_config *cfg)
1834 {
1835 	struct snd_soc_tplg_hw_config *hw_config;
1836 	unsigned char bclk_provider, fsync_provider;
1837 	unsigned char invert_bclk, invert_fsync;
1838 	int i;
1839 
1840 	for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
1841 		hw_config = &cfg->hw_config[i];
1842 		if (hw_config->id != cfg->default_hw_config_id)
1843 			continue;
1844 
1845 		link->dai_fmt = le32_to_cpu(hw_config->fmt) &
1846 			SND_SOC_DAIFMT_FORMAT_MASK;
1847 
1848 		/* clock gating */
1849 		switch (hw_config->clock_gated) {
1850 		case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
1851 			link->dai_fmt |= SND_SOC_DAIFMT_GATED;
1852 			break;
1853 
1854 		case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
1855 			link->dai_fmt |= SND_SOC_DAIFMT_CONT;
1856 			break;
1857 
1858 		default:
1859 			/* ignore the value */
1860 			break;
1861 		}
1862 
1863 		/* clock signal polarity */
1864 		invert_bclk = hw_config->invert_bclk;
1865 		invert_fsync = hw_config->invert_fsync;
1866 		if (!invert_bclk && !invert_fsync)
1867 			link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
1868 		else if (!invert_bclk && invert_fsync)
1869 			link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
1870 		else if (invert_bclk && !invert_fsync)
1871 			link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
1872 		else
1873 			link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
1874 
1875 		/* clock masters */
1876 		bclk_provider = (hw_config->bclk_provider ==
1877 			       SND_SOC_TPLG_BCLK_CP);
1878 		fsync_provider = (hw_config->fsync_provider ==
1879 				SND_SOC_TPLG_FSYNC_CP);
1880 		if (bclk_provider && fsync_provider)
1881 			link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
1882 		else if (!bclk_provider && fsync_provider)
1883 			link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
1884 		else if (bclk_provider && !fsync_provider)
1885 			link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
1886 		else
1887 			link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
1888 	}
1889 }
1890 
1891 /**
1892  * snd_soc_find_dai_link - Find a DAI link
1893  *
1894  * @card: soc card
1895  * @id: DAI link ID to match
1896  * @name: DAI link name to match, optional
1897  * @stream_name: DAI link stream name to match, optional
1898  *
1899  * This function will search all existing DAI links of the soc card to
1900  * find the link of the same ID. Since DAI links may not have their
1901  * unique ID, so name and stream name should also match if being
1902  * specified.
1903  *
1904  * Return: pointer of DAI link, or NULL if not found.
1905  */
1906 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
1907 						      int id, const char *name,
1908 						      const char *stream_name)
1909 {
1910 	struct snd_soc_pcm_runtime *rtd;
1911 
1912 	for_each_card_rtds(card, rtd) {
1913 		struct snd_soc_dai_link *link = rtd->dai_link;
1914 
1915 		if (link->id != id)
1916 			continue;
1917 
1918 		if (name && (!link->name || !strstr(link->name, name)))
1919 			continue;
1920 
1921 		if (stream_name && (!link->stream_name ||
1922 				    !strstr(link->stream_name, stream_name)))
1923 			continue;
1924 
1925 		return link;
1926 	}
1927 
1928 	return NULL;
1929 }
1930 
1931 /* Find and configure an existing physical DAI link */
1932 static int soc_tplg_link_config(struct soc_tplg *tplg,
1933 	struct snd_soc_tplg_link_config *cfg)
1934 {
1935 	struct snd_soc_dai_link *link;
1936 	const char *name, *stream_name;
1937 	size_t len;
1938 	int ret;
1939 
1940 	len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1941 	if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1942 		return -EINVAL;
1943 	else if (len)
1944 		name = cfg->name;
1945 	else
1946 		name = NULL;
1947 
1948 	len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1949 	if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1950 		return -EINVAL;
1951 	else if (len)
1952 		stream_name = cfg->stream_name;
1953 	else
1954 		stream_name = NULL;
1955 
1956 	link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
1957 				     name, stream_name);
1958 	if (!link) {
1959 		dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
1960 			name, cfg->id);
1961 		return -EINVAL;
1962 	}
1963 
1964 	/* hw format */
1965 	if (cfg->num_hw_configs)
1966 		set_link_hw_format(link, cfg);
1967 
1968 	/* flags */
1969 	if (cfg->flag_mask)
1970 		set_link_flags(link,
1971 			       le32_to_cpu(cfg->flag_mask),
1972 			       le32_to_cpu(cfg->flags));
1973 
1974 	/* pass control to component driver for optional further init */
1975 	ret = soc_tplg_dai_link_load(tplg, link, cfg);
1976 	if (ret < 0) {
1977 		dev_err(tplg->dev, "ASoC: physical link loading failed\n");
1978 		return ret;
1979 	}
1980 
1981 	/* for unloading it in snd_soc_tplg_component_remove */
1982 	link->dobj.index = tplg->index;
1983 	link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
1984 	if (tplg->ops)
1985 		link->dobj.unload = tplg->ops->link_unload;
1986 	list_add(&link->dobj.list, &tplg->comp->dobj_list);
1987 
1988 	return 0;
1989 }
1990 
1991 
1992 /* Load physical link config elements from the topology context */
1993 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
1994 	struct snd_soc_tplg_hdr *hdr)
1995 {
1996 	struct snd_soc_tplg_link_config *link;
1997 	int count;
1998 	int size;
1999 	int i, ret;
2000 
2001 	count = le32_to_cpu(hdr->count);
2002 
2003 	/* check the element size and count */
2004 	link = (struct snd_soc_tplg_link_config *)tplg->pos;
2005 	size = le32_to_cpu(link->size);
2006 	if (size > sizeof(struct snd_soc_tplg_link_config)) {
2007 		dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2008 			size);
2009 		return -EINVAL;
2010 	}
2011 
2012 	if (soc_tplg_check_elem_count(tplg, size, count,
2013 				      le32_to_cpu(hdr->payload_size),
2014 				      "physical link config"))
2015 		return -EINVAL;
2016 
2017 	/* config physical DAI links */
2018 	for (i = 0; i < count; i++) {
2019 		link = (struct snd_soc_tplg_link_config *)tplg->pos;
2020 		size = le32_to_cpu(link->size);
2021 		if (size != sizeof(*link))
2022 			return -EINVAL;
2023 
2024 		ret = soc_tplg_link_config(tplg, link);
2025 		if (ret < 0)
2026 			return ret;
2027 
2028 		/* offset by version-specific struct size and
2029 		 * real priv data size
2030 		 */
2031 		tplg->pos += size + le32_to_cpu(link->priv.size);
2032 	}
2033 
2034 	return 0;
2035 }
2036 
2037 /**
2038  * soc_tplg_dai_config - Find and configure an existing physical DAI.
2039  * @tplg: topology context
2040  * @d: physical DAI configs.
2041  *
2042  * The physical dai should already be registered by the platform driver.
2043  * The platform driver should specify the DAI name and ID for matching.
2044  */
2045 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2046 			       struct snd_soc_tplg_dai *d)
2047 {
2048 	struct snd_soc_dai_link_component dai_component;
2049 	struct snd_soc_dai *dai;
2050 	struct snd_soc_dai_driver *dai_drv;
2051 	struct snd_soc_pcm_stream *stream;
2052 	struct snd_soc_tplg_stream_caps *caps;
2053 	int ret;
2054 
2055 	memset(&dai_component, 0, sizeof(dai_component));
2056 
2057 	dai_component.dai_name = d->dai_name;
2058 	dai = snd_soc_find_dai(&dai_component);
2059 	if (!dai) {
2060 		dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2061 			d->dai_name);
2062 		return -EINVAL;
2063 	}
2064 
2065 	if (le32_to_cpu(d->dai_id) != dai->id) {
2066 		dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2067 			d->dai_name);
2068 		return -EINVAL;
2069 	}
2070 
2071 	dai_drv = dai->driver;
2072 	if (!dai_drv)
2073 		return -EINVAL;
2074 
2075 	if (d->playback) {
2076 		stream = &dai_drv->playback;
2077 		caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2078 		ret = set_stream_info(tplg, stream, caps);
2079 		if (ret < 0)
2080 			goto err;
2081 	}
2082 
2083 	if (d->capture) {
2084 		stream = &dai_drv->capture;
2085 		caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2086 		ret = set_stream_info(tplg, stream, caps);
2087 		if (ret < 0)
2088 			goto err;
2089 	}
2090 
2091 	if (d->flag_mask)
2092 		set_dai_flags(dai_drv,
2093 			      le32_to_cpu(d->flag_mask),
2094 			      le32_to_cpu(d->flags));
2095 
2096 	/* pass control to component driver for optional further init */
2097 	ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2098 	if (ret < 0) {
2099 		dev_err(tplg->dev, "ASoC: DAI loading failed\n");
2100 		goto err;
2101 	}
2102 
2103 	return 0;
2104 
2105 err:
2106 	return ret;
2107 }
2108 
2109 /* load physical DAI elements */
2110 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2111 				   struct snd_soc_tplg_hdr *hdr)
2112 {
2113 	int count;
2114 	int i;
2115 
2116 	count = le32_to_cpu(hdr->count);
2117 
2118 	/* config the existing BE DAIs */
2119 	for (i = 0; i < count; i++) {
2120 		struct snd_soc_tplg_dai *dai = (struct snd_soc_tplg_dai *)tplg->pos;
2121 		int ret;
2122 
2123 		if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2124 			dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2125 			return -EINVAL;
2126 		}
2127 
2128 		ret = soc_tplg_dai_config(tplg, dai);
2129 		if (ret < 0) {
2130 			dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2131 			return ret;
2132 		}
2133 
2134 		tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2135 	}
2136 
2137 	dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2138 	return 0;
2139 }
2140 
2141 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2142 				  struct snd_soc_tplg_hdr *hdr)
2143 {
2144 	struct snd_soc_tplg_manifest *manifest;
2145 	int ret = 0;
2146 
2147 	manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2148 
2149 	/* check ABI version by size, create a new manifest if abi not match */
2150 	if (le32_to_cpu(manifest->size) != sizeof(*manifest))
2151 		return -EINVAL;
2152 
2153 	/* pass control to component driver for optional further init */
2154 	if (tplg->ops && tplg->ops->manifest)
2155 		ret = tplg->ops->manifest(tplg->comp, tplg->index, manifest);
2156 
2157 	return ret;
2158 }
2159 
2160 /* validate header magic, size and type */
2161 static int soc_tplg_valid_header(struct soc_tplg *tplg,
2162 	struct snd_soc_tplg_hdr *hdr)
2163 {
2164 	if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2165 		dev_err(tplg->dev,
2166 			"ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2167 			le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2168 			tplg->fw->size);
2169 		return -EINVAL;
2170 	}
2171 
2172 	if (soc_tplg_get_hdr_offset(tplg) + le32_to_cpu(hdr->payload_size) >= tplg->fw->size) {
2173 		dev_err(tplg->dev,
2174 			"ASoC: invalid header of type %d at offset %ld payload_size %d\n",
2175 			le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2176 			hdr->payload_size);
2177 		return -EINVAL;
2178 	}
2179 
2180 	/* big endian firmware objects not supported atm */
2181 	if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2182 		dev_err(tplg->dev,
2183 			"ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2184 			tplg->pass, hdr->magic,
2185 			soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2186 		return -EINVAL;
2187 	}
2188 
2189 	if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2190 		dev_err(tplg->dev,
2191 			"ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2192 			tplg->pass, hdr->magic,
2193 			soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2194 		return -EINVAL;
2195 	}
2196 
2197 	/* Support ABI from version 4 */
2198 	if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2199 	    le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2200 		dev_err(tplg->dev,
2201 			"ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2202 			tplg->pass, hdr->abi,
2203 			SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2204 			tplg->fw->size);
2205 		return -EINVAL;
2206 	}
2207 
2208 	if (hdr->payload_size == 0) {
2209 		dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2210 			soc_tplg_get_hdr_offset(tplg));
2211 		return -EINVAL;
2212 	}
2213 
2214 	return 0;
2215 }
2216 
2217 /* check header type and call appropriate handler */
2218 static int soc_tplg_load_header(struct soc_tplg *tplg,
2219 	struct snd_soc_tplg_hdr *hdr)
2220 {
2221 	int (*elem_load)(struct soc_tplg *tplg,
2222 			 struct snd_soc_tplg_hdr *hdr);
2223 	unsigned int hdr_pass;
2224 
2225 	tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2226 
2227 	tplg->index = le32_to_cpu(hdr->index);
2228 
2229 	switch (le32_to_cpu(hdr->type)) {
2230 	case SND_SOC_TPLG_TYPE_MIXER:
2231 	case SND_SOC_TPLG_TYPE_ENUM:
2232 	case SND_SOC_TPLG_TYPE_BYTES:
2233 		hdr_pass = SOC_TPLG_PASS_CONTROL;
2234 		elem_load = soc_tplg_kcontrol_elems_load;
2235 		break;
2236 	case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2237 		hdr_pass = SOC_TPLG_PASS_GRAPH;
2238 		elem_load = soc_tplg_dapm_graph_elems_load;
2239 		break;
2240 	case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2241 		hdr_pass = SOC_TPLG_PASS_WIDGET;
2242 		elem_load = soc_tplg_dapm_widget_elems_load;
2243 		break;
2244 	case SND_SOC_TPLG_TYPE_PCM:
2245 		hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2246 		elem_load = soc_tplg_pcm_elems_load;
2247 		break;
2248 	case SND_SOC_TPLG_TYPE_DAI:
2249 		hdr_pass = SOC_TPLG_PASS_BE_DAI;
2250 		elem_load = soc_tplg_dai_elems_load;
2251 		break;
2252 	case SND_SOC_TPLG_TYPE_DAI_LINK:
2253 	case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2254 		/* physical link configurations */
2255 		hdr_pass = SOC_TPLG_PASS_LINK;
2256 		elem_load = soc_tplg_link_elems_load;
2257 		break;
2258 	case SND_SOC_TPLG_TYPE_MANIFEST:
2259 		hdr_pass = SOC_TPLG_PASS_MANIFEST;
2260 		elem_load = soc_tplg_manifest_load;
2261 		break;
2262 	default:
2263 		/* bespoke vendor data object */
2264 		hdr_pass = SOC_TPLG_PASS_VENDOR;
2265 		elem_load = soc_tplg_vendor_load;
2266 		break;
2267 	}
2268 
2269 	if (tplg->pass == hdr_pass) {
2270 		dev_dbg(tplg->dev,
2271 			"ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2272 			hdr->payload_size, hdr->type, hdr->version,
2273 			hdr->vendor_type, tplg->pass);
2274 		return elem_load(tplg, hdr);
2275 	}
2276 
2277 	return 0;
2278 }
2279 
2280 /* process the topology file headers */
2281 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2282 {
2283 	int ret;
2284 
2285 	/* process the header types from start to end */
2286 	for (tplg->pass = SOC_TPLG_PASS_START; tplg->pass <= SOC_TPLG_PASS_END; tplg->pass++) {
2287 		struct snd_soc_tplg_hdr *hdr;
2288 
2289 		tplg->hdr_pos = tplg->fw->data;
2290 		hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2291 
2292 		while (!soc_tplg_is_eof(tplg)) {
2293 
2294 			/* make sure header is valid before loading */
2295 			ret = soc_tplg_valid_header(tplg, hdr);
2296 			if (ret < 0)
2297 				return ret;
2298 
2299 			/* load the header object */
2300 			ret = soc_tplg_load_header(tplg, hdr);
2301 			if (ret < 0) {
2302 				if (ret != -EPROBE_DEFER) {
2303 					dev_err(tplg->dev,
2304 						"ASoC: topology: could not load header: %d\n",
2305 						ret);
2306 				}
2307 				return ret;
2308 			}
2309 
2310 			/* goto next header */
2311 			tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2312 				sizeof(struct snd_soc_tplg_hdr);
2313 			hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2314 		}
2315 
2316 	}
2317 
2318 	/* signal DAPM we are complete */
2319 	ret = soc_tplg_dapm_complete(tplg);
2320 
2321 	return ret;
2322 }
2323 
2324 static int soc_tplg_load(struct soc_tplg *tplg)
2325 {
2326 	int ret;
2327 
2328 	ret = soc_tplg_process_headers(tplg);
2329 	if (ret == 0)
2330 		return soc_tplg_complete(tplg);
2331 
2332 	return ret;
2333 }
2334 
2335 /* load audio component topology from "firmware" file */
2336 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2337 	struct snd_soc_tplg_ops *ops, const struct firmware *fw)
2338 {
2339 	struct soc_tplg tplg;
2340 	int ret;
2341 
2342 	/*
2343 	 * check if we have sane parameters:
2344 	 * comp - needs to exist to keep and reference data while parsing
2345 	 * comp->card - used for setting card related parameters
2346 	 * comp->card->dev - used for resource management and prints
2347 	 * fw - we need it, as it is the very thing we parse
2348 	 */
2349 	if (!comp || !comp->card || !comp->card->dev || !fw)
2350 		return -EINVAL;
2351 
2352 	/* setup parsing context */
2353 	memset(&tplg, 0, sizeof(tplg));
2354 	tplg.fw = fw;
2355 	tplg.dev = comp->card->dev;
2356 	tplg.comp = comp;
2357 	if (ops) {
2358 		tplg.ops = ops;
2359 		tplg.io_ops = ops->io_ops;
2360 		tplg.io_ops_count = ops->io_ops_count;
2361 		tplg.bytes_ext_ops = ops->bytes_ext_ops;
2362 		tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2363 	}
2364 
2365 	ret = soc_tplg_load(&tplg);
2366 	/* free the created components if fail to load topology */
2367 	if (ret)
2368 		snd_soc_tplg_component_remove(comp);
2369 
2370 	return ret;
2371 }
2372 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2373 
2374 /* remove dynamic controls from the component driver */
2375 int snd_soc_tplg_component_remove(struct snd_soc_component *comp)
2376 {
2377 	struct snd_soc_dobj *dobj, *next_dobj;
2378 	int pass;
2379 
2380 	/* process the header types from end to start */
2381 	for (pass = SOC_TPLG_PASS_END; pass >= SOC_TPLG_PASS_START; pass--) {
2382 
2383 		/* remove mixer controls */
2384 		list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2385 			list) {
2386 
2387 			switch (dobj->type) {
2388 			case SND_SOC_DOBJ_BYTES:
2389 			case SND_SOC_DOBJ_ENUM:
2390 			case SND_SOC_DOBJ_MIXER:
2391 				soc_tplg_remove_kcontrol(comp, dobj, pass);
2392 				break;
2393 			case SND_SOC_DOBJ_GRAPH:
2394 				soc_tplg_remove_route(comp, dobj, pass);
2395 				break;
2396 			case SND_SOC_DOBJ_WIDGET:
2397 				soc_tplg_remove_widget(comp, dobj, pass);
2398 				break;
2399 			case SND_SOC_DOBJ_PCM:
2400 				soc_tplg_remove_dai(comp, dobj, pass);
2401 				break;
2402 			case SND_SOC_DOBJ_DAI_LINK:
2403 				soc_tplg_remove_link(comp, dobj, pass);
2404 				break;
2405 			case SND_SOC_DOBJ_BACKEND_LINK:
2406 				/*
2407 				 * call link_unload ops if extra
2408 				 * deinitialization is needed.
2409 				 */
2410 				remove_backend_link(comp, dobj, pass);
2411 				break;
2412 			default:
2413 				dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2414 					dobj->type);
2415 				break;
2416 			}
2417 		}
2418 	}
2419 
2420 	/* let caller know if FW can be freed when no objects are left */
2421 	return !list_empty(&comp->dobj_list);
2422 }
2423 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);
2424