// SPDX-License-Identifier: GPL-2.0-or-later
/*
 *  Driver for Gallant SC-6000 soundcard. This card is also known as
 *  Audio Excel DSP 16 or Zoltrix AV302.
 *  These cards use CompuMedia ASC-9308 chip + AD1848 codec.
 *  SC-6600 and SC-7000 cards are also supported. They are based on
 *  CompuMedia ASC-9408 chip and CS4231 codec.
 *
 *  Copyright (C) 2007 Krzysztof Helt <krzysztof.h1@wp.pl>
 *
 *  I don't have documentation for this card. I used the driver
 *  for OSS/Free included in the kernel source as reference.
 */

#include <linux/module.h>
#include <linux/delay.h>
#include <linux/isa.h>
#include <linux/io.h>
#include <asm/dma.h>
#include <sound/core.h>
#include <sound/wss.h>
#include <sound/opl3.h>
#include <sound/mpu401.h>
#include <sound/control.h>
#define SNDRV_LEGACY_FIND_FREE_IRQ
#define SNDRV_LEGACY_FIND_FREE_DMA
#include <sound/initval.h>

MODULE_AUTHOR("Krzysztof Helt");
MODULE_DESCRIPTION("Gallant SC-6000");
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; /* Enable this card */
static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0x220, 0x240 */
static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 5, 7, 9, 10, 11 */
static long mss_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x530, 0xe80 */
static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
                                                /* 0x300, 0x310, 0x320, 0x330 */
