root/sound/soc/intel/boards/bytcr_wm5102.c 
// SPDX-License-Identifier: GPL-2.0-only
/*
 *  bytcr_wm5102.c - ASoc Machine driver for Intel Baytrail platforms with a
 *                   Wolfson Microelectronics WM5102 codec
 *
 *  Copyright (C) 2020 Hans de Goede <hdegoede@redhat.com>
 *  Loosely based on bytcr_rt5640.c which is:
 *  Copyright (C) 2014-2020 Intel Corp
 *  Author: Subhransu S. Prusty <subhransu.s.prusty@intel.com>
 */

#include <linux/acpi.h>
#include <linux/bitfield.h>
#include <linux/clk.h>
#include <linux/device.h>
#include <linux/init.h>
#include <linux/module.h>
#include <linux/moduleparam.h>
#include <linux/platform_data/x86/soc.h>
#include <linux/platform_device.h>
#include <linux/slab.h>
#include <linux/spi/spi.h>
#include <sound/jack.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/soc-acpi.h>
#include "../../codecs/wm5102.h"
#include "../atom/sst-atom-controls.h"

#define WM5102_MAX_SYSCLK_4K    49152000 /* max sysclk for 4K family */
#define WM5102_MAX_SYSCLK_11025 45158400 /* max sysclk for 11.025K family */

struct byt_wm5102_private {
        struct snd_soc_jack jack;
        struct clk *mclk;
        struct gpio_desc *spkvdd_en_gpio;
        int mclk_freq;
};

#define BYT_WM5102_IN_MAP               GENMASK(3, 0)
#define BYT_WM5102_OUT_MAP              GENMASK(7, 4)
#define BYT_WM5102_SSP2                 BIT(16)
#define BYT_WM5102_MCLK_19_2MHZ         BIT(17)

enum {
        BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L,
        BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L,
};

/* Note these values are pre-shifted for easy use of setting quirks */
enum {
        BYT_WM5102_SPK_SPK_MAP          = FIELD_PREP_CONST(BYT_WM5102_OUT_MAP, 0),
        BYT_WM5102_SPK_HPOUT2_MAP       = FIELD_PREP_CONST(BYT_WM5102_OUT_MAP, 1),
};

static unsigned long quirk;

static int quirk_override = -1;
module_param_named(quirk, quirk_override, int, 0444);
MODULE_PARM_DESC(quirk, "Board-specific quirk override");

static void log_quirks(struct device *dev)
{
        switch (quirk & BYT_WM5102_IN_MAP) {
        case BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L:
                dev_info_once(dev, "quirk INTMIC_IN3L_HSMIC_IN1L enabled\n");
                break;
        case BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L:
                dev_info_once(dev, "quirk INTMIC_IN1L_HSMIC_IN2L enabled\n");
                break;
        default:
                dev_warn_once(dev, "quirk sets invalid input map: 0x%lx, defaulting to INTMIC_IN3L_HSMIC_IN1L\n",
                              quirk & BYT_WM5102_IN_MAP);
                quirk &= ~BYT_WM5102_IN_MAP;
                quirk |= BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L;
                break;
        }
        switch (quirk & BYT_WM5102_OUT_MAP) {
        case BYT_WM5102_SPK_SPK_MAP:
                dev_info_once(dev, "quirk SPK_SPK_MAP enabled\n");
                break;
        case BYT_WM5102_SPK_HPOUT2_MAP:
                dev_info_once(dev, "quirk SPK_HPOUT2_MAP enabled\n");
                break;
        default:
                dev_warn_once(dev, "quirk sets invalid output map: 0x%lx, defaulting to SPK_SPK_MAP\n",
                              quirk & BYT_WM5102_OUT_MAP);
                quirk &= ~BYT_WM5102_OUT_MAP;
                quirk |= BYT_WM5102_SPK_SPK_MAP;
                break;
        }
        if (quirk & BYT_WM5102_SSP2)
                dev_info_once(dev, "quirk SSP2 enabled");
        if (quirk & BYT_WM5102_MCLK_19_2MHZ)
                dev_info_once(dev, "quirk MCLK 19.2MHz enabled");
}

