sound/soc/soc-topology.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 //
   3 // soc-topology.c  --  ALSA SoC Topology
   4 //
   5 // Copyright (C) 2012 Texas Instruments Inc.
   6 // Copyright (C) 2015 Intel Corporation.
   7 //
   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>
  15 //
  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.
  19 //
  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.
  22
  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>
  32
  33 #define SOC_TPLG_MAGIC_BIG_ENDIAN            0x436F5341 /* ASoC in reverse */
  34
  35 /*
  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).
  40  */
  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
  50
  51 #define SOC_TPLG_PASS_START     SOC_TPLG_PASS_MANIFEST
  52 #define SOC_TPLG_PASS_END       SOC_TPLG_PASS_LINK
  53
  54 /* topology context */
  55 struct soc_tplg {
  56         const struct firmware *fw;
  57
  58         /* runtime FW parsing */
  59         const u8 *pos;          /* read postion */
  60         const u8 *hdr_pos;      /* header position */
  61         unsigned int pass;      /* pass number */
  62
  63         /* component caller */
  64         struct device *dev;
  65         struct snd_soc_component *comp;
  66         u32 index;      /* current block index */
  67
  68         /* vendor specific kcontrol operations */
  69         const struct snd_soc_tplg_kcontrol_ops *io_ops;
  70         int io_ops_count;
  71
  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;
  75
  76         /* optional fw loading callbacks to component drivers */
  77         struct snd_soc_tplg_ops *ops;
  78 };
  79
  80 static int soc_tplg_process_headers(struct soc_tplg *tplg);
  81 static void soc_tplg_complete(struct soc_tplg *tplg);
  82
  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)
  86 {
  87         const u8 *end = tplg->pos + elem_size * count;
  88
  89         if (end > tplg->fw->data + tplg->fw->size) {
  90                 dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
  91                         elem_type);
  92                 return -EINVAL;
  93         }
  94
  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) {
  98                 dev_err(tplg->dev,
  99                         "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
 100                         elem_type, count, elem_size, bytes);
 101                 return -EINVAL;
 102         }
 103
 104         return 0;
 105 }
 106
 107 static inline int soc_tplg_is_eof(struct soc_tplg *tplg)
 108 {
 109         const u8 *end = tplg->hdr_pos;
 110
 111         if (end >= tplg->fw->data + tplg->fw->size)
 112                 return 1;
 113         return 0;
 114 }
 115
 116 static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
 117 {
 118         return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
 119 }
 120
 121 static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
 122 {
 123         return (unsigned long)(tplg->pos - tplg->fw->data);
 124 }
 125
 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},
 154 };
 155
 156 struct soc_tplg_map {
 157         int uid;
 158         int kid;
 159 };
 160
 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},
 187 };
 188
 189 static int tplc_chan_get_reg(struct soc_tplg *tplg,
 190         struct snd_soc_tplg_channel *chan, int map)
 191 {
 192         int i;
 193
 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);
 197         }
 198
 199         return -EINVAL;
 200 }
 201
 202 static int tplc_chan_get_shift(struct soc_tplg *tplg,
 203         struct snd_soc_tplg_channel *chan, int map)
 204 {
 205         int i;
 206
 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);
 210         }
 211
 212         return -EINVAL;
 213 }
 214
 215 static int get_widget_id(int tplg_type)
 216 {
 217         int i;
 218
 219         for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
 220                 if (tplg_type == dapm_map[i].uid)
 221                         return dapm_map[i].kid;
 222         }
 223
 224         return -EINVAL;
 225 }
 226
 227 static inline void soc_bind_err(struct soc_tplg *tplg,
 228         struct snd_soc_tplg_ctl_hdr *hdr, int index)
 229 {
 230         dev_err(tplg->dev,
 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));
 234 }
 235
 236 static inline void soc_control_err(struct soc_tplg *tplg,
 237         struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
 238 {
 239         dev_err(tplg->dev,
 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));
 243 }
 244
 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)
 248 {
 249         int ret = 0;
 250
 251         if (tplg->ops && tplg->ops->vendor_load)
 252                 ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
 253         else {
 254                 dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
 255                         hdr->vendor_type);
 256                 return -EINVAL;
 257         }
 258
 259         if (ret < 0)
 260                 dev_err(tplg->dev,
 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);
 265         return ret;
 266 }
 267
 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)
 272 {
 273         if (tplg->ops && tplg->ops->widget_load)
 274                 return tplg->ops->widget_load(tplg->comp, tplg->index, w,
 275                         tplg_w);
 276
 277         return 0;
 278 }
 279
 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)
 284 {
 285         if (tplg->ops && tplg->ops->widget_ready)
 286                 return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
 287                         tplg_w);
 288
 289         return 0;
 290 }
 291
 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)
 296 {
 297         if (tplg->ops && tplg->ops->dai_load)
 298                 return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
 299                         pcm, dai);
 300
 301         return 0;
 302 }
 303
 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)
 307 {
 308         if (tplg->ops && tplg->ops->link_load)
 309                 return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);
 310
 311         return 0;
 312 }
 313
 314 /* tell the component driver that all firmware has been loaded in this request */
 315 static void soc_tplg_complete(struct soc_tplg *tplg)
 316 {
 317         if (tplg->ops && tplg->ops->complete)
 318                 tplg->ops->complete(tplg->comp);
 319 }
 320
 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)
 325 {
 326         int err;
 327
 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",
 331                 control_new->name);
 332                 return -ENOMEM;
 333         }
 334
 335         err = snd_ctl_add(card, *kcontrol);
 336         if (err < 0) {
 337                 dev_err(dev, "ASoC: Failed to add %s: %d\n",
 338                         control_new->name, err);
 339                 return err;
 340         }
 341
 342         return 0;
 343 }
 344
 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)
 348 {
 349         struct snd_soc_component *comp = tplg->comp;
 350
 351         return soc_tplg_add_dcontrol(comp->card->snd_card,
 352                                 comp->dev, k, comp->name_prefix, comp, kcontrol);
 353 }
 354
 355 /* remove a mixer kcontrol */
 356 static void remove_mixer(struct snd_soc_component *comp,
 357         struct snd_soc_dobj *dobj, int pass)
 358 {
 359         struct snd_card *card = comp->card->snd_card;
 360
 361         if (pass != SOC_TPLG_PASS_MIXER)
 362                 return;
 363
 364         if (dobj->ops && dobj->ops->control_unload)
 365                 dobj->ops->control_unload(comp, dobj);
 366
 367         snd_ctl_remove(card, dobj->control.kcontrol);
 368         list_del(&dobj->list);
 369 }
 370
 371 /* remove an enum kcontrol */
 372 static void remove_enum(struct snd_soc_component *comp,
 373         struct snd_soc_dobj *dobj, int pass)
 374 {
 375         struct snd_card *card = comp->card->snd_card;
 376
 377         if (pass != SOC_TPLG_PASS_MIXER)
 378                 return;
 379
 380         if (dobj->ops && dobj->ops->control_unload)
 381                 dobj->ops->control_unload(comp, dobj);
 382
 383         snd_ctl_remove(card, dobj->control.kcontrol);
 384         list_del(&dobj->list);
 385 }
 386
 387 /* remove a byte kcontrol */
 388 static void remove_bytes(struct snd_soc_component *comp,
 389         struct snd_soc_dobj *dobj, int pass)
 390 {
 391         struct snd_card *card = comp->card->snd_card;
 392
 393         if (pass != SOC_TPLG_PASS_MIXER)
 394                 return;
 395
 396         if (dobj->ops && dobj->ops->control_unload)
 397                 dobj->ops->control_unload(comp, dobj);
 398
 399         snd_ctl_remove(card, dobj->control.kcontrol);
 400         list_del(&dobj->list);
 401 }
 402
 403 /* remove a route */
 404 static void remove_route(struct snd_soc_component *comp,
 405                          struct snd_soc_dobj *dobj, int pass)
 406 {
 407         if (pass != SOC_TPLG_PASS_GRAPH)
 408                 return;
 409
 410         if (dobj->ops && dobj->ops->dapm_route_unload)
 411                 dobj->ops->dapm_route_unload(comp, dobj);
 412
 413         list_del(&dobj->list);
 414 }
 415
 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)
 419 {
 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);
 423         int i;
 424
 425         if (pass != SOC_TPLG_PASS_WIDGET)
 426                 return;
 427
 428         if (dobj->ops && dobj->ops->widget_unload)
 429                 dobj->ops->widget_unload(comp, dobj);
 430
 431         if (!w->kcontrols)
 432                 goto free_news;
 433
 434         for (i = 0; w->kcontrols && i < w->num_kcontrols; i++)
 435                 snd_ctl_remove(card, w->kcontrols[i]);
 436
 437 free_news:
 438
 439         list_del(&dobj->list);
 440
 441         /* widget w is freed by soc-dapm.c */
 442 }
 443
 444 /* remove DAI configurations */
 445 static void remove_dai(struct snd_soc_component *comp,
 446         struct snd_soc_dobj *dobj, int pass)
 447 {
 448         struct snd_soc_dai_driver *dai_drv =
 449                 container_of(dobj, struct snd_soc_dai_driver, dobj);
 450         struct snd_soc_dai *dai;
 451
 452         if (pass != SOC_TPLG_PASS_PCM_DAI)
 453                 return;
 454
 455         if (dobj->ops && dobj->ops->dai_unload)
 456                 dobj->ops->dai_unload(comp, dobj);
 457
 458         for_each_component_dais(comp, dai)
 459                 if (dai->driver == dai_drv)
 460                         dai->driver = NULL;
 461
 462         list_del(&dobj->list);
 463 }
 464
 465 /* remove link configurations */
 466 static void remove_link(struct snd_soc_component *comp,
 467         struct snd_soc_dobj *dobj, int pass)
 468 {
 469         struct snd_soc_dai_link *link =
 470                 container_of(dobj, struct snd_soc_dai_link, dobj);
 471
 472         if (pass != SOC_TPLG_PASS_PCM_DAI)
 473                 return;
 474
 475         if (dobj->ops && dobj->ops->link_unload)
 476                 dobj->ops->link_unload(comp, dobj);
 477
 478         list_del(&dobj->list);
 479         snd_soc_remove_pcm_runtime(comp->card,
 480                         snd_soc_get_pcm_runtime(comp->card, link));
 481 }
 482
 483 /* unload dai link */
 484 static void remove_backend_link(struct snd_soc_component *comp,
 485         struct snd_soc_dobj *dobj, int pass)
 486 {
 487         if (pass != SOC_TPLG_PASS_LINK)
 488                 return;
 489
 490         if (dobj->ops && dobj->ops->link_unload)
 491                 dobj->ops->link_unload(comp, dobj);
 492
 493         /*
 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
 497          */
 498         dobj->type = SND_SOC_DOBJ_NONE;
 499         list_del(&dobj->list);
 500 }
 501
 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)
 506 {
 507         const struct snd_soc_tplg_kcontrol_ops *ops;
 508         const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
 509         int num_ops, i;
 510
 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;
 517
 518                 sbe = (struct soc_bytes_ext *)k->private_value;
 519                 be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
 520
 521                 /* TLV bytes controls need standard kcontrol info handler,
 522                  * TLV callback and extended put/get handlers.
 523                  */
 524                 k->info = snd_soc_bytes_info_ext;
 525                 k->tlv.c = snd_soc_bytes_tlv_callback;
 526
 527                 /*
 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
 533                  * being configured.
 534                  */
 535                 if (IS_ENABLED(CONFIG_SND_CTL_VALIDATION) && sbe->max > 512)
 536                         k->access |= SNDRV_CTL_ELEM_ACCESS_SKIP_CHECK;
 537
 538                 ext_ops = tplg->bytes_ext_ops;
 539                 num_ops = tplg->bytes_ext_ops_count;
 540                 for (i = 0; i < num_ops; i++) {
 541                         if (!sbe->put &&
 542                             ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
 543                                 sbe->put = ext_ops[i].put;
 544                         if (!sbe->get &&
 545                             ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
 546                                 sbe->get = ext_ops[i].get;
 547                 }
 548
 549                 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) && !sbe->get)
 550                         return -EINVAL;
 551                 if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) && !sbe->put)
 552                         return -EINVAL;
 553                 return 0;
 554         }
 555
 556         /* try and map vendor specific kcontrol handlers first */
 557         ops = tplg->io_ops;
 558         num_ops = tplg->io_ops_count;
 559         for (i = 0; i < num_ops; i++) {
 560
 561                 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
 562                         k->put = ops[i].put;
 563                 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
 564                         k->get = ops[i].get;
 565                 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
 566                         k->info = ops[i].info;
 567         }
 568
 569         /* vendor specific handlers found ? */
 570         if (k->put && k->get && k->info)
 571                 return 0;
 572
 573         /* none found so try standard kcontrol handlers */
 574         ops = io_ops;
 575         num_ops = ARRAY_SIZE(io_ops);
 576         for (i = 0; i < num_ops; i++) {
 577
 578                 if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
 579                         k->put = ops[i].put;
 580                 if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
 581                         k->get = ops[i].get;
 582                 if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
 583                         k->info = ops[i].info;
 584         }
 585
 586         /* standard handlers found ? */
 587         if (k->put && k->get && k->info)
 588                 return 0;
 589
 590         /* nothing to bind */
 591         return -EINVAL;
 592 }
 593
 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)
 598 {
 599         int i;
 600
 601         w->event = NULL;
 602
 603         for (i = 0; i < num_events; i++) {
 604                 if (event_type == events[i].type) {
 605
 606                         /* found - so assign event */
 607                         w->event = events[i].event_handler;
 608                         return 0;
 609                 }
 610         }
 611
 612         /* not found */
 613         return -EINVAL;
 614 }
 615 EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);
 616
 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)
 620 {
 621         if (tplg->ops && tplg->ops->control_load)
 622                 return tplg->ops->control_load(tplg->comp, tplg->index, k,
 623                         hdr);
 624
 625         return 0;
 626 }
 627
 628
 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)
 631 {
 632         unsigned int item_len = 2 * sizeof(unsigned int);
 633         unsigned int *p;
 634
 635         p = devm_kzalloc(tplg->dev, item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
 636         if (!p)
 637                 return -ENOMEM;
 638
 639         p[0] = SNDRV_CTL_TLVT_DB_SCALE;
 640         p[1] = item_len;
 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);
 644
 645         kc->tlv.p = (void *)p;
 646         return 0;
 647 }
 648
 649 static int soc_tplg_create_tlv(struct soc_tplg *tplg,
 650         struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
 651 {
 652         struct snd_soc_tplg_ctl_tlv *tplg_tlv;
 653         u32 access = le32_to_cpu(tc->access);
 654
 655         if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
 656                 return 0;
 657
 658         if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
 659                 tplg_tlv = &tc->tlv;
 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,
 663                                         &tplg_tlv->scale);
 664
 665                 /* TODO: add support for other TLV types */
 666                 default:
 667                         dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
 668                                         tplg_tlv->type);
 669                         return -EINVAL;
 670                 }
 671         }
 672
 673         return 0;
 674 }
 675
 676 static int soc_tplg_dbytes_create(struct soc_tplg *tplg, unsigned int count,
 677         size_t size)
 678 {
 679         struct snd_soc_tplg_bytes_control *be;
 680         struct soc_bytes_ext *sbe;
 681         struct snd_kcontrol_new kc;
 682         int i;
 683         int err = 0;
 684
 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",
 689                         count);
 690                 return -EINVAL;
 691         }
 692
 693         for (i = 0; i < count; i++) {
 694                 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
 695
 696                 /* validate kcontrol */
 697                 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
 698                         SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
 699                         return -EINVAL;
 700
 701                 sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
 702                 if (sbe == NULL)
 703                         return -ENOMEM;
 704
 705                 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
 706                               le32_to_cpu(be->priv.size));
 707
 708                 dev_dbg(tplg->dev,
 709                         "ASoC: adding bytes kcontrol %s with access 0x%x\n",
 710                         be->hdr.name, be->hdr.access);
 711
 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);
 717
 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);
 722
 723                 /* map io handlers */
 724                 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc, tplg);
 725                 if (err) {
 726                         soc_control_err(tplg, &be->hdr, be->hdr.name);
 727                         break;
 728                 }
 729
 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);
 733                 if (err < 0) {
 734                         dev_err(tplg->dev, "ASoC: failed to init %s\n",
 735                                 be->hdr.name);
 736                         break;
 737                 }
 738
 739                 /* register control here */
 740                 err = soc_tplg_add_kcontrol(tplg, &kc,
 741                         &sbe->dobj.control.kcontrol);
 742                 if (err < 0) {
 743                         dev_err(tplg->dev, "ASoC: failed to add %s\n",
 744                                 be->hdr.name);
 745                         break;
 746                 }
 747
 748                 list_add(&sbe->dobj.list, &tplg->comp->dobj_list);
 749         }
 750         return err;
 751
 752 }
 753
 754 static int soc_tplg_dmixer_create(struct soc_tplg *tplg, unsigned int count,
 755         size_t size)
 756 {
 757         struct snd_soc_tplg_mixer_control *mc;
 758         struct soc_mixer_control *sm;
 759         struct snd_kcontrol_new kc;
 760         int i;
 761         int err = 0;
 762
 763         if (soc_tplg_check_elem_count(tplg,
 764                 sizeof(struct snd_soc_tplg_mixer_control),
 765                 count, size, "mixers")) {
 766
 767                 dev_err(tplg->dev, "ASoC: invalid count %d for controls\n",
 768                         count);
 769                 return -EINVAL;
 770         }
 771
 772         for (i = 0; i < count; i++) {
 773                 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
 774
 775                 /* validate kcontrol */
 776                 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
 777                         SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
 778                         return -EINVAL;
 779
 780                 sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
 781                 if (sm == NULL)
 782                         return -ENOMEM;
 783                 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
 784                               le32_to_cpu(mc->priv.size));
 785
 786                 dev_dbg(tplg->dev,
 787                         "ASoC: adding mixer kcontrol %s with access 0x%x\n",
 788                         mc->hdr.name, mc->hdr.access);
 789
 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);
 795
 796                 /* we only support FL/FR channel mapping atm */
 797                 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
 798                         SNDRV_CHMAP_FL);
 799                 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
 800                         SNDRV_CHMAP_FR);
 801                 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
 802                         SNDRV_CHMAP_FL);
 803                 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
 804                         SNDRV_CHMAP_FR);
 805
 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);
 814
 815                 /* map io handlers */
 816                 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc, tplg);
 817                 if (err) {
 818                         soc_control_err(tplg, &mc->hdr, mc->hdr.name);
 819                         break;
 820                 }
 821
 822                 /* create any TLV data */
 823                 err = soc_tplg_create_tlv(tplg, &kc, &mc->hdr);
 824                 if (err < 0) {
 825                         dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
 826                                 mc->hdr.name);
 827                         break;
 828                 }
 829
 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);
 833                 if (err < 0) {
 834                         dev_err(tplg->dev, "ASoC: failed to init %s\n",
 835                                 mc->hdr.name);
 836                         break;
 837                 }
 838
 839                 /* register control here */
 840                 err = soc_tplg_add_kcontrol(tplg, &kc,
 841                         &sm->dobj.control.kcontrol);
 842                 if (err < 0) {
 843                         dev_err(tplg->dev, "ASoC: failed to add %s\n",
 844                                 mc->hdr.name);
 845                         break;
 846                 }
 847
 848                 list_add(&sm->dobj.list, &tplg->comp->dobj_list);
 849         }
 850
 851         return err;
 852 }
 853
 854 static int soc_tplg_denum_create_texts(struct soc_tplg *tplg, struct soc_enum *se,
 855                                        struct snd_soc_tplg_enum_control *ec)
 856 {
 857         int i, ret;
 858
 859         se->dobj.control.dtexts =
 860                 devm_kcalloc(tplg->dev, le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
 861         if (se->dobj.control.dtexts == NULL)
 862                 return -ENOMEM;
 863
 864         for (i = 0; i < le32_to_cpu(ec->items); i++) {
 865
 866                 if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
 867                         SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
 868                         ret = -EINVAL;
 869                         goto err;
 870                 }
 871
 872                 se->dobj.control.dtexts[i] = devm_kstrdup(tplg->dev, ec->texts[i], GFP_KERNEL);
 873                 if (!se->dobj.control.dtexts[i]) {
 874                         ret = -ENOMEM;
 875                         goto err;
 876                 }
 877         }
 878
 879         se->items = le32_to_cpu(ec->items);
 880         se->texts = (const char * const *)se->dobj.control.dtexts;
 881         return 0;
 882
 883 err:
 884         return ret;
 885 }
 886
 887 static int soc_tplg_denum_create_values(struct soc_tplg *tplg, struct soc_enum *se,
 888                                         struct snd_soc_tplg_enum_control *ec)
 889 {
 890         int i;
 891
 892         if (le32_to_cpu(ec->items) > sizeof(*ec->values))
 893                 return -EINVAL;
 894
 895         se->dobj.control.dvalues = devm_kzalloc(tplg->dev, le32_to_cpu(ec->items) *
 896                                            sizeof(u32),
 897                                            GFP_KERNEL);
 898         if (!se->dobj.control.dvalues)
 899                 return -ENOMEM;
 900
 901         /* convert from little-endian */
 902         for (i = 0; i < le32_to_cpu(ec->items); i++) {
 903                 se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
 904         }
 905
 906         return 0;
 907 }
 908
 909 static int soc_tplg_denum_create(struct soc_tplg *tplg, unsigned int count,
 910         size_t size)
 911 {
 912         struct snd_soc_tplg_enum_control *ec;
 913         struct soc_enum *se;
 914         struct snd_kcontrol_new kc;
 915         int i;
 916         int err = 0;
 917
 918         if (soc_tplg_check_elem_count(tplg,
 919                 sizeof(struct snd_soc_tplg_enum_control),
 920                 count, size, "enums")) {
 921
 922                 dev_err(tplg->dev, "ASoC: invalid count %d for enum controls\n",
 923                         count);
 924                 return -EINVAL;
 925         }
 926
 927         for (i = 0; i < count; i++) {
 928                 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
 929
 930                 /* validate kcontrol */
 931                 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
 932                         SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
 933                         return -EINVAL;
 934
 935                 se = devm_kzalloc(tplg->dev, (sizeof(*se)), GFP_KERNEL);
 936                 if (se == NULL)
 937                         return -ENOMEM;
 938
 939                 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
 940                               le32_to_cpu(ec->priv.size));
 941
 942                 dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n",
 943                         ec->hdr.name, ec->items);
 944
 945                 memset(&kc, 0, sizeof(kc));
 946                 kc.name = ec->hdr.name;
 947                 kc.private_value = (long)se;
 948                 kc.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 949                 kc.access = le32_to_cpu(ec->hdr.access);
 950
 951                 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
 952                 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
 953                         SNDRV_CHMAP_FL);
 954                 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
 955                         SNDRV_CHMAP_FL);
 956
 957                 se->mask = le32_to_cpu(ec->mask);
 958                 se->dobj.index = tplg->index;
 959                 se->dobj.type = SND_SOC_DOBJ_ENUM;
 960                 se->dobj.ops = tplg->ops;
 961                 INIT_LIST_HEAD(&se->dobj.list);
 962
 963                 switch (le32_to_cpu(ec->hdr.ops.info)) {
 964                 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
 965                 case SND_SOC_TPLG_CTL_ENUM_VALUE:
 966                         err = soc_tplg_denum_create_values(tplg, se, ec);
 967                         if (err < 0) {
 968                                 dev_err(tplg->dev,
 969                                         "ASoC: could not create values for %s\n",
 970                                         ec->hdr.name);
 971                                 goto err_denum;
 972                         }
 973                         fallthrough;
 974                 case SND_SOC_TPLG_CTL_ENUM:
 975                 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
 976                 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
 977                         err = soc_tplg_denum_create_texts(tplg, se, ec);
 978                         if (err < 0) {
 979                                 dev_err(tplg->dev,
 980                                         "ASoC: could not create texts for %s\n",
 981                                         ec->hdr.name);
 982                                 goto err_denum;
 983                         }
 984                         break;
 985                 default:
 986                         err = -EINVAL;
 987                         dev_err(tplg->dev,
 988                                 "ASoC: invalid enum control type %d for %s\n",
 989                                 ec->hdr.ops.info, ec->hdr.name);
 990                         goto err_denum;
 991                 }
 992
 993                 /* map io handlers */
 994                 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc, tplg);
 995                 if (err) {
 996                         soc_control_err(tplg, &ec->hdr, ec->hdr.name);
 997                         goto err_denum;
 998                 }
 999
