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/cs4231.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         struct snd_card *card;
 128         int version;            /* 2 or 3 */
 129         unsigned long port;     /* control port */
 130         struct resource *res_port; /* control port resource */
 131         int irq;
 132         int single_dma;
 133         spinlock_t reg_lock;
 134         struct snd_hwdep *synth;
 135         struct snd_rawmidi *rmidi;
 136         struct snd_cs4231 *cs4231;
 137         unsigned char ctlregs[0x20];
 138         int ymode;              /* SL added */
 139         struct snd_kcontrol *master_switch;
 140         struct snd_kcontrol *master_volume;
 141 };
 142
 143 #define PFX     "opl3sa2: "
 144
 145 #ifdef CONFIG_PNP
 146
 147 static struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
 148         { .id = "YMH0021" },
 149         { .id = "NMX2210" },    /* Gateway Solo 2500 */
 150         { .id = "" }            /* end */
 151 };
 152
 153 MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);
 154
 155 static struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
 156         /* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
 157         { .id = "YMH0020", .devs = { { "YMH0021" } } },
 158         /* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
 159         { .id = "YMH0030", .devs = { { "YMH0021" } } },
 160         /* Yamaha OPL3-SA2 */
 161         { .id = "YMH0800", .devs = { { "YMH0021" } } },
 162         /* Yamaha OPL3-SA2 */
 163         { .id = "YMH0801", .devs = { { "YMH0021" } } },
 164         /* NeoMagic MagicWave 3DX */
 165         { .id = "NMX2200", .devs = { { "YMH2210" } } },
 166         /* NeoMagic MagicWave 3D */
 167         { .id = "NMX2200", .devs = { { "NMX2210" } } },
 168         /* --- */
 169         { .id = "" }    /* end */
 170 };
 171
 172 MODULE_DEVICE_TABLE(pnp_card, snd_opl3sa2_pnpids);
 173
 174 #endif /* CONFIG_PNP */
 175
 176
 177 /* read control port (w/o spinlock) */
 178 static unsigned char __snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
 179 {
 180         unsigned char result;
 181 #if 0
 182         outb(0x1d, port);       /* password */
 183         printk("read [0x%lx] = 0x%x\n", port, inb(port));
 184 #endif
 185         outb(reg, chip->port);  /* register */
 186         result = inb(chip->port + 1);
 187 #if 0
 188         printk("read [0x%lx] = 0x%x [0x%x]\n", port, result, inb(port));
 189 #endif
 190         return result;
 191 }
 192
 193 /* read control port (with spinlock) */
 194 static unsigned char snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
 195 {
 196         unsigned long flags;
 197         unsigned char result;
 198
 199         spin_lock_irqsave(&chip->reg_lock, flags);
 200         result = __snd_opl3sa2_read(chip, reg);
 201         spin_unlock_irqrestore(&chip->reg_lock, flags);
 202         return result;
 203 }
 204
 205 /* write control port (w/o spinlock) */
 206 static void __snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
 207 {
 208 #if 0
 209         outb(0x1d, port);       /* password */
 210 #endif
 211         outb(reg, chip->port);  /* register */
 212         outb(value, chip->port + 1);
 213         chip->ctlregs[reg] = value;
 214 }
 215
 216 /* write control port (with spinlock) */
 217 static void snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
 218 {
 219         unsigned long flags;
 220         spin_lock_irqsave(&chip->reg_lock, flags);
 221         __snd_opl3sa2_write(chip, reg, value);
 222         spin_unlock_irqrestore(&chip->reg_lock, flags);
 223 }
 224
 225 static int __devinit snd_opl3sa2_detect(struct snd_opl3sa2 *chip)
 226 {
 227         struct snd_card *card;
 228         unsigned long port;
 229         unsigned char tmp, tmp1;
 230         char str[2];
 231
 232         card = chip->card;
 233         port = chip->port;
 234         if ((chip->res_port = request_region(port, 2, "OPL3-SA control")) == NULL) {
 235                 snd_printk(KERN_ERR PFX "can't grab port 0x%lx\n", port);
 236                 return -EBUSY;
 237         }
 238         // snd_printk("REG 0A = 0x%x\n", snd_opl3sa2_read(chip, 0x0a));
 239         chip->version = 0;
 240         tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
 241         if (tmp == 0xff) {
 242                 snd_printd("OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
 243                 return -ENODEV;
 244         }
 245         switch (tmp & 0x07) {
 246         case 0x01:
 247                 chip->version = 2; /* YMF711 */
 248                 break;
 249         default:
 250                 chip->version = 3;
 251                 /* 0x02 - standard */
 252                 /* 0x03 - YM715B */
 253                 /* 0x04 - YM719 - OPL-SA4? */
 254                 /* 0x05 - OPL3-SA3 - Libretto 100 */
 255                 /* 0x07 - unknown - Neomagic MagicWave 3D */
 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)
 299 {
 300         unsigned short status;
 301         struct snd_opl3sa2 *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);
 317         }
 318
 319         if (status & 0x07) {    /* TI,CI,PI */
 320                 handled = 1;
 321                 snd_cs4231_interrupt(irq, chip->cs4231);
 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 #define OPL3SA2_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
 343 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
 344   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
 345   .name = xname, .index = xindex, \
 346   .info = snd_opl3sa2_info_single, \
 347   .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
 348   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
 349   .tlv = { .p = (xtlv) } }
 350
 351 static int snd_opl3sa2_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
 352 {
 353         int mask = (kcontrol->private_value >> 16) & 0xff;
 354
 355         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
 356         uinfo->count = 1;
 357         uinfo->value.integer.min = 0;
 358         uinfo->value.integer.max = mask;
 359         return 0;
 360 }
 361
 362 static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 363 {
 364         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 365         unsigned long flags;
 366         int reg = kcontrol->private_value & 0xff;
 367         int shift = (kcontrol->private_value >> 8) & 0xff;
 368         int mask = (kcontrol->private_value >> 16) & 0xff;
 369         int invert = (kcontrol->private_value >> 24) & 0xff;
 370
 371         spin_lock_irqsave(&chip->reg_lock, flags);
 372         ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
 373         spin_unlock_irqrestore(&chip->reg_lock, flags);
 374         if (invert)
 375                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 376         return 0;
 377 }
 378
 379 static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 380 {
 381         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 382         unsigned long flags;
 383         int reg = kcontrol->private_value & 0xff;
 384         int shift = (kcontrol->private_value >> 8) & 0xff;
 385         int mask = (kcontrol->private_value >> 16) & 0xff;
 386         int invert = (kcontrol->private_value >> 24) & 0xff;
 387         int change;
 388         unsigned short val, oval;
 389
 390         val = (ucontrol->value.integer.value[0] & mask);
 391         if (invert)
 392                 val = mask - val;
 393         val <<= shift;
 394         spin_lock_irqsave(&chip->reg_lock, flags);
 395         oval = chip->ctlregs[reg];
 396         val = (oval & ~(mask << shift)) | val;
 397         change = val != oval;
 398         __snd_opl3sa2_write(chip, reg, val);
 399         spin_unlock_irqrestore(&chip->reg_lock, flags);
 400         return change;
 401 }
 402
 403 #define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
 404 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
 405   .info = snd_opl3sa2_info_double, \
 406   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
 407   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
 408 #define OPL3SA2_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
 409 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
 410   .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
 411   .name = xname, .index = xindex, \
 412   .info = snd_opl3sa2_info_double, \
 413   .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
 414   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
 415   .tlv = { .p = (xtlv) } }
 416
 417 static int snd_opl3sa2_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
 418 {
 419         int mask = (kcontrol->private_value >> 24) & 0xff;
 420
 421         uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
 422         uinfo->count = 2;
 423         uinfo->value.integer.min = 0;
 424         uinfo->value.integer.max = mask;
 425         return 0;
 426 }
 427
 428 static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 429 {
 430         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 431         unsigned long flags;
 432         int left_reg = kcontrol->private_value & 0xff;
 433         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 434         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 435         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 436         int mask = (kcontrol->private_value >> 24) & 0xff;
 437         int invert = (kcontrol->private_value >> 22) & 1;
 438
 439         spin_lock_irqsave(&chip->reg_lock, flags);
 440         ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
 441         ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
 442         spin_unlock_irqrestore(&chip->reg_lock, flags);
 443         if (invert) {
 444                 ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
 445                 ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
 446         }
 447         return 0;
 448 }
 449
 450 static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 451 {
 452         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 453         unsigned long flags;
 454         int left_reg = kcontrol->private_value & 0xff;
 455         int right_reg = (kcontrol->private_value >> 8) & 0xff;
 456         int shift_left = (kcontrol->private_value >> 16) & 0x07;
 457         int shift_right = (kcontrol->private_value >> 19) & 0x07;
 458         int mask = (kcontrol->private_value >> 24) & 0xff;
 459         int invert = (kcontrol->private_value >> 22) & 1;
 460         int change;
 461         unsigned short val1, val2, oval1, oval2;
 462
 463         val1 = ucontrol->value.integer.value[0] & mask;
 464         val2 = ucontrol->value.integer.value[1] & mask;
 465         if (invert) {
 466                 val1 = mask - val1;
 467                 val2 = mask - val2;
 468         }
 469         val1 <<= shift_left;
 470         val2 <<= shift_right;
 471         spin_lock_irqsave(&chip->reg_lock, flags);
 472         if (left_reg != right_reg) {
 473                 oval1 = chip->ctlregs[left_reg];
 474                 oval2 = chip->ctlregs[right_reg];
 475                 val1 = (oval1 & ~(mask << shift_left)) | val1;
 476                 val2 = (oval2 & ~(mask << shift_right)) | val2;
 477                 change = val1 != oval1 || val2 != oval2;
 478                 __snd_opl3sa2_write(chip, left_reg, val1);
 479                 __snd_opl3sa2_write(chip, right_reg, val2);
 480         } else {
 481                 oval1 = chip->ctlregs[left_reg];
 482                 val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
 483                 change = val1 != oval1;
 484                 __snd_opl3sa2_write(chip, left_reg, val1);
 485         }
 486         spin_unlock_irqrestore(&chip->reg_lock, flags);
 487         return change;
 488 }
 489
 490 static const DECLARE_TLV_DB_SCALE(db_scale_master, -3000, 200, 0);
 491 static const DECLARE_TLV_DB_SCALE(db_scale_5bit_12db_max, -3450, 150, 0);
 492
 493 static struct snd_kcontrol_new snd_opl3sa2_controls[] = {
 494 OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
 495 OPL3SA2_DOUBLE_TLV("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1,
 496                    db_scale_master),
 497 OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
 498 OPL3SA2_SINGLE_TLV("Mic Playback Volume", 0, 0x09, 0, 31, 1,
 499                    db_scale_5bit_12db_max),
 500 };
 501
 502 static struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
 503 OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
 504 OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
 505 OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
 506 };
 507
 508 static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
 509 {
 510         struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
 511         chip->master_switch = NULL;
 512         chip->master_volume = NULL;
 513 }
 514
 515 static int __devinit snd_opl3sa2_mixer(struct snd_opl3sa2 *chip)
 516 {
 517         struct snd_card *card = chip->card;
 518         struct snd_ctl_elem_id id1, id2;
 519         struct snd_kcontrol *kctl;
 520         unsigned int idx;
 521         int err;
 522
 523         memset(&id1, 0, sizeof(id1));
 524         memset(&id2, 0, sizeof(id2));
 525         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 526         /* reassign AUX0 to CD */
 527         strcpy(id1.name, "Aux Playback Switch");
 528         strcpy(id2.name, "CD Playback Switch");
 529         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 530                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 531                 return err;
 532         }
 533         strcpy(id1.name, "Aux Playback Volume");
 534         strcpy(id2.name, "CD Playback Volume");
 535         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 536                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 537                 return err;
 538         }
 539         /* reassign AUX1 to FM */
 540         strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
 541         strcpy(id2.name, "FM Playback Switch");
 542         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 543                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 544                 return err;
 545         }
 546         strcpy(id1.name, "Aux Playback Volume");
 547         strcpy(id2.name, "FM Playback Volume");
 548         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) {
 549                 snd_printk(KERN_ERR "Cannot rename opl3sa2 control\n");
 550                 return err;
 551         }
 552         /* add OPL3SA2 controls */
 553         for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
 554                 if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip))) < 0)
 555                         return err;
 556                 switch (idx) {
 557                 case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 558                 case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
 559                 }
 560         }
 561         if (chip->version > 2) {
 562                 for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++)
 563                         if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip))) < 0)
 564                                 return err;
 565         }
 566         return 0;
 567 }
 568
 569 /* Power Management support functions */
 570 #ifdef CONFIG_PM
 571 static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
 572 {
 573         struct snd_opl3sa2 *chip = card->private_data;
 574
 575         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
 576         chip->cs4231->suspend(chip->cs4231);
 577         /* power down */
 578         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
 579
 580         return 0;
 581 }
 582
 583 static int snd_opl3sa2_resume(struct snd_card *card)
 584 {
 585         struct snd_opl3sa2 *chip = card->private_data;
 586         int i;
 587
 588         /* power up */
 589         snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
 590
 591         /* restore registers */
 592         for (i = 2; i <= 0x0a; i++) {
 593                 if (i != OPL3SA2_IRQ_STATUS)
 594                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 595         }
 596         if (chip->version > 2) {
 597                 for (i = 0x12; i <= 0x16; i++)
 598                         snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
 599         }
 600         /* restore cs4231 */
 601         chip->cs4231->resume(chip->cs4231);
 602
 603         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
 604         return 0;
 605 }
 606 #endif /* CONFIG_PM */
 607
 608 #ifdef CONFIG_PNP
 609 static int __devinit snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
 610                                      struct pnp_dev *pdev)
 611 {
 612         if (pnp_activate_dev(pdev) < 0) {
 613                 snd_printk(KERN_ERR "PnP configure failure (out of resources?)\n");
 614                 return -EBUSY;
 615         }
 616         sb_port[dev] = pnp_port_start(pdev, 0);
 617         wss_port[dev] = pnp_port_start(pdev, 1);
 618         fm_port[dev] = pnp_port_start(pdev, 2);
 619         midi_port[dev] = pnp_port_start(pdev, 3);
 620         port[dev] = pnp_port_start(pdev, 4);
 621         dma1[dev] = pnp_dma(pdev, 0);
 622         dma2[dev] = pnp_dma(pdev, 1);
 623         irq[dev] = pnp_irq(pdev, 0);
 624         snd_printdd("%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
 625                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
 626         snd_printdd("%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
 627                 pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
 628         return 0;
 629 }
 630 #endif /* CONFIG_PNP */
 631
 632 static void snd_opl3sa2_free(struct snd_card *card)
 633 {
 634         struct snd_opl3sa2 *chip = card->private_data;
 635         if (chip->irq >= 0)
 636                 free_irq(chip->irq, (void *)chip);
 637         release_and_free_resource(chip->res_port);
 638 }
 639
 640 static struct snd_card *snd_opl3sa2_card_new(int dev)
 641 {
 642         struct snd_card *card;
 643         struct snd_opl3sa2 *chip;
 644
 645         card = snd_card_new(index[dev], id[dev], THIS_MODULE, sizeof(struct snd_opl3sa2));
 646         if (card == NULL)
 647                 return NULL;
 648         strcpy(card->driver, "OPL3SA2");
 649         strcpy(card->shortname, "Yamaha OPL3-SA2");
 650         chip = card->private_data;
 651         spin_lock_init(&chip->reg_lock);
 652         chip->irq = -1;
 653         chip->card = card;
 654         card->private_free = snd_opl3sa2_free;
 655         return card;
 656 }
 657
 658 static int __devinit snd_opl3sa2_probe(struct snd_card *card, int dev)
 659 {
 660         int xirq, xdma1, xdma2;
 661         struct snd_opl3sa2 *chip;
 662         struct snd_cs4231 *cs4231;
 663         struct snd_opl3 *opl3;
 664         int err;
 665
 666         /* initialise this card from supplied (or default) parameter*/
 667         chip = card->private_data;
 668         chip->ymode = opl3sa3_ymode[dev] & 0x03 ;
 669         chip->port = port[dev];
 670         xirq = irq[dev];
 671         xdma1 = dma1[dev];
 672         xdma2 = dma2[dev];
 673         if (xdma2 < 0)
 674                 chip->single_dma = 1;
 675         if ((err = snd_opl3sa2_detect(chip)) < 0)
 676                 return err;
 677         if (request_irq(xirq, snd_opl3sa2_interrupt, IRQF_DISABLED, "OPL3-SA2", chip)) {
 678                 snd_printk(KERN_ERR PFX "can't grab IRQ %d\n", xirq);
 679                 return -ENODEV;
 680         }
 681         chip->irq = xirq;
 682         if ((err = snd_cs4231_create(card,
 683                                      wss_port[dev] + 4, -1,
 684                                      xirq, xdma1, xdma2,
 685                                      CS4231_HW_OPL3SA2,
 686                                      CS4231_HWSHARE_IRQ,
 687                                      &cs4231)) < 0) {
 688                 snd_printd("Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
 689                 return err;
 690         }
 691         chip->cs4231 = cs4231;
 692         if ((err = snd_cs4231_pcm(cs4231, 0, NULL)) < 0)
 693                 return err;
 694         if ((err = snd_cs4231_mixer(cs4231)) < 0)
 695                 return err;
 696         if ((err = snd_opl3sa2_mixer(chip)) < 0)
 697                 return err;
 698         if ((err = snd_cs4231_timer(cs4231, 0, NULL)) < 0)
 699                 return err;
 700         if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
 701                 if ((err = snd_opl3_create(card, fm_port[dev],
 702                                            fm_port[dev] + 2,
 703                                            OPL3_HW_OPL3, 0, &opl3)) < 0)
 704                         return err;
 705                 if ((err = snd_opl3_timer_new(opl3, 1, 2)) < 0)
 706                         return err;
 707                 if ((err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth)) < 0)
 708                         return err;
 709         }
 710         if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
 711                 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
 712                                                midi_port[dev], 0,
 713                                                xirq, 0, &chip->rmidi)) < 0)
 714                         return err;
 715         }
 716         sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
 717                 card->shortname, chip->port, xirq, xdma1);
 718         if (xdma2 >= 0)
 719                 sprintf(card->longname + strlen(card->longname), "&%d", xdma2);
 720
 721         return snd_card_register(card);
 722 }
 723
 724 #ifdef CONFIG_PNP
 725 static int __devinit snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
 726                                             const struct pnp_device_id *id)
 727 {
 728         static int dev;
 729         int err;
 730         struct snd_card *card;
 731
 732         if (pnp_device_is_isapnp(pdev))
 733                 return -ENOENT; /* we have another procedure - card */
 734         for (; dev < SNDRV_CARDS; dev++) {
 735                 if (enable[dev] && isapnp[dev])
 736                         break;
 737         }
 738         if (dev >= SNDRV_CARDS)
 739                 return -ENODEV;
 740
 741         card = snd_opl3sa2_card_new(dev);
 742         if (! card)
 743                 return -ENOMEM;
 744         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
 745                 snd_card_free(card);
 746                 return err;
 747         }
 748         snd_card_set_dev(card, &pdev->dev);
 749         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
 750                 snd_card_free(card);
 751                 return err;
 752         }
 753         pnp_set_drvdata(pdev, card);
 754         dev++;
 755         return 0;
 756 }
 757
 758 static void __devexit snd_opl3sa2_pnp_remove(struct pnp_dev * pdev)
 759 {
 760         snd_card_free(pnp_get_drvdata(pdev));
 761         pnp_set_drvdata(pdev, NULL);
 762 }
 763
 764 #ifdef CONFIG_PM
 765 static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
 766 {
 767         return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
 768 }
 769 static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
 770 {
 771         return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
 772 }
 773 #endif
 774
 775 static struct pnp_driver opl3sa2_pnp_driver = {
 776         .name = "snd-opl3sa2-pnpbios",
 777         .id_table = snd_opl3sa2_pnpbiosids,
 778         .probe = snd_opl3sa2_pnp_detect,
 779         .remove = __devexit_p(snd_opl3sa2_pnp_remove),
 780 #ifdef CONFIG_PM
 781         .suspend = snd_opl3sa2_pnp_suspend,
 782         .resume = snd_opl3sa2_pnp_resume,
 783 #endif
 784 };
 785
 786 static int __devinit snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
 787                                              const struct pnp_card_device_id *id)
 788 {
 789         static int dev;
 790         struct pnp_dev *pdev;
 791         int err;
 792         struct snd_card *card;
 793
 794         pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
 795         if (pdev == NULL) {
 796                 snd_printk(KERN_ERR PFX "can't get pnp device from id '%s'\n",
 797                            id->devs[0].id);
 798                 return -EBUSY;
 799         }
 800         for (; dev < SNDRV_CARDS; dev++) {
 801                 if (enable[dev] && isapnp[dev])
 802                         break;
 803         }
 804         if (dev >= SNDRV_CARDS)
 805                 return -ENODEV;
 806
 807         card = snd_opl3sa2_card_new(dev);
 808         if (! card)
 809                 return -ENOMEM;
 810         if ((err = snd_opl3sa2_pnp(dev, card->private_data, pdev)) < 0) {
 811                 snd_card_free(card);
 812                 return err;
 813         }
 814         snd_card_set_dev(card, &pdev->dev);
 815         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
 816                 snd_card_free(card);
 817                 return err;
 818         }
 819         pnp_set_card_drvdata(pcard, card);
 820         dev++;
 821         return 0;
 822 }
 823
 824 static void __devexit snd_opl3sa2_pnp_cremove(struct pnp_card_link * pcard)
 825 {
 826         snd_card_free(pnp_get_card_drvdata(pcard));
 827         pnp_set_card_drvdata(pcard, NULL);
 828 }
 829
 830 #ifdef CONFIG_PM
 831 static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
 832 {
 833         return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
 834 }
 835 static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
 836 {
 837         return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
 838 }
 839 #endif
 840
 841 static struct pnp_card_driver opl3sa2_pnpc_driver = {
 842         .flags = PNP_DRIVER_RES_DISABLE,
 843         .name = "snd-opl3sa2-cpnp",
 844         .id_table = snd_opl3sa2_pnpids,
 845         .probe = snd_opl3sa2_pnp_cdetect,
 846         .remove = __devexit_p(snd_opl3sa2_pnp_cremove),
 847 #ifdef CONFIG_PM
 848         .suspend = snd_opl3sa2_pnp_csuspend,
 849         .resume = snd_opl3sa2_pnp_cresume,
 850 #endif
 851 };
 852 #endif /* CONFIG_PNP */
 853
 854 static int __devinit snd_opl3sa2_isa_match(struct device *pdev,
 855                                            unsigned int dev)
 856 {
 857         if (!enable[dev])
 858                 return 0;
 859 #ifdef CONFIG_PNP
 860         if (isapnp[dev])
 861                 return 0;
 862 #endif
 863         if (port[dev] == SNDRV_AUTO_PORT) {
 864                 snd_printk(KERN_ERR PFX "specify port\n");
 865                 return 0;
 866         }
 867         if (wss_port[dev] == SNDRV_AUTO_PORT) {
 868                 snd_printk(KERN_ERR PFX "specify wss_port\n");
 869                 return 0;
 870         }
 871         if (fm_port[dev] == SNDRV_AUTO_PORT) {
 872                 snd_printk(KERN_ERR PFX "specify fm_port\n");
 873                 return 0;
 874         }
 875         if (midi_port[dev] == SNDRV_AUTO_PORT) {
 876                 snd_printk(KERN_ERR PFX "specify midi_port\n");
 877                 return 0;
 878         }
 879         return 1;
 880 }
 881
 882 static int __devinit snd_opl3sa2_isa_probe(struct device *pdev,
 883                                            unsigned int dev)
 884 {
 885         struct snd_card *card;
 886         int err;
 887
 888         card = snd_opl3sa2_card_new(dev);
 889         if (! card)
 890                 return -ENOMEM;
 891         snd_card_set_dev(card, pdev);
 892         if ((err = snd_opl3sa2_probe(card, dev)) < 0) {
 893                 snd_card_free(card);
 894                 return err;
 895         }
 896         dev_set_drvdata(pdev, card);
 897         return 0;
 898 }
 899
 900 static int __devexit snd_opl3sa2_isa_remove(struct device *devptr,
 901                                             unsigned int dev)
 902 {
 903         snd_card_free(dev_get_drvdata(devptr));
 904         dev_set_drvdata(devptr, NULL);
 905         return 0;
 906 }
 907
 908 #ifdef CONFIG_PM
 909 static int snd_opl3sa2_isa_suspend(struct device *dev, unsigned int n,
 910                                    pm_message_t state)
 911 {
 912         return snd_opl3sa2_suspend(dev_get_drvdata(dev), state);
 913 }
 914
 915 static int snd_opl3sa2_isa_resume(struct device *dev, unsigned int n)
 916 {
 917         return snd_opl3sa2_resume(dev_get_drvdata(dev));
 918 }
 919 #endif
 920
 921 #define DEV_NAME "opl3sa2"
 922
 923 static struct isa_driver snd_opl3sa2_isa_driver = {
 924         .match          = snd_opl3sa2_isa_match,
 925         .probe          = snd_opl3sa2_isa_probe,
 926         .remove         = __devexit_p(snd_opl3sa2_isa_remove),
 927 #ifdef CONFIG_PM
 928         .suspend        = snd_opl3sa2_isa_suspend,
 929         .resume         = snd_opl3sa2_isa_resume,
 930 #endif
 931         .driver         = {
 932                 .name   = DEV_NAME
 933         },
 934 };
 935
 936 static int __init alsa_card_opl3sa2_init(void)
 937 {
 938         int err;
 939
 940         err = isa_register_driver(&snd_opl3sa2_isa_driver, SNDRV_CARDS);
 941 #ifdef CONFIG_PNP
 942         if (!err)
 943                 isa_registered = 1;
 944
 945         err = pnp_register_driver(&opl3sa2_pnp_driver);
 946         if (!err)
 947                 pnp_registered = 1;
 948
 949         err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
 950         if (!err)
 951                 pnpc_registered = 1;
 952
 953         if (isa_registered || pnp_registered)
 954                 err = 0;
 955 #endif
 956         return err;
 957 }
 958
 959 static void __exit alsa_card_opl3sa2_exit(void)
 960 {
 961 #ifdef CONFIG_PNP
 962         if (pnpc_registered)
 963                 pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
 964         if (pnp_registered)
 965                 pnp_unregister_driver(&opl3sa2_pnp_driver);
 966         if (isa_registered)
 967 #endif
 968                 isa_unregister_driver(&snd_opl3sa2_isa_driver);
 969 }
 970
 971 module_init(alsa_card_opl3sa2_init)
 972 module_exit(alsa_card_opl3sa2_exit)