// SPDX-License-Identifier: GPL-2.0-only
/*
 * es8316.c -- es8316 ALSA SoC audio driver
 * Copyright Everest Semiconductor Co.,Ltd
 *
 * Authors: David Yang <yangxiaohua@everest-semi.com>,
 *          Daniel Drake <drake@endlessm.com>
 */

#include <linux/module.h>
#include <linux/acpi.h>
#include <linux/clk.h>
#include <linux/delay.h>
#include <linux/i2c.h>
#include <linux/mutex.h>
#include <linux/regmap.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/soc.h>
#include <sound/soc-dapm.h>
#include <sound/tlv.h>
#include <sound/jack.h>
#include "es8316.h"

/* In slave mode at single speed, the codec is documented as accepting 5
 * MCLK/LRCK ratios, but we also add ratio 400, which is commonly used on
 * Intel Cherry Trail platforms (19.2MHz MCLK, 48kHz LRCK).
 */
static const unsigned int supported_mclk_lrck_ratios[] = {
        256, 384, 400, 500, 512, 768, 1024
};

struct es8316_priv {
        struct mutex lock;
        struct clk *mclk;
        struct regmap *regmap;
        struct snd_soc_component *component;
        struct snd_soc_jack *jack;
        int irq;
        unsigned int sysclk;
        /* ES83xx supports halving the MCLK so it supports twice as many rates
         */
        unsigned int allowed_rates[ARRAY_SIZE(supported_mclk_lrck_ratios) * 2];
        struct snd_pcm_hw_constraint_list sysclk_constraints;
        bool jd_inverted;
};

/*
 * ES8316 controls
 */
static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(dac_vol_tlv, -9600, 50, 1);
static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(adc_vol_tlv, -9600, 50, 1);
static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(alc_max_gain_tlv, -650, 150, 0);
static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(alc_min_gain_tlv, -1200, 150, 0);

static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(alc_target_tlv,
        0, 10, TLV_DB_SCALE_ITEM(-1650, 150, 0),
        11, 11, TLV_DB_SCALE_ITEM(-150, 0, 0),
);

static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(hpmixer_gain_tlv,
        0, 4, TLV_DB_SCALE_ITEM(-1200, 150, 0),
        8, 11, TLV_DB_SCALE_ITEM(-450, 150, 0),
);

static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(adc_pga_gain_tlv,
        0, 0, TLV_DB_SCALE_ITEM(-350, 0, 0),
        1, 1, TLV_DB_SCALE_ITEM(0, 0, 0),
        2, 2, TLV_DB_SCALE_ITEM(250, 0, 0),
        3, 3, TLV_DB_SCALE_ITEM(450, 0, 0),
        4, 7, TLV_DB_SCALE_ITEM(700, 300, 0),
        8, 10, TLV_DB_SCALE_ITEM(1800, 300, 0),
);

static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(hpout_vol_tlv,
        0, 0, TLV_DB_SCALE_ITEM(-4800, 0, 0),
        1, 3, TLV_DB_SCALE_ITEM(-2400, 1200, 0),
);

static const char * const ng_type_txt[] =
        { "Constant PGA Gain", "Mute ADC Output" };
static const struct soc_enum ng_type =
        SOC_ENUM_SINGLE(ES8316_ADC_ALC_NG, 6, 2, ng_type_txt);

static const char * const adcpol_txt[] = { "Normal", "Invert" };
static const struct soc_enum adcpol =
        SOC_ENUM_SINGLE(ES8316_ADC_MUTE, 1, 2, adcpol_txt);
static const char *const dacpol_txt[] =
        { "Normal", "R Invert", "L Invert", "L + R Invert" };
static const struct soc_enum dacpol =
        SOC_ENUM_SINGLE(ES8316_DAC_SET1, 0, 4, dacpol_txt);

