git.oblomov.eu Git - linux-2.6/blob - sound/pci/ac97/ac97_codec.c

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