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