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