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