xref: /openbmc/linux/sound/soc/codecs/es8316.c (revision 4b33b5ff)
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 6
31 static const unsigned int supported_mclk_lrck_ratios[] = {
32 	256, 384, 400, 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 static const SNDRV_CTL_TLVD_DECLARE_DB_SCALE(alc_target_tlv, -1650, 150, 0);
56 static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(hpmixer_gain_tlv,
57 	0, 4, TLV_DB_SCALE_ITEM(-1200, 150, 0),
58 	8, 11, TLV_DB_SCALE_ITEM(-450, 150, 0),
59 );
60 
61 static const SNDRV_CTL_TLVD_DECLARE_DB_RANGE(adc_pga_gain_tlv,
62 	0, 0, TLV_DB_SCALE_ITEM(-350, 0, 0),
63 	1, 1, TLV_DB_SCALE_ITEM(0, 0, 0),
64 	2, 2, TLV_DB_SCALE_ITEM(250, 0, 0),
65 	3, 3, TLV_DB_SCALE_ITEM(450, 0, 0),
66 	4, 7, TLV_DB_SCALE_ITEM(700, 300, 0),
67 	8, 10, TLV_DB_SCALE_ITEM(1800, 300, 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 		       4, 0, 11, 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, ret;
364 	int count = 0;
365 
366 	es8316->sysclk = freq;
367 
368 	if (freq == 0) {
369 		es8316->sysclk_constraints.list = NULL;
370 		es8316->sysclk_constraints.count = 0;
371 
372 		return 0;
373 	}
374 
375 	ret = clk_set_rate(es8316->mclk, freq);
376 	if (ret)
377 		return ret;
378 
379 	/* Limit supported sample rates to ones that can be autodetected
380 	 * by the codec running in slave mode.
381 	 */
382 	for (i = 0; i < NR_SUPPORTED_MCLK_LRCK_RATIOS; i++) {
383 		const unsigned int ratio = supported_mclk_lrck_ratios[i];
384 
385 		if (freq % ratio == 0)
386 			es8316->allowed_rates[count++] = freq / ratio;
387 	}
388 
389 	es8316->sysclk_constraints.list = es8316->allowed_rates;
390 	es8316->sysclk_constraints.count = count;
391 
392 	return 0;
393 }
394 
395 static int es8316_set_dai_fmt(struct snd_soc_dai *codec_dai,
396 			      unsigned int fmt)
397 {
398 	struct snd_soc_component *component = codec_dai->component;
399 	u8 serdata1 = 0;
400 	u8 serdata2 = 0;
401 	u8 clksw;
402 	u8 mask;
403 
404 	if ((fmt & SND_SOC_DAIFMT_CLOCK_PROVIDER_MASK) != SND_SOC_DAIFMT_CBC_CFC) {
405 		dev_err(component->dev, "Codec driver only supports consumer mode\n");
406 		return -EINVAL;
407 	}
408 
409 	if ((fmt & SND_SOC_DAIFMT_FORMAT_MASK) != SND_SOC_DAIFMT_I2S) {
410 		dev_err(component->dev, "Codec driver only supports I2S format\n");
411 		return -EINVAL;
412 	}
413 
414 	/* Clock inversion */
415 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
416 	case SND_SOC_DAIFMT_NB_NF:
417 		break;
418 	case SND_SOC_DAIFMT_IB_IF:
419 		serdata1 |= ES8316_SERDATA1_BCLK_INV;
420 		serdata2 |= ES8316_SERDATA2_ADCLRP;
421 		break;
422 	case SND_SOC_DAIFMT_IB_NF:
423 		serdata1 |= ES8316_SERDATA1_BCLK_INV;
424 		break;
425 	case SND_SOC_DAIFMT_NB_IF:
426 		serdata2 |= ES8316_SERDATA2_ADCLRP;
427 		break;
428 	default:
429 		return -EINVAL;
430 	}
431 
432 	mask = ES8316_SERDATA1_MASTER | ES8316_SERDATA1_BCLK_INV;
433 	snd_soc_component_update_bits(component, ES8316_SERDATA1, mask, serdata1);
434 
435 	mask = ES8316_SERDATA2_FMT_MASK | ES8316_SERDATA2_ADCLRP;
436 	snd_soc_component_update_bits(component, ES8316_SERDATA_ADC, mask, serdata2);
437 	snd_soc_component_update_bits(component, ES8316_SERDATA_DAC, mask, serdata2);
438 
439 	/* Enable BCLK and MCLK inputs in slave mode */
440 	clksw = ES8316_CLKMGR_CLKSW_MCLK_ON | ES8316_CLKMGR_CLKSW_BCLK_ON;
441 	snd_soc_component_update_bits(component, ES8316_CLKMGR_CLKSW, clksw, clksw);
442 
443 	return 0;
444 }
445 
446 static int es8316_pcm_startup(struct snd_pcm_substream *substream,
447 			      struct snd_soc_dai *dai)
448 {
449 	struct snd_soc_component *component = dai->component;
450 	struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
451 
452 	if (es8316->sysclk_constraints.list)
453 		snd_pcm_hw_constraint_list(substream->runtime, 0,
454 					   SNDRV_PCM_HW_PARAM_RATE,
455 					   &es8316->sysclk_constraints);
456 
457 	return 0;
458 }
459 
460 static int es8316_pcm_hw_params(struct snd_pcm_substream *substream,
461 				struct snd_pcm_hw_params *params,
462 				struct snd_soc_dai *dai)
463 {
464 	struct snd_soc_component *component = dai->component;
465 	struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
466 	u8 wordlen = 0;
467 	int i;
468 
469 	/* Validate supported sample rates that are autodetected from MCLK */
470 	for (i = 0; i < NR_SUPPORTED_MCLK_LRCK_RATIOS; i++) {
471 		const unsigned int ratio = supported_mclk_lrck_ratios[i];
472 
473 		if (es8316->sysclk % ratio != 0)
474 			continue;
475 		if (es8316->sysclk / ratio == params_rate(params))
476 			break;
477 	}
478 	if (i == NR_SUPPORTED_MCLK_LRCK_RATIOS)
479 		return -EINVAL;
480 
481 	switch (params_format(params)) {
482 	case SNDRV_PCM_FORMAT_S16_LE:
483 		wordlen = ES8316_SERDATA2_LEN_16;
484 		break;
485 	case SNDRV_PCM_FORMAT_S20_3LE:
486 		wordlen = ES8316_SERDATA2_LEN_20;
487 		break;
488 	case SNDRV_PCM_FORMAT_S24_LE:
489 		wordlen = ES8316_SERDATA2_LEN_24;
490 		break;
491 	case SNDRV_PCM_FORMAT_S32_LE:
492 		wordlen = ES8316_SERDATA2_LEN_32;
493 		break;
494 	default:
495 		return -EINVAL;
496 	}
497 
498 	snd_soc_component_update_bits(component, ES8316_SERDATA_DAC,
499 			    ES8316_SERDATA2_LEN_MASK, wordlen);
500 	snd_soc_component_update_bits(component, ES8316_SERDATA_ADC,
501 			    ES8316_SERDATA2_LEN_MASK, wordlen);
502 	return 0;
503 }
504 
505 static int es8316_mute(struct snd_soc_dai *dai, int mute, int direction)
506 {
507 	snd_soc_component_update_bits(dai->component, ES8316_DAC_SET1, 0x20,
508 			    mute ? 0x20 : 0);
509 	return 0;
510 }
511 
512 #define ES8316_FORMATS (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
513 			SNDRV_PCM_FMTBIT_S24_LE)
514 
515 static const struct snd_soc_dai_ops es8316_ops = {
516 	.startup = es8316_pcm_startup,
517 	.hw_params = es8316_pcm_hw_params,
518 	.set_fmt = es8316_set_dai_fmt,
519 	.set_sysclk = es8316_set_dai_sysclk,
520 	.mute_stream = es8316_mute,
521 	.no_capture_mute = 1,
522 };
523 
524 static struct snd_soc_dai_driver es8316_dai = {
525 	.name = "ES8316 HiFi",
526 	.playback = {
527 		.stream_name = "Playback",
528 		.channels_min = 1,
529 		.channels_max = 2,
530 		.rates = SNDRV_PCM_RATE_8000_48000,
531 		.formats = ES8316_FORMATS,
532 	},
533 	.capture = {
534 		.stream_name = "Capture",
535 		.channels_min = 1,
536 		.channels_max = 2,
537 		.rates = SNDRV_PCM_RATE_8000_48000,
538 		.formats = ES8316_FORMATS,
539 	},
540 	.ops = &es8316_ops,
541 	.symmetric_rate = 1,
542 };
543 
544 static void es8316_enable_micbias_for_mic_gnd_short_detect(
545 	struct snd_soc_component *component)
546 {
547 	struct snd_soc_dapm_context *dapm = snd_soc_component_get_dapm(component);
548 
549 	snd_soc_dapm_mutex_lock(dapm);
550 	snd_soc_dapm_force_enable_pin_unlocked(dapm, "Bias");
551 	snd_soc_dapm_force_enable_pin_unlocked(dapm, "Analog power");
552 	snd_soc_dapm_force_enable_pin_unlocked(dapm, "Mic Bias");
553 	snd_soc_dapm_sync_unlocked(dapm);
554 	snd_soc_dapm_mutex_unlock(dapm);
555 
556 	msleep(20);
557 }
558 
559 static void es8316_disable_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_disable_pin_unlocked(dapm, "Mic Bias");
566 	snd_soc_dapm_disable_pin_unlocked(dapm, "Analog power");
567 	snd_soc_dapm_disable_pin_unlocked(dapm, "Bias");
568 	snd_soc_dapm_sync_unlocked(dapm);
569 	snd_soc_dapm_mutex_unlock(dapm);
570 }
571 
572 static irqreturn_t es8316_irq(int irq, void *data)
573 {
574 	struct es8316_priv *es8316 = data;
575 	struct snd_soc_component *comp = es8316->component;
576 	unsigned int flags;
577 
578 	mutex_lock(&es8316->lock);
579 
580 	regmap_read(es8316->regmap, ES8316_GPIO_FLAG, &flags);
581 	if (flags == 0x00)
582 		goto out; /* Powered-down / reset */
583 
584 	/* Catch spurious IRQ before set_jack is called */
585 	if (!es8316->jack)
586 		goto out;
587 
588 	if (es8316->jd_inverted)
589 		flags ^= ES8316_GPIO_FLAG_HP_NOT_INSERTED;
590 
591 	dev_dbg(comp->dev, "gpio flags %#04x\n", flags);
592 	if (flags & ES8316_GPIO_FLAG_HP_NOT_INSERTED) {
593 		/* Jack removed, or spurious IRQ? */
594 		if (es8316->jack->status & SND_JACK_MICROPHONE)
595 			es8316_disable_micbias_for_mic_gnd_short_detect(comp);
596 
597 		if (es8316->jack->status & SND_JACK_HEADPHONE) {
598 			snd_soc_jack_report(es8316->jack, 0,
599 					    SND_JACK_HEADSET | SND_JACK_BTN_0);
600 			dev_dbg(comp->dev, "jack unplugged\n");
601 		}
602 	} else if (!(es8316->jack->status & SND_JACK_HEADPHONE)) {
603 		/* Jack inserted, determine type */
604 		es8316_enable_micbias_for_mic_gnd_short_detect(comp);
605 		regmap_read(es8316->regmap, ES8316_GPIO_FLAG, &flags);
606 		if (es8316->jd_inverted)
607 			flags ^= ES8316_GPIO_FLAG_HP_NOT_INSERTED;
608 		dev_dbg(comp->dev, "gpio flags %#04x\n", flags);
609 		if (flags & ES8316_GPIO_FLAG_HP_NOT_INSERTED) {
610 			/* Jack unplugged underneath us */
611 			es8316_disable_micbias_for_mic_gnd_short_detect(comp);
612 		} else if (flags & ES8316_GPIO_FLAG_GM_NOT_SHORTED) {
613 			/* Open, headset */
614 			snd_soc_jack_report(es8316->jack,
615 					    SND_JACK_HEADSET,
616 					    SND_JACK_HEADSET);
617 			/* Keep mic-gnd-short detection on for button press */
618 		} else {
619 			/* Shorted, headphones */
620 			snd_soc_jack_report(es8316->jack,
621 					    SND_JACK_HEADPHONE,
622 					    SND_JACK_HEADSET);
623 			/* No longer need mic-gnd-short detection */
624 			es8316_disable_micbias_for_mic_gnd_short_detect(comp);
625 		}
626 	} else if (es8316->jack->status & SND_JACK_MICROPHONE) {
627 		/* Interrupt while jack inserted, report button state */
628 		if (flags & ES8316_GPIO_FLAG_GM_NOT_SHORTED) {
629 			/* Open, button release */
630 			snd_soc_jack_report(es8316->jack, 0, SND_JACK_BTN_0);
631 		} else {
632 			/* Short, button press */
633 			snd_soc_jack_report(es8316->jack,
634 					    SND_JACK_BTN_0,
635 					    SND_JACK_BTN_0);
636 		}
637 	}
638 
639 out:
640 	mutex_unlock(&es8316->lock);
641 	return IRQ_HANDLED;
642 }
643 
644 static void es8316_enable_jack_detect(struct snd_soc_component *component,
645 				      struct snd_soc_jack *jack)
646 {
647 	struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
648 
649 	/*
650 	 * Init es8316->jd_inverted here and not in the probe, as we cannot
651 	 * guarantee that the bytchr-es8316 driver, which might set this
652 	 * property, will probe before us.
653 	 */
654 	es8316->jd_inverted = device_property_read_bool(component->dev,
655 							"everest,jack-detect-inverted");
656 
657 	mutex_lock(&es8316->lock);
658 
659 	es8316->jack = jack;
660 
661 	if (es8316->jack->status & SND_JACK_MICROPHONE)
662 		es8316_enable_micbias_for_mic_gnd_short_detect(component);
663 
664 	snd_soc_component_update_bits(component, ES8316_GPIO_DEBOUNCE,
665 				      ES8316_GPIO_ENABLE_INTERRUPT,
666 				      ES8316_GPIO_ENABLE_INTERRUPT);
667 
668 	mutex_unlock(&es8316->lock);
669 
670 	/* Enable irq and sync initial jack state */
671 	enable_irq(es8316->irq);
672 	es8316_irq(es8316->irq, es8316);
673 }
674 
675 static void es8316_disable_jack_detect(struct snd_soc_component *component)
676 {
677 	struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
678 
679 	if (!es8316->jack)
680 		return; /* Already disabled (or never enabled) */
681 
682 	disable_irq(es8316->irq);
683 
684 	mutex_lock(&es8316->lock);
685 
686 	snd_soc_component_update_bits(component, ES8316_GPIO_DEBOUNCE,
687 				      ES8316_GPIO_ENABLE_INTERRUPT, 0);
688 
689 	if (es8316->jack->status & SND_JACK_MICROPHONE) {
690 		es8316_disable_micbias_for_mic_gnd_short_detect(component);
691 		snd_soc_jack_report(es8316->jack, 0, SND_JACK_BTN_0);
692 	}
693 
694 	es8316->jack = NULL;
695 
696 	mutex_unlock(&es8316->lock);
697 }
698 
699 static int es8316_set_jack(struct snd_soc_component *component,
700 			   struct snd_soc_jack *jack, void *data)
701 {
702 	if (jack)
703 		es8316_enable_jack_detect(component, jack);
704 	else
705 		es8316_disable_jack_detect(component);
706 
707 	return 0;
708 }
709 
710 static int es8316_probe(struct snd_soc_component *component)
711 {
712 	struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
713 	int ret;
714 
715 	es8316->component = component;
716 
717 	es8316->mclk = devm_clk_get_optional(component->dev, "mclk");
718 	if (IS_ERR(es8316->mclk)) {
719 		dev_err(component->dev, "unable to get mclk\n");
720 		return PTR_ERR(es8316->mclk);
721 	}
722 	if (!es8316->mclk)
723 		dev_warn(component->dev, "assuming static mclk\n");
724 
725 	ret = clk_prepare_enable(es8316->mclk);
726 	if (ret) {
727 		dev_err(component->dev, "unable to enable mclk\n");
728 		return ret;
729 	}
730 
731 	/* Reset codec and enable current state machine */
732 	snd_soc_component_write(component, ES8316_RESET, 0x3f);
733 	usleep_range(5000, 5500);
734 	snd_soc_component_write(component, ES8316_RESET, ES8316_RESET_CSM_ON);
735 	msleep(30);
736 
737 	/*
738 	 * Documentation is unclear, but this value from the vendor driver is
739 	 * needed otherwise audio output is silent.
740 	 */
741 	snd_soc_component_write(component, ES8316_SYS_VMIDSEL, 0xff);
742 
743 	/*
744 	 * Documentation for this register is unclear and incomplete,
745 	 * but here is a vendor-provided value that improves volume
746 	 * and quality for Intel CHT platforms.
747 	 */
748 	snd_soc_component_write(component, ES8316_CLKMGR_ADCOSR, 0x32);
749 
750 	return 0;
751 }
752 
753 static void es8316_remove(struct snd_soc_component *component)
754 {
755 	struct es8316_priv *es8316 = snd_soc_component_get_drvdata(component);
756 
757 	clk_disable_unprepare(es8316->mclk);
758 }
759 
760 static const struct snd_soc_component_driver soc_component_dev_es8316 = {
761 	.probe			= es8316_probe,
762 	.remove			= es8316_remove,
763 	.set_jack		= es8316_set_jack,
764 	.controls		= es8316_snd_controls,
765 	.num_controls		= ARRAY_SIZE(es8316_snd_controls),
766 	.dapm_widgets		= es8316_dapm_widgets,
767 	.num_dapm_widgets	= ARRAY_SIZE(es8316_dapm_widgets),
768 	.dapm_routes		= es8316_dapm_routes,
769 	.num_dapm_routes	= ARRAY_SIZE(es8316_dapm_routes),
770 	.use_pmdown_time	= 1,
771 	.endianness		= 1,
772 	.non_legacy_dai_naming	= 1,
773 };
774 
775 static const struct regmap_range es8316_volatile_ranges[] = {
776 	regmap_reg_range(ES8316_GPIO_FLAG, ES8316_GPIO_FLAG),
777 };
778 
779 static const struct regmap_access_table es8316_volatile_table = {
780 	.yes_ranges	= es8316_volatile_ranges,
781 	.n_yes_ranges	= ARRAY_SIZE(es8316_volatile_ranges),
782 };
783 
784 static const struct regmap_config es8316_regmap = {
785 	.reg_bits = 8,
786 	.val_bits = 8,
787 	.max_register = 0x53,
788 	.volatile_table	= &es8316_volatile_table,
789 	.cache_type = REGCACHE_RBTREE,
790 };
791 
792 static int es8316_i2c_probe(struct i2c_client *i2c_client,
793 			    const struct i2c_device_id *id)
794 {
795 	struct device *dev = &i2c_client->dev;
796 	struct es8316_priv *es8316;
797 	int ret;
798 
799 	es8316 = devm_kzalloc(&i2c_client->dev, sizeof(struct es8316_priv),
800 			      GFP_KERNEL);
801 	if (es8316 == NULL)
802 		return -ENOMEM;
803 
804 	i2c_set_clientdata(i2c_client, es8316);
805 
806 	es8316->regmap = devm_regmap_init_i2c(i2c_client, &es8316_regmap);
807 	if (IS_ERR(es8316->regmap))
808 		return PTR_ERR(es8316->regmap);
809 
810 	es8316->irq = i2c_client->irq;
811 	mutex_init(&es8316->lock);
812 
813 	ret = devm_request_threaded_irq(dev, es8316->irq, NULL, es8316_irq,
814 					IRQF_TRIGGER_HIGH | IRQF_ONESHOT | IRQF_NO_AUTOEN,
815 					"es8316", es8316);
816 	if (ret) {
817 		dev_warn(dev, "Failed to get IRQ %d: %d\n", es8316->irq, ret);
818 		es8316->irq = -ENXIO;
819 	}
820 
821 	return devm_snd_soc_register_component(&i2c_client->dev,
822 				      &soc_component_dev_es8316,
823 				      &es8316_dai, 1);
824 }
825 
826 static const struct i2c_device_id es8316_i2c_id[] = {
827 	{"es8316", 0 },
828 	{}
829 };
830 MODULE_DEVICE_TABLE(i2c, es8316_i2c_id);
831 
832 #ifdef CONFIG_OF
833 static const struct of_device_id es8316_of_match[] = {
834 	{ .compatible = "everest,es8316", },
835 	{},
836 };
837 MODULE_DEVICE_TABLE(of, es8316_of_match);
838 #endif
839 
840 #ifdef CONFIG_ACPI
841 static const struct acpi_device_id es8316_acpi_match[] = {
842 	{"ESSX8316", 0},
843 	{"ESSX8336", 0},
844 	{},
845 };
846 MODULE_DEVICE_TABLE(acpi, es8316_acpi_match);
847 #endif
848 
849 static struct i2c_driver es8316_i2c_driver = {
850 	.driver = {
851 		.name			= "es8316",
852 		.acpi_match_table	= ACPI_PTR(es8316_acpi_match),
853 		.of_match_table		= of_match_ptr(es8316_of_match),
854 	},
855 	.probe		= es8316_i2c_probe,
856 	.id_table	= es8316_i2c_id,
857 };
858 module_i2c_driver(es8316_i2c_driver);
859 
860 MODULE_DESCRIPTION("Everest Semi ES8316 ALSA SoC Codec Driver");
861 MODULE_AUTHOR("David Yang <yangxiaohua@everest-semi.com>");
862 MODULE_LICENSE("GPL v2");
863