// SPDX-License-Identifier: GPL-2.0+
//
// soc-topology.c  --  ALSA SoC Topology
//
// Copyright (C) 2012 Texas Instruments Inc.
// Copyright (C) 2015 Intel Corporation.
//
// Authors: Liam Girdwood <liam.r.girdwood@linux.intel.com>
//              K, Mythri P <mythri.p.k@intel.com>
//              Prusty, Subhransu S <subhransu.s.prusty@intel.com>
//              B, Jayachandran <jayachandran.b@intel.com>
//              Abdullah, Omair M <omair.m.abdullah@intel.com>
//              Jin, Yao <yao.jin@intel.com>
//              Lin, Mengdong <mengdong.lin@intel.com>
//
//  Add support to read audio firmware topology alongside firmware text. The
//  topology data can contain kcontrols, DAPM graphs, widgets, DAIs, DAI links,
//  equalizers, firmware, coefficients etc.
//
//  This file only manages the core ALSA and ASoC components, all other bespoke
//  firmware topology data is passed to component drivers for bespoke handling.

#include <linux/kernel.h>
#include <linux/export.h>
#include <linux/list.h>
#include <linux/firmware.h>
#include <linux/slab.h>
#include <sound/soc.h>
#include <sound/soc-dapm.h>
#include <sound/soc-topology.h>
#include <sound/tlv.h>

#define SOC_TPLG_MAGIC_BIG_ENDIAN            0x436F5341 /* ASoC in reverse */

/*
 * We make several passes over the data (since it wont necessarily be ordered)
 * and process objects in the following order. This guarantees the component
 * drivers will be ready with any vendor data before the mixers and DAPM objects
 * are loaded (that may make use of the vendor data).
 */
#define SOC_TPLG_PASS_MANIFEST          0
#define SOC_TPLG_PASS_VENDOR            1
#define SOC_TPLG_PASS_CONTROL           2
#define SOC_TPLG_PASS_WIDGET            3
#define SOC_TPLG_PASS_PCM_DAI           4
#define SOC_TPLG_PASS_GRAPH             5
#define SOC_TPLG_PASS_BE_DAI            6
#define SOC_TPLG_PASS_LINK              7

#define SOC_TPLG_PASS_START     SOC_TPLG_PASS_MANIFEST
#define SOC_TPLG_PASS_END       SOC_TPLG_PASS_LINK

/* topology context */
struct soc_tplg {
        const struct firmware *fw;

        /* runtime FW parsing */
        const u8 *pos;          /* read position */
        const u8 *hdr_pos;      /* header position */
        unsigned int pass;      /* pass number */

        /* component caller */
        struct device *dev;
        struct snd_soc_component *comp;
        u32 index;      /* current block index */

        /* vendor specific kcontrol operations */
        const struct snd_soc_tplg_kcontrol_ops *io_ops;
        int io_ops_count;

        /* vendor specific bytes ext handlers, for TLV bytes controls */
        const struct snd_soc_tplg_bytes_ext_ops *bytes_ext_ops;
        int bytes_ext_ops_count;

        /* optional fw loading callbacks to component drivers */
        const struct snd_soc_tplg_ops *ops;
};

/* check we dont overflow the data for this control chunk */
static int soc_tplg_check_elem_count(struct soc_tplg *tplg, size_t elem_size,
        unsigned int count, size_t bytes, const char *elem_type)
{
        const u8 *end = tplg->pos + elem_size * count;

        if (end > tplg->fw->data + tplg->fw->size) {
                dev_err(tplg->dev, "ASoC: %s overflow end of data\n",
                        elem_type);
                return -EINVAL;
        }

        /* check there is enough room in chunk for control.
           extra bytes at the end of control are for vendor data here  */
        if (elem_size * count > bytes) {
                dev_err(tplg->dev,
                        "ASoC: %s count %d of size %zu is bigger than chunk %zu\n",
                        elem_type, count, elem_size, bytes);
                return -EINVAL;
        }

        return 0;
}

static inline bool soc_tplg_is_eof(struct soc_tplg *tplg)
{
        const u8 *end = tplg->hdr_pos;

        if (end >= tplg->fw->data + tplg->fw->size)
                return true;
        return false;
}

static inline unsigned long soc_tplg_get_hdr_offset(struct soc_tplg *tplg)
{
        return (unsigned long)(tplg->hdr_pos - tplg->fw->data);
}

static inline unsigned long soc_tplg_get_offset(struct soc_tplg *tplg)
{
        return (unsigned long)(tplg->pos - tplg->fw->data);
}

/* mapping of Kcontrol types and associated operations. */
static const struct snd_soc_tplg_kcontrol_ops io_ops[] = {
        {SND_SOC_TPLG_CTL_VOLSW, snd_soc_get_volsw,
                snd_soc_put_volsw, snd_soc_info_volsw},
        {SND_SOC_TPLG_CTL_VOLSW_SX, snd_soc_get_volsw_sx,
                snd_soc_put_volsw_sx, NULL},
        {SND_SOC_TPLG_CTL_ENUM, snd_soc_get_enum_double,
                snd_soc_put_enum_double, snd_soc_info_enum_double},
        {SND_SOC_TPLG_CTL_ENUM_VALUE, snd_soc_get_enum_double,
                snd_soc_put_enum_double, NULL},
        {SND_SOC_TPLG_CTL_BYTES, snd_soc_bytes_get,
                snd_soc_bytes_put, snd_soc_bytes_info},
        {SND_SOC_TPLG_CTL_RANGE, snd_soc_get_volsw,
                snd_soc_put_volsw, snd_soc_info_volsw},
        {SND_SOC_TPLG_CTL_VOLSW_XR_SX, snd_soc_get_xr_sx,
                snd_soc_put_xr_sx, snd_soc_info_xr_sx},
        {SND_SOC_TPLG_CTL_STROBE, snd_soc_get_strobe,
                snd_soc_put_strobe, NULL},
        {SND_SOC_TPLG_DAPM_CTL_VOLSW, snd_soc_dapm_get_volsw,
                snd_soc_dapm_put_volsw, snd_soc_info_volsw},
        {SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE, snd_soc_dapm_get_enum_double,
                snd_soc_dapm_put_enum_double, snd_soc_info_enum_double},
        {SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT, snd_soc_dapm_get_enum_double,
                snd_soc_dapm_put_enum_double, NULL},
        {SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE, snd_soc_dapm_get_enum_double,
                snd_soc_dapm_put_enum_double, NULL},
        {SND_SOC_TPLG_DAPM_CTL_PIN, snd_soc_dapm_get_pin_switch,
                snd_soc_dapm_put_pin_switch, snd_soc_dapm_info_pin_switch},
};

struct soc_tplg_map {
        int uid;
        int kid;
};

/* mapping of widget types from UAPI IDs to kernel IDs */
static const struct soc_tplg_map dapm_map[] = {
        {SND_SOC_TPLG_DAPM_INPUT, snd_soc_dapm_input},
        {SND_SOC_TPLG_DAPM_OUTPUT, snd_soc_dapm_output},
        {SND_SOC_TPLG_DAPM_MUX, snd_soc_dapm_mux},
        {SND_SOC_TPLG_DAPM_MIXER, snd_soc_dapm_mixer},
        {SND_SOC_TPLG_DAPM_PGA, snd_soc_dapm_pga},
        {SND_SOC_TPLG_DAPM_OUT_DRV, snd_soc_dapm_out_drv},
        {SND_SOC_TPLG_DAPM_ADC, snd_soc_dapm_adc},
        {SND_SOC_TPLG_DAPM_DAC, snd_soc_dapm_dac},
        {SND_SOC_TPLG_DAPM_SWITCH, snd_soc_dapm_switch},
        {SND_SOC_TPLG_DAPM_PRE, snd_soc_dapm_pre},
        {SND_SOC_TPLG_DAPM_POST, snd_soc_dapm_post},
        {SND_SOC_TPLG_DAPM_AIF_IN, snd_soc_dapm_aif_in},
        {SND_SOC_TPLG_DAPM_AIF_OUT, snd_soc_dapm_aif_out},
        {SND_SOC_TPLG_DAPM_DAI_IN, snd_soc_dapm_dai_in},
        {SND_SOC_TPLG_DAPM_DAI_OUT, snd_soc_dapm_dai_out},
        {SND_SOC_TPLG_DAPM_DAI_LINK, snd_soc_dapm_dai_link},
        {SND_SOC_TPLG_DAPM_BUFFER, snd_soc_dapm_buffer},
        {SND_SOC_TPLG_DAPM_SCHEDULER, snd_soc_dapm_scheduler},
        {SND_SOC_TPLG_DAPM_EFFECT, snd_soc_dapm_effect},
        {SND_SOC_TPLG_DAPM_SIGGEN, snd_soc_dapm_siggen},
        {SND_SOC_TPLG_DAPM_SRC, snd_soc_dapm_src},
        {SND_SOC_TPLG_DAPM_ASRC, snd_soc_dapm_asrc},
        {SND_SOC_TPLG_DAPM_ENCODER, snd_soc_dapm_encoder},
        {SND_SOC_TPLG_DAPM_DECODER, snd_soc_dapm_decoder},
};

static int tplg_chan_get_reg(struct soc_tplg *tplg,
        struct snd_soc_tplg_channel *chan, int map)
{
        int i;

        for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
                if (le32_to_cpu(chan[i].id) == map)
                        return le32_to_cpu(chan[i].reg);
        }

        return -EINVAL;
}

static int tplg_chan_get_shift(struct soc_tplg *tplg,
        struct snd_soc_tplg_channel *chan, int map)
{
        int i;

        for (i = 0; i < SND_SOC_TPLG_MAX_CHAN; i++) {
                if (le32_to_cpu(chan[i].id) == map)
                        return le32_to_cpu(chan[i].shift);
        }

        return -EINVAL;
}

