root/sound/soc/intel/avs/topology.c
// SPDX-License-Identifier: GPL-2.0-only
//
// Copyright(c) 2021 Intel Corporation
//
// Authors: Cezary Rojewski <cezary.rojewski@intel.com>
//          Amadeusz Slawinski <amadeuszx.slawinski@linux.intel.com>
//

#include <linux/firmware.h>
#include <linux/uuid.h>
#include <sound/soc.h>
#include <sound/soc-acpi.h>
#include <sound/soc-topology.h>
#include <uapi/sound/intel/avs/tokens.h>
#include "avs.h"
#include "control.h"
#include "topology.h"
#include "utils.h"

/* Get pointer to vendor array at the specified offset. */
#define avs_tplg_vendor_array_at(array, offset) \
        ((struct snd_soc_tplg_vendor_array *)((u8 *)array + offset))

/* Get pointer to vendor array that is next in line. */
#define avs_tplg_vendor_array_next(array) \
        (avs_tplg_vendor_array_at(array, le32_to_cpu((array)->size)))

/*
 * Scan provided block of tuples for the specified token. If found,
 * @offset is updated with position at which first matching token is
 * located.
 *
 * Returns 0 on success, -ENOENT if not found and error code otherwise.
 */
static int
avs_tplg_vendor_array_lookup(struct snd_soc_tplg_vendor_array *tuples,
                             u32 block_size, u32 token, u32 *offset)
{
        u32 pos = 0;

        while (block_size > 0) {
                struct snd_soc_tplg_vendor_value_elem *tuple;
                u32 tuples_size = le32_to_cpu(tuples->size);

                if (tuples_size > block_size)
                        return -EINVAL;

                tuple = tuples->value;
                if (le32_to_cpu(tuple->token) == token) {
                        *offset = pos;
                        return 0;
                }

                block_size -= tuples_size;
                pos += tuples_size;
                tuples = avs_tplg_vendor_array_next(tuples);
        }

        return -ENOENT;
}

/*
 * See avs_tplg_vendor_array_lookup() for description.
 *
 * Behaves exactly like avs_tplg_vendor_lookup() but starts from the
 * next vendor array in line. Useful when searching for the finish line
 * of an arbitrary entry in a list of entries where each is composed of
 * several vendor tuples and a specific token marks the beginning of
 * a new entry block.
 */
static int
avs_tplg_vendor_array_lookup_next(struct snd_soc_tplg_vendor_array *tuples,
                                  u32 block_size, u32 token, u32 *offset)
{
        u32 tuples_size = le32_to_cpu(tuples->size);
        int ret;

        if (tuples_size > block_size)
                return -EINVAL;

        tuples = avs_tplg_vendor_array_next(tuples);
        block_size -= tuples_size;

        ret = avs_tplg_vendor_array_lookup(tuples, block_size, token, offset);
        if (!ret)
                *offset += tuples_size;
        return ret;
}

/*
 * Scan provided block of tuples for the specified token which marks
 * the border of an entry block. Behavior is similar to
 * avs_tplg_vendor_array_lookup() except 0 is also returned if no
 * matching token has been found. In such case, returned @size is
 * assigned to @block_size as the entire block belongs to the current
 * entry.
 *
 * Returns 0 on success, error code otherwise.
 */
static int
avs_tplg_vendor_entry_size(struct snd_soc_tplg_vendor_array *tuples,
                           u32 block_size, u32 entry_id_token, u32 *size)
{
        int ret;

        ret = avs_tplg_vendor_array_lookup_next(tuples, block_size, entry_id_token, size);
        if (ret == -ENOENT) {
                *size = block_size;
                ret = 0;
        }

        return ret;
}

/*
 * Vendor tuple parsing descriptor.
 *
 * @token: vendor specific token that identifies tuple
 * @type: tuple type, one of SND_SOC_TPLG_TUPLE_TYPE_XXX
 * @offset: offset of a struct's field to initialize
 * @parse: parsing function, extracts and assigns value to object's field
 */
struct avs_tplg_token_parser {
        enum avs_tplg_token token;
        u32 type;
        u32 offset;
        int (*parse)(struct snd_soc_component *comp, void *elem, void *object, u32 offset);
};

static int
avs_parse_uuid_token(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_uuid_elem *tuple = elem;
        guid_t *val = (guid_t *)((u8 *)object + offset);

        guid_copy((guid_t *)val, (const guid_t *)&tuple->uuid);

        return 0;
}

static int
avs_parse_bool_token(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_value_elem *tuple = elem;
        bool *val = (bool *)((u8 *)object + offset);

        *val = le32_to_cpu(tuple->value);

        return 0;
}

static int
avs_parse_byte_token(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_value_elem *tuple = elem;
        u8 *val = ((u8 *)object + offset);

        *val = le32_to_cpu(tuple->value);

        return 0;
}

static int
avs_parse_short_token(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_value_elem *tuple = elem;
        u16 *val = (u16 *)((u8 *)object + offset);

        *val = le32_to_cpu(tuple->value);

        return 0;
}

static int
avs_parse_word_token(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_value_elem *tuple = elem;
        u32 *val = (u32 *)((u8 *)object + offset);

        *val = le32_to_cpu(tuple->value);

        return 0;
}

static int
avs_parse_string_token(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_string_elem *tuple = elem;
        char *val = (char *)((u8 *)object + offset);

        snprintf(val, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, "%s", tuple->string);

        return 0;
}

static int avs_parse_uuid_tokens(struct snd_soc_component *comp, void *object,
                                 const struct avs_tplg_token_parser *parsers, int count,
                                 struct snd_soc_tplg_vendor_array *tuples)
{
        struct snd_soc_tplg_vendor_uuid_elem *tuple;
        int ret, i, j;

        /* Parse element by element. */
        for (i = 0; i < le32_to_cpu(tuples->num_elems); i++) {
                tuple = &tuples->uuid[i];

                for (j = 0; j < count; j++) {
                        /* Ignore non-UUID tokens. */
                        if (parsers[j].type != SND_SOC_TPLG_TUPLE_TYPE_UUID ||
                            parsers[j].token != le32_to_cpu(tuple->token))
                                continue;

                        ret = parsers[j].parse(comp, tuple, object, parsers[j].offset);
                        if (ret)
                                return ret;
                }
        }

        return 0;
}

static int avs_parse_string_tokens(struct snd_soc_component *comp, void *object,
                                   const struct avs_tplg_token_parser *parsers, int count,
                                   struct snd_soc_tplg_vendor_array *tuples)
{
        struct snd_soc_tplg_vendor_string_elem *tuple;
        int ret, i, j;

        /* Parse element by element. */
        for (i = 0; i < le32_to_cpu(tuples->num_elems); i++) {
                tuple = &tuples->string[i];

                for (j = 0; j < count; j++) {
                        /* Ignore non-string tokens. */
                        if (parsers[j].type != SND_SOC_TPLG_TUPLE_TYPE_STRING ||
                            parsers[j].token != le32_to_cpu(tuple->token))
                                continue;

                        ret = parsers[j].parse(comp, tuple, object, parsers[j].offset);
                        if (ret)
                                return ret;
                }
        }

        return 0;
}

static int avs_parse_word_tokens(struct snd_soc_component *comp, void *object,
                                 const struct avs_tplg_token_parser *parsers, int count,
                                 struct snd_soc_tplg_vendor_array *tuples)
{
        struct snd_soc_tplg_vendor_value_elem *tuple;
        int ret, i, j;

        /* Parse element by element. */
        for (i = 0; i < le32_to_cpu(tuples->num_elems); i++) {
                tuple = &tuples->value[i];

                for (j = 0; j < count; j++) {
                        /* Ignore non-integer tokens. */
                        if (!(parsers[j].type == SND_SOC_TPLG_TUPLE_TYPE_WORD ||
                              parsers[j].type == SND_SOC_TPLG_TUPLE_TYPE_SHORT ||
                              parsers[j].type == SND_SOC_TPLG_TUPLE_TYPE_BYTE ||
                              parsers[j].type == SND_SOC_TPLG_TUPLE_TYPE_BOOL))
                                continue;

                        if (parsers[j].token != le32_to_cpu(tuple->token))
                                continue;

                        ret = parsers[j].parse(comp, tuple, object, parsers[j].offset);
                        if (ret)
                                return ret;
                }
        }

