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