xref: /openbmc/linux/sound/soc/codecs/stac9766.c (revision 275876e2)
1 /*
2  * stac9766.c  --  ALSA SoC STAC9766 codec support
3  *
4  * Copyright 2009 Jon Smirl, Digispeaker
5  * Author: Jon Smirl <jonsmirl@gmail.com>
6  *
7  *  This program is free software; you can redistribute  it and/or modify it
8  *  under  the terms of  the GNU General  Public License as published by the
9  *  Free Software Foundation;  either version 2 of the  License, or (at your
10  *  option) any later version.
11  *
12  *  Features:-
13  *
14  *   o Support for AC97 Codec, S/PDIF
15  */
16 
17 #include <linux/init.h>
18 #include <linux/slab.h>
19 #include <linux/module.h>
20 #include <linux/device.h>
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/ac97_codec.h>
24 #include <sound/initval.h>
25 #include <sound/pcm_params.h>
26 #include <sound/soc.h>
27 #include <sound/tlv.h>
28 
29 #include "stac9766.h"
30 
31 /*
32  * STAC9766 register cache
33  */
34 static const u16 stac9766_reg[] = {
35 	0x6A90, 0x8000, 0x8000, 0x8000, /* 6 */
36 	0x0000, 0x0000, 0x8008, 0x8008, /* e */
37 	0x8808, 0x8808, 0x8808, 0x8808, /* 16 */
38 	0x8808, 0x0000, 0x8000, 0x0000, /* 1e */
39 	0x0000, 0x0000, 0x0000, 0x000f, /* 26 */
40 	0x0a05, 0x0400, 0xbb80, 0x0000, /* 2e */
41 	0x0000, 0xbb80, 0x0000, 0x0000, /* 36 */
42 	0x0000, 0x2000, 0x0000, 0x0100, /* 3e */
43 	0x0000, 0x0000, 0x0080, 0x0000, /* 46 */
44 	0x0000, 0x0000, 0x0003, 0xffff, /* 4e */
45 	0x0000, 0x0000, 0x0000, 0x0000, /* 56 */
46 	0x4000, 0x0000, 0x0000, 0x0000, /* 5e */
47 	0x1201, 0xFFFF, 0xFFFF, 0x0000, /* 66 */
48 	0x0000, 0x0000, 0x0000, 0x0000, /* 6e */
49 	0x0000, 0x0000, 0x0000, 0x0006, /* 76 */
50 	0x0000, 0x0000, 0x0000, 0x0000, /* 7e */
51 };
52 
53 static const char *stac9766_record_mux[] = {"Mic", "CD", "Video", "AUX",
54 			"Line", "Stereo Mix", "Mono Mix", "Phone"};
55 static const char *stac9766_mono_mux[] = {"Mix", "Mic"};
56 static const char *stac9766_mic_mux[] = {"Mic1", "Mic2"};
57 static const char *stac9766_SPDIF_mux[] = {"PCM", "ADC Record"};
58 static const char *stac9766_popbypass_mux[] = {"Normal", "Bypass Mixer"};
59 static const char *stac9766_record_all_mux[] = {"All analog",
60 	"Analog plus DAC"};
61 static const char *stac9766_boost1[] = {"0dB", "10dB"};
62 static const char *stac9766_boost2[] = {"0dB", "20dB"};
63 static const char *stac9766_stereo_mic[] = {"Off", "On"};
64 
65 static SOC_ENUM_DOUBLE_DECL(stac9766_record_enum,
66 			    AC97_REC_SEL, 8, 0, stac9766_record_mux);
67 static SOC_ENUM_SINGLE_DECL(stac9766_mono_enum,
68 			    AC97_GENERAL_PURPOSE, 9, stac9766_mono_mux);
69 static SOC_ENUM_SINGLE_DECL(stac9766_mic_enum,
70 			    AC97_GENERAL_PURPOSE, 8, stac9766_mic_mux);
71 static SOC_ENUM_SINGLE_DECL(stac9766_SPDIF_enum,
72 			    AC97_STAC_DA_CONTROL, 1, stac9766_SPDIF_mux);
73 static SOC_ENUM_SINGLE_DECL(stac9766_popbypass_enum,
74 			    AC97_GENERAL_PURPOSE, 15, stac9766_popbypass_mux);
75 static SOC_ENUM_SINGLE_DECL(stac9766_record_all_enum,
76 			    AC97_STAC_ANALOG_SPECIAL, 12,
77 			    stac9766_record_all_mux);
78 static SOC_ENUM_SINGLE_DECL(stac9766_boost1_enum,
79 			    AC97_MIC, 6, stac9766_boost1); /* 0/10dB */
80 static SOC_ENUM_SINGLE_DECL(stac9766_boost2_enum,
81 			    AC97_STAC_ANALOG_SPECIAL, 2, stac9766_boost2); /* 0/20dB */
82 static SOC_ENUM_SINGLE_DECL(stac9766_stereo_mic_enum,
83 			    AC97_STAC_STEREO_MIC, 2, stac9766_stereo_mic);
84 
85 static const DECLARE_TLV_DB_LINEAR(master_tlv, -4600, 0);
86 static const DECLARE_TLV_DB_LINEAR(record_tlv, 0, 2250);
87 static const DECLARE_TLV_DB_LINEAR(beep_tlv, -4500, 0);
88 static const DECLARE_TLV_DB_LINEAR(mix_tlv, -3450, 1200);
89 
90 static const struct snd_kcontrol_new stac9766_snd_ac97_controls[] = {
91 	SOC_DOUBLE_TLV("Speaker Volume", AC97_MASTER, 8, 0, 31, 1, master_tlv),
92 	SOC_SINGLE("Speaker Switch", AC97_MASTER, 15, 1, 1),
93 	SOC_DOUBLE_TLV("Headphone Volume", AC97_HEADPHONE, 8, 0, 31, 1,
94 		       master_tlv),
95 	SOC_SINGLE("Headphone Switch", AC97_HEADPHONE, 15, 1, 1),
96 	SOC_SINGLE_TLV("Mono Out Volume", AC97_MASTER_MONO, 0, 31, 1,
97 		       master_tlv),
98 	SOC_SINGLE("Mono Out Switch", AC97_MASTER_MONO, 15, 1, 1),
99 
100 	SOC_DOUBLE_TLV("Record Volume", AC97_REC_GAIN, 8, 0, 15, 0, record_tlv),
101 	SOC_SINGLE("Record Switch", AC97_REC_GAIN, 15, 1, 1),
102 
103 
104 	SOC_SINGLE_TLV("Beep Volume", AC97_PC_BEEP, 1, 15, 1, beep_tlv),
105 	SOC_SINGLE("Beep Switch", AC97_PC_BEEP, 15, 1, 1),
106 	SOC_SINGLE("Beep Frequency", AC97_PC_BEEP, 5, 127, 1),
107 	SOC_SINGLE_TLV("Phone Volume", AC97_PHONE, 0, 31, 1, mix_tlv),
108 	SOC_SINGLE("Phone Switch", AC97_PHONE, 15, 1, 1),
109 
110 	SOC_ENUM("Mic Boost1", stac9766_boost1_enum),
111 	SOC_ENUM("Mic Boost2", stac9766_boost2_enum),
112 	SOC_SINGLE_TLV("Mic Volume", AC97_MIC, 0, 31, 1, mix_tlv),
113 	SOC_SINGLE("Mic Switch", AC97_MIC, 15, 1, 1),
114 	SOC_ENUM("Stereo Mic", stac9766_stereo_mic_enum),
115 
116 	SOC_DOUBLE_TLV("Line Volume", AC97_LINE, 8, 0, 31, 1, mix_tlv),
117 	SOC_SINGLE("Line Switch", AC97_LINE, 15, 1, 1),
118 	SOC_DOUBLE_TLV("CD Volume", AC97_CD, 8, 0, 31, 1, mix_tlv),
119 	SOC_SINGLE("CD Switch", AC97_CD, 15, 1, 1),
120 	SOC_DOUBLE_TLV("AUX Volume", AC97_AUX, 8, 0, 31, 1, mix_tlv),
121 	SOC_SINGLE("AUX Switch", AC97_AUX, 15, 1, 1),
122 	SOC_DOUBLE_TLV("Video Volume", AC97_VIDEO, 8, 0, 31, 1, mix_tlv),
123 	SOC_SINGLE("Video Switch", AC97_VIDEO, 15, 1, 1),
124 
125 	SOC_DOUBLE_TLV("DAC Volume", AC97_PCM, 8, 0, 31, 1, mix_tlv),
126 	SOC_SINGLE("DAC Switch", AC97_PCM, 15, 1, 1),
127 	SOC_SINGLE("Loopback Test Switch", AC97_GENERAL_PURPOSE, 7, 1, 0),
128 	SOC_SINGLE("3D Volume", AC97_3D_CONTROL, 3, 2, 1),
129 	SOC_SINGLE("3D Switch", AC97_GENERAL_PURPOSE, 13, 1, 0),
130 
131 	SOC_ENUM("SPDIF Mux", stac9766_SPDIF_enum),
132 	SOC_ENUM("Mic1/2 Mux", stac9766_mic_enum),
133 	SOC_ENUM("Record All Mux", stac9766_record_all_enum),
134 	SOC_ENUM("Record Mux", stac9766_record_enum),
135 	SOC_ENUM("Mono Mux", stac9766_mono_enum),
136 	SOC_ENUM("Pop Bypass Mux", stac9766_popbypass_enum),
137 };
138 
139 static int stac9766_ac97_write(struct snd_soc_codec *codec, unsigned int reg,
140 			       unsigned int val)
141 {
142 	u16 *cache = codec->reg_cache;
143 
144 	if (reg > AC97_STAC_PAGE0) {
145 		stac9766_ac97_write(codec, AC97_INT_PAGING, 0);
146 		soc_ac97_ops->write(codec->ac97, reg, val);
147 		stac9766_ac97_write(codec, AC97_INT_PAGING, 1);
148 		return 0;
149 	}
150 	if (reg / 2 >= ARRAY_SIZE(stac9766_reg))
151 		return -EIO;
152 
153 	soc_ac97_ops->write(codec->ac97, reg, val);
154 	cache[reg / 2] = val;
155 	return 0;
156 }
157 
158 static unsigned int stac9766_ac97_read(struct snd_soc_codec *codec,
159 				       unsigned int reg)
160 {
161 	u16 val = 0, *cache = codec->reg_cache;
162 
163 	if (reg > AC97_STAC_PAGE0) {
164 		stac9766_ac97_write(codec, AC97_INT_PAGING, 0);
165 		val = soc_ac97_ops->read(codec->ac97, reg - AC97_STAC_PAGE0);
166 		stac9766_ac97_write(codec, AC97_INT_PAGING, 1);
167 		return val;
168 	}
169 	if (reg / 2 >= ARRAY_SIZE(stac9766_reg))
170 		return -EIO;
171 
172 	if (reg == AC97_RESET || reg == AC97_GPIO_STATUS ||
173 		reg == AC97_INT_PAGING || reg == AC97_VENDOR_ID1 ||
174 		reg == AC97_VENDOR_ID2) {
175 
176 		val = soc_ac97_ops->read(codec->ac97, reg);
177 		return val;
178 	}
179 	return cache[reg / 2];
180 }
181 
182 static int ac97_analog_prepare(struct snd_pcm_substream *substream,
183 			       struct snd_soc_dai *dai)
184 {
185 	struct snd_soc_codec *codec = dai->codec;
186 	struct snd_pcm_runtime *runtime = substream->runtime;
187 	unsigned short reg, vra;
188 
189 	vra = stac9766_ac97_read(codec, AC97_EXTENDED_STATUS);
190 
191 	vra |= 0x1; /* enable variable rate audio */
192 	vra &= ~0x4; /* disable SPDIF output */
193 
194 	stac9766_ac97_write(codec, AC97_EXTENDED_STATUS, vra);
195 
196 	if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
197 		reg = AC97_PCM_FRONT_DAC_RATE;
198 	else
199 		reg = AC97_PCM_LR_ADC_RATE;
200 
201 	return stac9766_ac97_write(codec, reg, runtime->rate);
202 }
203 
204 static int ac97_digital_prepare(struct snd_pcm_substream *substream,
205 				struct snd_soc_dai *dai)
206 {
207 	struct snd_soc_codec *codec = dai->codec;
208 	struct snd_pcm_runtime *runtime = substream->runtime;
209 	unsigned short reg, vra;
210 
211 	stac9766_ac97_write(codec, AC97_SPDIF, 0x2002);
212 
213 	vra = stac9766_ac97_read(codec, AC97_EXTENDED_STATUS);
214 	vra |= 0x5; /* Enable VRA and SPDIF out */
215 
216 	stac9766_ac97_write(codec, AC97_EXTENDED_STATUS, vra);
217 
218 	reg = AC97_PCM_FRONT_DAC_RATE;
219 
220 	return stac9766_ac97_write(codec, reg, runtime->rate);
221 }
222 
223 static int stac9766_set_bias_level(struct snd_soc_codec *codec,
224 				   enum snd_soc_bias_level level)
225 {
226 	switch (level) {
227 	case SND_SOC_BIAS_ON: /* full On */
228 	case SND_SOC_BIAS_PREPARE: /* partial On */
229 	case SND_SOC_BIAS_STANDBY: /* Off, with power */
230 		stac9766_ac97_write(codec, AC97_POWERDOWN, 0x0000);
231 		break;
232 	case SND_SOC_BIAS_OFF: /* Off, without power */
233 		/* disable everything including AC link */
234 		stac9766_ac97_write(codec, AC97_POWERDOWN, 0xffff);
235 		break;
236 	}
237 	codec->dapm.bias_level = level;
238 	return 0;
239 }
240 
241 static int stac9766_reset(struct snd_soc_codec *codec, int try_warm)
242 {
243 	if (try_warm && soc_ac97_ops->warm_reset) {
244 		soc_ac97_ops->warm_reset(codec->ac97);
245 		if (stac9766_ac97_read(codec, 0) == stac9766_reg[0])
246 			return 1;
247 	}
248 
249 	soc_ac97_ops->reset(codec->ac97);
250 	if (soc_ac97_ops->warm_reset)
251 		soc_ac97_ops->warm_reset(codec->ac97);
252 	if (stac9766_ac97_read(codec, 0) != stac9766_reg[0])
253 		return -EIO;
254 	return 0;
255 }
256 
257 static int stac9766_codec_suspend(struct snd_soc_codec *codec)
258 {
259 	stac9766_set_bias_level(codec, SND_SOC_BIAS_OFF);
260 	return 0;
261 }
262 
263 static int stac9766_codec_resume(struct snd_soc_codec *codec)
264 {
265 	u16 id, reset;
266 
267 	reset = 0;
268 	/* give the codec an AC97 warm reset to start the link */
269 reset:
270 	if (reset > 5) {
271 		printk(KERN_ERR "stac9766 failed to resume");
272 		return -EIO;
273 	}
274 	codec->ac97->bus->ops->warm_reset(codec->ac97);
275 	id = soc_ac97_ops->read(codec->ac97, AC97_VENDOR_ID2);
276 	if (id != 0x4c13) {
277 		stac9766_reset(codec, 0);
278 		reset++;
279 		goto reset;
280 	}
281 	stac9766_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
282 
283 	return 0;
284 }
285 
286 static const struct snd_soc_dai_ops stac9766_dai_ops_analog = {
287 	.prepare = ac97_analog_prepare,
288 };
289 
290 static const struct snd_soc_dai_ops stac9766_dai_ops_digital = {
291 	.prepare = ac97_digital_prepare,
292 };
293 
294 static struct snd_soc_dai_driver stac9766_dai[] = {
295 {
296 	.name = "stac9766-hifi-analog",
297 	.ac97_control = 1,
298 
299 	/* stream cababilities */
300 	.playback = {
301 		.stream_name = "stac9766 analog",
302 		.channels_min = 1,
303 		.channels_max = 2,
304 		.rates = SNDRV_PCM_RATE_8000_48000,
305 		.formats = SND_SOC_STD_AC97_FMTS,
306 	},
307 	.capture = {
308 		.stream_name = "stac9766 analog",
309 		.channels_min = 1,
310 		.channels_max = 2,
311 		.rates = SNDRV_PCM_RATE_8000_48000,
312 		.formats = SND_SOC_STD_AC97_FMTS,
313 	},
314 	/* alsa ops */
315 	.ops = &stac9766_dai_ops_analog,
316 },
317 {
318 	.name = "stac9766-hifi-IEC958",
319 	.ac97_control = 1,
320 
321 	/* stream cababilities */
322 	.playback = {
323 		.stream_name = "stac9766 IEC958",
324 		.channels_min = 1,
325 		.channels_max = 2,
326 		.rates = SNDRV_PCM_RATE_32000 | \
327 			SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000,
328 		.formats = SNDRV_PCM_FORMAT_IEC958_SUBFRAME_BE,
329 	},
330 	/* alsa ops */
331 	.ops = &stac9766_dai_ops_digital,
332 }
333 };
334 
335 static int stac9766_codec_probe(struct snd_soc_codec *codec)
336 {
337 	int ret = 0;
338 
339 	ret = snd_soc_new_ac97_codec(codec, soc_ac97_ops, 0);
340 	if (ret < 0)
341 		goto codec_err;
342 
343 	/* do a cold reset for the controller and then try
344 	 * a warm reset followed by an optional cold reset for codec */
345 	stac9766_reset(codec, 0);
346 	ret = stac9766_reset(codec, 1);
347 	if (ret < 0) {
348 		printk(KERN_ERR "Failed to reset STAC9766: AC97 link error\n");
349 		goto codec_err;
350 	}
351 
352 	stac9766_set_bias_level(codec, SND_SOC_BIAS_STANDBY);
353 
354 	snd_soc_add_codec_controls(codec, stac9766_snd_ac97_controls,
355 			     ARRAY_SIZE(stac9766_snd_ac97_controls));
356 
357 	return 0;
358 
359 codec_err:
360 	snd_soc_free_ac97_codec(codec);
361 	return ret;
362 }
363 
364 static int stac9766_codec_remove(struct snd_soc_codec *codec)
365 {
366 	snd_soc_free_ac97_codec(codec);
367 	return 0;
368 }
369 
370 static struct snd_soc_codec_driver soc_codec_dev_stac9766 = {
371 	.write = stac9766_ac97_write,
372 	.read = stac9766_ac97_read,
373 	.set_bias_level = stac9766_set_bias_level,
374 	.probe = stac9766_codec_probe,
375 	.remove = stac9766_codec_remove,
376 	.suspend = stac9766_codec_suspend,
377 	.resume = stac9766_codec_resume,
378 	.reg_cache_size = ARRAY_SIZE(stac9766_reg),
379 	.reg_word_size = sizeof(u16),
380 	.reg_cache_step = 2,
381 	.reg_cache_default = stac9766_reg,
382 };
383 
384 static int stac9766_probe(struct platform_device *pdev)
385 {
386 	return snd_soc_register_codec(&pdev->dev,
387 			&soc_codec_dev_stac9766, stac9766_dai, ARRAY_SIZE(stac9766_dai));
388 }
389 
390 static int stac9766_remove(struct platform_device *pdev)
391 {
392 	snd_soc_unregister_codec(&pdev->dev);
393 	return 0;
394 }
395 
396 static struct platform_driver stac9766_codec_driver = {
397 	.driver = {
398 			.name = "stac9766-codec",
399 			.owner = THIS_MODULE,
400 	},
401 
402 	.probe = stac9766_probe,
403 	.remove = stac9766_remove,
404 };
405 
406 module_platform_driver(stac9766_codec_driver);
407 
408 MODULE_DESCRIPTION("ASoC stac9766 driver");
409 MODULE_AUTHOR("Jon Smirl <jonsmirl@gmail.com>");
410 MODULE_LICENSE("GPL");
411