sound/isa/gus/gusextreme.c

   1 /*
   2  *  Driver for Gravis UltraSound Extreme soundcards
   3  *  Copyright (c) by Jaroslav Kysela <perex@suse.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 <sound/driver.h>
  23 #include <linux/init.h>
  24 #include <linux/err.h>
  25 #include <linux/platform_device.h>
  26 #include <linux/delay.h>
  27 #include <linux/time.h>
  28 #include <linux/moduleparam.h>
  29 #include <asm/dma.h>
  30 #include <sound/core.h>
  31 #include <sound/gus.h>
  32 #include <sound/es1688.h>
  33 #include <sound/mpu401.h>
  34 #include <sound/opl3.h>
  35 #define SNDRV_LEGACY_AUTO_PROBE
  36 #define SNDRV_LEGACY_FIND_FREE_IRQ
  37 #define SNDRV_LEGACY_FIND_FREE_DMA
  38 #include <sound/initval.h>
  39
  40 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
  41 MODULE_DESCRIPTION("Gravis UltraSound Extreme");
  42 MODULE_LICENSE("GPL");
  43 MODULE_SUPPORTED_DEVICE("{{Gravis,UltraSound Extreme}}");
  44
  45 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;      /* Index 0-MAX */
  46 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;       /* ID for this card */
  47 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;  /* Enable this card */
  48 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;     /* 0x220,0x240,0x260 */
  49 static long gf1_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS) - 1] = -1}; /* 0x210,0x220,0x230,0x240,0x250,0x260,0x270 */
  50 static long mpu_port[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS) - 1] = -1}; /* 0x300,0x310,0x320 */
  51 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;        /* 5,7,9,10 */
  52 static int mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* 5,7,9,10 */
  53 static int gf1_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;    /* 2,3,5,9,11,12,15 */
  54 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;       /* 0,1,3 */
  55 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;
  56 static int joystick_dac[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 29};
  57                                 /* 0 to 31, (0.59V-4.52V or 0.389V-2.98V) */
  58 static int channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 24};
  59 static int pcm_channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 2};
  60
  61 module_param_array(index, int, NULL, 0444);
  62 MODULE_PARM_DESC(index, "Index value for GUS Extreme soundcard.");
  63 module_param_array(id, charp, NULL, 0444);
  64 MODULE_PARM_DESC(id, "ID string for GUS Extreme soundcard.");
  65 module_param_array(enable, bool, NULL, 0444);
  66 MODULE_PARM_DESC(enable, "Enable GUS Extreme soundcard.");
  67 module_param_array(port, long, NULL, 0444);
  68 MODULE_PARM_DESC(port, "Port # for GUS Extreme driver.");
  69 module_param_array(gf1_port, long, NULL, 0444);
  70 MODULE_PARM_DESC(gf1_port, "GF1 port # for GUS Extreme driver (optional).");
  71 module_param_array(mpu_port, long, NULL, 0444);
  72 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for GUS Extreme driver.");
  73 module_param_array(irq, int, NULL, 0444);
  74 MODULE_PARM_DESC(irq, "IRQ # for GUS Extreme driver.");
  75 module_param_array(mpu_irq, int, NULL, 0444);
  76 MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for GUS Extreme driver.");
  77 module_param_array(gf1_irq, int, NULL, 0444);
  78 MODULE_PARM_DESC(gf1_irq, "GF1 IRQ # for GUS Extreme driver.");
  79 module_param_array(dma8, int, NULL, 0444);
  80 MODULE_PARM_DESC(dma8, "8-bit DMA # for GUS Extreme driver.");
  81 module_param_array(dma1, int, NULL, 0444);
  82 MODULE_PARM_DESC(dma1, "GF1 DMA # for GUS Extreme driver.");
  83 module_param_array(joystick_dac, int, NULL, 0444);
  84 MODULE_PARM_DESC(joystick_dac, "Joystick DAC level 0.59V-4.52V or 0.389V-2.98V for GUS Extreme driver.");
  85 module_param_array(channels, int, NULL, 0444);
  86 MODULE_PARM_DESC(channels, "GF1 channels for GUS Extreme driver.");
  87 module_param_array(pcm_channels, int, NULL, 0444);
  88 MODULE_PARM_DESC(pcm_channels, "Reserved PCM channels for GUS Extreme driver.");
  89
  90 struct platform_device *devices[SNDRV_CARDS];
  91
  92
  93 #define PFX     "gusextreme: "
  94
  95 static int __init snd_gusextreme_detect(int dev,
  96                                         struct snd_card *card,
  97                                         struct snd_gus_card * gus,
  98                                         struct snd_es1688 *es1688)
  99 {
 100         unsigned long flags;
 101         unsigned char d;
 102
 103         /*
 104          * This is main stuff - enable access to GF1 chip...
 105          * I'm not sure, if this will work for card which have
 106          * ES1688 chip in another place than 0x220.
 107          *
 108          * I used reverse-engineering in DOSEMU. [--jk]
 109          *
 110          * ULTRINIT.EXE:
 111          * 0x230 = 0,2,3
 112          * 0x240 = 2,0,1
 113          * 0x250 = 2,0,3
 114          * 0x260 = 2,2,1
 115          */
 116
 117         spin_lock_irqsave(&es1688->mixer_lock, flags);
 118         snd_es1688_mixer_write(es1688, 0x40, 0x0b);     /* don't change!!! */
 119         spin_unlock_irqrestore(&es1688->mixer_lock, flags);
 120         spin_lock_irqsave(&es1688->reg_lock, flags);
 121         outb(gf1_port[dev] & 0x040 ? 2 : 0, ES1688P(es1688, INIT1));
 122         outb(0, 0x201);
 123         outb(gf1_port[dev] & 0x020 ? 2 : 0, ES1688P(es1688, INIT1));
 124         outb(0, 0x201);
 125         outb(gf1_port[dev] & 0x010 ? 3 : 1, ES1688P(es1688, INIT1));
 126         spin_unlock_irqrestore(&es1688->reg_lock, flags);
 127
 128         udelay(100);
 129
 130         snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0);   /* reset GF1 */
 131         if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) {
 132                 snd_printdd("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d);
 133                 return -EIO;
 134         }
 135         udelay(160);
 136         snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);   /* release reset */
 137         udelay(160);
 138         if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) {
 139                 snd_printdd("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d);
 140                 return -EIO;
 141         }
 142         return 0;
 143 }
 144
 145 static void __init snd_gusextreme_init(int dev, struct snd_gus_card * gus)
 146 {
 147         gus->joystick_dac = joystick_dac[dev];
 148 }
 149
 150 static int __init snd_gusextreme_mixer(struct snd_es1688 *chip)
 151 {
 152         struct snd_card *card = chip->card;
 153         struct snd_ctl_elem_id id1, id2;
 154         int err;
 155
 156         memset(&id1, 0, sizeof(id1));
 157         memset(&id2, 0, sizeof(id2));
 158         id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
 159         /* reassign AUX to SYNTHESIZER */
 160         strcpy(id1.name, "Aux Playback Volume");
 161         strcpy(id2.name, "Synth Playback Volume");
 162         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 163                 return err;
 164         /* reassign Master Playback Switch to Synth Playback Switch */
 165         strcpy(id1.name, "Master Playback Switch");
 166         strcpy(id2.name, "Synth Playback Switch");
 167         if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
 168                 return err;
 169         return 0;
 170 }
 171
 172 static int __init snd_gusextreme_probe(struct platform_device *pdev)
 173 {
 174         int dev = pdev->id;
 175         static int possible_ess_irqs[] = {5, 9, 10, 7, -1};
 176         static int possible_ess_dmas[] = {1, 3, 0, -1};
 177         static int possible_gf1_irqs[] = {5, 11, 12, 9, 7, 15, 3, -1};
 178         static int possible_gf1_dmas[] = {5, 6, 7, 1, 3, -1};
 179         int xgf1_irq, xgf1_dma, xess_irq, xmpu_irq, xess_dma;
 180         struct snd_card *card;
 181         struct snd_gus_card *gus;
 182         struct snd_es1688 *es1688;
 183         struct snd_opl3 *opl3;
 184         int err;
 185
 186         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
 187         if (card == NULL)
 188                 return -ENOMEM;
 189
 190         xgf1_irq = gf1_irq[dev];
 191         if (xgf1_irq == SNDRV_AUTO_IRQ) {
 192                 if ((xgf1_irq = snd_legacy_find_free_irq(possible_gf1_irqs)) < 0) {
 193                         snd_printk(KERN_ERR PFX "unable to find a free IRQ for GF1\n");
 194                         err = -EBUSY;
 195                         goto out;
 196                 }
 197         }
 198         xess_irq = irq[dev];
 199         if (xess_irq == SNDRV_AUTO_IRQ) {
 200                 if ((xess_irq = snd_legacy_find_free_irq(possible_ess_irqs)) < 0) {
 201                         snd_printk(KERN_ERR PFX "unable to find a free IRQ for ES1688\n");
 202                         err = -EBUSY;
 203                         goto out;
 204                 }
 205         }
 206         if (mpu_port[dev] == SNDRV_AUTO_PORT)
 207                 mpu_port[dev] = 0;
 208         xmpu_irq = mpu_irq[dev];
 209         if (xmpu_irq > 15)
 210                 xmpu_irq = -1;
 211         xgf1_dma = dma1[dev];
 212         if (xgf1_dma == SNDRV_AUTO_DMA) {
 213                 if ((xgf1_dma = snd_legacy_find_free_dma(possible_gf1_dmas)) < 0) {
 214                         snd_printk(KERN_ERR PFX "unable to find a free DMA for GF1\n");
 215                         err = -EBUSY;
 216                         goto out;
 217                 }
 218         }
 219         xess_dma = dma8[dev];
 220         if (xess_dma == SNDRV_AUTO_DMA) {
 221                 if ((xess_dma = snd_legacy_find_free_dma(possible_ess_dmas)) < 0) {
 222                         snd_printk(KERN_ERR PFX "unable to find a free DMA for ES1688\n");
 223                         err = -EBUSY;
 224                         goto out;
 225                 }
 226         }
 227
 228         if (port[dev] != SNDRV_AUTO_PORT) {
 229                 err = snd_es1688_create(card, port[dev], mpu_port[dev],
 230                                         xess_irq, xmpu_irq, xess_dma,
 231                                         ES1688_HW_1688, &es1688);
 232         } else {
 233                 /* auto-probe legacy ports */
 234                 static unsigned long possible_ports[] = {0x220, 0x240, 0x260};
 235                 int i;
 236                 for (i = 0; i < ARRAY_SIZE(possible_ports); i++) {
 237                         err = snd_es1688_create(card,
 238                                                 possible_ports[i],
 239                                                 mpu_port[dev],
 240                                                 xess_irq, xmpu_irq, xess_dma,
 241                                                 ES1688_HW_1688, &es1688);
 242                         if (err >= 0) {
 243                                 port[dev] = possible_ports[i];
 244                                 break;
 245                         }
 246                 }
 247         }
 248         if (err < 0)
 249                 goto out;
 250
 251         if (gf1_port[dev] < 0)
 252                 gf1_port[dev] = port[dev] + 0x20;
 253         if ((err = snd_gus_create(card,
 254                                   gf1_port[dev],
 255                                   xgf1_irq,
 256                                   xgf1_dma,
 257                                   -1,
 258                                   0, channels[dev],
 259                                   pcm_channels[dev], 0,
 260                                   &gus)) < 0)
 261                 goto out;
 262
 263         if ((err = snd_gusextreme_detect(dev, card, gus, es1688)) < 0)
 264                 goto out;
 265
 266         snd_gusextreme_init(dev, gus);
 267         if ((err = snd_gus_initialize(gus)) < 0)
 268                 goto out;
 269
 270         if (!gus->ess_flag) {
 271                 snd_printk(KERN_ERR PFX "GUS Extreme soundcard was not detected at 0x%lx\n", gus->gf1.port);
 272                 err = -ENODEV;
 273                 goto out;
 274         }
 275         if ((err = snd_es1688_pcm(es1688, 0, NULL)) < 0)
 276                 goto out;
 277
 278         if ((err = snd_es1688_mixer(es1688)) < 0)
 279                 goto out;
 280
 281         snd_component_add(card, "ES1688");
 282         if (pcm_channels[dev] > 0) {
 283                 if ((err = snd_gf1_pcm_new(gus, 1, 1, NULL)) < 0)
 284                         goto out;
 285         }
 286         if ((err = snd_gf1_new_mixer(gus)) < 0)
 287                 goto out;
 288
 289         if ((err = snd_gusextreme_mixer(es1688)) < 0)
 290                 goto out;
 291
 292         if (snd_opl3_create(card, es1688->port, es1688->port + 2,
 293                             OPL3_HW_OPL3, 0, &opl3) < 0) {
 294                 printk(KERN_ERR PFX "gusextreme: opl3 not detected at 0x%lx\n", es1688->port);
 295         } else {
 296                 if ((err = snd_opl3_hwdep_new(opl3, 0, 2, NULL)) < 0)
 297                         goto out;
 298         }
 299
 300         if (es1688->mpu_port >= 0x300 &&
 301             (err = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688,
 302                                                es1688->mpu_port, 0,
 303                                                xmpu_irq,
 304                                                IRQF_DISABLED,
 305                                                NULL)) < 0)
 306                 goto out;
 307
 308         sprintf(card->longname, "Gravis UltraSound Extreme at 0x%lx, irq %i&%i, dma %i&%i",
 309                 es1688->port, xgf1_irq, xess_irq, xgf1_dma, xess_dma);
 310
 311         snd_card_set_dev(card, &pdev->dev);
 312
 313         if ((err = snd_card_register(card)) < 0)
 314                 goto out;
 315
 316         platform_set_drvdata(pdev, card);
 317         return 0;
 318
 319       out:
 320         snd_card_free(card);
 321         return err;
 322 }
 323
 324 static int snd_gusextreme_remove(struct platform_device *devptr)
 325 {
 326         snd_card_free(platform_get_drvdata(devptr));
 327         platform_set_drvdata(devptr, NULL);
 328         return 0;
 329 }
 330
 331 #define GUSEXTREME_DRIVER       "snd_gusextreme"
 332
 333 static struct platform_driver snd_gusextreme_driver = {
 334         .probe          = snd_gusextreme_probe,
 335         .remove         = snd_gusextreme_remove,
 336         /* FIXME: suspend/resume */
 337         .driver         = {
 338                 .name   = GUSEXTREME_DRIVER
 339         },
 340 };
 341
 342 static void __init_or_module snd_gusextreme_unregister_all(void)
 343 {
 344         int i;
 345
 346         for (i = 0; i < ARRAY_SIZE(devices); ++i)
 347                 platform_device_unregister(devices[i]);
 348         platform_driver_unregister(&snd_gusextreme_driver);
 349 }
 350
 351 static int __init alsa_card_gusextreme_init(void)
 352 {
 353         int i, cards, err;
 354
 355         err = platform_driver_register(&snd_gusextreme_driver);
 356         if (err < 0)
 357                 return err;
 358
 359         cards = 0;
 360         for (i = 0; i < SNDRV_CARDS; i++) {
 361                 struct platform_device *device;
 362                 if (! enable[i])
 363                         continue;
 364                 device = platform_device_register_simple(GUSEXTREME_DRIVER,
 365                                                          i, NULL, 0);
 366                 if (IS_ERR(device))
 367                         continue;
 368                 if (!platform_get_drvdata(device)) {
 369                         platform_device_unregister(device);
 370                         continue;
 371                 }
 372                 devices[i] = device;
 373                 cards++;
 374         }
 375         if (!cards) {
 376 #ifdef MODULE
 377                 printk(KERN_ERR "GUS Extreme soundcard not found or device busy\n");
 378 #endif
 379                 snd_gusextreme_unregister_all();
 380                 return -ENODEV;
 381         }
 382         return 0;
 383 }
 384
 385 static void __exit alsa_card_gusextreme_exit(void)
 386 {
 387         snd_gusextreme_unregister_all();
 388 }
 389
 390 module_init(alsa_card_gusextreme_init)
 391 module_exit(alsa_card_gusextreme_exit)