sound/isa/opl3sa2.c

   1 /*
   2  *  Driver for Yamaha OPL3-SA[2,3] soundcards
   3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
   4  *
   5  *
   6  *   This program is free software; you can redistribute it and/or modify
   7  *   it under the terms of the GNU General Public License as published by
   8  *   the Free Software Foundation; either version 2 of the License, or
   9  *   (at your option) any later version.
  10  *
  11  *   This program is distributed in the hope that it will be useful,
  12  *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  *   GNU General Public License for more details.
  15  *
  16  *   You should have received a copy of the GNU General Public License
  17  *   along with this program; if not, write to the Free Software
  18  *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  19  *
  20  */
  21
  22 #include <linux/init.h>
  23 #include <linux/err.h>
  24 #include <linux/isa.h>
  25 #include <linux/interrupt.h>
  26 #include <linux/pm.h>
  27 #include <linux/slab.h>
  28 #include <linux/pnp.h>
  29 #include <linux/moduleparam.h>
  30 #include <sound/core.h>
  31 #include <sound/wss.h>
  32 #include <sound/mpu401.h>
  33 #include <sound/opl3.h>
  34 #include <sound/initval.h>
  35 #include <sound/tlv.h>
  36
  37 #include <asm/io.h>
  38
  39 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
  40 MODULE_DESCRIPTION("Yamaha OPL3SA2+");
  41 MODULE_LICENSE("GPL");
  42 MODULE_SUPPORTED_DEVICE("{{Yamaha,YMF719E-S},"
  43                 "{Genius,Sound Maker 3DX},"
  44                 "{Yamaha,OPL3SA3},"
  45                 "{Intel,AL440LX sound},"
  46                 "{NeoMagic,MagicWave 3DX}}");
  47
  48 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  49 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  50 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
  51 #ifdef CONFIG_PNP
  52 static int isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
  53 #endif
  54 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0xf86,0x370,0x100 */
  55 static long sb_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x220,0x240,0x260 */
  56 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x530,0xe80,0xf40,0x604 */
  57 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x388 */
  58 static long midi_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x330,0x300 */
  59 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 0,1,3,5,9,11,12,15 */
  60 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
  61 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
  62 static int opl3sa3_ymode[SNDRV_CARDS];   /* 0,1,2,3 */ /*SL Added*/
  63
  64 module_param_array(index, int, NULL, 0444);
  65 MODULE_PARM_DESC(index, "Index value for OPL3-SA soundcard.");
  66 module_param_array(id, charp, NULL, 0444);
  67 MODULE_PARM_DESC(id, "ID string for OPL3-SA soundcard.");
  68 module_param_array(enable, bool, NULL, 0444);
  69 MODULE_PARM_DESC(enable, "Enable OPL3-SA soundcard.");
  70 #ifdef CONFIG_PNP
  71 module_param_array(isapnp, bool, NULL, 0444);
  72 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
  73 #endif
  74 module_param_array(port, long, NULL, 0444);
  75 MODULE_PARM_DESC(port, "Port # for OPL3-SA driver.");
  76 module_param_array(sb_port, long, NULL, 0444);
  77 MODULE_PARM_DESC(sb_port, "SB port # for OPL3-SA driver.");
  78 module_param_array(wss_port, long, NULL, 0444);
  79 MODULE_PARM_DESC(wss_port, "WSS port # for OPL3-SA driver.");
  80 module_param_array(fm_port, long, NULL, 0444);
  81 MODULE_PARM_DESC(fm_port, "FM port # for OPL3-SA driver.");
  82 module_param_array(midi_port, long, NULL, 0444);
  83 MODULE_PARM_DESC(midi_port, "MIDI port # for OPL3-SA driver.");
  84 module_param_array(irq, int, NULL, 0444);
  85 MODULE_PARM_DESC(irq, "IRQ # for OPL3-SA driver.");
  86 module_param_array(dma1, int, NULL, 0444);
  87 MODULE_PARM_DESC(dma1, "DMA1 # for OPL3-SA driver.");
  88 module_param_array(dma2, int, NULL, 0444);
  89 MODULE_PARM_DESC(dma2, "DMA2 # for OPL3-SA driver.");
  90 module_param_array(opl3sa3_ymode, int, NULL, 0444);
  91 MODULE_PARM_DESC(opl3sa3_ymode, "Speaker size selection for 3D Enhancement mode: Desktop/Large Notebook/Small Notebook/HiFi.");
  92
  93 #ifdef CONFIG_PNP
  94 static int isa_registered;
  95 static int pnp_registered;
  96 static int pnpc_registered;
  97 #endif
  98
  99 /* control ports */
 100 #define OPL3SA2_PM_CTRL         0x01
 101 #define OPL3SA2_SYS_CTRL                0x02
 102 #define OPL3SA2_IRQ_CONFIG      0x03
 103 #define OPL3SA2_IRQ_STATUS      0x04
 104 #define OPL3SA2_DMA_CONFIG      0x06
 105 #define OPL3SA2_MASTER_LEFT     0x07
 106 #define OPL3SA2_MASTER_RIGHT    0x08
 107 #define OPL3SA2_MIC             0x09
 108 #define OPL3SA2_MISC            0x0A
 109
 110 /* opl3sa3 only */
 111 #define OPL3SA3_DGTL_DOWN       0x12
 112 #define OPL3SA3_ANLG_DOWN       0x13
 113 #define OPL3SA3_WIDE            0x14
 114 #define OPL3SA3_BASS            0x15
 115 #define OPL3SA3_TREBLE          0x16
 116
 117 /* power management bits */
 118 #define OPL3SA2_PM_ADOWN                0x20
 119 #define OPL3SA2_PM_PSV          0x04
 120 #define OPL3SA2_PM_PDN          0x02
 121 #define OPL3SA2_PM_PDX          0x01
 122
 123 #define OPL3SA2_PM_D0   0x00
 124 #define OPL3SA2_PM_D3   (OPL3SA2_PM_ADOWN|OPL3SA2_PM_PSV|OPL3SA2_PM_PDN|OPL3SA2_PM_PDX)
 125
 126 struct snd_opl3sa2 {
 127         int version;            /* 2 or 3 */
 128         unsigned long port;     /* control port */
 129         struct resource *res_port; /* control port resource */
 130         int irq;
 131         int single_dma;
 132         spinlock_t reg_lock;
 133         struct snd_hwdep *synth;
 134         struct snd_rawmidi *rmidi;
 135         struct snd_wss *wss;
 136         unsigned char ctlregs[0x20];
 137         int ymode;              /* SL added */
 138         struct snd_kcontrol *master_switch;
 139         struct snd_kcontrol *master_volume;
 140 };
 141
 142 #define PFX     "opl3sa2: "
 143
 144 #ifdef CONFIG_PNP
 145
 146 static struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
 147         { .id = "YMH0021" },
 148         { .id = "NMX2210" },    /* Gateway Solo 2500 */
 149         { .id = "" }            /* end */
 150 };
 151
 152 MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);
 153
 154 static struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
 155         /* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
 156         { .id = "YMH0020", .devs = { { "YMH0021" } } },
 157         /* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
 158         { .id = "YMH0030", .devs = { { "YMH0021" } } },
 159         /* Yamaha OPL3-SA2 */
 160         { .id = "YMH0800", .devs = { { "YMH0021" } } },
 161         /* Yamaha OPL3-SA2 */
 162         { .id = "YMH0801", .devs = { { "YMH0021" } } },
 163         /* NeoMagic MagicWave 3DX */
 164         { .id = "NMX2200", .devs = { { "YMH2210" } } },
 165         /* NeoMagic MagicWave 3D */
 166         { .id = "NMX2200", .devs = { { "NMX2210" } } },
 167         /* --- */
 168         { .id = "" }    /* end */
 169 };
 170
 171 MODULE_DEVICE_TABLE(pnp_card, snd_opl3sa2_pnpids);
 172
 173 #endif /* CONFIG_PNP */
 174
 175
 176 /* read control port (w/o spinlock) */
 177 static unsigned char __snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
 178 {
 179         unsigned char result;
 180 #if 0
 181         outb(0x1d, port);       /* password */
 182         printk("read [0x%lx] = 0x%x\n", port, inb(port));
 183 #endif
 184         outb(reg, chip->port);  /* register */
 185         result = inb(chip->port + 1);
 186 #if 0
 187         printk("read [0x%lx] = 0x%x [0x%x]\n", port, result, inb(port));
 188 #endif
 189         return result;
 190 }
 191
 192 /* read control port (with spinlock) */
 193 static unsigned char snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
 194 {
 195         unsigned long flags;
 196         unsigned char result;
 197
 198         spin_lock_irqsave(&chip->reg_lock, flags);
 199         result = __snd_opl3sa2_read(chip, reg);
 200         spin_unlock_irqrestore(&chip->reg_lock, flags);
 201         return result;
 202 }
 203
 204 /* write control port (w/o spinlock) */
 205 static void __snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
 206 {
 207 #if 0
 208         outb(0x1d, port);       /* password */
 209 #endif
 210         outb(reg, chip->port);  /* register */
 211         outb(value, chip->port + 1);
 212         chip->ctlregs[reg] = value;
 213 }
 214
 215 /* write control port (with spinlock) */
 216 static void snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
 217 {
 218         unsigned long flags;
 219         spin_lock_irqsave(&chip->reg_lock, flags);
 220         __snd_opl3sa2_write(chip, reg, value);
 221         spin_unlock_irqrestore(&chip->reg_lock, flags);
 222 }
 223
 224 static int __devinit snd_opl3sa2_detect(struct snd_card *card)
 225 {
 226         struct snd_opl3sa2 *chip = card->private_data;
 227         unsigned long port;
 228         unsigned char tmp, tmp1;
 229         char str[2];
 230
 231         port = chip->port;
 232         if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
 233                 snd_printk(KERN_ERR PFX "can't grab port 0x%lx\n", port);
 234                 return -EBUSY;
 235         }
 236         // snd_printk("REG 0A = 0x%x\n", snd_opl3sa2_read(chip, 0x0a));
 237         chip->version = 0;
 238         tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
 239         if (tmp == 0xff) {
 240                 snd_printd("OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
 241                 return -ENODEV;
 242         }
 243         switch (tmp & 0x07) {
 244         case 0x01:
 245                 chip->version = 2; /* YMF711 */
 246                 break;
 247         default:
 248                 chip->version = 3;
 249                 /* 0x02 - standard */
 250                 /* 0x03 - YM715B */
 251                 /* 0x04 - YM719 - OPL-SA4? */
 252                 /* 0x05 - OPL3-SA3 - Libretto 100 */
 253                 /* 0x07 - unknown - Neomagic MagicWave 3D */
 254                 break;
 255         }
 256         str[0] = chip->version + '0';
 257         str[1] = 0;
 258         strcat(card->shortname, str);
 259         snd_opl3sa2_write(chip, OPL3SA2_MISC, tmp ^ 7);
 260         if ((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MISC)) != tmp) {
 261                 snd_printd("OPL3-SA [0x%lx] detect (1) = 0x%x (0x%x)\n", port, tmp, tmp1);
 262                 return -ENODEV;
 263         }
 264         /* try if the MIC register is accesible */
 265         tmp = snd_opl3sa2_read(chip, OPL3SA2_MIC);
 266         snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x8a);
 267         if (((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MIC)) & 0x9f) != 0x8a) {
 268                 snd_printd("OPL3-SA [0x%lx] detect (2) = 0x%x (0x%x)\n", port, tmp, tmp1);
 269                 return -ENODEV;
 270         }
 271         snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x9f);
 272         /* initialization */
 273         /* Power Management - full on */
 274         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
 275         if (chip->version > 2) {
 276                 /* ymode is bits 4&5 (of 0 to 7) on all but opl3sa2 versions */
 277                 snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, (chip->ymode << 4));
 278         } else {
 279                 /* default for opl3sa2 versions */
 280                 snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, 0x00);
 281         }
 282         snd_opl3sa2_write(chip, OPL3SA2_IRQ_CONFIG, 0x0d);      /* Interrupt Channel Configuration - IRQ A = OPL3 + MPU + WSS */
 283         if (chip->single_dma) {
 284                 snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x03);      /* DMA Configuration - DMA A = WSS-R + WSS-P */
 285         } else {
 286                 snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x21);      /* DMA Configuration - DMA B = WSS-R, DMA A = WSS-P */
 287         }
 288         snd_opl3sa2_write(chip, OPL3SA2_MISC, 0x80 | (tmp & 7));        /* Miscellaneous - default */
 289         if (chip->version > 2) {
 290                 snd_opl3sa2_write(chip, OPL3SA3_DGTL_DOWN, 0x00);       /* Digital Block Partial Power Down - default */
 291                 snd_opl3sa2_write(chip, OPL3SA3_ANLG_DOWN, 0x00);       /* Analog Block Partial Power Down - default */
 292         }
 293         return 0;
 294 }
 295
 296 static irqreturn_t snd_opl3sa2_interrupt(int irq, void *dev_id)
 297 {
 298         unsigned short status;
 299         struct snd_card *card = dev_id;
 300         struct snd_opl3sa2 *chip;
 301         int handled = 0;
 302
 303         if (card == NULL)
 304                 return IRQ_NONE;
 305
 306         chip = card->private_data;
 307         status = snd_opl3sa2_read(chip, OPL3SA2_IRQ_STATUS);
 308
 309         if (status & 0x20) {
 310                 handled = 1;
 311                 snd_opl3_interrupt(chip->synth);
 312         }
 313
 314         if ((status & 0x10) && chip->rmidi != NULL) {
 315                 handled = 1;
 316                 snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
 317         }
 318
 319         if (status & 0x07) {    /* TI,CI,PI */
 320                 handled = 1;
 321                 snd_wss_interrupt(irq, chip->wss);
 322         }
 323
 324         if (status & 0x40) { /* hardware volume change */
 325                 handled = 1;
 326                 /* reading from Master Lch register at 0x07 clears this bit */
 327                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_RIGHT);
 328                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_LEFT);
 329                 if (chip->master_switch && chip->master_volume) {
 330                         snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
 331                                         &chip->master_switch->id);
 332                         snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
 333                                         &chip->master_volume->id);
 334                 }
 335         }
 336         return IRQ_RETVAL(handled);
 337 }
 338
 339 #define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
 340 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 341   .info = snd_wss_info_single, \
 342   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
 343   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
 344 #define OPL3SA2_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
 345 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
 346   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
 347   .name = xname, .index = xindex, \
 348   .info = snd_wss_info_single, \
 349   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
 350   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
 351   .tlv = { .p = (xtlv) } }
 352
 353 static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 354 {
 355         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 356         unsigned long flags;
 357         int reg = kcontrol->private_value & 0xff;
 358         int shift = (kcontrol->private_value >> 8) & 0xff;
 359         int mask = (kcontrol->private_value >> 16) & 0xff;
 360         int invert = (kcontrol->private_value >> 24) & 0xff;
 361
 362         spin_lock_irqsave(&chip->reg_lock, flags);
 363         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
 364         spin_unlock_irqrestore(&chip->reg_lock, flags);
 365         if (invert)
 366                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 367         return 0;
 368 }
 369
 370 static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 371 {
 372         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 373         unsigned long flags;
 374         int reg = kcontrol->private_value & 0xff;
 375         int shift = (kcontrol->private_value >> 8) & 0xff;
 376         int mask = (kcontrol->private_value >> 16) & 0xff;
 377         int invert = (kcontrol->private_value >> 24) & 0xff;
 378         int change;
 379         unsigned short val, oval;
 380
 381         val = (ucontrol->value.integer.value[0] & mask);
 382         if (invert)
 383                 val = mask - val;
 384         val <<= shift;
 385         spin_lock_irqsave(&chip->reg_lock, flags);
 386         oval = chip->ctlregs[reg];
 387         val = (oval & ~(mask << shift)) | val;
 388         change = val != oval;
 389         __snd_opl3sa2_write(chip, reg, val);
 390         spin_unlock_irqrestore(&chip->reg_lock, flags);
 391         return change;
 392 }
 393
 394 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
 395 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 396   .info = snd_wss_info_double, \
 397   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
 398   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
 399 #define OPL3SA2_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
 400 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
 401   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
 402   .name = xname, .index = xindex, \
 403   .info = snd_wss_info_double, \
 404   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
 405   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
 406   .tlv = { .p = (xtlv) } }
 407
 408 static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 409 {
 410         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 411         unsigned long flags;
 412         int left_reg = kcontrol->private_value & 0xff;
 413         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 414         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 415         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 416         int mask = (kcontrol->private_value >> 24) & 0xff;
 417         int invert = (kcontrol->private_value >> 22) & 1;
 418
 419         spin_lock_irqsave(&chip->reg_lock, flags);
 420         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
 421         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
 422         spin_unlock_irqrestore(&chip->reg_lock, flags);
 423         if (invert) {
 424                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 425                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
 426         }
 427         return 0;
 428 }
 429
 430 static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 431 {
 432         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 433         unsigned long flags;
 434         int left_reg = kcontrol->private_value & 0xff;
 435         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 436         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 437         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 438         int mask = (kcontrol->private_value >> 24) & 0xff;
 439         int invert = (kcontrol->private_value >> 22) & 1;
 440         int change;
 441         unsigned short val1, val2, oval1, oval2;
 442
 443         val1 = ucontrol->value.integer.value[0] & mask;
 444         val2 = ucontrol->value.integer.value[1] & mask;
 445         if (invert) {
 446                 val1 = mask - val1;
 447                 val2 = mask - val2;
 448         }
 449         val1 <<= shift_left;
 450         val2 <<= shift_right;
 451         spin_lock_irqsave(&chip->reg_lock, flags);
 452         if (left_reg != right_reg) {
 453                 oval1 = chip->ctlregs[left_reg];
 454                 oval2 = chip->ctlregs[right_reg];
 455                 val1 = (oval1 & ~(mask << shift_left)) | val1;
 456                 val2 = (oval2 & ~(mask << shift_right)) | val2;
 457                 change = val1 != oval1 || val2 != oval2;
 458                 __snd_opl3sa2_write(chip, left_reg, val1);
 459                 __snd_opl3sa2_write(chip, right_reg, val2);
 460         } else {
 461                 oval1 = chip->ctlregs[left_reg];
 462                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
 463                 change = val1 != oval1;
 464                 __snd_opl3sa2_write(chip, left_reg, val1);
 465         }
 466         spin_unlock_irqrestore(&chip->reg_lock, flags);
 467         return change;
 468 }
 469
 470 static const DECLARE_TLV_DB_SCALE(db_scale_master, -3000, 200, 0);
 471 static const DECLARE_TLV_DB_SCALE(db_scale_5bit_12db_max, -3450, 150, 0);
 472
 473 static struct snd_kcontrol_new snd_opl3sa2_controls[] = {
 474 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
 475 OPL3SA2_DOUBLE_TLV("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1,
 476                    db_scale_master),
 477 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
 478 OPL3SA2_SINGLE_TLV("Mic Playback Volume", 0, 0x09, 0, 31, 1,
 479                    db_scale_5bit_12db_max),
 480 };
 481
 482 static struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
 483 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
 484 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
 485 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
 486 };
 487
 488 static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
 489 {
 490         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 491         chip->master_switch = NULL;
 492         chip->master_volume = NULL;
 493 }
 494
 495 static int __devinit snd_opl3sa2_mixer(struct snd_card *card)
 496 {
 497         struct snd_opl3sa2 *chip = card->private_data;
 498         struct snd_ctl_elem_id id1, id2;
 499         struct snd_kcontrol *kctl;
 500         unsigned int idx;
 501         int err;
 502
 503         memset(&id1, 0, sizeof(id1));
 504         memset(&id2, 0, sizeof(id2));
 505         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 506         /* reassign AUX0 to CD */
 507         strcpy(id1.name, "Aux Playback Switch");
 508         strcpy(id2.name, "CD Playback Switch");
 509         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 510                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 511                 return err;
 512         }
 513         strcpy(id1.name, "Aux Playback Volume");
 514         strcpy(id2.name, "CD Playback Volume");
 515         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 516                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 517                 return err;
 518         }
 519         /* reassign AUX1 to FM */
 520         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
 521         strcpy(id2.name, "FM Playback Switch");
 522         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 523                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 524                 return err;
 525         }
 526         strcpy(id1.name, "Aux Playback Volume");
 527         strcpy(id2.name, "FM Playback Volume");
 528         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 529                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 530                 return err;
 531         }
 532         /* add OPL3SA2 controls */
 533         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
 534                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
 535                         return err;
 536                 switch (idx) {
 537                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 538                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 539                 }
 540         }
 541         if (chip->version > 2) {
 542                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
 543                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
 544                                 return err;
 545         }
 546         return 0;
 547 }
 548
 549 /* Power Management support functions */
 550 #ifdef CONFIG_PM
 551 static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
 552 {
 553         struct snd_opl3sa2 *chip = card->private_data;
 554
 555         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
 556         chip->wss->suspend(chip->wss);
 557         /* power down */
 558         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
 559
 560         return 0;
 561 }
 562
 563 static int snd_opl3sa2_resume(struct snd_card *card)
 564 {
 565         struct snd_opl3sa2 *chip = card->private_data;
 566         int i;
 567
 568         /* power up */
 569         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
 570
 571         /* restore registers */
 572         for (i = 2; i <= 0x0a; i++) {
 573                 if (i != OPL3SA2_IRQ_STATUS)
 574                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 575         }
 576         if (chip->version > 2) {
 577                 for (i = 0x12; i <= 0x16; i++)
 578                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 579         }
 580         /* restore wss */
 581         chip->wss->resume(chip->wss);
 582
 583         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
 584         return 0;
 585 }
 586 #endif /* CONFIG_PM */
 587
 588 #ifdef CONFIG_PNP
 589 static int __devinit snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
 590                                      struct pnp_dev *pdev)
 591 {
 592         if (pnp_activate_dev(pdev) < 0) {
 593                 snd_printk(KERN_ERR "PnP configure failure (out of resources?)\n");
 594                 return -EBUSY;
 595         }
 596         sb_port[dev] = pnp_port_start(pdev, 0);
 597         wss_port[dev] = pnp_port_start(pdev, 1);
 598         fm_port[dev] = pnp_port_start(pdev, 2);
 599         midi_port[dev] = pnp_port_start(pdev, 3);
 600         port[dev] = pnp_port_start(pdev, 4);
 601         dma1[dev] = pnp_dma(pdev, 0);
 602         dma2[dev] = pnp_dma(pdev, 1);
 603         irq[dev] = pnp_irq(pdev, 0);
 604         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
 605                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
 606         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
 607                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
 608         return 0;
 609 }
 610 #endif /* CONFIG_PNP */
 611
 612 static void snd_opl3sa2_free(struct snd_card *card)
 613 {
 614         struct snd_opl3sa2 *chip = card->private_data;
 615         if (chip->irq >= 0)
 616                 free_irq(chip->irq, (void *)chip);
 617         release_and_free_resource(chip->res_port);
 618 }
 619
 620 static struct snd_card *snd_opl3sa2_card_new(int dev)
 621 {
 622         struct snd_card *card;
 623         struct snd_opl3sa2 *chip;
 624
 625         card = snd_card_new(index[dev], id[dev], THIS_MODULE, sizeof(struct snd_opl3sa2));
 626         if (card == NULL)
 627                 return NULL;
 628         strcpy(card->driver, "OPL3SA2");
 629         strcpy(card->shortname, "Yamaha OPL3-SA2");
 630         chip = card->private_data;
 631         spin_lock_init(&chip->reg_lock);
 632         chip->irq = -1;
 633         card->private_free = snd_opl3sa2_free;
 634         return card;
 635 }
 636
 637 static int __devinit snd_opl3sa2_probe(struct snd_card *card, int dev)
 638 {
 639         int xirq, xdma1, xdma2;
 640         struct snd_opl3sa2 *chip;
 641         struct snd_wss *wss;
 642         struct snd_opl3 *opl3;
 643         int err;
 644
 645         /* initialise this card from supplied (or default) parameter*/
 646         chip = card->private_data;
 647         chip->ymode = opl3sa3_ymode[dev] & 0x03 ;
 648         chip->port = port[dev];
 649         xirq = irq[dev];
 650         xdma1 = dma1[dev];
 651         xdma2 = dma2[dev];
 652         if (xdma2 < 0)
 653                 chip->single_dma = 1;
 654         err = snd_opl3sa2_detect(card);
 655         if (err < 0)
 656                 return err;
 657         err = request_irq(xirq, snd_opl3sa2_interrupt, IRQF_DISABLED,
 658                           "OPL3-SA2", card);
 659         if (err) {
 660                 snd_printk(KERN_ERR PFX "can't grab IRQ %d\n", xirq);
 661                 return -ENODEV;
 662         }
 663         chip->irq = xirq;
 664         err = snd_wss_create(card,
 665                              wss_port[dev] + 4, -1,
 666                              xirq, xdma1, xdma2,
 667                              WSS_HW_OPL3SA2, WSS_HWSHARE_IRQ, &wss);
 668         if (err < 0) {
 669                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
 670                 return err;
 671         }
 672         chip->wss = wss;
 673         err = snd_wss_pcm(wss, 0, NULL);
 674         if (err < 0)
 675                 return err;
 676         err = snd_wss_mixer(wss);
 677         if (err < 0)
 678                 return err;
 679         err = snd_opl3sa2_mixer(card);
 680         if (err < 0)
 681                 return err;
 682         err = snd_wss_timer(wss, 0, NULL);
 683         if (err < 0)
 684                 return err;
 685         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
 686                 if ((err = snd_opl3_create(card, fm_port[dev],
 687                                            fm_port[dev] + 2,
 688                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
 689                         return err;
 690                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
 691                         return err;
 692                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
 693                         return err;
 694         }
 695         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
 696                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
 697                                                midi_port[dev], 0,
 698                                                xirq, 0, &chip->rmidi)) < 0)
 699                         return err;
 700         }
 701         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
 702                 card->shortname, chip->port, xirq, xdma1);
 703         if (xdma2 >= 0)
 704                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
 705
 706         return snd_card_register(card);
 707 }
 708
 709 #ifdef CONFIG_PNP
 710 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
 711                                             const struct pnp_device_id *id)
 712 {
 713         static int dev;
 714         int err;
 715         struct snd_card *card;
 716
 717         if (pnp_device_is_isapnp(pdev))
 718                 return -ENOENT; /* we have another procedure - card */
 719         for (; dev < SNDRV_CARDS; dev++) {
 720                 if (enable[dev] && isapnp[dev])
 721                         break;
 722         }
 723         if (dev >= SNDRV_CARDS)
 724                 return -ENODEV;
 725
 726         card = snd_opl3sa2_card_new(dev);
 727         if (! card)
 728                 return -ENOMEM;
 729         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
 730                 snd_card_free(card);
 731                 return err;
 732         }
 733         snd_card_set_dev(card, &pdev->dev);
 734         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
 735                 snd_card_free(card);
 736                 return err;
 737         }
 738         pnp_set_drvdata(pdev, card);
 739         dev++;
 740         return 0;
 741 }
 742
 743 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
 744 {
 745         snd_card_free(pnp_get_drvdata(pdev));
 746         pnp_set_drvdata(pdev, NULL);
 747 }
 748
 749 #ifdef CONFIG_PM
 750 static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
 751 {
 752         return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
 753 }
 754 static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
 755 {
 756         return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
 757 }
 758 #endif
 759
 760 static struct pnp_driver opl3sa2_pnp_driver = {
 761         .name = "snd-opl3sa2-pnpbios",
 762         .id_table = snd_opl3sa2_pnpbiosids,
 763         .probe = snd_opl3sa2_pnp_detect,
 764         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
 765 #ifdef CONFIG_PM
 766         .suspend = snd_opl3sa2_pnp_suspend,
 767         .resume = snd_opl3sa2_pnp_resume,
 768 #endif
 769 };
 770
 771 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
 772                                              const struct pnp_card_device_id *id)
 773 {
 774         static int dev;
 775         struct pnp_dev *pdev;
 776         int err;
 777         struct snd_card *card;
 778
 779         pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
 780         if (pdev == NULL) {
 781                 snd_printk(KERN_ERR PFX "can't get pnp device from id '%s'\n",
 782                            id->devs[0].id);
 783                 return -EBUSY;
 784         }
 785         for (; dev < SNDRV_CARDS; dev++) {
 786                 if (enable[dev] && isapnp[dev])
 787                         break;
 788         }
 789         if (dev >= SNDRV_CARDS)
 790                 return -ENODEV;
 791
 792         card = snd_opl3sa2_card_new(dev);
 793         if (! card)
 794                 return -ENOMEM;
 795         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
 796                 snd_card_free(card);
 797                 return err;
 798         }
 799         snd_card_set_dev(card, &pdev->dev);
 800         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
 801                 snd_card_free(card);
 802                 return err;
 803         }
 804         pnp_set_card_drvdata(pcard, card);
 805         dev++;
 806         return 0;
 807 }
 808
 809 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
 810 {
 811         snd_card_free(pnp_get_card_drvdata(pcard));
 812         pnp_set_card_drvdata(pcard, NULL);
 813 }
 814
 815 #ifdef CONFIG_PM
 816 static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
 817 {
 818         return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
 819 }
 820 static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
 821 {
 822         return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
 823 }
 824 #endif
 825
 826 static struct pnp_card_driver opl3sa2_pnpc_driver = {
 827         .flags = PNP_DRIVER_RES_DISABLE,
 828         .name = "snd-opl3sa2-cpnp",
 829         .id_table = snd_opl3sa2_pnpids,
 830         .probe = snd_opl3sa2_pnp_cdetect,
 831         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
 832 #ifdef CONFIG_PM
 833         .suspend = snd_opl3sa2_pnp_csuspend,
 834         .resume = snd_opl3sa2_pnp_cresume,
 835 #endif
 836 };
 837 #endif /* CONFIG_PNP */
 838
 839 static int __devinit snd_opl3sa2_isa_match(struct device *pdev,
 840                                            unsigned int dev)
 841 {
 842         if (!enable[dev])
 843                 return 0;
 844 #ifdef CONFIG_PNP
 845         if (isapnp[dev])
 846                 return 0;
 847 #endif
 848         if (port[dev] == SNDRV_AUTO_PORT) {
 849                 snd_printk(KERN_ERR PFX "specify port\n");
 850                 return 0;
 851         }
 852         if (wss_port[dev] == SNDRV_AUTO_PORT) {
 853                 snd_printk(KERN_ERR PFX "specify wss_port\n");
 854                 return 0;
 855         }
 856         if (fm_port[dev] == SNDRV_AUTO_PORT) {
 857                 snd_printk(KERN_ERR PFX "specify fm_port\n");
 858                 return 0;
 859         }
 860         if (midi_port[dev] == SNDRV_AUTO_PORT) {
 861                 snd_printk(KERN_ERR PFX "specify midi_port\n");
 862                 return 0;
 863         }
 864         return 1;
 865 }
 866
 867 static int __devinit snd_opl3sa2_isa_probe(struct device *pdev,
 868                                            unsigned int dev)
 869 {
 870         struct snd_card *card;
 871         int err;
 872
 873         card = snd_opl3sa2_card_new(dev);
 874         if (! card)
 875                 return -ENOMEM;
 876         snd_card_set_dev(card, pdev);
 877         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
 878                 snd_card_free(card);
 879                 return err;
 880         }
 881         dev_set_drvdata(pdev, card);
 882         return 0;
 883 }
 884
 885 static int __devexit snd_opl3sa2_isa_remove(struct device *devptr,
 886                                             unsigned int dev)
 887 {
 888         snd_card_free(dev_get_drvdata(devptr));
 889         dev_set_drvdata(devptr, NULL);
 890         return 0;
 891 }
 892
 893 #ifdef CONFIG_PM
 894 static int snd_opl3sa2_isa_suspend(struct device *dev, unsigned int n,
 895                                    pm_message_t state)
 896 {
 897         return snd_opl3sa2_suspend(dev_get_drvdata(dev), state);
 898 }
 899
 900 static int snd_opl3sa2_isa_resume(struct device *dev, unsigned int n)
 901 {
 902         return snd_opl3sa2_resume(dev_get_drvdata(dev));
 903 }
 904 #endif
 905
 906 #define DEV_NAME "opl3sa2"
 907
 908 static struct isa_driver snd_opl3sa2_isa_driver = {
 909         .match          = snd_opl3sa2_isa_match,
 910         .probe          = snd_opl3sa2_isa_probe,
 911         .remove         = __devexit_p(snd_opl3sa2_isa_remove),
 912 #ifdef CONFIG_PM
 913         .suspend        = snd_opl3sa2_isa_suspend,
 914         .resume         = snd_opl3sa2_isa_resume,
 915 #endif
 916         .driver         = {
 917                 .name   = DEV_NAME
 918         },
 919 };
 920
 921 static int __init alsa_card_opl3sa2_init(void)
 922 {
 923         int err;
 924
 925         err = isa_register_driver(&snd_opl3sa2_isa_driver, SNDRV_CARDS);
 926 #ifdef CONFIG_PNP
 927         if (!err)
 928                 isa_registered = 1;
 929
 930         err = pnp_register_driver(&opl3sa2_pnp_driver);
 931         if (!err)
 932                 pnp_registered = 1;
 933
 934         err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
 935         if (!err)
 936                 pnpc_registered = 1;
 937
 938         if (isa_registered || pnp_registered)
 939                 err = 0;
 940 #endif
 941         return err;
 942 }
 943
 944 static void __exit alsa_card_opl3sa2_exit(void)
 945 {
 946 #ifdef CONFIG_PNP
 947         if (pnpc_registered)
 948                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
 949         if (pnp_registered)
 950                 pnp_unregister_driver(&opl3sa2_pnp_driver);
 951         if (isa_registered)
 952 #endif
 953                 isa_unregister_driver(&snd_opl3sa2_isa_driver);
 954 }
 955
 956 module_init(alsa_card_opl3sa2_init)
 957 module_exit(alsa_card_opl3sa2_exit)