// SPDX-License-Identifier: GPL-2.0
//
// simple-card-utils.c
//
// Copyright (c) 2016 Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>

#include <dt-bindings/sound/audio-graph.h>
#include <linux/cleanup.h>
#include <linux/clk.h>
#include <linux/gpio/consumer.h>
#include <linux/module.h>
#include <linux/of.h>
#include <linux/of_graph.h>
#include <sound/jack.h>
#include <sound/pcm_params.h>
#include <sound/simple_card_utils.h>

#define simple_ret(priv, ret) _simple_ret(priv, __func__, ret)
static inline int _simple_ret(struct simple_util_priv *priv,
                              const char *func, int ret)
{
        return snd_soc_ret(simple_priv_to_dev(priv), ret, "at %s()\n", func);
}

int simple_util_get_sample_fmt(struct simple_util_data *data)
{
        int i;
        int val = -EINVAL;

        struct {
                char *fmt;
                u32 val;
        } of_sample_fmt_table[] = {
                { "s8",         SNDRV_PCM_FORMAT_S8},
                { "s16_le",     SNDRV_PCM_FORMAT_S16_LE},
                { "s24_le",     SNDRV_PCM_FORMAT_S24_LE},
                { "s24_3le",    SNDRV_PCM_FORMAT_S24_3LE},
                { "s32_le",     SNDRV_PCM_FORMAT_S32_LE},
        };

        for (i = 0; i < ARRAY_SIZE(of_sample_fmt_table); i++) {
                if (!strcmp(data->convert_sample_format,
                            of_sample_fmt_table[i].fmt)) {
                        val = of_sample_fmt_table[i].val;
                        break;
                }
        }
        return val;
}
EXPORT_SYMBOL_GPL(simple_util_get_sample_fmt);

static void simple_fixup_sample_fmt(struct simple_util_data *data,
                                    struct snd_pcm_hw_params *params)
{
        int val;
        struct snd_mask *mask = hw_param_mask(params,
                                              SNDRV_PCM_HW_PARAM_FORMAT);

        val = simple_util_get_sample_fmt(data);
        if (val >= 0) {
                snd_mask_none(mask);
                snd_mask_set(mask, val);
        }
}

void simple_util_parse_convert(struct device_node *np,
                               char *prefix,
                               struct simple_util_data *data)
{
        char prop[128];

        if (!np)
                return;

        if (!prefix)
                prefix = "";

        /* sampling rate convert */
        snprintf(prop, sizeof(prop), "%s%s", prefix, "convert-rate");
        of_property_read_u32(np, prop, &data->convert_rate);

        /* channels transfer */
        snprintf(prop, sizeof(prop), "%s%s", prefix, "convert-channels");
        of_property_read_u32(np, prop, &data->convert_channels);

        /* convert sample format */
        snprintf(prop, sizeof(prop), "%s%s", prefix, "convert-sample-format");
        of_property_read_string(np, prop, &data->convert_sample_format);
}
EXPORT_SYMBOL_GPL(simple_util_parse_convert);

/**
 * simple_util_is_convert_required() - Query if HW param conversion was requested
 * @data: Link data.
 *
 * Returns true if any HW param conversion was requested for this DAI link with
 * any "convert-xxx" properties.
 */
bool simple_util_is_convert_required(const struct simple_util_data *data)
{
        return data->convert_rate ||
               data->convert_channels ||
               data->convert_sample_format;
}
EXPORT_SYMBOL_GPL(simple_util_is_convert_required);

int simple_util_parse_daifmt(struct device *dev,
                             struct device_node *node,
                             struct device_node *codec,
                             char *prefix,
                             unsigned int *retfmt)
{
        struct device_node *bitclkmaster = NULL;
        struct device_node *framemaster = NULL;
        unsigned int daifmt;

        daifmt = snd_soc_daifmt_parse_format(node, prefix);

        snd_soc_daifmt_parse_clock_provider_as_phandle(node, prefix, &bitclkmaster, &framemaster);
        if (!bitclkmaster && !framemaster) {
                /*
                 * No dai-link level and master setting was not found from
                 * sound node level, revert back to legacy DT parsing and
                 * take the settings from codec node.
                 */
                dev_dbg(dev, "Revert to legacy daifmt parsing\n");

                daifmt |= snd_soc_daifmt_parse_clock_provider_as_flag(codec, NULL);
        } else {
                daifmt |= snd_soc_daifmt_clock_provider_from_bitmap(
                                ((codec == bitclkmaster) << 4) | (codec == framemaster));
        }

        of_node_put(bitclkmaster);
        of_node_put(framemaster);

        *retfmt = daifmt;

        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_parse_daifmt);

int simple_util_parse_tdm_width_map(struct simple_util_priv *priv, struct device_node *np,
                                    struct simple_util_dai *dai)
{
        struct device *dev = simple_priv_to_dev(priv);
        int n, i, ret;
        u32 *p;

        /*
         * NOTE
         *
         * Clang doesn't allow to use "goto end" before calling __free(),
         * because it bypasses the initialization. Use simple_ret() directly.
         */