static const struct snd_kcontrol_new es8316_snd_controls[] = {
        SOC_DOUBLE_TLV("Headphone Playback Volume", ES8316_CPHP_ICAL_VOL,
                       4, 0, 3, 1, hpout_vol_tlv),
        SOC_DOUBLE_TLV("Headphone Mixer Volume", ES8316_HPMIX_VOL,
                       4, 0, 11, 0, hpmixer_gain_tlv),

        SOC_ENUM("Playback Polarity", dacpol),
        SOC_DOUBLE_R_TLV("DAC Playback Volume", ES8316_DAC_VOLL,
                         ES8316_DAC_VOLR, 0, 0xc0, 1, dac_vol_tlv),
        SOC_SINGLE("DAC Soft Ramp Switch", ES8316_DAC_SET1, 4, 1, 1),
        SOC_SINGLE("DAC Soft Ramp Rate", ES8316_DAC_SET1, 2, 3, 0),
        SOC_SINGLE("DAC Notch Filter Switch", ES8316_DAC_SET2, 6, 1, 0),
        SOC_SINGLE("DAC Double Fs Switch", ES8316_DAC_SET2, 7, 1, 0),
        SOC_SINGLE("DAC Stereo Enhancement", ES8316_DAC_SET3, 0, 7, 0),
        SOC_SINGLE("DAC Mono Mix Switch", ES8316_DAC_SET3, 3, 1, 0),

        SOC_ENUM("Capture Polarity", adcpol),
        SOC_SINGLE("Mic Boost Switch", ES8316_ADC_D2SEPGA, 0, 1, 0),
        SOC_SINGLE_TLV("ADC Capture Volume", ES8316_ADC_VOLUME,
                       0, 0xc0, 1, adc_vol_tlv),
        SOC_SINGLE_TLV("ADC PGA Gain Volume", ES8316_ADC_PGAGAIN,
                       4, 10, 0, adc_pga_gain_tlv),
        SOC_SINGLE("ADC Soft Ramp Switch", ES8316_ADC_MUTE, 4, 1, 0),
        SOC_SINGLE("ADC Double Fs Switch", ES8316_ADC_DMIC, 4, 1, 0),

        SOC_SINGLE("ALC Capture Switch", ES8316_ADC_ALC1, 6, 1, 0),
        SOC_SINGLE_TLV("ALC Capture Max Volume", ES8316_ADC_ALC1, 0, 28, 0,
                       alc_max_gain_tlv),
        SOC_SINGLE_TLV("ALC Capture Min Volume", ES8316_ADC_ALC2, 0, 28, 0,
                       alc_min_gain_tlv),
        SOC_SINGLE_TLV("ALC Capture Target Volume", ES8316_ADC_ALC3, 4, 11, 0,
                       alc_target_tlv),
        SOC_SINGLE("ALC Capture Hold Time", ES8316_ADC_ALC3, 0, 10, 0),
        SOC_SINGLE("ALC Capture Decay Time", ES8316_ADC_ALC4, 4, 10, 0),
        SOC_SINGLE("ALC Capture Attack Time", ES8316_ADC_ALC4, 0, 10, 0),
        SOC_SINGLE("ALC Capture Noise Gate Switch", ES8316_ADC_ALC_NG,
                   5, 1, 0),
        SOC_SINGLE("ALC Capture Noise Gate Threshold", ES8316_ADC_ALC_NG,
                   0, 31, 0),
        SOC_ENUM("ALC Capture Noise Gate Type", ng_type),
};

/* Analog Input Mux */
static const char * const es8316_analog_in_txt[] = {
                "lin1-rin1",
                "lin2-rin2",
                "lin1-rin1 with 20db Boost",
                "lin2-rin2 with 20db Boost"
};
static const unsigned int es8316_analog_in_values[] = { 0, 1, 2, 3 };
static const struct soc_enum es8316_analog_input_enum =
        SOC_VALUE_ENUM_SINGLE(ES8316_ADC_PDN_LINSEL, 4, 3,
                              ARRAY_SIZE(es8316_analog_in_txt),
                              es8316_analog_in_txt,
                              es8316_analog_in_values);
static const struct snd_kcontrol_new es8316_analog_in_mux_controls =
        SOC_DAPM_ENUM("Route", es8316_analog_input_enum);

static const char * const es8316_dmic_txt[] = {
                "dmic disable",
                "dmic data at high level",
                "dmic data at low level",
};
static const unsigned int es8316_dmic_values[] = { 0, 2, 3 };
static const struct soc_enum es8316_dmic_src_enum =
        SOC_VALUE_ENUM_SINGLE(ES8316_ADC_DMIC, 0, 3,
                              ARRAY_SIZE(es8316_dmic_txt),
                              es8316_dmic_txt,
                              es8316_dmic_values);
static const struct snd_kcontrol_new es8316_dmic_src_controls =
        SOC_DAPM_ENUM("Route", es8316_dmic_src_enum);

/* hp mixer mux */
static const char * const es8316_hpmux_texts[] = {
        "lin1-rin1",
        "lin2-rin2",
        "lin-rin with Boost",
        "lin-rin with Boost and PGA"
};

static SOC_ENUM_SINGLE_DECL(es8316_left_hpmux_enum, ES8316_HPMIX_SEL,
        4, es8316_hpmux_texts);

static const struct snd_kcontrol_new es8316_left_hpmux_controls =
        SOC_DAPM_ENUM("Route", es8316_left_hpmux_enum);

static SOC_ENUM_SINGLE_DECL(es8316_right_hpmux_enum, ES8316_HPMIX_SEL,
        0, es8316_hpmux_texts);

static const struct snd_kcontrol_new es8316_right_hpmux_controls =
        SOC_DAPM_ENUM("Route", es8316_right_hpmux_enum);

/* headphone Output Mixer */
static const struct snd_kcontrol_new es8316_out_left_mix[] = {
        SOC_DAPM_SINGLE("LLIN Switch", ES8316_HPMIX_SWITCH, 6, 1, 0),
        SOC_DAPM_SINGLE("Left DAC Switch", ES8316_HPMIX_SWITCH, 7, 1, 0),
};
static const struct snd_kcontrol_new es8316_out_right_mix[] = {
        SOC_DAPM_SINGLE("RLIN Switch", ES8316_HPMIX_SWITCH, 2, 1, 0),
        SOC_DAPM_SINGLE("Right DAC Switch", ES8316_HPMIX_SWITCH, 3, 1, 0),
};

