isa/es1688/es1688.c

0001 // SPDX-License-Identifier: GPL-2.0-or-later
0002 /*
0003  *  Driver for generic ESS AudioDrive ESx688 soundcards
0004  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
0005  */
0006
0007 #include <linux/init.h>
0008 #include <linux/err.h>
0009 #include <linux/isa.h>
0010 #include <linux/isapnp.h>
0011 #include <linux/time.h>
0012 #include <linux/wait.h>
0013 #include <linux/module.h>
0014 #include <asm/dma.h>
0015 #include <sound/core.h>
0016 #include <sound/es1688.h>
0017 #include <sound/mpu401.h>
0018 #include <sound/opl3.h>
0019 #define SNDRV_LEGACY_FIND_FREE_IRQ
0020 #define SNDRV_LEGACY_FIND_FREE_DMA
0021 #include <sound/initval.h>
0022
0023 #define CRD_NAME "Generic ESS ES1688/ES688 AudioDrive"
0024 #define DEV_NAME "es1688"
0025
0026 MODULE_DESCRIPTION(CRD_NAME);
0027 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
0028 MODULE_LICENSE("GPL");
0029 MODULE_ALIAS("snd_es968");
0030
0031 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;  /* Index 0-MAX */
0032 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;   /* ID for this card */
0033 #ifdef CONFIG_PNP
0034 static bool isapnp[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP;
0035 #endif
0036 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
0037 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x240,0x260 */
0038 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* Usually 0x388 */
0039 static long mpu_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -1};
0040 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* 5,7,9,10 */
0041 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* 5,7,9,10 */
0042 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;   /* 0,1,3 */
0043
0044 module_param_array(index, int, NULL, 0444);
0045 MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard.");
0046 module_param_array(id, charp, NULL, 0444);
0047 MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard.");
0048 module_param_array(enable, bool, NULL, 0444);
0049 #ifdef CONFIG_PNP
0050 module_param_array(isapnp, bool, NULL, 0444);
0051 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
0052 #endif
0053 MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard.");
0054 module_param_hw_array(port, long, ioport, NULL, 0444);
0055 MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver.");
0056 module_param_hw_array(mpu_port, long, ioport, NULL, 0444);
0057 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for " CRD_NAME " driver.");
0058 module_param_hw_array(irq, int, irq, NULL, 0444);
0059 module_param_hw_array(fm_port, long, ioport, NULL, 0444);
0060 MODULE_PARM_DESC(fm_port, "FM port # for ES1688 driver.");
0061 MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver.");
0062 module_param_hw_array(mpu_irq, int, irq, NULL, 0444);
0063 MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for " CRD_NAME " driver.");
0064 module_param_hw_array(dma8, int, dma, NULL, 0444);
0065 MODULE_PARM_DESC(dma8, "8-bit DMA # for " CRD_NAME " driver.");
0066
0067 #ifdef CONFIG_PNP
0068 #define is_isapnp_selected(dev)     isapnp[dev]
0069 #else
0070 #define is_isapnp_selected(dev)     0
0071 #endif
0072
0073 static int snd_es1688_match(struct device *dev, unsigned int n)
0074 {
0075     return enable[n] && !is_isapnp_selected(n);
0076 }
0077
0078 static int snd_es1688_legacy_create(struct snd_card *card,
0079                     struct device *dev, unsigned int n)
0080 {
0081     struct snd_es1688 *chip = card->private_data;
0082     static const long possible_ports[] = {0x220, 0x240, 0x260};
0083     static const int possible_irqs[] = {5, 9, 10, 7, -1};
0084     static const int possible_dmas[] = {1, 3, 0, -1};
0085
0086     int i, error;
0087
0088     if (irq[n] == SNDRV_AUTO_IRQ) {
0089         irq[n] = snd_legacy_find_free_irq(possible_irqs);
0090         if (irq[n] < 0) {
0091             dev_err(dev, "unable to find a free IRQ\n");
0092             return -EBUSY;
0093         }
0094     }
0095     if (dma8[n] == SNDRV_AUTO_DMA) {
0096         dma8[n] = snd_legacy_find_free_dma(possible_dmas);
0097         if (dma8[n] < 0) {
0098             dev_err(dev, "unable to find a free DMA\n");
0099             return -EBUSY;
0100         }
0101     }
0102
0103     if (port[n] != SNDRV_AUTO_PORT)
0104         return snd_es1688_create(card, chip, port[n], mpu_port[n],
0105                 irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO);
0106
0107     i = 0;
0108     do {
0109         port[n] = possible_ports[i];
0110         error = snd_es1688_create(card, chip, port[n], mpu_port[n],
0111                 irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO);
0112     } while (error < 0 && ++i < ARRAY_SIZE(possible_ports));
0113
0114     return error;
0115 }
0116
0117 static int snd_es1688_probe(struct snd_card *card, unsigned int n)
0118 {
0119     struct snd_es1688 *chip = card->private_data;
0120     struct snd_opl3 *opl3;
0121     int error;
0122
0123     error = snd_es1688_pcm(card, chip, 0);
0124     if (error < 0)
0125         return error;
0126
0127     error = snd_es1688_mixer(card, chip);
0128     if (error < 0)
0129         return error;
0130
0131     strscpy(card->driver, "ES1688", sizeof(card->driver));
0132     strscpy(card->shortname, chip->pcm->name, sizeof(card->shortname));
0133     snprintf(card->longname, sizeof(card->longname),
0134         "%s at 0x%lx, irq %i, dma %i", chip->pcm->name, chip->port,
0135          chip->irq, chip->dma8);
0136
0137     if (fm_port[n] == SNDRV_AUTO_PORT)
0138         fm_port[n] = port[n];   /* share the same port */
0139
0140     if (fm_port[n] > 0) {
0141         if (snd_opl3_create(card, fm_port[n], fm_port[n] + 2,
0142                 OPL3_HW_OPL3, 0, &opl3) < 0)
0143             dev_warn(card->dev,
0144                  "opl3 not detected at 0x%lx\n", fm_port[n]);
0145         else {
0146             error = snd_opl3_hwdep_new(opl3, 0, 1, NULL);
0147             if (error < 0)
0148                 return error;
0149         }
0150     }
0151
0152     if (mpu_irq[n] >= 0 && mpu_irq[n] != SNDRV_AUTO_IRQ &&
0153             chip->mpu_port > 0) {
0154         error = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688,
0155                 chip->mpu_port, 0,
0156                 mpu_irq[n], NULL);
0157         if (error < 0)
0158             return error;
0159     }
0160
0161     return snd_card_register(card);
0162 }
0163
0164 static int snd_es1688_isa_probe(struct device *dev, unsigned int n)
0165 {
0166     struct snd_card *card;
0167     int error;
0168
0169     error = snd_devm_card_new(dev, index[n], id[n], THIS_MODULE,
0170                   sizeof(struct snd_es1688), &card);
0171     if (error < 0)
0172         return error;
0173
0174     error = snd_es1688_legacy_create(card, dev, n);
0175     if (error < 0)
0176         return error;
0177
0178     error = snd_es1688_probe(card, n);
0179     if (error < 0)
0180         return error;
0181
0182     dev_set_drvdata(dev, card);
0183
0184     return 0;
0185 }
0186
0187 static struct isa_driver snd_es1688_driver = {
0188     .match      = snd_es1688_match,
0189     .probe      = snd_es1688_isa_probe,
0190 #if 0   /* FIXME */
0191     .suspend    = snd_es1688_suspend,
0192     .resume     = snd_es1688_resume,
0193 #endif
0194     .driver     = {
0195         .name   = DEV_NAME
0196     }
0197 };
0198
0199 static int snd_es968_pnp_is_probed;
0200
0201 #ifdef CONFIG_PNP
0202 static int snd_card_es968_pnp(struct snd_card *card, unsigned int n,
0203                   struct pnp_card_link *pcard,
0204                   const struct pnp_card_device_id *pid)
0205 {
0206     struct snd_es1688 *chip = card->private_data;
0207     struct pnp_dev *pdev;
0208     int error;
0209
0210     pdev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
0211     if (pdev == NULL)
0212         return -ENODEV;
0213
0214     error = pnp_activate_dev(pdev);
0215     if (error < 0) {
0216         snd_printk(KERN_ERR "ES968 pnp configure failure\n");
0217         return error;
0218     }
0219     port[n] = pnp_port_start(pdev, 0);
0220     dma8[n] = pnp_dma(pdev, 0);
0221     irq[n] = pnp_irq(pdev, 0);
0222
0223     return snd_es1688_create(card, chip, port[n], mpu_port[n], irq[n],
0224                  mpu_irq[n], dma8[n], ES1688_HW_AUTO);
0225 }
0226
0227 static int snd_es968_pnp_detect(struct pnp_card_link *pcard,
0228                 const struct pnp_card_device_id *pid)
0229 {
0230     struct snd_card *card;
0231     static unsigned int dev;
0232     int error;
0233
0234     if (snd_es968_pnp_is_probed)
0235         return -EBUSY;
0236     for ( ; dev < SNDRV_CARDS; dev++) {
0237         if (enable[dev] && isapnp[dev])
0238             break;
0239     }
0240     if (dev == SNDRV_CARDS)
0241         return -ENODEV;
0242
0243     error = snd_devm_card_new(&pcard->card->dev,
0244                   index[dev], id[dev], THIS_MODULE,
0245                   sizeof(struct snd_es1688), &card);
0246     if (error < 0)
0247         return error;
0248
0249     error = snd_card_es968_pnp(card, dev, pcard, pid);
0250     if (error < 0)
0251         return error;
0252     error = snd_es1688_probe(card, dev);
0253     if (error < 0)
0254         return error;
0255     pnp_set_card_drvdata(pcard, card);
0256     snd_es968_pnp_is_probed = 1;
0257     return 0;
0258 }
0259
0260 static void snd_es968_pnp_remove(struct pnp_card_link *pcard)
0261 {
0262     snd_es968_pnp_is_probed = 0;
0263 }
0264
0265 #ifdef CONFIG_PM
0266 static int snd_es968_pnp_suspend(struct pnp_card_link *pcard,
0267                  pm_message_t state)
0268 {
0269     struct snd_card *card = pnp_get_card_drvdata(pcard);
0270
0271     snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
0272     return 0;
0273 }
0274
0275 static int snd_es968_pnp_resume(struct pnp_card_link *pcard)
0276 {
0277     struct snd_card *card = pnp_get_card_drvdata(pcard);
0278     struct snd_es1688 *chip = card->private_data;
0279
0280     snd_es1688_reset(chip);
0281     snd_power_change_state(card, SNDRV_CTL_POWER_D0);
0282     return 0;
0283 }
0284 #endif
0285
0286 static const struct pnp_card_device_id snd_es968_pnpids[] = {
0287     { .id = "ESS0968", .devs = { { "@@@0968" }, } },
0288     { .id = "ESS0968", .devs = { { "ESS0968" }, } },
0289     { .id = "", } /* end */
0290 };
0291
0292 MODULE_DEVICE_TABLE(pnp_card, snd_es968_pnpids);
0293
0294 static struct pnp_card_driver es968_pnpc_driver = {
0295     .flags      = PNP_DRIVER_RES_DISABLE,
0296     .name       = DEV_NAME " PnP",
0297     .id_table   = snd_es968_pnpids,
0298     .probe      = snd_es968_pnp_detect,
0299     .remove     = snd_es968_pnp_remove,
0300 #ifdef CONFIG_PM
0301     .suspend    = snd_es968_pnp_suspend,
0302     .resume     = snd_es968_pnp_resume,
0303 #endif
0304 };
0305 #endif
0306
0307 static int __init alsa_card_es1688_init(void)
0308 {
0309 #ifdef CONFIG_PNP
0310     pnp_register_card_driver(&es968_pnpc_driver);
0311     if (snd_es968_pnp_is_probed)
0312         return 0;
0313     pnp_unregister_card_driver(&es968_pnpc_driver);
0314 #endif
0315     return isa_register_driver(&snd_es1688_driver, SNDRV_CARDS);
0316 }
0317
0318 static void __exit alsa_card_es1688_exit(void)
0319 {
0320     if (!snd_es968_pnp_is_probed) {
0321         isa_unregister_driver(&snd_es1688_driver);
0322         return;
0323     }
0324 #ifdef CONFIG_PNP
0325     pnp_unregister_card_driver(&es968_pnpc_driver);
0326 #endif
0327 }
0328
0329 module_init(alsa_card_es1688_init);
0330 module_exit(alsa_card_es1688_exit);