static int byt_wm5102_spkvdd_power_event(struct snd_soc_dapm_widget *w,
        struct snd_kcontrol *kcontrol, int event)
{
        struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
        struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);

        gpiod_set_value_cansleep(priv->spkvdd_en_gpio,
                                 !!SND_SOC_DAPM_EVENT_ON(event));

        return 0;
}

static int byt_wm5102_prepare_and_enable_pll1(struct snd_soc_dai *codec_dai, int rate)
{
        struct snd_soc_component *codec_component = codec_dai->component;
        struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(codec_component->card);
        int sr_mult = ((rate % 4000) == 0) ?
                (WM5102_MAX_SYSCLK_4K / rate) :
                (WM5102_MAX_SYSCLK_11025 / rate);
        int ret;

        /* Reset FLL1 */
        snd_soc_dai_set_pll(codec_dai, WM5102_FLL1_REFCLK, ARIZONA_FLL_SRC_NONE, 0, 0);
        snd_soc_dai_set_pll(codec_dai, WM5102_FLL1, ARIZONA_FLL_SRC_NONE, 0, 0);

        /* Configure the FLL1 PLL before selecting it */
        ret = snd_soc_dai_set_pll(codec_dai, WM5102_FLL1, ARIZONA_CLK_SRC_MCLK1,
                                  priv->mclk_freq, rate * sr_mult);
        if (ret) {
                dev_err(codec_component->dev, "Error setting PLL: %d\n", ret);
                return ret;
        }

        ret = snd_soc_component_set_sysclk(codec_component, ARIZONA_CLK_SYSCLK,
                                           ARIZONA_CLK_SRC_FLL1, rate * sr_mult,
                                           SND_SOC_CLOCK_IN);
        if (ret) {
                dev_err(codec_component->dev, "Error setting SYSCLK: %d\n", ret);
                return ret;
        }

        ret = snd_soc_dai_set_sysclk(codec_dai, ARIZONA_CLK_SYSCLK,
                                     rate * 512, SND_SOC_CLOCK_IN);
        if (ret) {
                dev_err(codec_component->dev, "Error setting clock: %d\n", ret);
                return ret;
        }

        return 0;
}

static int platform_clock_control(struct snd_soc_dapm_widget *w,
                                  struct snd_kcontrol *k, int event)
{
        struct snd_soc_card *card = snd_soc_dapm_to_card(w->dapm);
        struct snd_soc_dai *codec_dai;
        struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);
        int ret;

        codec_dai = snd_soc_card_get_codec_dai(card, "wm5102-aif1");
        if (!codec_dai) {
                dev_err(card->dev, "Error codec DAI not found\n");
                return -EIO;
        }

        if (SND_SOC_DAPM_EVENT_ON(event)) {
                ret = clk_prepare_enable(priv->mclk);
                if (ret) {
                        dev_err(card->dev, "Error enabling MCLK: %d\n", ret);
                        return ret;
                }
                ret = byt_wm5102_prepare_and_enable_pll1(codec_dai, 48000);
                if (ret) {
                        dev_err(card->dev, "Error setting codec sysclk: %d\n", ret);
                        return ret;
                }
        } else {
                /*
                 * The WM5102 has a separate 32KHz clock for jack-detect
                 * so we can disable the PLL, followed by disabling the
                 * platform clock which is the source-clock for the PLL.
                 */
                snd_soc_dai_set_pll(codec_dai, WM5102_FLL1, ARIZONA_FLL_SRC_NONE, 0, 0);
                clk_disable_unprepare(priv->mclk);
        }

        return 0;
}