        return 0;
}

static int avs_parse_tokens(struct snd_soc_component *comp, void *object,
                            const struct avs_tplg_token_parser *parsers, size_t count,
                            struct snd_soc_tplg_vendor_array *tuples, int priv_size)
{
        int array_size, ret;

        while (priv_size > 0) {
                array_size = le32_to_cpu(tuples->size);

                if (array_size <= 0) {
                        dev_err(comp->dev, "invalid array size 0x%x\n", array_size);
                        return -EINVAL;
                }

                /* Make sure there is enough data before parsing. */
                priv_size -= array_size;
                if (priv_size < 0) {
                        dev_err(comp->dev, "invalid array size 0x%x\n", array_size);
                        return -EINVAL;
                }

                switch (le32_to_cpu(tuples->type)) {
                case SND_SOC_TPLG_TUPLE_TYPE_UUID:
                        ret = avs_parse_uuid_tokens(comp, object, parsers, count, tuples);
                        break;
                case SND_SOC_TPLG_TUPLE_TYPE_STRING:
                        ret = avs_parse_string_tokens(comp, object, parsers, count, tuples);
                        break;
                case SND_SOC_TPLG_TUPLE_TYPE_BOOL:
                case SND_SOC_TPLG_TUPLE_TYPE_BYTE:
                case SND_SOC_TPLG_TUPLE_TYPE_SHORT:
                case SND_SOC_TPLG_TUPLE_TYPE_WORD:
                        ret = avs_parse_word_tokens(comp, object, parsers, count, tuples);
                        break;
                default:
                        dev_err(comp->dev, "unknown token type %d\n", tuples->type);
                        ret = -EINVAL;
                }

                if (ret) {
                        dev_err(comp->dev, "parsing %zu tokens of %d type failed: %d\n",
                                count, tuples->type, ret);
                        return ret;
                }

                tuples = avs_tplg_vendor_array_next(tuples);
        }

        return 0;
}

#define AVS_DEFINE_PTR_PARSER(name, type, member) \
static int \
avs_parse_##name##_ptr(struct snd_soc_component *comp, void *elem, void *object, u32 offset) \
{ \
        struct snd_soc_tplg_vendor_value_elem *tuple = elem;            \
        struct avs_soc_component *acomp = to_avs_soc_component(comp);   \
        type **val = (type **)(object + offset);                        \
        u32 idx;                                                        \
                                                                        \
        idx = le32_to_cpu(tuple->value);                                \
        if (idx >= acomp->tplg->num_##member)                           \
                return -EINVAL;                                         \
                                                                        \
        *val = &acomp->tplg->member[idx];                               \
                                                                        \
        return 0;                                                       \
}

AVS_DEFINE_PTR_PARSER(audio_format, struct avs_audio_format, fmts);
AVS_DEFINE_PTR_PARSER(modcfg_base, struct avs_tplg_modcfg_base, modcfgs_base);
AVS_DEFINE_PTR_PARSER(modcfg_ext, struct avs_tplg_modcfg_ext, modcfgs_ext);
AVS_DEFINE_PTR_PARSER(pplcfg, struct avs_tplg_pplcfg, pplcfgs);
AVS_DEFINE_PTR_PARSER(binding, struct avs_tplg_binding, bindings);
AVS_DEFINE_PTR_PARSER(nhlt_config, struct avs_tplg_nhlt_config, nhlt_configs);

static int
parse_audio_format_bitfield(struct snd_soc_component *comp, void *elem, void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_value_elem *velem = elem;
        struct avs_audio_format *audio_format = object;

        switch (offset) {
        case AVS_TKN_AFMT_NUM_CHANNELS_U32:
                audio_format->num_channels = le32_to_cpu(velem->value);
                break;
        case AVS_TKN_AFMT_VALID_BIT_DEPTH_U32:
                audio_format->valid_bit_depth = le32_to_cpu(velem->value);
                break;
        case AVS_TKN_AFMT_SAMPLE_TYPE_U32:
                audio_format->sample_type = le32_to_cpu(velem->value);
                break;
        }

        return 0;
}

static int avs_ssp_sprint(char *buf, size_t size, const char *fmt, int port, int tdm)
{
        char *needle = strstr(fmt, "%d");
        int retsize;

        /*
         * If there is %d present in fmt string it should be replaced by either
         * SSP or SSP:TDM, where SSP and TDM are numbers, all other formatting
         * will be ignored.
         */
        if (needle) {
                retsize = scnprintf(buf, min_t(size_t, size, needle - fmt + 1), "%s", fmt);
                retsize += scnprintf(buf + retsize, size - retsize, "%d", port);
                if (tdm)
                        retsize += scnprintf(buf + retsize, size - retsize, ":%d", tdm);
                retsize += scnprintf(buf + retsize, size - retsize, "%s", needle + 2);
                return retsize;
        }

        return snprintf(buf, size, "%s", fmt);
}

static int parse_link_formatted_string(struct snd_soc_component *comp, void *elem,
                                       void *object, u32 offset)
{
        struct snd_soc_tplg_vendor_string_elem *tuple = elem;
        struct snd_soc_acpi_mach *mach = dev_get_platdata(comp->card->dev);
        char *val = (char *)((u8 *)object + offset);
        int ssp_port, tdm_slot;

        /*
         * Dynamic naming - string formats, e.g.: ssp%d - supported only for
         * topologies describing single device e.g.: an I2S codec on SSP0.
         */
        if (!avs_mach_singular_ssp(mach))
                return avs_parse_string_token(comp, elem, object, offset);

        ssp_port = avs_mach_ssp_port(mach);
        if (!avs_mach_singular_tdm(mach, ssp_port))
                return avs_parse_string_token(comp, elem, object, offset);

        tdm_slot = avs_mach_ssp_tdm(mach, ssp_port);

        avs_ssp_sprint(val, SNDRV_CTL_ELEM_ID_NAME_MAXLEN, tuple->string, ssp_port, tdm_slot);

        return 0;
}

static int avs_parse_nhlt_config_size(struct snd_soc_component *comp, void *elem, void *object,
                                      u32 offset)
{
        struct snd_soc_tplg_vendor_value_elem *tuple = elem;
        struct acpi_nhlt_config **blob = (struct acpi_nhlt_config **)((u8 *)object + offset);
        u32 size;

        size = le32_to_cpu(tuple->value);
        *blob = devm_kzalloc(comp->card->dev, struct_size(*blob, capabilities, size), GFP_KERNEL);
        if (!*blob)
                return -ENOMEM;

        (*blob)->capabilities_size = size;
        return 0;
}

static int
parse_dictionary_header(struct snd_soc_component *comp,
                        struct snd_soc_tplg_vendor_array *tuples,
                        void **dict, u32 *num_entries, size_t entry_size,
                        u32 num_entries_token)
{
        struct snd_soc_tplg_vendor_value_elem *tuple;

        /* Dictionary header consists of single tuple - entry count. */
        tuple = tuples->value;
        if (le32_to_cpu(tuple->token) != num_entries_token) {
                dev_err(comp->dev, "invalid dictionary header, expected: %d\n",
                        num_entries_token);
                return -EINVAL;
        }

        *num_entries = le32_to_cpu(tuple->value);
        *dict = devm_kcalloc(comp->card->dev, *num_entries, entry_size, GFP_KERNEL);
        if (!*dict)
                return -ENOMEM;

        return 0;
}

static int
parse_dictionary_entries(struct snd_soc_component *comp,
                         struct snd_soc_tplg_vendor_array *tuples, u32 block_size,
                         void *dict, u32 num_entries, size_t entry_size,
                         u32 entry_id_token,
                         const struct avs_tplg_token_parser *parsers, size_t num_parsers)
{
        void *pos = dict;
        int i;

        for (i = 0; i < num_entries; i++) {
                u32 esize;
                int ret;

                ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                                 entry_id_token, &esize);
                if (ret)
                        return ret;

                ret = avs_parse_tokens(comp, pos, parsers, num_parsers, tuples, esize);
                if (ret < 0) {
                        dev_err(comp->dev, "parse entry: %d of type: %d failed: %d\n",
                                i, entry_id_token, ret);
                        return ret;
                }

                pos += entry_size;
                block_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        }

        return 0;
}

