xref: /openbmc/linux/sound/soc/codecs/ad1836.c (revision b2c812e22de88bb79c290c0e718280f10b64a48d)
1 /*
2  * File:         sound/soc/codecs/ad1836.c
3  * Author:       Barry Song <Barry.Song@analog.com>
4  *
5  * Created:      Aug 04 2009
6  * Description:  Driver for AD1836 sound chip
7  *
8  * Modified:
9  *               Copyright 2009 Analog Devices Inc.
10  *
11  * Bugs:         Enter bugs at http://blackfin.uclinux.org/
12  *
13  * This program is free software; you can redistribute it and/or modify
14  * it under the terms of the GNU General Public License as published by
15  * the Free Software Foundation; either version 2 of the License, or
16  * (at your option) any later version.
17  */
18 
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/kernel.h>
22 #include <linux/device.h>
23 #include <sound/core.h>
24 #include <sound/pcm.h>
25 #include <sound/pcm_params.h>
26 #include <sound/initval.h>
27 #include <sound/soc.h>
28 #include <sound/tlv.h>
29 #include <sound/soc-dapm.h>
30 #include <linux/spi/spi.h>
31 #include "ad1836.h"
32 
33 /* codec private data */
34 struct ad1836_priv {
35 	struct snd_soc_codec codec;
36 	u16 reg_cache[AD1836_NUM_REGS];
37 };
38 
39 static struct snd_soc_codec *ad1836_codec;
40 struct snd_soc_codec_device soc_codec_dev_ad1836;
41 static int ad1836_register(struct ad1836_priv *ad1836);
42 static void ad1836_unregister(struct ad1836_priv *ad1836);
43 
44 /*
45  * AD1836 volume/mute/de-emphasis etc. controls
46  */
47 static const char *ad1836_deemp[] = {"None", "44.1kHz", "32kHz", "48kHz"};
48 
49 static const struct soc_enum ad1836_deemp_enum =
50 	SOC_ENUM_SINGLE(AD1836_DAC_CTRL1, 8, 4, ad1836_deemp);
51 
52 static const struct snd_kcontrol_new ad1836_snd_controls[] = {
53 	/* DAC volume control */
54 	SOC_DOUBLE_R("DAC1 Volume", AD1836_DAC_L1_VOL,
55 			AD1836_DAC_R1_VOL, 0, 0x3FF, 0),
56 	SOC_DOUBLE_R("DAC2 Volume", AD1836_DAC_L2_VOL,
57 			AD1836_DAC_R2_VOL, 0, 0x3FF, 0),
58 	SOC_DOUBLE_R("DAC3 Volume", AD1836_DAC_L3_VOL,
59 			AD1836_DAC_R3_VOL, 0, 0x3FF, 0),
60 
61 	/* ADC switch control */
62 	SOC_DOUBLE("ADC1 Switch", AD1836_ADC_CTRL2, AD1836_ADCL1_MUTE,
63 		AD1836_ADCR1_MUTE, 1, 1),
64 	SOC_DOUBLE("ADC2 Switch", AD1836_ADC_CTRL2, AD1836_ADCL2_MUTE,
65 		AD1836_ADCR2_MUTE, 1, 1),
66 
67 	/* DAC switch control */
68 	SOC_DOUBLE("DAC1 Switch", AD1836_DAC_CTRL2, AD1836_DACL1_MUTE,
69 		AD1836_DACR1_MUTE, 1, 1),
70 	SOC_DOUBLE("DAC2 Switch", AD1836_DAC_CTRL2, AD1836_DACL2_MUTE,
71 		AD1836_DACR2_MUTE, 1, 1),
72 	SOC_DOUBLE("DAC3 Switch", AD1836_DAC_CTRL2, AD1836_DACL3_MUTE,
73 		AD1836_DACR3_MUTE, 1, 1),
74 
75 	/* ADC high-pass filter */
76 	SOC_SINGLE("ADC High Pass Filter Switch", AD1836_ADC_CTRL1,
77 			AD1836_ADC_HIGHPASS_FILTER, 1, 0),
78 
79 	/* DAC de-emphasis */
80 	SOC_ENUM("Playback Deemphasis", ad1836_deemp_enum),
81 };
82 
83 static const struct snd_soc_dapm_widget ad1836_dapm_widgets[] = {
84 	SND_SOC_DAPM_DAC("DAC", "Playback", AD1836_DAC_CTRL1,
85 				AD1836_DAC_POWERDOWN, 1),
86 	SND_SOC_DAPM_ADC("ADC", "Capture", SND_SOC_NOPM, 0, 0),
87 	SND_SOC_DAPM_SUPPLY("ADC_PWR", AD1836_ADC_CTRL1,
88 				AD1836_ADC_POWERDOWN, 1, NULL, 0),
89 	SND_SOC_DAPM_OUTPUT("DAC1OUT"),
90 	SND_SOC_DAPM_OUTPUT("DAC2OUT"),
91 	SND_SOC_DAPM_OUTPUT("DAC3OUT"),
92 	SND_SOC_DAPM_INPUT("ADC1IN"),
93 	SND_SOC_DAPM_INPUT("ADC2IN"),
94 };
95 
96 static const struct snd_soc_dapm_route audio_paths[] = {
97 	{ "DAC", NULL, "ADC_PWR" },
98 	{ "ADC", NULL, "ADC_PWR" },
99 	{ "DAC1OUT", "DAC1 Switch", "DAC" },
100 	{ "DAC2OUT", "DAC2 Switch", "DAC" },
101 	{ "DAC3OUT", "DAC3 Switch", "DAC" },
102 	{ "ADC", "ADC1 Switch", "ADC1IN" },
103 	{ "ADC", "ADC2 Switch", "ADC2IN" },
104 };
105 
106 /*
107  * DAI ops entries
108  */
109 
110 static int ad1836_set_dai_fmt(struct snd_soc_dai *codec_dai,
111 		unsigned int fmt)
112 {
113 	switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
114 	/* at present, we support adc aux mode to interface with
115 	 * blackfin sport tdm mode
116 	 */
117 	case SND_SOC_DAIFMT_DSP_A:
118 		break;
119 	default:
120 		return -EINVAL;
121 	}
122 
123 	switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
124 	case SND_SOC_DAIFMT_IB_IF:
125 		break;
126 	default:
127 		return -EINVAL;
128 	}
129 
130 	switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
131 	/* ALCLK,ABCLK are both output, AD1836 can only be master */
132 	case SND_SOC_DAIFMT_CBM_CFM:
133 		break;
134 	default:
135 		return -EINVAL;
136 	}
137 
138 	return 0;
139 }
140 
141 static int ad1836_hw_params(struct snd_pcm_substream *substream,
142 		struct snd_pcm_hw_params *params,
143 		struct snd_soc_dai *dai)
144 {
145 	int word_len = 0;
146 
147 	struct snd_soc_pcm_runtime *rtd = substream->private_data;
148 	struct snd_soc_device *socdev = rtd->socdev;
149 	struct snd_soc_codec *codec = socdev->card->codec;
150 
151 	/* bit size */
152 	switch (params_format(params)) {
153 	case SNDRV_PCM_FORMAT_S16_LE:
154 		word_len = 3;
155 		break;
156 	case SNDRV_PCM_FORMAT_S20_3LE:
157 		word_len = 1;
158 		break;
159 	case SNDRV_PCM_FORMAT_S24_LE:
160 	case SNDRV_PCM_FORMAT_S32_LE:
161 		word_len = 0;
162 		break;
163 	}
164 
165 	snd_soc_update_bits(codec, AD1836_DAC_CTRL1,
166 		AD1836_DAC_WORD_LEN_MASK, word_len);
167 
168 	snd_soc_update_bits(codec, AD1836_ADC_CTRL2,
169 		AD1836_ADC_WORD_LEN_MASK, word_len);
170 
171 	return 0;
172 }
173 
174 #ifdef CONFIG_PM
175 static int ad1836_soc_suspend(struct platform_device *pdev,
176 		pm_message_t state)
177 {
178 	struct snd_soc_device *socdev = platform_get_drvdata(pdev);
179 	struct snd_soc_codec *codec = socdev->card->codec;
180 
181 	/* reset clock control mode */
182 	u16 adc_ctrl2 = snd_soc_read(codec, AD1836_ADC_CTRL2);
183 	adc_ctrl2 &= ~AD1836_ADC_SERFMT_MASK;
184 
185 	return snd_soc_write(codec, AD1836_ADC_CTRL2, adc_ctrl2);
186 }
187 
188 static int ad1836_soc_resume(struct platform_device *pdev)
189 {
190 	struct snd_soc_device *socdev = platform_get_drvdata(pdev);
191 	struct snd_soc_codec *codec = socdev->card->codec;
192 
193 	/* restore clock control mode */
194 	u16 adc_ctrl2 = snd_soc_read(codec, AD1836_ADC_CTRL2);
195 	adc_ctrl2 |= AD1836_ADC_AUX;
196 
197 	return snd_soc_write(codec, AD1836_ADC_CTRL2, adc_ctrl2);
198 }
199 #else
200 #define ad1836_soc_suspend NULL
201 #define ad1836_soc_resume  NULL
202 #endif
203 
204 static int __devinit ad1836_spi_probe(struct spi_device *spi)
205 {
206 	struct snd_soc_codec *codec;
207 	struct ad1836_priv *ad1836;
208 
209 	ad1836 = kzalloc(sizeof(struct ad1836_priv), GFP_KERNEL);
210 	if (ad1836 == NULL)
211 		return -ENOMEM;
212 
213 	codec = &ad1836->codec;
214 	codec->control_data = spi;
215 	codec->dev = &spi->dev;
216 
217 	dev_set_drvdata(&spi->dev, ad1836);
218 
219 	return ad1836_register(ad1836);
220 }
221 
222 static int __devexit ad1836_spi_remove(struct spi_device *spi)
223 {
224 	struct ad1836_priv *ad1836 = dev_get_drvdata(&spi->dev);
225 
226 	ad1836_unregister(ad1836);
227 	return 0;
228 }
229 
230 static struct spi_driver ad1836_spi_driver = {
231 	.driver = {
232 		.name	= "ad1836",
233 		.owner	= THIS_MODULE,
234 	},
235 	.probe		= ad1836_spi_probe,
236 	.remove		= __devexit_p(ad1836_spi_remove),
237 };
238 
239 static struct snd_soc_dai_ops ad1836_dai_ops = {
240 	.hw_params = ad1836_hw_params,
241 	.set_fmt = ad1836_set_dai_fmt,
242 };
243 
244 /* codec DAI instance */
245 struct snd_soc_dai ad1836_dai = {
246 	.name = "AD1836",
247 	.playback = {
248 		.stream_name = "Playback",
249 		.channels_min = 2,
250 		.channels_max = 6,
251 		.rates = SNDRV_PCM_RATE_48000,
252 		.formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
253 			SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
254 	},
255 	.capture = {
256 		.stream_name = "Capture",
257 		.channels_min = 2,
258 		.channels_max = 4,
259 		.rates = SNDRV_PCM_RATE_48000,
260 		.formats = SNDRV_PCM_FMTBIT_S32_LE | SNDRV_PCM_FMTBIT_S16_LE |
261 			SNDRV_PCM_FMTBIT_S20_3LE | SNDRV_PCM_FMTBIT_S24_LE,
262 	},
263 	.ops = &ad1836_dai_ops,
264 };
265 EXPORT_SYMBOL_GPL(ad1836_dai);
266 
267 static int ad1836_register(struct ad1836_priv *ad1836)
268 {
269 	int ret;
270 	struct snd_soc_codec *codec = &ad1836->codec;
271 
272 	if (ad1836_codec) {
273 		dev_err(codec->dev, "Another ad1836 is registered\n");
274 		return -EINVAL;
275 	}
276 
277 	mutex_init(&codec->mutex);
278 	INIT_LIST_HEAD(&codec->dapm_widgets);
279 	INIT_LIST_HEAD(&codec->dapm_paths);
280 	snd_soc_codec_set_drvdata(codec, ad1836);
281 	codec->reg_cache = ad1836->reg_cache;
282 	codec->reg_cache_size = AD1836_NUM_REGS;
283 	codec->name = "AD1836";
284 	codec->owner = THIS_MODULE;
285 	codec->dai = &ad1836_dai;
286 	codec->num_dai = 1;
287 	INIT_LIST_HEAD(&codec->dapm_widgets);
288 	INIT_LIST_HEAD(&codec->dapm_paths);
289 
290 	ad1836_dai.dev = codec->dev;
291 	ad1836_codec = codec;
292 
293 	ret = snd_soc_codec_set_cache_io(codec, 4, 12, SND_SOC_SPI);
294 	if (ret < 0) {
295 		dev_err(codec->dev, "failed to set cache I/O: %d\n",
296 				ret);
297 		kfree(ad1836);
298 		return ret;
299 	}
300 
301 	/* default setting for ad1836 */
302 	/* de-emphasis: 48kHz, power-on dac */
303 	snd_soc_write(codec, AD1836_DAC_CTRL1, 0x300);
304 	/* unmute dac channels */
305 	snd_soc_write(codec, AD1836_DAC_CTRL2, 0x0);
306 	/* high-pass filter enable, power-on adc */
307 	snd_soc_write(codec, AD1836_ADC_CTRL1, 0x100);
308 	/* unmute adc channles, adc aux mode */
309 	snd_soc_write(codec, AD1836_ADC_CTRL2, 0x180);
310 	/* left/right diff:PGA/MUX */
311 	snd_soc_write(codec, AD1836_ADC_CTRL3, 0x3A);
312 	/* volume */
313 	snd_soc_write(codec, AD1836_DAC_L1_VOL, 0x3FF);
314 	snd_soc_write(codec, AD1836_DAC_R1_VOL, 0x3FF);
315 	snd_soc_write(codec, AD1836_DAC_L2_VOL, 0x3FF);
316 	snd_soc_write(codec, AD1836_DAC_R2_VOL, 0x3FF);
317 	snd_soc_write(codec, AD1836_DAC_L3_VOL, 0x3FF);
318 	snd_soc_write(codec, AD1836_DAC_R3_VOL, 0x3FF);
319 
320 	ret = snd_soc_register_codec(codec);
321 	if (ret != 0) {
322 		dev_err(codec->dev, "Failed to register codec: %d\n", ret);
323 		kfree(ad1836);
324 		return ret;
325 	}
326 
327 	ret = snd_soc_register_dai(&ad1836_dai);
328 	if (ret != 0) {
329 		dev_err(codec->dev, "Failed to register DAI: %d\n", ret);
330 		snd_soc_unregister_codec(codec);
331 		kfree(ad1836);
332 		return ret;
333 	}
334 
335 	return 0;
336 }
337 
338 static void ad1836_unregister(struct ad1836_priv *ad1836)
339 {
340 	snd_soc_unregister_dai(&ad1836_dai);
341 	snd_soc_unregister_codec(&ad1836->codec);
342 	kfree(ad1836);
343 	ad1836_codec = NULL;
344 }
345 
346 static int ad1836_probe(struct platform_device *pdev)
347 {
348 	struct snd_soc_device *socdev = platform_get_drvdata(pdev);
349 	struct snd_soc_codec *codec;
350 	int ret = 0;
351 
352 	if (ad1836_codec == NULL) {
353 		dev_err(&pdev->dev, "Codec device not registered\n");
354 		return -ENODEV;
355 	}
356 
357 	socdev->card->codec = ad1836_codec;
358 	codec = ad1836_codec;
359 
360 	/* register pcms */
361 	ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
362 	if (ret < 0) {
363 		dev_err(codec->dev, "failed to create pcms: %d\n", ret);
364 		goto pcm_err;
365 	}
366 
367 	snd_soc_add_controls(codec, ad1836_snd_controls,
368 			     ARRAY_SIZE(ad1836_snd_controls));
369 	snd_soc_dapm_new_controls(codec, ad1836_dapm_widgets,
370 				  ARRAY_SIZE(ad1836_dapm_widgets));
371 	snd_soc_dapm_add_routes(codec, audio_paths, ARRAY_SIZE(audio_paths));
372 
373 pcm_err:
374 	return ret;
375 }
376 
377 /* power down chip */
378 static int ad1836_remove(struct platform_device *pdev)
379 {
380 	struct snd_soc_device *socdev = platform_get_drvdata(pdev);
381 
382 	snd_soc_free_pcms(socdev);
383 	snd_soc_dapm_free(socdev);
384 
385 	return 0;
386 }
387 
388 struct snd_soc_codec_device soc_codec_dev_ad1836 = {
389 	.probe = 	ad1836_probe,
390 	.remove = 	ad1836_remove,
391 	.suspend =      ad1836_soc_suspend,
392 	.resume =       ad1836_soc_resume,
393 };
394 EXPORT_SYMBOL_GPL(soc_codec_dev_ad1836);
395 
396 static int __init ad1836_init(void)
397 {
398 	int ret;
399 
400 	ret = spi_register_driver(&ad1836_spi_driver);
401 	if (ret != 0) {
402 		printk(KERN_ERR "Failed to register ad1836 SPI driver: %d\n",
403 				ret);
404 	}
405 
406 	return ret;
407 }
408 module_init(ad1836_init);
409 
410 static void __exit ad1836_exit(void)
411 {
412 	spi_unregister_driver(&ad1836_spi_driver);
413 }
414 module_exit(ad1836_exit);
415 
416 MODULE_DESCRIPTION("ASoC ad1836 driver");
417 MODULE_AUTHOR("Barry Song <21cnbao@gmail.com>");
418 MODULE_LICENSE("GPL");
419