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, *_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_safe(comp, dai, _dai)
518 if (dai->driver == dai_drv)
519 snd_soc_unregister_dai(dai);
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_READ
582 || k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
583 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
584 struct soc_bytes_ext *sbe;
585 struct snd_soc_tplg_bytes_control *be;
587 sbe = (struct soc_bytes_ext *)k->private_value;
588 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
590 /* TLV bytes controls need standard kcontrol info handler,
591 * TLV callback and extended put/get handlers.
593 k->info = snd_soc_bytes_info_ext;
594 k->tlv.c = snd_soc_bytes_tlv_callback;
597 * When a topology-based implementation abuses the
598 * control interface and uses bytes_ext controls of
599 * more than 512 bytes, we need to disable the size
600 * checks, otherwise accesses to such controls will
601 * return an -EINVAL error and prevent the card from
604 if (IS_ENABLED(CONFIG_SND_CTL_VALIDATION) && sbe->max > 512)
605 k->access |= SNDRV_CTL_ELEM_ACCESS_SKIP_CHECK;
607 ext_ops = tplg->bytes_ext_ops;
608 num_ops = tplg->bytes_ext_ops_count;
609 for (i = 0; i < num_ops; i++) {
611 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
612 sbe->put = ext_ops[i].put;
614 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
615 sbe->get = ext_ops[i].get;
618 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) && !sbe->get)
620 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) && !sbe->put)
625 /* try and map vendor specific kcontrol handlers first */
627 num_ops = tplg->io_ops_count;
628 for (i = 0; i < num_ops; i++) {
630 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
632 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
634 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
635 k->info = ops[i].info;
638 /* vendor specific handlers found ? */
639 if (k->put && k->get && k->info)
642 /* none found so try standard kcontrol handlers */
644 num_ops = ARRAY_SIZE(io_ops);
645 for (i = 0; i < num_ops; i++) {
647 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
649 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
651 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
652 k->info = ops[i].info;
655 /* standard handlers found ? */
656 if (k->put && k->get && k->info)
659 /* nothing to bind */
663 /* bind a widgets to it's evnt handlers */
664 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
665 const struct snd_soc_tplg_widget_events *events,
666 int num_events, u16 event_type)
672 for (i = 0; i < num_events; i++) {
673 if (event_type == events[i].type) {
675 /* found - so assign event */
676 w->event = events[i].event_handler;
684 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
686 /* optionally pass new dynamic kcontrol to component driver. */
687 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
688 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
690 if (tplg->ops && tplg->ops->control_load)
691 return tplg->ops->control_load(tplg->comp, tplg->index, k,
698 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
699 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
701 unsigned int item_len = 2 * sizeof(unsigned int);
704 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
708 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
710 p[2] = le32_to_cpu(scale->min);
711 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
712 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
714 kc->tlv.p = (void *)p;
718 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
719 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
721 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
722 u32 access = le32_to_cpu(tc->access);
724 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
727 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
729 switch (le32_to_cpu(tplg_tlv->type)) {
730 case SNDRV_CTL_TLVT_DB_SCALE:
731 return soc_tplg_create_tlv_db_scale(tplg, kc,
734 /* TODO: add support for other TLV types */
736 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
745 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
746 struct snd_kcontrol_new *kc)
751 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
754 struct snd_soc_tplg_bytes_control *be;
755 struct soc_bytes_ext *sbe;
756 struct snd_kcontrol_new kc;
760 if (soc_tplg_check_elem_count(tplg,
761 sizeof(struct snd_soc_tplg_bytes_control), count,
762 size, "mixer bytes")) {
763 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
768 for (i = 0; i < count; i++) {
769 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
771 /* validate kcontrol */
772 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
773 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
776 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
780 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
781 le32_to_cpu(be->priv.size));
784 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
785 be->hdr.name, be->hdr.access);
787 memset(&kc, 0, sizeof(kc));
788 kc.name = be->hdr.name;
789 kc.private_value = (long)sbe;
790 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
791 kc.access = le32_to_cpu(be->hdr.access);
793 sbe->max = le32_to_cpu(be->max);
794 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
795 sbe->dobj.ops = tplg->ops;
796 INIT_LIST_HEAD(&sbe->dobj.list);
798 /* map io handlers */
799 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
801 soc_control_err(tplg, &be->hdr, be->hdr.name);
806 /* pass control to driver for optional further init */
807 err = soc_tplg_init_kcontrol(tplg, &kc,
808 (struct snd_soc_tplg_ctl_hdr *)be);
810 dev_err(tplg->dev, "ASoC: failed to init %s\n",
816 /* register control here */
817 err = soc_tplg_add_kcontrol(tplg, &kc,
818 &sbe->dobj.control.kcontrol);
820 dev_err(tplg->dev, "ASoC: failed to add %s\n",
826 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
832 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
835 struct snd_soc_tplg_mixer_control *mc;
836 struct soc_mixer_control *sm;
837 struct snd_kcontrol_new kc;
841 if (soc_tplg_check_elem_count(tplg,
842 sizeof(struct snd_soc_tplg_mixer_control),
843 count, size, "mixers")) {
845 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
850 for (i = 0; i < count; i++) {
851 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
853 /* validate kcontrol */
854 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
855 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
858 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
861 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
862 le32_to_cpu(mc->priv.size));
865 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
866 mc->hdr.name, mc->hdr.access);
868 memset(&kc, 0, sizeof(kc));
869 kc.name = mc->hdr.name;
870 kc.private_value = (long)sm;
871 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
872 kc.access = le32_to_cpu(mc->hdr.access);
874 /* we only support FL/FR channel mapping atm */
875 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
877 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
879 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
881 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
884 sm->max = le32_to_cpu(mc->max);
885 sm->min = le32_to_cpu(mc->min);
886 sm->invert = le32_to_cpu(mc->invert);
887 sm->platform_max = le32_to_cpu(mc->platform_max);
888 sm->dobj.index = tplg->index;
889 sm->dobj.ops = tplg->ops;
890 sm->dobj.type = SND_SOC_DOBJ_MIXER;
891 INIT_LIST_HEAD(&sm->dobj.list);
893 /* map io handlers */
894 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
896 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
901 /* create any TLV data */
902 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
904 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
910 /* pass control to driver for optional further init */
911 err = soc_tplg_init_kcontrol(tplg, &kc,
912 (struct snd_soc_tplg_ctl_hdr *) mc);
914 dev_err(tplg->dev, "ASoC: failed to init %s\n",
916 soc_tplg_free_tlv(tplg, &kc);
921 /* register control here */
922 err = soc_tplg_add_kcontrol(tplg, &kc,
923 &sm->dobj.control.kcontrol);
925 dev_err(tplg->dev, "ASoC: failed to add %s\n",
927 soc_tplg_free_tlv(tplg, &kc);
932 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
938 static int soc_tplg_denum_create_texts(struct soc_enum *se,
939 struct snd_soc_tplg_enum_control *ec)
943 se->dobj.control.dtexts =
944 kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
945 if (se->dobj.control.dtexts == NULL)
948 for (i = 0; i < le32_to_cpu(ec->items); i++) {
950 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
951 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
956 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
957 if (!se->dobj.control.dtexts[i]) {
963 se->items = le32_to_cpu(ec->items);
964 se->texts = (const char * const *)se->dobj.control.dtexts;
969 soc_tplg_denum_remove_texts(se);
973 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
977 for (--i; i >= 0; i--)
978 kfree(se->dobj.control.dtexts[i]);
979 kfree(se->dobj.control.dtexts);
982 static int soc_tplg_denum_create_values(struct soc_enum *se,
983 struct snd_soc_tplg_enum_control *ec)
987 if (le32_to_cpu(ec->items) > sizeof(*ec->values))
990 se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
991 sizeof(*se->dobj.control.dvalues),
993 if (!se->dobj.control.dvalues)
996 /* convert from little-endian */
997 for (i = 0; i < le32_to_cpu(ec->items); i++) {
998 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
1004 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
1006 kfree(se->dobj.control.dvalues);
1009 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
1012 struct snd_soc_tplg_enum_control *ec;
1013 struct soc_enum *se;
1014 struct snd_kcontrol_new kc;
1018 if (soc_tplg_check_elem_count(tplg,
1019 sizeof(struct snd_soc_tplg_enum_control),
1020 count, size, "enums")) {
1022 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1027 for (i = 0; i < count; i++) {
1028 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1030 /* validate kcontrol */
1031 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1032 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1035 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1039 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1040 le32_to_cpu(ec->priv.size));
1042 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1043 ec->hdr.name, ec->items);
1045 memset(&kc, 0, sizeof(kc));
1046 kc.name = ec->hdr.name;
1047 kc.private_value = (long)se;
1048 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1049 kc.access = le32_to_cpu(ec->hdr.access);
1051 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1052 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1054 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1057 se->mask = le32_to_cpu(ec->mask);
1058 se->dobj.index = tplg->index;
1059 se->dobj.type = SND_SOC_DOBJ_ENUM;
1060 se->dobj.ops = tplg->ops;
1061 INIT_LIST_HEAD(&se->dobj.list);
1063 switch (le32_to_cpu(ec->hdr.ops.info)) {
1064 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1065 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1066 err = soc_tplg_denum_create_values(se, ec);
1069 "ASoC: could not create values for %s\n",
1074 case SND_SOC_TPLG_CTL_ENUM:
1075 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1076 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1077 err = soc_tplg_denum_create_texts(se, ec);
1080 "ASoC: could not create texts for %s\n",
1088 "ASoC: invalid enum control type %d for %s\n",
1089 ec->hdr.ops.info, ec->hdr.name);
1093 /* map io handlers */
1094 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1096 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1100 /* pass control to driver for optional further init */
1101 err = soc_tplg_init_kcontrol(tplg, &kc,
1102 (struct snd_soc_tplg_ctl_hdr *) ec);
1104 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1109 /* register control here */
1110 err = soc_tplg_add_kcontrol(tplg,
1111 &kc, &se->dobj.control.kcontrol);
1113 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1118 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1127 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1128 struct snd_soc_tplg_hdr *hdr)
1130 struct snd_soc_tplg_ctl_hdr *control_hdr;
1134 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1135 soc_tplg_get_offset(tplg));
1137 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1139 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1141 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1142 dev_err(tplg->dev, "ASoC: invalid control size\n");
1146 switch (le32_to_cpu(control_hdr->ops.info)) {
1147 case SND_SOC_TPLG_CTL_VOLSW:
1148 case SND_SOC_TPLG_CTL_STROBE:
1149 case SND_SOC_TPLG_CTL_VOLSW_SX:
1150 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1151 case SND_SOC_TPLG_CTL_RANGE:
1152 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1153 case SND_SOC_TPLG_DAPM_CTL_PIN:
1154 ret = soc_tplg_dmixer_create(tplg, 1,
1155 le32_to_cpu(hdr->payload_size));
1157 case SND_SOC_TPLG_CTL_ENUM:
1158 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1159 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1160 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1161 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1162 ret = soc_tplg_denum_create(tplg, 1,
1163 le32_to_cpu(hdr->payload_size));
1165 case SND_SOC_TPLG_CTL_BYTES:
1166 ret = soc_tplg_dbytes_create(tplg, 1,
1167 le32_to_cpu(hdr->payload_size));
1170 soc_bind_err(tplg, control_hdr, i);
1174 dev_err(tplg->dev, "ASoC: invalid control\n");
1183 /* optionally pass new dynamic kcontrol to component driver. */
1184 static int soc_tplg_add_route(struct soc_tplg *tplg,
1185 struct snd_soc_dapm_route *route)
1187 if (tplg->ops && tplg->ops->dapm_route_load)
1188 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1194 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1195 struct snd_soc_tplg_hdr *hdr)
1197 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1198 struct snd_soc_tplg_dapm_graph_elem *elem;
1199 struct snd_soc_dapm_route **routes;
1203 count = le32_to_cpu(hdr->count);
1205 if (soc_tplg_check_elem_count(tplg,
1206 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1207 count, le32_to_cpu(hdr->payload_size), "graph")) {
1209 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1214 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1217 /* allocate memory for pointer to array of dapm routes */
1218 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1224 * allocate memory for each dapm route in the array.
1225 * This needs to be done individually so that
1226 * each route can be freed when it is removed in remove_route().
1228 for (i = 0; i < count; i++) {
1229 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1231 /* free previously allocated memory */
1232 for (j = 0; j < i; j++)
1240 for (i = 0; i < count; i++) {
1241 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1242 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1244 /* validate routes */
1245 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1246 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1250 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1251 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1255 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1256 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1261 routes[i]->source = elem->source;
1262 routes[i]->sink = elem->sink;
1264 /* set to NULL atm for tplg users */
1265 routes[i]->connected = NULL;
1266 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1267 routes[i]->control = NULL;
1269 routes[i]->control = elem->control;
1271 /* add route dobj to dobj_list */
1272 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1273 routes[i]->dobj.ops = tplg->ops;
1274 routes[i]->dobj.index = tplg->index;
1275 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1277 ret = soc_tplg_add_route(tplg, routes[i]);
1279 dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1281 * this route was added to the list, it will
1282 * be freed in remove_route() so increment the
1283 * counter to skip it in the error handling
1290 /* add route, but keep going if some fail */
1291 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1295 * free memory allocated for all dapm routes not added to the
1296 * list in case of error
1304 * free pointer to array of dapm routes as this is no longer needed.
1305 * The memory allocated for each dapm route will be freed
1306 * when it is removed in remove_route().
1313 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1314 struct soc_tplg *tplg, int num_kcontrols)
1316 struct snd_kcontrol_new *kc;
1317 struct soc_mixer_control *sm;
1318 struct snd_soc_tplg_mixer_control *mc;
1321 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1325 for (i = 0; i < num_kcontrols; i++) {
1326 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1328 /* validate kcontrol */
1329 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1330 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1333 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1337 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1338 le32_to_cpu(mc->priv.size));
1340 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1343 kc[i].private_value = (long)sm;
1344 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1345 if (kc[i].name == NULL)
1347 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1348 kc[i].access = le32_to_cpu(mc->hdr.access);
1350 /* we only support FL/FR channel mapping atm */
1351 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1353 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1355 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1357 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1360 sm->max = le32_to_cpu(mc->max);
1361 sm->min = le32_to_cpu(mc->min);
1362 sm->invert = le32_to_cpu(mc->invert);
1363 sm->platform_max = le32_to_cpu(mc->platform_max);
1364 sm->dobj.index = tplg->index;
1365 INIT_LIST_HEAD(&sm->dobj.list);
1367 /* map io handlers */
1368 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1370 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1374 /* create any TLV data */
1375 err = soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1377 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1382 /* pass control to driver for optional further init */
1383 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1384 (struct snd_soc_tplg_ctl_hdr *)mc);
1386 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1394 for (; i >= 0; i--) {
1395 soc_tplg_free_tlv(tplg, &kc[i]);
1396 sm = (struct soc_mixer_control *)kc[i].private_value;
1405 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1406 struct soc_tplg *tplg, int num_kcontrols)
1408 struct snd_kcontrol_new *kc;
1409 struct snd_soc_tplg_enum_control *ec;
1410 struct soc_enum *se;
1413 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1417 for (i = 0; i < num_kcontrols; i++) {
1418 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1419 /* validate kcontrol */
1420 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1421 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1424 se = kzalloc(sizeof(*se), GFP_KERNEL);
1428 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1429 le32_to_cpu(ec->priv.size));
1431 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1434 kc[i].private_value = (long)se;
1435 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1436 if (kc[i].name == NULL)
1438 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1439 kc[i].access = le32_to_cpu(ec->hdr.access);
1441 /* we only support FL/FR channel mapping atm */
1442 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1443 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1445 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1448 se->items = le32_to_cpu(ec->items);
1449 se->mask = le32_to_cpu(ec->mask);
1450 se->dobj.index = tplg->index;
1452 switch (le32_to_cpu(ec->hdr.ops.info)) {
1453 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1454 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1455 err = soc_tplg_denum_create_values(se, ec);
1457 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1462 case SND_SOC_TPLG_CTL_ENUM:
1463 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1464 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1465 err = soc_tplg_denum_create_texts(se, ec);
1467 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1473 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1474 ec->hdr.ops.info, ec->hdr.name);
1478 /* map io handlers */
1479 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1481 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1485 /* pass control to driver for optional further init */
1486 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1487 (struct snd_soc_tplg_ctl_hdr *)ec);
1489 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1498 for (; i >= 0; i--) {
1499 /* free values and texts */
1500 se = (struct soc_enum *)kc[i].private_value;
1503 soc_tplg_denum_remove_values(se);
1504 soc_tplg_denum_remove_texts(se);
1515 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1516 struct soc_tplg *tplg, int num_kcontrols)
1518 struct snd_soc_tplg_bytes_control *be;
1519 struct soc_bytes_ext *sbe;
1520 struct snd_kcontrol_new *kc;
1523 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1527 for (i = 0; i < num_kcontrols; i++) {
1528 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1530 /* validate kcontrol */
1531 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1532 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1535 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1539 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1540 le32_to_cpu(be->priv.size));
1543 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1544 be->hdr.name, be->hdr.access);
1546 kc[i].private_value = (long)sbe;
1547 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1548 if (kc[i].name == NULL)
1550 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1551 kc[i].access = le32_to_cpu(be->hdr.access);
1553 sbe->max = le32_to_cpu(be->max);
1554 INIT_LIST_HEAD(&sbe->dobj.list);
1556 /* map standard io handlers and check for external handlers */
1557 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1559 soc_control_err(tplg, &be->hdr, be->hdr.name);
1563 /* pass control to driver for optional further init */
1564 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1565 (struct snd_soc_tplg_ctl_hdr *)be);
1567 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1576 for (; i >= 0; i--) {
1577 sbe = (struct soc_bytes_ext *)kc[i].private_value;
1586 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1587 struct snd_soc_tplg_dapm_widget *w)
1589 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1590 struct snd_soc_dapm_widget template, *widget;
1591 struct snd_soc_tplg_ctl_hdr *control_hdr;
1592 struct snd_soc_card *card = tplg->comp->card;
1593 unsigned int kcontrol_type;
1596 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1597 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1599 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1600 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1603 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1606 memset(&template, 0, sizeof(template));
1608 /* map user to kernel widget ID */
1609 template.id = get_widget_id(le32_to_cpu(w->id));
1610 if ((int)template.id < 0)
1613 /* strings are allocated here, but used and freed by the widget */
1614 template.name = kstrdup(w->name, GFP_KERNEL);
1617 template.sname = kstrdup(w->sname, GFP_KERNEL);
1618 if (!template.sname) {
1622 template.reg = le32_to_cpu(w->reg);
1623 template.shift = le32_to_cpu(w->shift);
1624 template.mask = le32_to_cpu(w->mask);
1625 template.subseq = le32_to_cpu(w->subseq);
1626 template.on_val = w->invert ? 0 : 1;
1627 template.off_val = w->invert ? 1 : 0;
1628 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1629 template.event_flags = le16_to_cpu(w->event_flags);
1630 template.dobj.index = tplg->index;
1633 (sizeof(struct snd_soc_tplg_dapm_widget) +
1634 le32_to_cpu(w->priv.size));
1636 if (w->num_kcontrols == 0) {
1638 template.num_kcontrols = 0;
1642 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1643 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1644 w->name, w->num_kcontrols, control_hdr->type);
1646 switch (le32_to_cpu(control_hdr->ops.info)) {
1647 case SND_SOC_TPLG_CTL_VOLSW:
1648 case SND_SOC_TPLG_CTL_STROBE:
1649 case SND_SOC_TPLG_CTL_VOLSW_SX:
1650 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1651 case SND_SOC_TPLG_CTL_RANGE:
1652 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1653 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1654 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1655 template.kcontrol_news =
1656 soc_tplg_dapm_widget_dmixer_create(tplg,
1657 template.num_kcontrols);
1658 if (!template.kcontrol_news) {
1663 case SND_SOC_TPLG_CTL_ENUM:
1664 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1665 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1666 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1667 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1668 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1669 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1670 template.kcontrol_news =
1671 soc_tplg_dapm_widget_denum_create(tplg,
1672 template.num_kcontrols);
1673 if (!template.kcontrol_news) {
1678 case SND_SOC_TPLG_CTL_BYTES:
1679 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1680 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1681 template.kcontrol_news =
1682 soc_tplg_dapm_widget_dbytes_create(tplg,
1683 template.num_kcontrols);
1684 if (!template.kcontrol_news) {
1690 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1691 control_hdr->ops.get, control_hdr->ops.put,
1692 le32_to_cpu(control_hdr->ops.info));
1698 ret = soc_tplg_widget_load(tplg, &template, w);
1702 /* card dapm mutex is held by the core if we are loading topology
1703 * data during sound card init. */
1704 if (card->instantiated)
1705 widget = snd_soc_dapm_new_control(dapm, &template);
1707 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1708 if (IS_ERR(widget)) {
1709 ret = PTR_ERR(widget);
1713 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1714 widget->dobj.widget.kcontrol_type = kcontrol_type;
1715 widget->dobj.ops = tplg->ops;
1716 widget->dobj.index = tplg->index;
1717 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1719 ret = soc_tplg_widget_ready(tplg, widget, w);
1723 kfree(template.sname);
1724 kfree(template.name);
1729 snd_soc_tplg_widget_remove(widget);
1730 snd_soc_dapm_free_widget(widget);
1732 kfree(template.sname);
1734 kfree(template.name);
1738 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1739 struct snd_soc_tplg_hdr *hdr)
1741 struct snd_soc_tplg_dapm_widget *widget;
1744 count = le32_to_cpu(hdr->count);
1746 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1748 for (i = 0; i < count; i++) {
1749 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1750 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1751 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1755 ret = soc_tplg_dapm_widget_create(tplg, widget);
1757 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1766 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1768 struct snd_soc_card *card = tplg->comp->card;
1771 /* Card might not have been registered at this point.
1772 * If so, just return success.
1774 if (!card || !card->instantiated) {
1775 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1776 " widget card binding deferred\n");
1780 ret = snd_soc_dapm_new_widgets(card);
1782 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1788 static int set_stream_info(struct snd_soc_pcm_stream *stream,
1789 struct snd_soc_tplg_stream_caps *caps)
1791 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1792 if (!stream->stream_name)
1795 stream->channels_min = le32_to_cpu(caps->channels_min);
1796 stream->channels_max = le32_to_cpu(caps->channels_max);
1797 stream->rates = le32_to_cpu(caps->rates);
1798 stream->rate_min = le32_to_cpu(caps->rate_min);
1799 stream->rate_max = le32_to_cpu(caps->rate_max);
1800 stream->formats = le64_to_cpu(caps->formats);
1801 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1806 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1807 unsigned int flag_mask, unsigned int flags)
1809 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1810 dai_drv->symmetric_rates =
1811 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1813 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1814 dai_drv->symmetric_channels =
1815 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1818 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1819 dai_drv->symmetric_samplebits =
1820 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1824 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1825 struct snd_soc_tplg_pcm *pcm)
1827 struct snd_soc_dai_driver *dai_drv;
1828 struct snd_soc_pcm_stream *stream;
1829 struct snd_soc_tplg_stream_caps *caps;
1830 struct snd_soc_dai *dai;
1831 struct snd_soc_dapm_context *dapm =
1832 snd_soc_component_get_dapm(tplg->comp);
1835 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1836 if (dai_drv == NULL)
1839 if (strlen(pcm->dai_name)) {
1840 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1841 if (!dai_drv->name) {
1846 dai_drv->id = le32_to_cpu(pcm->dai_id);
1848 if (pcm->playback) {
1849 stream = &dai_drv->playback;
1850 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1851 ret = set_stream_info(stream, caps);
1857 stream = &dai_drv->capture;
1858 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1859 ret = set_stream_info(stream, caps);
1865 dai_drv->compress_new = snd_soc_new_compress;
1867 /* pass control to component driver for optional further init */
1868 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1870 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1874 dai_drv->dobj.index = tplg->index;
1875 dai_drv->dobj.ops = tplg->ops;
1876 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1877 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1879 /* register the DAI to the component */
1880 dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1884 /* Create the DAI widgets here */
1885 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1887 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1888 snd_soc_unregister_dai(dai);
1895 kfree(dai_drv->playback.stream_name);
1896 kfree(dai_drv->capture.stream_name);
1897 kfree(dai_drv->name);
1903 static void set_link_flags(struct snd_soc_dai_link *link,
1904 unsigned int flag_mask, unsigned int flags)
1906 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1907 link->symmetric_rates =
1908 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1910 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1911 link->symmetric_channels =
1912 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1915 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1916 link->symmetric_samplebits =
1917 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1920 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1921 link->ignore_suspend =
1922 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1926 /* create the FE DAI link */
1927 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1928 struct snd_soc_tplg_pcm *pcm)
1930 struct snd_soc_dai_link *link;
1931 struct snd_soc_dai_link_component *dlc;
1934 /* link + cpu + codec + platform */
1935 link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1939 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1941 link->cpus = &dlc[0];
1942 link->codecs = &dlc[1];
1943 link->platforms = &dlc[2];
1946 link->num_codecs = 1;
1947 link->num_platforms = 1;
1949 link->dobj.index = tplg->index;
1950 link->dobj.ops = tplg->ops;
1951 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1953 if (strlen(pcm->pcm_name)) {
1954 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1955 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1956 if (!link->name || !link->stream_name) {
1961 link->id = le32_to_cpu(pcm->pcm_id);
1963 if (strlen(pcm->dai_name)) {
1964 link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1965 if (!link->cpus->dai_name) {
1971 link->codecs->name = "snd-soc-dummy";
1972 link->codecs->dai_name = "snd-soc-dummy-dai";
1974 link->platforms->name = "snd-soc-dummy";
1978 link->dpcm_playback = le32_to_cpu(pcm->playback);
1979 link->dpcm_capture = le32_to_cpu(pcm->capture);
1981 set_link_flags(link,
1982 le32_to_cpu(pcm->flag_mask),
1983 le32_to_cpu(pcm->flags));
1985 /* pass control to component driver for optional further init */
1986 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1988 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1992 ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1994 dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1998 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2003 kfree(link->stream_name);
2004 kfree(link->cpus->dai_name);
2009 /* create a FE DAI and DAI link from the PCM object */
2010 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
2011 struct snd_soc_tplg_pcm *pcm)
2015 ret = soc_tplg_dai_create(tplg, pcm);
2019 return soc_tplg_fe_link_create(tplg, pcm);
2022 /* copy stream caps from the old version 4 of source */
2023 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
2024 struct snd_soc_tplg_stream_caps_v4 *src)
2026 dest->size = cpu_to_le32(sizeof(*dest));
2027 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2028 dest->formats = src->formats;
2029 dest->rates = src->rates;
2030 dest->rate_min = src->rate_min;
2031 dest->rate_max = src->rate_max;
2032 dest->channels_min = src->channels_min;
2033 dest->channels_max = src->channels_max;
2034 dest->periods_min = src->periods_min;
2035 dest->periods_max = src->periods_max;
2036 dest->period_size_min = src->period_size_min;
2037 dest->period_size_max = src->period_size_max;
2038 dest->buffer_size_min = src->buffer_size_min;
2039 dest->buffer_size_max = src->buffer_size_max;
2043 * pcm_new_ver - Create the new version of PCM from the old version.
2044 * @tplg: topology context
2045 * @src: older version of pcm as a source
2046 * @pcm: latest version of pcm created from the source
2048 * Support from vesion 4. User should free the returned pcm manually.
2050 static int pcm_new_ver(struct soc_tplg *tplg,
2051 struct snd_soc_tplg_pcm *src,
2052 struct snd_soc_tplg_pcm **pcm)
2054 struct snd_soc_tplg_pcm *dest;
2055 struct snd_soc_tplg_pcm_v4 *src_v4;
2060 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2061 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2065 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2066 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2067 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2071 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2072 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2073 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2074 dest->pcm_id = src_v4->pcm_id;
2075 dest->dai_id = src_v4->dai_id;
2076 dest->playback = src_v4->playback;
2077 dest->capture = src_v4->capture;
2078 dest->compress = src_v4->compress;
2079 dest->num_streams = src_v4->num_streams;
2080 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2081 memcpy(&dest->stream[i], &src_v4->stream[i],
2082 sizeof(struct snd_soc_tplg_stream));
2084 for (i = 0; i < 2; i++)
2085 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2091 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2092 struct snd_soc_tplg_hdr *hdr)
2094 struct snd_soc_tplg_pcm *pcm, *_pcm;
2101 count = le32_to_cpu(hdr->count);
2103 /* check the element size and count */
2104 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2105 size = le32_to_cpu(pcm->size);
2106 if (size > sizeof(struct snd_soc_tplg_pcm)
2107 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2108 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2113 if (soc_tplg_check_elem_count(tplg,
2115 le32_to_cpu(hdr->payload_size),
2117 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2122 for (i = 0; i < count; i++) {
2123 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2124 size = le32_to_cpu(pcm->size);
2126 /* check ABI version by size, create a new version of pcm
2129 if (size == sizeof(*pcm)) {
2134 ret = pcm_new_ver(tplg, pcm, &_pcm);
2139 /* create the FE DAIs and DAI links */
2140 ret = soc_tplg_pcm_create(tplg, _pcm);
2147 /* offset by version-specific struct size and
2148 * real priv data size
2150 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2153 kfree(_pcm); /* free the duplicated one */
2156 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2162 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2163 * @link: &snd_soc_dai_link which should be updated
2164 * @cfg: physical link configs.
2166 * Topology context contains a list of supported HW formats (configs) and
2167 * a default format ID for the physical link. This function will use this
2168 * default ID to choose the HW format to set the link's DAI format for init.
2170 static void set_link_hw_format(struct snd_soc_dai_link *link,
2171 struct snd_soc_tplg_link_config *cfg)
2173 struct snd_soc_tplg_hw_config *hw_config;
2174 unsigned char bclk_master, fsync_master;
2175 unsigned char invert_bclk, invert_fsync;
2178 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2179 hw_config = &cfg->hw_config[i];
2180 if (hw_config->id != cfg->default_hw_config_id)
2183 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2184 SND_SOC_DAIFMT_FORMAT_MASK;
2187 switch (hw_config->clock_gated) {
2188 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2189 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2192 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2193 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2197 /* ignore the value */
2201 /* clock signal polarity */
2202 invert_bclk = hw_config->invert_bclk;
2203 invert_fsync = hw_config->invert_fsync;
2204 if (!invert_bclk && !invert_fsync)
2205 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2206 else if (!invert_bclk && invert_fsync)
2207 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2208 else if (invert_bclk && !invert_fsync)
2209 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2211 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2214 bclk_master = (hw_config->bclk_master ==
2215 SND_SOC_TPLG_BCLK_CM);
2216 fsync_master = (hw_config->fsync_master ==
2217 SND_SOC_TPLG_FSYNC_CM);
2218 if (bclk_master && fsync_master)
2219 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2220 else if (!bclk_master && fsync_master)
2221 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2222 else if (bclk_master && !fsync_master)
2223 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2225 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2230 * link_new_ver - Create a new physical link config from the old
2231 * version of source.
2232 * @tplg: topology context
2233 * @src: old version of phyical link config as a source
2234 * @link: latest version of physical link config created from the source
2236 * Support from vesion 4. User need free the returned link config manually.
2238 static int link_new_ver(struct soc_tplg *tplg,
2239 struct snd_soc_tplg_link_config *src,
2240 struct snd_soc_tplg_link_config **link)
2242 struct snd_soc_tplg_link_config *dest;
2243 struct snd_soc_tplg_link_config_v4 *src_v4;
2248 if (le32_to_cpu(src->size) !=
2249 sizeof(struct snd_soc_tplg_link_config_v4)) {
2250 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2254 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2256 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2257 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2261 dest->size = cpu_to_le32(sizeof(*dest));
2262 dest->id = src_v4->id;
2263 dest->num_streams = src_v4->num_streams;
2264 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2265 memcpy(&dest->stream[i], &src_v4->stream[i],
2266 sizeof(struct snd_soc_tplg_stream));
2273 * snd_soc_find_dai_link - Find a DAI link
2276 * @id: DAI link ID to match
2277 * @name: DAI link name to match, optional
2278 * @stream_name: DAI link stream name to match, optional
2280 * This function will search all existing DAI links of the soc card to
2281 * find the link of the same ID. Since DAI links may not have their
2282 * unique ID, so name and stream name should also match if being
2285 * Return: pointer of DAI link, or NULL if not found.
2287 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2288 int id, const char *name,
2289 const char *stream_name)
2291 struct snd_soc_pcm_runtime *rtd;
2292 struct snd_soc_dai_link *link;
2294 for_each_card_rtds(card, rtd) {
2295 link = rtd->dai_link;
2300 if (name && (!link->name || strcmp(name, link->name)))
2303 if (stream_name && (!link->stream_name
2304 || strcmp(stream_name, link->stream_name)))
2313 /* Find and configure an existing physical DAI link */
2314 static int soc_tplg_link_config(struct soc_tplg *tplg,
2315 struct snd_soc_tplg_link_config *cfg)
2317 struct snd_soc_dai_link *link;
2318 const char *name, *stream_name;
2322 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2323 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2330 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2331 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2334 stream_name = cfg->stream_name;
2338 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2341 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2347 if (cfg->num_hw_configs)
2348 set_link_hw_format(link, cfg);
2352 set_link_flags(link,
2353 le32_to_cpu(cfg->flag_mask),
2354 le32_to_cpu(cfg->flags));
2356 /* pass control to component driver for optional further init */
2357 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2359 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2363 /* for unloading it in snd_soc_tplg_component_remove */
2364 link->dobj.index = tplg->index;
2365 link->dobj.ops = tplg->ops;
2366 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2367 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2373 /* Load physical link config elements from the topology context */
2374 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2375 struct snd_soc_tplg_hdr *hdr)
2377 struct snd_soc_tplg_link_config *link, *_link;
2383 count = le32_to_cpu(hdr->count);
2385 /* check the element size and count */
2386 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2387 size = le32_to_cpu(link->size);
2388 if (size > sizeof(struct snd_soc_tplg_link_config)
2389 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2390 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2395 if (soc_tplg_check_elem_count(tplg,
2397 le32_to_cpu(hdr->payload_size),
2398 "physical link config")) {
2399 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2404 /* config physical DAI links */
2405 for (i = 0; i < count; i++) {
2406 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2407 size = le32_to_cpu(link->size);
2408 if (size == sizeof(*link)) {
2413 ret = link_new_ver(tplg, link, &_link);
2418 ret = soc_tplg_link_config(tplg, _link);
2425 /* offset by version-specific struct size and
2426 * real priv data size
2428 tplg->pos += size + le32_to_cpu(_link->priv.size);
2431 kfree(_link); /* free the duplicated one */
2438 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2439 * @tplg: topology context
2440 * @d: physical DAI configs.
2442 * The physical dai should already be registered by the platform driver.
2443 * The platform driver should specify the DAI name and ID for matching.
2445 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2446 struct snd_soc_tplg_dai *d)
2448 struct snd_soc_dai_link_component dai_component;
2449 struct snd_soc_dai *dai;
2450 struct snd_soc_dai_driver *dai_drv;
2451 struct snd_soc_pcm_stream *stream;
2452 struct snd_soc_tplg_stream_caps *caps;
2455 memset(&dai_component, 0, sizeof(dai_component));
2457 dai_component.dai_name = d->dai_name;
2458 dai = snd_soc_find_dai(&dai_component);
2460 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2465 if (le32_to_cpu(d->dai_id) != dai->id) {
2466 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2471 dai_drv = dai->driver;
2476 stream = &dai_drv->playback;
2477 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2478 ret = set_stream_info(stream, caps);
2484 stream = &dai_drv->capture;
2485 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2486 ret = set_stream_info(stream, caps);
2492 set_dai_flags(dai_drv,
2493 le32_to_cpu(d->flag_mask),
2494 le32_to_cpu(d->flags));
2496 /* pass control to component driver for optional further init */
2497 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2499 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2506 kfree(dai_drv->playback.stream_name);
2507 kfree(dai_drv->capture.stream_name);
2511 /* load physical DAI elements */
2512 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2513 struct snd_soc_tplg_hdr *hdr)
2515 struct snd_soc_tplg_dai *dai;
2519 count = le32_to_cpu(hdr->count);
2521 /* config the existing BE DAIs */
2522 for (i = 0; i < count; i++) {
2523 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2524 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2525 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2529 ret = soc_tplg_dai_config(tplg, dai);
2531 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2535 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2538 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2543 * manifest_new_ver - Create a new version of manifest from the old version
2545 * @tplg: topology context
2546 * @src: old version of manifest as a source
2547 * @manifest: latest version of manifest created from the source
2549 * Support from vesion 4. Users need free the returned manifest manually.
2551 static int manifest_new_ver(struct soc_tplg *tplg,
2552 struct snd_soc_tplg_manifest *src,
2553 struct snd_soc_tplg_manifest **manifest)
2555 struct snd_soc_tplg_manifest *dest;
2556 struct snd_soc_tplg_manifest_v4 *src_v4;
2561 size = le32_to_cpu(src->size);
2562 if (size != sizeof(*src_v4)) {
2563 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2567 src->size = cpu_to_le32(sizeof(*src_v4));
2570 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2572 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2573 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2578 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2579 dest->control_elems = src_v4->control_elems;
2580 dest->widget_elems = src_v4->widget_elems;
2581 dest->graph_elems = src_v4->graph_elems;
2582 dest->pcm_elems = src_v4->pcm_elems;
2583 dest->dai_link_elems = src_v4->dai_link_elems;
2584 dest->priv.size = src_v4->priv.size;
2585 if (dest->priv.size)
2586 memcpy(dest->priv.data, src_v4->priv.data,
2587 le32_to_cpu(src_v4->priv.size));
2593 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2594 struct snd_soc_tplg_hdr *hdr)
2596 struct snd_soc_tplg_manifest *manifest, *_manifest;
2600 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2602 /* check ABI version by size, create a new manifest if abi not match */
2603 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2605 _manifest = manifest;
2608 ret = manifest_new_ver(tplg, manifest, &_manifest);
2613 /* pass control to component driver for optional further init */
2614 if (tplg->ops && tplg->ops->manifest)
2615 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2617 if (!abi_match) /* free the duplicated one */
2623 /* validate header magic, size and type */
2624 static int soc_valid_header(struct soc_tplg *tplg,
2625 struct snd_soc_tplg_hdr *hdr)
2627 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2630 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2632 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2633 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2638 /* big endian firmware objects not supported atm */
2639 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2641 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2642 tplg->pass, hdr->magic,
2643 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2647 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2649 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2650 tplg->pass, hdr->magic,
2651 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2655 /* Support ABI from version 4 */
2656 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2657 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2659 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2660 tplg->pass, hdr->abi,
2661 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2666 if (hdr->payload_size == 0) {
2667 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2668 soc_tplg_get_hdr_offset(tplg));
2675 /* check header type and call appropriate handler */
2676 static int soc_tplg_load_header(struct soc_tplg *tplg,
2677 struct snd_soc_tplg_hdr *hdr)
2679 int (*elem_load)(struct soc_tplg *tplg,
2680 struct snd_soc_tplg_hdr *hdr);
2681 unsigned int hdr_pass;
2683 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2685 /* check for matching ID */
2686 if (le32_to_cpu(hdr->index) != tplg->req_index &&
2687 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2690 tplg->index = le32_to_cpu(hdr->index);
2692 switch (le32_to_cpu(hdr->type)) {
2693 case SND_SOC_TPLG_TYPE_MIXER:
2694 case SND_SOC_TPLG_TYPE_ENUM:
2695 case SND_SOC_TPLG_TYPE_BYTES:
2696 hdr_pass = SOC_TPLG_PASS_MIXER;
2697 elem_load = soc_tplg_kcontrol_elems_load;
2699 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2700 hdr_pass = SOC_TPLG_PASS_GRAPH;
2701 elem_load = soc_tplg_dapm_graph_elems_load;
2703 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2704 hdr_pass = SOC_TPLG_PASS_WIDGET;
2705 elem_load = soc_tplg_dapm_widget_elems_load;
2707 case SND_SOC_TPLG_TYPE_PCM:
2708 hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2709 elem_load = soc_tplg_pcm_elems_load;
2711 case SND_SOC_TPLG_TYPE_DAI:
2712 hdr_pass = SOC_TPLG_PASS_BE_DAI;
2713 elem_load = soc_tplg_dai_elems_load;
2715 case SND_SOC_TPLG_TYPE_DAI_LINK:
2716 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2717 /* physical link configurations */
2718 hdr_pass = SOC_TPLG_PASS_LINK;
2719 elem_load = soc_tplg_link_elems_load;
2721 case SND_SOC_TPLG_TYPE_MANIFEST:
2722 hdr_pass = SOC_TPLG_PASS_MANIFEST;
2723 elem_load = soc_tplg_manifest_load;
2726 /* bespoke vendor data object */
2727 hdr_pass = SOC_TPLG_PASS_VENDOR;
2728 elem_load = soc_tplg_vendor_load;
2732 if (tplg->pass == hdr_pass) {
2734 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2735 hdr->payload_size, hdr->type, hdr->version,
2736 hdr->vendor_type, tplg->pass);
2737 return elem_load(tplg, hdr);
2743 /* process the topology file headers */
2744 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2746 struct snd_soc_tplg_hdr *hdr;
2749 tplg->pass = SOC_TPLG_PASS_START;
2751 /* process the header types from start to end */
2752 while (tplg->pass <= SOC_TPLG_PASS_END) {
2754 tplg->hdr_pos = tplg->fw->data;
2755 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2757 while (!soc_tplg_is_eof(tplg)) {
2759 /* make sure header is valid before loading */
2760 ret = soc_valid_header(tplg, hdr);
2763 "ASoC: topology: invalid header: %d\n", ret);
2765 } else if (ret == 0) {
2769 /* load the header object */
2770 ret = soc_tplg_load_header(tplg, hdr);
2773 "ASoC: topology: could not load header: %d\n", ret);
2777 /* goto next header */
2778 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2779 sizeof(struct snd_soc_tplg_hdr);
2780 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2783 /* next data type pass */
2787 /* signal DAPM we are complete */
2788 ret = soc_tplg_dapm_complete(tplg);
2791 "ASoC: failed to initialise DAPM from Firmware\n");
2796 static int soc_tplg_load(struct soc_tplg *tplg)
2800 ret = soc_tplg_process_headers(tplg);
2802 soc_tplg_complete(tplg);
2807 /* load audio component topology from "firmware" file */
2808 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2809 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2811 struct soc_tplg tplg;
2814 /* component needs to exist to keep and reference data while parsing */
2818 /* setup parsing context */
2819 memset(&tplg, 0, sizeof(tplg));
2821 tplg.dev = comp->dev;
2824 tplg.req_index = id;
2825 tplg.io_ops = ops->io_ops;
2826 tplg.io_ops_count = ops->io_ops_count;
2827 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2828 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2830 ret = soc_tplg_load(&tplg);
2831 /* free the created components if fail to load topology */
2833 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2837 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2839 /* remove this dynamic widget */
2840 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2842 /* make sure we are a widget */
2843 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2846 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2848 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2850 /* remove all dynamic widgets from this DAPM context */
2851 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2854 struct snd_soc_dapm_widget *w, *next_w;
2856 for_each_card_widgets_safe(dapm->card, w, next_w) {
2858 /* make sure we are a widget with correct context */
2859 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2863 if (w->dobj.index != index &&
2864 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2866 /* check and free and dynamic widget kcontrols */
2867 snd_soc_tplg_widget_remove(w);
2868 snd_soc_dapm_free_widget(w);
2870 snd_soc_dapm_reset_cache(dapm);
2872 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2874 /* remove dynamic controls from the component driver */
2875 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2877 struct snd_card *card = comp->card->snd_card;
2878 struct snd_soc_dobj *dobj, *next_dobj;
2879 int pass = SOC_TPLG_PASS_END;
2881 /* process the header types from end to start */
2882 while (pass >= SOC_TPLG_PASS_START) {
2884 /* remove mixer controls */
2885 down_write(&card->controls_rwsem);
2886 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2890 if (dobj->index != index &&
2891 index != SND_SOC_TPLG_INDEX_ALL)
2894 switch (dobj->type) {
2895 case SND_SOC_DOBJ_MIXER:
2896 remove_mixer(comp, dobj, pass);
2898 case SND_SOC_DOBJ_ENUM:
2899 remove_enum(comp, dobj, pass);
2901 case SND_SOC_DOBJ_BYTES:
2902 remove_bytes(comp, dobj, pass);
2904 case SND_SOC_DOBJ_GRAPH:
2905 remove_route(comp, dobj, pass);
2907 case SND_SOC_DOBJ_WIDGET:
2908 remove_widget(comp, dobj, pass);
2910 case SND_SOC_DOBJ_PCM:
2911 remove_dai(comp, dobj, pass);
2913 case SND_SOC_DOBJ_DAI_LINK:
2914 remove_link(comp, dobj, pass);
2916 case SND_SOC_DOBJ_BACKEND_LINK:
2918 * call link_unload ops if extra
2919 * deinitialization is needed.
2921 remove_backend_link(comp, dobj, pass);
2924 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2929 up_write(&card->controls_rwsem);
2933 /* let caller know if FW can be freed when no objects are left */
2934 return !list_empty(&comp->dobj_list);
2936 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);