static int parse_dictionary(struct snd_soc_component *comp,
                            struct snd_soc_tplg_vendor_array *tuples, u32 block_size,
                            void **dict, u32 *num_entries, size_t entry_size,
                            u32 num_entries_token, u32 entry_id_token,
                            const struct avs_tplg_token_parser *parsers, size_t num_parsers)
{
        int ret;

        ret = parse_dictionary_header(comp, tuples, dict, num_entries,
                                      entry_size, num_entries_token);
        if (ret)
                return ret;

        block_size -= le32_to_cpu(tuples->size);
        /* With header parsed, move on to parsing entries. */
        tuples = avs_tplg_vendor_array_next(tuples);

        return parse_dictionary_entries(comp, tuples, block_size, *dict,
                                        *num_entries, entry_size,
                                        entry_id_token, parsers, num_parsers);
}

static const struct avs_tplg_token_parser library_parsers[] = {
        {
                .token = AVS_TKN_LIBRARY_NAME_STRING,
                .type = SND_SOC_TPLG_TUPLE_TYPE_STRING,
                .offset = offsetof(struct avs_tplg_library, name),
                .parse = avs_parse_string_token,
        },
};

static int avs_tplg_parse_libraries(struct snd_soc_component *comp,
                                    struct snd_soc_tplg_vendor_array *tuples, u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;

        return parse_dictionary(comp, tuples, block_size, (void **)&tplg->libs,
                                &tplg->num_libs, sizeof(*tplg->libs),
                                AVS_TKN_MANIFEST_NUM_LIBRARIES_U32,
                                AVS_TKN_LIBRARY_ID_U32,
                                library_parsers, ARRAY_SIZE(library_parsers));
}

static const struct avs_tplg_token_parser audio_format_parsers[] = {
        {
                .token = AVS_TKN_AFMT_SAMPLE_RATE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_audio_format, sampling_freq),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_AFMT_BIT_DEPTH_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_audio_format, bit_depth),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_AFMT_CHANNEL_MAP_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_audio_format, channel_map),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_AFMT_CHANNEL_CFG_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_audio_format, channel_config),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_AFMT_INTERLEAVING_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_audio_format, interleaving),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_AFMT_NUM_CHANNELS_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = AVS_TKN_AFMT_NUM_CHANNELS_U32,
                .parse = parse_audio_format_bitfield,
        },
        {
                .token = AVS_TKN_AFMT_VALID_BIT_DEPTH_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = AVS_TKN_AFMT_VALID_BIT_DEPTH_U32,
                .parse = parse_audio_format_bitfield,
        },
        {
                .token = AVS_TKN_AFMT_SAMPLE_TYPE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = AVS_TKN_AFMT_SAMPLE_TYPE_U32,
                .parse = parse_audio_format_bitfield,
        },
};

static int avs_tplg_parse_audio_formats(struct snd_soc_component *comp,
                                        struct snd_soc_tplg_vendor_array *tuples,
                                        u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;

        return parse_dictionary(comp, tuples, block_size, (void **)&tplg->fmts,
                                &tplg->num_fmts, sizeof(*tplg->fmts),
                                AVS_TKN_MANIFEST_NUM_AFMTS_U32,
                                AVS_TKN_AFMT_ID_U32,
                                audio_format_parsers, ARRAY_SIZE(audio_format_parsers));
}

static const struct avs_tplg_token_parser modcfg_base_parsers[] = {
        {
                .token = AVS_TKN_MODCFG_BASE_CPC_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_base, cpc),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_BASE_IBS_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_base, ibs),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_BASE_OBS_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_base, obs),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_BASE_PAGES_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_base, is_pages),
                .parse = avs_parse_word_token,
        },
};

static int avs_tplg_parse_modcfgs_base(struct snd_soc_component *comp,
                                       struct snd_soc_tplg_vendor_array *tuples,
                                       u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;

        return parse_dictionary(comp, tuples, block_size, (void **)&tplg->modcfgs_base,
                                &tplg->num_modcfgs_base, sizeof(*tplg->modcfgs_base),
                                AVS_TKN_MANIFEST_NUM_MODCFGS_BASE_U32,
                                AVS_TKN_MODCFG_BASE_ID_U32,
                                modcfg_base_parsers, ARRAY_SIZE(modcfg_base_parsers));
}

static const struct avs_tplg_token_parser modcfg_ext_parsers[] = {
        {
                .token = AVS_TKN_MODCFG_EXT_TYPE_UUID,
                .type = SND_SOC_TPLG_TUPLE_TYPE_UUID,
                .offset = offsetof(struct avs_tplg_modcfg_ext, type),
                .parse = avs_parse_uuid_token,
        },
        {
                .token = AVS_TKN_MODCFG_CPR_OUT_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, copier.out_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_CPR_FEATURE_MASK_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, copier.feature_mask),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_CPR_VINDEX_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_modcfg_ext, copier.vindex),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MODCFG_CPR_DMA_TYPE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, copier.dma_type),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_CPR_DMABUFF_SIZE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, copier.dma_buffer_size),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_CPR_BLOB_FMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, copier.blob_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_MICSEL_OUT_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, micsel.out_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_INTELWOV_CPC_LP_MODE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, wov.cpc_lp_mode),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_SRC_OUT_FREQ_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, src.out_freq),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_MUX_REF_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, mux.ref_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_MUX_OUT_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, mux.out_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_AEC_REF_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, aec.ref_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_AEC_OUT_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, aec.out_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_AEC_CPC_LP_MODE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, aec.cpc_lp_mode),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_ASRC_OUT_FREQ_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, asrc.out_freq),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_ASRC_MODE_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_modcfg_ext, asrc.mode),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MODCFG_ASRC_DISABLE_JITTER_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_modcfg_ext, asrc.disable_jitter_buffer),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_OUT_CHAN_CFG_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.out_channel_config),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_SELECT_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients_select),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_0_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[0]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_1_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[1]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_2_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[2]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_3_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[3]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_4_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[4]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_5_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[5]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_6_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[6]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_COEFF_7_S32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.coefficients[7]),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_UPDOWN_MIX_CHAN_MAP_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, updown_mix.channel_map),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_EXT_NUM_INPUT_PINS_U16,
                .type = SND_SOC_TPLG_TUPLE_TYPE_SHORT,
                .offset = offsetof(struct avs_tplg_modcfg_ext, generic.num_input_pins),
                .parse = avs_parse_short_token,
        },
        {
                .token = AVS_TKN_MODCFG_EXT_NUM_OUTPUT_PINS_U16,
                .type = SND_SOC_TPLG_TUPLE_TYPE_SHORT,
                .offset = offsetof(struct avs_tplg_modcfg_ext, generic.num_output_pins),
                .parse = avs_parse_short_token,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_REF_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.ref_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_OUT_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.out_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_WAKE_TICK_PERIOD_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.wake_tick_period),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_VINDEX_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.vindex),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_DMA_TYPE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.dma_type),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_DMABUFF_SIZE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.dma_buffer_size),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_WHM_BLOB_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, whm.blob_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MODCFG_PEAKVOL_VOLUME_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, peakvol.target_volume),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_PEAKVOL_CURVE_TYPE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, peakvol.curve_type),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MODCFG_PEAKVOL_CURVE_DURATION_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_modcfg_ext, peakvol.curve_duration),
                .parse = avs_parse_word_token,
        },
};

static const struct avs_tplg_token_parser pin_format_parsers[] = {
        {
                .token = AVS_TKN_PIN_FMT_INDEX_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pin_format, pin_index),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_PIN_FMT_IOBS_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pin_format, iobs),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_PIN_FMT_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pin_format, fmt),
                .parse = avs_parse_audio_format_ptr,
        },
};

