xref: /linux/sound/soc/codecs/ad1836.c (revision 0d456bad36d42d16022be045c8a53ddbb59ee478)
1  /*
2  * Audio Codec driver supporting:
3  *  AD1835A, AD1836, AD1837A, AD1838A, AD1839A
4  *
5  * Copyright 2009-2011 Analog Devices Inc.
6  *
7  * Licensed under the GPL-2 or later.
8  */
9 
10 #include <linux/init.h>
11 #include <linux/slab.h>
12 #include <linux/module.h>
13 #include <linux/kernel.h>
14 #include <linux/device.h>
15 #include <sound/core.h>
16 #include <sound/pcm.h>
17 #include <sound/pcm_params.h>
18 #include <sound/initval.h>
19 #include <sound/soc.h>
20 #include <sound/tlv.h>
21 #include <linux/spi/spi.h>
22 #include <linux/regmap.h>
23 
24 #include "ad1836.h"
25 
26 enum ad1836_type {
27 	AD1835,
28 	AD1836,
29 	AD1838,
30 };
31 
32 /* codec private data */
33 struct ad1836_priv {
34 	enum ad1836_type type;
35 	struct regmap *regmap;
36 };
37 
38 /*
39  * AD1836 volume/mute/de-emphasis etc. controls
40  */
41 static const char *ad1836_deemp[] = {"None", "44.1kHz", "32kHz", "48kHz"};
42 
43 static const struct soc_enum ad1836_deemp_enum =
44 	SOC_ENUM_SINGLE(AD1836_DAC_CTRL1, 8, 4, ad1836_deemp);
45 
46 #define AD1836_DAC_VOLUME(x) \
47 	SOC_DOUBLE_R("DAC" #x " Playback Volume", AD1836_DAC_L_VOL(x), \
48 			AD1836_DAC_R_VOL(x), 0, 0x3FF, 0)
49 
50 #define AD1836_DAC_SWITCH(x) \
51 	SOC_DOUBLE("DAC" #x " Playback Switch", AD1836_DAC_CTRL2, \
52 			AD1836_MUTE_LEFT(x), AD1836_MUTE_RIGHT(x), 1, 1)
53 
54 #define AD1836_ADC_SWITCH(x) \
55 	SOC_DOUBLE("ADC" #x " Capture Switch", AD1836_ADC_CTRL2, \
56 		AD1836_MUTE_LEFT(x), AD1836_MUTE_RIGHT(x), 1, 1)
57 
58 static const struct snd_kcontrol_new ad183x_dac_controls[] = {
59 	AD1836_DAC_VOLUME(1),
60 	AD1836_DAC_SWITCH(1),
61 	AD1836_DAC_VOLUME(2),
62 	AD1836_DAC_SWITCH(2),
63 	AD1836_DAC_VOLUME(3),
64 	AD1836_DAC_SWITCH(3),
65 	AD1836_DAC_VOLUME(4),
66 	AD1836_DAC_SWITCH(4),
67 };
68 
69 static const struct snd_soc_dapm_widget ad183x_dac_dapm_widgets[] = {
70 	SND_SOC_DAPM_OUTPUT("DAC1OUT"),
71 	SND_SOC_DAPM_OUTPUT("DAC2OUT"),
72 	SND_SOC_DAPM_OUTPUT("DAC3OUT"),
73 	SND_SOC_DAPM_OUTPUT("DAC4OUT"),
74 };
75 
76 static const struct snd_soc_dapm_route ad183x_dac_routes[] = {
77 	{ "DAC1OUT", NULL, "DAC" },
78 	{ "DAC2OUT", NULL, "DAC" },
79 	{ "DAC3OUT", NULL, "DAC" },
80 	{ "DAC4OUT", NULL, "DAC" },
81 };
82 
83 static const struct snd_kcontrol_new ad183x_adc_controls[] = {
84 	AD1836_ADC_SWITCH(1),
85 	AD1836_ADC_SWITCH(2),
86 	AD1836_ADC_SWITCH(3),
87 };
88 
89 static const struct snd_soc_dapm_widget ad183x_adc_dapm_widgets[] = {
90 	SND_SOC_DAPM_INPUT("ADC1IN"),
91 	SND_SOC_DAPM_INPUT("ADC2IN"),
92 };
93 
94 static const struct snd_soc_dapm_route ad183x_adc_routes[] = {
95 	{ "ADC", NULL, "ADC1IN" },
96 	{ "ADC", NULL, "ADC2IN" },
97 };
98 
99 static const struct snd_kcontrol_new ad183x_controls[] = {
100 	/* ADC high-pass filter */
101 	SOC_SINGLE("ADC High Pass Filter Switch", AD1836_ADC_CTRL1,
102 			AD1836_ADC_HIGHPASS_FILTER, 1, 0),
103 
104 	/* DAC de-emphasis */
105 	SOC_ENUM("Playback Deemphasis", ad1836_deemp_enum),
106 };
107 
108 static const struct snd_soc_dapm_widget ad183x_dapm_widgets[] = {
109 	SND_SOC_DAPM_DAC("DAC", "Playback", AD1836_DAC_CTRL1,
110 				AD1836_DAC_POWERDOWN, 1),
111 	SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
112 	SND_SOC_DAPM_SUPPLY("ADC_PWR", AD1836_ADC_CTRL1,
113 				AD1836_ADC_POWERDOWN, 1, NULL, 0),
114 };
115 
116 static const struct snd_soc_dapm_route ad183x_dapm_routes[] = {
117 	{ "DAC", NULL, "ADC_PWR" },
118 	{ "ADC", NULL, "ADC_PWR" },
119 };
120 
121 static const DECLARE_TLV_DB_SCALE(ad1836_in_tlv, 0, 300, 0);
122 
123 static const struct snd_kcontrol_new ad1836_controls[] = {
124 	SOC_DOUBLE_TLV("ADC2 Capture Volume", AD1836_ADC_CTRL1, 3, 0, 4, 0,
125 	    ad1836_in_tlv),
126 };
127 
128 /*
129  * DAI ops entries
130  */
131 
132 static int ad1836_set_dai_fmt(struct snd_soc_dai *codec_dai,
133 		unsigned int fmt)
134 {
135 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
136 	/* at present, we support adc aux mode to interface with
137 	 * blackfin sport tdm mode
138 	 */
139 	case SND_SOC_DAIFMT_DSP_A:
140 		break;
141 	default:
142 		return -EINVAL;
143 	}
144 
145 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
146 	case SND_SOC_DAIFMT_IB_IF:
147 		break;
148 	default:
149 		return -EINVAL;
150 	}
151 
152 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
153 	/* ALCLK,ABCLK are both output, AD1836 can only be master */
154 	case SND_SOC_DAIFMT_CBM_CFM:
155 		break;
156 	default:
157 		return -EINVAL;
158 	}
159 
160 	return 0;
161 }
162 
163 static int ad1836_hw_params(struct snd_pcm_substream *substream,
164 		struct snd_pcm_hw_params *params,
165 		struct snd_soc_dai *dai)
166 {
167 	struct ad1836_priv *ad1836 = snd_soc_codec_get_drvdata(dai->codec);
168 	int word_len = 0;
169 
170 	/* bit size */
171 	switch (params_format(params)) {
172 	case SNDRV_PCM_FORMAT_S16_LE:
173 		word_len = AD1836_WORD_LEN_16;
174 		break;
175 	case SNDRV_PCM_FORMAT_S20_3LE:
176 		word_len = AD1836_WORD_LEN_20;
177 		break;
178 	case SNDRV_PCM_FORMAT_S24_LE:
179 	case SNDRV_PCM_FORMAT_S32_LE:
180 		word_len = AD1836_WORD_LEN_24;
181 		break;
182 	}
183 
184 	regmap_update_bits(ad1836->regmap, AD1836_DAC_CTRL1,
185 		AD1836_DAC_WORD_LEN_MASK,
186 		word_len << AD1836_DAC_WORD_LEN_OFFSET);
187 
188 	regmap_update_bits(ad1836->regmap, AD1836_ADC_CTRL2,
189 		AD1836_ADC_WORD_LEN_MASK,
190 		word_len << AD1836_ADC_WORD_OFFSET);
191 
192 	return 0;
193 }
194 
195 static const struct snd_soc_dai_ops ad1836_dai_ops = {
196 	.hw_params = ad1836_hw_params,
197 	.set_fmt = ad1836_set_dai_fmt,
198 };
199 
200 #define AD183X_DAI(_name, num_dacs, num_adcs) \
201 { \
202 	.name = _name "-hifi", \
203 	.playback = { \
204 		.stream_name = "Playback", \
205 		.channels_min = 2, \
206 		.channels_max = (num_dacs) * 2, \
207 		.rates = SNDRV_PCM_RATE_48000,  \
208 		.formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE | \
209 			SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE, \
210 	}, \
211 	.capture = { \
212 		.stream_name = "Capture", \
213 		.channels_min = 2, \
214 		.channels_max = (num_adcs) * 2, \
215 		.rates = SNDRV_PCM_RATE_48000, \
216 		.formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE | \
217 			SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE, \
218 	}, \
219 	.ops = &ad1836_dai_ops, \
220 }
221 
222 static struct snd_soc_dai_driver ad183x_dais[] = {
223 	[AD1835] = AD183X_DAI("ad1835", 4, 1),
224 	[AD1836] = AD183X_DAI("ad1836", 3, 2),
225 	[AD1838] = AD183X_DAI("ad1838", 3, 1),
226 };
227 
228 #ifdef CONFIG_PM
229 static int ad1836_suspend(struct snd_soc_codec *codec)
230 {
231 	struct ad1836_priv *ad1836 = snd_soc_codec_get_drvdata(codec);
232 	/* reset clock control mode */
233 	return regmap_update_bits(ad1836->regmap, AD1836_ADC_CTRL2,
234 		AD1836_ADC_SERFMT_MASK, 0);
235 }
236 
237 static int ad1836_resume(struct snd_soc_codec *codec)
238 {
239 	struct ad1836_priv *ad1836 = snd_soc_codec_get_drvdata(codec);
240 	/* restore clock control mode */
241 	return regmap_update_bits(ad1836->regmap, AD1836_ADC_CTRL2,
242 		AD1836_ADC_SERFMT_MASK, AD1836_ADC_AUX);
243 }
244 #else
245 #define ad1836_suspend NULL
246 #define ad1836_resume  NULL
247 #endif
248 
249 static int ad1836_probe(struct snd_soc_codec *codec)
250 {
251 	struct ad1836_priv *ad1836 = snd_soc_codec_get_drvdata(codec);
252 	struct snd_soc_dapm_context *dapm = &codec->dapm;
253 	int num_dacs, num_adcs;
254 	int ret = 0;
255 	int i;
256 
257 	num_dacs = ad183x_dais[ad1836->type].playback.channels_max / 2;
258 	num_adcs = ad183x_dais[ad1836->type].capture.channels_max / 2;
259 
260 	/* default setting for ad1836 */
261 	/* de-emphasis: 48kHz, power-on dac */
262 	regmap_write(ad1836->regmap, AD1836_DAC_CTRL1, 0x300);
263 	/* unmute dac channels */
264 	regmap_write(ad1836->regmap, AD1836_DAC_CTRL2, 0x0);
265 	/* high-pass filter enable, power-on adc */
266 	regmap_write(ad1836->regmap, AD1836_ADC_CTRL1, 0x100);
267 	/* unmute adc channles, adc aux mode */
268 	regmap_write(ad1836->regmap, AD1836_ADC_CTRL2, 0x180);
269 	/* volume */
270 	for (i = 1; i <= num_dacs; ++i) {
271 		regmap_write(ad1836->regmap, AD1836_DAC_L_VOL(i), 0x3FF);
272 		regmap_write(ad1836->regmap, AD1836_DAC_R_VOL(i), 0x3FF);
273 	}
274 
275 	if (ad1836->type == AD1836) {
276 		/* left/right diff:PGA/MUX */
277 		regmap_write(ad1836->regmap, AD1836_ADC_CTRL3, 0x3A);
278 		ret = snd_soc_add_codec_controls(codec, ad1836_controls,
279 				ARRAY_SIZE(ad1836_controls));
280 		if (ret)
281 			return ret;
282 	} else {
283 		regmap_write(ad1836->regmap, AD1836_ADC_CTRL3, 0x00);
284 	}
285 
286 	ret = snd_soc_add_codec_controls(codec, ad183x_dac_controls, num_dacs * 2);
287 	if (ret)
288 		return ret;
289 
290 	ret = snd_soc_add_codec_controls(codec, ad183x_adc_controls, num_adcs);
291 	if (ret)
292 		return ret;
293 
294 	ret = snd_soc_dapm_new_controls(dapm, ad183x_dac_dapm_widgets, num_dacs);
295 	if (ret)
296 		return ret;
297 
298 	ret = snd_soc_dapm_new_controls(dapm, ad183x_adc_dapm_widgets, num_adcs);
299 	if (ret)
300 		return ret;
301 
302 	ret = snd_soc_dapm_add_routes(dapm, ad183x_dac_routes, num_dacs);
303 	if (ret)
304 		return ret;
305 
306 	ret = snd_soc_dapm_add_routes(dapm, ad183x_adc_routes, num_adcs);
307 	if (ret)
308 		return ret;
309 
310 	return ret;
311 }
312 
313 /* power down chip */
314 static int ad1836_remove(struct snd_soc_codec *codec)
315 {
316 	struct ad1836_priv *ad1836 = snd_soc_codec_get_drvdata(codec);
317 	/* reset clock control mode */
318 	return regmap_update_bits(ad1836->regmap, AD1836_ADC_CTRL2,
319 		AD1836_ADC_SERFMT_MASK, 0);
320 }
321 
322 static struct snd_soc_codec_driver soc_codec_dev_ad1836 = {
323 	.probe = ad1836_probe,
324 	.remove = ad1836_remove,
325 	.suspend = ad1836_suspend,
326 	.resume = ad1836_resume,
327 
328 	.controls = ad183x_controls,
329 	.num_controls = ARRAY_SIZE(ad183x_controls),
330 	.dapm_widgets = ad183x_dapm_widgets,
331 	.num_dapm_widgets = ARRAY_SIZE(ad183x_dapm_widgets),
332 	.dapm_routes = ad183x_dapm_routes,
333 	.num_dapm_routes = ARRAY_SIZE(ad183x_dapm_routes),
334 };
335 
336 static const struct reg_default ad1836_reg_defaults[] = {
337 	{ AD1836_DAC_CTRL1, 0x0000 },
338 	{ AD1836_DAC_CTRL2, 0x0000 },
339 	{ AD1836_DAC_L_VOL(0), 0x0000 },
340 	{ AD1836_DAC_R_VOL(0), 0x0000 },
341 	{ AD1836_DAC_L_VOL(1), 0x0000 },
342 	{ AD1836_DAC_R_VOL(1), 0x0000 },
343 	{ AD1836_DAC_L_VOL(2), 0x0000 },
344 	{ AD1836_DAC_R_VOL(2), 0x0000 },
345 	{ AD1836_DAC_L_VOL(3), 0x0000 },
346 	{ AD1836_DAC_R_VOL(3), 0x0000 },
347 	{ AD1836_ADC_CTRL1, 0x0000 },
348 	{ AD1836_ADC_CTRL2, 0x0000 },
349 	{ AD1836_ADC_CTRL3, 0x0000 },
350 };
351 
352 static const struct regmap_config ad1836_regmap_config = {
353 	.val_bits = 12,
354 	.reg_bits = 4,
355 	.read_flag_mask = 0x08,
356 
357 	.max_register = AD1836_ADC_CTRL3,
358 	.reg_defaults = ad1836_reg_defaults,
359 	.num_reg_defaults = ARRAY_SIZE(ad1836_reg_defaults),
360 	.cache_type = REGCACHE_RBTREE,
361 };
362 
363 static int ad1836_spi_probe(struct spi_device *spi)
364 {
365 	struct ad1836_priv *ad1836;
366 	int ret;
367 
368 	ad1836 = devm_kzalloc(&spi->dev, sizeof(struct ad1836_priv),
369 			      GFP_KERNEL);
370 	if (ad1836 == NULL)
371 		return -ENOMEM;
372 
373 	ad1836->regmap = devm_regmap_init_spi(spi, &ad1836_regmap_config);
374 	if (IS_ERR(ad1836->regmap))
375 		return PTR_ERR(ad1836->regmap);
376 
377 	ad1836->type = spi_get_device_id(spi)->driver_data;
378 
379 	spi_set_drvdata(spi, ad1836);
380 
381 	ret = snd_soc_register_codec(&spi->dev,
382 			&soc_codec_dev_ad1836, &ad183x_dais[ad1836->type], 1);
383 	return ret;
384 }
385 
386 static int ad1836_spi_remove(struct spi_device *spi)
387 {
388 	snd_soc_unregister_codec(&spi->dev);
389 	return 0;
390 }
391 
392 static const struct spi_device_id ad1836_ids[] = {
393 	{ "ad1835", AD1835 },
394 	{ "ad1836", AD1836 },
395 	{ "ad1837", AD1835 },
396 	{ "ad1838", AD1838 },
397 	{ "ad1839", AD1838 },
398 	{ },
399 };
400 MODULE_DEVICE_TABLE(spi, ad1836_ids);
401 
402 static struct spi_driver ad1836_spi_driver = {
403 	.driver = {
404 		.name	= "ad1836",
405 		.owner	= THIS_MODULE,
406 	},
407 	.probe		= ad1836_spi_probe,
408 	.remove		= ad1836_spi_remove,
409 	.id_table	= ad1836_ids,
410 };
411 
412 module_spi_driver(ad1836_spi_driver);
413 
414 MODULE_DESCRIPTION("ASoC ad1836 driver");
415 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
416 MODULE_LICENSE("GPL");
417