2 * ALSA card-level driver for Turtle Beach Wavefront cards
3 * (Maui,Tropez,Tropez+)
5 * Copyright (c) 1997-1999 by Paul Barton-Davis <pbd@op.net>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 #include <sound/driver.h>
23 #include <linux/init.h>
24 #include <linux/interrupt.h>
25 #include <linux/slab.h>
26 #include <linux/pnp.h>
27 #include <linux/moduleparam.h>
28 #include <sound/core.h>
29 #include <sound/initval.h>
30 #include <sound/opl3.h>
31 #include <sound/snd_wavefront.h>
33 MODULE_AUTHOR("Paul Barton-Davis <pbd@op.net>");
34 MODULE_DESCRIPTION("Turtle Beach Wavefront");
35 MODULE_LICENSE("GPL");
36 MODULE_SUPPORTED_DEVICE("{{Turtle Beach,Maui/Tropez/Tropez+}}");
38 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
39 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
40 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
41 static int isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
42 static long cs4232_pcm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
43 static int cs4232_pcm_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,11,12,15 */
44 static long cs4232_mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
45 static int cs4232_mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 9,11,12,15 */
46 static long ics2115_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
47 static int ics2115_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 2,9,11,12,15 */
48 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
49 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3,5,6,7 */
50 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3,5,6,7 */
51 static int use_cs4232_midi[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 0};
54 module_param_array(index, int, boot_devs, 0444);
55 MODULE_PARM_DESC(index, "Index value for WaveFront soundcard.");
56 module_param_array(id, charp, boot_devs, 0444);
57 MODULE_PARM_DESC(id, "ID string for WaveFront soundcard.");
58 module_param_array(enable, bool, boot_devs, 0444);
59 MODULE_PARM_DESC(enable, "Enable WaveFront soundcard.");
61 module_param_array(isapnp, bool, boot_devs, 0444);
62 MODULE_PARM_DESC(isapnp, "ISA PnP detection for WaveFront soundcards.");
64 module_param_array(cs4232_pcm_port, long, boot_devs, 0444);
65 MODULE_PARM_DESC(cs4232_pcm_port, "Port # for CS4232 PCM interface.");
66 module_param_array(cs4232_pcm_irq, int, boot_devs, 0444);
67 MODULE_PARM_DESC(cs4232_pcm_irq, "IRQ # for CS4232 PCM interface.");
68 module_param_array(dma1, int, boot_devs, 0444);
69 MODULE_PARM_DESC(dma1, "DMA1 # for CS4232 PCM interface.");
70 module_param_array(dma2, int, boot_devs, 0444);
71 MODULE_PARM_DESC(dma2, "DMA2 # for CS4232 PCM interface.");
72 module_param_array(cs4232_mpu_port, long, boot_devs, 0444);
73 MODULE_PARM_DESC(cs4232_mpu_port, "port # for CS4232 MPU-401 interface.");
74 module_param_array(cs4232_mpu_irq, int, boot_devs, 0444);
75 MODULE_PARM_DESC(cs4232_mpu_irq, "IRQ # for CS4232 MPU-401 interface.");
76 module_param_array(ics2115_irq, int, boot_devs, 0444);
77 MODULE_PARM_DESC(ics2115_irq, "IRQ # for ICS2115.");
78 module_param_array(ics2115_port, long, boot_devs, 0444);
79 MODULE_PARM_DESC(ics2115_port, "Port # for ICS2115.");
80 module_param_array(fm_port, long, boot_devs, 0444);
81 MODULE_PARM_DESC(fm_port, "FM port #.");
82 module_param_array(use_cs4232_midi, bool, boot_devs, 0444);
83 MODULE_PARM_DESC(use_cs4232_midi, "Use CS4232 MPU-401 interface (inaccessibly located inside your computer)");
85 static snd_card_t *snd_wavefront_legacy[SNDRV_CARDS] = SNDRV_DEFAULT_PTR;
89 static struct pnp_card_device_id snd_wavefront_pnpids[] = {
91 { .id = "CSC7532", .devs = { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
93 { .id = "CSC7632", .devs = { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
97 MODULE_DEVICE_TABLE(pnp_card, snd_wavefront_pnpids);
100 snd_wavefront_pnp (int dev, snd_wavefront_card_t *acard, struct pnp_card_link *card,
101 const struct pnp_card_device_id *id)
103 struct pnp_dev *pdev;
104 struct pnp_resource_table *cfg = kmalloc(sizeof(*cfg), GFP_KERNEL);
110 /* Check for each logical device. */
112 /* CS4232 chip (aka "windows sound system") is logical device 0 */
114 acard->wss = pnp_request_card_device(card, id->devs[0].id, NULL);
115 if (acard->wss == NULL) {
120 /* there is a game port at logical device 1, but we ignore it completely */
122 /* the control interface is logical device 2, but we ignore it
123 completely. in fact, nobody even seems to know what it
127 /* Only configure the CS4232 MIDI interface if its been
128 specifically requested. It is logical device 3.
131 if (use_cs4232_midi[dev]) {
132 acard->mpu = pnp_request_card_device(card, id->devs[2].id, NULL);
133 if (acard->mpu == NULL) {
139 /* The ICS2115 synth is logical device 4 */
141 acard->synth = pnp_request_card_device(card, id->devs[3].id, NULL);
142 if (acard->synth == NULL) {
147 /* PCM/FM initialization */
151 pnp_init_resource_table(cfg);
153 /* An interesting note from the Tropez+ FAQ:
155 Q. [Ports] Why is the base address of the WSS I/O ports off by 4?
157 A. WSS I/O requires a block of 8 I/O addresses ("ports"). Of these, the first
158 4 are used to identify and configure the board. With the advent of PnP,
159 these first 4 addresses have become obsolete, and software applications
160 only use the last 4 addresses to control the codec chip. Therefore, the
161 base address setting "skips past" the 4 unused addresses.
165 if (cs4232_pcm_port[dev] != SNDRV_AUTO_PORT)
166 pnp_resource_change(&cfg->port_resource[0], cs4232_pcm_port[dev], 4);
167 if (fm_port[dev] != SNDRV_AUTO_PORT)
168 pnp_resource_change(&cfg->port_resource[1], fm_port[dev], 4);
169 if (dma1[dev] != SNDRV_AUTO_DMA)
170 pnp_resource_change(&cfg->dma_resource[0], dma1[dev], 1);
171 if (dma2[dev] != SNDRV_AUTO_DMA)
172 pnp_resource_change(&cfg->dma_resource[1], dma2[dev], 1);
173 if (cs4232_pcm_irq[dev] != SNDRV_AUTO_IRQ)
174 pnp_resource_change(&cfg->irq_resource[0], cs4232_pcm_irq[dev], 1);
176 if (pnp_manual_config_dev(pdev, cfg, 0) < 0)
177 snd_printk(KERN_ERR "PnP WSS the requested resources are invalid, using auto config\n");
178 err = pnp_activate_dev(pdev);
180 snd_printk(KERN_ERR "PnP WSS pnp configure failure\n");
185 cs4232_pcm_port[dev] = pnp_port_start(pdev, 0);
186 fm_port[dev] = pnp_port_start(pdev, 1);
187 dma1[dev] = pnp_dma(pdev, 0);
188 dma2[dev] = pnp_dma(pdev, 1);
189 cs4232_pcm_irq[dev] = pnp_irq(pdev, 0);
191 /* Synth initialization */
195 pnp_init_resource_table(cfg);
197 if (ics2115_port[dev] != SNDRV_AUTO_PORT) {
198 pnp_resource_change(&cfg->port_resource[0], ics2115_port[dev], 16);
201 if (ics2115_port[dev] != SNDRV_AUTO_IRQ) {
202 pnp_resource_change(&cfg->irq_resource[0], ics2115_irq[dev], 1);
205 if (pnp_manual_config_dev(pdev, cfg, 0) < 0)
206 snd_printk(KERN_ERR "PnP ICS2115 the requested resources are invalid, using auto config\n");
207 err = pnp_activate_dev(pdev);
209 snd_printk(KERN_ERR "PnP ICS2115 pnp configure failure\n");
214 ics2115_port[dev] = pnp_port_start(pdev, 0);
215 ics2115_irq[dev] = pnp_irq(pdev, 0);
217 /* CS4232 MPU initialization. Configure this only if
218 explicitly requested, since its physically inaccessible and
219 consumes another IRQ.
222 if (use_cs4232_midi[dev]) {
226 pnp_init_resource_table(cfg);
228 if (cs4232_mpu_port[dev] != SNDRV_AUTO_PORT)
229 pnp_resource_change(&cfg->port_resource[0], cs4232_mpu_port[dev], 2);
230 if (cs4232_mpu_irq[dev] != SNDRV_AUTO_IRQ)
231 pnp_resource_change(&cfg->port_resource[0], cs4232_mpu_irq[dev], 1);
233 if (pnp_manual_config_dev(pdev, cfg, 0) < 0)
234 snd_printk(KERN_ERR "PnP MPU401 the requested resources are invalid, using auto config\n");
235 err = pnp_activate_dev(pdev);
237 snd_printk(KERN_ERR "PnP MPU401 pnp configure failure\n");
238 cs4232_mpu_port[dev] = SNDRV_AUTO_PORT;
240 cs4232_mpu_port[dev] = pnp_port_start(pdev, 0);
241 cs4232_mpu_irq[dev] = pnp_irq(pdev, 0);
244 snd_printk ("CS4232 MPU: port=0x%lx, irq=%i\n",
245 cs4232_mpu_port[dev],
246 cs4232_mpu_irq[dev]);
249 snd_printdd ("CS4232: pcm port=0x%lx, fm port=0x%lx, dma1=%i, dma2=%i, irq=%i\nICS2115: port=0x%lx, irq=%i\n",
250 cs4232_pcm_port[dev],
262 #endif /* CONFIG_PNP */
264 static irqreturn_t snd_wavefront_ics2115_interrupt(int irq,
266 struct pt_regs *regs)
268 snd_wavefront_card_t *acard;
270 acard = (snd_wavefront_card_t *) dev_id;
275 if (acard->wavefront.interrupts_are_midi) {
276 snd_wavefront_midi_interrupt (acard);
278 snd_wavefront_internal_interrupt (acard);
283 snd_hwdep_t * __devinit
284 snd_wavefront_new_synth (snd_card_t *card,
286 snd_wavefront_card_t *acard)
288 snd_hwdep_t *wavefront_synth;
290 if (snd_wavefront_detect (acard) < 0) {
294 if (snd_wavefront_start (&acard->wavefront) < 0) {
298 if (snd_hwdep_new(card, "WaveFront", hw_dev, &wavefront_synth) < 0)
300 strcpy (wavefront_synth->name,
301 "WaveFront (ICS2115) wavetable synthesizer");
302 wavefront_synth->ops.open = snd_wavefront_synth_open;
303 wavefront_synth->ops.release = snd_wavefront_synth_release;
304 wavefront_synth->ops.ioctl = snd_wavefront_synth_ioctl;
306 return wavefront_synth;
309 snd_hwdep_t * __devinit
310 snd_wavefront_new_fx (snd_card_t *card,
312 snd_wavefront_card_t *acard,
316 snd_hwdep_t *fx_processor;
318 if (snd_wavefront_fx_start (&acard->wavefront)) {
319 snd_printk ("cannot initialize YSS225 FX processor");
323 if (snd_hwdep_new (card, "YSS225", hw_dev, &fx_processor) < 0)
325 sprintf (fx_processor->name, "YSS225 FX Processor at 0x%lx", port);
326 fx_processor->ops.open = snd_wavefront_fx_open;
327 fx_processor->ops.release = snd_wavefront_fx_release;
328 fx_processor->ops.ioctl = snd_wavefront_fx_ioctl;
333 static snd_wavefront_mpu_id internal_id = internal_mpu;
334 static snd_wavefront_mpu_id external_id = external_mpu;
336 snd_rawmidi_t * __devinit
337 snd_wavefront_new_midi (snd_card_t *card,
339 snd_wavefront_card_t *acard,
341 snd_wavefront_mpu_id mpu)
344 snd_rawmidi_t *rmidi;
345 static int first = 1;
349 acard->wavefront.midi.base = port;
350 if (snd_wavefront_midi_start (acard)) {
351 snd_printk ("cannot initialize MIDI interface\n");
356 if (snd_rawmidi_new (card, "WaveFront MIDI", midi_dev, 1, 1, &rmidi) < 0)
359 if (mpu == internal_mpu) {
360 strcpy(rmidi->name, "WaveFront MIDI (Internal)");
361 rmidi->private_data = &internal_id;
363 strcpy(rmidi->name, "WaveFront MIDI (External)");
364 rmidi->private_data = &external_id;
367 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_wavefront_midi_output);
368 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_wavefront_midi_input);
370 rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT |
371 SNDRV_RAWMIDI_INFO_INPUT |
372 SNDRV_RAWMIDI_INFO_DUPLEX;
378 snd_wavefront_free(snd_card_t *card)
380 snd_wavefront_card_t *acard = (snd_wavefront_card_t *)card->private_data;
383 if (acard->wavefront.res_base != NULL) {
384 release_resource(acard->wavefront.res_base);
385 kfree_nocheck(acard->wavefront.res_base);
387 if (acard->wavefront.irq > 0)
388 free_irq(acard->wavefront.irq, (void *)acard);
393 snd_wavefront_probe (int dev, struct pnp_card_link *pcard,
394 const struct pnp_card_device_id *pid)
397 snd_wavefront_card_t *acard;
399 snd_hwdep_t *wavefront_synth;
400 snd_rawmidi_t *ics2115_internal_rmidi = NULL;
401 snd_rawmidi_t *ics2115_external_rmidi = NULL;
402 snd_hwdep_t *fx_processor;
403 int hw_dev = 0, midi_dev = 0, err;
408 if (cs4232_pcm_port[dev] == SNDRV_AUTO_PORT) {
409 snd_printk("specify CS4232 port\n");
412 if (ics2115_port[dev] == SNDRV_AUTO_PORT) {
413 snd_printk("specify ICS2115 port\n");
419 card = snd_card_new (index[dev],
422 sizeof(snd_wavefront_card_t));
427 acard = (snd_wavefront_card_t *)card->private_data;
428 acard->wavefront.irq = -1;
429 spin_lock_init(&acard->wavefront.irq_lock);
430 init_waitqueue_head(&acard->wavefront.interrupt_sleeper);
431 spin_lock_init(&acard->wavefront.midi.open);
432 spin_lock_init(&acard->wavefront.midi.virtual);
433 card->private_free = snd_wavefront_free;
437 if (snd_wavefront_pnp (dev, acard, pcard, pid) < 0) {
438 if (cs4232_pcm_port[dev] == SNDRV_AUTO_PORT) {
439 snd_printk ("isapnp detection failed\n");
440 snd_card_free (card);
444 snd_card_set_dev(card, &pcard->card->dev);
446 #endif /* CONFIG_PNP */
448 /* --------- PCM --------------- */
450 if ((err = snd_cs4231_create (card,
451 cs4232_pcm_port[dev],
456 CS4231_HW_DETECT, 0, &chip)) < 0) {
458 snd_printk ("can't allocate CS4231 device\n");
462 if ((err = snd_cs4231_pcm (chip, 0, NULL)) < 0) {
466 if ((err = snd_cs4231_timer (chip, 0, NULL)) < 0) {
471 /* ---------- OPL3 synth --------- */
473 if (fm_port[dev] > 0 && fm_port[dev] != SNDRV_AUTO_PORT) {
476 if ((err = snd_opl3_create(card,
481 snd_printk ("can't allocate or detect OPL3 synth\n");
486 if ((err = snd_opl3_hwdep_new(opl3, hw_dev, 1, NULL)) < 0) {
493 /* ------- ICS2115 Wavetable synth ------- */
495 if ((acard->wavefront.res_base = request_region(ics2115_port[dev], 16, "ICS2115")) == NULL) {
496 snd_printk("unable to grab ICS2115 i/o region 0x%lx-0x%lx\n", ics2115_port[dev], ics2115_port[dev] + 16 - 1);
500 if (request_irq(ics2115_irq[dev], snd_wavefront_ics2115_interrupt, SA_INTERRUPT, "ICS2115", (void *)acard)) {
501 snd_printk("unable to use ICS2115 IRQ %d\n", ics2115_irq[dev]);
506 acard->wavefront.irq = ics2115_irq[dev];
507 acard->wavefront.base = ics2115_port[dev];
509 if ((wavefront_synth = snd_wavefront_new_synth (card, hw_dev, acard)) == NULL) {
510 snd_printk ("can't create WaveFront synth device\n");
515 strcpy (wavefront_synth->name, "ICS2115 Wavetable MIDI Synthesizer");
516 wavefront_synth->iface = SNDRV_HWDEP_IFACE_ICS2115;
519 /* --------- Mixer ------------ */
521 if ((err = snd_cs4231_mixer(chip)) < 0) {
522 snd_printk ("can't allocate mixer device\n");
527 /* -------- CS4232 MPU-401 interface -------- */
529 if (cs4232_mpu_port[dev] > 0 && cs4232_mpu_port[dev] != SNDRV_AUTO_PORT) {
530 if ((err = snd_mpu401_uart_new(card, midi_dev, MPU401_HW_CS4232,
531 cs4232_mpu_port[dev], 0,
535 snd_printk ("can't allocate CS4232 MPU-401 device\n");
542 /* ------ ICS2115 internal MIDI ------------ */
544 if (ics2115_port[dev] > 0 && ics2115_port[dev] != SNDRV_AUTO_PORT) {
545 ics2115_internal_rmidi =
546 snd_wavefront_new_midi (card,
551 if (ics2115_internal_rmidi == NULL) {
552 snd_printk ("can't setup ICS2115 internal MIDI device\n");
559 /* ------ ICS2115 external MIDI ------------ */
561 if (ics2115_port[dev] > 0 && ics2115_port[dev] != SNDRV_AUTO_PORT) {
562 ics2115_external_rmidi =
563 snd_wavefront_new_midi (card,
568 if (ics2115_external_rmidi == NULL) {
569 snd_printk ("can't setup ICS2115 external MIDI device\n");
576 /* FX processor for Tropez+ */
578 if (acard->wavefront.has_fx) {
579 fx_processor = snd_wavefront_new_fx (card,
583 if (fx_processor == NULL) {
584 snd_printk ("can't setup FX device\n");
591 strcpy(card->driver, "Tropez+");
592 strcpy(card->shortname, "Turtle Beach Tropez+");
594 /* Need a way to distinguish between Maui and Tropez */
595 strcpy(card->driver, "WaveFront");
596 strcpy(card->shortname, "Turtle Beach WaveFront");
599 /* ----- Register the card --------- */
601 /* Not safe to include "Turtle Beach" in longname, due to
605 sprintf(card->longname, "%s PCM 0x%lx irq %d dma %d",
611 if (dma2[dev] >= 0 && dma2[dev] < 8)
612 sprintf(card->longname + strlen(card->longname), "&%d", dma2[dev]);
614 if (cs4232_mpu_port[dev] > 0 && cs4232_mpu_port[dev] != SNDRV_AUTO_PORT) {
615 sprintf (card->longname + strlen (card->longname),
616 " MPU-401 0x%lx irq %d",
617 cs4232_mpu_port[dev],
618 cs4232_mpu_irq[dev]);
621 sprintf (card->longname + strlen (card->longname),
622 " SYNTH 0x%lx irq %d",
626 if ((err = snd_card_register(card)) < 0) {
631 pnp_set_card_drvdata(pcard, card);
633 snd_wavefront_legacy[dev] = card;
639 static int __devinit snd_wavefront_pnp_detect(struct pnp_card_link *card,
640 const struct pnp_card_device_id *id)
645 for ( ; dev < SNDRV_CARDS; dev++) {
646 if (!enable[dev] || !isapnp[dev])
648 res = snd_wavefront_probe(dev, card, id);
658 static void __devexit snd_wavefront_pnp_remove(struct pnp_card_link * pcard)
660 snd_card_t *card = (snd_card_t *) pnp_get_card_drvdata(pcard);
662 snd_card_disconnect(card);
663 snd_card_free_in_thread(card);
666 static struct pnp_card_driver wavefront_pnpc_driver = {
667 .flags = PNP_DRIVER_RES_DISABLE,
669 .id_table = snd_wavefront_pnpids,
670 .probe = snd_wavefront_pnp_detect,
671 .remove = __devexit_p(snd_wavefront_pnp_remove),
674 #endif /* CONFIG_PNP */
676 static int __init alsa_card_wavefront_init(void)
680 for (dev = 0; dev < SNDRV_CARDS; dev++) {
687 if (snd_wavefront_probe(dev, NULL, NULL) >= 0)
691 cards += pnp_register_card_driver(&wavefront_pnpc_driver);
695 pnp_unregister_card_driver(&wavefront_pnpc_driver);
698 printk (KERN_ERR "No WaveFront cards found or devices busy\n");
705 static void __exit alsa_card_wavefront_exit(void)
710 pnp_unregister_card_driver(&wavefront_pnpc_driver);
712 for (idx = 0; idx < SNDRV_CARDS; idx++)
713 snd_card_free(snd_wavefront_legacy[idx]);
716 module_init(alsa_card_wavefront_init)
717 module_exit(alsa_card_wavefront_exit)