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