static void
assign_copier_gtw_instance(struct snd_soc_component *comp, struct avs_tplg_modcfg_ext *cfg)
{
        struct snd_soc_acpi_mach *mach;
        int ssp_port, tdm_slot;

        if (!guid_equal(&cfg->type, &AVS_COPIER_MOD_UUID))
                return;

        /* Only I2S boards assign port instance in ->i2s_link_mask. */
        switch (cfg->copier.dma_type) {
        case AVS_DMA_I2S_LINK_OUTPUT:
        case AVS_DMA_I2S_LINK_INPUT:
                break;
        default:
                return;
        }

        /* If topology sets value don't overwrite it */
        if (cfg->copier.vindex.val)
                return;

        mach = dev_get_platdata(comp->card->dev);

        if (!avs_mach_singular_ssp(mach))
                return;
        ssp_port = avs_mach_ssp_port(mach);

        if (!avs_mach_singular_tdm(mach, ssp_port))
                return;
        tdm_slot = avs_mach_ssp_tdm(mach, ssp_port);

        cfg->copier.vindex.i2s.instance = ssp_port;
        cfg->copier.vindex.i2s.time_slot = tdm_slot;
}

static int avs_tplg_parse_modcfg_ext(struct snd_soc_component *comp,
                                     struct avs_tplg_modcfg_ext *cfg,
                                     struct snd_soc_tplg_vendor_array *tuples,
                                     u32 block_size)
{
        u32 esize;
        int ret;

        /* See where pin block starts. */
        ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                         AVS_TKN_PIN_FMT_INDEX_U32, &esize);
        if (ret)
                return ret;

        ret = avs_parse_tokens(comp, cfg, modcfg_ext_parsers,
                               ARRAY_SIZE(modcfg_ext_parsers), tuples, esize);
        if (ret)
                return ret;

        /* Update copier gateway based on board's i2s_link_mask. */
        assign_copier_gtw_instance(comp, cfg);

        block_size -= esize;
        /* Parse trailing in/out pin formats if any. */
        if (block_size) {
                struct avs_tplg_pin_format *pins;
                u32 num_pins;

                num_pins = cfg->generic.num_input_pins + cfg->generic.num_output_pins;
                if (!num_pins)
                        return -EINVAL;

                pins = devm_kcalloc(comp->card->dev, num_pins, sizeof(*pins), GFP_KERNEL);
                if (!pins)
                        return -ENOMEM;

                tuples = avs_tplg_vendor_array_at(tuples, esize);
                ret = parse_dictionary_entries(comp, tuples, block_size,
                                               pins, num_pins, sizeof(*pins),
                                               AVS_TKN_PIN_FMT_INDEX_U32,
                                               pin_format_parsers,
                                               ARRAY_SIZE(pin_format_parsers));
                if (ret)
                        return ret;
                cfg->generic.pin_fmts = pins;
        }

        return 0;
}

static int avs_tplg_parse_modcfgs_ext(struct snd_soc_component *comp,
                                      struct snd_soc_tplg_vendor_array *tuples,
                                      u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;
        int ret, i;

        ret = parse_dictionary_header(comp, tuples, (void **)&tplg->modcfgs_ext,
                                      &tplg->num_modcfgs_ext,
                                      sizeof(*tplg->modcfgs_ext),
                                      AVS_TKN_MANIFEST_NUM_MODCFGS_EXT_U32);
        if (ret)
                return ret;

        block_size -= le32_to_cpu(tuples->size);
        /* With header parsed, move on to parsing entries. */
        tuples = avs_tplg_vendor_array_next(tuples);

        for (i = 0; i < tplg->num_modcfgs_ext; i++) {
                struct avs_tplg_modcfg_ext *cfg = &tplg->modcfgs_ext[i];
                u32 esize;

                ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                                 AVS_TKN_MODCFG_EXT_ID_U32, &esize);
                if (ret)
                        return ret;

                ret = avs_tplg_parse_modcfg_ext(comp, cfg, tuples, esize);
                if (ret)
                        return ret;

                block_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        }

        return 0;
}

static const struct avs_tplg_token_parser pplcfg_parsers[] = {
        {
                .token = AVS_TKN_PPLCFG_REQ_SIZE_U16,
                .type = SND_SOC_TPLG_TUPLE_TYPE_SHORT,
                .offset = offsetof(struct avs_tplg_pplcfg, req_size),
                .parse = avs_parse_short_token,
        },
        {
                .token = AVS_TKN_PPLCFG_PRIORITY_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_pplcfg, priority),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_PPLCFG_LOW_POWER_BOOL,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BOOL,
                .offset = offsetof(struct avs_tplg_pplcfg, lp),
                .parse = avs_parse_bool_token,
        },
        {
                .token = AVS_TKN_PPLCFG_ATTRIBUTES_U16,
                .type = SND_SOC_TPLG_TUPLE_TYPE_SHORT,
                .offset = offsetof(struct avs_tplg_pplcfg, attributes),
                .parse = avs_parse_short_token,
        },
        {
                .token = AVS_TKN_PPLCFG_TRIGGER_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pplcfg, trigger),
                .parse = avs_parse_word_token,
        },
};

static int avs_tplg_parse_pplcfgs(struct snd_soc_component *comp,
                                  struct snd_soc_tplg_vendor_array *tuples,
                                  u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;

        return parse_dictionary(comp, tuples, block_size, (void **)&tplg->pplcfgs,
                                &tplg->num_pplcfgs, sizeof(*tplg->pplcfgs),
                                AVS_TKN_MANIFEST_NUM_PPLCFGS_U32,
                                AVS_TKN_PPLCFG_ID_U32,
                                pplcfg_parsers, ARRAY_SIZE(pplcfg_parsers));
}

static const struct avs_tplg_token_parser binding_parsers[] = {
        {
                .token = AVS_TKN_BINDING_TARGET_TPLG_NAME_STRING,
                .type = SND_SOC_TPLG_TUPLE_TYPE_STRING,
                .offset = offsetof(struct avs_tplg_binding, target_tplg_name),
                .parse = parse_link_formatted_string,
        },
        {
                .token = AVS_TKN_BINDING_TARGET_PATH_TMPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_binding, target_path_tmpl_id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_BINDING_TARGET_PPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_binding, target_ppl_id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_BINDING_TARGET_MOD_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_binding, target_mod_id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_BINDING_TARGET_MOD_PIN_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_binding, target_mod_pin),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_BINDING_MOD_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_binding, mod_id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_BINDING_MOD_PIN_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_binding, mod_pin),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_BINDING_IS_SINK_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_binding, is_sink),
                .parse = avs_parse_byte_token,
        },
};

static int avs_tplg_parse_bindings(struct snd_soc_component *comp,
                                   struct snd_soc_tplg_vendor_array *tuples,
                                   u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;

        return parse_dictionary(comp, tuples, block_size, (void **)&tplg->bindings,
                                &tplg->num_bindings, sizeof(*tplg->bindings),
                                AVS_TKN_MANIFEST_NUM_BINDINGS_U32,
                                AVS_TKN_BINDING_ID_U32,
                                binding_parsers, ARRAY_SIZE(binding_parsers));
}

static const struct avs_tplg_token_parser module_parsers[] = {
        {
                .token = AVS_TKN_MOD_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_MOD_MODCFG_BASE_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, cfg_base),
                .parse = avs_parse_modcfg_base_ptr,
        },
        {
                .token = AVS_TKN_MOD_IN_AFMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, in_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_MOD_CORE_ID_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_module, core_id),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MOD_PROC_DOMAIN_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_module, domain),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MOD_MODCFG_EXT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, cfg_ext),
                .parse = avs_parse_modcfg_ext_ptr,
        },
        {
                .token = AVS_TKN_MOD_KCONTROL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, ctl_id),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MOD_INIT_CONFIG_NUM_IDS_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, num_config_ids),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_MOD_NHLT_CONFIG_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_module, nhlt_config),
                .parse = avs_parse_nhlt_config_ptr,
        },
};