static const struct snd_soc_dapm_widget byt_wm5102_widgets[] = {
        SND_SOC_DAPM_HP("Headphone", NULL),
        SND_SOC_DAPM_MIC("Headset Mic", NULL),
        SND_SOC_DAPM_MIC("Internal Mic", NULL),
        SND_SOC_DAPM_SPK("Speaker", NULL),
        SND_SOC_DAPM_LINE("Line Out", NULL),
        SND_SOC_DAPM_SUPPLY("Platform Clock", SND_SOC_NOPM, 0, 0,
                            platform_clock_control, SND_SOC_DAPM_PRE_PMU |
                            SND_SOC_DAPM_POST_PMD),
        SND_SOC_DAPM_SUPPLY("Speaker VDD", SND_SOC_NOPM, 0, 0,
                            byt_wm5102_spkvdd_power_event,
                            SND_SOC_DAPM_PRE_PMD | SND_SOC_DAPM_POST_PMU),
};

static const struct snd_soc_dapm_route byt_wm5102_audio_map[] = {
        {"Headphone", NULL, "Platform Clock"},
        {"Headset Mic", NULL, "Platform Clock"},
        {"Internal Mic", NULL, "Platform Clock"},
        {"Speaker", NULL, "Platform Clock"},
        {"Speaker", NULL, "Speaker VDD"},

        {"Headphone", NULL, "HPOUT1L"},
        {"Headphone", NULL, "HPOUT1R"},

        /*
         * The Headset Mix uses MICBIAS1 or 2 depending on if a CTIA/OMTP Headset
         * is connected, as the MICBIAS is applied after the CTIA/OMTP cross-switch.
         */
        {"Headset Mic", NULL, "MICBIAS1"},
        {"Headset Mic", NULL, "MICBIAS2"},
        {"Internal Mic", NULL, "MICBIAS3"},
};

static const struct snd_soc_dapm_route bytcr_wm5102_ssp0_map[] = {
        {"AIF1 Playback", NULL, "ssp0 Tx"},
        {"ssp0 Tx", NULL, "modem_out"},
        {"modem_in", NULL, "ssp0 Rx"},
        {"ssp0 Rx", NULL, "AIF1 Capture"},
};

static const struct snd_soc_dapm_route bytcr_wm5102_ssp2_map[] = {
        {"AIF1 Playback", NULL, "ssp2 Tx"},
        {"ssp2 Tx", NULL, "codec_out0"},
        {"ssp2 Tx", NULL, "codec_out1"},
        {"codec_in0", NULL, "ssp2 Rx"},
        {"codec_in1", NULL, "ssp2 Rx"},
        {"ssp2 Rx", NULL, "AIF1 Capture"},
};

static const struct snd_soc_dapm_route byt_wm5102_spk_spk_map[] = {
        {"Speaker", NULL, "SPKOUTLP"},
        {"Speaker", NULL, "SPKOUTLN"},
        {"Speaker", NULL, "SPKOUTRP"},
        {"Speaker", NULL, "SPKOUTRN"},
};

static const struct snd_soc_dapm_route byt_wm5102_spk_hpout2_map[] = {
        {"Speaker", NULL, "HPOUT2L"},
        {"Speaker", NULL, "HPOUT2R"},
};

static const struct snd_soc_dapm_route byt_wm5102_intmic_in3l_hsmic_in1l_map[] = {
        {"IN3L", NULL, "Internal Mic"},
        {"IN1L", NULL, "Headset Mic"},
};

static const struct snd_soc_dapm_route byt_wm5102_intmic_in1l_hsmic_in2l_map[] = {
        {"IN1L", NULL, "Internal Mic"},
        {"IN2L", NULL, "Headset Mic"},
};

static const struct snd_kcontrol_new byt_wm5102_controls[] = {
        SOC_DAPM_PIN_SWITCH("Headphone"),
        SOC_DAPM_PIN_SWITCH("Headset Mic"),
        SOC_DAPM_PIN_SWITCH("Internal Mic"),
        SOC_DAPM_PIN_SWITCH("Speaker"),
        SOC_DAPM_PIN_SWITCH("Line Out"),
};

static struct snd_soc_jack_pin byt_wm5102_pins[] = {
        {
                .pin    = "Headphone",
                .mask   = SND_JACK_HEADPHONE,
        },
        {
                .pin    = "Headset Mic",
                .mask   = SND_JACK_MICROPHONE,
        },
        {
                .pin    = "Line Out",
                .mask   = SND_JACK_LINEOUT,
        },
};

