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;
595 ext_ops = tplg->bytes_ext_ops;
596 num_ops = tplg->bytes_ext_ops_count;
597 for (i = 0; i < num_ops; i++) {
599 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
600 sbe->put = ext_ops[i].put;
602 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
603 sbe->get = ext_ops[i].get;
606 if (sbe->put && sbe->get)
612 /* try and map vendor specific kcontrol handlers first */
614 num_ops = tplg->io_ops_count;
615 for (i = 0; i < num_ops; i++) {
617 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
619 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
621 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
622 k->info = ops[i].info;
625 /* vendor specific handlers found ? */
626 if (k->put && k->get && k->info)
629 /* none found so try standard kcontrol handlers */
631 num_ops = ARRAY_SIZE(io_ops);
632 for (i = 0; i < num_ops; i++) {
634 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
636 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
638 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
639 k->info = ops[i].info;
642 /* standard handlers found ? */
643 if (k->put && k->get && k->info)
646 /* nothing to bind */
650 /* bind a widgets to it's evnt handlers */
651 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
652 const struct snd_soc_tplg_widget_events *events,
653 int num_events, u16 event_type)
659 for (i = 0; i < num_events; i++) {
660 if (event_type == events[i].type) {
662 /* found - so assign event */
663 w->event = events[i].event_handler;
671 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
673 /* optionally pass new dynamic kcontrol to component driver. */
674 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
675 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
677 if (tplg->ops && tplg->ops->control_load)
678 return tplg->ops->control_load(tplg->comp, tplg->index, k,
685 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
686 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
688 unsigned int item_len = 2 * sizeof(unsigned int);
691 p = kzalloc(item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
695 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
697 p[2] = le32_to_cpu(scale->min);
698 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
699 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
701 kc->tlv.p = (void *)p;
705 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
706 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
708 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
709 u32 access = le32_to_cpu(tc->access);
711 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
714 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
716 switch (le32_to_cpu(tplg_tlv->type)) {
717 case SNDRV_CTL_TLVT_DB_SCALE:
718 return soc_tplg_create_tlv_db_scale(tplg, kc,
721 /* TODO: add support for other TLV types */
723 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
732 static inline void soc_tplg_free_tlv(struct soc_tplg *tplg,
733 struct snd_kcontrol_new *kc)
738 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
741 struct snd_soc_tplg_bytes_control *be;
742 struct soc_bytes_ext *sbe;
743 struct snd_kcontrol_new kc;
747 if (soc_tplg_check_elem_count(tplg,
748 sizeof(struct snd_soc_tplg_bytes_control), count,
749 size, "mixer bytes")) {
750 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
755 for (i = 0; i < count; i++) {
756 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
758 /* validate kcontrol */
759 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
760 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
763 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
767 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
768 le32_to_cpu(be->priv.size));
771 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
772 be->hdr.name, be->hdr.access);
774 memset(&kc, 0, sizeof(kc));
775 kc.name = be->hdr.name;
776 kc.private_value = (long)sbe;
777 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
778 kc.access = le32_to_cpu(be->hdr.access);
780 sbe->max = le32_to_cpu(be->max);
781 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
782 sbe->dobj.ops = tplg->ops;
783 INIT_LIST_HEAD(&sbe->dobj.list);
785 /* map io handlers */
786 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
788 soc_control_err(tplg, &be->hdr, be->hdr.name);
793 /* pass control to driver for optional further init */
794 err = soc_tplg_init_kcontrol(tplg, &kc,
795 (struct snd_soc_tplg_ctl_hdr *)be);
797 dev_err(tplg->dev, "ASoC: failed to init %s\n",
803 /* register control here */
804 err = soc_tplg_add_kcontrol(tplg, &kc,
805 &sbe->dobj.control.kcontrol);
807 dev_err(tplg->dev, "ASoC: failed to add %s\n",
813 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
819 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
822 struct snd_soc_tplg_mixer_control *mc;
823 struct soc_mixer_control *sm;
824 struct snd_kcontrol_new kc;
828 if (soc_tplg_check_elem_count(tplg,
829 sizeof(struct snd_soc_tplg_mixer_control),
830 count, size, "mixers")) {
832 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
837 for (i = 0; i < count; i++) {
838 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
840 /* validate kcontrol */
841 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
842 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
845 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
848 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
849 le32_to_cpu(mc->priv.size));
852 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
853 mc->hdr.name, mc->hdr.access);
855 memset(&kc, 0, sizeof(kc));
856 kc.name = mc->hdr.name;
857 kc.private_value = (long)sm;
858 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
859 kc.access = le32_to_cpu(mc->hdr.access);
861 /* we only support FL/FR channel mapping atm */
862 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
864 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
866 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
868 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
871 sm->max = le32_to_cpu(mc->max);
872 sm->min = le32_to_cpu(mc->min);
873 sm->invert = le32_to_cpu(mc->invert);
874 sm->platform_max = le32_to_cpu(mc->platform_max);
875 sm->dobj.index = tplg->index;
876 sm->dobj.ops = tplg->ops;
877 sm->dobj.type = SND_SOC_DOBJ_MIXER;
878 INIT_LIST_HEAD(&sm->dobj.list);
880 /* map io handlers */
881 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
883 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
888 /* create any TLV data */
889 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
891 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
897 /* pass control to driver for optional further init */
898 err = soc_tplg_init_kcontrol(tplg, &kc,
899 (struct snd_soc_tplg_ctl_hdr *) mc);
901 dev_err(tplg->dev, "ASoC: failed to init %s\n",
903 soc_tplg_free_tlv(tplg, &kc);
908 /* register control here */
909 err = soc_tplg_add_kcontrol(tplg, &kc,
910 &sm->dobj.control.kcontrol);
912 dev_err(tplg->dev, "ASoC: failed to add %s\n",
914 soc_tplg_free_tlv(tplg, &kc);
919 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
925 static int soc_tplg_denum_create_texts(struct soc_enum *se,
926 struct snd_soc_tplg_enum_control *ec)
930 se->dobj.control.dtexts =
931 kcalloc(le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
932 if (se->dobj.control.dtexts == NULL)
935 for (i = 0; i < le32_to_cpu(ec->items); i++) {
937 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
938 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
943 se->dobj.control.dtexts[i] = kstrdup(ec->texts[i], GFP_KERNEL);
944 if (!se->dobj.control.dtexts[i]) {
950 se->items = le32_to_cpu(ec->items);
951 se->texts = (const char * const *)se->dobj.control.dtexts;
956 soc_tplg_denum_remove_texts(se);
960 static inline void soc_tplg_denum_remove_texts(struct soc_enum *se)
964 for (--i; i >= 0; i--)
965 kfree(se->dobj.control.dtexts[i]);
966 kfree(se->dobj.control.dtexts);
969 static int soc_tplg_denum_create_values(struct soc_enum *se,
970 struct snd_soc_tplg_enum_control *ec)
974 if (le32_to_cpu(ec->items) > sizeof(*ec->values))
977 se->dobj.control.dvalues = kzalloc(le32_to_cpu(ec->items) *
980 if (!se->dobj.control.dvalues)
983 /* convert from little-endian */
984 for (i = 0; i < le32_to_cpu(ec->items); i++) {
985 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
991 static inline void soc_tplg_denum_remove_values(struct soc_enum *se)
993 kfree(se->dobj.control.dvalues);
996 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
999 struct snd_soc_tplg_enum_control *ec;
1000 struct soc_enum *se;
1001 struct snd_kcontrol_new kc;
1005 if (soc_tplg_check_elem_count(tplg,
1006 sizeof(struct snd_soc_tplg_enum_control),
1007 count, size, "enums")) {
1009 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
1014 for (i = 0; i < count; i++) {
1015 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1017 /* validate kcontrol */
1018 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1019 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1022 se = kzalloc((sizeof(*se)), GFP_KERNEL);
1026 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1027 le32_to_cpu(ec->priv.size));
1029 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
1030 ec->hdr.name, ec->items);
1032 memset(&kc, 0, sizeof(kc));
1033 kc.name = ec->hdr.name;
1034 kc.private_value = (long)se;
1035 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1036 kc.access = le32_to_cpu(ec->hdr.access);
1038 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1039 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1041 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1044 se->mask = le32_to_cpu(ec->mask);
1045 se->dobj.index = tplg->index;
1046 se->dobj.type = SND_SOC_DOBJ_ENUM;
1047 se->dobj.ops = tplg->ops;
1048 INIT_LIST_HEAD(&se->dobj.list);
1050 switch (le32_to_cpu(ec->hdr.ops.info)) {
1051 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1052 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1053 err = soc_tplg_denum_create_values(se, ec);
1056 "ASoC: could not create values for %s\n",
1061 case SND_SOC_TPLG_CTL_ENUM:
1062 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1063 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1064 err = soc_tplg_denum_create_texts(se, ec);
1067 "ASoC: could not create texts for %s\n",
1075 "ASoC: invalid enum control type %d for %s\n",
1076 ec->hdr.ops.info, ec->hdr.name);
1080 /* map io handlers */
1081 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1083 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1087 /* pass control to driver for optional further init */
1088 err = soc_tplg_init_kcontrol(tplg, &kc,
1089 (struct snd_soc_tplg_ctl_hdr *) ec);
1091 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1096 /* register control here */
1097 err = soc_tplg_add_kcontrol(tplg,
1098 &kc, &se->dobj.control.kcontrol);
1100 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1105 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1114 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1115 struct snd_soc_tplg_hdr *hdr)
1117 struct snd_soc_tplg_ctl_hdr *control_hdr;
1121 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1122 soc_tplg_get_offset(tplg));
1124 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1126 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1128 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1129 dev_err(tplg->dev, "ASoC: invalid control size\n");
1133 switch (le32_to_cpu(control_hdr->ops.info)) {
1134 case SND_SOC_TPLG_CTL_VOLSW:
1135 case SND_SOC_TPLG_CTL_STROBE:
1136 case SND_SOC_TPLG_CTL_VOLSW_SX:
1137 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1138 case SND_SOC_TPLG_CTL_RANGE:
1139 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1140 case SND_SOC_TPLG_DAPM_CTL_PIN:
1141 ret = soc_tplg_dmixer_create(tplg, 1,
1142 le32_to_cpu(hdr->payload_size));
1144 case SND_SOC_TPLG_CTL_ENUM:
1145 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1146 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1147 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1148 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1149 ret = soc_tplg_denum_create(tplg, 1,
1150 le32_to_cpu(hdr->payload_size));
1152 case SND_SOC_TPLG_CTL_BYTES:
1153 ret = soc_tplg_dbytes_create(tplg, 1,
1154 le32_to_cpu(hdr->payload_size));
1157 soc_bind_err(tplg, control_hdr, i);
1161 dev_err(tplg->dev, "ASoC: invalid control\n");
1170 /* optionally pass new dynamic kcontrol to component driver. */
1171 static int soc_tplg_add_route(struct soc_tplg *tplg,
1172 struct snd_soc_dapm_route *route)
1174 if (tplg->ops && tplg->ops->dapm_route_load)
1175 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1181 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1182 struct snd_soc_tplg_hdr *hdr)
1184 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1185 struct snd_soc_tplg_dapm_graph_elem *elem;
1186 struct snd_soc_dapm_route **routes;
1190 count = le32_to_cpu(hdr->count);
1192 if (soc_tplg_check_elem_count(tplg,
1193 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1194 count, le32_to_cpu(hdr->payload_size), "graph")) {
1196 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1201 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1204 /* allocate memory for pointer to array of dapm routes */
1205 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1211 * allocate memory for each dapm route in the array.
1212 * This needs to be done individually so that
1213 * each route can be freed when it is removed in remove_route().
1215 for (i = 0; i < count; i++) {
1216 routes[i] = kzalloc(sizeof(*routes[i]), GFP_KERNEL);
1218 /* free previously allocated memory */
1219 for (j = 0; j < i; j++)
1227 for (i = 0; i < count; i++) {
1228 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1229 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1231 /* validate routes */
1232 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1233 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1237 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1238 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1242 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1243 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1248 routes[i]->source = elem->source;
1249 routes[i]->sink = elem->sink;
1251 /* set to NULL atm for tplg users */
1252 routes[i]->connected = NULL;
1253 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1254 routes[i]->control = NULL;
1256 routes[i]->control = elem->control;
1258 /* add route dobj to dobj_list */
1259 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1260 routes[i]->dobj.ops = tplg->ops;
1261 routes[i]->dobj.index = tplg->index;
1262 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1264 ret = soc_tplg_add_route(tplg, routes[i]);
1266 dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1268 * this route was added to the list, it will
1269 * be freed in remove_route() so increment the
1270 * counter to skip it in the error handling
1277 /* add route, but keep going if some fail */
1278 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1282 * free memory allocated for all dapm routes not added to the
1283 * list in case of error
1291 * free pointer to array of dapm routes as this is no longer needed.
1292 * The memory allocated for each dapm route will be freed
1293 * when it is removed in remove_route().
1300 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1301 struct soc_tplg *tplg, int num_kcontrols)
1303 struct snd_kcontrol_new *kc;
1304 struct soc_mixer_control *sm;
1305 struct snd_soc_tplg_mixer_control *mc;
1308 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1312 for (i = 0; i < num_kcontrols; i++) {
1313 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1315 /* validate kcontrol */
1316 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1317 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1320 sm = kzalloc(sizeof(*sm), GFP_KERNEL);
1324 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1325 le32_to_cpu(mc->priv.size));
1327 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1330 kc[i].private_value = (long)sm;
1331 kc[i].name = kstrdup(mc->hdr.name, GFP_KERNEL);
1332 if (kc[i].name == NULL)
1334 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1335 kc[i].access = le32_to_cpu(mc->hdr.access);
1337 /* we only support FL/FR channel mapping atm */
1338 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1340 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1342 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1344 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1347 sm->max = le32_to_cpu(mc->max);
1348 sm->min = le32_to_cpu(mc->min);
1349 sm->invert = le32_to_cpu(mc->invert);
1350 sm->platform_max = le32_to_cpu(mc->platform_max);
1351 sm->dobj.index = tplg->index;
1352 INIT_LIST_HEAD(&sm->dobj.list);
1354 /* map io handlers */
1355 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1357 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1361 /* create any TLV data */
1362 err = soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1364 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1369 /* pass control to driver for optional further init */
1370 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1371 (struct snd_soc_tplg_ctl_hdr *)mc);
1373 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1381 for (; i >= 0; i--) {
1382 soc_tplg_free_tlv(tplg, &kc[i]);
1383 sm = (struct soc_mixer_control *)kc[i].private_value;
1392 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1393 struct soc_tplg *tplg, int num_kcontrols)
1395 struct snd_kcontrol_new *kc;
1396 struct snd_soc_tplg_enum_control *ec;
1397 struct soc_enum *se;
1400 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1404 for (i = 0; i < num_kcontrols; i++) {
1405 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1406 /* validate kcontrol */
1407 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1408 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1411 se = kzalloc(sizeof(*se), GFP_KERNEL);
1415 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1416 le32_to_cpu(ec->priv.size));
1418 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1421 kc[i].private_value = (long)se;
1422 kc[i].name = kstrdup(ec->hdr.name, GFP_KERNEL);
1423 if (kc[i].name == NULL)
1425 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1426 kc[i].access = le32_to_cpu(ec->hdr.access);
1428 /* we only support FL/FR channel mapping atm */
1429 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1430 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1432 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1435 se->items = le32_to_cpu(ec->items);
1436 se->mask = le32_to_cpu(ec->mask);
1437 se->dobj.index = tplg->index;
1439 switch (le32_to_cpu(ec->hdr.ops.info)) {
1440 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1441 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1442 err = soc_tplg_denum_create_values(se, ec);
1444 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1449 case SND_SOC_TPLG_CTL_ENUM:
1450 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1451 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1452 err = soc_tplg_denum_create_texts(se, ec);
1454 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1460 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1461 ec->hdr.ops.info, ec->hdr.name);
1465 /* map io handlers */
1466 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1468 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1472 /* pass control to driver for optional further init */
1473 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1474 (struct snd_soc_tplg_ctl_hdr *)ec);
1476 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1485 for (; i >= 0; i--) {
1486 /* free values and texts */
1487 se = (struct soc_enum *)kc[i].private_value;
1490 soc_tplg_denum_remove_values(se);
1491 soc_tplg_denum_remove_texts(se);
1502 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1503 struct soc_tplg *tplg, int num_kcontrols)
1505 struct snd_soc_tplg_bytes_control *be;
1506 struct soc_bytes_ext *sbe;
1507 struct snd_kcontrol_new *kc;
1510 kc = kcalloc(num_kcontrols, sizeof(*kc), GFP_KERNEL);
1514 for (i = 0; i < num_kcontrols; i++) {
1515 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1517 /* validate kcontrol */
1518 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1519 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1522 sbe = kzalloc(sizeof(*sbe), GFP_KERNEL);
1526 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1527 le32_to_cpu(be->priv.size));
1530 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1531 be->hdr.name, be->hdr.access);
1533 kc[i].private_value = (long)sbe;
1534 kc[i].name = kstrdup(be->hdr.name, GFP_KERNEL);
1535 if (kc[i].name == NULL)
1537 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1538 kc[i].access = le32_to_cpu(be->hdr.access);
1540 sbe->max = le32_to_cpu(be->max);
1541 INIT_LIST_HEAD(&sbe->dobj.list);
1543 /* map standard io handlers and check for external handlers */
1544 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1546 soc_control_err(tplg, &be->hdr, be->hdr.name);
1550 /* pass control to driver for optional further init */
1551 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1552 (struct snd_soc_tplg_ctl_hdr *)be);
1554 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1563 for (; i >= 0; i--) {
1564 sbe = (struct soc_bytes_ext *)kc[i].private_value;
1573 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1574 struct snd_soc_tplg_dapm_widget *w)
1576 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1577 struct snd_soc_dapm_widget template, *widget;
1578 struct snd_soc_tplg_ctl_hdr *control_hdr;
1579 struct snd_soc_card *card = tplg->comp->card;
1580 unsigned int kcontrol_type;
1583 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1584 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1586 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1587 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1590 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1593 memset(&template, 0, sizeof(template));
1595 /* map user to kernel widget ID */
1596 template.id = get_widget_id(le32_to_cpu(w->id));
1597 if ((int)template.id < 0)
1600 /* strings are allocated here, but used and freed by the widget */
1601 template.name = kstrdup(w->name, GFP_KERNEL);
1604 template.sname = kstrdup(w->sname, GFP_KERNEL);
1605 if (!template.sname) {
1609 template.reg = le32_to_cpu(w->reg);
1610 template.shift = le32_to_cpu(w->shift);
1611 template.mask = le32_to_cpu(w->mask);
1612 template.subseq = le32_to_cpu(w->subseq);
1613 template.on_val = w->invert ? 0 : 1;
1614 template.off_val = w->invert ? 1 : 0;
1615 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1616 template.event_flags = le16_to_cpu(w->event_flags);
1617 template.dobj.index = tplg->index;
1620 (sizeof(struct snd_soc_tplg_dapm_widget) +
1621 le32_to_cpu(w->priv.size));
1623 if (w->num_kcontrols == 0) {
1625 template.num_kcontrols = 0;
1629 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1630 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1631 w->name, w->num_kcontrols, control_hdr->type);
1633 switch (le32_to_cpu(control_hdr->ops.info)) {
1634 case SND_SOC_TPLG_CTL_VOLSW:
1635 case SND_SOC_TPLG_CTL_STROBE:
1636 case SND_SOC_TPLG_CTL_VOLSW_SX:
1637 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1638 case SND_SOC_TPLG_CTL_RANGE:
1639 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1640 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER; /* volume mixer */
1641 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1642 template.kcontrol_news =
1643 soc_tplg_dapm_widget_dmixer_create(tplg,
1644 template.num_kcontrols);
1645 if (!template.kcontrol_news) {
1650 case SND_SOC_TPLG_CTL_ENUM:
1651 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1652 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1653 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1654 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1655 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1656 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1657 template.kcontrol_news =
1658 soc_tplg_dapm_widget_denum_create(tplg,
1659 template.num_kcontrols);
1660 if (!template.kcontrol_news) {
1665 case SND_SOC_TPLG_CTL_BYTES:
1666 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1667 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1668 template.kcontrol_news =
1669 soc_tplg_dapm_widget_dbytes_create(tplg,
1670 template.num_kcontrols);
1671 if (!template.kcontrol_news) {
1677 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1678 control_hdr->ops.get, control_hdr->ops.put,
1679 le32_to_cpu(control_hdr->ops.info));
1685 ret = soc_tplg_widget_load(tplg, &template, w);
1689 /* card dapm mutex is held by the core if we are loading topology
1690 * data during sound card init. */
1691 if (card->instantiated)
1692 widget = snd_soc_dapm_new_control(dapm, &template);
1694 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1695 if (IS_ERR(widget)) {
1696 ret = PTR_ERR(widget);
1700 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1701 widget->dobj.widget.kcontrol_type = kcontrol_type;
1702 widget->dobj.ops = tplg->ops;
1703 widget->dobj.index = tplg->index;
1704 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1706 ret = soc_tplg_widget_ready(tplg, widget, w);
1710 kfree(template.sname);
1711 kfree(template.name);
1716 snd_soc_tplg_widget_remove(widget);
1717 snd_soc_dapm_free_widget(widget);
1719 kfree(template.sname);
1721 kfree(template.name);
1725 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1726 struct snd_soc_tplg_hdr *hdr)
1728 struct snd_soc_tplg_dapm_widget *widget;
1731 count = le32_to_cpu(hdr->count);
1733 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1735 for (i = 0; i < count; i++) {
1736 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1737 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1738 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1742 ret = soc_tplg_dapm_widget_create(tplg, widget);
1744 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1753 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1755 struct snd_soc_card *card = tplg->comp->card;
1758 /* Card might not have been registered at this point.
1759 * If so, just return success.
1761 if (!card || !card->instantiated) {
1762 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1763 " widget card binding deferred\n");
1767 ret = snd_soc_dapm_new_widgets(card);
1769 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1775 static int set_stream_info(struct snd_soc_pcm_stream *stream,
1776 struct snd_soc_tplg_stream_caps *caps)
1778 stream->stream_name = kstrdup(caps->name, GFP_KERNEL);
1779 if (!stream->stream_name)
1782 stream->channels_min = le32_to_cpu(caps->channels_min);
1783 stream->channels_max = le32_to_cpu(caps->channels_max);
1784 stream->rates = le32_to_cpu(caps->rates);
1785 stream->rate_min = le32_to_cpu(caps->rate_min);
1786 stream->rate_max = le32_to_cpu(caps->rate_max);
1787 stream->formats = le64_to_cpu(caps->formats);
1788 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1793 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1794 unsigned int flag_mask, unsigned int flags)
1796 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1797 dai_drv->symmetric_rates =
1798 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1800 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1801 dai_drv->symmetric_channels =
1802 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1805 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1806 dai_drv->symmetric_samplebits =
1807 flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1811 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1812 struct snd_soc_tplg_pcm *pcm)
1814 struct snd_soc_dai_driver *dai_drv;
1815 struct snd_soc_pcm_stream *stream;
1816 struct snd_soc_tplg_stream_caps *caps;
1817 struct snd_soc_dai *dai;
1818 struct snd_soc_dapm_context *dapm =
1819 snd_soc_component_get_dapm(tplg->comp);
1822 dai_drv = kzalloc(sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1823 if (dai_drv == NULL)
1826 if (strlen(pcm->dai_name)) {
1827 dai_drv->name = kstrdup(pcm->dai_name, GFP_KERNEL);
1828 if (!dai_drv->name) {
1833 dai_drv->id = le32_to_cpu(pcm->dai_id);
1835 if (pcm->playback) {
1836 stream = &dai_drv->playback;
1837 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1838 ret = set_stream_info(stream, caps);
1844 stream = &dai_drv->capture;
1845 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1846 ret = set_stream_info(stream, caps);
1852 dai_drv->compress_new = snd_soc_new_compress;
1854 /* pass control to component driver for optional further init */
1855 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1857 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
1861 dai_drv->dobj.index = tplg->index;
1862 dai_drv->dobj.ops = tplg->ops;
1863 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1864 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1866 /* register the DAI to the component */
1867 dai = devm_snd_soc_register_dai(tplg->comp->dev, tplg->comp, dai_drv, false);
1871 /* Create the DAI widgets here */
1872 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1874 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1881 kfree(dai_drv->playback.stream_name);
1882 kfree(dai_drv->capture.stream_name);
1883 kfree(dai_drv->name);
1889 static void set_link_flags(struct snd_soc_dai_link *link,
1890 unsigned int flag_mask, unsigned int flags)
1892 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1893 link->symmetric_rates =
1894 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1896 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1897 link->symmetric_channels =
1898 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1901 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1902 link->symmetric_samplebits =
1903 flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1906 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1907 link->ignore_suspend =
1908 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1912 /* create the FE DAI link */
1913 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1914 struct snd_soc_tplg_pcm *pcm)
1916 struct snd_soc_dai_link *link;
1917 struct snd_soc_dai_link_component *dlc;
1920 /* link + cpu + codec + platform */
1921 link = kzalloc(sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1925 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1927 link->cpus = &dlc[0];
1928 link->codecs = &dlc[1];
1929 link->platforms = &dlc[2];
1932 link->num_codecs = 1;
1933 link->num_platforms = 1;
1935 link->dobj.index = tplg->index;
1936 link->dobj.ops = tplg->ops;
1937 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1939 if (strlen(pcm->pcm_name)) {
1940 link->name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1941 link->stream_name = kstrdup(pcm->pcm_name, GFP_KERNEL);
1942 if (!link->name || !link->stream_name) {
1947 link->id = le32_to_cpu(pcm->pcm_id);
1949 if (strlen(pcm->dai_name)) {
1950 link->cpus->dai_name = kstrdup(pcm->dai_name, GFP_KERNEL);
1951 if (!link->cpus->dai_name) {
1957 link->codecs->name = "snd-soc-dummy";
1958 link->codecs->dai_name = "snd-soc-dummy-dai";
1960 link->platforms->name = "snd-soc-dummy";
1964 link->dpcm_playback = le32_to_cpu(pcm->playback);
1965 link->dpcm_capture = le32_to_cpu(pcm->capture);
1967 set_link_flags(link,
1968 le32_to_cpu(pcm->flag_mask),
1969 le32_to_cpu(pcm->flags));
1971 /* pass control to component driver for optional further init */
1972 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1974 dev_err(tplg->comp->dev, "ASoC: FE link loading failed\n");
1978 ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1980 dev_err(tplg->comp->dev, "ASoC: adding FE link failed\n");
1984 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1989 kfree(link->stream_name);
1990 kfree(link->cpus->dai_name);
1995 /* create a FE DAI and DAI link from the PCM object */
1996 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1997 struct snd_soc_tplg_pcm *pcm)
2001 ret = soc_tplg_dai_create(tplg, pcm);
2005 return soc_tplg_fe_link_create(tplg, pcm);
2008 /* copy stream caps from the old version 4 of source */
2009 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
2010 struct snd_soc_tplg_stream_caps_v4 *src)
2012 dest->size = cpu_to_le32(sizeof(*dest));
2013 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2014 dest->formats = src->formats;
2015 dest->rates = src->rates;
2016 dest->rate_min = src->rate_min;
2017 dest->rate_max = src->rate_max;
2018 dest->channels_min = src->channels_min;
2019 dest->channels_max = src->channels_max;
2020 dest->periods_min = src->periods_min;
2021 dest->periods_max = src->periods_max;
2022 dest->period_size_min = src->period_size_min;
2023 dest->period_size_max = src->period_size_max;
2024 dest->buffer_size_min = src->buffer_size_min;
2025 dest->buffer_size_max = src->buffer_size_max;
2029 * pcm_new_ver - Create the new version of PCM from the old version.
2030 * @tplg: topology context
2031 * @src: older version of pcm as a source
2032 * @pcm: latest version of pcm created from the source
2034 * Support from vesion 4. User should free the returned pcm manually.
2036 static int pcm_new_ver(struct soc_tplg *tplg,
2037 struct snd_soc_tplg_pcm *src,
2038 struct snd_soc_tplg_pcm **pcm)
2040 struct snd_soc_tplg_pcm *dest;
2041 struct snd_soc_tplg_pcm_v4 *src_v4;
2046 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
2047 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
2051 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
2052 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
2053 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2057 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2058 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2059 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2060 dest->pcm_id = src_v4->pcm_id;
2061 dest->dai_id = src_v4->dai_id;
2062 dest->playback = src_v4->playback;
2063 dest->capture = src_v4->capture;
2064 dest->compress = src_v4->compress;
2065 dest->num_streams = src_v4->num_streams;
2066 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2067 memcpy(&dest->stream[i], &src_v4->stream[i],
2068 sizeof(struct snd_soc_tplg_stream));
2070 for (i = 0; i < 2; i++)
2071 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
2077 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
2078 struct snd_soc_tplg_hdr *hdr)
2080 struct snd_soc_tplg_pcm *pcm, *_pcm;
2087 count = le32_to_cpu(hdr->count);
2089 /* check the element size and count */
2090 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2091 size = le32_to_cpu(pcm->size);
2092 if (size > sizeof(struct snd_soc_tplg_pcm)
2093 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
2094 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
2099 if (soc_tplg_check_elem_count(tplg,
2101 le32_to_cpu(hdr->payload_size),
2103 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
2108 for (i = 0; i < count; i++) {
2109 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
2110 size = le32_to_cpu(pcm->size);
2112 /* check ABI version by size, create a new version of pcm
2115 if (size == sizeof(*pcm)) {
2120 ret = pcm_new_ver(tplg, pcm, &_pcm);
2125 /* create the FE DAIs and DAI links */
2126 ret = soc_tplg_pcm_create(tplg, _pcm);
2133 /* offset by version-specific struct size and
2134 * real priv data size
2136 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
2139 kfree(_pcm); /* free the duplicated one */
2142 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2148 * set_link_hw_format - Set the HW audio format of the physical DAI link.
2149 * @link: &snd_soc_dai_link which should be updated
2150 * @cfg: physical link configs.
2152 * Topology context contains a list of supported HW formats (configs) and
2153 * a default format ID for the physical link. This function will use this
2154 * default ID to choose the HW format to set the link's DAI format for init.
2156 static void set_link_hw_format(struct snd_soc_dai_link *link,
2157 struct snd_soc_tplg_link_config *cfg)
2159 struct snd_soc_tplg_hw_config *hw_config;
2160 unsigned char bclk_master, fsync_master;
2161 unsigned char invert_bclk, invert_fsync;
2164 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2165 hw_config = &cfg->hw_config[i];
2166 if (hw_config->id != cfg->default_hw_config_id)
2169 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2170 SND_SOC_DAIFMT_FORMAT_MASK;
2173 switch (hw_config->clock_gated) {
2174 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2175 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2178 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2179 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2183 /* ignore the value */
2187 /* clock signal polarity */
2188 invert_bclk = hw_config->invert_bclk;
2189 invert_fsync = hw_config->invert_fsync;
2190 if (!invert_bclk && !invert_fsync)
2191 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2192 else if (!invert_bclk && invert_fsync)
2193 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2194 else if (invert_bclk && !invert_fsync)
2195 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2197 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2200 bclk_master = (hw_config->bclk_master ==
2201 SND_SOC_TPLG_BCLK_CM);
2202 fsync_master = (hw_config->fsync_master ==
2203 SND_SOC_TPLG_FSYNC_CM);
2204 if (bclk_master && fsync_master)
2205 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFM;
2206 else if (!bclk_master && fsync_master)
2207 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFM;
2208 else if (bclk_master && !fsync_master)
2209 link->dai_fmt |= SND_SOC_DAIFMT_CBM_CFS;
2211 link->dai_fmt |= SND_SOC_DAIFMT_CBS_CFS;
2216 * link_new_ver - Create a new physical link config from the old
2217 * version of source.
2218 * @tplg: topology context
2219 * @src: old version of phyical link config as a source
2220 * @link: latest version of physical link config created from the source
2222 * Support from vesion 4. User need free the returned link config manually.
2224 static int link_new_ver(struct soc_tplg *tplg,
2225 struct snd_soc_tplg_link_config *src,
2226 struct snd_soc_tplg_link_config **link)
2228 struct snd_soc_tplg_link_config *dest;
2229 struct snd_soc_tplg_link_config_v4 *src_v4;
2234 if (le32_to_cpu(src->size) !=
2235 sizeof(struct snd_soc_tplg_link_config_v4)) {
2236 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2240 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2242 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2243 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2247 dest->size = cpu_to_le32(sizeof(*dest));
2248 dest->id = src_v4->id;
2249 dest->num_streams = src_v4->num_streams;
2250 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2251 memcpy(&dest->stream[i], &src_v4->stream[i],
2252 sizeof(struct snd_soc_tplg_stream));
2259 * snd_soc_find_dai_link - Find a DAI link
2262 * @id: DAI link ID to match
2263 * @name: DAI link name to match, optional
2264 * @stream_name: DAI link stream name to match, optional
2266 * This function will search all existing DAI links of the soc card to
2267 * find the link of the same ID. Since DAI links may not have their
2268 * unique ID, so name and stream name should also match if being
2271 * Return: pointer of DAI link, or NULL if not found.
2273 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2274 int id, const char *name,
2275 const char *stream_name)
2277 struct snd_soc_pcm_runtime *rtd;
2278 struct snd_soc_dai_link *link;
2280 for_each_card_rtds(card, rtd) {
2281 link = rtd->dai_link;
2286 if (name && (!link->name || strcmp(name, link->name)))
2289 if (stream_name && (!link->stream_name
2290 || strcmp(stream_name, link->stream_name)))
2299 /* Find and configure an existing physical DAI link */
2300 static int soc_tplg_link_config(struct soc_tplg *tplg,
2301 struct snd_soc_tplg_link_config *cfg)
2303 struct snd_soc_dai_link *link;
2304 const char *name, *stream_name;
2308 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2309 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2316 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2317 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2320 stream_name = cfg->stream_name;
2324 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2327 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2333 if (cfg->num_hw_configs)
2334 set_link_hw_format(link, cfg);
2338 set_link_flags(link,
2339 le32_to_cpu(cfg->flag_mask),
2340 le32_to_cpu(cfg->flags));
2342 /* pass control to component driver for optional further init */
2343 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2345 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2349 /* for unloading it in snd_soc_tplg_component_remove */
2350 link->dobj.index = tplg->index;
2351 link->dobj.ops = tplg->ops;
2352 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2353 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2359 /* Load physical link config elements from the topology context */
2360 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2361 struct snd_soc_tplg_hdr *hdr)
2363 struct snd_soc_tplg_link_config *link, *_link;
2369 count = le32_to_cpu(hdr->count);
2371 /* check the element size and count */
2372 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2373 size = le32_to_cpu(link->size);
2374 if (size > sizeof(struct snd_soc_tplg_link_config)
2375 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2376 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2381 if (soc_tplg_check_elem_count(tplg,
2383 le32_to_cpu(hdr->payload_size),
2384 "physical link config")) {
2385 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2390 /* config physical DAI links */
2391 for (i = 0; i < count; i++) {
2392 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2393 size = le32_to_cpu(link->size);
2394 if (size == sizeof(*link)) {
2399 ret = link_new_ver(tplg, link, &_link);
2404 ret = soc_tplg_link_config(tplg, _link);
2411 /* offset by version-specific struct size and
2412 * real priv data size
2414 tplg->pos += size + le32_to_cpu(_link->priv.size);
2417 kfree(_link); /* free the duplicated one */
2424 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2425 * @tplg: topology context
2426 * @d: physical DAI configs.
2428 * The physical dai should already be registered by the platform driver.
2429 * The platform driver should specify the DAI name and ID for matching.
2431 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2432 struct snd_soc_tplg_dai *d)
2434 struct snd_soc_dai_link_component dai_component;
2435 struct snd_soc_dai *dai;
2436 struct snd_soc_dai_driver *dai_drv;
2437 struct snd_soc_pcm_stream *stream;
2438 struct snd_soc_tplg_stream_caps *caps;
2441 memset(&dai_component, 0, sizeof(dai_component));
2443 dai_component.dai_name = d->dai_name;
2444 dai = snd_soc_find_dai(&dai_component);
2446 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2451 if (le32_to_cpu(d->dai_id) != dai->id) {
2452 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2457 dai_drv = dai->driver;
2462 stream = &dai_drv->playback;
2463 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2464 ret = set_stream_info(stream, caps);
2470 stream = &dai_drv->capture;
2471 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2472 ret = set_stream_info(stream, caps);
2478 set_dai_flags(dai_drv,
2479 le32_to_cpu(d->flag_mask),
2480 le32_to_cpu(d->flags));
2482 /* pass control to component driver for optional further init */
2483 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2485 dev_err(tplg->comp->dev, "ASoC: DAI loading failed\n");
2492 kfree(dai_drv->playback.stream_name);
2493 kfree(dai_drv->capture.stream_name);
2497 /* load physical DAI elements */
2498 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2499 struct snd_soc_tplg_hdr *hdr)
2501 struct snd_soc_tplg_dai *dai;
2505 count = le32_to_cpu(hdr->count);
2507 /* config the existing BE DAIs */
2508 for (i = 0; i < count; i++) {
2509 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2510 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2511 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2515 ret = soc_tplg_dai_config(tplg, dai);
2517 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2521 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2524 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2529 * manifest_new_ver - Create a new version of manifest from the old version
2531 * @tplg: topology context
2532 * @src: old version of manifest as a source
2533 * @manifest: latest version of manifest created from the source
2535 * Support from vesion 4. Users need free the returned manifest manually.
2537 static int manifest_new_ver(struct soc_tplg *tplg,
2538 struct snd_soc_tplg_manifest *src,
2539 struct snd_soc_tplg_manifest **manifest)
2541 struct snd_soc_tplg_manifest *dest;
2542 struct snd_soc_tplg_manifest_v4 *src_v4;
2547 size = le32_to_cpu(src->size);
2548 if (size != sizeof(*src_v4)) {
2549 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2553 src->size = cpu_to_le32(sizeof(*src_v4));
2556 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2558 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2559 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2564 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2565 dest->control_elems = src_v4->control_elems;
2566 dest->widget_elems = src_v4->widget_elems;
2567 dest->graph_elems = src_v4->graph_elems;
2568 dest->pcm_elems = src_v4->pcm_elems;
2569 dest->dai_link_elems = src_v4->dai_link_elems;
2570 dest->priv.size = src_v4->priv.size;
2571 if (dest->priv.size)
2572 memcpy(dest->priv.data, src_v4->priv.data,
2573 le32_to_cpu(src_v4->priv.size));
2579 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2580 struct snd_soc_tplg_hdr *hdr)
2582 struct snd_soc_tplg_manifest *manifest, *_manifest;
2586 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2588 /* check ABI version by size, create a new manifest if abi not match */
2589 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2591 _manifest = manifest;
2594 ret = manifest_new_ver(tplg, manifest, &_manifest);
2599 /* pass control to component driver for optional further init */
2600 if (tplg->ops && tplg->ops->manifest)
2601 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2603 if (!abi_match) /* free the duplicated one */
2609 /* validate header magic, size and type */
2610 static int soc_valid_header(struct soc_tplg *tplg,
2611 struct snd_soc_tplg_hdr *hdr)
2613 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2616 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2618 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2619 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2624 /* big endian firmware objects not supported atm */
2625 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2627 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2628 tplg->pass, hdr->magic,
2629 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2633 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2635 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2636 tplg->pass, hdr->magic,
2637 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2641 /* Support ABI from version 4 */
2642 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2643 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2645 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2646 tplg->pass, hdr->abi,
2647 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2652 if (hdr->payload_size == 0) {
2653 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2654 soc_tplg_get_hdr_offset(tplg));
2661 /* check header type and call appropriate handler */
2662 static int soc_tplg_load_header(struct soc_tplg *tplg,
2663 struct snd_soc_tplg_hdr *hdr)
2665 int (*elem_load)(struct soc_tplg *tplg,
2666 struct snd_soc_tplg_hdr *hdr);
2667 unsigned int hdr_pass;
2669 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2671 /* check for matching ID */
2672 if (le32_to_cpu(hdr->index) != tplg->req_index &&
2673 tplg->req_index != SND_SOC_TPLG_INDEX_ALL)
2676 tplg->index = le32_to_cpu(hdr->index);
2678 switch (le32_to_cpu(hdr->type)) {
2679 case SND_SOC_TPLG_TYPE_MIXER:
2680 case SND_SOC_TPLG_TYPE_ENUM:
2681 case SND_SOC_TPLG_TYPE_BYTES:
2682 hdr_pass = SOC_TPLG_PASS_MIXER;
2683 elem_load = soc_tplg_kcontrol_elems_load;
2685 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2686 hdr_pass = SOC_TPLG_PASS_GRAPH;
2687 elem_load = soc_tplg_dapm_graph_elems_load;
2689 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2690 hdr_pass = SOC_TPLG_PASS_WIDGET;
2691 elem_load = soc_tplg_dapm_widget_elems_load;
2693 case SND_SOC_TPLG_TYPE_PCM:
2694 hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2695 elem_load = soc_tplg_pcm_elems_load;
2697 case SND_SOC_TPLG_TYPE_DAI:
2698 hdr_pass = SOC_TPLG_PASS_BE_DAI;
2699 elem_load = soc_tplg_dai_elems_load;
2701 case SND_SOC_TPLG_TYPE_DAI_LINK:
2702 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2703 /* physical link configurations */
2704 hdr_pass = SOC_TPLG_PASS_LINK;
2705 elem_load = soc_tplg_link_elems_load;
2707 case SND_SOC_TPLG_TYPE_MANIFEST:
2708 hdr_pass = SOC_TPLG_PASS_MANIFEST;
2709 elem_load = soc_tplg_manifest_load;
2712 /* bespoke vendor data object */
2713 hdr_pass = SOC_TPLG_PASS_VENDOR;
2714 elem_load = soc_tplg_vendor_load;
2718 if (tplg->pass == hdr_pass) {
2720 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2721 hdr->payload_size, hdr->type, hdr->version,
2722 hdr->vendor_type, tplg->pass);
2723 return elem_load(tplg, hdr);
2729 /* process the topology file headers */
2730 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2732 struct snd_soc_tplg_hdr *hdr;
2735 tplg->pass = SOC_TPLG_PASS_START;
2737 /* process the header types from start to end */
2738 while (tplg->pass <= SOC_TPLG_PASS_END) {
2740 tplg->hdr_pos = tplg->fw->data;
2741 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2743 while (!soc_tplg_is_eof(tplg)) {
2745 /* make sure header is valid before loading */
2746 ret = soc_valid_header(tplg, hdr);
2749 "ASoC: topology: invalid header: %d\n", ret);
2751 } else if (ret == 0) {
2755 /* load the header object */
2756 ret = soc_tplg_load_header(tplg, hdr);
2759 "ASoC: topology: could not load header: %d\n", ret);
2763 /* goto next header */
2764 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2765 sizeof(struct snd_soc_tplg_hdr);
2766 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2769 /* next data type pass */
2773 /* signal DAPM we are complete */
2774 ret = soc_tplg_dapm_complete(tplg);
2777 "ASoC: failed to initialise DAPM from Firmware\n");
2782 static int soc_tplg_load(struct soc_tplg *tplg)
2786 ret = soc_tplg_process_headers(tplg);
2788 soc_tplg_complete(tplg);
2793 /* load audio component topology from "firmware" file */
2794 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2795 struct snd_soc_tplg_ops *ops, const struct firmware *fw, u32 id)
2797 struct soc_tplg tplg;
2800 /* component needs to exist to keep and reference data while parsing */
2804 /* setup parsing context */
2805 memset(&tplg, 0, sizeof(tplg));
2807 tplg.dev = comp->dev;
2810 tplg.req_index = id;
2811 tplg.io_ops = ops->io_ops;
2812 tplg.io_ops_count = ops->io_ops_count;
2813 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2814 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2816 ret = soc_tplg_load(&tplg);
2817 /* free the created components if fail to load topology */
2819 snd_soc_tplg_component_remove(comp, SND_SOC_TPLG_INDEX_ALL);
2823 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2825 /* remove this dynamic widget */
2826 void snd_soc_tplg_widget_remove(struct snd_soc_dapm_widget *w)
2828 /* make sure we are a widget */
2829 if (w->dobj.type != SND_SOC_DOBJ_WIDGET)
2832 remove_widget(w->dapm->component, &w->dobj, SOC_TPLG_PASS_WIDGET);
2834 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove);
2836 /* remove all dynamic widgets from this DAPM context */
2837 void snd_soc_tplg_widget_remove_all(struct snd_soc_dapm_context *dapm,
2840 struct snd_soc_dapm_widget *w, *next_w;
2842 for_each_card_widgets_safe(dapm->card, w, next_w) {
2844 /* make sure we are a widget with correct context */
2845 if (w->dobj.type != SND_SOC_DOBJ_WIDGET || w->dapm != dapm)
2849 if (w->dobj.index != index &&
2850 w->dobj.index != SND_SOC_TPLG_INDEX_ALL)
2852 /* check and free and dynamic widget kcontrols */
2853 snd_soc_tplg_widget_remove(w);
2854 snd_soc_dapm_free_widget(w);
2856 snd_soc_dapm_reset_cache(dapm);
2858 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_remove_all);
2860 /* remove dynamic controls from the component driver */
2861 int snd_soc_tplg_component_remove(struct snd_soc_component *comp, u32 index)
2863 struct snd_soc_dobj *dobj, *next_dobj;
2864 int pass = SOC_TPLG_PASS_END;
2866 /* process the header types from end to start */
2867 while (pass >= SOC_TPLG_PASS_START) {
2869 /* remove mixer controls */
2870 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2874 if (dobj->index != index &&
2875 index != SND_SOC_TPLG_INDEX_ALL)
2878 switch (dobj->type) {
2879 case SND_SOC_DOBJ_MIXER:
2880 remove_mixer(comp, dobj, pass);
2882 case SND_SOC_DOBJ_ENUM:
2883 remove_enum(comp, dobj, pass);
2885 case SND_SOC_DOBJ_BYTES:
2886 remove_bytes(comp, dobj, pass);
2888 case SND_SOC_DOBJ_GRAPH:
2889 remove_route(comp, dobj, pass);
2891 case SND_SOC_DOBJ_WIDGET:
2892 remove_widget(comp, dobj, pass);
2894 case SND_SOC_DOBJ_PCM:
2895 remove_dai(comp, dobj, pass);
2897 case SND_SOC_DOBJ_DAI_LINK:
2898 remove_link(comp, dobj, pass);
2900 case SND_SOC_DOBJ_BACKEND_LINK:
2902 * call link_unload ops if extra
2903 * deinitialization is needed.
2905 remove_backend_link(comp, dobj, pass);
2908 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2916 /* let caller know if FW can be freed when no objects are left */
2917 return !list_empty(&comp->dobj_list);
2919 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);