sound/isa/opl3sa2.c

   1 /*
   2  *  Driver for Yamaha OPL3-SA[2,3] soundcards
   3  *  Copyright (c) by Jaroslav Kysela <perex@suse.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 <sound/driver.h>
  23 #include <linux/init.h>
  24 #include <linux/interrupt.h>
  25 #include <linux/pm.h>
  26 #include <linux/slab.h>
  27 #include <linux/pnp.h>
  28 #include <linux/moduleparam.h>
  29 #include <sound/core.h>
  30 #include <sound/cs4231.h>
  31 #include <sound/mpu401.h>
  32 #include <sound/opl3.h>
  33 #include <sound/initval.h>
  34
  35 #include <asm/io.h>
  36
  37 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
  38 MODULE_DESCRIPTION("Yamaha OPL3SA2+");
  39 MODULE_LICENSE("GPL");
  40 MODULE_SUPPORTED_DEVICE("{{Yamaha,YMF719E-S},"
  41                 "{Genius,Sound Maker 3DX},"
  42                 "{Yamaha,OPL3SA3},"
  43                 "{Intel,AL440LX sound},"
  44                 "{NeoMagic,MagicWave 3DX}}");
  45
  46 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  47 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  48 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
  49 #ifdef CONFIG_PNP
  50 static int isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
  51 #endif
  52 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0xf86,0x370,0x100 */
  53 static long sb_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x220,0x240,0x260 */
  54 static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x530,0xe80,0xf40,0x604 */
  55 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x388 */
  56 static long midi_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x330,0x300 */
  57 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 0,1,3,5,9,11,12,15 */
  58 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
  59 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
  60 static int opl3sa3_ymode[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = 0 };   /* 0,1,2,3 */ /*SL Added*/
  61
  62 module_param_array(index, int, NULL, 0444);
  63 MODULE_PARM_DESC(index, "Index value for OPL3-SA soundcard.");
  64 module_param_array(id, charp, NULL, 0444);
  65 MODULE_PARM_DESC(id, "ID string for OPL3-SA soundcard.");
  66 module_param_array(enable, bool, NULL, 0444);
  67 MODULE_PARM_DESC(enable, "Enable OPL3-SA soundcard.");
  68 #ifdef CONFIG_PNP
  69 module_param_array(isapnp, bool, NULL, 0444);
  70 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
  71 #endif
  72 module_param_array(port, long, NULL, 0444);
  73 MODULE_PARM_DESC(port, "Port # for OPL3-SA driver.");
  74 module_param_array(sb_port, long, NULL, 0444);
  75 MODULE_PARM_DESC(sb_port, "SB port # for OPL3-SA driver.");
  76 module_param_array(wss_port, long, NULL, 0444);
  77 MODULE_PARM_DESC(wss_port, "WSS port # for OPL3-SA driver.");
  78 module_param_array(fm_port, long, NULL, 0444);
  79 MODULE_PARM_DESC(fm_port, "FM port # for OPL3-SA driver.");
  80 module_param_array(midi_port, long, NULL, 0444);
  81 MODULE_PARM_DESC(midi_port, "MIDI port # for OPL3-SA driver.");
  82 module_param_array(irq, int, NULL, 0444);
  83 MODULE_PARM_DESC(irq, "IRQ # for OPL3-SA driver.");
  84 module_param_array(dma1, int, NULL, 0444);
  85 MODULE_PARM_DESC(dma1, "DMA1 # for OPL3-SA driver.");
  86 module_param_array(dma2, int, NULL, 0444);
  87 MODULE_PARM_DESC(dma2, "DMA2 # for OPL3-SA driver.");
  88 module_param_array(opl3sa3_ymode, int, NULL, 0444);
  89 MODULE_PARM_DESC(opl3sa3_ymode, "Speaker size selection for 3D Enhancement mode: Desktop/Large Notebook/Small Notebook/HiFi.");
  90
  91 /* control ports */
  92 #define OPL3SA2_PM_CTRL         0x01
  93 #define OPL3SA2_SYS_CTRL                0x02
  94 #define OPL3SA2_IRQ_CONFIG      0x03
  95 #define OPL3SA2_IRQ_STATUS      0x04
  96 #define OPL3SA2_DMA_CONFIG      0x06
  97 #define OPL3SA2_MASTER_LEFT     0x07
  98 #define OPL3SA2_MASTER_RIGHT    0x08
  99 #define OPL3SA2_MIC             0x09
 100 #define OPL3SA2_MISC            0x0A
 101
 102 /* opl3sa3 only */
 103 #define OPL3SA3_DGTL_DOWN       0x12
 104 #define OPL3SA3_ANLG_DOWN       0x13
 105 #define OPL3SA3_WIDE            0x14
 106 #define OPL3SA3_BASS            0x15
 107 #define OPL3SA3_TREBLE          0x16
 108
 109 /* power management bits */
 110 #define OPL3SA2_PM_ADOWN                0x20
 111 #define OPL3SA2_PM_PSV          0x04
 112 #define OPL3SA2_PM_PDN          0x02
 113 #define OPL3SA2_PM_PDX          0x01
 114
 115 #define OPL3SA2_PM_D0   0x00
 116 #define OPL3SA2_PM_D3   (OPL3SA2_PM_ADOWN|OPL3SA2_PM_PSV|OPL3SA2_PM_PDN|OPL3SA2_PM_PDX)
 117
 118 typedef struct snd_opl3sa2 opl3sa2_t;
 119
 120 struct snd_opl3sa2 {
 121         snd_card_t *card;
 122         int version;            /* 2 or 3 */
 123         unsigned long port;     /* control port */
 124         struct resource *res_port; /* control port resource */
 125         int irq;
 126         int single_dma;
 127         spinlock_t reg_lock;
 128         snd_hwdep_t *synth;
 129         snd_rawmidi_t *rmidi;
 130         cs4231_t *cs4231;
 131 #ifdef CONFIG_PNP
 132         struct pnp_dev *dev;
 133 #endif
 134         unsigned char ctlregs[0x20];
 135         int ymode;              /* SL added */
 136         snd_kcontrol_t *master_switch;
 137         snd_kcontrol_t *master_volume;
 138 #ifdef CONFIG_PM
 139         void (*cs4231_suspend)(cs4231_t *);
 140         void (*cs4231_resume)(cs4231_t *);
 141 #endif
 142 };
 143
 144 static snd_card_t *snd_opl3sa2_legacy[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
 145
 146 #ifdef CONFIG_PNP
 147
 148 static struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
 149         { .id = "YMH0021" },
 150         { .id = "NMX2210" },    /* Gateway Solo 2500 */
 151         { .id = "" }            /* end */
 152 };
 153
 154 MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);
 155
 156 static struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
 157         /* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
 158         { .id = "YMH0020", .devs = { { "YMH0021" } } },
 159         /* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
 160         { .id = "YMH0030", .devs = { { "YMH0021" } } },
 161         /* Yamaha OPL3-SA2 */
 162         { .id = "YMH0800", .devs = { { "YMH0021" } } },
 163         /* Yamaha OPL3-SA2 */
 164         { .id = "YMH0801", .devs = { { "YMH0021" } } },
 165         /* NeoMagic MagicWave 3DX */
 166         { .id = "NMX2200", .devs = { { "YMH2210" } } },
 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(opl3sa2_t *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(opl3sa2_t *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(opl3sa2_t *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(opl3sa2_t *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 __init snd_opl3sa2_detect(opl3sa2_t *chip)
 225 {
 226         snd_card_t *card;
 227         unsigned long port;
 228         unsigned char tmp, tmp1;
 229         char str[2];
 230
 231         card = chip->card;
 232         port = chip->port;
 233         if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
 234                 snd_printk(KERN_ERR "opl3sa2: can't grab port 0x%lx\n", port);
 235                 return -EBUSY;
 236         }
 237         // snd_printk("REG 0A = 0x%x\n", snd_opl3sa2_read(chip, 0x0a));
 238         chip->version = 0;
 239         tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
 240         if (tmp == 0xff) {
 241                 snd_printd("OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
 242                 return -ENODEV;
 243         }
 244         switch (tmp & 0x07) {
 245         case 0x01:
 246                 chip->version = 2; /* YMF711 */
 247                 break;
 248         default:
 249                 chip->version = 3;
 250                 /* 0x02 - standard */
 251                 /* 0x03 - YM715B */
 252                 /* 0x04 - YM719 - OPL-SA4? */
 253                 /* 0x05 - OPL3-SA3 - Libretto 100 */
 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, struct pt_regs *regs)
 297 {
 298         unsigned short status;
 299         opl3sa2_t *chip = dev_id;
 300         int handled = 0;
 301
 302         if (chip == NULL || chip->card == NULL)
 303                 return IRQ_NONE;
 304
 305         status = snd_opl3sa2_read(chip, OPL3SA2_IRQ_STATUS);
 306
 307         if (status & 0x20) {
 308                 handled = 1;
 309                 snd_opl3_interrupt(chip->synth);
 310         }
 311
 312         if ((status & 0x10) && chip->rmidi != NULL) {
 313                 handled = 1;
 314                 snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data, regs);
 315         }
 316
 317         if (status & 0x07) {    /* TI,CI,PI */
 318                 handled = 1;
 319                 snd_cs4231_interrupt(irq, chip->cs4231, regs);
 320         }
 321
 322         if (status & 0x40) { /* hardware volume change */
 323                 handled = 1;
 324                 /* reading from Master Lch register at 0x07 clears this bit */
 325                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_RIGHT);
 326                 snd_opl3sa2_read(chip, OPL3SA2_MASTER_LEFT);
 327                 if (chip->master_switch && chip->master_volume) {
 328                         snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE, &chip->master_switch->id);
 329                         snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE, &chip->master_volume->id);
 330                 }
 331         }
 332         return IRQ_RETVAL(handled);
 333 }
 334
 335 #define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
 336 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 337   .info = snd_opl3sa2_info_single, \
 338   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
 339   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
 340
 341 static int snd_opl3sa2_info_single(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
 342 {
 343         int mask = (kcontrol->private_value >> 16) & 0xff;
 344
 345         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
 346         uinfo->count = 1;
 347         uinfo->value.integer.min = 0;
 348         uinfo->value.integer.max = mask;
 349         return 0;
 350 }
 351
 352 static int snd_opl3sa2_get_single(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 353 {
 354         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 355         unsigned long flags;
 356         int reg = kcontrol->private_value & 0xff;
 357         int shift = (kcontrol->private_value >> 8) & 0xff;
 358         int mask = (kcontrol->private_value >> 16) & 0xff;
 359         int invert = (kcontrol->private_value >> 24) & 0xff;
 360
 361         spin_lock_irqsave(&chip->reg_lock, flags);
 362         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
 363         spin_unlock_irqrestore(&chip->reg_lock, flags);
 364         if (invert)
 365                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 366         return 0;
 367 }
 368
 369 static int snd_opl3sa2_put_single(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 370 {
 371         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 372         unsigned long flags;
 373         int reg = kcontrol->private_value & 0xff;
 374         int shift = (kcontrol->private_value >> 8) & 0xff;
 375         int mask = (kcontrol->private_value >> 16) & 0xff;
 376         int invert = (kcontrol->private_value >> 24) & 0xff;
 377         int change;
 378         unsigned short val, oval;
 379
 380         val = (ucontrol->value.integer.value[0] & mask);
 381         if (invert)
 382                 val = mask - val;
 383         val <<= shift;
 384         spin_lock_irqsave(&chip->reg_lock, flags);
 385         oval = chip->ctlregs[reg];
 386         val = (oval & ~(mask << shift)) | val;
 387         change = val != oval;
 388         __snd_opl3sa2_write(chip, reg, val);
 389         spin_unlock_irqrestore(&chip->reg_lock, flags);
 390         return change;
 391 }
 392
 393 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
 394 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 395   .info = snd_opl3sa2_info_double, \
 396   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
 397   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
 398
 399 static int snd_opl3sa2_info_double(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
 400 {
 401         int mask = (kcontrol->private_value >> 24) & 0xff;
 402
 403         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
 404         uinfo->count = 2;
 405         uinfo->value.integer.min = 0;
 406         uinfo->value.integer.max = mask;
 407         return 0;
 408 }
 409
 410 static int snd_opl3sa2_get_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 411 {
 412         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 413         unsigned long flags;
 414         int left_reg = kcontrol->private_value & 0xff;
 415         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 416         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 417         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 418         int mask = (kcontrol->private_value >> 24) & 0xff;
 419         int invert = (kcontrol->private_value >> 22) & 1;
 420
 421         spin_lock_irqsave(&chip->reg_lock, flags);
 422         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
 423         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
 424         spin_unlock_irqrestore(&chip->reg_lock, flags);
 425         if (invert) {
 426                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 427                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
 428         }
 429         return 0;
 430 }
 431
 432 static int snd_opl3sa2_put_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 433 {
 434         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 435         unsigned long flags;
 436         int left_reg = kcontrol->private_value & 0xff;
 437         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 438         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 439         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 440         int mask = (kcontrol->private_value >> 24) & 0xff;
 441         int invert = (kcontrol->private_value >> 22) & 1;
 442         int change;
 443         unsigned short val1, val2, oval1, oval2;
 444
 445         val1 = ucontrol->value.integer.value[0] & mask;
 446         val2 = ucontrol->value.integer.value[1] & mask;
 447         if (invert) {
 448                 val1 = mask - val1;
 449                 val2 = mask - val2;
 450         }
 451         val1 <<= shift_left;
 452         val2 <<= shift_right;
 453         spin_lock_irqsave(&chip->reg_lock, flags);
 454         if (left_reg != right_reg) {
 455                 oval1 = chip->ctlregs[left_reg];
 456                 oval2 = chip->ctlregs[right_reg];
 457                 val1 = (oval1 & ~(mask << shift_left)) | val1;
 458                 val2 = (oval2 & ~(mask << shift_right)) | val2;
 459                 change = val1 != oval1 || val2 != oval2;
 460                 __snd_opl3sa2_write(chip, left_reg, val1);
 461                 __snd_opl3sa2_write(chip, right_reg, val2);
 462         } else {
 463                 oval1 = chip->ctlregs[left_reg];
 464                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
 465                 change = val1 != oval1;
 466                 __snd_opl3sa2_write(chip, left_reg, val1);
 467         }
 468         spin_unlock_irqrestore(&chip->reg_lock, flags);
 469         return change;
 470 }
 471
 472 static snd_kcontrol_new_t snd_opl3sa2_controls[] = {
 473 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
 474 OPL3SA2_DOUBLE("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1),
 475 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
 476 OPL3SA2_SINGLE("Mic Playback Volume", 0, 0x09, 0, 31, 1)
 477 };
 478
 479 static snd_kcontrol_new_t snd_opl3sa2_tone_controls[] = {
 480 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
 481 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
 482 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
 483 };
 484
 485 static void snd_opl3sa2_master_free(snd_kcontrol_t *kcontrol)
 486 {
 487         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 488         chip->master_switch = NULL;
 489         chip->master_volume = NULL;
 490 }
 491
 492 static int __init snd_opl3sa2_mixer(opl3sa2_t *chip)
 493 {
 494         snd_card_t *card = chip->card;
 495         snd_ctl_elem_id_t id1, id2;
 496         snd_kcontrol_t *kctl;
 497         unsigned int idx;
 498         int err;
 499
 500         memset(&id1, 0, sizeof(id1));
 501         memset(&id2, 0, sizeof(id2));
 502         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 503         /* reassign AUX0 to CD */
 504         strcpy(id1.name, "Aux Playback Switch");
 505         strcpy(id2.name, "CD Playback Switch");
 506         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 507                 return err;
 508         strcpy(id1.name, "Aux Playback Volume");
 509         strcpy(id2.name, "CD Playback Volume");
 510         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 511                 return err;
 512         /* reassign AUX1 to FM */
 513         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
 514         strcpy(id2.name, "FM Playback Switch");
 515         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 516                 return err;
 517         strcpy(id1.name, "Aux Playback Volume");
 518         strcpy(id2.name, "FM Playback Volume");
 519         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 520                 return err;
 521         /* add OPL3SA2 controls */
 522         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
 523                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
 524                         return err;
 525                 switch (idx) {
 526                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 527                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 528                 }
 529         }
 530         if (chip->version > 2) {
 531                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
 532                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
 533                                 return err;
 534         }
 535         return 0;
 536 }
 537
 538 /* Power Management support functions */
 539 #ifdef CONFIG_PM
 540 static int snd_opl3sa2_suspend(snd_card_t *card, pm_message_t state)
 541 {
 542         opl3sa2_t *chip = card->pm_private_data;
 543
 544         snd_pcm_suspend_all(chip->cs4231->pcm); /* stop before saving regs */
 545         chip->cs4231_suspend(chip->cs4231);
 546
 547         /* power down */
 548         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
 549
 550         return 0;
 551 }
 552
 553 static int snd_opl3sa2_resume(snd_card_t *card)
 554 {
 555         opl3sa2_t *chip = card->pm_private_data;
 556         int i;
 557
 558         /* power up */
 559         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
 560
 561         /* restore registers */
 562         for (i = 2; i <= 0x0a; i++) {
 563                 if (i != OPL3SA2_IRQ_STATUS)
 564                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 565         }
 566         if (chip->version > 2) {
 567                 for (i = 0x12; i <= 0x16; i++)
 568                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 569         }
 570         /* restore cs4231 */
 571         chip->cs4231_resume(chip->cs4231);
 572
 573         return 0;
 574 }
 575 #endif /* CONFIG_PM */
 576
 577 #ifdef CONFIG_PNP
 578 static int __init snd_opl3sa2_pnp(int dev, opl3sa2_t *chip,
 579                                   struct pnp_dev *pdev,
 580                                   int isapnp)
 581 {
 582         struct pnp_resource_table * cfg;
 583         int err;
 584
 585         if (!isapnp && pnp_device_is_isapnp(pdev))
 586                 return -ENOENT; /* we have another procedure - card */
 587
 588         cfg = kmalloc(sizeof(struct pnp_resource_table), GFP_KERNEL);
 589         if (!cfg)
 590                 return -ENOMEM;
 591         /* PnP initialization */
 592         pnp_init_resource_table(cfg);
 593         if (sb_port[dev] != SNDRV_AUTO_PORT)
 594                 pnp_resource_change(&cfg->port_resource[0], sb_port[dev], 16);
 595         if (wss_port[dev] != SNDRV_AUTO_PORT)
 596                 pnp_resource_change(&cfg->port_resource[1], wss_port[dev], 8);
 597         if (fm_port[dev] != SNDRV_AUTO_PORT)
 598                 pnp_resource_change(&cfg->port_resource[2], fm_port[dev], 4);
 599         if (midi_port[dev] != SNDRV_AUTO_PORT)
 600                 pnp_resource_change(&cfg->port_resource[3], midi_port[dev], 2);
 601         if (port[dev] != SNDRV_AUTO_PORT)
 602                 pnp_resource_change(&cfg->port_resource[4], port[dev], 2);
 603         if (dma1[dev] != SNDRV_AUTO_DMA)
 604                 pnp_resource_change(&cfg->dma_resource[0], dma1[dev], 1);
 605         if (dma2[dev] != SNDRV_AUTO_DMA)
 606                 pnp_resource_change(&cfg->dma_resource[1], dma2[dev], 1);
 607         if (irq[dev] != SNDRV_AUTO_IRQ)
 608                 pnp_resource_change(&cfg->irq_resource[0], irq[dev], 1);
 609         err = pnp_manual_config_dev(pdev, cfg, 0);
 610         if (err < 0 && isapnp)
 611                 snd_printk(KERN_ERR "PnP manual resources are invalid, using auto config\n");
 612         err = pnp_activate_dev(pdev);
 613         if (err < 0) {
 614                 kfree(cfg);
 615                 snd_printk(KERN_ERR "PnP configure failure (out of resources?) err = %d\n", err);
 616                 return -EBUSY;
 617         }
 618         sb_port[dev] = pnp_port_start(pdev, 0);
 619         wss_port[dev] = pnp_port_start(pdev, 1);
 620         fm_port[dev] = pnp_port_start(pdev, 2);
 621         midi_port[dev] = pnp_port_start(pdev, 3);
 622         port[dev] = pnp_port_start(pdev, 4);
 623         dma1[dev] = pnp_dma(pdev, 0);
 624         dma2[dev] = pnp_dma(pdev, 1);
 625         irq[dev] = pnp_irq(pdev, 0);
 626         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
 627                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
 628         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
 629                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
 630         kfree(cfg);
 631         chip->dev = pdev;
 632         return 0;
 633 }
 634
 635 static int __init snd_opl3sa2_cpnp(int dev, opl3sa2_t *chip,
 636                                    struct pnp_card_link *card,
 637                                    const struct pnp_card_device_id *id)
 638 {
 639         struct pnp_dev *pdev;
 640         struct pnp_resource_table * cfg = kmalloc(sizeof(struct pnp_resource_table), GFP_KERNEL);
 641
 642         if (!cfg)
 643                 return -ENOMEM;
 644         pdev = pnp_request_card_device(card, id->devs[0].id, NULL);
 645         if (pdev == NULL) {
 646                 kfree(cfg);
 647                 return -EBUSY;
 648         }
 649         return snd_opl3sa2_pnp(dev, chip, pdev, 1);
 650 }
 651 #endif /* CONFIG_PNP */
 652
 653 static int snd_opl3sa2_free(opl3sa2_t *chip)
 654 {
 655         if (chip->irq >= 0)
 656                 free_irq(chip->irq, (void *)chip);
 657         if (chip->res_port) {
 658                 release_resource(chip->res_port);
 659                 kfree_nocheck(chip->res_port);
 660         }
 661         kfree(chip);
 662         return 0;
 663 }
 664
 665 static int snd_opl3sa2_dev_free(snd_device_t *device)
 666 {
 667         opl3sa2_t *chip = device->device_data;
 668         return snd_opl3sa2_free(chip);
 669 }
 670
 671 static int __devinit snd_opl3sa2_probe(int dev,
 672                                        struct pnp_dev *pdev,
 673                                        struct pnp_card_link *pcard,
 674                                        const struct pnp_card_device_id *pid)
 675 {
 676         int xirq, xdma1, xdma2;
 677         snd_card_t *card;
 678         struct snd_opl3sa2 *chip;
 679         cs4231_t *cs4231;
 680         opl3_t *opl3;
 681         static snd_device_ops_t ops = {
 682                 .dev_free =     snd_opl3sa2_dev_free,
 683         };
 684         int err;
 685
 686 #ifdef CONFIG_PNP
 687         if (!isapnp[dev]) {
 688 #endif
 689                 if (port[dev] == SNDRV_AUTO_PORT) {
 690                         snd_printk("specify port\n");
 691                         return -EINVAL;
 692                 }
 693                 if (wss_port[dev] == SNDRV_AUTO_PORT) {
 694                         snd_printk("specify wss_port\n");
 695                         return -EINVAL;
 696                 }
 697                 if (fm_port[dev] == SNDRV_AUTO_PORT) {
 698                         snd_printk("specify fm_port\n");
 699                         return -EINVAL;
 700                 }
 701                 if (midi_port[dev] == SNDRV_AUTO_PORT) {
 702                         snd_printk("specify midi_port\n");
 703                         return -EINVAL;
 704                 }
 705 #ifdef CONFIG_PNP
 706         }
 707 #endif
 708         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 709         if (card == NULL)
 710                 return -ENOMEM;
 711         strcpy(card->driver, "OPL3SA2");
 712         strcpy(card->shortname, "Yamaha OPL3-SA2");
 713         chip = kcalloc(1, sizeof(*chip), GFP_KERNEL);
 714         if (chip == NULL) {
 715                 err = -ENOMEM;
 716                 goto __error;
 717         }
 718         spin_lock_init(&chip->reg_lock);
 719         chip->irq = -1;
 720         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0)
 721                 goto __error;
 722 #ifdef CONFIG_PNP
 723         if (pdev) {
 724                 if ((err = snd_opl3sa2_pnp(dev, chip, pdev, 0)) < 0)
 725                         goto __error;
 726                 snd_card_set_dev(card, &pdev->dev);
 727         }
 728         if (pcard) {
 729                 if ((err = snd_opl3sa2_cpnp(dev, chip, pcard, pid)) < 0)
 730                         goto __error;
 731                 snd_card_set_dev(card, &pcard->card->dev);
 732         }
 733 #endif
 734         chip->ymode = opl3sa3_ymode[dev] & 0x03 ; /* initialise this card from supplied (or default) parameter*/
 735         chip->card = card;
 736         chip->port = port[dev];
 737         xirq = irq[dev];
 738         xdma1 = dma1[dev];
 739         xdma2 = dma2[dev];
 740         if (xdma2 < 0)
 741                 chip->single_dma = 1;
 742         if ((err = snd_opl3sa2_detect(chip)) < 0)
 743                 goto __error;
 744         if (request_irq(xirq, snd_opl3sa2_interrupt, SA_INTERRUPT, "OPL3-SA2", (void *)chip)) {
 745                 snd_printk(KERN_ERR "opl3sa2: can't grab IRQ %d\n", xirq);
 746                 err = -ENODEV;
 747                 goto __error;
 748         }
 749         chip->irq = xirq;
 750         if ((err = snd_cs4231_create(card,
 751                                      wss_port[dev] + 4, -1,
 752                                      xirq, xdma1, xdma2,
 753                                      CS4231_HW_OPL3SA2,
 754                                      CS4231_HWSHARE_IRQ,
 755                                      &cs4231)) < 0) {
 756                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
 757                 goto __error;
 758         }
 759         chip->cs4231 = cs4231;
 760         if ((err = snd_cs4231_pcm(cs4231, 0, NULL)) < 0)
 761                 goto __error;
 762         if ((err = snd_cs4231_mixer(cs4231)) < 0)
 763                 goto __error;
 764         if ((err = snd_opl3sa2_mixer(chip)) < 0)
 765                 goto __error;
 766         if ((err = snd_cs4231_timer(cs4231, 0, NULL)) < 0)
 767                 goto __error;
 768         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
 769                 if ((err = snd_opl3_create(card, fm_port[dev],
 770                                            fm_port[dev] + 2,
 771                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
 772                         goto __error;
 773                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
 774                         goto __error;
 775                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
 776                         goto __error;
 777         }
 778         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
 779                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
 780                                                midi_port[dev], 0,
 781                                                xirq, 0, &chip->rmidi)) < 0)
 782                         goto __error;
 783         }
 784 #ifdef CONFIG_PM
 785         chip->cs4231_suspend = chip->cs4231->suspend;
 786         chip->cs4231_resume = chip->cs4231->resume;
 787         /* now clear callbacks for cs4231 */
 788         chip->cs4231->suspend = NULL;
 789         chip->cs4231->resume = NULL;
 790         snd_card_set_isa_pm_callback(card, snd_opl3sa2_suspend, snd_opl3sa2_resume, chip);
 791 #endif
 792
 793         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
 794                 card->shortname, chip->port, xirq, xdma1);
 795         if (dma2 >= 0)
 796                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
 797
 798         if ((err = snd_card_register(card)) < 0)
 799                 goto __error;
 800
 801         if (pdev)
 802                 pnp_set_drvdata(pdev, card);
 803         else if (pcard)
 804                 pnp_set_card_drvdata(pcard, card);
 805         else
 806                 snd_opl3sa2_legacy[dev] = card;
 807         return 0;
 808
 809  __error:
 810         snd_card_free(card);
 811         return err;
 812 }
 813
 814 #ifdef CONFIG_PNP
 815 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
 816                                             const struct pnp_device_id *id)
 817 {
 818         static int dev;
 819         int res;
 820
 821         for ( ; dev < SNDRV_CARDS; dev++) {
 822                 if (!enable[dev] || !isapnp[dev])
 823                         continue;
 824                 res = snd_opl3sa2_probe(dev, pdev, NULL, NULL);
 825                 if (res < 0)
 826                         return res;
 827                 dev++;
 828                 return 0;
 829         }
 830         return -ENODEV;
 831 }
 832
 833 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
 834 {
 835         snd_card_t *card = (snd_card_t *) pnp_get_drvdata(pdev);
 836
 837         snd_card_disconnect(card);
 838         snd_card_free_in_thread(card);
 839 }
 840
 841 static struct pnp_driver opl3sa2_pnp_driver = {
 842         .name = "opl3sa2-pnpbios",
 843         .id_table = snd_opl3sa2_pnpbiosids,
 844         .probe = snd_opl3sa2_pnp_detect,
 845         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
 846 };
 847
 848 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *card,
 849                                              const struct pnp_card_device_id *id)
 850 {
 851         static int dev;
 852         int res;
 853
 854         for ( ; dev < SNDRV_CARDS; dev++) {
 855                 if (!enable[dev] || !isapnp[dev])
 856                         continue;
 857                 res = snd_opl3sa2_probe(dev, NULL, card, id);
 858                 if (res < 0)
 859                         return res;
 860                 dev++;
 861                 return 0;
 862         }
 863         return -ENODEV;
 864 }
 865
 866 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
 867 {
 868         snd_card_t *card = (snd_card_t *) pnp_get_card_drvdata(pcard);
 869
 870         snd_card_disconnect(card);
 871         snd_card_free_in_thread(card);
 872 }
 873
 874 static struct pnp_card_driver opl3sa2_pnpc_driver = {
 875         .flags = PNP_DRIVER_RES_DISABLE,
 876         .name = "opl3sa2",
 877         .id_table = snd_opl3sa2_pnpids,
 878         .probe = snd_opl3sa2_pnp_cdetect,
 879         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
 880 };
 881 #endif /* CONFIG_PNP */
 882
 883 static int __init alsa_card_opl3sa2_init(void)
 884 {
 885         int dev, cards = 0;
 886
 887         for (dev = 0; dev < SNDRV_CARDS; dev++) {
 888                 if (!enable[dev])
 889                         continue;
 890 #ifdef CONFIG_PNP
 891                 if (isapnp[dev])
 892                         continue;
 893 #endif
 894                 if (snd_opl3sa2_probe(dev, NULL, NULL, NULL) >= 0)
 895                         cards++;
 896         }
 897 #ifdef CONFIG_PNP
 898         cards += pnp_register_driver(&opl3sa2_pnp_driver);
 899         cards += pnp_register_card_driver(&opl3sa2_pnpc_driver);
 900 #endif
 901         if (!cards) {
 902 #ifdef MODULE
 903                 snd_printk(KERN_ERR "Yamaha OPL3-SA soundcard not found or device busy\n");
 904 #endif
 905 #ifdef CONFIG_PNP
 906                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
 907 #endif
 908                 return -ENODEV;
 909         }
 910         return 0;
 911 }
 912
 913 static void __exit alsa_card_opl3sa2_exit(void)
 914 {
 915         int idx;
 916
 917 #ifdef CONFIG_PNP
 918         /* PnP cards first */
 919         pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
 920 #endif
 921         for (idx = 0; idx < SNDRV_CARDS; idx++)
 922                 snd_card_free(snd_opl3sa2_legacy[idx]);
 923 }
 924
 925 module_init(alsa_card_opl3sa2_init)
 926 module_exit(alsa_card_opl3sa2_exit)