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