sound/soc/codecs/es8316.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * es8316.c -- es8316 ALSA SoC audio driver
   4  * Copyright Everest Semiconductor Co.,Ltd
   5  *
   6  * Authors: David Yang <yangxiaohua@everest-semi.com>,
   7  *          Daniel Drake <drake@endlessm.com>
   8  */
   9
  10 #include <linux/module.h>
  11 #include <linux/acpi.h>
  12 #include <linux/clk.h>
  13 #include <linux/delay.h>
  14 #include <linux/i2c.h>
  15 #include <linux/mod_devicetable.h>
  16 #include <linux/mutex.h>
  17 #include <linux/regmap.h>
  18 #include <sound/pcm.h>
  19 #include <sound/pcm_params.h>
  20 #include <sound/soc.h>
  21 #include <sound/soc-dapm.h>
  22 #include <sound/tlv.h>
  23 #include <sound/jack.h>
  24 #include "es8316.h"
  25
  26 /* In slave mode at single speed, the codec is documented as accepting 5
  27  * MCLK/LRCK ratios, but we also add ratio 400, which is commonly used on
  28  * Intel Cherry Trail platforms (19.2MHz MCLK, 48kHz LRCK).
  29  */
  30 #define NR_SUPPORTED_MCLK_LRCK_RATIOS ARRAY_SIZE(supported_mclk_lrck_ratios)
  31 static const unsigned int supported_mclk_lrck_ratios[] = {
  32         256, 384, 400, 500, 512, 768, 1024
  33 };
  34
  35 struct es8316_priv {
  36         struct mutex lock;
  37         struct clk *mclk;
  38         struct regmap *regmap;
  39         struct snd_soc_component *component;
  40         struct snd_soc_jack *jack;
  41         int irq;
  42         unsigned int sysclk;
  43         unsigned int allowed_rates[NR_SUPPORTED_MCLK_LRCK_RATIOS];
  44         struct snd_pcm_hw_constraint_list sysclk_constraints;
  45         bool jd_inverted;
  46 };
  47
  48 /*
  49  * ES8316 controls
  50  */
  51 static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(dac_vol_tlv, -9600, 50, 1);
  52 static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(adc_vol_tlv, -9600, 50, 1);
  53 static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(alc_max_gain_tlv, -650, 150, 0);
  54 static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(alc_min_gain_tlv, -1200, 150, 0);
  55
  56 static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(alc_target_tlv,
  57         0, 10, TLV_DB_SCALE_ITEM(-1650, 150, 0),
  58         11, 11, TLV_DB_SCALE_ITEM(-150, 0, 0),
  59 );
  60
  61 static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(hpmixer_gain_tlv,
  62         0, 4, TLV_DB_SCALE_ITEM(-1200, 150, 0),
  63         8, 11, TLV_DB_SCALE_ITEM(-450, 150, 0),
  64 );
  65
  66 static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(adc_pga_gain_tlv,
  67         0, 0, TLV_DB_SCALE_ITEM(-350, 0, 0),
  68         1, 1, TLV_DB_SCALE_ITEM(0, 0, 0),
  69         2, 2, TLV_DB_SCALE_ITEM(250, 0, 0),
  70         3, 3, TLV_DB_SCALE_ITEM(450, 0, 0),
  71         4, 7, TLV_DB_SCALE_ITEM(700, 300, 0),
  72         8, 10, TLV_DB_SCALE_ITEM(1800, 300, 0),
  73 );
  74
  75 static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(hpout_vol_tlv,
  76         0, 0, TLV_DB_SCALE_ITEM(-4800, 0, 0),
  77         1, 3, TLV_DB_SCALE_ITEM(-2400, 1200, 0),
  78 );
  79
  80 static const char * const ng_type_txt[] =
  81         { "Constant PGA Gain", "Mute ADC Output" };
  82 static const struct soc_enum ng_type =
  83         SOC_ENUM_SINGLE(ES8316_ADC_ALC_NG, 6, 2, ng_type_txt);
  84
  85 static const char * const adcpol_txt[] = { "Normal", "Invert" };
  86 static const struct soc_enum adcpol =
  87         SOC_ENUM_SINGLE(ES8316_ADC_MUTE, 1, 2, adcpol_txt);
  88 static const char *const dacpol_txt[] =
  89         { "Normal", "R Invert", "L Invert", "L + R Invert" };
  90 static const struct soc_enum dacpol =
  91         SOC_ENUM_SINGLE(ES8316_DAC_SET1, 0, 4, dacpol_txt);
  92
  93 static const struct snd_kcontrol_new es8316_snd_controls[] = {
  94         SOC_DOUBLE_TLV("Headphone Playback Volume", ES8316_CPHP_ICAL_VOL,
  95                        4, 0, 3, 1, hpout_vol_tlv),
  96         SOC_DOUBLE_TLV("Headphone Mixer Volume", ES8316_HPMIX_VOL,
  97                        4, 0, 11, 0, hpmixer_gain_tlv),
  98
  99         SOC_ENUM("Playback Polarity", dacpol),
 100         SOC_DOUBLE_R_TLV("DAC Playback Volume", ES8316_DAC_VOLL,
 101                          ES8316_DAC_VOLR, 0, 0xc0, 1, dac_vol_tlv),
 102         SOC_SINGLE("DAC Soft Ramp Switch", ES8316_DAC_SET1, 4, 1, 1),
 103         SOC_SINGLE("DAC Soft Ramp Rate", ES8316_DAC_SET1, 2, 4, 0),
 104         SOC_SINGLE("DAC Notch Filter Switch", ES8316_DAC_SET2, 6, 1, 0),
 105         SOC_SINGLE("DAC Double Fs Switch", ES8316_DAC_SET2, 7, 1, 0),
 106         SOC_SINGLE("DAC Stereo Enhancement", ES8316_DAC_SET3, 0, 7, 0),
 107         SOC_SINGLE("DAC Mono Mix Switch", ES8316_DAC_SET3, 3, 1, 0),
 108
 109         SOC_ENUM("Capture Polarity", adcpol),
 110         SOC_SINGLE("Mic Boost Switch", ES8316_ADC_D2SEPGA, 0, 1, 0),
 111         SOC_SINGLE_TLV("ADC Capture Volume", ES8316_ADC_VOLUME,
 112                        0, 0xc0, 1, adc_vol_tlv),
 113         SOC_SINGLE_TLV("ADC PGA Gain Volume", ES8316_ADC_PGAGAIN,
 114                        4, 10, 0, adc_pga_gain_tlv),
 115         SOC_SINGLE("ADC Soft Ramp Switch", ES8316_ADC_MUTE, 4, 1, 0),
 116         SOC_SINGLE("ADC Double Fs Switch", ES8316_ADC_DMIC, 4, 1, 0),
 117
 118         SOC_SINGLE("ALC Capture Switch", ES8316_ADC_ALC1, 6, 1, 0),
 119         SOC_SINGLE_TLV("ALC Capture Max Volume", ES8316_ADC_ALC1, 0, 28, 0,
 120                        alc_max_gain_tlv),
 121         SOC_SINGLE_TLV("ALC Capture Min Volume", ES8316_ADC_ALC2, 0, 28, 0,
 122                        alc_min_gain_tlv),
 123         SOC_SINGLE_TLV("ALC Capture Target Volume", ES8316_ADC_ALC3, 4, 11, 0,
 124                        alc_target_tlv),
 125         SOC_SINGLE("ALC Capture Hold Time", ES8316_ADC_ALC3, 0, 10, 0),
 126         SOC_SINGLE("ALC Capture Decay Time", ES8316_ADC_ALC4, 4, 10, 0),
 127         SOC_SINGLE("ALC Capture Attack Time", ES8316_ADC_ALC4, 0, 10, 0),
 128         SOC_SINGLE("ALC Capture Noise Gate Switch", ES8316_ADC_ALC_NG,
 129                    5, 1, 0),
 130         SOC_SINGLE("ALC Capture Noise Gate Threshold", ES8316_ADC_ALC_NG,
 131                    0, 31, 0),
 132         SOC_ENUM("ALC Capture Noise Gate Type", ng_type),
 133 };
 134
 135 /* Analog Input Mux */
 136 static const char * const es8316_analog_in_txt[] = {
 137                 "lin1-rin1",
 138                 "lin2-rin2",
 139                 "lin1-rin1 with 20db Boost",
 140                 "lin2-rin2 with 20db Boost"
 141 };
 142 static const unsigned int es8316_analog_in_values[] = { 0, 1, 2, 3 };
 143 static const struct soc_enum es8316_analog_input_enum =
 144         SOC_VALUE_ENUM_SINGLE(ES8316_ADC_PDN_LINSEL, 4, 3,
 145                               ARRAY_SIZE(es8316_analog_in_txt),
 146                               es8316_analog_in_txt,
 147                               es8316_analog_in_values);
 148 static const struct snd_kcontrol_new es8316_analog_in_mux_controls =
 149         SOC_DAPM_ENUM("Route", es8316_analog_input_enum);
 150
 151 static const char * const es8316_dmic_txt[] = {
 152                 "dmic disable",
 153                 "dmic data at high level",
 154                 "dmic data at low level",
 155 };
 156 static const unsigned int es8316_dmic_values[] = { 0, 1, 2 };
 157 static const struct soc_enum es8316_dmic_src_enum =
 158         SOC_VALUE_ENUM_SINGLE(ES8316_ADC_DMIC, 0, 3,
 159                               ARRAY_SIZE(es8316_dmic_txt),
 160                               es8316_dmic_txt,
 161                               es8316_dmic_values);
 162 static const struct snd_kcontrol_new es8316_dmic_src_controls =
 163         SOC_DAPM_ENUM("Route", es8316_dmic_src_enum);
 164
 165 /* hp mixer mux */
 166 static const char * const es8316_hpmux_texts[] = {
 167         "lin1-rin1",
 168         "lin2-rin2",
 169         "lin-rin with Boost",
 170         "lin-rin with Boost and PGA"
 171 };
 172
 173 static SOC_ENUM_SINGLE_DECL(es8316_left_hpmux_enum, ES8316_HPMIX_SEL,
 174         4, es8316_hpmux_texts);
 175
 176 static const struct snd_kcontrol_new es8316_left_hpmux_controls =
 177         SOC_DAPM_ENUM("Route", es8316_left_hpmux_enum);
 178
 179 static SOC_ENUM_SINGLE_DECL(es8316_right_hpmux_enum, ES8316_HPMIX_SEL,
 180         0, es8316_hpmux_texts);
 181
 182 static const struct snd_kcontrol_new es8316_right_hpmux_controls =
 183         SOC_DAPM_ENUM("Route", es8316_right_hpmux_enum);
 184
 185 /* headphone Output Mixer */
 186 static const struct snd_kcontrol_new es8316_out_left_mix[] = {
 187         SOC_DAPM_SINGLE("LLIN Switch", ES8316_HPMIX_SWITCH, 6, 1, 0),
 188         SOC_DAPM_SINGLE("Left DAC Switch", ES8316_HPMIX_SWITCH, 7, 1, 0),
 189 };
 190 static const struct snd_kcontrol_new es8316_out_right_mix[] = {
 191         SOC_DAPM_SINGLE("RLIN Switch", ES8316_HPMIX_SWITCH, 2, 1, 0),
 192         SOC_DAPM_SINGLE("Right DAC Switch", ES8316_HPMIX_SWITCH, 3, 1, 0),
 193 };
 194
 195 /* DAC data source mux */
 196 static const char * const es8316_dacsrc_texts[] = {
 197         "LDATA TO LDAC, RDATA TO RDAC",
 198         "LDATA TO LDAC, LDATA TO RDAC",
 199         "RDATA TO LDAC, RDATA TO RDAC",
 200         "RDATA TO LDAC, LDATA TO RDAC",
 201 };
 202
 203 static SOC_ENUM_SINGLE_DECL(es8316_dacsrc_mux_enum, ES8316_DAC_SET1,
 204         6, es8316_dacsrc_texts);
 205
 206 static const struct snd_kcontrol_new es8316_dacsrc_mux_controls =
 207         SOC_DAPM_ENUM("Route", es8316_dacsrc_mux_enum);
 208
 209 static const struct snd_soc_dapm_widget es8316_dapm_widgets[] = {
 210         SND_SOC_DAPM_SUPPLY("Bias", ES8316_SYS_PDN, 3, 1, NULL, 0),
 211         SND_SOC_DAPM_SUPPLY("Analog power", ES8316_SYS_PDN, 4, 1, NULL, 0),
 212         SND_SOC_DAPM_SUPPLY("Mic Bias", ES8316_SYS_PDN, 5, 1, NULL, 0),
 213
 214         SND_SOC_DAPM_INPUT("DMIC"),
 215         SND_SOC_DAPM_INPUT("MIC1"),
 216         SND_SOC_DAPM_INPUT("MIC2"),
 217
 218         /* Input Mux */
 219         SND_SOC_DAPM_MUX("Differential Mux", SND_SOC_NOPM, 0, 0,
 220                          &es8316_analog_in_mux_controls),
 221
 222         SND_SOC_DAPM_SUPPLY("ADC Vref", ES8316_SYS_PDN, 1, 1, NULL, 0),
 223         SND_SOC_DAPM_SUPPLY("ADC bias", ES8316_SYS_PDN, 2, 1, NULL, 0),
 224         SND_SOC_DAPM_SUPPLY("ADC Clock", ES8316_CLKMGR_CLKSW, 3, 0, NULL, 0),
 225         SND_SOC_DAPM_PGA("Line input PGA", ES8316_ADC_PDN_LINSEL,
 226                          7, 1, NULL, 0),
 227         SND_SOC_DAPM_ADC("Mono ADC", NULL, ES8316_ADC_PDN_LINSEL, 6, 1),
 228         SND_SOC_DAPM_MUX("Digital Mic Mux", SND_SOC_NOPM, 0, 0,
 229                          &es8316_dmic_src_controls),
 230
 231         /* Digital Interface */
 232         SND_SOC_DAPM_AIF_OUT("I2S OUT", "I2S1 Capture",  1,
 233                              ES8316_SERDATA_ADC, 6, 1),
 234         SND_SOC_DAPM_AIF_IN("I2S IN", "I2S1 Playback", 0,
 235                             SND_SOC_NOPM, 0, 0),
 236
 237         SND_SOC_DAPM_MUX("DAC Source Mux", SND_SOC_NOPM, 0, 0,
 238                          &es8316_dacsrc_mux_controls),
 239
 240         SND_SOC_DAPM_SUPPLY("DAC Vref", ES8316_SYS_PDN, 0, 1, NULL, 0),
 241         SND_SOC_DAPM_SUPPLY("DAC Clock", ES8316_CLKMGR_CLKSW, 2, 0, NULL, 0),
 242         SND_SOC_DAPM_DAC("Right DAC", NULL, ES8316_DAC_PDN, 0, 1),
 243         SND_SOC_DAPM_DAC("Left DAC", NULL, ES8316_DAC_PDN, 4, 1),
 244
 245         /* Headphone Output Side */
 246         SND_SOC_DAPM_MUX("Left Headphone Mux", SND_SOC_NOPM, 0, 0,
 247                          &es8316_left_hpmux_controls),
 248         SND_SOC_DAPM_MUX("Right Headphone Mux", SND_SOC_NOPM, 0, 0,
 249                          &es8316_right_hpmux_controls),
 250         SND_SOC_DAPM_MIXER("Left Headphone Mixer", ES8316_HPMIX_PDN,
 251                            5, 1, &es8316_out_left_mix[0],
 252                            ARRAY_SIZE(es8316_out_left_mix)),
 253         SND_SOC_DAPM_MIXER("Right Headphone Mixer", ES8316_HPMIX_PDN,
 254                            1, 1, &es8316_out_right_mix[0],
 255                            ARRAY_SIZE(es8316_out_right_mix)),
 256         SND_SOC_DAPM_PGA("Left Headphone Mixer Out", ES8316_HPMIX_PDN,
 257                          4, 1, NULL, 0),
 258         SND_SOC_DAPM_PGA("Right Headphone Mixer Out", ES8316_HPMIX_PDN,
 259                          0, 1, NULL, 0),
 260
 261         SND_SOC_DAPM_OUT_DRV("Left Headphone Charge Pump", ES8316_CPHP_OUTEN,
 262                              6, 0, NULL, 0),
 263         SND_SOC_DAPM_OUT_DRV("Right Headphone Charge Pump", ES8316_CPHP_OUTEN,
 264                              2, 0, NULL, 0),
 265         SND_SOC_DAPM_SUPPLY("Headphone Charge Pump", ES8316_CPHP_PDN2,
 266                             5, 1, NULL, 0),
 267         SND_SOC_DAPM_SUPPLY("Headphone Charge Pump Clock", ES8316_CLKMGR_CLKSW,
 268                             4, 0, NULL, 0),
 269
 270         SND_SOC_DAPM_OUT_DRV("Left Headphone Driver", ES8316_CPHP_OUTEN,
 271                              5, 0, NULL, 0),
 272         SND_SOC_DAPM_OUT_DRV("Right Headphone Driver", ES8316_CPHP_OUTEN,
 273                              1, 0, NULL, 0),
 274         SND_SOC_DAPM_SUPPLY("Headphone Out", ES8316_CPHP_PDN1, 2, 1, NULL, 0),
 275
 276         /* pdn_Lical and pdn_Rical bits are documented as Reserved, but must
 277          * be explicitly unset in order to enable HP output
 278          */
 279         SND_SOC_DAPM_SUPPLY("Left Headphone ical", ES8316_CPHP_ICAL_VOL,
 280                             7, 1, NULL, 0),
 281         SND_SOC_DAPM_SUPPLY("Right Headphone ical", ES8316_CPHP_ICAL_VOL,
 282                             3, 1, NULL, 0),
 283
 284         SND_SOC_DAPM_OUTPUT("HPOL"),
 285         SND_SOC_DAPM_OUTPUT("HPOR"),
 286 };
 287
 288 static const struct snd_soc_dapm_route es8316_dapm_routes[] = {
 289         /* Recording */
 290         {"MIC1", NULL, "Mic Bias"},
 291         {"MIC2", NULL, "Mic Bias"},
 292         {"MIC1", NULL, "Bias"},
 293         {"MIC2", NULL, "Bias"},
 294         {"MIC1", NULL, "Analog power"},
 295         {"MIC2", NULL, "Analog power"},
 296
 297         {"Differential Mux", "lin1-rin1", "MIC1"},
 298         {"Differential Mux", "lin2-rin2", "MIC2"},
 299         {"Line input PGA", NULL, "Differential Mux"},
 300
 301         {"Mono ADC", NULL, "ADC Clock"},
 302         {"Mono ADC", NULL, "ADC Vref"},
 303         {"Mono ADC", NULL, "ADC bias"},
 304         {"Mono ADC", NULL, "Line input PGA"},
 305
 306         /* It's not clear why, but to avoid recording only silence,
 307          * the DAC clock must be running for the ADC to work.
 308          */
 309         {"Mono ADC", NULL, "DAC Clock"},
 310
 311         {"Digital Mic Mux", "dmic disable", "Mono ADC"},
 312
 313         {"I2S OUT", NULL, "Digital Mic Mux"},
 314
 315         /* Playback */
 316         {"DAC Source Mux", "LDATA TO LDAC, RDATA TO RDAC", "I2S IN"},
 317
 318         {"Left DAC", NULL, "DAC Clock"},
 319         {"Right DAC", NULL, "DAC Clock"},
 320
 321         {"Left DAC", NULL, "DAC Vref"},
 322         {"Right DAC", NULL, "DAC Vref"},
 323
 324         {"Left DAC", NULL, "DAC Source Mux"},
 325         {"Right DAC", NULL, "DAC Source Mux"},
 326
 327         {"Left Headphone Mux", "lin-rin with Boost and PGA", "Line input PGA"},
 328         {"Right Headphone Mux", "lin-rin with Boost and PGA", "Line input PGA"},
 329
 330         {"Left Headphone Mixer", "LLIN Switch", "Left Headphone Mux"},
 331         {"Left Headphone Mixer", "Left DAC Switch", "Left DAC"},
 332
 333         {"Right Headphone Mixer", "RLIN Switch", "Right Headphone Mux"},
 334         {"Right Headphone Mixer", "Right DAC Switch", "Right DAC"},
 335
 336         {"Left Headphone Mixer Out", NULL, "Left Headphone Mixer"},
 337         {"Right Headphone Mixer Out", NULL, "Right Headphone Mixer"},
 338
 339         {"Left Headphone Charge Pump", NULL, "Left Headphone Mixer Out"},
 340         {"Right Headphone Charge Pump", NULL, "Right Headphone Mixer Out"},
 341
 342         {"Left Headphone Charge Pump", NULL, "Headphone Charge Pump"},
 343         {"Right Headphone Charge Pump", NULL, "Headphone Charge Pump"},
 344
 345         {"Left Headphone Charge Pump", NULL, "Headphone Charge Pump Clock"},
 346         {"Right Headphone Charge Pump", NULL, "Headphone Charge Pump Clock"},
 347
 348         {"Left Headphone Driver", NULL, "Left Headphone Charge Pump"},
 349         {"Right Headphone Driver", NULL, "Right Headphone Charge Pump"},
 350
 351         {"HPOL", NULL, "Left Headphone Driver"},
 352         {"HPOR", NULL, "Right Headphone Driver"},
 353
 354         {"HPOL", NULL, "Left Headphone ical"},
 355         {"HPOR", NULL, "Right Headphone ical"},
 356
 357         {"Headphone Out", NULL, "Bias"},
 358         {"Headphone Out", NULL, "Analog power"},
 359         {"HPOL", NULL, "Headphone Out"},
 360         {"HPOR", NULL, "Headphone Out"},
 361 };
 362
 363 static int es8316_set_dai_sysclk(struct snd_soc_dai *codec_dai,
 364                                  int clk_id, unsigned int freq, int dir)
 365 {
 366         struct snd_soc_component *component = codec_dai->component;
 367         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 368         int i, ret;
 369         int count = 0;
 370
 371         es8316->sysclk = freq;
 372         es8316->sysclk_constraints.list = NULL;
 373         es8316->sysclk_constraints.count = 0;
 374
 375         if (freq == 0)
 376                 return 0;
 377
 378         ret = clk_set_rate(es8316->mclk, freq);
 379         if (ret)
 380                 return ret;
 381
 382         /* Limit supported sample rates to ones that can be autodetected
 383          * by the codec running in slave mode.
 384          */
 385         for (i = 0; i < NR_SUPPORTED_MCLK_LRCK_RATIOS; i++) {
 386                 const unsigned int ratio = supported_mclk_lrck_ratios[i];
 387
 388                 if (freq % ratio == 0)
 389                         es8316->allowed_rates[count++] = freq / ratio;
 390         }
 391
 392         if (count) {
 393                 es8316->sysclk_constraints.list = es8316->allowed_rates;
 394                 es8316->sysclk_constraints.count = count;
 395         }
 396
 397         return 0;
 398 }
 399
 400 static int es8316_set_dai_fmt(struct snd_soc_dai *codec_dai,
 401                               unsigned int fmt)
 402 {
 403         struct snd_soc_component *component = codec_dai->component;
 404         u8 serdata1 = 0;
 405         u8 serdata2 = 0;
 406         u8 clksw;
 407         u8 mask;
 408
 409         if ((fmt & SND_SOC_DAIFMT_MASTER_MASK) == SND_SOC_DAIFMT_CBP_CFP)
 410                 serdata1 |= ES8316_SERDATA1_MASTER;
 411
 412         if ((fmt & SND_SOC_DAIFMT_FORMAT_MASK) != SND_SOC_DAIFMT_I2S) {
 413                 dev_err(component->dev, "Codec driver only supports I2S format\n");
 414                 return -EINVAL;
 415         }
 416
 417         /* Clock inversion */
 418         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 419         case SND_SOC_DAIFMT_NB_NF:
 420                 break;
 421         case SND_SOC_DAIFMT_IB_IF:
 422                 serdata1 |= ES8316_SERDATA1_BCLK_INV;
 423                 serdata2 |= ES8316_SERDATA2_ADCLRP;
 424                 break;
 425         case SND_SOC_DAIFMT_IB_NF:
 426                 serdata1 |= ES8316_SERDATA1_BCLK_INV;
 427                 break;
 428         case SND_SOC_DAIFMT_NB_IF:
 429                 serdata2 |= ES8316_SERDATA2_ADCLRP;
 430                 break;
 431         default:
 432                 return -EINVAL;
 433         }
 434
 435         mask = ES8316_SERDATA1_MASTER | ES8316_SERDATA1_BCLK_INV;
 436         snd_soc_component_update_bits(component, ES8316_SERDATA1, mask, serdata1);
 437
 438         mask = ES8316_SERDATA2_FMT_MASK | ES8316_SERDATA2_ADCLRP;
 439         snd_soc_component_update_bits(component, ES8316_SERDATA_ADC, mask, serdata2);
 440         snd_soc_component_update_bits(component, ES8316_SERDATA_DAC, mask, serdata2);
 441
 442         /* Enable BCLK and MCLK inputs in slave mode */
 443         clksw = ES8316_CLKMGR_CLKSW_MCLK_ON | ES8316_CLKMGR_CLKSW_BCLK_ON;
 444         snd_soc_component_update_bits(component, ES8316_CLKMGR_CLKSW, clksw, clksw);
 445
 446         return 0;
 447 }
 448
 449 static int es8316_pcm_startup(struct snd_pcm_substream *substream,
 450                               struct snd_soc_dai *dai)
 451 {
 452         struct snd_soc_component *component = dai->component;
 453         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 454
 455         if (es8316->sysclk_constraints.list)
 456                 snd_pcm_hw_constraint_list(substream->runtime, 0,
 457                                            SNDRV_PCM_HW_PARAM_RATE,
 458                                            &es8316->sysclk_constraints);
 459
 460         return 0;
 461 }
 462
 463 static int es8316_pcm_hw_params(struct snd_pcm_substream *substream,
 464                                 struct snd_pcm_hw_params *params,
 465                                 struct snd_soc_dai *dai)
 466 {
 467         struct snd_soc_component *component = dai->component;
 468         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 469         u8 wordlen = 0;
 470         u8 bclk_divider;
 471         u16 lrck_divider;
 472         int i;
 473
 474         /* Validate supported sample rates that are autodetected from MCLK */
 475         for (i = 0; i < NR_SUPPORTED_MCLK_LRCK_RATIOS; i++) {
 476                 const unsigned int ratio = supported_mclk_lrck_ratios[i];
 477
 478                 if (es8316->sysclk % ratio != 0)
 479                         continue;
 480                 if (es8316->sysclk / ratio == params_rate(params))
 481                         break;
 482         }
 483         if (i == NR_SUPPORTED_MCLK_LRCK_RATIOS)
 484                 return -EINVAL;
 485         lrck_divider = es8316->sysclk / params_rate(params);
 486         bclk_divider = lrck_divider / 4;
 487         switch (params_format(params)) {
 488         case SNDRV_PCM_FORMAT_S16_LE:
 489                 wordlen = ES8316_SERDATA2_LEN_16;
 490                 bclk_divider /= 16;
 491                 break;
 492         case SNDRV_PCM_FORMAT_S20_3LE:
 493                 wordlen = ES8316_SERDATA2_LEN_20;
 494                 bclk_divider /= 20;
 495                 break;
 496         case SNDRV_PCM_FORMAT_S24_LE:
 497                 wordlen = ES8316_SERDATA2_LEN_24;
 498                 bclk_divider /= 24;
 499                 break;
 500         case SNDRV_PCM_FORMAT_S32_LE:
 501                 wordlen = ES8316_SERDATA2_LEN_32;
 502                 bclk_divider /= 32;
 503                 break;
 504         default:
 505                 return -EINVAL;
 506         }
 507
 508         snd_soc_component_update_bits(component, ES8316_SERDATA_DAC,
 509                             ES8316_SERDATA2_LEN_MASK, wordlen);
 510         snd_soc_component_update_bits(component, ES8316_SERDATA_ADC,
 511                             ES8316_SERDATA2_LEN_MASK, wordlen);
 512         snd_soc_component_update_bits(component, ES8316_SERDATA1, 0x1f, bclk_divider);
 513         snd_soc_component_update_bits(component, ES8316_CLKMGR_ADCDIV1, 0x0f, lrck_divider >> 8);
 514         snd_soc_component_update_bits(component, ES8316_CLKMGR_ADCDIV2, 0xff, lrck_divider & 0xff);
 515         snd_soc_component_update_bits(component, ES8316_CLKMGR_DACDIV1, 0x0f, lrck_divider >> 8);
 516         snd_soc_component_update_bits(component, ES8316_CLKMGR_DACDIV2, 0xff, lrck_divider & 0xff);
 517         return 0;
 518 }
 519
 520 static int es8316_mute(struct snd_soc_dai *dai, int mute, int direction)
 521 {
 522         snd_soc_component_update_bits(dai->component, ES8316_DAC_SET1, 0x20,
 523                             mute ? 0x20 : 0);
 524         return 0;
 525 }
 526
 527 #define ES8316_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
 528                         SNDRV_PCM_FMTBIT_S24_LE)
 529
 530 static const struct snd_soc_dai_ops es8316_ops = {
 531         .startup = es8316_pcm_startup,
 532         .hw_params = es8316_pcm_hw_params,
 533         .set_fmt = es8316_set_dai_fmt,
 534         .set_sysclk = es8316_set_dai_sysclk,
 535         .mute_stream = es8316_mute,
 536         .no_capture_mute = 1,
 537 };
 538
 539 static struct snd_soc_dai_driver es8316_dai = {
 540         .name = "ES8316 HiFi",
 541         .playback = {
 542                 .stream_name = "Playback",
 543                 .channels_min = 1,
 544                 .channels_max = 2,
 545                 .rates = SNDRV_PCM_RATE_8000_48000,
 546                 .formats = ES8316_FORMATS,
 547         },
 548         .capture = {
 549                 .stream_name = "Capture",
 550                 .channels_min = 1,
 551                 .channels_max = 2,
 552                 .rates = SNDRV_PCM_RATE_8000_48000,
 553                 .formats = ES8316_FORMATS,
 554         },
 555         .ops = &es8316_ops,
 556         .symmetric_rate = 1,
 557 };
 558
 559 static void es8316_enable_micbias_for_mic_gnd_short_detect(
 560         struct snd_soc_component *component)
 561 {
 562         struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
 563
 564         snd_soc_dapm_mutex_lock(dapm);
 565         snd_soc_dapm_force_enable_pin_unlocked(dapm, "Bias");
 566         snd_soc_dapm_force_enable_pin_unlocked(dapm, "Analog power");
 567         snd_soc_dapm_force_enable_pin_unlocked(dapm, "Mic Bias");
 568         snd_soc_dapm_sync_unlocked(dapm);
 569         snd_soc_dapm_mutex_unlock(dapm);
 570
 571         msleep(20);
 572 }
 573
 574 static void es8316_disable_micbias_for_mic_gnd_short_detect(
 575         struct snd_soc_component *component)
 576 {
 577         struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
 578
 579         snd_soc_dapm_mutex_lock(dapm);
 580         snd_soc_dapm_disable_pin_unlocked(dapm, "Mic Bias");
 581         snd_soc_dapm_disable_pin_unlocked(dapm, "Analog power");
 582         snd_soc_dapm_disable_pin_unlocked(dapm, "Bias");
 583         snd_soc_dapm_sync_unlocked(dapm);
 584         snd_soc_dapm_mutex_unlock(dapm);
 585 }
 586
 587 static irqreturn_t es8316_irq(int irq, void *data)
 588 {
 589         struct es8316_priv *es8316 = data;
 590         struct snd_soc_component *comp = es8316->component;
 591         unsigned int flags;
 592
 593         mutex_lock(&es8316->lock);
 594
 595         regmap_read(es8316->regmap, ES8316_GPIO_FLAG, &flags);
 596         if (flags == 0x00)
 597                 goto out; /* Powered-down / reset */
 598
 599         /* Catch spurious IRQ before set_jack is called */
 600         if (!es8316->jack)
 601                 goto out;
 602
 603         if (es8316->jd_inverted)
 604                 flags ^= ES8316_GPIO_FLAG_HP_NOT_INSERTED;
 605
 606         dev_dbg(comp->dev, "gpio flags %#04x\n", flags);
 607         if (flags & ES8316_GPIO_FLAG_HP_NOT_INSERTED) {
 608                 /* Jack removed, or spurious IRQ? */
 609                 if (es8316->jack->status & SND_JACK_MICROPHONE)
 610                         es8316_disable_micbias_for_mic_gnd_short_detect(comp);
 611
 612                 if (es8316->jack->status & SND_JACK_HEADPHONE) {
 613                         snd_soc_jack_report(es8316->jack, 0,
 614                                             SND_JACK_HEADSET | SND_JACK_BTN_0);
 615                         dev_dbg(comp->dev, "jack unplugged\n");
 616                 }
 617         } else if (!(es8316->jack->status & SND_JACK_HEADPHONE)) {
 618                 /* Jack inserted, determine type */
 619                 es8316_enable_micbias_for_mic_gnd_short_detect(comp);
 620                 regmap_read(es8316->regmap, ES8316_GPIO_FLAG, &flags);
 621                 if (es8316->jd_inverted)
 622                         flags ^= ES8316_GPIO_FLAG_HP_NOT_INSERTED;
 623                 dev_dbg(comp->dev, "gpio flags %#04x\n", flags);
 624                 if (flags & ES8316_GPIO_FLAG_HP_NOT_INSERTED) {
 625                         /* Jack unplugged underneath us */
 626                         es8316_disable_micbias_for_mic_gnd_short_detect(comp);
 627                 } else if (flags & ES8316_GPIO_FLAG_GM_NOT_SHORTED) {
 628                         /* Open, headset */
 629                         snd_soc_jack_report(es8316->jack,
 630                                             SND_JACK_HEADSET,
 631                                             SND_JACK_HEADSET);
 632                         /* Keep mic-gnd-short detection on for button press */
 633                 } else {
 634                         /* Shorted, headphones */
 635                         snd_soc_jack_report(es8316->jack,
 636                                             SND_JACK_HEADPHONE,
 637                                             SND_JACK_HEADSET);
 638                         /* No longer need mic-gnd-short detection */
 639                         es8316_disable_micbias_for_mic_gnd_short_detect(comp);
 640                 }
 641         } else if (es8316->jack->status & SND_JACK_MICROPHONE) {
 642                 /* Interrupt while jack inserted, report button state */
 643                 if (flags & ES8316_GPIO_FLAG_GM_NOT_SHORTED) {
 644                         /* Open, button release */
 645                         snd_soc_jack_report(es8316->jack, 0, SND_JACK_BTN_0);
 646                 } else {
 647                         /* Short, button press */
 648                         snd_soc_jack_report(es8316->jack,
 649                                             SND_JACK_BTN_0,
 650                                             SND_JACK_BTN_0);
 651                 }
 652         }
 653
 654 out:
 655         mutex_unlock(&es8316->lock);
 656         return IRQ_HANDLED;
 657 }
 658
 659 static void es8316_enable_jack_detect(struct snd_soc_component *component,
 660                                       struct snd_soc_jack *jack)
 661 {
 662         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 663
 664         /*
 665          * Init es8316->jd_inverted here and not in the probe, as we cannot
 666          * guarantee that the bytchr-es8316 driver, which might set this
 667          * property, will probe before us.
 668          */
 669         es8316->jd_inverted = device_property_read_bool(component->dev,
 670                                                         "everest,jack-detect-inverted");
 671
 672         mutex_lock(&es8316->lock);
 673
 674         es8316->jack = jack;
 675
 676         if (es8316->jack->status & SND_JACK_MICROPHONE)
 677                 es8316_enable_micbias_for_mic_gnd_short_detect(component);
 678
 679         snd_soc_component_update_bits(component, ES8316_GPIO_DEBOUNCE,
 680                                       ES8316_GPIO_ENABLE_INTERRUPT,
 681                                       ES8316_GPIO_ENABLE_INTERRUPT);
 682
 683         mutex_unlock(&es8316->lock);
 684
 685         /* Enable irq and sync initial jack state */
 686         enable_irq(es8316->irq);
 687         es8316_irq(es8316->irq, es8316);
 688 }
 689
 690 static void es8316_disable_jack_detect(struct snd_soc_component *component)
 691 {
 692         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 693
 694         if (!es8316->jack)
 695                 return; /* Already disabled (or never enabled) */
 696
 697         disable_irq(es8316->irq);
 698
 699         mutex_lock(&es8316->lock);
 700
 701         snd_soc_component_update_bits(component, ES8316_GPIO_DEBOUNCE,
 702                                       ES8316_GPIO_ENABLE_INTERRUPT, 0);
 703
 704         if (es8316->jack->status & SND_JACK_MICROPHONE) {
 705                 es8316_disable_micbias_for_mic_gnd_short_detect(component);
 706                 snd_soc_jack_report(es8316->jack, 0, SND_JACK_BTN_0);
 707         }
 708
 709         es8316->jack = NULL;
 710
 711         mutex_unlock(&es8316->lock);
 712 }
 713
 714 static int es8316_set_jack(struct snd_soc_component *component,
 715                            struct snd_soc_jack *jack, void *data)
 716 {
 717         if (jack)
 718                 es8316_enable_jack_detect(component, jack);
 719         else
 720                 es8316_disable_jack_detect(component);
 721
 722         return 0;
 723 }
 724
 725 static int es8316_probe(struct snd_soc_component *component)
 726 {
 727         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 728         int ret;
 729
 730         es8316->component = component;
 731
 732         es8316->mclk = devm_clk_get_optional(component->dev, "mclk");
 733         if (IS_ERR(es8316->mclk)) {
 734                 dev_err(component->dev, "unable to get mclk\n");
 735                 return PTR_ERR(es8316->mclk);
 736         }
 737         if (!es8316->mclk)
 738                 dev_warn(component->dev, "assuming static mclk\n");
 739
 740         ret = clk_prepare_enable(es8316->mclk);
 741         if (ret) {
 742                 dev_err(component->dev, "unable to enable mclk\n");
 743                 return ret;
 744         }
 745
 746         /* Reset codec and enable current state machine */
 747         snd_soc_component_write(component, ES8316_RESET, 0x3f);
 748         usleep_range(5000, 5500);
 749         snd_soc_component_write(component, ES8316_RESET, ES8316_RESET_CSM_ON);
 750         msleep(30);
 751
 752         /*
 753          * Documentation is unclear, but this value from the vendor driver is
 754          * needed otherwise audio output is silent.
 755          */
 756         snd_soc_component_write(component, ES8316_SYS_VMIDSEL, 0xff);
 757
 758         /*
 759          * Documentation for this register is unclear and incomplete,
 760          * but here is a vendor-provided value that improves volume
 761          * and quality for Intel CHT platforms.
 762          */
 763         snd_soc_component_write(component, ES8316_CLKMGR_ADCOSR, 0x32);
 764
 765         return 0;
 766 }
 767
 768 static void es8316_remove(struct snd_soc_component *component)
 769 {
 770         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 771
 772         clk_disable_unprepare(es8316->mclk);
 773 }
 774
 775 static int es8316_resume(struct snd_soc_component *component)
 776 {
 777         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 778
 779         regcache_cache_only(es8316->regmap, false);
 780         regcache_sync(es8316->regmap);
 781
 782         return 0;
 783 }
 784
 785 static int es8316_suspend(struct snd_soc_component *component)
 786 {
 787         struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
 788
 789         regcache_cache_only(es8316->regmap, true);
 790         regcache_mark_dirty(es8316->regmap);
 791
 792         return 0;
 793 }
 794
 795 static const struct snd_soc_component_driver soc_component_dev_es8316 = {
 796         .probe                  = es8316_probe,
 797         .remove                 = es8316_remove,
 798         .resume                 = es8316_resume,
 799         .suspend                = es8316_suspend,
 800         .set_jack               = es8316_set_jack,
 801         .controls               = es8316_snd_controls,
 802         .num_controls           = ARRAY_SIZE(es8316_snd_controls),
 803         .dapm_widgets           = es8316_dapm_widgets,
 804         .num_dapm_widgets       = ARRAY_SIZE(es8316_dapm_widgets),
 805         .dapm_routes            = es8316_dapm_routes,
 806         .num_dapm_routes        = ARRAY_SIZE(es8316_dapm_routes),
 807         .use_pmdown_time        = 1,
 808         .endianness             = 1,
 809 };
 810
 811 static bool es8316_volatile_reg(struct device *dev, unsigned int reg)
 812 {
 813         switch (reg) {
 814         case ES8316_GPIO_FLAG:
 815                 return true;
 816         default:
 817                 return false;
 818         }
 819 }
 820
 821 static const struct regmap_config es8316_regmap = {
 822         .reg_bits = 8,
 823         .val_bits = 8,
 824         .use_single_read = true,
 825         .use_single_write = true,
 826         .max_register = 0x53,
 827         .volatile_reg = es8316_volatile_reg,
 828         .cache_type = REGCACHE_MAPLE,
 829 };
 830
 831 static int es8316_i2c_probe(struct i2c_client *i2c_client)
 832 {
 833         struct device *dev = &i2c_client->dev;
 834         struct es8316_priv *es8316;
 835         int ret;
 836
 837         es8316 = devm_kzalloc(&i2c_client->dev, sizeof(struct es8316_priv),
 838                               GFP_KERNEL);
 839         if (es8316 == NULL)
 840                 return -ENOMEM;
 841
 842         i2c_set_clientdata(i2c_client, es8316);
 843
 844         es8316->regmap = devm_regmap_init_i2c(i2c_client, &es8316_regmap);
 845         if (IS_ERR(es8316->regmap))
 846                 return PTR_ERR(es8316->regmap);
 847
 848         es8316->irq = i2c_client->irq;
 849         mutex_init(&es8316->lock);
 850
 851         if (es8316->irq > 0) {
 852                 ret = devm_request_threaded_irq(dev, es8316->irq, NULL, es8316_irq,
 853                                                 IRQF_TRIGGER_HIGH | IRQF_ONESHOT | IRQF_NO_AUTOEN,
 854                                                 "es8316", es8316);
 855                 if (ret) {
 856                         dev_warn(dev, "Failed to get IRQ %d: %d\n", es8316->irq, ret);
 857                         es8316->irq = -ENXIO;
 858                 }
 859         }
 860
 861         return devm_snd_soc_register_component(&i2c_client->dev,
 862                                       &soc_component_dev_es8316,
 863                                       &es8316_dai, 1);
 864 }
 865
 866 static const struct i2c_device_id es8316_i2c_id[] = {
 867         {"es8316", 0 },
 868         {}
 869 };
 870 MODULE_DEVICE_TABLE(i2c, es8316_i2c_id);
 871
 872 #ifdef CONFIG_OF
 873 static const struct of_device_id es8316_of_match[] = {
 874         { .compatible = "everest,es8316", },
 875         {},
 876 };
 877 MODULE_DEVICE_TABLE(of, es8316_of_match);
 878 #endif
 879
 880 #ifdef CONFIG_ACPI
 881 static const struct acpi_device_id es8316_acpi_match[] = {
 882         {"ESSX8316", 0},
 883         {"ESSX8336", 0},
 884         {},
 885 };
 886 MODULE_DEVICE_TABLE(acpi, es8316_acpi_match);
 887 #endif
 888
 889 static struct i2c_driver es8316_i2c_driver = {
 890         .driver = {
 891                 .name                   = "es8316",
 892                 .acpi_match_table       = ACPI_PTR(es8316_acpi_match),
 893                 .of_match_table         = of_match_ptr(es8316_of_match),
 894         },
 895         .probe          = es8316_i2c_probe,
 896         .id_table       = es8316_i2c_id,
 897 };
 898 module_i2c_driver(es8316_i2c_driver);
 899
 900 MODULE_DESCRIPTION("Everest Semi ES8316 ALSA SoC Codec Driver");
 901 MODULE_AUTHOR("David Yang <yangxiaohua@everest-semi.com>");
 902 MODULE_LICENSE("GPL v2");