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