// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Driver for Yamaha OPL3-SA[2,3] soundcards
 *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
 */

#include <linux/init.h>
#include <linux/err.h>
#include <linux/isa.h>
#include <linux/interrupt.h>
#include <linux/pm.h>
#include <linux/pnp.h>
#include <linux/module.h>
#include <linux/io.h>
#include <sound/core.h>
#include <sound/wss.h>
#include <sound/mpu401.h>
#include <sound/opl3.h>
#include <sound/initval.h>
#include <sound/tlv.h>

MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
MODULE_DESCRIPTION("Yamaha OPL3SA2+");
MODULE_LICENSE("GPL");

static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
#ifdef CONFIG_PNP
static bool isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
#endif
static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0xf86,0x370,0x100 */
static long sb_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x220,0x240,0x260 */
static long wss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x530,0xe80,0xf40,0x604 */
static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* 0x388 */
static long midi_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;/* 0x330,0x300 */
static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 0,1,3,5,9,11,12,15 */
static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 1,3,5,6,7 */
static int opl3sa3_ymode[SNDRV_CARDS];   /* 0,1,2,3 */ /*SL Added*/

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for OPL3-SA soundcard.");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for OPL3-SA soundcard.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable OPL3-SA soundcard.");
#ifdef CONFIG_PNP
module_param_array(isapnp, bool, NULL, 0444);
MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
#endif
module_param_hw_array(port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(port, "Port # for OPL3-SA driver.");
module_param_hw_array(sb_port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(sb_port, "SB port # for OPL3-SA driver.");
module_param_hw_array(wss_port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(wss_port, "WSS port # for OPL3-SA driver.");
module_param_hw_array(fm_port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(fm_port, "FM port # for OPL3-SA driver.");
module_param_hw_array(midi_port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(midi_port, "MIDI port # for OPL3-SA driver.");
module_param_hw_array(irq, int, irq, NULL, 0444);
MODULE_PARM_DESC(irq, "IRQ # for OPL3-SA driver.");
module_param_hw_array(dma1, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma1, "DMA1 # for OPL3-SA driver.");
module_param_hw_array(dma2, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma2, "DMA2 # for OPL3-SA driver.");
module_param_array(opl3sa3_ymode, int, NULL, 0444);
MODULE_PARM_DESC(opl3sa3_ymode, "Speaker size selection for 3D Enhancement mode: Desktop/Large Notebook/Small Notebook/HiFi.");

#ifdef CONFIG_PNP
static int isa_registered;
static int pnp_registered;
static int pnpc_registered;
#endif

/* control ports */
#define OPL3SA2_PM_CTRL         0x01
#define OPL3SA2_SYS_CTRL                0x02
#define OPL3SA2_IRQ_CONFIG      0x03
#define OPL3SA2_IRQ_STATUS      0x04
#define OPL3SA2_DMA_CONFIG      0x06
#define OPL3SA2_MASTER_LEFT     0x07
#define OPL3SA2_MASTER_RIGHT    0x08
#define OPL3SA2_MIC             0x09
#define OPL3SA2_MISC            0x0A

/* opl3sa3 only */
#define OPL3SA3_DGTL_DOWN       0x12
#define OPL3SA3_ANLG_DOWN       0x13
#define OPL3SA3_WIDE            0x14
#define OPL3SA3_BASS            0x15
#define OPL3SA3_TREBLE          0x16

/* power management bits */
#define OPL3SA2_PM_ADOWN                0x20
#define OPL3SA2_PM_PSV          0x04            
#define OPL3SA2_PM_PDN          0x02
#define OPL3SA2_PM_PDX          0x01

#define OPL3SA2_PM_D0   0x00
#define OPL3SA2_PM_D3   (OPL3SA2_PM_ADOWN|OPL3SA2_PM_PSV|OPL3SA2_PM_PDN|OPL3SA2_PM_PDX)

struct snd_opl3sa2 {
        int version;            /* 2 or 3 */
        unsigned long port;     /* control port */
        struct resource *res_port; /* control port resource */
        int irq;
        int single_dma;
        spinlock_t reg_lock;
        struct snd_card *card;
        struct snd_hwdep *synth;
        struct snd_rawmidi *rmidi;
        struct snd_wss *wss;
        unsigned char ctlregs[0x20];
        int ymode;              /* SL added */
        struct snd_kcontrol *master_switch;
        struct snd_kcontrol *master_volume;
};

#define PFX     "opl3sa2: "

#ifdef CONFIG_PNP

static const struct pnp_device_id snd_opl3sa2_pnpbiosids[] = {
        { .id = "YMH0021" },
        { .id = "NMX2210" },    /* Gateway Solo 2500 */
        { .id = "" }            /* end */
};

MODULE_DEVICE_TABLE(pnp, snd_opl3sa2_pnpbiosids);

static const struct pnp_card_device_id snd_opl3sa2_pnpids[] = {
        /* Yamaha YMF719E-S (Genius Sound Maker 3DX) */
        { .id = "YMH0020", .devs = { { "YMH0021" } } },
        /* Yamaha OPL3-SA3 (integrated on Intel's Pentium II AL440LX motherboard) */
        { .id = "YMH0030", .devs = { { "YMH0021" } } },
        /* Yamaha OPL3-SA2 */
        { .id = "YMH0800", .devs = { { "YMH0021" } } },
        /* Yamaha OPL3-SA2 */
        { .id = "YMH0801", .devs = { { "YMH0021" } } },
        /* NeoMagic MagicWave 3DX */
        { .id = "NMX2200", .devs = { { "YMH2210" } } },
        /* NeoMagic MagicWave 3D */
        { .id = "NMX2200", .devs = { { "NMX2210" } } },
        /* --- */
        { .id = "" }    /* end */
};

MODULE_DEVICE_TABLE(pnp_card, snd_opl3sa2_pnpids);

#endif /* CONFIG_PNP */


/* read control port (w/o spinlock) */
static unsigned char __snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
{
        unsigned char result;
#if 0
        outb(0x1d, port);       /* password */
        dev_dbg(chip->card->dev, "read [0x%lx] = 0x%x\n", port, inb(port));
#endif
        outb(reg, chip->port);  /* register */
        result = inb(chip->port + 1);
#if 0
        dev_dbg(chip->card->dev, "read [0x%lx] = 0x%x [0x%x]\n",
               port, result, inb(port));
#endif
        return result;
}

/* read control port (with spinlock) */
static unsigned char snd_opl3sa2_read(struct snd_opl3sa2 *chip, unsigned char reg)
{
        guard(spinlock_irqsave)(&chip->reg_lock);
        return __snd_opl3sa2_read(chip, reg);
}

/* write control port (w/o spinlock) */
static void __snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
{
#if 0
        outb(0x1d, port);       /* password */
#endif
        outb(reg, chip->port);  /* register */
        outb(value, chip->port + 1);
        chip->ctlregs[reg] = value;
}

/* write control port (with spinlock) */
static void snd_opl3sa2_write(struct snd_opl3sa2 *chip, unsigned char reg, unsigned char value)
{
        guard(spinlock_irqsave)(&chip->reg_lock);
        __snd_opl3sa2_write(chip, reg, value);
}

static int snd_opl3sa2_detect(struct snd_card *card)
{
        struct snd_opl3sa2 *chip = card->private_data;
        unsigned long port;
        unsigned char tmp, tmp1;
        char str[2];

        port = chip->port;
        chip->res_port = devm_request_region(card->dev, port, 2,
                                             "OPL3-SA control");
        if (!chip->res_port) {
                dev_err(card->dev, "can't grab port 0x%lx\n", port);
                return -EBUSY;
        }
        chip->version = 0;
        tmp = snd_opl3sa2_read(chip, OPL3SA2_MISC);
        if (tmp == 0xff) {
                dev_dbg(card->dev, "OPL3-SA [0x%lx] detect = 0x%x\n", port, tmp);
                return -ENODEV;
        }
        switch (tmp & 0x07) {
        case 0x01:
                chip->version = 2; /* YMF711 */
                break;
        default:
                chip->version = 3;
                /* 0x02 - standard */
                /* 0x03 - YM715B */
                /* 0x04 - YM719 - OPL-SA4? */
                /* 0x05 - OPL3-SA3 - Libretto 100 */
                /* 0x07 - unknown - Neomagic MagicWave 3D */
                break;
        }
        str[0] = chip->version + '0';
        str[1] = 0;
        strcat(card->shortname, str);
        snd_opl3sa2_write(chip, OPL3SA2_MISC, tmp ^ 7);
        tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MISC);
        if (tmp1 != tmp) {
                dev_dbg(card->dev, "OPL3-SA [0x%lx] detect (1) = 0x%x (0x%x)\n", port, tmp, tmp1);
                return -ENODEV;
        }
        /* try if the MIC register is accessible */
        tmp = snd_opl3sa2_read(chip, OPL3SA2_MIC);
        snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x8a);
        tmp1 = snd_opl3sa2_read(chip, OPL3SA2_MIC);
        if ((tmp1 & 0x9f) != 0x8a) {
                dev_dbg(card->dev, "OPL3-SA [0x%lx] detect (2) = 0x%x (0x%x)\n", port, tmp, tmp1);
                return -ENODEV;
        }
        snd_opl3sa2_write(chip, OPL3SA2_MIC, 0x9f);
        /* initialization */
        /* Power Management - full on */
        snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);
        if (chip->version > 2) {
                /* ymode is bits 4&5 (of 0 to 7) on all but opl3sa2 versions */
                snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, (chip->ymode << 4));
        } else {
                /* default for opl3sa2 versions */
                snd_opl3sa2_write(chip, OPL3SA2_SYS_CTRL, 0x00);
        }
        snd_opl3sa2_write(chip, OPL3SA2_IRQ_CONFIG, 0x0d);      /* Interrupt Channel Configuration - IRQ A = OPL3 + MPU + WSS */
        if (chip->single_dma) {
                snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x03);      /* DMA Configuration - DMA A = WSS-R + WSS-P */
        } else {
                snd_opl3sa2_write(chip, OPL3SA2_DMA_CONFIG, 0x21);      /* DMA Configuration - DMA B = WSS-R, DMA A = WSS-P */
        }
        snd_opl3sa2_write(chip, OPL3SA2_MISC, 0x80 | (tmp & 7));        /* Miscellaneous - default */
        if (chip->version > 2) {
                snd_opl3sa2_write(chip, OPL3SA3_DGTL_DOWN, 0x00);       /* Digital Block Partial Power Down - default */
                snd_opl3sa2_write(chip, OPL3SA3_ANLG_DOWN, 0x00);       /* Analog Block Partial Power Down - default */
        }
        return 0;
}

