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