xref: /linux/sound/soc/codecs/ad193x.c (revision ca55b2fef3a9373fcfc30f82fd26bc7fccbda732)
1 /*
2  * AD193X Audio Codec driver supporting AD1936/7/8/9
3  *
4  * Copyright 2010 Analog Devices Inc.
5  *
6  * Licensed under the GPL-2 or later.
7  */
8 
9 #include <linux/module.h>
10 #include <linux/kernel.h>
11 #include <linux/device.h>
12 #include <linux/regmap.h>
13 #include <linux/slab.h>
14 #include <sound/core.h>
15 #include <sound/pcm.h>
16 #include <sound/pcm_params.h>
17 #include <sound/initval.h>
18 #include <sound/soc.h>
19 #include <sound/tlv.h>
20 
21 #include "ad193x.h"
22 
23 /* codec private data */
24 struct ad193x_priv {
25 	struct regmap *regmap;
26 	int sysclk;
27 };
28 
29 /*
30  * AD193X volume/mute/de-emphasis etc. controls
31  */
32 static const char * const ad193x_deemp[] = {"None", "48kHz", "44.1kHz", "32kHz"};
33 
34 static SOC_ENUM_SINGLE_DECL(ad193x_deemp_enum, AD193X_DAC_CTRL2, 1,
35 			    ad193x_deemp);
36 
37 static const DECLARE_TLV_DB_MINMAX(adau193x_tlv, -9563, 0);
38 
39 static const struct snd_kcontrol_new ad193x_snd_controls[] = {
40 	/* DAC volume control */
41 	SOC_DOUBLE_R_TLV("DAC1 Volume", AD193X_DAC_L1_VOL,
42 			AD193X_DAC_R1_VOL, 0, 0xFF, 1, adau193x_tlv),
43 	SOC_DOUBLE_R_TLV("DAC2 Volume", AD193X_DAC_L2_VOL,
44 			AD193X_DAC_R2_VOL, 0, 0xFF, 1, adau193x_tlv),
45 	SOC_DOUBLE_R_TLV("DAC3 Volume", AD193X_DAC_L3_VOL,
46 			AD193X_DAC_R3_VOL, 0, 0xFF, 1, adau193x_tlv),
47 	SOC_DOUBLE_R_TLV("DAC4 Volume", AD193X_DAC_L4_VOL,
48 			AD193X_DAC_R4_VOL, 0, 0xFF, 1, adau193x_tlv),
49 
50 	/* ADC switch control */
51 	SOC_DOUBLE("ADC1 Switch", AD193X_ADC_CTRL0, AD193X_ADCL1_MUTE,
52 		AD193X_ADCR1_MUTE, 1, 1),
53 	SOC_DOUBLE("ADC2 Switch", AD193X_ADC_CTRL0, AD193X_ADCL2_MUTE,
54 		AD193X_ADCR2_MUTE, 1, 1),
55 
56 	/* DAC switch control */
57 	SOC_DOUBLE("DAC1 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL1_MUTE,
58 		AD193X_DACR1_MUTE, 1, 1),
59 	SOC_DOUBLE("DAC2 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL2_MUTE,
60 		AD193X_DACR2_MUTE, 1, 1),
61 	SOC_DOUBLE("DAC3 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL3_MUTE,
62 		AD193X_DACR3_MUTE, 1, 1),
63 	SOC_DOUBLE("DAC4 Switch", AD193X_DAC_CHNL_MUTE, AD193X_DACL4_MUTE,
64 		AD193X_DACR4_MUTE, 1, 1),
65 
66 	/* ADC high-pass filter */
67 	SOC_SINGLE("ADC High Pass Filter Switch", AD193X_ADC_CTRL0,
68 			AD193X_ADC_HIGHPASS_FILTER, 1, 0),
69 
70 	/* DAC de-emphasis */
71 	SOC_ENUM("Playback Deemphasis", ad193x_deemp_enum),
72 };
73 
74 static const struct snd_soc_dapm_widget ad193x_dapm_widgets[] = {
75 	SND_SOC_DAPM_DAC("DAC", "Playback", SND_SOC_NOPM, 0, 0),
76 	SND_SOC_DAPM_PGA("DAC Output", AD193X_DAC_CTRL0, 0, 1, NULL, 0),
77 	SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
78 	SND_SOC_DAPM_SUPPLY("PLL_PWR", AD193X_PLL_CLK_CTRL0, 0, 1, NULL, 0),
79 	SND_SOC_DAPM_SUPPLY("ADC_PWR", AD193X_ADC_CTRL0, 0, 1, NULL, 0),
80 	SND_SOC_DAPM_SUPPLY("SYSCLK", AD193X_PLL_CLK_CTRL0, 7, 0, NULL, 0),
81 	SND_SOC_DAPM_VMID("VMID"),
82 	SND_SOC_DAPM_OUTPUT("DAC1OUT"),
83 	SND_SOC_DAPM_OUTPUT("DAC2OUT"),
84 	SND_SOC_DAPM_OUTPUT("DAC3OUT"),
85 	SND_SOC_DAPM_OUTPUT("DAC4OUT"),
86 	SND_SOC_DAPM_INPUT("ADC1IN"),
87 	SND_SOC_DAPM_INPUT("ADC2IN"),
88 };
89 
90 static const struct snd_soc_dapm_route audio_paths[] = {
91 	{ "DAC", NULL, "SYSCLK" },
92 	{ "DAC Output", NULL, "DAC" },
93 	{ "DAC Output", NULL, "VMID" },
94 	{ "ADC", NULL, "SYSCLK" },
95 	{ "DAC", NULL, "ADC_PWR" },
96 	{ "ADC", NULL, "ADC_PWR" },
97 	{ "DAC1OUT", NULL, "DAC Output" },
98 	{ "DAC2OUT", NULL, "DAC Output" },
99 	{ "DAC3OUT", NULL, "DAC Output" },
100 	{ "DAC4OUT", NULL, "DAC Output" },
101 	{ "ADC", NULL, "ADC1IN" },
102 	{ "ADC", NULL, "ADC2IN" },
103 	{ "SYSCLK", NULL, "PLL_PWR" },
104 };
105 
106 /*
107  * DAI ops entries
108  */
109 
110 static int ad193x_mute(struct snd_soc_dai *dai, int mute)
111 {
112 	struct ad193x_priv *ad193x = snd_soc_codec_get_drvdata(dai->codec);
113 
114 	if (mute)
115 		regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL2,
116 				    AD193X_DAC_MASTER_MUTE,
117 				    AD193X_DAC_MASTER_MUTE);
118 	else
119 		regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL2,
120 				    AD193X_DAC_MASTER_MUTE, 0);
121 
122 	return 0;
123 }
124 
125 static int ad193x_set_tdm_slot(struct snd_soc_dai *dai, unsigned int tx_mask,
126 			       unsigned int rx_mask, int slots, int width)
127 {
128 	struct ad193x_priv *ad193x = snd_soc_codec_get_drvdata(dai->codec);
129 	unsigned int channels;
130 
131 	switch (slots) {
132 	case 2:
133 		channels = AD193X_2_CHANNELS;
134 		break;
135 	case 4:
136 		channels = AD193X_4_CHANNELS;
137 		break;
138 	case 8:
139 		channels = AD193X_8_CHANNELS;
140 		break;
141 	case 16:
142 		channels = AD193X_16_CHANNELS;
143 		break;
144 	default:
145 		return -EINVAL;
146 	}
147 
148 	regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL1,
149 		AD193X_DAC_CHAN_MASK, channels << AD193X_DAC_CHAN_SHFT);
150 	regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL2,
151 		AD193X_ADC_CHAN_MASK, channels << AD193X_ADC_CHAN_SHFT);
152 
153 	return 0;
154 }
155 
156 static int ad193x_set_dai_fmt(struct snd_soc_dai *codec_dai,
157 		unsigned int fmt)
158 {
159 	struct ad193x_priv *ad193x = snd_soc_codec_get_drvdata(codec_dai->codec);
160 	unsigned int adc_serfmt = 0;
161 	unsigned int adc_fmt = 0;
162 	unsigned int dac_fmt = 0;
163 
164 	/* At present, the driver only support AUX ADC mode(SND_SOC_DAIFMT_I2S
165 	 * with TDM) and ADC&DAC TDM mode(SND_SOC_DAIFMT_DSP_A)
166 	 */
167 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
168 	case SND_SOC_DAIFMT_I2S:
169 		adc_serfmt |= AD193X_ADC_SERFMT_TDM;
170 		break;
171 	case SND_SOC_DAIFMT_DSP_A:
172 		adc_serfmt |= AD193X_ADC_SERFMT_AUX;
173 		break;
174 	default:
175 		return -EINVAL;
176 	}
177 
178 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
179 	case SND_SOC_DAIFMT_NB_NF: /* normal bit clock + frame */
180 		break;
181 	case SND_SOC_DAIFMT_NB_IF: /* normal bclk + invert frm */
182 		adc_fmt |= AD193X_ADC_LEFT_HIGH;
183 		dac_fmt |= AD193X_DAC_LEFT_HIGH;
184 		break;
185 	case SND_SOC_DAIFMT_IB_NF: /* invert bclk + normal frm */
186 		adc_fmt |= AD193X_ADC_BCLK_INV;
187 		dac_fmt |= AD193X_DAC_BCLK_INV;
188 		break;
189 	case SND_SOC_DAIFMT_IB_IF: /* invert bclk + frm */
190 		adc_fmt |= AD193X_ADC_LEFT_HIGH;
191 		adc_fmt |= AD193X_ADC_BCLK_INV;
192 		dac_fmt |= AD193X_DAC_LEFT_HIGH;
193 		dac_fmt |= AD193X_DAC_BCLK_INV;
194 		break;
195 	default:
196 		return -EINVAL;
197 	}
198 
199 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
200 	case SND_SOC_DAIFMT_CBM_CFM: /* codec clk & frm master */
201 		adc_fmt |= AD193X_ADC_LCR_MASTER;
202 		adc_fmt |= AD193X_ADC_BCLK_MASTER;
203 		dac_fmt |= AD193X_DAC_LCR_MASTER;
204 		dac_fmt |= AD193X_DAC_BCLK_MASTER;
205 		break;
206 	case SND_SOC_DAIFMT_CBS_CFM: /* codec clk slave & frm master */
207 		adc_fmt |= AD193X_ADC_LCR_MASTER;
208 		dac_fmt |= AD193X_DAC_LCR_MASTER;
209 		break;
210 	case SND_SOC_DAIFMT_CBM_CFS: /* codec clk master & frame slave */
211 		adc_fmt |= AD193X_ADC_BCLK_MASTER;
212 		dac_fmt |= AD193X_DAC_BCLK_MASTER;
213 		break;
214 	case SND_SOC_DAIFMT_CBS_CFS: /* codec clk & frm slave */
215 		break;
216 	default:
217 		return -EINVAL;
218 	}
219 
220 	regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL1,
221 		AD193X_ADC_SERFMT_MASK, adc_serfmt);
222 	regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL2,
223 		AD193X_ADC_FMT_MASK, adc_fmt);
224 	regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL1,
225 		AD193X_DAC_FMT_MASK, dac_fmt);
226 
227 	return 0;
228 }
229 
230 static int ad193x_set_dai_sysclk(struct snd_soc_dai *codec_dai,
231 		int clk_id, unsigned int freq, int dir)
232 {
233 	struct snd_soc_codec *codec = codec_dai->codec;
234 	struct ad193x_priv *ad193x = snd_soc_codec_get_drvdata(codec);
235 	switch (freq) {
236 	case 12288000:
237 	case 18432000:
238 	case 24576000:
239 	case 36864000:
240 		ad193x->sysclk = freq;
241 		return 0;
242 	}
243 	return -EINVAL;
244 }
245 
246 static int ad193x_hw_params(struct snd_pcm_substream *substream,
247 		struct snd_pcm_hw_params *params,
248 		struct snd_soc_dai *dai)
249 {
250 	int word_len = 0, master_rate = 0;
251 	struct snd_soc_codec *codec = dai->codec;
252 	struct ad193x_priv *ad193x = snd_soc_codec_get_drvdata(codec);
253 
254 	/* bit size */
255 	switch (params_width(params)) {
256 	case 16:
257 		word_len = 3;
258 		break;
259 	case 20:
260 		word_len = 1;
261 		break;
262 	case 24:
263 	case 32:
264 		word_len = 0;
265 		break;
266 	}
267 
268 	switch (ad193x->sysclk) {
269 	case 12288000:
270 		master_rate = AD193X_PLL_INPUT_256;
271 		break;
272 	case 18432000:
273 		master_rate = AD193X_PLL_INPUT_384;
274 		break;
275 	case 24576000:
276 		master_rate = AD193X_PLL_INPUT_512;
277 		break;
278 	case 36864000:
279 		master_rate = AD193X_PLL_INPUT_768;
280 		break;
281 	}
282 
283 	regmap_update_bits(ad193x->regmap, AD193X_PLL_CLK_CTRL0,
284 			    AD193X_PLL_INPUT_MASK, master_rate);
285 
286 	regmap_update_bits(ad193x->regmap, AD193X_DAC_CTRL2,
287 			    AD193X_DAC_WORD_LEN_MASK,
288 			    word_len << AD193X_DAC_WORD_LEN_SHFT);
289 
290 	regmap_update_bits(ad193x->regmap, AD193X_ADC_CTRL1,
291 			    AD193X_ADC_WORD_LEN_MASK, word_len);
292 
293 	return 0;
294 }
295 
296 static const struct snd_soc_dai_ops ad193x_dai_ops = {
297 	.hw_params = ad193x_hw_params,
298 	.digital_mute = ad193x_mute,
299 	.set_tdm_slot = ad193x_set_tdm_slot,
300 	.set_sysclk	= ad193x_set_dai_sysclk,
301 	.set_fmt = ad193x_set_dai_fmt,
302 };
303 
304 /* codec DAI instance */
305 static struct snd_soc_dai_driver ad193x_dai = {
306 	.name = "ad193x-hifi",
307 	.playback = {
308 		.stream_name = "Playback",
309 		.channels_min = 2,
310 		.channels_max = 8,
311 		.rates = SNDRV_PCM_RATE_48000,
312 		.formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
313 			SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
314 	},
315 	.capture = {
316 		.stream_name = "Capture",
317 		.channels_min = 2,
318 		.channels_max = 4,
319 		.rates = SNDRV_PCM_RATE_48000,
320 		.formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
321 			SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
322 	},
323 	.ops = &ad193x_dai_ops,
324 };
325 
326 static int ad193x_codec_probe(struct snd_soc_codec *codec)
327 {
328 	struct ad193x_priv *ad193x = snd_soc_codec_get_drvdata(codec);
329 
330 	/* default setting for ad193x */
331 
332 	/* unmute dac channels */
333 	regmap_write(ad193x->regmap, AD193X_DAC_CHNL_MUTE, 0x0);
334 	/* de-emphasis: 48kHz, powedown dac */
335 	regmap_write(ad193x->regmap, AD193X_DAC_CTRL2, 0x1A);
336 	/* dac in tdm mode */
337 	regmap_write(ad193x->regmap, AD193X_DAC_CTRL0, 0x40);
338 	/* high-pass filter enable */
339 	regmap_write(ad193x->regmap, AD193X_ADC_CTRL0, 0x3);
340 	/* sata delay=1, adc aux mode */
341 	regmap_write(ad193x->regmap, AD193X_ADC_CTRL1, 0x43);
342 	/* pll input: mclki/xi */
343 	regmap_write(ad193x->regmap, AD193X_PLL_CLK_CTRL0, 0x99); /* mclk=24.576Mhz: 0x9D; mclk=12.288Mhz: 0x99 */
344 	regmap_write(ad193x->regmap, AD193X_PLL_CLK_CTRL1, 0x04);
345 
346 	return 0;
347 }
348 
349 static struct snd_soc_codec_driver soc_codec_dev_ad193x = {
350 	.probe = ad193x_codec_probe,
351 	.controls = ad193x_snd_controls,
352 	.num_controls = ARRAY_SIZE(ad193x_snd_controls),
353 	.dapm_widgets = ad193x_dapm_widgets,
354 	.num_dapm_widgets = ARRAY_SIZE(ad193x_dapm_widgets),
355 	.dapm_routes = audio_paths,
356 	.num_dapm_routes = ARRAY_SIZE(audio_paths),
357 };
358 
359 static bool adau193x_reg_volatile(struct device *dev, unsigned int reg)
360 {
361 	return false;
362 }
363 
364 const struct regmap_config ad193x_regmap_config = {
365 	.max_register = AD193X_NUM_REGS - 1,
366 	.volatile_reg = adau193x_reg_volatile,
367 };
368 EXPORT_SYMBOL_GPL(ad193x_regmap_config);
369 
370 int ad193x_probe(struct device *dev, struct regmap *regmap)
371 {
372 	struct ad193x_priv *ad193x;
373 
374 	if (IS_ERR(regmap))
375 		return PTR_ERR(regmap);
376 
377 	ad193x = devm_kzalloc(dev, sizeof(*ad193x), GFP_KERNEL);
378 	if (ad193x == NULL)
379 		return -ENOMEM;
380 
381 	ad193x->regmap = regmap;
382 
383 	dev_set_drvdata(dev, ad193x);
384 
385 	return snd_soc_register_codec(dev, &soc_codec_dev_ad193x,
386 		&ad193x_dai, 1);
387 }
388 EXPORT_SYMBOL_GPL(ad193x_probe);
389 
390 MODULE_DESCRIPTION("ASoC ad193x driver");
391 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
392 MODULE_LICENSE("GPL");
393