static const struct avs_tplg_token_parser init_config_parsers[] = {
        {
                .token = AVS_TKN_MOD_INIT_CONFIG_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = 0,
                .parse = avs_parse_word_token,
        },
};

static struct avs_tplg_module *
avs_tplg_module_create(struct snd_soc_component *comp, struct avs_tplg_pipeline *owner,
                       struct snd_soc_tplg_vendor_array *tuples, u32 block_size)
{
        struct avs_tplg_module *module;
        u32 esize;
        int ret;

        /* See where config id block starts. */
        ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                         AVS_TKN_MOD_INIT_CONFIG_ID_U32, &esize);
        if (ret)
                return ERR_PTR(ret);

        module = devm_kzalloc(comp->card->dev, sizeof(*module), GFP_KERNEL);
        if (!module)
                return ERR_PTR(-ENOMEM);

        ret = avs_parse_tokens(comp, module, module_parsers,
                               ARRAY_SIZE(module_parsers), tuples, esize);
        if (ret < 0)
                return ERR_PTR(ret);

        block_size -= esize;
        /* Parse trailing config ids if any. */
        if (block_size) {
                u32 num_config_ids = module->num_config_ids;
                u32 *config_ids;

                if (!num_config_ids)
                        return ERR_PTR(-EINVAL);

                config_ids = devm_kcalloc(comp->card->dev, num_config_ids, sizeof(*config_ids),
                                           GFP_KERNEL);
                if (!config_ids)
                        return ERR_PTR(-ENOMEM);

                tuples = avs_tplg_vendor_array_at(tuples, esize);
                ret = parse_dictionary_entries(comp, tuples, block_size,
                                               config_ids, num_config_ids, sizeof(*config_ids),
                                               AVS_TKN_MOD_INIT_CONFIG_ID_U32,
                                               init_config_parsers,
                                               ARRAY_SIZE(init_config_parsers));
                if (ret)
                        return ERR_PTR(ret);

                module->config_ids = config_ids;
        }

        module->owner = owner;
        INIT_LIST_HEAD(&module->node);

        return module;
}

static const struct avs_tplg_token_parser pipeline_parsers[] = {
        {
                .token = AVS_TKN_PPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pipeline, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_PPL_PPLCFG_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pipeline, cfg),
                .parse = avs_parse_pplcfg_ptr,
        },
        {
                .token = AVS_TKN_PPL_NUM_BINDING_IDS_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_pipeline, num_bindings),
                .parse = avs_parse_word_token,
        },
};

static const struct avs_tplg_token_parser bindings_parsers[] = {
        {
                .token = AVS_TKN_PPL_BINDING_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = 0, /* to treat pipeline->bindings as dictionary */
                .parse = avs_parse_binding_ptr,
        },
};

static struct avs_tplg_pipeline *
avs_tplg_pipeline_create(struct snd_soc_component *comp, struct avs_tplg_path *owner,
                         struct snd_soc_tplg_vendor_array *tuples, u32 block_size)
{
        struct avs_tplg_pipeline *pipeline;
        u32 modblk_size, offset;
        int ret;

        pipeline = devm_kzalloc(comp->card->dev, sizeof(*pipeline), GFP_KERNEL);
        if (!pipeline)
                return ERR_PTR(-ENOMEM);

        pipeline->owner = owner;
        INIT_LIST_HEAD(&pipeline->mod_list);

        /* Pipeline header MUST be followed by at least one module. */
        ret = avs_tplg_vendor_array_lookup(tuples, block_size,
                                           AVS_TKN_MOD_ID_U32, &offset);
        if (!ret && !offset)
                ret = -EINVAL;
        if (ret)
                return ERR_PTR(ret);

        /* Process header which precedes module sections. */
        ret = avs_parse_tokens(comp, pipeline, pipeline_parsers,
                               ARRAY_SIZE(pipeline_parsers), tuples, offset);
        if (ret < 0)
                return ERR_PTR(ret);

        block_size -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        /* Optionally, binding sections follow module ones. */
        ret = avs_tplg_vendor_array_lookup_next(tuples, block_size,
                                                AVS_TKN_PPL_BINDING_ID_U32, &offset);
        if (ret) {
                if (ret != -ENOENT)
                        return ERR_PTR(ret);

                /* Does header information match actual block layout? */
                if (pipeline->num_bindings)
                        return ERR_PTR(-EINVAL);

                modblk_size = block_size;
        } else {
                pipeline->bindings = devm_kcalloc(comp->card->dev, pipeline->num_bindings,
                                                  sizeof(*pipeline->bindings), GFP_KERNEL);
                if (!pipeline->bindings)
                        return ERR_PTR(-ENOMEM);

                modblk_size = offset;
        }

        block_size -= modblk_size;
        do {
                struct avs_tplg_module *module;
                u32 esize;

                ret = avs_tplg_vendor_entry_size(tuples, modblk_size,
                                                 AVS_TKN_MOD_ID_U32, &esize);
                if (ret)
                        return ERR_PTR(ret);

                module = avs_tplg_module_create(comp, pipeline, tuples, esize);
                if (IS_ERR(module)) {
                        dev_err(comp->dev, "parse module failed: %ld\n",
                                PTR_ERR(module));
                        return ERR_CAST(module);
                }

                list_add_tail(&module->node, &pipeline->mod_list);
                modblk_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        } while (modblk_size > 0);

        /* What's left is optional range of bindings. */
        ret = parse_dictionary_entries(comp, tuples, block_size, pipeline->bindings,
                                       pipeline->num_bindings, sizeof(*pipeline->bindings),
                                       AVS_TKN_PPL_BINDING_ID_U32,
                                       bindings_parsers, ARRAY_SIZE(bindings_parsers));
        if (ret)
                return ERR_PTR(ret);

        return pipeline;
}

static const struct avs_tplg_token_parser path_parsers[] = {
        {
                .token = AVS_TKN_PATH_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_PATH_FE_FMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path, fe_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
        {
                .token = AVS_TKN_PATH_BE_FMT_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path, be_fmt),
                .parse = avs_parse_audio_format_ptr,
        },
};

static const struct avs_tplg_token_parser condpath_parsers[] = {
        {
                .token = AVS_TKN_CONDPATH_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_CONDPATH_SOURCE_PATH_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path, source_path_id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_CONDPATH_SINK_PATH_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path, sink_path_id),
                .parse = avs_parse_word_token,
        },
};

static struct avs_tplg_path *
avs_tplg_path_create(struct snd_soc_component *comp, struct avs_tplg_path_template *owner,
                     struct snd_soc_tplg_vendor_array *tuples, u32 block_size,
                     const struct avs_tplg_token_parser *parsers, u32 num_parsers)
{
        struct avs_tplg_pipeline *pipeline;
        struct avs_tplg_path *path;
        u32 offset;
        int ret;

        path = devm_kzalloc(comp->card->dev, sizeof(*path), GFP_KERNEL);
        if (!path)
                return ERR_PTR(-ENOMEM);

        path->owner = owner;
        INIT_LIST_HEAD(&path->ppl_list);
        INIT_LIST_HEAD(&path->node);

        /* Path header MAY be followed by one or more pipelines. */
        ret = avs_tplg_vendor_array_lookup(tuples, block_size,
                                           AVS_TKN_PPL_ID_U32, &offset);
        if (ret == -ENOENT)
                offset = block_size;
        else if (ret)
                return ERR_PTR(ret);
        else if (!offset)
                return ERR_PTR(-EINVAL);

        /* Process header which precedes pipeline sections. */
        ret = avs_parse_tokens(comp, path, parsers, num_parsers, tuples, offset);
        if (ret < 0)
                return ERR_PTR(ret);

        block_size -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);
        while (block_size > 0) {
                u32 esize;

                ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                                 AVS_TKN_PPL_ID_U32, &esize);
                if (ret)
                        return ERR_PTR(ret);

                pipeline = avs_tplg_pipeline_create(comp, path, tuples, esize);
                if (IS_ERR(pipeline)) {
                        dev_err(comp->dev, "parse pipeline failed: %ld\n",
                                PTR_ERR(pipeline));
                        return ERR_CAST(pipeline);
                }

                list_add_tail(&pipeline->node, &path->ppl_list);
                block_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        }

        return path;
}

