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_READWRITE
591 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
592 struct soc_bytes_ext *sbe;
593 struct snd_soc_tplg_bytes_control *be;
595 sbe = (struct soc_bytes_ext *)k->private_value;
596 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
598 /* TLV bytes controls need standard kcontrol info handler,
599 * TLV callback and extended put/get handlers.
601 k->info = snd_soc_bytes_info_ext;
602 k->tlv.c = snd_soc_bytes_tlv_callback;
604 ext_ops = tplg->bytes_ext_ops;
605 num_ops = tplg->bytes_ext_ops_count;
606 for (i = 0; i < num_ops; i++) {
608 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
609 sbe->put = ext_ops[i].put;
611 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
612 sbe->get = ext_ops[i].get;
615 if (sbe->put && sbe->get)
621 /* try and map vendor specific kcontrol handlers first */
623 num_ops = tplg->io_ops_count;
624 for (i = 0; i < num_ops; i++) {
626 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
628 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
630 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
631 k->info = ops[i].info;
634 /* vendor specific handlers found ? */
635 if (k->put && k->get && k->info)
638 /* none found so try standard kcontrol handlers */
640 num_ops = ARRAY_SIZE(io_ops);
641 for (i = 0; i < num_ops; i++) {
643 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
645 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
647 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
648 k->info = ops[i].info;
651 /* standard handlers found ? */
652 if (k->put && k->get && k->info)
655 /* nothing to bind */
659 /* bind a widgets to it's evnt handlers */
660 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
661 const struct snd_soc_tplg_widget_events *events,
662 int num_events, u16 event_type)
668 for (i = 0; i < num_events; i++) {
669 if (event_type == events[i].type) {
671 /* found - so assign event */
672 w->event = events[i].event_handler;
680 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
682 /* optionally pass new dynamic kcontrol to component driver. */
683 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
684 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
686 if (tplg->comp && tplg->ops && tplg->ops->control_load)
687 return tplg->ops->control_load(tplg->comp, tplg->index, k,
694 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
695 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
697 unsigned int item_len = 2 * sizeof(unsigned int);
700 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
704 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
706 p[2] = le32_to_cpu(scale->min);
707 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
708 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
710 kc->tlv.p = (void *)p;
714 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
715 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
717 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
718 u32 access = le32_to_cpu(tc->access);
720 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
723 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
725 switch (le32_to_cpu(tplg_tlv->type)) {
726 case SNDRV_CTL_TLVT_DB_SCALE:
727 return soc_tplg_create_tlv_db_scale(tplg, kc,
730 /* TODO: add support for other TLV types */
732 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
741 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
742 struct snd_kcontrol_new *kc)
747 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
750 struct snd_soc_tplg_bytes_control *be;
751 struct soc_bytes_ext *sbe;
752 struct snd_kcontrol_new kc;
755 if (soc_tplg_check_elem_count(tplg,
756 sizeof(struct snd_soc_tplg_bytes_control), count,
757 size, "mixer bytes")) {
758 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
763 for (i = 0; i < count; i++) {
764 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
766 /* validate kcontrol */
767 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
768 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
771 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
775 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
776 le32_to_cpu(be->priv.size));
779 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
780 be->hdr.name, be->hdr.access);
782 memset(&kc, 0, sizeof(kc));
783 kc.name = be->hdr.name;
784 kc.private_value = (long)sbe;
785 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
786 kc.access = le32_to_cpu(be->hdr.access);
788 sbe->max = le32_to_cpu(be->max);
789 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
790 sbe->dobj.ops = tplg->ops;
791 INIT_LIST_HEAD(&sbe->dobj.list);
793 /* map io handlers */
794 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
796 soc_control_err(tplg, &be->hdr, be->hdr.name);
801 /* pass control to driver for optional further init */
802 err = soc_tplg_init_kcontrol(tplg, &kc,
803 (struct snd_soc_tplg_ctl_hdr *)be);
805 dev_err(tplg->dev, "ASoC: failed to init %s\n",
811 /* register control here */
812 err = soc_tplg_add_kcontrol(tplg, &kc,
813 &sbe->dobj.control.kcontrol);
815 dev_err(tplg->dev, "ASoC: failed to add %s\n",
821 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
827 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
830 struct snd_soc_tplg_mixer_control *mc;
831 struct soc_mixer_control *sm;
832 struct snd_kcontrol_new kc;
835 if (soc_tplg_check_elem_count(tplg,
836 sizeof(struct snd_soc_tplg_mixer_control),
837 count, size, "mixers")) {
839 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
844 for (i = 0; i < count; i++) {
845 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
847 /* validate kcontrol */
848 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
849 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
852 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
855 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
856 le32_to_cpu(mc->priv.size));
859 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
860 mc->hdr.name, mc->hdr.access);
862 memset(&kc, 0, sizeof(kc));
863 kc.name = mc->hdr.name;
864 kc.private_value = (long)sm;
865 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
866 kc.access = le32_to_cpu(mc->hdr.access);
868 /* we only support FL/FR channel mapping atm */
869 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
871 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
873 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
875 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
878 sm->max = le32_to_cpu(mc->max);
879 sm->min = le32_to_cpu(mc->min);
880 sm->invert = le32_to_cpu(mc->invert);
881 sm->platform_max = le32_to_cpu(mc->platform_max);
882 sm->dobj.index = tplg->index;
883 sm->dobj.ops = tplg->ops;
884 sm->dobj.type = SND_SOC_DOBJ_MIXER;
885 INIT_LIST_HEAD(&sm->dobj.list);
887 /* map io handlers */
888 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
890 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
895 /* create any TLV data */
896 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
898 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
904 /* pass control to driver for optional further init */
905 err = soc_tplg_init_kcontrol(tplg, &kc,
906 (struct snd_soc_tplg_ctl_hdr *) mc);
908 dev_err(tplg->dev, "ASoC: failed to init %s\n",
910 soc_tplg_free_tlv(tplg, &kc);
915 /* register control here */
916 err = soc_tplg_add_kcontrol(tplg, &kc,
917 &sm->dobj.control.kcontrol);
919 dev_err(tplg->dev, "ASoC: failed to add %s\n",
921 soc_tplg_free_tlv(tplg, &kc);
926 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
932 static int soc_tplg_denum_create_texts(struct soc_enum *se,
933 struct snd_soc_tplg_enum_control *ec)
937 se->dobj.control.dtexts =
938 kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
939 if (se->dobj.control.dtexts == NULL)
942 for (i = 0; i < le32_to_cpu(ec->items); i++) {
944 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
945 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
950 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
951 if (!se->dobj.control.dtexts[i]) {
957 se->items = le32_to_cpu(ec->items);
958 se->texts = (const char * const *)se->dobj.control.dtexts;
963 soc_tplg_denum_remove_texts(se);
967 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
971 for (--i; i >= 0; i--)
972 kfree(se->dobj.control.dtexts[i]);
973 kfree(se->dobj.control.dtexts);
976 static int soc_tplg_denum_create_values(struct soc_enum *se,
977 struct snd_soc_tplg_enum_control *ec)
981 if (le32_to_cpu(ec->items) > sizeof(*ec->values))
984 se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
987 if (!se->dobj.control.dvalues)
990 /* convert from little-endian */
991 for (i = 0; i < le32_to_cpu(ec->items); i++) {
992 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
998 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
1000 kfree(se->dobj.control.dvalues);
1003 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
1006 struct snd_soc_tplg_enum_control *ec;
1007 struct soc_enum *se;
1008 struct snd_kcontrol_new kc;
1011 if (soc_tplg_check_elem_count(tplg,
1012 sizeof(struct snd_soc_tplg_enum_control),
1013 count, size, "enums")) {
1015 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1020 for (i = 0; i < count; i++) {
1021 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1023 /* validate kcontrol */
1024 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1025 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1028 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1032 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1033 le32_to_cpu(ec->priv.size));
1035 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1036 ec->hdr.name, ec->items);
1038 memset(&kc, 0, sizeof(kc));
1039 kc.name = ec->hdr.name;
1040 kc.private_value = (long)se;
1041 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1042 kc.access = le32_to_cpu(ec->hdr.access);
1044 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1045 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1047 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1050 se->mask = le32_to_cpu(ec->mask);
1051 se->dobj.index = tplg->index;
1052 se->dobj.type = SND_SOC_DOBJ_ENUM;
1053 se->dobj.ops = tplg->ops;
1054 INIT_LIST_HEAD(&se->dobj.list);
1056 switch (le32_to_cpu(ec->hdr.ops.info)) {
1057 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1058 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1059 err = soc_tplg_denum_create_values(se, ec);
1062 "ASoC: could not create values for %s\n",
1068 case SND_SOC_TPLG_CTL_ENUM:
1069 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1070 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1071 err = soc_tplg_denum_create_texts(se, ec);
1074 "ASoC: could not create texts for %s\n",
1082 "ASoC: invalid enum control type %d for %s\n",
1083 ec->hdr.ops.info, ec->hdr.name);
1088 /* map io handlers */
1089 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1091 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1096 /* pass control to driver for optional further init */
1097 err = soc_tplg_init_kcontrol(tplg, &kc,
1098 (struct snd_soc_tplg_ctl_hdr *) ec);
1100 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1106 /* register control here */
1107 ret = soc_tplg_add_kcontrol(tplg,
1108 &kc, &se->dobj.control.kcontrol);
1110 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1116 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1122 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1123 struct snd_soc_tplg_hdr *hdr)
1125 struct snd_soc_tplg_ctl_hdr *control_hdr;
1129 if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1130 tplg->pos += le32_to_cpu(hdr->size) +
1131 le32_to_cpu(hdr->payload_size);
1135 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1136 soc_tplg_get_offset(tplg));
1138 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1140 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1142 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1143 dev_err(tplg->dev, "ASoC: invalid control size\n");
1147 switch (le32_to_cpu(control_hdr->ops.info)) {
1148 case SND_SOC_TPLG_CTL_VOLSW:
1149 case SND_SOC_TPLG_CTL_STROBE:
1150 case SND_SOC_TPLG_CTL_VOLSW_SX:
1151 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1152 case SND_SOC_TPLG_CTL_RANGE:
1153 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1154 case SND_SOC_TPLG_DAPM_CTL_PIN:
1155 ret = soc_tplg_dmixer_create(tplg, 1,
1156 le32_to_cpu(hdr->payload_size));
1158 case SND_SOC_TPLG_CTL_ENUM:
1159 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1160 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1161 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1162 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1163 ret = soc_tplg_denum_create(tplg, 1,
1164 le32_to_cpu(hdr->payload_size));
1166 case SND_SOC_TPLG_CTL_BYTES:
1167 ret = soc_tplg_dbytes_create(tplg, 1,
1168 le32_to_cpu(hdr->payload_size));
1171 soc_bind_err(tplg, control_hdr, i);
1175 dev_err(tplg->dev, "ASoC: invalid control\n");
1184 /* optionally pass new dynamic kcontrol to component driver. */
1185 static int soc_tplg_add_route(struct soc_tplg *tplg,
1186 struct snd_soc_dapm_route *route)
1188 if (tplg->comp && tplg->ops && tplg->ops->dapm_route_load)
1189 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1195 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1196 struct snd_soc_tplg_hdr *hdr)
1198 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1199 struct snd_soc_tplg_dapm_graph_elem *elem;
1200 struct snd_soc_dapm_route **routes;
1204 count = le32_to_cpu(hdr->count);
1206 if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1208 le32_to_cpu(hdr->size) +
1209 le32_to_cpu(hdr->payload_size);
1214 if (soc_tplg_check_elem_count(tplg,
1215 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1216 count, le32_to_cpu(hdr->payload_size), "graph")) {
1218 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1223 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1226 /* allocate memory for pointer to array of dapm routes */
1227 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1233 * allocate memory for each dapm route in the array.
1234 * This needs to be done individually so that
1235 * each route can be freed when it is removed in remove_route().
1237 for (i = 0; i < count; i++) {
1238 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1240 /* free previously allocated memory */
1241 for (j = 0; j < i; j++)
1249 for (i = 0; i < count; i++) {
1250 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1251 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1253 /* validate routes */
1254 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1255 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1259 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1260 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1264 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1265 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1270 routes[i]->source = elem->source;
1271 routes[i]->sink = elem->sink;
1273 /* set to NULL atm for tplg users */
1274 routes[i]->connected = NULL;
1275 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1276 routes[i]->control = NULL;
1278 routes[i]->control = elem->control;
1280 /* add route dobj to dobj_list */
1281 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1282 routes[i]->dobj.ops = tplg->ops;
1283 routes[i]->dobj.index = tplg->index;
1284 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1286 ret = soc_tplg_add_route(tplg, routes[i]);
1290 /* add route, but keep going if some fail */
1291 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1294 /* free memory allocated for all dapm routes in case of error */
1296 for (i = 0; i < count ; i++)
1300 * free pointer to array of dapm routes as this is no longer needed.
1301 * The memory allocated for each dapm route will be freed
1302 * when it is removed in remove_route().
1309 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1310 struct soc_tplg *tplg, int num_kcontrols)
1312 struct snd_kcontrol_new *kc;
1313 struct soc_mixer_control *sm;
1314 struct snd_soc_tplg_mixer_control *mc;
1317 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1321 for (i = 0; i < num_kcontrols; i++) {
1322 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1324 /* validate kcontrol */
1325 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1326 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1329 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1333 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1334 le32_to_cpu(mc->priv.size));
1336 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1339 kc[i].private_value = (long)sm;
1340 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1341 if (kc[i].name == NULL)
1343 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1344 kc[i].access = le32_to_cpu(mc->hdr.access);
1346 /* we only support FL/FR channel mapping atm */
1347 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1349 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1351 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1353 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1356 sm->max = le32_to_cpu(mc->max);
1357 sm->min = le32_to_cpu(mc->min);
1358 sm->invert = le32_to_cpu(mc->invert);
1359 sm->platform_max = le32_to_cpu(mc->platform_max);
1360 sm->dobj.index = tplg->index;
1361 INIT_LIST_HEAD(&sm->dobj.list);
1363 /* map io handlers */
1364 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1366 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1370 /* create any TLV data */
1371 err = soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1373 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1379 /* pass control to driver for optional further init */
1380 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1381 (struct snd_soc_tplg_ctl_hdr *)mc);
1383 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1385 soc_tplg_free_tlv(tplg, &kc[i]);
1392 for (; i >= 0; i--) {
1393 sm = (struct soc_mixer_control *)kc[i].private_value;
1402 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1403 struct soc_tplg *tplg, int num_kcontrols)
1405 struct snd_kcontrol_new *kc;
1406 struct snd_soc_tplg_enum_control *ec;
1407 struct soc_enum *se;
1410 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1414 for (i = 0; i < num_kcontrols; i++) {
1415 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1416 /* validate kcontrol */
1417 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1418 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1421 se = kzalloc(sizeof(*se), GFP_KERNEL);
1425 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1426 le32_to_cpu(ec->priv.size));
1428 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1431 kc[i].private_value = (long)se;
1432 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1433 if (kc[i].name == NULL)
1435 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1436 kc[i].access = le32_to_cpu(ec->hdr.access);
1438 /* we only support FL/FR channel mapping atm */
1439 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1440 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1442 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1445 se->items = le32_to_cpu(ec->items);
1446 se->mask = le32_to_cpu(ec->mask);
1447 se->dobj.index = tplg->index;
1449 switch (le32_to_cpu(ec->hdr.ops.info)) {
1450 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1451 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1452 err = soc_tplg_denum_create_values(se, ec);
1454 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1459 case SND_SOC_TPLG_CTL_ENUM:
1460 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1461 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1462 err = soc_tplg_denum_create_texts(se, ec);
1464 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1470 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1471 ec->hdr.ops.info, ec->hdr.name);
1475 /* map io handlers */
1476 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1478 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1482 /* pass control to driver for optional further init */
1483 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1484 (struct snd_soc_tplg_ctl_hdr *)ec);
1486 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1495 for (; i >= 0; i--) {
1496 /* free values and texts */
1497 se = (struct soc_enum *)kc[i].private_value;
1500 soc_tplg_denum_remove_values(se);
1501 soc_tplg_denum_remove_texts(se);
1512 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1513 struct soc_tplg *tplg, int num_kcontrols)
1515 struct snd_soc_tplg_bytes_control *be;
1516 struct soc_bytes_ext *sbe;
1517 struct snd_kcontrol_new *kc;
1520 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1524 for (i = 0; i < num_kcontrols; i++) {
1525 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1527 /* validate kcontrol */
1528 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1529 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1532 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1536 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1537 le32_to_cpu(be->priv.size));
1540 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1541 be->hdr.name, be->hdr.access);
1543 kc[i].private_value = (long)sbe;
1544 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1545 if (kc[i].name == NULL)
1547 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1548 kc[i].access = le32_to_cpu(be->hdr.access);
1550 sbe->max = le32_to_cpu(be->max);
1551 INIT_LIST_HEAD(&sbe->dobj.list);
1553 /* map standard io handlers and check for external handlers */
1554 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1556 soc_control_err(tplg, &be->hdr, be->hdr.name);
1560 /* pass control to driver for optional further init */
1561 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1562 (struct snd_soc_tplg_ctl_hdr *)be);
1564 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1573 for (; i >= 0; i--) {
1574 sbe = (struct soc_bytes_ext *)kc[i].private_value;
1583 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1584 struct snd_soc_tplg_dapm_widget *w)
1586 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1587 struct snd_soc_dapm_widget template, *widget;
1588 struct snd_soc_tplg_ctl_hdr *control_hdr;
1589 struct snd_soc_card *card = tplg->comp->card;
1590 unsigned int kcontrol_type;
1593 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1594 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1596 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1597 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1600 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1603 memset(&template, 0, sizeof(template));
1605 /* map user to kernel widget ID */
1606 template.id = get_widget_id(le32_to_cpu(w->id));
1607 if ((int)template.id < 0)
1610 /* strings are allocated here, but used and freed by the widget */
1611 template.name = kstrdup(w->name, GFP_KERNEL);
1614 template.sname = kstrdup(w->sname, GFP_KERNEL);
1615 if (!template.sname) {
1619 template.reg = le32_to_cpu(w->reg);
1620 template.shift = le32_to_cpu(w->shift);
1621 template.mask = le32_to_cpu(w->mask);
1622 template.subseq = le32_to_cpu(w->subseq);
1623 template.on_val = w->invert ? 0 : 1;
1624 template.off_val = w->invert ? 1 : 0;
1625 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1626 template.event_flags = le16_to_cpu(w->event_flags);
1627 template.dobj.index = tplg->index;
1630 (sizeof(struct snd_soc_tplg_dapm_widget) +
1631 le32_to_cpu(w->priv.size));
1633 if (w->num_kcontrols == 0) {
1635 template.num_kcontrols = 0;
1639 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1640 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1641 w->name, w->num_kcontrols, control_hdr->type);
1643 switch (le32_to_cpu(control_hdr->ops.info)) {
1644 case SND_SOC_TPLG_CTL_VOLSW:
1645 case SND_SOC_TPLG_CTL_STROBE:
1646 case SND_SOC_TPLG_CTL_VOLSW_SX:
1647 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1648 case SND_SOC_TPLG_CTL_RANGE:
1649 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1650 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1651 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1652 template.kcontrol_news =
1653 soc_tplg_dapm_widget_dmixer_create(tplg,
1654 template.num_kcontrols);
1655 if (!template.kcontrol_news) {
1660 case SND_SOC_TPLG_CTL_ENUM:
1661 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1662 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1663 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1664 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1665 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1666 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1667 template.kcontrol_news =
1668 soc_tplg_dapm_widget_denum_create(tplg,
1669 template.num_kcontrols);
1670 if (!template.kcontrol_news) {
1675 case SND_SOC_TPLG_CTL_BYTES:
1676 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1677 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1678 template.kcontrol_news =
1679 soc_tplg_dapm_widget_dbytes_create(tplg,
1680 template.num_kcontrols);
1681 if (!template.kcontrol_news) {
1687 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1688 control_hdr->ops.get, control_hdr->ops.put,
1689 le32_to_cpu(control_hdr->ops.info));
1695 ret = soc_tplg_widget_load(tplg, &template, w);
1699 /* card dapm mutex is held by the core if we are loading topology
1700 * data during sound card init. */
1701 if (card->instantiated)
1702 widget = snd_soc_dapm_new_control(dapm, &template);
1704 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1705 if (IS_ERR(widget)) {
1706 ret = PTR_ERR(widget);
1710 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1711 widget->dobj.widget.kcontrol_type = kcontrol_type;
1712 widget->dobj.ops = tplg->ops;
1713 widget->dobj.index = tplg->index;
1714 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1716 ret = soc_tplg_widget_ready(tplg, widget, w);
1720 kfree(template.sname);
1721 kfree(template.name);
1726 snd_soc_tplg_widget_remove(widget);
1727 snd_soc_dapm_free_widget(widget);
1729 kfree(template.sname);
1731 kfree(template.name);
1735 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1736 struct snd_soc_tplg_hdr *hdr)
1738 struct snd_soc_tplg_dapm_widget *widget;
1741 count = le32_to_cpu(hdr->count);
1743 if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1746 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1748 for (i = 0; i < count; i++) {
1749 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1750 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1751 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1755 ret = soc_tplg_dapm_widget_create(tplg, widget);
1757 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1766 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1768 struct snd_soc_card *card = tplg->comp->card;
1771 /* Card might not have been registered at this point.
1772 * If so, just return success.
1774 if (!card || !card->instantiated) {
1775 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1776 " widget card binding deferred\n");
1780 ret = snd_soc_dapm_new_widgets(card);
1782 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1788 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1789 struct snd_soc_tplg_stream_caps *caps)
1791 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1792 stream->channels_min = le32_to_cpu(caps->channels_min);
1793 stream->channels_max = le32_to_cpu(caps->channels_max);
1794 stream->rates = le32_to_cpu(caps->rates);
1795 stream->rate_min = le32_to_cpu(caps->rate_min);
1796 stream->rate_max = le32_to_cpu(caps->rate_max);
1797 stream->formats = le64_to_cpu(caps->formats);
1798 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1801 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1802 unsigned int flag_mask, unsigned int flags)
1804 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1805 dai_drv->symmetric_rates =
1806 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1808 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1809 dai_drv->symmetric_channels =
1810 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1813 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1814 dai_drv->symmetric_samplebits =
1815 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1819 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1820 struct snd_soc_tplg_pcm *pcm)
1822 struct snd_soc_dai_driver *dai_drv;
1823 struct snd_soc_pcm_stream *stream;
1824 struct snd_soc_tplg_stream_caps *caps;
1827 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1828 if (dai_drv == NULL)
1831 if (strlen(pcm->dai_name))
1832 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1833 dai_drv->id = le32_to_cpu(pcm->dai_id);
1835 if (pcm->playback) {
1836 stream = &dai_drv->playback;
1837 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1838 set_stream_info(stream, caps);
1842 stream = &dai_drv->capture;
1843 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1844 set_stream_info(stream, caps);
1848 dai_drv->compress_new = snd_soc_new_compress;
1850 /* pass control to component driver for optional further init */
1851 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1853 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1854 kfree(dai_drv->playback.stream_name);
1855 kfree(dai_drv->capture.stream_name);
1856 kfree(dai_drv->name);
1861 dai_drv->dobj.index = tplg->index;
1862 dai_drv->dobj.ops = tplg->ops;
1863 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1864 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1866 /* register the DAI to the component */
1867 return snd_soc_register_dai(tplg->comp, dai_drv);
1870 static void set_link_flags(struct snd_soc_dai_link *link,
1871 unsigned int flag_mask, unsigned int flags)
1873 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1874 link->symmetric_rates =
1875 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1877 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1878 link->symmetric_channels =
1879 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1882 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1883 link->symmetric_samplebits =
1884 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1887 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1888 link->ignore_suspend =
1889 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1893 /* create the FE DAI link */
1894 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1895 struct snd_soc_tplg_pcm *pcm)
1897 struct snd_soc_dai_link *link;
1898 struct snd_soc_dai_link_component *dlc;
1901 /* link + cpu + codec + platform */
1902 link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1906 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1908 link->cpus = &dlc[0];
1909 link->codecs = &dlc[1];
1910 link->platforms = &dlc[2];
1913 link->num_codecs = 1;
1914 link->num_platforms = 1;
1916 link->dobj.index = tplg->index;
1917 link->dobj.ops = tplg->ops;
1918 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1920 if (strlen(pcm->pcm_name)) {
1921 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1922 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1924 link->id = le32_to_cpu(pcm->pcm_id);
1926 if (strlen(pcm->dai_name))
1927 link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1929 link->codecs->name = "snd-soc-dummy";
1930 link->codecs->dai_name = "snd-soc-dummy-dai";
1932 link->platforms->name = "snd-soc-dummy";
1936 link->dpcm_playback = le32_to_cpu(pcm->playback);
1937 link->dpcm_capture = le32_to_cpu(pcm->capture);
1939 set_link_flags(link,
1940 le32_to_cpu(pcm->flag_mask),
1941 le32_to_cpu(pcm->flags));
1943 /* pass control to component driver for optional further init */
1944 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1946 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1950 ret = snd_soc_add_dai_link(tplg->comp->card, link);
1952 dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1956 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1961 kfree(link->stream_name);
1962 kfree(link->cpus->dai_name);
1967 /* create a FE DAI and DAI link from the PCM object */
1968 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1969 struct snd_soc_tplg_pcm *pcm)
1973 ret = soc_tplg_dai_create(tplg, pcm);
1977 return soc_tplg_fe_link_create(tplg, pcm);
1980 /* copy stream caps from the old version 4 of source */
1981 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1982 struct snd_soc_tplg_stream_caps_v4 *src)
1984 dest->size = cpu_to_le32(sizeof(*dest));
1985 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1986 dest->formats = src->formats;
1987 dest->rates = src->rates;
1988 dest->rate_min = src->rate_min;
1989 dest->rate_max = src->rate_max;
1990 dest->channels_min = src->channels_min;
1991 dest->channels_max = src->channels_max;
1992 dest->periods_min = src->periods_min;
1993 dest->periods_max = src->periods_max;
1994 dest->period_size_min = src->period_size_min;
1995 dest->period_size_max = src->period_size_max;
1996 dest->buffer_size_min = src->buffer_size_min;
1997 dest->buffer_size_max = src->buffer_size_max;
2001 * pcm_new_ver - Create the new version of PCM from the old version.
2002 * @tplg: topology context
2003 * @src: older version of pcm as a source
2004 * @pcm: latest version of pcm created from the source
2006 * Support from vesion 4. User should free the returned pcm manually.
2008 static int pcm_new_ver(struct soc_tplg *tplg,
2009 struct snd_soc_tplg_pcm *src,
2010 struct snd_soc_tplg_pcm **pcm)
2012 struct snd_soc_tplg_pcm *dest;
2013 struct snd_soc_tplg_pcm_v4 *src_v4;
2018 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2019 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2023 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2024 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2025 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2029 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2030 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2031 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2032 dest->pcm_id = src_v4->pcm_id;
2033 dest->dai_id = src_v4->dai_id;
2034 dest->playback = src_v4->playback;
2035 dest->capture = src_v4->capture;
2036 dest->compress = src_v4->compress;
2037 dest->num_streams = src_v4->num_streams;
2038 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2039 memcpy(&dest->stream[i], &src_v4->stream[i],
2040 sizeof(struct snd_soc_tplg_stream));
2042 for (i = 0; i < 2; i++)
2043 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2049 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2050 struct snd_soc_tplg_hdr *hdr)
2052 struct snd_soc_tplg_pcm *pcm, *_pcm;
2059 count = le32_to_cpu(hdr->count);
2061 if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
2064 /* check the element size and count */
2065 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2066 size = le32_to_cpu(pcm->size);
2067 if (size > sizeof(struct snd_soc_tplg_pcm)
2068 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2069 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2074 if (soc_tplg_check_elem_count(tplg,
2076 le32_to_cpu(hdr->payload_size),
2078 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2083 for (i = 0; i < count; i++) {
2084 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2085 size = le32_to_cpu(pcm->size);
2087 /* check ABI version by size, create a new version of pcm
2090 if (size == sizeof(*pcm)) {
2095 ret = pcm_new_ver(tplg, pcm, &_pcm);
2100 /* create the FE DAIs and DAI links */
2101 ret = soc_tplg_pcm_create(tplg, _pcm);
2108 /* offset by version-specific struct size and
2109 * real priv data size
2111 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2114 kfree(_pcm); /* free the duplicated one */
2117 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2123 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2124 * @link: &snd_soc_dai_link which should be updated
2125 * @cfg: physical link configs.
2127 * Topology context contains a list of supported HW formats (configs) and
2128 * a default format ID for the physical link. This function will use this
2129 * default ID to choose the HW format to set the link's DAI format for init.
2131 static void set_link_hw_format(struct snd_soc_dai_link *link,
2132 struct snd_soc_tplg_link_config *cfg)
2134 struct snd_soc_tplg_hw_config *hw_config;
2135 unsigned char bclk_master, fsync_master;
2136 unsigned char invert_bclk, invert_fsync;
2139 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2140 hw_config = &cfg->hw_config[i];
2141 if (hw_config->id != cfg->default_hw_config_id)
2144 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2145 SND_SOC_DAIFMT_FORMAT_MASK;
2148 switch (hw_config->clock_gated) {
2149 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2150 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2153 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2154 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2158 /* ignore the value */
2162 /* clock signal polarity */
2163 invert_bclk = hw_config->invert_bclk;
2164 invert_fsync = hw_config->invert_fsync;
2165 if (!invert_bclk && !invert_fsync)
2166 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2167 else if (!invert_bclk && invert_fsync)
2168 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2169 else if (invert_bclk && !invert_fsync)
2170 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2172 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2175 bclk_master = (hw_config->bclk_master ==
2176 SND_SOC_TPLG_BCLK_CM);
2177 fsync_master = (hw_config->fsync_master ==
2178 SND_SOC_TPLG_FSYNC_CM);
2179 if (bclk_master && fsync_master)
2180 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2181 else if (!bclk_master && fsync_master)
2182 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2183 else if (bclk_master && !fsync_master)
2184 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2186 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2191 * link_new_ver - Create a new physical link config from the old
2192 * version of source.
2193 * @tplg: topology context
2194 * @src: old version of phyical link config as a source
2195 * @link: latest version of physical link config created from the source
2197 * Support from vesion 4. User need free the returned link config manually.
2199 static int link_new_ver(struct soc_tplg *tplg,
2200 struct snd_soc_tplg_link_config *src,
2201 struct snd_soc_tplg_link_config **link)
2203 struct snd_soc_tplg_link_config *dest;
2204 struct snd_soc_tplg_link_config_v4 *src_v4;
2209 if (le32_to_cpu(src->size) !=
2210 sizeof(struct snd_soc_tplg_link_config_v4)) {
2211 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2215 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2217 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2218 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2222 dest->size = cpu_to_le32(sizeof(*dest));
2223 dest->id = src_v4->id;
2224 dest->num_streams = src_v4->num_streams;
2225 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2226 memcpy(&dest->stream[i], &src_v4->stream[i],
2227 sizeof(struct snd_soc_tplg_stream));
2233 /* Find and configure an existing physical DAI link */
2234 static int soc_tplg_link_config(struct soc_tplg *tplg,
2235 struct snd_soc_tplg_link_config *cfg)
2237 struct snd_soc_dai_link *link;
2238 const char *name, *stream_name;
2242 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2243 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2250 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2251 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2254 stream_name = cfg->stream_name;
2258 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2261 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2267 if (cfg->num_hw_configs)
2268 set_link_hw_format(link, cfg);
2272 set_link_flags(link,
2273 le32_to_cpu(cfg->flag_mask),
2274 le32_to_cpu(cfg->flags));
2276 /* pass control to component driver for optional further init */
2277 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2279 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2283 /* for unloading it in snd_soc_tplg_component_remove */
2284 link->dobj.index = tplg->index;
2285 link->dobj.ops = tplg->ops;
2286 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2287 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2293 /* Load physical link config elements from the topology context */
2294 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2295 struct snd_soc_tplg_hdr *hdr)
2297 struct snd_soc_tplg_link_config *link, *_link;
2303 count = le32_to_cpu(hdr->count);
2305 if (tplg->pass != SOC_TPLG_PASS_LINK) {
2306 tplg->pos += le32_to_cpu(hdr->size) +
2307 le32_to_cpu(hdr->payload_size);
2311 /* check the element size and count */
2312 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2313 size = le32_to_cpu(link->size);
2314 if (size > sizeof(struct snd_soc_tplg_link_config)
2315 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2316 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2321 if (soc_tplg_check_elem_count(tplg,
2323 le32_to_cpu(hdr->payload_size),
2324 "physical link config")) {
2325 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2330 /* config physical DAI links */
2331 for (i = 0; i < count; i++) {
2332 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2333 size = le32_to_cpu(link->size);
2334 if (size == sizeof(*link)) {
2339 ret = link_new_ver(tplg, link, &_link);
2344 ret = soc_tplg_link_config(tplg, _link);
2351 /* offset by version-specific struct size and
2352 * real priv data size
2354 tplg->pos += size + le32_to_cpu(_link->priv.size);
2357 kfree(_link); /* free the duplicated one */
2364 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2365 * @tplg: topology context
2366 * @d: physical DAI configs.
2368 * The physical dai should already be registered by the platform driver.
2369 * The platform driver should specify the DAI name and ID for matching.
2371 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2372 struct snd_soc_tplg_dai *d)
2374 struct snd_soc_dai_link_component dai_component;
2375 struct snd_soc_dai *dai;
2376 struct snd_soc_dai_driver *dai_drv;
2377 struct snd_soc_pcm_stream *stream;
2378 struct snd_soc_tplg_stream_caps *caps;
2381 memset(&dai_component, 0, sizeof(dai_component));
2383 dai_component.dai_name = d->dai_name;
2384 dai = snd_soc_find_dai(&dai_component);
2386 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2391 if (le32_to_cpu(d->dai_id) != dai->id) {
2392 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2397 dai_drv = dai->driver;
2402 stream = &dai_drv->playback;
2403 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2404 set_stream_info(stream, caps);
2408 stream = &dai_drv->capture;
2409 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2410 set_stream_info(stream, caps);
2414 set_dai_flags(dai_drv,
2415 le32_to_cpu(d->flag_mask),
2416 le32_to_cpu(d->flags));
2418 /* pass control to component driver for optional further init */
2419 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2421 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2428 /* load physical DAI elements */
2429 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2430 struct snd_soc_tplg_hdr *hdr)
2432 struct snd_soc_tplg_dai *dai;
2436 count = le32_to_cpu(hdr->count);
2438 if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2441 /* config the existing BE DAIs */
2442 for (i = 0; i < count; i++) {
2443 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2444 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2445 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2449 ret = soc_tplg_dai_config(tplg, dai);
2451 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2455 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2458 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2463 * manifest_new_ver - Create a new version of manifest from the old version
2465 * @tplg: topology context
2466 * @src: old version of manifest as a source
2467 * @manifest: latest version of manifest created from the source
2469 * Support from vesion 4. Users need free the returned manifest manually.
2471 static int manifest_new_ver(struct soc_tplg *tplg,
2472 struct snd_soc_tplg_manifest *src,
2473 struct snd_soc_tplg_manifest **manifest)
2475 struct snd_soc_tplg_manifest *dest;
2476 struct snd_soc_tplg_manifest_v4 *src_v4;
2481 size = le32_to_cpu(src->size);
2482 if (size != sizeof(*src_v4)) {
2483 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2487 src->size = cpu_to_le32(sizeof(*src_v4));
2490 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2492 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2493 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2498 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2499 dest->control_elems = src_v4->control_elems;
2500 dest->widget_elems = src_v4->widget_elems;
2501 dest->graph_elems = src_v4->graph_elems;
2502 dest->pcm_elems = src_v4->pcm_elems;
2503 dest->dai_link_elems = src_v4->dai_link_elems;
2504 dest->priv.size = src_v4->priv.size;
2505 if (dest->priv.size)
2506 memcpy(dest->priv.data, src_v4->priv.data,
2507 le32_to_cpu(src_v4->priv.size));
2513 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2514 struct snd_soc_tplg_hdr *hdr)
2516 struct snd_soc_tplg_manifest *manifest, *_manifest;
2520 if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2523 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2525 /* check ABI version by size, create a new manifest if abi not match */
2526 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2528 _manifest = manifest;
2531 ret = manifest_new_ver(tplg, manifest, &_manifest);
2536 /* pass control to component driver for optional further init */
2537 if (tplg->comp && tplg->ops && tplg->ops->manifest)
2538 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2540 if (!abi_match) /* free the duplicated one */
2546 /* validate header magic, size and type */
2547 static int soc_valid_header(struct soc_tplg *tplg,
2548 struct snd_soc_tplg_hdr *hdr)
2550 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2553 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2555 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2556 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2561 /* big endian firmware objects not supported atm */
2562 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2564 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2565 tplg->pass, hdr->magic,
2566 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2570 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2572 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2573 tplg->pass, hdr->magic,
2574 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2578 /* Support ABI from version 4 */
2579 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2580 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2582 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2583 tplg->pass, hdr->abi,
2584 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2589 if (hdr->payload_size == 0) {
2590 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2591 soc_tplg_get_hdr_offset(tplg));
2595 if (tplg->pass == le32_to_cpu(hdr->type))
2597 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2598 hdr->payload_size, hdr->type, hdr->version,
2599 hdr->vendor_type, tplg->pass);
2604 /* check header type and call appropriate handler */
2605 static int soc_tplg_load_header(struct soc_tplg *tplg,
2606 struct snd_soc_tplg_hdr *hdr)
2608 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2610 /* check for matching ID */
2611 if (le32_to_cpu(hdr->index) != tplg->req_index &&
2612 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2615 tplg->index = le32_to_cpu(hdr->index);
2617 switch (le32_to_cpu(hdr->type)) {
2618 case SND_SOC_TPLG_TYPE_MIXER:
2619 case SND_SOC_TPLG_TYPE_ENUM:
2620 case SND_SOC_TPLG_TYPE_BYTES:
2621 return soc_tplg_kcontrol_elems_load(tplg, hdr);
2622 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2623 return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2624 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2625 return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2626 case SND_SOC_TPLG_TYPE_PCM:
2627 return soc_tplg_pcm_elems_load(tplg, hdr);
2628 case SND_SOC_TPLG_TYPE_DAI:
2629 return soc_tplg_dai_elems_load(tplg, hdr);
2630 case SND_SOC_TPLG_TYPE_DAI_LINK:
2631 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2632 /* physical link configurations */
2633 return soc_tplg_link_elems_load(tplg, hdr);
2634 case SND_SOC_TPLG_TYPE_MANIFEST:
2635 return soc_tplg_manifest_load(tplg, hdr);
2637 /* bespoke vendor data object */
2638 return soc_tplg_vendor_load(tplg, hdr);
2644 /* process the topology file headers */
2645 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2647 struct snd_soc_tplg_hdr *hdr;
2650 tplg->pass = SOC_TPLG_PASS_START;
2652 /* process the header types from start to end */
2653 while (tplg->pass <= SOC_TPLG_PASS_END) {
2655 tplg->hdr_pos = tplg->fw->data;
2656 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2658 while (!soc_tplg_is_eof(tplg)) {
2660 /* make sure header is valid before loading */
2661 ret = soc_valid_header(tplg, hdr);
2667 /* load the header object */
2668 ret = soc_tplg_load_header(tplg, hdr);
2672 /* goto next header */
2673 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2674 sizeof(struct snd_soc_tplg_hdr);
2675 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2678 /* next data type pass */
2682 /* signal DAPM we are complete */
2683 ret = soc_tplg_dapm_complete(tplg);
2686 "ASoC: failed to initialise DAPM from Firmware\n");
2691 static int soc_tplg_load(struct soc_tplg *tplg)
2695 ret = soc_tplg_process_headers(tplg);
2697 soc_tplg_complete(tplg);
2702 /* load audio component topology from "firmware" file */
2703 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2704 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2706 struct soc_tplg tplg;
2709 /* setup parsing context */
2710 memset(&tplg, 0, sizeof(tplg));
2712 tplg.dev = comp->dev;
2715 tplg.req_index = id;
2716 tplg.io_ops = ops->io_ops;
2717 tplg.io_ops_count = ops->io_ops_count;
2718 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2719 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2721 ret = soc_tplg_load(&tplg);
2722 /* free the created components if fail to load topology */
2724 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2728 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2730 /* remove this dynamic widget */
2731 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2733 /* make sure we are a widget */
2734 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2737 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2739 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2741 /* remove all dynamic widgets from this DAPM context */
2742 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2745 struct snd_soc_dapm_widget *w, *next_w;
2747 list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2749 /* make sure we are a widget with correct context */
2750 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2754 if (w->dobj.index != index &&
2755 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2757 /* check and free and dynamic widget kcontrols */
2758 snd_soc_tplg_widget_remove(w);
2759 snd_soc_dapm_free_widget(w);
2761 snd_soc_dapm_reset_cache(dapm);
2763 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2765 /* remove dynamic controls from the component driver */
2766 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2768 struct snd_soc_dobj *dobj, *next_dobj;
2769 int pass = SOC_TPLG_PASS_END;
2771 /* process the header types from end to start */
2772 while (pass >= SOC_TPLG_PASS_START) {
2774 /* remove mixer controls */
2775 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2779 if (dobj->index != index &&
2780 index != SND_SOC_TPLG_INDEX_ALL)
2783 switch (dobj->type) {
2784 case SND_SOC_DOBJ_MIXER:
2785 remove_mixer(comp, dobj, pass);
2787 case SND_SOC_DOBJ_ENUM:
2788 remove_enum(comp, dobj, pass);
2790 case SND_SOC_DOBJ_BYTES:
2791 remove_bytes(comp, dobj, pass);
2793 case SND_SOC_DOBJ_GRAPH:
2794 remove_route(comp, dobj, pass);
2796 case SND_SOC_DOBJ_WIDGET:
2797 remove_widget(comp, dobj, pass);
2799 case SND_SOC_DOBJ_PCM:
2800 remove_dai(comp, dobj, pass);
2802 case SND_SOC_DOBJ_DAI_LINK:
2803 remove_link(comp, dobj, pass);
2805 case SND_SOC_DOBJ_BACKEND_LINK:
2807 * call link_unload ops if extra
2808 * deinitialization is needed.
2810 remove_backend_link(comp, dobj, pass);
2813 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2821 /* let caller know if FW can be freed when no objects are left */
2822 return !list_empty(&comp->dobj_list);
2824 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);