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_CONTROL 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_BE_DAI 6
48 #define SOC_TPLG_PASS_LINK 7
50 #define SOC_TPLG_PASS_START SOC_TPLG_PASS_MANIFEST
51 #define SOC_TPLG_PASS_END SOC_TPLG_PASS_LINK
53 /* topology context */
55 const struct firmware *fw;
57 /* runtime FW parsing */
58 const u8 *pos; /* read position */
59 const u8 *hdr_pos; /* header position */
60 unsigned int pass; /* pass number */
62 /* component caller */
64 struct snd_soc_component *comp;
65 u32 index; /* current block index */
67 /* vendor specific kcontrol operations */
68 const struct snd_soc_tplg_kcontrol_ops *io_ops;
71 /* vendor specific bytes ext handlers, for TLV bytes controls */
72 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
73 int bytes_ext_ops_count;
75 /* optional fw loading callbacks to component drivers */
76 struct snd_soc_tplg_ops *ops;
79 /* check we dont overflow the data for this control chunk */
80 static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
81 unsigned int count, size_t bytes, const char *elem_type)
83 const u8 *end = tplg->pos + elem_size * count;
85 if (end > tplg->fw->data + tplg->fw->size) {
86 dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
91 /* check there is enough room in chunk for control.
92 extra bytes at the end of control are for vendor data here */
93 if (elem_size * count > bytes) {
95 "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
96 elem_type, count, elem_size, bytes);
103 static inline bool soc_tplg_is_eof(struct soc_tplg *tplg)
105 const u8 *end = tplg->hdr_pos;
107 if (end >= tplg->fw->data + tplg->fw->size)
112 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
114 return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
117 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
119 return (unsigned long)(tplg->pos - tplg->fw->data);
122 /* mapping of Kcontrol types and associated operations. */
123 static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
124 {SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
125 snd_soc_put_volsw, snd_soc_info_volsw},
126 {SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
127 snd_soc_put_volsw_sx, NULL},
128 {SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
129 snd_soc_put_enum_double, snd_soc_info_enum_double},
130 {SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
131 snd_soc_put_enum_double, NULL},
132 {SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
133 snd_soc_bytes_put, snd_soc_bytes_info},
134 {SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw_range,
135 snd_soc_put_volsw_range, snd_soc_info_volsw_range},
136 {SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
137 snd_soc_put_xr_sx, snd_soc_info_xr_sx},
138 {SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
139 snd_soc_put_strobe, NULL},
140 {SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
141 snd_soc_dapm_put_volsw, snd_soc_info_volsw},
142 {SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
143 snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
144 {SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
145 snd_soc_dapm_put_enum_double, NULL},
146 {SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
147 snd_soc_dapm_put_enum_double, NULL},
148 {SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
149 snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
152 struct soc_tplg_map {
157 /* mapping of widget types from UAPI IDs to kernel IDs */
158 static const struct soc_tplg_map dapm_map[] = {
159 {SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
160 {SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
161 {SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
162 {SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
163 {SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
164 {SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
165 {SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
166 {SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
167 {SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
168 {SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
169 {SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
170 {SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
171 {SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
172 {SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
173 {SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
174 {SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
175 {SND_SOC_TPLG_DAPM_BUFFER, snd_soc_dapm_buffer},
176 {SND_SOC_TPLG_DAPM_SCHEDULER, snd_soc_dapm_scheduler},
177 {SND_SOC_TPLG_DAPM_EFFECT, snd_soc_dapm_effect},
178 {SND_SOC_TPLG_DAPM_SIGGEN, snd_soc_dapm_siggen},
179 {SND_SOC_TPLG_DAPM_SRC, snd_soc_dapm_src},
180 {SND_SOC_TPLG_DAPM_ASRC, snd_soc_dapm_asrc},
181 {SND_SOC_TPLG_DAPM_ENCODER, snd_soc_dapm_encoder},
182 {SND_SOC_TPLG_DAPM_DECODER, snd_soc_dapm_decoder},
185 static int tplg_chan_get_reg(struct soc_tplg *tplg,
186 struct snd_soc_tplg_channel *chan, int map)
190 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
191 if (le32_to_cpu(chan[i].id) == map)
192 return le32_to_cpu(chan[i].reg);
198 static int tplg_chan_get_shift(struct soc_tplg *tplg,
199 struct snd_soc_tplg_channel *chan, int map)
203 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
204 if (le32_to_cpu(chan[i].id) == map)
205 return le32_to_cpu(chan[i].shift);
211 static int get_widget_id(int tplg_type)
215 for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
216 if (tplg_type == dapm_map[i].uid)
217 return dapm_map[i].kid;
223 static inline void soc_bind_err(struct soc_tplg *tplg,
224 struct snd_soc_tplg_ctl_hdr *hdr, int index)
227 "ASoC: invalid control type (g,p,i) %d:%d:%d index %d at 0x%lx\n",
228 hdr->ops.get, hdr->ops.put, hdr->ops.info, index,
229 soc_tplg_get_offset(tplg));
232 static inline void soc_control_err(struct soc_tplg *tplg,
233 struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
236 "ASoC: no complete control IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
237 name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
238 soc_tplg_get_offset(tplg));
241 /* pass vendor data to component driver for processing */
242 static int soc_tplg_vendor_load(struct soc_tplg *tplg,
243 struct snd_soc_tplg_hdr *hdr)
247 if (tplg->ops && tplg->ops->vendor_load)
248 ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
250 dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
257 "ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
258 soc_tplg_get_hdr_offset(tplg),
259 soc_tplg_get_hdr_offset(tplg),
260 hdr->type, hdr->vendor_type);
264 /* optionally pass new dynamic widget to component driver. This is mainly for
265 * external widgets where we can assign private data/ops */
266 static int soc_tplg_widget_load(struct soc_tplg *tplg,
267 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
269 if (tplg->ops && tplg->ops->widget_load)
270 return tplg->ops->widget_load(tplg->comp, tplg->index, w,
276 /* optionally pass new dynamic widget to component driver. This is mainly for
277 * external widgets where we can assign private data/ops */
278 static int soc_tplg_widget_ready(struct soc_tplg *tplg,
279 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
281 if (tplg->ops && tplg->ops->widget_ready)
282 return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
288 /* pass DAI configurations to component driver for extra initialization */
289 static int soc_tplg_dai_load(struct soc_tplg *tplg,
290 struct snd_soc_dai_driver *dai_drv,
291 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
293 if (tplg->ops && tplg->ops->dai_load)
294 return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
300 /* pass link configurations to component driver for extra initialization */
301 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
302 struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
304 if (tplg->ops && tplg->ops->link_load)
305 return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
310 /* tell the component driver that all firmware has been loaded in this request */
311 static int soc_tplg_complete(struct soc_tplg *tplg)
313 if (tplg->ops && tplg->ops->complete)
314 return tplg->ops->complete(tplg->comp);
319 /* add a dynamic kcontrol */
320 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
321 const struct snd_kcontrol_new *control_new, const char *prefix,
322 void *data, struct snd_kcontrol **kcontrol)
326 *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
327 if (*kcontrol == NULL) {
328 dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
333 err = snd_ctl_add(card, *kcontrol);
335 dev_err(dev, "ASoC: Failed to add %s: %d\n",
336 control_new->name, err);
343 /* add a dynamic kcontrol for component driver */
344 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
345 struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
347 struct snd_soc_component *comp = tplg->comp;
349 return soc_tplg_add_dcontrol(comp->card->snd_card,
350 tplg->dev, k, comp->name_prefix, comp, kcontrol);
353 /* remove kcontrol */
354 static void soc_tplg_remove_kcontrol(struct snd_soc_component *comp, struct snd_soc_dobj *dobj,
357 struct snd_card *card = comp->card->snd_card;
359 if (pass != SOC_TPLG_PASS_CONTROL)
363 dobj->unload(comp, dobj);
365 snd_ctl_remove(card, dobj->control.kcontrol);
366 list_del(&dobj->list);
370 static void soc_tplg_remove_route(struct snd_soc_component *comp,
371 struct snd_soc_dobj *dobj, int pass)
373 if (pass != SOC_TPLG_PASS_GRAPH)
377 dobj->unload(comp, dobj);
379 list_del(&dobj->list);
382 /* remove a widget and it's kcontrols - routes must be removed first */
383 static void soc_tplg_remove_widget(struct snd_soc_component *comp,
384 struct snd_soc_dobj *dobj, int pass)
386 struct snd_card *card = comp->card->snd_card;
387 struct snd_soc_dapm_widget *w =
388 container_of(dobj, struct snd_soc_dapm_widget, dobj);
391 if (pass != SOC_TPLG_PASS_WIDGET)
395 dobj->unload(comp, dobj);
400 for (i = 0; w->kcontrols && i < w->num_kcontrols; i++)
401 snd_ctl_remove(card, w->kcontrols[i]);
405 list_del(&dobj->list);
407 /* widget w is freed by soc-dapm.c */
410 /* remove DAI configurations */
411 static void soc_tplg_remove_dai(struct snd_soc_component *comp,
412 struct snd_soc_dobj *dobj, int pass)
414 struct snd_soc_dai_driver *dai_drv =
415 container_of(dobj, struct snd_soc_dai_driver, dobj);
416 struct snd_soc_dai *dai, *_dai;
418 if (pass != SOC_TPLG_PASS_PCM_DAI)
422 dobj->unload(comp, dobj);
424 for_each_component_dais_safe(comp, dai, _dai)
425 if (dai->driver == dai_drv)
426 snd_soc_unregister_dai(dai);
428 list_del(&dobj->list);
431 /* remove link configurations */
432 static void soc_tplg_remove_link(struct snd_soc_component *comp,
433 struct snd_soc_dobj *dobj, int pass)
435 struct snd_soc_dai_link *link =
436 container_of(dobj, struct snd_soc_dai_link, dobj);
438 if (pass != SOC_TPLG_PASS_PCM_DAI)
442 dobj->unload(comp, dobj);
444 list_del(&dobj->list);
445 snd_soc_remove_pcm_runtime(comp->card,
446 snd_soc_get_pcm_runtime(comp->card, link));
449 /* unload dai link */
450 static void remove_backend_link(struct snd_soc_component *comp,
451 struct snd_soc_dobj *dobj, int pass)
453 if (pass != SOC_TPLG_PASS_LINK)
457 dobj->unload(comp, dobj);
460 * We don't free the link here as what soc_tplg_remove_link() do since BE
461 * links are not allocated by topology.
462 * We however need to reset the dobj type to its initial values
464 dobj->type = SND_SOC_DOBJ_NONE;
465 list_del(&dobj->list);
468 /* bind a kcontrol to it's IO handlers */
469 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
470 struct snd_kcontrol_new *k,
471 const struct soc_tplg *tplg)
473 const struct snd_soc_tplg_kcontrol_ops *ops;
474 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
477 if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
478 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
479 && (k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ
480 || k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
481 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
482 struct soc_bytes_ext *sbe;
483 struct snd_soc_tplg_bytes_control *be;
485 sbe = (struct soc_bytes_ext *)k->private_value;
486 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
488 /* TLV bytes controls need standard kcontrol info handler,
489 * TLV callback and extended put/get handlers.
491 k->info = snd_soc_bytes_info_ext;
492 k->tlv.c = snd_soc_bytes_tlv_callback;
495 * When a topology-based implementation abuses the
496 * control interface and uses bytes_ext controls of
497 * more than 512 bytes, we need to disable the size
498 * checks, otherwise accesses to such controls will
499 * return an -EINVAL error and prevent the card from
503 k->access |= SNDRV_CTL_ELEM_ACCESS_SKIP_CHECK;
505 ext_ops = tplg->bytes_ext_ops;
506 num_ops = tplg->bytes_ext_ops_count;
507 for (i = 0; i < num_ops; i++) {
509 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
510 sbe->put = ext_ops[i].put;
512 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
513 sbe->get = ext_ops[i].get;
516 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) && !sbe->get)
518 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) && !sbe->put)
523 /* try and map vendor specific kcontrol handlers first */
525 num_ops = tplg->io_ops_count;
526 for (i = 0; i < num_ops; i++) {
528 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
530 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
532 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
533 k->info = ops[i].info;
536 /* vendor specific handlers found ? */
537 if (k->put && k->get && k->info)
540 /* none found so try standard kcontrol handlers */
542 num_ops = ARRAY_SIZE(io_ops);
543 for (i = 0; i < num_ops; i++) {
545 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
547 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
549 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
550 k->info = ops[i].info;
553 /* standard handlers found ? */
554 if (k->put && k->get && k->info)
557 /* nothing to bind */
561 /* bind a widgets to it's evnt handlers */
562 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
563 const struct snd_soc_tplg_widget_events *events,
564 int num_events, u16 event_type)
570 for (i = 0; i < num_events; i++) {
571 if (event_type == events[i].type) {
573 /* found - so assign event */
574 w->event = events[i].event_handler;
582 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
584 /* optionally pass new dynamic kcontrol to component driver. */
585 static int soc_tplg_control_load(struct soc_tplg *tplg,
586 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
588 if (tplg->ops && tplg->ops->control_load)
589 return tplg->ops->control_load(tplg->comp, tplg->index, k,
596 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
597 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
599 unsigned int item_len = 2 * sizeof(unsigned int);
602 p = devm_kzalloc(tplg->dev, item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
606 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
608 p[2] = le32_to_cpu(scale->min);
609 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
610 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
612 kc->tlv.p = (void *)p;
616 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
617 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
619 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
620 u32 access = le32_to_cpu(tc->access);
622 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
625 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
627 switch (le32_to_cpu(tplg_tlv->type)) {
628 case SNDRV_CTL_TLVT_DB_SCALE:
629 return soc_tplg_create_tlv_db_scale(tplg, kc,
632 /* TODO: add support for other TLV types */
634 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
643 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, size_t size)
645 struct snd_soc_tplg_bytes_control *be;
646 struct soc_bytes_ext *sbe;
647 struct snd_kcontrol_new kc;
650 if (soc_tplg_check_elem_count(tplg,
651 sizeof(struct snd_soc_tplg_bytes_control),
652 1, size, "mixer bytes"))
655 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
657 /* validate kcontrol */
658 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
659 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
662 sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
666 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
667 le32_to_cpu(be->priv.size));
670 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
671 be->hdr.name, be->hdr.access);
673 memset(&kc, 0, sizeof(kc));
674 kc.name = be->hdr.name;
675 kc.private_value = (long)sbe;
676 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
677 kc.access = le32_to_cpu(be->hdr.access);
679 sbe->max = le32_to_cpu(be->max);
680 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
682 sbe->dobj.unload = tplg->ops->control_unload;
683 INIT_LIST_HEAD(&sbe->dobj.list);
685 /* map io handlers */
686 ret = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
688 soc_control_err(tplg, &be->hdr, be->hdr.name);
692 /* pass control to driver for optional further init */
693 ret = soc_tplg_control_load(tplg, &kc, &be->hdr);
695 dev_err(tplg->dev, "ASoC: failed to init %s\n", be->hdr.name);
699 /* register control here */
700 ret = soc_tplg_add_kcontrol(tplg, &kc, &sbe->dobj.control.kcontrol);
702 dev_err(tplg->dev, "ASoC: failed to add %s\n", be->hdr.name);
706 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
712 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, size_t size)
714 struct snd_soc_tplg_mixer_control *mc;
715 struct soc_mixer_control *sm;
716 struct snd_kcontrol_new kc;
719 if (soc_tplg_check_elem_count(tplg,
720 sizeof(struct snd_soc_tplg_mixer_control),
724 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
726 /* validate kcontrol */
727 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
728 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
731 sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
734 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
735 le32_to_cpu(mc->priv.size));
738 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
739 mc->hdr.name, mc->hdr.access);
741 memset(&kc, 0, sizeof(kc));
742 kc.name = mc->hdr.name;
743 kc.private_value = (long)sm;
744 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
745 kc.access = le32_to_cpu(mc->hdr.access);
747 /* we only support FL/FR channel mapping atm */
748 sm->reg = tplg_chan_get_reg(tplg, mc->channel, SNDRV_CHMAP_FL);
749 sm->rreg = tplg_chan_get_reg(tplg, mc->channel, SNDRV_CHMAP_FR);
750 sm->shift = tplg_chan_get_shift(tplg, mc->channel, SNDRV_CHMAP_FL);
751 sm->rshift = tplg_chan_get_shift(tplg, mc->channel, SNDRV_CHMAP_FR);
753 sm->max = le32_to_cpu(mc->max);
754 sm->min = le32_to_cpu(mc->min);
755 sm->invert = le32_to_cpu(mc->invert);
756 sm->platform_max = le32_to_cpu(mc->platform_max);
757 sm->dobj.index = tplg->index;
758 sm->dobj.type = SND_SOC_DOBJ_MIXER;
760 sm->dobj.unload = tplg->ops->control_unload;
761 INIT_LIST_HEAD(&sm->dobj.list);
763 /* map io handlers */
764 ret = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
766 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
770 /* create any TLV data */
771 ret = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
773 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n", mc->hdr.name);
777 /* pass control to driver for optional further init */
778 ret = soc_tplg_control_load(tplg, &kc, &mc->hdr);
780 dev_err(tplg->dev, "ASoC: failed to init %s\n", mc->hdr.name);
784 /* register control here */
785 ret = soc_tplg_add_kcontrol(tplg, &kc, &sm->dobj.control.kcontrol);
787 dev_err(tplg->dev, "ASoC: failed to add %s\n", mc->hdr.name);
791 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
797 static int soc_tplg_denum_create_texts(struct soc_tplg *tplg, struct soc_enum *se,
798 struct snd_soc_tplg_enum_control *ec)
802 if (le32_to_cpu(ec->items) > ARRAY_SIZE(ec->texts))
805 se->dobj.control.dtexts =
806 devm_kcalloc(tplg->dev, le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
807 if (se->dobj.control.dtexts == NULL)
810 for (i = 0; i < le32_to_cpu(ec->items); i++) {
812 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
813 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
818 se->dobj.control.dtexts[i] = devm_kstrdup(tplg->dev, ec->texts[i], GFP_KERNEL);
819 if (!se->dobj.control.dtexts[i]) {
825 se->items = le32_to_cpu(ec->items);
826 se->texts = (const char * const *)se->dobj.control.dtexts;
833 static int soc_tplg_denum_create_values(struct soc_tplg *tplg, struct soc_enum *se,
834 struct snd_soc_tplg_enum_control *ec)
839 * Following "if" checks if we have at most SND_SOC_TPLG_NUM_TEXTS
840 * values instead of using ARRAY_SIZE(ec->values) due to the fact that
841 * it is oversized for its purpose. Additionally it is done so because
842 * it is defined in UAPI header where it can't be easily changed.
844 if (le32_to_cpu(ec->items) > SND_SOC_TPLG_NUM_TEXTS)
847 se->dobj.control.dvalues = devm_kcalloc(tplg->dev, le32_to_cpu(ec->items),
848 sizeof(*se->dobj.control.dvalues),
850 if (!se->dobj.control.dvalues)
853 /* convert from little-endian */
854 for (i = 0; i < le32_to_cpu(ec->items); i++) {
855 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
861 static int soc_tplg_denum_create(struct soc_tplg *tplg, size_t size)
863 struct snd_soc_tplg_enum_control *ec;
865 struct snd_kcontrol_new kc;
868 if (soc_tplg_check_elem_count(tplg,
869 sizeof(struct snd_soc_tplg_enum_control),
873 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
875 /* validate kcontrol */
876 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
877 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
880 se = devm_kzalloc(tplg->dev, (sizeof(*se)), GFP_KERNEL);
884 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
885 le32_to_cpu(ec->priv.size));
887 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
888 ec->hdr.name, ec->items);
890 memset(&kc, 0, sizeof(kc));
891 kc.name = ec->hdr.name;
892 kc.private_value = (long)se;
893 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
894 kc.access = le32_to_cpu(ec->hdr.access);
896 se->reg = tplg_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
897 se->shift_l = tplg_chan_get_shift(tplg, ec->channel,
899 se->shift_r = tplg_chan_get_shift(tplg, ec->channel,
902 se->mask = le32_to_cpu(ec->mask);
903 se->dobj.index = tplg->index;
904 se->dobj.type = SND_SOC_DOBJ_ENUM;
906 se->dobj.unload = tplg->ops->control_unload;
907 INIT_LIST_HEAD(&se->dobj.list);
909 switch (le32_to_cpu(ec->hdr.ops.info)) {
910 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
911 case SND_SOC_TPLG_CTL_ENUM_VALUE:
912 ret = soc_tplg_denum_create_values(tplg, se, ec);
915 "ASoC: could not create values for %s\n",
920 case SND_SOC_TPLG_CTL_ENUM:
921 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
922 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
923 ret = soc_tplg_denum_create_texts(tplg, se, ec);
926 "ASoC: could not create texts for %s\n",
934 "ASoC: invalid enum control type %d for %s\n",
935 ec->hdr.ops.info, ec->hdr.name);
939 /* map io handlers */
940 ret = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
942 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
946 /* pass control to driver for optional further init */
947 ret = soc_tplg_control_load(tplg, &kc, &ec->hdr);
949 dev_err(tplg->dev, "ASoC: failed to init %s\n", ec->hdr.name);
953 /* register control here */
954 ret = soc_tplg_add_kcontrol(tplg, &kc, &se->dobj.control.kcontrol);
956 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n", ec->hdr.name);
960 list_add(&se->dobj.list, &tplg->comp->dobj_list);
966 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
967 struct snd_soc_tplg_hdr *hdr)
972 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
973 soc_tplg_get_offset(tplg));
975 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
976 struct snd_soc_tplg_ctl_hdr *control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
978 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
979 dev_err(tplg->dev, "ASoC: invalid control size\n");
983 switch (le32_to_cpu(control_hdr->ops.info)) {
984 case SND_SOC_TPLG_CTL_VOLSW:
985 case SND_SOC_TPLG_CTL_STROBE:
986 case SND_SOC_TPLG_CTL_VOLSW_SX:
987 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
988 case SND_SOC_TPLG_CTL_RANGE:
989 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
990 case SND_SOC_TPLG_DAPM_CTL_PIN:
991 ret = soc_tplg_dmixer_create(tplg, le32_to_cpu(hdr->payload_size));
993 case SND_SOC_TPLG_CTL_ENUM:
994 case SND_SOC_TPLG_CTL_ENUM_VALUE:
995 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
996 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
997 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
998 ret = soc_tplg_denum_create(tplg, le32_to_cpu(hdr->payload_size));
1000 case SND_SOC_TPLG_CTL_BYTES:
1001 ret = soc_tplg_dbytes_create(tplg, le32_to_cpu(hdr->payload_size));
1004 soc_bind_err(tplg, control_hdr, i);
1008 dev_err(tplg->dev, "ASoC: invalid control\n");
1017 /* optionally pass new dynamic kcontrol to component driver. */
1018 static int soc_tplg_add_route(struct soc_tplg *tplg,
1019 struct snd_soc_dapm_route *route)
1021 if (tplg->ops && tplg->ops->dapm_route_load)
1022 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1028 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1029 struct snd_soc_tplg_hdr *hdr)
1031 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1032 struct snd_soc_tplg_dapm_graph_elem *elem;
1033 struct snd_soc_dapm_route *route;
1037 count = le32_to_cpu(hdr->count);
1039 if (soc_tplg_check_elem_count(tplg,
1040 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1041 count, le32_to_cpu(hdr->payload_size), "graph"))
1044 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1047 for (i = 0; i < count; i++) {
1048 route = devm_kzalloc(tplg->dev, sizeof(*route), GFP_KERNEL);
1051 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1052 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1054 /* validate routes */
1055 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1056 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1060 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1061 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1065 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1066 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1071 route->source = elem->source;
1072 route->sink = elem->sink;
1074 /* set to NULL atm for tplg users */
1075 route->connected = NULL;
1076 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1077 route->control = NULL;
1079 route->control = elem->control;
1081 /* add route dobj to dobj_list */
1082 route->dobj.type = SND_SOC_DOBJ_GRAPH;
1084 route->dobj.unload = tplg->ops->dapm_route_unload;
1085 route->dobj.index = tplg->index;
1086 list_add(&route->dobj.list, &tplg->comp->dobj_list);
1088 ret = soc_tplg_add_route(tplg, route);
1090 dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1094 /* add route, but keep going if some fail */
1095 snd_soc_dapm_add_routes(dapm, route, 1);
1101 static int soc_tplg_dapm_widget_dmixer_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1103 struct soc_mixer_control *sm;
1104 struct snd_soc_tplg_mixer_control *mc;
1107 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1109 /* validate kcontrol */
1110 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1111 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1114 sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
1118 tplg->pos += sizeof(struct snd_soc_tplg_mixer_control) +
1119 le32_to_cpu(mc->priv.size);
1121 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s\n",
1124 kc->private_value = (long)sm;
1125 kc->name = devm_kstrdup(tplg->dev, mc->hdr.name, GFP_KERNEL);
1128 kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1129 kc->access = le32_to_cpu(mc->hdr.access);
1131 /* we only support FL/FR channel mapping atm */
1132 sm->reg = tplg_chan_get_reg(tplg, mc->channel,
1134 sm->rreg = tplg_chan_get_reg(tplg, mc->channel,
1136 sm->shift = tplg_chan_get_shift(tplg, mc->channel,
1138 sm->rshift = tplg_chan_get_shift(tplg, mc->channel,
1141 sm->max = le32_to_cpu(mc->max);
1142 sm->min = le32_to_cpu(mc->min);
1143 sm->invert = le32_to_cpu(mc->invert);
1144 sm->platform_max = le32_to_cpu(mc->platform_max);
1145 sm->dobj.index = tplg->index;
1146 INIT_LIST_HEAD(&sm->dobj.list);
1148 /* map io handlers */
1149 err = soc_tplg_kcontrol_bind_io(&mc->hdr, kc, tplg);
1151 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1155 /* create any TLV data */
1156 err = soc_tplg_create_tlv(tplg, kc, &mc->hdr);
1158 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1163 /* pass control to driver for optional further init */
1164 err = soc_tplg_control_load(tplg, kc, &mc->hdr);
1166 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1174 static int soc_tplg_dapm_widget_denum_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1176 struct snd_soc_tplg_enum_control *ec;
1177 struct soc_enum *se;
1180 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1181 /* validate kcontrol */
1182 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1183 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1186 se = devm_kzalloc(tplg->dev, sizeof(*se), GFP_KERNEL);
1190 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1191 le32_to_cpu(ec->priv.size));
1193 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1196 kc->private_value = (long)se;
1197 kc->name = devm_kstrdup(tplg->dev, ec->hdr.name, GFP_KERNEL);
1200 kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1201 kc->access = le32_to_cpu(ec->hdr.access);
1203 /* we only support FL/FR channel mapping atm */
1204 se->reg = tplg_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1205 se->shift_l = tplg_chan_get_shift(tplg, ec->channel,
1207 se->shift_r = tplg_chan_get_shift(tplg, ec->channel,
1210 se->items = le32_to_cpu(ec->items);
1211 se->mask = le32_to_cpu(ec->mask);
1212 se->dobj.index = tplg->index;
1214 switch (le32_to_cpu(ec->hdr.ops.info)) {
1215 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1216 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1217 err = soc_tplg_denum_create_values(tplg, se, ec);
1219 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1224 case SND_SOC_TPLG_CTL_ENUM:
1225 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1226 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1227 err = soc_tplg_denum_create_texts(tplg, se, ec);
1229 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1235 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1236 ec->hdr.ops.info, ec->hdr.name);
1240 /* map io handlers */
1241 err = soc_tplg_kcontrol_bind_io(&ec->hdr, kc, tplg);
1243 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1247 /* pass control to driver for optional further init */
1248 err = soc_tplg_control_load(tplg, kc, &ec->hdr);
1250 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1258 static int soc_tplg_dapm_widget_dbytes_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1260 struct snd_soc_tplg_bytes_control *be;
1261 struct soc_bytes_ext *sbe;
1264 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1266 /* validate kcontrol */
1267 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1268 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1271 sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
1275 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1276 le32_to_cpu(be->priv.size));
1279 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1280 be->hdr.name, be->hdr.access);
1282 kc->private_value = (long)sbe;
1283 kc->name = devm_kstrdup(tplg->dev, be->hdr.name, GFP_KERNEL);
1286 kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1287 kc->access = le32_to_cpu(be->hdr.access);
1289 sbe->max = le32_to_cpu(be->max);
1290 INIT_LIST_HEAD(&sbe->dobj.list);
1292 /* map standard io handlers and check for external handlers */
1293 err = soc_tplg_kcontrol_bind_io(&be->hdr, kc, tplg);
1295 soc_control_err(tplg, &be->hdr, be->hdr.name);
1299 /* pass control to driver for optional further init */
1300 err = soc_tplg_control_load(tplg, kc, &be->hdr);
1302 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1310 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1311 struct snd_soc_tplg_dapm_widget *w)
1313 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1314 struct snd_soc_dapm_widget template, *widget;
1315 struct snd_soc_tplg_ctl_hdr *control_hdr;
1316 struct snd_soc_card *card = tplg->comp->card;
1317 unsigned int *kcontrol_type = NULL;
1318 struct snd_kcontrol_new *kc;
1319 int mixer_count = 0;
1320 int bytes_count = 0;
1325 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1326 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1328 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1329 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1332 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1335 memset(&template, 0, sizeof(template));
1337 /* map user to kernel widget ID */
1338 template.id = get_widget_id(le32_to_cpu(w->id));
1339 if ((int)template.id < 0)
1342 /* strings are allocated here, but used and freed by the widget */
1343 template.name = kstrdup(w->name, GFP_KERNEL);
1346 template.sname = kstrdup(w->sname, GFP_KERNEL);
1347 if (!template.sname) {
1351 template.reg = le32_to_cpu(w->reg);
1352 template.shift = le32_to_cpu(w->shift);
1353 template.mask = le32_to_cpu(w->mask);
1354 template.subseq = le32_to_cpu(w->subseq);
1355 template.on_val = w->invert ? 0 : 1;
1356 template.off_val = w->invert ? 1 : 0;
1357 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1358 template.event_flags = le16_to_cpu(w->event_flags);
1359 template.dobj.index = tplg->index;
1362 (sizeof(struct snd_soc_tplg_dapm_widget) +
1363 le32_to_cpu(w->priv.size));
1365 if (w->num_kcontrols == 0) {
1366 template.num_kcontrols = 0;
1370 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1371 kc = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(*kc), GFP_KERNEL);
1377 kcontrol_type = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(unsigned int),
1379 if (!kcontrol_type) {
1384 for (i = 0; i < le32_to_cpu(w->num_kcontrols); i++) {
1385 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1386 switch (le32_to_cpu(control_hdr->ops.info)) {
1387 case SND_SOC_TPLG_CTL_VOLSW:
1388 case SND_SOC_TPLG_CTL_STROBE:
1389 case SND_SOC_TPLG_CTL_VOLSW_SX:
1390 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1391 case SND_SOC_TPLG_CTL_RANGE:
1392 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1394 kc[i].index = mixer_count;
1395 kcontrol_type[i] = SND_SOC_TPLG_TYPE_MIXER;
1397 ret = soc_tplg_dapm_widget_dmixer_create(tplg, &kc[i]);
1401 case SND_SOC_TPLG_CTL_ENUM:
1402 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1403 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1404 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1405 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1406 /* enumerated mixer */
1407 kc[i].index = enum_count;
1408 kcontrol_type[i] = SND_SOC_TPLG_TYPE_ENUM;
1410 ret = soc_tplg_dapm_widget_denum_create(tplg, &kc[i]);
1414 case SND_SOC_TPLG_CTL_BYTES:
1416 kc[i].index = bytes_count;
1417 kcontrol_type[i] = SND_SOC_TPLG_TYPE_BYTES;
1419 ret = soc_tplg_dapm_widget_dbytes_create(tplg, &kc[i]);
1424 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1425 control_hdr->ops.get, control_hdr->ops.put,
1426 le32_to_cpu(control_hdr->ops.info));
1432 template.kcontrol_news = kc;
1433 dev_dbg(tplg->dev, "ASoC: template %s with %d/%d/%d (mixer/enum/bytes) control\n",
1434 w->name, mixer_count, enum_count, bytes_count);
1437 ret = soc_tplg_widget_load(tplg, &template, w);
1441 /* card dapm mutex is held by the core if we are loading topology
1442 * data during sound card init. */
1443 if (snd_soc_card_is_instantiated(card))
1444 widget = snd_soc_dapm_new_control(dapm, &template);
1446 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1447 if (IS_ERR(widget)) {
1448 ret = PTR_ERR(widget);
1452 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1453 widget->dobj.widget.kcontrol_type = kcontrol_type;
1455 widget->dobj.unload = tplg->ops->widget_unload;
1456 widget->dobj.index = tplg->index;
1457 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1459 ret = soc_tplg_widget_ready(tplg, widget, w);
1463 kfree(template.sname);
1464 kfree(template.name);
1469 soc_tplg_remove_widget(widget->dapm->component, &widget->dobj, SOC_TPLG_PASS_WIDGET);
1470 snd_soc_dapm_free_widget(widget);
1472 kfree(template.sname);
1474 kfree(template.name);
1478 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1479 struct snd_soc_tplg_hdr *hdr)
1483 count = le32_to_cpu(hdr->count);
1485 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1487 for (i = 0; i < count; i++) {
1488 struct snd_soc_tplg_dapm_widget *widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1492 * check if widget itself fits within topology file
1493 * use sizeof instead of widget->size, as we can't be sure
1494 * it is set properly yet (file may end before it is present)
1496 if (soc_tplg_get_offset(tplg) + sizeof(*widget) >= tplg->fw->size) {
1497 dev_err(tplg->dev, "ASoC: invalid widget data size\n");
1501 /* check if widget has proper size */
1502 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1503 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1507 /* check if widget private data fits within topology file */
1508 if (soc_tplg_get_offset(tplg) + le32_to_cpu(widget->priv.size) >= tplg->fw->size) {
1509 dev_err(tplg->dev, "ASoC: invalid widget private data size\n");
1513 ret = soc_tplg_dapm_widget_create(tplg, widget);
1515 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1524 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1526 struct snd_soc_card *card = tplg->comp->card;
1529 /* Card might not have been registered at this point.
1530 * If so, just return success.
1532 if (!snd_soc_card_is_instantiated(card)) {
1533 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1534 " widget card binding deferred\n");
1538 ret = snd_soc_dapm_new_widgets(card);
1540 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1546 static int set_stream_info(struct soc_tplg *tplg, struct snd_soc_pcm_stream *stream,
1547 struct snd_soc_tplg_stream_caps *caps)
1549 stream->stream_name = devm_kstrdup(tplg->dev, caps->name, GFP_KERNEL);
1550 if (!stream->stream_name)
1553 stream->channels_min = le32_to_cpu(caps->channels_min);
1554 stream->channels_max = le32_to_cpu(caps->channels_max);
1555 stream->rates = le32_to_cpu(caps->rates);
1556 stream->rate_min = le32_to_cpu(caps->rate_min);
1557 stream->rate_max = le32_to_cpu(caps->rate_max);
1558 stream->formats = le64_to_cpu(caps->formats);
1559 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1564 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1565 unsigned int flag_mask, unsigned int flags)
1567 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1568 dai_drv->symmetric_rate =
1569 (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;
1571 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1572 dai_drv->symmetric_channels =
1573 (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS) ?
1576 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1577 dai_drv->symmetric_sample_bits =
1578 (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
1582 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1583 struct snd_soc_tplg_pcm *pcm)
1585 struct snd_soc_dai_driver *dai_drv;
1586 struct snd_soc_pcm_stream *stream;
1587 struct snd_soc_tplg_stream_caps *caps;
1588 struct snd_soc_dai *dai;
1589 struct snd_soc_dapm_context *dapm =
1590 snd_soc_component_get_dapm(tplg->comp);
1593 dai_drv = devm_kzalloc(tplg->dev, sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1594 if (dai_drv == NULL)
1597 if (strlen(pcm->dai_name)) {
1598 dai_drv->name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1599 if (!dai_drv->name) {
1604 dai_drv->id = le32_to_cpu(pcm->dai_id);
1606 if (pcm->playback) {
1607 stream = &dai_drv->playback;
1608 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1609 ret = set_stream_info(tplg, stream, caps);
1615 stream = &dai_drv->capture;
1616 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1617 ret = set_stream_info(tplg, stream, caps);
1623 dai_drv->compress_new = snd_soc_new_compress;
1625 /* pass control to component driver for optional further init */
1626 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1628 dev_err(tplg->dev, "ASoC: DAI loading failed\n");
1632 dai_drv->dobj.index = tplg->index;
1633 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1635 dai_drv->dobj.unload = tplg->ops->dai_unload;
1636 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1638 /* register the DAI to the component */
1639 dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1643 /* Create the DAI widgets here */
1644 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1646 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1647 snd_soc_unregister_dai(dai);
1657 static void set_link_flags(struct snd_soc_dai_link *link,
1658 unsigned int flag_mask, unsigned int flags)
1660 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1661 link->symmetric_rate =
1662 (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;
1664 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1665 link->symmetric_channels =
1666 (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS) ?
1669 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1670 link->symmetric_sample_bits =
1671 (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
1674 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1675 link->ignore_suspend =
1676 (flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP) ?
1680 /* create the FE DAI link */
1681 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1682 struct snd_soc_tplg_pcm *pcm)
1684 struct snd_soc_dai_link *link;
1685 struct snd_soc_dai_link_component *dlc;
1688 /* link + cpu + codec + platform */
1689 link = devm_kzalloc(tplg->dev, sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1693 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1695 link->cpus = &dlc[0];
1696 link->codecs = &dlc[1];
1697 link->platforms = &dlc[2];
1700 link->num_codecs = 1;
1701 link->num_platforms = 1;
1703 link->dobj.index = tplg->index;
1704 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1706 link->dobj.unload = tplg->ops->link_unload;
1708 if (strlen(pcm->pcm_name)) {
1709 link->name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1710 link->stream_name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1711 if (!link->name || !link->stream_name) {
1716 link->id = le32_to_cpu(pcm->pcm_id);
1718 if (strlen(pcm->dai_name)) {
1719 link->cpus->dai_name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1720 if (!link->cpus->dai_name) {
1726 link->codecs->name = "snd-soc-dummy";
1727 link->codecs->dai_name = "snd-soc-dummy-dai";
1729 link->platforms->name = "snd-soc-dummy";
1733 link->ignore_pmdown_time = 1;
1734 link->dpcm_playback = le32_to_cpu(pcm->playback);
1735 link->dpcm_capture = le32_to_cpu(pcm->capture);
1737 set_link_flags(link,
1738 le32_to_cpu(pcm->flag_mask),
1739 le32_to_cpu(pcm->flags));
1741 /* pass control to component driver for optional further init */
1742 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1744 dev_err(tplg->dev, "ASoC: FE link loading failed\n");
1748 ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1750 dev_err(tplg->dev, "ASoC: adding FE link failed\n");
1754 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1761 /* create a FE DAI and DAI link from the PCM object */
1762 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1763 struct snd_soc_tplg_pcm *pcm)
1767 ret = soc_tplg_dai_create(tplg, pcm);
1771 return soc_tplg_fe_link_create(tplg, pcm);
1774 /* copy stream caps from the old version 4 of source */
1775 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1776 struct snd_soc_tplg_stream_caps_v4 *src)
1778 dest->size = cpu_to_le32(sizeof(*dest));
1779 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1780 dest->formats = src->formats;
1781 dest->rates = src->rates;
1782 dest->rate_min = src->rate_min;
1783 dest->rate_max = src->rate_max;
1784 dest->channels_min = src->channels_min;
1785 dest->channels_max = src->channels_max;
1786 dest->periods_min = src->periods_min;
1787 dest->periods_max = src->periods_max;
1788 dest->period_size_min = src->period_size_min;
1789 dest->period_size_max = src->period_size_max;
1790 dest->buffer_size_min = src->buffer_size_min;
1791 dest->buffer_size_max = src->buffer_size_max;
1795 * pcm_new_ver - Create the new version of PCM from the old version.
1796 * @tplg: topology context
1797 * @src: older version of pcm as a source
1798 * @pcm: latest version of pcm created from the source
1800 * Support from version 4. User should free the returned pcm manually.
1802 static int pcm_new_ver(struct soc_tplg *tplg,
1803 struct snd_soc_tplg_pcm *src,
1804 struct snd_soc_tplg_pcm **pcm)
1806 struct snd_soc_tplg_pcm *dest;
1807 struct snd_soc_tplg_pcm_v4 *src_v4;
1812 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
1813 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
1817 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
1818 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
1819 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
1823 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
1824 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1825 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1826 dest->pcm_id = src_v4->pcm_id;
1827 dest->dai_id = src_v4->dai_id;
1828 dest->playback = src_v4->playback;
1829 dest->capture = src_v4->capture;
1830 dest->compress = src_v4->compress;
1831 dest->num_streams = src_v4->num_streams;
1832 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
1833 memcpy(&dest->stream[i], &src_v4->stream[i],
1834 sizeof(struct snd_soc_tplg_stream));
1836 for (i = 0; i < 2; i++)
1837 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
1843 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
1844 struct snd_soc_tplg_hdr *hdr)
1846 struct snd_soc_tplg_pcm *pcm, *_pcm;
1853 count = le32_to_cpu(hdr->count);
1855 /* check the element size and count */
1856 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1857 size = le32_to_cpu(pcm->size);
1858 if (size > sizeof(struct snd_soc_tplg_pcm)
1859 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
1860 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
1865 if (soc_tplg_check_elem_count(tplg,
1867 le32_to_cpu(hdr->payload_size),
1871 for (i = 0; i < count; i++) {
1872 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1873 size = le32_to_cpu(pcm->size);
1875 /* check ABI version by size, create a new version of pcm
1878 if (size == sizeof(*pcm)) {
1883 ret = pcm_new_ver(tplg, pcm, &_pcm);
1888 /* create the FE DAIs and DAI links */
1889 ret = soc_tplg_pcm_create(tplg, _pcm);
1896 /* offset by version-specific struct size and
1897 * real priv data size
1899 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
1902 kfree(_pcm); /* free the duplicated one */
1905 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
1911 * set_link_hw_format - Set the HW audio format of the physical DAI link.
1912 * @link: &snd_soc_dai_link which should be updated
1913 * @cfg: physical link configs.
1915 * Topology context contains a list of supported HW formats (configs) and
1916 * a default format ID for the physical link. This function will use this
1917 * default ID to choose the HW format to set the link's DAI format for init.
1919 static void set_link_hw_format(struct snd_soc_dai_link *link,
1920 struct snd_soc_tplg_link_config *cfg)
1922 struct snd_soc_tplg_hw_config *hw_config;
1923 unsigned char bclk_provider, fsync_provider;
1924 unsigned char invert_bclk, invert_fsync;
1927 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
1928 hw_config = &cfg->hw_config[i];
1929 if (hw_config->id != cfg->default_hw_config_id)
1932 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
1933 SND_SOC_DAIFMT_FORMAT_MASK;
1936 switch (hw_config->clock_gated) {
1937 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
1938 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
1941 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
1942 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
1946 /* ignore the value */
1950 /* clock signal polarity */
1951 invert_bclk = hw_config->invert_bclk;
1952 invert_fsync = hw_config->invert_fsync;
1953 if (!invert_bclk && !invert_fsync)
1954 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
1955 else if (!invert_bclk && invert_fsync)
1956 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
1957 else if (invert_bclk && !invert_fsync)
1958 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
1960 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
1963 bclk_provider = (hw_config->bclk_provider ==
1964 SND_SOC_TPLG_BCLK_CP);
1965 fsync_provider = (hw_config->fsync_provider ==
1966 SND_SOC_TPLG_FSYNC_CP);
1967 if (bclk_provider && fsync_provider)
1968 link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
1969 else if (!bclk_provider && fsync_provider)
1970 link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
1971 else if (bclk_provider && !fsync_provider)
1972 link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
1974 link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
1979 * link_new_ver - Create a new physical link config from the old
1980 * version of source.
1981 * @tplg: topology context
1982 * @src: old version of phyical link config as a source
1983 * @link: latest version of physical link config created from the source
1985 * Support from version 4. User need free the returned link config manually.
1987 static int link_new_ver(struct soc_tplg *tplg,
1988 struct snd_soc_tplg_link_config *src,
1989 struct snd_soc_tplg_link_config **link)
1991 struct snd_soc_tplg_link_config *dest;
1992 struct snd_soc_tplg_link_config_v4 *src_v4;
1997 if (le32_to_cpu(src->size) !=
1998 sizeof(struct snd_soc_tplg_link_config_v4)) {
1999 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2003 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2005 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2006 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2010 dest->size = cpu_to_le32(sizeof(*dest));
2011 dest->id = src_v4->id;
2012 dest->num_streams = src_v4->num_streams;
2013 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2014 memcpy(&dest->stream[i], &src_v4->stream[i],
2015 sizeof(struct snd_soc_tplg_stream));
2022 * snd_soc_find_dai_link - Find a DAI link
2025 * @id: DAI link ID to match
2026 * @name: DAI link name to match, optional
2027 * @stream_name: DAI link stream name to match, optional
2029 * This function will search all existing DAI links of the soc card to
2030 * find the link of the same ID. Since DAI links may not have their
2031 * unique ID, so name and stream name should also match if being
2034 * Return: pointer of DAI link, or NULL if not found.
2036 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2037 int id, const char *name,
2038 const char *stream_name)
2040 struct snd_soc_pcm_runtime *rtd;
2042 for_each_card_rtds(card, rtd) {
2043 struct snd_soc_dai_link *link = rtd->dai_link;
2048 if (name && (!link->name || strcmp(name, link->name)))
2051 if (stream_name && (!link->stream_name
2052 || strcmp(stream_name, link->stream_name)))
2061 /* Find and configure an existing physical DAI link */
2062 static int soc_tplg_link_config(struct soc_tplg *tplg,
2063 struct snd_soc_tplg_link_config *cfg)
2065 struct snd_soc_dai_link *link;
2066 const char *name, *stream_name;
2070 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2071 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2078 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2079 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2082 stream_name = cfg->stream_name;
2086 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2089 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2095 if (cfg->num_hw_configs)
2096 set_link_hw_format(link, cfg);
2100 set_link_flags(link,
2101 le32_to_cpu(cfg->flag_mask),
2102 le32_to_cpu(cfg->flags));
2104 /* pass control to component driver for optional further init */
2105 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2107 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2111 /* for unloading it in snd_soc_tplg_component_remove */
2112 link->dobj.index = tplg->index;
2113 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2115 link->dobj.unload = tplg->ops->link_unload;
2116 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2122 /* Load physical link config elements from the topology context */
2123 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2124 struct snd_soc_tplg_hdr *hdr)
2126 struct snd_soc_tplg_link_config *link, *_link;
2132 count = le32_to_cpu(hdr->count);
2134 /* check the element size and count */
2135 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2136 size = le32_to_cpu(link->size);
2137 if (size > sizeof(struct snd_soc_tplg_link_config)
2138 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2139 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2144 if (soc_tplg_check_elem_count(tplg, size, count,
2145 le32_to_cpu(hdr->payload_size),
2146 "physical link config"))
2149 /* config physical DAI links */
2150 for (i = 0; i < count; i++) {
2151 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2152 size = le32_to_cpu(link->size);
2153 if (size == sizeof(*link)) {
2158 ret = link_new_ver(tplg, link, &_link);
2163 ret = soc_tplg_link_config(tplg, _link);
2170 /* offset by version-specific struct size and
2171 * real priv data size
2173 tplg->pos += size + le32_to_cpu(_link->priv.size);
2176 kfree(_link); /* free the duplicated one */
2183 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2184 * @tplg: topology context
2185 * @d: physical DAI configs.
2187 * The physical dai should already be registered by the platform driver.
2188 * The platform driver should specify the DAI name and ID for matching.
2190 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2191 struct snd_soc_tplg_dai *d)
2193 struct snd_soc_dai_link_component dai_component;
2194 struct snd_soc_dai *dai;
2195 struct snd_soc_dai_driver *dai_drv;
2196 struct snd_soc_pcm_stream *stream;
2197 struct snd_soc_tplg_stream_caps *caps;
2200 memset(&dai_component, 0, sizeof(dai_component));
2202 dai_component.dai_name = d->dai_name;
2203 dai = snd_soc_find_dai(&dai_component);
2205 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2210 if (le32_to_cpu(d->dai_id) != dai->id) {
2211 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2216 dai_drv = dai->driver;
2221 stream = &dai_drv->playback;
2222 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2223 ret = set_stream_info(tplg, stream, caps);
2229 stream = &dai_drv->capture;
2230 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2231 ret = set_stream_info(tplg, stream, caps);
2237 set_dai_flags(dai_drv,
2238 le32_to_cpu(d->flag_mask),
2239 le32_to_cpu(d->flags));
2241 /* pass control to component driver for optional further init */
2242 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2244 dev_err(tplg->dev, "ASoC: DAI loading failed\n");
2254 /* load physical DAI elements */
2255 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2256 struct snd_soc_tplg_hdr *hdr)
2261 count = le32_to_cpu(hdr->count);
2263 /* config the existing BE DAIs */
2264 for (i = 0; i < count; i++) {
2265 struct snd_soc_tplg_dai *dai = (struct snd_soc_tplg_dai *)tplg->pos;
2268 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2269 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2273 ret = soc_tplg_dai_config(tplg, dai);
2275 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2279 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2282 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2287 * manifest_new_ver - Create a new version of manifest from the old version
2289 * @tplg: topology context
2290 * @src: old version of manifest as a source
2291 * @manifest: latest version of manifest created from the source
2293 * Support from version 4. Users need free the returned manifest manually.
2295 static int manifest_new_ver(struct soc_tplg *tplg,
2296 struct snd_soc_tplg_manifest *src,
2297 struct snd_soc_tplg_manifest **manifest)
2299 struct snd_soc_tplg_manifest *dest;
2300 struct snd_soc_tplg_manifest_v4 *src_v4;
2305 size = le32_to_cpu(src->size);
2306 if (size != sizeof(*src_v4)) {
2307 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2311 src->size = cpu_to_le32(sizeof(*src_v4));
2314 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2316 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2317 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2322 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2323 dest->control_elems = src_v4->control_elems;
2324 dest->widget_elems = src_v4->widget_elems;
2325 dest->graph_elems = src_v4->graph_elems;
2326 dest->pcm_elems = src_v4->pcm_elems;
2327 dest->dai_link_elems = src_v4->dai_link_elems;
2328 dest->priv.size = src_v4->priv.size;
2329 if (dest->priv.size)
2330 memcpy(dest->priv.data, src_v4->priv.data,
2331 le32_to_cpu(src_v4->priv.size));
2337 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2338 struct snd_soc_tplg_hdr *hdr)
2340 struct snd_soc_tplg_manifest *manifest, *_manifest;
2344 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2346 /* check ABI version by size, create a new manifest if abi not match */
2347 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2349 _manifest = manifest;
2353 ret = manifest_new_ver(tplg, manifest, &_manifest);
2358 /* pass control to component driver for optional further init */
2359 if (tplg->ops && tplg->ops->manifest)
2360 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2362 if (!abi_match) /* free the duplicated one */
2368 /* validate header magic, size and type */
2369 static int soc_tplg_valid_header(struct soc_tplg *tplg,
2370 struct snd_soc_tplg_hdr *hdr)
2372 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2374 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2375 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2380 if (soc_tplg_get_hdr_offset(tplg) + le32_to_cpu(hdr->payload_size) >= tplg->fw->size) {
2382 "ASoC: invalid header of type %d at offset %ld payload_size %d\n",
2383 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2388 /* big endian firmware objects not supported atm */
2389 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2391 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2392 tplg->pass, hdr->magic,
2393 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2397 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2399 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2400 tplg->pass, hdr->magic,
2401 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2405 /* Support ABI from version 4 */
2406 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2407 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2409 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2410 tplg->pass, hdr->abi,
2411 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2416 if (hdr->payload_size == 0) {
2417 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2418 soc_tplg_get_hdr_offset(tplg));
2425 /* check header type and call appropriate handler */
2426 static int soc_tplg_load_header(struct soc_tplg *tplg,
2427 struct snd_soc_tplg_hdr *hdr)
2429 int (*elem_load)(struct soc_tplg *tplg,
2430 struct snd_soc_tplg_hdr *hdr);
2431 unsigned int hdr_pass;
2433 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2435 tplg->index = le32_to_cpu(hdr->index);
2437 switch (le32_to_cpu(hdr->type)) {
2438 case SND_SOC_TPLG_TYPE_MIXER:
2439 case SND_SOC_TPLG_TYPE_ENUM:
2440 case SND_SOC_TPLG_TYPE_BYTES:
2441 hdr_pass = SOC_TPLG_PASS_CONTROL;
2442 elem_load = soc_tplg_kcontrol_elems_load;
2444 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2445 hdr_pass = SOC_TPLG_PASS_GRAPH;
2446 elem_load = soc_tplg_dapm_graph_elems_load;
2448 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2449 hdr_pass = SOC_TPLG_PASS_WIDGET;
2450 elem_load = soc_tplg_dapm_widget_elems_load;
2452 case SND_SOC_TPLG_TYPE_PCM:
2453 hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2454 elem_load = soc_tplg_pcm_elems_load;
2456 case SND_SOC_TPLG_TYPE_DAI:
2457 hdr_pass = SOC_TPLG_PASS_BE_DAI;
2458 elem_load = soc_tplg_dai_elems_load;
2460 case SND_SOC_TPLG_TYPE_DAI_LINK:
2461 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2462 /* physical link configurations */
2463 hdr_pass = SOC_TPLG_PASS_LINK;
2464 elem_load = soc_tplg_link_elems_load;
2466 case SND_SOC_TPLG_TYPE_MANIFEST:
2467 hdr_pass = SOC_TPLG_PASS_MANIFEST;
2468 elem_load = soc_tplg_manifest_load;
2471 /* bespoke vendor data object */
2472 hdr_pass = SOC_TPLG_PASS_VENDOR;
2473 elem_load = soc_tplg_vendor_load;
2477 if (tplg->pass == hdr_pass) {
2479 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2480 hdr->payload_size, hdr->type, hdr->version,
2481 hdr->vendor_type, tplg->pass);
2482 return elem_load(tplg, hdr);
2488 /* process the topology file headers */
2489 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2493 /* process the header types from start to end */
2494 for (tplg->pass = SOC_TPLG_PASS_START; tplg->pass <= SOC_TPLG_PASS_END; tplg->pass++) {
2495 struct snd_soc_tplg_hdr *hdr;
2497 tplg->hdr_pos = tplg->fw->data;
2498 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2500 while (!soc_tplg_is_eof(tplg)) {
2502 /* make sure header is valid before loading */
2503 ret = soc_tplg_valid_header(tplg, hdr);
2506 "ASoC: topology: invalid header: %d\n", ret);
2510 /* load the header object */
2511 ret = soc_tplg_load_header(tplg, hdr);
2514 "ASoC: topology: could not load header: %d\n", ret);
2518 /* goto next header */
2519 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2520 sizeof(struct snd_soc_tplg_hdr);
2521 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2526 /* signal DAPM we are complete */
2527 ret = soc_tplg_dapm_complete(tplg);
2530 "ASoC: failed to initialise DAPM from Firmware\n");
2535 static int soc_tplg_load(struct soc_tplg *tplg)
2539 ret = soc_tplg_process_headers(tplg);
2541 return soc_tplg_complete(tplg);
2546 /* load audio component topology from "firmware" file */
2547 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2548 struct snd_soc_tplg_ops *ops, const struct firmware *fw)
2550 struct soc_tplg tplg;
2554 * check if we have sane parameters:
2555 * comp - needs to exist to keep and reference data while parsing
2556 * comp->card - used for setting card related parameters
2557 * comp->card->dev - used for resource management and prints
2558 * fw - we need it, as it is the very thing we parse
2560 if (!comp || !comp->card || !comp->card->dev || !fw)
2563 /* setup parsing context */
2564 memset(&tplg, 0, sizeof(tplg));
2566 tplg.dev = comp->card->dev;
2570 tplg.io_ops = ops->io_ops;
2571 tplg.io_ops_count = ops->io_ops_count;
2572 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2573 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2576 ret = soc_tplg_load(&tplg);
2577 /* free the created components if fail to load topology */
2579 snd_soc_tplg_component_remove(comp);
2583 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2585 /* remove dynamic controls from the component driver */
2586 int snd_soc_tplg_component_remove(struct snd_soc_component *comp)
2588 struct snd_card *card = comp->card->snd_card;
2589 struct snd_soc_dobj *dobj, *next_dobj;
2592 /* process the header types from end to start */
2593 for (pass = SOC_TPLG_PASS_END; pass >= SOC_TPLG_PASS_START; pass--) {
2595 /* remove mixer controls */
2596 down_write(&card->controls_rwsem);
2597 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2600 switch (dobj->type) {
2601 case SND_SOC_DOBJ_BYTES:
2602 case SND_SOC_DOBJ_ENUM:
2603 case SND_SOC_DOBJ_MIXER:
2604 soc_tplg_remove_kcontrol(comp, dobj, pass);
2606 case SND_SOC_DOBJ_GRAPH:
2607 soc_tplg_remove_route(comp, dobj, pass);
2609 case SND_SOC_DOBJ_WIDGET:
2610 soc_tplg_remove_widget(comp, dobj, pass);
2612 case SND_SOC_DOBJ_PCM:
2613 soc_tplg_remove_dai(comp, dobj, pass);
2615 case SND_SOC_DOBJ_DAI_LINK:
2616 soc_tplg_remove_link(comp, dobj, pass);
2618 case SND_SOC_DOBJ_BACKEND_LINK:
2620 * call link_unload ops if extra
2621 * deinitialization is needed.
2623 remove_backend_link(comp, dobj, pass);
2626 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2631 up_write(&card->controls_rwsem);
2634 /* let caller know if FW can be freed when no objects are left */
2635 return !list_empty(&comp->dobj_list);
2637 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);