static const struct avs_tplg_token_parser path_tmpl_parsers[] = {
        {
                .token = AVS_TKN_PATH_TMPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path_template, id),
                .parse = avs_parse_word_token,
        },
};

static const struct avs_tplg_token_parser condpath_tmpl_parsers[] = {
        {
                .token = AVS_TKN_CONDPATH_TMPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path_template, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_CONDPATH_TMPL_SOURCE_TPLG_NAME_STRING,
                .type = SND_SOC_TPLG_TUPLE_TYPE_STRING,
                .offset = offsetof(struct avs_tplg_path_template, source.tplg_name),
                .parse = avs_parse_string_token,
        },
        {
                .token = AVS_TKN_CONDPATH_TMPL_SOURCE_PATH_TMPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path_template, source.id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_CONDPATH_TMPL_SINK_TPLG_NAME_STRING,
                .type = SND_SOC_TPLG_TUPLE_TYPE_STRING,
                .offset = offsetof(struct avs_tplg_path_template, sink.tplg_name),
                .parse = avs_parse_string_token,
        },
        {
                .token = AVS_TKN_CONDPATH_TMPL_SINK_PATH_TMPL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_path_template, sink.id),
                .parse = avs_parse_word_token,
        },
};

static int parse_path_template(struct snd_soc_component *comp,
                               struct snd_soc_tplg_vendor_array *tuples, u32 block_size,
                               struct avs_tplg_path_template *template,
                               const struct avs_tplg_token_parser *tmpl_tokens, u32 num_tmpl_tokens,
                               const struct avs_tplg_token_parser *path_tokens, u32 num_path_tokens)
{
        struct avs_tplg_path *path;
        u32 offset;
        int ret;

        /* Path template header MUST be followed by at least one path variant. */
        ret = avs_tplg_vendor_array_lookup(tuples, block_size,
                                           AVS_TKN_PATH_ID_U32, &offset);
        if (ret)
                return ret;

        /* Process header which precedes path variants sections. */
        ret = avs_parse_tokens(comp, template, tmpl_tokens, num_tmpl_tokens, tuples, offset);
        if (ret < 0)
                return ret;

        block_size -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);
        do {
                u32 esize;

                ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                                 AVS_TKN_PATH_ID_U32, &esize);
                if (ret)
                        return ret;

                path = avs_tplg_path_create(comp, template, tuples, esize, path_tokens,
                                            num_path_tokens);
                if (IS_ERR(path)) {
                        dev_err(comp->dev, "parse path failed: %ld\n", PTR_ERR(path));
                        return PTR_ERR(path);
                }

                list_add_tail(&path->node, &template->path_list);
                block_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        } while (block_size > 0);

        return 0;
}

static struct avs_tplg_path_template *
avs_tplg_path_template_create(struct snd_soc_component *comp, struct avs_tplg *owner,
                              struct snd_soc_tplg_vendor_array *tuples, u32 block_size)
{
        struct avs_tplg_path_template *template;
        int ret;

        template = devm_kzalloc(comp->card->dev, sizeof(*template), GFP_KERNEL);
        if (!template)
                return ERR_PTR(-ENOMEM);

        template->owner = owner; /* Used to access component tplg is assigned to. */
        INIT_LIST_HEAD(&template->path_list);
        INIT_LIST_HEAD(&template->node);

        ret = parse_path_template(comp, tuples, block_size, template, path_tmpl_parsers,
                                  ARRAY_SIZE(path_tmpl_parsers), path_parsers,
                                  ARRAY_SIZE(path_parsers));
        if (ret)
                return ERR_PTR(ret);

        return template;
}

static int avs_tplg_parse_condpath_templates(struct snd_soc_component *comp,
                                             struct snd_soc_tplg_vendor_array *tuples,
                                             u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;
        int ret, i;

        ret = parse_dictionary_header(comp, tuples, (void **)&tplg->condpath_tmpls,
                                      &tplg->num_condpath_tmpls,
                                      sizeof(*tplg->condpath_tmpls),
                                      AVS_TKN_MANIFEST_NUM_CONDPATH_TMPLS_U32);
        if (ret)
                return ret;

        block_size -= le32_to_cpu(tuples->size);
        /* With header parsed, move on to parsing entries. */
        tuples = avs_tplg_vendor_array_next(tuples);

        for (i = 0; i < tplg->num_condpath_tmpls; i++) {
                struct avs_tplg_path_template *template;
                u32 esize;

                template = &tplg->condpath_tmpls[i];
                template->owner = tplg; /* Used when building sysfs hierarchy. */
                INIT_LIST_HEAD(&template->path_list);
                INIT_LIST_HEAD(&template->node);

                ret = avs_tplg_vendor_entry_size(tuples, block_size,
                                                 AVS_TKN_CONDPATH_TMPL_ID_U32, &esize);
                if (ret)
                        return ret;

                ret = parse_path_template(comp, tuples, esize, template,
                                          condpath_tmpl_parsers,
                                          ARRAY_SIZE(condpath_tmpl_parsers),
                                          condpath_parsers,
                                          ARRAY_SIZE(condpath_parsers));
                if (ret < 0) {
                        dev_err(comp->dev, "parse condpath_tmpl: %d failed: %d\n", i, ret);
                        return ret;
                }

                block_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        }

        return 0;
}

static const struct avs_tplg_token_parser mod_init_config_parsers[] = {
        {
                .token = AVS_TKN_INIT_CONFIG_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_init_config, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_INIT_CONFIG_PARAM_U8,
                .type = SND_SOC_TPLG_TUPLE_TYPE_BYTE,
                .offset = offsetof(struct avs_tplg_init_config, param),
                .parse = avs_parse_byte_token,
        },
        {
                .token = AVS_TKN_INIT_CONFIG_LENGTH_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_init_config, length),
                .parse = avs_parse_word_token,
        },
};

static int avs_tplg_parse_initial_configs(struct snd_soc_component *comp,
                                           struct snd_soc_tplg_vendor_array *tuples,
                                           u32 block_size, u32 *offset)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;
        int ret, i;

        *offset = 0;

        /* Parse tuple section telling how many init configs there are. */
        ret = parse_dictionary_header(comp, tuples, (void **)&tplg->init_configs,
                                      &tplg->num_init_configs,
                                      sizeof(*tplg->init_configs),
                                      AVS_TKN_MANIFEST_NUM_INIT_CONFIGS_U32);
        if (ret)
                return ret;

        block_size -= le32_to_cpu(tuples->size);
        *offset += le32_to_cpu(tuples->size);
        /* With header parsed, move on to parsing entries. */
        tuples = avs_tplg_vendor_array_next(tuples);

        for (i = 0; i < tplg->num_init_configs && block_size > 0; i++) {
                struct avs_tplg_init_config *config = &tplg->init_configs[i];
                struct snd_soc_tplg_vendor_array *tmp;
                void *init_config_data;
                u32 esize;

                /*
                 * Usually to get section length we search for first token of next group of data,
                 * but in this case we can't as tuples are followed by raw data.
                 */
                tmp = avs_tplg_vendor_array_next(tuples);
                esize = le32_to_cpu(tuples->size) + le32_to_cpu(tmp->size);
                *offset += esize;

                ret = parse_dictionary_entries(comp, tuples, esize, config, 1, sizeof(*config),
                                               AVS_TKN_INIT_CONFIG_ID_U32,
                                               mod_init_config_parsers,
                                               ARRAY_SIZE(mod_init_config_parsers));

                block_size -= esize;

                /* handle raw data section */
                init_config_data = (void *)tuples + esize;
                esize = config->length;
                *offset += esize;

                config->data = devm_kmemdup(comp->card->dev, init_config_data, esize, GFP_KERNEL);
                if (!config->data)
                        return -ENOMEM;

                tuples = init_config_data + esize;
                block_size -= esize;
        }

        return 0;
}