static int byt_wm5102_init(struct snd_soc_pcm_runtime *runtime)
{
        struct snd_soc_card *card = runtime->card;
        struct snd_soc_dapm_context *dapm = snd_soc_card_to_dapm(card);
        struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);
        struct snd_soc_component *component = snd_soc_rtd_to_codec(runtime, 0)->component;
        const struct snd_soc_dapm_route *custom_map = NULL;
        int ret, jack_type, num_routes = 0;

        snd_soc_dapm_set_idle_bias(dapm, false);

        ret = snd_soc_add_card_controls(card, byt_wm5102_controls,
                                        ARRAY_SIZE(byt_wm5102_controls));
        if (ret) {
                dev_err(card->dev, "Error adding card controls: %d\n", ret);
                return ret;
        }

        switch (quirk & BYT_WM5102_IN_MAP) {
        case BYT_WM5102_INTMIC_IN3L_HSMIC_IN1L:
                custom_map = byt_wm5102_intmic_in3l_hsmic_in1l_map;
                num_routes = ARRAY_SIZE(byt_wm5102_intmic_in3l_hsmic_in1l_map);
                break;
        case BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L:
                custom_map = byt_wm5102_intmic_in1l_hsmic_in2l_map;
                num_routes = ARRAY_SIZE(byt_wm5102_intmic_in1l_hsmic_in2l_map);
                break;
        }
        ret = snd_soc_dapm_add_routes(dapm, custom_map, num_routes);
        if (ret)
                return ret;

        switch (quirk & BYT_WM5102_OUT_MAP) {
        case BYT_WM5102_SPK_SPK_MAP:
                custom_map = byt_wm5102_spk_spk_map;
                num_routes = ARRAY_SIZE(byt_wm5102_spk_spk_map);
                break;
        case BYT_WM5102_SPK_HPOUT2_MAP:
                custom_map = byt_wm5102_spk_hpout2_map;
                num_routes = ARRAY_SIZE(byt_wm5102_spk_hpout2_map);
                break;
        }
        ret = snd_soc_dapm_add_routes(dapm, custom_map, num_routes);
        if (ret)
                return ret;

        if (quirk & BYT_WM5102_SSP2) {
                custom_map = bytcr_wm5102_ssp2_map;
                num_routes = ARRAY_SIZE(bytcr_wm5102_ssp2_map);
        } else {
                custom_map = bytcr_wm5102_ssp0_map;
                num_routes = ARRAY_SIZE(bytcr_wm5102_ssp0_map);
        }
        ret = snd_soc_dapm_add_routes(dapm, custom_map, num_routes);
        if (ret)
                return ret;

        if (quirk & BYT_WM5102_MCLK_19_2MHZ)
                priv->mclk_freq = 19200000;
        else
                priv->mclk_freq = 25000000;

        /*
         * The firmware might enable the clock at boot (this information
         * may or may not be reflected in the enable clock register).
         * To change the rate we must disable the clock first to cover these
         * cases. Due to common clock framework restrictions that do not allow
         * to disable a clock that has not been enabled, we need to enable
         * the clock first.
         */
        ret = clk_prepare_enable(priv->mclk);
        if (!ret)
                clk_disable_unprepare(priv->mclk);

        ret = clk_set_rate(priv->mclk, priv->mclk_freq);
        if (ret) {
                dev_err(card->dev, "Error setting MCLK rate: %d\n", ret);
                return ret;
        }

        jack_type = ARIZONA_JACK_MASK | SND_JACK_BTN_0 | SND_JACK_BTN_1 |
                    SND_JACK_BTN_2 | SND_JACK_BTN_3;
        ret = snd_soc_card_jack_new_pins(card, "Headset", jack_type,
                                         &priv->jack, byt_wm5102_pins,
                                         ARRAY_SIZE(byt_wm5102_pins));
        if (ret) {
                dev_err(card->dev, "Error creating jack: %d\n", ret);
                return ret;
        }

        snd_soc_component_set_jack(component, &priv->jack, NULL);

        return 0;
}