static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* 5, 7, 9, 10, 0 */
static int dma[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;        /* 0, 1, 3 */
static bool joystick[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = false };

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "Index value for sc-6000 based soundcard.");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string for sc-6000 based soundcard.");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "Enable sc-6000 based soundcard.");
module_param_hw_array(port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(port, "Port # for sc-6000 driver.");
module_param_hw_array(mss_port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(mss_port, "MSS Port # for sc-6000 driver.");
module_param_hw_array(mpu_port, long, ioport, NULL, 0444);
MODULE_PARM_DESC(mpu_port, "MPU-401 port # for sc-6000 driver.");
module_param_hw_array(irq, int, irq, NULL, 0444);
MODULE_PARM_DESC(irq, "IRQ # for sc-6000 driver.");
module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for sc-6000 driver.");
module_param_hw_array(dma, int, dma, NULL, 0444);
MODULE_PARM_DESC(dma, "DMA # for sc-6000 driver.");
module_param_array(joystick, bool, NULL, 0444);
MODULE_PARM_DESC(joystick, "Enable gameport.");

/*
 * Commands of SC6000's DSP (SBPRO+special).
 * Some of them are COMMAND_xx, in the future they may change.
 */
#define WRITE_MDIRQ_CFG 0x50    /* Set M&I&DRQ mask (the real config)   */
#define COMMAND_52      0x52    /*                                      */
#define READ_HARD_CFG   0x58    /* Read Hardware Config (I/O base etc)  */
#define COMMAND_5C      0x5c    /*                                      */
#define COMMAND_60      0x60    /*                                      */
#define COMMAND_66      0x66    /*                                      */
#define COMMAND_6C      0x6c    /*                                      */
#define COMMAND_6E      0x6e    /*                                      */
#define COMMAND_88      0x88    /* Unknown command                      */
#define DSP_INIT_MSS    0x8c    /* Enable Microsoft Sound System mode   */
#define COMMAND_C5      0xc5    /*                                      */
#define GET_DSP_VERSION 0xe1    /* Get DSP Version                      */
#define GET_DSP_COPYRIGHT 0xe3  /* Get DSP Copyright                    */

/*
 * Offsets of SC6000 DSP I/O ports. The offset is added to base I/O port
 * to have the actual I/O port.
 * Register permissions are:
 * (wo) == Write Only
 * (ro) == Read  Only
 * (w-) == Write
 * (r-) == Read
 */
#define DSP_RESET       0x06    /* offset of DSP RESET          (wo) */
#define DSP_READ        0x0a    /* offset of DSP READ           (ro) */
#define DSP_WRITE       0x0c    /* offset of DSP WRITE          (w-) */
#define DSP_COMMAND     0x0c    /* offset of DSP COMMAND        (w-) */
#define DSP_STATUS      0x0c    /* offset of DSP STATUS         (r-) */
#define DSP_DATAVAIL    0x0e    /* offset of DSP DATA AVAILABLE (ro) */

#define PFX "sc6000: "
#define DRV_NAME "SC-6000"

/* hardware dependent functions */

/*
 * sc6000_irq_to_softcfg - Decode irq number into cfg code.
 */
static unsigned char sc6000_irq_to_softcfg(int irq)
{
        unsigned char val = 0;

        switch (irq) {
        case 5:
                val = 0x28;
                break;
        case 7:
                val = 0x8;
                break;
        case 9:
                val = 0x10;
                break;
        case 10:
                val = 0x18;
                break;
        case 11:
                val = 0x20;
                break;
        default:
                break;
        }
        return val;
}

/*
 * sc6000_dma_to_softcfg - Decode dma number into cfg code.
 */
static unsigned char sc6000_dma_to_softcfg(int dma)
{
        unsigned char val = 0;

        switch (dma) {
        case 0:
                val = 1;
                break;
        case 1:
                val = 2;
                break;
        case 3:
                val = 3;
                break;
        default:
                break;
        }
        return val;
}

/*
 * sc6000_mpu_irq_to_softcfg - Decode MPU-401 irq number into cfg code.
 */
static unsigned char sc6000_mpu_irq_to_softcfg(int mpu_irq)
{
        unsigned char val = 0;

        switch (mpu_irq) {
        case 5:
                val = 4;
                break;
        case 7:
                val = 0x44;
                break;
        case 9:
                val = 0x84;
                break;
        case 10:
                val = 0xc4;
                break;
        default:
                break;
        }
        return val;
}

static int sc6000_wait_data(char __iomem *vport)
{
        int loop = 1000;
        unsigned char val = 0;

        do {
                val = ioread8(vport + DSP_DATAVAIL);
                if (val & 0x80)
                        return 0;
                cpu_relax();
        } while (loop--);

        return -EAGAIN;
}

static int sc6000_read(char __iomem *vport)
{
        if (sc6000_wait_data(vport))
                return -EBUSY;

        return ioread8(vport + DSP_READ);

}

static int sc6000_write(struct device *devptr, char __iomem *vport, int cmd)
{
        unsigned char val;
        int loop = 500000;

        do {
                val = ioread8(vport + DSP_STATUS);
                /*
                 * DSP ready to receive data if bit 7 of val == 0
                 */
                if (!(val & 0x80)) {
                        iowrite8(cmd, vport + DSP_COMMAND);
                        return 0;
                }
                cpu_relax();
        } while (loop--);

        dev_err(devptr, "DSP Command (0x%x) timeout.\n", cmd);

        return -EIO;
}

static int sc6000_dsp_get_answer(struct device *devptr,
                                 char __iomem *vport, int command,
                                 char *data, int data_len)
{
        int len = 0;

        if (sc6000_write(devptr, vport, command)) {
                dev_err(devptr, "CMD 0x%x: failed!\n", command);
                return -EIO;
        }

        do {
                int val = sc6000_read(vport);

                if (val < 0)
                        break;

                data[len++] = val;

        } while (len < data_len);

        /*
         * If no more data available, return to the caller, no error if len>0.
         * We have no other way to know when the string is finished.
         */
        return len ? len : -EIO;
}

static int sc6000_dsp_reset(char __iomem *vport)
{
        iowrite8(1, vport + DSP_RESET);
        udelay(10);
        iowrite8(0, vport + DSP_RESET);
        udelay(20);
        if (sc6000_read(vport) == 0xaa)
                return 0;
        return -ENODEV;
}

/* detection and initialization */
static int sc6000_hw_cfg_write(struct device *devptr,
                               char __iomem *vport, const int *cfg)
{
        if (sc6000_write(devptr, vport, COMMAND_6C) < 0) {
                dev_warn(devptr, "CMD 0x%x: failed!\n", COMMAND_6C);
                return -EIO;
        }
        if (sc6000_write(devptr, vport, COMMAND_5C) < 0) {
                dev_err(devptr, "CMD 0x%x: failed!\n", COMMAND_5C);
                return -EIO;
        }
        if (sc6000_write(devptr, vport, cfg[0]) < 0) {
                dev_err(devptr, "DATA 0x%x: failed!\n", cfg[0]);
                return -EIO;
        }
        if (sc6000_write(devptr, vport, cfg[1]) < 0) {
                dev_err(devptr, "DATA 0x%x: failed!\n", cfg[1]);
                return -EIO;
        }
        if (sc6000_write(devptr, vport, COMMAND_C5) < 0) {
                dev_err(devptr, "CMD 0x%x: failed!\n", COMMAND_C5);
                return -EIO;
        }

        return 0;
}

static int sc6000_cfg_write(struct device *devptr,
                            char __iomem *vport, unsigned char softcfg)
{

        if (sc6000_write(devptr, vport, WRITE_MDIRQ_CFG)) {
                dev_err(devptr, "CMD 0x%x: failed!\n", WRITE_MDIRQ_CFG);
                return -EIO;
        }
        if (sc6000_write(devptr, vport, softcfg)) {
                dev_err(devptr, "%s: failed!\n", __func__);
                return -EIO;
        }
        return 0;
}

static int sc6000_setup_board(struct device *devptr,
                              char __iomem *vport, int config)
{
        int loop = 10;

        do {
                if (sc6000_write(devptr, vport, COMMAND_88)) {
                        dev_err(devptr, "CMD 0x%x: failed!\n",
                                COMMAND_88);
                        return -EIO;
                }
        } while ((sc6000_wait_data(vport) < 0) && loop--);

        if (sc6000_read(vport) < 0) {
                dev_err(devptr, "sc6000_read after CMD 0x%x: failed\n",
                        COMMAND_88);
                return -EIO;
        }

        if (sc6000_cfg_write(devptr, vport, config))
                return -ENODEV;

        return 0;
}

static int sc6000_init_mss(struct device *devptr,
                           char __iomem *vport, int config,
                           char __iomem *vmss_port, int mss_config)
{
        if (sc6000_write(devptr, vport, DSP_INIT_MSS)) {
                dev_err(devptr, "%s [0x%x]: failed!\n", __func__,
                        DSP_INIT_MSS);
                return -EIO;
        }

        msleep(10);

        if (sc6000_cfg_write(devptr, vport, config))
                return -EIO;

        iowrite8(mss_config, vmss_port);

        return 0;
}

static void sc6000_hw_cfg_encode(struct device *devptr,
                                 char __iomem *vport, int *cfg,
                                 long xport, long xmpu,
                                 long xmss_port, int joystick)
{
        cfg[0] = 0;
        cfg[1] = 0;
        if (xport == 0x240)
                cfg[0] |= 1;
        if (xmpu != SNDRV_AUTO_PORT) {
                cfg[0] |= (xmpu & 0x30) >> 2;
                cfg[1] |= 0x20;
        }
        if (xmss_port == 0xe80)
                cfg[0] |= 0x10;
        cfg[0] |= 0x40;         /* always set */
        if (!joystick)
                cfg[0] |= 0x02;
        cfg[1] |= 0x80;         /* enable WSS system */
        cfg[1] &= ~0x40;        /* disable IDE */
        dev_dbg(devptr, "hw cfg %x, %x\n", cfg[0], cfg[1]);
}

static int sc6000_init_board(struct device *devptr,
                             char __iomem *vport,
                             char __iomem *vmss_port, int dev)
{
        char answer[15];
        char version[2];
        int mss_config = sc6000_irq_to_softcfg(irq[dev]) |
                         sc6000_dma_to_softcfg(dma[dev]);
        int config = mss_config |
                     sc6000_mpu_irq_to_softcfg(mpu_irq[dev]);
        int err;
        int old = 0;

        err = sc6000_dsp_reset(vport);
        if (err < 0) {
                dev_err(devptr, "sc6000_dsp_reset: failed!\n");
                return err;
        }

        memset(answer, 0, sizeof(answer));
        err = sc6000_dsp_get_answer(devptr, vport, GET_DSP_COPYRIGHT, answer, 15);
        if (err <= 0) {
                dev_err(devptr, "sc6000_dsp_copyright: failed!\n");
                return -ENODEV;
        }
        /*
         * My SC-6000 card return "SC-6000" in DSPCopyright, so
         * if we have something different, we have to be warned.
         */
        if (strncmp("SC-6000", answer, 7))
                dev_warn(devptr, "Warning: non SC-6000 audio card!\n");

        if (sc6000_dsp_get_answer(devptr, vport, GET_DSP_VERSION, version, 2) < 2) {
                dev_err(devptr, "sc6000_dsp_version: failed!\n");
                return -ENODEV;
        }
        dev_info(devptr, "Detected model: %s, DSP version %d.%d\n",
                answer, version[0], version[1]);

        /* set configuration */
        sc6000_write(devptr, vport, COMMAND_5C);
        if (sc6000_read(vport) < 0)
                old = 1;

        if (!old) {
                int cfg[2];
                sc6000_hw_cfg_encode(devptr,
                                     vport, &cfg[0], port[dev], mpu_port[dev],
                                     mss_port[dev], joystick[dev]);
                if (sc6000_hw_cfg_write(devptr, vport, cfg) < 0) {
                        dev_err(devptr, "sc6000_hw_cfg_write: failed!\n");
                        return -EIO;
                }
        }
        err = sc6000_setup_board(devptr, vport, config);
        if (err < 0) {
                dev_err(devptr, "sc6000_setup_board: failed!\n");
                return -ENODEV;
        }

        sc6000_dsp_reset(vport);

        if (!old) {
                sc6000_write(devptr, vport, COMMAND_60);
                sc6000_write(devptr, vport, 0x02);
                sc6000_dsp_reset(vport);
        }

        err = sc6000_setup_board(devptr, vport, config);
        if (err < 0) {
                dev_err(devptr, "sc6000_setup_board: failed!\n");
                return -ENODEV;
        }
        err = sc6000_init_mss(devptr, vport, config, vmss_port, mss_config);
        if (err < 0) {
                dev_err(devptr, "Cannot initialize Microsoft Sound System mode.\n");
                return -ENODEV;
        }

        return 0;
}

static int snd_sc6000_mixer(struct snd_wss *chip)
{
        struct snd_card *card = chip->card;
        struct snd_ctl_elem_id id1, id2;
        int err;

        memset(&id1, 0, sizeof(id1));
        memset(&id2, 0, sizeof(id2));
        id1.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
        /* reassign AUX0 to FM */
        strscpy(id1.name, "Aux Playback Switch");
        strscpy(id2.name, "FM Playback Switch");
        err = snd_ctl_rename_id(card, &id1, &id2);
        if (err < 0)
                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)
                return err;
        /* reassign AUX1 to CD */
        strscpy(id1.name, "Aux Playback Switch"); id1.index = 1;
        strscpy(id2.name, "CD Playback Switch");
        err = snd_ctl_rename_id(card, &id1, &id2);
        if (err < 0)
                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)
                return err;
        return 0;
}