static const struct avs_tplg_token_parser mod_nhlt_config_parsers[] = {
        {
                .token = AVS_TKN_NHLT_CONFIG_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_nhlt_config, id),
                .parse = avs_parse_word_token,
        },
        {
                .token = AVS_TKN_NHLT_CONFIG_SIZE_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg_nhlt_config, blob),
                .parse = avs_parse_nhlt_config_size,
        },
};

static int avs_tplg_parse_nhlt_configs(struct snd_soc_component *comp,
                                       struct snd_soc_tplg_vendor_array *tuples,
                                       u32 block_size)
{
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg = acomp->tplg;
        int ret, i;

        /* Parse the header section to know how many entries there are. */
        ret = parse_dictionary_header(comp, tuples, (void **)&tplg->nhlt_configs,
                                      &tplg->num_nhlt_configs,
                                      sizeof(*tplg->nhlt_configs),
                                      AVS_TKN_MANIFEST_NUM_NHLT_CONFIGS_U32);
        if (ret)
                return ret;

        block_size -= le32_to_cpu(tuples->size);
        /* With the header parsed, move on to parsing entries. */
        tuples = avs_tplg_vendor_array_next(tuples);

        for (i = 0; i < tplg->num_nhlt_configs && block_size > 0; i++) {
                struct avs_tplg_nhlt_config *config;
                u32 esize;

                config = &tplg->nhlt_configs[i];
                esize = le32_to_cpu(tuples->size);

                ret = parse_dictionary_entries(comp, tuples, esize, config, 1, sizeof(*config),
                                               AVS_TKN_NHLT_CONFIG_ID_U32,
                                               mod_nhlt_config_parsers,
                                               ARRAY_SIZE(mod_nhlt_config_parsers));
                if (ret)
                        return ret;
                /* With tuples parsed, the blob shall be allocated. */
                if (!config->blob)
                        return -EINVAL;

                /* Consume the raw data and move to the next entry. */
                memcpy(config->blob->capabilities, (u8 *)tuples + esize,
                       config->blob->capabilities_size);
                esize += config->blob->capabilities_size;

                block_size -= esize;
                tuples = avs_tplg_vendor_array_at(tuples, esize);
        }

        return 0;
}

static int avs_route_load(struct snd_soc_component *comp, int index,
                          struct snd_soc_dapm_route *route)
{
        struct snd_soc_acpi_mach *mach = dev_get_platdata(comp->card->dev);
        size_t len = SNDRV_CTL_ELEM_ID_NAME_MAXLEN;
        int ssp_port, tdm_slot;
        char *buf;

        /* See parse_link_formatted_string() for dynamic naming when(s). */
        if (!avs_mach_singular_ssp(mach))
                return 0;
        ssp_port = avs_mach_ssp_port(mach);

        if (!avs_mach_singular_tdm(mach, ssp_port))
                return 0;
        tdm_slot = avs_mach_ssp_tdm(mach, ssp_port);

        buf = devm_kzalloc(comp->card->dev, len, GFP_KERNEL);
        if (!buf)
                return -ENOMEM;
        avs_ssp_sprint(buf, len, route->source, ssp_port, tdm_slot);
        route->source = buf;

        buf = devm_kzalloc(comp->card->dev, len, GFP_KERNEL);
        if (!buf)
                return -ENOMEM;
        avs_ssp_sprint(buf, len, route->sink, ssp_port, tdm_slot);
        route->sink = buf;

        if (route->control) {
                buf = devm_kzalloc(comp->card->dev, len, GFP_KERNEL);
                if (!buf)
                        return -ENOMEM;
                avs_ssp_sprint(buf, len, route->control, ssp_port, tdm_slot);
                route->control = buf;
        }

        return 0;
}

static int avs_widget_load(struct snd_soc_component *comp, int index,
                           struct snd_soc_dapm_widget *w,
                           struct snd_soc_tplg_dapm_widget *dw)
{
        struct snd_soc_acpi_mach *mach;
        struct avs_tplg_path_template *template;
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        struct avs_tplg *tplg;
        int ssp_port, tdm_slot;

        if (!le32_to_cpu(dw->priv.size))
                return 0;

        w->no_wname_in_kcontrol_name = true;

        if (w->ignore_suspend && !AVS_S0IX_SUPPORTED) {
                dev_info_once(comp->dev, "Device does not support S0IX, check BIOS settings\n");
                w->ignore_suspend = false;
        }

        tplg = acomp->tplg;
        mach = dev_get_platdata(comp->card->dev);
        if (!avs_mach_singular_ssp(mach))
                goto static_name;
        ssp_port = avs_mach_ssp_port(mach);

        /* See parse_link_formatted_string() for dynamic naming when(s). */
        if (avs_mach_singular_tdm(mach, ssp_port)) {
                /* size is based on possible %d -> SSP:TDM, where SSP and TDM < 16 + '\0' */
                size_t size = strlen(dw->name) + 3;
                char *buf;

                tdm_slot = avs_mach_ssp_tdm(mach, ssp_port);

                buf = kmalloc(size, GFP_KERNEL);
                if (!buf)
                        return -ENOMEM;
                avs_ssp_sprint(buf, size, dw->name, ssp_port, tdm_slot);
                kfree(w->name);
                /* w->name is freed later by soc_tplg_dapm_widget_create() */
                w->name = buf;
        }

static_name:
        template = avs_tplg_path_template_create(comp, tplg, dw->priv.array,
                                                 le32_to_cpu(dw->priv.size));
        if (IS_ERR(template)) {
                dev_err(comp->dev, "widget %s load failed: %ld\n", dw->name,
                        PTR_ERR(template));
                return PTR_ERR(template);
        }

        w->priv = template; /* link path information to widget */
        list_add_tail(&template->node, &tplg->path_tmpl_list);
        return 0;
}

static int avs_widget_ready(struct snd_soc_component *comp, int index,
                            struct snd_soc_dapm_widget *w,
                            struct snd_soc_tplg_dapm_widget *dw)
{
        struct avs_tplg_path_template *template = w->priv;

        template->w = w;
        return 0;
}

static int avs_dai_load(struct snd_soc_component *comp, int index,
                        struct snd_soc_dai_driver *dai_drv, struct snd_soc_tplg_pcm *pcm,
                        struct snd_soc_dai *dai)
{
        u32 fe_subformats = SNDRV_PCM_SUBFMTBIT_MSBITS_20 |
                            SNDRV_PCM_SUBFMTBIT_MSBITS_24 |
                            SNDRV_PCM_SUBFMTBIT_MSBITS_MAX;

        if (pcm) {
                dai_drv->ops = &avs_dai_fe_ops;
                dai_drv->capture.subformats = fe_subformats;
                dai_drv->playback.subformats = fe_subformats;
        }

        return 0;
}

static int avs_link_load(struct snd_soc_component *comp, int index, struct snd_soc_dai_link *link,
                         struct snd_soc_tplg_link_config *cfg)
{
        if (link->ignore_suspend && !AVS_S0IX_SUPPORTED) {
                dev_info_once(comp->dev, "Device does not support S0IX, check BIOS settings\n");
                link->ignore_suspend = false;
        }

        if (!link->no_pcm) {
                /* Stream control handled by IPCs. */
                link->nonatomic = true;

                /* Open LINK (BE) pipes last and close them first to prevent xruns. */
                link->trigger[0] = SND_SOC_DPCM_TRIGGER_PRE;
                link->trigger[1] = SND_SOC_DPCM_TRIGGER_PRE;
        } else {
                /* Do not ignore codec capabilities. */
                link->dpcm_merged_format = 1;
        }

        return 0;
}

static const struct avs_tplg_token_parser manifest_parsers[] = {
        {
                .token = AVS_TKN_MANIFEST_NAME_STRING,
                .type = SND_SOC_TPLG_TUPLE_TYPE_STRING,
                .offset = offsetof(struct avs_tplg, name),
                .parse = parse_link_formatted_string,
        },
        {
                .token = AVS_TKN_MANIFEST_VERSION_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_tplg, version),
                .parse = avs_parse_word_token,
        },
};