static irqreturn_t snd_opl3sa2_interrupt(int irq, void *dev_id)
{
        unsigned short status;
        struct snd_card *card = dev_id;
        struct snd_opl3sa2 *chip;
        int handled = 0;

        if (card == NULL)
                return IRQ_NONE;

        chip = card->private_data;
        status = snd_opl3sa2_read(chip, OPL3SA2_IRQ_STATUS);

        if (status & 0x20) {
                handled = 1;
                snd_opl3_interrupt(chip->synth);
        }

        if ((status & 0x10) && chip->rmidi != NULL) {
                handled = 1;
                snd_mpu401_uart_interrupt(irq, chip->rmidi->private_data);
        }

        if (status & 0x07) {    /* TI,CI,PI */
                handled = 1;
                snd_wss_interrupt(irq, chip->wss);
        }

        if (status & 0x40) { /* hardware volume change */
                handled = 1;
                /* reading from Master Lch register at 0x07 clears this bit */
                snd_opl3sa2_read(chip, OPL3SA2_MASTER_RIGHT);
                snd_opl3sa2_read(chip, OPL3SA2_MASTER_LEFT);
                if (chip->master_switch && chip->master_volume) {
                        snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
                                        &chip->master_switch->id);
                        snd_ctl_notify(card, SNDRV_CTL_EVENT_MASK_VALUE,
                                        &chip->master_volume->id);
                }
        }
        return IRQ_RETVAL(handled);
}

