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