xref: /linux/sound/soc/codecs/cs42l51.c (revision ca853314e78b0a65c20b6a889a23c31f918d4aa2)
1 // SPDX-License-Identifier: GPL-2.0-only
2 /*
3  * cs42l51.c
4  *
5  * ASoC Driver for Cirrus Logic CS42L51 codecs
6  *
7  * Copyright (c) 2010 Arnaud Patard <apatard@mandriva.com>
8  *
9  * Based on cs4270.c - Copyright (c) Freescale Semiconductor
10  *
11  * For now:
12  *  - Only I2C is support. Not SPI
13  *  - master mode *NOT* supported
14  */
15 
16 #include <linux/clk.h>
17 #include <linux/module.h>
18 #include <linux/slab.h>
19 #include <sound/core.h>
20 #include <sound/soc.h>
21 #include <sound/tlv.h>
22 #include <sound/initval.h>
23 #include <sound/pcm_params.h>
24 #include <sound/pcm.h>
25 #include <linux/gpio/consumer.h>
26 #include <linux/regmap.h>
27 #include <linux/regulator/consumer.h>
28 
29 #include "cs42l51.h"
30 
31 enum master_slave_mode {
32 	MODE_SLAVE,
33 	MODE_SLAVE_AUTO,
34 	MODE_MASTER,
35 };
36 
37 static const char * const cs42l51_supply_names[] = {
38 	"VL",
39 	"VD",
40 	"VA",
41 	"VAHP",
42 };
43 
44 struct cs42l51_private {
45 	unsigned int mclk;
46 	struct clk *mclk_handle;
47 	unsigned int audio_mode;	/* The mode (I2S or left-justified) */
48 	enum master_slave_mode func;
49 	struct regulator_bulk_data supplies[ARRAY_SIZE(cs42l51_supply_names)];
50 	struct gpio_desc *reset_gpio;
51 	struct regmap *regmap;
52 };
53 
54 #define CS42L51_FORMATS ( \
55 		SNDRV_PCM_FMTBIT_S16_LE  | SNDRV_PCM_FMTBIT_S16_BE  | \
56 		SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S18_3BE | \
57 		SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S20_3BE | \
58 		SNDRV_PCM_FMTBIT_S24_LE  | SNDRV_PCM_FMTBIT_S24_BE)
59 
60 static int cs42l51_get_chan_mix(struct snd_kcontrol *kcontrol,
61 			struct snd_ctl_elem_value *ucontrol)
62 {
63 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
64 	unsigned long value = snd_soc_component_read(component, CS42L51_PCM_MIXER)&3;
65 
66 	switch (value) {
67 	default:
68 	case 0:
69 		ucontrol->value.enumerated.item[0] = 0;
70 		break;
71 	/* same value : (L+R)/2 and (R+L)/2 */
72 	case 1:
73 	case 2:
74 		ucontrol->value.enumerated.item[0] = 1;
75 		break;
76 	case 3:
77 		ucontrol->value.enumerated.item[0] = 2;
78 		break;
79 	}
80 
81 	return 0;
82 }
83 
84 #define CHAN_MIX_NORMAL	0x00
85 #define CHAN_MIX_BOTH	0x55
86 #define CHAN_MIX_SWAP	0xFF
87 
88 static int cs42l51_set_chan_mix(struct snd_kcontrol *kcontrol,
89 			struct snd_ctl_elem_value *ucontrol)
90 {
91 	struct snd_soc_component *component = snd_soc_kcontrol_component(kcontrol);
92 	unsigned char val;
93 
94 	switch (ucontrol->value.enumerated.item[0]) {
95 	default:
96 	case 0:
97 		val = CHAN_MIX_NORMAL;
98 		break;
99 	case 1:
100 		val = CHAN_MIX_BOTH;
101 		break;
102 	case 2:
103 		val = CHAN_MIX_SWAP;
104 		break;
105 	}
106 
107 	snd_soc_component_write(component, CS42L51_PCM_MIXER, val);
108 
109 	return 1;
110 }
111 
112 static const DECLARE_TLV_DB_SCALE(adc_pcm_tlv, -5150, 50, 0);
113 static const DECLARE_TLV_DB_SCALE(tone_tlv, -1050, 150, 0);
114 
115 static const DECLARE_TLV_DB_SCALE(aout_tlv, -10200, 50, 0);
116 
117 static const DECLARE_TLV_DB_SCALE(boost_tlv, 1600, 1600, 0);
118 static const DECLARE_TLV_DB_SCALE(adc_boost_tlv, 2000, 2000, 0);
119 static const char *chan_mix[] = {
120 	"L R",
121 	"L+R",
122 	"R L",
123 };
124 
125 static const DECLARE_TLV_DB_SCALE(pga_tlv, -300, 50, 0);
126 static const DECLARE_TLV_DB_SCALE(adc_att_tlv, -9600, 100, 0);
127 
128 static SOC_ENUM_SINGLE_EXT_DECL(cs42l51_chan_mix, chan_mix);
129 
130 static const struct snd_kcontrol_new cs42l51_snd_controls[] = {
131 	SOC_DOUBLE_R_SX_TLV("PCM Playback Volume",
132 			CS42L51_PCMA_VOL, CS42L51_PCMB_VOL,
133 			0, 0x19, 0x7F, adc_pcm_tlv),
134 	SOC_DOUBLE_R("PCM Playback Switch",
135 			CS42L51_PCMA_VOL, CS42L51_PCMB_VOL, 7, 1, 1),
136 	SOC_DOUBLE_R_SX_TLV("Analog Playback Volume",
137 			CS42L51_AOUTA_VOL, CS42L51_AOUTB_VOL,
138 			0, 0x34, 0xE4, aout_tlv),
139 	SOC_DOUBLE_R_SX_TLV("ADC Mixer Volume",
140 			CS42L51_ADCA_VOL, CS42L51_ADCB_VOL,
141 			0, 0x19, 0x7F, adc_pcm_tlv),
142 	SOC_DOUBLE_R("ADC Mixer Switch",
143 			CS42L51_ADCA_VOL, CS42L51_ADCB_VOL, 7, 1, 1),
144 	SOC_DOUBLE_R_SX_TLV("ADC Attenuator Volume",
145 			CS42L51_ADCA_ATT, CS42L51_ADCB_ATT,
146 			0, 0xA0, 96, adc_att_tlv),
147 	SOC_DOUBLE_R_SX_TLV("PGA Volume",
148 			CS42L51_ALC_PGA_CTL, CS42L51_ALC_PGB_CTL,
149 			0, 0x1A, 30, pga_tlv),
150 	SOC_SINGLE("Playback Deemphasis Switch", CS42L51_DAC_CTL, 3, 1, 0),
151 	SOC_SINGLE("Auto-Mute Switch", CS42L51_DAC_CTL, 2, 1, 0),
152 	SOC_SINGLE("Soft Ramp Switch", CS42L51_DAC_CTL, 1, 1, 0),
153 	SOC_SINGLE("Zero Cross Switch", CS42L51_DAC_CTL, 0, 0, 0),
154 	SOC_DOUBLE_TLV("Mic Boost Volume",
155 			CS42L51_MIC_CTL, 0, 1, 1, 0, boost_tlv),
156 	SOC_DOUBLE_TLV("ADC Boost Volume",
157 		       CS42L51_MIC_CTL, 5, 6, 1, 0, adc_boost_tlv),
158 	SOC_SINGLE_TLV("Bass Volume", CS42L51_TONE_CTL, 0, 0xf, 1, tone_tlv),
159 	SOC_SINGLE_TLV("Treble Volume", CS42L51_TONE_CTL, 4, 0xf, 1, tone_tlv),
160 	SOC_ENUM_EXT("PCM channel mixer",
161 			cs42l51_chan_mix,
162 			cs42l51_get_chan_mix, cs42l51_set_chan_mix),
163 };
164 
165 /*
166  * to power down, one must:
167  * 1.) Enable the PDN bit
168  * 2.) enable power-down for the select channels
169  * 3.) disable the PDN bit.
170  */
171 static int cs42l51_pdn_event(struct snd_soc_dapm_widget *w,
172 		struct snd_kcontrol *kcontrol, int event)
173 {
174 	struct snd_soc_component *component = snd_soc_dapm_to_component(w->dapm);
175 
176 	switch (event) {
177 	case SND_SOC_DAPM_PRE_PMD:
178 		snd_soc_component_update_bits(component, CS42L51_POWER_CTL1,
179 				    CS42L51_POWER_CTL1_PDN,
180 				    CS42L51_POWER_CTL1_PDN);
181 		break;
182 	default:
183 	case SND_SOC_DAPM_POST_PMD:
184 		snd_soc_component_update_bits(component, CS42L51_POWER_CTL1,
185 				    CS42L51_POWER_CTL1_PDN, 0);
186 		break;
187 	}
188 
189 	return 0;
190 }
191 
192 static const char *cs42l51_dac_names[] = {"Direct PCM",
193 	"DSP PCM", "ADC"};
194 static SOC_ENUM_SINGLE_DECL(cs42l51_dac_mux_enum,
195 			    CS42L51_DAC_CTL, 6, cs42l51_dac_names);
196 static const struct snd_kcontrol_new cs42l51_dac_mux_controls =
197 	SOC_DAPM_ENUM("Route", cs42l51_dac_mux_enum);
198 
199 static const char *cs42l51_adcl_names[] = {"AIN1 Left", "AIN2 Left",
200 	"MIC Left", "MIC+preamp Left"};
201 static SOC_ENUM_SINGLE_DECL(cs42l51_adcl_mux_enum,
202 			    CS42L51_ADC_INPUT, 4, cs42l51_adcl_names);
203 static const struct snd_kcontrol_new cs42l51_adcl_mux_controls =
204 	SOC_DAPM_ENUM("Route", cs42l51_adcl_mux_enum);
205 
206 static const char *cs42l51_adcr_names[] = {"AIN1 Right", "AIN2 Right",
207 	"MIC Right", "MIC+preamp Right"};
208 static SOC_ENUM_SINGLE_DECL(cs42l51_adcr_mux_enum,
209 			    CS42L51_ADC_INPUT, 6, cs42l51_adcr_names);
210 static const struct snd_kcontrol_new cs42l51_adcr_mux_controls =
211 	SOC_DAPM_ENUM("Route", cs42l51_adcr_mux_enum);
212 
213 static const struct snd_soc_dapm_widget cs42l51_dapm_widgets[] = {
214 	SND_SOC_DAPM_SUPPLY("Mic Bias", CS42L51_MIC_POWER_CTL, 1, 1, NULL,
215 			    SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
216 	SND_SOC_DAPM_PGA_E("Left PGA", CS42L51_POWER_CTL1, 3, 1, NULL, 0,
217 		cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
218 	SND_SOC_DAPM_PGA_E("Right PGA", CS42L51_POWER_CTL1, 4, 1, NULL, 0,
219 		cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
220 	SND_SOC_DAPM_ADC_E("Left ADC", "Left HiFi Capture",
221 		CS42L51_POWER_CTL1, 1, 1,
222 		cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
223 	SND_SOC_DAPM_ADC_E("Right ADC", "Right HiFi Capture",
224 		CS42L51_POWER_CTL1, 2, 1,
225 		cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
226 	SND_SOC_DAPM_DAC_E("Left DAC", NULL, CS42L51_POWER_CTL1, 5, 1,
227 			   cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
228 	SND_SOC_DAPM_DAC_E("Right DAC", NULL, CS42L51_POWER_CTL1, 6, 1,
229 			   cs42l51_pdn_event, SND_SOC_DAPM_PRE_POST_PMD),
230 
231 	/* analog/mic */
232 	SND_SOC_DAPM_INPUT("AIN1L"),
233 	SND_SOC_DAPM_INPUT("AIN1R"),
234 	SND_SOC_DAPM_INPUT("AIN2L"),
235 	SND_SOC_DAPM_INPUT("AIN2R"),
236 	SND_SOC_DAPM_INPUT("MICL"),
237 	SND_SOC_DAPM_INPUT("MICR"),
238 
239 	SND_SOC_DAPM_MIXER("Mic Preamp Left",
240 		CS42L51_MIC_POWER_CTL, 2, 1, NULL, 0),
241 	SND_SOC_DAPM_MIXER("Mic Preamp Right",
242 		CS42L51_MIC_POWER_CTL, 3, 1, NULL, 0),
243 
244 	/* HP */
245 	SND_SOC_DAPM_OUTPUT("HPL"),
246 	SND_SOC_DAPM_OUTPUT("HPR"),
247 
248 	/* mux */
249 	SND_SOC_DAPM_MUX("DAC Mux", SND_SOC_NOPM, 0, 0,
250 		&cs42l51_dac_mux_controls),
251 	SND_SOC_DAPM_MUX("PGA-ADC Mux Left", SND_SOC_NOPM, 0, 0,
252 		&cs42l51_adcl_mux_controls),
253 	SND_SOC_DAPM_MUX("PGA-ADC Mux Right", SND_SOC_NOPM, 0, 0,
254 		&cs42l51_adcr_mux_controls),
255 };
256 
257 static int mclk_event(struct snd_soc_dapm_widget *w,
258 		      struct snd_kcontrol *kcontrol, int event)
259 {
260 	struct snd_soc_component *comp = snd_soc_dapm_to_component(w->dapm);
261 	struct cs42l51_private *cs42l51 = snd_soc_component_get_drvdata(comp);
262 
263 	switch (event) {
264 	case SND_SOC_DAPM_PRE_PMU:
265 		return clk_prepare_enable(cs42l51->mclk_handle);
266 	case SND_SOC_DAPM_POST_PMD:
267 		/* Delay mclk shutdown to fulfill power-down sequence requirements */
268 		msleep(20);
269 		clk_disable_unprepare(cs42l51->mclk_handle);
270 		break;
271 	}
272 
273 	return 0;
274 }
275 
276 static const struct snd_soc_dapm_widget cs42l51_dapm_mclk_widgets[] = {
277 	SND_SOC_DAPM_SUPPLY("MCLK", SND_SOC_NOPM, 0, 0, mclk_event,
278 			    SND_SOC_DAPM_PRE_PMU | SND_SOC_DAPM_POST_PMD),
279 };
280 
281 static const struct snd_soc_dapm_route cs42l51_routes[] = {
282 	{"HPL", NULL, "Left DAC"},
283 	{"HPR", NULL, "Right DAC"},
284 
285 	{"Right DAC", NULL, "DAC Mux"},
286 	{"Left DAC", NULL, "DAC Mux"},
287 
288 	{"DAC Mux", "Direct PCM", "Playback"},
289 	{"DAC Mux", "DSP PCM", "Playback"},
290 
291 	{"Left ADC", NULL, "Left PGA"},
292 	{"Right ADC", NULL, "Right PGA"},
293 
294 	{"Mic Preamp Left",  NULL,  "MICL"},
295 	{"Mic Preamp Right", NULL,  "MICR"},
296 
297 	{"PGA-ADC Mux Left",  "AIN1 Left",        "AIN1L" },
298 	{"PGA-ADC Mux Left",  "AIN2 Left",        "AIN2L" },
299 	{"PGA-ADC Mux Left",  "MIC Left",         "MICL"  },
300 	{"PGA-ADC Mux Left",  "MIC+preamp Left",  "Mic Preamp Left" },
301 	{"PGA-ADC Mux Right", "AIN1 Right",       "AIN1R" },
302 	{"PGA-ADC Mux Right", "AIN2 Right",       "AIN2R" },
303 	{"PGA-ADC Mux Right", "MIC Right",        "MICR" },
304 	{"PGA-ADC Mux Right", "MIC+preamp Right", "Mic Preamp Right" },
305 
306 	{"Left PGA", NULL, "PGA-ADC Mux Left"},
307 	{"Right PGA", NULL, "PGA-ADC Mux Right"},
308 };
309 
310 static int cs42l51_set_dai_fmt(struct snd_soc_dai *codec_dai,
311 		unsigned int format)
312 {
313 	struct snd_soc_component *component = codec_dai->component;
314 	struct cs42l51_private *cs42l51 = snd_soc_component_get_drvdata(component);
315 
316 	switch (format & SND_SOC_DAIFMT_FORMAT_MASK) {
317 	case SND_SOC_DAIFMT_I2S:
318 	case SND_SOC_DAIFMT_LEFT_J:
319 	case SND_SOC_DAIFMT_RIGHT_J:
320 		cs42l51->audio_mode = format & SND_SOC_DAIFMT_FORMAT_MASK;
321 		break;
322 	default:
323 		dev_err(component->dev, "invalid DAI format\n");
324 		return -EINVAL;
325 	}
326 
327 	switch (format & SND_SOC_DAIFMT_MASTER_MASK) {
328 	case SND_SOC_DAIFMT_CBM_CFM:
329 		cs42l51->func = MODE_MASTER;
330 		break;
331 	case SND_SOC_DAIFMT_CBS_CFS:
332 		cs42l51->func = MODE_SLAVE_AUTO;
333 		break;
334 	default:
335 		dev_err(component->dev, "Unknown master/slave configuration\n");
336 		return -EINVAL;
337 	}
338 
339 	return 0;
340 }
341 
342 struct cs42l51_ratios {
343 	unsigned int ratio;
344 	unsigned char speed_mode;
345 	unsigned char mclk;
346 };
347 
348 static struct cs42l51_ratios slave_ratios[] = {
349 	{  512, CS42L51_QSM_MODE, 0 }, {  768, CS42L51_QSM_MODE, 0 },
350 	{ 1024, CS42L51_QSM_MODE, 0 }, { 1536, CS42L51_QSM_MODE, 0 },
351 	{ 2048, CS42L51_QSM_MODE, 0 }, { 3072, CS42L51_QSM_MODE, 0 },
352 	{  256, CS42L51_HSM_MODE, 0 }, {  384, CS42L51_HSM_MODE, 0 },
353 	{  512, CS42L51_HSM_MODE, 0 }, {  768, CS42L51_HSM_MODE, 0 },
354 	{ 1024, CS42L51_HSM_MODE, 0 }, { 1536, CS42L51_HSM_MODE, 0 },
355 	{  128, CS42L51_SSM_MODE, 0 }, {  192, CS42L51_SSM_MODE, 0 },
356 	{  256, CS42L51_SSM_MODE, 0 }, {  384, CS42L51_SSM_MODE, 0 },
357 	{  512, CS42L51_SSM_MODE, 0 }, {  768, CS42L51_SSM_MODE, 0 },
358 	{  128, CS42L51_DSM_MODE, 0 }, {  192, CS42L51_DSM_MODE, 0 },
359 	{  256, CS42L51_DSM_MODE, 0 }, {  384, CS42L51_DSM_MODE, 0 },
360 };
361 
362 static struct cs42l51_ratios slave_auto_ratios[] = {
363 	{ 1024, CS42L51_QSM_MODE, 0 }, { 1536, CS42L51_QSM_MODE, 0 },
364 	{ 2048, CS42L51_QSM_MODE, 1 }, { 3072, CS42L51_QSM_MODE, 1 },
365 	{  512, CS42L51_HSM_MODE, 0 }, {  768, CS42L51_HSM_MODE, 0 },
366 	{ 1024, CS42L51_HSM_MODE, 1 }, { 1536, CS42L51_HSM_MODE, 1 },
367 	{  256, CS42L51_SSM_MODE, 0 }, {  384, CS42L51_SSM_MODE, 0 },
368 	{  512, CS42L51_SSM_MODE, 1 }, {  768, CS42L51_SSM_MODE, 1 },
369 	{  128, CS42L51_DSM_MODE, 0 }, {  192, CS42L51_DSM_MODE, 0 },
370 	{  256, CS42L51_DSM_MODE, 1 }, {  384, CS42L51_DSM_MODE, 1 },
371 };
372 
373 /*
374  * Master mode mclk/fs ratios.
375  * Recommended configurations are SSM for 4-50khz and DSM for 50-100kHz ranges
376  * The table below provides support of following ratios:
377  * 128: SSM (%128) with div2 disabled
378  * 256: SSM (%128) with div2 enabled
379  * In both cases, if sampling rate is above 50kHz, SSM is overridden
380  * with DSM (%128) configuration
381  */
382 static struct cs42l51_ratios master_ratios[] = {
383 	{ 128, CS42L51_SSM_MODE, 0 }, { 256, CS42L51_SSM_MODE, 1 },
384 };
385 
386 static int cs42l51_set_dai_sysclk(struct snd_soc_dai *codec_dai,
387 		int clk_id, unsigned int freq, int dir)
388 {
389 	struct snd_soc_component *component = codec_dai->component;
390 	struct cs42l51_private *cs42l51 = snd_soc_component_get_drvdata(component);
391 
392 	cs42l51->mclk = freq;
393 	return 0;
394 }
395 
396 static int cs42l51_hw_params(struct snd_pcm_substream *substream,
397 		struct snd_pcm_hw_params *params,
398 		struct snd_soc_dai *dai)
399 {
400 	struct snd_soc_component *component = dai->component;
401 	struct cs42l51_private *cs42l51 = snd_soc_component_get_drvdata(component);
402 	int ret;
403 	unsigned int i;
404 	unsigned int rate;
405 	unsigned int ratio;
406 	struct cs42l51_ratios *ratios = NULL;
407 	int nr_ratios = 0;
408 	int intf_ctl, power_ctl, fmt, mode;
409 
410 	switch (cs42l51->func) {
411 	case MODE_MASTER:
412 		ratios = master_ratios;
413 		nr_ratios = ARRAY_SIZE(master_ratios);
414 		break;
415 	case MODE_SLAVE:
416 		ratios = slave_ratios;
417 		nr_ratios = ARRAY_SIZE(slave_ratios);
418 		break;
419 	case MODE_SLAVE_AUTO:
420 		ratios = slave_auto_ratios;
421 		nr_ratios = ARRAY_SIZE(slave_auto_ratios);
422 		break;
423 	}
424 
425 	/* Figure out which MCLK/LRCK ratio to use */
426 	rate = params_rate(params);     /* Sampling rate, in Hz */
427 	ratio = cs42l51->mclk / rate;    /* MCLK/LRCK ratio */
428 	for (i = 0; i < nr_ratios; i++) {
429 		if (ratios[i].ratio == ratio)
430 			break;
431 	}
432 
433 	if (i == nr_ratios) {
434 		/* We did not find a matching ratio */
435 		dev_err(component->dev, "could not find matching ratio\n");
436 		return -EINVAL;
437 	}
438 
439 	intf_ctl = snd_soc_component_read(component, CS42L51_INTF_CTL);
440 	power_ctl = snd_soc_component_read(component, CS42L51_MIC_POWER_CTL);
441 
442 	intf_ctl &= ~(CS42L51_INTF_CTL_MASTER | CS42L51_INTF_CTL_ADC_I2S
443 			| CS42L51_INTF_CTL_DAC_FORMAT(7));
444 	power_ctl &= ~(CS42L51_MIC_POWER_CTL_SPEED(3)
445 			| CS42L51_MIC_POWER_CTL_MCLK_DIV2);
446 
447 	switch (cs42l51->func) {
448 	case MODE_MASTER:
449 		intf_ctl |= CS42L51_INTF_CTL_MASTER;
450 		mode = ratios[i].speed_mode;
451 		/* Force DSM mode if sampling rate is above 50kHz */
452 		if (rate > 50000)
453 			mode = CS42L51_DSM_MODE;
454 		power_ctl |= CS42L51_MIC_POWER_CTL_SPEED(mode);
455 		/*
456 		 * Auto detect mode is not applicable for master mode and has to
457 		 * be disabled. Otherwise SPEED[1:0] bits will be ignored.
458 		 */
459 		power_ctl &= ~CS42L51_MIC_POWER_CTL_AUTO;
460 		break;
461 	case MODE_SLAVE:
462 		power_ctl |= CS42L51_MIC_POWER_CTL_SPEED(ratios[i].speed_mode);
463 		break;
464 	case MODE_SLAVE_AUTO:
465 		power_ctl |= CS42L51_MIC_POWER_CTL_AUTO;
466 		break;
467 	}
468 
469 	switch (cs42l51->audio_mode) {
470 	case SND_SOC_DAIFMT_I2S:
471 		intf_ctl |= CS42L51_INTF_CTL_ADC_I2S;
472 		intf_ctl |= CS42L51_INTF_CTL_DAC_FORMAT(CS42L51_DAC_DIF_I2S);
473 		break;
474 	case SND_SOC_DAIFMT_LEFT_J:
475 		intf_ctl |= CS42L51_INTF_CTL_DAC_FORMAT(CS42L51_DAC_DIF_LJ24);
476 		break;
477 	case SND_SOC_DAIFMT_RIGHT_J:
478 		switch (params_width(params)) {
479 		case 16:
480 			fmt = CS42L51_DAC_DIF_RJ16;
481 			break;
482 		case 18:
483 			fmt = CS42L51_DAC_DIF_RJ18;
484 			break;
485 		case 20:
486 			fmt = CS42L51_DAC_DIF_RJ20;
487 			break;
488 		case 24:
489 			fmt = CS42L51_DAC_DIF_RJ24;
490 			break;
491 		default:
492 			dev_err(component->dev, "unknown format\n");
493 			return -EINVAL;
494 		}
495 		intf_ctl |= CS42L51_INTF_CTL_DAC_FORMAT(fmt);
496 		break;
497 	default:
498 		dev_err(component->dev, "unknown format\n");
499 		return -EINVAL;
500 	}
501 
502 	if (ratios[i].mclk)
503 		power_ctl |= CS42L51_MIC_POWER_CTL_MCLK_DIV2;
504 
505 	ret = snd_soc_component_write(component, CS42L51_INTF_CTL, intf_ctl);
506 	if (ret < 0)
507 		return ret;
508 
509 	ret = snd_soc_component_write(component, CS42L51_MIC_POWER_CTL, power_ctl);
510 	if (ret < 0)
511 		return ret;
512 
513 	return 0;
514 }
515 
516 static int cs42l51_dai_mute(struct snd_soc_dai *dai, int mute, int direction)
517 {
518 	struct snd_soc_component *component = dai->component;
519 	int reg;
520 	int mask = CS42L51_DAC_OUT_CTL_DACA_MUTE|CS42L51_DAC_OUT_CTL_DACB_MUTE;
521 
522 	reg = snd_soc_component_read(component, CS42L51_DAC_OUT_CTL);
523 
524 	if (mute)
525 		reg |= mask;
526 	else
527 		reg &= ~mask;
528 
529 	return snd_soc_component_write(component, CS42L51_DAC_OUT_CTL, reg);
530 }
531 
532 static int cs42l51_of_xlate_dai_id(struct snd_soc_component *component,
533 				   struct device_node *endpoint)
534 {
535 	/* return dai id 0, whatever the endpoint index */
536 	return 0;
537 }
538 
539 static const struct snd_soc_dai_ops cs42l51_dai_ops = {
540 	.hw_params      = cs42l51_hw_params,
541 	.set_sysclk     = cs42l51_set_dai_sysclk,
542 	.set_fmt        = cs42l51_set_dai_fmt,
543 	.mute_stream    = cs42l51_dai_mute,
544 	.no_capture_mute = 1,
545 };
546 
547 static struct snd_soc_dai_driver cs42l51_dai = {
548 	.name = "cs42l51-hifi",
549 	.playback = {
550 		.stream_name = "Playback",
551 		.channels_min = 1,
552 		.channels_max = 2,
553 		.rates = SNDRV_PCM_RATE_8000_96000,
554 		.formats = CS42L51_FORMATS,
555 	},
556 	.capture = {
557 		.stream_name = "Capture",
558 		.channels_min = 1,
559 		.channels_max = 2,
560 		.rates = SNDRV_PCM_RATE_8000_96000,
561 		.formats = CS42L51_FORMATS,
562 	},
563 	.ops = &cs42l51_dai_ops,
564 };
565 
566 static int cs42l51_component_probe(struct snd_soc_component *component)
567 {
568 	int ret, reg;
569 	struct snd_soc_dapm_context *dapm;
570 	struct cs42l51_private *cs42l51;
571 
572 	cs42l51 = snd_soc_component_get_drvdata(component);
573 	dapm = snd_soc_component_get_dapm(component);
574 
575 	if (cs42l51->mclk_handle)
576 		snd_soc_dapm_new_controls(dapm, cs42l51_dapm_mclk_widgets, 1);
577 
578 	/*
579 	 * DAC configuration
580 	 * - Use signal processor
581 	 * - auto mute
582 	 * - vol changes immediate
583 	 * - no de-emphasize
584 	 */
585 	reg = CS42L51_DAC_CTL_DATA_SEL(1)
586 		| CS42L51_DAC_CTL_AMUTE | CS42L51_DAC_CTL_DACSZ(0);
587 	ret = snd_soc_component_write(component, CS42L51_DAC_CTL, reg);
588 	if (ret < 0)
589 		return ret;
590 
591 	return 0;
592 }
593 
594 static const struct snd_soc_component_driver soc_component_device_cs42l51 = {
595 	.probe			= cs42l51_component_probe,
596 	.controls		= cs42l51_snd_controls,
597 	.num_controls		= ARRAY_SIZE(cs42l51_snd_controls),
598 	.dapm_widgets		= cs42l51_dapm_widgets,
599 	.num_dapm_widgets	= ARRAY_SIZE(cs42l51_dapm_widgets),
600 	.dapm_routes		= cs42l51_routes,
601 	.num_dapm_routes	= ARRAY_SIZE(cs42l51_routes),
602 	.of_xlate_dai_id	= cs42l51_of_xlate_dai_id,
603 	.idle_bias_on		= 1,
604 	.use_pmdown_time	= 1,
605 	.endianness		= 1,
606 	.non_legacy_dai_naming	= 1,
607 };
608 
609 static bool cs42l51_writeable_reg(struct device *dev, unsigned int reg)
610 {
611 	switch (reg) {
612 	case CS42L51_POWER_CTL1:
613 	case CS42L51_MIC_POWER_CTL:
614 	case CS42L51_INTF_CTL:
615 	case CS42L51_MIC_CTL:
616 	case CS42L51_ADC_CTL:
617 	case CS42L51_ADC_INPUT:
618 	case CS42L51_DAC_OUT_CTL:
619 	case CS42L51_DAC_CTL:
620 	case CS42L51_ALC_PGA_CTL:
621 	case CS42L51_ALC_PGB_CTL:
622 	case CS42L51_ADCA_ATT:
623 	case CS42L51_ADCB_ATT:
624 	case CS42L51_ADCA_VOL:
625 	case CS42L51_ADCB_VOL:
626 	case CS42L51_PCMA_VOL:
627 	case CS42L51_PCMB_VOL:
628 	case CS42L51_BEEP_FREQ:
629 	case CS42L51_BEEP_VOL:
630 	case CS42L51_BEEP_CONF:
631 	case CS42L51_TONE_CTL:
632 	case CS42L51_AOUTA_VOL:
633 	case CS42L51_AOUTB_VOL:
634 	case CS42L51_PCM_MIXER:
635 	case CS42L51_LIMIT_THRES_DIS:
636 	case CS42L51_LIMIT_REL:
637 	case CS42L51_LIMIT_ATT:
638 	case CS42L51_ALC_EN:
639 	case CS42L51_ALC_REL:
640 	case CS42L51_ALC_THRES:
641 	case CS42L51_NOISE_CONF:
642 	case CS42L51_CHARGE_FREQ:
643 		return true;
644 	default:
645 		return false;
646 	}
647 }
648 
649 static bool cs42l51_volatile_reg(struct device *dev, unsigned int reg)
650 {
651 	switch (reg) {
652 	case CS42L51_STATUS:
653 		return true;
654 	default:
655 		return false;
656 	}
657 }
658 
659 static bool cs42l51_readable_reg(struct device *dev, unsigned int reg)
660 {
661 	switch (reg) {
662 	case CS42L51_CHIP_REV_ID:
663 	case CS42L51_POWER_CTL1:
664 	case CS42L51_MIC_POWER_CTL:
665 	case CS42L51_INTF_CTL:
666 	case CS42L51_MIC_CTL:
667 	case CS42L51_ADC_CTL:
668 	case CS42L51_ADC_INPUT:
669 	case CS42L51_DAC_OUT_CTL:
670 	case CS42L51_DAC_CTL:
671 	case CS42L51_ALC_PGA_CTL:
672 	case CS42L51_ALC_PGB_CTL:
673 	case CS42L51_ADCA_ATT:
674 	case CS42L51_ADCB_ATT:
675 	case CS42L51_ADCA_VOL:
676 	case CS42L51_ADCB_VOL:
677 	case CS42L51_PCMA_VOL:
678 	case CS42L51_PCMB_VOL:
679 	case CS42L51_BEEP_FREQ:
680 	case CS42L51_BEEP_VOL:
681 	case CS42L51_BEEP_CONF:
682 	case CS42L51_TONE_CTL:
683 	case CS42L51_AOUTA_VOL:
684 	case CS42L51_AOUTB_VOL:
685 	case CS42L51_PCM_MIXER:
686 	case CS42L51_LIMIT_THRES_DIS:
687 	case CS42L51_LIMIT_REL:
688 	case CS42L51_LIMIT_ATT:
689 	case CS42L51_ALC_EN:
690 	case CS42L51_ALC_REL:
691 	case CS42L51_ALC_THRES:
692 	case CS42L51_NOISE_CONF:
693 	case CS42L51_STATUS:
694 	case CS42L51_CHARGE_FREQ:
695 		return true;
696 	default:
697 		return false;
698 	}
699 }
700 
701 const struct regmap_config cs42l51_regmap = {
702 	.reg_bits = 8,
703 	.reg_stride = 1,
704 	.val_bits = 8,
705 	.use_single_write = true,
706 	.readable_reg = cs42l51_readable_reg,
707 	.volatile_reg = cs42l51_volatile_reg,
708 	.writeable_reg = cs42l51_writeable_reg,
709 	.max_register = CS42L51_CHARGE_FREQ,
710 	.cache_type = REGCACHE_RBTREE,
711 };
712 EXPORT_SYMBOL_GPL(cs42l51_regmap);
713 
714 int cs42l51_probe(struct device *dev, struct regmap *regmap)
715 {
716 	struct cs42l51_private *cs42l51;
717 	unsigned int val;
718 	int ret, i;
719 
720 	if (IS_ERR(regmap))
721 		return PTR_ERR(regmap);
722 
723 	cs42l51 = devm_kzalloc(dev, sizeof(struct cs42l51_private),
724 			       GFP_KERNEL);
725 	if (!cs42l51)
726 		return -ENOMEM;
727 
728 	dev_set_drvdata(dev, cs42l51);
729 	cs42l51->regmap = regmap;
730 
731 	cs42l51->mclk_handle = devm_clk_get(dev, "MCLK");
732 	if (IS_ERR(cs42l51->mclk_handle)) {
733 		if (PTR_ERR(cs42l51->mclk_handle) != -ENOENT)
734 			return PTR_ERR(cs42l51->mclk_handle);
735 		cs42l51->mclk_handle = NULL;
736 	}
737 
738 	for (i = 0; i < ARRAY_SIZE(cs42l51->supplies); i++)
739 		cs42l51->supplies[i].supply = cs42l51_supply_names[i];
740 
741 	ret = devm_regulator_bulk_get(dev, ARRAY_SIZE(cs42l51->supplies),
742 				      cs42l51->supplies);
743 	if (ret != 0) {
744 		dev_err(dev, "Failed to request supplies: %d\n", ret);
745 		return ret;
746 	}
747 
748 	ret = regulator_bulk_enable(ARRAY_SIZE(cs42l51->supplies),
749 				    cs42l51->supplies);
750 	if (ret != 0) {
751 		dev_err(dev, "Failed to enable supplies: %d\n", ret);
752 		return ret;
753 	}
754 
755 	cs42l51->reset_gpio = devm_gpiod_get_optional(dev, "reset",
756 						      GPIOD_OUT_LOW);
757 	if (IS_ERR(cs42l51->reset_gpio))
758 		return PTR_ERR(cs42l51->reset_gpio);
759 
760 	if (cs42l51->reset_gpio) {
761 		dev_dbg(dev, "Release reset gpio\n");
762 		gpiod_set_value_cansleep(cs42l51->reset_gpio, 0);
763 		mdelay(2);
764 	}
765 
766 	/* Verify that we have a CS42L51 */
767 	ret = regmap_read(regmap, CS42L51_CHIP_REV_ID, &val);
768 	if (ret < 0) {
769 		dev_err(dev, "failed to read I2C\n");
770 		goto error;
771 	}
772 
773 	if ((val != CS42L51_MK_CHIP_REV(CS42L51_CHIP_ID, CS42L51_CHIP_REV_A)) &&
774 	    (val != CS42L51_MK_CHIP_REV(CS42L51_CHIP_ID, CS42L51_CHIP_REV_B))) {
775 		dev_err(dev, "Invalid chip id: %x\n", val);
776 		ret = -ENODEV;
777 		goto error;
778 	}
779 	dev_info(dev, "Cirrus Logic CS42L51, Revision: %02X\n",
780 		 val & CS42L51_CHIP_REV_MASK);
781 
782 	ret = devm_snd_soc_register_component(dev,
783 			&soc_component_device_cs42l51, &cs42l51_dai, 1);
784 	if (ret < 0)
785 		goto error;
786 
787 	return 0;
788 
789 error:
790 	regulator_bulk_disable(ARRAY_SIZE(cs42l51->supplies),
791 			       cs42l51->supplies);
792 	return ret;
793 }
794 EXPORT_SYMBOL_GPL(cs42l51_probe);
795 
796 int cs42l51_remove(struct device *dev)
797 {
798 	struct cs42l51_private *cs42l51 = dev_get_drvdata(dev);
799 
800 	gpiod_set_value_cansleep(cs42l51->reset_gpio, 1);
801 
802 	return regulator_bulk_disable(ARRAY_SIZE(cs42l51->supplies),
803 				      cs42l51->supplies);
804 }
805 EXPORT_SYMBOL_GPL(cs42l51_remove);
806 
807 int __maybe_unused cs42l51_suspend(struct device *dev)
808 {
809 	struct cs42l51_private *cs42l51 = dev_get_drvdata(dev);
810 
811 	regcache_cache_only(cs42l51->regmap, true);
812 	regcache_mark_dirty(cs42l51->regmap);
813 
814 	return 0;
815 }
816 EXPORT_SYMBOL_GPL(cs42l51_suspend);
817 
818 int __maybe_unused cs42l51_resume(struct device *dev)
819 {
820 	struct cs42l51_private *cs42l51 = dev_get_drvdata(dev);
821 
822 	regcache_cache_only(cs42l51->regmap, false);
823 
824 	return regcache_sync(cs42l51->regmap);
825 }
826 EXPORT_SYMBOL_GPL(cs42l51_resume);
827 
828 const struct of_device_id cs42l51_of_match[] = {
829 	{ .compatible = "cirrus,cs42l51", },
830 	{ }
831 };
832 MODULE_DEVICE_TABLE(of, cs42l51_of_match);
833 EXPORT_SYMBOL_GPL(cs42l51_of_match);
834 
835 MODULE_AUTHOR("Arnaud Patard <arnaud.patard@rtp-net.org>");
836 MODULE_DESCRIPTION("Cirrus Logic CS42L51 ALSA SoC Codec Driver");
837 MODULE_LICENSE("GPL");
838