static int snd_sc6000_match(struct device *devptr, unsigned int dev)
{
        if (!enable[dev])
                return 0;
        if (port[dev] == SNDRV_AUTO_PORT) {
                dev_err(devptr, "specify IO port\n");
                return 0;
        }
        if (mss_port[dev] == SNDRV_AUTO_PORT) {
                dev_err(devptr, "specify MSS port\n");
                return 0;
        }
        if (port[dev] != 0x220 && port[dev] != 0x240) {
                dev_err(devptr, "Port must be 0x220 or 0x240\n");
                return 0;
        }
        if (mss_port[dev] != 0x530 && mss_port[dev] != 0xe80) {
                dev_err(devptr, "MSS port must be 0x530 or 0xe80\n");
                return 0;
        }
        if (irq[dev] != SNDRV_AUTO_IRQ && !sc6000_irq_to_softcfg(irq[dev])) {
                dev_err(devptr, "invalid IRQ %d\n", irq[dev]);
                return 0;
        }
        if (dma[dev] != SNDRV_AUTO_DMA && !sc6000_dma_to_softcfg(dma[dev])) {
                dev_err(devptr, "invalid DMA %d\n", dma[dev]);
                return 0;
        }
        if (mpu_port[dev] != SNDRV_AUTO_PORT &&
            (mpu_port[dev] & ~0x30L) != 0x300) {
                dev_err(devptr, "invalid MPU-401 port %lx\n",
                        mpu_port[dev]);
                return 0;
        }
        if (mpu_port[dev] != SNDRV_AUTO_PORT &&
            mpu_irq[dev] != SNDRV_AUTO_IRQ && mpu_irq[dev] != 0 &&
            !sc6000_mpu_irq_to_softcfg(mpu_irq[dev])) {
                dev_err(devptr, "invalid MPU-401 IRQ %d\n", mpu_irq[dev]);
                return 0;
        }
        return 1;
}

