xref: /linux/sound/soc/codecs/ad1980.c (revision bcefe12eff5dca6fdfa94ed85e5bee66380d5cd9)
1 /*
2  * ad1980.c  --  ALSA Soc AD1980 codec support
3  *
4  * Copyright:	Analog Device Inc.
5  * Author:	Roy Huang <roy.huang@analog.com>
6  * 		Cliff Cai <cliff.cai@analog.com>
7  *
8  *  This program is free software; you can redistribute  it and/or modify it
9  *  under  the terms of  the GNU General  Public License as published by the
10  *  Free Software Foundation;  either version 2 of the  License, or (at your
11  *  option) any later version.
12  */
13 
14 #include <linux/init.h>
15 #include <linux/module.h>
16 #include <linux/kernel.h>
17 #include <linux/device.h>
18 #include <sound/core.h>
19 #include <sound/pcm.h>
20 #include <sound/ac97_codec.h>
21 #include <sound/initval.h>
22 #include <sound/soc.h>
23 #include <sound/soc-dapm.h>
24 
25 #include "ad1980.h"
26 
27 static unsigned int ac97_read(struct snd_soc_codec *codec,
28 	unsigned int reg);
29 static int ac97_write(struct snd_soc_codec *codec,
30 	unsigned int reg, unsigned int val);
31 
32 /*
33  * AD1980 register cache
34  */
35 static const u16 ad1980_reg[] = {
36 	0x0090, 0x8000, 0x8000, 0x8000, /* 0 - 6  */
37 	0x0000, 0x0000, 0x8008, 0x8008, /* 8 - e  */
38 	0x8808, 0x8808, 0x0000, 0x8808, /* 10 - 16 */
39 	0x8808, 0x0000, 0x8000, 0x0000, /* 18 - 1e */
40 	0x0000, 0x0000, 0x0000, 0x0000, /* 20 - 26 */
41 	0x03c7, 0x0000, 0xbb80, 0xbb80, /* 28 - 2e */
42 	0xbb80, 0xbb80, 0x0000, 0x8080, /* 30 - 36 */
43 	0x8080, 0x2000, 0x0000, 0x0000, /* 38 - 3e */
44 	0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
45 	0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
46 	0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
47 	0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
48 	0x8080, 0x0000, 0x0000, 0x0000, /* 60 - 66 */
49 	0x0000, 0x0000, 0x0000, 0x0000, /* reserved */
50 	0x0000, 0x0000, 0x1001, 0x0000, /* 70 - 76 */
51 	0x0000, 0x0000, 0x4144, 0x5370  /* 78 - 7e */
52 };
53 
54 static const char *ad1980_rec_sel[] = {"Mic", "CD", "NC", "AUX", "Line",
55 		"Stereo Mix", "Mono Mix", "Phone"};
56 
57 static const struct soc_enum ad1980_cap_src =
58 	SOC_ENUM_DOUBLE(AC97_REC_SEL, 8, 0, 7, ad1980_rec_sel);
59 
60 static const struct snd_kcontrol_new ad1980_snd_ac97_controls[] = {
61 SOC_DOUBLE("Master Playback Volume", AC97_MASTER, 8, 0, 31, 1),
62 SOC_SINGLE("Master Playback Switch", AC97_MASTER, 15, 1, 1),
63 
64 SOC_DOUBLE("Headphone Playback Volume", AC97_HEADPHONE, 8, 0, 31, 1),
65 SOC_SINGLE("Headphone Playback Switch", AC97_HEADPHONE, 15, 1, 1),
66 
67 SOC_DOUBLE("PCM Playback Volume", AC97_PCM, 8, 0, 31, 1),
68 SOC_SINGLE("PCM Playback Switch", AC97_PCM, 15, 1, 1),
69 
70 SOC_DOUBLE("PCM Capture Volume", AC97_REC_GAIN, 8, 0, 31, 0),
71 SOC_SINGLE("PCM Capture Switch", AC97_REC_GAIN, 15, 1, 1),
72 
73 SOC_SINGLE("Mono Playback Volume", AC97_MASTER_MONO, 0, 31, 1),
74 SOC_SINGLE("Mono Playback Switch", AC97_MASTER_MONO, 15, 1, 1),
75 
76 SOC_SINGLE("Phone Capture Volume", AC97_PHONE, 0, 31, 1),
77 SOC_SINGLE("Phone Capture Switch", AC97_PHONE, 15, 1, 1),
78 
79 SOC_SINGLE("Mic Volume", AC97_MIC, 0, 31, 1),
80 SOC_SINGLE("Mic Switch", AC97_MIC, 15, 1, 1),
81 
82 SOC_SINGLE("Stereo Mic Switch", AC97_AD_MISC, 6, 1, 0),
83 SOC_DOUBLE("Line HP Swap Switch", AC97_AD_MISC, 10, 5, 1, 0),
84 
85 SOC_DOUBLE("Surround Playback Volume", AC97_SURROUND_MASTER, 8, 0, 31, 1),
86 SOC_DOUBLE("Surround Playback Switch", AC97_SURROUND_MASTER, 15, 7, 1, 1),
87 
88 SOC_DOUBLE("Center/LFE Playback Volume", AC97_CENTER_LFE_MASTER, 8, 0, 31, 1),
89 SOC_DOUBLE("Center/LFE Playback Switch", AC97_CENTER_LFE_MASTER, 15, 7, 1, 1),
90 
91 SOC_ENUM("Capture Source", ad1980_cap_src),
92 
93 SOC_SINGLE("Mic Boost Switch", AC97_MIC, 6, 1, 0),
94 };
95 
96 static unsigned int ac97_read(struct snd_soc_codec *codec,
97 	unsigned int reg)
98 {
99 	u16 *cache = codec->reg_cache;
100 
101 	switch (reg) {
102 	case AC97_RESET:
103 	case AC97_INT_PAGING:
104 	case AC97_POWERDOWN:
105 	case AC97_EXTENDED_STATUS:
106 	case AC97_VENDOR_ID1:
107 	case AC97_VENDOR_ID2:
108 		return soc_ac97_ops.read(codec->ac97, reg);
109 	default:
110 		reg = reg >> 1;
111 
112 		if (reg >= ARRAY_SIZE(ad1980_reg))
113 			return -EINVAL;
114 
115 		return cache[reg];
116 	}
117 }
118 
119 static int ac97_write(struct snd_soc_codec *codec, unsigned int reg,
120 	unsigned int val)
121 {
122 	u16 *cache = codec->reg_cache;
123 
124 	soc_ac97_ops.write(codec->ac97, reg, val);
125 	reg = reg >> 1;
126 	if (reg < ARRAY_SIZE(ad1980_reg))
127 		cache[reg] = val;
128 
129 	return 0;
130 }
131 
132 struct snd_soc_dai ad1980_dai = {
133 	.name = "AC97",
134 	.ac97_control = 1,
135 	.playback = {
136 		.stream_name = "Playback",
137 		.channels_min = 2,
138 		.channels_max = 6,
139 		.rates = SNDRV_PCM_RATE_48000,
140 		.formats = SND_SOC_STD_AC97_FMTS, },
141 	.capture = {
142 		.stream_name = "Capture",
143 		.channels_min = 2,
144 		.channels_max = 2,
145 		.rates = SNDRV_PCM_RATE_48000,
146 		.formats = SND_SOC_STD_AC97_FMTS, },
147 };
148 EXPORT_SYMBOL_GPL(ad1980_dai);
149 
150 static int ad1980_reset(struct snd_soc_codec *codec, int try_warm)
151 {
152 	u16 retry_cnt = 0;
153 
154 retry:
155 	if (try_warm && soc_ac97_ops.warm_reset) {
156 		soc_ac97_ops.warm_reset(codec->ac97);
157 		if (ac97_read(codec, AC97_RESET) == 0x0090)
158 			return 1;
159 	}
160 
161 	soc_ac97_ops.reset(codec->ac97);
162 	/* Set bit 16slot in register 74h, then every slot will has only 16
163 	 * bits. This command is sent out in 20bit mode, in which case the
164 	 * first nibble of data is eaten by the addr. (Tag is always 16 bit)*/
165 	ac97_write(codec, AC97_AD_SERIAL_CFG, 0x9900);
166 
167 	if (ac97_read(codec, AC97_RESET)  != 0x0090)
168 		goto err;
169 	return 0;
170 
171 err:
172 	while (retry_cnt++ < 10)
173 		goto retry;
174 
175 	printk(KERN_ERR "AD1980 AC97 reset failed\n");
176 	return -EIO;
177 }
178 
179 static int ad1980_soc_probe(struct platform_device *pdev)
180 {
181 	struct snd_soc_device *socdev = platform_get_drvdata(pdev);
182 	struct snd_soc_codec *codec;
183 	int ret = 0;
184 	u16 vendor_id2;
185 	u16 ext_status;
186 
187 	printk(KERN_INFO "AD1980 SoC Audio Codec\n");
188 
189 	socdev->card->codec = kzalloc(sizeof(struct snd_soc_codec), GFP_KERNEL);
190 	if (socdev->card->codec == NULL)
191 		return -ENOMEM;
192 	codec = socdev->card->codec;
193 	mutex_init(&codec->mutex);
194 
195 	codec->reg_cache =
196 		kzalloc(sizeof(u16) * ARRAY_SIZE(ad1980_reg), GFP_KERNEL);
197 	if (codec->reg_cache == NULL) {
198 		ret = -ENOMEM;
199 		goto cache_err;
200 	}
201 	memcpy(codec->reg_cache, ad1980_reg, sizeof(u16) * \
202 			ARRAY_SIZE(ad1980_reg));
203 	codec->reg_cache_size = sizeof(u16) * ARRAY_SIZE(ad1980_reg);
204 	codec->reg_cache_step = 2;
205 	codec->name = "AD1980";
206 	codec->owner = THIS_MODULE;
207 	codec->dai = &ad1980_dai;
208 	codec->num_dai = 1;
209 	codec->write = ac97_write;
210 	codec->read = ac97_read;
211 	INIT_LIST_HEAD(&codec->dapm_widgets);
212 	INIT_LIST_HEAD(&codec->dapm_paths);
213 
214 	ret = snd_soc_new_ac97_codec(codec, &soc_ac97_ops, 0);
215 	if (ret < 0) {
216 		printk(KERN_ERR "ad1980: failed to register AC97 codec\n");
217 		goto codec_err;
218 	}
219 
220 	/* register pcms */
221 	ret = snd_soc_new_pcms(socdev, SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1);
222 	if (ret < 0)
223 		goto pcm_err;
224 
225 
226 	ret = ad1980_reset(codec, 0);
227 	if (ret < 0) {
228 		printk(KERN_ERR "Failed to reset AD1980: AC97 link error\n");
229 		goto reset_err;
230 	}
231 
232 	/* Read out vendor ID to make sure it is ad1980 */
233 	if (ac97_read(codec, AC97_VENDOR_ID1) != 0x4144)
234 		goto reset_err;
235 
236 	vendor_id2 = ac97_read(codec, AC97_VENDOR_ID2);
237 
238 	if (vendor_id2 != 0x5370) {
239 		if (vendor_id2 != 0x5374)
240 			goto reset_err;
241 		else
242 			printk(KERN_WARNING "ad1980: "
243 				"Found AD1981 - only 2/2 IN/OUT Channels "
244 				"supported\n");
245 	}
246 
247 	/* unmute captures and playbacks volume */
248 	ac97_write(codec, AC97_MASTER, 0x0000);
249 	ac97_write(codec, AC97_PCM, 0x0000);
250 	ac97_write(codec, AC97_REC_GAIN, 0x0000);
251 	ac97_write(codec, AC97_CENTER_LFE_MASTER, 0x0000);
252 	ac97_write(codec, AC97_SURROUND_MASTER, 0x0000);
253 
254 	/*power on LFE/CENTER/Surround DACs*/
255 	ext_status = ac97_read(codec, AC97_EXTENDED_STATUS);
256 	ac97_write(codec, AC97_EXTENDED_STATUS, ext_status&~0x3800);
257 
258 	snd_soc_add_controls(codec, ad1980_snd_ac97_controls,
259 				ARRAY_SIZE(ad1980_snd_ac97_controls));
260 	ret = snd_soc_init_card(socdev);
261 	if (ret < 0) {
262 		printk(KERN_ERR "ad1980: failed to register card\n");
263 		goto reset_err;
264 	}
265 
266 	return 0;
267 
268 reset_err:
269 	snd_soc_free_pcms(socdev);
270 
271 pcm_err:
272 	snd_soc_free_ac97_codec(codec);
273 
274 codec_err:
275 	kfree(codec->reg_cache);
276 
277 cache_err:
278 	kfree(socdev->card->codec);
279 	socdev->card->codec = NULL;
280 	return ret;
281 }
282 
283 static int ad1980_soc_remove(struct platform_device *pdev)
284 {
285 	struct snd_soc_device *socdev = platform_get_drvdata(pdev);
286 	struct snd_soc_codec *codec = socdev->card->codec;
287 
288 	if (codec == NULL)
289 		return 0;
290 
291 	snd_soc_dapm_free(socdev);
292 	snd_soc_free_pcms(socdev);
293 	snd_soc_free_ac97_codec(codec);
294 	kfree(codec->reg_cache);
295 	kfree(codec);
296 	return 0;
297 }
298 
299 struct snd_soc_codec_device soc_codec_dev_ad1980 = {
300 	.probe = 	ad1980_soc_probe,
301 	.remove = 	ad1980_soc_remove,
302 };
303 EXPORT_SYMBOL_GPL(soc_codec_dev_ad1980);
304 
305 MODULE_DESCRIPTION("ASoC ad1980 driver");
306 MODULE_AUTHOR("Roy Huang, Cliff Cai");
307 MODULE_LICENSE("GPL");
308