        n = of_property_count_elems_of_size(np, "dai-tdm-slot-width-map", sizeof(u32));
        if (n <= 0)
                return 0;

        if (n % 3) {
                dev_err(dev, "Invalid number of cells for dai-tdm-slot-width-map\n");
                return simple_ret(priv, -EINVAL); /* see NOTE */
        }

        ret = -ENOMEM;
        dai->tdm_width_map = devm_kcalloc(dev, n, sizeof(*dai->tdm_width_map), GFP_KERNEL);
        if (!dai->tdm_width_map)
                return simple_ret(priv, ret); /* see NOTE */

        u32 *array_values __free(kfree) = kcalloc(n, sizeof(*array_values), GFP_KERNEL);
        if (!array_values)
                goto end;

        ret = of_property_read_u32_array(np, "dai-tdm-slot-width-map", array_values, n);
        if (ret < 0) {
                dev_err(dev, "Could not read dai-tdm-slot-width-map: %d\n", ret);
                goto end;
        }

        p = array_values;
        for (i = 0; i < n / 3; ++i) {
                dai->tdm_width_map[i].sample_bits = *p++;
                dai->tdm_width_map[i].slot_width = *p++;
                dai->tdm_width_map[i].slot_count = *p++;
        }

        dai->n_tdm_widths = i;
        ret = 0;
end:
        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(simple_util_parse_tdm_width_map);

int simple_util_set_dailink_name(struct simple_util_priv *priv,
                                 struct snd_soc_dai_link *dai_link,
                                 const char *fmt, ...)
{
        struct device *dev = simple_priv_to_dev(priv);
        va_list ap;
        char *name = NULL;
        int ret = -ENOMEM;

        va_start(ap, fmt);
        name = devm_kvasprintf(dev, GFP_KERNEL, fmt, ap);
        va_end(ap);

        if (name) {
                ret = 0;

                dai_link->name          = name;
                dai_link->stream_name   = name;
        }

        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(simple_util_set_dailink_name);

int simple_util_parse_card_name(struct simple_util_priv *priv,
                                char *prefix)
{
        struct snd_soc_card *card = simple_priv_to_card(priv);
        int ret;

        if (!prefix)
                prefix = "";

        /* Parse the card name from DT */
        ret = snd_soc_of_parse_card_name(card, "label");
        if (ret < 0 || !card->name) {
                char prop[128];

                snprintf(prop, sizeof(prop), "%sname", prefix);
                ret = snd_soc_of_parse_card_name(card, prop);
                if (ret < 0)
                        goto end;
        }

        if (!card->name && card->dai_link)
                card->name = card->dai_link->name;
end:
        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(simple_util_parse_card_name);

static int simple_clk_enable(struct simple_util_dai *dai)
{
        if (dai)
                return clk_prepare_enable(dai->clk);

        return 0;
}

static void simple_clk_disable(struct simple_util_dai *dai)
{
        if (dai)
                clk_disable_unprepare(dai->clk);
}

int simple_util_parse_clk(struct device *dev,
                          struct device_node *node,
                          struct simple_util_dai *simple_dai,
                          struct snd_soc_dai_link_component *dlc)
{
        struct clk *clk;
        u32 val;

        /*
         * Parse dai->sysclk come from "clocks = <&xxx>"
         * (if system has common clock)
         *  or "system-clock-frequency = <xxx>"
         *  or device's module clock.
         */
        clk = devm_get_clk_from_child(dev, node, NULL);
        simple_dai->clk_fixed = of_property_read_bool(
                node, "system-clock-fixed");
        if (!IS_ERR(clk)) {
                simple_dai->sysclk = clk_get_rate(clk);

                simple_dai->clk = clk;
        } else if (!of_property_read_u32(node, "system-clock-frequency", &val)) {
                simple_dai->sysclk = val;
                simple_dai->clk_fixed = true;
        } else {
                clk = devm_get_clk_from_child(dev, dlc->of_node, NULL);
                if (!IS_ERR(clk))
                        simple_dai->sysclk = clk_get_rate(clk);
        }

        if (of_property_read_bool(node, "system-clock-direction-out"))
                simple_dai->clk_direction = SND_SOC_CLOCK_OUT;

        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_parse_clk);

static int simple_check_fixed_sysclk(struct device *dev,
                                          struct simple_util_dai *dai,
                                          unsigned int *fixed_sysclk)
{
        if (dai->clk_fixed) {
                if (*fixed_sysclk && *fixed_sysclk != dai->sysclk) {
                        dev_err(dev, "inconsistent fixed sysclk rates (%u vs %u)\n",
                                *fixed_sysclk, dai->sysclk);
                        return -EINVAL;
                }
                *fixed_sysclk = dai->sysclk;
        }

        return 0;
}

int simple_util_startup(struct snd_pcm_substream *substream)
{
        struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
        struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
        struct simple_dai_props *props = runtime_simple_priv_to_props(priv, rtd);
        struct simple_util_dai *dai;
        unsigned int fixed_sysclk = 0;
        int i1, i2, i;
        int ret;

        for_each_prop_dai_cpu(props, i1, dai) {
                ret = simple_clk_enable(dai);
                if (ret)
                        goto cpu_err;
                ret = simple_check_fixed_sysclk(rtd->dev, dai, &fixed_sysclk);
                if (ret)
                        goto cpu_err;
        }

        for_each_prop_dai_codec(props, i2, dai) {
                ret = simple_clk_enable(dai);
                if (ret)
                        goto codec_err;
                ret = simple_check_fixed_sysclk(rtd->dev, dai, &fixed_sysclk);
                if (ret)
                        goto codec_err;
        }

        if (fixed_sysclk && props->mclk_fs) {
                unsigned int fixed_rate = fixed_sysclk / props->mclk_fs;

                if (fixed_sysclk % props->mclk_fs) {
                        dev_err(rtd->dev, "fixed sysclk %u not divisible by mclk_fs %u\n",
                                fixed_sysclk, props->mclk_fs);
                        ret = -EINVAL;
                        goto codec_err;
                }
                ret = snd_pcm_hw_constraint_minmax(substream->runtime, SNDRV_PCM_HW_PARAM_RATE,
                        fixed_rate, fixed_rate);
                if (ret < 0)
                        goto codec_err;
        }

        return 0;

codec_err:
        for_each_prop_dai_codec(props, i, dai) {
                if (i >= i2)
                        break;
                simple_clk_disable(dai);
        }
cpu_err:
        for_each_prop_dai_cpu(props, i, dai) {
                if (i >= i1)
                        break;
                simple_clk_disable(dai);
        }

        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(simple_util_startup);

void simple_util_shutdown(struct snd_pcm_substream *substream)
{
        struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
        struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
        struct simple_dai_props *props = runtime_simple_priv_to_props(priv, rtd);
        struct simple_util_dai *dai;
        int i;

        for_each_prop_dai_cpu(props, i, dai) {
                struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, i);

                if (props->mclk_fs && !dai->clk_fixed && !snd_soc_dai_active(cpu_dai))
                        snd_soc_dai_set_sysclk(cpu_dai, 0, 0, dai->clk_direction);

                simple_clk_disable(dai);
        }
        for_each_prop_dai_codec(props, i, dai) {
                struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, i);

                if (props->mclk_fs && !dai->clk_fixed && !snd_soc_dai_active(codec_dai))
                        snd_soc_dai_set_sysclk(codec_dai, 0, 0, dai->clk_direction);

                simple_clk_disable(dai);
        }
}
EXPORT_SYMBOL_GPL(simple_util_shutdown);

static int simple_set_clk_rate(struct simple_util_priv *priv,
                               struct simple_util_dai *simple_dai,
                               unsigned long rate)
{
        struct device *dev = simple_priv_to_dev(priv);
        int ret = -EINVAL;

        if (!simple_dai)
                return 0;

        if (simple_dai->clk_fixed && rate != simple_dai->sysclk) {
                dev_err(dev, "dai %s invalid clock rate %lu\n", simple_dai->name, rate);
                goto end;
        }

        if (!simple_dai->clk)
                return 0;

        if (clk_get_rate(simple_dai->clk) == rate)
                return 0;

        ret = clk_set_rate(simple_dai->clk, rate);
end:
        return simple_ret(priv, ret);
}

static int simple_set_tdm(struct simple_util_priv *priv,
                          struct snd_soc_dai *dai,
                          struct simple_util_dai *simple_dai,
                          struct snd_pcm_hw_params *params)
{
        int sample_bits = params_width(params);
        int slot_width, slot_count;
        int i, ret;

        if (!simple_dai || !simple_dai->tdm_width_map)
                return 0;

        slot_width = simple_dai->slot_width;
        slot_count = simple_dai->slots;

        if (slot_width == 0)
                slot_width = sample_bits;

        for (i = 0; i < simple_dai->n_tdm_widths; ++i) {
                if (simple_dai->tdm_width_map[i].sample_bits == sample_bits) {
                        slot_width = simple_dai->tdm_width_map[i].slot_width;
                        slot_count = simple_dai->tdm_width_map[i].slot_count;
                        break;
                }
        }

        ret = snd_soc_dai_set_tdm_slot(dai,
                                       simple_dai->tx_slot_mask,
                                       simple_dai->rx_slot_mask,
                                       slot_count,
                                       slot_width);

        return simple_ret(priv, ret);
}

int simple_util_hw_params(struct snd_pcm_substream *substream,
                          struct snd_pcm_hw_params *params)
{
        struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
        struct simple_util_dai *pdai;
        struct snd_soc_dai *sdai;
        struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
        struct simple_dai_props *props = runtime_simple_priv_to_props(priv, rtd);
        unsigned int mclk, mclk_fs = 0;
        int i, ret;

        if (props->mclk_fs)
                mclk_fs = props->mclk_fs;

        if (mclk_fs) {
                struct snd_soc_component *component;
                mclk = params_rate(params) * mclk_fs;

                for_each_prop_dai_codec(props, i, pdai) {
                        ret = simple_set_clk_rate(priv, pdai, mclk);
                        if (ret < 0)
                                goto end;
                }

                for_each_prop_dai_cpu(props, i, pdai) {
                        ret = simple_set_clk_rate(priv, pdai, mclk);
                        if (ret < 0)
                                goto end;
                }

                /* Ensure sysclk is set on all components in case any
                 * (such as platform components) are missed by calls to
                 * snd_soc_dai_set_sysclk.
                 */
                for_each_rtd_components(rtd, i, component) {
                        ret = snd_soc_component_set_sysclk(component, 0, 0,
                                                           mclk, SND_SOC_CLOCK_IN);
                        if (ret && ret != -ENOTSUPP)
                                goto end;
                }

                for_each_rtd_codec_dais(rtd, i, sdai) {
                        pdai = simple_props_to_dai_codec(props, i);
                        ret = snd_soc_dai_set_sysclk(sdai, 0, mclk, pdai->clk_direction);
                        if (ret && ret != -ENOTSUPP)
                                goto end;
                }

                for_each_rtd_cpu_dais(rtd, i, sdai) {
                        pdai = simple_props_to_dai_cpu(props, i);
                        ret = snd_soc_dai_set_sysclk(sdai, 0, mclk, pdai->clk_direction);
                        if (ret && ret != -ENOTSUPP)
                                goto end;
                }
        }

        for_each_prop_dai_codec(props, i, pdai) {
                sdai = snd_soc_rtd_to_codec(rtd, i);
                ret = simple_set_tdm(priv, sdai, pdai, params);
                if (ret < 0)
                        goto end;
        }

        for_each_prop_dai_cpu(props, i, pdai) {
                sdai = snd_soc_rtd_to_cpu(rtd, i);
                ret = simple_set_tdm(priv, sdai, pdai, params);
                if (ret < 0)
                        goto end;
        }
        ret = 0;
end:
        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(simple_util_hw_params);

int simple_util_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
                                   struct snd_pcm_hw_params *params)
{
        struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
        struct simple_dai_props *dai_props = runtime_simple_priv_to_props(priv, rtd);
        struct simple_util_data *data = &dai_props->adata;
        struct snd_interval *rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
        struct snd_interval *channels = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);

        if (data->convert_rate)
                rate->min =
                rate->max = data->convert_rate;

        if (data->convert_channels)
                channels->min =
                channels->max = data->convert_channels;

        if (data->convert_sample_format)
                simple_fixup_sample_fmt(data, params);

        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_be_hw_params_fixup);

static int simple_init_dai(struct simple_util_priv *priv,
                           struct snd_soc_dai *dai, struct simple_util_dai *simple_dai)
{
        int ret;

