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 */
68 /* vendor specific kcontrol operations */
69 const struct snd_soc_tplg_kcontrol_ops *io_ops;
72 /* vendor specific bytes ext handlers, for TLV bytes controls */
73 const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
74 int bytes_ext_ops_count;
76 /* optional fw loading callbacks to component drivers */
77 struct snd_soc_tplg_ops *ops;
80 static int soc_tplg_process_headers(struct soc_tplg *tplg);
81 static void soc_tplg_complete(struct soc_tplg *tplg);
83 /* check we dont overflow the data for this control chunk */
84 static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
85 unsigned int count, size_t bytes, const char *elem_type)
87 const u8 *end = tplg->pos + elem_size * count;
89 if (end > tplg->fw->data + tplg->fw->size) {
90 dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
95 /* check there is enough room in chunk for control.
96 extra bytes at the end of control are for vendor data here */
97 if (elem_size * count > bytes) {
99 "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
100 elem_type, count, elem_size, bytes);
107 static inline int soc_tplg_is_eof(struct soc_tplg *tplg)
109 const u8 *end = tplg->hdr_pos;
111 if (end >= tplg->fw->data + tplg->fw->size)
116 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
118 return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
121 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
123 return (unsigned long)(tplg->pos - tplg->fw->data);
126 /* mapping of Kcontrol types and associated operations. */
127 static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
128 {SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
129 snd_soc_put_volsw, snd_soc_info_volsw},
130 {SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
131 snd_soc_put_volsw_sx, NULL},
132 {SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
133 snd_soc_put_enum_double, snd_soc_info_enum_double},
134 {SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
135 snd_soc_put_enum_double, NULL},
136 {SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
137 snd_soc_bytes_put, snd_soc_bytes_info},
138 {SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw_range,
139 snd_soc_put_volsw_range, snd_soc_info_volsw_range},
140 {SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
141 snd_soc_put_xr_sx, snd_soc_info_xr_sx},
142 {SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
143 snd_soc_put_strobe, NULL},
144 {SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
145 snd_soc_dapm_put_volsw, snd_soc_info_volsw},
146 {SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
147 snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
148 {SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
149 snd_soc_dapm_put_enum_double, NULL},
150 {SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
151 snd_soc_dapm_put_enum_double, NULL},
152 {SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
153 snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
156 struct soc_tplg_map {
161 /* mapping of widget types from UAPI IDs to kernel IDs */
162 static const struct soc_tplg_map dapm_map[] = {
163 {SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
164 {SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
165 {SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
166 {SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
167 {SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
168 {SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
169 {SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
170 {SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
171 {SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
172 {SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
173 {SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
174 {SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
175 {SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
176 {SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
177 {SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
178 {SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
179 {SND_SOC_TPLG_DAPM_BUFFER, snd_soc_dapm_buffer},
180 {SND_SOC_TPLG_DAPM_SCHEDULER, snd_soc_dapm_scheduler},
181 {SND_SOC_TPLG_DAPM_EFFECT, snd_soc_dapm_effect},
182 {SND_SOC_TPLG_DAPM_SIGGEN, snd_soc_dapm_siggen},
183 {SND_SOC_TPLG_DAPM_SRC, snd_soc_dapm_src},
184 {SND_SOC_TPLG_DAPM_ASRC, snd_soc_dapm_asrc},
185 {SND_SOC_TPLG_DAPM_ENCODER, snd_soc_dapm_encoder},
186 {SND_SOC_TPLG_DAPM_DECODER, snd_soc_dapm_decoder},
189 static int tplc_chan_get_reg(struct soc_tplg *tplg,
190 struct snd_soc_tplg_channel *chan, int map)
194 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
195 if (le32_to_cpu(chan[i].id) == map)
196 return le32_to_cpu(chan[i].reg);
202 static int tplc_chan_get_shift(struct soc_tplg *tplg,
203 struct snd_soc_tplg_channel *chan, int map)
207 for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
208 if (le32_to_cpu(chan[i].id) == map)
209 return le32_to_cpu(chan[i].shift);
215 static int get_widget_id(int tplg_type)
219 for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
220 if (tplg_type == dapm_map[i].uid)
221 return dapm_map[i].kid;
227 static inline void soc_bind_err(struct soc_tplg *tplg,
228 struct snd_soc_tplg_ctl_hdr *hdr, int index)
231 "ASoC: invalid control type (g,p,i) %d:%d:%d index %d at 0x%lx\n",
232 hdr->ops.get, hdr->ops.put, hdr->ops.info, index,
233 soc_tplg_get_offset(tplg));
236 static inline void soc_control_err(struct soc_tplg *tplg,
237 struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
240 "ASoC: no complete mixer IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
241 name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
242 soc_tplg_get_offset(tplg));
245 /* pass vendor data to component driver for processing */
246 static int soc_tplg_vendor_load(struct soc_tplg *tplg,
247 struct snd_soc_tplg_hdr *hdr)
251 if (tplg->ops && tplg->ops->vendor_load)
252 ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
254 dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
261 "ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
262 soc_tplg_get_hdr_offset(tplg),
263 soc_tplg_get_hdr_offset(tplg),
264 hdr->type, hdr->vendor_type);
268 /* optionally pass new dynamic widget to component driver. This is mainly for
269 * external widgets where we can assign private data/ops */
270 static int soc_tplg_widget_load(struct soc_tplg *tplg,
271 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
273 if (tplg->ops && tplg->ops->widget_load)
274 return tplg->ops->widget_load(tplg->comp, tplg->index, w,
280 /* optionally pass new dynamic widget to component driver. This is mainly for
281 * external widgets where we can assign private data/ops */
282 static int soc_tplg_widget_ready(struct soc_tplg *tplg,
283 struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
285 if (tplg->ops && tplg->ops->widget_ready)
286 return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
292 /* pass DAI configurations to component driver for extra initialization */
293 static int soc_tplg_dai_load(struct soc_tplg *tplg,
294 struct snd_soc_dai_driver *dai_drv,
295 struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
297 if (tplg->ops && tplg->ops->dai_load)
298 return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
304 /* pass link configurations to component driver for extra initialization */
305 static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
306 struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
308 if (tplg->ops && tplg->ops->link_load)
309 return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
314 /* tell the component driver that all firmware has been loaded in this request */
315 static void soc_tplg_complete(struct soc_tplg *tplg)
317 if (tplg->ops && tplg->ops->complete)
318 tplg->ops->complete(tplg->comp);
321 /* add a dynamic kcontrol */
322 static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
323 const struct snd_kcontrol_new *control_new, const char *prefix,
324 void *data, struct snd_kcontrol **kcontrol)
328 *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
329 if (*kcontrol == NULL) {
330 dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
335 err = snd_ctl_add(card, *kcontrol);
337 dev_err(dev, "ASoC: Failed to add %s: %d\n",
338 control_new->name, err);
345 /* add a dynamic kcontrol for component driver */
346 static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
347 struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
349 struct snd_soc_component *comp = tplg->comp;
351 return soc_tplg_add_dcontrol(comp->card->snd_card,
352 comp->dev, k, comp->name_prefix, comp, kcontrol);
355 /* remove a mixer kcontrol */
356 static void remove_mixer(struct snd_soc_component *comp,
357 struct snd_soc_dobj *dobj, int pass)
359 struct snd_card *card = comp->card->snd_card;
361 if (pass != SOC_TPLG_PASS_MIXER)
364 if (dobj->ops && dobj->ops->control_unload)
365 dobj->ops->control_unload(comp, dobj);
367 snd_ctl_remove(card, dobj->control.kcontrol);
368 list_del(&dobj->list);
371 /* remove an enum kcontrol */
372 static void remove_enum(struct snd_soc_component *comp,
373 struct snd_soc_dobj *dobj, int pass)
375 struct snd_card *card = comp->card->snd_card;
377 if (pass != SOC_TPLG_PASS_MIXER)
380 if (dobj->ops && dobj->ops->control_unload)
381 dobj->ops->control_unload(comp, dobj);
383 snd_ctl_remove(card, dobj->control.kcontrol);
384 list_del(&dobj->list);
387 /* remove a byte kcontrol */
388 static void remove_bytes(struct snd_soc_component *comp,
389 struct snd_soc_dobj *dobj, int pass)
391 struct snd_card *card = comp->card->snd_card;
393 if (pass != SOC_TPLG_PASS_MIXER)
396 if (dobj->ops && dobj->ops->control_unload)
397 dobj->ops->control_unload(comp, dobj);
399 snd_ctl_remove(card, dobj->control.kcontrol);
400 list_del(&dobj->list);
404 static void remove_route(struct snd_soc_component *comp,
405 struct snd_soc_dobj *dobj, int pass)
407 if (pass != SOC_TPLG_PASS_GRAPH)
410 if (dobj->ops && dobj->ops->dapm_route_unload)
411 dobj->ops->dapm_route_unload(comp, dobj);
413 list_del(&dobj->list);
416 /* remove a widget and it's kcontrols - routes must be removed first */
417 static void remove_widget(struct snd_soc_component *comp,
418 struct snd_soc_dobj *dobj, int pass)
420 struct snd_card *card = comp->card->snd_card;
421 struct snd_soc_dapm_widget *w =
422 container_of(dobj, struct snd_soc_dapm_widget, dobj);
425 if (pass != SOC_TPLG_PASS_WIDGET)
428 if (dobj->ops && dobj->ops->widget_unload)
429 dobj->ops->widget_unload(comp, dobj);
434 for (i = 0; w->kcontrols && i < w->num_kcontrols; i++)
435 snd_ctl_remove(card, w->kcontrols[i]);
439 list_del(&dobj->list);
441 /* widget w is freed by soc-dapm.c */
444 /* remove DAI configurations */
445 static void remove_dai(struct snd_soc_component *comp,
446 struct snd_soc_dobj *dobj, int pass)
448 struct snd_soc_dai_driver *dai_drv =
449 container_of(dobj, struct snd_soc_dai_driver, dobj);
450 struct snd_soc_dai *dai, *_dai;
452 if (pass != SOC_TPLG_PASS_PCM_DAI)
455 if (dobj->ops && dobj->ops->dai_unload)
456 dobj->ops->dai_unload(comp, dobj);
458 for_each_component_dais_safe(comp, dai, _dai)
459 if (dai->driver == dai_drv)
460 snd_soc_unregister_dai(dai);
462 list_del(&dobj->list);
465 /* remove link configurations */
466 static void remove_link(struct snd_soc_component *comp,
467 struct snd_soc_dobj *dobj, int pass)
469 struct snd_soc_dai_link *link =
470 container_of(dobj, struct snd_soc_dai_link, dobj);
472 if (pass != SOC_TPLG_PASS_PCM_DAI)
475 if (dobj->ops && dobj->ops->link_unload)
476 dobj->ops->link_unload(comp, dobj);
478 list_del(&dobj->list);
479 snd_soc_remove_pcm_runtime(comp->card,
480 snd_soc_get_pcm_runtime(comp->card, link));
483 /* unload dai link */
484 static void remove_backend_link(struct snd_soc_component *comp,
485 struct snd_soc_dobj *dobj, int pass)
487 if (pass != SOC_TPLG_PASS_LINK)
490 if (dobj->ops && dobj->ops->link_unload)
491 dobj->ops->link_unload(comp, dobj);
494 * We don't free the link here as what remove_link() do since BE
495 * links are not allocated by topology.
496 * We however need to reset the dobj type to its initial values
498 dobj->type = SND_SOC_DOBJ_NONE;
499 list_del(&dobj->list);
502 /* bind a kcontrol to it's IO handlers */
503 static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
504 struct snd_kcontrol_new *k,
505 const struct soc_tplg *tplg)
507 const struct snd_soc_tplg_kcontrol_ops *ops;
508 const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
511 if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
512 && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
513 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE
514 && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
515 struct soc_bytes_ext *sbe;
516 struct snd_soc_tplg_bytes_control *be;
518 sbe = (struct soc_bytes_ext *)k->private_value;
519 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
521 /* TLV bytes controls need standard kcontrol info handler,
522 * TLV callback and extended put/get handlers.
524 k->info = snd_soc_bytes_info_ext;
525 k->tlv.c = snd_soc_bytes_tlv_callback;
528 * When a topology-based implementation abuses the
529 * control interface and uses bytes_ext controls of
530 * more than 512 bytes, we need to disable the size
531 * checks, otherwise accesses to such controls will
532 * return an -EINVAL error and prevent the card from
535 if (IS_ENABLED(CONFIG_SND_CTL_VALIDATION) && sbe->max > 512)
536 k->access |= SNDRV_CTL_ELEM_ACCESS_SKIP_CHECK;
538 ext_ops = tplg->bytes_ext_ops;
539 num_ops = tplg->bytes_ext_ops_count;
540 for (i = 0; i < num_ops; i++) {
542 ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
543 sbe->put = ext_ops[i].put;
545 ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
546 sbe->get = ext_ops[i].get;
549 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) && !sbe->get)
551 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) && !sbe->put)
556 /* try and map vendor specific kcontrol handlers first */
558 num_ops = tplg->io_ops_count;
559 for (i = 0; i < num_ops; i++) {
561 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
563 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
565 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
566 k->info = ops[i].info;
569 /* vendor specific handlers found ? */
570 if (k->put && k->get && k->info)
573 /* none found so try standard kcontrol handlers */
575 num_ops = ARRAY_SIZE(io_ops);
576 for (i = 0; i < num_ops; i++) {
578 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
580 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
582 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
583 k->info = ops[i].info;
586 /* standard handlers found ? */
587 if (k->put && k->get && k->info)
590 /* nothing to bind */
594 /* bind a widgets to it's evnt handlers */
595 int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
596 const struct snd_soc_tplg_widget_events *events,
597 int num_events, u16 event_type)
603 for (i = 0; i < num_events; i++) {
604 if (event_type == events[i].type) {
606 /* found - so assign event */
607 w->event = events[i].event_handler;
615 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
617 /* optionally pass new dynamic kcontrol to component driver. */
618 static int soc_tplg_init_kcontrol(struct soc_tplg *tplg,
619 struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
621 if (tplg->ops && tplg->ops->control_load)
622 return tplg->ops->control_load(tplg->comp, tplg->index, k,
629 static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
630 struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
632 unsigned int item_len = 2 * sizeof(unsigned int);
635 p = devm_kzalloc(tplg->dev, item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
639 p[0] = SNDRV_CTL_TLVT_DB_SCALE;
641 p[2] = le32_to_cpu(scale->min);
642 p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
643 | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);
645 kc->tlv.p = (void *)p;
649 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
650 struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
652 struct snd_soc_tplg_ctl_tlv *tplg_tlv;
653 u32 access = le32_to_cpu(tc->access);
655 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
658 if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
660 switch (le32_to_cpu(tplg_tlv->type)) {
661 case SNDRV_CTL_TLVT_DB_SCALE:
662 return soc_tplg_create_tlv_db_scale(tplg, kc,
665 /* TODO: add support for other TLV types */
667 dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
676 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
679 struct snd_soc_tplg_bytes_control *be;
680 struct soc_bytes_ext *sbe;
681 struct snd_kcontrol_new kc;
685 if (soc_tplg_check_elem_count(tplg,
686 sizeof(struct snd_soc_tplg_bytes_control), count,
687 size, "mixer bytes")) {
688 dev_err(tplg->dev, "ASoC: Invalid count %d for byte control\n",
693 for (i = 0; i < count; i++) {
694 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
696 /* validate kcontrol */
697 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
698 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
701 sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
705 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
706 le32_to_cpu(be->priv.size));
709 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
710 be->hdr.name, be->hdr.access);
712 memset(&kc, 0, sizeof(kc));
713 kc.name = be->hdr.name;
714 kc.private_value = (long)sbe;
715 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
716 kc.access = le32_to_cpu(be->hdr.access);
718 sbe->max = le32_to_cpu(be->max);
719 sbe->dobj.type = SND_SOC_DOBJ_BYTES;
720 sbe->dobj.ops = tplg->ops;
721 INIT_LIST_HEAD(&sbe->dobj.list);
723 /* map io handlers */
724 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
726 soc_control_err(tplg, &be->hdr, be->hdr.name);
730 /* pass control to driver for optional further init */
731 err = soc_tplg_init_kcontrol(tplg, &kc,
732 (struct snd_soc_tplg_ctl_hdr *)be);
734 dev_err(tplg->dev, "ASoC: failed to init %s\n",
739 /* register control here */
740 err = soc_tplg_add_kcontrol(tplg, &kc,
741 &sbe->dobj.control.kcontrol);
743 dev_err(tplg->dev, "ASoC: failed to add %s\n",
748 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
754 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
757 struct snd_soc_tplg_mixer_control *mc;
758 struct soc_mixer_control *sm;
759 struct snd_kcontrol_new kc;
763 if (soc_tplg_check_elem_count(tplg,
764 sizeof(struct snd_soc_tplg_mixer_control),
765 count, size, "mixers")) {
767 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
772 for (i = 0; i < count; i++) {
773 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
775 /* validate kcontrol */
776 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
777 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
780 sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
783 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
784 le32_to_cpu(mc->priv.size));
787 "ASoC: adding mixer kcontrol %s with access 0x%x\n",
788 mc->hdr.name, mc->hdr.access);
790 memset(&kc, 0, sizeof(kc));
791 kc.name = mc->hdr.name;
792 kc.private_value = (long)sm;
793 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
794 kc.access = le32_to_cpu(mc->hdr.access);
796 /* we only support FL/FR channel mapping atm */
797 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
799 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
801 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
803 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
806 sm->max = le32_to_cpu(mc->max);
807 sm->min = le32_to_cpu(mc->min);
808 sm->invert = le32_to_cpu(mc->invert);
809 sm->platform_max = le32_to_cpu(mc->platform_max);
810 sm->dobj.index = tplg->index;
811 sm->dobj.ops = tplg->ops;
812 sm->dobj.type = SND_SOC_DOBJ_MIXER;
813 INIT_LIST_HEAD(&sm->dobj.list);
815 /* map io handlers */
816 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
818 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
822 /* create any TLV data */
823 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
825 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
830 /* pass control to driver for optional further init */
831 err = soc_tplg_init_kcontrol(tplg, &kc,
832 (struct snd_soc_tplg_ctl_hdr *) mc);
834 dev_err(tplg->dev, "ASoC: failed to init %s\n",
839 /* register control here */
840 err = soc_tplg_add_kcontrol(tplg, &kc,
841 &sm->dobj.control.kcontrol);
843 dev_err(tplg->dev, "ASoC: failed to add %s\n",
848 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
854 static int soc_tplg_denum_create_texts(struct soc_tplg *tplg, struct soc_enum *se,
855 struct snd_soc_tplg_enum_control *ec)
859 if (le32_to_cpu(ec->items) > ARRAY_SIZE(ec->texts))
862 se->dobj.control.dtexts =
863 devm_kcalloc(tplg->dev, le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
864 if (se->dobj.control.dtexts == NULL)
867 for (i = 0; i < le32_to_cpu(ec->items); i++) {
869 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
870 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
875 se->dobj.control.dtexts[i] = devm_kstrdup(tplg->dev, ec->texts[i], GFP_KERNEL);
876 if (!se->dobj.control.dtexts[i]) {
882 se->items = le32_to_cpu(ec->items);
883 se->texts = (const char * const *)se->dobj.control.dtexts;
890 static int soc_tplg_denum_create_values(struct soc_tplg *tplg, struct soc_enum *se,
891 struct snd_soc_tplg_enum_control *ec)
896 * Following "if" checks if we have at most SND_SOC_TPLG_NUM_TEXTS
897 * values instead of using ARRAY_SIZE(ec->values) due to the fact that
898 * it is oversized for its purpose. Additionally it is done so because
899 * it is defined in UAPI header where it can't be easily changed.
901 if (le32_to_cpu(ec->items) > SND_SOC_TPLG_NUM_TEXTS)
904 se->dobj.control.dvalues = devm_kcalloc(tplg->dev, le32_to_cpu(ec->items),
905 sizeof(*se->dobj.control.dvalues),
907 if (!se->dobj.control.dvalues)
910 /* convert from little-endian */
911 for (i = 0; i < le32_to_cpu(ec->items); i++) {
912 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
918 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
921 struct snd_soc_tplg_enum_control *ec;
923 struct snd_kcontrol_new kc;
927 if (soc_tplg_check_elem_count(tplg,
928 sizeof(struct snd_soc_tplg_enum_control),
929 count, size, "enums")) {
931 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
936 for (i = 0; i < count; i++) {
937 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
939 /* validate kcontrol */
940 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
941 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
944 se = devm_kzalloc(tplg->dev, (sizeof(*se)), GFP_KERNEL);
948 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
949 le32_to_cpu(ec->priv.size));
951 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
952 ec->hdr.name, ec->items);
954 memset(&kc, 0, sizeof(kc));
955 kc.name = ec->hdr.name;
956 kc.private_value = (long)se;
957 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
958 kc.access = le32_to_cpu(ec->hdr.access);
960 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
961 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
963 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
966 se->mask = le32_to_cpu(ec->mask);
967 se->dobj.index = tplg->index;
968 se->dobj.type = SND_SOC_DOBJ_ENUM;
969 se->dobj.ops = tplg->ops;
970 INIT_LIST_HEAD(&se->dobj.list);
972 switch (le32_to_cpu(ec->hdr.ops.info)) {
973 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
974 case SND_SOC_TPLG_CTL_ENUM_VALUE:
975 err = soc_tplg_denum_create_values(tplg, se, ec);
978 "ASoC: could not create values for %s\n",
983 case SND_SOC_TPLG_CTL_ENUM:
984 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
985 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
986 err = soc_tplg_denum_create_texts(tplg, se, ec);
989 "ASoC: could not create texts for %s\n",
997 "ASoC: invalid enum control type %d for %s\n",
998 ec->hdr.ops.info, ec->hdr.name);
1002 /* map io handlers */
1003 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
1005 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1009 /* pass control to driver for optional further init */
1010 err = soc_tplg_init_kcontrol(tplg, &kc,
1011 (struct snd_soc_tplg_ctl_hdr *) ec);
1013 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1018 /* register control here */
1019 err = soc_tplg_add_kcontrol(tplg,
1020 &kc, &se->dobj.control.kcontrol);
1022 dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1027 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1035 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1036 struct snd_soc_tplg_hdr *hdr)
1038 struct snd_soc_tplg_ctl_hdr *control_hdr;
1042 dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1043 soc_tplg_get_offset(tplg));
1045 for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1047 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1049 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1050 dev_err(tplg->dev, "ASoC: invalid control size\n");
1054 switch (le32_to_cpu(control_hdr->ops.info)) {
1055 case SND_SOC_TPLG_CTL_VOLSW:
1056 case SND_SOC_TPLG_CTL_STROBE:
1057 case SND_SOC_TPLG_CTL_VOLSW_SX:
1058 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1059 case SND_SOC_TPLG_CTL_RANGE:
1060 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1061 case SND_SOC_TPLG_DAPM_CTL_PIN:
1062 ret = soc_tplg_dmixer_create(tplg, 1,
1063 le32_to_cpu(hdr->payload_size));
1065 case SND_SOC_TPLG_CTL_ENUM:
1066 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1067 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1068 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1069 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1070 ret = soc_tplg_denum_create(tplg, 1,
1071 le32_to_cpu(hdr->payload_size));
1073 case SND_SOC_TPLG_CTL_BYTES:
1074 ret = soc_tplg_dbytes_create(tplg, 1,
1075 le32_to_cpu(hdr->payload_size));
1078 soc_bind_err(tplg, control_hdr, i);
1082 dev_err(tplg->dev, "ASoC: invalid control\n");
1091 /* optionally pass new dynamic kcontrol to component driver. */
1092 static int soc_tplg_add_route(struct soc_tplg *tplg,
1093 struct snd_soc_dapm_route *route)
1095 if (tplg->ops && tplg->ops->dapm_route_load)
1096 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1102 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1103 struct snd_soc_tplg_hdr *hdr)
1105 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1106 struct snd_soc_tplg_dapm_graph_elem *elem;
1107 struct snd_soc_dapm_route **routes;
1111 count = le32_to_cpu(hdr->count);
1113 if (soc_tplg_check_elem_count(tplg,
1114 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1115 count, le32_to_cpu(hdr->payload_size), "graph")) {
1117 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1122 dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1125 /* allocate memory for pointer to array of dapm routes */
1126 routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1132 * allocate memory for each dapm route in the array.
1133 * This needs to be done individually so that
1134 * each route can be freed when it is removed in remove_route().
1136 for (i = 0; i < count; i++) {
1137 routes[i] = devm_kzalloc(tplg->dev, sizeof(*routes[i]), GFP_KERNEL);
1142 for (i = 0; i < count; i++) {
1143 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1144 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1146 /* validate routes */
1147 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1148 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1152 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1153 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1157 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1158 SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1163 routes[i]->source = elem->source;
1164 routes[i]->sink = elem->sink;
1166 /* set to NULL atm for tplg users */
1167 routes[i]->connected = NULL;
1168 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1169 routes[i]->control = NULL;
1171 routes[i]->control = elem->control;
1173 /* add route dobj to dobj_list */
1174 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1175 routes[i]->dobj.ops = tplg->ops;
1176 routes[i]->dobj.index = tplg->index;
1177 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1179 ret = soc_tplg_add_route(tplg, routes[i]);
1181 dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1183 * this route was added to the list, it will
1184 * be freed in remove_route() so increment the
1185 * counter to skip it in the error handling
1192 /* add route, but keep going if some fail */
1193 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1197 * free pointer to array of dapm routes as this is no longer needed.
1198 * The memory allocated for each dapm route will be freed
1199 * when it is removed in remove_route().
1206 static int soc_tplg_dapm_widget_dmixer_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1208 struct soc_mixer_control *sm;
1209 struct snd_soc_tplg_mixer_control *mc;
1212 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1214 /* validate kcontrol */
1215 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1216 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1219 sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
1223 tplg->pos += sizeof(struct snd_soc_tplg_mixer_control) +
1224 le32_to_cpu(mc->priv.size);
1226 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s\n",
1229 kc->private_value = (long)sm;
1230 kc->name = devm_kstrdup(tplg->dev, mc->hdr.name, GFP_KERNEL);
1233 kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1234 kc->access = le32_to_cpu(mc->hdr.access);
1236 /* we only support FL/FR channel mapping atm */
1237 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1239 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1241 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1243 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1246 sm->max = le32_to_cpu(mc->max);
1247 sm->min = le32_to_cpu(mc->min);
1248 sm->invert = le32_to_cpu(mc->invert);
1249 sm->platform_max = le32_to_cpu(mc->platform_max);
1250 sm->dobj.index = tplg->index;
1251 INIT_LIST_HEAD(&sm->dobj.list);
1253 /* map io handlers */
1254 err = soc_tplg_kcontrol_bind_io(&mc->hdr, kc, tplg);
1256 soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1260 /* create any TLV data */
1261 err = soc_tplg_create_tlv(tplg, kc, &mc->hdr);
1263 dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1268 /* pass control to driver for optional further init */
1269 err = soc_tplg_init_kcontrol(tplg, kc,
1270 (struct snd_soc_tplg_ctl_hdr *)mc);
1272 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1280 static int soc_tplg_dapm_widget_denum_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1282 struct snd_soc_tplg_enum_control *ec;
1283 struct soc_enum *se;
1286 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1287 /* validate kcontrol */
1288 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1289 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1292 se = devm_kzalloc(tplg->dev, sizeof(*se), GFP_KERNEL);
1296 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1297 le32_to_cpu(ec->priv.size));
1299 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1302 kc->private_value = (long)se;
1303 kc->name = devm_kstrdup(tplg->dev, ec->hdr.name, GFP_KERNEL);
1306 kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1307 kc->access = le32_to_cpu(ec->hdr.access);
1309 /* we only support FL/FR channel mapping atm */
1310 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1311 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1313 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1316 se->items = le32_to_cpu(ec->items);
1317 se->mask = le32_to_cpu(ec->mask);
1318 se->dobj.index = tplg->index;
1320 switch (le32_to_cpu(ec->hdr.ops.info)) {
1321 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1322 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1323 err = soc_tplg_denum_create_values(tplg, se, ec);
1325 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1330 case SND_SOC_TPLG_CTL_ENUM:
1331 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1332 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1333 err = soc_tplg_denum_create_texts(tplg, se, ec);
1335 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1341 dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1342 ec->hdr.ops.info, ec->hdr.name);
1346 /* map io handlers */
1347 err = soc_tplg_kcontrol_bind_io(&ec->hdr, kc, tplg);
1349 soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1353 /* pass control to driver for optional further init */
1354 err = soc_tplg_init_kcontrol(tplg, kc,
1355 (struct snd_soc_tplg_ctl_hdr *)ec);
1357 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1365 static int soc_tplg_dapm_widget_dbytes_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
1367 struct snd_soc_tplg_bytes_control *be;
1368 struct soc_bytes_ext *sbe;
1371 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1373 /* validate kcontrol */
1374 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1375 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1378 sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
1382 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1383 le32_to_cpu(be->priv.size));
1386 "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1387 be->hdr.name, be->hdr.access);
1389 kc->private_value = (long)sbe;
1390 kc->name = devm_kstrdup(tplg->dev, be->hdr.name, GFP_KERNEL);
1393 kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1394 kc->access = le32_to_cpu(be->hdr.access);
1396 sbe->max = le32_to_cpu(be->max);
1397 INIT_LIST_HEAD(&sbe->dobj.list);
1399 /* map standard io handlers and check for external handlers */
1400 err = soc_tplg_kcontrol_bind_io(&be->hdr, kc, tplg);
1402 soc_control_err(tplg, &be->hdr, be->hdr.name);
1406 /* pass control to driver for optional further init */
1407 err = soc_tplg_init_kcontrol(tplg, kc,
1408 (struct snd_soc_tplg_ctl_hdr *)be);
1410 dev_err(tplg->dev, "ASoC: failed to init %s\n",
1418 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1419 struct snd_soc_tplg_dapm_widget *w)
1421 struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1422 struct snd_soc_dapm_widget template, *widget;
1423 struct snd_soc_tplg_ctl_hdr *control_hdr;
1424 struct snd_soc_card *card = tplg->comp->card;
1425 unsigned int *kcontrol_type = NULL;
1426 struct snd_kcontrol_new *kc;
1427 int mixer_count = 0;
1428 int bytes_count = 0;
1433 if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1434 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1436 if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1437 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1440 dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1443 memset(&template, 0, sizeof(template));
1445 /* map user to kernel widget ID */
1446 template.id = get_widget_id(le32_to_cpu(w->id));
1447 if ((int)template.id < 0)
1450 /* strings are allocated here, but used and freed by the widget */
1451 template.name = kstrdup(w->name, GFP_KERNEL);
1454 template.sname = kstrdup(w->sname, GFP_KERNEL);
1455 if (!template.sname) {
1459 template.reg = le32_to_cpu(w->reg);
1460 template.shift = le32_to_cpu(w->shift);
1461 template.mask = le32_to_cpu(w->mask);
1462 template.subseq = le32_to_cpu(w->subseq);
1463 template.on_val = w->invert ? 0 : 1;
1464 template.off_val = w->invert ? 1 : 0;
1465 template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1466 template.event_flags = le16_to_cpu(w->event_flags);
1467 template.dobj.index = tplg->index;
1470 (sizeof(struct snd_soc_tplg_dapm_widget) +
1471 le32_to_cpu(w->priv.size));
1473 if (w->num_kcontrols == 0) {
1474 template.num_kcontrols = 0;
1478 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1479 dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1480 w->name, w->num_kcontrols, control_hdr->type);
1482 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1483 kc = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(*kc), GFP_KERNEL);
1487 kcontrol_type = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(unsigned int),
1492 for (i = 0; i < w->num_kcontrols; i++) {
1493 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1494 switch (le32_to_cpu(control_hdr->ops.info)) {
1495 case SND_SOC_TPLG_CTL_VOLSW:
1496 case SND_SOC_TPLG_CTL_STROBE:
1497 case SND_SOC_TPLG_CTL_VOLSW_SX:
1498 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1499 case SND_SOC_TPLG_CTL_RANGE:
1500 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1502 kc[i].index = mixer_count;
1503 kcontrol_type[i] = SND_SOC_TPLG_TYPE_MIXER;
1505 ret = soc_tplg_dapm_widget_dmixer_create(tplg, &kc[i]);
1509 case SND_SOC_TPLG_CTL_ENUM:
1510 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1511 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1512 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1513 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1514 /* enumerated mixer */
1515 kc[i].index = enum_count;
1516 kcontrol_type[i] = SND_SOC_TPLG_TYPE_ENUM;
1518 ret = soc_tplg_dapm_widget_denum_create(tplg, &kc[i]);
1522 case SND_SOC_TPLG_CTL_BYTES:
1524 kc[i].index = bytes_count;
1525 kcontrol_type[i] = SND_SOC_TPLG_TYPE_BYTES;
1527 ret = soc_tplg_dapm_widget_dbytes_create(tplg, &kc[i]);
1532 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1533 control_hdr->ops.get, control_hdr->ops.put,
1534 le32_to_cpu(control_hdr->ops.info));
1540 template.kcontrol_news = kc;
1543 ret = soc_tplg_widget_load(tplg, &template, w);
1547 /* card dapm mutex is held by the core if we are loading topology
1548 * data during sound card init. */
1549 if (card->instantiated)
1550 widget = snd_soc_dapm_new_control(dapm, &template);
1552 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1553 if (IS_ERR(widget)) {
1554 ret = PTR_ERR(widget);
1558 widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1559 widget->dobj.widget.kcontrol_type = kcontrol_type;
1560 widget->dobj.ops = tplg->ops;
1561 widget->dobj.index = tplg->index;
1562 list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1564 ret = soc_tplg_widget_ready(tplg, widget, w);
1568 kfree(template.sname);
1569 kfree(template.name);
1574 remove_widget(widget->dapm->component, &widget->dobj, SOC_TPLG_PASS_WIDGET);
1575 snd_soc_dapm_free_widget(widget);
1577 kfree(template.sname);
1579 kfree(template.name);
1583 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1584 struct snd_soc_tplg_hdr *hdr)
1586 struct snd_soc_tplg_dapm_widget *widget;
1589 count = le32_to_cpu(hdr->count);
1591 dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1593 for (i = 0; i < count; i++) {
1594 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1595 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1596 dev_err(tplg->dev, "ASoC: invalid widget size\n");
1600 ret = soc_tplg_dapm_widget_create(tplg, widget);
1602 dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1611 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1613 struct snd_soc_card *card = tplg->comp->card;
1616 /* Card might not have been registered at this point.
1617 * If so, just return success.
1619 if (!card || !card->instantiated) {
1620 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1621 " widget card binding deferred\n");
1625 ret = snd_soc_dapm_new_widgets(card);
1627 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1633 static int set_stream_info(struct soc_tplg *tplg, struct snd_soc_pcm_stream *stream,
1634 struct snd_soc_tplg_stream_caps *caps)
1636 stream->stream_name = devm_kstrdup(tplg->dev, caps->name, GFP_KERNEL);
1637 if (!stream->stream_name)
1640 stream->channels_min = le32_to_cpu(caps->channels_min);
1641 stream->channels_max = le32_to_cpu(caps->channels_max);
1642 stream->rates = le32_to_cpu(caps->rates);
1643 stream->rate_min = le32_to_cpu(caps->rate_min);
1644 stream->rate_max = le32_to_cpu(caps->rate_max);
1645 stream->formats = le64_to_cpu(caps->formats);
1646 stream->sig_bits = le32_to_cpu(caps->sig_bits);
1651 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1652 unsigned int flag_mask, unsigned int flags)
1654 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1655 dai_drv->symmetric_rate =
1656 (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;
1658 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1659 dai_drv->symmetric_channels =
1660 (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS) ?
1663 if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1664 dai_drv->symmetric_sample_bits =
1665 (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
1669 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1670 struct snd_soc_tplg_pcm *pcm)
1672 struct snd_soc_dai_driver *dai_drv;
1673 struct snd_soc_pcm_stream *stream;
1674 struct snd_soc_tplg_stream_caps *caps;
1675 struct snd_soc_dai *dai;
1676 struct snd_soc_dapm_context *dapm =
1677 snd_soc_component_get_dapm(tplg->comp);
1680 dai_drv = devm_kzalloc(tplg->dev, sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1681 if (dai_drv == NULL)
1684 if (strlen(pcm->dai_name)) {
1685 dai_drv->name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1686 if (!dai_drv->name) {
1691 dai_drv->id = le32_to_cpu(pcm->dai_id);
1693 if (pcm->playback) {
1694 stream = &dai_drv->playback;
1695 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1696 ret = set_stream_info(tplg, stream, caps);
1702 stream = &dai_drv->capture;
1703 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1704 ret = set_stream_info(tplg, stream, caps);
1710 dai_drv->compress_new = snd_soc_new_compress;
1712 /* pass control to component driver for optional further init */
1713 ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1715 dev_err(tplg->dev, "ASoC: DAI loading failed\n");
1719 dai_drv->dobj.index = tplg->index;
1720 dai_drv->dobj.ops = tplg->ops;
1721 dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1722 list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1724 /* register the DAI to the component */
1725 dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
1729 /* Create the DAI widgets here */
1730 ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1732 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1733 snd_soc_unregister_dai(dai);
1743 static void set_link_flags(struct snd_soc_dai_link *link,
1744 unsigned int flag_mask, unsigned int flags)
1746 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1747 link->symmetric_rate =
1748 (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;
1750 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1751 link->symmetric_channels =
1752 (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS) ?
1755 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1756 link->symmetric_sample_bits =
1757 (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
1760 if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1761 link->ignore_suspend =
1762 (flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP) ?
1766 /* create the FE DAI link */
1767 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1768 struct snd_soc_tplg_pcm *pcm)
1770 struct snd_soc_dai_link *link;
1771 struct snd_soc_dai_link_component *dlc;
1774 /* link + cpu + codec + platform */
1775 link = devm_kzalloc(tplg->dev, sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1779 dlc = (struct snd_soc_dai_link_component *)(link + 1);
1781 link->cpus = &dlc[0];
1782 link->codecs = &dlc[1];
1783 link->platforms = &dlc[2];
1786 link->num_codecs = 1;
1787 link->num_platforms = 1;
1789 link->dobj.index = tplg->index;
1790 link->dobj.ops = tplg->ops;
1791 link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1793 if (strlen(pcm->pcm_name)) {
1794 link->name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1795 link->stream_name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1796 if (!link->name || !link->stream_name) {
1801 link->id = le32_to_cpu(pcm->pcm_id);
1803 if (strlen(pcm->dai_name)) {
1804 link->cpus->dai_name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1805 if (!link->cpus->dai_name) {
1811 link->codecs->name = "snd-soc-dummy";
1812 link->codecs->dai_name = "snd-soc-dummy-dai";
1814 link->platforms->name = "snd-soc-dummy";
1818 link->dpcm_playback = le32_to_cpu(pcm->playback);
1819 link->dpcm_capture = le32_to_cpu(pcm->capture);
1821 set_link_flags(link,
1822 le32_to_cpu(pcm->flag_mask),
1823 le32_to_cpu(pcm->flags));
1825 /* pass control to component driver for optional further init */
1826 ret = soc_tplg_dai_link_load(tplg, link, NULL);
1828 dev_err(tplg->dev, "ASoC: FE link loading failed\n");
1832 ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1834 dev_err(tplg->dev, "ASoC: adding FE link failed\n");
1838 list_add(&link->dobj.list, &tplg->comp->dobj_list);
1845 /* create a FE DAI and DAI link from the PCM object */
1846 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1847 struct snd_soc_tplg_pcm *pcm)
1851 ret = soc_tplg_dai_create(tplg, pcm);
1855 return soc_tplg_fe_link_create(tplg, pcm);
1858 /* copy stream caps from the old version 4 of source */
1859 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1860 struct snd_soc_tplg_stream_caps_v4 *src)
1862 dest->size = cpu_to_le32(sizeof(*dest));
1863 memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1864 dest->formats = src->formats;
1865 dest->rates = src->rates;
1866 dest->rate_min = src->rate_min;
1867 dest->rate_max = src->rate_max;
1868 dest->channels_min = src->channels_min;
1869 dest->channels_max = src->channels_max;
1870 dest->periods_min = src->periods_min;
1871 dest->periods_max = src->periods_max;
1872 dest->period_size_min = src->period_size_min;
1873 dest->period_size_max = src->period_size_max;
1874 dest->buffer_size_min = src->buffer_size_min;
1875 dest->buffer_size_max = src->buffer_size_max;
1879 * pcm_new_ver - Create the new version of PCM from the old version.
1880 * @tplg: topology context
1881 * @src: older version of pcm as a source
1882 * @pcm: latest version of pcm created from the source
1884 * Support from version 4. User should free the returned pcm manually.
1886 static int pcm_new_ver(struct soc_tplg *tplg,
1887 struct snd_soc_tplg_pcm *src,
1888 struct snd_soc_tplg_pcm **pcm)
1890 struct snd_soc_tplg_pcm *dest;
1891 struct snd_soc_tplg_pcm_v4 *src_v4;
1896 if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
1897 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
1901 dev_warn(tplg->dev, "ASoC: old version of PCM\n");
1902 src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
1903 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
1907 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
1908 memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1909 memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1910 dest->pcm_id = src_v4->pcm_id;
1911 dest->dai_id = src_v4->dai_id;
1912 dest->playback = src_v4->playback;
1913 dest->capture = src_v4->capture;
1914 dest->compress = src_v4->compress;
1915 dest->num_streams = src_v4->num_streams;
1916 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
1917 memcpy(&dest->stream[i], &src_v4->stream[i],
1918 sizeof(struct snd_soc_tplg_stream));
1920 for (i = 0; i < 2; i++)
1921 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
1927 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
1928 struct snd_soc_tplg_hdr *hdr)
1930 struct snd_soc_tplg_pcm *pcm, *_pcm;
1937 count = le32_to_cpu(hdr->count);
1939 /* check the element size and count */
1940 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1941 size = le32_to_cpu(pcm->size);
1942 if (size > sizeof(struct snd_soc_tplg_pcm)
1943 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
1944 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
1949 if (soc_tplg_check_elem_count(tplg,
1951 le32_to_cpu(hdr->payload_size),
1953 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
1958 for (i = 0; i < count; i++) {
1959 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1960 size = le32_to_cpu(pcm->size);
1962 /* check ABI version by size, create a new version of pcm
1965 if (size == sizeof(*pcm)) {
1970 ret = pcm_new_ver(tplg, pcm, &_pcm);
1975 /* create the FE DAIs and DAI links */
1976 ret = soc_tplg_pcm_create(tplg, _pcm);
1983 /* offset by version-specific struct size and
1984 * real priv data size
1986 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
1989 kfree(_pcm); /* free the duplicated one */
1992 dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
1998 * set_link_hw_format - Set the HW audio format of the physical DAI link.
1999 * @link: &snd_soc_dai_link which should be updated
2000 * @cfg: physical link configs.
2002 * Topology context contains a list of supported HW formats (configs) and
2003 * a default format ID for the physical link. This function will use this
2004 * default ID to choose the HW format to set the link's DAI format for init.
2006 static void set_link_hw_format(struct snd_soc_dai_link *link,
2007 struct snd_soc_tplg_link_config *cfg)
2009 struct snd_soc_tplg_hw_config *hw_config;
2010 unsigned char bclk_provider, fsync_provider;
2011 unsigned char invert_bclk, invert_fsync;
2014 for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2015 hw_config = &cfg->hw_config[i];
2016 if (hw_config->id != cfg->default_hw_config_id)
2019 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2020 SND_SOC_DAIFMT_FORMAT_MASK;
2023 switch (hw_config->clock_gated) {
2024 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2025 link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2028 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2029 link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2033 /* ignore the value */
2037 /* clock signal polarity */
2038 invert_bclk = hw_config->invert_bclk;
2039 invert_fsync = hw_config->invert_fsync;
2040 if (!invert_bclk && !invert_fsync)
2041 link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2042 else if (!invert_bclk && invert_fsync)
2043 link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2044 else if (invert_bclk && !invert_fsync)
2045 link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2047 link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2050 bclk_provider = (hw_config->bclk_provider ==
2051 SND_SOC_TPLG_BCLK_CP);
2052 fsync_provider = (hw_config->fsync_provider ==
2053 SND_SOC_TPLG_FSYNC_CP);
2054 if (bclk_provider && fsync_provider)
2055 link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
2056 else if (!bclk_provider && fsync_provider)
2057 link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
2058 else if (bclk_provider && !fsync_provider)
2059 link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
2061 link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
2066 * link_new_ver - Create a new physical link config from the old
2067 * version of source.
2068 * @tplg: topology context
2069 * @src: old version of phyical link config as a source
2070 * @link: latest version of physical link config created from the source
2072 * Support from version 4. User need free the returned link config manually.
2074 static int link_new_ver(struct soc_tplg *tplg,
2075 struct snd_soc_tplg_link_config *src,
2076 struct snd_soc_tplg_link_config **link)
2078 struct snd_soc_tplg_link_config *dest;
2079 struct snd_soc_tplg_link_config_v4 *src_v4;
2084 if (le32_to_cpu(src->size) !=
2085 sizeof(struct snd_soc_tplg_link_config_v4)) {
2086 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2090 dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2092 src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2093 dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2097 dest->size = cpu_to_le32(sizeof(*dest));
2098 dest->id = src_v4->id;
2099 dest->num_streams = src_v4->num_streams;
2100 for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2101 memcpy(&dest->stream[i], &src_v4->stream[i],
2102 sizeof(struct snd_soc_tplg_stream));
2109 * snd_soc_find_dai_link - Find a DAI link
2112 * @id: DAI link ID to match
2113 * @name: DAI link name to match, optional
2114 * @stream_name: DAI link stream name to match, optional
2116 * This function will search all existing DAI links of the soc card to
2117 * find the link of the same ID. Since DAI links may not have their
2118 * unique ID, so name and stream name should also match if being
2121 * Return: pointer of DAI link, or NULL if not found.
2123 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2124 int id, const char *name,
2125 const char *stream_name)
2127 struct snd_soc_pcm_runtime *rtd;
2128 struct snd_soc_dai_link *link;
2130 for_each_card_rtds(card, rtd) {
2131 link = rtd->dai_link;
2136 if (name && (!link->name || strcmp(name, link->name)))
2139 if (stream_name && (!link->stream_name
2140 || strcmp(stream_name, link->stream_name)))
2149 /* Find and configure an existing physical DAI link */
2150 static int soc_tplg_link_config(struct soc_tplg *tplg,
2151 struct snd_soc_tplg_link_config *cfg)
2153 struct snd_soc_dai_link *link;
2154 const char *name, *stream_name;
2158 len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2159 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2166 len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2167 if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2170 stream_name = cfg->stream_name;
2174 link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2177 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2183 if (cfg->num_hw_configs)
2184 set_link_hw_format(link, cfg);
2188 set_link_flags(link,
2189 le32_to_cpu(cfg->flag_mask),
2190 le32_to_cpu(cfg->flags));
2192 /* pass control to component driver for optional further init */
2193 ret = soc_tplg_dai_link_load(tplg, link, cfg);
2195 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2199 /* for unloading it in snd_soc_tplg_component_remove */
2200 link->dobj.index = tplg->index;
2201 link->dobj.ops = tplg->ops;
2202 link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2203 list_add(&link->dobj.list, &tplg->comp->dobj_list);
2209 /* Load physical link config elements from the topology context */
2210 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2211 struct snd_soc_tplg_hdr *hdr)
2213 struct snd_soc_tplg_link_config *link, *_link;
2219 count = le32_to_cpu(hdr->count);
2221 /* check the element size and count */
2222 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2223 size = le32_to_cpu(link->size);
2224 if (size > sizeof(struct snd_soc_tplg_link_config)
2225 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2226 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2231 if (soc_tplg_check_elem_count(tplg,
2233 le32_to_cpu(hdr->payload_size),
2234 "physical link config")) {
2235 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2240 /* config physical DAI links */
2241 for (i = 0; i < count; i++) {
2242 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2243 size = le32_to_cpu(link->size);
2244 if (size == sizeof(*link)) {
2249 ret = link_new_ver(tplg, link, &_link);
2254 ret = soc_tplg_link_config(tplg, _link);
2261 /* offset by version-specific struct size and
2262 * real priv data size
2264 tplg->pos += size + le32_to_cpu(_link->priv.size);
2267 kfree(_link); /* free the duplicated one */
2274 * soc_tplg_dai_config - Find and configure an existing physical DAI.
2275 * @tplg: topology context
2276 * @d: physical DAI configs.
2278 * The physical dai should already be registered by the platform driver.
2279 * The platform driver should specify the DAI name and ID for matching.
2281 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2282 struct snd_soc_tplg_dai *d)
2284 struct snd_soc_dai_link_component dai_component;
2285 struct snd_soc_dai *dai;
2286 struct snd_soc_dai_driver *dai_drv;
2287 struct snd_soc_pcm_stream *stream;
2288 struct snd_soc_tplg_stream_caps *caps;
2291 memset(&dai_component, 0, sizeof(dai_component));
2293 dai_component.dai_name = d->dai_name;
2294 dai = snd_soc_find_dai(&dai_component);
2296 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2301 if (le32_to_cpu(d->dai_id) != dai->id) {
2302 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2307 dai_drv = dai->driver;
2312 stream = &dai_drv->playback;
2313 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2314 ret = set_stream_info(tplg, stream, caps);
2320 stream = &dai_drv->capture;
2321 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2322 ret = set_stream_info(tplg, stream, caps);
2328 set_dai_flags(dai_drv,
2329 le32_to_cpu(d->flag_mask),
2330 le32_to_cpu(d->flags));
2332 /* pass control to component driver for optional further init */
2333 ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2335 dev_err(tplg->dev, "ASoC: DAI loading failed\n");
2345 /* load physical DAI elements */
2346 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2347 struct snd_soc_tplg_hdr *hdr)
2349 struct snd_soc_tplg_dai *dai;
2353 count = le32_to_cpu(hdr->count);
2355 /* config the existing BE DAIs */
2356 for (i = 0; i < count; i++) {
2357 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2358 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2359 dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2363 ret = soc_tplg_dai_config(tplg, dai);
2365 dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2369 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2372 dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2377 * manifest_new_ver - Create a new version of manifest from the old version
2379 * @tplg: topology context
2380 * @src: old version of manifest as a source
2381 * @manifest: latest version of manifest created from the source
2383 * Support from version 4. Users need free the returned manifest manually.
2385 static int manifest_new_ver(struct soc_tplg *tplg,
2386 struct snd_soc_tplg_manifest *src,
2387 struct snd_soc_tplg_manifest **manifest)
2389 struct snd_soc_tplg_manifest *dest;
2390 struct snd_soc_tplg_manifest_v4 *src_v4;
2395 size = le32_to_cpu(src->size);
2396 if (size != sizeof(*src_v4)) {
2397 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2401 src->size = cpu_to_le32(sizeof(*src_v4));
2404 dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2406 src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2407 dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2412 dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2413 dest->control_elems = src_v4->control_elems;
2414 dest->widget_elems = src_v4->widget_elems;
2415 dest->graph_elems = src_v4->graph_elems;
2416 dest->pcm_elems = src_v4->pcm_elems;
2417 dest->dai_link_elems = src_v4->dai_link_elems;
2418 dest->priv.size = src_v4->priv.size;
2419 if (dest->priv.size)
2420 memcpy(dest->priv.data, src_v4->priv.data,
2421 le32_to_cpu(src_v4->priv.size));
2427 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2428 struct snd_soc_tplg_hdr *hdr)
2430 struct snd_soc_tplg_manifest *manifest, *_manifest;
2434 manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2436 /* check ABI version by size, create a new manifest if abi not match */
2437 if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2439 _manifest = manifest;
2442 ret = manifest_new_ver(tplg, manifest, &_manifest);
2447 /* pass control to component driver for optional further init */
2448 if (tplg->ops && tplg->ops->manifest)
2449 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2451 if (!abi_match) /* free the duplicated one */
2457 /* validate header magic, size and type */
2458 static int soc_valid_header(struct soc_tplg *tplg,
2459 struct snd_soc_tplg_hdr *hdr)
2461 if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2464 if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2466 "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2467 le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2472 /* big endian firmware objects not supported atm */
2473 if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2475 "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2476 tplg->pass, hdr->magic,
2477 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2481 if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2483 "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2484 tplg->pass, hdr->magic,
2485 soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2489 /* Support ABI from version 4 */
2490 if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2491 le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2493 "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2494 tplg->pass, hdr->abi,
2495 SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2500 if (hdr->payload_size == 0) {
2501 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2502 soc_tplg_get_hdr_offset(tplg));
2509 /* check header type and call appropriate handler */
2510 static int soc_tplg_load_header(struct soc_tplg *tplg,
2511 struct snd_soc_tplg_hdr *hdr)
2513 int (*elem_load)(struct soc_tplg *tplg,
2514 struct snd_soc_tplg_hdr *hdr);
2515 unsigned int hdr_pass;
2517 tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2519 tplg->index = le32_to_cpu(hdr->index);
2521 switch (le32_to_cpu(hdr->type)) {
2522 case SND_SOC_TPLG_TYPE_MIXER:
2523 case SND_SOC_TPLG_TYPE_ENUM:
2524 case SND_SOC_TPLG_TYPE_BYTES:
2525 hdr_pass = SOC_TPLG_PASS_MIXER;
2526 elem_load = soc_tplg_kcontrol_elems_load;
2528 case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2529 hdr_pass = SOC_TPLG_PASS_GRAPH;
2530 elem_load = soc_tplg_dapm_graph_elems_load;
2532 case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2533 hdr_pass = SOC_TPLG_PASS_WIDGET;
2534 elem_load = soc_tplg_dapm_widget_elems_load;
2536 case SND_SOC_TPLG_TYPE_PCM:
2537 hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2538 elem_load = soc_tplg_pcm_elems_load;
2540 case SND_SOC_TPLG_TYPE_DAI:
2541 hdr_pass = SOC_TPLG_PASS_BE_DAI;
2542 elem_load = soc_tplg_dai_elems_load;
2544 case SND_SOC_TPLG_TYPE_DAI_LINK:
2545 case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2546 /* physical link configurations */
2547 hdr_pass = SOC_TPLG_PASS_LINK;
2548 elem_load = soc_tplg_link_elems_load;
2550 case SND_SOC_TPLG_TYPE_MANIFEST:
2551 hdr_pass = SOC_TPLG_PASS_MANIFEST;
2552 elem_load = soc_tplg_manifest_load;
2555 /* bespoke vendor data object */
2556 hdr_pass = SOC_TPLG_PASS_VENDOR;
2557 elem_load = soc_tplg_vendor_load;
2561 if (tplg->pass == hdr_pass) {
2563 "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2564 hdr->payload_size, hdr->type, hdr->version,
2565 hdr->vendor_type, tplg->pass);
2566 return elem_load(tplg, hdr);
2572 /* process the topology file headers */
2573 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2575 struct snd_soc_tplg_hdr *hdr;
2578 tplg->pass = SOC_TPLG_PASS_START;
2580 /* process the header types from start to end */
2581 while (tplg->pass <= SOC_TPLG_PASS_END) {
2583 tplg->hdr_pos = tplg->fw->data;
2584 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2586 while (!soc_tplg_is_eof(tplg)) {
2588 /* make sure header is valid before loading */
2589 ret = soc_valid_header(tplg, hdr);
2592 "ASoC: topology: invalid header: %d\n", ret);
2594 } else if (ret == 0) {
2598 /* load the header object */
2599 ret = soc_tplg_load_header(tplg, hdr);
2602 "ASoC: topology: could not load header: %d\n", ret);
2606 /* goto next header */
2607 tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2608 sizeof(struct snd_soc_tplg_hdr);
2609 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2612 /* next data type pass */
2616 /* signal DAPM we are complete */
2617 ret = soc_tplg_dapm_complete(tplg);
2620 "ASoC: failed to initialise DAPM from Firmware\n");
2625 static int soc_tplg_load(struct soc_tplg *tplg)
2629 ret = soc_tplg_process_headers(tplg);
2631 soc_tplg_complete(tplg);
2636 /* load audio component topology from "firmware" file */
2637 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2638 struct snd_soc_tplg_ops *ops, const struct firmware *fw)
2640 struct soc_tplg tplg;
2644 * check if we have sane parameters:
2645 * comp - needs to exist to keep and reference data while parsing
2646 * comp->dev - used for resource management and prints
2647 * comp->card - used for setting card related parameters
2648 * fw - we need it, as it is the very thing we parse
2650 if (!comp || !comp->dev || !comp->card || !fw)
2653 /* setup parsing context */
2654 memset(&tplg, 0, sizeof(tplg));
2656 tplg.dev = comp->dev;
2660 tplg.io_ops = ops->io_ops;
2661 tplg.io_ops_count = ops->io_ops_count;
2662 tplg.bytes_ext_ops = ops->bytes_ext_ops;
2663 tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2666 ret = soc_tplg_load(&tplg);
2667 /* free the created components if fail to load topology */
2669 snd_soc_tplg_component_remove(comp);
2673 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2675 /* remove dynamic controls from the component driver */
2676 int snd_soc_tplg_component_remove(struct snd_soc_component *comp)
2678 struct snd_soc_dobj *dobj, *next_dobj;
2679 int pass = SOC_TPLG_PASS_END;
2681 /* process the header types from end to start */
2682 while (pass >= SOC_TPLG_PASS_START) {
2684 /* remove mixer controls */
2685 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2688 switch (dobj->type) {
2689 case SND_SOC_DOBJ_MIXER:
2690 remove_mixer(comp, dobj, pass);
2692 case SND_SOC_DOBJ_ENUM:
2693 remove_enum(comp, dobj, pass);
2695 case SND_SOC_DOBJ_BYTES:
2696 remove_bytes(comp, dobj, pass);
2698 case SND_SOC_DOBJ_GRAPH:
2699 remove_route(comp, dobj, pass);
2701 case SND_SOC_DOBJ_WIDGET:
2702 remove_widget(comp, dobj, pass);
2704 case SND_SOC_DOBJ_PCM:
2705 remove_dai(comp, dobj, pass);
2707 case SND_SOC_DOBJ_DAI_LINK:
2708 remove_link(comp, dobj, pass);
2710 case SND_SOC_DOBJ_BACKEND_LINK:
2712 * call link_unload ops if extra
2713 * deinitialization is needed.
2715 remove_backend_link(comp, dobj, pass);
2718 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2726 /* let caller know if FW can be freed when no objects are left */
2727 return !list_empty(&comp->dobj_list);
2729 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);