static int byt_wm5102_codec_fixup(struct snd_soc_pcm_runtime *rtd,
                                  struct snd_pcm_hw_params *params)
{
        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);
        int ret, bits;

        /* The DSP will convert the FE rate to 48k, stereo */
        rate->min = 48000;
        rate->max = 48000;
        channels->min = 2;
        channels->max = 2;

        if (quirk & BYT_WM5102_SSP2) {
                /* set SSP2 to 24-bit */
                params_set_format(params, SNDRV_PCM_FORMAT_S24_LE);
                bits = 24;
        } else {
                /* set SSP0 to 16-bit */
                params_set_format(params, SNDRV_PCM_FORMAT_S16_LE);
                bits = 16;
        }

        /*
         * Default mode for SSP configuration is TDM 4 slot, override config
         * with explicit setting to I2S 2ch 16-bit. The word length is set with
         * dai_set_tdm_slot() since there is no other API exposed
         */
        ret = snd_soc_dai_set_fmt(snd_soc_rtd_to_cpu(rtd, 0),
                                  SND_SOC_DAIFMT_I2S     |
                                  SND_SOC_DAIFMT_NB_NF   |
                                  SND_SOC_DAIFMT_BP_FP);
        if (ret) {
                dev_err(rtd->dev, "Error setting format to I2S: %d\n", ret);
                return ret;
        }

        ret = snd_soc_dai_set_tdm_slot(snd_soc_rtd_to_cpu(rtd, 0), 0x3, 0x3, 2, bits);
        if (ret) {
                dev_err(rtd->dev, "Error setting I2S config: %d\n", ret);
                return ret;
        }

        return 0;
}

static int byt_wm5102_aif1_startup(struct snd_pcm_substream *substream)
{
        return snd_pcm_hw_constraint_single(substream->runtime,
                                            SNDRV_PCM_HW_PARAM_RATE, 48000);
}

static const struct snd_soc_ops byt_wm5102_aif1_ops = {
        .startup = byt_wm5102_aif1_startup,
};

SND_SOC_DAILINK_DEF(dummy,
        DAILINK_COMP_ARRAY(COMP_DUMMY()));

SND_SOC_DAILINK_DEF(media,
        DAILINK_COMP_ARRAY(COMP_CPU("media-cpu-dai")));

SND_SOC_DAILINK_DEF(deepbuffer,
        DAILINK_COMP_ARRAY(COMP_CPU("deepbuffer-cpu-dai")));

SND_SOC_DAILINK_DEF(ssp0_port,
        DAILINK_COMP_ARRAY(COMP_CPU("ssp0-port")));

SND_SOC_DAILINK_DEF(ssp0_codec,
        DAILINK_COMP_ARRAY(COMP_CODEC(
        /*
         * Note there is no need to overwrite the codec-name as is done in
         * other bytcr machine drivers, because the codec is a MFD child-dev.
         */
        "wm5102-codec",
        "wm5102-aif1")));

SND_SOC_DAILINK_DEF(platform,
        DAILINK_COMP_ARRAY(COMP_PLATFORM("sst-mfld-platform")));

static struct snd_soc_dai_link byt_wm5102_dais[] = {
        [MERR_DPCM_AUDIO] = {
                .name = "Baytrail Audio Port",
                .stream_name = "Baytrail Audio",
                .nonatomic = true,
                .dynamic = 1,
                .ops = &byt_wm5102_aif1_ops,
                SND_SOC_DAILINK_REG(media, dummy, platform),

        },
        [MERR_DPCM_DEEP_BUFFER] = {
                .name = "Deep-Buffer Audio Port",
                .stream_name = "Deep-Buffer Audio",
                .nonatomic = true,
                .dynamic = 1,
                .playback_only = 1,
                .ops = &byt_wm5102_aif1_ops,
                SND_SOC_DAILINK_REG(deepbuffer, dummy, platform),
        },
                /* back ends */
        {
                /*
                 * This dailink is updated dynamically to point to SSP0 or SSP2.
                 * Yet its name is always kept as "SSP2-Codec" because the SOF
                 * tplg files hardcode "SSP2-Codec" even in byt-foo-ssp0.tplg.
                 */
                .name = "SSP2-Codec",
                .id = 0,
                .no_pcm = 1,
                .dai_fmt = SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_NB_NF
                                                | SND_SOC_DAIFMT_CBC_CFC,
                .be_hw_params_fixup = byt_wm5102_codec_fixup,
                .init = byt_wm5102_init,
                SND_SOC_DAILINK_REG(ssp0_port, ssp0_codec, platform),
        },
};