        if (!simple_dai)
                return 0;

        if (simple_dai->sysclk) {
                ret = snd_soc_dai_set_sysclk(dai, 0, simple_dai->sysclk,
                                             simple_dai->clk_direction);
                if (ret && ret != -ENOTSUPP) {
                        dev_err(dai->dev, "simple-card: set_sysclk error\n");
                        goto end;
                }
        }

        if (simple_dai->slots) {
                ret = snd_soc_dai_set_tdm_slot(dai,
                                               simple_dai->tx_slot_mask,
                                               simple_dai->rx_slot_mask,
                                               simple_dai->slots,
                                               simple_dai->slot_width);
                if (ret && ret != -ENOTSUPP) {
                        dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
                        goto end;
                }
        }
        ret = 0;
end:
        return simple_ret(priv, ret);
}

static inline int simple_component_is_codec(struct snd_soc_component *component)
{
        return component->driver->endianness;
}

static int simple_init_for_codec2codec(struct simple_util_priv *priv,
                                       struct snd_soc_pcm_runtime *rtd,
                                       struct simple_dai_props *dai_props)
{
        struct snd_soc_dai_link *dai_link = rtd->dai_link;
        struct snd_soc_component *component;
        struct snd_soc_pcm_stream *c2c_params;
        struct snd_pcm_hardware hw;
        int i, ret, stream;

