xref: /openbmc/linux/sound/isa/gus/gusmax.c (revision 275876e2)
1 /*
2  *  Driver for Gravis UltraSound MAX soundcard
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/module.h>
28 #include <asm/dma.h>
29 #include <sound/core.h>
30 #include <sound/gus.h>
31 #include <sound/wss.h>
32 #define SNDRV_LEGACY_FIND_FREE_IRQ
33 #define SNDRV_LEGACY_FIND_FREE_DMA
34 #include <sound/initval.h>
35 
36 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
37 MODULE_DESCRIPTION("Gravis UltraSound MAX");
38 MODULE_LICENSE("GPL");
39 MODULE_SUPPORTED_DEVICE("{{Gravis,UltraSound MAX}}");
40 
41 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
42 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
43 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE;	/* Enable this card */
44 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;	/* 0x220,0x230,0x240,0x250,0x260 */
45 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ;	/* 2,3,5,9,11,12,15 */
46 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 1,3,5,6,7 */
47 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA;	/* 1,3,5,6,7 */
48 static int joystick_dac[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 29};
49 				/* 0 to 31, (0.59V-4.52V or 0.389V-2.98V) */
50 static int channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 24};
51 static int pcm_channels[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 2};
52 
53 module_param_array(index, int, NULL, 0444);
54 MODULE_PARM_DESC(index, "Index value for GUS MAX soundcard.");
55 module_param_array(id, charp, NULL, 0444);
56 MODULE_PARM_DESC(id, "ID string for GUS MAX soundcard.");
57 module_param_array(enable, bool, NULL, 0444);
58 MODULE_PARM_DESC(enable, "Enable GUS MAX soundcard.");
59 module_param_array(port, long, NULL, 0444);
60 MODULE_PARM_DESC(port, "Port # for GUS MAX driver.");
61 module_param_array(irq, int, NULL, 0444);
62 MODULE_PARM_DESC(irq, "IRQ # for GUS MAX driver.");
63 module_param_array(dma1, int, NULL, 0444);
64 MODULE_PARM_DESC(dma1, "DMA1 # for GUS MAX driver.");
65 module_param_array(dma2, int, NULL, 0444);
66 MODULE_PARM_DESC(dma2, "DMA2 # for GUS MAX driver.");
67 module_param_array(joystick_dac, int, NULL, 0444);
68 MODULE_PARM_DESC(joystick_dac, "Joystick DAC level 0.59V-4.52V or 0.389V-2.98V for GUS MAX driver.");
69 module_param_array(channels, int, NULL, 0444);
70 MODULE_PARM_DESC(channels, "Used GF1 channels for GUS MAX driver.");
71 module_param_array(pcm_channels, int, NULL, 0444);
72 MODULE_PARM_DESC(pcm_channels, "Reserved PCM channels for GUS MAX driver.");
73 
74 struct snd_gusmax {
75 	int irq;
76 	struct snd_card *card;
77 	struct snd_gus_card *gus;
78 	struct snd_wss *wss;
79 	unsigned short gus_status_reg;
80 	unsigned short pcm_status_reg;
81 };
82 
83 #define PFX	"gusmax: "
84 
85 static int snd_gusmax_detect(struct snd_gus_card *gus)
86 {
87 	unsigned char d;
88 
89 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0);	/* reset GF1 */
90 	if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 0) {
91 		snd_printdd("[0x%lx] check 1 failed - 0x%x\n", gus->gf1.port, d);
92 		return -ENODEV;
93 	}
94 	udelay(160);
95 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);	/* release reset */
96 	udelay(160);
97 	if (((d = snd_gf1_i_look8(gus, SNDRV_GF1_GB_RESET)) & 0x07) != 1) {
98 		snd_printdd("[0x%lx] check 2 failed - 0x%x\n", gus->gf1.port, d);
99 		return -ENODEV;
100 	}
101 
102 	return 0;
103 }
104 
105 static irqreturn_t snd_gusmax_interrupt(int irq, void *dev_id)
106 {
107 	struct snd_gusmax *maxcard = dev_id;
108 	int loop, max = 5;
109 	int handled = 0;
110 
111 	do {
112 		loop = 0;
113 		if (inb(maxcard->gus_status_reg)) {
114 			handled = 1;
115 			snd_gus_interrupt(irq, maxcard->gus);
116 			loop++;
117 		}
118 		if (inb(maxcard->pcm_status_reg) & 0x01) { /* IRQ bit is set? */
119 			handled = 1;
120 			snd_wss_interrupt(irq, maxcard->wss);
121 			loop++;
122 		}
123 	} while (loop && --max > 0);
124 	return IRQ_RETVAL(handled);
125 }
126 
127 static void snd_gusmax_init(int dev, struct snd_card *card,
128 			    struct snd_gus_card *gus)
129 {
130 	gus->equal_irq = 1;
131 	gus->codec_flag = 1;
132 	gus->joystick_dac = joystick_dac[dev];
133 	/* init control register */
134 	gus->max_cntrl_val = (gus->gf1.port >> 4) & 0x0f;
135 	if (gus->gf1.dma1 > 3)
136 		gus->max_cntrl_val |= 0x10;
137 	if (gus->gf1.dma2 > 3)
138 		gus->max_cntrl_val |= 0x20;
139 	gus->max_cntrl_val |= 0x40;
140 	outb(gus->max_cntrl_val, GUSP(gus, MAXCNTRLPORT));
141 }
142 
143 static int snd_gusmax_mixer(struct snd_wss *chip)
144 {
145 	struct snd_card *card = chip->card;
146 	struct snd_ctl_elem_id id1, id2;
147 	int err;
148 
149 	memset(&id1, 0, sizeof(id1));
150 	memset(&id2, 0, sizeof(id2));
151 	id1.iface = id2.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
152 	/* reassign AUXA to SYNTHESIZER */
153 	strcpy(id1.name, "Aux Playback Switch");
154 	strcpy(id2.name, "Synth Playback Switch");
155 	if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
156 		return err;
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 AUXB to CD */
162 	strcpy(id1.name, "Aux Playback Switch"); id1.index = 1;
163 	strcpy(id2.name, "CD Playback Switch");
164 	if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
165 		return err;
166 	strcpy(id1.name, "Aux Playback Volume");
167 	strcpy(id2.name, "CD Playback Volume");
168 	if ((err = snd_ctl_rename_id(card, &id1, &id2)) < 0)
169 		return err;
170 #if 0
171 	/* reassign Mono Input to MIC */
172 	if (snd_mixer_group_rename(mixer,
173 				SNDRV_MIXER_IN_MONO, 0,
174 				SNDRV_MIXER_IN_MIC, 0) < 0)
175 		goto __error;
176 	if (snd_mixer_elem_rename(mixer,
177 				SNDRV_MIXER_IN_MONO, 0, SNDRV_MIXER_ETYPE_INPUT,
178 				SNDRV_MIXER_IN_MIC, 0) < 0)
179 		goto __error;
180 	if (snd_mixer_elem_rename(mixer,
181 				"Mono Capture Volume", 0, SNDRV_MIXER_ETYPE_VOLUME1,
182 				"Mic Capture Volume", 0) < 0)
183 		goto __error;
184 	if (snd_mixer_elem_rename(mixer,
185 				"Mono Capture Switch", 0, SNDRV_MIXER_ETYPE_SWITCH1,
186 				"Mic Capture Switch", 0) < 0)
187 		goto __error;
188 #endif
189 	return 0;
190 }
191 
192 static void snd_gusmax_free(struct snd_card *card)
193 {
194 	struct snd_gusmax *maxcard = card->private_data;
195 
196 	if (maxcard == NULL)
197 		return;
198 	if (maxcard->irq >= 0)
199 		free_irq(maxcard->irq, (void *)maxcard);
200 }
201 
202 static int snd_gusmax_match(struct device *pdev, unsigned int dev)
203 {
204 	return enable[dev];
205 }
206 
207 static int snd_gusmax_probe(struct device *pdev, unsigned int dev)
208 {
209 	static int possible_irqs[] = {5, 11, 12, 9, 7, 15, 3, -1};
210 	static int possible_dmas[] = {5, 6, 7, 1, 3, -1};
211 	int xirq, xdma1, xdma2, err;
212 	struct snd_card *card;
213 	struct snd_gus_card *gus = NULL;
214 	struct snd_wss *wss;
215 	struct snd_gusmax *maxcard;
216 
217 	err = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
218 			   sizeof(struct snd_gusmax), &card);
219 	if (err < 0)
220 		return err;
221 	card->private_free = snd_gusmax_free;
222 	maxcard = card->private_data;
223 	maxcard->card = card;
224 	maxcard->irq = -1;
225 
226 	xirq = irq[dev];
227 	if (xirq == SNDRV_AUTO_IRQ) {
228 		if ((xirq = snd_legacy_find_free_irq(possible_irqs)) < 0) {
229 			snd_printk(KERN_ERR PFX "unable to find a free IRQ\n");
230 			err = -EBUSY;
231 			goto _err;
232 		}
233 	}
234 	xdma1 = dma1[dev];
235 	if (xdma1 == SNDRV_AUTO_DMA) {
236 		if ((xdma1 = snd_legacy_find_free_dma(possible_dmas)) < 0) {
237 			snd_printk(KERN_ERR PFX "unable to find a free DMA1\n");
238 			err = -EBUSY;
239 			goto _err;
240 		}
241 	}
242 	xdma2 = dma2[dev];
243 	if (xdma2 == SNDRV_AUTO_DMA) {
244 		if ((xdma2 = snd_legacy_find_free_dma(possible_dmas)) < 0) {
245 			snd_printk(KERN_ERR PFX "unable to find a free DMA2\n");
246 			err = -EBUSY;
247 			goto _err;
248 		}
249 	}
250 
251 	if (port[dev] != SNDRV_AUTO_PORT) {
252 		err = snd_gus_create(card,
253 				     port[dev],
254 				     -xirq, xdma1, xdma2,
255 				     0, channels[dev],
256 				     pcm_channels[dev],
257 				     0, &gus);
258 	} else {
259 		static unsigned long possible_ports[] = {
260 			0x220, 0x230, 0x240, 0x250, 0x260
261 		};
262 		int i;
263 		for (i = 0; i < ARRAY_SIZE(possible_ports); i++) {
264 			err = snd_gus_create(card,
265 					     possible_ports[i],
266 					     -xirq, xdma1, xdma2,
267 					     0, channels[dev],
268 					     pcm_channels[dev],
269 					     0, &gus);
270 			if (err >= 0) {
271 				port[dev] = possible_ports[i];
272 				break;
273 			}
274 		}
275 	}
276 	if (err < 0)
277 		goto _err;
278 
279 	if ((err = snd_gusmax_detect(gus)) < 0)
280 		goto _err;
281 
282 	maxcard->gus_status_reg = gus->gf1.reg_irqstat;
283 	maxcard->pcm_status_reg = gus->gf1.port + 0x10c + 2;
284 	snd_gusmax_init(dev, card, gus);
285 	if ((err = snd_gus_initialize(gus)) < 0)
286 		goto _err;
287 
288 	if (!gus->max_flag) {
289 		snd_printk(KERN_ERR PFX "GUS MAX soundcard was not detected at 0x%lx\n", gus->gf1.port);
290 		err = -ENODEV;
291 		goto _err;
292 	}
293 
294 	if (request_irq(xirq, snd_gusmax_interrupt, 0, "GUS MAX", (void *)maxcard)) {
295 		snd_printk(KERN_ERR PFX "unable to grab IRQ %d\n", xirq);
296 		err = -EBUSY;
297 		goto _err;
298 	}
299 	maxcard->irq = xirq;
300 
301 	err = snd_wss_create(card,
302 			     gus->gf1.port + 0x10c, -1, xirq,
303 			     xdma2 < 0 ? xdma1 : xdma2, xdma1,
304 			     WSS_HW_DETECT,
305 			     WSS_HWSHARE_IRQ |
306 			     WSS_HWSHARE_DMA1 |
307 			     WSS_HWSHARE_DMA2,
308 			     &wss);
309 	if (err < 0)
310 		goto _err;
311 
312 	err = snd_wss_pcm(wss, 0, NULL);
313 	if (err < 0)
314 		goto _err;
315 
316 	err = snd_wss_mixer(wss);
317 	if (err < 0)
318 		goto _err;
319 
320 	err = snd_wss_timer(wss, 2, NULL);
321 	if (err < 0)
322 		goto _err;
323 
324 	if (pcm_channels[dev] > 0) {
325 		if ((err = snd_gf1_pcm_new(gus, 1, 1, NULL)) < 0)
326 			goto _err;
327 	}
328 	err = snd_gusmax_mixer(wss);
329 	if (err < 0)
330 		goto _err;
331 
332 	err = snd_gf1_rawmidi_new(gus, 0, NULL);
333 	if (err < 0)
334 		goto _err;
335 
336 	sprintf(card->longname + strlen(card->longname), " at 0x%lx, irq %i, dma %i", gus->gf1.port, xirq, xdma1);
337 	if (xdma2 >= 0)
338 		sprintf(card->longname + strlen(card->longname), "&%i", xdma2);
339 
340 	err = snd_card_register(card);
341 	if (err < 0)
342 		goto _err;
343 
344 	maxcard->gus = gus;
345 	maxcard->wss = wss;
346 
347 	dev_set_drvdata(pdev, card);
348 	return 0;
349 
350  _err:
351 	snd_card_free(card);
352 	return err;
353 }
354 
355 static int snd_gusmax_remove(struct device *devptr, unsigned int dev)
356 {
357 	snd_card_free(dev_get_drvdata(devptr));
358 	return 0;
359 }
360 
361 #define DEV_NAME "gusmax"
362 
363 static struct isa_driver snd_gusmax_driver = {
364 	.match		= snd_gusmax_match,
365 	.probe		= snd_gusmax_probe,
366 	.remove		= snd_gusmax_remove,
367 	/* FIXME: suspend/resume */
368 	.driver		= {
369 		.name	= DEV_NAME
370 	},
371 };
372 
373 static int __init alsa_card_gusmax_init(void)
374 {
375 	return isa_register_driver(&snd_gusmax_driver, SNDRV_CARDS);
376 }
377 
378 static void __exit alsa_card_gusmax_exit(void)
379 {
380 	isa_unregister_driver(&snd_gusmax_driver);
381 }
382 
383 module_init(alsa_card_gusmax_init)
384 module_exit(alsa_card_gusmax_exit)
385