static int get_widget_id(int tplg_type)
{
        int i;

        for (i = 0; i < ARRAY_SIZE(dapm_map); i++) {
                if (tplg_type == dapm_map[i].uid)
                        return dapm_map[i].kid;
        }

        return -EINVAL;
}

static inline void soc_control_err(struct soc_tplg *tplg,
        struct snd_soc_tplg_ctl_hdr *hdr, const char *name)
{
        dev_err(tplg->dev,
                "ASoC: no complete control IO handler for %s type (g,p,i) %d:%d:%d at 0x%lx\n",
                name, hdr->ops.get, hdr->ops.put, hdr->ops.info,
                soc_tplg_get_offset(tplg));
}

/* pass vendor data to component driver for processing */
static int soc_tplg_vendor_load(struct soc_tplg *tplg,
                                struct snd_soc_tplg_hdr *hdr)
{
        int ret = 0;

        if (tplg->ops && tplg->ops->vendor_load)
                ret = tplg->ops->vendor_load(tplg->comp, tplg->index, hdr);
        else {
                dev_err(tplg->dev, "ASoC: no vendor load callback for ID %d\n",
                        hdr->vendor_type);
                return -EINVAL;
        }

        if (ret < 0)
                dev_err(tplg->dev,
                        "ASoC: vendor load failed at hdr offset %ld/0x%lx for type %d:%d\n",
                        soc_tplg_get_hdr_offset(tplg),
                        soc_tplg_get_hdr_offset(tplg),
                        hdr->type, hdr->vendor_type);
        return ret;
}

/* optionally pass new dynamic widget to component driver. This is mainly for
 * external widgets where we can assign private data/ops */
static int soc_tplg_widget_load(struct soc_tplg *tplg,
        struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
{
        if (tplg->ops && tplg->ops->widget_load)
                return tplg->ops->widget_load(tplg->comp, tplg->index, w,
                        tplg_w);

        return 0;
}

/* optionally pass new dynamic widget to component driver. This is mainly for
 * external widgets where we can assign private data/ops */
static int soc_tplg_widget_ready(struct soc_tplg *tplg,
        struct snd_soc_dapm_widget *w, struct snd_soc_tplg_dapm_widget *tplg_w)
{
        if (tplg->ops && tplg->ops->widget_ready)
                return tplg->ops->widget_ready(tplg->comp, tplg->index, w,
                        tplg_w);

        return 0;
}

/* pass DAI configurations to component driver for extra initialization */
static int soc_tplg_dai_load(struct soc_tplg *tplg,
        struct snd_soc_dai_driver *dai_drv,
        struct snd_soc_tplg_pcm *pcm, struct snd_soc_dai *dai)
{
        if (tplg->ops && tplg->ops->dai_load)
                return tplg->ops->dai_load(tplg->comp, tplg->index, dai_drv,
                        pcm, dai);

        return 0;
}

/* pass link configurations to component driver for extra initialization */
static int soc_tplg_dai_link_load(struct soc_tplg *tplg,
        struct snd_soc_dai_link *link, struct snd_soc_tplg_link_config *cfg)
{
        if (tplg->ops && tplg->ops->link_load)
                return tplg->ops->link_load(tplg->comp, tplg->index, link, cfg);

        return 0;
}

/* tell the component driver that all firmware has been loaded in this request */
static int soc_tplg_complete(struct soc_tplg *tplg)
{
        if (tplg->ops && tplg->ops->complete)
                return tplg->ops->complete(tplg->comp);

        return 0;
}

/* add a dynamic kcontrol */
static int soc_tplg_add_dcontrol(struct snd_card *card, struct device *dev,
        const struct snd_kcontrol_new *control_new, const char *prefix,
        void *data, struct snd_kcontrol **kcontrol)
{
        int err;

        *kcontrol = snd_soc_cnew(control_new, data, control_new->name, prefix);
        if (*kcontrol == NULL) {
                dev_err(dev, "ASoC: Failed to create new kcontrol %s\n",
                control_new->name);
                return -ENOMEM;
        }

        err = snd_ctl_add(card, *kcontrol);
        if (err < 0) {
                dev_err(dev, "ASoC: Failed to add %s: %d\n",
                        control_new->name, err);
                return err;
        }

        return 0;
}

/* add a dynamic kcontrol for component driver */
static int soc_tplg_add_kcontrol(struct soc_tplg *tplg,
        struct snd_kcontrol_new *k, struct snd_kcontrol **kcontrol)
{
        struct snd_soc_component *comp = tplg->comp;

        return soc_tplg_add_dcontrol(comp->card->snd_card,
                                tplg->dev, k, comp->name_prefix, comp, kcontrol);
}

/* remove kcontrol */
static void soc_tplg_remove_kcontrol(struct snd_soc_component *comp, struct snd_soc_dobj *dobj,
                                     int pass)
{
        struct snd_card *card = comp->card->snd_card;

        if (pass != SOC_TPLG_PASS_CONTROL)
                return;

        if (dobj->unload)
                dobj->unload(comp, dobj);

        snd_ctl_remove(card, dobj->control.kcontrol);
        list_del(&dobj->list);
}

/* remove a route */
static void soc_tplg_remove_route(struct snd_soc_component *comp,
                         struct snd_soc_dobj *dobj, int pass)
{
        if (pass != SOC_TPLG_PASS_GRAPH)
                return;

        if (dobj->unload)
                dobj->unload(comp, dobj);

        list_del(&dobj->list);
}

/* remove a widget and it's kcontrols - routes must be removed first */
static void soc_tplg_remove_widget(struct snd_soc_component *comp,
        struct snd_soc_dobj *dobj, int pass)
{
        struct snd_card *card = comp->card->snd_card;
        struct snd_soc_dapm_widget *w =
                container_of(dobj, struct snd_soc_dapm_widget, dobj);
        int i;

        if (pass != SOC_TPLG_PASS_WIDGET)
                return;

        if (dobj->unload)
                dobj->unload(comp, dobj);

        if (w->kcontrols)
                for (i = 0; i < w->num_kcontrols; i++)
                        snd_ctl_remove(card, w->kcontrols[i]);

        list_del(&dobj->list);

        /* widget w is freed by soc-dapm.c */
}

/* remove DAI configurations */
static void soc_tplg_remove_dai(struct snd_soc_component *comp,
        struct snd_soc_dobj *dobj, int pass)
{
        struct snd_soc_dai_driver *dai_drv =
                container_of(dobj, struct snd_soc_dai_driver, dobj);
        struct snd_soc_dai *dai, *_dai;

        if (pass != SOC_TPLG_PASS_PCM_DAI)
                return;

        if (dobj->unload)
                dobj->unload(comp, dobj);

        for_each_component_dais_safe(comp, dai, _dai)
                if (dai->driver == dai_drv)
                        snd_soc_unregister_dai(dai);

        list_del(&dobj->list);
}

/* remove link configurations */
static void soc_tplg_remove_link(struct snd_soc_component *comp,
        struct snd_soc_dobj *dobj, int pass)
{
        struct snd_soc_dai_link *link =
                container_of(dobj, struct snd_soc_dai_link, dobj);

        if (pass != SOC_TPLG_PASS_PCM_DAI)
                return;

        if (dobj->unload)
                dobj->unload(comp, dobj);

        list_del(&dobj->list);

        /* Ignored links do not need to be removed, they are not added */
        if (!link->ignore)
                snd_soc_remove_pcm_runtime(comp->card,
                                snd_soc_get_pcm_runtime(comp->card, link));
}

/* unload dai link */
static void remove_backend_link(struct snd_soc_component *comp,
        struct snd_soc_dobj *dobj, int pass)
{
        if (pass != SOC_TPLG_PASS_LINK)
                return;

        if (dobj->unload)
                dobj->unload(comp, dobj);

        /*
         * We don't free the link here as what soc_tplg_remove_link() do since BE
         * links are not allocated by topology.
         * We however need to reset the dobj type to its initial values
         */
        dobj->type = SND_SOC_DOBJ_NONE;
        list_del(&dobj->list);
}

/* bind a kcontrol to it's IO handlers */
static int soc_tplg_kcontrol_bind_io(struct snd_soc_tplg_ctl_hdr *hdr,
        struct snd_kcontrol_new *k,
        const struct soc_tplg *tplg)
{
        const struct snd_soc_tplg_kcontrol_ops *ops;
        const struct snd_soc_tplg_bytes_ext_ops *ext_ops;
        int num_ops, i;

        if (le32_to_cpu(hdr->ops.info) == SND_SOC_TPLG_CTL_BYTES
                && k->iface & SNDRV_CTL_ELEM_IFACE_MIXER
                && (k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ
                    || k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE)
                && k->access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK) {
                struct soc_bytes_ext *sbe;
                struct snd_soc_tplg_bytes_control *be;

                sbe = (struct soc_bytes_ext *)k->private_value;
                be = container_of(hdr, struct snd_soc_tplg_bytes_control, hdr);

                /* TLV bytes controls need standard kcontrol info handler,
                 * TLV callback and extended put/get handlers.
                 */
                k->info = snd_soc_bytes_info_ext;
                k->tlv.c = snd_soc_bytes_tlv_callback;

                /*
                 * When a topology-based implementation abuses the
                 * control interface and uses bytes_ext controls of
                 * more than 512 bytes, we need to disable the size
                 * checks, otherwise accesses to such controls will
                 * return an -EINVAL error and prevent the card from
                 * being configured.
                 */
                if (sbe->max > 512)
                        k->access |= SNDRV_CTL_ELEM_ACCESS_SKIP_CHECK;

                ext_ops = tplg->bytes_ext_ops;
                num_ops = tplg->bytes_ext_ops_count;
                for (i = 0; i < num_ops; i++) {
                        if (!sbe->put &&
                            ext_ops[i].id == le32_to_cpu(be->ext_ops.put))
                                sbe->put = ext_ops[i].put;
                        if (!sbe->get &&
                            ext_ops[i].id == le32_to_cpu(be->ext_ops.get))
                                sbe->get = ext_ops[i].get;
                }

                if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_READ) && !sbe->get)
                        return -EINVAL;
                if ((k->access & SNDRV_CTL_ELEM_ACCESS_TLV_WRITE) && !sbe->put)
                        return -EINVAL;
                return 0;
        }

        /* try and map vendor specific kcontrol handlers first */
        ops = tplg->io_ops;
        num_ops = tplg->io_ops_count;
        for (i = 0; i < num_ops; i++) {

                if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
                        k->put = ops[i].put;
                if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
                        k->get = ops[i].get;
                if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
                        k->info = ops[i].info;
        }

        /* vendor specific handlers found ? */
        if (k->put && k->get && k->info)
                return 0;

        /* none found so try standard kcontrol handlers */
        ops = io_ops;
        num_ops = ARRAY_SIZE(io_ops);
        for (i = 0; i < num_ops; i++) {

                if (k->put == NULL && ops[i].id == le32_to_cpu(hdr->ops.put))
                        k->put = ops[i].put;
                if (k->get == NULL && ops[i].id == le32_to_cpu(hdr->ops.get))
                        k->get = ops[i].get;
                if (k->info == NULL && ops[i].id == le32_to_cpu(hdr->ops.info))
                        k->info = ops[i].info;
        }

        /* standard handlers found ? */
        if (k->put && k->get && k->info)
                return 0;

        /* nothing to bind */
        return -EINVAL;
}

