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