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