sound/isa/es1688/es1688.c

   1 /*
   2  *  Driver for generic ESS AudioDrive ESx688 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/isapnp.h>
  26 #include <linux/time.h>
  27 #include <linux/wait.h>
  28 #include <linux/module.h>
  29 #include <asm/dma.h>
  30 #include <sound/core.h>
  31 #include <sound/es1688.h>
  32 #include <sound/mpu401.h>
  33 #include <sound/opl3.h>
  34 #define SNDRV_LEGACY_FIND_FREE_IRQ
  35 #define SNDRV_LEGACY_FIND_FREE_DMA
  36 #include <sound/initval.h>
  37
  38 #define CRD_NAME "Generic ESS ES1688/ES688 AudioDrive"
  39 #define DEV_NAME "es1688"
  40
  41 MODULE_DESCRIPTION(CRD_NAME);
  42 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
  43 MODULE_LICENSE("GPL");
  44 MODULE_SUPPORTED_DEVICE("{{ESS,ES688 PnP AudioDrive,pnp:ESS0100},"
  45                 "{ESS,ES1688 PnP AudioDrive,pnp:ESS0102},"
  46                 "{ESS,ES688 AudioDrive,pnp:ESS6881},"
  47                 "{ESS,ES1688 AudioDrive,pnp:ESS1681}}");
  48
  49 MODULE_ALIAS("snd_es968");
  50
  51 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  52 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  53 #ifdef CONFIG_PNP
  54 static bool isapnp[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP;
  55 #endif
  56 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
  57 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0x220,0x240,0x260 */
  58 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;  /* Usually 0x388 */
  59 static long mpu_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = -1};
  60 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 5,7,9,10 */
  61 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* 5,7,9,10 */
  62 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 0,1,3 */
  63
  64 module_param_array(index, int, NULL, 0444);
  65 MODULE_PARM_DESC(index, "Index value for " CRD_NAME " soundcard.");
  66 module_param_array(id, charp, NULL, 0444);
  67 MODULE_PARM_DESC(id, "ID string for " CRD_NAME " soundcard.");
  68 module_param_array(enable, bool, NULL, 0444);
  69 #ifdef CONFIG_PNP
  70 module_param_array(isapnp, bool, NULL, 0444);
  71 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
  72 #endif
  73 MODULE_PARM_DESC(enable, "Enable " CRD_NAME " soundcard.");
  74 module_param_array(port, long, NULL, 0444);
  75 MODULE_PARM_DESC(port, "Port # for " CRD_NAME " driver.");
  76 module_param_array(mpu_port, long, NULL, 0444);
  77 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for " CRD_NAME " driver.");
  78 module_param_array(irq, int, NULL, 0444);
  79 module_param_array(fm_port, long, NULL, 0444);
  80 MODULE_PARM_DESC(fm_port, "FM port # for ES1688 driver.");
  81 MODULE_PARM_DESC(irq, "IRQ # for " CRD_NAME " driver.");
  82 module_param_array(mpu_irq, int, NULL, 0444);
  83 MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for " CRD_NAME " driver.");
  84 module_param_array(dma8, int, NULL, 0444);
  85 MODULE_PARM_DESC(dma8, "8-bit DMA # for " CRD_NAME " driver.");
  86
  87 #ifdef CONFIG_PNP
  88 #define is_isapnp_selected(dev)         isapnp[dev]
  89 #else
  90 #define is_isapnp_selected(dev)         0
  91 #endif
  92
  93 static int snd_es1688_match(struct device *dev, unsigned int n)
  94 {
  95         return enable[n] && !is_isapnp_selected(n);
  96 }
  97
  98 static int snd_es1688_legacy_create(struct snd_card *card,
  99                                     struct device *dev, unsigned int n)
 100 {
 101         struct snd_es1688 *chip = card->private_data;
 102         static long possible_ports[] = {0x220, 0x240, 0x260};
 103         static int possible_irqs[] = {5, 9, 10, 7, -1};
 104         static int possible_dmas[] = {1, 3, 0, -1};
 105
 106         int i, error;
 107
 108         if (irq[n] == SNDRV_AUTO_IRQ) {
 109                 irq[n] = snd_legacy_find_free_irq(possible_irqs);
 110                 if (irq[n] < 0) {
 111                         dev_err(dev, "unable to find a free IRQ\n");
 112                         return -EBUSY;
 113                 }
 114         }
 115         if (dma8[n] == SNDRV_AUTO_DMA) {
 116                 dma8[n] = snd_legacy_find_free_dma(possible_dmas);
 117                 if (dma8[n] < 0) {
 118                         dev_err(dev, "unable to find a free DMA\n");
 119                         return -EBUSY;
 120                 }
 121         }
 122
 123         if (port[n] != SNDRV_AUTO_PORT)
 124                 return snd_es1688_create(card, chip, port[n], mpu_port[n],
 125                                 irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO);
 126
 127         i = 0;
 128         do {
 129                 port[n] = possible_ports[i];
 130                 error = snd_es1688_create(card, chip, port[n], mpu_port[n],
 131                                 irq[n], mpu_irq[n], dma8[n], ES1688_HW_AUTO);
 132         } while (error < 0 && ++i < ARRAY_SIZE(possible_ports));
 133
 134         return error;
 135 }
 136
 137 static int snd_es1688_probe(struct snd_card *card, unsigned int n)
 138 {
 139         struct snd_es1688 *chip = card->private_data;
 140         struct snd_opl3 *opl3;
 141         struct snd_pcm *pcm;
 142         int error;
 143
 144         error = snd_es1688_pcm(card, chip, 0, &pcm);
 145         if (error < 0)
 146                 return error;
 147
 148         error = snd_es1688_mixer(card, chip);
 149         if (error < 0)
 150                 return error;
 151
 152         strlcpy(card->driver, "ES1688", sizeof(card->driver));
 153         strlcpy(card->shortname, pcm->name, sizeof(card->shortname));
 154         snprintf(card->longname, sizeof(card->longname),
 155                 "%s at 0x%lx, irq %i, dma %i", pcm->name, chip->port,
 156                  chip->irq, chip->dma8);
 157
 158         if (fm_port[n] == SNDRV_AUTO_PORT)
 159                 fm_port[n] = port[n];   /* share the same port */
 160
 161         if (fm_port[n] > 0) {
 162                 if (snd_opl3_create(card, fm_port[n], fm_port[n] + 2,
 163                                 OPL3_HW_OPL3, 0, &opl3) < 0)
 164                         dev_warn(card->dev,
 165                                  "opl3 not detected at 0x%lx\n", fm_port[n]);
 166                 else {
 167                         error = snd_opl3_hwdep_new(opl3, 0, 1, NULL);
 168                         if (error < 0)
 169                                 return error;
 170                 }
 171         }
 172
 173         if (mpu_irq[n] >= 0 && mpu_irq[n] != SNDRV_AUTO_IRQ &&
 174                         chip->mpu_port > 0) {
 175                 error = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688,
 176                                 chip->mpu_port, 0,
 177                                 mpu_irq[n], NULL);
 178                 if (error < 0)
 179                         return error;
 180         }
 181
 182         return snd_card_register(card);
 183 }
 184
 185 static int snd_es1688_isa_probe(struct device *dev, unsigned int n)
 186 {
 187         struct snd_card *card;
 188         int error;
 189
 190         error = snd_card_create(index[n], id[n], THIS_MODULE,
 191                                 sizeof(struct snd_es1688), &card);
 192         if (error < 0)
 193                 return error;
 194
 195         error = snd_es1688_legacy_create(card, dev, n);
 196         if (error < 0)
 197                 goto out;
 198
 199         snd_card_set_dev(card, dev);
 200
 201         error = snd_es1688_probe(card, n);
 202         if (error < 0)
 203                 goto out;
 204
 205         dev_set_drvdata(dev, card);
 206
 207         return 0;
 208 out:
 209         snd_card_free(card);
 210         return error;
 211 }
 212
 213 static int snd_es1688_isa_remove(struct device *dev, unsigned int n)
 214 {
 215         snd_card_free(dev_get_drvdata(dev));
 216         return 0;
 217 }
 218
 219 static struct isa_driver snd_es1688_driver = {
 220         .match          = snd_es1688_match,
 221         .probe          = snd_es1688_isa_probe,
 222         .remove         = snd_es1688_isa_remove,
 223 #if 0   /* FIXME */
 224         .suspend        = snd_es1688_suspend,
 225         .resume         = snd_es1688_resume,
 226 #endif
 227         .driver         = {
 228                 .name   = DEV_NAME
 229         }
 230 };
 231
 232 static int snd_es968_pnp_is_probed;
 233
 234 #ifdef CONFIG_PNP
 235 static int snd_card_es968_pnp(struct snd_card *card, unsigned int n,
 236                               struct pnp_card_link *pcard,
 237                               const struct pnp_card_device_id *pid)
 238 {
 239         struct snd_es1688 *chip = card->private_data;
 240         struct pnp_dev *pdev;
 241         int error;
 242
 243         pdev = pnp_request_card_device(pcard, pid->devs[0].id, NULL);
 244         if (pdev == NULL)
 245                 return -ENODEV;
 246
 247         error = pnp_activate_dev(pdev);
 248         if (error < 0) {
 249                 snd_printk(KERN_ERR "ES968 pnp configure failure\n");
 250                 return error;
 251         }
 252         port[n] = pnp_port_start(pdev, 0);
 253         dma8[n] = pnp_dma(pdev, 0);
 254         irq[n] = pnp_irq(pdev, 0);
 255
 256         return snd_es1688_create(card, chip, port[n], mpu_port[n], irq[n],
 257                                  mpu_irq[n], dma8[n], ES1688_HW_AUTO);
 258 }
 259
 260 static int snd_es968_pnp_detect(struct pnp_card_link *pcard,
 261                                 const struct pnp_card_device_id *pid)
 262 {
 263         struct snd_card *card;
 264         static unsigned int dev;
 265         int error;
 266         struct snd_es1688 *chip;
 267
 268         if (snd_es968_pnp_is_probed)
 269                 return -EBUSY;
 270         for ( ; dev < SNDRV_CARDS; dev++) {
 271                 if (enable[dev] && isapnp[dev])
 272                         break;
 273         }
 274         if (dev == SNDRV_CARDS)
 275                 return -ENODEV;
 276
 277         error = snd_card_create(index[dev], id[dev], THIS_MODULE,
 278                                 sizeof(struct snd_es1688), &card);
 279         if (error < 0)
 280                 return error;
 281         chip = card->private_data;
 282
 283         error = snd_card_es968_pnp(card, dev, pcard, pid);
 284         if (error < 0) {
 285                 snd_card_free(card);
 286                 return error;
 287         }
 288         snd_card_set_dev(card, &pcard->card->dev);
 289         error = snd_es1688_probe(card, dev);
 290         if (error < 0)
 291                 return error;
 292         pnp_set_card_drvdata(pcard, card);
 293         snd_es968_pnp_is_probed = 1;
 294         return 0;
 295 }
 296
 297 static void snd_es968_pnp_remove(struct pnp_card_link *pcard)
 298 {
 299         snd_card_free(pnp_get_card_drvdata(pcard));
 300         pnp_set_card_drvdata(pcard, NULL);
 301         snd_es968_pnp_is_probed = 0;
 302 }
 303
 304 #ifdef CONFIG_PM
 305 static int snd_es968_pnp_suspend(struct pnp_card_link *pcard,
 306                                  pm_message_t state)
 307 {
 308         struct snd_card *card = pnp_get_card_drvdata(pcard);
 309         struct snd_es1688 *chip = card->private_data;
 310
 311         snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
 312         snd_pcm_suspend_all(chip->pcm);
 313         return 0;
 314 }
 315
 316 static int snd_es968_pnp_resume(struct pnp_card_link *pcard)
 317 {
 318         struct snd_card *card = pnp_get_card_drvdata(pcard);
 319         struct snd_es1688 *chip = card->private_data;
 320
 321         snd_es1688_reset(chip);
 322         snd_power_change_state(card, SNDRV_CTL_POWER_D0);
 323         return 0;
 324 }
 325 #endif
 326
 327 static struct pnp_card_device_id snd_es968_pnpids[] = {
 328         { .id = "ESS0968", .devs = { { "@@@0968" }, } },
 329         { .id = "ESS0968", .devs = { { "ESS0968" }, } },
 330         { .id = "", } /* end */
 331 };
 332
 333 MODULE_DEVICE_TABLE(pnp_card, snd_es968_pnpids);
 334
 335 static struct pnp_card_driver es968_pnpc_driver = {
 336         .flags          = PNP_DRIVER_RES_DISABLE,
 337         .name           = DEV_NAME " PnP",
 338         .id_table       = snd_es968_pnpids,
 339         .probe          = snd_es968_pnp_detect,
 340         .remove         = snd_es968_pnp_remove,
 341 #ifdef CONFIG_PM
 342         .suspend        = snd_es968_pnp_suspend,
 343         .resume         = snd_es968_pnp_resume,
 344 #endif
 345 };
 346 #endif
 347
 348 static int __init alsa_card_es1688_init(void)
 349 {
 350 #ifdef CONFIG_PNP
 351         pnp_register_card_driver(&es968_pnpc_driver);
 352         if (snd_es968_pnp_is_probed)
 353                 return 0;
 354         pnp_unregister_card_driver(&es968_pnpc_driver);
 355 #endif
 356         return isa_register_driver(&snd_es1688_driver, SNDRV_CARDS);
 357 }
 358
 359 static void __exit alsa_card_es1688_exit(void)
 360 {
 361         if (!snd_es968_pnp_is_probed) {
 362                 isa_unregister_driver(&snd_es1688_driver);
 363                 return;
 364         }
 365 #ifdef CONFIG_PNP
 366         pnp_unregister_card_driver(&es968_pnpc_driver);
 367 #endif
 368 }
 369
 370 module_init(alsa_card_es1688_init);
 371 module_exit(alsa_card_es1688_exit);