1000                 /* pass control to driver for optional further init */
1001                 err = soc_tplg_init_kcontrol(tplg, &kc,
1002                         (struct snd_soc_tplg_ctl_hdr *) ec);
1003                 if (err < 0) {
1004                         dev_err(tplg->dev, "ASoC: failed to init %s\n",
1005                                 ec->hdr.name);
1006                         goto err_denum;
1007                 }
1008
1009                 /* register control here */
1010                 err = soc_tplg_add_kcontrol(tplg,
1011                                             &kc, &se->dobj.control.kcontrol);
1012                 if (err < 0) {
1013                         dev_err(tplg->dev, "ASoC: could not add kcontrol %s\n",
1014                                 ec->hdr.name);
1015                         goto err_denum;
1016                 }
1017
1018                 list_add(&se->dobj.list, &tplg->comp->dobj_list);
1019         }
1020         return 0;
1021
1022 err_denum:
1023         return err;
1024 }
1025
1026 static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
1027         struct snd_soc_tplg_hdr *hdr)
1028 {
1029         struct snd_soc_tplg_ctl_hdr *control_hdr;
1030         int ret;
1031         int i;
1032
1033         dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
1034                 soc_tplg_get_offset(tplg));
1035
1036         for (i = 0; i < le32_to_cpu(hdr->count); i++) {
1037
1038                 control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1039
1040                 if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
1041                         dev_err(tplg->dev, "ASoC: invalid control size\n");
1042                         return -EINVAL;
1043                 }
1044
1045                 switch (le32_to_cpu(control_hdr->ops.info)) {
1046                 case SND_SOC_TPLG_CTL_VOLSW:
1047                 case SND_SOC_TPLG_CTL_STROBE:
1048                 case SND_SOC_TPLG_CTL_VOLSW_SX:
1049                 case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1050                 case SND_SOC_TPLG_CTL_RANGE:
1051                 case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1052                 case SND_SOC_TPLG_DAPM_CTL_PIN:
1053                         ret = soc_tplg_dmixer_create(tplg, 1,
1054                                         le32_to_cpu(hdr->payload_size));
1055                         break;
1056                 case SND_SOC_TPLG_CTL_ENUM:
1057                 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1058                 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1059                 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1060                 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1061                         ret = soc_tplg_denum_create(tplg, 1,
1062                                         le32_to_cpu(hdr->payload_size));
1063                         break;
1064                 case SND_SOC_TPLG_CTL_BYTES:
1065                         ret = soc_tplg_dbytes_create(tplg, 1,
1066                                         le32_to_cpu(hdr->payload_size));
1067                         break;
1068                 default:
1069                         soc_bind_err(tplg, control_hdr, i);
1070                         return -EINVAL;
1071                 }
1072                 if (ret < 0) {
1073                         dev_err(tplg->dev, "ASoC: invalid control\n");
1074                         return ret;
1075                 }
1076
1077         }
1078
1079         return 0;
1080 }
1081
1082 /* optionally pass new dynamic kcontrol to component driver. */
1083 static int soc_tplg_add_route(struct soc_tplg *tplg,
1084         struct snd_soc_dapm_route *route)
1085 {
1086         if (tplg->ops && tplg->ops->dapm_route_load)
1087                 return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
1088                         route);
1089
1090         return 0;
1091 }
1092
1093 static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
1094         struct snd_soc_tplg_hdr *hdr)
1095 {
1096         struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1097         struct snd_soc_tplg_dapm_graph_elem *elem;
1098         struct snd_soc_dapm_route **routes;
1099         int count, i;
1100         int ret = 0;
1101
1102         count = le32_to_cpu(hdr->count);
1103
1104         if (soc_tplg_check_elem_count(tplg,
1105                 sizeof(struct snd_soc_tplg_dapm_graph_elem),
1106                 count, le32_to_cpu(hdr->payload_size), "graph")) {
1107
1108                 dev_err(tplg->dev, "ASoC: invalid count %d for DAPM routes\n",
1109                         count);
1110                 return -EINVAL;
1111         }
1112
1113         dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
1114                 hdr->index);
1115
1116         /* allocate memory for pointer to array of dapm routes */
1117         routes = kcalloc(count, sizeof(struct snd_soc_dapm_route *),
1118                          GFP_KERNEL);
1119         if (!routes)
1120                 return -ENOMEM;
1121
1122         /*
1123          * allocate memory for each dapm route in the array.
1124          * This needs to be done individually so that
1125          * each route can be freed when it is removed in remove_route().
1126          */
1127         for (i = 0; i < count; i++) {
1128                 routes[i] = devm_kzalloc(tplg->dev, sizeof(*routes[i]), GFP_KERNEL);
1129                 if (!routes[i])
1130                         return -ENOMEM;
1131         }
1132
1133         for (i = 0; i < count; i++) {
1134                 elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
1135                 tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);
1136
1137                 /* validate routes */
1138                 if (strnlen(elem->source, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1139                             SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1140                         ret = -EINVAL;
1141                         break;
1142                 }
1143                 if (strnlen(elem->sink, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1144                             SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1145                         ret = -EINVAL;
1146                         break;
1147                 }
1148                 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1149                             SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
1150                         ret = -EINVAL;
1151                         break;
1152                 }
1153
1154                 routes[i]->source = elem->source;
1155                 routes[i]->sink = elem->sink;
1156
1157                 /* set to NULL atm for tplg users */
1158                 routes[i]->connected = NULL;
1159                 if (strnlen(elem->control, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == 0)
1160                         routes[i]->control = NULL;
1161                 else
1162                         routes[i]->control = elem->control;
1163
1164                 /* add route dobj to dobj_list */
1165                 routes[i]->dobj.type = SND_SOC_DOBJ_GRAPH;
1166                 routes[i]->dobj.ops = tplg->ops;
1167                 routes[i]->dobj.index = tplg->index;
1168                 list_add(&routes[i]->dobj.list, &tplg->comp->dobj_list);
1169
1170                 ret = soc_tplg_add_route(tplg, routes[i]);
1171                 if (ret < 0) {
1172                         dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
1173                         /*
1174                          * this route was added to the list, it will
1175                          * be freed in remove_route() so increment the
1176                          * counter to skip it in the error handling
1177                          * below.
1178                          */
1179                         i++;
1180                         break;
1181                 }
1182
1183                 /* add route, but keep going if some fail */
1184                 snd_soc_dapm_add_routes(dapm, routes[i], 1);
1185         }
1186
1187         /*
1188          * free pointer to array of dapm routes as this is no longer needed.
1189          * The memory allocated for each dapm route will be freed
1190          * when it is removed in remove_route().
1191          */
1192         kfree(routes);
1193
1194         return ret;
1195 }
1196
1197 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dmixer_create(
1198         struct soc_tplg *tplg, int num_kcontrols)
1199 {
1200         struct snd_kcontrol_new *kc;
1201         struct soc_mixer_control *sm;
1202         struct snd_soc_tplg_mixer_control *mc;
1203         int i, err;
1204
1205         kc = devm_kcalloc(tplg->dev, num_kcontrols, sizeof(*kc), GFP_KERNEL);
1206         if (kc == NULL)
1207                 return NULL;
1208
1209         for (i = 0; i < num_kcontrols; i++) {
1210                 mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;
1211
1212                 /* validate kcontrol */
1213                 if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1214                         SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1215                         goto err_sm;
1216
1217                 sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
1218                 if (sm == NULL)
1219                         goto err_sm;
1220
1221                 tplg->pos += (sizeof(struct snd_soc_tplg_mixer_control) +
1222                               le32_to_cpu(mc->priv.size));
1223
1224                 dev_dbg(tplg->dev, " adding DAPM widget mixer control %s at %d\n",
1225                         mc->hdr.name, i);
1226
1227                 kc[i].private_value = (long)sm;
1228                 kc[i].name = devm_kstrdup(tplg->dev, mc->hdr.name, GFP_KERNEL);
1229                 if (kc[i].name == NULL)
1230                         goto err_sm;
1231                 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1232                 kc[i].access = le32_to_cpu(mc->hdr.access);
1233
1234                 /* we only support FL/FR channel mapping atm */
1235                 sm->reg = tplc_chan_get_reg(tplg, mc->channel,
1236                         SNDRV_CHMAP_FL);
1237                 sm->rreg = tplc_chan_get_reg(tplg, mc->channel,
1238                         SNDRV_CHMAP_FR);
1239                 sm->shift = tplc_chan_get_shift(tplg, mc->channel,
1240                         SNDRV_CHMAP_FL);
1241                 sm->rshift = tplc_chan_get_shift(tplg, mc->channel,
1242                         SNDRV_CHMAP_FR);
1243
1244                 sm->max = le32_to_cpu(mc->max);
1245                 sm->min = le32_to_cpu(mc->min);
1246                 sm->invert = le32_to_cpu(mc->invert);
1247                 sm->platform_max = le32_to_cpu(mc->platform_max);
1248                 sm->dobj.index = tplg->index;
1249                 INIT_LIST_HEAD(&sm->dobj.list);
1250
1251                 /* map io handlers */
1252                 err = soc_tplg_kcontrol_bind_io(&mc->hdr, &kc[i], tplg);
1253                 if (err) {
1254                         soc_control_err(tplg, &mc->hdr, mc->hdr.name);
1255                         goto err_sm;
1256                 }
1257
1258                 /* create any TLV data */
1259                 err = soc_tplg_create_tlv(tplg, &kc[i], &mc->hdr);
1260                 if (err < 0) {
1261                         dev_err(tplg->dev, "ASoC: failed to create TLV %s\n",
1262                                 mc->hdr.name);
1263                         goto err_sm;
1264                 }
1265
1266                 /* pass control to driver for optional further init */
1267                 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1268                         (struct snd_soc_tplg_ctl_hdr *)mc);
1269                 if (err < 0) {
1270                         dev_err(tplg->dev, "ASoC: failed to init %s\n",
1271                                 mc->hdr.name);
1272                         goto err_sm;
1273                 }
1274         }
1275         return kc;
1276
1277 err_sm:
1278         return NULL;
1279 }
1280
1281 static struct snd_kcontrol_new *soc_tplg_dapm_widget_denum_create(
1282         struct soc_tplg *tplg, int num_kcontrols)
1283 {
1284         struct snd_kcontrol_new *kc;
1285         struct snd_soc_tplg_enum_control *ec;
1286         struct soc_enum *se;
1287         int i, err;
1288
1289         kc = devm_kcalloc(tplg->dev, num_kcontrols, sizeof(*kc), GFP_KERNEL);
1290         if (kc == NULL)
1291                 return NULL;
1292
1293         for (i = 0; i < num_kcontrols; i++) {
1294                 ec = (struct snd_soc_tplg_enum_control *)tplg->pos;
1295                 /* validate kcontrol */
1296                 if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1297                             SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1298                         goto err_se;
1299
1300                 se = devm_kzalloc(tplg->dev, sizeof(*se), GFP_KERNEL);
1301                 if (se == NULL)
1302                         goto err_se;
1303
1304                 tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) +
1305                               le32_to_cpu(ec->priv.size));
1306
1307                 dev_dbg(tplg->dev, " adding DAPM widget enum control %s\n",
1308                         ec->hdr.name);
1309
1310                 kc[i].private_value = (long)se;
1311                 kc[i].name = devm_kstrdup(tplg->dev, ec->hdr.name, GFP_KERNEL);
1312                 if (kc[i].name == NULL)
1313                         goto err_se;
1314                 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1315                 kc[i].access = le32_to_cpu(ec->hdr.access);
1316
1317                 /* we only support FL/FR channel mapping atm */
1318                 se->reg = tplc_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
1319                 se->shift_l = tplc_chan_get_shift(tplg, ec->channel,
1320                                                   SNDRV_CHMAP_FL);
1321                 se->shift_r = tplc_chan_get_shift(tplg, ec->channel,
1322                                                   SNDRV_CHMAP_FR);
1323
1324                 se->items = le32_to_cpu(ec->items);
1325                 se->mask = le32_to_cpu(ec->mask);
1326                 se->dobj.index = tplg->index;
1327
1328                 switch (le32_to_cpu(ec->hdr.ops.info)) {
1329                 case SND_SOC_TPLG_CTL_ENUM_VALUE:
1330                 case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1331                         err = soc_tplg_denum_create_values(tplg, se, ec);
1332                         if (err < 0) {
1333                                 dev_err(tplg->dev, "ASoC: could not create values for %s\n",
1334                                         ec->hdr.name);
1335                                 goto err_se;
1336                         }
1337                         fallthrough;
1338                 case SND_SOC_TPLG_CTL_ENUM:
1339                 case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1340                 case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1341                         err = soc_tplg_denum_create_texts(tplg, se, ec);
1342                         if (err < 0) {
1343                                 dev_err(tplg->dev, "ASoC: could not create texts for %s\n",
1344                                         ec->hdr.name);
1345                                 goto err_se;
1346                         }
1347                         break;
1348                 default:
1349                         dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
1350                                 ec->hdr.ops.info, ec->hdr.name);
1351                         goto err_se;
1352                 }
1353
1354                 /* map io handlers */
1355                 err = soc_tplg_kcontrol_bind_io(&ec->hdr, &kc[i], tplg);
1356                 if (err) {
1357                         soc_control_err(tplg, &ec->hdr, ec->hdr.name);
1358                         goto err_se;
1359                 }
1360
1361                 /* pass control to driver for optional further init */
1362                 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1363                         (struct snd_soc_tplg_ctl_hdr *)ec);
1364                 if (err < 0) {
1365                         dev_err(tplg->dev, "ASoC: failed to init %s\n",
1366                                 ec->hdr.name);
1367                         goto err_se;
1368                 }
1369         }
1370
1371         return kc;
1372
1373 err_se:
1374         return NULL;
1375 }
1376
1377 static struct snd_kcontrol_new *soc_tplg_dapm_widget_dbytes_create(
1378         struct soc_tplg *tplg, int num_kcontrols)
1379 {
1380         struct snd_soc_tplg_bytes_control *be;
1381         struct soc_bytes_ext *sbe;
1382         struct snd_kcontrol_new *kc;
1383         int i, err;
1384
1385         kc = devm_kcalloc(tplg->dev, num_kcontrols, sizeof(*kc), GFP_KERNEL);
1386         if (!kc)
1387                 return NULL;
1388
1389         for (i = 0; i < num_kcontrols; i++) {
1390                 be = (struct snd_soc_tplg_bytes_control *)tplg->pos;
1391
1392                 /* validate kcontrol */
1393                 if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1394                         SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1395                         goto err_sbe;
1396
1397                 sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
1398                 if (sbe == NULL)
1399                         goto err_sbe;
1400
1401                 tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) +
1402                               le32_to_cpu(be->priv.size));
1403
1404                 dev_dbg(tplg->dev,
1405                         "ASoC: adding bytes kcontrol %s with access 0x%x\n",
1406                         be->hdr.name, be->hdr.access);
1407
1408                 kc[i].private_value = (long)sbe;
1409                 kc[i].name = devm_kstrdup(tplg->dev, be->hdr.name, GFP_KERNEL);
1410                 if (kc[i].name == NULL)
1411                         goto err_sbe;
1412                 kc[i].iface = SNDRV_CTL_ELEM_IFACE_MIXER;
1413                 kc[i].access = le32_to_cpu(be->hdr.access);
1414
1415                 sbe->max = le32_to_cpu(be->max);
1416                 INIT_LIST_HEAD(&sbe->dobj.list);
1417
1418                 /* map standard io handlers and check for external handlers */
1419                 err = soc_tplg_kcontrol_bind_io(&be->hdr, &kc[i], tplg);
1420                 if (err) {
1421                         soc_control_err(tplg, &be->hdr, be->hdr.name);
1422                         goto err_sbe;
1423                 }
1424
1425                 /* pass control to driver for optional further init */
1426                 err = soc_tplg_init_kcontrol(tplg, &kc[i],
1427                         (struct snd_soc_tplg_ctl_hdr *)be);
1428                 if (err < 0) {
1429                         dev_err(tplg->dev, "ASoC: failed to init %s\n",
1430                                 be->hdr.name);
1431                         goto err_sbe;
1432                 }
1433         }
1434
1435         return kc;
1436
1437 err_sbe:
1438
1439         return NULL;
1440 }
1441
1442 static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
1443         struct snd_soc_tplg_dapm_widget *w)
1444 {
1445         struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
1446         struct snd_soc_dapm_widget template, *widget;
1447         struct snd_soc_tplg_ctl_hdr *control_hdr;
1448         struct snd_soc_card *card = tplg->comp->card;
1449         unsigned int kcontrol_type;
1450         int ret = 0;
1451
1452         if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1453                 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1454                 return -EINVAL;
1455         if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
1456                 SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
1457                 return -EINVAL;
1458
1459         dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
1460                 w->name, w->id);
1461
1462         memset(&template, 0, sizeof(template));
1463
1464         /* map user to kernel widget ID */
1465         template.id = get_widget_id(le32_to_cpu(w->id));
1466         if ((int)template.id < 0)
1467                 return template.id;
1468
1469         /* strings are allocated here, but used and freed by the widget */
1470         template.name = kstrdup(w->name, GFP_KERNEL);
1471         if (!template.name)
1472                 return -ENOMEM;
1473         template.sname = kstrdup(w->sname, GFP_KERNEL);
1474         if (!template.sname) {
1475                 ret = -ENOMEM;
1476                 goto err;
1477         }
1478         template.reg = le32_to_cpu(w->reg);
1479         template.shift = le32_to_cpu(w->shift);
1480         template.mask = le32_to_cpu(w->mask);
1481         template.subseq = le32_to_cpu(w->subseq);
1482         template.on_val = w->invert ? 0 : 1;
1483         template.off_val = w->invert ? 1 : 0;
1484         template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
1485         template.event_flags = le16_to_cpu(w->event_flags);
1486         template.dobj.index = tplg->index;
1487
1488         tplg->pos +=
1489                 (sizeof(struct snd_soc_tplg_dapm_widget) +
1490                  le32_to_cpu(w->priv.size));
1491
1492         if (w->num_kcontrols == 0) {
1493                 kcontrol_type = 0;
1494                 template.num_kcontrols = 0;
1495                 goto widget;
1496         }
1497
1498         control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;
1499         dev_dbg(tplg->dev, "ASoC: template %s has %d controls of type %x\n",
1500                 w->name, w->num_kcontrols, control_hdr->type);
1501
1502         switch (le32_to_cpu(control_hdr->ops.info)) {
1503         case SND_SOC_TPLG_CTL_VOLSW:
1504         case SND_SOC_TPLG_CTL_STROBE:
1505         case SND_SOC_TPLG_CTL_VOLSW_SX:
1506         case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
1507         case SND_SOC_TPLG_CTL_RANGE:
1508         case SND_SOC_TPLG_DAPM_CTL_VOLSW:
1509                 kcontrol_type = SND_SOC_TPLG_TYPE_MIXER;  /* volume mixer */
1510                 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1511                 template.kcontrol_news =
1512                         soc_tplg_dapm_widget_dmixer_create(tplg,
1513                         template.num_kcontrols);
1514                 if (!template.kcontrol_news) {
1515                         ret = -ENOMEM;
1516                         goto hdr_err;
1517                 }
1518                 break;
1519         case SND_SOC_TPLG_CTL_ENUM:
1520         case SND_SOC_TPLG_CTL_ENUM_VALUE:
1521         case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
1522         case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
1523         case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
1524                 kcontrol_type = SND_SOC_TPLG_TYPE_ENUM; /* enumerated mixer */
1525                 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1526                 template.kcontrol_news =
1527                         soc_tplg_dapm_widget_denum_create(tplg,
1528                         template.num_kcontrols);
1529                 if (!template.kcontrol_news) {
1530                         ret = -ENOMEM;
1531                         goto hdr_err;
1532                 }
1533                 break;
1534         case SND_SOC_TPLG_CTL_BYTES:
1535                 kcontrol_type = SND_SOC_TPLG_TYPE_BYTES; /* bytes control */
1536                 template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
1537                 template.kcontrol_news =
1538                         soc_tplg_dapm_widget_dbytes_create(tplg,
1539                                 template.num_kcontrols);
1540                 if (!template.kcontrol_news) {
1541                         ret = -ENOMEM;
1542                         goto hdr_err;
1543                 }
1544                 break;
1545         default:
1546                 dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
1547                         control_hdr->ops.get, control_hdr->ops.put,
1548                         le32_to_cpu(control_hdr->ops.info));
1549                 ret = -EINVAL;
1550                 goto hdr_err;
1551         }
1552
1553 widget:
1554         ret = soc_tplg_widget_load(tplg, &template, w);
1555         if (ret < 0)
1556                 goto hdr_err;
1557
1558         /* card dapm mutex is held by the core if we are loading topology
1559          * data during sound card init. */
1560         if (card->instantiated)
1561                 widget = snd_soc_dapm_new_control(dapm, &template);
1562         else
1563                 widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
1564         if (IS_ERR(widget)) {
1565                 ret = PTR_ERR(widget);
1566                 goto hdr_err;
1567         }
1568
1569         widget->dobj.type = SND_SOC_DOBJ_WIDGET;
1570         widget->dobj.widget.kcontrol_type = kcontrol_type;
1571         widget->dobj.ops = tplg->ops;
1572         widget->dobj.index = tplg->index;
1573         list_add(&widget->dobj.list, &tplg->comp->dobj_list);
1574
1575         ret = soc_tplg_widget_ready(tplg, widget, w);
1576         if (ret < 0)
1577                 goto ready_err;
1578
1579         kfree(template.sname);
1580         kfree(template.name);
1581
1582         return 0;
1583
1584 ready_err:
1585         remove_widget(widget->dapm->component, &widget->dobj, SOC_TPLG_PASS_WIDGET);
1586         snd_soc_dapm_free_widget(widget);
1587 hdr_err:
1588         kfree(template.sname);
1589 err:
1590         kfree(template.name);
1591         return ret;
1592 }
1593
1594 static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
1595         struct snd_soc_tplg_hdr *hdr)
1596 {
1597         struct snd_soc_tplg_dapm_widget *widget;
1598         int ret, count, i;
1599
1600         count = le32_to_cpu(hdr->count);
1601
1602         dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);
1603
1604         for (i = 0; i < count; i++) {
1605                 widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
1606                 if (le32_to_cpu(widget->size) != sizeof(*widget)) {
1607                         dev_err(tplg->dev, "ASoC: invalid widget size\n");
1608                         return -EINVAL;
1609                 }
1610
1611                 ret = soc_tplg_dapm_widget_create(tplg, widget);
1612                 if (ret < 0) {
1613                         dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
1614                                 widget->name);
1615                         return ret;
1616                 }
1617         }
1618
1619         return 0;
1620 }
1621
1622 static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
1623 {
1624         struct snd_soc_card *card = tplg->comp->card;
1625         int ret;
1626
1627         /* Card might not have been registered at this point.
1628          * If so, just return success.
1629         */
1630         if (!card || !card->instantiated) {
1631                 dev_warn(tplg->dev, "ASoC: Parent card not yet available,"
1632                         " widget card binding deferred\n");
1633                 return 0;
1634         }
1635
1636         ret = snd_soc_dapm_new_widgets(card);
1637         if (ret < 0)
1638                 dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n",
1639                         ret);
1640
1641         return 0;
1642 }
1643
1644 static int set_stream_info(struct soc_tplg *tplg, struct snd_soc_pcm_stream *stream,
1645                            struct snd_soc_tplg_stream_caps *caps)
1646 {
1647         stream->stream_name = devm_kstrdup(tplg->dev, caps->name, GFP_KERNEL);
1648         if (!stream->stream_name)
1649                 return -ENOMEM;
1650
1651         stream->channels_min = le32_to_cpu(caps->channels_min);
1652         stream->channels_max = le32_to_cpu(caps->channels_max);
1653         stream->rates = le32_to_cpu(caps->rates);
1654         stream->rate_min = le32_to_cpu(caps->rate_min);
1655         stream->rate_max = le32_to_cpu(caps->rate_max);
1656         stream->formats = le64_to_cpu(caps->formats);
1657         stream->sig_bits = le32_to_cpu(caps->sig_bits);
1658
1659         return 0;
1660 }
1661
1662 static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
1663                           unsigned int flag_mask, unsigned int flags)
1664 {
1665         if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
1666                 dai_drv->symmetric_rates =
1667                         flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1668
1669         if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
1670                 dai_drv->symmetric_channels =
1671                         flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS ?
1672                         1 : 0;
1673
1674         if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
1675                 dai_drv->symmetric_samplebits =
1676                         flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1677                         1 : 0;
1678 }
1679
1680 static int soc_tplg_dai_create(struct soc_tplg *tplg,
1681         struct snd_soc_tplg_pcm *pcm)
1682 {
1683         struct snd_soc_dai_driver *dai_drv;
1684         struct snd_soc_pcm_stream *stream;
1685         struct snd_soc_tplg_stream_caps *caps;
1686         struct snd_soc_dai *dai;
1687         struct snd_soc_dapm_context *dapm =
1688                 snd_soc_component_get_dapm(tplg->comp);
1689         int ret;
1690
1691         dai_drv = devm_kzalloc(tplg->dev, sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
1692         if (dai_drv == NULL)
1693                 return -ENOMEM;
1694
1695         if (strlen(pcm->dai_name)) {
1696                 dai_drv->name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1697                 if (!dai_drv->name) {
1698                         ret = -ENOMEM;
1699                         goto err;
1700                 }
1701         }
1702         dai_drv->id = le32_to_cpu(pcm->dai_id);
1703
1704         if (pcm->playback) {
1705                 stream = &dai_drv->playback;
1706                 caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
1707                 ret = set_stream_info(tplg, stream, caps);
1708                 if (ret < 0)
1709                         goto err;
1710         }
1711
1712         if (pcm->capture) {
1713                 stream = &dai_drv->capture;
1714                 caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
1715                 ret = set_stream_info(tplg, stream, caps);
1716                 if (ret < 0)
1717                         goto err;
1718         }
1719
1720         if (pcm->compress)
1721                 dai_drv->compress_new = snd_soc_new_compress;
1722
1723         /* pass control to component driver for optional further init */
1724         ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
1725         if (ret < 0) {
1726                 dev_err(tplg->dev, "ASoC: DAI loading failed\n");
1727                 goto err;
1728         }
1729
1730         dai_drv->dobj.index = tplg->index;
1731         dai_drv->dobj.ops = tplg->ops;
1732         dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
1733         list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);
1734
1735         /* register the DAI to the component */
1736         dai = devm_snd_soc_register_dai(tplg->dev, tplg->comp, dai_drv, false);
1737         if (!dai)
1738                 return -ENOMEM;
1739
1740         /* Create the DAI widgets here */
1741         ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
1742         if (ret != 0) {
1743                 dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
1744                 return ret;
1745         }
1746
1747         return 0;
1748
1749 err:
1750         return ret;
1751 }
1752
1753 static void set_link_flags(struct snd_soc_dai_link *link,
1754                 unsigned int flag_mask, unsigned int flags)
1755 {
1756         if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
1757                 link->symmetric_rates =
1758                         flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES ? 1 : 0;
1759
1760         if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
1761                 link->symmetric_channels =
1762                         flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS ?
1763                         1 : 0;
1764
1765         if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
1766                 link->symmetric_samplebits =
1767                         flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS ?
1768                         1 : 0;
1769
1770         if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
1771                 link->ignore_suspend =
1772                 flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP ?
1773                 1 : 0;
1774 }
1775
1776 /* create the FE DAI link */
1777 static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
1778         struct snd_soc_tplg_pcm *pcm)
1779 {
1780         struct snd_soc_dai_link *link;
1781         struct snd_soc_dai_link_component *dlc;
1782         int ret;
1783
1784         /* link + cpu + codec + platform */
1785         link = devm_kzalloc(tplg->dev, sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
1786         if (link == NULL)
1787                 return -ENOMEM;
1788
1789         dlc = (struct snd_soc_dai_link_component *)(link + 1);
1790
1791         link->cpus      = &dlc[0];
1792         link->codecs    = &dlc[1];
1793         link->platforms = &dlc[2];
1794
1795         link->num_cpus   = 1;
1796         link->num_codecs = 1;
1797         link->num_platforms = 1;
1798
1799         link->dobj.index = tplg->index;
1800         link->dobj.ops = tplg->ops;
1801         link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
1802
1803         if (strlen(pcm->pcm_name)) {
1804                 link->name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1805                 link->stream_name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
1806                 if (!link->name || !link->stream_name) {
1807                         ret = -ENOMEM;
1808                         goto err;
1809                 }
1810         }
1811         link->id = le32_to_cpu(pcm->pcm_id);
1812
1813         if (strlen(pcm->dai_name)) {
1814                 link->cpus->dai_name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
1815                 if (!link->cpus->dai_name) {
1816                         ret = -ENOMEM;
1817                         goto err;
1818                 }
1819         }
1820
1821         link->codecs->name = "snd-soc-dummy";
1822         link->codecs->dai_name = "snd-soc-dummy-dai";
1823
1824         link->platforms->name = "snd-soc-dummy";
1825
1826         /* enable DPCM */
1827         link->dynamic = 1;
1828         link->dpcm_playback = le32_to_cpu(pcm->playback);
1829         link->dpcm_capture = le32_to_cpu(pcm->capture);
1830         if (pcm->flag_mask)
1831                 set_link_flags(link,
1832                                le32_to_cpu(pcm->flag_mask),
1833                                le32_to_cpu(pcm->flags));
1834
1835         /* pass control to component driver for optional further init */
1836         ret = soc_tplg_dai_link_load(tplg, link, NULL);
1837         if (ret < 0) {
1838                 dev_err(tplg->dev, "ASoC: FE link loading failed\n");
1839                 goto err;
1840         }
1841
1842         ret = snd_soc_add_pcm_runtime(tplg->comp->card, link);
1843         if (ret < 0) {
1844                 dev_err(tplg->dev, "ASoC: adding FE link failed\n");
1845                 goto err;
1846         }
1847
1848         list_add(&link->dobj.list, &tplg->comp->dobj_list);
1849
1850         return 0;
1851 err:
1852         return ret;
1853 }
1854
1855 /* create a FE DAI and DAI link from the PCM object */
1856 static int soc_tplg_pcm_create(struct soc_tplg *tplg,
1857         struct snd_soc_tplg_pcm *pcm)
1858 {
1859         int ret;
1860
1861         ret = soc_tplg_dai_create(tplg, pcm);
1862         if (ret < 0)
1863                 return ret;
1864
1865         return  soc_tplg_fe_link_create(tplg, pcm);
1866 }
1867
1868 /* copy stream caps from the old version 4 of source */
1869 static void stream_caps_new_ver(struct snd_soc_tplg_stream_caps *dest,
1870                                 struct snd_soc_tplg_stream_caps_v4 *src)
1871 {
1872         dest->size = cpu_to_le32(sizeof(*dest));
1873         memcpy(dest->name, src->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1874         dest->formats = src->formats;
1875         dest->rates = src->rates;
1876         dest->rate_min = src->rate_min;
1877         dest->rate_max = src->rate_max;
1878         dest->channels_min = src->channels_min;
1879         dest->channels_max = src->channels_max;
1880         dest->periods_min = src->periods_min;
1881         dest->periods_max = src->periods_max;
1882         dest->period_size_min = src->period_size_min;
1883         dest->period_size_max = src->period_size_max;
1884         dest->buffer_size_min = src->buffer_size_min;
1885         dest->buffer_size_max = src->buffer_size_max;
1886 }
1887
1888 /**
1889  * pcm_new_ver - Create the new version of PCM from the old version.
1890  * @tplg: topology context
1891  * @src: older version of pcm as a source
1892  * @pcm: latest version of pcm created from the source
1893  *
1894  * Support from vesion 4. User should free the returned pcm manually.
1895  */
1896 static int pcm_new_ver(struct soc_tplg *tplg,
1897                        struct snd_soc_tplg_pcm *src,
1898                        struct snd_soc_tplg_pcm **pcm)
1899 {
1900         struct snd_soc_tplg_pcm *dest;
1901         struct snd_soc_tplg_pcm_v4 *src_v4;
1902         int i;
1903
1904         *pcm = NULL;
1905
1906         if (le32_to_cpu(src->size) != sizeof(*src_v4)) {
1907                 dev_err(tplg->dev, "ASoC: invalid PCM size\n");
1908                 return -EINVAL;
1909         }
1910
1911         dev_warn(tplg->dev, "ASoC: old version of PCM\n");
1912         src_v4 = (struct snd_soc_tplg_pcm_v4 *)src;
1913         dest = kzalloc(sizeof(*dest), GFP_KERNEL);
1914         if (!dest)
1915                 return -ENOMEM;
1916
1917         dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
1918         memcpy(dest->pcm_name, src_v4->pcm_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1919         memcpy(dest->dai_name, src_v4->dai_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
1920         dest->pcm_id = src_v4->pcm_id;
1921         dest->dai_id = src_v4->dai_id;
1922         dest->playback = src_v4->playback;
1923         dest->capture = src_v4->capture;
1924         dest->compress = src_v4->compress;
1925         dest->num_streams = src_v4->num_streams;
1926         for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
1927                 memcpy(&dest->stream[i], &src_v4->stream[i],
1928                        sizeof(struct snd_soc_tplg_stream));
1929
1930         for (i = 0; i < 2; i++)
1931                 stream_caps_new_ver(&dest->caps[i], &src_v4->caps[i]);
1932
1933         *pcm = dest;
1934         return 0;
1935 }
1936
1937 static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
1938         struct snd_soc_tplg_hdr *hdr)
1939 {
1940         struct snd_soc_tplg_pcm *pcm, *_pcm;
1941         int count;
1942         int size;
1943         int i;
1944         bool abi_match;
1945         int ret;
1946
1947         count = le32_to_cpu(hdr->count);
1948
1949         /* check the element size and count */
1950         pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1951         size = le32_to_cpu(pcm->size);
1952         if (size > sizeof(struct snd_soc_tplg_pcm)
1953                 || size < sizeof(struct snd_soc_tplg_pcm_v4)) {
1954                 dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
1955                         size);
1956                 return -EINVAL;
1957         }
1958
1959         if (soc_tplg_check_elem_count(tplg,
1960                                       size, count,
1961                                       le32_to_cpu(hdr->payload_size),
1962                                       "PCM DAI")) {
1963                 dev_err(tplg->dev, "ASoC: invalid count %d for PCM DAI elems\n",
1964                         count);
1965                 return -EINVAL;
1966         }
1967
1968         for (i = 0; i < count; i++) {
1969                 pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
1970                 size = le32_to_cpu(pcm->size);
1971
1972                 /* check ABI version by size, create a new version of pcm
1973                  * if abi not match.
1974                  */
1975                 if (size == sizeof(*pcm)) {
1976                         abi_match = true;
1977                         _pcm = pcm;
1978                 } else {
1979                         abi_match = false;
1980                         ret = pcm_new_ver(tplg, pcm, &_pcm);
1981                         if (ret < 0)
1982                                 return ret;
1983                 }
1984
1985                 /* create the FE DAIs and DAI links */
1986                 ret = soc_tplg_pcm_create(tplg, _pcm);
1987                 if (ret < 0) {
1988                         if (!abi_match)
1989                                 kfree(_pcm);
1990                         return ret;
1991                 }
1992
1993                 /* offset by version-specific struct size and
1994                  * real priv data size
1995                  */
1996                 tplg->pos += size + le32_to_cpu(_pcm->priv.size);
1997
1998                 if (!abi_match)
1999                         kfree(_pcm); /* free the duplicated one */
2000         }
2001
2002         dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);
2003
2004         return 0;
2005 }
2006
2007 /**
2008  * set_link_hw_format - Set the HW audio format of the physical DAI link.
2009  * @link: &snd_soc_dai_link which should be updated
2010  * @cfg: physical link configs.
2011  *
2012  * Topology context contains a list of supported HW formats (configs) and
2013  * a default format ID for the physical link. This function will use this
2014  * default ID to choose the HW format to set the link's DAI format for init.
2015  */
2016 static void set_link_hw_format(struct snd_soc_dai_link *link,
2017                         struct snd_soc_tplg_link_config *cfg)
2018 {
2019         struct snd_soc_tplg_hw_config *hw_config;
2020         unsigned char bclk_provider, fsync_provider;
2021         unsigned char invert_bclk, invert_fsync;
2022         int i;
2023
2024         for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
2025                 hw_config = &cfg->hw_config[i];
2026                 if (hw_config->id != cfg->default_hw_config_id)
2027                         continue;
2028
2029                 link->dai_fmt = le32_to_cpu(hw_config->fmt) &
2030                         SND_SOC_DAIFMT_FORMAT_MASK;
2031
2032                 /* clock gating */
2033                 switch (hw_config->clock_gated) {
2034                 case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
2035                         link->dai_fmt |= SND_SOC_DAIFMT_GATED;
2036                         break;
2037
2038                 case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
2039                         link->dai_fmt |= SND_SOC_DAIFMT_CONT;
2040                         break;
2041
2042                 default:
2043                         /* ignore the value */
2044                         break;
2045                 }
2046
2047                 /* clock signal polarity */
2048                 invert_bclk = hw_config->invert_bclk;
2049                 invert_fsync = hw_config->invert_fsync;
2050                 if (!invert_bclk && !invert_fsync)
2051                         link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
2052                 else if (!invert_bclk && invert_fsync)
2053                         link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
2054                 else if (invert_bclk && !invert_fsync)
2055                         link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
2056                 else
2057                         link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;
2058
2059                 /* clock masters */
2060                 bclk_provider = (hw_config->bclk_provider ==
2061                                SND_SOC_TPLG_BCLK_CP);
2062                 fsync_provider = (hw_config->fsync_provider ==
2063                                 SND_SOC_TPLG_FSYNC_CP);
2064                 if (bclk_provider && fsync_provider)
2065                         link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
2066                 else if (!bclk_provider && fsync_provider)
2067                         link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
2068                 else if (bclk_provider && !fsync_provider)
2069                         link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
2070                 else
2071                         link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
2072         }
2073 }
2074
2075 /**
2076  * link_new_ver - Create a new physical link config from the old
2077  * version of source.
2078  * @tplg: topology context
2079  * @src: old version of phyical link config as a source
2080  * @link: latest version of physical link config created from the source
2081  *
2082  * Support from vesion 4. User need free the returned link config manually.
2083  */
2084 static int link_new_ver(struct soc_tplg *tplg,
2085                         struct snd_soc_tplg_link_config *src,
2086                         struct snd_soc_tplg_link_config **link)
2087 {
2088         struct snd_soc_tplg_link_config *dest;
2089         struct snd_soc_tplg_link_config_v4 *src_v4;
2090         int i;
2091
2092         *link = NULL;
2093
2094         if (le32_to_cpu(src->size) !=
2095             sizeof(struct snd_soc_tplg_link_config_v4)) {
2096                 dev_err(tplg->dev, "ASoC: invalid physical link config size\n");
2097                 return -EINVAL;
2098         }
2099
2100         dev_warn(tplg->dev, "ASoC: old version of physical link config\n");
2101
2102         src_v4 = (struct snd_soc_tplg_link_config_v4 *)src;
2103         dest = kzalloc(sizeof(*dest), GFP_KERNEL);
2104         if (!dest)
2105                 return -ENOMEM;
2106
2107         dest->size = cpu_to_le32(sizeof(*dest));
2108         dest->id = src_v4->id;
2109         dest->num_streams = src_v4->num_streams;
2110         for (i = 0; i < le32_to_cpu(dest->num_streams); i++)
2111                 memcpy(&dest->stream[i], &src_v4->stream[i],
2112                        sizeof(struct snd_soc_tplg_stream));
2113
2114         *link = dest;
2115         return 0;
2116 }
2117
2118 /**
2119  * snd_soc_find_dai_link - Find a DAI link
2120  *
2121  * @card: soc card
2122  * @id: DAI link ID to match
2123  * @name: DAI link name to match, optional
2124  * @stream_name: DAI link stream name to match, optional
2125  *
2126  * This function will search all existing DAI links of the soc card to
2127  * find the link of the same ID. Since DAI links may not have their
2128  * unique ID, so name and stream name should also match if being
2129  * specified.
2130  *
2131  * Return: pointer of DAI link, or NULL if not found.
2132  */
2133 static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
2134                                                       int id, const char *name,
2135                                                       const char *stream_name)
2136 {
2137         struct snd_soc_pcm_runtime *rtd;
2138         struct snd_soc_dai_link *link;
2139
2140         for_each_card_rtds(card, rtd) {
2141                 link = rtd->dai_link;
2142
2143                 if (link->id != id)
2144                         continue;
2145
2146                 if (name && (!link->name || strcmp(name, link->name)))
2147                         continue;
2148
2149                 if (stream_name && (!link->stream_name
2150                                     || strcmp(stream_name, link->stream_name)))
2151                         continue;
2152
2153                 return link;
2154         }
2155
2156         return NULL;
2157 }
2158
2159 /* Find and configure an existing physical DAI link */
2160 static int soc_tplg_link_config(struct soc_tplg *tplg,
2161         struct snd_soc_tplg_link_config *cfg)
2162 {
2163         struct snd_soc_dai_link *link;
2164         const char *name, *stream_name;
2165         size_t len;
2166         int ret;
2167
2168         len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2169         if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2170                 return -EINVAL;
2171         else if (len)
2172                 name = cfg->name;
2173         else
2174                 name = NULL;
2175
2176         len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
2177         if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
2178                 return -EINVAL;
2179         else if (len)
2180                 stream_name = cfg->stream_name;
2181         else
2182                 stream_name = NULL;
2183
2184         link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
2185                                      name, stream_name);
2186         if (!link) {
2187                 dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
2188                         name, cfg->id);
2189                 return -EINVAL;
2190         }
2191
2192         /* hw format */
2193         if (cfg->num_hw_configs)
2194                 set_link_hw_format(link, cfg);
2195
2196         /* flags */
2197         if (cfg->flag_mask)
2198                 set_link_flags(link,
2199                                le32_to_cpu(cfg->flag_mask),
2200                                le32_to_cpu(cfg->flags));
2201
2202         /* pass control to component driver for optional further init */
2203         ret = soc_tplg_dai_link_load(tplg, link, cfg);
2204         if (ret < 0) {
2205                 dev_err(tplg->dev, "ASoC: physical link loading failed\n");
2206                 return ret;
2207         }
2208
2209         /* for unloading it in snd_soc_tplg_component_remove */
2210         link->dobj.index = tplg->index;
2211         link->dobj.ops = tplg->ops;
2212         link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
2213         list_add(&link->dobj.list, &tplg->comp->dobj_list);
2214
2215         return 0;
2216 }
2217
2218
2219 /* Load physical link config elements from the topology context */
2220 static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
2221         struct snd_soc_tplg_hdr *hdr)
2222 {
2223         struct snd_soc_tplg_link_config *link, *_link;
2224         int count;
2225         int size;
2226         int i, ret;
2227         bool abi_match;
2228
2229         count = le32_to_cpu(hdr->count);
2230
2231         /* check the element size and count */
2232         link = (struct snd_soc_tplg_link_config *)tplg->pos;
2233         size = le32_to_cpu(link->size);
2234         if (size > sizeof(struct snd_soc_tplg_link_config)
2235                 || size < sizeof(struct snd_soc_tplg_link_config_v4)) {
2236                 dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
2237                         size);
2238                 return -EINVAL;
2239         }
2240
2241         if (soc_tplg_check_elem_count(tplg,
2242                                       size, count,
2243                                       le32_to_cpu(hdr->payload_size),
2244                                       "physical link config")) {
2245                 dev_err(tplg->dev, "ASoC: invalid count %d for physical link elems\n",
2246                         count);
2247                 return -EINVAL;
2248         }
2249
2250         /* config physical DAI links */
2251         for (i = 0; i < count; i++) {
2252                 link = (struct snd_soc_tplg_link_config *)tplg->pos;
2253                 size = le32_to_cpu(link->size);
2254                 if (size == sizeof(*link)) {
2255                         abi_match = true;
2256                         _link = link;
2257                 } else {
2258                         abi_match = false;
2259                         ret = link_new_ver(tplg, link, &_link);
2260                         if (ret < 0)
2261                                 return ret;
2262                 }
2263
2264                 ret = soc_tplg_link_config(tplg, _link);
2265                 if (ret < 0) {
2266                         if (!abi_match)
2267                                 kfree(_link);
2268                         return ret;
2269                 }
2270
2271                 /* offset by version-specific struct size and
2272                  * real priv data size
2273                  */
2274                 tplg->pos += size + le32_to_cpu(_link->priv.size);
2275
2276                 if (!abi_match)
2277                         kfree(_link); /* free the duplicated one */
2278         }
2279
2280         return 0;
2281 }
2282
2283 /**
2284  * soc_tplg_dai_config - Find and configure an existing physical DAI.
2285  * @tplg: topology context
2286  * @d: physical DAI configs.
2287  *
2288  * The physical dai should already be registered by the platform driver.
2289  * The platform driver should specify the DAI name and ID for matching.
2290  */
2291 static int soc_tplg_dai_config(struct soc_tplg *tplg,
2292                                struct snd_soc_tplg_dai *d)
2293 {
2294         struct snd_soc_dai_link_component dai_component;
2295         struct snd_soc_dai *dai;
2296         struct snd_soc_dai_driver *dai_drv;
2297         struct snd_soc_pcm_stream *stream;
2298         struct snd_soc_tplg_stream_caps *caps;
2299         int ret;
2300
2301         memset(&dai_component, 0, sizeof(dai_component));
2302
2303         dai_component.dai_name = d->dai_name;
2304         dai = snd_soc_find_dai(&dai_component);
2305         if (!dai) {
2306                 dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
2307                         d->dai_name);
2308                 return -EINVAL;
2309         }
2310
2311         if (le32_to_cpu(d->dai_id) != dai->id) {
2312                 dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
2313                         d->dai_name);
2314                 return -EINVAL;
2315         }
2316
2317         dai_drv = dai->driver;
2318         if (!dai_drv)
2319                 return -EINVAL;
2320
2321         if (d->playback) {
2322                 stream = &dai_drv->playback;
2323                 caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
2324                 ret = set_stream_info(tplg, stream, caps);
2325                 if (ret < 0)
2326                         goto err;
2327         }
2328
2329         if (d->capture) {
2330                 stream = &dai_drv->capture;
2331                 caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
2332                 ret = set_stream_info(tplg, stream, caps);
2333                 if (ret < 0)
2334                         goto err;
2335         }
2336
2337         if (d->flag_mask)
2338                 set_dai_flags(dai_drv,
2339                               le32_to_cpu(d->flag_mask),
2340                               le32_to_cpu(d->flags));
2341
2342         /* pass control to component driver for optional further init */
2343         ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
2344         if (ret < 0) {
2345                 dev_err(tplg->dev, "ASoC: DAI loading failed\n");
2346                 goto err;
2347         }
2348
2349         return 0;
2350
2351 err:
2352         return ret;
2353 }
2354
2355 /* load physical DAI elements */
2356 static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
2357                                    struct snd_soc_tplg_hdr *hdr)
2358 {
2359         struct snd_soc_tplg_dai *dai;
2360         int count;
2361         int i, ret;
2362
2363         count = le32_to_cpu(hdr->count);
2364
2365         /* config the existing BE DAIs */
2366         for (i = 0; i < count; i++) {
2367                 dai = (struct snd_soc_tplg_dai *)tplg->pos;
2368                 if (le32_to_cpu(dai->size) != sizeof(*dai)) {
2369                         dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
2370                         return -EINVAL;
2371                 }
2372
2373                 ret = soc_tplg_dai_config(tplg, dai);
2374                 if (ret < 0) {
2375                         dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
2376                         return ret;
2377                 }
2378
2379                 tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
2380         }
2381
2382         dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
2383         return 0;
2384 }
2385
2386 /**
2387  * manifest_new_ver - Create a new version of manifest from the old version
2388  * of source.
2389  * @tplg: topology context
2390  * @src: old version of manifest as a source
2391  * @manifest: latest version of manifest created from the source
2392  *
2393  * Support from vesion 4. Users need free the returned manifest manually.
2394  */
2395 static int manifest_new_ver(struct soc_tplg *tplg,
2396                             struct snd_soc_tplg_manifest *src,
2397                             struct snd_soc_tplg_manifest **manifest)
2398 {
2399         struct snd_soc_tplg_manifest *dest;
2400         struct snd_soc_tplg_manifest_v4 *src_v4;
2401         int size;
2402
2403         *manifest = NULL;
2404
2405         size = le32_to_cpu(src->size);
2406         if (size != sizeof(*src_v4)) {
2407                 dev_warn(tplg->dev, "ASoC: invalid manifest size %d\n",
2408                          size);
2409                 if (size)
2410                         return -EINVAL;
2411                 src->size = cpu_to_le32(sizeof(*src_v4));
2412         }
2413
2414         dev_warn(tplg->dev, "ASoC: old version of manifest\n");
2415
2416         src_v4 = (struct snd_soc_tplg_manifest_v4 *)src;
2417         dest = kzalloc(sizeof(*dest) + le32_to_cpu(src_v4->priv.size),
2418                        GFP_KERNEL);
2419         if (!dest)
2420                 return -ENOMEM;
2421
2422         dest->size = cpu_to_le32(sizeof(*dest)); /* size of latest abi version */
2423         dest->control_elems = src_v4->control_elems;
2424         dest->widget_elems = src_v4->widget_elems;
2425         dest->graph_elems = src_v4->graph_elems;
2426         dest->pcm_elems = src_v4->pcm_elems;
2427         dest->dai_link_elems = src_v4->dai_link_elems;
2428         dest->priv.size = src_v4->priv.size;
2429         if (dest->priv.size)
2430                 memcpy(dest->priv.data, src_v4->priv.data,
2431                        le32_to_cpu(src_v4->priv.size));
2432
2433         *manifest = dest;
2434         return 0;
2435 }
2436
2437 static int soc_tplg_manifest_load(struct soc_tplg *tplg,
2438                                   struct snd_soc_tplg_hdr *hdr)
2439 {
2440         struct snd_soc_tplg_manifest *manifest, *_manifest;
2441         bool abi_match;
2442         int ret = 0;
2443
2444         manifest = (struct snd_soc_tplg_manifest *)tplg->pos;
2445
2446         /* check ABI version by size, create a new manifest if abi not match */
2447         if (le32_to_cpu(manifest->size) == sizeof(*manifest)) {
2448                 abi_match = true;
2449                 _manifest = manifest;
2450         } else {
2451                 abi_match = false;
2452                 ret = manifest_new_ver(tplg, manifest, &_manifest);
2453                 if (ret < 0)
2454                         return ret;
2455         }
2456
2457         /* pass control to component driver for optional further init */
2458         if (tplg->ops && tplg->ops->manifest)
2459                 ret = tplg->ops->manifest(tplg->comp, tplg->index, _manifest);
2460
2461         if (!abi_match) /* free the duplicated one */
2462                 kfree(_manifest);
2463
2464         return ret;
2465 }
2466
2467 /* validate header magic, size and type */
2468 static int soc_valid_header(struct soc_tplg *tplg,
2469         struct snd_soc_tplg_hdr *hdr)
2470 {
2471         if (soc_tplg_get_hdr_offset(tplg) >= tplg->fw->size)
2472                 return 0;
2473
2474         if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
2475                 dev_err(tplg->dev,
2476                         "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
2477                         le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
2478                         tplg->fw->size);
2479                 return -EINVAL;
2480         }
2481
2482         /* big endian firmware objects not supported atm */
2483         if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
2484                 dev_err(tplg->dev,
2485                         "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
2486                         tplg->pass, hdr->magic,
2487                         soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2488                 return -EINVAL;
2489         }
2490
2491         if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
2492                 dev_err(tplg->dev,
2493                         "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
2494                         tplg->pass, hdr->magic,
2495                         soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
2496                 return -EINVAL;
2497         }
2498
2499         /* Support ABI from version 4 */
2500         if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
2501             le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
2502                 dev_err(tplg->dev,
2503                         "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
2504                         tplg->pass, hdr->abi,
2505                         SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
2506                         tplg->fw->size);
2507                 return -EINVAL;
2508         }
2509
2510         if (hdr->payload_size == 0) {
2511                 dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
2512                         soc_tplg_get_hdr_offset(tplg));
2513                 return -EINVAL;
2514         }
2515
2516         return 1;
2517 }
2518
2519 /* check header type and call appropriate handler */
2520 static int soc_tplg_load_header(struct soc_tplg *tplg,
2521         struct snd_soc_tplg_hdr *hdr)
2522 {
2523         int (*elem_load)(struct soc_tplg *tplg,
2524                          struct snd_soc_tplg_hdr *hdr);
2525         unsigned int hdr_pass;
2526
2527         tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);
2528
2529         tplg->index = le32_to_cpu(hdr->index);
2530
2531         switch (le32_to_cpu(hdr->type)) {
2532         case SND_SOC_TPLG_TYPE_MIXER:
2533         case SND_SOC_TPLG_TYPE_ENUM:
2534         case SND_SOC_TPLG_TYPE_BYTES:
2535                 hdr_pass = SOC_TPLG_PASS_MIXER;
2536                 elem_load = soc_tplg_kcontrol_elems_load;
2537                 break;
2538         case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
2539                 hdr_pass = SOC_TPLG_PASS_GRAPH;
2540                 elem_load = soc_tplg_dapm_graph_elems_load;
2541                 break;
2542         case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
2543                 hdr_pass = SOC_TPLG_PASS_WIDGET;
2544                 elem_load = soc_tplg_dapm_widget_elems_load;
2545                 break;
2546         case SND_SOC_TPLG_TYPE_PCM:
2547                 hdr_pass = SOC_TPLG_PASS_PCM_DAI;
2548                 elem_load = soc_tplg_pcm_elems_load;
2549                 break;
2550         case SND_SOC_TPLG_TYPE_DAI:
2551                 hdr_pass = SOC_TPLG_PASS_BE_DAI;
2552                 elem_load = soc_tplg_dai_elems_load;
2553                 break;
2554         case SND_SOC_TPLG_TYPE_DAI_LINK:
2555         case SND_SOC_TPLG_TYPE_BACKEND_LINK:
2556                 /* physical link configurations */
2557                 hdr_pass = SOC_TPLG_PASS_LINK;
2558                 elem_load = soc_tplg_link_elems_load;
2559                 break;
2560         case SND_SOC_TPLG_TYPE_MANIFEST:
2561                 hdr_pass = SOC_TPLG_PASS_MANIFEST;
2562                 elem_load = soc_tplg_manifest_load;
2563                 break;
2564         default:
2565                 /* bespoke vendor data object */
2566                 hdr_pass = SOC_TPLG_PASS_VENDOR;
2567                 elem_load = soc_tplg_vendor_load;
2568                 break;
2569         }
2570
2571         if (tplg->pass == hdr_pass) {
2572                 dev_dbg(tplg->dev,
2573                         "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
2574                         hdr->payload_size, hdr->type, hdr->version,
2575                         hdr->vendor_type, tplg->pass);
2576                 return elem_load(tplg, hdr);
2577         }
2578
2579         return 0;
2580 }
2581
2582 /* process the topology file headers */
2583 static int soc_tplg_process_headers(struct soc_tplg *tplg)
2584 {
2585         struct snd_soc_tplg_hdr *hdr;
2586         int ret;
2587
2588         tplg->pass = SOC_TPLG_PASS_START;
2589
2590         /* process the header types from start to end */
2591         while (tplg->pass <= SOC_TPLG_PASS_END) {
2592
2593                 tplg->hdr_pos = tplg->fw->data;
2594                 hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2595
2596                 while (!soc_tplg_is_eof(tplg)) {
2597
2598                         /* make sure header is valid before loading */
2599                         ret = soc_valid_header(tplg, hdr);
2600                         if (ret < 0) {
2601                                 dev_err(tplg->dev,
2602                                         "ASoC: topology: invalid header: %d\n", ret);
2603                                 return ret;
2604                         } else if (ret == 0) {
2605                                 break;
2606                         }
2607
2608                         /* load the header object */
2609                         ret = soc_tplg_load_header(tplg, hdr);
2610                         if (ret < 0) {
2611                                 dev_err(tplg->dev,
2612                                         "ASoC: topology: could not load header: %d\n", ret);
2613                                 return ret;
2614                         }
2615
2616                         /* goto next header */
2617                         tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
2618                                 sizeof(struct snd_soc_tplg_hdr);
2619                         hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
2620                 }
2621
2622                 /* next data type pass */
2623                 tplg->pass++;
2624         }
2625
2626         /* signal DAPM we are complete */
2627         ret = soc_tplg_dapm_complete(tplg);
2628         if (ret < 0)
2629                 dev_err(tplg->dev,
2630                         "ASoC: failed to initialise DAPM from Firmware\n");
2631
2632         return ret;
2633 }
2634
2635 static int soc_tplg_load(struct soc_tplg *tplg)
2636 {
2637         int ret;
2638
2639         ret = soc_tplg_process_headers(tplg);
2640         if (ret == 0)
2641                 soc_tplg_complete(tplg);
2642
2643         return ret;
2644 }
2645
2646 /* load audio component topology from "firmware" file */
2647 int snd_soc_tplg_component_load(struct snd_soc_component *comp,
2648         struct snd_soc_tplg_ops *ops, const struct firmware *fw)
2649 {
2650         struct soc_tplg tplg;
2651         int ret;
2652
2653         /* component needs to exist to keep and reference data while parsing */
2654         if (!comp)
2655                 return -EINVAL;
2656
2657         /* setup parsing context */
2658         memset(&tplg, 0, sizeof(tplg));
2659         tplg.fw = fw;
2660         tplg.dev = comp->dev;
2661         tplg.comp = comp;
2662         tplg.ops = ops;
2663         tplg.io_ops = ops->io_ops;
2664         tplg.io_ops_count = ops->io_ops_count;
2665         tplg.bytes_ext_ops = ops->bytes_ext_ops;
2666         tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
2667
2668         ret = soc_tplg_load(&tplg);
2669         /* free the created components if fail to load topology */
2670         if (ret)
2671                 snd_soc_tplg_component_remove(comp);
2672
2673         return ret;
2674 }
2675 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);
2676
2677 /* remove dynamic controls from the component driver */
2678 int snd_soc_tplg_component_remove(struct snd_soc_component *comp)
2679 {
2680         struct snd_soc_dobj *dobj, *next_dobj;
2681         int pass = SOC_TPLG_PASS_END;
2682
2683         /* process the header types from end to start */
2684         while (pass >= SOC_TPLG_PASS_START) {
2685
2686                 /* remove mixer controls */
2687                 list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
2688                         list) {
2689
2690                         switch (dobj->type) {
2691                         case SND_SOC_DOBJ_MIXER:
2692                                 remove_mixer(comp, dobj, pass);
2693                                 break;
2694                         case SND_SOC_DOBJ_ENUM:
2695                                 remove_enum(comp, dobj, pass);
2696                                 break;
2697                         case SND_SOC_DOBJ_BYTES:
2698                                 remove_bytes(comp, dobj, pass);
2699                                 break;
2700                         case SND_SOC_DOBJ_GRAPH:
2701                                 remove_route(comp, dobj, pass);
2702                                 break;
2703                         case SND_SOC_DOBJ_WIDGET:
2704                                 remove_widget(comp, dobj, pass);
2705                                 break;
2706                         case SND_SOC_DOBJ_PCM:
2707                                 remove_dai(comp, dobj, pass);
2708                                 break;
2709                         case SND_SOC_DOBJ_DAI_LINK:
2710                                 remove_link(comp, dobj, pass);
2711                                 break;
2712                         case SND_SOC_DOBJ_BACKEND_LINK:
2713                                 /*
2714                                  * call link_unload ops if extra
2715                                  * deinitialization is needed.
2716                                  */
2717                                 remove_backend_link(comp, dobj, pass);
2718                                 break;
2719                         default:
2720                                 dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
2721                                         dobj->type);
2722                                 break;
2723                         }
2724                 }
2725                 pass--;
2726         }
2727
2728         /* let caller know if FW can be freed when no objects are left */
2729         return !list_empty(&comp->dobj_list);
2730 }
2731 EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);