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, NULL, 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);
552 kfree(link->stream_name);
553 kfree(link->cpus->dai_name);
555 list_del(&dobj->list);
557 snd_soc_remove_pcm_runtime(comp->card,
558 snd_soc_get_pcm_runtime(comp->card, link));
562 /* unload dai link */
563 static void remove_backend_link(struct snd_soc_component *comp,
564 struct snd_soc_dobj *dobj, int pass)
566 if (pass != SOC_TPLG_PASS_LINK)
569 if (dobj->ops && dobj->ops->link_unload)
570 dobj->ops->link_unload(comp, dobj);
573 * We don't free the link here as what remove_link() do since BE
574 * links are not allocated by topology.
575 * We however need to reset the dobj type to its initial values
577 dobj->type = SND_SOC_DOBJ_NONE;
578 list_del(&dobj->list);
581 /* bind a kcontrol to it's IO handlers */
582 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
583 struct snd_kcontrol_new *k,
584 const struct soc_tplg *tplg)
586 const struct snd_soc_tplg_kcontrol_ops *ops;
587 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
590 if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
591 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
592 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
593 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
594 struct soc_bytes_ext *sbe;
595 struct snd_soc_tplg_bytes_control *be;
597 sbe = (struct soc_bytes_ext *)k->private_value;
598 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
600 /* TLV bytes controls need standard kcontrol info handler,
601 * TLV callback and extended put/get handlers.
603 k->info = snd_soc_bytes_info_ext;
604 k->tlv.c = snd_soc_bytes_tlv_callback;
606 ext_ops = tplg->bytes_ext_ops;
607 num_ops = tplg->bytes_ext_ops_count;
608 for (i = 0; i < num_ops; i++) {
609 if (!sbe->put && ext_ops[i].id == be->ext_ops.put)
610 sbe->put = ext_ops[i].put;
611 if (!sbe->get && ext_ops[i].id == 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 == hdr->ops.put)
628 if (k->get == NULL && ops[i].id == hdr->ops.get)
630 if (k->info == NULL && ops[i].id == 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 == hdr->ops.put)
645 if (k->get == NULL && ops[i].id == hdr->ops.get)
647 if (k->info == NULL && ops[i].id == 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 soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
898 /* pass control to driver for optional further init */
899 err = soc_tplg_init_kcontrol(tplg, &kc,
900 (struct snd_soc_tplg_ctl_hdr *) mc);
902 dev_err(tplg->dev, "ASoC: failed to init %s\n",
904 soc_tplg_free_tlv(tplg, &kc);
909 /* register control here */
910 err = soc_tplg_add_kcontrol(tplg, &kc,
911 &sm->dobj.control.kcontrol);
913 dev_err(tplg->dev, "ASoC: failed to add %s\n",
915 soc_tplg_free_tlv(tplg, &kc);
920 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
926 static int soc_tplg_denum_create_texts(struct soc_enum *se,
927 struct snd_soc_tplg_enum_control *ec)
931 se->dobj.control.dtexts =
932 kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
933 if (se->dobj.control.dtexts == NULL)
936 for (i = 0; i < ec->items; i++) {
938 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
939 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
944 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
945 if (!se->dobj.control.dtexts[i]) {
951 se->items = le32_to_cpu(ec->items);
952 se->texts = (const char * const *)se->dobj.control.dtexts;
957 soc_tplg_denum_remove_texts(se);
961 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
965 for (--i; i >= 0; i--)
966 kfree(se->dobj.control.dtexts[i]);
967 kfree(se->dobj.control.dtexts);
970 static int soc_tplg_denum_create_values(struct soc_enum *se,
971 struct snd_soc_tplg_enum_control *ec)
975 if (le32_to_cpu(ec->items) > sizeof(*ec->values))
978 se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
981 if (!se->dobj.control.dvalues)
984 /* convert from little-endian */
985 for (i = 0; i < le32_to_cpu(ec->items); i++) {
986 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
992 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
994 kfree(se->dobj.control.dvalues);
997 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
1000 struct snd_soc_tplg_enum_control *ec;
1001 struct soc_enum *se;
1002 struct snd_kcontrol_new kc;
1005 if (soc_tplg_check_elem_count(tplg,
1006 sizeof(struct snd_soc_tplg_enum_control),
1007 count, size, "enums")) {
1009 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1014 for (i = 0; i < count; i++) {
1015 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1017 /* validate kcontrol */
1018 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1019 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1022 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1026 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1027 le32_to_cpu(ec->priv.size));
1029 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1030 ec->hdr.name, ec->items);
1032 memset(&kc, 0, sizeof(kc));
1033 kc.name = ec->hdr.name;
1034 kc.private_value = (long)se;
1035 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1036 kc.access = le32_to_cpu(ec->hdr.access);
1038 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1039 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1041 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1044 se->mask = le32_to_cpu(ec->mask);
1045 se->dobj.index = tplg->index;
1046 se->dobj.type = SND_SOC_DOBJ_ENUM;
1047 se->dobj.ops = tplg->ops;
1048 INIT_LIST_HEAD(&se->dobj.list);
1050 switch (le32_to_cpu(ec->hdr.ops.info)) {
1051 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1052 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1053 err = soc_tplg_denum_create_values(se, ec);
1056 "ASoC: could not create values for %s\n",
1062 case SND_SOC_TPLG_CTL_ENUM:
1063 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1064 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1065 err = soc_tplg_denum_create_texts(se, ec);
1068 "ASoC: could not create texts for %s\n",
1076 "ASoC: invalid enum control type %d for %s\n",
1077 ec->hdr.ops.info, ec->hdr.name);
1082 /* map io handlers */
1083 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1085 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1090 /* pass control to driver for optional further init */
1091 err = soc_tplg_init_kcontrol(tplg, &kc,
1092 (struct snd_soc_tplg_ctl_hdr *) ec);
1094 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1100 /* register control here */
1101 ret = soc_tplg_add_kcontrol(tplg,
1102 &kc, &se->dobj.control.kcontrol);
1104 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1110 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1116 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1117 struct snd_soc_tplg_hdr *hdr)
1119 struct snd_soc_tplg_ctl_hdr *control_hdr;
1122 if (tplg->pass != SOC_TPLG_PASS_MIXER) {
1123 tplg->pos += le32_to_cpu(hdr->size) +
1124 le32_to_cpu(hdr->payload_size);
1128 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1129 soc_tplg_get_offset(tplg));
1131 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1133 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1135 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1136 dev_err(tplg->dev, "ASoC: invalid control size\n");
1140 switch (le32_to_cpu(control_hdr->ops.info)) {
1141 case SND_SOC_TPLG_CTL_VOLSW:
1142 case SND_SOC_TPLG_CTL_STROBE:
1143 case SND_SOC_TPLG_CTL_VOLSW_SX:
1144 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1145 case SND_SOC_TPLG_CTL_RANGE:
1146 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1147 case SND_SOC_TPLG_DAPM_CTL_PIN:
1148 soc_tplg_dmixer_create(tplg, 1,
1149 le32_to_cpu(hdr->payload_size));
1151 case SND_SOC_TPLG_CTL_ENUM:
1152 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1153 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1154 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1155 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1156 soc_tplg_denum_create(tplg, 1,
1157 le32_to_cpu(hdr->payload_size));
1159 case SND_SOC_TPLG_CTL_BYTES:
1160 soc_tplg_dbytes_create(tplg, 1,
1161 le32_to_cpu(hdr->payload_size));
1164 soc_bind_err(tplg, control_hdr, i);
1172 /* optionally pass new dynamic kcontrol to component driver. */
1173 static int soc_tplg_add_route(struct soc_tplg *tplg,
1174 struct snd_soc_dapm_route *route)
1176 if (tplg->comp && tplg->ops && tplg->ops->dapm_route_load)
1177 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1183 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1184 struct snd_soc_tplg_hdr *hdr)
1186 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1187 struct snd_soc_tplg_dapm_graph_elem *elem;
1188 struct snd_soc_dapm_route **routes;
1192 count = le32_to_cpu(hdr->count);
1194 if (tplg->pass != SOC_TPLG_PASS_GRAPH) {
1196 le32_to_cpu(hdr->size) +
1197 le32_to_cpu(hdr->payload_size);
1202 if (soc_tplg_check_elem_count(tplg,
1203 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1204 count, le32_to_cpu(hdr->payload_size), "graph")) {
1206 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1211 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1214 /* allocate memory for pointer to array of dapm routes */
1215 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1221 * allocate memory for each dapm route in the array.
1222 * This needs to be done individually so that
1223 * each route can be freed when it is removed in remove_route().
1225 for (i = 0; i < count; i++) {
1226 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1228 /* free previously allocated memory */
1229 for (j = 0; j < i; j++)
1237 for (i = 0; i < count; i++) {
1238 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1239 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1241 /* validate routes */
1242 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1243 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1247 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1248 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1252 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1253 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1258 routes[i]->source = elem->source;
1259 routes[i]->sink = elem->sink;
1261 /* set to NULL atm for tplg users */
1262 routes[i]->connected = NULL;
1263 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1264 routes[i]->control = NULL;
1266 routes[i]->control = elem->control;
1268 /* add route dobj to dobj_list */
1269 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1270 routes[i]->dobj.ops = tplg->ops;
1271 routes[i]->dobj.index = tplg->index;
1272 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1274 soc_tplg_add_route(tplg, routes[i]);
1276 /* add route, but keep going if some fail */
1277 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1280 /* free memory allocated for all dapm routes in case of error */
1282 for (i = 0; i < count ; i++)
1286 * free pointer to array of dapm routes as this is no longer needed.
1287 * The memory allocated for each dapm route will be freed
1288 * when it is removed in remove_route().
1295 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1296 struct soc_tplg *tplg, int num_kcontrols)
1298 struct snd_kcontrol_new *kc;
1299 struct soc_mixer_control *sm;
1300 struct snd_soc_tplg_mixer_control *mc;
1303 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1307 for (i = 0; i < num_kcontrols; i++) {
1308 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1310 /* validate kcontrol */
1311 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1312 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1315 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1319 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1320 le32_to_cpu(mc->priv.size));
1322 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1325 kc[i].private_value = (long)sm;
1326 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1327 if (kc[i].name == NULL)
1329 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1330 kc[i].access = mc->hdr.access;
1332 /* we only support FL/FR channel mapping atm */
1333 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1335 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1337 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1339 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1344 sm->invert = mc->invert;
1345 sm->platform_max = mc->platform_max;
1346 sm->dobj.index = tplg->index;
1347 INIT_LIST_HEAD(&sm->dobj.list);
1349 /* map io handlers */
1350 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1352 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1356 /* create any TLV data */
1357 soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1359 /* pass control to driver for optional further init */
1360 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1361 (struct snd_soc_tplg_ctl_hdr *)mc);
1363 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1365 soc_tplg_free_tlv(tplg, &kc[i]);
1372 for (; i >= 0; i--) {
1373 sm = (struct soc_mixer_control *)kc[i].private_value;
1382 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1383 struct soc_tplg *tplg, int num_kcontrols)
1385 struct snd_kcontrol_new *kc;
1386 struct snd_soc_tplg_enum_control *ec;
1387 struct soc_enum *se;
1390 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1394 for (i = 0; i < num_kcontrols; i++) {
1395 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1396 /* validate kcontrol */
1397 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1398 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1401 se = kzalloc(sizeof(*se), GFP_KERNEL);
1405 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1408 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1411 kc[i].private_value = (long)se;
1412 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1413 if (kc[i].name == NULL)
1415 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1416 kc[i].access = ec->hdr.access;
1418 /* we only support FL/FR channel mapping atm */
1419 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1420 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1422 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1425 se->items = ec->items;
1426 se->mask = ec->mask;
1427 se->dobj.index = tplg->index;
1429 switch (le32_to_cpu(ec->hdr.ops.info)) {
1430 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1431 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1432 err = soc_tplg_denum_create_values(se, ec);
1434 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1439 case SND_SOC_TPLG_CTL_ENUM:
1440 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1441 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1442 err = soc_tplg_denum_create_texts(se, ec);
1444 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1450 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1451 ec->hdr.ops.info, ec->hdr.name);
1455 /* map io handlers */
1456 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1458 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1462 /* pass control to driver for optional further init */
1463 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1464 (struct snd_soc_tplg_ctl_hdr *)ec);
1466 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1475 for (; i >= 0; i--) {
1476 /* free values and texts */
1477 se = (struct soc_enum *)kc[i].private_value;
1480 soc_tplg_denum_remove_values(se);
1481 soc_tplg_denum_remove_texts(se);
1492 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1493 struct soc_tplg *tplg, int num_kcontrols)
1495 struct snd_soc_tplg_bytes_control *be;
1496 struct soc_bytes_ext *sbe;
1497 struct snd_kcontrol_new *kc;
1500 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1504 for (i = 0; i < num_kcontrols; i++) {
1505 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1507 /* validate kcontrol */
1508 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1509 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1512 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1516 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1517 le32_to_cpu(be->priv.size));
1520 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1521 be->hdr.name, be->hdr.access);
1523 kc[i].private_value = (long)sbe;
1524 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1525 if (kc[i].name == NULL)
1527 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1528 kc[i].access = be->hdr.access;
1531 INIT_LIST_HEAD(&sbe->dobj.list);
1533 /* map standard io handlers and check for external handlers */
1534 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1536 soc_control_err(tplg, &be->hdr, be->hdr.name);
1540 /* pass control to driver for optional further init */
1541 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1542 (struct snd_soc_tplg_ctl_hdr *)be);
1544 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1553 for (; i >= 0; i--) {
1554 sbe = (struct soc_bytes_ext *)kc[i].private_value;
1563 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1564 struct snd_soc_tplg_dapm_widget *w)
1566 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1567 struct snd_soc_dapm_widget template, *widget;
1568 struct snd_soc_tplg_ctl_hdr *control_hdr;
1569 struct snd_soc_card *card = tplg->comp->card;
1570 unsigned int kcontrol_type;
1573 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1574 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1576 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1577 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1580 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1583 memset(&template, 0, sizeof(template));
1585 /* map user to kernel widget ID */
1586 template.id = get_widget_id(le32_to_cpu(w->id));
1587 if ((int)template.id < 0)
1590 /* strings are allocated here, but used and freed by the widget */
1591 template.name = kstrdup(w->name, GFP_KERNEL);
1594 template.sname = kstrdup(w->sname, GFP_KERNEL);
1595 if (!template.sname) {
1599 template.reg = le32_to_cpu(w->reg);
1600 template.shift = le32_to_cpu(w->shift);
1601 template.mask = le32_to_cpu(w->mask);
1602 template.subseq = le32_to_cpu(w->subseq);
1603 template.on_val = w->invert ? 0 : 1;
1604 template.off_val = w->invert ? 1 : 0;
1605 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1606 template.event_flags = le16_to_cpu(w->event_flags);
1607 template.dobj.index = tplg->index;
1610 (sizeof(struct snd_soc_tplg_dapm_widget) +
1611 le32_to_cpu(w->priv.size));
1613 if (w->num_kcontrols == 0) {
1615 template.num_kcontrols = 0;
1619 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1620 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1621 w->name, w->num_kcontrols, control_hdr->type);
1623 switch (le32_to_cpu(control_hdr->ops.info)) {
1624 case SND_SOC_TPLG_CTL_VOLSW:
1625 case SND_SOC_TPLG_CTL_STROBE:
1626 case SND_SOC_TPLG_CTL_VOLSW_SX:
1627 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1628 case SND_SOC_TPLG_CTL_RANGE:
1629 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1630 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1631 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1632 template.kcontrol_news =
1633 soc_tplg_dapm_widget_dmixer_create(tplg,
1634 template.num_kcontrols);
1635 if (!template.kcontrol_news) {
1640 case SND_SOC_TPLG_CTL_ENUM:
1641 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1642 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1643 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1644 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1645 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1646 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1647 template.kcontrol_news =
1648 soc_tplg_dapm_widget_denum_create(tplg,
1649 template.num_kcontrols);
1650 if (!template.kcontrol_news) {
1655 case SND_SOC_TPLG_CTL_BYTES:
1656 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1657 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1658 template.kcontrol_news =
1659 soc_tplg_dapm_widget_dbytes_create(tplg,
1660 template.num_kcontrols);
1661 if (!template.kcontrol_news) {
1667 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1668 control_hdr->ops.get, control_hdr->ops.put,
1669 le32_to_cpu(control_hdr->ops.info));
1675 ret = soc_tplg_widget_load(tplg, &template, w);
1679 /* card dapm mutex is held by the core if we are loading topology
1680 * data during sound card init. */
1681 if (card->instantiated)
1682 widget = snd_soc_dapm_new_control(dapm, &template);
1684 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1685 if (IS_ERR(widget)) {
1686 ret = PTR_ERR(widget);
1690 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1691 widget->dobj.widget.kcontrol_type = kcontrol_type;
1692 widget->dobj.ops = tplg->ops;
1693 widget->dobj.index = tplg->index;
1694 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1696 ret = soc_tplg_widget_ready(tplg, widget, w);
1700 kfree(template.sname);
1701 kfree(template.name);
1706 snd_soc_tplg_widget_remove(widget);
1707 snd_soc_dapm_free_widget(widget);
1709 kfree(template.sname);
1711 kfree(template.name);
1715 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1716 struct snd_soc_tplg_hdr *hdr)
1718 struct snd_soc_tplg_dapm_widget *widget;
1721 count = le32_to_cpu(hdr->count);
1723 if (tplg->pass != SOC_TPLG_PASS_WIDGET)
1726 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1728 for (i = 0; i < count; i++) {
1729 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1730 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1731 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1735 ret = soc_tplg_dapm_widget_create(tplg, widget);
1737 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1746 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1748 struct snd_soc_card *card = tplg->comp->card;
1751 /* Card might not have been registered at this point.
1752 * If so, just return success.
1754 if (!card || !card->instantiated) {
1755 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1756 " widget card binding deferred\n");
1760 ret = snd_soc_dapm_new_widgets(card);
1762 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1768 static void set_stream_info(struct snd_soc_pcm_stream *stream,
1769 struct snd_soc_tplg_stream_caps *caps)
1771 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1772 stream->channels_min = le32_to_cpu(caps->channels_min);
1773 stream->channels_max = le32_to_cpu(caps->channels_max);
1774 stream->rates = le32_to_cpu(caps->rates);
1775 stream->rate_min = le32_to_cpu(caps->rate_min);
1776 stream->rate_max = le32_to_cpu(caps->rate_max);
1777 stream->formats = le64_to_cpu(caps->formats);
1778 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1781 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1782 unsigned int flag_mask, unsigned int flags)
1784 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1785 dai_drv->symmetric_rates =
1786 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1788 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1789 dai_drv->symmetric_channels =
1790 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1793 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1794 dai_drv->symmetric_samplebits =
1795 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1799 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1800 struct snd_soc_tplg_pcm *pcm)
1802 struct snd_soc_dai_driver *dai_drv;
1803 struct snd_soc_pcm_stream *stream;
1804 struct snd_soc_tplg_stream_caps *caps;
1805 struct snd_soc_dai *dai;
1806 struct snd_soc_dapm_context *dapm =
1807 snd_soc_component_get_dapm(tplg->comp);
1810 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1811 if (dai_drv == NULL)
1814 if (strlen(pcm->dai_name))
1815 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1816 dai_drv->id = le32_to_cpu(pcm->dai_id);
1818 if (pcm->playback) {
1819 stream = &dai_drv->playback;
1820 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1821 set_stream_info(stream, caps);
1825 stream = &dai_drv->capture;
1826 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1827 set_stream_info(stream, caps);
1831 dai_drv->compress_new = snd_soc_new_compress;
1833 /* pass control to component driver for optional further init */
1834 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1836 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1837 kfree(dai_drv->playback.stream_name);
1838 kfree(dai_drv->capture.stream_name);
1839 kfree(dai_drv->name);
1844 dai_drv->dobj.index = tplg->index;
1845 dai_drv->dobj.ops = tplg->ops;
1846 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1847 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1849 /* register the DAI to the component */
1850 dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1854 /* Create the DAI widgets here */
1855 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1857 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1858 snd_soc_unregister_dai(dai);
1865 static void set_link_flags(struct snd_soc_dai_link *link,
1866 unsigned int flag_mask, unsigned int flags)
1868 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1869 link->symmetric_rates =
1870 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1872 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1873 link->symmetric_channels =
1874 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1877 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1878 link->symmetric_samplebits =
1879 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1882 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1883 link->ignore_suspend =
1884 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1888 /* create the FE DAI link */
1889 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1890 struct snd_soc_tplg_pcm *pcm)
1892 struct snd_soc_dai_link *link;
1893 struct snd_soc_dai_link_component *dlc;
1896 /* link + cpu + codec + platform */
1897 link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1901 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1903 link->cpus = &dlc[0];
1904 link->codecs = &dlc[1];
1905 link->platforms = &dlc[2];
1908 link->num_codecs = 1;
1909 link->num_platforms = 1;
1911 if (strlen(pcm->pcm_name)) {
1912 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1913 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1915 link->id = le32_to_cpu(pcm->pcm_id);
1917 if (strlen(pcm->dai_name))
1918 link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1920 link->codecs->name = "snd-soc-dummy";
1921 link->codecs->dai_name = "snd-soc-dummy-dai";
1923 link->platforms->name = "snd-soc-dummy";
1927 link->dpcm_playback = le32_to_cpu(pcm->playback);
1928 link->dpcm_capture = le32_to_cpu(pcm->capture);
1930 set_link_flags(link,
1931 le32_to_cpu(pcm->flag_mask),
1932 le32_to_cpu(pcm->flags));
1934 /* pass control to component driver for optional further init */
1935 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1937 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1941 ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1943 dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1947 link->dobj.index = tplg->index;
1948 link->dobj.ops = tplg->ops;
1949 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1950 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1955 kfree(link->stream_name);
1956 kfree(link->cpus->dai_name);
1961 /* create a FE DAI and DAI link from the PCM object */
1962 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1963 struct snd_soc_tplg_pcm *pcm)
1967 ret = soc_tplg_dai_create(tplg, pcm);
1971 return soc_tplg_fe_link_create(tplg, pcm);
1974 /* copy stream caps from the old version 4 of source */
1975 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1976 struct snd_soc_tplg_stream_caps_v4 *src)
1978 dest->size = cpu_to_le32(sizeof(*dest));
1979 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1980 dest->formats = src->formats;
1981 dest->rates = src->rates;
1982 dest->rate_min = src->rate_min;
1983 dest->rate_max = src->rate_max;
1984 dest->channels_min = src->channels_min;
1985 dest->channels_max = src->channels_max;
1986 dest->periods_min = src->periods_min;
1987 dest->periods_max = src->periods_max;
1988 dest->period_size_min = src->period_size_min;
1989 dest->period_size_max = src->period_size_max;
1990 dest->buffer_size_min = src->buffer_size_min;
1991 dest->buffer_size_max = src->buffer_size_max;
1995 * pcm_new_ver - Create the new version of PCM from the old version.
1996 * @tplg: topology context
1997 * @src: older version of pcm as a source
1998 * @pcm: latest version of pcm created from the source
2000 * Support from vesion 4. User should free the returned pcm manually.
2002 static int pcm_new_ver(struct soc_tplg *tplg,
2003 struct snd_soc_tplg_pcm *src,
2004 struct snd_soc_tplg_pcm **pcm)
2006 struct snd_soc_tplg_pcm *dest;
2007 struct snd_soc_tplg_pcm_v4 *src_v4;
2012 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2013 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2017 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2018 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2019 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2023 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2024 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2025 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2026 dest->pcm_id = src_v4->pcm_id;
2027 dest->dai_id = src_v4->dai_id;
2028 dest->playback = src_v4->playback;
2029 dest->capture = src_v4->capture;
2030 dest->compress = src_v4->compress;
2031 dest->num_streams = src_v4->num_streams;
2032 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2033 memcpy(&dest->stream[i], &src_v4->stream[i],
2034 sizeof(struct snd_soc_tplg_stream));
2036 for (i = 0; i < 2; i++)
2037 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2043 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2044 struct snd_soc_tplg_hdr *hdr)
2046 struct snd_soc_tplg_pcm *pcm, *_pcm;
2053 count = le32_to_cpu(hdr->count);
2055 if (tplg->pass != SOC_TPLG_PASS_PCM_DAI)
2058 /* check the element size and count */
2059 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2060 size = le32_to_cpu(pcm->size);
2061 if (size > sizeof(struct snd_soc_tplg_pcm)
2062 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2063 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2068 if (soc_tplg_check_elem_count(tplg,
2070 le32_to_cpu(hdr->payload_size),
2072 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2077 for (i = 0; i < count; i++) {
2078 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2079 size = le32_to_cpu(pcm->size);
2081 /* check ABI version by size, create a new version of pcm
2084 if (size == sizeof(*pcm)) {
2089 pcm_new_ver(tplg, pcm, &_pcm);
2092 /* create the FE DAIs and DAI links */
2093 ret = soc_tplg_pcm_create(tplg, _pcm);
2100 /* offset by version-specific struct size and
2101 * real priv data size
2103 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2106 kfree(_pcm); /* free the duplicated one */
2109 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2115 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2116 * @link: &snd_soc_dai_link which should be updated
2117 * @cfg: physical link configs.
2119 * Topology context contains a list of supported HW formats (configs) and
2120 * a default format ID for the physical link. This function will use this
2121 * default ID to choose the HW format to set the link's DAI format for init.
2123 static void set_link_hw_format(struct snd_soc_dai_link *link,
2124 struct snd_soc_tplg_link_config *cfg)
2126 struct snd_soc_tplg_hw_config *hw_config;
2127 unsigned char bclk_master, fsync_master;
2128 unsigned char invert_bclk, invert_fsync;
2131 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2132 hw_config = &cfg->hw_config[i];
2133 if (hw_config->id != cfg->default_hw_config_id)
2136 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2137 SND_SOC_DAIFMT_FORMAT_MASK;
2140 switch (hw_config->clock_gated) {
2141 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2142 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2145 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2146 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2150 /* ignore the value */
2154 /* clock signal polarity */
2155 invert_bclk = hw_config->invert_bclk;
2156 invert_fsync = hw_config->invert_fsync;
2157 if (!invert_bclk && !invert_fsync)
2158 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2159 else if (!invert_bclk && invert_fsync)
2160 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2161 else if (invert_bclk && !invert_fsync)
2162 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2164 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2167 bclk_master = (hw_config->bclk_master ==
2168 SND_SOC_TPLG_BCLK_CM);
2169 fsync_master = (hw_config->fsync_master ==
2170 SND_SOC_TPLG_FSYNC_CM);
2171 if (bclk_master && fsync_master)
2172 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2173 else if (!bclk_master && fsync_master)
2174 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2175 else if (bclk_master && !fsync_master)
2176 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2178 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2183 * link_new_ver - Create a new physical link config from the old
2184 * version of source.
2185 * @tplg: topology context
2186 * @src: old version of phyical link config as a source
2187 * @link: latest version of physical link config created from the source
2189 * Support from vesion 4. User need free the returned link config manually.
2191 static int link_new_ver(struct soc_tplg *tplg,
2192 struct snd_soc_tplg_link_config *src,
2193 struct snd_soc_tplg_link_config **link)
2195 struct snd_soc_tplg_link_config *dest;
2196 struct snd_soc_tplg_link_config_v4 *src_v4;
2201 if (le32_to_cpu(src->size) !=
2202 sizeof(struct snd_soc_tplg_link_config_v4)) {
2203 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2207 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2209 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2210 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2214 dest->size = cpu_to_le32(sizeof(*dest));
2215 dest->id = src_v4->id;
2216 dest->num_streams = src_v4->num_streams;
2217 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2218 memcpy(&dest->stream[i], &src_v4->stream[i],
2219 sizeof(struct snd_soc_tplg_stream));
2226 * snd_soc_find_dai_link - Find a DAI link
2229 * @id: DAI link ID to match
2230 * @name: DAI link name to match, optional
2231 * @stream_name: DAI link stream name to match, optional
2233 * This function will search all existing DAI links of the soc card to
2234 * find the link of the same ID. Since DAI links may not have their
2235 * unique ID, so name and stream name should also match if being
2238 * Return: pointer of DAI link, or NULL if not found.
2240 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2241 int id, const char *name,
2242 const char *stream_name)
2244 struct snd_soc_pcm_runtime *rtd;
2245 struct snd_soc_dai_link *link;
2247 for_each_card_rtds(card, rtd) {
2248 link = rtd->dai_link;
2253 if (name && (!link->name || strcmp(name, link->name)))
2256 if (stream_name && (!link->stream_name
2257 || strcmp(stream_name, link->stream_name)))
2266 /* Find and configure an existing physical DAI link */
2267 static int soc_tplg_link_config(struct soc_tplg *tplg,
2268 struct snd_soc_tplg_link_config *cfg)
2270 struct snd_soc_dai_link *link;
2271 const char *name, *stream_name;
2275 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2276 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2283 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2284 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2287 stream_name = cfg->stream_name;
2291 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2294 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2300 if (cfg->num_hw_configs)
2301 set_link_hw_format(link, cfg);
2305 set_link_flags(link,
2306 le32_to_cpu(cfg->flag_mask),
2307 le32_to_cpu(cfg->flags));
2309 /* pass control to component driver for optional further init */
2310 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2312 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2316 /* for unloading it in snd_soc_tplg_component_remove */
2317 link->dobj.index = tplg->index;
2318 link->dobj.ops = tplg->ops;
2319 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2320 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2326 /* Load physical link config elements from the topology context */
2327 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2328 struct snd_soc_tplg_hdr *hdr)
2330 struct snd_soc_tplg_link_config *link, *_link;
2336 count = le32_to_cpu(hdr->count);
2338 if (tplg->pass != SOC_TPLG_PASS_LINK) {
2339 tplg->pos += le32_to_cpu(hdr->size) +
2340 le32_to_cpu(hdr->payload_size);
2344 /* check the element size and count */
2345 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2346 size = le32_to_cpu(link->size);
2347 if (size > sizeof(struct snd_soc_tplg_link_config)
2348 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2349 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2354 if (soc_tplg_check_elem_count(tplg,
2356 le32_to_cpu(hdr->payload_size),
2357 "physical link config")) {
2358 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2363 /* config physical DAI links */
2364 for (i = 0; i < count; i++) {
2365 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2366 size = le32_to_cpu(link->size);
2367 if (size == sizeof(*link)) {
2372 ret = link_new_ver(tplg, link, &_link);
2377 ret = soc_tplg_link_config(tplg, _link);
2381 /* offset by version-specific struct size and
2382 * real priv data size
2384 tplg->pos += size + le32_to_cpu(_link->priv.size);
2387 kfree(_link); /* free the duplicated one */
2394 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2395 * @tplg: topology context
2396 * @d: physical DAI configs.
2398 * The physical dai should already be registered by the platform driver.
2399 * The platform driver should specify the DAI name and ID for matching.
2401 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2402 struct snd_soc_tplg_dai *d)
2404 struct snd_soc_dai_link_component dai_component;
2405 struct snd_soc_dai *dai;
2406 struct snd_soc_dai_driver *dai_drv;
2407 struct snd_soc_pcm_stream *stream;
2408 struct snd_soc_tplg_stream_caps *caps;
2411 memset(&dai_component, 0, sizeof(dai_component));
2413 dai_component.dai_name = d->dai_name;
2414 dai = snd_soc_find_dai(&dai_component);
2416 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2421 if (le32_to_cpu(d->dai_id) != dai->id) {
2422 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2427 dai_drv = dai->driver;
2432 stream = &dai_drv->playback;
2433 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2434 set_stream_info(stream, caps);
2438 stream = &dai_drv->capture;
2439 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2440 set_stream_info(stream, caps);
2444 set_dai_flags(dai_drv,
2445 le32_to_cpu(d->flag_mask),
2446 le32_to_cpu(d->flags));
2448 /* pass control to component driver for optional further init */
2449 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2451 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2458 /* load physical DAI elements */
2459 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2460 struct snd_soc_tplg_hdr *hdr)
2462 struct snd_soc_tplg_dai *dai;
2466 count = le32_to_cpu(hdr->count);
2468 if (tplg->pass != SOC_TPLG_PASS_BE_DAI)
2471 /* config the existing BE DAIs */
2472 for (i = 0; i < count; i++) {
2473 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2474 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2475 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2479 soc_tplg_dai_config(tplg, dai);
2480 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2483 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2488 * manifest_new_ver - Create a new version of manifest from the old version
2490 * @tplg: topology context
2491 * @src: old version of manifest as a source
2492 * @manifest: latest version of manifest created from the source
2494 * Support from vesion 4. Users need free the returned manifest manually.
2496 static int manifest_new_ver(struct soc_tplg *tplg,
2497 struct snd_soc_tplg_manifest *src,
2498 struct snd_soc_tplg_manifest **manifest)
2500 struct snd_soc_tplg_manifest *dest;
2501 struct snd_soc_tplg_manifest_v4 *src_v4;
2506 size = le32_to_cpu(src->size);
2507 if (size != sizeof(*src_v4)) {
2508 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2512 src->size = cpu_to_le32(sizeof(*src_v4));
2515 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2517 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2518 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2523 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2524 dest->control_elems = src_v4->control_elems;
2525 dest->widget_elems = src_v4->widget_elems;
2526 dest->graph_elems = src_v4->graph_elems;
2527 dest->pcm_elems = src_v4->pcm_elems;
2528 dest->dai_link_elems = src_v4->dai_link_elems;
2529 dest->priv.size = src_v4->priv.size;
2530 if (dest->priv.size)
2531 memcpy(dest->priv.data, src_v4->priv.data,
2532 le32_to_cpu(src_v4->priv.size));
2538 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2539 struct snd_soc_tplg_hdr *hdr)
2541 struct snd_soc_tplg_manifest *manifest, *_manifest;
2545 if (tplg->pass != SOC_TPLG_PASS_MANIFEST)
2548 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2550 /* check ABI version by size, create a new manifest if abi not match */
2551 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2553 _manifest = manifest;
2556 err = manifest_new_ver(tplg, manifest, &_manifest);
2561 /* pass control to component driver for optional further init */
2562 if (tplg->comp && tplg->ops && tplg->ops->manifest)
2563 return tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2565 if (!abi_match) /* free the duplicated one */
2571 /* validate header magic, size and type */
2572 static int soc_valid_header(struct soc_tplg *tplg,
2573 struct snd_soc_tplg_hdr *hdr)
2575 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2578 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2580 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2581 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2586 /* big endian firmware objects not supported atm */
2587 if (hdr->magic == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2589 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2590 tplg->pass, hdr->magic,
2591 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2595 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2597 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2598 tplg->pass, hdr->magic,
2599 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2603 /* Support ABI from version 4 */
2604 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2605 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2607 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2608 tplg->pass, hdr->abi,
2609 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2614 if (hdr->payload_size == 0) {
2615 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2616 soc_tplg_get_hdr_offset(tplg));
2620 if (tplg->pass == le32_to_cpu(hdr->type))
2622 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2623 hdr->payload_size, hdr->type, hdr->version,
2624 hdr->vendor_type, tplg->pass);
2629 /* check header type and call appropriate handler */
2630 static int soc_tplg_load_header(struct soc_tplg *tplg,
2631 struct snd_soc_tplg_hdr *hdr)
2633 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2635 /* check for matching ID */
2636 if (le32_to_cpu(hdr->index) != tplg->req_index &&
2637 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2640 tplg->index = le32_to_cpu(hdr->index);
2642 switch (le32_to_cpu(hdr->type)) {
2643 case SND_SOC_TPLG_TYPE_MIXER:
2644 case SND_SOC_TPLG_TYPE_ENUM:
2645 case SND_SOC_TPLG_TYPE_BYTES:
2646 return soc_tplg_kcontrol_elems_load(tplg, hdr);
2647 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2648 return soc_tplg_dapm_graph_elems_load(tplg, hdr);
2649 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2650 return soc_tplg_dapm_widget_elems_load(tplg, hdr);
2651 case SND_SOC_TPLG_TYPE_PCM:
2652 return soc_tplg_pcm_elems_load(tplg, hdr);
2653 case SND_SOC_TPLG_TYPE_DAI:
2654 return soc_tplg_dai_elems_load(tplg, hdr);
2655 case SND_SOC_TPLG_TYPE_DAI_LINK:
2656 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2657 /* physical link configurations */
2658 return soc_tplg_link_elems_load(tplg, hdr);
2659 case SND_SOC_TPLG_TYPE_MANIFEST:
2660 return soc_tplg_manifest_load(tplg, hdr);
2662 /* bespoke vendor data object */
2663 return soc_tplg_vendor_load(tplg, hdr);
2669 /* process the topology file headers */
2670 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2672 struct snd_soc_tplg_hdr *hdr;
2675 tplg->pass = SOC_TPLG_PASS_START;
2677 /* process the header types from start to end */
2678 while (tplg->pass <= SOC_TPLG_PASS_END) {
2680 tplg->hdr_pos = tplg->fw->data;
2681 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2683 while (!soc_tplg_is_eof(tplg)) {
2685 /* make sure header is valid before loading */
2686 ret = soc_valid_header(tplg, hdr);
2692 /* load the header object */
2693 ret = soc_tplg_load_header(tplg, hdr);
2697 /* goto next header */
2698 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2699 sizeof(struct snd_soc_tplg_hdr);
2700 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2703 /* next data type pass */
2707 /* signal DAPM we are complete */
2708 ret = soc_tplg_dapm_complete(tplg);
2711 "ASoC: failed to initialise DAPM from Firmware\n");
2716 static int soc_tplg_load(struct soc_tplg *tplg)
2720 ret = soc_tplg_process_headers(tplg);
2722 soc_tplg_complete(tplg);
2727 /* load audio component topology from "firmware" file */
2728 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2729 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2731 struct soc_tplg tplg;
2734 /* setup parsing context */
2735 memset(&tplg, 0, sizeof(tplg));
2737 tplg.dev = comp->dev;
2740 tplg.req_index = id;
2741 tplg.io_ops = ops->io_ops;
2742 tplg.io_ops_count = ops->io_ops_count;
2743 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2744 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2746 ret = soc_tplg_load(&tplg);
2747 /* free the created components if fail to load topology */
2749 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2753 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2755 /* remove this dynamic widget */
2756 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2758 /* make sure we are a widget */
2759 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2762 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2764 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2766 /* remove all dynamic widgets from this DAPM context */
2767 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2770 struct snd_soc_dapm_widget *w, *next_w;
2772 list_for_each_entry_safe(w, next_w, &dapm->card->widgets, list) {
2774 /* make sure we are a widget with correct context */
2775 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2779 if (w->dobj.index != index &&
2780 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2782 /* check and free and dynamic widget kcontrols */
2783 snd_soc_tplg_widget_remove(w);
2784 snd_soc_dapm_free_widget(w);
2786 snd_soc_dapm_reset_cache(dapm);
2788 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2790 /* remove dynamic controls from the component driver */
2791 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2793 struct snd_soc_dobj *dobj, *next_dobj;
2794 int pass = SOC_TPLG_PASS_END;
2796 /* process the header types from end to start */
2797 while (pass >= SOC_TPLG_PASS_START) {
2799 /* remove mixer controls */
2800 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2804 if (dobj->index != index &&
2805 index != SND_SOC_TPLG_INDEX_ALL)
2808 switch (dobj->type) {
2809 case SND_SOC_DOBJ_MIXER:
2810 remove_mixer(comp, dobj, pass);
2812 case SND_SOC_DOBJ_ENUM:
2813 remove_enum(comp, dobj, pass);
2815 case SND_SOC_DOBJ_BYTES:
2816 remove_bytes(comp, dobj, pass);
2818 case SND_SOC_DOBJ_GRAPH:
2819 remove_route(comp, dobj, pass);
2821 case SND_SOC_DOBJ_WIDGET:
2822 remove_widget(comp, dobj, pass);
2824 case SND_SOC_DOBJ_PCM:
2825 remove_dai(comp, dobj, pass);
2827 case SND_SOC_DOBJ_DAI_LINK:
2828 remove_link(comp, dobj, pass);
2830 case SND_SOC_DOBJ_BACKEND_LINK:
2832 * call link_unload ops if extra
2833 * deinitialization is needed.
2835 remove_backend_link(comp, dobj, pass);
2838 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2846 /* let caller know if FW can be freed when no objects are left */
2847 return !list_empty(&comp->dobj_list);
2849 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);