sound/pci/ac97/ac97_codec.c

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