sound/pci/ac97/ac97_codec.c

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