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 #define PFX     "opl3sa2: "
 147
 148 #ifdef CONFIG_PNP
 149
 150 static struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
 151         { .id = "YMH0021" },
 152         { .id = "NMX2210" },    /* Gateway Solo 2500 */
 153         { .id = "" }            /* end */
 154 };
 155
 156 MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);
 157
 158 static struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
 159         /* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
 160         { .id = "YMH0020", .devs = { { "YMH0021" } } },
 161         /* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
 162         { .id = "YMH0030", .devs = { { "YMH0021" } } },
 163         /* Yamaha OPL3-SA2 */
 164         { .id = "YMH0800", .devs = { { "YMH0021" } } },
 165         /* Yamaha OPL3-SA2 */
 166         { .id = "YMH0801", .devs = { { "YMH0021" } } },
 167         /* NeoMagic MagicWave 3DX */
 168         { .id = "NMX2200", .devs = { { "YMH2210" } } },
 169         /* --- */
 170         { .id = "" }    /* end */
 171 };
 172
 173 MODULE_DEVICE_TABLE(pnp_card, snd_opl3sa2_pnpids);
 174
 175 #endif /* CONFIG_PNP */
 176
 177
 178 /* read control port (w/o spinlock) */
 179 static unsigned char __snd_opl3sa2_read(opl3sa2_t *chip, unsigned char reg)
 180 {
 181         unsigned char result;
 182 #if 0
 183         outb(0x1d, port);       /* password */
 184         printk("read [0x%lx] = 0x%x\n", port, inb(port));
 185 #endif
 186         outb(reg, chip->port);  /* register */
 187         result = inb(chip->port + 1);
 188 #if 0
 189         printk("read [0x%lx] = 0x%x [0x%x]\n", port, result, inb(port));
 190 #endif
 191         return result;
 192 }
 193
 194 /* read control port (with spinlock) */
 195 static unsigned char snd_opl3sa2_read(opl3sa2_t *chip, unsigned char reg)
 196 {
 197         unsigned long flags;
 198         unsigned char result;
 199
 200         spin_lock_irqsave(&chip->reg_lock, flags);
 201         result = __snd_opl3sa2_read(chip, reg);
 202         spin_unlock_irqrestore(&chip->reg_lock, flags);
 203         return result;
 204 }
 205
 206 /* write control port (w/o spinlock) */
 207 static void __snd_opl3sa2_write(opl3sa2_t *chip, unsigned char reg, unsigned char value)
 208 {
 209 #if 0
 210         outb(0x1d, port);       /* password */
 211 #endif
 212         outb(reg, chip->port);  /* register */
 213         outb(value, chip->port + 1);
 214         chip->ctlregs[reg] = value;
 215 }
 216
 217 /* write control port (with spinlock) */
 218 static void snd_opl3sa2_write(opl3sa2_t *chip, unsigned char reg, unsigned char value)
 219 {
 220         unsigned long flags;
 221         spin_lock_irqsave(&chip->reg_lock, flags);
 222         __snd_opl3sa2_write(chip, reg, value);
 223         spin_unlock_irqrestore(&chip->reg_lock, flags);
 224 }
 225
 226 static int __init snd_opl3sa2_detect(opl3sa2_t *chip)
 227 {
 228         snd_card_t *card;
 229         unsigned long port;
 230         unsigned char tmp, tmp1;
 231         char str[2];
 232
 233         card = chip->card;
 234         port = chip->port;
 235         if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
 236                 snd_printk(KERN_ERR PFX "can't grab port 0x%lx\n", port);
 237                 return -EBUSY;
 238         }
 239         // snd_printk("REG 0A = 0x%x\n", snd_opl3sa2_read(chip, 0x0a));
 240         chip->version = 0;
 241         tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
 242         if (tmp == 0xff) {
 243                 snd_printd("OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
 244                 return -ENODEV;
 245         }
 246         switch (tmp & 0x07) {
 247         case 0x01:
 248                 chip->version = 2; /* YMF711 */
 249                 break;
 250         default:
 251                 chip->version = 3;
 252                 /* 0x02 - standard */
 253                 /* 0x03 - YM715B */
 254                 /* 0x04 - YM719 - OPL-SA4? */
 255                 /* 0x05 - OPL3-SA3 - Libretto 100 */
 256                 break;
 257         }
 258         str[0] = chip->version + '0';
 259         str[1] = 0;
 260         strcat(card->shortname, str);
 261         snd_opl3sa2_write(chip, OPL3SA2_MISC, tmp ^ 7);
 262         if ((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MISC)) != tmp) {
 263                 snd_printd("OPL3-SA [0x%lx] detect (1) = 0x%x (0x%x)\n", port, tmp, tmp1);
 264                 return -ENODEV;
 265         }
 266         /* try if the MIC register is accesible */
 267         tmp = snd_opl3sa2_read(chip, OPL3SA2_MIC);
 268         snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x8a);
 269         if (((tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MIC)) & 0x9f) != 0x8a) {
 270                 snd_printd("OPL3-SA [0x%lx] detect (2) = 0x%x (0x%x)\n", port, tmp, tmp1);
 271                 return -ENODEV;
 272         }
 273         snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x9f);
 274         /* initialization */
 275         /* Power Management - full on */
 276         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
 277         if (chip->version > 2) {
 278                 /* ymode is bits 4&5 (of 0 to 7) on all but opl3sa2 versions */
 279                 snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, (chip->ymode << 4));
 280         } else {
 281                 /* default for opl3sa2 versions */
 282                 snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, 0x00);
 283         }
 284         snd_opl3sa2_write(chip, OPL3SA2_IRQ_CONFIG, 0x0d);      /* Interrupt Channel Configuration - IRQ A = OPL3 + MPU + WSS */
 285         if (chip->single_dma) {
 286                 snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x03);      /* DMA Configuration - DMA A = WSS-R + WSS-P */
 287         } else {
 288                 snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x21);      /* DMA Configuration - DMA B = WSS-R, DMA A = WSS-P */
 289         }
 290         snd_opl3sa2_write(chip, OPL3SA2_MISC, 0x80 | (tmp & 7));        /* Miscellaneous - default */
 291         if (chip->version > 2) {
 292                 snd_opl3sa2_write(chip, OPL3SA3_DGTL_DOWN, 0x00);       /* Digital Block Partial Power Down - default */
 293                 snd_opl3sa2_write(chip, OPL3SA3_ANLG_DOWN, 0x00);       /* Analog Block Partial Power Down - default */
 294         }
 295         return 0;
 296 }
 297
 298 static irqreturn_t snd_opl3sa2_interrupt(int irq, void *dev_id, struct pt_regs *regs)
 299 {
 300         unsigned short status;
 301         opl3sa2_t *chip = dev_id;
 302         int handled = 0;
 303
 304         if (chip == NULL || chip->card == NULL)
 305                 return IRQ_NONE;
 306
 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, regs);
 317         }
 318
 319         if (status & 0x07) {    /* TI,CI,PI */
 320                 handled = 1;
 321                 snd_cs4231_interrupt(irq, chip->cs4231, regs);
 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(chip->card, SNDRV_CTL_EVENT_MASK_VALUE, &chip->master_switch->id);
 331                         snd_ctl_notify(chip->card, SNDRV_CTL_EVENT_MASK_VALUE, &chip->master_volume->id);
 332                 }
 333         }
 334         return IRQ_RETVAL(handled);
 335 }
 336
 337 #define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
 338 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 339   .info = snd_opl3sa2_info_single, \
 340   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
 341   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
 342
 343 static int snd_opl3sa2_info_single(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
 344 {
 345         int mask = (kcontrol->private_value >> 16) & 0xff;
 346
 347         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
 348         uinfo->count = 1;
 349         uinfo->value.integer.min = 0;
 350         uinfo->value.integer.max = mask;
 351         return 0;
 352 }
 353
 354 static int snd_opl3sa2_get_single(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 355 {
 356         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 357         unsigned long flags;
 358         int reg = kcontrol->private_value & 0xff;
 359         int shift = (kcontrol->private_value >> 8) & 0xff;
 360         int mask = (kcontrol->private_value >> 16) & 0xff;
 361         int invert = (kcontrol->private_value >> 24) & 0xff;
 362
 363         spin_lock_irqsave(&chip->reg_lock, flags);
 364         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
 365         spin_unlock_irqrestore(&chip->reg_lock, flags);
 366         if (invert)
 367                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 368         return 0;
 369 }
 370
 371 static int snd_opl3sa2_put_single(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 372 {
 373         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 374         unsigned long flags;
 375         int reg = kcontrol->private_value & 0xff;
 376         int shift = (kcontrol->private_value >> 8) & 0xff;
 377         int mask = (kcontrol->private_value >> 16) & 0xff;
 378         int invert = (kcontrol->private_value >> 24) & 0xff;
 379         int change;
 380         unsigned short val, oval;
 381
 382         val = (ucontrol->value.integer.value[0] & mask);
 383         if (invert)
 384                 val = mask - val;
 385         val <<= shift;
 386         spin_lock_irqsave(&chip->reg_lock, flags);
 387         oval = chip->ctlregs[reg];
 388         val = (oval & ~(mask << shift)) | val;
 389         change = val != oval;
 390         __snd_opl3sa2_write(chip, reg, val);
 391         spin_unlock_irqrestore(&chip->reg_lock, flags);
 392         return change;
 393 }
 394
 395 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
 396 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 397   .info = snd_opl3sa2_info_double, \
 398   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
 399   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
 400
 401 static int snd_opl3sa2_info_double(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
 402 {
 403         int mask = (kcontrol->private_value >> 24) & 0xff;
 404
 405         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
 406         uinfo->count = 2;
 407         uinfo->value.integer.min = 0;
 408         uinfo->value.integer.max = mask;
 409         return 0;
 410 }
 411
 412 static int snd_opl3sa2_get_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 413 {
 414         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 415         unsigned long flags;
 416         int left_reg = kcontrol->private_value & 0xff;
 417         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 418         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 419         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 420         int mask = (kcontrol->private_value >> 24) & 0xff;
 421         int invert = (kcontrol->private_value >> 22) & 1;
 422
 423         spin_lock_irqsave(&chip->reg_lock, flags);
 424         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
 425         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
 426         spin_unlock_irqrestore(&chip->reg_lock, flags);
 427         if (invert) {
 428                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 429                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
 430         }
 431         return 0;
 432 }
 433
 434 static int snd_opl3sa2_put_double(snd_kcontrol_t * kcontrol, snd_ctl_elem_value_t * ucontrol)
 435 {
 436         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 437         unsigned long flags;
 438         int left_reg = kcontrol->private_value & 0xff;
 439         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 440         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 441         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 442         int mask = (kcontrol->private_value >> 24) & 0xff;
 443         int invert = (kcontrol->private_value >> 22) & 1;
 444         int change;
 445         unsigned short val1, val2, oval1, oval2;
 446
 447         val1 = ucontrol->value.integer.value[0] & mask;
 448         val2 = ucontrol->value.integer.value[1] & mask;
 449         if (invert) {
 450                 val1 = mask - val1;
 451                 val2 = mask - val2;
 452         }
 453         val1 <<= shift_left;
 454         val2 <<= shift_right;
 455         spin_lock_irqsave(&chip->reg_lock, flags);
 456         if (left_reg != right_reg) {
 457                 oval1 = chip->ctlregs[left_reg];
 458                 oval2 = chip->ctlregs[right_reg];
 459                 val1 = (oval1 & ~(mask << shift_left)) | val1;
 460                 val2 = (oval2 & ~(mask << shift_right)) | val2;
 461                 change = val1 != oval1 || val2 != oval2;
 462                 __snd_opl3sa2_write(chip, left_reg, val1);
 463                 __snd_opl3sa2_write(chip, right_reg, val2);
 464         } else {
 465                 oval1 = chip->ctlregs[left_reg];
 466                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
 467                 change = val1 != oval1;
 468                 __snd_opl3sa2_write(chip, left_reg, val1);
 469         }
 470         spin_unlock_irqrestore(&chip->reg_lock, flags);
 471         return change;
 472 }
 473
 474 static snd_kcontrol_new_t snd_opl3sa2_controls[] = {
 475 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
 476 OPL3SA2_DOUBLE("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1),
 477 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
 478 OPL3SA2_SINGLE("Mic Playback Volume", 0, 0x09, 0, 31, 1)
 479 };
 480
 481 static snd_kcontrol_new_t snd_opl3sa2_tone_controls[] = {
 482 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
 483 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
 484 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
 485 };
 486
 487 static void snd_opl3sa2_master_free(snd_kcontrol_t *kcontrol)
 488 {
 489         opl3sa2_t *chip = snd_kcontrol_chip(kcontrol);
 490         chip->master_switch = NULL;
 491         chip->master_volume = NULL;
 492 }
 493
 494 static int __init snd_opl3sa2_mixer(opl3sa2_t *chip)
 495 {
 496         snd_card_t *card = chip->card;
 497         snd_ctl_elem_id_t id1, id2;
 498         snd_kcontrol_t *kctl;
 499         unsigned int idx;
 500         int err;
 501
 502         memset(&id1, 0, sizeof(id1));
 503         memset(&id2, 0, sizeof(id2));
 504         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 505         /* reassign AUX0 to CD */
 506         strcpy(id1.name, "Aux Playback Switch");
 507         strcpy(id2.name, "CD Playback Switch");
 508         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 509                 return err;
 510         strcpy(id1.name, "Aux Playback Volume");
 511         strcpy(id2.name, "CD Playback Volume");
 512         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 513                 return err;
 514         /* reassign AUX1 to FM */
 515         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
 516         strcpy(id2.name, "FM Playback Switch");
 517         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 518                 return err;
 519         strcpy(id1.name, "Aux Playback Volume");
 520         strcpy(id2.name, "FM Playback Volume");
 521         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 522                 return err;
 523         /* add OPL3SA2 controls */
 524         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
 525                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
 526                         return err;
 527                 switch (idx) {
 528                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 529                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 530                 }
 531         }
 532         if (chip->version > 2) {
 533                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
 534                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
 535                                 return err;
 536         }
 537         return 0;
 538 }
 539
 540 /* Power Management support functions */
 541 #ifdef CONFIG_PM
 542 static int snd_opl3sa2_suspend(snd_card_t *card, pm_message_t state)
 543 {
 544         opl3sa2_t *chip = card->pm_private_data;
 545
 546         snd_pcm_suspend_all(chip->cs4231->pcm); /* stop before saving regs */
 547         chip->cs4231_suspend(chip->cs4231);
 548
 549         /* power down */
 550         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
 551
 552         return 0;
 553 }
 554
 555 static int snd_opl3sa2_resume(snd_card_t *card)
 556 {
 557         opl3sa2_t *chip = card->pm_private_data;
 558         int i;
 559
 560         /* power up */
 561         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
 562
 563         /* restore registers */
 564         for (i = 2; i <= 0x0a; i++) {
 565                 if (i != OPL3SA2_IRQ_STATUS)
 566                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 567         }
 568         if (chip->version > 2) {
 569                 for (i = 0x12; i <= 0x16; i++)
 570                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 571         }
 572         /* restore cs4231 */
 573         chip->cs4231_resume(chip->cs4231);
 574
 575         return 0;
 576 }
 577 #endif /* CONFIG_PM */
 578
 579 #ifdef CONFIG_PNP
 580 static int __init snd_opl3sa2_pnp(int dev, opl3sa2_t *chip,
 581                                   struct pnp_dev *pdev,
 582                                   int isapnp)
 583 {
 584         struct pnp_resource_table * cfg;
 585         int err;
 586
 587         if (!isapnp && pnp_device_is_isapnp(pdev))
 588                 return -ENOENT; /* we have another procedure - card */
 589
 590         cfg = kmalloc(sizeof(struct pnp_resource_table), GFP_KERNEL);
 591         if (!cfg)
 592                 return -ENOMEM;
 593         /* PnP initialization */
 594         pnp_init_resource_table(cfg);
 595         if (sb_port[dev] != SNDRV_AUTO_PORT)
 596                 pnp_resource_change(&cfg->port_resource[0], sb_port[dev], 16);
 597         if (wss_port[dev] != SNDRV_AUTO_PORT)
 598                 pnp_resource_change(&cfg->port_resource[1], wss_port[dev], 8);
 599         if (fm_port[dev] != SNDRV_AUTO_PORT)
 600                 pnp_resource_change(&cfg->port_resource[2], fm_port[dev], 4);
 601         if (midi_port[dev] != SNDRV_AUTO_PORT)
 602                 pnp_resource_change(&cfg->port_resource[3], midi_port[dev], 2);
 603         if (port[dev] != SNDRV_AUTO_PORT)
 604                 pnp_resource_change(&cfg->port_resource[4], port[dev], 2);
 605         if (dma1[dev] != SNDRV_AUTO_DMA)
 606                 pnp_resource_change(&cfg->dma_resource[0], dma1[dev], 1);
 607         if (dma2[dev] != SNDRV_AUTO_DMA)
 608                 pnp_resource_change(&cfg->dma_resource[1], dma2[dev], 1);
 609         if (irq[dev] != SNDRV_AUTO_IRQ)
 610                 pnp_resource_change(&cfg->irq_resource[0], irq[dev], 1);
 611         err = pnp_manual_config_dev(pdev, cfg, 0);
 612         if (err < 0 && isapnp)
 613                 snd_printk(KERN_ERR "PnP manual resources are invalid, using auto config\n");
 614         err = pnp_activate_dev(pdev);
 615         if (err < 0) {
 616                 kfree(cfg);
 617                 snd_printk(KERN_ERR "PnP configure failure (out of resources?) err = %d\n", err);
 618                 return -EBUSY;
 619         }
 620         sb_port[dev] = pnp_port_start(pdev, 0);
 621         wss_port[dev] = pnp_port_start(pdev, 1);
 622         fm_port[dev] = pnp_port_start(pdev, 2);
 623         midi_port[dev] = pnp_port_start(pdev, 3);
 624         port[dev] = pnp_port_start(pdev, 4);
 625         dma1[dev] = pnp_dma(pdev, 0);
 626         dma2[dev] = pnp_dma(pdev, 1);
 627         irq[dev] = pnp_irq(pdev, 0);
 628         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
 629                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
 630         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
 631                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
 632         kfree(cfg);
 633         chip->dev = pdev;
 634         return 0;
 635 }
 636
 637 static int __init snd_opl3sa2_cpnp(int dev, opl3sa2_t *chip,
 638                                    struct pnp_card_link *card,
 639                                    const struct pnp_card_device_id *id)
 640 {
 641         struct pnp_dev *pdev;
 642         struct pnp_resource_table * cfg = kmalloc(sizeof(struct pnp_resource_table), GFP_KERNEL);
 643
 644         if (!cfg)
 645                 return -ENOMEM;
 646         pdev = pnp_request_card_device(card, id->devs[0].id, NULL);
 647         if (pdev == NULL) {
 648                 kfree(cfg);
 649                 return -EBUSY;
 650         }
 651         return snd_opl3sa2_pnp(dev, chip, pdev, 1);
 652 }
 653 #endif /* CONFIG_PNP */
 654
 655 static int snd_opl3sa2_free(opl3sa2_t *chip)
 656 {
 657         if (chip->irq >= 0)
 658                 free_irq(chip->irq, (void *)chip);
 659         release_and_free_resource(chip->res_port);
 660         kfree(chip);
 661         return 0;
 662 }
 663
 664 static int snd_opl3sa2_dev_free(snd_device_t *device)
 665 {
 666         opl3sa2_t *chip = device->device_data;
 667         return snd_opl3sa2_free(chip);
 668 }
 669
 670 #ifdef CONFIG_PNP
 671 #define is_isapnp_selected(dev)         isapnp[dev]
 672 #else
 673 #define is_isapnp_selected(dev)         0
 674 #endif
 675
 676 static int __devinit snd_opl3sa2_probe(int dev,
 677                                        struct pnp_dev *pdev,
 678                                        struct pnp_card_link *pcard,
 679                                        const struct pnp_card_device_id *pid)
 680 {
 681         int xirq, xdma1, xdma2;
 682         snd_card_t *card;
 683         struct snd_opl3sa2 *chip;
 684         cs4231_t *cs4231;
 685         opl3_t *opl3;
 686         static snd_device_ops_t ops = {
 687                 .dev_free =     snd_opl3sa2_dev_free,
 688         };
 689         int err;
 690
 691         if (! is_isapnp_selected(dev)) {
 692                 if (port[dev] == SNDRV_AUTO_PORT) {
 693                         snd_printk(KERN_ERR PFX "specify port\n");
 694                         return -EINVAL;
 695                 }
 696                 if (wss_port[dev] == SNDRV_AUTO_PORT) {
 697                         snd_printk(KERN_ERR PFX "specify wss_port\n");
 698                         return -EINVAL;
 699                 }
 700                 if (fm_port[dev] == SNDRV_AUTO_PORT) {
 701                         snd_printk(KERN_ERR PFX "specify fm_port\n");
 702                         return -EINVAL;
 703                 }
 704                 if (midi_port[dev] == SNDRV_AUTO_PORT) {
 705                         snd_printk(KERN_ERR PFX "specify midi_port\n");
 706                         return -EINVAL;
 707                 }
 708         }
 709
 710         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 711         if (card == NULL)
 712                 return -ENOMEM;
 713         strcpy(card->driver, "OPL3SA2");
 714         strcpy(card->shortname, "Yamaha OPL3-SA2");
 715         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
 716         if (chip == NULL) {
 717                 err = -ENOMEM;
 718                 goto __error;
 719         }
 720         spin_lock_init(&chip->reg_lock);
 721         chip->irq = -1;
 722         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0)
 723                 goto __error;
 724 #ifdef CONFIG_PNP
 725         if (pdev) {
 726                 if ((err = snd_opl3sa2_pnp(dev, chip, pdev, 0)) < 0)
 727                         goto __error;
 728                 snd_card_set_dev(card, &pdev->dev);
 729         }
 730         if (pcard) {
 731                 if ((err = snd_opl3sa2_cpnp(dev, chip, pcard, pid)) < 0)
 732                         goto __error;
 733                 snd_card_set_dev(card, &pcard->card->dev);
 734         }
 735 #endif
 736         chip->ymode = opl3sa3_ymode[dev] & 0x03 ; /* initialise this card from supplied (or default) parameter*/
 737         chip->card = card;
 738         chip->port = port[dev];
 739         xirq = irq[dev];
 740         xdma1 = dma1[dev];
 741         xdma2 = dma2[dev];
 742         if (xdma2 < 0)
 743                 chip->single_dma = 1;
 744         if ((err = snd_opl3sa2_detect(chip)) < 0)
 745                 goto __error;
 746         if (request_irq(xirq, snd_opl3sa2_interrupt, SA_INTERRUPT, "OPL3-SA2", (void *)chip)) {
 747                 snd_printk(KERN_ERR PFX "can't grab IRQ %d\n", xirq);
 748                 err = -ENODEV;
 749                 goto __error;
 750         }
 751         chip->irq = xirq;
 752         if ((err = snd_cs4231_create(card,
 753                                      wss_port[dev] + 4, -1,
 754                                      xirq, xdma1, xdma2,
 755                                      CS4231_HW_OPL3SA2,
 756                                      CS4231_HWSHARE_IRQ,
 757                                      &cs4231)) < 0) {
 758                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
 759                 goto __error;
 760         }
 761         chip->cs4231 = cs4231;
 762         if ((err = snd_cs4231_pcm(cs4231, 0, NULL)) < 0)
 763                 goto __error;
 764         if ((err = snd_cs4231_mixer(cs4231)) < 0)
 765                 goto __error;
 766         if ((err = snd_opl3sa2_mixer(chip)) < 0)
 767                 goto __error;
 768         if ((err = snd_cs4231_timer(cs4231, 0, NULL)) < 0)
 769                 goto __error;
 770         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
 771                 if ((err = snd_opl3_create(card, fm_port[dev],
 772                                            fm_port[dev] + 2,
 773                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
 774                         goto __error;
 775                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
 776                         goto __error;
 777                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
 778                         goto __error;
 779         }
 780         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
 781                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
 782                                                midi_port[dev], 0,
 783                                                xirq, 0, &chip->rmidi)) < 0)
 784                         goto __error;
 785         }
 786 #ifdef CONFIG_PM
 787         chip->cs4231_suspend = chip->cs4231->suspend;
 788         chip->cs4231_resume = chip->cs4231->resume;
 789         /* now clear callbacks for cs4231 */
 790         chip->cs4231->suspend = NULL;
 791         chip->cs4231->resume = NULL;
 792         snd_card_set_isa_pm_callback(card, snd_opl3sa2_suspend, snd_opl3sa2_resume, chip);
 793 #endif
 794
 795         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
 796                 card->shortname, chip->port, xirq, xdma1);
 797         if (dma2 >= 0)
 798                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
 799
 800         if ((err = snd_card_set_generic_dev(card)) < 0)
 801                 goto __error;
 802
 803         if ((err = snd_card_register(card)) < 0)
 804                 goto __error;
 805
 806         if (pdev)
 807                 pnp_set_drvdata(pdev, card);
 808         else if (pcard)
 809                 pnp_set_card_drvdata(pcard, card);
 810         else
 811                 snd_opl3sa2_legacy[dev] = card;
 812         return 0;
 813
 814  __error:
 815         snd_card_free(card);
 816         return err;
 817 }
 818
 819 #ifdef CONFIG_PNP
 820 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
 821                                             const struct pnp_device_id *id)
 822 {
 823         static int dev;
 824         int res;
 825
 826         for ( ; dev < SNDRV_CARDS; dev++) {
 827                 if (!enable[dev] || !isapnp[dev])
 828                         continue;
 829                 res = snd_opl3sa2_probe(dev, pdev, NULL, NULL);
 830                 if (res < 0)
 831                         return res;
 832                 dev++;
 833                 return 0;
 834         }
 835         return -ENODEV;
 836 }
 837
 838 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
 839 {
 840         snd_card_t *card = (snd_card_t *) pnp_get_drvdata(pdev);
 841
 842         snd_card_disconnect(card);
 843         snd_card_free_in_thread(card);
 844 }
 845
 846 static struct pnp_driver opl3sa2_pnp_driver = {
 847         .name = "opl3sa2-pnpbios",
 848         .id_table = snd_opl3sa2_pnpbiosids,
 849         .probe = snd_opl3sa2_pnp_detect,
 850         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
 851 };
 852
 853 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *card,
 854                                              const struct pnp_card_device_id *id)
 855 {
 856         static int dev;
 857         int res;
 858
 859         for ( ; dev < SNDRV_CARDS; dev++) {
 860                 if (!enable[dev])
 861                         continue;
 862                 if (is_isapnp_selected(dev))
 863                         continue;
 864                 res = snd_opl3sa2_probe(dev, NULL, card, id);
 865                 if (res < 0)
 866                         return res;
 867                 dev++;
 868                 return 0;
 869         }
 870         return -ENODEV;
 871 }
 872
 873 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
 874 {
 875         snd_card_t *card = (snd_card_t *) pnp_get_card_drvdata(pcard);
 876
 877         snd_card_disconnect(card);
 878         snd_card_free_in_thread(card);
 879 }
 880
 881 static struct pnp_card_driver opl3sa2_pnpc_driver = {
 882         .flags = PNP_DRIVER_RES_DISABLE,
 883         .name = "opl3sa2",
 884         .id_table = snd_opl3sa2_pnpids,
 885         .probe = snd_opl3sa2_pnp_cdetect,
 886         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
 887 };
 888 #endif /* CONFIG_PNP */
 889
 890 static int __init alsa_card_opl3sa2_init(void)
 891 {
 892         int dev, cards = 0;
 893
 894         for (dev = 0; dev < SNDRV_CARDS; dev++) {
 895                 if (!enable[dev])
 896                         continue;
 897 #ifdef CONFIG_PNP
 898                 if (isapnp[dev])
 899                         continue;
 900 #endif
 901                 if (snd_opl3sa2_probe(dev, NULL, NULL, NULL) >= 0)
 902                         cards++;
 903         }
 904 #ifdef CONFIG_PNP
 905         cards += pnp_register_driver(&opl3sa2_pnp_driver);
 906         cards += pnp_register_card_driver(&opl3sa2_pnpc_driver);
 907 #endif
 908         if (!cards) {
 909 #ifdef MODULE
 910                 snd_printk(KERN_ERR "Yamaha OPL3-SA soundcard not found or device busy\n");
 911 #endif
 912 #ifdef CONFIG_PNP
 913                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
 914                 pnp_unregister_driver(&opl3sa2_pnp_driver);
 915 #endif
 916                 return -ENODEV;
 917         }
 918         return 0;
 919 }
 920
 921 static void __exit alsa_card_opl3sa2_exit(void)
 922 {
 923         int idx;
 924
 925 #ifdef CONFIG_PNP
 926         /* PnP cards first */
 927         pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
 928         pnp_unregister_driver(&opl3sa2_pnp_driver);
 929 #endif
 930         for (idx = 0; idx < SNDRV_CARDS; idx++)
 931                 snd_card_free(snd_opl3sa2_legacy[idx]);
 932 }
 933
 934 module_init(alsa_card_opl3sa2_init)
 935 module_exit(alsa_card_opl3sa2_exit)