/* bind a widgets to it's evnt handlers */
int snd_soc_tplg_widget_bind_event(struct snd_soc_dapm_widget *w,
                const struct snd_soc_tplg_widget_events *events,
                int num_events, u16 event_type)
{
        int i;

        w->event = NULL;

        for (i = 0; i < num_events; i++) {
                if (event_type == events[i].type) {

                        /* found - so assign event */
                        w->event = events[i].event_handler;
                        return 0;
                }
        }

        /* not found */
        return -EINVAL;
}
EXPORT_SYMBOL_GPL(snd_soc_tplg_widget_bind_event);

/* optionally pass new dynamic kcontrol to component driver. */
static int soc_tplg_control_load(struct soc_tplg *tplg,
        struct snd_kcontrol_new *k, struct snd_soc_tplg_ctl_hdr *hdr)
{
        int ret = 0;

        if (tplg->ops && tplg->ops->control_load)
                ret = tplg->ops->control_load(tplg->comp, tplg->index, k, hdr);

        if (ret)
                dev_err(tplg->dev, "ASoC: failed to init %s\n", hdr->name);

        return ret;
}


static int soc_tplg_create_tlv_db_scale(struct soc_tplg *tplg,
        struct snd_kcontrol_new *kc, struct snd_soc_tplg_tlv_dbscale *scale)
{
        unsigned int item_len = 2 * sizeof(unsigned int);
        unsigned int *p;

        p = devm_kzalloc(tplg->dev, item_len + 2 * sizeof(unsigned int), GFP_KERNEL);
        if (!p)
                return -ENOMEM;

        p[0] = SNDRV_CTL_TLVT_DB_SCALE;
        p[1] = item_len;
        p[2] = le32_to_cpu(scale->min);
        p[3] = (le32_to_cpu(scale->step) & TLV_DB_SCALE_MASK)
                | (le32_to_cpu(scale->mute) ? TLV_DB_SCALE_MUTE : 0);

        kc->tlv.p = (void *)p;
        return 0;
}

static int soc_tplg_create_tlv(struct soc_tplg *tplg,
        struct snd_kcontrol_new *kc, struct snd_soc_tplg_ctl_hdr *tc)
{
        struct snd_soc_tplg_ctl_tlv *tplg_tlv;
        u32 access = le32_to_cpu(tc->access);

        if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_READWRITE))
                return 0;

        if (!(access & SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK)) {
                tplg_tlv = &tc->tlv;
                switch (le32_to_cpu(tplg_tlv->type)) {
                case SNDRV_CTL_TLVT_DB_SCALE:
                        return soc_tplg_create_tlv_db_scale(tplg, kc,
                                        &tplg_tlv->scale);

                /* TODO: add support for other TLV types */
                default:
                        dev_dbg(tplg->dev, "Unsupported TLV type %d\n",
                                        tplg_tlv->type);
                        return -EINVAL;
                }
        }

        return 0;
}