        /* Do nothing if it already has Codec2Codec settings */
        if (dai_link->c2c_params)
                return 0;

        /* Do nothing if it was DPCM :: BE */
        if (dai_link->no_pcm)
                return 0;

        /* Only Codecs */
        for_each_rtd_components(rtd, i, component) {
                if (!simple_component_is_codec(component))
                        return 0;
        }

        /* Assumes the capabilities are the same for all supported streams */
        for_each_pcm_streams(stream) {
                ret = snd_soc_runtime_calc_hw(rtd, &hw, stream);
                if (ret == 0)
                        break;
        }

        if (ret < 0) {
                dev_err(rtd->dev, "simple-card: no valid dai_link params\n");
                goto end;
        }

        ret = -ENOMEM;
        c2c_params = devm_kzalloc(rtd->dev, sizeof(*c2c_params), GFP_KERNEL);
        if (!c2c_params)
                goto end;

        c2c_params->formats             = hw.formats;
        c2c_params->rates               = hw.rates;
        c2c_params->rate_min            = hw.rate_min;
        c2c_params->rate_max            = hw.rate_max;
        c2c_params->channels_min        = hw.channels_min;
        c2c_params->channels_max        = hw.channels_max;

        dai_link->c2c_params            = c2c_params;
        dai_link->num_c2c_params        = 1;