#define OPL3SA2_SINGLE(xname, xindex, reg, shift, mask, invert) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_wss_info_single, \
  .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
  .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
#define OPL3SA2_SINGLE_TLV(xname, xindex, reg, shift, mask, invert, xtlv) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
  .name = xname, .index = xindex, \
  .info = snd_wss_info_single, \
  .get = snd_opl3sa2_get_single, .put = snd_opl3sa2_put_single, \
  .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24), \
  .tlv = { .p = (xtlv) } }

static int snd_opl3sa2_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
{
        struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
        int reg = kcontrol->private_value & 0xff;
        int shift = (kcontrol->private_value >> 8) & 0xff;
        int mask = (kcontrol->private_value >> 16) & 0xff;
        int invert = (kcontrol->private_value >> 24) & 0xff;

        guard(spinlock_irqsave)(&chip->reg_lock);
        ucontrol->value.integer.value[0] = (chip->ctlregs[reg] >> shift) & mask;
        if (invert)
                ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
        return 0;
}

static int snd_opl3sa2_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
{
        struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
        int reg = kcontrol->private_value & 0xff;
        int shift = (kcontrol->private_value >> 8) & 0xff;
        int mask = (kcontrol->private_value >> 16) & 0xff;
        int invert = (kcontrol->private_value >> 24) & 0xff;
        int change;
        unsigned short val, oval;
        
        val = (ucontrol->value.integer.value[0] & mask);
        if (invert)
                val = mask - val;
        val <<= shift;
        guard(spinlock_irqsave)(&chip->reg_lock);
        oval = chip->ctlregs[reg];
        val = (oval & ~(mask << shift)) | val;
        change = val != oval;
        __snd_opl3sa2_write(chip, reg, val);
        return change;
}