static int soc_tplg_control_dmixer_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
{
        struct snd_soc_tplg_mixer_control *mc;
        struct soc_mixer_control *sm;
        int err;

        mc = (struct snd_soc_tplg_mixer_control *)tplg->pos;

        /* validate kcontrol */
        if (strnlen(mc->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;

        sm = devm_kzalloc(tplg->dev, sizeof(*sm), GFP_KERNEL);
        if (!sm)
                return -ENOMEM;

        tplg->pos += sizeof(struct snd_soc_tplg_mixer_control) + le32_to_cpu(mc->priv.size);

        dev_dbg(tplg->dev, "ASoC: adding mixer kcontrol %s with access 0x%x\n",
                mc->hdr.name, mc->hdr.access);

        kc->name = devm_kstrdup(tplg->dev, mc->hdr.name, GFP_KERNEL);
        if (!kc->name)
                return -ENOMEM;
        kc->private_value = (long)sm;
        kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        kc->access = le32_to_cpu(mc->hdr.access);

        /* we only support FL/FR channel mapping atm */
        sm->reg = tplg_chan_get_reg(tplg, mc->channel, SNDRV_CHMAP_FL);
        sm->rreg = tplg_chan_get_reg(tplg, mc->channel, SNDRV_CHMAP_FR);
        sm->shift = tplg_chan_get_shift(tplg, mc->channel, SNDRV_CHMAP_FL);
        sm->rshift = tplg_chan_get_shift(tplg, mc->channel, SNDRV_CHMAP_FR);

        sm->max = le32_to_cpu(mc->max);
        sm->min = le32_to_cpu(mc->min);
        sm->invert = le32_to_cpu(mc->invert);
        sm->platform_max = le32_to_cpu(mc->platform_max);
        sm->num_channels = le32_to_cpu(mc->num_channels);

        /* map io handlers */
        err = soc_tplg_kcontrol_bind_io(&mc->hdr, kc, tplg);
        if (err) {
                soc_control_err(tplg, &mc->hdr, mc->hdr.name);
                return err;
        }

        /* create any TLV data */
        err = soc_tplg_create_tlv(tplg, kc, &mc->hdr);
        if (err < 0) {
                dev_err(tplg->dev, "ASoC: failed to create TLV %s\n", mc->hdr.name);
                return err;
        }

        /* pass control to driver for optional further init */
        return soc_tplg_control_load(tplg, kc, &mc->hdr);
}

static int soc_tplg_denum_create_texts(struct soc_tplg *tplg, struct soc_enum *se,
                                       struct snd_soc_tplg_enum_control *ec)
{
        int i, ret;

        if (le32_to_cpu(ec->items) > ARRAY_SIZE(ec->texts))
                return -EINVAL;

        se->dobj.control.dtexts =
                devm_kcalloc(tplg->dev, le32_to_cpu(ec->items), sizeof(char *), GFP_KERNEL);
        if (se->dobj.control.dtexts == NULL)
                return -ENOMEM;

        for (i = 0; i < le32_to_cpu(ec->items); i++) {

                if (strnlen(ec->texts[i], SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
                        SNDRV_CTL_ELEM_ID_NAME_MAXLEN) {
                        ret = -EINVAL;
                        goto err;
                }

                se->dobj.control.dtexts[i] = devm_kstrdup(tplg->dev, ec->texts[i], GFP_KERNEL);
                if (!se->dobj.control.dtexts[i]) {
                        ret = -ENOMEM;
                        goto err;
                }
        }

        se->items = le32_to_cpu(ec->items);
        se->texts = (const char * const *)se->dobj.control.dtexts;
        return 0;

err:
        return ret;
}

static int soc_tplg_denum_create_values(struct soc_tplg *tplg, struct soc_enum *se,
                                        struct snd_soc_tplg_enum_control *ec)
{
        int i;

        /*
         * Following "if" checks if we have at most SND_SOC_TPLG_NUM_TEXTS
         * values instead of using ARRAY_SIZE(ec->values) due to the fact that
         * it is oversized for its purpose. Additionally it is done so because
         * it is defined in UAPI header where it can't be easily changed.
         */
        if (le32_to_cpu(ec->items) > SND_SOC_TPLG_NUM_TEXTS)
                return -EINVAL;

        se->dobj.control.dvalues = devm_kcalloc(tplg->dev, le32_to_cpu(ec->items),
                                           sizeof(*se->dobj.control.dvalues),
                                           GFP_KERNEL);
        if (!se->dobj.control.dvalues)
                return -ENOMEM;

        /* convert from little-endian */
        for (i = 0; i < le32_to_cpu(ec->items); i++) {
                se->dobj.control.dvalues[i] = le32_to_cpu(ec->values[i]);
        }

        se->items = le32_to_cpu(ec->items);
        se->values = (const unsigned int *)se->dobj.control.dvalues;
        return 0;
}

static int soc_tplg_control_denum_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
{
        struct snd_soc_tplg_enum_control *ec;
        struct soc_enum *se;
        int err;

        ec = (struct snd_soc_tplg_enum_control *)tplg->pos;

        /* validate kcontrol */
        if (strnlen(ec->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;

        se = devm_kzalloc(tplg->dev, sizeof(*se), GFP_KERNEL);
        if (!se)
                return -ENOMEM;

        tplg->pos += (sizeof(struct snd_soc_tplg_enum_control) + le32_to_cpu(ec->priv.size));

        dev_dbg(tplg->dev, "ASoC: adding enum kcontrol %s size %d\n", ec->hdr.name, ec->items);

        kc->name = devm_kstrdup(tplg->dev, ec->hdr.name, GFP_KERNEL);
        if (!kc->name)
                return -ENOMEM;
        kc->private_value = (long)se;
        kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        kc->access = le32_to_cpu(ec->hdr.access);

        /* we only support FL/FR channel mapping atm */
        se->reg = tplg_chan_get_reg(tplg, ec->channel, SNDRV_CHMAP_FL);
        se->shift_l = tplg_chan_get_shift(tplg, ec->channel, SNDRV_CHMAP_FL);
        se->shift_r = tplg_chan_get_shift(tplg, ec->channel, SNDRV_CHMAP_FR);

        se->mask = le32_to_cpu(ec->mask);

        switch (le32_to_cpu(ec->hdr.ops.info)) {
        case SND_SOC_TPLG_CTL_ENUM_VALUE:
        case SND_SOC_TPLG_DAPM_CTL_ENUM_VALUE:
                err = soc_tplg_denum_create_values(tplg, se, ec);
                if (err < 0) {
                        dev_err(tplg->dev, "ASoC: could not create values for %s\n", ec->hdr.name);
                        return err;
                }
                fallthrough;
        case SND_SOC_TPLG_CTL_ENUM:
        case SND_SOC_TPLG_DAPM_CTL_ENUM_DOUBLE:
        case SND_SOC_TPLG_DAPM_CTL_ENUM_VIRT:
                err = soc_tplg_denum_create_texts(tplg, se, ec);
                if (err < 0) {
                        dev_err(tplg->dev, "ASoC: could not create texts for %s\n", ec->hdr.name);
                        return err;
                }
                break;
        default:
                dev_err(tplg->dev, "ASoC: invalid enum control type %d for %s\n",
                        ec->hdr.ops.info, ec->hdr.name);
                return -EINVAL;
        }

        /* map io handlers */
        err = soc_tplg_kcontrol_bind_io(&ec->hdr, kc, tplg);
        if (err) {
                soc_control_err(tplg, &ec->hdr, ec->hdr.name);
                return err;
        }

        /* pass control to driver for optional further init */
        return soc_tplg_control_load(tplg, kc, &ec->hdr);
}

static int soc_tplg_control_dbytes_create(struct soc_tplg *tplg, struct snd_kcontrol_new *kc)
{
        struct snd_soc_tplg_bytes_control *be;
        struct soc_bytes_ext *sbe;
        int err;

        be = (struct snd_soc_tplg_bytes_control *)tplg->pos;

        /* validate kcontrol */
        if (strnlen(be->hdr.name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;

        sbe = devm_kzalloc(tplg->dev, sizeof(*sbe), GFP_KERNEL);
        if (!sbe)
                return -ENOMEM;

        tplg->pos += (sizeof(struct snd_soc_tplg_bytes_control) + le32_to_cpu(be->priv.size));

        dev_dbg(tplg->dev, "ASoC: adding bytes kcontrol %s with access 0x%x\n",
                be->hdr.name, be->hdr.access);

        kc->name = devm_kstrdup(tplg->dev, be->hdr.name, GFP_KERNEL);
        if (!kc->name)
                return -ENOMEM;
        kc->private_value = (long)sbe;
        kc->iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        kc->access = le32_to_cpu(be->hdr.access);

        sbe->max = le32_to_cpu(be->max);

        /* map standard io handlers and check for external handlers */
        err = soc_tplg_kcontrol_bind_io(&be->hdr, kc, tplg);
        if (err) {
                soc_control_err(tplg, &be->hdr, be->hdr.name);
                return err;
        }

        /* pass control to driver for optional further init */
        return soc_tplg_control_load(tplg, kc, &be->hdr);
}

static int soc_tplg_dbytes_create(struct soc_tplg *tplg, size_t size)
{
        struct snd_kcontrol_new kc = {0};
        struct soc_bytes_ext *sbe;
        int ret;

        if (soc_tplg_check_elem_count(tplg,
                                      sizeof(struct snd_soc_tplg_bytes_control),
                                      1, size, "mixer bytes"))
                return -EINVAL;

        ret = soc_tplg_control_dbytes_create(tplg, &kc);
        if (ret)
                return ret;

        /* register dynamic object */
        sbe = (struct soc_bytes_ext *)kc.private_value;

        INIT_LIST_HEAD(&sbe->dobj.list);
        sbe->dobj.type = SND_SOC_DOBJ_BYTES;
        sbe->dobj.index = tplg->index;
        if (tplg->ops)
                sbe->dobj.unload = tplg->ops->control_unload;

        /* create control directly */
        ret = soc_tplg_add_kcontrol(tplg, &kc, &sbe->dobj.control.kcontrol);
        if (ret < 0)
                return ret;

        list_add(&sbe->dobj.list, &tplg->comp->dobj_list);

        return ret;
}

static int soc_tplg_dmixer_create(struct soc_tplg *tplg, size_t size)
{
        struct snd_kcontrol_new kc = {0};
        struct soc_mixer_control *sm;
        int ret;

        if (soc_tplg_check_elem_count(tplg,
                                      sizeof(struct snd_soc_tplg_mixer_control),
                                      1, size, "mixers"))
                return -EINVAL;

        ret = soc_tplg_control_dmixer_create(tplg, &kc);
        if (ret)
                return ret;

        /* register dynamic object */
        sm = (struct soc_mixer_control *)kc.private_value;

        INIT_LIST_HEAD(&sm->dobj.list);
        sm->dobj.type = SND_SOC_DOBJ_MIXER;
        sm->dobj.index = tplg->index;
        if (tplg->ops)
                sm->dobj.unload = tplg->ops->control_unload;

        /* create control directly */
        ret = soc_tplg_add_kcontrol(tplg, &kc, &sm->dobj.control.kcontrol);
        if (ret < 0)
                return ret;

        list_add(&sm->dobj.list, &tplg->comp->dobj_list);

        return ret;
}

static int soc_tplg_denum_create(struct soc_tplg *tplg, size_t size)
{
        struct snd_kcontrol_new kc = {0};
        struct soc_enum *se;
        int ret;

        if (soc_tplg_check_elem_count(tplg,
                                      sizeof(struct snd_soc_tplg_enum_control),
                                      1, size, "enums"))
                return -EINVAL;

        ret = soc_tplg_control_denum_create(tplg, &kc);
        if (ret)
                return ret;

        /* register dynamic object */
        se = (struct soc_enum *)kc.private_value;

        INIT_LIST_HEAD(&se->dobj.list);
        se->dobj.type = SND_SOC_DOBJ_ENUM;
        se->dobj.index = tplg->index;
        if (tplg->ops)
                se->dobj.unload = tplg->ops->control_unload;

        /* create control directly */
        ret = soc_tplg_add_kcontrol(tplg, &kc, &se->dobj.control.kcontrol);
        if (ret < 0)
                return ret;

        list_add(&se->dobj.list, &tplg->comp->dobj_list);

        return ret;
}

static int soc_tplg_kcontrol_elems_load(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        int ret;
        int i;

        dev_dbg(tplg->dev, "ASoC: adding %d kcontrols at 0x%lx\n", hdr->count,
                soc_tplg_get_offset(tplg));

        for (i = 0; i < le32_to_cpu(hdr->count); i++) {
                struct snd_soc_tplg_ctl_hdr *control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;

                if (le32_to_cpu(control_hdr->size) != sizeof(*control_hdr)) {
                        dev_err(tplg->dev, "ASoC: invalid control size\n");
                        return -EINVAL;
                }

                switch (le32_to_cpu(control_hdr->type)) {
                case SND_SOC_TPLG_TYPE_MIXER:
                        ret = soc_tplg_dmixer_create(tplg, le32_to_cpu(hdr->payload_size));
                        break;
                case SND_SOC_TPLG_TYPE_ENUM:
                        ret = soc_tplg_denum_create(tplg, le32_to_cpu(hdr->payload_size));
                        break;
                case SND_SOC_TPLG_TYPE_BYTES:
                        ret = soc_tplg_dbytes_create(tplg, le32_to_cpu(hdr->payload_size));
                        break;
                default:

                        ret = -EINVAL;
                        break;
                }

                if (ret < 0) {
                        dev_err(tplg->dev, "ASoC: invalid control type: %d, index: %d at 0x%lx\n",
                                control_hdr->type, i, soc_tplg_get_offset(tplg));
                        return ret;
                }
        }

        return 0;
}

/* optionally pass new dynamic kcontrol to component driver. */
static int soc_tplg_add_route(struct soc_tplg *tplg,
        struct snd_soc_dapm_route *route)
{
        if (tplg->ops && tplg->ops->dapm_route_load)
                return tplg->ops->dapm_route_load(tplg->comp, tplg->index,
                        route);

        return 0;
}

static int soc_tplg_dapm_graph_elems_load(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
        const size_t maxlen = SNDRV_CTL_ELEM_ID_NAME_MAXLEN;
        struct snd_soc_tplg_dapm_graph_elem *elem;
        struct snd_soc_dapm_route *route;
        int count, i;
        int ret = 0;

        count = le32_to_cpu(hdr->count);

        if (soc_tplg_check_elem_count(tplg,
                                      sizeof(struct snd_soc_tplg_dapm_graph_elem),
                                      count, le32_to_cpu(hdr->payload_size), "graph"))
                return -EINVAL;

        dev_dbg(tplg->dev, "ASoC: adding %d DAPM routes for index %d\n", count,
                hdr->index);

        for (i = 0; i < count; i++) {
                route = devm_kzalloc(tplg->dev, sizeof(*route), GFP_KERNEL);
                if (!route)
                        return -ENOMEM;
                elem = (struct snd_soc_tplg_dapm_graph_elem *)tplg->pos;
                tplg->pos += sizeof(struct snd_soc_tplg_dapm_graph_elem);

                /* validate routes */
                if ((strnlen(elem->source, maxlen) == maxlen) ||
                    (strnlen(elem->sink, maxlen) == maxlen) ||
                    (strnlen(elem->control, maxlen) == maxlen)) {
                        ret = -EINVAL;
                        break;
                }

                route->source = devm_kstrdup(tplg->dev, elem->source, GFP_KERNEL);
                route->sink = devm_kstrdup(tplg->dev, elem->sink, GFP_KERNEL);
                if (!route->source || !route->sink) {
                        ret = -ENOMEM;
                        break;
                }

                if (strnlen(elem->control, maxlen) != 0) {
                        route->control = devm_kstrdup(tplg->dev, elem->control, GFP_KERNEL);
                        if (!route->control) {
                                ret = -ENOMEM;
                                break;
                        }
                }

                /* add route dobj to dobj_list */
                route->dobj.type = SND_SOC_DOBJ_GRAPH;
                if (tplg->ops)
                        route->dobj.unload = tplg->ops->dapm_route_unload;
                route->dobj.index = tplg->index;
                list_add(&route->dobj.list, &tplg->comp->dobj_list);

                ret = soc_tplg_add_route(tplg, route);
                if (ret < 0) {
                        dev_err(tplg->dev, "ASoC: topology: add_route failed: %d\n", ret);
                        break;
                }

                ret = snd_soc_dapm_add_routes(dapm, route, 1);
                if (ret)
                        break;
        }

        return ret;
}

static int soc_tplg_dapm_widget_create(struct soc_tplg *tplg,
        struct snd_soc_tplg_dapm_widget *w)
{
        struct snd_soc_dapm_context *dapm = &tplg->comp->dapm;
        struct snd_soc_dapm_widget template, *widget;
        struct snd_soc_tplg_ctl_hdr *control_hdr;
        struct snd_soc_card *card = tplg->comp->card;
        unsigned int *kcontrol_type = NULL;
        struct snd_kcontrol_new *kc;
        int mixer_count = 0;
        int bytes_count = 0;
        int enum_count = 0;
        int ret = 0;
        int i;

        if (strnlen(w->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
                SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;
        if (strnlen(w->sname, SNDRV_CTL_ELEM_ID_NAME_MAXLEN) ==
                SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;

        dev_dbg(tplg->dev, "ASoC: creating DAPM widget %s id %d\n",
                w->name, w->id);

        memset(&template, 0, sizeof(template));

        /* map user to kernel widget ID */
        template.id = get_widget_id(le32_to_cpu(w->id));
        if ((int)template.id < 0)
                return template.id;

        /* strings are allocated here, but used and freed by the widget */
        template.name = kstrdup(w->name, GFP_KERNEL);
        if (!template.name)
                return -ENOMEM;
        template.sname = kstrdup(w->sname, GFP_KERNEL);
        if (!template.sname) {
                ret = -ENOMEM;
                goto err;
        }
        template.reg = le32_to_cpu(w->reg);
        template.shift = le32_to_cpu(w->shift);
        template.mask = le32_to_cpu(w->mask);
        template.subseq = le32_to_cpu(w->subseq);
        template.on_val = w->invert ? 0 : 1;
        template.off_val = w->invert ? 1 : 0;
        template.ignore_suspend = le32_to_cpu(w->ignore_suspend);
        template.event_flags = le16_to_cpu(w->event_flags);
        template.dobj.index = tplg->index;

        tplg->pos +=
                (sizeof(struct snd_soc_tplg_dapm_widget) +
                 le32_to_cpu(w->priv.size));

        if (w->num_kcontrols == 0) {
                template.num_kcontrols = 0;
                goto widget;
        }

        template.num_kcontrols = le32_to_cpu(w->num_kcontrols);
        kc = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(*kc), GFP_KERNEL);
        if (!kc) {
                ret = -ENOMEM;
                goto hdr_err;
        }

        kcontrol_type = devm_kcalloc(tplg->dev, le32_to_cpu(w->num_kcontrols), sizeof(unsigned int),
                                     GFP_KERNEL);
        if (!kcontrol_type) {
                ret = -ENOMEM;
                goto hdr_err;
        }

        for (i = 0; i < le32_to_cpu(w->num_kcontrols); i++) {
                control_hdr = (struct snd_soc_tplg_ctl_hdr *)tplg->pos;

                switch (le32_to_cpu(control_hdr->type)) {
                case SND_SOC_TPLG_TYPE_MIXER:
                        /* volume mixer */
                        kc[i].index = mixer_count;
                        kcontrol_type[i] = SND_SOC_TPLG_TYPE_MIXER;
                        mixer_count++;
                        ret = soc_tplg_control_dmixer_create(tplg, &kc[i]);
                        if (ret < 0)
                                goto hdr_err;
                        break;
                case SND_SOC_TPLG_TYPE_ENUM:
                        /* enumerated mixer */
                        kc[i].index = enum_count;
                        kcontrol_type[i] = SND_SOC_TPLG_TYPE_ENUM;
                        enum_count++;
                        ret = soc_tplg_control_denum_create(tplg, &kc[i]);
                        if (ret < 0)
                                goto hdr_err;
                        break;
                case SND_SOC_TPLG_TYPE_BYTES:
                        /* bytes control */
                        kc[i].index = bytes_count;
                        kcontrol_type[i] = SND_SOC_TPLG_TYPE_BYTES;
                        bytes_count++;
                        ret = soc_tplg_control_dbytes_create(tplg, &kc[i]);
                        if (ret < 0)
                                goto hdr_err;
                        break;
                default:
                        dev_err(tplg->dev, "ASoC: invalid widget control type %d:%d:%d\n",
                                control_hdr->ops.get, control_hdr->ops.put,
                                le32_to_cpu(control_hdr->ops.info));
                        ret = -EINVAL;
                        goto hdr_err;
                }
        }

        template.kcontrol_news = kc;
        dev_dbg(tplg->dev, "ASoC: template %s with %d/%d/%d (mixer/enum/bytes) control\n",
                w->name, mixer_count, enum_count, bytes_count);

widget:
        ret = soc_tplg_widget_load(tplg, &template, w);
        if (ret < 0)
                goto hdr_err;

        /* card dapm mutex is held by the core if we are loading topology
         * data during sound card init. */
        if (snd_soc_card_is_instantiated(card))
                widget = snd_soc_dapm_new_control(dapm, &template);
        else
                widget = snd_soc_dapm_new_control_unlocked(dapm, &template);
        if (IS_ERR(widget)) {
                ret = PTR_ERR(widget);
                goto hdr_err;
        }

        widget->dobj.type = SND_SOC_DOBJ_WIDGET;
        widget->dobj.widget.kcontrol_type = kcontrol_type;
        if (tplg->ops)
                widget->dobj.unload = tplg->ops->widget_unload;
        widget->dobj.index = tplg->index;
        list_add(&widget->dobj.list, &tplg->comp->dobj_list);

        ret = soc_tplg_widget_ready(tplg, widget, w);
        if (ret < 0)
                goto ready_err;

        kfree(template.sname);
        kfree(template.name);

        return 0;

ready_err:
        soc_tplg_remove_widget(widget->dapm->component, &widget->dobj, SOC_TPLG_PASS_WIDGET);
        snd_soc_dapm_free_widget(widget);
hdr_err:
        kfree(template.sname);
err:
        kfree(template.name);
        return ret;
}

static int soc_tplg_dapm_widget_elems_load(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        int count, i;

        count = le32_to_cpu(hdr->count);

        dev_dbg(tplg->dev, "ASoC: adding %d DAPM widgets\n", count);

        for (i = 0; i < count; i++) {
                struct snd_soc_tplg_dapm_widget *widget = (struct snd_soc_tplg_dapm_widget *) tplg->pos;
                int ret;

                /*
                 * check if widget itself fits within topology file
                 * use sizeof instead of widget->size, as we can't be sure
                 * it is set properly yet (file may end before it is present)
                 */
                if (soc_tplg_get_offset(tplg) + sizeof(*widget) >= tplg->fw->size) {
                        dev_err(tplg->dev, "ASoC: invalid widget data size\n");
                        return -EINVAL;
                }

                /* check if widget has proper size */
                if (le32_to_cpu(widget->size) != sizeof(*widget)) {
                        dev_err(tplg->dev, "ASoC: invalid widget size\n");
                        return -EINVAL;
                }

                /* check if widget private data fits within topology file */
                if (soc_tplg_get_offset(tplg) + le32_to_cpu(widget->priv.size) >= tplg->fw->size) {
                        dev_err(tplg->dev, "ASoC: invalid widget private data size\n");
                        return -EINVAL;
                }

                ret = soc_tplg_dapm_widget_create(tplg, widget);
                if (ret < 0) {
                        dev_err(tplg->dev, "ASoC: failed to load widget %s\n",
                                widget->name);
                        return ret;
                }
        }

        return 0;
}

static int soc_tplg_dapm_complete(struct soc_tplg *tplg)
{
        struct snd_soc_card *card = tplg->comp->card;
        int ret;

        /* Card might not have been registered at this point.
         * If so, just return success.
        */
        if (!snd_soc_card_is_instantiated(card)) {
                dev_warn(tplg->dev, "ASoC: Parent card not yet available, widget card binding deferred\n");
                return 0;
        }

        ret = snd_soc_dapm_new_widgets(card);
        if (ret < 0)
                dev_err(tplg->dev, "ASoC: failed to create new widgets %d\n", ret);

        return ret;
}

static int set_stream_info(struct soc_tplg *tplg, struct snd_soc_pcm_stream *stream,
                           struct snd_soc_tplg_stream_caps *caps)
{
        stream->stream_name = devm_kstrdup(tplg->dev, caps->name, GFP_KERNEL);
        if (!stream->stream_name)
                return -ENOMEM;

        stream->channels_min = le32_to_cpu(caps->channels_min);
        stream->channels_max = le32_to_cpu(caps->channels_max);
        stream->rates = le32_to_cpu(caps->rates);
        stream->rate_min = le32_to_cpu(caps->rate_min);
        stream->rate_max = le32_to_cpu(caps->rate_max);
        stream->formats = le64_to_cpu(caps->formats);
        stream->sig_bits = le32_to_cpu(caps->sig_bits);

        return 0;
}

static void set_dai_flags(struct snd_soc_dai_driver *dai_drv,
                          unsigned int flag_mask, unsigned int flags)
{
        if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES)
                dai_drv->symmetric_rate =
                        (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;

        if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS)
                dai_drv->symmetric_channels =
                        (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_CHANNELS) ?
                        1 : 0;

        if (flag_mask & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS)
                dai_drv->symmetric_sample_bits =
                        (flags & SND_SOC_TPLG_DAI_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
                        1 : 0;
}

static const struct snd_soc_dai_ops tplg_dai_ops = {
        .compress_new   = snd_soc_new_compress,
};

static int soc_tplg_dai_create(struct soc_tplg *tplg,
        struct snd_soc_tplg_pcm *pcm)
{
        struct snd_soc_dai_driver *dai_drv;
        struct snd_soc_pcm_stream *stream;
        struct snd_soc_tplg_stream_caps *caps;
        struct snd_soc_dai *dai;
        struct snd_soc_dapm_context *dapm =
                snd_soc_component_get_dapm(tplg->comp);
        int ret;

        dai_drv = devm_kzalloc(tplg->dev, sizeof(struct snd_soc_dai_driver), GFP_KERNEL);
        if (dai_drv == NULL)
                return -ENOMEM;

        if (strlen(pcm->dai_name)) {
                dai_drv->name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
                if (!dai_drv->name) {
                        ret = -ENOMEM;
                        goto err;
                }
        }
        dai_drv->id = le32_to_cpu(pcm->dai_id);

        if (pcm->playback) {
                stream = &dai_drv->playback;
                caps = &pcm->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
                ret = set_stream_info(tplg, stream, caps);
                if (ret < 0)
                        goto err;
        }

        if (pcm->capture) {
                stream = &dai_drv->capture;
                caps = &pcm->caps[SND_SOC_TPLG_STREAM_CAPTURE];
                ret = set_stream_info(tplg, stream, caps);
                if (ret < 0)
                        goto err;
        }

        if (pcm->compress)
                dai_drv->ops = &tplg_dai_ops;

        /* pass control to component driver for optional further init */
        ret = soc_tplg_dai_load(tplg, dai_drv, pcm, NULL);
        if (ret < 0) {
                dev_err(tplg->dev, "ASoC: DAI loading failed\n");
                goto err;
        }

        dai_drv->dobj.index = tplg->index;
        dai_drv->dobj.type = SND_SOC_DOBJ_PCM;
        if (tplg->ops)
                dai_drv->dobj.unload = tplg->ops->dai_unload;
        list_add(&dai_drv->dobj.list, &tplg->comp->dobj_list);

        /* register the DAI to the component */
        dai = snd_soc_register_dai(tplg->comp, dai_drv, false);
        if (!dai)
                return -ENOMEM;

        /* Create the DAI widgets here */
        ret = snd_soc_dapm_new_dai_widgets(dapm, dai);
        if (ret != 0) {
                dev_err(dai->dev, "Failed to create DAI widgets %d\n", ret);
                snd_soc_unregister_dai(dai);
                return ret;
        }

        return 0;

err:
        return ret;
}

static void set_link_flags(struct snd_soc_dai_link *link,
                unsigned int flag_mask, unsigned int flags)
{
        if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES)
                link->symmetric_rate =
                        (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_RATES) ? 1 : 0;

        if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS)
                link->symmetric_channels =
                        (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_CHANNELS) ?
                        1 : 0;

        if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS)
                link->symmetric_sample_bits =
                        (flags & SND_SOC_TPLG_LNK_FLGBIT_SYMMETRIC_SAMPLEBITS) ?
                        1 : 0;

        if (flag_mask & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP)
                link->ignore_suspend =
                        (flags & SND_SOC_TPLG_LNK_FLGBIT_VOICE_WAKEUP) ?
                        1 : 0;
}

/* create the FE DAI link */
static int soc_tplg_fe_link_create(struct soc_tplg *tplg,
        struct snd_soc_tplg_pcm *pcm)
{
        struct snd_soc_dai_link *link;
        struct snd_soc_dai_link_component *dlc;
        int ret;

        /* link + cpu + codec + platform */
        link = devm_kzalloc(tplg->dev, sizeof(*link) + (3 * sizeof(*dlc)), GFP_KERNEL);
        if (link == NULL)
                return -ENOMEM;

        dlc = (struct snd_soc_dai_link_component *)(link + 1);

        link->cpus      = &dlc[0];
        link->num_cpus   = 1;

        link->dobj.index = tplg->index;
        link->dobj.type = SND_SOC_DOBJ_DAI_LINK;
        if (tplg->ops)
                link->dobj.unload = tplg->ops->link_unload;

        if (strlen(pcm->pcm_name)) {
                link->name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
                link->stream_name = devm_kstrdup(tplg->dev, pcm->pcm_name, GFP_KERNEL);
                if (!link->name || !link->stream_name) {
                        ret = -ENOMEM;
                        goto err;
                }
        }
        link->id = le32_to_cpu(pcm->pcm_id);

        if (strlen(pcm->dai_name)) {
                link->cpus->dai_name = devm_kstrdup(tplg->dev, pcm->dai_name, GFP_KERNEL);
                if (!link->cpus->dai_name) {
                        ret = -ENOMEM;
                        goto err;
                }
        }

        /*
         * Many topology are assuming link has Codec / Platform, and
         * these might be overwritten at soc_tplg_dai_link_load().
         * Don't use &snd_soc_dummy_dlc here.
         */
        link->codecs            = &dlc[1];      /* Don't use &snd_soc_dummy_dlc here */
        link->codecs->name      = "snd-soc-dummy";
        link->codecs->dai_name  = "snd-soc-dummy-dai";
        link->num_codecs        = 1;

        link->platforms         = &dlc[2];      /* Don't use &snd_soc_dummy_dlc here */
        link->platforms->name   = "snd-soc-dummy";
        link->num_platforms     = 1;

        /* enable DPCM */
        link->dynamic = 1;
        link->ignore_pmdown_time = 1;
        link->playback_only =  le32_to_cpu(pcm->playback) && !le32_to_cpu(pcm->capture);
        link->capture_only  = !le32_to_cpu(pcm->playback) &&  le32_to_cpu(pcm->capture);
        if (pcm->flag_mask)
                set_link_flags(link,
                               le32_to_cpu(pcm->flag_mask),
                               le32_to_cpu(pcm->flags));

        /* pass control to component driver for optional further init */
        ret = soc_tplg_dai_link_load(tplg, link, NULL);
        if (ret < 0) {
                dev_err(tplg->dev, "ASoC: FE link loading failed\n");
                goto err;
        }

        ret = snd_soc_add_pcm_runtimes(tplg->comp->card, link, 1);
        if (ret < 0) {
                if (ret != -EPROBE_DEFER)
                        dev_err(tplg->dev, "ASoC: adding FE link failed\n");
                goto err;
        }

        list_add(&link->dobj.list, &tplg->comp->dobj_list);

        return 0;
err:
        return ret;
}

/* create a FE DAI and DAI link from the PCM object */
static int soc_tplg_pcm_create(struct soc_tplg *tplg,
        struct snd_soc_tplg_pcm *pcm)
{
        int ret;

        ret = soc_tplg_dai_create(tplg, pcm);
        if (ret < 0)
                return ret;

        return  soc_tplg_fe_link_create(tplg, pcm);
}

static int soc_tplg_pcm_elems_load(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        struct snd_soc_tplg_pcm *pcm;
        int count;
        int size;
        int i;
        int ret;

        count = le32_to_cpu(hdr->count);

        /* check the element size and count */
        pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
        size = le32_to_cpu(pcm->size);
        if (size > sizeof(struct snd_soc_tplg_pcm)) {
                dev_err(tplg->dev, "ASoC: invalid size %d for PCM elems\n",
                        size);
                return -EINVAL;
        }

        if (soc_tplg_check_elem_count(tplg,
                                      size, count,
                                      le32_to_cpu(hdr->payload_size),
                                      "PCM DAI"))
                return -EINVAL;

        for (i = 0; i < count; i++) {
                pcm = (struct snd_soc_tplg_pcm *)tplg->pos;
                size = le32_to_cpu(pcm->size);

                /* check ABI version by size, create a new version of pcm
                 * if abi not match.
                 */
                if (size != sizeof(*pcm))
                        return -EINVAL;

                /* create the FE DAIs and DAI links */
                ret = soc_tplg_pcm_create(tplg, pcm);
                if (ret < 0)
                        return ret;

                /* offset by version-specific struct size and
                 * real priv data size
                 */
                tplg->pos += size + le32_to_cpu(pcm->priv.size);
        }

        dev_dbg(tplg->dev, "ASoC: adding %d PCM DAIs\n", count);

        return 0;
}

/**
 * set_link_hw_format - Set the HW audio format of the physical DAI link.
 * @link: &snd_soc_dai_link which should be updated
 * @cfg: physical link configs.
 *
 * Topology context contains a list of supported HW formats (configs) and
 * a default format ID for the physical link. This function will use this
 * default ID to choose the HW format to set the link's DAI format for init.
 */
static void set_link_hw_format(struct snd_soc_dai_link *link,
                        struct snd_soc_tplg_link_config *cfg)
{
        struct snd_soc_tplg_hw_config *hw_config;
        unsigned char bclk_provider, fsync_provider;
        unsigned char invert_bclk, invert_fsync;
        int i;

        for (i = 0; i < le32_to_cpu(cfg->num_hw_configs); i++) {
                hw_config = &cfg->hw_config[i];
                if (hw_config->id != cfg->default_hw_config_id)
                        continue;

                link->dai_fmt = le32_to_cpu(hw_config->fmt) &
                        SND_SOC_DAIFMT_FORMAT_MASK;

                /* clock gating */
                switch (hw_config->clock_gated) {
                case SND_SOC_TPLG_DAI_CLK_GATE_GATED:
                        link->dai_fmt |= SND_SOC_DAIFMT_GATED;
                        break;

                case SND_SOC_TPLG_DAI_CLK_GATE_CONT:
                        link->dai_fmt |= SND_SOC_DAIFMT_CONT;
                        break;

                default:
                        /* ignore the value */
                        break;
                }

                /* clock signal polarity */
                invert_bclk = hw_config->invert_bclk;
                invert_fsync = hw_config->invert_fsync;
                if (!invert_bclk && !invert_fsync)
                        link->dai_fmt |= SND_SOC_DAIFMT_NB_NF;
                else if (!invert_bclk && invert_fsync)
                        link->dai_fmt |= SND_SOC_DAIFMT_NB_IF;
                else if (invert_bclk && !invert_fsync)
                        link->dai_fmt |= SND_SOC_DAIFMT_IB_NF;
                else
                        link->dai_fmt |= SND_SOC_DAIFMT_IB_IF;

                /* clock masters */
                bclk_provider = (hw_config->bclk_provider ==
                               SND_SOC_TPLG_BCLK_CP);
                fsync_provider = (hw_config->fsync_provider ==
                                SND_SOC_TPLG_FSYNC_CP);
                if (bclk_provider && fsync_provider)
                        link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFP;
                else if (!bclk_provider && fsync_provider)
                        link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFP;
                else if (bclk_provider && !fsync_provider)
                        link->dai_fmt |= SND_SOC_DAIFMT_CBP_CFC;
                else
                        link->dai_fmt |= SND_SOC_DAIFMT_CBC_CFC;
        }
}

/**
 * snd_soc_find_dai_link - Find a DAI link
 *
 * @card: soc card
 * @id: DAI link ID to match
 * @name: DAI link name to match, optional
 * @stream_name: DAI link stream name to match, optional
 *
 * This function will search all existing DAI links of the soc card to
 * find the link of the same ID. Since DAI links may not have their
 * unique ID, so name and stream name should also match if being
 * specified.
 *
 * Return: pointer of DAI link, or NULL if not found.
 */
static struct snd_soc_dai_link *snd_soc_find_dai_link(struct snd_soc_card *card,
                                                      int id, const char *name,
                                                      const char *stream_name)
{
        struct snd_soc_pcm_runtime *rtd;

        for_each_card_rtds(card, rtd) {
                struct snd_soc_dai_link *link = rtd->dai_link;

                if (link->id != id)
                        continue;

                if (name && (!link->name || !strstr(link->name, name)))
                        continue;

                if (stream_name && (!link->stream_name ||
                                    !strstr(link->stream_name, stream_name)))
                        continue;

                return link;
        }

        return NULL;
}

/* Find and configure an existing physical DAI link */
static int soc_tplg_link_config(struct soc_tplg *tplg,
        struct snd_soc_tplg_link_config *cfg)
{
        struct snd_soc_dai_link *link;
        const char *name, *stream_name;
        size_t len;
        int ret;

        len = strnlen(cfg->name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
        if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;
        else if (len)
                name = cfg->name;
        else
                name = NULL;

        len = strnlen(cfg->stream_name, SNDRV_CTL_ELEM_ID_NAME_MAXLEN);
        if (len == SNDRV_CTL_ELEM_ID_NAME_MAXLEN)
                return -EINVAL;
        else if (len)
                stream_name = cfg->stream_name;
        else
                stream_name = NULL;

        link = snd_soc_find_dai_link(tplg->comp->card, le32_to_cpu(cfg->id),
                                     name, stream_name);
        if (!link) {
                dev_err(tplg->dev, "ASoC: physical link %s (id %d) not exist\n",
                        name, cfg->id);
                return -EINVAL;
        }

        /* hw format */
        if (cfg->num_hw_configs)
                set_link_hw_format(link, cfg);

        /* flags */
        if (cfg->flag_mask)
                set_link_flags(link,
                               le32_to_cpu(cfg->flag_mask),
                               le32_to_cpu(cfg->flags));

        /* pass control to component driver for optional further init */
        ret = soc_tplg_dai_link_load(tplg, link, cfg);
        if (ret < 0) {
                dev_err(tplg->dev, "ASoC: physical link loading failed\n");
                return ret;
        }

        /* for unloading it in snd_soc_tplg_component_remove */
        link->dobj.index = tplg->index;
        link->dobj.type = SND_SOC_DOBJ_BACKEND_LINK;
        if (tplg->ops)
                link->dobj.unload = tplg->ops->link_unload;
        list_add(&link->dobj.list, &tplg->comp->dobj_list);

        return 0;
}


/* Load physical link config elements from the topology context */
static int soc_tplg_link_elems_load(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        struct snd_soc_tplg_link_config *link;
        int count;
        int size;
        int i, ret;

        count = le32_to_cpu(hdr->count);

        /* check the element size and count */
        link = (struct snd_soc_tplg_link_config *)tplg->pos;
        size = le32_to_cpu(link->size);
        if (size > sizeof(struct snd_soc_tplg_link_config)) {
                dev_err(tplg->dev, "ASoC: invalid size %d for physical link elems\n",
                        size);
                return -EINVAL;
        }

        if (soc_tplg_check_elem_count(tplg, size, count,
                                      le32_to_cpu(hdr->payload_size),
                                      "physical link config"))
                return -EINVAL;

        /* config physical DAI links */
        for (i = 0; i < count; i++) {
                link = (struct snd_soc_tplg_link_config *)tplg->pos;
                size = le32_to_cpu(link->size);
                if (size != sizeof(*link))
                        return -EINVAL;

                ret = soc_tplg_link_config(tplg, link);
                if (ret < 0)
                        return ret;

                /* offset by version-specific struct size and
                 * real priv data size
                 */
                tplg->pos += size + le32_to_cpu(link->priv.size);
        }

        return 0;
}

/**
 * soc_tplg_dai_config - Find and configure an existing physical DAI.
 * @tplg: topology context
 * @d: physical DAI configs.
 *
 * The physical dai should already be registered by the platform driver.
 * The platform driver should specify the DAI name and ID for matching.
 */
static int soc_tplg_dai_config(struct soc_tplg *tplg,
                               struct snd_soc_tplg_dai *d)
{
        struct snd_soc_dai_link_component dai_component;
        struct snd_soc_dai *dai;
        struct snd_soc_dai_driver *dai_drv;
        struct snd_soc_pcm_stream *stream;
        struct snd_soc_tplg_stream_caps *caps;
        int ret;

        memset(&dai_component, 0, sizeof(dai_component));

        dai_component.dai_name = d->dai_name;
        dai = snd_soc_find_dai(&dai_component);
        if (!dai) {
                dev_err(tplg->dev, "ASoC: physical DAI %s not registered\n",
                        d->dai_name);
                return -EINVAL;
        }

        if (le32_to_cpu(d->dai_id) != dai->id) {
                dev_err(tplg->dev, "ASoC: physical DAI %s id mismatch\n",
                        d->dai_name);
                return -EINVAL;
        }

        dai_drv = dai->driver;
        if (!dai_drv)
                return -EINVAL;

        if (d->playback) {
                stream = &dai_drv->playback;
                caps = &d->caps[SND_SOC_TPLG_STREAM_PLAYBACK];
                ret = set_stream_info(tplg, stream, caps);
                if (ret < 0)
                        return ret;
        }

        if (d->capture) {
                stream = &dai_drv->capture;
                caps = &d->caps[SND_SOC_TPLG_STREAM_CAPTURE];
                ret = set_stream_info(tplg, stream, caps);
                if (ret < 0)
                        return ret;
        }

        if (d->flag_mask)
                set_dai_flags(dai_drv,
                              le32_to_cpu(d->flag_mask),
                              le32_to_cpu(d->flags));

        /* pass control to component driver for optional further init */
        ret = soc_tplg_dai_load(tplg, dai_drv, NULL, dai);
        if (ret < 0) {
                dev_err(tplg->dev, "ASoC: DAI loading failed\n");
                return ret;
        }

        return 0;
}

/* load physical DAI elements */
static int soc_tplg_dai_elems_load(struct soc_tplg *tplg,
                                   struct snd_soc_tplg_hdr *hdr)
{
        int count;
        int i;

        count = le32_to_cpu(hdr->count);

        /* config the existing BE DAIs */
        for (i = 0; i < count; i++) {
                struct snd_soc_tplg_dai *dai = (struct snd_soc_tplg_dai *)tplg->pos;
                int ret;

                if (le32_to_cpu(dai->size) != sizeof(*dai)) {
                        dev_err(tplg->dev, "ASoC: invalid physical DAI size\n");
                        return -EINVAL;
                }

                ret = soc_tplg_dai_config(tplg, dai);
                if (ret < 0) {
                        dev_err(tplg->dev, "ASoC: failed to configure DAI\n");
                        return ret;
                }

                tplg->pos += (sizeof(*dai) + le32_to_cpu(dai->priv.size));
        }

        dev_dbg(tplg->dev, "ASoC: Configure %d BE DAIs\n", count);
        return 0;
}

static int soc_tplg_manifest_load(struct soc_tplg *tplg,
                                  struct snd_soc_tplg_hdr *hdr)
{
        struct snd_soc_tplg_manifest *manifest;
        int ret = 0;

        manifest = (struct snd_soc_tplg_manifest *)tplg->pos;

        /* check ABI version by size, create a new manifest if abi not match */
        if (le32_to_cpu(manifest->size) != sizeof(*manifest))
                return -EINVAL;

        /* pass control to component driver for optional further init */
        if (tplg->ops && tplg->ops->manifest)
                ret = tplg->ops->manifest(tplg->comp, tplg->index, manifest);

        return ret;
}

/* validate header magic, size and type */
static int soc_tplg_valid_header(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        if (le32_to_cpu(hdr->size) != sizeof(*hdr)) {
                dev_err(tplg->dev,
                        "ASoC: invalid header size for type %d at offset 0x%lx size 0x%zx.\n",
                        le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
                        tplg->fw->size);
                return -EINVAL;
        }

        if (soc_tplg_get_hdr_offset(tplg) + le32_to_cpu(hdr->payload_size) >= tplg->fw->size) {
                dev_err(tplg->dev,
                        "ASoC: invalid header of type %d at offset %ld payload_size %d\n",
                        le32_to_cpu(hdr->type), soc_tplg_get_hdr_offset(tplg),
                        hdr->payload_size);
                return -EINVAL;
        }

        /* big endian firmware objects not supported atm */
        if (le32_to_cpu(hdr->magic) == SOC_TPLG_MAGIC_BIG_ENDIAN) {
                dev_err(tplg->dev,
                        "ASoC: pass %d big endian not supported header got %x at offset 0x%lx size 0x%zx.\n",
                        tplg->pass, hdr->magic,
                        soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
                return -EINVAL;
        }

        if (le32_to_cpu(hdr->magic) != SND_SOC_TPLG_MAGIC) {
                dev_err(tplg->dev,
                        "ASoC: pass %d does not have a valid header got %x at offset 0x%lx size 0x%zx.\n",
                        tplg->pass, hdr->magic,
                        soc_tplg_get_hdr_offset(tplg), tplg->fw->size);
                return -EINVAL;
        }

        /* Support ABI from version 4 */
        if (le32_to_cpu(hdr->abi) > SND_SOC_TPLG_ABI_VERSION ||
            le32_to_cpu(hdr->abi) < SND_SOC_TPLG_ABI_VERSION_MIN) {
                dev_err(tplg->dev,
                        "ASoC: pass %d invalid ABI version got 0x%x need 0x%x at offset 0x%lx size 0x%zx.\n",
                        tplg->pass, hdr->abi,
                        SND_SOC_TPLG_ABI_VERSION, soc_tplg_get_hdr_offset(tplg),
                        tplg->fw->size);
                return -EINVAL;
        }

        if (hdr->payload_size == 0) {
                dev_err(tplg->dev, "ASoC: header has 0 size at offset 0x%lx.\n",
                        soc_tplg_get_hdr_offset(tplg));
                return -EINVAL;
        }

        return 0;

}

/* check header type and call appropriate handler */
static int soc_tplg_load_header(struct soc_tplg *tplg,
        struct snd_soc_tplg_hdr *hdr)
{
        int (*elem_load)(struct soc_tplg *tplg,
                         struct snd_soc_tplg_hdr *hdr);
        unsigned int hdr_pass;

        tplg->pos = tplg->hdr_pos + sizeof(struct snd_soc_tplg_hdr);

        tplg->index = le32_to_cpu(hdr->index);

        switch (le32_to_cpu(hdr->type)) {
        case SND_SOC_TPLG_TYPE_MIXER:
        case SND_SOC_TPLG_TYPE_ENUM:
        case SND_SOC_TPLG_TYPE_BYTES:
                hdr_pass = SOC_TPLG_PASS_CONTROL;
                elem_load = soc_tplg_kcontrol_elems_load;
                break;
        case SND_SOC_TPLG_TYPE_DAPM_GRAPH:
                hdr_pass = SOC_TPLG_PASS_GRAPH;
                elem_load = soc_tplg_dapm_graph_elems_load;
                break;
        case SND_SOC_TPLG_TYPE_DAPM_WIDGET:
                hdr_pass = SOC_TPLG_PASS_WIDGET;
                elem_load = soc_tplg_dapm_widget_elems_load;
                break;
        case SND_SOC_TPLG_TYPE_PCM:
                hdr_pass = SOC_TPLG_PASS_PCM_DAI;
                elem_load = soc_tplg_pcm_elems_load;
                break;
        case SND_SOC_TPLG_TYPE_DAI:
                hdr_pass = SOC_TPLG_PASS_BE_DAI;
                elem_load = soc_tplg_dai_elems_load;
                break;
        case SND_SOC_TPLG_TYPE_DAI_LINK:
        case SND_SOC_TPLG_TYPE_BACKEND_LINK:
                /* physical link configurations */
                hdr_pass = SOC_TPLG_PASS_LINK;
                elem_load = soc_tplg_link_elems_load;
                break;
        case SND_SOC_TPLG_TYPE_MANIFEST:
                hdr_pass = SOC_TPLG_PASS_MANIFEST;
                elem_load = soc_tplg_manifest_load;
                break;
        default:
                /* bespoke vendor data object */
                hdr_pass = SOC_TPLG_PASS_VENDOR;
                elem_load = soc_tplg_vendor_load;
                break;
        }

        if (tplg->pass == hdr_pass) {
                dev_dbg(tplg->dev,
                        "ASoC: Got 0x%x bytes of type %d version %d vendor %d at pass %d\n",
                        hdr->payload_size, hdr->type, hdr->version,
                        hdr->vendor_type, tplg->pass);
                return elem_load(tplg, hdr);
        }

        return 0;
}

/* process the topology file headers */
static int soc_tplg_process_headers(struct soc_tplg *tplg)
{
        int ret;

        /* process the header types from start to end */
        for (tplg->pass = SOC_TPLG_PASS_START; tplg->pass <= SOC_TPLG_PASS_END; tplg->pass++) {
                struct snd_soc_tplg_hdr *hdr;

                tplg->hdr_pos = tplg->fw->data;
                hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;

                while (!soc_tplg_is_eof(tplg)) {

                        /* make sure header is valid before loading */
                        ret = soc_tplg_valid_header(tplg, hdr);
                        if (ret < 0)
                                return ret;

                        /* load the header object */
                        ret = soc_tplg_load_header(tplg, hdr);
                        if (ret < 0) {
                                if (ret != -EPROBE_DEFER) {
                                        dev_err(tplg->dev,
                                                "ASoC: topology: could not load header: %d\n",
                                                ret);
                                }
                                return ret;
                        }

                        /* goto next header */
                        tplg->hdr_pos += le32_to_cpu(hdr->payload_size) +
                                sizeof(struct snd_soc_tplg_hdr);
                        hdr = (struct snd_soc_tplg_hdr *)tplg->hdr_pos;
                }

        }

        /* signal DAPM we are complete */
        ret = soc_tplg_dapm_complete(tplg);

        return ret;
}

static int soc_tplg_load(struct soc_tplg *tplg)
{
        int ret;

        ret = soc_tplg_process_headers(tplg);
        if (ret == 0)
                return soc_tplg_complete(tplg);

        return ret;
}

/* load audio component topology from "firmware" file */
int snd_soc_tplg_component_load(struct snd_soc_component *comp,
        const struct snd_soc_tplg_ops *ops, const struct firmware *fw)
{
        struct soc_tplg tplg;
        int ret;

        /*
         * check if we have sane parameters:
         * comp - needs to exist to keep and reference data while parsing
         * comp->card - used for setting card related parameters
         * comp->card->dev - used for resource management and prints
         * fw - we need it, as it is the very thing we parse
         */
        if (!comp || !comp->card || !comp->card->dev || !fw)
                return -EINVAL;

        /* setup parsing context */
        memset(&tplg, 0, sizeof(tplg));
        tplg.fw = fw;
        tplg.dev = comp->card->dev;
        tplg.comp = comp;
        if (ops) {
                tplg.ops = ops;
                tplg.io_ops = ops->io_ops;
                tplg.io_ops_count = ops->io_ops_count;
                tplg.bytes_ext_ops = ops->bytes_ext_ops;
                tplg.bytes_ext_ops_count = ops->bytes_ext_ops_count;
        }

        ret = soc_tplg_load(&tplg);
        /* free the created components if fail to load topology */
        if (ret)
                snd_soc_tplg_component_remove(comp);

        return ret;
}
EXPORT_SYMBOL_GPL(snd_soc_tplg_component_load);

/* remove dynamic controls from the component driver */
int snd_soc_tplg_component_remove(struct snd_soc_component *comp)
{
        struct snd_soc_dobj *dobj, *next_dobj;
        int pass;

        /* process the header types from end to start */
        for (pass = SOC_TPLG_PASS_END; pass >= SOC_TPLG_PASS_START; pass--) {

                /* remove mixer controls */
                list_for_each_entry_safe(dobj, next_dobj, &comp->dobj_list,
                        list) {

                        switch (dobj->type) {
                        case SND_SOC_DOBJ_BYTES:
                        case SND_SOC_DOBJ_ENUM:
                        case SND_SOC_DOBJ_MIXER:
                                soc_tplg_remove_kcontrol(comp, dobj, pass);
                                break;
                        case SND_SOC_DOBJ_GRAPH:
                                soc_tplg_remove_route(comp, dobj, pass);
                                break;
                        case SND_SOC_DOBJ_WIDGET:
                                soc_tplg_remove_widget(comp, dobj, pass);
                                break;
                        case SND_SOC_DOBJ_PCM:
                                soc_tplg_remove_dai(comp, dobj, pass);
                                break;
                        case SND_SOC_DOBJ_DAI_LINK:
                                soc_tplg_remove_link(comp, dobj, pass);
                                break;
                        case SND_SOC_DOBJ_BACKEND_LINK:
                                /*
                                 * call link_unload ops if extra
                                 * deinitialization is needed.
                                 */
                                remove_backend_link(comp, dobj, pass);
                                break;
                        default:
                                dev_err(comp->dev, "ASoC: invalid component type %d for removal\n",
                                        dobj->type);
                                break;
                        }
                }
        }

        /* let caller know if FW can be freed when no objects are left */
        return !list_empty(&comp->dobj_list);
}
EXPORT_SYMBOL_GPL(snd_soc_tplg_component_remove);