static void snd_sc6000_free(struct snd_card *card)
{
        char __iomem *vport = (char __force __iomem *)card->private_data;

        if (vport)
                sc6000_setup_board(card->dev, vport, 0);
}

static int __snd_sc6000_probe(struct device *devptr, unsigned int dev)
{
        static const int possible_irqs[] = { 5, 7, 9, 10, 11, -1 };
        static const int possible_dmas[] = { 1, 3, 0, -1 };
        int err;
        int xirq = irq[dev];
        int xdma = dma[dev];
        struct snd_card *card;
        struct snd_wss *chip;
        struct snd_opl3 *opl3;
        char __iomem *vport;
        char __iomem *vmss_port;

        err = snd_devm_card_new(devptr, index[dev], id[dev], THIS_MODULE,
                                0, &card);
        if (err < 0)
                return err;

        if (xirq == SNDRV_AUTO_IRQ) {
                xirq = snd_legacy_find_free_irq(possible_irqs);
                if (xirq < 0) {
                        dev_err(devptr, "unable to find a free IRQ\n");
                        return -EBUSY;
                }
        }

        if (xdma == SNDRV_AUTO_DMA) {
                xdma = snd_legacy_find_free_dma(possible_dmas);
                if (xdma < 0) {
                        dev_err(devptr, "unable to find a free DMA\n");
                        return -EBUSY;
                }
        }

        if (!devm_request_region(devptr, port[dev], 0x10, DRV_NAME)) {
                dev_err(devptr, "I/O port region is already in use.\n");
                return -EBUSY;
        }
        vport = devm_ioport_map(devptr, port[dev], 0x10);
        if (!vport) {
                dev_err(devptr, "I/O port cannot be iomapped.\n");
                return -EBUSY;
        }
        card->private_data = (void __force *)vport;

        /* to make it marked as used */
        if (!devm_request_region(devptr, mss_port[dev], 4, DRV_NAME)) {
                dev_err(devptr,
                        "SC-6000 port I/O port region is already in use.\n");
                return -EBUSY;
        }
        vmss_port = devm_ioport_map(devptr, mss_port[dev], 4);
        if (!vmss_port) {
                dev_err(devptr, "MSS port I/O cannot be iomapped.\n");
                return -EBUSY;
        }

        dev_dbg(devptr, "Initializing BASE[0x%lx] IRQ[%d] DMA[%d] MIRQ[%d]\n",
                port[dev], xirq, xdma,
                mpu_irq[dev] == SNDRV_AUTO_IRQ ? 0 : mpu_irq[dev]);

        err = sc6000_init_board(devptr, vport, vmss_port, dev);
        if (err < 0)
                return err;
        card->private_free = snd_sc6000_free;

        err = snd_wss_create(card, mss_port[dev] + 4,  -1, xirq, xdma, -1,
                             WSS_HW_DETECT, 0, &chip);
        if (err < 0)
                return err;

        err = snd_wss_pcm(chip, 0);
        if (err < 0) {
                dev_err(devptr, "error creating new WSS PCM device\n");
                return err;
        }
        err = snd_wss_mixer(chip);
        if (err < 0) {
                dev_err(devptr, "error creating new WSS mixer\n");
                return err;
        }
        err = snd_sc6000_mixer(chip);
        if (err < 0) {
                dev_err(devptr, "the mixer rewrite failed\n");
                return err;
        }
        if (snd_opl3_create(card,
                            0x388, 0x388 + 2,
                            OPL3_HW_AUTO, 0, &opl3) < 0) {
                dev_err(devptr, "no OPL device at 0x%x-0x%x ?\n",
                        0x388, 0x388 + 2);
        } else {
                err = snd_opl3_hwdep_new(opl3, 0, 1, NULL);
                if (err < 0)
                        return err;
        }

        if (mpu_port[dev] != SNDRV_AUTO_PORT) {
                if (mpu_irq[dev] == SNDRV_AUTO_IRQ)
                        mpu_irq[dev] = -1;
                if (snd_mpu401_uart_new(card, 0,
                                        MPU401_HW_MPU401,
                                        mpu_port[dev], 0,
                                        mpu_irq[dev], NULL) < 0)
                        dev_err(devptr, "no MPU-401 device at 0x%lx ?\n",
                                mpu_port[dev]);
        }

        strscpy(card->driver, DRV_NAME);
        strscpy(card->shortname, "SC-6000");
        sprintf(card->longname, "Gallant SC-6000 at 0x%lx, irq %d, dma %d",
                mss_port[dev], xirq, xdma);

        err = snd_card_register(card);
        if (err < 0)
                return err;

        dev_set_drvdata(devptr, card);
        return 0;
}

static int snd_sc6000_probe(struct device *devptr, unsigned int dev)
{
        return snd_card_free_on_error(devptr, __snd_sc6000_probe(devptr, dev));
}

static struct isa_driver snd_sc6000_driver = {
        .match          = snd_sc6000_match,
        .probe          = snd_sc6000_probe,
        /* FIXME: suspend/resume */
        .driver         = {
                .name   = DRV_NAME,
        },
};


module_isa_driver(snd_sc6000_driver, SNDRV_CARDS);