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