/* DAC data source mux */
static const char * const es8316_dacsrc_texts[] = {
        "LDATA TO LDAC, RDATA TO RDAC",
        "LDATA TO LDAC, LDATA TO RDAC",
        "RDATA TO LDAC, RDATA TO RDAC",
        "RDATA TO LDAC, LDATA TO RDAC",
};

static SOC_ENUM_SINGLE_DECL(es8316_dacsrc_mux_enum, ES8316_DAC_SET1,
        6, es8316_dacsrc_texts);

static const struct snd_kcontrol_new es8316_dacsrc_mux_controls =
        SOC_DAPM_ENUM("Route", es8316_dacsrc_mux_enum);

static const struct snd_soc_dapm_widget es8316_dapm_widgets[] = {
        SND_SOC_DAPM_SUPPLY("Bias", ES8316_SYS_PDN, 3, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("Analog power", ES8316_SYS_PDN, 4, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("Mic Bias", ES8316_SYS_PDN, 5, 1, NULL, 0),

        SND_SOC_DAPM_INPUT("DMIC"),
        SND_SOC_DAPM_INPUT("MIC1"),
        SND_SOC_DAPM_INPUT("MIC2"),

        /* Input Mux */
        SND_SOC_DAPM_MUX("Differential Mux", SND_SOC_NOPM, 0, 0,
                         &es8316_analog_in_mux_controls),

        SND_SOC_DAPM_SUPPLY("ADC Vref", ES8316_SYS_PDN, 1, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("ADC bias", ES8316_SYS_PDN, 2, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("ADC Clock", ES8316_CLKMGR_CLKSW, 3, 0, NULL, 0),
        SND_SOC_DAPM_PGA("Line input PGA", ES8316_ADC_PDN_LINSEL,
                         7, 1, NULL, 0),
        SND_SOC_DAPM_ADC("Mono ADC", NULL, ES8316_ADC_PDN_LINSEL, 6, 1),
        SND_SOC_DAPM_MUX("Digital Mic Mux", SND_SOC_NOPM, 0, 0,
                         &es8316_dmic_src_controls),

        /* Digital Interface */
        SND_SOC_DAPM_AIF_OUT("I2S OUT", "I2S1 Capture",  1,
                             ES8316_SERDATA_ADC, 6, 1),
        SND_SOC_DAPM_AIF_IN("I2S IN", "I2S1 Playback", 0,
                            SND_SOC_NOPM, 0, 0),

        SND_SOC_DAPM_MUX("DAC Source Mux", SND_SOC_NOPM, 0, 0,
                         &es8316_dacsrc_mux_controls),

        SND_SOC_DAPM_SUPPLY("DAC Vref", ES8316_SYS_PDN, 0, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("DAC Clock", ES8316_CLKMGR_CLKSW, 2, 0, NULL, 0),
        SND_SOC_DAPM_DAC("Right DAC", NULL, ES8316_DAC_PDN, 0, 1),
        SND_SOC_DAPM_DAC("Left DAC", NULL, ES8316_DAC_PDN, 4, 1),

        /* Headphone Output Side */
        SND_SOC_DAPM_MUX("Left Headphone Mux", SND_SOC_NOPM, 0, 0,
                         &es8316_left_hpmux_controls),
        SND_SOC_DAPM_MUX("Right Headphone Mux", SND_SOC_NOPM, 0, 0,
                         &es8316_right_hpmux_controls),
        SND_SOC_DAPM_MIXER("Left Headphone Mixer", ES8316_HPMIX_PDN,
                           5, 1, &es8316_out_left_mix[0],
                           ARRAY_SIZE(es8316_out_left_mix)),
        SND_SOC_DAPM_MIXER("Right Headphone Mixer", ES8316_HPMIX_PDN,
                           1, 1, &es8316_out_right_mix[0],
                           ARRAY_SIZE(es8316_out_right_mix)),
        SND_SOC_DAPM_PGA("Left Headphone Mixer Out", ES8316_HPMIX_PDN,
                         4, 1, NULL, 0),
        SND_SOC_DAPM_PGA("Right Headphone Mixer Out", ES8316_HPMIX_PDN,
                         0, 1, NULL, 0),

        SND_SOC_DAPM_OUT_DRV("Left Headphone Charge Pump", ES8316_CPHP_OUTEN,
                             6, 0, NULL, 0),
        SND_SOC_DAPM_OUT_DRV("Right Headphone Charge Pump", ES8316_CPHP_OUTEN,
                             2, 0, NULL, 0),
        SND_SOC_DAPM_SUPPLY("Headphone Charge Pump", ES8316_CPHP_PDN2,
                            5, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("Headphone Charge Pump Clock", ES8316_CLKMGR_CLKSW,
                            4, 0, NULL, 0),

        SND_SOC_DAPM_OUT_DRV("Left Headphone Driver", ES8316_CPHP_OUTEN,
                             5, 0, NULL, 0),
        SND_SOC_DAPM_OUT_DRV("Right Headphone Driver", ES8316_CPHP_OUTEN,
                             1, 0, NULL, 0),
        SND_SOC_DAPM_SUPPLY("Headphone Out", ES8316_CPHP_PDN1, 2, 1, NULL, 0),

        /* pdn_Lical and pdn_Rical bits are documented as Reserved, but must
         * be explicitly unset in order to enable HP output
         */
        SND_SOC_DAPM_SUPPLY("Left Headphone ical", ES8316_CPHP_ICAL_VOL,
                            7, 1, NULL, 0),
        SND_SOC_DAPM_SUPPLY("Right Headphone ical", ES8316_CPHP_ICAL_VOL,
                            3, 1, NULL, 0),

        SND_SOC_DAPM_OUTPUT("HPOL"),
        SND_SOC_DAPM_OUTPUT("HPOR"),
};

static const struct snd_soc_dapm_route es8316_dapm_routes[] = {
        /* Recording */
        {"MIC1", NULL, "Mic Bias"},
        {"MIC2", NULL, "Mic Bias"},
        {"MIC1", NULL, "Bias"},
        {"MIC2", NULL, "Bias"},
        {"MIC1", NULL, "Analog power"},
        {"MIC2", NULL, "Analog power"},

        {"Differential Mux", "lin1-rin1", "MIC1"},
        {"Differential Mux", "lin2-rin2", "MIC2"},
        {"Line input PGA", NULL, "Differential Mux"},

        {"Mono ADC", NULL, "ADC Clock"},
        {"Mono ADC", NULL, "ADC Vref"},
        {"Mono ADC", NULL, "ADC bias"},
        {"Mono ADC", NULL, "Line input PGA"},

        /* It's not clear why, but to avoid recording only silence,
         * the DAC clock must be running for the ADC to work.
         */
        {"Mono ADC", NULL, "DAC Clock"},

        {"Digital Mic Mux", "dmic disable", "Mono ADC"},

        {"I2S OUT", NULL, "Digital Mic Mux"},

        /* Playback */
        {"DAC Source Mux", "LDATA TO LDAC, RDATA TO RDAC", "I2S IN"},

        {"Left DAC", NULL, "DAC Clock"},
        {"Right DAC", NULL, "DAC Clock"},

        {"Left DAC", NULL, "DAC Vref"},
        {"Right DAC", NULL, "DAC Vref"},

        {"Left DAC", NULL, "DAC Source Mux"},
        {"Right DAC", NULL, "DAC Source Mux"},

        {"Left Headphone Mux", "lin-rin with Boost and PGA", "Line input PGA"},
        {"Right Headphone Mux", "lin-rin with Boost and PGA", "Line input PGA"},

        {"Left Headphone Mixer", "LLIN Switch", "Left Headphone Mux"},
        {"Left Headphone Mixer", "Left DAC Switch", "Left DAC"},

        {"Right Headphone Mixer", "RLIN Switch", "Right Headphone Mux"},
        {"Right Headphone Mixer", "Right DAC Switch", "Right DAC"},

        {"Left Headphone Mixer Out", NULL, "Left Headphone Mixer"},
        {"Right Headphone Mixer Out", NULL, "Right Headphone Mixer"},

        {"Left Headphone Charge Pump", NULL, "Left Headphone Mixer Out"},
        {"Right Headphone Charge Pump", NULL, "Right Headphone Mixer Out"},

        {"Left Headphone Charge Pump", NULL, "Headphone Charge Pump"},
        {"Right Headphone Charge Pump", NULL, "Headphone Charge Pump"},

        {"Left Headphone Charge Pump", NULL, "Headphone Charge Pump Clock"},
        {"Right Headphone Charge Pump", NULL, "Headphone Charge Pump Clock"},

        {"Left Headphone Driver", NULL, "Left Headphone Charge Pump"},
        {"Right Headphone Driver", NULL, "Right Headphone Charge Pump"},

        {"HPOL", NULL, "Left Headphone Driver"},
        {"HPOR", NULL, "Right Headphone Driver"},

        {"HPOL", NULL, "Left Headphone ical"},
        {"HPOR", NULL, "Right Headphone ical"},

        {"Headphone Out", NULL, "Bias"},
        {"Headphone Out", NULL, "Analog power"},
        {"HPOL", NULL, "Headphone Out"},
        {"HPOR", NULL, "Headphone Out"},
};

static int es8316_set_dai_sysclk(struct snd_soc_dai *codec_dai,
                                 int clk_id, unsigned int freq, int dir)
{
        struct snd_soc_component *component = codec_dai->component;
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
        int i, ret;
        int count = 0;

        es8316->sysclk = freq;
        es8316->sysclk_constraints.list = NULL;
        es8316->sysclk_constraints.count = 0;

        if (freq == 0)
                return 0;

        ret = clk_set_rate(es8316->mclk, freq);
        if (ret)
                return ret;

        /* Limit supported sample rates to ones that can be autodetected
         * by the codec running in slave mode.
         */
        for (i = 0; i < ARRAY_SIZE(supported_mclk_lrck_ratios); i++) {
                const unsigned int ratio = supported_mclk_lrck_ratios[i];

                if (freq % ratio == 0)
                        es8316->allowed_rates[count++] = freq / ratio;

                /* We also check if the halved MCLK produces a valid rate
                 * since the codec supports halving the MCLK.
                 */
                if ((freq / ratio) % 2 == 0)
                        es8316->allowed_rates[count++] = freq / ratio / 2;
        }

        if (count) {
                es8316->sysclk_constraints.list = es8316->allowed_rates;
                es8316->sysclk_constraints.count = count;
        }

        return 0;
}

static int es8316_set_dai_fmt(struct snd_soc_dai *codec_dai,
                              unsigned int fmt)
{
        struct snd_soc_component *component = codec_dai->component;
        u8 serdata1 = 0;
        u8 serdata2 = 0;
        u8 clksw;
        u8 mask;

        if ((fmt & SND_SOC_DAIFMT_MASTER_MASK) == SND_SOC_DAIFMT_CBP_CFP)
                serdata1 |= ES8316_SERDATA1_MASTER;

        if ((fmt & SND_SOC_DAIFMT_FORMAT_MASK) != SND_SOC_DAIFMT_I2S) {
                dev_err(component->dev, "Codec driver only supports I2S format\n");
                return -EINVAL;
        }

        /* Clock inversion */
        switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
        case SND_SOC_DAIFMT_NB_NF:
                break;
        case SND_SOC_DAIFMT_IB_IF:
                serdata1 |= ES8316_SERDATA1_BCLK_INV;
                serdata2 |= ES8316_SERDATA2_ADCLRP;
                break;
        case SND_SOC_DAIFMT_IB_NF:
                serdata1 |= ES8316_SERDATA1_BCLK_INV;
                break;
        case SND_SOC_DAIFMT_NB_IF:
                serdata2 |= ES8316_SERDATA2_ADCLRP;
                break;
        default:
                return -EINVAL;
        }

        mask = ES8316_SERDATA1_MASTER | ES8316_SERDATA1_BCLK_INV;
        snd_soc_component_update_bits(component, ES8316_SERDATA1, mask, serdata1);

        mask = ES8316_SERDATA2_FMT_MASK | ES8316_SERDATA2_ADCLRP;
        snd_soc_component_update_bits(component, ES8316_SERDATA_ADC, mask, serdata2);
        snd_soc_component_update_bits(component, ES8316_SERDATA_DAC, mask, serdata2);

        /* Enable BCLK and MCLK inputs in slave mode */
        clksw = ES8316_CLKMGR_CLKSW_MCLK_ON | ES8316_CLKMGR_CLKSW_BCLK_ON;
        snd_soc_component_update_bits(component, ES8316_CLKMGR_CLKSW, clksw, clksw);

        return 0;
}

static int es8316_pcm_startup(struct snd_pcm_substream *substream,
                              struct snd_soc_dai *dai)
{
        struct snd_soc_component *component = dai->component;
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);

        if (es8316->sysclk_constraints.list)
                snd_pcm_hw_constraint_list(substream->runtime, 0,
                                           SNDRV_PCM_HW_PARAM_RATE,
                                           &es8316->sysclk_constraints);

        return 0;
}

static int es8316_pcm_hw_params(struct snd_pcm_substream *substream,
                                struct snd_pcm_hw_params *params,
                                struct snd_soc_dai *dai)
{
        struct snd_soc_component *component = dai->component;
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
        u8 wordlen = 0;
        u8 bclk_divider;
        u16 lrck_divider;
        int i;
        unsigned int clk = es8316->sysclk / 2;
        bool clk_valid = false;

        /* We will start with halved sysclk and see if we can use it
         * for proper clocking. This is to minimise the risk of running
         * the CODEC with a too high frequency. We have an SKU where
         * the sysclk frequency is 48Mhz and this causes the sound to be
         * sped up. If we can run with a halved sysclk, we will use it,
         * if we can't use it, then full sysclk will be used.
         */
        do {
                /* Validate supported sample rates that are autodetected from MCLK */
                for (i = 0; i < ARRAY_SIZE(supported_mclk_lrck_ratios); i++) {
                        const unsigned int ratio = supported_mclk_lrck_ratios[i];

                        if (clk % ratio != 0)
                                continue;
                        if (clk / ratio == params_rate(params))
                                break;
                }
                if (i == ARRAY_SIZE(supported_mclk_lrck_ratios)) {
                        if (clk == es8316->sysclk)
                                return -EINVAL;
                        clk = es8316->sysclk;
                } else {
                        clk_valid = true;
                }
        } while (!clk_valid);

        if (clk != es8316->sysclk) {
                snd_soc_component_update_bits(component, ES8316_CLKMGR_CLKSW,
                                              ES8316_CLKMGR_CLKSW_MCLK_DIV,
                                              ES8316_CLKMGR_CLKSW_MCLK_DIV);
        }

        lrck_divider = clk / params_rate(params);
        bclk_divider = lrck_divider / 4;
        switch (params_format(params)) {
        case SNDRV_PCM_FORMAT_S16_LE:
                wordlen = ES8316_SERDATA2_LEN_16;
                bclk_divider /= 16;
                break;
        case SNDRV_PCM_FORMAT_S20_3LE:
                wordlen = ES8316_SERDATA2_LEN_20;
                bclk_divider /= 20;
                break;
        case SNDRV_PCM_FORMAT_S24_LE:
        case SNDRV_PCM_FORMAT_S24_3LE:
                wordlen = ES8316_SERDATA2_LEN_24;
                bclk_divider /= 24;
                break;
        case SNDRV_PCM_FORMAT_S32_LE:
                wordlen = ES8316_SERDATA2_LEN_32;
                bclk_divider /= 32;
                break;
        default:
                return -EINVAL;
        }

        snd_soc_component_update_bits(component, ES8316_SERDATA_DAC,
                            ES8316_SERDATA2_LEN_MASK, wordlen);
        snd_soc_component_update_bits(component, ES8316_SERDATA_ADC,
                            ES8316_SERDATA2_LEN_MASK, wordlen);
        snd_soc_component_update_bits(component, ES8316_SERDATA1, 0x1f, bclk_divider);
        snd_soc_component_update_bits(component, ES8316_CLKMGR_ADCDIV1, 0x0f, lrck_divider >> 8);
        snd_soc_component_update_bits(component, ES8316_CLKMGR_ADCDIV2, 0xff, lrck_divider & 0xff);
        snd_soc_component_update_bits(component, ES8316_CLKMGR_DACDIV1, 0x0f, lrck_divider >> 8);
        snd_soc_component_update_bits(component, ES8316_CLKMGR_DACDIV2, 0xff, lrck_divider & 0xff);
        return 0;
}

static int es8316_mute(struct snd_soc_dai *dai, int mute, int direction)
{
        snd_soc_component_update_bits(dai->component, ES8316_DAC_SET1, 0x20,
                            mute ? 0x20 : 0);
        return 0;
}

#define ES8316_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
                        SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)

static const struct snd_soc_dai_ops es8316_ops = {
        .startup = es8316_pcm_startup,
        .hw_params = es8316_pcm_hw_params,
        .set_fmt = es8316_set_dai_fmt,
        .set_sysclk = es8316_set_dai_sysclk,
        .mute_stream = es8316_mute,
        .no_capture_mute = 1,
};

static struct snd_soc_dai_driver es8316_dai = {
        .name = "ES8316 HiFi",
        .playback = {
                .stream_name = "Playback",
                .channels_min = 1,
                .channels_max = 2,
                .rates = SNDRV_PCM_RATE_8000_48000,
                .formats = ES8316_FORMATS,
        },
        .capture = {
                .stream_name = "Capture",
                .channels_min = 1,
                .channels_max = 2,
                .rates = SNDRV_PCM_RATE_8000_48000,
                .formats = ES8316_FORMATS,
        },
        .ops = &es8316_ops,
        .symmetric_rate = 1,
};

static void es8316_enable_micbias_for_mic_gnd_short_detect(
        struct snd_soc_component *component)
{
        struct snd_soc_dapm_context *dapm = snd_soc_component_to_dapm(component);

        snd_soc_dapm_mutex_lock(dapm);
        snd_soc_dapm_force_enable_pin_unlocked(dapm, "Bias");
        snd_soc_dapm_force_enable_pin_unlocked(dapm, "Analog power");
        snd_soc_dapm_force_enable_pin_unlocked(dapm, "Mic Bias");
        snd_soc_dapm_sync_unlocked(dapm);
        snd_soc_dapm_mutex_unlock(dapm);

        msleep(20);
}

static void es8316_disable_micbias_for_mic_gnd_short_detect(
        struct snd_soc_component *component)
{
        struct snd_soc_dapm_context *dapm = snd_soc_component_to_dapm(component);

        snd_soc_dapm_mutex_lock(dapm);
        snd_soc_dapm_disable_pin_unlocked(dapm, "Mic Bias");
        snd_soc_dapm_disable_pin_unlocked(dapm, "Analog power");
        snd_soc_dapm_disable_pin_unlocked(dapm, "Bias");
        snd_soc_dapm_sync_unlocked(dapm);
        snd_soc_dapm_mutex_unlock(dapm);
}

static irqreturn_t es8316_irq(int irq, void *data)
{
        struct es8316_priv *es8316 = data;
        struct snd_soc_component *comp = es8316->component;
        unsigned int flags;

        mutex_lock(&es8316->lock);

        regmap_read(es8316->regmap, ES8316_GPIO_FLAG, &flags);
        if (flags == 0x00)
                goto out; /* Powered-down / reset */

        /* Catch spurious IRQ before set_jack is called */
        if (!es8316->jack)
                goto out;

        if (es8316->jd_inverted)
                flags ^= ES8316_GPIO_FLAG_HP_NOT_INSERTED;

        dev_dbg(comp->dev, "gpio flags %#04x\n", flags);
        if (flags & ES8316_GPIO_FLAG_HP_NOT_INSERTED) {
                /* Jack removed, or spurious IRQ? */
                if (es8316->jack->status & SND_JACK_MICROPHONE)
                        es8316_disable_micbias_for_mic_gnd_short_detect(comp);

                if (es8316->jack->status & SND_JACK_HEADPHONE) {
                        snd_soc_jack_report(es8316->jack, 0,
                                            SND_JACK_HEADSET | SND_JACK_BTN_0);
                        dev_dbg(comp->dev, "jack unplugged\n");
                }
        } else if (!(es8316->jack->status & SND_JACK_HEADPHONE)) {
                /* Jack inserted, determine type */
                es8316_enable_micbias_for_mic_gnd_short_detect(comp);
                regmap_read(es8316->regmap, ES8316_GPIO_FLAG, &flags);
                if (es8316->jd_inverted)
                        flags ^= ES8316_GPIO_FLAG_HP_NOT_INSERTED;
                dev_dbg(comp->dev, "gpio flags %#04x\n", flags);
                if (flags & ES8316_GPIO_FLAG_HP_NOT_INSERTED) {
                        /* Jack unplugged underneath us */
                        es8316_disable_micbias_for_mic_gnd_short_detect(comp);
                } else if (flags & ES8316_GPIO_FLAG_GM_NOT_SHORTED) {
                        /* Open, headset */
                        snd_soc_jack_report(es8316->jack,
                                            SND_JACK_HEADSET,
                                            SND_JACK_HEADSET);
                        /* Keep mic-gnd-short detection on for button press */
                } else {
                        /* Shorted, headphones */
                        snd_soc_jack_report(es8316->jack,
                                            SND_JACK_HEADPHONE,
                                            SND_JACK_HEADSET);
                        /* No longer need mic-gnd-short detection */
                        es8316_disable_micbias_for_mic_gnd_short_detect(comp);
                }
        } else if (es8316->jack->status & SND_JACK_MICROPHONE) {
                /* Interrupt while jack inserted, report button state */
                if (flags & ES8316_GPIO_FLAG_GM_NOT_SHORTED) {
                        /* Open, button release */
                        snd_soc_jack_report(es8316->jack, 0, SND_JACK_BTN_0);
                } else {
                        /* Short, button press */
                        snd_soc_jack_report(es8316->jack,
                                            SND_JACK_BTN_0,
                                            SND_JACK_BTN_0);
                }
        }

out:
        mutex_unlock(&es8316->lock);
        return IRQ_HANDLED;
}

static void es8316_enable_jack_detect(struct snd_soc_component *component,
                                      struct snd_soc_jack *jack)
{
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);

        /*
         * Init es8316->jd_inverted here and not in the probe, as we cannot
         * guarantee that the bytchr-es8316 driver, which might set this
         * property, will probe before us.
         */
        es8316->jd_inverted = device_property_read_bool(component->dev,
                                                        "everest,jack-detect-inverted");

        mutex_lock(&es8316->lock);

        es8316->jack = jack;

        if (es8316->jack->status & SND_JACK_MICROPHONE)
                es8316_enable_micbias_for_mic_gnd_short_detect(component);

        snd_soc_component_update_bits(component, ES8316_GPIO_DEBOUNCE,
                                      ES8316_GPIO_ENABLE_INTERRUPT,
                                      ES8316_GPIO_ENABLE_INTERRUPT);

        mutex_unlock(&es8316->lock);

        /* Enable irq and sync initial jack state */
        enable_irq(es8316->irq);
        es8316_irq(es8316->irq, es8316);
}

static void es8316_disable_jack_detect(struct snd_soc_component *component)
{
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);

        if (!es8316->jack)
                return; /* Already disabled (or never enabled) */

        disable_irq(es8316->irq);

        mutex_lock(&es8316->lock);

        snd_soc_component_update_bits(component, ES8316_GPIO_DEBOUNCE,
                                      ES8316_GPIO_ENABLE_INTERRUPT, 0);

        if (es8316->jack->status & SND_JACK_MICROPHONE) {
                es8316_disable_micbias_for_mic_gnd_short_detect(component);
                snd_soc_jack_report(es8316->jack, 0, SND_JACK_BTN_0);
        }

        es8316->jack = NULL;

        mutex_unlock(&es8316->lock);
}

static int es8316_set_jack(struct snd_soc_component *component,
                           struct snd_soc_jack *jack, void *data)
{
        if (jack)
                es8316_enable_jack_detect(component, jack);
        else
                es8316_disable_jack_detect(component);

        return 0;
}

static int es8316_probe(struct snd_soc_component *component)
{
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
        int ret;

        es8316->component = component;

        es8316->mclk = devm_clk_get_optional(component->dev, "mclk");
        if (IS_ERR(es8316->mclk)) {
                dev_err(component->dev, "unable to get mclk\n");
                return PTR_ERR(es8316->mclk);
        }
        if (!es8316->mclk)
                dev_warn(component->dev, "assuming static mclk\n");

        ret = clk_prepare_enable(es8316->mclk);
        if (ret) {
                dev_err(component->dev, "unable to enable mclk\n");
                return ret;
        }

        /* Reset codec and enable current state machine */
        snd_soc_component_write(component, ES8316_RESET, 0x3f);
        usleep_range(5000, 5500);
        snd_soc_component_write(component, ES8316_RESET, ES8316_RESET_CSM_ON);
        msleep(30);

        /*
         * Documentation is unclear, but this value from the vendor driver is
         * needed otherwise audio output is silent.
         */
        snd_soc_component_write(component, ES8316_SYS_VMIDSEL, 0xff);

        /*
         * Documentation for this register is unclear and incomplete,
         * but here is a vendor-provided value that improves volume
         * and quality for Intel CHT platforms.
         */
        snd_soc_component_write(component, ES8316_CLKMGR_ADCOSR, 0x32);

        return 0;
}

static void es8316_remove(struct snd_soc_component *component)
{
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);

        clk_disable_unprepare(es8316->mclk);
}

