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 snd_card_t *snd_gusextreme_cards[SNDRV_CARDS] = SNDRV_DEFAULT_PTR; 89 90 91 static int __init snd_gusextreme_detect(int dev, 92 snd_card_t * card, 93 snd_gus_card_t * gus, 94 es1688_t *es1688) 95 { 96 unsigned long flags; 97 98 /* 99 * This is main stuff - enable access to GF1 chip... 100 * I'm not sure, if this will work for card which have 101 * ES1688 chip in another place than 0x220. 102 * 103 * I used reverse-engineering in DOSEMU. [--jk] 104 * 105 * ULTRINIT.EXE: 106 * 0x230 = 0,2,3 107 * 0x240 = 2,0,1 108 * 0x250 = 2,0,3 109 * 0x260 = 2,2,1 110 */ 111 112 spin_lock_irqsave(&es1688->mixer_lock, flags); 113 snd_es1688_mixer_write(es1688, 0x40, 0x0b); /* don't change!!! */ 114 spin_unlock_irqrestore(&es1688->mixer_lock, flags); 115 spin_lock_irqsave(&es1688->reg_lock, flags); 116 outb(gf1_port[dev] & 0x040 ? 2 : 0, ES1688P(es1688, INIT1)); 117 outb(0, 0x201); 118 outb(gf1_port[dev] & 0x020 ? 2 : 0, ES1688P(es1688, INIT1)); 119 outb(0, 0x201); 120 outb(gf1_port[dev] & 0x010 ? 3 : 1, ES1688P(es1688, INIT1)); 121 spin_unlock_irqrestore(&es1688->reg_lock, flags); 122 123 udelay(100); 124 125 snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0); /* reset GF1 */ 126 #ifdef CONFIG_SND_DEBUG_DETECT 127 { 128 unsigned char d; 129 130 if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) { 131 snd_printk("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d); 132 return -EIO; 133 } 134 } 135 #else 136 if ((snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET) & 0x07) != 0) 137 return -EIO; 138 #endif 139 udelay(160); 140 snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1); /* release reset */ 141 udelay(160); 142 #ifdef CONFIG_SND_DEBUG_DETECT 143 { 144 unsigned char d; 145 146 if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) { 147 snd_printk("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d); 148 return -EIO; 149 } 150 } 151 #else 152 if ((snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET) & 0x07) != 1) 153 return -EIO; 154 #endif 155 156 return 0; 157 } 158 159 static void __init snd_gusextreme_init(int dev, snd_gus_card_t * gus) 160 { 161 gus->joystick_dac = joystick_dac[dev]; 162 } 163 164 static int __init snd_gusextreme_mixer(es1688_t *chip) 165 { 166 snd_card_t *card = chip->card; 167 snd_ctl_elem_id_t id1, id2; 168 int err; 169 170 memset(&id1, 0, sizeof(id1)); 171 memset(&id2, 0, sizeof(id2)); 172 id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER; 173 /* reassign AUX to SYNTHESIZER */ 174 strcpy(id1.name, "Aux Playback Volume"); 175 strcpy(id2.name, "Synth Playback Volume"); 176 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) 177 return err; 178 /* reassign Master Playback Switch to Synth Playback Switch */ 179 strcpy(id1.name, "Master Playback Switch"); 180 strcpy(id2.name, "Synth Playback Switch"); 181 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0) 182 return err; 183 return 0; 184 } 185 186 static int __init snd_gusextreme_probe(int dev) 187 { 188 static int possible_ess_irqs[] = {5, 9, 10, 7, -1}; 189 static int possible_ess_dmas[] = {1, 3, 0, -1}; 190 static int possible_gf1_irqs[] = {5, 11, 12, 9, 7, 15, 3, -1}; 191 static int possible_gf1_dmas[] = {5, 6, 7, 1, 3, -1}; 192 int xgf1_irq, xgf1_dma, xess_irq, xmpu_irq, xess_dma; 193 snd_card_t *card; 194 struct snd_gusextreme *acard; 195 snd_gus_card_t *gus; 196 es1688_t *es1688; 197 opl3_t *opl3; 198 int err; 199 200 card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0); 201 if (card == NULL) 202 return -ENOMEM; 203 acard = (struct snd_gusextreme *)card->private_data; 204 205 xgf1_irq = gf1_irq[dev]; 206 if (xgf1_irq == SNDRV_AUTO_IRQ) { 207 if ((xgf1_irq = snd_legacy_find_free_irq(possible_gf1_irqs)) < 0) { 208 snd_printk("unable to find a free IRQ for GF1\n"); 209 err = -EBUSY; 210 goto out; 211 } 212 } 213 xess_irq = irq[dev]; 214 if (xess_irq == SNDRV_AUTO_IRQ) { 215 if ((xess_irq = snd_legacy_find_free_irq(possible_ess_irqs)) < 0) { 216 snd_printk("unable to find a free IRQ for ES1688\n"); 217 err = -EBUSY; 218 goto out; 219 } 220 } 221 if (mpu_port[dev] == SNDRV_AUTO_PORT) 222 mpu_port[dev] = 0; 223 xmpu_irq = mpu_irq[dev]; 224 if (xmpu_irq > 15) 225 xmpu_irq = -1; 226 xgf1_dma = dma1[dev]; 227 if (xgf1_dma == SNDRV_AUTO_DMA) { 228 if ((xgf1_dma = snd_legacy_find_free_dma(possible_gf1_dmas)) < 0) { 229 snd_printk("unable to find a free DMA for GF1\n"); 230 err = -EBUSY; 231 goto out; 232 } 233 } 234 xess_dma = dma8[dev]; 235 if (xess_dma == SNDRV_AUTO_DMA) { 236 if ((xess_dma = snd_legacy_find_free_dma(possible_ess_dmas)) < 0) { 237 snd_printk("unable to find a free DMA for ES1688\n"); 238 err = -EBUSY; 239 goto out; 240 } 241 } 242 243 if ((err = snd_es1688_create(card, port[dev], mpu_port[dev], 244 xess_irq, xmpu_irq, xess_dma, 245 ES1688_HW_1688, &es1688)) < 0) 246 goto out; 247 if (gf1_port[dev] < 0) 248 gf1_port[dev] = port[dev] + 0x20; 249 if ((err = snd_gus_create(card, 250 gf1_port[dev], 251 xgf1_irq, 252 xgf1_dma, 253 -1, 254 0, channels[dev], 255 pcm_channels[dev], 0, 256 &gus)) < 0) 257 goto out; 258 259 if ((err = snd_gusextreme_detect(dev, card, gus, es1688)) < 0) 260 goto out; 261 262 snd_gusextreme_init(dev, gus); 263 if ((err = snd_gus_initialize(gus)) < 0) 264 goto out; 265 266 if (!gus->ess_flag) { 267 snd_printdd("GUS Extreme soundcard was not detected at 0x%lx\n", gus->gf1.port); 268 err = -ENODEV; 269 goto out; 270 } 271 if ((err = snd_es1688_pcm(es1688, 0, NULL)) < 0) 272 goto out; 273 274 if ((err = snd_es1688_mixer(es1688)) < 0) 275 goto out; 276 277 snd_component_add(card, "ES1688"); 278 if (pcm_channels[dev] > 0) { 279 if ((err = snd_gf1_pcm_new(gus, 1, 1, NULL)) < 0) 280 goto out; 281 } 282 if ((err = snd_gf1_new_mixer(gus)) < 0) 283 goto out; 284 285 if ((err = snd_gusextreme_mixer(es1688)) < 0) 286 goto out; 287 288 if (snd_opl3_create(card, es1688->port, es1688->port + 2, 289 OPL3_HW_OPL3, 0, &opl3) < 0) { 290 printk(KERN_ERR "gusextreme: opl3 not detected at 0x%lx\n", es1688->port); 291 } else { 292 if ((err = snd_opl3_hwdep_new(opl3, 0, 2, NULL)) < 0) 293 goto out; 294 } 295 296 if (es1688->mpu_port >= 0x300 && 297 (err = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688, 298 es1688->mpu_port, 0, 299 xmpu_irq, 300 SA_INTERRUPT, 301 NULL)) < 0) 302 goto out; 303 304 sprintf(card->longname, "Gravis UltraSound Extreme at 0x%lx, irq %i&%i, dma %i&%i", 305 es1688->port, xgf1_irq, xess_irq, xgf1_dma, xess_dma); 306 if ((err = snd_card_register(card)) < 0) 307 goto out; 308 309 snd_gusextreme_cards[dev] = card; 310 return 0; 311 312 out: 313 snd_card_free(card); 314 return err; 315 } 316 317 static int __init snd_gusextreme_legacy_auto_probe(unsigned long xport) 318 { 319 static int dev; 320 int res; 321 322 for ( ; dev < SNDRV_CARDS; dev++) { 323 if (!enable[dev] || port[dev] != SNDRV_AUTO_PORT) 324 continue; 325 port[dev] = xport; 326 res = snd_gusextreme_probe(dev); 327 if (res < 0) 328 port[dev] = SNDRV_AUTO_PORT; 329 return res; 330 } 331 return -ENODEV; 332 } 333 334 static int __init alsa_card_gusextreme_init(void) 335 { 336 static unsigned long possible_ports[] = {0x220, 0x240, 0x260, -1}; 337 int dev, cards, i; 338 339 for (dev = cards = 0; dev < SNDRV_CARDS && enable[dev] > 0; dev++) { 340 if (port[dev] == SNDRV_AUTO_PORT) 341 continue; 342 if (snd_gusextreme_probe(dev) >= 0) 343 cards++; 344 } 345 i = snd_legacy_auto_probe(possible_ports, snd_gusextreme_legacy_auto_probe); 346 if (i > 0) 347 cards += i; 348 349 if (!cards) { 350 #ifdef MODULE 351 printk(KERN_ERR "GUS Extreme soundcard not found or device busy\n"); 352 #endif 353 return -ENODEV; 354 } 355 return 0; 356 } 357 358 static void __exit alsa_card_gusextreme_exit(void) 359 { 360 int idx; 361 snd_card_t *card; 362 struct snd_gusextreme *acard; 363 364 for (idx = 0; idx < SNDRV_CARDS; idx++) { 365 card = snd_gusextreme_cards[idx]; 366 if (card == NULL) 367 continue; 368 acard = (struct snd_gusextreme *)card->private_data; 369 snd_card_free(snd_gusextreme_cards[idx]); 370 } 371 } 372 373 module_init(alsa_card_gusextreme_init) 374 module_exit(alsa_card_gusextreme_exit) 375