sound/soc/sof/topology.c

   1 // SPDX-License-Identifier: (GPL-2.0-only OR BSD-3-Clause)
   2 //
   3 // This file is provided under a dual BSD/GPLv2 license.  When using or
   4 // redistributing this file, you may do so under either license.
   5 //
   6 // Copyright(c) 2018 Intel Corporation. All rights reserved.
   7 //
   8 // Author: Liam Girdwood <liam.r.girdwood@linux.intel.com>
   9 //
  10
  11 #include <linux/bits.h>
  12 #include <linux/device.h>
  13 #include <linux/errno.h>
  14 #include <linux/firmware.h>
  15 #include <linux/workqueue.h>
  16 #include <sound/tlv.h>
  17 #include <uapi/sound/sof/tokens.h>
  18 #include "sof-priv.h"
  19 #include "sof-audio.h"
  20 #include "ops.h"
  21
  22 #define COMP_ID_UNASSIGNED              0xffffffff
  23 /*
  24  * Constants used in the computation of linear volume gain
  25  * from dB gain 20th root of 10 in Q1.16 fixed-point notation
  26  */
  27 #define VOL_TWENTIETH_ROOT_OF_TEN       73533
  28 /* 40th root of 10 in Q1.16 fixed-point notation*/
  29 #define VOL_FORTIETH_ROOT_OF_TEN        69419
  30
  31 /* 0.5 dB step value in topology TLV */
  32 #define VOL_HALF_DB_STEP        50
  33
  34 /* TLV data items */
  35 #define TLV_MIN         0
  36 #define TLV_STEP        1
  37 #define TLV_MUTE        2
  38
  39 /**
  40  * sof_update_ipc_object - Parse multiple sets of tokens within the token array associated with the
  41  *                          token ID.
  42  * @scomp: pointer to SOC component
  43  * @object: target IPC struct to save the parsed values
  44  * @token_id: token ID for the token array to be searched
  45  * @tuples: pointer to the tuples array
  46  * @num_tuples: number of tuples in the tuples array
  47  * @object_size: size of the object
  48  * @token_instance_num: number of times the same @token_id needs to be parsed i.e. the function
  49  *                      looks for @token_instance_num of each token in the token array associated
  50  *                      with the @token_id
  51  */
  52 int sof_update_ipc_object(struct snd_soc_component *scomp, void *object, enum sof_tokens token_id,
  53                           struct snd_sof_tuple *tuples, int num_tuples,
  54                           size_t object_size, int token_instance_num)
  55 {
  56         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
  57         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
  58         const struct sof_token_info *token_list = ipc_tplg_ops->token_list;
  59         const struct sof_topology_token *tokens;
  60         int i, j;
  61
  62         if (token_list[token_id].count < 0) {
  63                 dev_err(scomp->dev, "Invalid token count for token ID: %d\n", token_id);
  64                 return -EINVAL;
  65         }
  66
  67         /* No tokens to match */
  68         if (!token_list[token_id].count)
  69                 return 0;
  70
  71         tokens = token_list[token_id].tokens;
  72         if (!tokens) {
  73                 dev_err(scomp->dev, "Invalid tokens for token id: %d\n", token_id);
  74                 return -EINVAL;
  75         }
  76
  77         for (i = 0; i < token_list[token_id].count; i++) {
  78                 int offset = 0;
  79                 int num_tokens_matched = 0;
  80
  81                 for (j = 0; j < num_tuples; j++) {
  82                         if (tokens[i].token == tuples[j].token) {
  83                                 switch (tokens[i].type) {
  84                                 case SND_SOC_TPLG_TUPLE_TYPE_WORD:
  85                                 {
  86                                         u32 *val = (u32 *)((u8 *)object + tokens[i].offset +
  87                                                            offset);
  88
  89                                         *val = tuples[j].value.v;
  90                                         break;
  91                                 }
  92                                 case SND_SOC_TPLG_TUPLE_TYPE_SHORT:
  93                                 case SND_SOC_TPLG_TUPLE_TYPE_BOOL:
  94                                 {
  95                                         u16 *val = (u16 *)((u8 *)object + tokens[i].offset +
  96                                                             offset);
  97
  98                                         *val = (u16)tuples[j].value.v;
  99                                         break;
 100                                 }
 101                                 case SND_SOC_TPLG_TUPLE_TYPE_STRING:
 102                                 {
 103                                         if (!tokens[i].get_token) {
 104                                                 dev_err(scomp->dev,
 105                                                         "get_token not defined for token %d in %s\n",
 106                                                         tokens[i].token, token_list[token_id].name);
 107                                                 return -EINVAL;
 108                                         }
 109
 110                                         tokens[i].get_token((void *)tuples[j].value.s, object,
 111                                                             tokens[i].offset + offset);
 112                                         break;
 113                                 }
 114                                 default:
 115                                         break;
 116                                 }
 117
 118                                 num_tokens_matched++;
 119
 120                                 /* found all required sets of current token. Move to the next one */
 121                                 if (!(num_tokens_matched % token_instance_num))
 122                                         break;
 123
 124                                 /* move to the next object */
 125                                 offset += object_size;
 126                         }
 127                 }
 128         }
 129
 130         return 0;
 131 }
 132
 133 static inline int get_tlv_data(const int *p, int tlv[SOF_TLV_ITEMS])
 134 {
 135         /* we only support dB scale TLV type at the moment */
 136         if ((int)p[SNDRV_CTL_TLVO_TYPE] != SNDRV_CTL_TLVT_DB_SCALE)
 137                 return -EINVAL;
 138
 139         /* min value in topology tlv data is multiplied by 100 */
 140         tlv[TLV_MIN] = (int)p[SNDRV_CTL_TLVO_DB_SCALE_MIN] / 100;
 141
 142         /* volume steps */
 143         tlv[TLV_STEP] = (int)(p[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP] &
 144                                 TLV_DB_SCALE_MASK);
 145
 146         /* mute ON/OFF */
 147         if ((p[SNDRV_CTL_TLVO_DB_SCALE_MUTE_AND_STEP] &
 148                 TLV_DB_SCALE_MUTE) == 0)
 149                 tlv[TLV_MUTE] = 0;
 150         else
 151                 tlv[TLV_MUTE] = 1;
 152
 153         return 0;
 154 }
 155
 156 /*
 157  * Function to truncate an unsigned 64-bit number
 158  * by x bits and return 32-bit unsigned number. This
 159  * function also takes care of rounding while truncating
 160  */
 161 static inline u32 vol_shift_64(u64 i, u32 x)
 162 {
 163         /* do not truncate more than 32 bits */
 164         if (x > 32)
 165                 x = 32;
 166
 167         if (x == 0)
 168                 return (u32)i;
 169
 170         return (u32)(((i >> (x - 1)) + 1) >> 1);
 171 }
 172
 173 /*
 174  * Function to compute a ^ exp where,
 175  * a is a fractional number represented by a fixed-point
 176  * integer with a fractional world length of "fwl"
 177  * exp is an integer
 178  * fwl is the fractional word length
 179  * Return value is a fractional number represented by a
 180  * fixed-point integer with a fractional word length of "fwl"
 181  */
 182 static u32 vol_pow32(u32 a, int exp, u32 fwl)
 183 {
 184         int i, iter;
 185         u32 power = 1 << fwl;
 186         u64 numerator;
 187
 188         /* if exponent is 0, return 1 */
 189         if (exp == 0)
 190                 return power;
 191
 192         /* determine the number of iterations based on the exponent */
 193         if (exp < 0)
 194                 iter = exp * -1;
 195         else
 196                 iter = exp;
 197
 198         /* mutiply a "iter" times to compute power */
 199         for (i = 0; i < iter; i++) {
 200                 /*
 201                  * Product of 2 Qx.fwl fixed-point numbers yields a Q2*x.2*fwl
 202                  * Truncate product back to fwl fractional bits with rounding
 203                  */
 204                 power = vol_shift_64((u64)power * a, fwl);
 205         }
 206
 207         if (exp > 0) {
 208                 /* if exp is positive, return the result */
 209                 return power;
 210         }
 211
 212         /* if exp is negative, return the multiplicative inverse */
 213         numerator = (u64)1 << (fwl << 1);
 214         do_div(numerator, power);
 215
 216         return (u32)numerator;
 217 }
 218
 219 /*
 220  * Function to calculate volume gain from TLV data.
 221  * This function can only handle gain steps that are multiples of 0.5 dB
 222  */
 223 u32 vol_compute_gain(u32 value, int *tlv)
 224 {
 225         int dB_gain;
 226         u32 linear_gain;
 227         int f_step;
 228
 229         /* mute volume */
 230         if (value == 0 && tlv[TLV_MUTE])
 231                 return 0;
 232
 233         /*
 234          * compute dB gain from tlv. tlv_step
 235          * in topology is multiplied by 100
 236          */
 237         dB_gain = tlv[TLV_MIN] + (value * tlv[TLV_STEP]) / 100;
 238
 239         /*
 240          * compute linear gain represented by fixed-point
 241          * int with VOLUME_FWL fractional bits
 242          */
 243         linear_gain = vol_pow32(VOL_TWENTIETH_ROOT_OF_TEN, dB_gain, VOLUME_FWL);
 244
 245         /* extract the fractional part of volume step */
 246         f_step = tlv[TLV_STEP] - (tlv[TLV_STEP] / 100);
 247
 248         /* if volume step is an odd multiple of 0.5 dB */
 249         if (f_step == VOL_HALF_DB_STEP && (value & 1))
 250                 linear_gain = vol_shift_64((u64)linear_gain *
 251                                                   VOL_FORTIETH_ROOT_OF_TEN,
 252                                                   VOLUME_FWL);
 253
 254         return linear_gain;
 255 }
 256
 257 /*
 258  * Set up volume table for kcontrols from tlv data
 259  * "size" specifies the number of entries in the table
 260  */
 261 static int set_up_volume_table(struct snd_sof_control *scontrol,
 262                                int tlv[SOF_TLV_ITEMS], int size)
 263 {
 264         struct snd_soc_component *scomp = scontrol->scomp;
 265         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 266         const struct sof_ipc_tplg_ops *tplg_ops = sdev->ipc->ops->tplg;
 267
 268         if (tplg_ops->control->set_up_volume_table)
 269                 return tplg_ops->control->set_up_volume_table(scontrol, tlv, size);
 270
 271         dev_err(scomp->dev, "Mandatory op %s not set\n", __func__);
 272         return -EINVAL;
 273 }
 274
 275 struct sof_dai_types {
 276         const char *name;
 277         enum sof_ipc_dai_type type;
 278 };
 279
 280 static const struct sof_dai_types sof_dais[] = {
 281         {"SSP", SOF_DAI_INTEL_SSP},
 282         {"HDA", SOF_DAI_INTEL_HDA},
 283         {"DMIC", SOF_DAI_INTEL_DMIC},
 284         {"ALH", SOF_DAI_INTEL_ALH},
 285         {"SAI", SOF_DAI_IMX_SAI},
 286         {"ESAI", SOF_DAI_IMX_ESAI},
 287         {"ACP", SOF_DAI_AMD_BT},
 288         {"ACPSP", SOF_DAI_AMD_SP},
 289         {"ACPDMIC", SOF_DAI_AMD_DMIC},
 290         {"AFE", SOF_DAI_MEDIATEK_AFE},
 291 };
 292
 293 static enum sof_ipc_dai_type find_dai(const char *name)
 294 {
 295         int i;
 296
 297         for (i = 0; i < ARRAY_SIZE(sof_dais); i++) {
 298                 if (strcmp(name, sof_dais[i].name) == 0)
 299                         return sof_dais[i].type;
 300         }
 301
 302         return SOF_DAI_INTEL_NONE;
 303 }
 304
 305 /*
 306  * Supported Frame format types and lookup, add new ones to end of list.
 307  */
 308
 309 struct sof_frame_types {
 310         const char *name;
 311         enum sof_ipc_frame frame;
 312 };
 313
 314 static const struct sof_frame_types sof_frames[] = {
 315         {"s16le", SOF_IPC_FRAME_S16_LE},
 316         {"s24le", SOF_IPC_FRAME_S24_4LE},
 317         {"s32le", SOF_IPC_FRAME_S32_LE},
 318         {"float", SOF_IPC_FRAME_FLOAT},
 319 };
 320
 321 static enum sof_ipc_frame find_format(const char *name)
 322 {
 323         int i;
 324
 325         for (i = 0; i < ARRAY_SIZE(sof_frames); i++) {
 326                 if (strcmp(name, sof_frames[i].name) == 0)
 327                         return sof_frames[i].frame;
 328         }
 329
 330         /* use s32le if nothing is specified */
 331         return SOF_IPC_FRAME_S32_LE;
 332 }
 333
 334 int get_token_u32(void *elem, void *object, u32 offset)
 335 {
 336         struct snd_soc_tplg_vendor_value_elem *velem = elem;
 337         u32 *val = (u32 *)((u8 *)object + offset);
 338
 339         *val = le32_to_cpu(velem->value);
 340         return 0;
 341 }
 342
 343 int get_token_u16(void *elem, void *object, u32 offset)
 344 {
 345         struct snd_soc_tplg_vendor_value_elem *velem = elem;
 346         u16 *val = (u16 *)((u8 *)object + offset);
 347
 348         *val = (u16)le32_to_cpu(velem->value);
 349         return 0;
 350 }
 351
 352 int get_token_uuid(void *elem, void *object, u32 offset)
 353 {
 354         struct snd_soc_tplg_vendor_uuid_elem *velem = elem;
 355         u8 *dst = (u8 *)object + offset;
 356
 357         memcpy(dst, velem->uuid, UUID_SIZE);
 358
 359         return 0;
 360 }
 361
 362 int get_token_comp_format(void *elem, void *object, u32 offset)
 363 {
 364         u32 *val = (u32 *)((u8 *)object + offset);
 365
 366         *val = find_format((const char *)elem);
 367         return 0;
 368 }
 369
 370 int get_token_dai_type(void *elem, void *object, u32 offset)
 371 {
 372         u32 *val = (u32 *)((u8 *)object + offset);
 373
 374         *val = find_dai((const char *)elem);
 375         return 0;
 376 }
 377
 378 /* PCM */
 379 static const struct sof_topology_token stream_tokens[] = {
 380         {SOF_TKN_STREAM_PLAYBACK_COMPATIBLE_D0I3, SND_SOC_TPLG_TUPLE_TYPE_BOOL, get_token_u16,
 381                 offsetof(struct snd_sof_pcm, stream[0].d0i3_compatible)},
 382         {SOF_TKN_STREAM_CAPTURE_COMPATIBLE_D0I3, SND_SOC_TPLG_TUPLE_TYPE_BOOL, get_token_u16,
 383                 offsetof(struct snd_sof_pcm, stream[1].d0i3_compatible)},
 384 };
 385
 386 /* Leds */
 387 static const struct sof_topology_token led_tokens[] = {
 388         {SOF_TKN_MUTE_LED_USE, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
 389                 offsetof(struct snd_sof_led_control, use_led)},
 390         {SOF_TKN_MUTE_LED_DIRECTION, SND_SOC_TPLG_TUPLE_TYPE_WORD, get_token_u32,
 391                 offsetof(struct snd_sof_led_control, direction)},
 392 };
 393
 394 /**
 395  * sof_parse_uuid_tokens - Parse multiple sets of UUID tokens
 396  * @scomp: pointer to soc component
 397  * @object: target ipc struct for parsed values
 398  * @offset: offset within the object pointer
 399  * @tokens: array of struct sof_topology_token containing the tokens to be matched
 400  * @num_tokens: number of tokens in tokens array
 401  * @array: source pointer to consecutive vendor arrays in topology
 402  *
 403  * This function parses multiple sets of string type tokens in vendor arrays
 404  */
 405 static int sof_parse_uuid_tokens(struct snd_soc_component *scomp,
 406                                   void *object, size_t offset,
 407                                   const struct sof_topology_token *tokens, int num_tokens,
 408                                   struct snd_soc_tplg_vendor_array *array)
 409 {
 410         struct snd_soc_tplg_vendor_uuid_elem *elem;
 411         int found = 0;
 412         int i, j;
 413
 414         /* parse element by element */
 415         for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
 416                 elem = &array->uuid[i];
 417
 418                 /* search for token */
 419                 for (j = 0; j < num_tokens; j++) {
 420                         /* match token type */
 421                         if (tokens[j].type != SND_SOC_TPLG_TUPLE_TYPE_UUID)
 422                                 continue;
 423
 424                         /* match token id */
 425                         if (tokens[j].token != le32_to_cpu(elem->token))
 426                                 continue;
 427
 428                         /* matched - now load token */
 429                         tokens[j].get_token(elem, object,
 430                                             offset + tokens[j].offset);
 431
 432                         found++;
 433                 }
 434         }
 435
 436         return found;
 437 }
 438
 439 /**
 440  * sof_copy_tuples - Parse tokens and copy them to the @tuples array
 441  * @sdev: pointer to struct snd_sof_dev
 442  * @array: source pointer to consecutive vendor arrays in topology
 443  * @array_size: size of @array
 444  * @token_id: Token ID associated with a token array
 445  * @token_instance_num: number of times the same @token_id needs to be parsed i.e. the function
 446  *                      looks for @token_instance_num of each token in the token array associated
 447  *                      with the @token_id
 448  * @tuples: tuples array to copy the matched tuples to
 449  * @tuples_size: size of @tuples
 450  * @num_copied_tuples: pointer to the number of copied tuples in the tuples array
 451  *
 452  */
 453 static int sof_copy_tuples(struct snd_sof_dev *sdev, struct snd_soc_tplg_vendor_array *array,
 454                            int array_size, u32 token_id, int token_instance_num,
 455                            struct snd_sof_tuple *tuples, int tuples_size, int *num_copied_tuples)
 456 {
 457         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
 458         const struct sof_token_info *token_list = ipc_tplg_ops->token_list;
 459         const struct sof_topology_token *tokens;
 460         int found = 0;
 461         int num_tokens, asize;
 462         int i, j;
 463
 464         /* nothing to do if token_list is NULL */
 465         if (!token_list)
 466                 return 0;
 467
 468         if (!tuples || !num_copied_tuples) {
 469                 dev_err(sdev->dev, "Invalid tuples array\n");
 470                 return -EINVAL;
 471         }
 472
 473         tokens = token_list[token_id].tokens;
 474         num_tokens = token_list[token_id].count;
 475
 476         if (!tokens) {
 477                 dev_err(sdev->dev, "No token array defined for token ID: %d\n", token_id);
 478                 return -EINVAL;
 479         }
 480
 481         /* check if there's space in the tuples array for new tokens */
 482         if (*num_copied_tuples >= tuples_size) {
 483                 dev_err(sdev->dev, "No space in tuples array for new tokens from %s",
 484                         token_list[token_id].name);
 485                 return -EINVAL;
 486         }
 487
 488         while (array_size > 0 && found < num_tokens * token_instance_num) {
 489                 asize = le32_to_cpu(array->size);
 490
 491                 /* validate asize */
 492                 if (asize < 0) {
 493                         dev_err(sdev->dev, "Invalid array size 0x%x\n", asize);
 494                         return -EINVAL;
 495                 }
 496
 497                 /* make sure there is enough data before parsing */
 498                 array_size -= asize;
 499                 if (array_size < 0) {
 500                         dev_err(sdev->dev, "Invalid array size 0x%x\n", asize);
 501                         return -EINVAL;
 502                 }
 503
 504                 /* parse element by element */
 505                 for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
 506                         /* search for token */
 507                         for (j = 0; j < num_tokens; j++) {
 508                                 /* match token type */
 509                                 if (!(tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_WORD ||
 510                                       tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_SHORT ||
 511                                       tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_BYTE ||
 512                                       tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_BOOL ||
 513                                       tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_STRING))
 514                                         continue;
 515
 516                                 if (tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_STRING) {
 517                                         struct snd_soc_tplg_vendor_string_elem *elem;
 518
 519                                         elem = &array->string[i];
 520
 521                                         /* match token id */
 522                                         if (tokens[j].token != le32_to_cpu(elem->token))
 523                                                 continue;
 524
 525                                         tuples[*num_copied_tuples].token = tokens[j].token;
 526                                         tuples[*num_copied_tuples].value.s = elem->string;
 527                                 } else {
 528                                         struct snd_soc_tplg_vendor_value_elem *elem;
 529
 530                                         elem = &array->value[i];
 531
 532                                         /* match token id */
 533                                         if (tokens[j].token != le32_to_cpu(elem->token))
 534                                                 continue;
 535
 536                                         tuples[*num_copied_tuples].token = tokens[j].token;
 537                                         tuples[*num_copied_tuples].value.v =
 538                                                 le32_to_cpu(elem->value);
 539                                 }
 540                                 found++;
 541                                 (*num_copied_tuples)++;
 542
 543                                 /* stop if there's no space for any more new tuples */
 544                                 if (*num_copied_tuples == tuples_size)
 545                                         return 0;
 546                         }
 547                 }
 548
 549                 /* next array */
 550                 array = (struct snd_soc_tplg_vendor_array *)((u8 *)array + asize);
 551         }
 552
 553         return 0;
 554 }
 555
 556 /**
 557  * sof_parse_string_tokens - Parse multiple sets of tokens
 558  * @scomp: pointer to soc component
 559  * @object: target ipc struct for parsed values
 560  * @offset: offset within the object pointer
 561  * @tokens: array of struct sof_topology_token containing the tokens to be matched
 562  * @num_tokens: number of tokens in tokens array
 563  * @array: source pointer to consecutive vendor arrays in topology
 564  *
 565  * This function parses multiple sets of string type tokens in vendor arrays
 566  */
 567 static int sof_parse_string_tokens(struct snd_soc_component *scomp,
 568                                    void *object, int offset,
 569                                    const struct sof_topology_token *tokens, int num_tokens,
 570                                    struct snd_soc_tplg_vendor_array *array)
 571 {
 572         struct snd_soc_tplg_vendor_string_elem *elem;
 573         int found = 0;
 574         int i, j;
 575
 576         /* parse element by element */
 577         for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
 578                 elem = &array->string[i];
 579
 580                 /* search for token */
 581                 for (j = 0; j < num_tokens; j++) {
 582                         /* match token type */
 583                         if (tokens[j].type != SND_SOC_TPLG_TUPLE_TYPE_STRING)
 584                                 continue;
 585
 586                         /* match token id */
 587                         if (tokens[j].token != le32_to_cpu(elem->token))
 588                                 continue;
 589
 590                         /* matched - now load token */
 591                         tokens[j].get_token(elem->string, object, offset + tokens[j].offset);
 592
 593                         found++;
 594                 }
 595         }
 596
 597         return found;
 598 }
 599
 600 /**
 601  * sof_parse_word_tokens - Parse multiple sets of tokens
 602  * @scomp: pointer to soc component
 603  * @object: target ipc struct for parsed values
 604  * @offset: offset within the object pointer
 605  * @tokens: array of struct sof_topology_token containing the tokens to be matched
 606  * @num_tokens: number of tokens in tokens array
 607  * @array: source pointer to consecutive vendor arrays in topology
 608  *
 609  * This function parses multiple sets of word type tokens in vendor arrays
 610  */
 611 static int sof_parse_word_tokens(struct snd_soc_component *scomp,
 612                                   void *object, int offset,
 613                                   const struct sof_topology_token *tokens, int num_tokens,
 614                                   struct snd_soc_tplg_vendor_array *array)
 615 {
 616         struct snd_soc_tplg_vendor_value_elem *elem;
 617         int found = 0;
 618         int i, j;
 619
 620         /* parse element by element */
 621         for (i = 0; i < le32_to_cpu(array->num_elems); i++) {
 622                 elem = &array->value[i];
 623
 624                 /* search for token */
 625                 for (j = 0; j < num_tokens; j++) {
 626                         /* match token type */
 627                         if (!(tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_WORD ||
 628                               tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_SHORT ||
 629                               tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_BYTE ||
 630                               tokens[j].type == SND_SOC_TPLG_TUPLE_TYPE_BOOL))
 631                                 continue;
 632
 633                         /* match token id */
 634                         if (tokens[j].token != le32_to_cpu(elem->token))
 635                                 continue;
 636
 637                         /* load token */
 638                         tokens[j].get_token(elem, object, offset + tokens[j].offset);
 639
 640                         found++;
 641                 }
 642         }
 643
 644         return found;
 645 }
 646
 647 /**
 648  * sof_parse_token_sets - Parse multiple sets of tokens
 649  * @scomp: pointer to soc component
 650  * @object: target ipc struct for parsed values
 651  * @tokens: token definition array describing what tokens to parse
 652  * @count: number of tokens in definition array
 653  * @array: source pointer to consecutive vendor arrays in topology
 654  * @array_size: total size of @array
 655  * @token_instance_num: number of times the same tokens needs to be parsed i.e. the function
 656  *                      looks for @token_instance_num of each token in the @tokens
 657  * @object_size: offset to next target ipc struct with multiple sets
 658  *
 659  * This function parses multiple sets of tokens in vendor arrays into
 660  * consecutive ipc structs.
 661  */
 662 static int sof_parse_token_sets(struct snd_soc_component *scomp,
 663                                 void *object, const struct sof_topology_token *tokens,
 664                                 int count, struct snd_soc_tplg_vendor_array *array,
 665                                 int array_size, int token_instance_num, size_t object_size)
 666 {
 667         size_t offset = 0;
 668         int found = 0;
 669         int total = 0;
 670         int asize;
 671
 672         while (array_size > 0 && total < count * token_instance_num) {
 673                 asize = le32_to_cpu(array->size);
 674
 675                 /* validate asize */
 676                 if (asize < 0) { /* FIXME: A zero-size array makes no sense */
 677                         dev_err(scomp->dev, "error: invalid array size 0x%x\n",
 678                                 asize);
 679                         return -EINVAL;
 680                 }
 681
 682                 /* make sure there is enough data before parsing */
 683                 array_size -= asize;
 684                 if (array_size < 0) {
 685                         dev_err(scomp->dev, "error: invalid array size 0x%x\n",
 686                                 asize);
 687                         return -EINVAL;
 688                 }
 689
 690                 /* call correct parser depending on type */
 691                 switch (le32_to_cpu(array->type)) {
 692                 case SND_SOC_TPLG_TUPLE_TYPE_UUID:
 693                         found += sof_parse_uuid_tokens(scomp, object, offset, tokens, count,
 694                                                        array);
 695                         break;
 696                 case SND_SOC_TPLG_TUPLE_TYPE_STRING:
 697                         found += sof_parse_string_tokens(scomp, object, offset, tokens, count,
 698                                                          array);
 699                         break;
 700                 case SND_SOC_TPLG_TUPLE_TYPE_BOOL:
 701                 case SND_SOC_TPLG_TUPLE_TYPE_BYTE:
 702                 case SND_SOC_TPLG_TUPLE_TYPE_WORD:
 703                 case SND_SOC_TPLG_TUPLE_TYPE_SHORT:
 704                         found += sof_parse_word_tokens(scomp, object, offset, tokens, count,
 705                                                        array);
 706                         break;
 707                 default:
 708                         dev_err(scomp->dev, "error: unknown token type %d\n",
 709                                 array->type);
 710                         return -EINVAL;
 711                 }
 712
 713                 /* next array */
 714                 array = (struct snd_soc_tplg_vendor_array *)((u8 *)array
 715                         + asize);
 716
 717                 /* move to next target struct */
 718                 if (found >= count) {
 719                         offset += object_size;
 720                         total += found;
 721                         found = 0;
 722                 }
 723         }
 724
 725         return 0;
 726 }
 727
 728 /**
 729  * sof_parse_tokens - Parse one set of tokens
 730  * @scomp: pointer to soc component
 731  * @object: target ipc struct for parsed values
 732  * @tokens: token definition array describing what tokens to parse
 733  * @num_tokens: number of tokens in definition array
 734  * @array: source pointer to consecutive vendor arrays in topology
 735  * @array_size: total size of @array
 736  *
 737  * This function parses a single set of tokens in vendor arrays into
 738  * consecutive ipc structs.
 739  */
 740 static int sof_parse_tokens(struct snd_soc_component *scomp,  void *object,
 741                             const struct sof_topology_token *tokens, int num_tokens,
 742                             struct snd_soc_tplg_vendor_array *array,
 743                             int array_size)
 744
 745 {
 746         /*
 747          * sof_parse_tokens is used when topology contains only a single set of
 748          * identical tuples arrays. So additional parameters to
 749          * sof_parse_token_sets are sets = 1 (only 1 set) and
 750          * object_size = 0 (irrelevant).
 751          */
 752         return sof_parse_token_sets(scomp, object, tokens, num_tokens, array,
 753                                     array_size, 1, 0);
 754 }
 755
 756 /*
 757  * Standard Kcontrols.
 758  */
 759
 760 static int sof_control_load_volume(struct snd_soc_component *scomp,
 761                                    struct snd_sof_control *scontrol,
 762                                    struct snd_kcontrol_new *kc,
 763                                    struct snd_soc_tplg_ctl_hdr *hdr)
 764 {
 765         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 766         struct snd_soc_tplg_mixer_control *mc =
 767                 container_of(hdr, struct snd_soc_tplg_mixer_control, hdr);
 768         int tlv[SOF_TLV_ITEMS];
 769         unsigned int mask;
 770         int ret;
 771
 772         /* validate topology data */
 773         if (le32_to_cpu(mc->num_channels) > SND_SOC_TPLG_MAX_CHAN)
 774                 return -EINVAL;
 775
 776         /*
 777          * If control has more than 2 channels we need to override the info. This is because even if
 778          * ASoC layer has defined topology's max channel count to SND_SOC_TPLG_MAX_CHAN = 8, the
 779          * pre-defined dapm control types (and related functions) creating the actual control
 780          * restrict the channels only to mono or stereo.
 781          */
 782         if (le32_to_cpu(mc->num_channels) > 2)
 783                 kc->info = snd_sof_volume_info;
 784
 785         scontrol->comp_id = sdev->next_comp_id;
 786         scontrol->min_volume_step = le32_to_cpu(mc->min);
 787         scontrol->max_volume_step = le32_to_cpu(mc->max);
 788         scontrol->num_channels = le32_to_cpu(mc->num_channels);
 789
 790         scontrol->max = le32_to_cpu(mc->max);
 791         if (le32_to_cpu(mc->max) == 1)
 792                 goto skip;
 793
 794         /* extract tlv data */
 795         if (!kc->tlv.p || get_tlv_data(kc->tlv.p, tlv) < 0) {
 796                 dev_err(scomp->dev, "error: invalid TLV data\n");
 797                 return -EINVAL;
 798         }
 799
 800         /* set up volume table */
 801         ret = set_up_volume_table(scontrol, tlv, le32_to_cpu(mc->max) + 1);
 802         if (ret < 0) {
 803                 dev_err(scomp->dev, "error: setting up volume table\n");
 804                 return ret;
 805         }
 806
 807 skip:
 808         /* set up possible led control from mixer private data */
 809         ret = sof_parse_tokens(scomp, &scontrol->led_ctl, led_tokens,
 810                                ARRAY_SIZE(led_tokens), mc->priv.array,
 811                                le32_to_cpu(mc->priv.size));
 812         if (ret != 0) {
 813                 dev_err(scomp->dev, "error: parse led tokens failed %d\n",
 814                         le32_to_cpu(mc->priv.size));
 815                 goto err;
 816         }
 817
 818         if (scontrol->led_ctl.use_led) {
 819                 mask = scontrol->led_ctl.direction ? SNDRV_CTL_ELEM_ACCESS_MIC_LED :
 820                                                         SNDRV_CTL_ELEM_ACCESS_SPK_LED;
 821                 scontrol->access &= ~SNDRV_CTL_ELEM_ACCESS_LED_MASK;
 822                 scontrol->access |= mask;
 823                 kc->access &= ~SNDRV_CTL_ELEM_ACCESS_LED_MASK;
 824                 kc->access |= mask;
 825                 sdev->led_present = true;
 826         }
 827
 828         dev_dbg(scomp->dev, "tplg: load kcontrol index %d chans %d\n",
 829                 scontrol->comp_id, scontrol->num_channels);
 830
 831         return 0;
 832
 833 err:
 834         if (le32_to_cpu(mc->max) > 1)
 835                 kfree(scontrol->volume_table);
 836
 837         return ret;
 838 }
 839
 840 static int sof_control_load_enum(struct snd_soc_component *scomp,
 841                                  struct snd_sof_control *scontrol,
 842                                  struct snd_kcontrol_new *kc,
 843                                  struct snd_soc_tplg_ctl_hdr *hdr)
 844 {
 845         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 846         struct snd_soc_tplg_enum_control *ec =
 847                 container_of(hdr, struct snd_soc_tplg_enum_control, hdr);
 848
 849         /* validate topology data */
 850         if (le32_to_cpu(ec->num_channels) > SND_SOC_TPLG_MAX_CHAN)
 851                 return -EINVAL;
 852
 853         scontrol->comp_id = sdev->next_comp_id;
 854         scontrol->num_channels = le32_to_cpu(ec->num_channels);
 855
 856         dev_dbg(scomp->dev, "tplg: load kcontrol index %d chans %d comp_id %d\n",
 857                 scontrol->comp_id, scontrol->num_channels, scontrol->comp_id);
 858
 859         return 0;
 860 }
 861
 862 static int sof_control_load_bytes(struct snd_soc_component *scomp,
 863                                   struct snd_sof_control *scontrol,
 864                                   struct snd_kcontrol_new *kc,
 865                                   struct snd_soc_tplg_ctl_hdr *hdr)
 866 {
 867         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 868         struct snd_soc_tplg_bytes_control *control =
 869                 container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);
 870         struct soc_bytes_ext *sbe = (struct soc_bytes_ext *)kc->private_value;
 871         size_t priv_size = le32_to_cpu(control->priv.size);
 872
 873         scontrol->max_size = sbe->max;
 874         scontrol->comp_id = sdev->next_comp_id;
 875
 876         dev_dbg(scomp->dev, "tplg: load kcontrol index %d\n", scontrol->comp_id);
 877
 878         /* copy the private data */
 879         if (priv_size > 0) {
 880                 scontrol->priv = kmemdup(control->priv.data, priv_size, GFP_KERNEL);
 881                 if (!scontrol->priv)
 882                         return -ENOMEM;
 883
 884                 scontrol->priv_size = priv_size;
 885         }
 886
 887         return 0;
 888 }
 889
 890 /* external kcontrol init - used for any driver specific init */
 891 static int sof_control_load(struct snd_soc_component *scomp, int index,
 892                             struct snd_kcontrol_new *kc,
 893                             struct snd_soc_tplg_ctl_hdr *hdr)
 894 {
 895         struct soc_mixer_control *sm;
 896         struct soc_bytes_ext *sbe;
 897         struct soc_enum *se;
 898         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 899         struct snd_soc_dobj *dobj;
 900         struct snd_sof_control *scontrol;
 901         int ret;
 902
 903         dev_dbg(scomp->dev, "tplg: load control type %d name : %s\n",
 904                 hdr->type, hdr->name);
 905
 906         scontrol = kzalloc(sizeof(*scontrol), GFP_KERNEL);
 907         if (!scontrol)
 908                 return -ENOMEM;
 909
 910         scontrol->name = kstrdup(hdr->name, GFP_KERNEL);
 911         if (!scontrol->name) {
 912                 kfree(scontrol);
 913                 return -ENOMEM;
 914         }
 915
 916         scontrol->scomp = scomp;
 917         scontrol->access = kc->access;
 918         scontrol->info_type = le32_to_cpu(hdr->ops.info);
 919         scontrol->index = kc->index;
 920
 921         switch (le32_to_cpu(hdr->ops.info)) {
 922         case SND_SOC_TPLG_CTL_VOLSW:
 923         case SND_SOC_TPLG_CTL_VOLSW_SX:
 924         case SND_SOC_TPLG_CTL_VOLSW_XR_SX:
 925                 sm = (struct soc_mixer_control *)kc->private_value;
 926                 dobj = &sm->dobj;
 927                 ret = sof_control_load_volume(scomp, scontrol, kc, hdr);
 928                 break;
 929         case SND_SOC_TPLG_CTL_BYTES:
 930                 sbe = (struct soc_bytes_ext *)kc->private_value;
 931                 dobj = &sbe->dobj;
 932                 ret = sof_control_load_bytes(scomp, scontrol, kc, hdr);
 933                 break;
 934         case SND_SOC_TPLG_CTL_ENUM:
 935         case SND_SOC_TPLG_CTL_ENUM_VALUE:
 936                 se = (struct soc_enum *)kc->private_value;
 937                 dobj = &se->dobj;
 938                 ret = sof_control_load_enum(scomp, scontrol, kc, hdr);
 939                 break;
 940         case SND_SOC_TPLG_CTL_RANGE:
 941         case SND_SOC_TPLG_CTL_STROBE:
 942         case SND_SOC_TPLG_DAPM_CTL_VOLSW:
 943         case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
 944         case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
 945         case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
 946         case SND_SOC_TPLG_DAPM_CTL_PIN:
 947         default:
 948                 dev_warn(scomp->dev, "control type not supported %d:%d:%d\n",
 949                          hdr->ops.get, hdr->ops.put, hdr->ops.info);
 950                 kfree(scontrol->name);
 951                 kfree(scontrol);
 952                 return 0;
 953         }
 954
 955         if (ret < 0) {
 956                 kfree(scontrol->name);
 957                 kfree(scontrol);
 958                 return ret;
 959         }
 960
 961         scontrol->led_ctl.led_value = -1;
 962
 963         dobj->private = scontrol;
 964         list_add(&scontrol->list, &sdev->kcontrol_list);
 965         return 0;
 966 }
 967
 968 static int sof_control_unload(struct snd_soc_component *scomp,
 969                               struct snd_soc_dobj *dobj)
 970 {
 971         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
 972         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
 973         struct snd_sof_control *scontrol = dobj->private;
 974         int ret = 0;
 975
 976         dev_dbg(scomp->dev, "tplg: unload control name : %s\n", scontrol->name);
 977
 978         if (ipc_tplg_ops->control_free) {
 979                 ret = ipc_tplg_ops->control_free(sdev, scontrol);
 980                 if (ret < 0)
 981                         dev_err(scomp->dev, "failed to free control: %s\n", scontrol->name);
 982         }
 983
 984         /* free all data before returning in case of error too */
 985         kfree(scontrol->ipc_control_data);
 986         kfree(scontrol->priv);
 987         kfree(scontrol->name);
 988         list_del(&scontrol->list);
 989         kfree(scontrol);
 990
 991         return ret;
 992 }
 993
 994 /*
 995  * DAI Topology
 996  */
 997
 998 static int sof_connect_dai_widget(struct snd_soc_component *scomp,
 999                                   struct snd_soc_dapm_widget *w,
1000                                   struct snd_soc_tplg_dapm_widget *tw,
1001                                   struct snd_sof_dai *dai)
1002 {
1003         struct snd_soc_card *card = scomp->card;
1004         struct snd_soc_pcm_runtime *rtd;
1005         struct snd_soc_dai *cpu_dai;
1006         int i;
1007
1008         if (!w->sname) {
1009                 dev_err(scomp->dev, "Widget %s does not have stream\n", w->name);
1010                 return -EINVAL;
1011         }
1012
1013         list_for_each_entry(rtd, &card->rtd_list, list) {
1014                 /* does stream match DAI link ? */
1015                 if (!rtd->dai_link->stream_name ||
1016                     strcmp(w->sname, rtd->dai_link->stream_name))
1017                         continue;
1018
1019                 switch (w->id) {
1020                 case snd_soc_dapm_dai_out:
1021                         for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1022                                 /*
1023                                  * Please create DAI widget in the right order
1024                                  * to ensure BE will connect to the right DAI
1025                                  * widget.
1026                                  */
1027                                 if (!cpu_dai->capture_widget) {
1028                                         cpu_dai->capture_widget = w;
1029                                         break;
1030                                 }
1031                         }
1032                         if (i == rtd->num_cpus) {
1033                                 dev_err(scomp->dev, "error: can't find BE for DAI %s\n",
1034                                         w->name);
1035
1036                                 return -EINVAL;
1037                         }
1038                         dai->name = rtd->dai_link->name;
1039                         dev_dbg(scomp->dev, "tplg: connected widget %s -> DAI link %s\n",
1040                                 w->name, rtd->dai_link->name);
1041                         break;
1042                 case snd_soc_dapm_dai_in:
1043                         for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1044                                 /*
1045                                  * Please create DAI widget in the right order
1046                                  * to ensure BE will connect to the right DAI
1047                                  * widget.
1048                                  */
1049                                 if (!cpu_dai->playback_widget) {
1050                                         cpu_dai->playback_widget = w;
1051                                         break;
1052                                 }
1053                         }
1054                         if (i == rtd->num_cpus) {
1055                                 dev_err(scomp->dev, "error: can't find BE for DAI %s\n",
1056                                         w->name);
1057
1058                                 return -EINVAL;
1059                         }
1060                         dai->name = rtd->dai_link->name;
1061                         dev_dbg(scomp->dev, "tplg: connected widget %s -> DAI link %s\n",
1062                                 w->name, rtd->dai_link->name);
1063                         break;
1064                 default:
1065                         break;
1066                 }
1067         }
1068
1069         /* check we have a connection */
1070         if (!dai->name) {
1071                 dev_err(scomp->dev, "error: can't connect DAI %s stream %s\n",
1072                         w->name, w->sname);
1073                 return -EINVAL;
1074         }
1075
1076         return 0;
1077 }
1078
1079 static void sof_disconnect_dai_widget(struct snd_soc_component *scomp,
1080                                       struct snd_soc_dapm_widget *w)
1081 {
1082         struct snd_soc_card *card = scomp->card;
1083         struct snd_soc_pcm_runtime *rtd;
1084         struct snd_soc_dai *cpu_dai;
1085         int i;
1086
1087         if (!w->sname)
1088                 return;
1089
1090         list_for_each_entry(rtd, &card->rtd_list, list) {
1091                 /* does stream match DAI link ? */
1092                 if (!rtd->dai_link->stream_name ||
1093                     strcmp(w->sname, rtd->dai_link->stream_name))
1094                         continue;
1095
1096                 switch (w->id) {
1097                 case snd_soc_dapm_dai_out:
1098                         for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1099                                 if (cpu_dai->capture_widget == w) {
1100                                         cpu_dai->capture_widget = NULL;
1101                                         break;
1102                                 }
1103                         }
1104                         break;
1105                 case snd_soc_dapm_dai_in:
1106                         for_each_rtd_cpu_dais(rtd, i, cpu_dai) {
1107                                 if (cpu_dai->playback_widget == w) {
1108                                         cpu_dai->playback_widget = NULL;
1109                                         break;
1110                                 }
1111                         }
1112                         break;
1113                 default:
1114                         break;
1115                 }
1116         }
1117 }
1118
1119 /* bind PCM ID to host component ID */
1120 static int spcm_bind(struct snd_soc_component *scomp, struct snd_sof_pcm *spcm,
1121                      int dir)
1122 {
1123         struct snd_sof_widget *host_widget;
1124
1125         host_widget = snd_sof_find_swidget_sname(scomp,
1126                                                  spcm->pcm.caps[dir].name,
1127                                                  dir);
1128         if (!host_widget) {
1129                 dev_err(scomp->dev, "can't find host comp to bind pcm\n");
1130                 return -EINVAL;
1131         }
1132
1133         spcm->stream[dir].comp_id = host_widget->comp_id;
1134
1135         return 0;
1136 }
1137
1138 static int sof_get_token_value(u32 token_id, struct snd_sof_tuple *tuples, int num_tuples)
1139 {
1140         int i;
1141
1142         if (!tuples)
1143                 return -EINVAL;
1144
1145         for (i = 0; i < num_tuples; i++) {
1146                 if (tuples[i].token == token_id)
1147                         return tuples[i].value.v;
1148         }
1149
1150         return -EINVAL;
1151 }
1152
1153 static int sof_widget_parse_tokens(struct snd_soc_component *scomp, struct snd_sof_widget *swidget,
1154                                    struct snd_soc_tplg_dapm_widget *tw,
1155                                    enum sof_tokens *object_token_list, int count)
1156 {
1157         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1158         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
1159         const struct sof_token_info *token_list = ipc_tplg_ops->token_list;
1160         struct snd_soc_tplg_private *private = &tw->priv;
1161         int num_tuples = 0;
1162         int ret, i;
1163
1164         if (count > 0 && !object_token_list) {
1165                 dev_err(scomp->dev, "No token list for widget %s\n", swidget->widget->name);
1166                 return -EINVAL;
1167         }
1168
1169         /* calculate max size of tuples array */
1170         for (i = 0; i < count; i++)
1171                 num_tuples += token_list[object_token_list[i]].count;
1172
1173         /* allocate memory for tuples array */
1174         swidget->tuples = kcalloc(num_tuples, sizeof(*swidget->tuples), GFP_KERNEL);
1175         if (!swidget->tuples)
1176                 return -ENOMEM;
1177
1178         /* parse token list for widget */
1179         for (i = 0; i < count; i++) {
1180                 int num_sets = 1;
1181
1182                 if (object_token_list[i] >= SOF_TOKEN_COUNT) {
1183                         dev_err(scomp->dev, "Invalid token id %d for widget %s\n",
1184                                 object_token_list[i], swidget->widget->name);
1185                         ret = -EINVAL;
1186                         goto err;
1187                 }
1188
1189                 switch (object_token_list[i]) {
1190                 case SOF_COMP_EXT_TOKENS:
1191                         /* parse and save UUID in swidget */
1192                         ret = sof_parse_tokens(scomp, swidget,
1193                                                token_list[object_token_list[i]].tokens,
1194                                                token_list[object_token_list[i]].count,
1195                                                private->array, le32_to_cpu(private->size));
1196                         if (ret < 0) {
1197                                 dev_err(scomp->dev, "Failed parsing %s for widget %s\n",
1198                                         token_list[object_token_list[i]].name,
1199                                         swidget->widget->name);
1200                                 goto err;
1201                         }
1202
1203                         continue;
1204                 case SOF_IN_AUDIO_FORMAT_TOKENS:
1205                 case SOF_OUT_AUDIO_FORMAT_TOKENS:
1206                 case SOF_COPIER_GATEWAY_CFG_TOKENS:
1207                 case SOF_AUDIO_FORMAT_BUFFER_SIZE_TOKENS:
1208                         num_sets = sof_get_token_value(SOF_TKN_COMP_NUM_AUDIO_FORMATS,
1209                                                        swidget->tuples, swidget->num_tuples);
1210
1211                         if (num_sets < 0) {
1212                                 dev_err(sdev->dev, "Invalid audio format count for %s\n",
1213                                         swidget->widget->name);
1214                                 ret = num_sets;
1215                                 goto err;
1216                         }
1217
1218                         if (num_sets > 1) {
1219                                 struct snd_sof_tuple *new_tuples;
1220
1221                                 num_tuples += token_list[object_token_list[i]].count * num_sets;
1222                                 new_tuples = krealloc(swidget->tuples,
1223                                                       sizeof(*new_tuples) * num_tuples, GFP_KERNEL);
1224                                 if (!new_tuples) {
1225                                         ret = -ENOMEM;
1226                                         goto err;
1227                                 }
1228
1229                                 swidget->tuples = new_tuples;
1230                         }
1231                         break;
1232                 default:
1233                         break;
1234                 }
1235
1236                 /* copy one set of tuples per token ID into swidget->tuples */
1237                 ret = sof_copy_tuples(sdev, private->array, le32_to_cpu(private->size),
1238                                       object_token_list[i], num_sets, swidget->tuples,
1239                                       num_tuples, &swidget->num_tuples);
1240                 if (ret < 0) {
1241                         dev_err(scomp->dev, "Failed parsing %s for widget %s err: %d\n",
1242                                 token_list[object_token_list[i]].name, swidget->widget->name, ret);
1243                         goto err;
1244                 }
1245         }
1246
1247         return 0;
1248 err:
1249         kfree(swidget->tuples);
1250         return ret;
1251 }
1252
1253 /* external widget init - used for any driver specific init */
1254 static int sof_widget_ready(struct snd_soc_component *scomp, int index,
1255                             struct snd_soc_dapm_widget *w,
1256                             struct snd_soc_tplg_dapm_widget *tw)
1257 {
1258         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1259         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
1260         const struct sof_ipc_tplg_widget_ops *widget_ops = ipc_tplg_ops->widget;
1261         struct snd_sof_widget *swidget;
1262         struct snd_sof_dai *dai;
1263         enum sof_tokens *token_list;
1264         int token_list_size;
1265         int ret = 0;
1266
1267         swidget = kzalloc(sizeof(*swidget), GFP_KERNEL);
1268         if (!swidget)
1269                 return -ENOMEM;
1270
1271         swidget->scomp = scomp;
1272         swidget->widget = w;
1273         swidget->comp_id = sdev->next_comp_id++;
1274         swidget->complete = 0;
1275         swidget->id = w->id;
1276         swidget->pipeline_id = index;
1277         swidget->private = NULL;
1278
1279         dev_dbg(scomp->dev, "tplg: ready widget id %d pipe %d type %d name : %s stream %s\n",
1280                 swidget->comp_id, index, swidget->id, tw->name,
1281                 strnlen(tw->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) > 0
1282                         ? tw->sname : "none");
1283
1284         token_list = widget_ops[w->id].token_list;
1285         token_list_size = widget_ops[w->id].token_list_size;
1286
1287         /* handle any special case widgets */
1288         switch (w->id) {
1289         case snd_soc_dapm_dai_in:
1290         case snd_soc_dapm_dai_out:
1291                 dai = kzalloc(sizeof(*dai), GFP_KERNEL);
1292                 if (!dai) {
1293                         kfree(swidget);
1294                         return -ENOMEM;
1295
1296                 }
1297
1298                 ret = sof_widget_parse_tokens(scomp, swidget, tw, token_list, token_list_size);
1299                 if (!ret)
1300                         ret = sof_connect_dai_widget(scomp, w, tw, dai);
1301                 if (ret < 0) {
1302                         kfree(dai);
1303                         break;
1304                 }
1305                 list_add(&dai->list, &sdev->dai_list);
1306                 swidget->private = dai;
1307                 break;
1308         case snd_soc_dapm_effect:
1309                 /* check we have some tokens - we need at least process type */
1310                 if (le32_to_cpu(tw->priv.size) == 0) {
1311                         dev_err(scomp->dev, "error: process tokens not found\n");
1312                         ret = -EINVAL;
1313                         break;
1314                 }
1315                 ret = sof_widget_parse_tokens(scomp, swidget, tw, token_list, token_list_size);
1316                 break;
1317         case snd_soc_dapm_pga:
1318                 if (!le32_to_cpu(tw->num_kcontrols)) {
1319                         dev_err(scomp->dev, "invalid kcontrol count %d for volume\n",
1320                                 tw->num_kcontrols);
1321                         ret = -EINVAL;
1322                         break;
1323                 }
1324
1325                 fallthrough;
1326         case snd_soc_dapm_mixer:
1327         case snd_soc_dapm_buffer:
1328         case snd_soc_dapm_scheduler:
1329         case snd_soc_dapm_aif_out:
1330         case snd_soc_dapm_aif_in:
1331         case snd_soc_dapm_src:
1332         case snd_soc_dapm_asrc:
1333         case snd_soc_dapm_siggen:
1334         case snd_soc_dapm_mux:
1335         case snd_soc_dapm_demux:
1336                 ret = sof_widget_parse_tokens(scomp, swidget, tw,  token_list, token_list_size);
1337                 break;
1338         case snd_soc_dapm_switch:
1339         case snd_soc_dapm_dai_link:
1340         case snd_soc_dapm_kcontrol:
1341         default:
1342                 dev_dbg(scomp->dev, "widget type %d name %s not handled\n", swidget->id, tw->name);
1343                 break;
1344         }
1345
1346         if (sof_debug_check_flag(SOF_DBG_DISABLE_MULTICORE)) {
1347                 swidget->core = SOF_DSP_PRIMARY_CORE;
1348         } else {
1349                 int core = sof_get_token_value(SOF_TKN_COMP_CORE_ID, swidget->tuples,
1350                                                swidget->num_tuples);
1351
1352                 if (core >= 0)
1353                         swidget->core = core;
1354         }
1355
1356         /* check token parsing reply */
1357         if (ret < 0) {
1358                 dev_err(scomp->dev,
1359                         "error: failed to add widget id %d type %d name : %s stream %s\n",
1360                         tw->shift, swidget->id, tw->name,
1361                         strnlen(tw->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) > 0
1362                                 ? tw->sname : "none");
1363                 kfree(swidget);
1364                 return ret;
1365         }
1366
1367         /* bind widget to external event */
1368         if (tw->event_type) {
1369                 if (widget_ops[w->id].bind_event) {
1370                         ret = widget_ops[w->id].bind_event(scomp, swidget,
1371                                                            le16_to_cpu(tw->event_type));
1372                         if (ret) {
1373                                 dev_err(scomp->dev, "widget event binding failed for %s\n",
1374                                         swidget->widget->name);
1375                                 kfree(swidget->private);
1376                                 kfree(swidget->tuples);
1377                                 kfree(swidget);
1378                                 return ret;
1379                         }
1380                 }
1381         }
1382
1383         w->dobj.private = swidget;
1384         list_add(&swidget->list, &sdev->widget_list);
1385         return ret;
1386 }
1387
1388 static int sof_route_unload(struct snd_soc_component *scomp,
1389                             struct snd_soc_dobj *dobj)
1390 {
1391         struct snd_sof_route *sroute;
1392
1393         sroute = dobj->private;
1394         if (!sroute)
1395                 return 0;
1396
1397         /* free sroute and its private data */
1398         kfree(sroute->private);
1399         list_del(&sroute->list);
1400         kfree(sroute);
1401
1402         return 0;
1403 }
1404
1405 static int sof_widget_unload(struct snd_soc_component *scomp,
1406                              struct snd_soc_dobj *dobj)
1407 {
1408         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1409         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
1410         const struct sof_ipc_tplg_widget_ops *widget_ops = ipc_tplg_ops->widget;
1411         const struct snd_kcontrol_new *kc;
1412         struct snd_soc_dapm_widget *widget;
1413         struct snd_sof_control *scontrol;
1414         struct snd_sof_widget *swidget;
1415         struct soc_mixer_control *sm;
1416         struct soc_bytes_ext *sbe;
1417         struct snd_sof_dai *dai;
1418         struct soc_enum *se;
1419         int i;
1420
1421         swidget = dobj->private;
1422         if (!swidget)
1423                 return 0;
1424
1425         widget = swidget->widget;
1426
1427         switch (swidget->id) {
1428         case snd_soc_dapm_dai_in:
1429         case snd_soc_dapm_dai_out:
1430                 dai = swidget->private;
1431
1432                 if (dai)
1433                         list_del(&dai->list);
1434
1435                 sof_disconnect_dai_widget(scomp, widget);
1436
1437                 break;
1438         default:
1439                 break;
1440         }
1441         for (i = 0; i < widget->num_kcontrols; i++) {
1442                 kc = &widget->kcontrol_news[i];
1443                 switch (widget->dobj.widget.kcontrol_type[i]) {
1444                 case SND_SOC_TPLG_TYPE_MIXER:
1445                         sm = (struct soc_mixer_control *)kc->private_value;
1446                         scontrol = sm->dobj.private;
1447                         if (sm->max > 1)
1448                                 kfree(scontrol->volume_table);
1449                         break;
1450                 case SND_SOC_TPLG_TYPE_ENUM:
1451                         se = (struct soc_enum *)kc->private_value;
1452                         scontrol = se->dobj.private;
1453                         break;
1454                 case SND_SOC_TPLG_TYPE_BYTES:
1455                         sbe = (struct soc_bytes_ext *)kc->private_value;
1456                         scontrol = sbe->dobj.private;
1457                         break;
1458                 default:
1459                         dev_warn(scomp->dev, "unsupported kcontrol_type\n");
1460                         goto out;
1461                 }
1462                 kfree(scontrol->ipc_control_data);
1463                 list_del(&scontrol->list);
1464                 kfree(scontrol->name);
1465                 kfree(scontrol);
1466         }
1467
1468 out:
1469         /* free IPC related data */
1470         if (widget_ops[swidget->id].ipc_free)
1471                 widget_ops[swidget->id].ipc_free(swidget);
1472
1473         kfree(swidget->tuples);
1474
1475         /* remove and free swidget object */
1476         list_del(&swidget->list);
1477         kfree(swidget);
1478
1479         return 0;
1480 }
1481
1482 /*
1483  * DAI HW configuration.
1484  */
1485
1486 /* FE DAI - used for any driver specific init */
1487 static int sof_dai_load(struct snd_soc_component *scomp, int index,
1488                         struct snd_soc_dai_driver *dai_drv,
1489                         struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
1490 {
1491         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1492         struct snd_soc_tplg_stream_caps *caps;
1493         struct snd_soc_tplg_private *private = &pcm->priv;
1494         struct snd_sof_pcm *spcm;
1495         int stream;
1496         int ret;
1497
1498         /* nothing to do for BEs atm */
1499         if (!pcm)
1500                 return 0;
1501
1502         spcm = kzalloc(sizeof(*spcm), GFP_KERNEL);
1503         if (!spcm)
1504                 return -ENOMEM;
1505
1506         spcm->scomp = scomp;
1507
1508         for_each_pcm_streams(stream) {
1509                 spcm->stream[stream].comp_id = COMP_ID_UNASSIGNED;
1510                 if (pcm->compress)
1511                         snd_sof_compr_init_elapsed_work(&spcm->stream[stream].period_elapsed_work);
1512                 else
1513                         snd_sof_pcm_init_elapsed_work(&spcm->stream[stream].period_elapsed_work);
1514         }
1515
1516         spcm->pcm = *pcm;
1517         dev_dbg(scomp->dev, "tplg: load pcm %s\n", pcm->dai_name);
1518
1519         dai_drv->dobj.private = spcm;
1520         list_add(&spcm->list, &sdev->pcm_list);
1521
1522         ret = sof_parse_tokens(scomp, spcm, stream_tokens,
1523                                ARRAY_SIZE(stream_tokens), private->array,
1524                                le32_to_cpu(private->size));
1525         if (ret) {
1526                 dev_err(scomp->dev, "error: parse stream tokens failed %d\n",
1527                         le32_to_cpu(private->size));
1528                 return ret;
1529         }
1530
1531         /* do we need to allocate playback PCM DMA pages */
1532         if (!spcm->pcm.playback)
1533                 goto capture;
1534
1535         stream = SNDRV_PCM_STREAM_PLAYBACK;
1536
1537         caps = &spcm->pcm.caps[stream];
1538
1539         /* allocate playback page table buffer */
1540         ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
1541                                   PAGE_SIZE, &spcm->stream[stream].page_table);
1542         if (ret < 0) {
1543                 dev_err(scomp->dev, "error: can't alloc page table for %s %d\n",
1544                         caps->name, ret);
1545
1546                 return ret;
1547         }
1548
1549         /* bind pcm to host comp */
1550         ret = spcm_bind(scomp, spcm, stream);
1551         if (ret) {
1552                 dev_err(scomp->dev,
1553                         "error: can't bind pcm to host\n");
1554                 goto free_playback_tables;
1555         }
1556
1557 capture:
1558         stream = SNDRV_PCM_STREAM_CAPTURE;
1559
1560         /* do we need to allocate capture PCM DMA pages */
1561         if (!spcm->pcm.capture)
1562                 return ret;
1563
1564         caps = &spcm->pcm.caps[stream];
1565
1566         /* allocate capture page table buffer */
1567         ret = snd_dma_alloc_pages(SNDRV_DMA_TYPE_DEV, sdev->dev,
1568                                   PAGE_SIZE, &spcm->stream[stream].page_table);
1569         if (ret < 0) {
1570                 dev_err(scomp->dev, "error: can't alloc page table for %s %d\n",
1571                         caps->name, ret);
1572                 goto free_playback_tables;
1573         }
1574
1575         /* bind pcm to host comp */
1576         ret = spcm_bind(scomp, spcm, stream);
1577         if (ret) {
1578                 dev_err(scomp->dev,
1579                         "error: can't bind pcm to host\n");
1580                 snd_dma_free_pages(&spcm->stream[stream].page_table);
1581                 goto free_playback_tables;
1582         }
1583
1584         return ret;
1585
1586 free_playback_tables:
1587         if (spcm->pcm.playback)
1588                 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].page_table);
1589
1590         return ret;
1591 }
1592
1593 static int sof_dai_unload(struct snd_soc_component *scomp,
1594                           struct snd_soc_dobj *dobj)
1595 {
1596         struct snd_sof_pcm *spcm = dobj->private;
1597
1598         /* free PCM DMA pages */
1599         if (spcm->pcm.playback)
1600                 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_PLAYBACK].page_table);
1601
1602         if (spcm->pcm.capture)
1603                 snd_dma_free_pages(&spcm->stream[SNDRV_PCM_STREAM_CAPTURE].page_table);
1604
1605         /* remove from list and free spcm */
1606         list_del(&spcm->list);
1607         kfree(spcm);
1608
1609         return 0;
1610 }
1611
1612 static const struct sof_topology_token common_dai_link_tokens[] = {
1613         {SOF_TKN_DAI_TYPE, SND_SOC_TPLG_TUPLE_TYPE_STRING, get_token_dai_type,
1614                 offsetof(struct snd_sof_dai_link, type)},
1615 };
1616
1617 /* DAI link - used for any driver specific init */
1618 static int sof_link_load(struct snd_soc_component *scomp, int index, struct snd_soc_dai_link *link,
1619                          struct snd_soc_tplg_link_config *cfg)
1620 {
1621         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1622         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
1623         const struct sof_token_info *token_list = ipc_tplg_ops->token_list;
1624         struct snd_soc_tplg_private *private = &cfg->priv;
1625         struct snd_sof_dai_link *slink;
1626         u32 token_id = 0;
1627         int num_tuples = 0;
1628         int ret, num_sets;
1629
1630         if (!link->platforms) {
1631                 dev_err(scomp->dev, "error: no platforms\n");
1632                 return -EINVAL;
1633         }
1634         link->platforms->name = dev_name(scomp->dev);
1635
1636         /*
1637          * Set nonatomic property for FE dai links as their trigger action
1638          * involves IPC's.
1639          */
1640         if (!link->no_pcm) {
1641                 link->nonatomic = true;
1642
1643                 /*
1644                  * set default trigger order for all links. Exceptions to
1645                  * the rule will be handled in sof_pcm_dai_link_fixup()
1646                  * For playback, the sequence is the following: start FE,
1647                  * start BE, stop BE, stop FE; for Capture the sequence is
1648                  * inverted start BE, start FE, stop FE, stop BE
1649                  */
1650                 link->trigger[SNDRV_PCM_STREAM_PLAYBACK] =
1651                                         SND_SOC_DPCM_TRIGGER_PRE;
1652                 link->trigger[SNDRV_PCM_STREAM_CAPTURE] =
1653                                         SND_SOC_DPCM_TRIGGER_POST;
1654
1655                 /* nothing more to do for FE dai links */
1656                 return 0;
1657         }
1658
1659         /* check we have some tokens - we need at least DAI type */
1660         if (le32_to_cpu(private->size) == 0) {
1661                 dev_err(scomp->dev, "error: expected tokens for DAI, none found\n");
1662                 return -EINVAL;
1663         }
1664
1665         slink = kzalloc(sizeof(*slink), GFP_KERNEL);
1666         if (!slink)
1667                 return -ENOMEM;
1668
1669         slink->num_hw_configs = le32_to_cpu(cfg->num_hw_configs);
1670         slink->hw_configs = kmemdup(cfg->hw_config,
1671                                     sizeof(*slink->hw_configs) * slink->num_hw_configs,
1672                                     GFP_KERNEL);
1673         if (!slink->hw_configs) {
1674                 kfree(slink);
1675                 return -ENOMEM;
1676         }
1677
1678         slink->default_hw_cfg_id = le32_to_cpu(cfg->default_hw_config_id);
1679         slink->link = link;
1680
1681         dev_dbg(scomp->dev, "tplg: %d hw_configs found, default id: %d for dai link %s!\n",
1682                 slink->num_hw_configs, slink->default_hw_cfg_id, link->name);
1683
1684         ret = sof_parse_tokens(scomp, slink, common_dai_link_tokens,
1685                                ARRAY_SIZE(common_dai_link_tokens),
1686                                private->array, le32_to_cpu(private->size));
1687         if (ret < 0) {
1688                 dev_err(scomp->dev, "Failed tp parse common DAI link tokens\n");
1689                 kfree(slink->hw_configs);
1690                 kfree(slink);
1691                 return ret;
1692         }
1693
1694         if (!token_list)
1695                 goto out;
1696
1697         /* calculate size of tuples array */
1698         num_tuples += token_list[SOF_DAI_LINK_TOKENS].count;
1699         num_sets = slink->num_hw_configs;
1700         switch (slink->type) {
1701         case SOF_DAI_INTEL_SSP:
1702                 token_id = SOF_SSP_TOKENS;
1703                 num_tuples += token_list[SOF_SSP_TOKENS].count * slink->num_hw_configs;
1704                 break;
1705         case SOF_DAI_INTEL_DMIC:
1706                 token_id = SOF_DMIC_TOKENS;
1707                 num_tuples += token_list[SOF_DMIC_TOKENS].count;
1708
1709                 /* Allocate memory for max PDM controllers */
1710                 num_tuples += token_list[SOF_DMIC_PDM_TOKENS].count * SOF_DAI_INTEL_DMIC_NUM_CTRL;
1711                 break;
1712         case SOF_DAI_INTEL_HDA:
1713                 token_id = SOF_HDA_TOKENS;
1714                 num_tuples += token_list[SOF_HDA_TOKENS].count;
1715                 break;
1716         case SOF_DAI_INTEL_ALH:
1717                 token_id = SOF_ALH_TOKENS;
1718                 num_tuples += token_list[SOF_ALH_TOKENS].count;
1719                 break;
1720         case SOF_DAI_IMX_SAI:
1721                 token_id = SOF_SAI_TOKENS;
1722                 num_tuples += token_list[SOF_SAI_TOKENS].count;
1723                 break;
1724         case SOF_DAI_IMX_ESAI:
1725                 token_id = SOF_ESAI_TOKENS;
1726                 num_tuples += token_list[SOF_ESAI_TOKENS].count;
1727                 break;
1728         case SOF_DAI_MEDIATEK_AFE:
1729                 token_id = SOF_AFE_TOKENS;
1730                 num_tuples += token_list[SOF_AFE_TOKENS].count;
1731                 break;
1732         case SOF_DAI_AMD_DMIC:
1733                 token_id = SOF_ACPDMIC_TOKENS;
1734                 num_tuples += token_list[SOF_ACPDMIC_TOKENS].count;
1735                 break;
1736         default:
1737                 break;
1738         }
1739
1740         /* allocate memory for tuples array */
1741         slink->tuples = kcalloc(num_tuples, sizeof(*slink->tuples), GFP_KERNEL);
1742         if (!slink->tuples) {
1743                 kfree(slink->hw_configs);
1744                 kfree(slink);
1745                 return -ENOMEM;
1746         }
1747
1748         if (token_list[SOF_DAI_LINK_TOKENS].tokens) {
1749                 /* parse one set of DAI link tokens */
1750                 ret = sof_copy_tuples(sdev, private->array, le32_to_cpu(private->size),
1751                                       SOF_DAI_LINK_TOKENS, 1, slink->tuples,
1752                                       num_tuples, &slink->num_tuples);
1753                 if (ret < 0) {
1754                         dev_err(scomp->dev, "failed to parse %s for dai link %s\n",
1755                                 token_list[SOF_DAI_LINK_TOKENS].name, link->name);
1756                         goto err;
1757                 }
1758         }
1759
1760         /* nothing more to do if there are no DAI type-specific tokens defined */
1761         if (!token_id || !token_list[token_id].tokens)
1762                 goto out;
1763
1764         /* parse "num_sets" sets of DAI-specific tokens */
1765         ret = sof_copy_tuples(sdev, private->array, le32_to_cpu(private->size),
1766                               token_id, num_sets, slink->tuples, num_tuples, &slink->num_tuples);
1767         if (ret < 0) {
1768                 dev_err(scomp->dev, "failed to parse %s for dai link %s\n",
1769                         token_list[token_id].name, link->name);
1770                 goto err;
1771         }
1772
1773         /* for DMIC, also parse all sets of DMIC PDM tokens based on active PDM count */
1774         if (token_id == SOF_DMIC_TOKENS) {
1775                 num_sets = sof_get_token_value(SOF_TKN_INTEL_DMIC_NUM_PDM_ACTIVE,
1776                                                slink->tuples, slink->num_tuples);
1777
1778                 if (num_sets < 0) {
1779                         dev_err(sdev->dev, "Invalid active PDM count for %s\n", link->name);
1780                         ret = num_sets;
1781                         goto err;
1782                 }
1783
1784                 ret = sof_copy_tuples(sdev, private->array, le32_to_cpu(private->size),
1785                                       SOF_DMIC_PDM_TOKENS, num_sets, slink->tuples,
1786                                       num_tuples, &slink->num_tuples);
1787                 if (ret < 0) {
1788                         dev_err(scomp->dev, "failed to parse %s for dai link %s\n",
1789                                 token_list[SOF_DMIC_PDM_TOKENS].name, link->name);
1790                         goto err;
1791                 }
1792         }
1793 out:
1794         link->dobj.private = slink;
1795         list_add(&slink->list, &sdev->dai_link_list);
1796
1797         return 0;
1798
1799 err:
1800         kfree(slink->tuples);
1801         kfree(slink->hw_configs);
1802         kfree(slink);
1803
1804         return ret;
1805 }
1806
1807 static int sof_link_unload(struct snd_soc_component *scomp, struct snd_soc_dobj *dobj)
1808 {
1809         struct snd_sof_dai_link *slink = dobj->private;
1810
1811         if (!slink)
1812                 return 0;
1813
1814         kfree(slink->tuples);
1815         list_del(&slink->list);
1816         kfree(slink->hw_configs);
1817         kfree(slink);
1818         dobj->private = NULL;
1819
1820         return 0;
1821 }
1822
1823 /* DAI link - used for any driver specific init */
1824 static int sof_route_load(struct snd_soc_component *scomp, int index,
1825                           struct snd_soc_dapm_route *route)
1826 {
1827         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1828         struct snd_sof_widget *source_swidget, *sink_swidget;
1829         struct snd_soc_dobj *dobj = &route->dobj;
1830         struct snd_sof_route *sroute;
1831         int ret = 0;
1832
1833         /* allocate memory for sroute and connect */
1834         sroute = kzalloc(sizeof(*sroute), GFP_KERNEL);
1835         if (!sroute)
1836                 return -ENOMEM;
1837
1838         sroute->scomp = scomp;
1839         dev_dbg(scomp->dev, "sink %s control %s source %s\n",
1840                 route->sink, route->control ? route->control : "none",
1841                 route->source);
1842
1843         /* source component */
1844         source_swidget = snd_sof_find_swidget(scomp, (char *)route->source);
1845         if (!source_swidget) {
1846                 dev_err(scomp->dev, "error: source %s not found\n",
1847                         route->source);
1848                 ret = -EINVAL;
1849                 goto err;
1850         }
1851
1852         /*
1853          * Virtual widgets of type output/out_drv may be added in topology
1854          * for compatibility. These are not handled by the FW.
1855          * So, don't send routes whose source/sink widget is of such types
1856          * to the DSP.
1857          */
1858         if (source_swidget->id == snd_soc_dapm_out_drv ||
1859             source_swidget->id == snd_soc_dapm_output)
1860                 goto err;
1861
1862         /* sink component */
1863         sink_swidget = snd_sof_find_swidget(scomp, (char *)route->sink);
1864         if (!sink_swidget) {
1865                 dev_err(scomp->dev, "error: sink %s not found\n",
1866                         route->sink);
1867                 ret = -EINVAL;
1868                 goto err;
1869         }
1870
1871         /*
1872          * Don't send routes whose sink widget is of type
1873          * output or out_drv to the DSP
1874          */
1875         if (sink_swidget->id == snd_soc_dapm_out_drv ||
1876             sink_swidget->id == snd_soc_dapm_output)
1877                 goto err;
1878
1879         sroute->route = route;
1880         dobj->private = sroute;
1881         sroute->src_widget = source_swidget;
1882         sroute->sink_widget = sink_swidget;
1883
1884         /* add route to route list */
1885         list_add(&sroute->list, &sdev->route_list);
1886
1887         return 0;
1888 err:
1889         kfree(sroute);
1890         return ret;
1891 }
1892
1893 /**
1894  * sof_set_pipe_widget - Set pipe_widget for a component
1895  * @sdev: pointer to struct snd_sof_dev
1896  * @pipe_widget: pointer to struct snd_sof_widget of type snd_soc_dapm_scheduler
1897  * @swidget: pointer to struct snd_sof_widget that has the same pipeline ID as @pipe_widget
1898  *
1899  * Return: 0 if successful, -EINVAL on error.
1900  * The function checks if @swidget is associated with any volatile controls. If so, setting
1901  * the dynamic_pipeline_widget is disallowed.
1902  */
1903 static int sof_set_pipe_widget(struct snd_sof_dev *sdev, struct snd_sof_widget *pipe_widget,
1904                                struct snd_sof_widget *swidget)
1905 {
1906         struct snd_sof_control *scontrol;
1907
1908         if (pipe_widget->dynamic_pipeline_widget) {
1909                 /* dynamic widgets cannot have volatile kcontrols */
1910                 list_for_each_entry(scontrol, &sdev->kcontrol_list, list)
1911                         if (scontrol->comp_id == swidget->comp_id &&
1912                             (scontrol->access & SNDRV_CTL_ELEM_ACCESS_VOLATILE)) {
1913                                 dev_err(sdev->dev,
1914                                         "error: volatile control found for dynamic widget %s\n",
1915                                         swidget->widget->name);
1916                                 return -EINVAL;
1917                         }
1918         }
1919
1920         /* set the pipe_widget and apply the dynamic_pipeline_widget_flag */
1921         swidget->pipe_widget = pipe_widget;
1922         swidget->dynamic_pipeline_widget = pipe_widget->dynamic_pipeline_widget;
1923
1924         return 0;
1925 }
1926
1927 /* completion - called at completion of firmware loading */
1928 static int sof_complete(struct snd_soc_component *scomp)
1929 {
1930         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
1931         struct snd_sof_widget *swidget, *comp_swidget;
1932         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
1933         const struct sof_ipc_tplg_widget_ops *widget_ops = ipc_tplg_ops->widget;
1934         struct snd_sof_control *scontrol;
1935         int ret;
1936
1937         /* first update all control IPC structures based on the IPC version */
1938         if (ipc_tplg_ops->control_setup)
1939                 list_for_each_entry(scontrol, &sdev->kcontrol_list, list) {
1940                         ret = ipc_tplg_ops->control_setup(sdev, scontrol);
1941                         if (ret < 0) {
1942                                 dev_err(sdev->dev, "failed updating IPC struct for control %s\n",
1943                                         scontrol->name);
1944                                 return ret;
1945                         }
1946                 }
1947
1948         /*
1949          * then update all widget IPC structures. If any of the ipc_setup callbacks fail, the
1950          * topology will be removed and all widgets will be unloaded resulting in freeing all
1951          * associated memories.
1952          */
1953         list_for_each_entry(swidget, &sdev->widget_list, list) {
1954                 if (widget_ops[swidget->id].ipc_setup) {
1955                         ret = widget_ops[swidget->id].ipc_setup(swidget);
1956                         if (ret < 0) {
1957                                 dev_err(sdev->dev, "failed updating IPC struct for %s\n",
1958                                         swidget->widget->name);
1959                                 return ret;
1960                         }
1961                 }
1962         }
1963
1964         /* set the pipe_widget and apply the dynamic_pipeline_widget_flag */
1965         list_for_each_entry(swidget, &sdev->widget_list, list) {
1966                 switch (swidget->id) {
1967                 case snd_soc_dapm_scheduler:
1968                         /*
1969                          * Apply the dynamic_pipeline_widget flag and set the pipe_widget field
1970                          * for all widgets that have the same pipeline ID as the scheduler widget
1971                          */
1972                         list_for_each_entry(comp_swidget, &sdev->widget_list, list)
1973                                 if (comp_swidget->pipeline_id == swidget->pipeline_id) {
1974                                         ret = sof_set_pipe_widget(sdev, swidget, comp_swidget);
1975                                         if (ret < 0)
1976                                                 return ret;
1977                                 }
1978                         break;
1979                 default:
1980                         break;
1981                 }
1982         }
1983
1984         /* verify topology components loading including dynamic pipelines */
1985         if (sof_debug_check_flag(SOF_DBG_VERIFY_TPLG)) {
1986                 if (ipc_tplg_ops->set_up_all_pipelines && ipc_tplg_ops->tear_down_all_pipelines) {
1987                         ret = ipc_tplg_ops->set_up_all_pipelines(sdev, true);
1988                         if (ret < 0) {
1989                                 dev_err(sdev->dev, "Failed to set up all topology pipelines: %d\n",
1990                                         ret);
1991                                 return ret;
1992                         }
1993
1994                         ret = ipc_tplg_ops->tear_down_all_pipelines(sdev, true);
1995                         if (ret < 0) {
1996                                 dev_err(sdev->dev, "Failed to tear down topology pipelines: %d\n",
1997                                         ret);
1998                                 return ret;
1999                         }
2000                 }
2001         }
2002
2003         /* set up static pipelines */
2004         if (ipc_tplg_ops->set_up_all_pipelines)
2005                 return ipc_tplg_ops->set_up_all_pipelines(sdev, false);
2006
2007         return 0;
2008 }
2009
2010 /* manifest - optional to inform component of manifest */
2011 static int sof_manifest(struct snd_soc_component *scomp, int index,
2012                         struct snd_soc_tplg_manifest *man)
2013 {
2014         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2015         const struct sof_ipc_tplg_ops *ipc_tplg_ops = sdev->ipc->ops->tplg;
2016
2017         if (ipc_tplg_ops->parse_manifest)
2018                 return ipc_tplg_ops->parse_manifest(scomp, index, man);
2019
2020         return 0;
2021 }
2022
2023 /* vendor specific kcontrol handlers available for binding */
2024 static const struct snd_soc_tplg_kcontrol_ops sof_io_ops[] = {
2025         {SOF_TPLG_KCTL_VOL_ID, snd_sof_volume_get, snd_sof_volume_put},
2026         {SOF_TPLG_KCTL_BYTES_ID, snd_sof_bytes_get, snd_sof_bytes_put},
2027         {SOF_TPLG_KCTL_ENUM_ID, snd_sof_enum_get, snd_sof_enum_put},
2028         {SOF_TPLG_KCTL_SWITCH_ID, snd_sof_switch_get, snd_sof_switch_put},
2029 };
2030
2031 /* vendor specific bytes ext handlers available for binding */
2032 static const struct snd_soc_tplg_bytes_ext_ops sof_bytes_ext_ops[] = {
2033         {SOF_TPLG_KCTL_BYTES_ID, snd_sof_bytes_ext_get, snd_sof_bytes_ext_put},
2034         {SOF_TPLG_KCTL_BYTES_VOLATILE_RO, snd_sof_bytes_ext_volatile_get},
2035 };
2036
2037 static struct snd_soc_tplg_ops sof_tplg_ops = {
2038         /* external kcontrol init - used for any driver specific init */
2039         .control_load   = sof_control_load,
2040         .control_unload = sof_control_unload,
2041
2042         /* external kcontrol init - used for any driver specific init */
2043         .dapm_route_load        = sof_route_load,
2044         .dapm_route_unload      = sof_route_unload,
2045
2046         /* external widget init - used for any driver specific init */
2047         /* .widget_load is not currently used */
2048         .widget_ready   = sof_widget_ready,
2049         .widget_unload  = sof_widget_unload,
2050
2051         /* FE DAI - used for any driver specific init */
2052         .dai_load       = sof_dai_load,
2053         .dai_unload     = sof_dai_unload,
2054
2055         /* DAI link - used for any driver specific init */
2056         .link_load      = sof_link_load,
2057         .link_unload    = sof_link_unload,
2058
2059         /* completion - called at completion of firmware loading */
2060         .complete       = sof_complete,
2061
2062         /* manifest - optional to inform component of manifest */
2063         .manifest       = sof_manifest,
2064
2065         /* vendor specific kcontrol handlers available for binding */
2066         .io_ops         = sof_io_ops,
2067         .io_ops_count   = ARRAY_SIZE(sof_io_ops),
2068
2069         /* vendor specific bytes ext handlers available for binding */
2070         .bytes_ext_ops  = sof_bytes_ext_ops,
2071         .bytes_ext_ops_count    = ARRAY_SIZE(sof_bytes_ext_ops),
2072 };
2073
2074 int snd_sof_load_topology(struct snd_soc_component *scomp, const char *file)
2075 {
2076         struct snd_sof_dev *sdev = snd_soc_component_get_drvdata(scomp);
2077         const struct firmware *fw;
2078         int ret;
2079
2080         dev_dbg(scomp->dev, "loading topology:%s\n", file);
2081
2082         ret = request_firmware(&fw, file, scomp->dev);
2083         if (ret < 0) {
2084                 dev_err(scomp->dev, "error: tplg request firmware %s failed err: %d\n",
2085                         file, ret);
2086                 dev_err(scomp->dev,
2087                         "you may need to download the firmware from https://github.com/thesofproject/sof-bin/\n");
2088                 return ret;
2089         }
2090
2091         ret = snd_soc_tplg_component_load(scomp, &sof_tplg_ops, fw);
2092         if (ret < 0) {
2093                 dev_err(scomp->dev, "error: tplg component load failed %d\n",
2094                         ret);
2095                 ret = -EINVAL;
2096         }
2097
2098         release_firmware(fw);
2099
2100         if (ret >= 0 && sdev->led_present)
2101                 ret = snd_ctl_led_request();
2102
2103         return ret;
2104 }
2105 EXPORT_SYMBOL(snd_sof_load_topology);