static int es8316_resume(struct snd_soc_component *component)
{
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);

        regcache_cache_only(es8316->regmap, false);
        regcache_sync(es8316->regmap);

        return 0;
}

static int es8316_suspend(struct snd_soc_component *component)
{
        struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);

        regcache_cache_only(es8316->regmap, true);
        regcache_mark_dirty(es8316->regmap);

        return 0;
}

static const struct snd_soc_component_driver soc_component_dev_es8316 = {
        .probe                  = es8316_probe,
        .remove                 = es8316_remove,
        .resume                 = es8316_resume,
        .suspend                = es8316_suspend,
        .set_jack               = es8316_set_jack,
        .controls               = es8316_snd_controls,
        .num_controls           = ARRAY_SIZE(es8316_snd_controls),
        .dapm_widgets           = es8316_dapm_widgets,
        .num_dapm_widgets       = ARRAY_SIZE(es8316_dapm_widgets),
        .dapm_routes            = es8316_dapm_routes,
        .num_dapm_routes        = ARRAY_SIZE(es8316_dapm_routes),
        .use_pmdown_time        = 1,
        .endianness             = 1,
};

static bool es8316_volatile_reg(struct device *dev, unsigned int reg)
{
        switch (reg) {
        case ES8316_GPIO_FLAG:
                return true;
        default:
                return false;
        }
}

