2 * Driver for Gravis UltraSound Extreme soundcards
3 * Copyright (c) by Jaroslav Kysela <perex@suse.cz>
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.
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.
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
22 #include <sound/driver.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>
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}}");
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};
61 module_param_array(index, int, boot_devs, 0444);
62 MODULE_PARM_DESC(index, "Index value for GUS Extreme soundcard.");
63 MODULE_PARM_SYNTAX(index, SNDRV_INDEX_DESC);
64 module_param_array(id, charp, boot_devs, 0444);
65 MODULE_PARM_DESC(id, "ID string for GUS Extreme soundcard.");
66 MODULE_PARM_SYNTAX(id, SNDRV_ID_DESC);
67 module_param_array(enable, bool, boot_devs, 0444);
68 MODULE_PARM_DESC(enable, "Enable GUS Extreme soundcard.");
69 MODULE_PARM_SYNTAX(enable, SNDRV_ENABLE_DESC);
70 module_param_array(port, long, boot_devs, 0444);
71 MODULE_PARM_DESC(port, "Port # for GUS Extreme driver.");
72 MODULE_PARM_SYNTAX(port, SNDRV_ENABLED ",allows:{{0x220,0x260,0x20}},dialog:list");
73 module_param_array(gf1_port, long, boot_devs, 0444);
74 MODULE_PARM_DESC(gf1_port, "GF1 port # for GUS Extreme driver (optional).");
75 MODULE_PARM_SYNTAX(gf1_port, SNDRV_ENABLED ",allows:{{0x210,0x270,0x10}},dialog:list");
76 module_param_array(mpu_port, long, boot_devs, 0444);
77 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for GUS Extreme driver.");
78 MODULE_PARM_SYNTAX(mpu_port, SNDRV_ENABLED ",allows:{{0x300,0x320,0x10}},dialog:list");
79 module_param_array(irq, int, boot_devs, 0444);
80 MODULE_PARM_DESC(irq, "IRQ # for GUS Extreme driver.");
81 MODULE_PARM_SYNTAX(irq, SNDRV_ENABLED ",allows:{{5},{7},{9},{10}},dialog:list");
82 module_param_array(mpu_irq, int, boot_devs, 0444);
83 MODULE_PARM_DESC(mpu_irq, "MPU-401 IRQ # for GUS Extreme driver.");
84 MODULE_PARM_SYNTAX(mpu_irq, SNDRV_ENABLED ",allows:{{5},{7},{9},{10}},dialog:list");
85 module_param_array(gf1_irq, int, boot_devs, 0444);
86 MODULE_PARM_DESC(gf1_irq, "GF1 IRQ # for GUS Extreme driver.");
87 MODULE_PARM_SYNTAX(gf1_irq, SNDRV_ENABLED ",allows:{{2},{3},{5},{9},{11},{12},{15}},dialog:list");
88 module_param_array(dma8, int, boot_devs, 0444);
89 MODULE_PARM_DESC(dma8, "8-bit DMA # for GUS Extreme driver.");
90 MODULE_PARM_SYNTAX(dma8, SNDRV_DMA8_DESC);
91 module_param_array(dma1, int, boot_devs, 0444);
92 MODULE_PARM_DESC(dma1, "GF1 DMA # for GUS Extreme driver.");
93 MODULE_PARM_SYNTAX(dma1, SNDRV_DMA_DESC);
94 module_param_array(joystick_dac, int, boot_devs, 0444);
95 MODULE_PARM_DESC(joystick_dac, "Joystick DAC level 0.59V-4.52V or 0.389V-2.98V for GUS Extreme driver.");
96 MODULE_PARM_SYNTAX(joystick_dac, SNDRV_ENABLED ",allows:{{0,31}}");
97 module_param_array(channels, int, boot_devs, 0444);
98 MODULE_PARM_DESC(channels, "GF1 channels for GUS Extreme driver.");
99 MODULE_PARM_SYNTAX(channels, SNDRV_ENABLED ",allows:{{14,32}}");
100 module_param_array(pcm_channels, int, boot_devs, 0444);
101 MODULE_PARM_DESC(pcm_channels, "Reserved PCM channels for GUS Extreme driver.");
102 MODULE_PARM_SYNTAX(pcm_channels, SNDRV_ENABLED ",allows:{{2,16}}");
104 static snd_card_t *snd_gusextreme_cards[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
107 static int __init snd_gusextreme_detect(int dev,
109 snd_gus_card_t * gus,
115 * This is main stuff - enable access to GF1 chip...
116 * I'm not sure, if this will work for card which have
117 * ES1688 chip in another place than 0x220.
119 * I used reverse-engineering in DOSEMU. [--jk]
128 spin_lock_irqsave(&es1688->mixer_lock, flags);
129 snd_es1688_mixer_write(es1688, 0x40, 0x0b); /* don't change!!! */
130 spin_unlock_irqrestore(&es1688->mixer_lock, flags);
131 spin_lock_irqsave(&es1688->reg_lock, flags);
132 outb(gf1_port[dev] & 0x040 ? 2 : 0, ES1688P(es1688, INIT1));
134 outb(gf1_port[dev] & 0x020 ? 2 : 0, ES1688P(es1688, INIT1));
136 outb(gf1_port[dev] & 0x010 ? 3 : 1, ES1688P(es1688, INIT1));
137 spin_unlock_irqrestore(&es1688->reg_lock, flags);
141 snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0); /* reset GF1 */
142 #ifdef CONFIG_SND_DEBUG_DETECT
146 if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) {
147 snd_printk("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d);
152 if ((snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET) & 0x07) != 0)
156 snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1); /* release reset */
158 #ifdef CONFIG_SND_DEBUG_DETECT
162 if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) {
163 snd_printk("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d);
168 if ((snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET) & 0x07) != 1)
175 static void __init snd_gusextreme_init(int dev, snd_gus_card_t * gus)
177 gus->joystick_dac = joystick_dac[dev];
180 static int __init snd_gusextreme_mixer(es1688_t *chip)
182 snd_card_t *card = chip->card;
183 snd_ctl_elem_id_t id1, id2;
186 memset(&id1, 0, sizeof(id1));
187 memset(&id2, 0, sizeof(id2));
188 id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
189 /* reassign AUX to SYNTHESIZER */
190 strcpy(id1.name, "Aux Playback Volume");
191 strcpy(id2.name, "Synth Playback Volume");
192 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
194 /* reassign Master Playback Switch to Synth Playback Switch */
195 strcpy(id1.name, "Master Playback Switch");
196 strcpy(id2.name, "Synth Playback Switch");
197 if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
202 static int __init snd_gusextreme_probe(int dev)
204 static int possible_ess_irqs[] = {5, 9, 10, 7, -1};
205 static int possible_ess_dmas[] = {1, 3, 0, -1};
206 static int possible_gf1_irqs[] = {5, 11, 12, 9, 7, 15, 3, -1};
207 static int possible_gf1_dmas[] = {5, 6, 7, 1, 3, -1};
208 int xgf1_irq, xgf1_dma, xess_irq, xmpu_irq, xess_dma;
210 struct snd_gusextreme *acard;
216 card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
219 acard = (struct snd_gusextreme *)card->private_data;
221 xgf1_irq = gf1_irq[dev];
222 if (xgf1_irq == SNDRV_AUTO_IRQ) {
223 if ((xgf1_irq = snd_legacy_find_free_irq(possible_gf1_irqs)) < 0) {
224 snd_printk("unable to find a free IRQ for GF1\n");
230 if (xess_irq == SNDRV_AUTO_IRQ) {
231 if ((xess_irq = snd_legacy_find_free_irq(possible_ess_irqs)) < 0) {
232 snd_printk("unable to find a free IRQ for ES1688\n");
237 if (mpu_port[dev] == SNDRV_AUTO_PORT)
239 xmpu_irq = mpu_irq[dev];
242 xgf1_dma = dma1[dev];
243 if (xgf1_dma == SNDRV_AUTO_DMA) {
244 if ((xgf1_dma = snd_legacy_find_free_dma(possible_gf1_dmas)) < 0) {
245 snd_printk("unable to find a free DMA for GF1\n");
250 xess_dma = dma8[dev];
251 if (xess_dma == SNDRV_AUTO_DMA) {
252 if ((xess_dma = snd_legacy_find_free_dma(possible_ess_dmas)) < 0) {
253 snd_printk("unable to find a free DMA for ES1688\n");
259 if ((err = snd_es1688_create(card, port[dev], mpu_port[dev],
260 xess_irq, xmpu_irq, xess_dma,
261 ES1688_HW_1688, &es1688)) < 0)
263 if (gf1_port[dev] < 0)
264 gf1_port[dev] = port[dev] + 0x20;
265 if ((err = snd_gus_create(card,
271 pcm_channels[dev], 0,
275 if ((err = snd_gusextreme_detect(dev, card, gus, es1688)) < 0)
278 snd_gusextreme_init(dev, gus);
279 if ((err = snd_gus_initialize(gus)) < 0)
282 if (!gus->ess_flag) {
283 snd_printdd("GUS Extreme soundcard was not detected at 0x%lx\n", gus->gf1.port);
287 if ((err = snd_es1688_pcm(es1688, 0, NULL)) < 0)
290 if ((err = snd_es1688_mixer(es1688)) < 0)
293 snd_component_add(card, "ES1688");
294 if (pcm_channels[dev] > 0) {
295 if ((err = snd_gf1_pcm_new(gus, 1, 1, NULL)) < 0)
298 if ((err = snd_gf1_new_mixer(gus)) < 0)
301 if ((err = snd_gusextreme_mixer(es1688)) < 0)
304 if (snd_opl3_create(card, es1688->port, es1688->port + 2,
305 OPL3_HW_OPL3, 0, &opl3) < 0) {
306 printk(KERN_ERR "gusextreme: opl3 not detected at 0x%lx\n", es1688->port);
308 if ((err = snd_opl3_hwdep_new(opl3, 0, 2, NULL)) < 0)
312 if (es1688->mpu_port >= 0x300 &&
313 (err = snd_mpu401_uart_new(card, 0, MPU401_HW_ES1688,
320 sprintf(card->longname, "Gravis UltraSound Extreme at 0x%lx, irq %i&%i, dma %i&%i",
321 es1688->port, xgf1_irq, xess_irq, xgf1_dma, xess_dma);
322 if ((err = snd_card_register(card)) < 0)
325 snd_gusextreme_cards[dev] = card;
333 static int __init snd_gusextreme_legacy_auto_probe(unsigned long xport)
338 for ( ; dev < SNDRV_CARDS; dev++) {
339 if (!enable[dev] || port[dev] != SNDRV_AUTO_PORT)
342 res = snd_gusextreme_probe(dev);
344 port[dev] = SNDRV_AUTO_PORT;
350 static int __init alsa_card_gusextreme_init(void)
352 static unsigned long possible_ports[] = {0x220, 0x240, 0x260, -1};
355 for (dev = cards = 0; dev < SNDRV_CARDS && enable[dev] > 0; dev++) {
356 if (port[dev] == SNDRV_AUTO_PORT)
358 if (snd_gusextreme_probe(dev) >= 0)
361 i = snd_legacy_auto_probe(possible_ports, snd_gusextreme_legacy_auto_probe);
367 printk(KERN_ERR "GUS Extreme soundcard not found or device busy\n");
374 static void __exit alsa_card_gusextreme_exit(void)
378 struct snd_gusextreme *acard;
380 for (idx = 0; idx < SNDRV_CARDS; idx++) {
381 card = snd_gusextreme_cards[idx];
384 acard = (struct snd_gusextreme *)card->private_data;
385 snd_card_free(snd_gusextreme_cards[idx]);
389 module_init(alsa_card_gusextreme_init)
390 module_exit(alsa_card_gusextreme_exit)