#define OPL3SA2_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
  .info = snd_wss_info_double, \
  .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
  .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
#define OPL3SA2_DOUBLE_TLV(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert, xtlv) \
{ .iface = SNDRV_CTL_ELEM_IFACE_MIXER, \
  .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_TLV_READ, \
  .name = xname, .index = xindex, \
  .info = snd_wss_info_double, \
  .get = snd_opl3sa2_get_double, .put = snd_opl3sa2_put_double, \
  .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22), \
  .tlv = { .p = (xtlv) } }

static int snd_opl3sa2_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
{
        struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
        int left_reg = kcontrol->private_value & 0xff;
        int right_reg = (kcontrol->private_value >> 8) & 0xff;
        int shift_left = (kcontrol->private_value >> 16) & 0x07;
        int shift_right = (kcontrol->private_value >> 19) & 0x07;
        int mask = (kcontrol->private_value >> 24) & 0xff;
        int invert = (kcontrol->private_value >> 22) & 1;
        
        guard(spinlock_irqsave)(&chip->reg_lock);
        ucontrol->value.integer.value[0] = (chip->ctlregs[left_reg] >> shift_left) & mask;
        ucontrol->value.integer.value[1] = (chip->ctlregs[right_reg] >> shift_right) & mask;
        if (invert) {
                ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
                ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
        }
        return 0;
}

static int snd_opl3sa2_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
{
        struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
        int left_reg = kcontrol->private_value & 0xff;
        int right_reg = (kcontrol->private_value >> 8) & 0xff;
        int shift_left = (kcontrol->private_value >> 16) & 0x07;
        int shift_right = (kcontrol->private_value >> 19) & 0x07;
        int mask = (kcontrol->private_value >> 24) & 0xff;
        int invert = (kcontrol->private_value >> 22) & 1;
        int change;
        unsigned short val1, val2, oval1, oval2;
        
        val1 = ucontrol->value.integer.value[0] & mask;
        val2 = ucontrol->value.integer.value[1] & mask;
        if (invert) {
                val1 = mask - val1;
                val2 = mask - val2;
        }
        val1 <<= shift_left;
        val2 <<= shift_right;
        guard(spinlock_irqsave)(&chip->reg_lock);
        if (left_reg != right_reg) {
                oval1 = chip->ctlregs[left_reg];
                oval2 = chip->ctlregs[right_reg];
                val1 = (oval1 & ~(mask << shift_left)) | val1;
                val2 = (oval2 & ~(mask << shift_right)) | val2;
                change = val1 != oval1 || val2 != oval2;
                __snd_opl3sa2_write(chip, left_reg, val1);
                __snd_opl3sa2_write(chip, right_reg, val2);
        } else {
                oval1 = chip->ctlregs[left_reg];
                val1 = (oval1 & ~((mask << shift_left) | (mask << shift_right))) | val1 | val2;
                change = val1 != oval1;
                __snd_opl3sa2_write(chip, left_reg, val1);
        }
        return change;
}

static const DECLARE_TLV_DB_SCALE(db_scale_master, -3000, 200, 0);
static const DECLARE_TLV_DB_SCALE(db_scale_5bit_12db_max, -3450, 150, 0);

