xref: /linux/sound/pci/ac97/ac97_codec.c (revision 1d6ae775d7a948c9575658eb41184fd2e506c0df)
1 /*
2  *  Copyright (c) by Jaroslav Kysela <perex@suse.cz>
3  *  Universal interface for Audio Codec '97
4  *
5  *  For more details look to AC '97 component specification revision 2.2
6  *  by Intel Corporation (http://developer.intel.com).
7  *
8  *
9  *   This program is free software; you can redistribute it and/or modify
10  *   it under the terms of the GNU General Public License as published by
11  *   the Free Software Foundation; either version 2 of the License, or
12  *   (at your option) any later version.
13  *
14  *   This program is distributed in the hope that it will be useful,
15  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
16  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  *   GNU General Public License for more details.
18  *
19  *   You should have received a copy of the GNU General Public License
20  *   along with this program; if not, write to the Free Software
21  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
22  *
23  */
24 
25 #include <sound/driver.h>
26 #include <linux/delay.h>
27 #include <linux/init.h>
28 #include <linux/slab.h>
29 #include <linux/pci.h>
30 #include <linux/moduleparam.h>
31 #include <sound/core.h>
32 #include <sound/pcm.h>
33 #include <sound/ac97_codec.h>
34 #include <sound/asoundef.h>
35 #include <sound/initval.h>
36 #include "ac97_local.h"
37 #include "ac97_id.h"
38 #include "ac97_patch.h"
39 
40 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
41 MODULE_DESCRIPTION("Universal interface for Audio Codec '97");
42 MODULE_LICENSE("GPL");
43 
44 static int enable_loopback;
45 
46 module_param(enable_loopback, bool, 0444);
47 MODULE_PARM_DESC(enable_loopback, "Enable AC97 ADC/DAC Loopback Control");
48 
49 /*
50 
51  */
52 
53 typedef struct {
54 	unsigned int id;
55 	unsigned int mask;
56 	const char *name;
57 	int (*patch)(ac97_t *ac97);
58 	int (*mpatch)(ac97_t *ac97);
59 	unsigned int flags;
60 } ac97_codec_id_t;
61 
62 static const ac97_codec_id_t snd_ac97_codec_id_vendors[] = {
63 { 0x414b4d00, 0xffffff00, "Asahi Kasei",	NULL,	NULL },
64 { 0x41445300, 0xffffff00, "Analog Devices",	NULL,	NULL },
65 { 0x414c4300, 0xffffff00, "Realtek",		NULL,	NULL },
66 { 0x414c4700, 0xffffff00, "Realtek",		NULL,	NULL },
67 { 0x434d4900, 0xffffff00, "C-Media Electronics", NULL,	NULL },
68 { 0x43525900, 0xffffff00, "Cirrus Logic",	NULL,	NULL },
69 { 0x43585400, 0xffffff00, "Conexant",           NULL,	NULL },
70 { 0x44543000, 0xffffff00, "Diamond Technology", NULL,	NULL },
71 { 0x454d4300, 0xffffff00, "eMicro",		NULL,	NULL },
72 { 0x45838300, 0xffffff00, "ESS Technology",	NULL,	NULL },
73 { 0x48525300, 0xffffff00, "Intersil",		NULL,	NULL },
74 { 0x49434500, 0xffffff00, "ICEnsemble",		NULL,	NULL },
75 { 0x49544500, 0xffffff00, "ITE Tech.Inc",	NULL,	NULL },
76 { 0x4e534300, 0xffffff00, "National Semiconductor", NULL, NULL },
77 { 0x50534300, 0xffffff00, "Philips",		NULL,	NULL },
78 { 0x53494c00, 0xffffff00, "Silicon Laboratory",	NULL,	NULL },
79 { 0x54524100, 0xffffff00, "TriTech",		NULL,	NULL },
80 { 0x54584e00, 0xffffff00, "Texas Instruments",	NULL,	NULL },
81 { 0x56494100, 0xffffff00, "VIA Technologies",   NULL,	NULL },
82 { 0x57454300, 0xffffff00, "Winbond",		NULL,	NULL },
83 { 0x574d4c00, 0xffffff00, "Wolfson",		NULL,	NULL },
84 { 0x594d4800, 0xffffff00, "Yamaha",		NULL,	NULL },
85 { 0x83847600, 0xffffff00, "SigmaTel",		NULL,	NULL },
86 { 0,	      0, 	  NULL,			NULL,	NULL }
87 };
88 
89 static const ac97_codec_id_t snd_ac97_codec_ids[] = {
90 { 0x414b4d00, 0xffffffff, "AK4540",		NULL,		NULL },
91 { 0x414b4d01, 0xffffffff, "AK4542",		NULL,		NULL },
92 { 0x414b4d02, 0xffffffff, "AK4543",		NULL,		NULL },
93 { 0x414b4d06, 0xffffffff, "AK4544A",		NULL,		NULL },
94 { 0x414b4d07, 0xffffffff, "AK4545",		NULL,		NULL },
95 { 0x41445303, 0xffffffff, "AD1819",		patch_ad1819,	NULL },
96 { 0x41445340, 0xffffffff, "AD1881",		patch_ad1881,	NULL },
97 { 0x41445348, 0xffffffff, "AD1881A",		patch_ad1881,	NULL },
98 { 0x41445360, 0xffffffff, "AD1885",		patch_ad1885,	NULL },
99 { 0x41445361, 0xffffffff, "AD1886",		patch_ad1886,	NULL },
100 { 0x41445362, 0xffffffff, "AD1887",		patch_ad1881,	NULL },
101 { 0x41445363, 0xffffffff, "AD1886A",		patch_ad1881,	NULL },
102 { 0x41445368, 0xffffffff, "AD1888",		patch_ad1888,	NULL },
103 { 0x41445370, 0xffffffff, "AD1980",		patch_ad1980,	NULL },
104 { 0x41445372, 0xffffffff, "AD1981A",		patch_ad1981a,	NULL },
105 { 0x41445374, 0xffffffff, "AD1981B",		patch_ad1981b,	NULL },
106 { 0x41445375, 0xffffffff, "AD1985",		patch_ad1985,	NULL },
107 { 0x41445378, 0xffffffff, "AD1986",		patch_ad1985,	NULL },
108 { 0x414c4300, 0xffffff00, "ALC100,100P", 	NULL,		NULL },
109 { 0x414c4710, 0xfffffff0, "ALC200,200P",	NULL,		NULL },
110 { 0x414c4721, 0xffffffff, "ALC650D",		NULL,	NULL }, /* already patched */
111 { 0x414c4722, 0xffffffff, "ALC650E",		NULL,	NULL }, /* already patched */
112 { 0x414c4723, 0xffffffff, "ALC650F",		NULL,	NULL }, /* already patched */
113 { 0x414c4720, 0xfffffff0, "ALC650",		patch_alc650,	NULL },
114 { 0x414c4760, 0xfffffff0, "ALC655",		patch_alc655,	NULL },
115 { 0x414c4780, 0xfffffff0, "ALC658",		patch_alc655,	NULL },
116 { 0x414c4790, 0xfffffff0, "ALC850",		patch_alc850,	NULL },
117 { 0x414c4730, 0xffffffff, "ALC101",		NULL,		NULL },
118 { 0x414c4740, 0xfffffff0, "ALC202",		NULL,		NULL },
119 { 0x414c4750, 0xfffffff0, "ALC250",		NULL,		NULL },
120 { 0x414c4770, 0xfffffff0, "ALC203",		NULL,		NULL },
121 { 0x434d4941, 0xffffffff, "CMI9738",		patch_cm9738,	NULL },
122 { 0x434d4961, 0xffffffff, "CMI9739",		patch_cm9739,	NULL },
123 { 0x434d4969, 0xffffffff, "CMI9780",		patch_cm9780,	NULL },
124 { 0x434d4978, 0xffffffff, "CMI9761",		patch_cm9761,	NULL },
125 { 0x434d4982, 0xffffffff, "CMI9761",		patch_cm9761,	NULL },
126 { 0x434d4983, 0xffffffff, "CMI9761",		patch_cm9761,	NULL },
127 { 0x43525900, 0xfffffff8, "CS4297",		NULL,		NULL },
128 { 0x43525910, 0xfffffff8, "CS4297A",		patch_cirrus_spdif,	NULL },
129 { 0x43525920, 0xfffffff8, "CS4298",		patch_cirrus_spdif,		NULL },
130 { 0x43525928, 0xfffffff8, "CS4294",		NULL,		NULL },
131 { 0x43525930, 0xfffffff8, "CS4299",		patch_cirrus_cs4299,	NULL },
132 { 0x43525948, 0xfffffff8, "CS4201",		NULL,		NULL },
133 { 0x43525958, 0xfffffff8, "CS4205",		patch_cirrus_spdif,	NULL },
134 { 0x43525960, 0xfffffff8, "CS4291",		NULL,		NULL },
135 { 0x43525970, 0xfffffff8, "CS4202",		NULL,		NULL },
136 { 0x43585421, 0xffffffff, "HSD11246",		NULL,		NULL },	// SmartMC II
137 { 0x43585428, 0xfffffff8, "Cx20468",		patch_conexant,	NULL }, // SmartAMC fixme: the mask might be different
138 { 0x44543031, 0xfffffff0, "DT0398",		NULL,		NULL },
139 { 0x454d4328, 0xffffffff, "28028",		NULL,		NULL },  // same as TR28028?
140 { 0x45838308, 0xffffffff, "ESS1988",		NULL,		NULL },
141 { 0x48525300, 0xffffff00, "HMP9701",		NULL,		NULL },
142 { 0x49434501, 0xffffffff, "ICE1230",		NULL,		NULL },
143 { 0x49434511, 0xffffffff, "ICE1232",		NULL,		NULL }, // alias VIA VT1611A?
144 { 0x49434514, 0xffffffff, "ICE1232A",		NULL,		NULL },
145 { 0x49434551, 0xffffffff, "VT1616", 		patch_vt1616,	NULL },
146 { 0x49434552, 0xffffffff, "VT1616i",		patch_vt1616,	NULL }, // VT1616 compatible (chipset integrated)
147 { 0x49544520, 0xffffffff, "IT2226E",		NULL,		NULL },
148 { 0x49544561, 0xffffffff, "IT2646E",		patch_it2646,	NULL },
149 { 0x4e534300, 0xffffffff, "LM4540,43,45,46,48",	NULL,		NULL }, // only guess --jk
150 { 0x4e534331, 0xffffffff, "LM4549",		NULL,		NULL },
151 { 0x4e534350, 0xffffffff, "LM4550",		NULL,		NULL },
152 { 0x50534304, 0xffffffff, "UCB1400",		NULL,		NULL },
153 { 0x53494c20, 0xffffffe0, "Si3036,8",		mpatch_si3036,	mpatch_si3036, AC97_MODEM_PATCH },
154 { 0x54524102, 0xffffffff, "TR28022",		NULL,		NULL },
155 { 0x54524106, 0xffffffff, "TR28026",		NULL,		NULL },
156 { 0x54524108, 0xffffffff, "TR28028",		patch_tritech_tr28028,	NULL }, // added by xin jin [07/09/99]
157 { 0x54524123, 0xffffffff, "TR28602",		NULL,		NULL }, // only guess --jk [TR28023 = eMicro EM28023 (new CT1297)]
158 { 0x54584e20, 0xffffffff, "TLC320AD9xC",	NULL,		NULL },
159 { 0x56494161, 0xffffffff, "VIA1612A",		NULL,		NULL }, // modified ICE1232 with S/PDIF
160 { 0x56494170, 0xffffffff, "VIA1617A",		patch_vt1617a,	NULL }, // modified VT1616 with S/PDIF
161 { 0x57454301, 0xffffffff, "W83971D",		NULL,		NULL },
162 { 0x574d4c00, 0xffffffff, "WM9701A",		NULL,		NULL },
163 { 0x574d4C03, 0xffffffff, "WM9703,WM9707,WM9708,WM9717", patch_wolfson03, NULL},
164 { 0x574d4C04, 0xffffffff, "WM9704M,WM9704Q",	patch_wolfson04, NULL},
165 { 0x574d4C05, 0xffffffff, "WM9705,WM9710",	patch_wolfson05, NULL},
166 { 0x574d4C09, 0xffffffff, "WM9709",		NULL,		NULL},
167 { 0x574d4C12, 0xffffffff, "WM9711,WM9712",	patch_wolfson11, NULL},
168 { 0x574d4c13, 0xffffffff, "WM9713,WM9714",	patch_wolfson13, NULL, AC97_DEFAULT_POWER_OFF},
169 { 0x594d4800, 0xffffffff, "YMF743",		NULL,		NULL },
170 { 0x594d4802, 0xffffffff, "YMF752",		NULL,		NULL },
171 { 0x594d4803, 0xffffffff, "YMF753",		patch_yamaha_ymf753,	NULL },
172 { 0x83847600, 0xffffffff, "STAC9700,83,84",	patch_sigmatel_stac9700,	NULL },
173 { 0x83847604, 0xffffffff, "STAC9701,3,4,5",	NULL,		NULL },
174 { 0x83847605, 0xffffffff, "STAC9704",		NULL,		NULL },
175 { 0x83847608, 0xffffffff, "STAC9708,11",	patch_sigmatel_stac9708,	NULL },
176 { 0x83847609, 0xffffffff, "STAC9721,23",	patch_sigmatel_stac9721,	NULL },
177 { 0x83847644, 0xffffffff, "STAC9744",		patch_sigmatel_stac9744,	NULL },
178 { 0x83847650, 0xffffffff, "STAC9750,51",	NULL,		NULL },	// patch?
179 { 0x83847652, 0xffffffff, "STAC9752,53",	NULL,		NULL }, // patch?
180 { 0x83847656, 0xffffffff, "STAC9756,57",	patch_sigmatel_stac9756,	NULL },
181 { 0x83847658, 0xffffffff, "STAC9758,59",	patch_sigmatel_stac9758,	NULL },
182 { 0x83847666, 0xffffffff, "STAC9766,67",	NULL,		NULL }, // patch?
183 { 0, 	      0,	  NULL,			NULL,		NULL }
184 };
185 
186 const char *snd_ac97_stereo_enhancements[] =
187 {
188   /*   0 */ "No 3D Stereo Enhancement",
189   /*   1 */ "Analog Devices Phat Stereo",
190   /*   2 */ "Creative Stereo Enhancement",
191   /*   3 */ "National Semi 3D Stereo Enhancement",
192   /*   4 */ "YAMAHA Ymersion",
193   /*   5 */ "BBE 3D Stereo Enhancement",
194   /*   6 */ "Crystal Semi 3D Stereo Enhancement",
195   /*   7 */ "Qsound QXpander",
196   /*   8 */ "Spatializer 3D Stereo Enhancement",
197   /*   9 */ "SRS 3D Stereo Enhancement",
198   /*  10 */ "Platform Tech 3D Stereo Enhancement",
199   /*  11 */ "AKM 3D Audio",
200   /*  12 */ "Aureal Stereo Enhancement",
201   /*  13 */ "Aztech 3D Enhancement",
202   /*  14 */ "Binaura 3D Audio Enhancement",
203   /*  15 */ "ESS Technology Stereo Enhancement",
204   /*  16 */ "Harman International VMAx",
205   /*  17 */ "Nvidea/IC Ensemble/KS Waves 3D Stereo Enhancement",
206   /*  18 */ "Philips Incredible Sound",
207   /*  19 */ "Texas Instruments 3D Stereo Enhancement",
208   /*  20 */ "VLSI Technology 3D Stereo Enhancement",
209   /*  21 */ "TriTech 3D Stereo Enhancement",
210   /*  22 */ "Realtek 3D Stereo Enhancement",
211   /*  23 */ "Samsung 3D Stereo Enhancement",
212   /*  24 */ "Wolfson Microelectronics 3D Enhancement",
213   /*  25 */ "Delta Integration 3D Enhancement",
214   /*  26 */ "SigmaTel 3D Enhancement",
215   /*  27 */ "IC Ensemble/KS Waves",
216   /*  28 */ "Rockwell 3D Stereo Enhancement",
217   /*  29 */ "Reserved 29",
218   /*  30 */ "Reserved 30",
219   /*  31 */ "Reserved 31"
220 };
221 
222 /*
223  * Shared AC97 controllers (ICH, ATIIXP...)
224  */
225 static DECLARE_MUTEX(shared_codec_mutex);
226 static ac97_t *shared_codec[AC97_SHARED_TYPES][4];
227 
228 
229 /*
230  *  I/O routines
231  */
232 
233 static int snd_ac97_valid_reg(ac97_t *ac97, unsigned short reg)
234 {
235 	if (ac97->limited_regs && ! test_bit(reg, ac97->reg_accessed))
236   		return 0;
237 
238 	/* filter some registers for buggy codecs */
239 	switch (ac97->id) {
240 	case AC97_ID_AK4540:
241 	case AC97_ID_AK4542:
242 		if (reg <= 0x1c || reg == 0x20 || reg == 0x26 || reg >= 0x7c)
243 			return 1;
244 		return 0;
245 	case AC97_ID_AD1819:	/* AD1819 */
246 	case AC97_ID_AD1881:	/* AD1881 */
247 	case AC97_ID_AD1881A:	/* AD1881A */
248 		if (reg >= 0x3a && reg <= 0x6e)	/* 0x59 */
249 			return 0;
250 		return 1;
251 	case AC97_ID_AD1885:	/* AD1885 */
252 	case AC97_ID_AD1886:	/* AD1886 */
253 	case AC97_ID_AD1886A:	/* AD1886A - !!verify!! --jk */
254 	case AC97_ID_AD1887:	/* AD1887 - !!verify!! --jk */
255 		if (reg == 0x5a)
256 			return 1;
257 		if (reg >= 0x3c && reg <= 0x6e)	/* 0x59 */
258 			return 0;
259 		return 1;
260 	case AC97_ID_STAC9700:
261 	case AC97_ID_STAC9704:
262 	case AC97_ID_STAC9705:
263 	case AC97_ID_STAC9708:
264 	case AC97_ID_STAC9721:
265 	case AC97_ID_STAC9744:
266 	case AC97_ID_STAC9756:
267 		if (reg <= 0x3a || reg >= 0x5a)
268 			return 1;
269 		return 0;
270 	}
271 	return 1;
272 }
273 
274 /**
275  * snd_ac97_write - write a value on the given register
276  * @ac97: the ac97 instance
277  * @reg: the register to change
278  * @value: the value to set
279  *
280  * Writes a value on the given register.  This will invoke the write
281  * callback directly after the register check.
282  * This function doesn't change the register cache unlike
283  * #snd_ca97_write_cache(), so use this only when you don't want to
284  * reflect the change to the suspend/resume state.
285  */
286 void snd_ac97_write(ac97_t *ac97, unsigned short reg, unsigned short value)
287 {
288 	if (!snd_ac97_valid_reg(ac97, reg))
289 		return;
290 	if ((ac97->id & 0xffffff00) == AC97_ID_ALC100) {
291 		/* Fix H/W bug of ALC100/100P */
292 		if (reg == AC97_MASTER || reg == AC97_HEADPHONE)
293 			ac97->bus->ops->write(ac97, AC97_RESET, 0);	/* reset audio codec */
294 	}
295 	ac97->bus->ops->write(ac97, reg, value);
296 }
297 
298 /**
299  * snd_ac97_read - read a value from the given register
300  *
301  * @ac97: the ac97 instance
302  * @reg: the register to read
303  *
304  * Reads a value from the given register.  This will invoke the read
305  * callback directly after the register check.
306  *
307  * Returns the read value.
308  */
309 unsigned short snd_ac97_read(ac97_t *ac97, unsigned short reg)
310 {
311 	if (!snd_ac97_valid_reg(ac97, reg))
312 		return 0;
313 	return ac97->bus->ops->read(ac97, reg);
314 }
315 
316 /* read a register - return the cached value if already read */
317 static inline unsigned short snd_ac97_read_cache(ac97_t *ac97, unsigned short reg)
318 {
319 	if (! test_bit(reg, ac97->reg_accessed)) {
320 		ac97->regs[reg] = ac97->bus->ops->read(ac97, reg);
321 		// set_bit(reg, ac97->reg_accessed);
322 	}
323 	return ac97->regs[reg];
324 }
325 
326 /**
327  * snd_ac97_write_cache - write a value on the given register and update the cache
328  * @ac97: the ac97 instance
329  * @reg: the register to change
330  * @value: the value to set
331  *
332  * Writes a value on the given register and updates the register
333  * cache.  The cached values are used for the cached-read and the
334  * suspend/resume.
335  */
336 void snd_ac97_write_cache(ac97_t *ac97, unsigned short reg, unsigned short value)
337 {
338 	if (!snd_ac97_valid_reg(ac97, reg))
339 		return;
340 	down(&ac97->reg_mutex);
341 	ac97->regs[reg] = value;
342 	ac97->bus->ops->write(ac97, reg, value);
343 	set_bit(reg, ac97->reg_accessed);
344 	up(&ac97->reg_mutex);
345 }
346 
347 /**
348  * snd_ac97_update - update the value on the given register
349  * @ac97: the ac97 instance
350  * @reg: the register to change
351  * @value: the value to set
352  *
353  * Compares the value with the register cache and updates the value
354  * only when the value is changed.
355  *
356  * Returns 1 if the value is changed, 0 if no change, or a negative
357  * code on failure.
358  */
359 int snd_ac97_update(ac97_t *ac97, unsigned short reg, unsigned short value)
360 {
361 	int change;
362 
363 	if (!snd_ac97_valid_reg(ac97, reg))
364 		return -EINVAL;
365 	down(&ac97->reg_mutex);
366 	change = ac97->regs[reg] != value;
367 	if (change) {
368 		ac97->regs[reg] = value;
369 		ac97->bus->ops->write(ac97, reg, value);
370 	}
371 	set_bit(reg, ac97->reg_accessed);
372 	up(&ac97->reg_mutex);
373 	return change;
374 }
375 
376 /**
377  * snd_ac97_update_bits - update the bits on the given register
378  * @ac97: the ac97 instance
379  * @reg: the register to change
380  * @mask: the bit-mask to change
381  * @value: the value to set
382  *
383  * Updates the masked-bits on the given register only when the value
384  * is changed.
385  *
386  * Returns 1 if the bits are changed, 0 if no change, or a negative
387  * code on failure.
388  */
389 int snd_ac97_update_bits(ac97_t *ac97, unsigned short reg, unsigned short mask, unsigned short value)
390 {
391 	int change;
392 
393 	if (!snd_ac97_valid_reg(ac97, reg))
394 		return -EINVAL;
395 	down(&ac97->reg_mutex);
396 	change = snd_ac97_update_bits_nolock(ac97, reg, mask, value);
397 	up(&ac97->reg_mutex);
398 	return change;
399 }
400 
401 /* no lock version - see snd_ac97_updat_bits() */
402 int snd_ac97_update_bits_nolock(ac97_t *ac97, unsigned short reg,
403 				unsigned short mask, unsigned short value)
404 {
405 	int change;
406 	unsigned short old, new;
407 
408 	old = snd_ac97_read_cache(ac97, reg);
409 	new = (old & ~mask) | value;
410 	change = old != new;
411 	if (change) {
412 		ac97->regs[reg] = new;
413 		ac97->bus->ops->write(ac97, reg, new);
414 	}
415 	set_bit(reg, ac97->reg_accessed);
416 	return change;
417 }
418 
419 static int snd_ac97_ad18xx_update_pcm_bits(ac97_t *ac97, int codec, unsigned short mask, unsigned short value)
420 {
421 	int change;
422 	unsigned short old, new, cfg;
423 
424 	down(&ac97->page_mutex);
425 	old = ac97->spec.ad18xx.pcmreg[codec];
426 	new = (old & ~mask) | value;
427 	change = old != new;
428 	if (change) {
429 		down(&ac97->reg_mutex);
430 		cfg = snd_ac97_read_cache(ac97, AC97_AD_SERIAL_CFG);
431 		ac97->spec.ad18xx.pcmreg[codec] = new;
432 		/* select single codec */
433 		ac97->bus->ops->write(ac97, AC97_AD_SERIAL_CFG,
434 				 (cfg & ~0x7000) |
435 				 ac97->spec.ad18xx.unchained[codec] | ac97->spec.ad18xx.chained[codec]);
436 		/* update PCM bits */
437 		ac97->bus->ops->write(ac97, AC97_PCM, new);
438 		/* select all codecs */
439 		ac97->bus->ops->write(ac97, AC97_AD_SERIAL_CFG,
440 				 cfg | 0x7000);
441 		up(&ac97->reg_mutex);
442 	}
443 	up(&ac97->page_mutex);
444 	return change;
445 }
446 
447 /*
448  * Controls
449  */
450 
451 int snd_ac97_info_enum_double(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
452 {
453 	struct ac97_enum *e = (struct ac97_enum *)kcontrol->private_value;
454 
455 	uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
456 	uinfo->count = e->shift_l == e->shift_r ? 1 : 2;
457 	uinfo->value.enumerated.items = e->mask;
458 
459 	if (uinfo->value.enumerated.item > e->mask - 1)
460 		uinfo->value.enumerated.item = e->mask - 1;
461 	strcpy(uinfo->value.enumerated.name, e->texts[uinfo->value.enumerated.item]);
462 	return 0;
463 }
464 
465 int snd_ac97_get_enum_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
466 {
467 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
468 	struct ac97_enum *e = (struct ac97_enum *)kcontrol->private_value;
469 	unsigned short val, bitmask;
470 
471 	for (bitmask = 1; bitmask < e->mask; bitmask <<= 1)
472 		;
473 	val = snd_ac97_read_cache(ac97, e->reg);
474 	ucontrol->value.enumerated.item[0] = (val >> e->shift_l) & (bitmask - 1);
475 	if (e->shift_l != e->shift_r)
476 		ucontrol->value.enumerated.item[1] = (val >> e->shift_r) & (bitmask - 1);
477 
478 	return 0;
479 }
480 
481 int snd_ac97_put_enum_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
482 {
483 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
484 	struct ac97_enum *e = (struct ac97_enum *)kcontrol->private_value;
485 	unsigned short val;
486 	unsigned short mask, bitmask;
487 
488 	for (bitmask = 1; bitmask < e->mask; bitmask <<= 1)
489 		;
490 	if (ucontrol->value.enumerated.item[0] > e->mask - 1)
491 		return -EINVAL;
492 	val = ucontrol->value.enumerated.item[0] << e->shift_l;
493 	mask = (bitmask - 1) << e->shift_l;
494 	if (e->shift_l != e->shift_r) {
495 		if (ucontrol->value.enumerated.item[1] > e->mask - 1)
496 			return -EINVAL;
497 		val |= ucontrol->value.enumerated.item[1] << e->shift_r;
498 		mask |= (bitmask - 1) << e->shift_r;
499 	}
500 	return snd_ac97_update_bits(ac97, e->reg, mask, val);
501 }
502 
503 /* save/restore ac97 v2.3 paging */
504 static int snd_ac97_page_save(ac97_t *ac97, int reg, snd_kcontrol_t *kcontrol)
505 {
506 	int page_save = -1;
507 	if ((kcontrol->private_value & (1<<25)) &&
508 	    (ac97->ext_id & AC97_EI_REV_MASK) >= AC97_EI_REV_23 &&
509 	    (reg >= 0x60 && reg < 0x70)) {
510 		unsigned short page = (kcontrol->private_value >> 26) & 0x0f;
511 		down(&ac97->page_mutex); /* lock paging */
512 		page_save = snd_ac97_read(ac97, AC97_INT_PAGING) & AC97_PAGE_MASK;
513 		snd_ac97_update_bits(ac97, AC97_INT_PAGING, AC97_PAGE_MASK, page);
514 	}
515 	return page_save;
516 }
517 
518 static void snd_ac97_page_restore(ac97_t *ac97, int page_save)
519 {
520 	if (page_save >= 0) {
521 		snd_ac97_update_bits(ac97, AC97_INT_PAGING, AC97_PAGE_MASK, page_save);
522 		up(&ac97->page_mutex); /* unlock paging */
523 	}
524 }
525 
526 /* volume and switch controls */
527 int snd_ac97_info_volsw(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
528 {
529 	int mask = (kcontrol->private_value >> 16) & 0xff;
530 	int shift = (kcontrol->private_value >> 8) & 0x0f;
531 	int rshift = (kcontrol->private_value >> 12) & 0x0f;
532 
533 	uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
534 	uinfo->count = shift == rshift ? 1 : 2;
535 	uinfo->value.integer.min = 0;
536 	uinfo->value.integer.max = mask;
537 	return 0;
538 }
539 
540 int snd_ac97_get_volsw(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
541 {
542 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
543 	int reg = kcontrol->private_value & 0xff;
544 	int shift = (kcontrol->private_value >> 8) & 0x0f;
545 	int rshift = (kcontrol->private_value >> 12) & 0x0f;
546 	int mask = (kcontrol->private_value >> 16) & 0xff;
547 	int invert = (kcontrol->private_value >> 24) & 0x01;
548 	int page_save;
549 
550 	page_save = snd_ac97_page_save(ac97, reg, kcontrol);
551 	ucontrol->value.integer.value[0] = (snd_ac97_read_cache(ac97, reg) >> shift) & mask;
552 	if (shift != rshift)
553 		ucontrol->value.integer.value[1] = (snd_ac97_read_cache(ac97, reg) >> rshift) & mask;
554 	if (invert) {
555 		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
556 		if (shift != rshift)
557 			ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
558 	}
559 	snd_ac97_page_restore(ac97, page_save);
560 	return 0;
561 }
562 
563 int snd_ac97_put_volsw(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
564 {
565 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
566 	int reg = kcontrol->private_value & 0xff;
567 	int shift = (kcontrol->private_value >> 8) & 0x0f;
568 	int rshift = (kcontrol->private_value >> 12) & 0x0f;
569 	int mask = (kcontrol->private_value >> 16) & 0xff;
570 	int invert = (kcontrol->private_value >> 24) & 0x01;
571 	int err, page_save;
572 	unsigned short val, val2, val_mask;
573 
574 	page_save = snd_ac97_page_save(ac97, reg, kcontrol);
575 	val = (ucontrol->value.integer.value[0] & mask);
576 	if (invert)
577 		val = mask - val;
578 	val_mask = mask << shift;
579 	val = val << shift;
580 	if (shift != rshift) {
581 		val2 = (ucontrol->value.integer.value[1] & mask);
582 		if (invert)
583 			val2 = mask - val2;
584 		val_mask |= mask << rshift;
585 		val |= val2 << rshift;
586 	}
587 	err = snd_ac97_update_bits(ac97, reg, val_mask, val);
588 	snd_ac97_page_restore(ac97, page_save);
589 	return err;
590 }
591 
592 static const snd_kcontrol_new_t snd_ac97_controls_master_mono[2] = {
593 AC97_SINGLE("Master Mono Playback Switch", AC97_MASTER_MONO, 15, 1, 1),
594 AC97_SINGLE("Master Mono Playback Volume", AC97_MASTER_MONO, 0, 31, 1)
595 };
596 
597 static const snd_kcontrol_new_t snd_ac97_controls_tone[2] = {
598 AC97_SINGLE("Tone Control - Bass", AC97_MASTER_TONE, 8, 15, 1),
599 AC97_SINGLE("Tone Control - Treble", AC97_MASTER_TONE, 0, 15, 1)
600 };
601 
602 static const snd_kcontrol_new_t snd_ac97_controls_pc_beep[2] = {
603 AC97_SINGLE("PC Speaker Playback Switch", AC97_PC_BEEP, 15, 1, 1),
604 AC97_SINGLE("PC Speaker Playback Volume", AC97_PC_BEEP, 1, 15, 1)
605 };
606 
607 static const snd_kcontrol_new_t snd_ac97_controls_mic_boost =
608 	AC97_SINGLE("Mic Boost (+20dB)", AC97_MIC, 6, 1, 0);
609 
610 
611 static const char* std_rec_sel[] = {"Mic", "CD", "Video", "Aux", "Line", "Mix", "Mix Mono", "Phone"};
612 static const char* std_3d_path[] = {"pre 3D", "post 3D"};
613 static const char* std_mix[] = {"Mix", "Mic"};
614 static const char* std_mic[] = {"Mic1", "Mic2"};
615 
616 static const struct ac97_enum std_enum[] = {
617 AC97_ENUM_DOUBLE(AC97_REC_SEL, 8, 0, 8, std_rec_sel),
618 AC97_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 15, 2, std_3d_path),
619 AC97_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 9, 2, std_mix),
620 AC97_ENUM_SINGLE(AC97_GENERAL_PURPOSE, 8, 2, std_mic),
621 };
622 
623 static const snd_kcontrol_new_t snd_ac97_control_capture_src =
624 AC97_ENUM("Capture Source", std_enum[0]);
625 
626 static const snd_kcontrol_new_t snd_ac97_control_capture_vol =
627 AC97_DOUBLE("Capture Volume", AC97_REC_GAIN, 8, 0, 15, 0);
628 
629 static const snd_kcontrol_new_t snd_ac97_controls_mic_capture[2] = {
630 AC97_SINGLE("Mic Capture Switch", AC97_REC_GAIN_MIC, 15, 1, 1),
631 AC97_SINGLE("Mic Capture Volume", AC97_REC_GAIN_MIC, 0, 15, 0)
632 };
633 
634 typedef enum {
635 	AC97_GENERAL_PCM_OUT = 0,
636 	AC97_GENERAL_STEREO_ENHANCEMENT,
637 	AC97_GENERAL_3D,
638 	AC97_GENERAL_LOUDNESS,
639 	AC97_GENERAL_MONO,
640 	AC97_GENERAL_MIC,
641 	AC97_GENERAL_LOOPBACK
642 } ac97_general_index_t;
643 
644 static const snd_kcontrol_new_t snd_ac97_controls_general[7] = {
645 AC97_ENUM("PCM Out Path & Mute", std_enum[1]),
646 AC97_SINGLE("Simulated Stereo Enhancement", AC97_GENERAL_PURPOSE, 14, 1, 0),
647 AC97_SINGLE("3D Control - Switch", AC97_GENERAL_PURPOSE, 13, 1, 0),
648 AC97_SINGLE("Loudness (bass boost)", AC97_GENERAL_PURPOSE, 12, 1, 0),
649 AC97_ENUM("Mono Output Select", std_enum[2]),
650 AC97_ENUM("Mic Select", std_enum[3]),
651 AC97_SINGLE("ADC/DAC Loopback", AC97_GENERAL_PURPOSE, 7, 1, 0)
652 };
653 
654 const snd_kcontrol_new_t snd_ac97_controls_3d[2] = {
655 AC97_SINGLE("3D Control - Center", AC97_3D_CONTROL, 8, 15, 0),
656 AC97_SINGLE("3D Control - Depth", AC97_3D_CONTROL, 0, 15, 0)
657 };
658 
659 static const snd_kcontrol_new_t snd_ac97_controls_center[2] = {
660 AC97_SINGLE("Center Playback Switch", AC97_CENTER_LFE_MASTER, 7, 1, 1),
661 AC97_SINGLE("Center Playback Volume", AC97_CENTER_LFE_MASTER, 0, 31, 1)
662 };
663 
664 static const snd_kcontrol_new_t snd_ac97_controls_lfe[2] = {
665 AC97_SINGLE("LFE Playback Switch", AC97_CENTER_LFE_MASTER, 15, 1, 1),
666 AC97_SINGLE("LFE Playback Volume", AC97_CENTER_LFE_MASTER, 8, 31, 1)
667 };
668 
669 static const snd_kcontrol_new_t snd_ac97_control_eapd =
670 AC97_SINGLE("External Amplifier", AC97_POWERDOWN, 15, 1, 1);
671 
672 static const snd_kcontrol_new_t snd_ac97_controls_modem_switches[2] = {
673 AC97_SINGLE("Off-hook Switch", AC97_GPIO_STATUS, 0, 1, 0),
674 AC97_SINGLE("Caller ID Switch", AC97_GPIO_STATUS, 2, 1, 0)
675 };
676 
677 /* change the existing EAPD control as inverted */
678 static void set_inv_eapd(ac97_t *ac97, snd_kcontrol_t *kctl)
679 {
680 	kctl->private_value = AC97_SINGLE_VALUE(AC97_POWERDOWN, 15, 1, 0);
681 	snd_ac97_update_bits(ac97, AC97_POWERDOWN, (1<<15), (1<<15)); /* EAPD up */
682 	ac97->scaps |= AC97_SCAP_INV_EAPD;
683 }
684 
685 static int snd_ac97_spdif_mask_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
686 {
687 	uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
688 	uinfo->count = 1;
689 	return 0;
690 }
691 
692 static int snd_ac97_spdif_cmask_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t * ucontrol)
693 {
694 	ucontrol->value.iec958.status[0] = IEC958_AES0_PROFESSIONAL |
695 					   IEC958_AES0_NONAUDIO |
696 					   IEC958_AES0_CON_EMPHASIS_5015 |
697 					   IEC958_AES0_CON_NOT_COPYRIGHT;
698 	ucontrol->value.iec958.status[1] = IEC958_AES1_CON_CATEGORY |
699 					   IEC958_AES1_CON_ORIGINAL;
700 	ucontrol->value.iec958.status[3] = IEC958_AES3_CON_FS;
701 	return 0;
702 }
703 
704 static int snd_ac97_spdif_pmask_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t * ucontrol)
705 {
706 	/* FIXME: AC'97 spec doesn't say which bits are used for what */
707 	ucontrol->value.iec958.status[0] = IEC958_AES0_PROFESSIONAL |
708 					   IEC958_AES0_NONAUDIO |
709 					   IEC958_AES0_PRO_FS |
710 					   IEC958_AES0_PRO_EMPHASIS_5015;
711 	return 0;
712 }
713 
714 static int snd_ac97_spdif_default_get(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t * ucontrol)
715 {
716 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
717 
718 	down(&ac97->reg_mutex);
719 	ucontrol->value.iec958.status[0] = ac97->spdif_status & 0xff;
720 	ucontrol->value.iec958.status[1] = (ac97->spdif_status >> 8) & 0xff;
721 	ucontrol->value.iec958.status[2] = (ac97->spdif_status >> 16) & 0xff;
722 	ucontrol->value.iec958.status[3] = (ac97->spdif_status >> 24) & 0xff;
723 	up(&ac97->reg_mutex);
724 	return 0;
725 }
726 
727 static int snd_ac97_spdif_default_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t * ucontrol)
728 {
729 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
730 	unsigned int new = 0;
731 	unsigned short val = 0;
732 	int change;
733 
734 	new = val = ucontrol->value.iec958.status[0] & (IEC958_AES0_PROFESSIONAL|IEC958_AES0_NONAUDIO);
735 	if (ucontrol->value.iec958.status[0] & IEC958_AES0_PROFESSIONAL) {
736 		new |= ucontrol->value.iec958.status[0] & (IEC958_AES0_PRO_FS|IEC958_AES0_PRO_EMPHASIS_5015);
737 		switch (new & IEC958_AES0_PRO_FS) {
738 		case IEC958_AES0_PRO_FS_44100: val |= 0<<12; break;
739 		case IEC958_AES0_PRO_FS_48000: val |= 2<<12; break;
740 		case IEC958_AES0_PRO_FS_32000: val |= 3<<12; break;
741 		default:		       val |= 1<<12; break;
742 		}
743 		if ((new & IEC958_AES0_PRO_EMPHASIS) == IEC958_AES0_PRO_EMPHASIS_5015)
744 			val |= 1<<3;
745 	} else {
746 		new |= ucontrol->value.iec958.status[0] & (IEC958_AES0_CON_EMPHASIS_5015|IEC958_AES0_CON_NOT_COPYRIGHT);
747 		new |= ((ucontrol->value.iec958.status[1] & (IEC958_AES1_CON_CATEGORY|IEC958_AES1_CON_ORIGINAL)) << 8);
748 		new |= ((ucontrol->value.iec958.status[3] & IEC958_AES3_CON_FS) << 24);
749 		if ((new & IEC958_AES0_CON_EMPHASIS) == IEC958_AES0_CON_EMPHASIS_5015)
750 			val |= 1<<3;
751 		if (!(new & IEC958_AES0_CON_NOT_COPYRIGHT))
752 			val |= 1<<2;
753 		val |= ((new >> 8) & 0xff) << 4;	// category + original
754 		switch ((new >> 24) & 0xff) {
755 		case IEC958_AES3_CON_FS_44100: val |= 0<<12; break;
756 		case IEC958_AES3_CON_FS_48000: val |= 2<<12; break;
757 		case IEC958_AES3_CON_FS_32000: val |= 3<<12; break;
758 		default:		       val |= 1<<12; break;
759 		}
760 	}
761 
762 	down(&ac97->reg_mutex);
763 	change = ac97->spdif_status != new;
764 	ac97->spdif_status = new;
765 
766 	if (ac97->flags & AC97_CS_SPDIF) {
767 		int x = (val >> 12) & 0x03;
768 		switch (x) {
769 		case 0: x = 1; break;  // 44.1
770 		case 2: x = 0; break;  // 48.0
771 		default: x = 0; break; // illegal.
772 		}
773 		change |= snd_ac97_update_bits_nolock(ac97, AC97_CSR_SPDIF, 0x3fff, ((val & 0xcfff) | (x << 12)));
774 	} else if (ac97->flags & AC97_CX_SPDIF) {
775 		int v;
776 		v = new & (IEC958_AES0_CON_EMPHASIS_5015|IEC958_AES0_CON_NOT_COPYRIGHT) ? 0 : AC97_CXR_COPYRGT;
777 		v |= new & IEC958_AES0_NONAUDIO ? AC97_CXR_SPDIF_AC3 : AC97_CXR_SPDIF_PCM;
778 		change |= snd_ac97_update_bits_nolock(ac97, AC97_CXR_AUDIO_MISC,
779 						      AC97_CXR_SPDIF_MASK | AC97_CXR_COPYRGT,
780 						      v);
781 	} else {
782 		unsigned short extst = snd_ac97_read_cache(ac97, AC97_EXTENDED_STATUS);
783 		snd_ac97_update_bits_nolock(ac97, AC97_EXTENDED_STATUS, AC97_EA_SPDIF, 0); /* turn off */
784 
785 		change |= snd_ac97_update_bits_nolock(ac97, AC97_SPDIF, 0x3fff, val);
786 		if (extst & AC97_EA_SPDIF) {
787 			snd_ac97_update_bits_nolock(ac97, AC97_EXTENDED_STATUS, AC97_EA_SPDIF, AC97_EA_SPDIF); /* turn on again */
788                 }
789 	}
790 	up(&ac97->reg_mutex);
791 
792 	return change;
793 }
794 
795 static int snd_ac97_put_spsa(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
796 {
797 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
798 	int reg = kcontrol->private_value & 0xff;
799 	int shift = (kcontrol->private_value >> 8) & 0xff;
800 	int mask = (kcontrol->private_value >> 16) & 0xff;
801 	// int invert = (kcontrol->private_value >> 24) & 0xff;
802 	unsigned short value, old, new;
803 	int change;
804 
805 	value = (ucontrol->value.integer.value[0] & mask);
806 
807 	down(&ac97->reg_mutex);
808 	mask <<= shift;
809 	value <<= shift;
810 	old = snd_ac97_read_cache(ac97, reg);
811 	new = (old & ~mask) | value;
812 	change = old != new;
813 
814 	if (change) {
815 		unsigned short extst = snd_ac97_read_cache(ac97, AC97_EXTENDED_STATUS);
816 		snd_ac97_update_bits_nolock(ac97, AC97_EXTENDED_STATUS, AC97_EA_SPDIF, 0); /* turn off */
817 		change = snd_ac97_update_bits_nolock(ac97, reg, mask, value);
818 		if (extst & AC97_EA_SPDIF)
819 			snd_ac97_update_bits_nolock(ac97, AC97_EXTENDED_STATUS, AC97_EA_SPDIF, AC97_EA_SPDIF); /* turn on again */
820 	}
821 	up(&ac97->reg_mutex);
822 	return change;
823 }
824 
825 const snd_kcontrol_new_t snd_ac97_controls_spdif[5] = {
826 	{
827 		.access = SNDRV_CTL_ELEM_ACCESS_READ,
828 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
829 		.name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,CON_MASK),
830 		.info = snd_ac97_spdif_mask_info,
831 		.get = snd_ac97_spdif_cmask_get,
832 	},
833 	{
834 		.access = SNDRV_CTL_ELEM_ACCESS_READ,
835 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
836 		.name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,PRO_MASK),
837 		.info = snd_ac97_spdif_mask_info,
838 		.get = snd_ac97_spdif_pmask_get,
839 	},
840 	{
841 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
842 		.name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,DEFAULT),
843 		.info = snd_ac97_spdif_mask_info,
844 		.get = snd_ac97_spdif_default_get,
845 		.put = snd_ac97_spdif_default_put,
846 	},
847 
848 	AC97_SINGLE(SNDRV_CTL_NAME_IEC958("",PLAYBACK,SWITCH),AC97_EXTENDED_STATUS, 2, 1, 0),
849 	{
850 		.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
851 		.name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,NONE) "AC97-SPSA",
852 		.info = snd_ac97_info_volsw,
853 		.get = snd_ac97_get_volsw,
854 		.put = snd_ac97_put_spsa,
855 		.private_value = AC97_SINGLE_VALUE(AC97_EXTENDED_STATUS, 4, 3, 0)
856 	},
857 };
858 
859 #define AD18XX_PCM_BITS(xname, codec, lshift, rshift, mask) \
860 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .info = snd_ac97_ad18xx_pcm_info_bits, \
861   .get = snd_ac97_ad18xx_pcm_get_bits, .put = snd_ac97_ad18xx_pcm_put_bits, \
862   .private_value = (codec) | ((lshift) << 8) | ((rshift) << 12) | ((mask) << 16) }
863 
864 static int snd_ac97_ad18xx_pcm_info_bits(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
865 {
866 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
867 	int mask = (kcontrol->private_value >> 16) & 0x0f;
868 	int lshift = (kcontrol->private_value >> 8) & 0x0f;
869 	int rshift = (kcontrol->private_value >> 12) & 0x0f;
870 
871 	uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
872 	if (lshift != rshift && (ac97->flags & AC97_STEREO_MUTES))
873 		uinfo->count = 2;
874 	else
875 		uinfo->count = 1;
876 	uinfo->value.integer.min = 0;
877 	uinfo->value.integer.max = mask;
878 	return 0;
879 }
880 
881 static int snd_ac97_ad18xx_pcm_get_bits(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
882 {
883 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
884 	int codec = kcontrol->private_value & 3;
885 	int lshift = (kcontrol->private_value >> 8) & 0x0f;
886 	int rshift = (kcontrol->private_value >> 12) & 0x0f;
887 	int mask = (kcontrol->private_value >> 16) & 0xff;
888 
889 	ucontrol->value.integer.value[0] = mask - ((ac97->spec.ad18xx.pcmreg[codec] >> lshift) & mask);
890 	if (lshift != rshift && (ac97->flags & AC97_STEREO_MUTES))
891 		ucontrol->value.integer.value[1] = mask - ((ac97->spec.ad18xx.pcmreg[codec] >> rshift) & mask);
892 	return 0;
893 }
894 
895 static int snd_ac97_ad18xx_pcm_put_bits(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
896 {
897 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
898 	int codec = kcontrol->private_value & 3;
899 	int lshift = (kcontrol->private_value >> 8) & 0x0f;
900 	int rshift = (kcontrol->private_value >> 12) & 0x0f;
901 	int mask = (kcontrol->private_value >> 16) & 0xff;
902 	unsigned short val, valmask;
903 
904 	val = (mask - (ucontrol->value.integer.value[0] & mask)) << lshift;
905 	valmask = mask << lshift;
906 	if (lshift != rshift && (ac97->flags & AC97_STEREO_MUTES)) {
907 		val |= (mask - (ucontrol->value.integer.value[1] & mask)) << rshift;
908 		valmask |= mask << rshift;
909 	}
910 	return snd_ac97_ad18xx_update_pcm_bits(ac97, codec, valmask, val);
911 }
912 
913 #define AD18XX_PCM_VOLUME(xname, codec) \
914 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .info = snd_ac97_ad18xx_pcm_info_volume, \
915   .get = snd_ac97_ad18xx_pcm_get_volume, .put = snd_ac97_ad18xx_pcm_put_volume, \
916   .private_value = codec }
917 
918 static int snd_ac97_ad18xx_pcm_info_volume(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
919 {
920 	uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
921 	uinfo->count = 2;
922 	uinfo->value.integer.min = 0;
923 	uinfo->value.integer.max = 31;
924 	return 0;
925 }
926 
927 static int snd_ac97_ad18xx_pcm_get_volume(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
928 {
929 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
930 	int codec = kcontrol->private_value & 3;
931 
932 	down(&ac97->page_mutex);
933 	ucontrol->value.integer.value[0] = 31 - ((ac97->spec.ad18xx.pcmreg[codec] >> 0) & 31);
934 	ucontrol->value.integer.value[1] = 31 - ((ac97->spec.ad18xx.pcmreg[codec] >> 8) & 31);
935 	up(&ac97->page_mutex);
936 	return 0;
937 }
938 
939 static int snd_ac97_ad18xx_pcm_put_volume(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
940 {
941 	ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
942 	int codec = kcontrol->private_value & 3;
943 	unsigned short val1, val2;
944 
945 	val1 = 31 - (ucontrol->value.integer.value[0] & 31);
946 	val2 = 31 - (ucontrol->value.integer.value[1] & 31);
947 	return snd_ac97_ad18xx_update_pcm_bits(ac97, codec, 0x1f1f, (val1 << 8) | val2);
948 }
949 
950 static const snd_kcontrol_new_t snd_ac97_controls_ad18xx_pcm[2] = {
951 AD18XX_PCM_BITS("PCM Playback Switch", 0, 15, 7, 1),
952 AD18XX_PCM_VOLUME("PCM Playback Volume", 0)
953 };
954 
955 static const snd_kcontrol_new_t snd_ac97_controls_ad18xx_surround[2] = {
956 AD18XX_PCM_BITS("Surround Playback Switch", 1, 15, 7, 1),
957 AD18XX_PCM_VOLUME("Surround Playback Volume", 1)
958 };
959 
960 static const snd_kcontrol_new_t snd_ac97_controls_ad18xx_center[2] = {
961 AD18XX_PCM_BITS("Center Playback Switch", 2, 15, 15, 1),
962 AD18XX_PCM_BITS("Center Playback Volume", 2, 8, 8, 31)
963 };
964 
965 static const snd_kcontrol_new_t snd_ac97_controls_ad18xx_lfe[2] = {
966 AD18XX_PCM_BITS("LFE Playback Switch", 2, 7, 7, 1),
967 AD18XX_PCM_BITS("LFE Playback Volume", 2, 0, 0, 31)
968 };
969 
970 /*
971  *
972  */
973 
974 static void snd_ac97_powerdown(ac97_t *ac97);
975 
976 static int snd_ac97_bus_free(ac97_bus_t *bus)
977 {
978 	if (bus) {
979 		snd_ac97_bus_proc_done(bus);
980 		kfree(bus->pcms);
981 		if (bus->private_free)
982 			bus->private_free(bus);
983 		kfree(bus);
984 	}
985 	return 0;
986 }
987 
988 static int snd_ac97_bus_dev_free(snd_device_t *device)
989 {
990 	ac97_bus_t *bus = device->device_data;
991 	return snd_ac97_bus_free(bus);
992 }
993 
994 static int snd_ac97_free(ac97_t *ac97)
995 {
996 	if (ac97) {
997 		snd_ac97_proc_done(ac97);
998 		if (ac97->bus) {
999 			ac97->bus->codec[ac97->num] = NULL;
1000 			if (ac97->bus->shared_type) {
1001 				down(&shared_codec_mutex);
1002 				shared_codec[ac97->bus->shared_type-1][ac97->num] = NULL;
1003 				up(&shared_codec_mutex);
1004 			}
1005 		}
1006 		if (ac97->private_free)
1007 			ac97->private_free(ac97);
1008 		kfree(ac97);
1009 	}
1010 	return 0;
1011 }
1012 
1013 static int snd_ac97_dev_free(snd_device_t *device)
1014 {
1015 	ac97_t *ac97 = device->device_data;
1016 	snd_ac97_powerdown(ac97); /* for avoiding click noises during shut down */
1017 	return snd_ac97_free(ac97);
1018 }
1019 
1020 static int snd_ac97_try_volume_mix(ac97_t * ac97, int reg)
1021 {
1022 	unsigned short val, mask = 0x8000;
1023 
1024 	if (! snd_ac97_valid_reg(ac97, reg))
1025 		return 0;
1026 
1027 	switch (reg) {
1028 	case AC97_MASTER_TONE:
1029 		return ac97->caps & 0x04 ? 1 : 0;
1030 	case AC97_HEADPHONE:
1031 		return ac97->caps & 0x10 ? 1 : 0;
1032 	case AC97_REC_GAIN_MIC:
1033 		return ac97->caps & 0x01 ? 1 : 0;
1034 	case AC97_3D_CONTROL:
1035 		if (ac97->caps & 0x7c00) {
1036 			val = snd_ac97_read(ac97, reg);
1037 			/* if nonzero - fixed and we can't set it */
1038 			return val == 0;
1039 		}
1040 		return 0;
1041 	case AC97_CENTER_LFE_MASTER:	/* center */
1042 		if ((ac97->ext_id & AC97_EI_CDAC) == 0)
1043 			return 0;
1044 		break;
1045 	case AC97_CENTER_LFE_MASTER+1:	/* lfe */
1046 		if ((ac97->ext_id & AC97_EI_LDAC) == 0)
1047 			return 0;
1048 		reg = AC97_CENTER_LFE_MASTER;
1049 		mask = 0x0080;
1050 		break;
1051 	case AC97_SURROUND_MASTER:
1052 		if ((ac97->ext_id & AC97_EI_SDAC) == 0)
1053 			return 0;
1054 		break;
1055 	}
1056 
1057 	if (ac97->limited_regs && test_bit(reg, ac97->reg_accessed))
1058 		return 1; /* allow without check */
1059 
1060 	val = snd_ac97_read(ac97, reg);
1061 	if (!(val & mask)) {
1062 		/* nothing seems to be here - mute flag is not set */
1063 		/* try another test */
1064 		snd_ac97_write_cache(ac97, reg, val | mask);
1065 		val = snd_ac97_read(ac97, reg);
1066 		if (!(val & mask))
1067 			return 0;	/* nothing here */
1068 	}
1069 	return 1;		/* success, useable */
1070 }
1071 
1072 static void check_volume_resolution(ac97_t *ac97, int reg, unsigned char *lo_max, unsigned char *hi_max)
1073 {
1074 	unsigned short cbit[3] = { 0x20, 0x10, 0x01 };
1075 	unsigned char max[3] = { 63, 31, 15 };
1076 	int i;
1077 
1078 	*lo_max = *hi_max = 0;
1079 	for (i = 0 ; i < ARRAY_SIZE(cbit); i++) {
1080 		unsigned short val;
1081 		snd_ac97_write(ac97, reg, 0x8080 | cbit[i] | (cbit[i] << 8));
1082 		/* Do the read twice due to buffers on some ac97 codecs.
1083 		 * e.g. The STAC9704 returns exactly what you wrote the the register
1084 		 * if you read it immediately. This causes the detect routine to fail.
1085 		 */
1086 		val = snd_ac97_read(ac97, reg);
1087 		val = snd_ac97_read(ac97, reg);
1088 		if (! *lo_max && (val & 0x7f) == cbit[i])
1089 			*lo_max = max[i];
1090 		if (! *hi_max && ((val >> 8) & 0x7f) == cbit[i])
1091 			*hi_max = max[i];
1092 		if (*lo_max && *hi_max)
1093 			break;
1094 	}
1095 }
1096 
1097 int snd_ac97_try_bit(ac97_t * ac97, int reg, int bit)
1098 {
1099 	unsigned short mask, val, orig, res;
1100 
1101 	mask = 1 << bit;
1102 	orig = snd_ac97_read(ac97, reg);
1103 	val = orig ^ mask;
1104 	snd_ac97_write(ac97, reg, val);
1105 	res = snd_ac97_read(ac97, reg);
1106 	snd_ac97_write_cache(ac97, reg, orig);
1107 	return res == val;
1108 }
1109 
1110 /* check the volume resolution of center/lfe */
1111 static void snd_ac97_change_volume_params2(ac97_t * ac97, int reg, int shift, unsigned char *max)
1112 {
1113 	unsigned short val, val1;
1114 
1115 	*max = 63;
1116 	val = 0x8080 | (0x20 << shift);
1117 	snd_ac97_write(ac97, reg, val);
1118 	val1 = snd_ac97_read(ac97, reg);
1119 	if (val != val1) {
1120 		*max = 31;
1121 	}
1122 	/* reset volume to zero */
1123 	snd_ac97_write_cache(ac97, reg, 0x8080);
1124 }
1125 
1126 static inline int printable(unsigned int x)
1127 {
1128 	x &= 0xff;
1129 	if (x < ' ' || x >= 0x71) {
1130 		if (x <= 0x89)
1131 			return x - 0x71 + 'A';
1132 		return '?';
1133 	}
1134 	return x;
1135 }
1136 
1137 snd_kcontrol_t *snd_ac97_cnew(const snd_kcontrol_new_t *_template, ac97_t * ac97)
1138 {
1139 	snd_kcontrol_new_t template;
1140 	memcpy(&template, _template, sizeof(template));
1141 	snd_runtime_check(!template.index, return NULL);
1142 	template.index = ac97->num;
1143 	return snd_ctl_new1(&template, ac97);
1144 }
1145 
1146 /*
1147  * create mute switch(es) for normal stereo controls
1148  */
1149 static int snd_ac97_cmute_new_stereo(snd_card_t *card, char *name, int reg, int check_stereo, ac97_t *ac97)
1150 {
1151 	snd_kcontrol_t *kctl;
1152 	int err;
1153 	unsigned short val, val1, mute_mask;
1154 
1155 	if (! snd_ac97_valid_reg(ac97, reg))
1156 		return 0;
1157 
1158 	mute_mask = 0x8000;
1159 	val = snd_ac97_read(ac97, reg);
1160 	if (check_stereo || (ac97->flags & AC97_STEREO_MUTES)) {
1161 		/* check whether both mute bits work */
1162 		val1 = val | 0x8080;
1163 		snd_ac97_write(ac97, reg, val1);
1164 		if (val1 == snd_ac97_read(ac97, reg))
1165 			mute_mask = 0x8080;
1166 	}
1167 	if (mute_mask == 0x8080) {
1168 		snd_kcontrol_new_t tmp = AC97_DOUBLE(name, reg, 15, 7, 1, 1);
1169 		tmp.index = ac97->num;
1170 		kctl = snd_ctl_new1(&tmp, ac97);
1171 	} else {
1172 		snd_kcontrol_new_t tmp = AC97_SINGLE(name, reg, 15, 1, 1);
1173 		tmp.index = ac97->num;
1174 		kctl = snd_ctl_new1(&tmp, ac97);
1175 	}
1176 	err = snd_ctl_add(card, kctl);
1177 	if (err < 0)
1178 		return err;
1179 	/* mute as default */
1180 	snd_ac97_write_cache(ac97, reg, val | mute_mask);
1181 	return 0;
1182 }
1183 
1184 /*
1185  * create a volume for normal stereo/mono controls
1186  */
1187 static int snd_ac97_cvol_new(snd_card_t *card, char *name, int reg, unsigned int lo_max,
1188 			     unsigned int hi_max, ac97_t *ac97)
1189 {
1190 	int err;
1191 	snd_kcontrol_t *kctl;
1192 
1193 	if (! snd_ac97_valid_reg(ac97, reg))
1194 		return 0;
1195 	if (hi_max) {
1196 		/* invert */
1197 		snd_kcontrol_new_t tmp = AC97_DOUBLE(name, reg, 8, 0, lo_max, 1);
1198 		tmp.index = ac97->num;
1199 		kctl = snd_ctl_new1(&tmp, ac97);
1200 	} else {
1201 		/* invert */
1202 		snd_kcontrol_new_t tmp = AC97_SINGLE(name, reg, 0, lo_max, 1);
1203 		tmp.index = ac97->num;
1204 		kctl = snd_ctl_new1(&tmp, ac97);
1205 	}
1206 	err = snd_ctl_add(card, kctl);
1207 	if (err < 0)
1208 		return err;
1209 	snd_ac97_write_cache(ac97, reg,
1210 			     (snd_ac97_read(ac97, reg) & 0x8080) |
1211 			     lo_max | (hi_max << 8));
1212 	return 0;
1213 }
1214 
1215 /*
1216  * create a mute-switch and a volume for normal stereo/mono controls
1217  */
1218 static int snd_ac97_cmix_new_stereo(snd_card_t *card, const char *pfx, int reg, int check_stereo, ac97_t *ac97)
1219 {
1220 	int err;
1221 	char name[44];
1222 	unsigned char lo_max, hi_max;
1223 
1224 	if (! snd_ac97_valid_reg(ac97, reg))
1225 		return 0;
1226 
1227 	if (snd_ac97_try_bit(ac97, reg, 15)) {
1228 		sprintf(name, "%s Switch", pfx);
1229 		if ((err = snd_ac97_cmute_new_stereo(card, name, reg, check_stereo, ac97)) < 0)
1230 			return err;
1231 	}
1232 	check_volume_resolution(ac97, reg, &lo_max, &hi_max);
1233 	if (lo_max) {
1234 		sprintf(name, "%s Volume", pfx);
1235 		if ((err = snd_ac97_cvol_new(card, name, reg, lo_max, hi_max, ac97)) < 0)
1236 			return err;
1237 	}
1238 	return 0;
1239 }
1240 
1241 #define snd_ac97_cmix_new(card, pfx, reg, ac97)	snd_ac97_cmix_new_stereo(card, pfx, reg, 0, ac97)
1242 #define snd_ac97_cmute_new(card, name, reg, ac97)	snd_ac97_cmute_new_stereo(card, name, reg, 0, ac97)
1243 
1244 static unsigned int snd_ac97_determine_spdif_rates(ac97_t *ac97);
1245 
1246 static int snd_ac97_mixer_build(ac97_t * ac97)
1247 {
1248 	snd_card_t *card = ac97->bus->card;
1249 	snd_kcontrol_t *kctl;
1250 	int err;
1251 	unsigned int idx;
1252 	unsigned char max;
1253 
1254 	/* build master controls */
1255 	/* AD claims to remove this control from AD1887, although spec v2.2 does not allow this */
1256 	if (snd_ac97_try_volume_mix(ac97, AC97_MASTER)) {
1257 		if (ac97->flags & AC97_HAS_NO_MASTER_VOL)
1258 			err = snd_ac97_cmute_new(card, "Master Playback Switch", AC97_MASTER, ac97);
1259 		else
1260 			err = snd_ac97_cmix_new(card, "Master Playback", AC97_MASTER, ac97);
1261 		if (err < 0)
1262 			return err;
1263 	}
1264 
1265 	ac97->regs[AC97_CENTER_LFE_MASTER] = 0x8080;
1266 
1267 	/* build center controls */
1268 	if (snd_ac97_try_volume_mix(ac97, AC97_CENTER_LFE_MASTER)) {
1269 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_center[0], ac97))) < 0)
1270 			return err;
1271 		if ((err = snd_ctl_add(card, kctl = snd_ac97_cnew(&snd_ac97_controls_center[1], ac97))) < 0)
1272 			return err;
1273 		snd_ac97_change_volume_params2(ac97, AC97_CENTER_LFE_MASTER, 0, &max);
1274 		kctl->private_value &= ~(0xff << 16);
1275 		kctl->private_value |= (int)max << 16;
1276 		snd_ac97_write_cache(ac97, AC97_CENTER_LFE_MASTER, ac97->regs[AC97_CENTER_LFE_MASTER] | max);
1277 	}
1278 
1279 	/* build LFE controls */
1280 	if (snd_ac97_try_volume_mix(ac97, AC97_CENTER_LFE_MASTER+1)) {
1281 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_lfe[0], ac97))) < 0)
1282 			return err;
1283 		if ((err = snd_ctl_add(card, kctl = snd_ac97_cnew(&snd_ac97_controls_lfe[1], ac97))) < 0)
1284 			return err;
1285 		snd_ac97_change_volume_params2(ac97, AC97_CENTER_LFE_MASTER, 8, &max);
1286 		kctl->private_value &= ~(0xff << 16);
1287 		kctl->private_value |= (int)max << 16;
1288 		snd_ac97_write_cache(ac97, AC97_CENTER_LFE_MASTER, ac97->regs[AC97_CENTER_LFE_MASTER] | max << 8);
1289 	}
1290 
1291 	/* build surround controls */
1292 	if (snd_ac97_try_volume_mix(ac97, AC97_SURROUND_MASTER)) {
1293 		/* Surround Master (0x38) is with stereo mutes */
1294 		if ((err = snd_ac97_cmix_new_stereo(card, "Surround Playback", AC97_SURROUND_MASTER, 1, ac97)) < 0)
1295 			return err;
1296 	}
1297 
1298 	/* build headphone controls */
1299 	if (snd_ac97_try_volume_mix(ac97, AC97_HEADPHONE)) {
1300 		if ((err = snd_ac97_cmix_new(card, "Headphone Playback", AC97_HEADPHONE, ac97)) < 0)
1301 			return err;
1302 	}
1303 
1304 	/* build master mono controls */
1305 	if (snd_ac97_try_volume_mix(ac97, AC97_MASTER_MONO)) {
1306 		if ((err = snd_ac97_cmix_new(card, "Master Mono Playback", AC97_MASTER_MONO, ac97)) < 0)
1307 			return err;
1308 	}
1309 
1310 	/* build master tone controls */
1311 	if (!(ac97->flags & AC97_HAS_NO_TONE)) {
1312 		if (snd_ac97_try_volume_mix(ac97, AC97_MASTER_TONE)) {
1313 			for (idx = 0; idx < 2; idx++) {
1314 				if ((err = snd_ctl_add(card, kctl = snd_ac97_cnew(&snd_ac97_controls_tone[idx], ac97))) < 0)
1315 					return err;
1316 				if (ac97->id == AC97_ID_YMF753) {
1317 					kctl->private_value &= ~(0xff << 16);
1318 					kctl->private_value |= 7 << 16;
1319 				}
1320 			}
1321 			snd_ac97_write_cache(ac97, AC97_MASTER_TONE, 0x0f0f);
1322 		}
1323 	}
1324 
1325 	/* build PC Speaker controls */
1326 	if (!(ac97->flags & AC97_HAS_NO_PC_BEEP) &&
1327 		((ac97->flags & AC97_HAS_PC_BEEP) ||
1328 	    snd_ac97_try_volume_mix(ac97, AC97_PC_BEEP))) {
1329 		for (idx = 0; idx < 2; idx++)
1330 			if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_pc_beep[idx], ac97))) < 0)
1331 				return err;
1332 		snd_ac97_write_cache(ac97, AC97_PC_BEEP,
1333 				     snd_ac97_read(ac97, AC97_PC_BEEP) | 0x801e);
1334 	}
1335 
1336 	/* build Phone controls */
1337 	if (!(ac97->flags & AC97_HAS_NO_PHONE)) {
1338 		if (snd_ac97_try_volume_mix(ac97, AC97_PHONE)) {
1339 			if ((err = snd_ac97_cmix_new(card, "Phone Playback", AC97_PHONE, ac97)) < 0)
1340 				return err;
1341 		}
1342 	}
1343 
1344 	/* build MIC controls */
1345 	if (!(ac97->flags & AC97_HAS_NO_MIC)) {
1346 		if (snd_ac97_try_volume_mix(ac97, AC97_MIC)) {
1347 			if ((err = snd_ac97_cmix_new(card, "Mic Playback", AC97_MIC, ac97)) < 0)
1348 				return err;
1349 			if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_mic_boost, ac97))) < 0)
1350 				return err;
1351 		}
1352 	}
1353 
1354 	/* build Line controls */
1355 	if (snd_ac97_try_volume_mix(ac97, AC97_LINE)) {
1356 		if ((err = snd_ac97_cmix_new(card, "Line Playback", AC97_LINE, ac97)) < 0)
1357 			return err;
1358 	}
1359 
1360 	/* build CD controls */
1361 	if (!(ac97->flags & AC97_HAS_NO_CD)) {
1362 		if (snd_ac97_try_volume_mix(ac97, AC97_CD)) {
1363 			if ((err = snd_ac97_cmix_new(card, "CD Playback", AC97_CD, ac97)) < 0)
1364 				return err;
1365 		}
1366 	}
1367 
1368 	/* build Video controls */
1369 	if (!(ac97->flags & AC97_HAS_NO_VIDEO)) {
1370 		if (snd_ac97_try_volume_mix(ac97, AC97_VIDEO)) {
1371 			if ((err = snd_ac97_cmix_new(card, "Video Playback", AC97_VIDEO, ac97)) < 0)
1372 				return err;
1373 		}
1374 	}
1375 
1376 	/* build Aux controls */
1377 	if (snd_ac97_try_volume_mix(ac97, AC97_AUX)) {
1378 		if ((err = snd_ac97_cmix_new(card, "Aux Playback", AC97_AUX, ac97)) < 0)
1379 			return err;
1380 	}
1381 
1382 	/* build PCM controls */
1383 	if (ac97->flags & AC97_AD_MULTI) {
1384 		unsigned short init_val;
1385 		if (ac97->flags & AC97_STEREO_MUTES)
1386 			init_val = 0x9f9f;
1387 		else
1388 			init_val = 0x9f1f;
1389 		for (idx = 0; idx < 2; idx++)
1390 			if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_ad18xx_pcm[idx], ac97))) < 0)
1391 				return err;
1392 		ac97->spec.ad18xx.pcmreg[0] = init_val;
1393 		if (ac97->scaps & AC97_SCAP_SURROUND_DAC) {
1394 			for (idx = 0; idx < 2; idx++)
1395 				if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_ad18xx_surround[idx], ac97))) < 0)
1396 					return err;
1397 			ac97->spec.ad18xx.pcmreg[1] = init_val;
1398 		}
1399 		if (ac97->scaps & AC97_SCAP_CENTER_LFE_DAC) {
1400 			for (idx = 0; idx < 2; idx++)
1401 				if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_ad18xx_center[idx], ac97))) < 0)
1402 					return err;
1403 			for (idx = 0; idx < 2; idx++)
1404 				if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_ad18xx_lfe[idx], ac97))) < 0)
1405 					return err;
1406 			ac97->spec.ad18xx.pcmreg[2] = init_val;
1407 		}
1408 		snd_ac97_write_cache(ac97, AC97_PCM, init_val);
1409 	} else {
1410 		if (!(ac97->flags & AC97_HAS_NO_STD_PCM)) {
1411 			if (ac97->flags & AC97_HAS_NO_PCM_VOL)
1412 				err = snd_ac97_cmute_new(card, "PCM Playback Switch", AC97_PCM, ac97);
1413 			else
1414 				err = snd_ac97_cmix_new(card, "PCM Playback", AC97_PCM, ac97);
1415 			if (err < 0)
1416 				return err;
1417 		}
1418 	}
1419 
1420 	/* build Capture controls */
1421 	if (!(ac97->flags & AC97_HAS_NO_REC_GAIN)) {
1422 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_control_capture_src, ac97))) < 0)
1423 			return err;
1424 		if (snd_ac97_try_bit(ac97, AC97_REC_GAIN, 15)) {
1425 			if ((err = snd_ac97_cmute_new(card, "Capture Switch", AC97_REC_GAIN, ac97)) < 0)
1426 				return err;
1427 		}
1428 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_control_capture_vol, ac97))) < 0)
1429 			return err;
1430 		snd_ac97_write_cache(ac97, AC97_REC_SEL, 0x0000);
1431 		snd_ac97_write_cache(ac97, AC97_REC_GAIN, 0x0000);
1432 	}
1433 	/* build MIC Capture controls */
1434 	if (snd_ac97_try_volume_mix(ac97, AC97_REC_GAIN_MIC)) {
1435 		for (idx = 0; idx < 2; idx++)
1436 			if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_mic_capture[idx], ac97))) < 0)
1437 				return err;
1438 		snd_ac97_write_cache(ac97, AC97_REC_GAIN_MIC, 0x0000);
1439 	}
1440 
1441 	/* build PCM out path & mute control */
1442 	if (snd_ac97_try_bit(ac97, AC97_GENERAL_PURPOSE, 15)) {
1443 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_PCM_OUT], ac97))) < 0)
1444 			return err;
1445 	}
1446 
1447 	/* build Simulated Stereo Enhancement control */
1448 	if (ac97->caps & 0x0008) {
1449 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_STEREO_ENHANCEMENT], ac97))) < 0)
1450 			return err;
1451 	}
1452 
1453 	/* build 3D Stereo Enhancement control */
1454 	if (snd_ac97_try_bit(ac97, AC97_GENERAL_PURPOSE, 13)) {
1455 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_3D], ac97))) < 0)
1456 			return err;
1457 	}
1458 
1459 	/* build Loudness control */
1460 	if (ac97->caps & 0x0020) {
1461 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_LOUDNESS], ac97))) < 0)
1462 			return err;
1463 	}
1464 
1465 	/* build Mono output select control */
1466 	if (snd_ac97_try_bit(ac97, AC97_GENERAL_PURPOSE, 9)) {
1467 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_MONO], ac97))) < 0)
1468 			return err;
1469 	}
1470 
1471 	/* build Mic select control */
1472 	if (snd_ac97_try_bit(ac97, AC97_GENERAL_PURPOSE, 8)) {
1473 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_MIC], ac97))) < 0)
1474 			return err;
1475 	}
1476 
1477 	/* build ADC/DAC loopback control */
1478 	if (enable_loopback && snd_ac97_try_bit(ac97, AC97_GENERAL_PURPOSE, 7)) {
1479 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_general[AC97_GENERAL_LOOPBACK], ac97))) < 0)
1480 			return err;
1481 	}
1482 
1483 	snd_ac97_update_bits(ac97, AC97_GENERAL_PURPOSE, ~AC97_GP_DRSS_MASK, 0x0000);
1484 
1485 	/* build 3D controls */
1486 	if (ac97->build_ops->build_3d) {
1487 		ac97->build_ops->build_3d(ac97);
1488 	} else {
1489 		if (snd_ac97_try_volume_mix(ac97, AC97_3D_CONTROL)) {
1490 			unsigned short val;
1491 			val = 0x0707;
1492 			snd_ac97_write(ac97, AC97_3D_CONTROL, val);
1493 			val = snd_ac97_read(ac97, AC97_3D_CONTROL);
1494 			val = val == 0x0606;
1495 			if ((err = snd_ctl_add(card, kctl = snd_ac97_cnew(&snd_ac97_controls_3d[0], ac97))) < 0)
1496 				return err;
1497 			if (val)
1498 				kctl->private_value = AC97_3D_CONTROL | (9 << 8) | (7 << 16);
1499 			if ((err = snd_ctl_add(card, kctl = snd_ac97_cnew(&snd_ac97_controls_3d[1], ac97))) < 0)
1500 				return err;
1501 			if (val)
1502 				kctl->private_value = AC97_3D_CONTROL | (1 << 8) | (7 << 16);
1503 			snd_ac97_write_cache(ac97, AC97_3D_CONTROL, 0x0000);
1504 		}
1505 	}
1506 
1507 	/* build S/PDIF controls */
1508 	if ((ac97->ext_id & AC97_EI_SPDIF) && !(ac97->scaps & AC97_SCAP_NO_SPDIF)) {
1509 		if (ac97->build_ops->build_spdif) {
1510 			if ((err = ac97->build_ops->build_spdif(ac97)) < 0)
1511 				return err;
1512 		} else {
1513 			for (idx = 0; idx < 5; idx++)
1514 				if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_spdif[idx], ac97))) < 0)
1515 					return err;
1516 			if (ac97->build_ops->build_post_spdif) {
1517 				if ((err = ac97->build_ops->build_post_spdif(ac97)) < 0)
1518 					return err;
1519 			}
1520 			/* set default PCM S/PDIF params */
1521 			/* consumer,PCM audio,no copyright,no preemphasis,PCM coder,original,48000Hz */
1522 			snd_ac97_write_cache(ac97, AC97_SPDIF, 0x2a20);
1523 			ac97->rates[AC97_RATES_SPDIF] = snd_ac97_determine_spdif_rates(ac97);
1524 		}
1525 		ac97->spdif_status = SNDRV_PCM_DEFAULT_CON_SPDIF;
1526 	}
1527 
1528 	/* build chip specific controls */
1529 	if (ac97->build_ops->build_specific)
1530 		if ((err = ac97->build_ops->build_specific(ac97)) < 0)
1531 			return err;
1532 
1533 	if (snd_ac97_try_bit(ac97, AC97_POWERDOWN, 15)) {
1534 		kctl = snd_ac97_cnew(&snd_ac97_control_eapd, ac97);
1535 		if (! kctl)
1536 			return -ENOMEM;
1537 		if (ac97->scaps & AC97_SCAP_INV_EAPD)
1538 			set_inv_eapd(ac97, kctl);
1539 		if ((err = snd_ctl_add(card, kctl)) < 0)
1540 			return err;
1541 	}
1542 
1543 	return 0;
1544 }
1545 
1546 static int snd_ac97_modem_build(snd_card_t * card, ac97_t * ac97)
1547 {
1548 	int err, idx;
1549 
1550 	//printk("AC97_GPIO_CFG = %x\n",snd_ac97_read(ac97,AC97_GPIO_CFG));
1551 	snd_ac97_write(ac97, AC97_GPIO_CFG, 0xffff & ~(AC97_GPIO_LINE1_OH));
1552 	snd_ac97_write(ac97, AC97_GPIO_POLARITY, 0xffff & ~(AC97_GPIO_LINE1_OH));
1553 	snd_ac97_write(ac97, AC97_GPIO_STICKY, 0xffff);
1554 	snd_ac97_write(ac97, AC97_GPIO_WAKEUP, 0x0);
1555 	snd_ac97_write(ac97, AC97_MISC_AFE, 0x0);
1556 
1557 	/* build modem switches */
1558 	for (idx = 0; idx < ARRAY_SIZE(snd_ac97_controls_modem_switches); idx++)
1559 		if ((err = snd_ctl_add(card, snd_ac97_cnew(&snd_ac97_controls_modem_switches[idx], ac97))) < 0)
1560 			return err;
1561 
1562 	/* build chip specific controls */
1563 	if (ac97->build_ops->build_specific)
1564 		if ((err = ac97->build_ops->build_specific(ac97)) < 0)
1565 			return err;
1566 
1567 	return 0;
1568 }
1569 
1570 static int snd_ac97_test_rate(ac97_t *ac97, int reg, int shadow_reg, int rate)
1571 {
1572 	unsigned short val;
1573 	unsigned int tmp;
1574 
1575 	tmp = ((unsigned int)rate * ac97->bus->clock) / 48000;
1576 	snd_ac97_write_cache(ac97, reg, tmp & 0xffff);
1577 	if (shadow_reg)
1578 		snd_ac97_write_cache(ac97, shadow_reg, tmp & 0xffff);
1579 	val = snd_ac97_read(ac97, reg);
1580 	return val == (tmp & 0xffff);
1581 }
1582 
1583 static void snd_ac97_determine_rates(ac97_t *ac97, int reg, int shadow_reg, unsigned int *r_result)
1584 {
1585 	unsigned int result = 0;
1586 	unsigned short saved;
1587 
1588 	if (ac97->bus->no_vra) {
1589 		*r_result = SNDRV_PCM_RATE_48000;
1590 		if ((ac97->flags & AC97_DOUBLE_RATE) &&
1591 		    reg == AC97_PCM_FRONT_DAC_RATE)
1592 			*r_result |= SNDRV_PCM_RATE_96000;
1593 		return;
1594 	}
1595 
1596 	saved = snd_ac97_read(ac97, reg);
1597 	if ((ac97->ext_id & AC97_EI_DRA) && reg == AC97_PCM_FRONT_DAC_RATE)
1598 		snd_ac97_update_bits(ac97, AC97_EXTENDED_STATUS,
1599 				     AC97_EA_DRA, 0);
1600 	/* test a non-standard rate */
1601 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 11000))
1602 		result |= SNDRV_PCM_RATE_CONTINUOUS;
1603 	/* let's try to obtain standard rates */
1604 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 8000))
1605 		result |= SNDRV_PCM_RATE_8000;
1606 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 11025))
1607 		result |= SNDRV_PCM_RATE_11025;
1608 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 16000))
1609 		result |= SNDRV_PCM_RATE_16000;
1610 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 22050))
1611 		result |= SNDRV_PCM_RATE_22050;
1612 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 32000))
1613 		result |= SNDRV_PCM_RATE_32000;
1614 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 44100))
1615 		result |= SNDRV_PCM_RATE_44100;
1616 	if (snd_ac97_test_rate(ac97, reg, shadow_reg, 48000))
1617 		result |= SNDRV_PCM_RATE_48000;
1618 	if ((ac97->flags & AC97_DOUBLE_RATE) &&
1619 	    reg == AC97_PCM_FRONT_DAC_RATE) {
1620 		/* test standard double rates */
1621 		snd_ac97_update_bits(ac97, AC97_EXTENDED_STATUS,
1622 				     AC97_EA_DRA, AC97_EA_DRA);
1623 		if (snd_ac97_test_rate(ac97, reg, shadow_reg, 64000 / 2))
1624 			result |= SNDRV_PCM_RATE_64000;
1625 		if (snd_ac97_test_rate(ac97, reg, shadow_reg, 88200 / 2))
1626 			result |= SNDRV_PCM_RATE_88200;
1627 		if (snd_ac97_test_rate(ac97, reg, shadow_reg, 96000 / 2))
1628 			result |= SNDRV_PCM_RATE_96000;
1629 		/* some codecs don't support variable double rates */
1630 		if (!snd_ac97_test_rate(ac97, reg, shadow_reg, 76100 / 2))
1631 			result &= ~SNDRV_PCM_RATE_CONTINUOUS;
1632 		snd_ac97_update_bits(ac97, AC97_EXTENDED_STATUS,
1633 				     AC97_EA_DRA, 0);
1634 	}
1635 	/* restore the default value */
1636 	snd_ac97_write_cache(ac97, reg, saved);
1637 	if (shadow_reg)
1638 		snd_ac97_write_cache(ac97, shadow_reg, saved);
1639 	*r_result = result;
1640 }
1641 
1642 /* check AC97_SPDIF register to accept which sample rates */
1643 static unsigned int snd_ac97_determine_spdif_rates(ac97_t *ac97)
1644 {
1645 	unsigned int result = 0;
1646 	int i;
1647 	static unsigned short ctl_bits[] = {
1648 		AC97_SC_SPSR_44K, AC97_SC_SPSR_32K, AC97_SC_SPSR_48K
1649 	};
1650 	static unsigned int rate_bits[] = {
1651 		SNDRV_PCM_RATE_44100, SNDRV_PCM_RATE_32000, SNDRV_PCM_RATE_48000
1652 	};
1653 
1654 	for (i = 0; i < (int)ARRAY_SIZE(ctl_bits); i++) {
1655 		snd_ac97_update_bits(ac97, AC97_SPDIF, AC97_SC_SPSR_MASK, ctl_bits[i]);
1656 		if ((snd_ac97_read(ac97, AC97_SPDIF) & AC97_SC_SPSR_MASK) == ctl_bits[i])
1657 			result |= rate_bits[i];
1658 	}
1659 	return result;
1660 }
1661 
1662 /* look for the codec id table matching with the given id */
1663 static const ac97_codec_id_t *look_for_codec_id(const ac97_codec_id_t *table,
1664 						unsigned int id)
1665 {
1666 	const ac97_codec_id_t *pid;
1667 
1668 	for (pid = table; pid->id; pid++)
1669 		if (pid->id == (id & pid->mask))
1670 			return pid;
1671 	return NULL;
1672 }
1673 
1674 void snd_ac97_get_name(ac97_t *ac97, unsigned int id, char *name, int modem)
1675 {
1676 	const ac97_codec_id_t *pid;
1677 
1678 	sprintf(name, "0x%x %c%c%c", id,
1679 		printable(id >> 24),
1680 		printable(id >> 16),
1681 		printable(id >> 8));
1682 	pid = look_for_codec_id(snd_ac97_codec_id_vendors, id);
1683 	if (! pid)
1684 		return;
1685 
1686 	strcpy(name, pid->name);
1687 	if (ac97 && pid->patch) {
1688 		if ((modem && (pid->flags & AC97_MODEM_PATCH)) ||
1689 		    (! modem && ! (pid->flags & AC97_MODEM_PATCH)))
1690 			pid->patch(ac97);
1691 	}
1692 
1693 	pid = look_for_codec_id(snd_ac97_codec_ids, id);
1694 	if (pid) {
1695 		strcat(name, " ");
1696 		strcat(name, pid->name);
1697 		if (pid->mask != 0xffffffff)
1698 			sprintf(name + strlen(name), " rev %d", id & ~pid->mask);
1699 		if (ac97 && pid->patch) {
1700 			if ((modem && (pid->flags & AC97_MODEM_PATCH)) ||
1701 			    (! modem && ! (pid->flags & AC97_MODEM_PATCH)))
1702 				pid->patch(ac97);
1703 		}
1704 	} else
1705 		sprintf(name + strlen(name), " id %x", id & 0xff);
1706 }
1707 
1708 /**
1709  * snd_ac97_get_short_name - retrieve codec name
1710  * @ac97: the codec instance
1711  *
1712  * Returns the short identifying name of the codec.
1713  */
1714 const char *snd_ac97_get_short_name(ac97_t *ac97)
1715 {
1716 	const ac97_codec_id_t *pid;
1717 
1718 	for (pid = snd_ac97_codec_ids; pid->id; pid++)
1719 		if (pid->id == (ac97->id & pid->mask))
1720 			return pid->name;
1721 	return "unknown codec";
1722 }
1723 
1724 
1725 /* wait for a while until registers are accessible after RESET
1726  * return 0 if ok, negative not ready
1727  */
1728 static int ac97_reset_wait(ac97_t *ac97, int timeout, int with_modem)
1729 {
1730 	unsigned long end_time;
1731 	unsigned short val;
1732 
1733 	end_time = jiffies + timeout;
1734 	do {
1735 
1736 		/* use preliminary reads to settle the communication */
1737 		snd_ac97_read(ac97, AC97_RESET);
1738 		snd_ac97_read(ac97, AC97_VENDOR_ID1);
1739 		snd_ac97_read(ac97, AC97_VENDOR_ID2);
1740 		/* modem? */
1741 		if (with_modem) {
1742 			val = snd_ac97_read(ac97, AC97_EXTENDED_MID);
1743 			if (val != 0xffff && (val & 1) != 0)
1744 				return 0;
1745 		}
1746 		if (ac97->scaps & AC97_SCAP_DETECT_BY_VENDOR) {
1747 			/* probably only Xbox issue - all registers are read as zero */
1748 			val = snd_ac97_read(ac97, AC97_VENDOR_ID1);
1749 			if (val != 0 && val != 0xffff)
1750 				return 0;
1751 		} else {
1752 			/* because the PCM or MASTER volume registers can be modified,
1753 			 * the REC_GAIN register is used for tests
1754 			 */
1755 			/* test if we can write to the record gain volume register */
1756 			snd_ac97_write_cache(ac97, AC97_REC_GAIN, 0x8a05);
1757 			if ((snd_ac97_read(ac97, AC97_REC_GAIN) & 0x7fff) == 0x0a05)
1758 				return 0;
1759 		}
1760 		set_current_state(TASK_UNINTERRUPTIBLE);
1761 		schedule_timeout(1);
1762 	} while (time_after_eq(end_time, jiffies));
1763 	return -ENODEV;
1764 }
1765 
1766 /**
1767  * snd_ac97_bus - create an AC97 bus component
1768  * @card: the card instance
1769  * @num: the bus number
1770  * @ops: the bus callbacks table
1771  * @private_data: private data pointer for the new instance
1772  * @rbus: the pointer to store the new AC97 bus instance.
1773  *
1774  * Creates an AC97 bus component.  An ac97_bus_t instance is newly
1775  * allocated and initialized.
1776  *
1777  * The ops table must include valid callbacks (at least read and
1778  * write).  The other callbacks, wait and reset, are not mandatory.
1779  *
1780  * The clock is set to 48000.  If another clock is needed, set
1781  * (*rbus)->clock manually.
1782  *
1783  * The AC97 bus instance is registered as a low-level device, so you don't
1784  * have to release it manually.
1785  *
1786  * Returns zero if successful, or a negative error code on failure.
1787  */
1788 int snd_ac97_bus(snd_card_t *card, int num, ac97_bus_ops_t *ops,
1789 		 void *private_data, ac97_bus_t **rbus)
1790 {
1791 	int err;
1792 	ac97_bus_t *bus;
1793 	static snd_device_ops_t dev_ops = {
1794 		.dev_free =	snd_ac97_bus_dev_free,
1795 	};
1796 
1797 	snd_assert(card != NULL, return -EINVAL);
1798 	snd_assert(rbus != NULL, return -EINVAL);
1799 	bus = kcalloc(1, sizeof(*bus), GFP_KERNEL);
1800 	if (bus == NULL)
1801 		return -ENOMEM;
1802 	bus->card = card;
1803 	bus->num = num;
1804 	bus->ops = ops;
1805 	bus->private_data = private_data;
1806 	bus->clock = 48000;
1807 	spin_lock_init(&bus->bus_lock);
1808 	snd_ac97_bus_proc_init(bus);
1809 	if ((err = snd_device_new(card, SNDRV_DEV_BUS, bus, &dev_ops)) < 0) {
1810 		snd_ac97_bus_free(bus);
1811 		return err;
1812 	}
1813 	*rbus = bus;
1814 	return 0;
1815 }
1816 
1817 /* stop no dev release warning */
1818 static void ac97_device_release(struct device * dev)
1819 {
1820 }
1821 
1822 /* register ac97 codec to bus */
1823 static int snd_ac97_dev_register(snd_device_t *device)
1824 {
1825 	ac97_t *ac97 = device->device_data;
1826 	int err;
1827 
1828 	ac97->dev.bus = &ac97_bus_type;
1829 	ac97->dev.parent = ac97->bus->card->dev;
1830 	ac97->dev.platform_data = ac97;
1831 	ac97->dev.release = ac97_device_release;
1832 	snprintf(ac97->dev.bus_id, BUS_ID_SIZE, "card%d-%d", ac97->bus->card->number, ac97->num);
1833 	if ((err = device_register(&ac97->dev)) < 0) {
1834 		snd_printk(KERN_ERR "Can't register ac97 bus\n");
1835 		ac97->dev.bus = NULL;
1836 		return err;
1837 	}
1838 	return 0;
1839 }
1840 
1841 /* unregister ac97 codec */
1842 static int snd_ac97_dev_unregister(snd_device_t *device)
1843 {
1844 	ac97_t *ac97 = device->device_data;
1845 	if (ac97->dev.bus)
1846 		device_unregister(&ac97->dev);
1847 	return snd_ac97_free(ac97);
1848 }
1849 
1850 /* build_ops to do nothing */
1851 static struct snd_ac97_build_ops null_build_ops;
1852 
1853 /**
1854  * snd_ac97_mixer - create an Codec97 component
1855  * @bus: the AC97 bus which codec is attached to
1856  * @template: the template of ac97, including index, callbacks and
1857  *         the private data.
1858  * @rac97: the pointer to store the new ac97 instance.
1859  *
1860  * Creates an Codec97 component.  An ac97_t instance is newly
1861  * allocated and initialized from the template.  The codec
1862  * is then initialized by the standard procedure.
1863  *
1864  * The template must include the codec number (num) and address (addr),
1865  * and the private data (private_data).
1866  *
1867  * The ac97 instance is registered as a low-level device, so you don't
1868  * have to release it manually.
1869  *
1870  * Returns zero if successful, or a negative error code on failure.
1871  */
1872 int snd_ac97_mixer(ac97_bus_t *bus, ac97_template_t *template, ac97_t **rac97)
1873 {
1874 	int err;
1875 	ac97_t *ac97;
1876 	snd_card_t *card;
1877 	char name[64];
1878 	unsigned long end_time;
1879 	unsigned int reg;
1880 	const ac97_codec_id_t *pid;
1881 	static snd_device_ops_t ops = {
1882 		.dev_free =	snd_ac97_dev_free,
1883 		.dev_register =	snd_ac97_dev_register,
1884 		.dev_unregister =	snd_ac97_dev_unregister,
1885 	};
1886 
1887 	snd_assert(rac97 != NULL, return -EINVAL);
1888 	*rac97 = NULL;
1889 	snd_assert(bus != NULL && template != NULL, return -EINVAL);
1890 	snd_assert(template->num < 4 && bus->codec[template->num] == NULL, return -EINVAL);
1891 
1892 	snd_assert(bus->shared_type <= AC97_SHARED_TYPES, return -EINVAL);
1893 	if (bus->shared_type) {
1894 		/* already shared? */
1895 		down(&shared_codec_mutex);
1896 		ac97 = shared_codec[bus->shared_type-1][template->num];
1897 		if (ac97) {
1898 			if ((ac97_is_audio(ac97) && (template->scaps & AC97_SCAP_SKIP_AUDIO)) ||
1899 			    (ac97_is_modem(ac97) && (template->scaps & AC97_SCAP_SKIP_MODEM))) {
1900 				up(&shared_codec_mutex);
1901 				return -EACCES; /* skip this */
1902 			}
1903 		}
1904 		up(&shared_codec_mutex);
1905 	}
1906 
1907 	card = bus->card;
1908 	ac97 = kcalloc(1, sizeof(*ac97), GFP_KERNEL);
1909 	if (ac97 == NULL)
1910 		return -ENOMEM;
1911 	ac97->private_data = template->private_data;
1912 	ac97->private_free = template->private_free;
1913 	ac97->bus = bus;
1914 	ac97->pci = template->pci;
1915 	ac97->num = template->num;
1916 	ac97->addr = template->addr;
1917 	ac97->scaps = template->scaps;
1918 	ac97->limited_regs = template->limited_regs;
1919 	memcpy(ac97->reg_accessed, template->reg_accessed, sizeof(ac97->reg_accessed));
1920 	bus->codec[ac97->num] = ac97;
1921 	init_MUTEX(&ac97->reg_mutex);
1922 	init_MUTEX(&ac97->page_mutex);
1923 
1924 	if (ac97->pci) {
1925 		pci_read_config_word(ac97->pci, PCI_SUBSYSTEM_VENDOR_ID, &ac97->subsystem_vendor);
1926 		pci_read_config_word(ac97->pci, PCI_SUBSYSTEM_ID, &ac97->subsystem_device);
1927 	}
1928 	if (bus->ops->reset) {
1929 		bus->ops->reset(ac97);
1930 		goto __access_ok;
1931 	}
1932 
1933 	ac97->id = snd_ac97_read(ac97, AC97_VENDOR_ID1) << 16;
1934 	ac97->id |= snd_ac97_read(ac97, AC97_VENDOR_ID2);
1935 	if (ac97->id && ac97->id != (unsigned int)-1) {
1936 		pid = look_for_codec_id(snd_ac97_codec_ids, ac97->id);
1937 		if (pid && (pid->flags & AC97_DEFAULT_POWER_OFF))
1938 			goto __access_ok;
1939 	}
1940 
1941 	/* reset to defaults */
1942 	if (!(ac97->scaps & AC97_SCAP_SKIP_AUDIO))
1943 		snd_ac97_write(ac97, AC97_RESET, 0);
1944 	if (!(ac97->scaps & AC97_SCAP_SKIP_MODEM))
1945 		snd_ac97_write(ac97, AC97_EXTENDED_MID, 0);
1946 	if (bus->ops->wait)
1947 		bus->ops->wait(ac97);
1948 	else {
1949 		udelay(50);
1950 		if (ac97->scaps & AC97_SCAP_SKIP_AUDIO)
1951 			err = ac97_reset_wait(ac97, HZ/2, 1);
1952 		else {
1953 			err = ac97_reset_wait(ac97, HZ/2, 0);
1954 			if (err < 0)
1955 				err = ac97_reset_wait(ac97, HZ/2, 1);
1956 		}
1957 		if (err < 0) {
1958 			snd_printk(KERN_WARNING "AC'97 %d does not respond - RESET\n", ac97->num);
1959 			/* proceed anyway - it's often non-critical */
1960 		}
1961 	}
1962       __access_ok:
1963 	ac97->id = snd_ac97_read(ac97, AC97_VENDOR_ID1) << 16;
1964 	ac97->id |= snd_ac97_read(ac97, AC97_VENDOR_ID2);
1965 	if (! (ac97->scaps & AC97_SCAP_DETECT_BY_VENDOR) &&
1966 	    (ac97->id == 0x00000000 || ac97->id == 0xffffffff)) {
1967 		snd_printk(KERN_ERR "AC'97 %d access is not valid [0x%x], removing mixer.\n", ac97->num, ac97->id);
1968 		snd_ac97_free(ac97);
1969 		return -EIO;
1970 	}
1971 	pid = look_for_codec_id(snd_ac97_codec_ids, ac97->id);
1972 	if (pid)
1973 		ac97->flags |= pid->flags;
1974 
1975 	/* test for AC'97 */
1976 	if (!(ac97->scaps & AC97_SCAP_SKIP_AUDIO) && !(ac97->scaps & AC97_SCAP_AUDIO)) {
1977 		/* test if we can write to the record gain volume register */
1978 		snd_ac97_write_cache(ac97, AC97_REC_GAIN, 0x8a06);
1979 		if (((err = snd_ac97_read(ac97, AC97_REC_GAIN)) & 0x7fff) == 0x0a06)
1980 			ac97->scaps |= AC97_SCAP_AUDIO;
1981 	}
1982 	if (ac97->scaps & AC97_SCAP_AUDIO) {
1983 		ac97->caps = snd_ac97_read(ac97, AC97_RESET);
1984 		ac97->ext_id = snd_ac97_read(ac97, AC97_EXTENDED_ID);
1985 		if (ac97->ext_id == 0xffff)	/* invalid combination */
1986 			ac97->ext_id = 0;
1987 	}
1988 
1989 	/* test for MC'97 */
1990 	if (!(ac97->scaps & AC97_SCAP_SKIP_MODEM) && !(ac97->scaps & AC97_SCAP_MODEM)) {
1991 		ac97->ext_mid = snd_ac97_read(ac97, AC97_EXTENDED_MID);
1992 		if (ac97->ext_mid == 0xffff)	/* invalid combination */
1993 			ac97->ext_mid = 0;
1994 		if (ac97->ext_mid & 1)
1995 			ac97->scaps |= AC97_SCAP_MODEM;
1996 	}
1997 
1998 	if (!ac97_is_audio(ac97) && !ac97_is_modem(ac97)) {
1999 		if (!(ac97->scaps & (AC97_SCAP_SKIP_AUDIO|AC97_SCAP_SKIP_MODEM)))
2000 			snd_printk(KERN_ERR "AC'97 %d access error (not audio or modem codec)\n", ac97->num);
2001 		snd_ac97_free(ac97);
2002 		return -EACCES;
2003 	}
2004 
2005 	if (bus->ops->reset) // FIXME: always skipping?
2006 		goto __ready_ok;
2007 
2008 	/* FIXME: add powerdown control */
2009 	if (ac97_is_audio(ac97)) {
2010 		/* nothing should be in powerdown mode */
2011 		snd_ac97_write_cache(ac97, AC97_POWERDOWN, 0);
2012 		if (! (ac97->flags & AC97_DEFAULT_POWER_OFF)) {
2013 			snd_ac97_write_cache(ac97, AC97_RESET, 0); /* reset to defaults */
2014 			udelay(100);
2015 			snd_ac97_write_cache(ac97, AC97_POWERDOWN, 0);
2016 		}
2017 		/* nothing should be in powerdown mode */
2018 		snd_ac97_write_cache(ac97, AC97_GENERAL_PURPOSE, 0);
2019 		end_time = jiffies + (HZ / 10);
2020 		do {
2021 			if ((snd_ac97_read(ac97, AC97_POWERDOWN) & 0x0f) == 0x0f)
2022 				goto __ready_ok;
2023 			set_current_state(TASK_UNINTERRUPTIBLE);
2024 			schedule_timeout(1);
2025 		} while (time_after_eq(end_time, jiffies));
2026 		snd_printk(KERN_WARNING "AC'97 %d analog subsections not ready\n", ac97->num);
2027 	}
2028 
2029 	/* FIXME: add powerdown control */
2030 	if (ac97_is_modem(ac97)) {
2031 		unsigned char tmp;
2032 
2033 		/* nothing should be in powerdown mode */
2034 		/* note: it's important to set the rate at first */
2035 		tmp = AC97_MEA_GPIO;
2036 		if (ac97->ext_mid & AC97_MEI_LINE1) {
2037 			snd_ac97_write_cache(ac97, AC97_LINE1_RATE, 8000);
2038 			tmp |= AC97_MEA_ADC1 | AC97_MEA_DAC1;
2039 		}
2040 		if (ac97->ext_mid & AC97_MEI_LINE2) {
2041 			snd_ac97_write_cache(ac97, AC97_LINE2_RATE, 8000);
2042 			tmp |= AC97_MEA_ADC2 | AC97_MEA_DAC2;
2043 		}
2044 		if (ac97->ext_mid & AC97_MEI_HANDSET) {
2045 			snd_ac97_write_cache(ac97, AC97_HANDSET_RATE, 8000);
2046 			tmp |= AC97_MEA_HADC | AC97_MEA_HDAC;
2047 		}
2048 		snd_ac97_write_cache(ac97, AC97_EXTENDED_MSTATUS, 0);
2049 		udelay(100);
2050 		/* nothing should be in powerdown mode */
2051 		snd_ac97_write_cache(ac97, AC97_EXTENDED_MSTATUS, 0);
2052 		end_time = jiffies + (HZ / 10);
2053 		do {
2054 			if ((snd_ac97_read(ac97, AC97_EXTENDED_MSTATUS) & tmp) == tmp)
2055 				goto __ready_ok;
2056 			set_current_state(TASK_UNINTERRUPTIBLE);
2057 			schedule_timeout(1);
2058 		} while (time_after_eq(end_time, jiffies));
2059 		snd_printk(KERN_WARNING "MC'97 %d converters and GPIO not ready (0x%x)\n", ac97->num, snd_ac97_read(ac97, AC97_EXTENDED_MSTATUS));
2060 	}
2061 
2062       __ready_ok:
2063 	if (ac97_is_audio(ac97))
2064 		ac97->addr = (ac97->ext_id & AC97_EI_ADDR_MASK) >> AC97_EI_ADDR_SHIFT;
2065 	else
2066 		ac97->addr = (ac97->ext_mid & AC97_MEI_ADDR_MASK) >> AC97_MEI_ADDR_SHIFT;
2067 	if (ac97->ext_id & 0x01c9) {	/* L/R, MIC, SDAC, LDAC VRA support */
2068 		reg = snd_ac97_read(ac97, AC97_EXTENDED_STATUS);
2069 		reg |= ac97->ext_id & 0x01c0; /* LDAC/SDAC/CDAC */
2070 		if (! bus->no_vra)
2071 			reg |= ac97->ext_id & 0x0009; /* VRA/VRM */
2072 		snd_ac97_write_cache(ac97, AC97_EXTENDED_STATUS, reg);
2073 	}
2074 	if ((ac97->ext_id & AC97_EI_DRA) && bus->dra) {
2075 		/* Intel controllers require double rate data to be put in
2076 		 * slots 7+8, so let's hope the codec supports it. */
2077 		snd_ac97_update_bits(ac97, AC97_GENERAL_PURPOSE, AC97_GP_DRSS_MASK, AC97_GP_DRSS_78);
2078 		if ((snd_ac97_read(ac97, AC97_GENERAL_PURPOSE) & AC97_GP_DRSS_MASK) == AC97_GP_DRSS_78)
2079 			ac97->flags |= AC97_DOUBLE_RATE;
2080 	}
2081 	if (ac97->ext_id & AC97_EI_VRA) {	/* VRA support */
2082 		snd_ac97_determine_rates(ac97, AC97_PCM_FRONT_DAC_RATE, 0, &ac97->rates[AC97_RATES_FRONT_DAC]);
2083 		snd_ac97_determine_rates(ac97, AC97_PCM_LR_ADC_RATE, 0, &ac97->rates[AC97_RATES_ADC]);
2084 	} else {
2085 		ac97->rates[AC97_RATES_FRONT_DAC] = SNDRV_PCM_RATE_48000;
2086 		if (ac97->flags & AC97_DOUBLE_RATE)
2087 			ac97->rates[AC97_RATES_FRONT_DAC] |= SNDRV_PCM_RATE_96000;
2088 		ac97->rates[AC97_RATES_ADC] = SNDRV_PCM_RATE_48000;
2089 	}
2090 	if (ac97->ext_id & AC97_EI_SPDIF) {
2091 		/* codec specific code (patch) should override these values */
2092 		ac97->rates[AC97_RATES_SPDIF] = SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_32000;
2093 	}
2094 	if (ac97->ext_id & AC97_EI_VRM) {	/* MIC VRA support */
2095 		snd_ac97_determine_rates(ac97, AC97_PCM_MIC_ADC_RATE, 0, &ac97->rates[AC97_RATES_MIC_ADC]);
2096 	} else {
2097 		ac97->rates[AC97_RATES_MIC_ADC] = SNDRV_PCM_RATE_48000;
2098 	}
2099 	if (ac97->ext_id & AC97_EI_SDAC) {	/* SDAC support */
2100 		snd_ac97_determine_rates(ac97, AC97_PCM_SURR_DAC_RATE, AC97_PCM_FRONT_DAC_RATE, &ac97->rates[AC97_RATES_SURR_DAC]);
2101 		ac97->scaps |= AC97_SCAP_SURROUND_DAC;
2102 	}
2103 	if (ac97->ext_id & AC97_EI_LDAC) {	/* LDAC support */
2104 		snd_ac97_determine_rates(ac97, AC97_PCM_LFE_DAC_RATE, AC97_PCM_FRONT_DAC_RATE, &ac97->rates[AC97_RATES_LFE_DAC]);
2105 		ac97->scaps |= AC97_SCAP_CENTER_LFE_DAC;
2106 	}
2107 	/* additional initializations */
2108 	if (bus->ops->init)
2109 		bus->ops->init(ac97);
2110 	snd_ac97_get_name(ac97, ac97->id, name, !ac97_is_audio(ac97));
2111 	snd_ac97_get_name(NULL, ac97->id, name, !ac97_is_audio(ac97));  // ac97->id might be changed in the special setup code
2112 	if (! ac97->build_ops)
2113 		ac97->build_ops = &null_build_ops;
2114 
2115 	if (ac97_is_audio(ac97)) {
2116 		char comp[16];
2117 		if (card->mixername[0] == '\0') {
2118 			strcpy(card->mixername, name);
2119 		} else {
2120 			if (strlen(card->mixername) + 1 + strlen(name) + 1 <= sizeof(card->mixername)) {
2121 				strcat(card->mixername, ",");
2122 				strcat(card->mixername, name);
2123 			}
2124 		}
2125 		sprintf(comp, "AC97a:%08x", ac97->id);
2126 		if ((err = snd_component_add(card, comp)) < 0) {
2127 			snd_ac97_free(ac97);
2128 			return err;
2129 		}
2130 		if (snd_ac97_mixer_build(ac97) < 0) {
2131 			snd_ac97_free(ac97);
2132 			return -ENOMEM;
2133 		}
2134 	}
2135 	if (ac97_is_modem(ac97)) {
2136 		char comp[16];
2137 		if (card->mixername[0] == '\0') {
2138 			strcpy(card->mixername, name);
2139 		} else {
2140 			if (strlen(card->mixername) + 1 + strlen(name) + 1 <= sizeof(card->mixername)) {
2141 				strcat(card->mixername, ",");
2142 				strcat(card->mixername, name);
2143 			}
2144 		}
2145 		sprintf(comp, "AC97m:%08x", ac97->id);
2146 		if ((err = snd_component_add(card, comp)) < 0) {
2147 			snd_ac97_free(ac97);
2148 			return err;
2149 		}
2150 		if (snd_ac97_modem_build(card, ac97) < 0) {
2151 			snd_ac97_free(ac97);
2152 			return -ENOMEM;
2153 		}
2154 	}
2155 	/* make sure the proper powerdown bits are cleared */
2156 	if (ac97->scaps) {
2157 		reg = snd_ac97_read(ac97, AC97_EXTENDED_STATUS);
2158 		if (ac97->scaps & AC97_SCAP_SURROUND_DAC)
2159 			reg &= ~AC97_EA_PRJ;
2160 		if (ac97->scaps & AC97_SCAP_CENTER_LFE_DAC)
2161 			reg &= ~(AC97_EA_PRI | AC97_EA_PRK);
2162 		snd_ac97_write_cache(ac97, AC97_EXTENDED_STATUS, reg);
2163 	}
2164 	snd_ac97_proc_init(ac97);
2165 	if ((err = snd_device_new(card, SNDRV_DEV_CODEC, ac97, &ops)) < 0) {
2166 		snd_ac97_free(ac97);
2167 		return err;
2168 	}
2169 	*rac97 = ac97;
2170 
2171 	if (bus->shared_type) {
2172 		down(&shared_codec_mutex);
2173 		shared_codec[bus->shared_type-1][ac97->num] = ac97;
2174 		up(&shared_codec_mutex);
2175 	}
2176 
2177 	return 0;
2178 }
2179 
2180 
2181 /*
2182  * Power down the chip.
2183  *
2184  * MASTER and HEADPHONE registers are muted but the register cache values
2185  * are not changed, so that the values can be restored in snd_ac97_resume().
2186  */
2187 static void snd_ac97_powerdown(ac97_t *ac97)
2188 {
2189 	unsigned short power;
2190 
2191 	if (ac97_is_audio(ac97)) {
2192 		/* some codecs have stereo mute bits */
2193 		snd_ac97_write(ac97, AC97_MASTER, 0x9f9f);
2194 		snd_ac97_write(ac97, AC97_HEADPHONE, 0x9f9f);
2195 	}
2196 
2197 	power = ac97->regs[AC97_POWERDOWN] | 0x8000;	/* EAPD */
2198 	power |= 0x4000;	/* Headphone amplifier powerdown */
2199 	power |= 0x0300;	/* ADC & DAC powerdown */
2200 	snd_ac97_write(ac97, AC97_POWERDOWN, power);
2201 	udelay(100);
2202 	power |= 0x0400;	/* Analog Mixer powerdown (Vref on) */
2203 	snd_ac97_write(ac97, AC97_POWERDOWN, power);
2204 	udelay(100);
2205 #if 0
2206 	/* FIXME: this causes click noises on some boards at resume */
2207 	power |= 0x3800;	/* AC-link powerdown, internal Clk disable */
2208 	snd_ac97_write(ac97, AC97_POWERDOWN, power);
2209 #endif
2210 }
2211 
2212 
2213 #ifdef CONFIG_PM
2214 /**
2215  * snd_ac97_suspend - General suspend function for AC97 codec
2216  * @ac97: the ac97 instance
2217  *
2218  * Suspends the codec, power down the chip.
2219  */
2220 void snd_ac97_suspend(ac97_t *ac97)
2221 {
2222 	if (ac97->build_ops->suspend)
2223 		ac97->build_ops->suspend(ac97);
2224 	snd_ac97_powerdown(ac97);
2225 }
2226 
2227 /*
2228  * restore ac97 status
2229  */
2230 void snd_ac97_restore_status(ac97_t *ac97)
2231 {
2232 	int i;
2233 
2234 	for (i = 2; i < 0x7c ; i += 2) {
2235 		if (i == AC97_POWERDOWN || i == AC97_EXTENDED_ID)
2236 			continue;
2237 		/* restore only accessible registers
2238 		 * some chip (e.g. nm256) may hang up when unsupported registers
2239 		 * are accessed..!
2240 		 */
2241 		if (test_bit(i, ac97->reg_accessed)) {
2242 			snd_ac97_write(ac97, i, ac97->regs[i]);
2243 			snd_ac97_read(ac97, i);
2244 		}
2245 	}
2246 }
2247 
2248 /*
2249  * restore IEC958 status
2250  */
2251 void snd_ac97_restore_iec958(ac97_t *ac97)
2252 {
2253 	if (ac97->ext_id & AC97_EI_SPDIF) {
2254 		if (ac97->regs[AC97_EXTENDED_STATUS] & AC97_EA_SPDIF) {
2255 			/* reset spdif status */
2256 			snd_ac97_update_bits(ac97, AC97_EXTENDED_STATUS, AC97_EA_SPDIF, 0);
2257 			snd_ac97_write(ac97, AC97_EXTENDED_STATUS, ac97->regs[AC97_EXTENDED_STATUS]);
2258 			if (ac97->flags & AC97_CS_SPDIF)
2259 				snd_ac97_write(ac97, AC97_CSR_SPDIF, ac97->regs[AC97_CSR_SPDIF]);
2260 			else
2261 				snd_ac97_write(ac97, AC97_SPDIF, ac97->regs[AC97_SPDIF]);
2262 			snd_ac97_update_bits(ac97, AC97_EXTENDED_STATUS, AC97_EA_SPDIF, AC97_EA_SPDIF); /* turn on again */
2263 		}
2264 	}
2265 }
2266 
2267 /**
2268  * snd_ac97_resume - General resume function for AC97 codec
2269  * @ac97: the ac97 instance
2270  *
2271  * Do the standard resume procedure, power up and restoring the
2272  * old register values.
2273  */
2274 void snd_ac97_resume(ac97_t *ac97)
2275 {
2276 	unsigned long end_time;
2277 
2278 	if (ac97->bus->ops->reset) {
2279 		ac97->bus->ops->reset(ac97);
2280 		goto  __reset_ready;
2281 	}
2282 
2283 	snd_ac97_write(ac97, AC97_POWERDOWN, 0);
2284 	if (! (ac97->flags & AC97_DEFAULT_POWER_OFF)) {
2285 		snd_ac97_write(ac97, AC97_RESET, 0);
2286 		udelay(100);
2287 		snd_ac97_write(ac97, AC97_POWERDOWN, 0);
2288 	}
2289 	snd_ac97_write(ac97, AC97_GENERAL_PURPOSE, 0);
2290 
2291 	snd_ac97_write(ac97, AC97_POWERDOWN, ac97->regs[AC97_POWERDOWN]);
2292 	if (ac97_is_audio(ac97)) {
2293 		ac97->bus->ops->write(ac97, AC97_MASTER, 0x8101);
2294 		end_time = jiffies + msecs_to_jiffies(100);
2295 		do {
2296 			if (snd_ac97_read(ac97, AC97_MASTER) == 0x8101)
2297 				break;
2298 			set_current_state(TASK_UNINTERRUPTIBLE);
2299 			schedule_timeout(1);
2300 		} while (time_after_eq(end_time, jiffies));
2301 		/* FIXME: extra delay */
2302 		ac97->bus->ops->write(ac97, AC97_MASTER, 0x8000);
2303 		if (snd_ac97_read(ac97, AC97_MASTER) != 0x8000)
2304 			msleep(250);
2305 	} else {
2306 		end_time = jiffies + msecs_to_jiffies(100);
2307 		do {
2308 			unsigned short val = snd_ac97_read(ac97, AC97_EXTENDED_MID);
2309 			if (val != 0xffff && (val & 1) != 0)
2310 				break;
2311 			set_current_state(TASK_UNINTERRUPTIBLE);
2312 			schedule_timeout(1);
2313 		} while (time_after_eq(end_time, jiffies));
2314 	}
2315 __reset_ready:
2316 
2317 	if (ac97->bus->ops->init)
2318 		ac97->bus->ops->init(ac97);
2319 
2320 	if (ac97->build_ops->resume)
2321 		ac97->build_ops->resume(ac97);
2322 	else {
2323 		snd_ac97_restore_status(ac97);
2324 		snd_ac97_restore_iec958(ac97);
2325 	}
2326 }
2327 #endif
2328 
2329 
2330 /*
2331  * Hardware tuning
2332  */
2333 static void set_ctl_name(char *dst, const char *src, const char *suffix)
2334 {
2335 	if (suffix)
2336 		sprintf(dst, "%s %s", src, suffix);
2337 	else
2338 		strcpy(dst, src);
2339 }
2340 
2341 /* remove the control with the given name and optional suffix */
2342 int snd_ac97_remove_ctl(ac97_t *ac97, const char *name, const char *suffix)
2343 {
2344 	snd_ctl_elem_id_t id;
2345 	memset(&id, 0, sizeof(id));
2346 	set_ctl_name(id.name, name, suffix);
2347 	id.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
2348 	return snd_ctl_remove_id(ac97->bus->card, &id);
2349 }
2350 
2351 static snd_kcontrol_t *ctl_find(ac97_t *ac97, const char *name, const char *suffix)
2352 {
2353 	snd_ctl_elem_id_t sid;
2354 	memset(&sid, 0, sizeof(sid));
2355 	set_ctl_name(sid.name, name, suffix);
2356 	sid.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
2357 	return snd_ctl_find_id(ac97->bus->card, &sid);
2358 }
2359 
2360 /* rename the control with the given name and optional suffix */
2361 int snd_ac97_rename_ctl(ac97_t *ac97, const char *src, const char *dst, const char *suffix)
2362 {
2363 	snd_kcontrol_t *kctl = ctl_find(ac97, src, suffix);
2364 	if (kctl) {
2365 		set_ctl_name(kctl->id.name, dst, suffix);
2366 		return 0;
2367 	}
2368 	return -ENOENT;
2369 }
2370 
2371 /* rename both Volume and Switch controls - don't check the return value */
2372 void snd_ac97_rename_vol_ctl(ac97_t *ac97, const char *src, const char *dst)
2373 {
2374 	snd_ac97_rename_ctl(ac97, src, dst, "Switch");
2375 	snd_ac97_rename_ctl(ac97, src, dst, "Volume");
2376 }
2377 
2378 /* swap controls */
2379 int snd_ac97_swap_ctl(ac97_t *ac97, const char *s1, const char *s2, const char *suffix)
2380 {
2381 	snd_kcontrol_t *kctl1, *kctl2;
2382 	kctl1 = ctl_find(ac97, s1, suffix);
2383 	kctl2 = ctl_find(ac97, s2, suffix);
2384 	if (kctl1 && kctl2) {
2385 		set_ctl_name(kctl1->id.name, s2, suffix);
2386 		set_ctl_name(kctl2->id.name, s1, suffix);
2387 		return 0;
2388 	}
2389 	return -ENOENT;
2390 }
2391 
2392 #if 1
2393 /* bind hp and master controls instead of using only hp control */
2394 static int bind_hp_volsw_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
2395 {
2396 	int err = snd_ac97_put_volsw(kcontrol, ucontrol);
2397 	if (err > 0) {
2398 		unsigned long priv_saved = kcontrol->private_value;
2399 		kcontrol->private_value = (kcontrol->private_value & ~0xff) | AC97_HEADPHONE;
2400 		snd_ac97_put_volsw(kcontrol, ucontrol);
2401 		kcontrol->private_value = priv_saved;
2402 	}
2403 	return err;
2404 }
2405 
2406 /* ac97 tune: bind Master and Headphone controls */
2407 static int tune_hp_only(ac97_t *ac97)
2408 {
2409 	snd_kcontrol_t *msw = ctl_find(ac97, "Master Playback Switch", NULL);
2410 	snd_kcontrol_t *mvol = ctl_find(ac97, "Master Playback Volume", NULL);
2411 	if (! msw || ! mvol)
2412 		return -ENOENT;
2413 	msw->put = bind_hp_volsw_put;
2414 	mvol->put = bind_hp_volsw_put;
2415 	snd_ac97_remove_ctl(ac97, "Headphone Playback", "Switch");
2416 	snd_ac97_remove_ctl(ac97, "Headphone Playback", "Volume");
2417 	return 0;
2418 }
2419 
2420 #else
2421 /* ac97 tune: use Headphone control as master */
2422 static int tune_hp_only(ac97_t *ac97)
2423 {
2424 	if (ctl_find(ac97, "Headphone Playback Switch", NULL) == NULL)
2425 		return -ENOENT;
2426 	snd_ac97_remove_ctl(ac97, "Master Playback", "Switch");
2427 	snd_ac97_remove_ctl(ac97, "Master Playback", "Volume");
2428 	snd_ac97_rename_vol_ctl(ac97, "Headphone Playback", "Master Playback");
2429 	return 0;
2430 }
2431 #endif
2432 
2433 /* ac97 tune: swap Headphone and Master controls */
2434 static int tune_swap_hp(ac97_t *ac97)
2435 {
2436 	if (ctl_find(ac97, "Headphone Playback Switch", NULL) == NULL)
2437 		return -ENOENT;
2438 	snd_ac97_rename_vol_ctl(ac97, "Master Playback", "Line-Out Playback");
2439 	snd_ac97_rename_vol_ctl(ac97, "Headphone Playback", "Master Playback");
2440 	return 0;
2441 }
2442 
2443 /* ac97 tune: swap Surround and Master controls */
2444 static int tune_swap_surround(ac97_t *ac97)
2445 {
2446 	if (snd_ac97_swap_ctl(ac97, "Master Playback", "Surround Playback", "Switch") ||
2447 	    snd_ac97_swap_ctl(ac97, "Master Playback", "Surround Playback", "Volume"))
2448 		return -ENOENT;
2449 	return 0;
2450 }
2451 
2452 /* ac97 tune: set up mic sharing for AD codecs */
2453 static int tune_ad_sharing(ac97_t *ac97)
2454 {
2455 	unsigned short scfg;
2456 	if ((ac97->id & 0xffffff00) != 0x41445300) {
2457 		snd_printk(KERN_ERR "ac97_quirk AD_SHARING is only for AD codecs\n");
2458 		return -EINVAL;
2459 	}
2460 	/* Turn on OMS bit to route microphone to back panel */
2461 	scfg = snd_ac97_read(ac97, AC97_AD_SERIAL_CFG);
2462 	snd_ac97_write_cache(ac97, AC97_AD_SERIAL_CFG, scfg | 0x0200);
2463 	return 0;
2464 }
2465 
2466 static const snd_kcontrol_new_t snd_ac97_alc_jack_detect =
2467 AC97_SINGLE("Jack Detect", AC97_ALC650_CLOCK, 5, 1, 0);
2468 
2469 /* ac97 tune: set up ALC jack-select */
2470 static int tune_alc_jack(ac97_t *ac97)
2471 {
2472 	if ((ac97->id & 0xffffff00) != 0x414c4700) {
2473 		snd_printk(KERN_ERR "ac97_quirk ALC_JACK is only for Realtek codecs\n");
2474 		return -EINVAL;
2475 	}
2476 	snd_ac97_update_bits(ac97, 0x7a, 0x20, 0x20); /* select jack detect function */
2477 	snd_ac97_update_bits(ac97, 0x7a, 0x01, 0x01); /* Line-out auto mute */
2478 	return snd_ctl_add(ac97->bus->card, snd_ac97_cnew(&snd_ac97_alc_jack_detect, ac97));
2479 }
2480 
2481 /* ac97 tune: inversed EAPD bit */
2482 static int tune_inv_eapd(ac97_t *ac97)
2483 {
2484 	snd_kcontrol_t *kctl = ctl_find(ac97, "External Amplifier", NULL);
2485 	if (! kctl)
2486 		return -ENOENT;
2487 	set_inv_eapd(ac97, kctl);
2488 	return 0;
2489 }
2490 
2491 static int master_mute_sw_put(snd_kcontrol_t *kcontrol, snd_ctl_elem_value_t *ucontrol)
2492 {
2493 	int err = snd_ac97_put_volsw(kcontrol, ucontrol);
2494 	if (err > 0) {
2495 		ac97_t *ac97 = snd_kcontrol_chip(kcontrol);
2496 		int shift = (kcontrol->private_value >> 8) & 0x0f;
2497 		int rshift = (kcontrol->private_value >> 12) & 0x0f;
2498 		unsigned short mask;
2499 		if (shift != rshift)
2500 			mask = 0x8080;
2501 		else
2502 			mask = 0x8000;
2503 		snd_ac97_update_bits(ac97, AC97_POWERDOWN, 0x8000,
2504 				     (ac97->regs[AC97_MASTER] & mask) == mask ?
2505 				     0x8000 : 0);
2506 	}
2507 	return err;
2508 }
2509 
2510 /* ac97 tune: EAPD controls mute LED bound with the master mute */
2511 static int tune_mute_led(ac97_t *ac97)
2512 {
2513 	snd_kcontrol_t *msw = ctl_find(ac97, "Master Playback Switch", NULL);
2514 	if (! msw)
2515 		return -ENOENT;
2516 	msw->put = master_mute_sw_put;
2517 	snd_ac97_remove_ctl(ac97, "External Amplifier", NULL);
2518 	snd_ac97_update_bits(ac97, AC97_POWERDOWN, 0x8000, 0x8000); /* mute LED on */
2519 	return 0;
2520 }
2521 
2522 struct quirk_table {
2523 	const char *name;
2524 	int (*func)(ac97_t *);
2525 };
2526 
2527 static struct quirk_table applicable_quirks[] = {
2528 	{ "none", NULL },
2529 	{ "hp_only", tune_hp_only },
2530 	{ "swap_hp", tune_swap_hp },
2531 	{ "swap_surround", tune_swap_surround },
2532 	{ "ad_sharing", tune_ad_sharing },
2533 	{ "alc_jack", tune_alc_jack },
2534 	{ "inv_eapd", tune_inv_eapd },
2535 	{ "mute_led", tune_mute_led },
2536 };
2537 
2538 /* apply the quirk with the given type */
2539 static int apply_quirk(ac97_t *ac97, int type)
2540 {
2541 	if (type <= 0)
2542 		return 0;
2543 	else if (type >= ARRAY_SIZE(applicable_quirks))
2544 		return -EINVAL;
2545 	if (applicable_quirks[type].func)
2546 		return applicable_quirks[type].func(ac97);
2547 	return 0;
2548 }
2549 
2550 /* apply the quirk with the given name */
2551 static int apply_quirk_str(ac97_t *ac97, const char *typestr)
2552 {
2553 	int i;
2554 	struct quirk_table *q;
2555 
2556 	for (i = 0; i < ARRAY_SIZE(applicable_quirks); i++) {
2557 		q = &applicable_quirks[i];
2558 		if (q->name && ! strcmp(typestr, q->name))
2559 			return apply_quirk(ac97, i);
2560 	}
2561 	/* for compatibility, accept the numbers, too */
2562 	if (*typestr >= '0' && *typestr <= '9')
2563 		return apply_quirk(ac97, (int)simple_strtoul(typestr, NULL, 10));
2564 	return -EINVAL;
2565 }
2566 
2567 /**
2568  * snd_ac97_tune_hardware - tune up the hardware
2569  * @ac97: the ac97 instance
2570  * @quirk: quirk list
2571  * @override: explicit quirk value (overrides the list if non-NULL)
2572  *
2573  * Do some workaround for each pci device, such as renaming of the
2574  * headphone (true line-out) control as "Master".
2575  * The quirk-list must be terminated with a zero-filled entry.
2576  *
2577  * Returns zero if successful, or a negative error code on failure.
2578  */
2579 
2580 int snd_ac97_tune_hardware(ac97_t *ac97, struct ac97_quirk *quirk, const char *override)
2581 {
2582 	int result;
2583 
2584 	/* quirk overriden? */
2585 	if (override && strcmp(override, "-1") && strcmp(override, "default")) {
2586 		result = apply_quirk_str(ac97, override);
2587 		if (result < 0)
2588 			snd_printk(KERN_ERR "applying quirk type %s failed (%d)\n", override, result);
2589 		return result;
2590 	}
2591 
2592 	if (! quirk)
2593 		return -EINVAL;
2594 
2595 	for (; quirk->subvendor; quirk++) {
2596 		if (quirk->subvendor != ac97->subsystem_vendor)
2597 			continue;
2598 		if ((! quirk->mask && quirk->subdevice == ac97->subsystem_device) ||
2599 		    quirk->subdevice == (quirk->mask & ac97->subsystem_device)) {
2600 			if (quirk->codec_id && quirk->codec_id != ac97->id)
2601 				continue;
2602 			snd_printdd("ac97 quirk for %s (%04x:%04x)\n", quirk->name, ac97->subsystem_vendor, ac97->subsystem_device);
2603 			result = apply_quirk(ac97, quirk->type);
2604 			if (result < 0)
2605 				snd_printk(KERN_ERR "applying quirk type %d for %s failed (%d)\n", quirk->type, quirk->name, result);
2606 			return result;
2607 		}
2608 	}
2609 	return 0;
2610 }
2611 
2612 
2613 /*
2614  *  Exported symbols
2615  */
2616 
2617 EXPORT_SYMBOL(snd_ac97_write);
2618 EXPORT_SYMBOL(snd_ac97_read);
2619 EXPORT_SYMBOL(snd_ac97_write_cache);
2620 EXPORT_SYMBOL(snd_ac97_update);
2621 EXPORT_SYMBOL(snd_ac97_update_bits);
2622 EXPORT_SYMBOL(snd_ac97_get_short_name);
2623 EXPORT_SYMBOL(snd_ac97_bus);
2624 EXPORT_SYMBOL(snd_ac97_mixer);
2625 EXPORT_SYMBOL(snd_ac97_pcm_assign);
2626 EXPORT_SYMBOL(snd_ac97_pcm_open);
2627 EXPORT_SYMBOL(snd_ac97_pcm_close);
2628 EXPORT_SYMBOL(snd_ac97_pcm_double_rate_rules);
2629 EXPORT_SYMBOL(snd_ac97_tune_hardware);
2630 EXPORT_SYMBOL(snd_ac97_set_rate);
2631 #ifdef CONFIG_PM
2632 EXPORT_SYMBOL(snd_ac97_resume);
2633 EXPORT_SYMBOL(snd_ac97_suspend);
2634 #endif
2635 
2636 /*
2637  *  INIT part
2638  */
2639 
2640 static int __init alsa_ac97_init(void)
2641 {
2642 	return 0;
2643 }
2644 
2645 static void __exit alsa_ac97_exit(void)
2646 {
2647 }
2648 
2649 module_init(alsa_ac97_init)
2650 module_exit(alsa_ac97_exit)
2651