static const struct regmap_config es8316_regmap = {
        .reg_bits = 8,
        .val_bits = 8,
        .use_single_read = true,
        .use_single_write = true,
        .max_register = 0x53,
        .volatile_reg = es8316_volatile_reg,
        .cache_type = REGCACHE_MAPLE,
};

static int es8316_i2c_probe(struct i2c_client *i2c_client)
{
        struct device *dev = &i2c_client->dev;
        struct es8316_priv *es8316;
        int ret;

        es8316 = devm_kzalloc(&i2c_client->dev, sizeof(struct es8316_priv),
                              GFP_KERNEL);
        if (es8316 == NULL)
                return -ENOMEM;

        i2c_set_clientdata(i2c_client, es8316);

        es8316->regmap = devm_regmap_init_i2c(i2c_client, &es8316_regmap);
        if (IS_ERR(es8316->regmap))
                return PTR_ERR(es8316->regmap);

        es8316->irq = i2c_client->irq;
        mutex_init(&es8316->lock);

        if (es8316->irq > 0) {
                ret = devm_request_threaded_irq(dev, es8316->irq, NULL, es8316_irq,
                                                IRQF_TRIGGER_HIGH | IRQF_ONESHOT | IRQF_NO_AUTOEN,
                                                "es8316", es8316);
                if (ret) {
                        dev_warn(dev, "Failed to get IRQ %d: %d\n", es8316->irq, ret);
                        es8316->irq = -ENXIO;
                }
        }

        return devm_snd_soc_register_component(&i2c_client->dev,
                                      &soc_component_dev_es8316,
                                      &es8316_dai, 1);
}