static const struct snd_kcontrol_new snd_opl3sa2_controls[] = {
OPL3SA2_DOUBLE("Master Playback Switch", 0, 0x07, 0x08, 7, 7, 1, 1),
OPL3SA2_DOUBLE_TLV("Master Playback Volume", 0, 0x07, 0x08, 0, 0, 15, 1,
                   db_scale_master),
OPL3SA2_SINGLE("Mic Playback Switch", 0, 0x09, 7, 1, 1),
OPL3SA2_SINGLE_TLV("Mic Playback Volume", 0, 0x09, 0, 31, 1,
                   db_scale_5bit_12db_max),
OPL3SA2_SINGLE("ZV Port Switch", 0, 0x02, 0, 1, 0),
};

static const struct snd_kcontrol_new snd_opl3sa2_tone_controls[] = {
OPL3SA2_DOUBLE("3D Control - Wide", 0, 0x14, 0x14, 4, 0, 7, 0),
OPL3SA2_DOUBLE("Tone Control - Bass", 0, 0x15, 0x15, 4, 0, 7, 0),
OPL3SA2_DOUBLE("Tone Control - Treble", 0, 0x16, 0x16, 4, 0, 7, 0)
};

static void snd_opl3sa2_master_free(struct snd_kcontrol *kcontrol)
{
        struct snd_opl3sa2 *chip = snd_kcontrol_chip(kcontrol);
        chip->master_switch = NULL;
        chip->master_volume = NULL;
}

static int snd_opl3sa2_mixer(struct snd_card *card)
{
        struct snd_opl3sa2 *chip = card->private_data;
        struct snd_ctl_elem_id id1, id2;
        struct snd_kcontrol *kctl;
        unsigned int idx;
        int err;

        memset(&id1, 0, sizeof(id1));
        memset(&id2, 0, sizeof(id2));
        id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        /* reassign AUX0 to CD */
        strscpy(id1.name, "Aux Playback Switch");
        strscpy(id2.name, "CD Playback Switch");
        err = snd_ctl_rename_id(card, &id1, &id2);
        if (err < 0) {
                dev_err(card->dev, "Cannot rename opl3sa2 control\n");
                return err;
        }
        strscpy(id1.name, "Aux Playback Volume");
        strscpy(id2.name, "CD Playback Volume");
        err = snd_ctl_rename_id(card, &id1, &id2);
        if (err < 0) {
                dev_err(card->dev, "Cannot rename opl3sa2 control\n");
                return err;
        }
        /* reassign AUX1 to FM */
        strscpy(id1.name, "Aux Playback Switch"); id1.index = 1;
        strscpy(id2.name, "FM Playback Switch");
        err = snd_ctl_rename_id(card, &id1, &id2);
        if (err < 0) {
                dev_err(card->dev, "Cannot rename opl3sa2 control\n");
                return err;
        }
        strscpy(id1.name, "Aux Playback Volume");
        strscpy(id2.name, "FM Playback Volume");
        err = snd_ctl_rename_id(card, &id1, &id2);
        if (err < 0) {
                dev_err(card->dev, "Cannot rename opl3sa2 control\n");
                return err;
        }
        /* add OPL3SA2 controls */
        for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_controls); idx++) {
                kctl = snd_ctl_new1(&snd_opl3sa2_controls[idx], chip);
                err = snd_ctl_add(card, kctl);
                if (err < 0)
                        return err;
                switch (idx) {
                case 0: chip->master_switch = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
                case 1: chip->master_volume = kctl; kctl->private_free = snd_opl3sa2_master_free; break;
                }
        }
        if (chip->version > 2) {
                for (idx = 0; idx < ARRAY_SIZE(snd_opl3sa2_tone_controls); idx++) {
                        err = snd_ctl_add(card, snd_ctl_new1(&snd_opl3sa2_tone_controls[idx], chip));
                        if (err < 0)
                                return err;
                }
        }
        return 0;
}

/* Power Management support functions */
#ifdef CONFIG_PM
static int snd_opl3sa2_suspend(struct snd_card *card, pm_message_t state)
{
        if (card) {
                struct snd_opl3sa2 *chip = card->private_data;

                snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
                chip->wss->suspend(chip->wss);
                /* power down */
                snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D3);
        }

        return 0;
}

