[ALSA] au88x0 - Init before create components
[linux-2.6.git] / sound / pci / au88x0 / au88x0.c
1 /*
2  * ALSA driver for the Aureal Vortex family of soundprocessors.
3  * Author: Manuel Jander (mjander@embedded.cl)
4  *
5  *   This driver is the result of the OpenVortex Project from Savannah
6  * (savannah.nongnu.org/projects/openvortex). I would like to thank
7  * the developers of OpenVortex, Jeff Muizelaar and Kester Maddock, from
8  * whom i got plenty of help, and their codebase was invaluable.
9  *   Thanks to the ALSA developers, they helped a lot working out
10  * the ALSA part.
11  *   Thanks also to Sourceforge for maintaining the old binary drivers,
12  * and the forum, where developers could comunicate.
13  *
14  * Now at least i can play Legacy DOOM with MIDI music :-)
15  */
16
17 #include "au88x0.h"
18 #include <linux/init.h>
19 #include <linux/pci.h>
20 #include <linux/slab.h>
21 #include <linux/interrupt.h>
22 #include <linux/moduleparam.h>
23 #include <linux/dma-mapping.h>
24 #include <sound/initval.h>
25
26 // module parameters (see "Module Parameters")
27 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
28 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
29 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
30 static int pcifix[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 255 };
31
32 module_param_array(index, int, NULL, 0444);
33 MODULE_PARM_DESC(index, "Index value for " CARD_NAME " soundcard.");
34 module_param_array(id, charp, NULL, 0444);
35 MODULE_PARM_DESC(id, "ID string for " CARD_NAME " soundcard.");
36 module_param_array(enable, bool, NULL, 0444);
37 MODULE_PARM_DESC(enable, "Enable " CARD_NAME " soundcard.");
38 module_param_array(pcifix, int, NULL, 0444);
39 MODULE_PARM_DESC(pcifix, "Enable VIA-workaround for " CARD_NAME " soundcard.");
40
41 MODULE_DESCRIPTION("Aureal vortex");
42 MODULE_LICENSE("GPL");
43 MODULE_SUPPORTED_DEVICE("{{Aureal Semiconductor Inc., Aureal Vortex Sound Processor}}");
44
45 MODULE_DEVICE_TABLE(pci, snd_vortex_ids);
46
47 static void vortex_fix_latency(struct pci_dev *vortex)
48 {
49         int rc;
50         if (!(rc = pci_write_config_byte(vortex, 0x40, 0xff))) {
51                         printk(KERN_INFO CARD_NAME
52                                ": vortex latency is 0xff\n");
53         } else {
54                 printk(KERN_WARNING CARD_NAME
55                                 ": could not set vortex latency: pci error 0x%x\n", rc);
56         }
57 }
58
59 static void vortex_fix_agp_bridge(struct pci_dev *via)
60 {
61         int rc;
62         u8 value;
63
64         /*
65          * only set the bit (Extend PCI#2 Internal Master for
66          * Efficient Handling of Dummy Requests) if the can
67          * read the config and it is not already set
68          */
69
70         if (!(rc = pci_read_config_byte(via, 0x42, &value))
71                         && ((value & 0x10)
72                                 || !(rc = pci_write_config_byte(via, 0x42, value | 0x10)))) {
73                 printk(KERN_INFO CARD_NAME
74                                 ": bridge config is 0x%x\n", value | 0x10);
75         } else {
76                 printk(KERN_WARNING CARD_NAME
77                                 ": could not set vortex latency: pci error 0x%x\n", rc);
78         }
79 }
80
81 static void __devinit snd_vortex_workaround(struct pci_dev *vortex, int fix)
82 {
83         struct pci_dev *via = NULL;
84
85         /* autodetect if workarounds are required */
86         if (fix == 255) {
87                 /* VIA KT133 */
88                 via = pci_get_device(PCI_VENDOR_ID_VIA,
89                         PCI_DEVICE_ID_VIA_8365_1, NULL);
90                 /* VIA Apollo */
91                 if (via == NULL) {
92                         via = pci_get_device(PCI_VENDOR_ID_VIA,
93                                 PCI_DEVICE_ID_VIA_82C598_1, NULL);
94                         /* AMD Irongate */
95                         if (via == NULL)
96                                 via = pci_get_device(PCI_VENDOR_ID_AMD,
97                                         PCI_DEVICE_ID_AMD_FE_GATE_7007, NULL);
98                 }
99                 if (via) {
100                         printk(KERN_INFO CARD_NAME ": Activating latency workaround...\n");
101                         vortex_fix_latency(vortex);
102                         vortex_fix_agp_bridge(via);
103                 }
104         } else {
105                 if (fix & 0x1)
106                         vortex_fix_latency(vortex);
107                 if ((fix & 0x2) && (via = pci_get_device(PCI_VENDOR_ID_VIA,
108                                 PCI_DEVICE_ID_VIA_8365_1, NULL)))
109                         vortex_fix_agp_bridge(via);
110                 if ((fix & 0x4) && (via = pci_get_device(PCI_VENDOR_ID_VIA,
111                                 PCI_DEVICE_ID_VIA_82C598_1, NULL)))
112                         vortex_fix_agp_bridge(via);
113                 if ((fix & 0x8) && (via = pci_get_device(PCI_VENDOR_ID_AMD,
114                                 PCI_DEVICE_ID_AMD_FE_GATE_7007, NULL)))
115                         vortex_fix_agp_bridge(via);
116         }
117         pci_dev_put(via);
118 }
119
120 // component-destructor
121 // (see "Management of Cards and Components")
122 static int snd_vortex_dev_free(struct snd_device *device)
123 {
124         vortex_t *vortex = device->device_data;
125
126         vortex_gameport_unregister(vortex);
127         vortex_core_shutdown(vortex);
128         // Take down PCI interface.
129         synchronize_irq(vortex->irq);
130         free_irq(vortex->irq, vortex);
131         pci_release_regions(vortex->pci_dev);
132         pci_disable_device(vortex->pci_dev);
133         kfree(vortex);
134
135         return 0;
136 }
137
138 // chip-specific constructor
139 // (see "Management of Cards and Components")
140 static int __devinit
141 snd_vortex_create(struct snd_card *card, struct pci_dev *pci, vortex_t ** rchip)
142 {
143         vortex_t *chip;
144         int err;
145         static struct snd_device_ops ops = {
146                 .dev_free = snd_vortex_dev_free,
147         };
148
149         *rchip = NULL;
150
151         // check PCI availability (DMA).
152         if ((err = pci_enable_device(pci)) < 0)
153                 return err;
154         if (pci_set_dma_mask(pci, DMA_32BIT_MASK) < 0 ||
155             pci_set_consistent_dma_mask(pci, DMA_32BIT_MASK) < 0) {
156                 printk(KERN_ERR "error to set DMA mask\n");
157                 pci_disable_device(pci);
158                 return -ENXIO;
159         }
160
161         chip = kzalloc(sizeof(*chip), GFP_KERNEL);
162         if (chip == NULL) {
163                 pci_disable_device(pci);
164                 return -ENOMEM;
165         }
166
167         chip->card = card;
168
169         // initialize the stuff
170         chip->pci_dev = pci;
171         chip->io = pci_resource_start(pci, 0);
172         chip->vendor = pci->vendor;
173         chip->device = pci->device;
174         chip->card = card;
175         chip->irq = -1;
176
177         // (1) PCI resource allocation
178         // Get MMIO area
179         //
180         if ((err = pci_request_regions(pci, CARD_NAME_SHORT)) != 0)
181                 goto regions_out;
182
183         chip->mmio = ioremap_nocache(pci_resource_start(pci, 0),
184                                      pci_resource_len(pci, 0));
185         if (!chip->mmio) {
186                 printk(KERN_ERR "MMIO area remap failed.\n");
187                 err = -ENOMEM;
188                 goto ioremap_out;
189         }
190
191         /* Init audio core.
192          * This must be done before we do request_irq otherwise we can get spurious
193          * interupts that we do not handle properly and make a mess of things */
194         if ((err = vortex_core_init(chip)) != 0) {
195                 printk(KERN_ERR "hw core init failed\n");
196                 goto core_out;
197         }
198
199         if ((err = request_irq(pci->irq, vortex_interrupt,
200                                SA_INTERRUPT | SA_SHIRQ, CARD_NAME_SHORT,
201                                chip)) != 0) {
202                 printk(KERN_ERR "cannot grab irq\n");
203                 goto irq_out;
204         }
205         chip->irq = pci->irq;
206
207         pci_set_master(pci);
208         // End of PCI setup.
209
210         // Register alsa root device.
211         if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0) {
212                 goto alloc_out;
213         }
214
215         snd_card_set_dev(card, &pci->dev);
216
217         *rchip = chip;
218
219         return 0;
220
221       alloc_out:
222         synchronize_irq(chip->irq);
223         free_irq(chip->irq, chip);
224       irq_out:
225         vortex_core_shutdown(chip);
226       core_out:
227         iounmap(chip->mmio);
228       ioremap_out:
229         pci_release_regions(chip->pci_dev);
230       regions_out:
231         pci_disable_device(chip->pci_dev);
232         //FIXME: this not the right place to unregister the gameport
233         vortex_gameport_unregister(chip);
234         return err;
235 }
236
237 // constructor -- see "Constructor" sub-section
238 static int __devinit
239 snd_vortex_probe(struct pci_dev *pci, const struct pci_device_id *pci_id)
240 {
241         static int dev;
242         struct snd_card *card;
243         vortex_t *chip;
244         int err;
245
246         // (1)
247         if (dev >= SNDRV_CARDS)
248                 return -ENODEV;
249         if (!enable[dev]) {
250                 dev++;
251                 return -ENOENT;
252         }
253         // (2)
254         card = snd_card_new(index[dev], id[dev], THIS_MODULE, 0);
255         if (card == NULL)
256                 return -ENOMEM;
257
258         // (3)
259         if ((err = snd_vortex_create(card, pci, &chip)) < 0) {
260                 snd_card_free(card);
261                 return err;
262         }
263         snd_vortex_workaround(pci, pcifix[dev]);
264
265         // Card details needed in snd_vortex_midi
266         strcpy(card->driver, CARD_NAME_SHORT);
267         sprintf(card->shortname, "Aureal Vortex %s", CARD_NAME_SHORT);
268         sprintf(card->longname, "%s at 0x%lx irq %i",
269                 card->shortname, chip->io, chip->irq);
270
271         // (4) Alloc components.
272         // ADB pcm.
273         if ((err = snd_vortex_new_pcm(chip, VORTEX_PCM_ADB, NR_ADB)) < 0) {
274                 snd_card_free(card);
275                 return err;
276         }
277 #ifndef CHIP_AU8820
278         // ADB SPDIF
279         if ((err = snd_vortex_new_pcm(chip, VORTEX_PCM_SPDIF, 1)) < 0) {
280                 snd_card_free(card);
281                 return err;
282         }
283         // A3D
284         if ((err = snd_vortex_new_pcm(chip, VORTEX_PCM_A3D, NR_A3D)) < 0) {
285                 snd_card_free(card);
286                 return err;
287         }
288 #endif
289         /*
290            // ADB I2S
291            if ((err = snd_vortex_new_pcm(chip, VORTEX_PCM_I2S, 1)) < 0) {
292            snd_card_free(card);
293            return err;
294            }
295          */
296 #ifndef CHIP_AU8810
297         // WT pcm.
298         if ((err = snd_vortex_new_pcm(chip, VORTEX_PCM_WT, NR_WT)) < 0) {
299                 snd_card_free(card);
300                 return err;
301         }
302 #endif
303         // snd_ac97_mixer and Vortex mixer.
304         if ((err = snd_vortex_mixer(chip)) < 0) {
305                 snd_card_free(card);
306                 return err;
307         }
308         if ((err = snd_vortex_midi(chip)) < 0) {
309                 snd_card_free(card);
310                 return err;
311         }
312
313         vortex_gameport_register(chip);
314
315 #if 0
316         if (snd_seq_device_new(card, 1, SNDRV_SEQ_DEV_ID_VORTEX_SYNTH,
317                                sizeof(snd_vortex_synth_arg_t), &wave) < 0
318             || wave == NULL) {
319                 snd_printk(KERN_ERR "Can't initialize Aureal wavetable synth\n");
320         } else {
321                 snd_vortex_synth_arg_t *arg;
322
323                 arg = SNDRV_SEQ_DEVICE_ARGPTR(wave);
324                 strcpy(wave->name, "Aureal Synth");
325                 arg->hwptr = vortex;
326                 arg->index = 1;
327                 arg->seq_ports = seq_ports[dev];
328                 arg->max_voices = max_synth_voices[dev];
329         }
330 #endif
331
332         // (5)
333         if ((err = pci_read_config_word(pci, PCI_DEVICE_ID,
334                                   &(chip->device))) < 0) {
335                 snd_card_free(card);
336                 return err;
337         }       
338         if ((err = pci_read_config_word(pci, PCI_VENDOR_ID,
339                                   &(chip->vendor))) < 0) {
340                 snd_card_free(card);
341                 return err;
342         }
343         if ((err = pci_read_config_byte(pci, PCI_REVISION_ID,
344                                   &(chip->rev))) < 0) {
345                 snd_card_free(card);
346                 return err;
347         }
348 #ifdef CHIP_AU8830
349         if ((chip->rev) != 0xfe && (chip->rev) != 0xfa) {
350                 printk(KERN_ALERT
351                        "vortex: The revision (%x) of your card has not been seen before.\n",
352                        chip->rev);
353                 printk(KERN_ALERT
354                        "vortex: Please email the results of 'lspci -vv' to openvortex-dev@nongnu.org.\n");
355                 snd_card_free(card);
356                 err = -ENODEV;
357                 return err;
358         }
359 #endif
360
361         // (6)
362         if ((err = snd_card_register(card)) < 0) {
363                 snd_card_free(card);
364                 return err;
365         }
366         // (7)
367         pci_set_drvdata(pci, card);
368         dev++;
369         vortex_connect_default(chip, 1);
370         vortex_enable_int(chip);
371         return 0;
372 }
373
374 // destructor -- see "Destructor" sub-section
375 static void __devexit snd_vortex_remove(struct pci_dev *pci)
376 {
377         snd_card_free(pci_get_drvdata(pci));
378         pci_set_drvdata(pci, NULL);
379 }
380
381 // pci_driver definition
382 static struct pci_driver driver = {
383         .name = CARD_NAME_SHORT,
384         .id_table = snd_vortex_ids,
385         .probe = snd_vortex_probe,
386         .remove = __devexit_p(snd_vortex_remove),
387 };
388
389 // initialization of the module
390 static int __init alsa_card_vortex_init(void)
391 {
392         return pci_register_driver(&driver);
393 }
394
395 // clean up the module
396 static void __exit alsa_card_vortex_exit(void)
397 {
398         pci_unregister_driver(&driver);
399 }
400
401 module_init(alsa_card_vortex_init)
402 module_exit(alsa_card_vortex_exit)