1 // SPDX-License-Identifier: GPL-2.0+
3 // soc-topology.c -- ALSA SoC Topology
5 // Copyright (C) 2012 Texas Instruments Inc.
6 // Copyright (C) 2015 Intel Corporation.
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>
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.
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.
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>
34 * We make several passes over the data (since it wont necessarily be ordered)
35 * and process objects in the following order. This guarantees the component
36 * drivers will be ready with any vendor data before the mixers and DAPM objects
37 * are loaded (that may make use of the vendor data).
39 #define SOC_TPLG_PASS_MANIFEST 0
40 #define SOC_TPLG_PASS_VENDOR 1
41 #define SOC_TPLG_PASS_MIXER 2
42 #define SOC_TPLG_PASS_WIDGET 3
43 #define SOC_TPLG_PASS_PCM_DAI 4
44 #define SOC_TPLG_PASS_GRAPH 5
45 #define SOC_TPLG_PASS_PINS 6
46 #define SOC_TPLG_PASS_BE_DAI 7
47 #define SOC_TPLG_PASS_LINK 8
49 #define SOC_TPLG_PASS_START SOC_TPLG_PASS_MANIFEST
50 #define SOC_TPLG_PASS_END SOC_TPLG_PASS_LINK
52 /* topology context */
54 const struct firmware *fw;
56 /* runtime FW parsing */
57 const u8 *pos; /* read postion */
58 const u8 *hdr_pos; /* header position */
59 unsigned int pass; /* pass number */
61 /* component caller */
63 struct snd_soc_component *comp;
64 u32 index; /* current block index */
65 u32 req_index; /* required index, only loaded/free matching blocks */
67 /* vendor specific kcontrol operations */
68 const struct snd_soc_tplg_kcontrol_ops *io_ops;
71 /* vendor specific bytes ext handlers, for TLV bytes controls */
72 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
73 int bytes_ext_ops_count;
75 /* optional fw loading callbacks to component drivers */
76 struct snd_soc_tplg_ops *ops;
79 static int soc_tplg_process_headers(struct soc_tplg *tplg);
80 static void soc_tplg_complete(struct soc_tplg *tplg);
81 struct snd_soc_dapm_widget *
82 snd_soc_dapm_new_control_unlocked(struct snd_soc_dapm_context *dapm,
83 const struct snd_soc_dapm_widget *widget);
84 struct snd_soc_dapm_widget *
85 snd_soc_dapm_new_control(struct snd_soc_dapm_context *dapm,
86 const struct snd_soc_dapm_widget *widget);
88 /* check we dont overflow the data for this control chunk */
89 static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
90 unsigned int count, size_t bytes, const char *elem_type)
92 const u8 *end = tplg->pos + elem_size * count;
94 if (end > tplg->fw->data + tplg->fw->size) {
95 dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
100 /* check there is enough room in chunk for control.
101 extra bytes at the end of control are for vendor data here */
102 if (elem_size * count > bytes) {
104 "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
105 elem_type, count, elem_size, bytes);
112 static inline int soc_tplg_is_eof(struct soc_tplg *tplg)
114 const u8 *end = tplg->hdr_pos;
116 if (end >= tplg->fw->data + tplg->fw->size)
121 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
123 return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
126 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
128 return (unsigned long)(tplg->pos - tplg->fw->data);
131 /* mapping of Kcontrol types and associated operations. */
132 static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
133 {SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
134 snd_soc_put_volsw, snd_soc_info_volsw},
135 {SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
136 snd_soc_put_volsw_sx, NULL},
137 {SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
138 snd_soc_put_enum_double, snd_soc_info_enum_double},
139 {SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
140 snd_soc_put_enum_double, NULL},
141 {SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
142 snd_soc_bytes_put, snd_soc_bytes_info},
143 {SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw_range,
144 snd_soc_put_volsw_range, snd_soc_info_volsw_range},
145 {SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
146 snd_soc_put_xr_sx, snd_soc_info_xr_sx},
147 {SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
148 snd_soc_put_strobe, NULL},
149 {SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
150 snd_soc_dapm_put_volsw, snd_soc_info_volsw},
151 {SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
152 snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
153 {SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
154 snd_soc_dapm_put_enum_double, NULL},
155 {SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
156 snd_soc_dapm_put_enum_double, NULL},
157 {SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
158 snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
161 struct soc_tplg_map {
166 /* mapping of widget types from UAPI IDs to kernel IDs */
167 static const struct soc_tplg_map dapm_map[] = {
168 {SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
169 {SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
170 {SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
171 {SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
172 {SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
173 {SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
174 {SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
175 {SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
176 {SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
177 {SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
178 {SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
179 {SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
180 {SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
181 {SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
182 {SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
183 {SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
184 {SND_SOC_TPLG_DAPM_BUFFER, snd_soc_dapm_buffer},
185 {SND_SOC_TPLG_DAPM_SCHEDULER, snd_soc_dapm_scheduler},
186 {SND_SOC_TPLG_DAPM_EFFECT, snd_soc_dapm_effect},
187 {SND_SOC_TPLG_DAPM_SIGGEN, snd_soc_dapm_siggen},
188 {SND_SOC_TPLG_DAPM_SRC, snd_soc_dapm_src},
189 {SND_SOC_TPLG_DAPM_ASRC, snd_soc_dapm_asrc},
190 {SND_SOC_TPLG_DAPM_ENCODER, snd_soc_dapm_encoder},
191 {SND_SOC_TPLG_DAPM_DECODER, snd_soc_dapm_decoder},
194 static int tplc_chan_get_reg(struct soc_tplg *tplg,
195 struct snd_soc_tplg_channel *chan, int map)
199 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
200 if (chan[i].id == map)
207 static int tplc_chan_get_shift(struct soc_tplg *tplg,
208 struct snd_soc_tplg_channel *chan, int map)
212 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
213 if (chan[i].id == map)
214 return chan[i].shift;
220 static int get_widget_id(int tplg_type)
224 for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
225 if (tplg_type == dapm_map[i].uid)
226 return dapm_map[i].kid;
232 static inline void soc_bind_err(struct soc_tplg *tplg,
233 struct snd_soc_tplg_ctl_hdr *hdr, int index)
236 "ASoC: invalid control type (g,p,i) %d:%d:%d index %d at 0x%lx\n",
237 hdr->ops.get, hdr->ops.put, hdr->ops.info, index,
238 soc_tplg_get_offset(tplg));
241 static inline void soc_control_err(struct soc_tplg *tplg,
242 struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
245 "ASoC: no complete mixer IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
246 name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
247 soc_tplg_get_offset(tplg));
250 /* pass vendor data to component driver for processing */
251 static int soc_tplg_vendor_load_(struct soc_tplg *tplg,
252 struct snd_soc_tplg_hdr *hdr)
256 if (tplg->comp && tplg->ops && tplg->ops->vendor_load)
257 ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
259 dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
266 "ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
267 soc_tplg_get_hdr_offset(tplg),
268 soc_tplg_get_hdr_offset(tplg),
269 hdr->type, hdr->vendor_type);
273 /* pass vendor data to component driver for processing */
274 static int soc_tplg_vendor_load(struct soc_tplg *tplg,
275 struct snd_soc_tplg_hdr *hdr)
277 if (tplg->pass != SOC_TPLG_PASS_VENDOR)
280 return soc_tplg_vendor_load_(tplg, hdr);
283 /* optionally pass new dynamic widget to component driver. This is mainly for
284 * external widgets where we can assign private data/ops */
285 static int soc_tplg_widget_load(struct soc_tplg *tplg,
286 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
288 if (tplg->comp && tplg->ops && tplg->ops->widget_load)
289 return tplg->ops->widget_load(tplg->comp, tplg->index, w,
295 /* optionally pass new dynamic widget to component driver. This is mainly for
296 * external widgets where we can assign private data/ops */
297 static int soc_tplg_widget_ready(struct soc_tplg *tplg,
298 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
300 if (tplg->comp && tplg->ops && tplg->ops->widget_ready)
301 return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
307 /* pass DAI configurations to component driver for extra initialization */
308 static int soc_tplg_dai_load(struct soc_tplg *tplg,
309 struct snd_soc_dai_driver *dai_drv,
310 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
312 if (tplg->comp && tplg->ops && tplg->ops->dai_load)
313 return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
319 /* pass link configurations to component driver for extra initialization */
320 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
321 struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
323 if (tplg->comp && tplg->ops && tplg->ops->link_load)
324 return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
329 /* tell the component driver that all firmware has been loaded in this request */
330 static void soc_tplg_complete(struct soc_tplg *tplg)
332 if (tplg->comp && tplg->ops && tplg->ops->complete)
333 tplg->ops->complete(tplg->comp);
336 /* add a dynamic kcontrol */
337 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
338 const struct snd_kcontrol_new *control_new, const char *prefix,
339 void *data, struct snd_kcontrol **kcontrol)
343 *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
344 if (*kcontrol == NULL) {
345 dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
350 err = snd_ctl_add(card, *kcontrol);
352 dev_err(dev, "ASoC: Failed to add %s: %d\n",
353 control_new->name, err);
360 /* add a dynamic kcontrol for component driver */
361 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
362 struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
364 struct snd_soc_component *comp = tplg->comp;
366 return soc_tplg_add_dcontrol(comp->card->snd_card,
367 comp->dev, k, NULL, comp, kcontrol);
370 /* remove a mixer kcontrol */
371 static void remove_mixer(struct snd_soc_component *comp,
372 struct snd_soc_dobj *dobj, int pass)
374 struct snd_card *card = comp->card->snd_card;
375 struct soc_mixer_control *sm =
376 container_of(dobj, struct soc_mixer_control, dobj);
377 const unsigned int *p = NULL;
379 if (pass != SOC_TPLG_PASS_MIXER)
382 if (dobj->ops && dobj->ops->control_unload)
383 dobj->ops->control_unload(comp, dobj);
385 if (dobj->control.kcontrol->tlv.p)
386 p = dobj->control.kcontrol->tlv.p;
387 snd_ctl_remove(card, dobj->control.kcontrol);
388 list_del(&dobj->list);
393 /* remove an enum kcontrol */
394 static void remove_enum(struct snd_soc_component *comp,
395 struct snd_soc_dobj *dobj, int pass)
397 struct snd_card *card = comp->card->snd_card;
398 struct soc_enum *se = container_of(dobj, struct soc_enum, dobj);
401 if (pass != SOC_TPLG_PASS_MIXER)
404 if (dobj->ops && dobj->ops->control_unload)
405 dobj->ops->control_unload(comp, dobj);
407 snd_ctl_remove(card, dobj->control.kcontrol);
408 list_del(&dobj->list);
410 kfree(dobj->control.dvalues);
411 for (i = 0; i < se->items; i++)
412 kfree(dobj->control.dtexts[i]);
413 kfree(dobj->control.dtexts);
417 /* remove a byte kcontrol */
418 static void remove_bytes(struct snd_soc_component *comp,
419 struct snd_soc_dobj *dobj, int pass)
421 struct snd_card *card = comp->card->snd_card;
422 struct soc_bytes_ext *sb =
423 container_of(dobj, struct soc_bytes_ext, dobj);
425 if (pass != SOC_TPLG_PASS_MIXER)
428 if (dobj->ops && dobj->ops->control_unload)
429 dobj->ops->control_unload(comp, dobj);
431 snd_ctl_remove(card, dobj->control.kcontrol);
432 list_del(&dobj->list);
437 static void remove_route(struct snd_soc_component *comp,
438 struct snd_soc_dobj *dobj, int pass)
440 struct snd_soc_dapm_route *route =
441 container_of(dobj, struct snd_soc_dapm_route, dobj);
443 if (pass != SOC_TPLG_PASS_GRAPH)
446 if (dobj->ops && dobj->ops->dapm_route_unload)
447 dobj->ops->dapm_route_unload(comp, dobj);
449 list_del(&dobj->list);
453 /* remove a widget and it's kcontrols - routes must be removed first */
454 static void remove_widget(struct snd_soc_component *comp,
455 struct snd_soc_dobj *dobj, int pass)
457 struct snd_card *card = comp->card->snd_card;
458 struct snd_soc_dapm_widget *w =
459 container_of(dobj, struct snd_soc_dapm_widget, dobj);
462 if (pass != SOC_TPLG_PASS_WIDGET)
465 if (dobj->ops && dobj->ops->widget_unload)
466 dobj->ops->widget_unload(comp, dobj);
472 * Dynamic Widgets either have 1..N enum kcontrols or mixers.
473 * The enum may either have an array of values or strings.
475 if (dobj->widget.kcontrol_type == SND_SOC_TPLG_TYPE_ENUM) {
476 /* enumerated widget mixer */
477 for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
478 struct snd_kcontrol *kcontrol = w->kcontrols[i];
479 struct soc_enum *se =
480 (struct soc_enum *)kcontrol->private_value;
483 snd_ctl_remove(card, kcontrol);
485 /* free enum kcontrol's dvalues and dtexts */
486 kfree(se->dobj.control.dvalues);
487 for (j = 0; j < se->items; j++)
488 kfree(se->dobj.control.dtexts[j]);
489 kfree(se->dobj.control.dtexts);
492 kfree(w->kcontrol_news[i].name);
495 /* volume mixer or bytes controls */
496 for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
497 struct snd_kcontrol *kcontrol = w->kcontrols[i];
499 if (dobj->widget.kcontrol_type
500 == SND_SOC_TPLG_TYPE_MIXER)
501 kfree(kcontrol->tlv.p);
503 /* Private value is used as struct soc_mixer_control
504 * for volume mixers or soc_bytes_ext for bytes
507 kfree((void *)kcontrol->private_value);
508 snd_ctl_remove(card, kcontrol);
509 kfree(w->kcontrol_news[i].name);
514 kfree(w->kcontrol_news);
516 list_del(&dobj->list);
518 /* widget w is freed by soc-dapm.c */
521 /* remove DAI configurations */
522 static void remove_dai(struct snd_soc_component *comp,
523 struct snd_soc_dobj *dobj, int pass)
525 struct snd_soc_dai_driver *dai_drv =
526 container_of(dobj, struct snd_soc_dai_driver, dobj);
527 struct snd_soc_dai *dai;
529 if (pass != SOC_TPLG_PASS_PCM_DAI)
532 if (dobj->ops && dobj->ops->dai_unload)
533 dobj->ops->dai_unload(comp, dobj);
535 list_for_each_entry(dai, &comp->dai_list, list)
536 if (dai->driver == dai_drv)
539 kfree(dai_drv->name);
540 list_del(&dobj->list);
544 /* remove link configurations */
545 static void remove_link(struct snd_soc_component *comp,
546 struct snd_soc_dobj *dobj, int pass)
548 struct snd_soc_dai_link *link =
549 container_of(dobj, struct snd_soc_dai_link, dobj);
551 if (pass != SOC_TPLG_PASS_PCM_DAI)
554 if (dobj->ops && dobj->ops->link_unload)
555 dobj->ops->link_unload(comp, dobj);
558 kfree(link->stream_name);
559 kfree(link->cpu_dai_name);
561 list_del(&dobj->list);
562 snd_soc_remove_dai_link(comp->card, link);
566 /* unload dai link */
567 static void remove_backend_link(struct snd_soc_component *comp,
568 struct snd_soc_dobj *dobj, int pass)
570 if (pass != SOC_TPLG_PASS_LINK)
573 if (dobj->ops && dobj->ops->link_unload)
574 dobj->ops->link_unload(comp, dobj);
577 * We don't free the link here as what remove_link() do since BE
578 * links are not allocated by topology.
579 * We however need to reset the dobj type to its initial values
581 dobj->type = SND_SOC_DOBJ_NONE;
582 list_del(&dobj->list);
585 /* bind a kcontrol to it's IO handlers */
586 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
587 struct snd_kcontrol_new *k,
588 const struct soc_tplg *tplg)
590 const struct snd_soc_tplg_kcontrol_ops *ops;
591 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
594 if (hdr->ops.info == SND_SOC_TPLG_CTL_BYTES
595 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
596 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
597 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
598 struct soc_bytes_ext *sbe;
599 struct snd_soc_tplg_bytes_control *be;
601 sbe = (struct soc_bytes_ext *)k->private_value;
602 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
604 /* TLV bytes controls need standard kcontrol info handler,
605 * TLV callback and extended put/get handlers.
607 k->info = snd_soc_bytes_info_ext;
608 k->tlv.c = snd_soc_bytes_tlv_callback;
610 ext_ops = tplg->bytes_ext_ops;
611 num_ops = tplg->bytes_ext_ops_count;
612 for (i = 0; i < num_ops; i++) {
613 if (!sbe->put && ext_ops[i].id == be->ext_ops.put)
614 sbe->put = ext_ops[i].put;
615 if (!sbe->get && ext_ops[i].id == be->ext_ops.get)
616 sbe->get = ext_ops[i].get;
619 if (sbe->put && sbe->get)
625 /* try and map vendor specific kcontrol handlers first */
627 num_ops = tplg->io_ops_count;
628 for (i = 0; i < num_ops; i++) {
630 if (k->put == NULL && ops[i].id == hdr->ops.put)
632 if (k->get == NULL && ops[i].id == hdr->ops.get)
634 if (k->info == NULL && ops[i].id == hdr->ops.info)
635 k->info = ops[i].info;
638 /* vendor specific handlers found ? */
639 if (k->put && k->get && k->info)
642 /* none found so try standard kcontrol handlers */
644 num_ops = ARRAY_SIZE(io_ops);
645 for (i = 0; i < num_ops; i++) {
647 if (k->put == NULL && ops[i].id == hdr->ops.put)
649 if (k->get == NULL && ops[i].id == hdr->ops.get)
651 if (k->info == NULL && ops[i].id == hdr->ops.info)
652 k->info = ops[i].info;
655 /* standard handlers found ? */
656 if (k->put && k->get && k->info)
659 /* nothing to bind */
663 /* bind a widgets to it's evnt handlers */
664 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
665 const struct snd_soc_tplg_widget_events *events,
666 int num_events, u16 event_type)
672 for (i = 0; i < num_events; i++) {
673 if (event_type == events[i].type) {
675 /* found - so assign event */
676 w->event = events[i].event_handler;
684 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
686 /* optionally pass new dynamic kcontrol to component driver. */
687 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
688 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
690 if (tplg->comp && tplg->ops && tplg->ops->control_load)
691 return tplg->ops->control_load(tplg->comp, tplg->index, k,
698 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
699 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
701 unsigned int item_len = 2 * sizeof(unsigned int);
704 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
708 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
711 p[3] = (scale->step & TLV_DB_SCALE_MASK)
712 | (scale->mute ? TLV_DB_SCALE_MUTE : 0);
714 kc->tlv.p = (void *)p;
718 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
719 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
721 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
723 if (!(tc->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
726 if (!(tc->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
728 switch (tplg_tlv->type) {
729 case SNDRV_CTL_TLVT_DB_SCALE:
730 return soc_tplg_create_tlv_db_scale(tplg, kc,
733 /* TODO: add support for other TLV types */
735 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
744 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
745 struct snd_kcontrol_new *kc)
750 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
753 struct snd_soc_tplg_bytes_control *be;
754 struct soc_bytes_ext *sbe;
755 struct snd_kcontrol_new kc;
758 if (soc_tplg_check_elem_count(tplg,
759 sizeof(struct snd_soc_tplg_bytes_control), count,
760 size, "mixer bytes")) {
761 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
766 for (i = 0; i < count; i++) {
767 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
769 /* validate kcontrol */
770 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
771 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
774 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
778 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
782 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
783 be->hdr.name, be->hdr.access);
785 memset(&kc, 0, sizeof(kc));
786 kc.name = be->hdr.name;
787 kc.private_value = (long)sbe;
788 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
789 kc.access = be->hdr.access;
792 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
793 sbe->dobj.ops = tplg->ops;
794 INIT_LIST_HEAD(&sbe->dobj.list);
796 /* map io handlers */
797 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
799 soc_control_err(tplg, &be->hdr, be->hdr.name);
804 /* pass control to driver for optional further init */
805 err = soc_tplg_init_kcontrol(tplg, &kc,
806 (struct snd_soc_tplg_ctl_hdr *)be);
808 dev_err(tplg->dev, "ASoC: failed to init %s\n",
814 /* register control here */
815 err = soc_tplg_add_kcontrol(tplg, &kc,
816 &sbe->dobj.control.kcontrol);
818 dev_err(tplg->dev, "ASoC: failed to add %s\n",
824 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
830 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
833 struct snd_soc_tplg_mixer_control *mc;
834 struct soc_mixer_control *sm;
835 struct snd_kcontrol_new kc;
838 if (soc_tplg_check_elem_count(tplg,
839 sizeof(struct snd_soc_tplg_mixer_control),
840 count, size, "mixers")) {
842 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
847 for (i = 0; i < count; i++) {
848 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
850 /* validate kcontrol */
851 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
852 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
855 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
858 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
862 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
863 mc->hdr.name, mc->hdr.access);
865 memset(&kc, 0, sizeof(kc));
866 kc.name = mc->hdr.name;
867 kc.private_value = (long)sm;
868 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
869 kc.access = mc->hdr.access;
871 /* we only support FL/FR channel mapping atm */
872 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
874 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
876 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
878 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
883 sm->invert = mc->invert;
884 sm->platform_max = mc->platform_max;
885 sm->dobj.index = tplg->index;
886 sm->dobj.ops = tplg->ops;
887 sm->dobj.type = SND_SOC_DOBJ_MIXER;
888 INIT_LIST_HEAD(&sm->dobj.list);
890 /* map io handlers */
891 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
893 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
898 /* pass control to driver for optional further init */
899 err = soc_tplg_init_kcontrol(tplg, &kc,
900 (struct snd_soc_tplg_ctl_hdr *) mc);
902 dev_err(tplg->dev, "ASoC: failed to init %s\n",
908 /* create any TLV data */
909 soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
911 /* register control here */
912 err = soc_tplg_add_kcontrol(tplg, &kc,
913 &sm->dobj.control.kcontrol);
915 dev_err(tplg->dev, "ASoC: failed to add %s\n",
917 soc_tplg_free_tlv(tplg, &kc);
922 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
928 static int soc_tplg_denum_create_texts(struct soc_enum *se,
929 struct snd_soc_tplg_enum_control *ec)
933 se->dobj.control.dtexts =
934 kcalloc(ec->items, sizeof(char *), GFP_KERNEL);
935 if (se->dobj.control.dtexts == NULL)
938 for (i = 0; i < ec->items; i++) {
940 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
941 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
946 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
947 if (!se->dobj.control.dtexts[i]) {
953 se->texts = (const char * const *)se->dobj.control.dtexts;
957 for (--i; i >= 0; i--)
958 kfree(se->dobj.control.dtexts[i]);
959 kfree(se->dobj.control.dtexts);
963 static int soc_tplg_denum_create_values(struct soc_enum *se,
964 struct snd_soc_tplg_enum_control *ec)
966 if (ec->items > sizeof(*ec->values))
969 se->dobj.control.dvalues = kmemdup(ec->values,
970 ec->items * sizeof(u32),
972 if (!se->dobj.control.dvalues)
978 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
981 struct snd_soc_tplg_enum_control *ec;
983 struct snd_kcontrol_new kc;
986 if (soc_tplg_check_elem_count(tplg,
987 sizeof(struct snd_soc_tplg_enum_control),
988 count, size, "enums")) {
990 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
995 for (i = 0; i < count; i++) {
996 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
997 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1000 /* validate kcontrol */
1001 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1002 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1005 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1009 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1010 ec->hdr.name, ec->items);
1012 memset(&kc, 0, sizeof(kc));
1013 kc.name = ec->hdr.name;
1014 kc.private_value = (long)se;
1015 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1016 kc.access = ec->hdr.access;
1018 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1019 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1021 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1024 se->items = ec->items;
1025 se->mask = ec->mask;
1026 se->dobj.index = tplg->index;
1027 se->dobj.type = SND_SOC_DOBJ_ENUM;
1028 se->dobj.ops = tplg->ops;
1029 INIT_LIST_HEAD(&se->dobj.list);
1031 switch (ec->hdr.ops.info) {
1032 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1033 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1034 err = soc_tplg_denum_create_values(se, ec);
1037 "ASoC: could not create values for %s\n",
1043 case SND_SOC_TPLG_CTL_ENUM:
1044 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1045 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1046 err = soc_tplg_denum_create_texts(se, ec);
1049 "ASoC: could not create texts for %s\n",
1057 "ASoC: invalid enum control type %d for %s\n",
1058 ec->hdr.ops.info, ec->hdr.name);
1063 /* map io handlers */
1064 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1066 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1071 /* pass control to driver for optional further init */
1072 err = soc_tplg_init_kcontrol(tplg, &kc,
1073 (struct snd_soc_tplg_ctl_hdr *) ec);
1075 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1081 /* register control here */
1082 ret = soc_tplg_add_kcontrol(tplg,
1083 &kc, &se->dobj.control.kcontrol);
1085 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1091 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1097 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1098 struct snd_soc_tplg_hdr *hdr)
1100 struct snd_soc_tplg_ctl_hdr *control_hdr;
1103 if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1104 tplg->pos += hdr->size + hdr->payload_size;
1108 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1109 soc_tplg_get_offset(tplg));
1111 for (i = 0; i < hdr->count; i++) {
1113 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1115 if (control_hdr->size != sizeof(*control_hdr)) {
1116 dev_err(tplg->dev, "ASoC: invalid control size\n");
1120 switch (control_hdr->ops.info) {
1121 case SND_SOC_TPLG_CTL_VOLSW:
1122 case SND_SOC_TPLG_CTL_STROBE:
1123 case SND_SOC_TPLG_CTL_VOLSW_SX:
1124 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1125 case SND_SOC_TPLG_CTL_RANGE:
1126 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1127 case SND_SOC_TPLG_DAPM_CTL_PIN:
1128 soc_tplg_dmixer_create(tplg, 1, hdr->payload_size);
1130 case SND_SOC_TPLG_CTL_ENUM:
1131 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1132 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1133 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1134 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1135 soc_tplg_denum_create(tplg, 1, hdr->payload_size);
1137 case SND_SOC_TPLG_CTL_BYTES:
1138 soc_tplg_dbytes_create(tplg, 1, hdr->payload_size);
1141 soc_bind_err(tplg, control_hdr, i);
1149 /* optionally pass new dynamic kcontrol to component driver. */
1150 static int soc_tplg_add_route(struct soc_tplg *tplg,
1151 struct snd_soc_dapm_route *route)
1153 if (tplg->comp && tplg->ops && tplg->ops->dapm_route_load)
1154 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1160 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1161 struct snd_soc_tplg_hdr *hdr)
1163 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1164 struct snd_soc_tplg_dapm_graph_elem *elem;
1165 struct snd_soc_dapm_route **routes;
1166 int count = hdr->count, i, j;
1169 if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1170 tplg->pos += hdr->size + hdr->payload_size;
1174 if (soc_tplg_check_elem_count(tplg,
1175 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1176 count, hdr->payload_size, "graph")) {
1178 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1183 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1186 /* allocate memory for pointer to array of dapm routes */
1187 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1193 * allocate memory for each dapm route in the array.
1194 * This needs to be done individually so that
1195 * each route can be freed when it is removed in remove_route().
1197 for (i = 0; i < count; i++) {
1198 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1200 /* free previously allocated memory */
1201 for (j = 0; j < i; j++)
1209 for (i = 0; i < count; i++) {
1210 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1211 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1213 /* validate routes */
1214 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1215 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1219 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1220 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1224 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1225 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1230 routes[i]->source = elem->source;
1231 routes[i]->sink = elem->sink;
1233 /* set to NULL atm for tplg users */
1234 routes[i]->connected = NULL;
1235 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1236 routes[i]->control = NULL;
1238 routes[i]->control = elem->control;
1240 /* add route dobj to dobj_list */
1241 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1242 routes[i]->dobj.ops = tplg->ops;
1243 routes[i]->dobj.index = tplg->index;
1244 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1246 soc_tplg_add_route(tplg, routes[i]);
1248 /* add route, but keep going if some fail */
1249 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1252 /* free memory allocated for all dapm routes in case of error */
1254 for (i = 0; i < count ; i++)
1258 * free pointer to array of dapm routes as this is no longer needed.
1259 * The memory allocated for each dapm route will be freed
1260 * when it is removed in remove_route().
1267 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1268 struct soc_tplg *tplg, int num_kcontrols)
1270 struct snd_kcontrol_new *kc;
1271 struct soc_mixer_control *sm;
1272 struct snd_soc_tplg_mixer_control *mc;
1275 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1279 for (i = 0; i < num_kcontrols; i++) {
1280 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1281 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1285 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1288 /* validate kcontrol */
1289 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1290 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1293 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1296 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1297 if (kc[i].name == NULL)
1299 kc[i].private_value = (long)sm;
1300 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1301 kc[i].access = mc->hdr.access;
1303 /* we only support FL/FR channel mapping atm */
1304 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1306 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1308 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1310 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1315 sm->invert = mc->invert;
1316 sm->platform_max = mc->platform_max;
1317 sm->dobj.index = tplg->index;
1318 INIT_LIST_HEAD(&sm->dobj.list);
1320 /* map io handlers */
1321 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1323 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1328 /* pass control to driver for optional further init */
1329 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1330 (struct snd_soc_tplg_ctl_hdr *)mc);
1332 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1338 /* create any TLV data */
1339 soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1346 for (--i; i >= 0; i--) {
1347 kfree((void *)kc[i].private_value);
1354 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1355 struct soc_tplg *tplg, int num_kcontrols)
1357 struct snd_kcontrol_new *kc;
1358 struct snd_soc_tplg_enum_control *ec;
1359 struct soc_enum *se;
1362 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1366 for (i = 0; i < num_kcontrols; i++) {
1367 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1368 /* validate kcontrol */
1369 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1370 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1373 se = kzalloc(sizeof(*se), GFP_KERNEL);
1377 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1380 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1381 if (kc[i].name == NULL) {
1385 kc[i].private_value = (long)se;
1386 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1387 kc[i].access = ec->hdr.access;
1389 /* we only support FL/FR channel mapping atm */
1390 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1391 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1393 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1396 se->items = ec->items;
1397 se->mask = ec->mask;
1398 se->dobj.index = tplg->index;
1400 switch (ec->hdr.ops.info) {
1401 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1402 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1403 err = soc_tplg_denum_create_values(se, ec);
1405 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1410 case SND_SOC_TPLG_CTL_ENUM:
1411 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1412 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1413 err = soc_tplg_denum_create_texts(se, ec);
1415 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1421 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1422 ec->hdr.ops.info, ec->hdr.name);
1426 /* map io handlers */
1427 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1429 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1433 /* pass control to driver for optional further init */
1434 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1435 (struct snd_soc_tplg_ctl_hdr *)ec);
1437 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1442 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1449 for (; i >= 0; i--) {
1450 /* free values and texts */
1451 se = (struct soc_enum *)kc[i].private_value;
1455 kfree(se->dobj.control.dvalues);
1456 for (j = 0; j < ec->items; j++)
1457 kfree(se->dobj.control.dtexts[j]);
1458 kfree(se->dobj.control.dtexts);
1469 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1470 struct soc_tplg *tplg, int count)
1472 struct snd_soc_tplg_bytes_control *be;
1473 struct soc_bytes_ext *sbe;
1474 struct snd_kcontrol_new *kc;
1477 kc = kcalloc(count, sizeof(*kc), GFP_KERNEL);
1481 for (i = 0; i < count; i++) {
1482 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1484 /* validate kcontrol */
1485 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1486 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1489 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1493 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1497 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1498 be->hdr.name, be->hdr.access);
1500 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1501 if (kc[i].name == NULL) {
1505 kc[i].private_value = (long)sbe;
1506 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1507 kc[i].access = be->hdr.access;
1510 INIT_LIST_HEAD(&sbe->dobj.list);
1512 /* map standard io handlers and check for external handlers */
1513 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1515 soc_control_err(tplg, &be->hdr, be->hdr.name);
1520 /* pass control to driver for optional further init */
1521 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1522 (struct snd_soc_tplg_ctl_hdr *)be);
1524 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1534 for (--i; i >= 0; i--) {
1535 kfree((void *)kc[i].private_value);
1543 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1544 struct snd_soc_tplg_dapm_widget *w)
1546 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1547 struct snd_soc_dapm_widget template, *widget;
1548 struct snd_soc_tplg_ctl_hdr *control_hdr;
1549 struct snd_soc_card *card = tplg->comp->card;
1550 unsigned int kcontrol_type;
1553 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1554 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1556 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1557 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1560 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1563 memset(&template, 0, sizeof(template));
1565 /* map user to kernel widget ID */
1566 template.id = get_widget_id(w->id);
1567 if (template.id < 0)
1570 /* strings are allocated here, but used and freed by the widget */
1571 template.name = kstrdup(w->name, GFP_KERNEL);
1574 template.sname = kstrdup(w->sname, GFP_KERNEL);
1575 if (!template.sname) {
1579 template.reg = w->reg;
1580 template.shift = w->shift;
1581 template.mask = w->mask;
1582 template.subseq = w->subseq;
1583 template.on_val = w->invert ? 0 : 1;
1584 template.off_val = w->invert ? 1 : 0;
1585 template.ignore_suspend = w->ignore_suspend;
1586 template.event_flags = w->event_flags;
1587 template.dobj.index = tplg->index;
1590 (sizeof(struct snd_soc_tplg_dapm_widget) + w->priv.size);
1591 if (w->num_kcontrols == 0) {
1593 template.num_kcontrols = 0;
1597 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1598 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1599 w->name, w->num_kcontrols, control_hdr->type);
1601 switch (control_hdr->ops.info) {
1602 case SND_SOC_TPLG_CTL_VOLSW:
1603 case SND_SOC_TPLG_CTL_STROBE:
1604 case SND_SOC_TPLG_CTL_VOLSW_SX:
1605 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1606 case SND_SOC_TPLG_CTL_RANGE:
1607 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1608 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1609 template.num_kcontrols = w->num_kcontrols;
1610 template.kcontrol_news =
1611 soc_tplg_dapm_widget_dmixer_create(tplg,
1612 template.num_kcontrols);
1613 if (!template.kcontrol_news) {
1618 case SND_SOC_TPLG_CTL_ENUM:
1619 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1620 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1621 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1622 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1623 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1624 template.num_kcontrols = w->num_kcontrols;
1625 template.kcontrol_news =
1626 soc_tplg_dapm_widget_denum_create(tplg,
1627 template.num_kcontrols);
1628 if (!template.kcontrol_news) {
1633 case SND_SOC_TPLG_CTL_BYTES:
1634 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1635 template.num_kcontrols = w->num_kcontrols;
1636 template.kcontrol_news =
1637 soc_tplg_dapm_widget_dbytes_create(tplg,
1638 template.num_kcontrols);
1639 if (!template.kcontrol_news) {
1645 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1646 control_hdr->ops.get, control_hdr->ops.put,
1647 control_hdr->ops.info);
1653 ret = soc_tplg_widget_load(tplg, &template, w);
1657 /* card dapm mutex is held by the core if we are loading topology
1658 * data during sound card init. */
1659 if (card->instantiated)
1660 widget = snd_soc_dapm_new_control(dapm, &template);
1662 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1663 if (IS_ERR(widget)) {
1664 ret = PTR_ERR(widget);
1668 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1669 widget->dobj.widget.kcontrol_type = kcontrol_type;
1670 widget->dobj.ops = tplg->ops;
1671 widget->dobj.index = tplg->index;
1672 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1674 ret = soc_tplg_widget_ready(tplg, widget, w);
1678 kfree(template.sname);
1679 kfree(template.name);
1684 snd_soc_tplg_widget_remove(widget);
1685 snd_soc_dapm_free_widget(widget);
1687 kfree(template.sname);
1689 kfree(template.name);
1693 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1694 struct snd_soc_tplg_hdr *hdr)
1696 struct snd_soc_tplg_dapm_widget *widget;
1697 int ret, count = hdr->count, i;
1699 if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1702 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1704 for (i = 0; i < count; i++) {
1705 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1706 if (widget->size != sizeof(*widget)) {
1707 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1711 ret = soc_tplg_dapm_widget_create(tplg, widget);
1713 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1722 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1724 struct snd_soc_card *card = tplg->comp->card;
1727 /* Card might not have been registered at this point.
1728 * If so, just return success.
1730 if (!card || !card->instantiated) {
1731 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1732 " widget card binding deferred\n");
1736 ret = snd_soc_dapm_new_widgets(card);
1738 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1744 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1745 struct snd_soc_tplg_stream_caps *caps)
1747 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1748 stream->channels_min = caps->channels_min;
1749 stream->channels_max = caps->channels_max;
1750 stream->rates = caps->rates;
1751 stream->rate_min = caps->rate_min;
1752 stream->rate_max = caps->rate_max;
1753 stream->formats = caps->formats;
1754 stream->sig_bits = caps->sig_bits;
1757 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1758 unsigned int flag_mask, unsigned int flags)
1760 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1761 dai_drv->symmetric_rates =
1762 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1764 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1765 dai_drv->symmetric_channels =
1766 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1769 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1770 dai_drv->symmetric_samplebits =
1771 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1775 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1776 struct snd_soc_tplg_pcm *pcm)
1778 struct snd_soc_dai_driver *dai_drv;
1779 struct snd_soc_pcm_stream *stream;
1780 struct snd_soc_tplg_stream_caps *caps;
1783 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1784 if (dai_drv == NULL)
1787 if (strlen(pcm->dai_name))
1788 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1789 dai_drv->id = pcm->dai_id;
1791 if (pcm->playback) {
1792 stream = &dai_drv->playback;
1793 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1794 set_stream_info(stream, caps);
1798 stream = &dai_drv->capture;
1799 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1800 set_stream_info(stream, caps);
1804 dai_drv->compress_new = snd_soc_new_compress;
1806 /* pass control to component driver for optional further init */
1807 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1809 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1814 dai_drv->dobj.index = tplg->index;
1815 dai_drv->dobj.ops = tplg->ops;
1816 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1817 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1819 /* register the DAI to the component */
1820 return snd_soc_register_dai(tplg->comp, dai_drv);
1823 static void set_link_flags(struct snd_soc_dai_link *link,
1824 unsigned int flag_mask, unsigned int flags)
1826 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1827 link->symmetric_rates =
1828 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1830 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1831 link->symmetric_channels =
1832 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1835 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1836 link->symmetric_samplebits =
1837 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1840 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1841 link->ignore_suspend =
1842 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1846 /* create the FE DAI link */
1847 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1848 struct snd_soc_tplg_pcm *pcm)
1850 struct snd_soc_dai_link *link;
1853 link = kzalloc(sizeof(struct snd_soc_dai_link), GFP_KERNEL);
1857 if (strlen(pcm->pcm_name)) {
1858 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1859 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1861 link->id = pcm->pcm_id;
1863 if (strlen(pcm->dai_name))
1864 link->cpu_dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1866 link->codec_name = "snd-soc-dummy";
1867 link->codec_dai_name = "snd-soc-dummy-dai";
1871 link->dpcm_playback = pcm->playback;
1872 link->dpcm_capture = pcm->capture;
1874 set_link_flags(link, pcm->flag_mask, pcm->flags);
1876 /* pass control to component driver for optional further init */
1877 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1879 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1884 link->dobj.index = tplg->index;
1885 link->dobj.ops = tplg->ops;
1886 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1887 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1889 snd_soc_add_dai_link(tplg->comp->card, link);
1893 /* create a FE DAI and DAI link from the PCM object */
1894 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1895 struct snd_soc_tplg_pcm *pcm)
1899 ret = soc_tplg_dai_create(tplg, pcm);
1903 return soc_tplg_fe_link_create(tplg, pcm);
1906 /* copy stream caps from the old version 4 of source */
1907 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1908 struct snd_soc_tplg_stream_caps_v4 *src)
1910 dest->size = sizeof(*dest);
1911 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1912 dest->formats = src->formats;
1913 dest->rates = src->rates;
1914 dest->rate_min = src->rate_min;
1915 dest->rate_max = src->rate_max;
1916 dest->channels_min = src->channels_min;
1917 dest->channels_max = src->channels_max;
1918 dest->periods_min = src->periods_min;
1919 dest->periods_max = src->periods_max;
1920 dest->period_size_min = src->period_size_min;
1921 dest->period_size_max = src->period_size_max;
1922 dest->buffer_size_min = src->buffer_size_min;
1923 dest->buffer_size_max = src->buffer_size_max;
1927 * pcm_new_ver - Create the new version of PCM from the old version.
1928 * @tplg: topology context
1929 * @src: older version of pcm as a source
1930 * @pcm: latest version of pcm created from the source
1932 * Support from vesion 4. User should free the returned pcm manually.
1934 static int pcm_new_ver(struct soc_tplg *tplg,
1935 struct snd_soc_tplg_pcm *src,
1936 struct snd_soc_tplg_pcm **pcm)
1938 struct snd_soc_tplg_pcm *dest;
1939 struct snd_soc_tplg_pcm_v4 *src_v4;
1944 if (src->size != sizeof(*src_v4)) {
1945 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
1949 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
1950 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
1951 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
1955 dest->size = sizeof(*dest); /* size of latest abi version */
1956 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1957 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1958 dest->pcm_id = src_v4->pcm_id;
1959 dest->dai_id = src_v4->dai_id;
1960 dest->playback = src_v4->playback;
1961 dest->capture = src_v4->capture;
1962 dest->compress = src_v4->compress;
1963 dest->num_streams = src_v4->num_streams;
1964 for (i = 0; i < dest->num_streams; i++)
1965 memcpy(&dest->stream[i], &src_v4->stream[i],
1966 sizeof(struct snd_soc_tplg_stream));
1968 for (i = 0; i < 2; i++)
1969 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
1975 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
1976 struct snd_soc_tplg_hdr *hdr)
1978 struct snd_soc_tplg_pcm *pcm, *_pcm;
1979 int count = hdr->count;
1983 if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
1986 /* check the element size and count */
1987 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1988 if (pcm->size > sizeof(struct snd_soc_tplg_pcm)
1989 || pcm->size < sizeof(struct snd_soc_tplg_pcm_v4)) {
1990 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
1995 if (soc_tplg_check_elem_count(tplg,
1997 hdr->payload_size, "PCM DAI")) {
1998 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2003 for (i = 0; i < count; i++) {
2004 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2006 /* check ABI version by size, create a new version of pcm
2009 if (pcm->size == sizeof(*pcm)) {
2014 pcm_new_ver(tplg, pcm, &_pcm);
2017 /* create the FE DAIs and DAI links */
2018 soc_tplg_pcm_create(tplg, _pcm);
2020 /* offset by version-specific struct size and
2021 * real priv data size
2023 tplg->pos += pcm->size + _pcm->priv.size;
2026 kfree(_pcm); /* free the duplicated one */
2029 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2035 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2036 * @link: &snd_soc_dai_link which should be updated
2037 * @cfg: physical link configs.
2039 * Topology context contains a list of supported HW formats (configs) and
2040 * a default format ID for the physical link. This function will use this
2041 * default ID to choose the HW format to set the link's DAI format for init.
2043 static void set_link_hw_format(struct snd_soc_dai_link *link,
2044 struct snd_soc_tplg_link_config *cfg)
2046 struct snd_soc_tplg_hw_config *hw_config;
2047 unsigned char bclk_master, fsync_master;
2048 unsigned char invert_bclk, invert_fsync;
2051 for (i = 0; i < cfg->num_hw_configs; i++) {
2052 hw_config = &cfg->hw_config[i];
2053 if (hw_config->id != cfg->default_hw_config_id)
2056 link->dai_fmt = hw_config->fmt & SND_SOC_DAIFMT_FORMAT_MASK;
2059 switch (hw_config->clock_gated) {
2060 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2061 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2064 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2065 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2069 /* ignore the value */
2073 /* clock signal polarity */
2074 invert_bclk = hw_config->invert_bclk;
2075 invert_fsync = hw_config->invert_fsync;
2076 if (!invert_bclk && !invert_fsync)
2077 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2078 else if (!invert_bclk && invert_fsync)
2079 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2080 else if (invert_bclk && !invert_fsync)
2081 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2083 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2086 bclk_master = (hw_config->bclk_master ==
2087 SND_SOC_TPLG_BCLK_CM);
2088 fsync_master = (hw_config->fsync_master ==
2089 SND_SOC_TPLG_FSYNC_CM);
2090 if (bclk_master && fsync_master)
2091 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2092 else if (!bclk_master && fsync_master)
2093 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2094 else if (bclk_master && !fsync_master)
2095 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2097 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2102 * link_new_ver - Create a new physical link config from the old
2103 * version of source.
2104 * @tplg: topology context
2105 * @src: old version of phyical link config as a source
2106 * @link: latest version of physical link config created from the source
2108 * Support from vesion 4. User need free the returned link config manually.
2110 static int link_new_ver(struct soc_tplg *tplg,
2111 struct snd_soc_tplg_link_config *src,
2112 struct snd_soc_tplg_link_config **link)
2114 struct snd_soc_tplg_link_config *dest;
2115 struct snd_soc_tplg_link_config_v4 *src_v4;
2120 if (src->size != sizeof(struct snd_soc_tplg_link_config_v4)) {
2121 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2125 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2127 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2128 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2132 dest->size = sizeof(*dest);
2133 dest->id = src_v4->id;
2134 dest->num_streams = src_v4->num_streams;
2135 for (i = 0; i < dest->num_streams; i++)
2136 memcpy(&dest->stream[i], &src_v4->stream[i],
2137 sizeof(struct snd_soc_tplg_stream));
2143 /* Find and configure an existing physical DAI link */
2144 static int soc_tplg_link_config(struct soc_tplg *tplg,
2145 struct snd_soc_tplg_link_config *cfg)
2147 struct snd_soc_dai_link *link;
2148 const char *name, *stream_name;
2152 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2153 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2160 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2161 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2164 stream_name = cfg->stream_name;
2168 link = snd_soc_find_dai_link(tplg->comp->card, cfg->id,
2171 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2177 if (cfg->num_hw_configs)
2178 set_link_hw_format(link, cfg);
2182 set_link_flags(link, cfg->flag_mask, cfg->flags);
2184 /* pass control to component driver for optional further init */
2185 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2187 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2191 /* for unloading it in snd_soc_tplg_component_remove */
2192 link->dobj.index = tplg->index;
2193 link->dobj.ops = tplg->ops;
2194 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2195 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2201 /* Load physical link config elements from the topology context */
2202 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2203 struct snd_soc_tplg_hdr *hdr)
2205 struct snd_soc_tplg_link_config *link, *_link;
2206 int count = hdr->count;
2210 if (tplg->pass != SOC_TPLG_PASS_LINK) {
2211 tplg->pos += hdr->size + hdr->payload_size;
2215 /* check the element size and count */
2216 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2217 if (link->size > sizeof(struct snd_soc_tplg_link_config)
2218 || link->size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2219 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2224 if (soc_tplg_check_elem_count(tplg,
2226 hdr->payload_size, "physical link config")) {
2227 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2232 /* config physical DAI links */
2233 for (i = 0; i < count; i++) {
2234 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2235 if (link->size == sizeof(*link)) {
2240 ret = link_new_ver(tplg, link, &_link);
2245 ret = soc_tplg_link_config(tplg, _link);
2249 /* offset by version-specific struct size and
2250 * real priv data size
2252 tplg->pos += link->size + _link->priv.size;
2255 kfree(_link); /* free the duplicated one */
2262 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2263 * @tplg: topology context
2264 * @d: physical DAI configs.
2266 * The physical dai should already be registered by the platform driver.
2267 * The platform driver should specify the DAI name and ID for matching.
2269 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2270 struct snd_soc_tplg_dai *d)
2272 struct snd_soc_dai_link_component dai_component = {0};
2273 struct snd_soc_dai *dai;
2274 struct snd_soc_dai_driver *dai_drv;
2275 struct snd_soc_pcm_stream *stream;
2276 struct snd_soc_tplg_stream_caps *caps;
2279 dai_component.dai_name = d->dai_name;
2280 dai = snd_soc_find_dai(&dai_component);
2282 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2287 if (d->dai_id != dai->id) {
2288 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2293 dai_drv = dai->driver;
2298 stream = &dai_drv->playback;
2299 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2300 set_stream_info(stream, caps);
2304 stream = &dai_drv->capture;
2305 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2306 set_stream_info(stream, caps);
2310 set_dai_flags(dai_drv, d->flag_mask, d->flags);
2312 /* pass control to component driver for optional further init */
2313 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2315 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2322 /* load physical DAI elements */
2323 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2324 struct snd_soc_tplg_hdr *hdr)
2326 struct snd_soc_tplg_dai *dai;
2327 int count = hdr->count;
2330 if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2333 /* config the existing BE DAIs */
2334 for (i = 0; i < count; i++) {
2335 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2336 if (dai->size != sizeof(*dai)) {
2337 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2341 soc_tplg_dai_config(tplg, dai);
2342 tplg->pos += (sizeof(*dai) + dai->priv.size);
2345 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2350 * manifest_new_ver - Create a new version of manifest from the old version
2352 * @tplg: topology context
2353 * @src: old version of manifest as a source
2354 * @manifest: latest version of manifest created from the source
2356 * Support from vesion 4. Users need free the returned manifest manually.
2358 static int manifest_new_ver(struct soc_tplg *tplg,
2359 struct snd_soc_tplg_manifest *src,
2360 struct snd_soc_tplg_manifest **manifest)
2362 struct snd_soc_tplg_manifest *dest;
2363 struct snd_soc_tplg_manifest_v4 *src_v4;
2367 if (src->size != sizeof(*src_v4)) {
2368 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2372 src->size = sizeof(*src_v4);
2375 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2377 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2378 dest = kzalloc(sizeof(*dest) + src_v4->priv.size, GFP_KERNEL);
2382 dest->size = sizeof(*dest); /* size of latest abi version */
2383 dest->control_elems = src_v4->control_elems;
2384 dest->widget_elems = src_v4->widget_elems;
2385 dest->graph_elems = src_v4->graph_elems;
2386 dest->pcm_elems = src_v4->pcm_elems;
2387 dest->dai_link_elems = src_v4->dai_link_elems;
2388 dest->priv.size = src_v4->priv.size;
2389 if (dest->priv.size)
2390 memcpy(dest->priv.data, src_v4->priv.data,
2397 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2398 struct snd_soc_tplg_hdr *hdr)
2400 struct snd_soc_tplg_manifest *manifest, *_manifest;
2404 if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2407 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2409 /* check ABI version by size, create a new manifest if abi not match */
2410 if (manifest->size == sizeof(*manifest)) {
2412 _manifest = manifest;
2415 err = manifest_new_ver(tplg, manifest, &_manifest);
2420 /* pass control to component driver for optional further init */
2421 if (tplg->comp && tplg->ops && tplg->ops->manifest)
2422 return tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2424 if (!abi_match) /* free the duplicated one */
2430 /* validate header magic, size and type */
2431 static int soc_valid_header(struct soc_tplg *tplg,
2432 struct snd_soc_tplg_hdr *hdr)
2434 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2437 if (hdr->size != sizeof(*hdr)) {
2439 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2440 hdr->type, soc_tplg_get_hdr_offset(tplg),
2445 /* big endian firmware objects not supported atm */
2446 if (hdr->magic == cpu_to_be32(SND_SOC_TPLG_MAGIC)) {
2448 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2449 tplg->pass, hdr->magic,
2450 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2454 if (hdr->magic != SND_SOC_TPLG_MAGIC) {
2456 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2457 tplg->pass, hdr->magic,
2458 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2462 /* Support ABI from version 4 */
2463 if (hdr->abi > SND_SOC_TPLG_ABI_VERSION
2464 || hdr->abi < SND_SOC_TPLG_ABI_VERSION_MIN) {
2466 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2467 tplg->pass, hdr->abi,
2468 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2473 if (hdr->payload_size == 0) {
2474 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2475 soc_tplg_get_hdr_offset(tplg));
2479 if (tplg->pass == hdr->type)
2481 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2482 hdr->payload_size, hdr->type, hdr->version,
2483 hdr->vendor_type, tplg->pass);
2488 /* check header type and call appropriate handler */
2489 static int soc_tplg_load_header(struct soc_tplg *tplg,
2490 struct snd_soc_tplg_hdr *hdr)
2492 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2494 /* check for matching ID */
2495 if (hdr->index != tplg->req_index &&
2496 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2499 tplg->index = hdr->index;
2501 switch (hdr->type) {
2502 case SND_SOC_TPLG_TYPE_MIXER:
2503 case SND_SOC_TPLG_TYPE_ENUM:
2504 case SND_SOC_TPLG_TYPE_BYTES:
2505 return soc_tplg_kcontrol_elems_load(tplg, hdr);
2506 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2507 return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2508 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2509 return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2510 case SND_SOC_TPLG_TYPE_PCM:
2511 return soc_tplg_pcm_elems_load(tplg, hdr);
2512 case SND_SOC_TPLG_TYPE_DAI:
2513 return soc_tplg_dai_elems_load(tplg, hdr);
2514 case SND_SOC_TPLG_TYPE_DAI_LINK:
2515 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2516 /* physical link configurations */
2517 return soc_tplg_link_elems_load(tplg, hdr);
2518 case SND_SOC_TPLG_TYPE_MANIFEST:
2519 return soc_tplg_manifest_load(tplg, hdr);
2521 /* bespoke vendor data object */
2522 return soc_tplg_vendor_load(tplg, hdr);
2528 /* process the topology file headers */
2529 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2531 struct snd_soc_tplg_hdr *hdr;
2534 tplg->pass = SOC_TPLG_PASS_START;
2536 /* process the header types from start to end */
2537 while (tplg->pass <= SOC_TPLG_PASS_END) {
2539 tplg->hdr_pos = tplg->fw->data;
2540 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2542 while (!soc_tplg_is_eof(tplg)) {
2544 /* make sure header is valid before loading */
2545 ret = soc_valid_header(tplg, hdr);
2551 /* load the header object */
2552 ret = soc_tplg_load_header(tplg, hdr);
2556 /* goto next header */
2557 tplg->hdr_pos += hdr->payload_size +
2558 sizeof(struct snd_soc_tplg_hdr);
2559 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2562 /* next data type pass */
2566 /* signal DAPM we are complete */
2567 ret = soc_tplg_dapm_complete(tplg);
2570 "ASoC: failed to initialise DAPM from Firmware\n");
2575 static int soc_tplg_load(struct soc_tplg *tplg)
2579 ret = soc_tplg_process_headers(tplg);
2581 soc_tplg_complete(tplg);
2586 /* load audio component topology from "firmware" file */
2587 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2588 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2590 struct soc_tplg tplg;
2593 /* setup parsing context */
2594 memset(&tplg, 0, sizeof(tplg));
2596 tplg.dev = comp->dev;
2599 tplg.req_index = id;
2600 tplg.io_ops = ops->io_ops;
2601 tplg.io_ops_count = ops->io_ops_count;
2602 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2603 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2605 ret = soc_tplg_load(&tplg);
2606 /* free the created components if fail to load topology */
2608 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2612 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2614 /* remove this dynamic widget */
2615 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2617 /* make sure we are a widget */
2618 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2621 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2623 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2625 /* remove all dynamic widgets from this DAPM context */
2626 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2629 struct snd_soc_dapm_widget *w, *next_w;
2631 list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2633 /* make sure we are a widget with correct context */
2634 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2638 if (w->dobj.index != index &&
2639 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2641 /* check and free and dynamic widget kcontrols */
2642 snd_soc_tplg_widget_remove(w);
2643 snd_soc_dapm_free_widget(w);
2645 snd_soc_dapm_reset_cache(dapm);
2647 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2649 /* remove dynamic controls from the component driver */
2650 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2652 struct snd_soc_dobj *dobj, *next_dobj;
2653 int pass = SOC_TPLG_PASS_END;
2655 /* process the header types from end to start */
2656 while (pass >= SOC_TPLG_PASS_START) {
2658 /* remove mixer controls */
2659 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2663 if (dobj->index != index &&
2664 index != SND_SOC_TPLG_INDEX_ALL)
2667 switch (dobj->type) {
2668 case SND_SOC_DOBJ_MIXER:
2669 remove_mixer(comp, dobj, pass);
2671 case SND_SOC_DOBJ_ENUM:
2672 remove_enum(comp, dobj, pass);
2674 case SND_SOC_DOBJ_BYTES:
2675 remove_bytes(comp, dobj, pass);
2677 case SND_SOC_DOBJ_GRAPH:
2678 remove_route(comp, dobj, pass);
2680 case SND_SOC_DOBJ_WIDGET:
2681 remove_widget(comp, dobj, pass);
2683 case SND_SOC_DOBJ_PCM:
2684 remove_dai(comp, dobj, pass);
2686 case SND_SOC_DOBJ_DAI_LINK:
2687 remove_link(comp, dobj, pass);
2689 case SND_SOC_DOBJ_BACKEND_LINK:
2691 * call link_unload ops if extra
2692 * deinitialization is needed.
2694 remove_backend_link(comp, dobj, pass);
2697 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2705 /* let caller know if FW can be freed when no objects are left */
2706 return !list_empty(&comp->dobj_list);
2708 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);