static int snd_opl3sa2_resume(struct snd_card *card)
{
        struct snd_opl3sa2 *chip;
        int i;

        if (!card)
                return 0;

        chip = card->private_data;
        /* power up */
        snd_opl3sa2_write(chip, OPL3SA2_PM_CTRL, OPL3SA2_PM_D0);

        /* restore registers */
        for (i = 2; i <= 0x0a; i++) {
                if (i != OPL3SA2_IRQ_STATUS)
                        snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
        }
        if (chip->version > 2) {
                for (i = 0x12; i <= 0x16; i++)
                        snd_opl3sa2_write(chip, i, chip->ctlregs[i]);
        }
        /* restore wss */
        chip->wss->resume(chip->wss);

        snd_power_change_state(card, SNDRV_CTL_POWER_D0);
        return 0;
}
#endif /* CONFIG_PM */

#ifdef CONFIG_PNP
static int snd_opl3sa2_pnp(int dev, struct snd_opl3sa2 *chip,
                           struct pnp_dev *pdev)
{
        if (pnp_activate_dev(pdev) < 0) {
                dev_err(chip->card->dev, "PnP configure failure (out of resources?)\n");
                return -EBUSY;
        }
        sb_port[dev] = pnp_port_start(pdev, 0);
        wss_port[dev] = pnp_port_start(pdev, 1);
        fm_port[dev] = pnp_port_start(pdev, 2);
        midi_port[dev] = pnp_port_start(pdev, 3);
        port[dev] = pnp_port_start(pdev, 4);
        dma1[dev] = pnp_dma(pdev, 0);
        dma2[dev] = pnp_dma(pdev, 1);
        irq[dev] = pnp_irq(pdev, 0);
        dev_dbg(chip->card->dev, "%sPnP OPL3-SA: sb port=0x%lx, wss port=0x%lx, fm port=0x%lx, midi port=0x%lx\n",
                pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", sb_port[dev], wss_port[dev], fm_port[dev], midi_port[dev]);
        dev_dbg(chip->card->dev, "%sPnP OPL3-SA: control port=0x%lx, dma1=%i, dma2=%i, irq=%i\n",
                pnp_device_is_pnpbios(pdev) ? "BIOS" : "ISA", port[dev], dma1[dev], dma2[dev], irq[dev]);
        return 0;
}
#endif /* CONFIG_PNP */

static int snd_opl3sa2_card_new(struct device *pdev, int dev,
                                struct snd_card **cardp)
{
        struct snd_card *card;
        struct snd_opl3sa2 *chip;
        int err;

