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->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 /* optionally pass new dynamic widget to component driver. This is mainly for
272 * external widgets where we can assign private data/ops */
273 static int soc_tplg_widget_load(struct soc_tplg *tplg,
274 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
276 if (tplg->ops && tplg->ops->widget_load)
277 return tplg->ops->widget_load(tplg->comp, tplg->index, w,
283 /* optionally pass new dynamic widget to component driver. This is mainly for
284 * external widgets where we can assign private data/ops */
285 static int soc_tplg_widget_ready(struct soc_tplg *tplg,
286 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
288 if (tplg->ops && tplg->ops->widget_ready)
289 return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
295 /* pass DAI configurations to component driver for extra initialization */
296 static int soc_tplg_dai_load(struct soc_tplg *tplg,
297 struct snd_soc_dai_driver *dai_drv,
298 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
300 if (tplg->ops && tplg->ops->dai_load)
301 return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
307 /* pass link configurations to component driver for extra initialization */
308 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
309 struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
311 if (tplg->ops && tplg->ops->link_load)
312 return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
317 /* tell the component driver that all firmware has been loaded in this request */
318 static void soc_tplg_complete(struct soc_tplg *tplg)
320 if (tplg->ops && tplg->ops->complete)
321 tplg->ops->complete(tplg->comp);
324 /* add a dynamic kcontrol */
325 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
326 const struct snd_kcontrol_new *control_new, const char *prefix,
327 void *data, struct snd_kcontrol **kcontrol)
331 *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
332 if (*kcontrol == NULL) {
333 dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
338 err = snd_ctl_add(card, *kcontrol);
340 dev_err(dev, "ASoC: Failed to add %s: %d\n",
341 control_new->name, err);
348 /* add a dynamic kcontrol for component driver */
349 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
350 struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
352 struct snd_soc_component *comp = tplg->comp;
354 return soc_tplg_add_dcontrol(comp->card->snd_card,
355 comp->dev, k, comp->name_prefix, comp, kcontrol);
358 /* remove a mixer kcontrol */
359 static void remove_mixer(struct snd_soc_component *comp,
360 struct snd_soc_dobj *dobj, int pass)
362 struct snd_card *card = comp->card->snd_card;
363 struct soc_mixer_control *sm =
364 container_of(dobj, struct soc_mixer_control, dobj);
365 const unsigned int *p = NULL;
367 if (pass != SOC_TPLG_PASS_MIXER)
370 if (dobj->ops && dobj->ops->control_unload)
371 dobj->ops->control_unload(comp, dobj);
373 if (dobj->control.kcontrol->tlv.p)
374 p = dobj->control.kcontrol->tlv.p;
375 snd_ctl_remove(card, dobj->control.kcontrol);
376 list_del(&dobj->list);
381 /* remove an enum kcontrol */
382 static void remove_enum(struct snd_soc_component *comp,
383 struct snd_soc_dobj *dobj, int pass)
385 struct snd_card *card = comp->card->snd_card;
386 struct soc_enum *se = container_of(dobj, struct soc_enum, dobj);
388 if (pass != SOC_TPLG_PASS_MIXER)
391 if (dobj->ops && dobj->ops->control_unload)
392 dobj->ops->control_unload(comp, dobj);
394 snd_ctl_remove(card, dobj->control.kcontrol);
395 list_del(&dobj->list);
397 soc_tplg_denum_remove_values(se);
398 soc_tplg_denum_remove_texts(se);
402 /* remove a byte kcontrol */
403 static void remove_bytes(struct snd_soc_component *comp,
404 struct snd_soc_dobj *dobj, int pass)
406 struct snd_card *card = comp->card->snd_card;
407 struct soc_bytes_ext *sb =
408 container_of(dobj, struct soc_bytes_ext, dobj);
410 if (pass != SOC_TPLG_PASS_MIXER)
413 if (dobj->ops && dobj->ops->control_unload)
414 dobj->ops->control_unload(comp, dobj);
416 snd_ctl_remove(card, dobj->control.kcontrol);
417 list_del(&dobj->list);
422 static void remove_route(struct snd_soc_component *comp,
423 struct snd_soc_dobj *dobj, int pass)
425 struct snd_soc_dapm_route *route =
426 container_of(dobj, struct snd_soc_dapm_route, dobj);
428 if (pass != SOC_TPLG_PASS_GRAPH)
431 if (dobj->ops && dobj->ops->dapm_route_unload)
432 dobj->ops->dapm_route_unload(comp, dobj);
434 list_del(&dobj->list);
438 /* remove a widget and it's kcontrols - routes must be removed first */
439 static void remove_widget(struct snd_soc_component *comp,
440 struct snd_soc_dobj *dobj, int pass)
442 struct snd_card *card = comp->card->snd_card;
443 struct snd_soc_dapm_widget *w =
444 container_of(dobj, struct snd_soc_dapm_widget, dobj);
447 if (pass != SOC_TPLG_PASS_WIDGET)
450 if (dobj->ops && dobj->ops->widget_unload)
451 dobj->ops->widget_unload(comp, dobj);
457 * Dynamic Widgets either have 1..N enum kcontrols or mixers.
458 * The enum may either have an array of values or strings.
460 if (dobj->widget.kcontrol_type == SND_SOC_TPLG_TYPE_ENUM) {
461 /* enumerated widget mixer */
462 for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
463 struct snd_kcontrol *kcontrol = w->kcontrols[i];
464 struct soc_enum *se =
465 (struct soc_enum *)kcontrol->private_value;
467 snd_ctl_remove(card, kcontrol);
469 /* free enum kcontrol's dvalues and dtexts */
470 soc_tplg_denum_remove_values(se);
471 soc_tplg_denum_remove_texts(se);
474 kfree(w->kcontrol_news[i].name);
477 /* volume mixer or bytes controls */
478 for (i = 0; w->kcontrols != NULL && i < w->num_kcontrols; i++) {
479 struct snd_kcontrol *kcontrol = w->kcontrols[i];
481 if (dobj->widget.kcontrol_type
482 == SND_SOC_TPLG_TYPE_MIXER)
483 kfree(kcontrol->tlv.p);
485 /* Private value is used as struct soc_mixer_control
486 * for volume mixers or soc_bytes_ext for bytes
489 kfree((void *)kcontrol->private_value);
490 snd_ctl_remove(card, kcontrol);
491 kfree(w->kcontrol_news[i].name);
496 kfree(w->kcontrol_news);
498 list_del(&dobj->list);
500 /* widget w is freed by soc-dapm.c */
503 /* remove DAI configurations */
504 static void remove_dai(struct snd_soc_component *comp,
505 struct snd_soc_dobj *dobj, int pass)
507 struct snd_soc_dai_driver *dai_drv =
508 container_of(dobj, struct snd_soc_dai_driver, dobj);
509 struct snd_soc_dai *dai;
511 if (pass != SOC_TPLG_PASS_PCM_DAI)
514 if (dobj->ops && dobj->ops->dai_unload)
515 dobj->ops->dai_unload(comp, dobj);
517 for_each_component_dais(comp, dai)
518 if (dai->driver == dai_drv)
521 kfree(dai_drv->playback.stream_name);
522 kfree(dai_drv->capture.stream_name);
523 kfree(dai_drv->name);
524 list_del(&dobj->list);
528 /* remove link configurations */
529 static void remove_link(struct snd_soc_component *comp,
530 struct snd_soc_dobj *dobj, int pass)
532 struct snd_soc_dai_link *link =
533 container_of(dobj, struct snd_soc_dai_link, dobj);
535 if (pass != SOC_TPLG_PASS_PCM_DAI)
538 if (dobj->ops && dobj->ops->link_unload)
539 dobj->ops->link_unload(comp, dobj);
541 list_del(&dobj->list);
542 snd_soc_remove_pcm_runtime(comp->card,
543 snd_soc_get_pcm_runtime(comp->card, link));
546 kfree(link->stream_name);
547 kfree(link->cpus->dai_name);
551 /* unload dai link */
552 static void remove_backend_link(struct snd_soc_component *comp,
553 struct snd_soc_dobj *dobj, int pass)
555 if (pass != SOC_TPLG_PASS_LINK)
558 if (dobj->ops && dobj->ops->link_unload)
559 dobj->ops->link_unload(comp, dobj);
562 * We don't free the link here as what remove_link() do since BE
563 * links are not allocated by topology.
564 * We however need to reset the dobj type to its initial values
566 dobj->type = SND_SOC_DOBJ_NONE;
567 list_del(&dobj->list);
570 /* bind a kcontrol to it's IO handlers */
571 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
572 struct snd_kcontrol_new *k,
573 const struct soc_tplg *tplg)
575 const struct snd_soc_tplg_kcontrol_ops *ops;
576 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
579 if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
580 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
581 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
582 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
583 struct soc_bytes_ext *sbe;
584 struct snd_soc_tplg_bytes_control *be;
586 sbe = (struct soc_bytes_ext *)k->private_value;
587 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
589 /* TLV bytes controls need standard kcontrol info handler,
590 * TLV callback and extended put/get handlers.
592 k->info = snd_soc_bytes_info_ext;
593 k->tlv.c = snd_soc_bytes_tlv_callback;
596 * When a topology-based implementation abuses the
597 * control interface and uses bytes_ext controls of
598 * more than 512 bytes, we need to disable the size
599 * checks, otherwise accesses to such controls will
600 * return an -EINVAL error and prevent the card from
603 if (IS_ENABLED(CONFIG_SND_CTL_VALIDATION) && sbe->max > 512)
604 k->access |= SNDRV_CTL_ELEM_ACCESS_SKIP_CHECK;
606 ext_ops = tplg->bytes_ext_ops;
607 num_ops = tplg->bytes_ext_ops_count;
608 for (i = 0; i < num_ops; i++) {
610 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
611 sbe->put = ext_ops[i].put;
613 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
614 sbe->get = ext_ops[i].get;
617 if (sbe->put && sbe->get)
623 /* try and map vendor specific kcontrol handlers first */
625 num_ops = tplg->io_ops_count;
626 for (i = 0; i < num_ops; i++) {
628 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
630 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
632 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
633 k->info = ops[i].info;
636 /* vendor specific handlers found ? */
637 if (k->put && k->get && k->info)
640 /* none found so try standard kcontrol handlers */
642 num_ops = ARRAY_SIZE(io_ops);
643 for (i = 0; i < num_ops; i++) {
645 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
647 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
649 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
650 k->info = ops[i].info;
653 /* standard handlers found ? */
654 if (k->put && k->get && k->info)
657 /* nothing to bind */
661 /* bind a widgets to it's evnt handlers */
662 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
663 const struct snd_soc_tplg_widget_events *events,
664 int num_events, u16 event_type)
670 for (i = 0; i < num_events; i++) {
671 if (event_type == events[i].type) {
673 /* found - so assign event */
674 w->event = events[i].event_handler;
682 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
684 /* optionally pass new dynamic kcontrol to component driver. */
685 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
686 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
688 if (tplg->ops && tplg->ops->control_load)
689 return tplg->ops->control_load(tplg->comp, tplg->index, k,
696 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
697 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
699 unsigned int item_len = 2 * sizeof(unsigned int);
702 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
706 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
708 p[2] = le32_to_cpu(scale->min);
709 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
710 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
712 kc->tlv.p = (void *)p;
716 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
717 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
719 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
720 u32 access = le32_to_cpu(tc->access);
722 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
725 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
727 switch (le32_to_cpu(tplg_tlv->type)) {
728 case SNDRV_CTL_TLVT_DB_SCALE:
729 return soc_tplg_create_tlv_db_scale(tplg, kc,
732 /* TODO: add support for other TLV types */
734 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
743 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
744 struct snd_kcontrol_new *kc)
749 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
752 struct snd_soc_tplg_bytes_control *be;
753 struct soc_bytes_ext *sbe;
754 struct snd_kcontrol_new kc;
758 if (soc_tplg_check_elem_count(tplg,
759 sizeof(struct snd_soc_tplg_bytes_control), count,
760 size, "mixer bytes")) {
761 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
766 for (i = 0; i < count; i++) {
767 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
769 /* validate kcontrol */
770 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
771 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
774 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
778 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
779 le32_to_cpu(be->priv.size));
782 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
783 be->hdr.name, be->hdr.access);
785 memset(&kc, 0, sizeof(kc));
786 kc.name = be->hdr.name;
787 kc.private_value = (long)sbe;
788 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
789 kc.access = le32_to_cpu(be->hdr.access);
791 sbe->max = le32_to_cpu(be->max);
792 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
793 sbe->dobj.ops = tplg->ops;
794 INIT_LIST_HEAD(&sbe->dobj.list);
796 /* map io handlers */
797 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
799 soc_control_err(tplg, &be->hdr, be->hdr.name);
804 /* pass control to driver for optional further init */
805 err = soc_tplg_init_kcontrol(tplg, &kc,
806 (struct snd_soc_tplg_ctl_hdr *)be);
808 dev_err(tplg->dev, "ASoC: failed to init %s\n",
814 /* register control here */
815 err = soc_tplg_add_kcontrol(tplg, &kc,
816 &sbe->dobj.control.kcontrol);
818 dev_err(tplg->dev, "ASoC: failed to add %s\n",
824 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
830 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
833 struct snd_soc_tplg_mixer_control *mc;
834 struct soc_mixer_control *sm;
835 struct snd_kcontrol_new kc;
839 if (soc_tplg_check_elem_count(tplg,
840 sizeof(struct snd_soc_tplg_mixer_control),
841 count, size, "mixers")) {
843 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
848 for (i = 0; i < count; i++) {
849 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
851 /* validate kcontrol */
852 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
853 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
856 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
859 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
860 le32_to_cpu(mc->priv.size));
863 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
864 mc->hdr.name, mc->hdr.access);
866 memset(&kc, 0, sizeof(kc));
867 kc.name = mc->hdr.name;
868 kc.private_value = (long)sm;
869 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
870 kc.access = le32_to_cpu(mc->hdr.access);
872 /* we only support FL/FR channel mapping atm */
873 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
875 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
877 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
879 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
882 sm->max = le32_to_cpu(mc->max);
883 sm->min = le32_to_cpu(mc->min);
884 sm->invert = le32_to_cpu(mc->invert);
885 sm->platform_max = le32_to_cpu(mc->platform_max);
886 sm->dobj.index = tplg->index;
887 sm->dobj.ops = tplg->ops;
888 sm->dobj.type = SND_SOC_DOBJ_MIXER;
889 INIT_LIST_HEAD(&sm->dobj.list);
891 /* map io handlers */
892 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
894 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
899 /* create any TLV data */
900 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
902 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
908 /* pass control to driver for optional further init */
909 err = soc_tplg_init_kcontrol(tplg, &kc,
910 (struct snd_soc_tplg_ctl_hdr *) mc);
912 dev_err(tplg->dev, "ASoC: failed to init %s\n",
914 soc_tplg_free_tlv(tplg, &kc);
919 /* register control here */
920 err = soc_tplg_add_kcontrol(tplg, &kc,
921 &sm->dobj.control.kcontrol);
923 dev_err(tplg->dev, "ASoC: failed to add %s\n",
925 soc_tplg_free_tlv(tplg, &kc);
930 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
936 static int soc_tplg_denum_create_texts(struct soc_enum *se,
937 struct snd_soc_tplg_enum_control *ec)
941 se->dobj.control.dtexts =
942 kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
943 if (se->dobj.control.dtexts == NULL)
946 for (i = 0; i < le32_to_cpu(ec->items); i++) {
948 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
949 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
954 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
955 if (!se->dobj.control.dtexts[i]) {
961 se->items = le32_to_cpu(ec->items);
962 se->texts = (const char * const *)se->dobj.control.dtexts;
967 soc_tplg_denum_remove_texts(se);
971 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
975 for (--i; i >= 0; i--)
976 kfree(se->dobj.control.dtexts[i]);
977 kfree(se->dobj.control.dtexts);
980 static int soc_tplg_denum_create_values(struct soc_enum *se,
981 struct snd_soc_tplg_enum_control *ec)
985 if (le32_to_cpu(ec->items) > sizeof(*ec->values))
988 se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
991 if (!se->dobj.control.dvalues)
994 /* convert from little-endian */
995 for (i = 0; i < le32_to_cpu(ec->items); i++) {
996 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
1002 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
1004 kfree(se->dobj.control.dvalues);
1007 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
1010 struct snd_soc_tplg_enum_control *ec;
1011 struct soc_enum *se;
1012 struct snd_kcontrol_new kc;
1016 if (soc_tplg_check_elem_count(tplg,
1017 sizeof(struct snd_soc_tplg_enum_control),
1018 count, size, "enums")) {
1020 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1025 for (i = 0; i < count; i++) {
1026 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1028 /* validate kcontrol */
1029 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1030 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1033 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1037 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1038 le32_to_cpu(ec->priv.size));
1040 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1041 ec->hdr.name, ec->items);
1043 memset(&kc, 0, sizeof(kc));
1044 kc.name = ec->hdr.name;
1045 kc.private_value = (long)se;
1046 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1047 kc.access = le32_to_cpu(ec->hdr.access);
1049 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1050 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1052 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1055 se->mask = le32_to_cpu(ec->mask);
1056 se->dobj.index = tplg->index;
1057 se->dobj.type = SND_SOC_DOBJ_ENUM;
1058 se->dobj.ops = tplg->ops;
1059 INIT_LIST_HEAD(&se->dobj.list);
1061 switch (le32_to_cpu(ec->hdr.ops.info)) {
1062 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1063 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1064 err = soc_tplg_denum_create_values(se, ec);
1067 "ASoC: could not create values for %s\n",
1072 case SND_SOC_TPLG_CTL_ENUM:
1073 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1074 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1075 err = soc_tplg_denum_create_texts(se, ec);
1078 "ASoC: could not create texts for %s\n",
1086 "ASoC: invalid enum control type %d for %s\n",
1087 ec->hdr.ops.info, ec->hdr.name);
1091 /* map io handlers */
1092 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1094 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1098 /* pass control to driver for optional further init */
1099 err = soc_tplg_init_kcontrol(tplg, &kc,
1100 (struct snd_soc_tplg_ctl_hdr *) ec);
1102 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1107 /* register control here */
1108 err = soc_tplg_add_kcontrol(tplg,
1109 &kc, &se->dobj.control.kcontrol);
1111 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1116 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1125 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1126 struct snd_soc_tplg_hdr *hdr)
1128 struct snd_soc_tplg_ctl_hdr *control_hdr;
1132 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1133 soc_tplg_get_offset(tplg));
1135 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1137 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1139 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1140 dev_err(tplg->dev, "ASoC: invalid control size\n");
1144 switch (le32_to_cpu(control_hdr->ops.info)) {
1145 case SND_SOC_TPLG_CTL_VOLSW:
1146 case SND_SOC_TPLG_CTL_STROBE:
1147 case SND_SOC_TPLG_CTL_VOLSW_SX:
1148 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1149 case SND_SOC_TPLG_CTL_RANGE:
1150 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1151 case SND_SOC_TPLG_DAPM_CTL_PIN:
1152 ret = soc_tplg_dmixer_create(tplg, 1,
1153 le32_to_cpu(hdr->payload_size));
1155 case SND_SOC_TPLG_CTL_ENUM:
1156 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1157 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1158 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1159 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1160 ret = soc_tplg_denum_create(tplg, 1,
1161 le32_to_cpu(hdr->payload_size));
1163 case SND_SOC_TPLG_CTL_BYTES:
1164 ret = soc_tplg_dbytes_create(tplg, 1,
1165 le32_to_cpu(hdr->payload_size));
1168 soc_bind_err(tplg, control_hdr, i);
1172 dev_err(tplg->dev, "ASoC: invalid control\n");
1181 /* optionally pass new dynamic kcontrol to component driver. */
1182 static int soc_tplg_add_route(struct soc_tplg *tplg,
1183 struct snd_soc_dapm_route *route)
1185 if (tplg->ops && tplg->ops->dapm_route_load)
1186 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1192 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1193 struct snd_soc_tplg_hdr *hdr)
1195 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1196 struct snd_soc_tplg_dapm_graph_elem *elem;
1197 struct snd_soc_dapm_route **routes;
1201 count = le32_to_cpu(hdr->count);
1203 if (soc_tplg_check_elem_count(tplg,
1204 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1205 count, le32_to_cpu(hdr->payload_size), "graph")) {
1207 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1212 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1215 /* allocate memory for pointer to array of dapm routes */
1216 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1222 * allocate memory for each dapm route in the array.
1223 * This needs to be done individually so that
1224 * each route can be freed when it is removed in remove_route().
1226 for (i = 0; i < count; i++) {
1227 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1229 /* free previously allocated memory */
1230 for (j = 0; j < i; j++)
1238 for (i = 0; i < count; i++) {
1239 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1240 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1242 /* validate routes */
1243 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1244 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1248 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1249 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1253 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1254 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1259 routes[i]->source = elem->source;
1260 routes[i]->sink = elem->sink;
1262 /* set to NULL atm for tplg users */
1263 routes[i]->connected = NULL;
1264 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1265 routes[i]->control = NULL;
1267 routes[i]->control = elem->control;
1269 /* add route dobj to dobj_list */
1270 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1271 routes[i]->dobj.ops = tplg->ops;
1272 routes[i]->dobj.index = tplg->index;
1273 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1275 ret = soc_tplg_add_route(tplg, routes[i]);
1277 dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1279 * this route was added to the list, it will
1280 * be freed in remove_route() so increment the
1281 * counter to skip it in the error handling
1288 /* add route, but keep going if some fail */
1289 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1293 * free memory allocated for all dapm routes not added to the
1294 * list in case of error
1302 * free pointer to array of dapm routes as this is no longer needed.
1303 * The memory allocated for each dapm route will be freed
1304 * when it is removed in remove_route().
1311 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1312 struct soc_tplg *tplg, int num_kcontrols)
1314 struct snd_kcontrol_new *kc;
1315 struct soc_mixer_control *sm;
1316 struct snd_soc_tplg_mixer_control *mc;
1319 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1323 for (i = 0; i < num_kcontrols; i++) {
1324 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1326 /* validate kcontrol */
1327 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1328 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1331 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1335 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1336 le32_to_cpu(mc->priv.size));
1338 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1341 kc[i].private_value = (long)sm;
1342 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1343 if (kc[i].name == NULL)
1345 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1346 kc[i].access = le32_to_cpu(mc->hdr.access);
1348 /* we only support FL/FR channel mapping atm */
1349 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1351 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1353 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1355 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1358 sm->max = le32_to_cpu(mc->max);
1359 sm->min = le32_to_cpu(mc->min);
1360 sm->invert = le32_to_cpu(mc->invert);
1361 sm->platform_max = le32_to_cpu(mc->platform_max);
1362 sm->dobj.index = tplg->index;
1363 INIT_LIST_HEAD(&sm->dobj.list);
1365 /* map io handlers */
1366 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1368 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1372 /* create any TLV data */
1373 err = soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1375 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1380 /* pass control to driver for optional further init */
1381 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1382 (struct snd_soc_tplg_ctl_hdr *)mc);
1384 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1392 for (; i >= 0; i--) {
1393 soc_tplg_free_tlv(tplg, &kc[i]);
1394 sm = (struct soc_mixer_control *)kc[i].private_value;
1403 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1404 struct soc_tplg *tplg, int num_kcontrols)
1406 struct snd_kcontrol_new *kc;
1407 struct snd_soc_tplg_enum_control *ec;
1408 struct soc_enum *se;
1411 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1415 for (i = 0; i < num_kcontrols; i++) {
1416 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1417 /* validate kcontrol */
1418 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1419 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1422 se = kzalloc(sizeof(*se), GFP_KERNEL);
1426 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1427 le32_to_cpu(ec->priv.size));
1429 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1432 kc[i].private_value = (long)se;
1433 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1434 if (kc[i].name == NULL)
1436 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1437 kc[i].access = le32_to_cpu(ec->hdr.access);
1439 /* we only support FL/FR channel mapping atm */
1440 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1441 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1443 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1446 se->items = le32_to_cpu(ec->items);
1447 se->mask = le32_to_cpu(ec->mask);
1448 se->dobj.index = tplg->index;
1450 switch (le32_to_cpu(ec->hdr.ops.info)) {
1451 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1452 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1453 err = soc_tplg_denum_create_values(se, ec);
1455 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1460 case SND_SOC_TPLG_CTL_ENUM:
1461 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1462 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1463 err = soc_tplg_denum_create_texts(se, ec);
1465 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1471 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1472 ec->hdr.ops.info, ec->hdr.name);
1476 /* map io handlers */
1477 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1479 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1483 /* pass control to driver for optional further init */
1484 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1485 (struct snd_soc_tplg_ctl_hdr *)ec);
1487 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1496 for (; i >= 0; i--) {
1497 /* free values and texts */
1498 se = (struct soc_enum *)kc[i].private_value;
1501 soc_tplg_denum_remove_values(se);
1502 soc_tplg_denum_remove_texts(se);
1513 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1514 struct soc_tplg *tplg, int num_kcontrols)
1516 struct snd_soc_tplg_bytes_control *be;
1517 struct soc_bytes_ext *sbe;
1518 struct snd_kcontrol_new *kc;
1521 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1525 for (i = 0; i < num_kcontrols; i++) {
1526 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1528 /* validate kcontrol */
1529 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1530 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1533 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1537 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1538 le32_to_cpu(be->priv.size));
1541 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1542 be->hdr.name, be->hdr.access);
1544 kc[i].private_value = (long)sbe;
1545 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1546 if (kc[i].name == NULL)
1548 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1549 kc[i].access = le32_to_cpu(be->hdr.access);
1551 sbe->max = le32_to_cpu(be->max);
1552 INIT_LIST_HEAD(&sbe->dobj.list);
1554 /* map standard io handlers and check for external handlers */
1555 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1557 soc_control_err(tplg, &be->hdr, be->hdr.name);
1561 /* pass control to driver for optional further init */
1562 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1563 (struct snd_soc_tplg_ctl_hdr *)be);
1565 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1574 for (; i >= 0; i--) {
1575 sbe = (struct soc_bytes_ext *)kc[i].private_value;
1584 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1585 struct snd_soc_tplg_dapm_widget *w)
1587 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1588 struct snd_soc_dapm_widget template, *widget;
1589 struct snd_soc_tplg_ctl_hdr *control_hdr;
1590 struct snd_soc_card *card = tplg->comp->card;
1591 unsigned int kcontrol_type;
1594 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1595 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1597 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1598 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1601 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1604 memset(&template, 0, sizeof(template));
1606 /* map user to kernel widget ID */
1607 template.id = get_widget_id(le32_to_cpu(w->id));
1608 if ((int)template.id < 0)
1611 /* strings are allocated here, but used and freed by the widget */
1612 template.name = kstrdup(w->name, GFP_KERNEL);
1615 template.sname = kstrdup(w->sname, GFP_KERNEL);
1616 if (!template.sname) {
1620 template.reg = le32_to_cpu(w->reg);
1621 template.shift = le32_to_cpu(w->shift);
1622 template.mask = le32_to_cpu(w->mask);
1623 template.subseq = le32_to_cpu(w->subseq);
1624 template.on_val = w->invert ? 0 : 1;
1625 template.off_val = w->invert ? 1 : 0;
1626 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1627 template.event_flags = le16_to_cpu(w->event_flags);
1628 template.dobj.index = tplg->index;
1631 (sizeof(struct snd_soc_tplg_dapm_widget) +
1632 le32_to_cpu(w->priv.size));
1634 if (w->num_kcontrols == 0) {
1636 template.num_kcontrols = 0;
1640 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1641 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1642 w->name, w->num_kcontrols, control_hdr->type);
1644 switch (le32_to_cpu(control_hdr->ops.info)) {
1645 case SND_SOC_TPLG_CTL_VOLSW:
1646 case SND_SOC_TPLG_CTL_STROBE:
1647 case SND_SOC_TPLG_CTL_VOLSW_SX:
1648 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1649 case SND_SOC_TPLG_CTL_RANGE:
1650 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1651 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1652 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1653 template.kcontrol_news =
1654 soc_tplg_dapm_widget_dmixer_create(tplg,
1655 template.num_kcontrols);
1656 if (!template.kcontrol_news) {
1661 case SND_SOC_TPLG_CTL_ENUM:
1662 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1663 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1664 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1665 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1666 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1667 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1668 template.kcontrol_news =
1669 soc_tplg_dapm_widget_denum_create(tplg,
1670 template.num_kcontrols);
1671 if (!template.kcontrol_news) {
1676 case SND_SOC_TPLG_CTL_BYTES:
1677 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1678 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1679 template.kcontrol_news =
1680 soc_tplg_dapm_widget_dbytes_create(tplg,
1681 template.num_kcontrols);
1682 if (!template.kcontrol_news) {
1688 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1689 control_hdr->ops.get, control_hdr->ops.put,
1690 le32_to_cpu(control_hdr->ops.info));
1696 ret = soc_tplg_widget_load(tplg, &template, w);
1700 /* card dapm mutex is held by the core if we are loading topology
1701 * data during sound card init. */
1702 if (card->instantiated)
1703 widget = snd_soc_dapm_new_control(dapm, &template);
1705 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1706 if (IS_ERR(widget)) {
1707 ret = PTR_ERR(widget);
1711 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1712 widget->dobj.widget.kcontrol_type = kcontrol_type;
1713 widget->dobj.ops = tplg->ops;
1714 widget->dobj.index = tplg->index;
1715 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1717 ret = soc_tplg_widget_ready(tplg, widget, w);
1721 kfree(template.sname);
1722 kfree(template.name);
1727 snd_soc_tplg_widget_remove(widget);
1728 snd_soc_dapm_free_widget(widget);
1730 kfree(template.sname);
1732 kfree(template.name);
1736 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1737 struct snd_soc_tplg_hdr *hdr)
1739 struct snd_soc_tplg_dapm_widget *widget;
1742 count = le32_to_cpu(hdr->count);
1744 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1746 for (i = 0; i < count; i++) {
1747 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1748 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1749 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1753 ret = soc_tplg_dapm_widget_create(tplg, widget);
1755 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1764 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1766 struct snd_soc_card *card = tplg->comp->card;
1769 /* Card might not have been registered at this point.
1770 * If so, just return success.
1772 if (!card || !card->instantiated) {
1773 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1774 " widget card binding deferred\n");
1778 ret = snd_soc_dapm_new_widgets(card);
1780 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1786 static int set_stream_info(struct snd_soc_pcm_stream *stream,
1787 struct snd_soc_tplg_stream_caps *caps)
1789 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1790 if (!stream->stream_name)
1793 stream->channels_min = le32_to_cpu(caps->channels_min);
1794 stream->channels_max = le32_to_cpu(caps->channels_max);
1795 stream->rates = le32_to_cpu(caps->rates);
1796 stream->rate_min = le32_to_cpu(caps->rate_min);
1797 stream->rate_max = le32_to_cpu(caps->rate_max);
1798 stream->formats = le64_to_cpu(caps->formats);
1799 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1804 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1805 unsigned int flag_mask, unsigned int flags)
1807 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1808 dai_drv->symmetric_rates =
1809 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1811 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1812 dai_drv->symmetric_channels =
1813 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1816 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1817 dai_drv->symmetric_samplebits =
1818 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1822 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1823 struct snd_soc_tplg_pcm *pcm)
1825 struct snd_soc_dai_driver *dai_drv;
1826 struct snd_soc_pcm_stream *stream;
1827 struct snd_soc_tplg_stream_caps *caps;
1828 struct snd_soc_dai *dai;
1829 struct snd_soc_dapm_context *dapm =
1830 snd_soc_component_get_dapm(tplg->comp);
1833 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1834 if (dai_drv == NULL)
1837 if (strlen(pcm->dai_name)) {
1838 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1839 if (!dai_drv->name) {
1844 dai_drv->id = le32_to_cpu(pcm->dai_id);
1846 if (pcm->playback) {
1847 stream = &dai_drv->playback;
1848 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1849 ret = set_stream_info(stream, caps);
1855 stream = &dai_drv->capture;
1856 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1857 ret = set_stream_info(stream, caps);
1863 dai_drv->compress_new = snd_soc_new_compress;
1865 /* pass control to component driver for optional further init */
1866 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1868 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1872 dai_drv->dobj.index = tplg->index;
1873 dai_drv->dobj.ops = tplg->ops;
1874 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1875 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1877 /* register the DAI to the component */
1878 dai = devm_snd_soc_register_dai(tplg->comp->dev, tplg->comp, dai_drv, false);
1882 /* Create the DAI widgets here */
1883 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1885 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1892 kfree(dai_drv->playback.stream_name);
1893 kfree(dai_drv->capture.stream_name);
1894 kfree(dai_drv->name);
1900 static void set_link_flags(struct snd_soc_dai_link *link,
1901 unsigned int flag_mask, unsigned int flags)
1903 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1904 link->symmetric_rates =
1905 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1907 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1908 link->symmetric_channels =
1909 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1912 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1913 link->symmetric_samplebits =
1914 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1917 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1918 link->ignore_suspend =
1919 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1923 /* create the FE DAI link */
1924 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1925 struct snd_soc_tplg_pcm *pcm)
1927 struct snd_soc_dai_link *link;
1928 struct snd_soc_dai_link_component *dlc;
1931 /* link + cpu + codec + platform */
1932 link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1936 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1938 link->cpus = &dlc[0];
1939 link->codecs = &dlc[1];
1940 link->platforms = &dlc[2];
1943 link->num_codecs = 1;
1944 link->num_platforms = 1;
1946 link->dobj.index = tplg->index;
1947 link->dobj.ops = tplg->ops;
1948 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1950 if (strlen(pcm->pcm_name)) {
1951 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1952 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1953 if (!link->name || !link->stream_name) {
1958 link->id = le32_to_cpu(pcm->pcm_id);
1960 if (strlen(pcm->dai_name)) {
1961 link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1962 if (!link->cpus->dai_name) {
1968 link->codecs->name = "snd-soc-dummy";
1969 link->codecs->dai_name = "snd-soc-dummy-dai";
1971 link->platforms->name = "snd-soc-dummy";
1975 link->dpcm_playback = le32_to_cpu(pcm->playback);
1976 link->dpcm_capture = le32_to_cpu(pcm->capture);
1978 set_link_flags(link,
1979 le32_to_cpu(pcm->flag_mask),
1980 le32_to_cpu(pcm->flags));
1982 /* pass control to component driver for optional further init */
1983 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1985 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1989 ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1991 dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1995 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2000 kfree(link->stream_name);
2001 kfree(link->cpus->dai_name);
2006 /* create a FE DAI and DAI link from the PCM object */
2007 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
2008 struct snd_soc_tplg_pcm *pcm)
2012 ret = soc_tplg_dai_create(tplg, pcm);
2016 return soc_tplg_fe_link_create(tplg, pcm);
2019 /* copy stream caps from the old version 4 of source */
2020 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
2021 struct snd_soc_tplg_stream_caps_v4 *src)
2023 dest->size = cpu_to_le32(sizeof(*dest));
2024 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2025 dest->formats = src->formats;
2026 dest->rates = src->rates;
2027 dest->rate_min = src->rate_min;
2028 dest->rate_max = src->rate_max;
2029 dest->channels_min = src->channels_min;
2030 dest->channels_max = src->channels_max;
2031 dest->periods_min = src->periods_min;
2032 dest->periods_max = src->periods_max;
2033 dest->period_size_min = src->period_size_min;
2034 dest->period_size_max = src->period_size_max;
2035 dest->buffer_size_min = src->buffer_size_min;
2036 dest->buffer_size_max = src->buffer_size_max;
2040 * pcm_new_ver - Create the new version of PCM from the old version.
2041 * @tplg: topology context
2042 * @src: older version of pcm as a source
2043 * @pcm: latest version of pcm created from the source
2045 * Support from vesion 4. User should free the returned pcm manually.
2047 static int pcm_new_ver(struct soc_tplg *tplg,
2048 struct snd_soc_tplg_pcm *src,
2049 struct snd_soc_tplg_pcm **pcm)
2051 struct snd_soc_tplg_pcm *dest;
2052 struct snd_soc_tplg_pcm_v4 *src_v4;
2057 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2058 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2062 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2063 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2064 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2068 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2069 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2070 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2071 dest->pcm_id = src_v4->pcm_id;
2072 dest->dai_id = src_v4->dai_id;
2073 dest->playback = src_v4->playback;
2074 dest->capture = src_v4->capture;
2075 dest->compress = src_v4->compress;
2076 dest->num_streams = src_v4->num_streams;
2077 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2078 memcpy(&dest->stream[i], &src_v4->stream[i],
2079 sizeof(struct snd_soc_tplg_stream));
2081 for (i = 0; i < 2; i++)
2082 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2088 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2089 struct snd_soc_tplg_hdr *hdr)
2091 struct snd_soc_tplg_pcm *pcm, *_pcm;
2098 count = le32_to_cpu(hdr->count);
2100 /* check the element size and count */
2101 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2102 size = le32_to_cpu(pcm->size);
2103 if (size > sizeof(struct snd_soc_tplg_pcm)
2104 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2105 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2110 if (soc_tplg_check_elem_count(tplg,
2112 le32_to_cpu(hdr->payload_size),
2114 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2119 for (i = 0; i < count; i++) {
2120 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2121 size = le32_to_cpu(pcm->size);
2123 /* check ABI version by size, create a new version of pcm
2126 if (size == sizeof(*pcm)) {
2131 ret = pcm_new_ver(tplg, pcm, &_pcm);
2136 /* create the FE DAIs and DAI links */
2137 ret = soc_tplg_pcm_create(tplg, _pcm);
2144 /* offset by version-specific struct size and
2145 * real priv data size
2147 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2150 kfree(_pcm); /* free the duplicated one */
2153 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2159 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2160 * @link: &snd_soc_dai_link which should be updated
2161 * @cfg: physical link configs.
2163 * Topology context contains a list of supported HW formats (configs) and
2164 * a default format ID for the physical link. This function will use this
2165 * default ID to choose the HW format to set the link's DAI format for init.
2167 static void set_link_hw_format(struct snd_soc_dai_link *link,
2168 struct snd_soc_tplg_link_config *cfg)
2170 struct snd_soc_tplg_hw_config *hw_config;
2171 unsigned char bclk_master, fsync_master;
2172 unsigned char invert_bclk, invert_fsync;
2175 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2176 hw_config = &cfg->hw_config[i];
2177 if (hw_config->id != cfg->default_hw_config_id)
2180 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2181 SND_SOC_DAIFMT_FORMAT_MASK;
2184 switch (hw_config->clock_gated) {
2185 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2186 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2189 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2190 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2194 /* ignore the value */
2198 /* clock signal polarity */
2199 invert_bclk = hw_config->invert_bclk;
2200 invert_fsync = hw_config->invert_fsync;
2201 if (!invert_bclk && !invert_fsync)
2202 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2203 else if (!invert_bclk && invert_fsync)
2204 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2205 else if (invert_bclk && !invert_fsync)
2206 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2208 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2211 bclk_master = (hw_config->bclk_master ==
2212 SND_SOC_TPLG_BCLK_CM);
2213 fsync_master = (hw_config->fsync_master ==
2214 SND_SOC_TPLG_FSYNC_CM);
2215 if (bclk_master && fsync_master)
2216 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2217 else if (!bclk_master && fsync_master)
2218 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2219 else if (bclk_master && !fsync_master)
2220 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2222 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2227 * link_new_ver - Create a new physical link config from the old
2228 * version of source.
2229 * @tplg: topology context
2230 * @src: old version of phyical link config as a source
2231 * @link: latest version of physical link config created from the source
2233 * Support from vesion 4. User need free the returned link config manually.
2235 static int link_new_ver(struct soc_tplg *tplg,
2236 struct snd_soc_tplg_link_config *src,
2237 struct snd_soc_tplg_link_config **link)
2239 struct snd_soc_tplg_link_config *dest;
2240 struct snd_soc_tplg_link_config_v4 *src_v4;
2245 if (le32_to_cpu(src->size) !=
2246 sizeof(struct snd_soc_tplg_link_config_v4)) {
2247 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2251 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2253 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2254 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2258 dest->size = cpu_to_le32(sizeof(*dest));
2259 dest->id = src_v4->id;
2260 dest->num_streams = src_v4->num_streams;
2261 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2262 memcpy(&dest->stream[i], &src_v4->stream[i],
2263 sizeof(struct snd_soc_tplg_stream));
2270 * snd_soc_find_dai_link - Find a DAI link
2273 * @id: DAI link ID to match
2274 * @name: DAI link name to match, optional
2275 * @stream_name: DAI link stream name to match, optional
2277 * This function will search all existing DAI links of the soc card to
2278 * find the link of the same ID. Since DAI links may not have their
2279 * unique ID, so name and stream name should also match if being
2282 * Return: pointer of DAI link, or NULL if not found.
2284 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2285 int id, const char *name,
2286 const char *stream_name)
2288 struct snd_soc_pcm_runtime *rtd;
2289 struct snd_soc_dai_link *link;
2291 for_each_card_rtds(card, rtd) {
2292 link = rtd->dai_link;
2297 if (name && (!link->name || strcmp(name, link->name)))
2300 if (stream_name && (!link->stream_name
2301 || strcmp(stream_name, link->stream_name)))
2310 /* Find and configure an existing physical DAI link */
2311 static int soc_tplg_link_config(struct soc_tplg *tplg,
2312 struct snd_soc_tplg_link_config *cfg)
2314 struct snd_soc_dai_link *link;
2315 const char *name, *stream_name;
2319 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2320 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2327 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2328 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2331 stream_name = cfg->stream_name;
2335 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2338 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2344 if (cfg->num_hw_configs)
2345 set_link_hw_format(link, cfg);
2349 set_link_flags(link,
2350 le32_to_cpu(cfg->flag_mask),
2351 le32_to_cpu(cfg->flags));
2353 /* pass control to component driver for optional further init */
2354 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2356 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2360 /* for unloading it in snd_soc_tplg_component_remove */
2361 link->dobj.index = tplg->index;
2362 link->dobj.ops = tplg->ops;
2363 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2364 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2370 /* Load physical link config elements from the topology context */
2371 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2372 struct snd_soc_tplg_hdr *hdr)
2374 struct snd_soc_tplg_link_config *link, *_link;
2380 count = le32_to_cpu(hdr->count);
2382 /* check the element size and count */
2383 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2384 size = le32_to_cpu(link->size);
2385 if (size > sizeof(struct snd_soc_tplg_link_config)
2386 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2387 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2392 if (soc_tplg_check_elem_count(tplg,
2394 le32_to_cpu(hdr->payload_size),
2395 "physical link config")) {
2396 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2401 /* config physical DAI links */
2402 for (i = 0; i < count; i++) {
2403 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2404 size = le32_to_cpu(link->size);
2405 if (size == sizeof(*link)) {
2410 ret = link_new_ver(tplg, link, &_link);
2415 ret = soc_tplg_link_config(tplg, _link);
2422 /* offset by version-specific struct size and
2423 * real priv data size
2425 tplg->pos += size + le32_to_cpu(_link->priv.size);
2428 kfree(_link); /* free the duplicated one */
2435 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2436 * @tplg: topology context
2437 * @d: physical DAI configs.
2439 * The physical dai should already be registered by the platform driver.
2440 * The platform driver should specify the DAI name and ID for matching.
2442 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2443 struct snd_soc_tplg_dai *d)
2445 struct snd_soc_dai_link_component dai_component;
2446 struct snd_soc_dai *dai;
2447 struct snd_soc_dai_driver *dai_drv;
2448 struct snd_soc_pcm_stream *stream;
2449 struct snd_soc_tplg_stream_caps *caps;
2452 memset(&dai_component, 0, sizeof(dai_component));
2454 dai_component.dai_name = d->dai_name;
2455 dai = snd_soc_find_dai(&dai_component);
2457 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2462 if (le32_to_cpu(d->dai_id) != dai->id) {
2463 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2468 dai_drv = dai->driver;
2473 stream = &dai_drv->playback;
2474 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2475 ret = set_stream_info(stream, caps);
2481 stream = &dai_drv->capture;
2482 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2483 ret = set_stream_info(stream, caps);
2489 set_dai_flags(dai_drv,
2490 le32_to_cpu(d->flag_mask),
2491 le32_to_cpu(d->flags));
2493 /* pass control to component driver for optional further init */
2494 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2496 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2503 kfree(dai_drv->playback.stream_name);
2504 kfree(dai_drv->capture.stream_name);
2508 /* load physical DAI elements */
2509 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2510 struct snd_soc_tplg_hdr *hdr)
2512 struct snd_soc_tplg_dai *dai;
2516 count = le32_to_cpu(hdr->count);
2518 /* config the existing BE DAIs */
2519 for (i = 0; i < count; i++) {
2520 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2521 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2522 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2526 ret = soc_tplg_dai_config(tplg, dai);
2528 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2532 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2535 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2540 * manifest_new_ver - Create a new version of manifest from the old version
2542 * @tplg: topology context
2543 * @src: old version of manifest as a source
2544 * @manifest: latest version of manifest created from the source
2546 * Support from vesion 4. Users need free the returned manifest manually.
2548 static int manifest_new_ver(struct soc_tplg *tplg,
2549 struct snd_soc_tplg_manifest *src,
2550 struct snd_soc_tplg_manifest **manifest)
2552 struct snd_soc_tplg_manifest *dest;
2553 struct snd_soc_tplg_manifest_v4 *src_v4;
2558 size = le32_to_cpu(src->size);
2559 if (size != sizeof(*src_v4)) {
2560 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2564 src->size = cpu_to_le32(sizeof(*src_v4));
2567 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2569 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2570 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2575 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2576 dest->control_elems = src_v4->control_elems;
2577 dest->widget_elems = src_v4->widget_elems;
2578 dest->graph_elems = src_v4->graph_elems;
2579 dest->pcm_elems = src_v4->pcm_elems;
2580 dest->dai_link_elems = src_v4->dai_link_elems;
2581 dest->priv.size = src_v4->priv.size;
2582 if (dest->priv.size)
2583 memcpy(dest->priv.data, src_v4->priv.data,
2584 le32_to_cpu(src_v4->priv.size));
2590 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2591 struct snd_soc_tplg_hdr *hdr)
2593 struct snd_soc_tplg_manifest *manifest, *_manifest;
2597 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2599 /* check ABI version by size, create a new manifest if abi not match */
2600 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2602 _manifest = manifest;
2605 ret = manifest_new_ver(tplg, manifest, &_manifest);
2610 /* pass control to component driver for optional further init */
2611 if (tplg->ops && tplg->ops->manifest)
2612 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2614 if (!abi_match) /* free the duplicated one */
2620 /* validate header magic, size and type */
2621 static int soc_valid_header(struct soc_tplg *tplg,
2622 struct snd_soc_tplg_hdr *hdr)
2624 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2627 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2629 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2630 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2635 /* big endian firmware objects not supported atm */
2636 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2638 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2639 tplg->pass, hdr->magic,
2640 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2644 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2646 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2647 tplg->pass, hdr->magic,
2648 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2652 /* Support ABI from version 4 */
2653 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2654 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2656 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2657 tplg->pass, hdr->abi,
2658 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2663 if (hdr->payload_size == 0) {
2664 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2665 soc_tplg_get_hdr_offset(tplg));
2672 /* check header type and call appropriate handler */
2673 static int soc_tplg_load_header(struct soc_tplg *tplg,
2674 struct snd_soc_tplg_hdr *hdr)
2676 int (*elem_load)(struct soc_tplg *tplg,
2677 struct snd_soc_tplg_hdr *hdr);
2678 unsigned int hdr_pass;
2680 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2682 /* check for matching ID */
2683 if (le32_to_cpu(hdr->index) != tplg->req_index &&
2684 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2687 tplg->index = le32_to_cpu(hdr->index);
2689 switch (le32_to_cpu(hdr->type)) {
2690 case SND_SOC_TPLG_TYPE_MIXER:
2691 case SND_SOC_TPLG_TYPE_ENUM:
2692 case SND_SOC_TPLG_TYPE_BYTES:
2693 hdr_pass = SOC_TPLG_PASS_MIXER;
2694 elem_load = soc_tplg_kcontrol_elems_load;
2696 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2697 hdr_pass = SOC_TPLG_PASS_GRAPH;
2698 elem_load = soc_tplg_dapm_graph_elems_load;
2700 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2701 hdr_pass = SOC_TPLG_PASS_WIDGET;
2702 elem_load = soc_tplg_dapm_widget_elems_load;
2704 case SND_SOC_TPLG_TYPE_PCM:
2705 hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2706 elem_load = soc_tplg_pcm_elems_load;
2708 case SND_SOC_TPLG_TYPE_DAI:
2709 hdr_pass = SOC_TPLG_PASS_BE_DAI;
2710 elem_load = soc_tplg_dai_elems_load;
2712 case SND_SOC_TPLG_TYPE_DAI_LINK:
2713 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2714 /* physical link configurations */
2715 hdr_pass = SOC_TPLG_PASS_LINK;
2716 elem_load = soc_tplg_link_elems_load;
2718 case SND_SOC_TPLG_TYPE_MANIFEST:
2719 hdr_pass = SOC_TPLG_PASS_MANIFEST;
2720 elem_load = soc_tplg_manifest_load;
2723 /* bespoke vendor data object */
2724 hdr_pass = SOC_TPLG_PASS_VENDOR;
2725 elem_load = soc_tplg_vendor_load;
2729 if (tplg->pass == hdr_pass) {
2731 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2732 hdr->payload_size, hdr->type, hdr->version,
2733 hdr->vendor_type, tplg->pass);
2734 return elem_load(tplg, hdr);
2740 /* process the topology file headers */
2741 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2743 struct snd_soc_tplg_hdr *hdr;
2746 tplg->pass = SOC_TPLG_PASS_START;
2748 /* process the header types from start to end */
2749 while (tplg->pass <= SOC_TPLG_PASS_END) {
2751 tplg->hdr_pos = tplg->fw->data;
2752 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2754 while (!soc_tplg_is_eof(tplg)) {
2756 /* make sure header is valid before loading */
2757 ret = soc_valid_header(tplg, hdr);
2760 "ASoC: topology: invalid header: %d\n", ret);
2762 } else if (ret == 0) {
2766 /* load the header object */
2767 ret = soc_tplg_load_header(tplg, hdr);
2770 "ASoC: topology: could not load header: %d\n", ret);
2774 /* goto next header */
2775 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2776 sizeof(struct snd_soc_tplg_hdr);
2777 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2780 /* next data type pass */
2784 /* signal DAPM we are complete */
2785 ret = soc_tplg_dapm_complete(tplg);
2788 "ASoC: failed to initialise DAPM from Firmware\n");
2793 static int soc_tplg_load(struct soc_tplg *tplg)
2797 ret = soc_tplg_process_headers(tplg);
2799 soc_tplg_complete(tplg);
2804 /* load audio component topology from "firmware" file */
2805 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2806 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2808 struct soc_tplg tplg;
2811 /* component needs to exist to keep and reference data while parsing */
2815 /* setup parsing context */
2816 memset(&tplg, 0, sizeof(tplg));
2818 tplg.dev = comp->dev;
2821 tplg.req_index = id;
2822 tplg.io_ops = ops->io_ops;
2823 tplg.io_ops_count = ops->io_ops_count;
2824 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2825 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2827 ret = soc_tplg_load(&tplg);
2828 /* free the created components if fail to load topology */
2830 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2834 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2836 /* remove this dynamic widget */
2837 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2839 /* make sure we are a widget */
2840 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2843 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2845 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2847 /* remove all dynamic widgets from this DAPM context */
2848 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2851 struct snd_soc_dapm_widget *w, *next_w;
2853 for_each_card_widgets_safe(dapm->card, w, next_w) {
2855 /* make sure we are a widget with correct context */
2856 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2860 if (w->dobj.index != index &&
2861 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2863 /* check and free and dynamic widget kcontrols */
2864 snd_soc_tplg_widget_remove(w);
2865 snd_soc_dapm_free_widget(w);
2867 snd_soc_dapm_reset_cache(dapm);
2869 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2871 /* remove dynamic controls from the component driver */
2872 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2874 struct snd_soc_dobj *dobj, *next_dobj;
2875 int pass = SOC_TPLG_PASS_END;
2877 /* process the header types from end to start */
2878 while (pass >= SOC_TPLG_PASS_START) {
2880 /* remove mixer controls */
2881 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2885 if (dobj->index != index &&
2886 index != SND_SOC_TPLG_INDEX_ALL)
2889 switch (dobj->type) {
2890 case SND_SOC_DOBJ_MIXER:
2891 remove_mixer(comp, dobj, pass);
2893 case SND_SOC_DOBJ_ENUM:
2894 remove_enum(comp, dobj, pass);
2896 case SND_SOC_DOBJ_BYTES:
2897 remove_bytes(comp, dobj, pass);
2899 case SND_SOC_DOBJ_GRAPH:
2900 remove_route(comp, dobj, pass);
2902 case SND_SOC_DOBJ_WIDGET:
2903 remove_widget(comp, dobj, pass);
2905 case SND_SOC_DOBJ_PCM:
2906 remove_dai(comp, dobj, pass);
2908 case SND_SOC_DOBJ_DAI_LINK:
2909 remove_link(comp, dobj, pass);
2911 case SND_SOC_DOBJ_BACKEND_LINK:
2913 * call link_unload ops if extra
2914 * deinitialization is needed.
2916 remove_backend_link(comp, dobj, pass);
2919 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2927 /* let caller know if FW can be freed when no objects are left */
2928 return !list_empty(&comp->dobj_list);
2930 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);