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