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