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>
33 #define SOC_TPLG_MAGIC_BIG_ENDIAN 0x436F5341 /* ASoC in reverse */
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).
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
51 #define SOC_TPLG_PASS_START SOC_TPLG_PASS_MANIFEST
52 #define SOC_TPLG_PASS_END SOC_TPLG_PASS_LINK
54 /* topology context */
56 const struct firmware *fw;
58 /* runtime FW parsing */
59 const u8 *pos; /* read postion */
60 const u8 *hdr_pos; /* header position */
61 unsigned int pass; /* pass number */
63 /* component caller */
65 struct snd_soc_component *comp;
66 u32 index; /* current block index */
67 u32 req_index; /* required index, only loaded/free matching blocks */
69 /* vendor specific kcontrol operations */
70 const struct snd_soc_tplg_kcontrol_ops *io_ops;
73 /* vendor specific bytes ext handlers, for TLV bytes controls */
74 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
75 int bytes_ext_ops_count;
77 /* optional fw loading callbacks to component drivers */
78 struct snd_soc_tplg_ops *ops;
81 static int soc_tplg_process_headers(struct soc_tplg *tplg);
82 static void soc_tplg_complete(struct soc_tplg *tplg);
83 static void soc_tplg_denum_remove_texts(struct soc_enum *se);
84 static void soc_tplg_denum_remove_values(struct soc_enum *se);
86 /* check we dont overflow the data for this control chunk */
87 static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
88 unsigned int count, size_t bytes, const char *elem_type)
90 const u8 *end = tplg->pos + elem_size * count;
92 if (end > tplg->fw->data + tplg->fw->size) {
93 dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
98 /* check there is enough room in chunk for control.
99 extra bytes at the end of control are for vendor data here */
100 if (elem_size * count > bytes) {
102 "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
103 elem_type, count, elem_size, bytes);
110 static inline int soc_tplg_is_eof(struct soc_tplg *tplg)
112 const u8 *end = tplg->hdr_pos;
114 if (end >= tplg->fw->data + tplg->fw->size)
119 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
121 return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
124 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
126 return (unsigned long)(tplg->pos - tplg->fw->data);
129 /* mapping of Kcontrol types and associated operations. */
130 static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
131 {SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
132 snd_soc_put_volsw, snd_soc_info_volsw},
133 {SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
134 snd_soc_put_volsw_sx, NULL},
135 {SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
136 snd_soc_put_enum_double, snd_soc_info_enum_double},
137 {SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
138 snd_soc_put_enum_double, NULL},
139 {SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
140 snd_soc_bytes_put, snd_soc_bytes_info},
141 {SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw_range,
142 snd_soc_put_volsw_range, snd_soc_info_volsw_range},
143 {SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
144 snd_soc_put_xr_sx, snd_soc_info_xr_sx},
145 {SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
146 snd_soc_put_strobe, NULL},
147 {SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
148 snd_soc_dapm_put_volsw, snd_soc_info_volsw},
149 {SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
150 snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
151 {SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
152 snd_soc_dapm_put_enum_double, NULL},
153 {SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
154 snd_soc_dapm_put_enum_double, NULL},
155 {SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
156 snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
159 struct soc_tplg_map {
164 /* mapping of widget types from UAPI IDs to kernel IDs */
165 static const struct soc_tplg_map dapm_map[] = {
166 {SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
167 {SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
168 {SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
169 {SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
170 {SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
171 {SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
172 {SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
173 {SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
174 {SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
175 {SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
176 {SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
177 {SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
178 {SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
179 {SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
180 {SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
181 {SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
182 {SND_SOC_TPLG_DAPM_BUFFER, snd_soc_dapm_buffer},
183 {SND_SOC_TPLG_DAPM_SCHEDULER, snd_soc_dapm_scheduler},
184 {SND_SOC_TPLG_DAPM_EFFECT, snd_soc_dapm_effect},
185 {SND_SOC_TPLG_DAPM_SIGGEN, snd_soc_dapm_siggen},
186 {SND_SOC_TPLG_DAPM_SRC, snd_soc_dapm_src},
187 {SND_SOC_TPLG_DAPM_ASRC, snd_soc_dapm_asrc},
188 {SND_SOC_TPLG_DAPM_ENCODER, snd_soc_dapm_encoder},
189 {SND_SOC_TPLG_DAPM_DECODER, snd_soc_dapm_decoder},
192 static int tplc_chan_get_reg(struct soc_tplg *tplg,
193 struct snd_soc_tplg_channel *chan, int map)
197 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
198 if (le32_to_cpu(chan[i].id) == map)
199 return le32_to_cpu(chan[i].reg);
205 static int tplc_chan_get_shift(struct soc_tplg *tplg,
206 struct snd_soc_tplg_channel *chan, int map)
210 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
211 if (le32_to_cpu(chan[i].id) == map)
212 return le32_to_cpu(chan[i].shift);
218 static int get_widget_id(int tplg_type)
222 for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
223 if (tplg_type == dapm_map[i].uid)
224 return dapm_map[i].kid;
230 static inline void soc_bind_err(struct soc_tplg *tplg,
231 struct snd_soc_tplg_ctl_hdr *hdr, int index)
234 "ASoC: invalid control type (g,p,i) %d:%d:%d index %d at 0x%lx\n",
235 hdr->ops.get, hdr->ops.put, hdr->ops.info, index,
236 soc_tplg_get_offset(tplg));
239 static inline void soc_control_err(struct soc_tplg *tplg,
240 struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
243 "ASoC: no complete mixer IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
244 name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
245 soc_tplg_get_offset(tplg));
248 /* pass vendor data to component driver for processing */
249 static int soc_tplg_vendor_load_(struct soc_tplg *tplg,
250 struct snd_soc_tplg_hdr *hdr)
254 if (tplg->comp && tplg->ops && tplg->ops->vendor_load)
255 ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
257 dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
264 "ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
265 soc_tplg_get_hdr_offset(tplg),
266 soc_tplg_get_hdr_offset(tplg),
267 hdr->type, hdr->vendor_type);
271 /* pass vendor data to component driver for processing */
272 static int soc_tplg_vendor_load(struct soc_tplg *tplg,
273 struct snd_soc_tplg_hdr *hdr)
275 if (tplg->pass != SOC_TPLG_PASS_VENDOR)
278 return soc_tplg_vendor_load_(tplg, hdr);
281 /* optionally pass new dynamic widget to component driver. This is mainly for
282 * external widgets where we can assign private data/ops */
283 static int soc_tplg_widget_load(struct soc_tplg *tplg,
284 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
286 if (tplg->comp && tplg->ops && tplg->ops->widget_load)
287 return tplg->ops->widget_load(tplg->comp, tplg->index, w,
293 /* optionally pass new dynamic widget to component driver. This is mainly for
294 * external widgets where we can assign private data/ops */
295 static int soc_tplg_widget_ready(struct soc_tplg *tplg,
296 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
298 if (tplg->comp && tplg->ops && tplg->ops->widget_ready)
299 return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
305 /* pass DAI configurations to component driver for extra initialization */
306 static int soc_tplg_dai_load(struct soc_tplg *tplg,
307 struct snd_soc_dai_driver *dai_drv,
308 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
310 if (tplg->comp && tplg->ops && tplg->ops->dai_load)
311 return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
317 /* pass link configurations to component driver for extra initialization */
318 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
319 struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
321 if (tplg->comp && tplg->ops && tplg->ops->link_load)
322 return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
327 /* tell the component driver that all firmware has been loaded in this request */
328 static void soc_tplg_complete(struct soc_tplg *tplg)
330 if (tplg->comp && tplg->ops && tplg->ops->complete)
331 tplg->ops->complete(tplg->comp);
334 /* add a dynamic kcontrol */
335 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
336 const struct snd_kcontrol_new *control_new, const char *prefix,
337 void *data, struct snd_kcontrol **kcontrol)
341 *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
342 if (*kcontrol == NULL) {
343 dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
348 err = snd_ctl_add(card, *kcontrol);
350 dev_err(dev, "ASoC: Failed to add %s: %d\n",
351 control_new->name, err);
358 /* add a dynamic kcontrol for component driver */
359 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
360 struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
362 struct snd_soc_component *comp = tplg->comp;
364 return soc_tplg_add_dcontrol(comp->card->snd_card,
365 comp->dev, k, comp->name_prefix, comp, kcontrol);
368 /* remove a mixer kcontrol */
369 static void remove_mixer(struct snd_soc_component *comp,
370 struct snd_soc_dobj *dobj, int pass)
372 struct snd_card *card = comp->card->snd_card;
373 struct soc_mixer_control *sm =
374 container_of(dobj, struct soc_mixer_control, dobj);
375 const unsigned int *p = NULL;
377 if (pass != SOC_TPLG_PASS_MIXER)
380 if (dobj->ops && dobj->ops->control_unload)
381 dobj->ops->control_unload(comp, dobj);
383 if (dobj->control.kcontrol->tlv.p)
384 p = dobj->control.kcontrol->tlv.p;
385 snd_ctl_remove(card, dobj->control.kcontrol);
386 list_del(&dobj->list);
391 /* remove an enum kcontrol */
392 static void remove_enum(struct snd_soc_component *comp,
393 struct snd_soc_dobj *dobj, int pass)
395 struct snd_card *card = comp->card->snd_card;
396 struct soc_enum *se = container_of(dobj, struct soc_enum, dobj);
398 if (pass != SOC_TPLG_PASS_MIXER)
401 if (dobj->ops && dobj->ops->control_unload)
402 dobj->ops->control_unload(comp, dobj);
404 snd_ctl_remove(card, dobj->control.kcontrol);
405 list_del(&dobj->list);
407 soc_tplg_denum_remove_values(se);
408 soc_tplg_denum_remove_texts(se);
412 /* remove a byte kcontrol */
413 static void remove_bytes(struct snd_soc_component *comp,
414 struct snd_soc_dobj *dobj, int pass)
416 struct snd_card *card = comp->card->snd_card;
417 struct soc_bytes_ext *sb =
418 container_of(dobj, struct soc_bytes_ext, dobj);
420 if (pass != SOC_TPLG_PASS_MIXER)
423 if (dobj->ops && dobj->ops->control_unload)
424 dobj->ops->control_unload(comp, dobj);
426 snd_ctl_remove(card, dobj->control.kcontrol);
427 list_del(&dobj->list);
432 static void remove_route(struct snd_soc_component *comp,
433 struct snd_soc_dobj *dobj, int pass)
435 struct snd_soc_dapm_route *route =
436 container_of(dobj, struct snd_soc_dapm_route, dobj);
438 if (pass != SOC_TPLG_PASS_GRAPH)
441 if (dobj->ops && dobj->ops->dapm_route_unload)
442 dobj->ops->dapm_route_unload(comp, dobj);
444 list_del(&dobj->list);
448 /* remove a widget and it's kcontrols - routes must be removed first */
449 static void remove_widget(struct snd_soc_component *comp,
450 struct snd_soc_dobj *dobj, int pass)
452 struct snd_card *card = comp->card->snd_card;
453 struct snd_soc_dapm_widget *w =
454 container_of(dobj, struct snd_soc_dapm_widget, dobj);
457 if (pass != SOC_TPLG_PASS_WIDGET)
460 if (dobj->ops && dobj->ops->widget_unload)
461 dobj->ops->widget_unload(comp, dobj);
467 * Dynamic Widgets either have 1..N enum kcontrols or mixers.
468 * The enum may either have an array of values or strings.
470 if (dobj->widget.kcontrol_type == SND_SOC_TPLG_TYPE_ENUM) {
471 /* enumerated widget mixer */
472 for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
473 struct snd_kcontrol *kcontrol = w->kcontrols[i];
474 struct soc_enum *se =
475 (struct soc_enum *)kcontrol->private_value;
477 snd_ctl_remove(card, kcontrol);
479 /* free enum kcontrol's dvalues and dtexts */
480 soc_tplg_denum_remove_values(se);
481 soc_tplg_denum_remove_texts(se);
484 kfree(w->kcontrol_news[i].name);
487 /* volume mixer or bytes controls */
488 for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
489 struct snd_kcontrol *kcontrol = w->kcontrols[i];
491 if (dobj->widget.kcontrol_type
492 == SND_SOC_TPLG_TYPE_MIXER)
493 kfree(kcontrol->tlv.p);
495 /* Private value is used as struct soc_mixer_control
496 * for volume mixers or soc_bytes_ext for bytes
499 kfree((void *)kcontrol->private_value);
500 snd_ctl_remove(card, kcontrol);
501 kfree(w->kcontrol_news[i].name);
506 kfree(w->kcontrol_news);
508 list_del(&dobj->list);
510 /* widget w is freed by soc-dapm.c */
513 /* remove DAI configurations */
514 static void remove_dai(struct snd_soc_component *comp,
515 struct snd_soc_dobj *dobj, int pass)
517 struct snd_soc_dai_driver *dai_drv =
518 container_of(dobj, struct snd_soc_dai_driver, dobj);
519 struct snd_soc_dai *dai;
521 if (pass != SOC_TPLG_PASS_PCM_DAI)
524 if (dobj->ops && dobj->ops->dai_unload)
525 dobj->ops->dai_unload(comp, dobj);
527 for_each_component_dais(comp, dai)
528 if (dai->driver == dai_drv)
531 kfree(dai_drv->playback.stream_name);
532 kfree(dai_drv->capture.stream_name);
533 kfree(dai_drv->name);
534 list_del(&dobj->list);
538 /* remove link configurations */
539 static void remove_link(struct snd_soc_component *comp,
540 struct snd_soc_dobj *dobj, int pass)
542 struct snd_soc_dai_link *link =
543 container_of(dobj, struct snd_soc_dai_link, dobj);
545 if (pass != SOC_TPLG_PASS_PCM_DAI)
548 if (dobj->ops && dobj->ops->link_unload)
549 dobj->ops->link_unload(comp, dobj);
551 list_del(&dobj->list);
552 snd_soc_remove_dai_link(comp->card, link);
555 kfree(link->stream_name);
556 kfree(link->cpus->dai_name);
560 /* unload dai link */
561 static void remove_backend_link(struct snd_soc_component *comp,
562 struct snd_soc_dobj *dobj, int pass)
564 if (pass != SOC_TPLG_PASS_LINK)
567 if (dobj->ops && dobj->ops->link_unload)
568 dobj->ops->link_unload(comp, dobj);
571 * We don't free the link here as what remove_link() do since BE
572 * links are not allocated by topology.
573 * We however need to reset the dobj type to its initial values
575 dobj->type = SND_SOC_DOBJ_NONE;
576 list_del(&dobj->list);
579 /* bind a kcontrol to it's IO handlers */
580 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
581 struct snd_kcontrol_new *k,
582 const struct soc_tplg *tplg)
584 const struct snd_soc_tplg_kcontrol_ops *ops;
585 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
588 if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
589 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
590 && (k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ
591 || k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
592 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
593 struct soc_bytes_ext *sbe;
594 struct snd_soc_tplg_bytes_control *be;
596 sbe = (struct soc_bytes_ext *)k->private_value;
597 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
599 /* TLV bytes controls need standard kcontrol info handler,
600 * TLV callback and extended put/get handlers.
602 k->info = snd_soc_bytes_info_ext;
603 k->tlv.c = snd_soc_bytes_tlv_callback;
605 ext_ops = tplg->bytes_ext_ops;
606 num_ops = tplg->bytes_ext_ops_count;
607 for (i = 0; i < num_ops; i++) {
609 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
610 sbe->put = ext_ops[i].put;
612 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
613 sbe->get = ext_ops[i].get;
616 if (sbe->put && sbe->get)
622 /* try and map vendor specific kcontrol handlers first */
624 num_ops = tplg->io_ops_count;
625 for (i = 0; i < num_ops; i++) {
627 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
629 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
631 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
632 k->info = ops[i].info;
635 /* vendor specific handlers found ? */
636 if (k->put && k->get && k->info)
639 /* none found so try standard kcontrol handlers */
641 num_ops = ARRAY_SIZE(io_ops);
642 for (i = 0; i < num_ops; i++) {
644 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
646 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
648 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
649 k->info = ops[i].info;
652 /* standard handlers found ? */
653 if (k->put && k->get && k->info)
656 /* nothing to bind */
660 /* bind a widgets to it's evnt handlers */
661 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
662 const struct snd_soc_tplg_widget_events *events,
663 int num_events, u16 event_type)
669 for (i = 0; i < num_events; i++) {
670 if (event_type == events[i].type) {
672 /* found - so assign event */
673 w->event = events[i].event_handler;
681 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
683 /* optionally pass new dynamic kcontrol to component driver. */
684 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
685 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
687 if (tplg->comp && tplg->ops && tplg->ops->control_load)
688 return tplg->ops->control_load(tplg->comp, tplg->index, k,
695 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
696 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
698 unsigned int item_len = 2 * sizeof(unsigned int);
701 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
705 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
707 p[2] = le32_to_cpu(scale->min);
708 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
709 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
711 kc->tlv.p = (void *)p;
715 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
716 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
718 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
719 u32 access = le32_to_cpu(tc->access);
721 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
724 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
726 switch (le32_to_cpu(tplg_tlv->type)) {
727 case SNDRV_CTL_TLVT_DB_SCALE:
728 return soc_tplg_create_tlv_db_scale(tplg, kc,
731 /* TODO: add support for other TLV types */
733 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
742 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
743 struct snd_kcontrol_new *kc)
748 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
751 struct snd_soc_tplg_bytes_control *be;
752 struct soc_bytes_ext *sbe;
753 struct snd_kcontrol_new kc;
756 if (soc_tplg_check_elem_count(tplg,
757 sizeof(struct snd_soc_tplg_bytes_control), count,
758 size, "mixer bytes")) {
759 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
764 for (i = 0; i < count; i++) {
765 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
767 /* validate kcontrol */
768 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
769 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
772 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
776 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
777 le32_to_cpu(be->priv.size));
780 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
781 be->hdr.name, be->hdr.access);
783 memset(&kc, 0, sizeof(kc));
784 kc.name = be->hdr.name;
785 kc.private_value = (long)sbe;
786 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
787 kc.access = le32_to_cpu(be->hdr.access);
789 sbe->max = le32_to_cpu(be->max);
790 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
791 sbe->dobj.ops = tplg->ops;
792 INIT_LIST_HEAD(&sbe->dobj.list);
794 /* map io handlers */
795 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
797 soc_control_err(tplg, &be->hdr, be->hdr.name);
802 /* pass control to driver for optional further init */
803 err = soc_tplg_init_kcontrol(tplg, &kc,
804 (struct snd_soc_tplg_ctl_hdr *)be);
806 dev_err(tplg->dev, "ASoC: failed to init %s\n",
812 /* register control here */
813 err = soc_tplg_add_kcontrol(tplg, &kc,
814 &sbe->dobj.control.kcontrol);
816 dev_err(tplg->dev, "ASoC: failed to add %s\n",
822 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
828 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
831 struct snd_soc_tplg_mixer_control *mc;
832 struct soc_mixer_control *sm;
833 struct snd_kcontrol_new kc;
836 if (soc_tplg_check_elem_count(tplg,
837 sizeof(struct snd_soc_tplg_mixer_control),
838 count, size, "mixers")) {
840 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
845 for (i = 0; i < count; i++) {
846 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
848 /* validate kcontrol */
849 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
850 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
853 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
856 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
857 le32_to_cpu(mc->priv.size));
860 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
861 mc->hdr.name, mc->hdr.access);
863 memset(&kc, 0, sizeof(kc));
864 kc.name = mc->hdr.name;
865 kc.private_value = (long)sm;
866 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
867 kc.access = le32_to_cpu(mc->hdr.access);
869 /* we only support FL/FR channel mapping atm */
870 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
872 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
874 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
876 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
879 sm->max = le32_to_cpu(mc->max);
880 sm->min = le32_to_cpu(mc->min);
881 sm->invert = le32_to_cpu(mc->invert);
882 sm->platform_max = le32_to_cpu(mc->platform_max);
883 sm->dobj.index = tplg->index;
884 sm->dobj.ops = tplg->ops;
885 sm->dobj.type = SND_SOC_DOBJ_MIXER;
886 INIT_LIST_HEAD(&sm->dobj.list);
888 /* map io handlers */
889 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
891 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
896 /* create any TLV data */
897 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
899 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
905 /* pass control to driver for optional further init */
906 err = soc_tplg_init_kcontrol(tplg, &kc,
907 (struct snd_soc_tplg_ctl_hdr *) mc);
909 dev_err(tplg->dev, "ASoC: failed to init %s\n",
911 soc_tplg_free_tlv(tplg, &kc);
916 /* register control here */
917 err = soc_tplg_add_kcontrol(tplg, &kc,
918 &sm->dobj.control.kcontrol);
920 dev_err(tplg->dev, "ASoC: failed to add %s\n",
922 soc_tplg_free_tlv(tplg, &kc);
927 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
933 static int soc_tplg_denum_create_texts(struct soc_enum *se,
934 struct snd_soc_tplg_enum_control *ec)
938 se->dobj.control.dtexts =
939 kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
940 if (se->dobj.control.dtexts == NULL)
943 for (i = 0; i < le32_to_cpu(ec->items); i++) {
945 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
946 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
951 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
952 if (!se->dobj.control.dtexts[i]) {
958 se->items = le32_to_cpu(ec->items);
959 se->texts = (const char * const *)se->dobj.control.dtexts;
964 soc_tplg_denum_remove_texts(se);
968 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
972 for (--i; i >= 0; i--)
973 kfree(se->dobj.control.dtexts[i]);
974 kfree(se->dobj.control.dtexts);
977 static int soc_tplg_denum_create_values(struct soc_enum *se,
978 struct snd_soc_tplg_enum_control *ec)
982 if (le32_to_cpu(ec->items) > sizeof(*ec->values))
985 se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
986 sizeof(*se->dobj.control.dvalues),
988 if (!se->dobj.control.dvalues)
991 /* convert from little-endian */
992 for (i = 0; i < le32_to_cpu(ec->items); i++) {
993 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
999 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
1001 kfree(se->dobj.control.dvalues);
1004 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
1007 struct snd_soc_tplg_enum_control *ec;
1008 struct soc_enum *se;
1009 struct snd_kcontrol_new kc;
1012 if (soc_tplg_check_elem_count(tplg,
1013 sizeof(struct snd_soc_tplg_enum_control),
1014 count, size, "enums")) {
1016 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1021 for (i = 0; i < count; i++) {
1022 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1024 /* validate kcontrol */
1025 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1026 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1029 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1033 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1034 le32_to_cpu(ec->priv.size));
1036 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1037 ec->hdr.name, ec->items);
1039 memset(&kc, 0, sizeof(kc));
1040 kc.name = ec->hdr.name;
1041 kc.private_value = (long)se;
1042 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1043 kc.access = le32_to_cpu(ec->hdr.access);
1045 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1046 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1048 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1051 se->mask = le32_to_cpu(ec->mask);
1052 se->dobj.index = tplg->index;
1053 se->dobj.type = SND_SOC_DOBJ_ENUM;
1054 se->dobj.ops = tplg->ops;
1055 INIT_LIST_HEAD(&se->dobj.list);
1057 switch (le32_to_cpu(ec->hdr.ops.info)) {
1058 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1059 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1060 err = soc_tplg_denum_create_values(se, ec);
1063 "ASoC: could not create values for %s\n",
1069 case SND_SOC_TPLG_CTL_ENUM:
1070 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1071 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1072 err = soc_tplg_denum_create_texts(se, ec);
1075 "ASoC: could not create texts for %s\n",
1083 "ASoC: invalid enum control type %d for %s\n",
1084 ec->hdr.ops.info, ec->hdr.name);
1089 /* map io handlers */
1090 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1092 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1097 /* pass control to driver for optional further init */
1098 err = soc_tplg_init_kcontrol(tplg, &kc,
1099 (struct snd_soc_tplg_ctl_hdr *) ec);
1101 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1107 /* register control here */
1108 ret = soc_tplg_add_kcontrol(tplg,
1109 &kc, &se->dobj.control.kcontrol);
1111 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1117 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1123 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1124 struct snd_soc_tplg_hdr *hdr)
1126 struct snd_soc_tplg_ctl_hdr *control_hdr;
1130 if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1131 tplg->pos += le32_to_cpu(hdr->size) +
1132 le32_to_cpu(hdr->payload_size);
1136 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1137 soc_tplg_get_offset(tplg));
1139 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1141 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1143 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1144 dev_err(tplg->dev, "ASoC: invalid control size\n");
1148 switch (le32_to_cpu(control_hdr->ops.info)) {
1149 case SND_SOC_TPLG_CTL_VOLSW:
1150 case SND_SOC_TPLG_CTL_STROBE:
1151 case SND_SOC_TPLG_CTL_VOLSW_SX:
1152 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1153 case SND_SOC_TPLG_CTL_RANGE:
1154 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1155 case SND_SOC_TPLG_DAPM_CTL_PIN:
1156 ret = soc_tplg_dmixer_create(tplg, 1,
1157 le32_to_cpu(hdr->payload_size));
1159 case SND_SOC_TPLG_CTL_ENUM:
1160 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1161 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1162 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1163 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1164 ret = soc_tplg_denum_create(tplg, 1,
1165 le32_to_cpu(hdr->payload_size));
1167 case SND_SOC_TPLG_CTL_BYTES:
1168 ret = soc_tplg_dbytes_create(tplg, 1,
1169 le32_to_cpu(hdr->payload_size));
1172 soc_bind_err(tplg, control_hdr, i);
1176 dev_err(tplg->dev, "ASoC: invalid control\n");
1185 /* optionally pass new dynamic kcontrol to component driver. */
1186 static int soc_tplg_add_route(struct soc_tplg *tplg,
1187 struct snd_soc_dapm_route *route)
1189 if (tplg->comp && tplg->ops && tplg->ops->dapm_route_load)
1190 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1196 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1197 struct snd_soc_tplg_hdr *hdr)
1199 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1200 struct snd_soc_tplg_dapm_graph_elem *elem;
1201 struct snd_soc_dapm_route **routes;
1205 count = le32_to_cpu(hdr->count);
1207 if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1209 le32_to_cpu(hdr->size) +
1210 le32_to_cpu(hdr->payload_size);
1215 if (soc_tplg_check_elem_count(tplg,
1216 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1217 count, le32_to_cpu(hdr->payload_size), "graph")) {
1219 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1224 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1227 /* allocate memory for pointer to array of dapm routes */
1228 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1234 * allocate memory for each dapm route in the array.
1235 * This needs to be done individually so that
1236 * each route can be freed when it is removed in remove_route().
1238 for (i = 0; i < count; i++) {
1239 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1241 /* free previously allocated memory */
1242 for (j = 0; j < i; j++)
1250 for (i = 0; i < count; i++) {
1251 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1252 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1254 /* validate routes */
1255 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1256 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1260 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1261 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1265 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1266 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1271 routes[i]->source = elem->source;
1272 routes[i]->sink = elem->sink;
1274 /* set to NULL atm for tplg users */
1275 routes[i]->connected = NULL;
1276 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1277 routes[i]->control = NULL;
1279 routes[i]->control = elem->control;
1281 /* add route dobj to dobj_list */
1282 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1283 routes[i]->dobj.ops = tplg->ops;
1284 routes[i]->dobj.index = tplg->index;
1285 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1287 ret = soc_tplg_add_route(tplg, routes[i]);
1290 * this route was added to the list, it will
1291 * be freed in remove_route() so increment the
1292 * counter to skip it in the error handling
1299 /* add route, but keep going if some fail */
1300 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1304 * free memory allocated for all dapm routes not added to the
1305 * list in case of error
1313 * free pointer to array of dapm routes as this is no longer needed.
1314 * The memory allocated for each dapm route will be freed
1315 * when it is removed in remove_route().
1322 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1323 struct soc_tplg *tplg, int num_kcontrols)
1325 struct snd_kcontrol_new *kc;
1326 struct soc_mixer_control *sm;
1327 struct snd_soc_tplg_mixer_control *mc;
1330 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1334 for (i = 0; i < num_kcontrols; i++) {
1335 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1337 /* validate kcontrol */
1338 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1339 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1342 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1346 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1347 le32_to_cpu(mc->priv.size));
1349 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1352 kc[i].private_value = (long)sm;
1353 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1354 if (kc[i].name == NULL)
1356 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1357 kc[i].access = le32_to_cpu(mc->hdr.access);
1359 /* we only support FL/FR channel mapping atm */
1360 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1362 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1364 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1366 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1369 sm->max = le32_to_cpu(mc->max);
1370 sm->min = le32_to_cpu(mc->min);
1371 sm->invert = le32_to_cpu(mc->invert);
1372 sm->platform_max = le32_to_cpu(mc->platform_max);
1373 sm->dobj.index = tplg->index;
1374 INIT_LIST_HEAD(&sm->dobj.list);
1376 /* map io handlers */
1377 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1379 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1383 /* create any TLV data */
1384 err = soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1386 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1392 /* pass control to driver for optional further init */
1393 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1394 (struct snd_soc_tplg_ctl_hdr *)mc);
1396 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1404 for (; i >= 0; i--) {
1405 soc_tplg_free_tlv(tplg, &kc[i]);
1406 sm = (struct soc_mixer_control *)kc[i].private_value;
1415 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1416 struct soc_tplg *tplg, int num_kcontrols)
1418 struct snd_kcontrol_new *kc;
1419 struct snd_soc_tplg_enum_control *ec;
1420 struct soc_enum *se;
1423 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1427 for (i = 0; i < num_kcontrols; i++) {
1428 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1429 /* validate kcontrol */
1430 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1431 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1434 se = kzalloc(sizeof(*se), GFP_KERNEL);
1438 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1439 le32_to_cpu(ec->priv.size));
1441 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1444 kc[i].private_value = (long)se;
1445 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1446 if (kc[i].name == NULL)
1448 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1449 kc[i].access = le32_to_cpu(ec->hdr.access);
1451 /* we only support FL/FR channel mapping atm */
1452 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1453 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1455 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1458 se->items = le32_to_cpu(ec->items);
1459 se->mask = le32_to_cpu(ec->mask);
1460 se->dobj.index = tplg->index;
1462 switch (le32_to_cpu(ec->hdr.ops.info)) {
1463 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1464 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1465 err = soc_tplg_denum_create_values(se, ec);
1467 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1472 case SND_SOC_TPLG_CTL_ENUM:
1473 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1474 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1475 err = soc_tplg_denum_create_texts(se, ec);
1477 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1483 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1484 ec->hdr.ops.info, ec->hdr.name);
1488 /* map io handlers */
1489 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1491 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1495 /* pass control to driver for optional further init */
1496 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1497 (struct snd_soc_tplg_ctl_hdr *)ec);
1499 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1508 for (; i >= 0; i--) {
1509 /* free values and texts */
1510 se = (struct soc_enum *)kc[i].private_value;
1513 soc_tplg_denum_remove_values(se);
1514 soc_tplg_denum_remove_texts(se);
1525 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1526 struct soc_tplg *tplg, int num_kcontrols)
1528 struct snd_soc_tplg_bytes_control *be;
1529 struct soc_bytes_ext *sbe;
1530 struct snd_kcontrol_new *kc;
1533 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1537 for (i = 0; i < num_kcontrols; i++) {
1538 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1540 /* validate kcontrol */
1541 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1542 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1545 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1549 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1550 le32_to_cpu(be->priv.size));
1553 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1554 be->hdr.name, be->hdr.access);
1556 kc[i].private_value = (long)sbe;
1557 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1558 if (kc[i].name == NULL)
1560 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1561 kc[i].access = le32_to_cpu(be->hdr.access);
1563 sbe->max = le32_to_cpu(be->max);
1564 INIT_LIST_HEAD(&sbe->dobj.list);
1566 /* map standard io handlers and check for external handlers */
1567 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1569 soc_control_err(tplg, &be->hdr, be->hdr.name);
1573 /* pass control to driver for optional further init */
1574 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1575 (struct snd_soc_tplg_ctl_hdr *)be);
1577 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1586 for (; i >= 0; i--) {
1587 sbe = (struct soc_bytes_ext *)kc[i].private_value;
1596 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1597 struct snd_soc_tplg_dapm_widget *w)
1599 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1600 struct snd_soc_dapm_widget template, *widget;
1601 struct snd_soc_tplg_ctl_hdr *control_hdr;
1602 struct snd_soc_card *card = tplg->comp->card;
1603 unsigned int kcontrol_type;
1606 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1607 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1609 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1610 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1613 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1616 memset(&template, 0, sizeof(template));
1618 /* map user to kernel widget ID */
1619 template.id = get_widget_id(le32_to_cpu(w->id));
1620 if ((int)template.id < 0)
1623 /* strings are allocated here, but used and freed by the widget */
1624 template.name = kstrdup(w->name, GFP_KERNEL);
1627 template.sname = kstrdup(w->sname, GFP_KERNEL);
1628 if (!template.sname) {
1632 template.reg = le32_to_cpu(w->reg);
1633 template.shift = le32_to_cpu(w->shift);
1634 template.mask = le32_to_cpu(w->mask);
1635 template.subseq = le32_to_cpu(w->subseq);
1636 template.on_val = w->invert ? 0 : 1;
1637 template.off_val = w->invert ? 1 : 0;
1638 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1639 template.event_flags = le16_to_cpu(w->event_flags);
1640 template.dobj.index = tplg->index;
1643 (sizeof(struct snd_soc_tplg_dapm_widget) +
1644 le32_to_cpu(w->priv.size));
1646 if (w->num_kcontrols == 0) {
1648 template.num_kcontrols = 0;
1652 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1653 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1654 w->name, w->num_kcontrols, control_hdr->type);
1656 switch (le32_to_cpu(control_hdr->ops.info)) {
1657 case SND_SOC_TPLG_CTL_VOLSW:
1658 case SND_SOC_TPLG_CTL_STROBE:
1659 case SND_SOC_TPLG_CTL_VOLSW_SX:
1660 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1661 case SND_SOC_TPLG_CTL_RANGE:
1662 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1663 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1664 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1665 template.kcontrol_news =
1666 soc_tplg_dapm_widget_dmixer_create(tplg,
1667 template.num_kcontrols);
1668 if (!template.kcontrol_news) {
1673 case SND_SOC_TPLG_CTL_ENUM:
1674 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1675 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1676 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1677 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1678 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1679 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1680 template.kcontrol_news =
1681 soc_tplg_dapm_widget_denum_create(tplg,
1682 template.num_kcontrols);
1683 if (!template.kcontrol_news) {
1688 case SND_SOC_TPLG_CTL_BYTES:
1689 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1690 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1691 template.kcontrol_news =
1692 soc_tplg_dapm_widget_dbytes_create(tplg,
1693 template.num_kcontrols);
1694 if (!template.kcontrol_news) {
1700 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1701 control_hdr->ops.get, control_hdr->ops.put,
1702 le32_to_cpu(control_hdr->ops.info));
1708 ret = soc_tplg_widget_load(tplg, &template, w);
1712 /* card dapm mutex is held by the core if we are loading topology
1713 * data during sound card init. */
1714 if (card->instantiated)
1715 widget = snd_soc_dapm_new_control(dapm, &template);
1717 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1718 if (IS_ERR(widget)) {
1719 ret = PTR_ERR(widget);
1723 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1724 widget->dobj.widget.kcontrol_type = kcontrol_type;
1725 widget->dobj.ops = tplg->ops;
1726 widget->dobj.index = tplg->index;
1727 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1729 ret = soc_tplg_widget_ready(tplg, widget, w);
1733 kfree(template.sname);
1734 kfree(template.name);
1739 snd_soc_tplg_widget_remove(widget);
1740 snd_soc_dapm_free_widget(widget);
1742 kfree(template.sname);
1744 kfree(template.name);
1748 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1749 struct snd_soc_tplg_hdr *hdr)
1751 struct snd_soc_tplg_dapm_widget *widget;
1754 count = le32_to_cpu(hdr->count);
1756 if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1759 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1761 for (i = 0; i < count; i++) {
1762 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1763 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1764 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1768 ret = soc_tplg_dapm_widget_create(tplg, widget);
1770 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1779 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1781 struct snd_soc_card *card = tplg->comp->card;
1784 /* Card might not have been registered at this point.
1785 * If so, just return success.
1787 if (!card || !card->instantiated) {
1788 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1789 " widget card binding deferred\n");
1793 ret = snd_soc_dapm_new_widgets(card);
1795 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1801 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1802 struct snd_soc_tplg_stream_caps *caps)
1804 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1805 stream->channels_min = le32_to_cpu(caps->channels_min);
1806 stream->channels_max = le32_to_cpu(caps->channels_max);
1807 stream->rates = le32_to_cpu(caps->rates);
1808 stream->rate_min = le32_to_cpu(caps->rate_min);
1809 stream->rate_max = le32_to_cpu(caps->rate_max);
1810 stream->formats = le64_to_cpu(caps->formats);
1811 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1814 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1815 unsigned int flag_mask, unsigned int flags)
1817 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1818 dai_drv->symmetric_rates =
1819 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1821 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1822 dai_drv->symmetric_channels =
1823 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1826 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1827 dai_drv->symmetric_samplebits =
1828 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1832 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1833 struct snd_soc_tplg_pcm *pcm)
1835 struct snd_soc_dai_driver *dai_drv;
1836 struct snd_soc_pcm_stream *stream;
1837 struct snd_soc_tplg_stream_caps *caps;
1840 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1841 if (dai_drv == NULL)
1844 if (strlen(pcm->dai_name))
1845 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1846 dai_drv->id = le32_to_cpu(pcm->dai_id);
1848 if (pcm->playback) {
1849 stream = &dai_drv->playback;
1850 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1851 set_stream_info(stream, caps);
1855 stream = &dai_drv->capture;
1856 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1857 set_stream_info(stream, caps);
1861 dai_drv->compress_new = snd_soc_new_compress;
1863 /* pass control to component driver for optional further init */
1864 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1866 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1867 kfree(dai_drv->playback.stream_name);
1868 kfree(dai_drv->capture.stream_name);
1869 kfree(dai_drv->name);
1874 dai_drv->dobj.index = tplg->index;
1875 dai_drv->dobj.ops = tplg->ops;
1876 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1877 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1879 /* register the DAI to the component */
1880 return snd_soc_register_dai(tplg->comp, dai_drv);
1883 static void set_link_flags(struct snd_soc_dai_link *link,
1884 unsigned int flag_mask, unsigned int flags)
1886 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1887 link->symmetric_rates =
1888 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1890 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1891 link->symmetric_channels =
1892 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1895 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1896 link->symmetric_samplebits =
1897 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1900 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1901 link->ignore_suspend =
1902 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1906 /* create the FE DAI link */
1907 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1908 struct snd_soc_tplg_pcm *pcm)
1910 struct snd_soc_dai_link *link;
1911 struct snd_soc_dai_link_component *dlc;
1914 /* link + cpu + codec + platform */
1915 link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1919 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1921 link->cpus = &dlc[0];
1922 link->codecs = &dlc[1];
1923 link->platforms = &dlc[2];
1926 link->num_codecs = 1;
1927 link->num_platforms = 1;
1929 link->dobj.index = tplg->index;
1930 link->dobj.ops = tplg->ops;
1931 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1933 if (strlen(pcm->pcm_name)) {
1934 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1935 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1937 link->id = le32_to_cpu(pcm->pcm_id);
1939 if (strlen(pcm->dai_name))
1940 link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1942 link->codecs->name = "snd-soc-dummy";
1943 link->codecs->dai_name = "snd-soc-dummy-dai";
1945 link->platforms->name = "snd-soc-dummy";
1949 link->dpcm_playback = le32_to_cpu(pcm->playback);
1950 link->dpcm_capture = le32_to_cpu(pcm->capture);
1952 set_link_flags(link,
1953 le32_to_cpu(pcm->flag_mask),
1954 le32_to_cpu(pcm->flags));
1956 /* pass control to component driver for optional further init */
1957 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1959 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1963 ret = snd_soc_add_dai_link(tplg->comp->card, link);
1965 dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1969 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1974 kfree(link->stream_name);
1975 kfree(link->cpus->dai_name);
1980 /* create a FE DAI and DAI link from the PCM object */
1981 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1982 struct snd_soc_tplg_pcm *pcm)
1986 ret = soc_tplg_dai_create(tplg, pcm);
1990 return soc_tplg_fe_link_create(tplg, pcm);
1993 /* copy stream caps from the old version 4 of source */
1994 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1995 struct snd_soc_tplg_stream_caps_v4 *src)
1997 dest->size = cpu_to_le32(sizeof(*dest));
1998 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1999 dest->formats = src->formats;
2000 dest->rates = src->rates;
2001 dest->rate_min = src->rate_min;
2002 dest->rate_max = src->rate_max;
2003 dest->channels_min = src->channels_min;
2004 dest->channels_max = src->channels_max;
2005 dest->periods_min = src->periods_min;
2006 dest->periods_max = src->periods_max;
2007 dest->period_size_min = src->period_size_min;
2008 dest->period_size_max = src->period_size_max;
2009 dest->buffer_size_min = src->buffer_size_min;
2010 dest->buffer_size_max = src->buffer_size_max;
2014 * pcm_new_ver - Create the new version of PCM from the old version.
2015 * @tplg: topology context
2016 * @src: older version of pcm as a source
2017 * @pcm: latest version of pcm created from the source
2019 * Support from vesion 4. User should free the returned pcm manually.
2021 static int pcm_new_ver(struct soc_tplg *tplg,
2022 struct snd_soc_tplg_pcm *src,
2023 struct snd_soc_tplg_pcm **pcm)
2025 struct snd_soc_tplg_pcm *dest;
2026 struct snd_soc_tplg_pcm_v4 *src_v4;
2031 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2032 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2036 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2037 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2038 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2042 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2043 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2044 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2045 dest->pcm_id = src_v4->pcm_id;
2046 dest->dai_id = src_v4->dai_id;
2047 dest->playback = src_v4->playback;
2048 dest->capture = src_v4->capture;
2049 dest->compress = src_v4->compress;
2050 dest->num_streams = src_v4->num_streams;
2051 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2052 memcpy(&dest->stream[i], &src_v4->stream[i],
2053 sizeof(struct snd_soc_tplg_stream));
2055 for (i = 0; i < 2; i++)
2056 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2062 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2063 struct snd_soc_tplg_hdr *hdr)
2065 struct snd_soc_tplg_pcm *pcm, *_pcm;
2072 count = le32_to_cpu(hdr->count);
2074 if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
2077 /* check the element size and count */
2078 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2079 size = le32_to_cpu(pcm->size);
2080 if (size > sizeof(struct snd_soc_tplg_pcm)
2081 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2082 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2087 if (soc_tplg_check_elem_count(tplg,
2089 le32_to_cpu(hdr->payload_size),
2091 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2096 for (i = 0; i < count; i++) {
2097 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2098 size = le32_to_cpu(pcm->size);
2100 /* check ABI version by size, create a new version of pcm
2103 if (size == sizeof(*pcm)) {
2108 ret = pcm_new_ver(tplg, pcm, &_pcm);
2113 /* create the FE DAIs and DAI links */
2114 ret = soc_tplg_pcm_create(tplg, _pcm);
2121 /* offset by version-specific struct size and
2122 * real priv data size
2124 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2127 kfree(_pcm); /* free the duplicated one */
2130 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2136 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2137 * @link: &snd_soc_dai_link which should be updated
2138 * @cfg: physical link configs.
2140 * Topology context contains a list of supported HW formats (configs) and
2141 * a default format ID for the physical link. This function will use this
2142 * default ID to choose the HW format to set the link's DAI format for init.
2144 static void set_link_hw_format(struct snd_soc_dai_link *link,
2145 struct snd_soc_tplg_link_config *cfg)
2147 struct snd_soc_tplg_hw_config *hw_config;
2148 unsigned char bclk_master, fsync_master;
2149 unsigned char invert_bclk, invert_fsync;
2152 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2153 hw_config = &cfg->hw_config[i];
2154 if (hw_config->id != cfg->default_hw_config_id)
2157 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2158 SND_SOC_DAIFMT_FORMAT_MASK;
2161 switch (hw_config->clock_gated) {
2162 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2163 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2166 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2167 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2171 /* ignore the value */
2175 /* clock signal polarity */
2176 invert_bclk = hw_config->invert_bclk;
2177 invert_fsync = hw_config->invert_fsync;
2178 if (!invert_bclk && !invert_fsync)
2179 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2180 else if (!invert_bclk && invert_fsync)
2181 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2182 else if (invert_bclk && !invert_fsync)
2183 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2185 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2188 bclk_master = (hw_config->bclk_master ==
2189 SND_SOC_TPLG_BCLK_CM);
2190 fsync_master = (hw_config->fsync_master ==
2191 SND_SOC_TPLG_FSYNC_CM);
2192 if (bclk_master && fsync_master)
2193 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2194 else if (!bclk_master && fsync_master)
2195 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2196 else if (bclk_master && !fsync_master)
2197 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2199 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2204 * link_new_ver - Create a new physical link config from the old
2205 * version of source.
2206 * @tplg: topology context
2207 * @src: old version of phyical link config as a source
2208 * @link: latest version of physical link config created from the source
2210 * Support from vesion 4. User need free the returned link config manually.
2212 static int link_new_ver(struct soc_tplg *tplg,
2213 struct snd_soc_tplg_link_config *src,
2214 struct snd_soc_tplg_link_config **link)
2216 struct snd_soc_tplg_link_config *dest;
2217 struct snd_soc_tplg_link_config_v4 *src_v4;
2222 if (le32_to_cpu(src->size) !=
2223 sizeof(struct snd_soc_tplg_link_config_v4)) {
2224 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2228 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2230 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2231 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2235 dest->size = cpu_to_le32(sizeof(*dest));
2236 dest->id = src_v4->id;
2237 dest->num_streams = src_v4->num_streams;
2238 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2239 memcpy(&dest->stream[i], &src_v4->stream[i],
2240 sizeof(struct snd_soc_tplg_stream));
2246 /* Find and configure an existing physical DAI link */
2247 static int soc_tplg_link_config(struct soc_tplg *tplg,
2248 struct snd_soc_tplg_link_config *cfg)
2250 struct snd_soc_dai_link *link;
2251 const char *name, *stream_name;
2255 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2256 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2263 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2264 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2267 stream_name = cfg->stream_name;
2271 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2274 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2280 if (cfg->num_hw_configs)
2281 set_link_hw_format(link, cfg);
2285 set_link_flags(link,
2286 le32_to_cpu(cfg->flag_mask),
2287 le32_to_cpu(cfg->flags));
2289 /* pass control to component driver for optional further init */
2290 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2292 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2296 /* for unloading it in snd_soc_tplg_component_remove */
2297 link->dobj.index = tplg->index;
2298 link->dobj.ops = tplg->ops;
2299 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2300 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2306 /* Load physical link config elements from the topology context */
2307 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2308 struct snd_soc_tplg_hdr *hdr)
2310 struct snd_soc_tplg_link_config *link, *_link;
2316 count = le32_to_cpu(hdr->count);
2318 if (tplg->pass != SOC_TPLG_PASS_LINK) {
2319 tplg->pos += le32_to_cpu(hdr->size) +
2320 le32_to_cpu(hdr->payload_size);
2324 /* check the element size and count */
2325 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2326 size = le32_to_cpu(link->size);
2327 if (size > sizeof(struct snd_soc_tplg_link_config)
2328 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2329 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2334 if (soc_tplg_check_elem_count(tplg,
2336 le32_to_cpu(hdr->payload_size),
2337 "physical link config")) {
2338 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2343 /* config physical DAI links */
2344 for (i = 0; i < count; i++) {
2345 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2346 size = le32_to_cpu(link->size);
2347 if (size == sizeof(*link)) {
2352 ret = link_new_ver(tplg, link, &_link);
2357 ret = soc_tplg_link_config(tplg, _link);
2364 /* offset by version-specific struct size and
2365 * real priv data size
2367 tplg->pos += size + le32_to_cpu(_link->priv.size);
2370 kfree(_link); /* free the duplicated one */
2377 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2378 * @tplg: topology context
2379 * @d: physical DAI configs.
2381 * The physical dai should already be registered by the platform driver.
2382 * The platform driver should specify the DAI name and ID for matching.
2384 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2385 struct snd_soc_tplg_dai *d)
2387 struct snd_soc_dai_link_component dai_component;
2388 struct snd_soc_dai *dai;
2389 struct snd_soc_dai_driver *dai_drv;
2390 struct snd_soc_pcm_stream *stream;
2391 struct snd_soc_tplg_stream_caps *caps;
2394 memset(&dai_component, 0, sizeof(dai_component));
2396 dai_component.dai_name = d->dai_name;
2397 dai = snd_soc_find_dai(&dai_component);
2399 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2404 if (le32_to_cpu(d->dai_id) != dai->id) {
2405 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2410 dai_drv = dai->driver;
2415 stream = &dai_drv->playback;
2416 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2417 set_stream_info(stream, caps);
2421 stream = &dai_drv->capture;
2422 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2423 set_stream_info(stream, caps);
2427 set_dai_flags(dai_drv,
2428 le32_to_cpu(d->flag_mask),
2429 le32_to_cpu(d->flags));
2431 /* pass control to component driver for optional further init */
2432 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2434 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2441 /* load physical DAI elements */
2442 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2443 struct snd_soc_tplg_hdr *hdr)
2445 struct snd_soc_tplg_dai *dai;
2449 count = le32_to_cpu(hdr->count);
2451 if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2454 /* config the existing BE DAIs */
2455 for (i = 0; i < count; i++) {
2456 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2457 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2458 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2462 ret = soc_tplg_dai_config(tplg, dai);
2464 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2468 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2471 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2476 * manifest_new_ver - Create a new version of manifest from the old version
2478 * @tplg: topology context
2479 * @src: old version of manifest as a source
2480 * @manifest: latest version of manifest created from the source
2482 * Support from vesion 4. Users need free the returned manifest manually.
2484 static int manifest_new_ver(struct soc_tplg *tplg,
2485 struct snd_soc_tplg_manifest *src,
2486 struct snd_soc_tplg_manifest **manifest)
2488 struct snd_soc_tplg_manifest *dest;
2489 struct snd_soc_tplg_manifest_v4 *src_v4;
2494 size = le32_to_cpu(src->size);
2495 if (size != sizeof(*src_v4)) {
2496 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2500 src->size = cpu_to_le32(sizeof(*src_v4));
2503 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2505 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2506 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2511 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2512 dest->control_elems = src_v4->control_elems;
2513 dest->widget_elems = src_v4->widget_elems;
2514 dest->graph_elems = src_v4->graph_elems;
2515 dest->pcm_elems = src_v4->pcm_elems;
2516 dest->dai_link_elems = src_v4->dai_link_elems;
2517 dest->priv.size = src_v4->priv.size;
2518 if (dest->priv.size)
2519 memcpy(dest->priv.data, src_v4->priv.data,
2520 le32_to_cpu(src_v4->priv.size));
2526 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2527 struct snd_soc_tplg_hdr *hdr)
2529 struct snd_soc_tplg_manifest *manifest, *_manifest;
2533 if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2536 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2538 /* check ABI version by size, create a new manifest if abi not match */
2539 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2541 _manifest = manifest;
2544 ret = manifest_new_ver(tplg, manifest, &_manifest);
2549 /* pass control to component driver for optional further init */
2550 if (tplg->comp && tplg->ops && tplg->ops->manifest)
2551 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2553 if (!abi_match) /* free the duplicated one */
2559 /* validate header magic, size and type */
2560 static int soc_valid_header(struct soc_tplg *tplg,
2561 struct snd_soc_tplg_hdr *hdr)
2563 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2566 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2568 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2569 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2574 /* big endian firmware objects not supported atm */
2575 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2577 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2578 tplg->pass, hdr->magic,
2579 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2583 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2585 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2586 tplg->pass, hdr->magic,
2587 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2591 /* Support ABI from version 4 */
2592 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2593 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2595 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2596 tplg->pass, hdr->abi,
2597 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2602 if (hdr->payload_size == 0) {
2603 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2604 soc_tplg_get_hdr_offset(tplg));
2608 if (tplg->pass == le32_to_cpu(hdr->type))
2610 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2611 hdr->payload_size, hdr->type, hdr->version,
2612 hdr->vendor_type, tplg->pass);
2617 /* check header type and call appropriate handler */
2618 static int soc_tplg_load_header(struct soc_tplg *tplg,
2619 struct snd_soc_tplg_hdr *hdr)
2621 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2623 /* check for matching ID */
2624 if (le32_to_cpu(hdr->index) != tplg->req_index &&
2625 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2628 tplg->index = le32_to_cpu(hdr->index);
2630 switch (le32_to_cpu(hdr->type)) {
2631 case SND_SOC_TPLG_TYPE_MIXER:
2632 case SND_SOC_TPLG_TYPE_ENUM:
2633 case SND_SOC_TPLG_TYPE_BYTES:
2634 return soc_tplg_kcontrol_elems_load(tplg, hdr);
2635 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2636 return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2637 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2638 return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2639 case SND_SOC_TPLG_TYPE_PCM:
2640 return soc_tplg_pcm_elems_load(tplg, hdr);
2641 case SND_SOC_TPLG_TYPE_DAI:
2642 return soc_tplg_dai_elems_load(tplg, hdr);
2643 case SND_SOC_TPLG_TYPE_DAI_LINK:
2644 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2645 /* physical link configurations */
2646 return soc_tplg_link_elems_load(tplg, hdr);
2647 case SND_SOC_TPLG_TYPE_MANIFEST:
2648 return soc_tplg_manifest_load(tplg, hdr);
2650 /* bespoke vendor data object */
2651 return soc_tplg_vendor_load(tplg, hdr);
2657 /* process the topology file headers */
2658 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2660 struct snd_soc_tplg_hdr *hdr;
2663 tplg->pass = SOC_TPLG_PASS_START;
2665 /* process the header types from start to end */
2666 while (tplg->pass <= SOC_TPLG_PASS_END) {
2668 tplg->hdr_pos = tplg->fw->data;
2669 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2671 while (!soc_tplg_is_eof(tplg)) {
2673 /* make sure header is valid before loading */
2674 ret = soc_valid_header(tplg, hdr);
2680 /* load the header object */
2681 ret = soc_tplg_load_header(tplg, hdr);
2685 /* goto next header */
2686 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2687 sizeof(struct snd_soc_tplg_hdr);
2688 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2691 /* next data type pass */
2695 /* signal DAPM we are complete */
2696 ret = soc_tplg_dapm_complete(tplg);
2699 "ASoC: failed to initialise DAPM from Firmware\n");
2704 static int soc_tplg_load(struct soc_tplg *tplg)
2708 ret = soc_tplg_process_headers(tplg);
2710 soc_tplg_complete(tplg);
2715 /* load audio component topology from "firmware" file */
2716 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2717 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2719 struct soc_tplg tplg;
2722 /* setup parsing context */
2723 memset(&tplg, 0, sizeof(tplg));
2725 tplg.dev = comp->dev;
2728 tplg.req_index = id;
2729 tplg.io_ops = ops->io_ops;
2730 tplg.io_ops_count = ops->io_ops_count;
2731 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2732 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2734 ret = soc_tplg_load(&tplg);
2735 /* free the created components if fail to load topology */
2737 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2741 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2743 /* remove this dynamic widget */
2744 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2746 /* make sure we are a widget */
2747 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2750 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2752 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2754 /* remove all dynamic widgets from this DAPM context */
2755 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2758 struct snd_soc_dapm_widget *w, *next_w;
2760 list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2762 /* make sure we are a widget with correct context */
2763 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2767 if (w->dobj.index != index &&
2768 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2770 /* check and free and dynamic widget kcontrols */
2771 snd_soc_tplg_widget_remove(w);
2772 snd_soc_dapm_free_widget(w);
2774 snd_soc_dapm_reset_cache(dapm);
2776 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2778 /* remove dynamic controls from the component driver */
2779 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2781 struct snd_card *card = comp->card->snd_card;
2782 struct snd_soc_dobj *dobj, *next_dobj;
2783 int pass = SOC_TPLG_PASS_END;
2785 /* process the header types from end to start */
2786 while (pass >= SOC_TPLG_PASS_START) {
2788 /* remove mixer controls */
2789 down_write(&card->controls_rwsem);
2790 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2794 if (dobj->index != index &&
2795 index != SND_SOC_TPLG_INDEX_ALL)
2798 switch (dobj->type) {
2799 case SND_SOC_DOBJ_MIXER:
2800 remove_mixer(comp, dobj, pass);
2802 case SND_SOC_DOBJ_ENUM:
2803 remove_enum(comp, dobj, pass);
2805 case SND_SOC_DOBJ_BYTES:
2806 remove_bytes(comp, dobj, pass);
2808 case SND_SOC_DOBJ_GRAPH:
2809 remove_route(comp, dobj, pass);
2811 case SND_SOC_DOBJ_WIDGET:
2812 remove_widget(comp, dobj, pass);
2814 case SND_SOC_DOBJ_PCM:
2815 remove_dai(comp, dobj, pass);
2817 case SND_SOC_DOBJ_DAI_LINK:
2818 remove_link(comp, dobj, pass);
2820 case SND_SOC_DOBJ_BACKEND_LINK:
2822 * call link_unload ops if extra
2823 * deinitialization is needed.
2825 remove_backend_link(comp, dobj, pass);
2828 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2833 up_write(&card->controls_rwsem);
2837 /* let caller know if FW can be freed when no objects are left */
2838 return !list_empty(&comp->dobj_list);
2840 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);