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