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