        err = snd_devm_card_new(pdev, index[dev], id[dev], THIS_MODULE,
                                sizeof(struct snd_opl3sa2), &card);
        if (err < 0)
                return err;
        strscpy(card->driver, "OPL3SA2");
        strscpy(card->shortname, "Yamaha OPL3-SA");
        chip = card->private_data;
        spin_lock_init(&chip->reg_lock);
        chip->irq = -1;
        *cardp = card;
        return 0;
}

static int snd_opl3sa2_probe(struct snd_card *card, int dev)
{
        int xirq, xdma1, xdma2;
        struct snd_opl3sa2 *chip;
        struct snd_wss *wss;
        struct snd_opl3 *opl3;
        int err;

        /* initialise this card from supplied (or default) parameter*/ 
        chip = card->private_data;
        chip->card = card;
        chip->ymode = opl3sa3_ymode[dev] & 0x03 ;
        chip->port = port[dev];
        xirq = irq[dev];
        xdma1 = dma1[dev];
        xdma2 = dma2[dev];
        if (xdma2 < 0)
                chip->single_dma = 1;
        err = snd_opl3sa2_detect(card);
        if (err < 0)
                return err;
        err = devm_request_irq(card->dev, xirq, snd_opl3sa2_interrupt, 0,
                               "OPL3-SA2", card);
        if (err) {
                dev_err(card->dev, "can't grab IRQ %d\n", xirq);
                return -ENODEV;
        }
        chip->irq = xirq;
        card->sync_irq = chip->irq;
        err = snd_wss_create(card,
                             wss_port[dev] + 4, -1,
                             xirq, xdma1, xdma2,
                             WSS_HW_OPL3SA2, WSS_HWSHARE_IRQ, &wss);
        if (err < 0) {
                dev_dbg(card->dev, "Oops, WSS not detected at 0x%lx\n", wss_port[dev] + 4);
                return err;
        }
        chip->wss = wss;
        err = snd_wss_pcm(wss, 0);
        if (err < 0)
                return err;
        err = snd_wss_mixer(wss);
        if (err < 0)
                return err;
        err = snd_opl3sa2_mixer(card);
        if (err < 0)
                return err;
        err = snd_wss_timer(wss, 0);
        if (err < 0)
                return err;
        if (fm_port[dev] >= 0x340 && fm_port[dev] < 0x400) {
                err = snd_opl3_create(card, fm_port[dev],
                                      fm_port[dev] + 2,
                                      OPL3_HW_OPL3, 0, &opl3);
                if (err < 0)
                        return err;
                err = snd_opl3_timer_new(opl3, 1, 2);
                if (err < 0)
                        return err;
                err = snd_opl3_hwdep_new(opl3, 0, 1, &chip->synth);
                if (err < 0)
                        return err;
        }
        if (midi_port[dev] >= 0x300 && midi_port[dev] < 0x340) {
                err = snd_mpu401_uart_new(card, 0, MPU401_HW_OPL3SA2,
                                          midi_port[dev],
                                          MPU401_INFO_IRQ_HOOK, -1,
                                          &chip->rmidi);
                if (err < 0)
                        return err;
        }
        sprintf(card->longname, "%s at 0x%lx, irq %d, dma %d",
                card->shortname, chip->port, xirq, xdma1);
        if (xdma2 >= 0)
                sprintf(card->longname + strlen(card->longname), "&%d", xdma2);

        return snd_card_register(card);
}

#ifdef CONFIG_PNP
static int snd_opl3sa2_pnp_detect(struct pnp_dev *pdev,
                                  const struct pnp_device_id *id)
{
        static int dev;
        int err;
        struct snd_card *card;

        if (pnp_device_is_isapnp(pdev))
                return -ENOENT; /* we have another procedure - card */
        for (; dev < SNDRV_CARDS; dev++) {
                if (enable[dev] && isapnp[dev])
                        break;
        }
        if (dev >= SNDRV_CARDS)
                return -ENODEV;

        err = snd_opl3sa2_card_new(&pdev->dev, dev, &card);
        if (err < 0)
                return err;
        err = snd_opl3sa2_pnp(dev, card->private_data, pdev);
        if (err < 0)
                return err;
        err = snd_opl3sa2_probe(card, dev);
        if (err < 0)
                return err;
        pnp_set_drvdata(pdev, card);
        dev++;
        return 0;
}

#ifdef CONFIG_PM
static int snd_opl3sa2_pnp_suspend(struct pnp_dev *pdev, pm_message_t state)
{
        return snd_opl3sa2_suspend(pnp_get_drvdata(pdev), state);
}
static int snd_opl3sa2_pnp_resume(struct pnp_dev *pdev)
{
        return snd_opl3sa2_resume(pnp_get_drvdata(pdev));
}
#endif

static struct pnp_driver opl3sa2_pnp_driver = {
        .name = "snd-opl3sa2-pnpbios",
        .id_table = snd_opl3sa2_pnpbiosids,
        .probe = snd_opl3sa2_pnp_detect,
#ifdef CONFIG_PM
        .suspend = snd_opl3sa2_pnp_suspend,
        .resume = snd_opl3sa2_pnp_resume,
#endif
};

static int snd_opl3sa2_pnp_cdetect(struct pnp_card_link *pcard,
                                   const struct pnp_card_device_id *id)
{
        static int dev;
        struct pnp_dev *pdev;
        int err;
        struct snd_card *card;

        pdev = pnp_request_card_device(pcard, id->devs[0].id, NULL);
        if (pdev == NULL) {
                dev_err(&pcard->card->dev, "can't get pnp device from id '%s'\n",
                           id->devs[0].id);
                return -EBUSY;
        }
        for (; dev < SNDRV_CARDS; dev++) {
                if (enable[dev] && isapnp[dev])
                        break;
        }
        if (dev >= SNDRV_CARDS)
                return -ENODEV;

        err = snd_opl3sa2_card_new(&pdev->dev, dev, &card);
        if (err < 0)
                return err;
        err = snd_opl3sa2_pnp(dev, card->private_data, pdev);
        if (err < 0)
                return err;
        err = snd_opl3sa2_probe(card, dev);
        if (err < 0)
                return err;
        pnp_set_card_drvdata(pcard, card);
        dev++;
        return 0;
}

#ifdef CONFIG_PM
static int snd_opl3sa2_pnp_csuspend(struct pnp_card_link *pcard, pm_message_t state)
{
        return snd_opl3sa2_suspend(pnp_get_card_drvdata(pcard), state);
}
static int snd_opl3sa2_pnp_cresume(struct pnp_card_link *pcard)
{
        return snd_opl3sa2_resume(pnp_get_card_drvdata(pcard));
}
#endif

static struct pnp_card_driver opl3sa2_pnpc_driver = {
        .flags = PNP_DRIVER_RES_DISABLE,
        .name = "snd-opl3sa2-cpnp",
        .id_table = snd_opl3sa2_pnpids,
        .probe = snd_opl3sa2_pnp_cdetect,
#ifdef CONFIG_PM
        .suspend = snd_opl3sa2_pnp_csuspend,
        .resume = snd_opl3sa2_pnp_cresume,
#endif
};
#endif /* CONFIG_PNP */

static int snd_opl3sa2_isa_match(struct device *pdev,
                                 unsigned int dev)
{
        if (!enable[dev])
                return 0;
#ifdef CONFIG_PNP
        if (isapnp[dev])
                return 0;
#endif
        if (port[dev] == SNDRV_AUTO_PORT) {
                dev_err(pdev, "specify port\n");
                return 0;
        }
        if (wss_port[dev] == SNDRV_AUTO_PORT) {
                dev_err(pdev, "specify wss_port\n");
                return 0;
        }
        if (fm_port[dev] == SNDRV_AUTO_PORT) {
                dev_err(pdev, "specify fm_port\n");
                return 0;
        }
        if (midi_port[dev] == SNDRV_AUTO_PORT) {
                dev_err(pdev, "specify midi_port\n");
                return 0;
        }
        return 1;
}

static int snd_opl3sa2_isa_probe(struct device *pdev,
                                 unsigned int dev)
{
        struct snd_card *card;
        int err;

        err = snd_opl3sa2_card_new(pdev, dev, &card);
        if (err < 0)
                return err;
        err = snd_opl3sa2_probe(card, dev);
        if (err < 0)
                return err;
        dev_set_drvdata(pdev, card);
        return 0;
}

#ifdef CONFIG_PM
static int snd_opl3sa2_isa_suspend(struct device *dev, unsigned int n,
                                   pm_message_t state)
{
        return snd_opl3sa2_suspend(dev_get_drvdata(dev), state);
}

static int snd_opl3sa2_isa_resume(struct device *dev, unsigned int n)
{
        return snd_opl3sa2_resume(dev_get_drvdata(dev));
}
#endif

#define DEV_NAME "opl3sa2"

static struct isa_driver snd_opl3sa2_isa_driver = {
        .match          = snd_opl3sa2_isa_match,
        .probe          = snd_opl3sa2_isa_probe,
#ifdef CONFIG_PM
        .suspend        = snd_opl3sa2_isa_suspend,
        .resume         = snd_opl3sa2_isa_resume,
#endif
        .driver         = {
                .name   = DEV_NAME
        },
};

static int __init alsa_card_opl3sa2_init(void)
{
        int err;

        err = isa_register_driver(&snd_opl3sa2_isa_driver, SNDRV_CARDS);
#ifdef CONFIG_PNP
        if (!err)
                isa_registered = 1;

        err = pnp_register_driver(&opl3sa2_pnp_driver);
        if (!err)
                pnp_registered = 1;

        err = pnp_register_card_driver(&opl3sa2_pnpc_driver);
        if (!err)
                pnpc_registered = 1;

        if (isa_registered || pnp_registered)
                err = 0;
#endif
        return err;
}

static void __exit alsa_card_opl3sa2_exit(void)
{
#ifdef CONFIG_PNP
        if (pnpc_registered)
                pnp_unregister_card_driver(&opl3sa2_pnpc_driver);
        if (pnp_registered)
                pnp_unregister_driver(&opl3sa2_pnp_driver);
        if (isa_registered)
#endif
                isa_unregister_driver(&snd_opl3sa2_isa_driver);
}

module_init(alsa_card_opl3sa2_init)
module_exit(alsa_card_opl3sa2_exit)