        ret = 0;
end:
        return simple_ret(priv, ret);
}

int simple_util_dai_init(struct snd_soc_pcm_runtime *rtd)
{
        struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
        struct simple_dai_props *props = runtime_simple_priv_to_props(priv, rtd);
        struct simple_util_dai *dai;
        int i, ret;

        for_each_prop_dai_codec(props, i, dai) {
                ret = simple_init_dai(priv, snd_soc_rtd_to_codec(rtd, i), dai);
                if (ret < 0)
                        goto end;
        }
        for_each_prop_dai_cpu(props, i, dai) {
                ret = simple_init_dai(priv, snd_soc_rtd_to_cpu(rtd, i), dai);
                if (ret < 0)
                        goto end;
        }

        ret = simple_init_for_codec2codec(priv, rtd, props);
end:
        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(simple_util_dai_init);

void simple_util_canonicalize_platform(struct snd_soc_dai_link_component *platforms,
                                       struct snd_soc_dai_link_component *cpus)
{
        /*
         * Assumes Platform == CPU
         *
         * Some CPU might be using soc-generic-dmaengine-pcm. This means CPU and Platform
         * are different Component, but are sharing same component->dev.
         *
         * Let's assume Platform is same as CPU if it doesn't identify Platform on DT.
         * see
         *      simple-card.c :: simple_count_noml()
         */
        if (!platforms->of_node)
                snd_soc_dlc_use_cpu_as_platform(platforms, cpus);
}
EXPORT_SYMBOL_GPL(simple_util_canonicalize_platform);

void simple_util_canonicalize_cpu(struct snd_soc_dai_link_component *cpus,
                                  int is_single_links)
{
        /*
         * In soc_bind_dai_link() will check cpu name after
         * of_node matching if dai_link has cpu_dai_name.
         * but, it will never match if name was created by
         * fmt_single_name() remove cpu_dai_name if cpu_args
         * was 0. See:
         *      fmt_single_name()
         *      fmt_multiple_name()
         */
        if (is_single_links)
                cpus->dai_name = NULL;
}
EXPORT_SYMBOL_GPL(simple_util_canonicalize_cpu);

void simple_util_clean_reference(struct snd_soc_card *card)
{
        struct snd_soc_dai_link *dai_link;
        struct snd_soc_dai_link_component *cpu;
        struct snd_soc_dai_link_component *codec;
        int i, j;

        for_each_card_prelinks(card, i, dai_link) {
                for_each_link_cpus(dai_link, j, cpu)
                        of_node_put(cpu->of_node);
                for_each_link_codecs(dai_link, j, codec)
                        of_node_put(codec->of_node);
        }
}
EXPORT_SYMBOL_GPL(simple_util_clean_reference);

int simple_util_parse_routing(struct snd_soc_card *card,
                              char *prefix)
{
        struct device_node *node = card->dev->of_node;
        char prop[128];

        if (!prefix)
                prefix = "";

        snprintf(prop, sizeof(prop), "%s%s", prefix, "routing");

        if (!of_property_present(node, prop))
                return 0;

        return snd_soc_of_parse_audio_routing(card, prop);
}
EXPORT_SYMBOL_GPL(simple_util_parse_routing);

int simple_util_parse_widgets(struct snd_soc_card *card,
                              char *prefix)
{
        struct device_node *node = card->dev->of_node;
        char prop[128];

        if (!prefix)
                prefix = "";

        snprintf(prop, sizeof(prop), "%s%s", prefix, "widgets");

        if (of_property_present(node, prop))
                return snd_soc_of_parse_audio_simple_widgets(card, prop);

        /* no widgets is not error */
        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_parse_widgets);

int simple_util_parse_pin_switches(struct snd_soc_card *card,
                                   char *prefix)
{
        char prop[128];

        if (!prefix)
                prefix = "";

        snprintf(prop, sizeof(prop), "%s%s", prefix, "pin-switches");

        return snd_soc_of_parse_pin_switches(card, prop);
}
EXPORT_SYMBOL_GPL(simple_util_parse_pin_switches);

int simple_util_init_jack(struct snd_soc_card *card,
                          struct simple_util_jack *sjack,
                          int is_hp, char *prefix,
                          char *pin)
{
        struct device *dev = card->dev;
        struct gpio_desc *desc;
        char prop[128];
        char *pin_name;
        char *gpio_name;
        int mask;
        int error;

        if (!prefix)
                prefix = "";

        if (is_hp) {
                snprintf(prop, sizeof(prop), "%shp-det", prefix);
                pin_name        = pin ? pin : "Headphones";
                gpio_name       = "Headphone detection";
                mask            = SND_JACK_HEADPHONE;
        } else {
                snprintf(prop, sizeof(prop), "%smic-det", prefix);
                pin_name        = pin ? pin : "Mic Jack";
                gpio_name       = "Mic detection";
                mask            = SND_JACK_MICROPHONE;
        }

        desc = gpiod_get_optional(dev, prop, GPIOD_IN);
        error = PTR_ERR_OR_ZERO(desc);
        if (error)
                return error;

        if (desc) {
                error = gpiod_set_consumer_name(desc, gpio_name);
                if (error)
                        return error;

                sjack->pin.pin          = pin_name;
                sjack->pin.mask         = mask;

                sjack->gpio.name        = gpio_name;
                sjack->gpio.report      = mask;
                sjack->gpio.desc        = desc;
                sjack->gpio.debounce_time = 150;

                snd_soc_card_jack_new_pins(card, pin_name, mask, &sjack->jack,
                                           &sjack->pin, 1);

                snd_soc_jack_add_gpios(&sjack->jack, 1, &sjack->gpio);
        }

        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_init_jack);

int simple_util_init_aux_jacks(struct simple_util_priv *priv, char *prefix)
{
        struct snd_soc_card *card = simple_priv_to_card(priv);
        struct snd_soc_component *component;
        int found_jack_index = 0;
        int type = 0;
        int num = 0;
        int ret;

        if (priv->aux_jacks)
                return 0;

        for_each_card_auxs(card, component) {
                type = snd_soc_component_get_jack_type(component);
                if (type > 0)
                        num++;
        }
        if (num < 1)
                return 0;

        priv->aux_jacks = devm_kcalloc(card->dev, num,
                                       sizeof(struct snd_soc_jack), GFP_KERNEL);
        if (!priv->aux_jacks)
                return simple_ret(priv, -ENOMEM);

        for_each_card_auxs(card, component) {
                char id[128];
                struct snd_soc_jack *jack;

                if (found_jack_index >= num)
                        break;

                type = snd_soc_component_get_jack_type(component);
                if (type <= 0)
                        continue;

                /* create jack */
                jack = &(priv->aux_jacks[found_jack_index++]);
                snprintf(id, sizeof(id), "%s-jack", component->name);
                ret = snd_soc_card_jack_new(card, id, type, jack);
                if (ret)
                        continue;

                (void)snd_soc_component_set_jack(component, jack, NULL);
        }
        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_init_aux_jacks);

static struct simple_util_dai dummy_util_dais = {
        .name = "dummy_util_dais",
};

int simple_util_init_priv(struct simple_util_priv *priv,
                          struct link_info *li)
{
        struct snd_soc_card *card = simple_priv_to_card(priv);
        struct device *dev = simple_priv_to_dev(priv);
        struct snd_soc_dai_link *dai_link;
        struct simple_dai_props *dai_props;
        struct simple_util_dai *dais;
        struct snd_soc_dai_link_component *dlcs;
        struct snd_soc_codec_conf *cconf = NULL;
        int i, dai_num = 0, dlc_num = 0, cnf_num = 0;

        dai_props = devm_kcalloc(dev, li->link, sizeof(*dai_props), GFP_KERNEL);
        dai_link  = devm_kcalloc(dev, li->link, sizeof(*dai_link),  GFP_KERNEL);
        if (!dai_props || !dai_link)
                return -ENOMEM;

        /*
         * dais (= CPU+Codec)
         * dlcs (= CPU+Codec+Platform)
         */
        for (i = 0; i < li->link; i++) {
                int cc = li->num[i].cpus + li->num[i].codecs;

                dai_num += cc;
                dlc_num += cc + li->num[i].platforms;

                if (!li->num[i].cpus)
                        cnf_num += li->num[i].codecs;
        }

        dais = devm_kcalloc(dev, dai_num, sizeof(*dais), GFP_KERNEL);
        dlcs = devm_kcalloc(dev, dlc_num, sizeof(*dlcs), GFP_KERNEL);
        if (!dais || !dlcs)
                return -ENOMEM;

        if (cnf_num) {
                cconf = devm_kcalloc(dev, cnf_num, sizeof(*cconf), GFP_KERNEL);
                if (!cconf)
                        return -ENOMEM;
        }

        dev_dbg(dev, "link %d, dais %d, ccnf %d\n",
                li->link, dai_num, cnf_num);

        priv->dai_props         = dai_props;
        priv->dai_link          = dai_link;
        priv->dais              = dais;
        priv->dlcs              = dlcs;
        priv->codec_conf        = cconf;

        card->dai_link          = priv->dai_link;
        card->num_links         = li->link;
        card->codec_conf        = cconf;
        card->num_configs       = cnf_num;

        for (i = 0; i < li->link; i++) {
                if (li->num[i].cpus) {
                        /* Normal CPU */
                        dai_link[i].cpus        = dlcs;
                        dai_props[i].num.cpus   =
                        dai_link[i].num_cpus    = li->num[i].cpus;
                        dai_props[i].cpu_dai    = dais;

                        dlcs += li->num[i].cpus;
                        dais += li->num[i].cpus;
                } else {
                        /* DPCM Be's CPU = dummy */
                        dai_link[i].cpus        = &snd_soc_dummy_dlc;
                        dai_props[i].num.cpus   =
                        dai_link[i].num_cpus    = 1;
                        dai_props[i].cpu_dai    = &dummy_util_dais;
                }

                if (li->num[i].codecs) {
                        /* Normal Codec */
                        dai_link[i].codecs      = dlcs;
                        dai_props[i].num.codecs =
                        dai_link[i].num_codecs  = li->num[i].codecs;
                        dai_props[i].codec_dai  = dais;

                        dlcs += li->num[i].codecs;
                        dais += li->num[i].codecs;

                        if (!li->num[i].cpus) {
                                /* DPCM Be's Codec */
                                dai_props[i].codec_conf = cconf;
                                cconf += li->num[i].codecs;
                        }
                } else {
                        /* DPCM Fe's Codec = dummy */
                        dai_link[i].codecs      = &snd_soc_dummy_dlc;
                        dai_props[i].num.codecs =
                        dai_link[i].num_codecs  = 1;
                        dai_props[i].codec_dai  = &dummy_util_dais;
                }

                if (li->num[i].platforms) {
                        /* Have Platform */
                        dai_link[i].platforms           = dlcs;
                        dai_props[i].num.platforms      =
                        dai_link[i].num_platforms       = li->num[i].platforms;

                        dlcs += li->num[i].platforms;
                } else {
                        /* Doesn't have Platform */
                        dai_link[i].platforms           = NULL;
                        dai_props[i].num.platforms      =
                        dai_link[i].num_platforms       = 0;
                }
        }

        return 0;
}
EXPORT_SYMBOL_GPL(simple_util_init_priv);

void simple_util_remove(struct platform_device *pdev)
{
        struct snd_soc_card *card = platform_get_drvdata(pdev);

        simple_util_clean_reference(card);
}
EXPORT_SYMBOL_GPL(simple_util_remove);

int graph_util_card_probe(struct snd_soc_card *card)
{
        struct simple_util_priv *priv = snd_soc_card_get_drvdata(card);
        int ret;

        ret = simple_util_init_hp(card, &priv->hp_jack, NULL);
        if (ret < 0)
                goto end;

        ret = simple_util_init_mic(card, &priv->mic_jack, NULL);
end:
        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(graph_util_card_probe);

int graph_util_is_ports0(struct device_node *np)
{
        struct device_node *parent __free(device_node) = of_get_parent(np);
        struct device_node *port;

        /* np is "endpoint" or "port" */
        if (of_node_name_eq(np, "endpoint"))
                port = parent;
        else
                port = np;

        struct device_node *ports __free(device_node) = of_get_parent(port);
        const char *at = strchr(kbasename(ports->full_name), '@');

        /*
         * Since child iteration order may differ
         * between a base DT and DT overlays,
         * string match "ports" or "ports@0" in the node name instead.
         */
        return !at || !strcmp(at, "@0");
}
EXPORT_SYMBOL_GPL(graph_util_is_ports0);

static int graph_get_dai_id(struct device_node *ep)
{
        struct device_node *node __free(device_node) = of_graph_get_port_parent(ep);
        struct device_node *port __free(device_node) = of_get_parent(ep);
        struct of_endpoint info;
        int i, id;
        int ret;

        /* use driver specified DAI ID if exist */
        ret = snd_soc_get_dai_id(ep);
        if (ret != -ENOTSUPP)
                return ret;

        /* use endpoint/port reg if exist */
        ret = of_graph_parse_endpoint(ep, &info);
        if (ret == 0) {
                /*
                 * Because it will count port/endpoint if it doesn't have "reg".
                 * But, we can't judge whether it has "no reg", or "reg = <0>"
                 * only of_graph_parse_endpoint().
                 * We need to check "reg" property
                 */

                /* check port first */
                ret = of_property_present(port, "reg");
                if (ret)
                        return info.port;

                /* check endpoint 2nd as backup */
                if (of_property_present(ep,   "reg"))
                        return info.id;
        }

        /*
         * Non HDMI sound case, counting port/endpoint on its DT
         * is enough. Let's count it.
         */
        i = 0;
        id = -1;
        for_each_of_graph_port(node, p) {
                if (port == p) {
                        id = i;
                        break;
                }
                i++;
        }

        if (id < 0)
                return -ENODEV;

        return id;
}

int graph_util_parse_dai(struct simple_util_priv *priv, struct device_node *ep,
                         struct snd_soc_dai_link_component *dlc, int *is_single_link)
{
        struct device *dev = simple_priv_to_dev(priv);
        struct device_node *node;
        struct of_phandle_args args = {};
        struct snd_soc_dai *dai;
        int ret;

        if (!ep)
                return 0;

        node = of_graph_get_port_parent(ep);

        /*
         * Try to find from DAI node
         */
        args.np = ep;
        dai = snd_soc_get_dai_via_args(&args);
        if (dai) {
                const char *dai_name = snd_soc_dai_name_get(dai);
                const struct of_phandle_args *dai_args = snd_soc_copy_dai_args(dev, &args);

                ret = -ENOMEM;
                if (!dai_args)
                        goto err;

                dlc->of_node  = node;
                dlc->dai_name = dai_name;
                dlc->dai_args = dai_args;

                goto parse_dai_end;
        }

        /* Get dai->name */
        args.np         = node;
        args.args[0]    = graph_get_dai_id(ep);
        args.args_count = (of_graph_get_endpoint_count(node) > 1);

        /*
         * FIXME
         *
         * Here, dlc->dai_name is pointer to CPU/Codec DAI name.
         * If user unbinded CPU or Codec driver, but not for Sound Card,
         * dlc->dai_name is keeping unbinded CPU or Codec
         * driver's pointer.
         *
         * If user re-bind CPU or Codec driver again, ALSA SoC will try
         * to rebind Card via snd_soc_try_rebind_card(), but because of
         * above reason, it might can't bind Sound Card.
         * Because Sound Card is pointing to released dai_name pointer.
         *
         * To avoid this rebind Card issue,
         * 1) It needs to alloc memory to keep dai_name eventhough
         *    CPU or Codec driver was unbinded, or
         * 2) user need to rebind Sound Card everytime
         *    if he unbinded CPU or Codec.
         */
        ret = snd_soc_get_dlc(&args, dlc);
        if (ret < 0)
                goto err;

parse_dai_end:
        if (is_single_link)
                *is_single_link = of_graph_get_endpoint_count(node) == 1;
        ret = 0;
err:
        if (ret < 0)
                of_node_put(node);

        return simple_ret(priv, ret);
}
EXPORT_SYMBOL_GPL(graph_util_parse_dai);

void graph_util_parse_link_direction(struct device_node *np,
                                    bool *playback_only, bool *capture_only)
{
        bool is_playback_only = of_property_read_bool(np, "playback-only");
        bool is_capture_only  = of_property_read_bool(np, "capture-only");

        if (playback_only && is_playback_only)
                *playback_only = is_playback_only;
        if (capture_only && is_capture_only)
                *capture_only = is_capture_only;
}
EXPORT_SYMBOL_GPL(graph_util_parse_link_direction);

static enum snd_soc_trigger_order
__graph_util_parse_trigger_order(struct simple_util_priv *priv,
                                 struct device_node *np,
                                 const char *prop)
{
        u32 val[SND_SOC_TRIGGER_SIZE];
        int ret;

        ret = of_property_read_u32_array(np, prop, val, SND_SOC_TRIGGER_SIZE);
        if (ret == 0) {
                struct device *dev = simple_priv_to_dev(priv);
                u32 order =     (val[0] << 8) +
                        (val[1] << 4) +
                        (val[2]);

                switch (order) {
                case    (SND_SOC_TRIGGER_LINK           << 8) +
                        (SND_SOC_TRIGGER_COMPONENT      << 4) +
                        (SND_SOC_TRIGGER_DAI):
                        return SND_SOC_TRIGGER_ORDER_DEFAULT;

                case    (SND_SOC_TRIGGER_LINK           << 8) +
                        (SND_SOC_TRIGGER_DAI            << 4) +
                        (SND_SOC_TRIGGER_COMPONENT):
                        return SND_SOC_TRIGGER_ORDER_LDC;

                default:
                        dev_err(dev, "unsupported trigger order [0x%x]\n", order);
                }
        }

        /* SND_SOC_TRIGGER_ORDER_MAX means error */
        return SND_SOC_TRIGGER_ORDER_MAX;
}

void graph_util_parse_trigger_order(struct simple_util_priv *priv,
                                    struct device_node *np,
                                    enum snd_soc_trigger_order *trigger_start,
                                    enum snd_soc_trigger_order *trigger_stop)
{
        static enum snd_soc_trigger_order order;

        /*
         * We can use it like below
         *
         * #include <dt-bindings/sound/audio-graph.h>
         *
         * link-trigger-order = <SND_SOC_TRIGGER_LINK
         *                       SND_SOC_TRIGGER_COMPONENT
         *                       SND_SOC_TRIGGER_DAI>;
         */

        order = __graph_util_parse_trigger_order(priv, np, "link-trigger-order");
        if (order < SND_SOC_TRIGGER_ORDER_MAX) {
                *trigger_start = order;
                *trigger_stop  = order;
        }

        order = __graph_util_parse_trigger_order(priv, np, "link-trigger-order-start");
        if (order < SND_SOC_TRIGGER_ORDER_MAX)
                *trigger_start = order;

        order = __graph_util_parse_trigger_order(priv, np, "link-trigger-order-stop");
        if (order < SND_SOC_TRIGGER_ORDER_MAX)
                *trigger_stop  = order;

        return;
}
EXPORT_SYMBOL_GPL(graph_util_parse_trigger_order);

/* Module information */
MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
MODULE_DESCRIPTION("ALSA SoC Simple Card Utils");
MODULE_LICENSE("GPL v2");