static int avs_manifest(struct snd_soc_component *comp, int index,
                        struct snd_soc_tplg_manifest *manifest)
{
        struct snd_soc_tplg_vendor_array *tuples = manifest->priv.array;
        struct avs_soc_component *acomp = to_avs_soc_component(comp);
        size_t remaining = le32_to_cpu(manifest->priv.size);
        bool has_init_config = true;
        u32 offset;
        int ret;

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_LIBRARIES_U32, &offset);
        /* Manifest MUST begin with a header. */
        if (!ret && !offset)
                ret = -EINVAL;
        if (ret) {
                dev_err(comp->dev, "incorrect manifest format: %d\n", ret);
                return ret;
        }

        /* Process header which precedes any of the dictionaries. */
        ret = avs_parse_tokens(comp, acomp->tplg, manifest_parsers,
                               ARRAY_SIZE(manifest_parsers), tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_AFMTS_U32, &offset);
        if (ret) {
                dev_err(comp->dev, "audio formats lookup failed: %d\n", ret);
                return ret;
        }

        /* Libraries dictionary. */
        ret = avs_tplg_parse_libraries(comp, tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_MODCFGS_BASE_U32, &offset);
        if (ret) {
                dev_err(comp->dev, "modcfgs_base lookup failed: %d\n", ret);
                return ret;
        }

        /* Audio formats dictionary. */
        ret = avs_tplg_parse_audio_formats(comp, tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_MODCFGS_EXT_U32, &offset);
        if (ret) {
                dev_err(comp->dev, "modcfgs_ext lookup failed: %d\n", ret);
                return ret;
        }

        /* Module configs-base dictionary. */
        ret = avs_tplg_parse_modcfgs_base(comp, tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_PPLCFGS_U32, &offset);
        if (ret) {
                dev_err(comp->dev, "pplcfgs lookup failed: %d\n", ret);
                return ret;
        }

        /* Module configs-ext dictionary. */
        ret = avs_tplg_parse_modcfgs_ext(comp, tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_BINDINGS_U32, &offset);
        if (ret) {
                dev_err(comp->dev, "bindings lookup failed: %d\n", ret);
                return ret;
        }

        /* Pipeline configs dictionary. */
        ret = avs_tplg_parse_pplcfgs(comp, tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_CONDPATH_TMPLS_U32, &offset);
        if (ret) {
                dev_err(comp->dev, "condpath lookup failed: %d\n", ret);
                return ret;
        }

        /* Bindings dictionary. */
        ret = avs_tplg_parse_bindings(comp, tuples, offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_INIT_CONFIGS_U32, &offset);
        if (ret == -ENOENT) {
                dev_dbg(comp->dev, "init config lookup failed: %d\n", ret);
                has_init_config = false;
        } else if (ret) {
                dev_err(comp->dev, "init config lookup failed: %d\n", ret);
                return ret;
        }

        /* Condpaths dictionary. */
        ret = avs_tplg_parse_condpath_templates(comp, tuples,
                                                has_init_config ? offset : remaining);
        if (ret < 0)
                return ret;

        if (!has_init_config)
                return 0;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        /* Initial configs dictionary. */
        ret = avs_tplg_parse_initial_configs(comp, tuples, remaining, &offset);
        if (ret < 0)
                return ret;

        remaining -= offset;
        tuples = avs_tplg_vendor_array_at(tuples, offset);

        ret = avs_tplg_vendor_array_lookup(tuples, remaining,
                                           AVS_TKN_MANIFEST_NUM_NHLT_CONFIGS_U32, &offset);
        if (ret == -ENOENT)
                return 0;
        if (ret) {
                dev_err(comp->dev, "NHLT config lookup failed: %d\n", ret);
                return ret;
        }

        tuples = avs_tplg_vendor_array_at(tuples, offset);

        /* NHLT configs dictionary. */
        return avs_tplg_parse_nhlt_configs(comp, tuples, remaining);
}

enum {
        AVS_CONTROL_OPS_VOLUME = 257,
        AVS_CONTROL_OPS_MUTE,
};

static const struct snd_soc_tplg_kcontrol_ops avs_control_ops[] = {
        {
                .id = AVS_CONTROL_OPS_VOLUME,
                .get = avs_control_volume_get,
                .put = avs_control_volume_put,
                .info = avs_control_volume_info,
        },
        {
                .id = AVS_CONTROL_OPS_MUTE,
                .get = avs_control_mute_get,
                .put = avs_control_mute_put,
                .info = avs_control_mute_info,
        },
};

static const struct avs_tplg_token_parser control_parsers[] = {
        {
                .token = AVS_TKN_KCONTROL_ID_U32,
                .type = SND_SOC_TPLG_TUPLE_TYPE_WORD,
                .offset = offsetof(struct avs_control_data, id),
                .parse = avs_parse_word_token,
        },
};

static int
avs_control_load(struct snd_soc_component *comp, int index, struct snd_kcontrol_new *ctmpl,
                 struct snd_soc_tplg_ctl_hdr *hdr)
{
        struct snd_soc_tplg_vendor_array *tuples;
        struct snd_soc_tplg_mixer_control *tmc;
        struct avs_control_data *ctl_data;
        struct soc_mixer_control *mc;
        size_t block_size;
        int ret, i;

        switch (le32_to_cpu(hdr->type)) {
        case SND_SOC_TPLG_TYPE_MIXER:
                break;
        default:
                return -EINVAL;
        }

        mc = (struct soc_mixer_control *)ctmpl->private_value;
        tmc = container_of(hdr, typeof(*tmc), hdr);
        tuples = tmc->priv.array;
        block_size = le32_to_cpu(tmc->priv.size);

        ctl_data = devm_kzalloc(comp->card->dev, sizeof(*ctl_data), GFP_KERNEL);
        if (!ctl_data)
                return -ENOMEM;

        ret = parse_dictionary_entries(comp, tuples, block_size, ctl_data, 1, sizeof(*ctl_data),
                                       AVS_TKN_KCONTROL_ID_U32, control_parsers,
                                       ARRAY_SIZE(control_parsers));
        if (ret)
                return ret;

        mc->dobj.private = ctl_data;
        if (tmc->invert) {
                ctl_data->values[0] = mc->max;
                for (i = 1; i < mc->num_channels; i++)
                        ctl_data->values[i] = mc->max;
        }

        return 0;
}

static const struct snd_soc_tplg_ops avs_tplg_ops = {
        .io_ops                 = avs_control_ops,
        .io_ops_count           = ARRAY_SIZE(avs_control_ops),
        .control_load           = avs_control_load,
        .dapm_route_load        = avs_route_load,
        .widget_load            = avs_widget_load,
        .widget_ready           = avs_widget_ready,
        .dai_load               = avs_dai_load,
        .link_load              = avs_link_load,
        .manifest               = avs_manifest,
};

struct avs_tplg *avs_tplg_new(struct snd_soc_component *comp)
{
        struct avs_tplg *tplg;

        tplg = devm_kzalloc(comp->card->dev, sizeof(*tplg), GFP_KERNEL);
        if (!tplg)
                return NULL;

        tplg->comp = comp;
        INIT_LIST_HEAD(&tplg->path_tmpl_list);

        return tplg;
}

int avs_load_topology(struct snd_soc_component *comp, const char *filename)
{
        const struct firmware *fw;
        int ret;

        ret = request_firmware(&fw, filename, comp->dev);
        if (ret < 0) {
                dev_err(comp->dev, "request topology \"%s\" failed: %d\n", filename, ret);
                return ret;
        }

        ret = snd_soc_tplg_component_load(comp, &avs_tplg_ops, fw);
        if (ret < 0)
                dev_err(comp->dev, "load topology \"%s\" failed: %d\n", filename, ret);

        release_firmware(fw);
        return ret;
}

int avs_remove_topology(struct snd_soc_component *comp)
{
        snd_soc_tplg_component_remove(comp);

        return 0;
}