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