/* use space before codec name to simplify card ID, and simplify driver name */
#define SOF_CARD_NAME "bytcht wm5102" /* card name will be 'sof-bytcht wm5102' */
#define SOF_DRIVER_NAME "SOF"

#define CARD_NAME "bytcr-wm5102"
#define DRIVER_NAME NULL /* card name will be used for driver name */

/* SoC card */
static struct snd_soc_card byt_wm5102_card = {
        .owner = THIS_MODULE,
        .dai_link = byt_wm5102_dais,
        .num_links = ARRAY_SIZE(byt_wm5102_dais),
        .dapm_widgets = byt_wm5102_widgets,
        .num_dapm_widgets = ARRAY_SIZE(byt_wm5102_widgets),
        .dapm_routes = byt_wm5102_audio_map,
        .num_dapm_routes = ARRAY_SIZE(byt_wm5102_audio_map),
        .fully_routed = true,
};

static char byt_wm5102_components[64]; /* = "cfg-spk:* cfg-int-mic:* cfg-hs-mic:* ..." */

static int snd_byt_wm5102_mc_probe(struct platform_device *pdev)
{
        static const char * const out_map_name[] = { "spk", "hpout2" };
        static const char * const intmic_map_name[] = { "in3l", "in1l" };
        static const char * const hsmic_map_name[] = { "in1l", "in2l" };
        char codec_name[SND_ACPI_I2C_ID_LEN];
        struct device *dev = &pdev->dev;
        struct byt_wm5102_private *priv;
        struct snd_soc_acpi_mach *mach;
        const char *platform_name;
        struct acpi_device *adev;
        struct device *codec_dev;
        int dai_index = 0;
        bool sof_parent;
        int i, ret;

        priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
        if (!priv)
                return -ENOMEM;

        /* Get MCLK */
        priv->mclk = devm_clk_get(dev, "pmc_plt_clk_3");
        if (IS_ERR(priv->mclk))
                return dev_err_probe(dev, PTR_ERR(priv->mclk), "getting pmc_plt_clk_3\n");

        /*
         * Get speaker VDD enable GPIO:
         * 1. Get codec-device-name
         * 2. Get codec-device
         * 3. Get GPIO from codec-device
         */
        mach = dev->platform_data;
        adev = acpi_dev_get_first_match_dev(mach->id, NULL, -1);
        if (adev) {
                snprintf(codec_name, sizeof(codec_name), "spi-%s", acpi_dev_name(adev));
                acpi_dev_put(adev);
        } else {
                /* Special case for when the codec is missing from the DSTD */
                strscpy(codec_name, "spi-wm5102", sizeof(codec_name));
        }

        codec_dev = bus_find_device_by_name(&spi_bus_type, NULL, codec_name);
        if (!codec_dev)
                return -EPROBE_DEFER;

        /* Note no devm_ here since we call gpiod_get on codec_dev rather then dev */
        priv->spkvdd_en_gpio = gpiod_get(codec_dev, "wlf,spkvdd-ena", GPIOD_OUT_LOW);
        put_device(codec_dev);

        if (IS_ERR(priv->spkvdd_en_gpio)) {
                ret = PTR_ERR(priv->spkvdd_en_gpio);
                /*
                 * The spkvdd gpio-lookup is registered by: drivers/mfd/arizona-spi.c,
                 * so -ENOENT means that arizona-spi hasn't probed yet.
                 */
                if (ret == -ENOENT)
                        ret = -EPROBE_DEFER;

                return dev_err_probe(dev, ret, "getting spkvdd-GPIO\n");
        }

        if (soc_intel_is_cht()) {
                /*
                 * CHT always uses SSP2 and 19.2 MHz; and
                 * the one currently supported CHT design uses HPOUT2 as
                 * speaker output and has the intmic on IN1L + hsmic on IN2L.
                 */
                quirk = BYT_WM5102_SSP2 | BYT_WM5102_MCLK_19_2MHZ |
                        BYT_WM5102_INTMIC_IN1L_HSMIC_IN2L |
                        BYT_WM5102_SPK_HPOUT2_MAP;
        }
        if (quirk_override != -1) {
                dev_info_once(dev, "Overriding quirk 0x%lx => 0x%x\n",
                              quirk, quirk_override);
                quirk = quirk_override;
        }
        log_quirks(dev);

        snprintf(byt_wm5102_components, sizeof(byt_wm5102_components),
                 "cfg-spk:%s cfg-intmic:%s cfg-hsmic:%s",
                 out_map_name[FIELD_GET(BYT_WM5102_OUT_MAP, quirk)],
                 intmic_map_name[FIELD_GET(BYT_WM5102_IN_MAP, quirk)],
                 hsmic_map_name[FIELD_GET(BYT_WM5102_IN_MAP, quirk)]);
        byt_wm5102_card.components = byt_wm5102_components;

        /* find index of codec dai */
        for (i = 0; i < ARRAY_SIZE(byt_wm5102_dais); i++) {
                if (byt_wm5102_dais[i].num_codecs &&
                    !strcmp(byt_wm5102_dais[i].codecs->name,
                            "wm5102-codec")) {
                        dai_index = i;
                        break;
                }
        }

        /* override platform name, if required */
        byt_wm5102_card.dev = dev;
        platform_name = mach->mach_params.platform;
        ret = snd_soc_fixup_dai_links_platform_name(&byt_wm5102_card, platform_name);
        if (ret)
                goto out_put_gpio;

        /* override SSP port, if required */
        if (quirk & BYT_WM5102_SSP2)
                byt_wm5102_dais[dai_index].cpus->dai_name = "ssp2-port";

        /* set card and driver name and pm-ops */
        sof_parent = snd_soc_acpi_sof_parent(dev);
        if (sof_parent) {
                byt_wm5102_card.name = SOF_CARD_NAME;
                byt_wm5102_card.driver_name = SOF_DRIVER_NAME;
                dev->driver->pm = &snd_soc_pm_ops;
        } else {
                byt_wm5102_card.name = CARD_NAME;
                byt_wm5102_card.driver_name = DRIVER_NAME;
        }

        snd_soc_card_set_drvdata(&byt_wm5102_card, priv);
        ret = devm_snd_soc_register_card(dev, &byt_wm5102_card);
        if (ret) {
                dev_err_probe(dev, ret, "registering card\n");
                goto out_put_gpio;
        }

        platform_set_drvdata(pdev, &byt_wm5102_card);
        return 0;

out_put_gpio:
        gpiod_put(priv->spkvdd_en_gpio);
        return ret;
}

static void snd_byt_wm5102_mc_remove(struct platform_device *pdev)
{
        struct snd_soc_card *card = platform_get_drvdata(pdev);
        struct byt_wm5102_private *priv = snd_soc_card_get_drvdata(card);

        gpiod_put(priv->spkvdd_en_gpio);
}

static struct platform_driver snd_byt_wm5102_mc_driver = {
        .driver = {
                .name = "bytcr_wm5102",
        },
        .probe = snd_byt_wm5102_mc_probe,
        .remove = snd_byt_wm5102_mc_remove,
};

module_platform_driver(snd_byt_wm5102_mc_driver);

MODULE_DESCRIPTION("ASoC Baytrail with WM5102 codec machine driver");
MODULE_AUTHOR("Hans de Goede <hdegoede@redhat.com>");
MODULE_LICENSE("GPL v2");
MODULE_ALIAS("platform:bytcr_wm5102");