static const struct i2c_device_id es8316_i2c_id[] = {
        { .name = "es8316" },
        { }
};
MODULE_DEVICE_TABLE(i2c, es8316_i2c_id);

#ifdef CONFIG_OF
static const struct of_device_id es8316_of_match[] = {
        { .compatible = "everest,es8316", },
        {},
};
MODULE_DEVICE_TABLE(of, es8316_of_match);
#endif

#ifdef CONFIG_ACPI
static const struct acpi_device_id es8316_acpi_match[] = {
        {"ESSX8316", 0},
        {"ESSX8336", 0},
        {},
};
MODULE_DEVICE_TABLE(acpi, es8316_acpi_match);
#endif

static struct i2c_driver es8316_i2c_driver = {
        .driver = {
                .name                   = "es8316",
                .acpi_match_table       = ACPI_PTR(es8316_acpi_match),
                .of_match_table         = of_match_ptr(es8316_of_match),
        },
        .probe          = es8316_i2c_probe,
        .id_table       = es8316_i2c_id,
};
module_i2c_driver(es8316_i2c_driver);

MODULE_DESCRIPTION("Everest Semi ES8316 ALSA SoC Codec Driver");
MODULE_AUTHOR("David Yang <yangxiaohua@everest-semi.com>");
MODULE_LICENSE("GPL v2");