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 <linux/init.h>
23 #include <linux/interrupt.h>
24 #include <linux/err.h>
25 #include <linux/isa.h>
26 #include <linux/pnp.h>
27 #include <linux/module.h>
28 #include <sound/core.h>
29 #include <sound/initval.h>
30 #include <sound/opl3.h>
31 #include <sound/wss.h>
32 #include <sound/snd_wavefront.h>
34 MODULE_AUTHOR("Paul Barton-Davis <pbd@op.net>");
35 MODULE_DESCRIPTION("Turtle Beach Wavefront");
36 MODULE_LICENSE("GPL");
37 MODULE_SUPPORTED_DEVICE("{{Turtle Beach,Maui/Tropez/Tropez+}}");
39 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
40 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
41 static bool enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE
; /* Enable this card */
43 static bool isapnp
[SNDRV_CARDS
] = {[0 ... (SNDRV_CARDS
- 1)] = 1};
45 static long cs4232_pcm_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
46 static int cs4232_pcm_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5,7,9,11,12,15 */
47 static long cs4232_mpu_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
48 static int cs4232_mpu_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 9,11,12,15 */
49 static long ics2115_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
50 static int ics2115_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 2,9,11,12,15 */
51 static long fm_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
52 static int dma1
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0,1,3,5,6,7 */
53 static int dma2
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0,1,3,5,6,7 */
54 static bool use_cs4232_midi
[SNDRV_CARDS
];
56 module_param_array(index
, int, NULL
, 0444);
57 MODULE_PARM_DESC(index
, "Index value for WaveFront soundcard.");
58 module_param_array(id
, charp
, NULL
, 0444);
59 MODULE_PARM_DESC(id
, "ID string for WaveFront soundcard.");
60 module_param_array(enable
, bool, NULL
, 0444);
61 MODULE_PARM_DESC(enable
, "Enable WaveFront soundcard.");
63 module_param_array(isapnp
, bool, NULL
, 0444);
64 MODULE_PARM_DESC(isapnp
, "ISA PnP detection for WaveFront soundcards.");
66 module_param_array(cs4232_pcm_port
, long, NULL
, 0444);
67 MODULE_PARM_DESC(cs4232_pcm_port
, "Port # for CS4232 PCM interface.");
68 module_param_array(cs4232_pcm_irq
, int, NULL
, 0444);
69 MODULE_PARM_DESC(cs4232_pcm_irq
, "IRQ # for CS4232 PCM interface.");
70 module_param_array(dma1
, int, NULL
, 0444);
71 MODULE_PARM_DESC(dma1
, "DMA1 # for CS4232 PCM interface.");
72 module_param_array(dma2
, int, NULL
, 0444);
73 MODULE_PARM_DESC(dma2
, "DMA2 # for CS4232 PCM interface.");
74 module_param_array(cs4232_mpu_port
, long, NULL
, 0444);
75 MODULE_PARM_DESC(cs4232_mpu_port
, "port # for CS4232 MPU-401 interface.");
76 module_param_array(cs4232_mpu_irq
, int, NULL
, 0444);
77 MODULE_PARM_DESC(cs4232_mpu_irq
, "IRQ # for CS4232 MPU-401 interface.");
78 module_param_array(ics2115_irq
, int, NULL
, 0444);
79 MODULE_PARM_DESC(ics2115_irq
, "IRQ # for ICS2115.");
80 module_param_array(ics2115_port
, long, NULL
, 0444);
81 MODULE_PARM_DESC(ics2115_port
, "Port # for ICS2115.");
82 module_param_array(fm_port
, long, NULL
, 0444);
83 MODULE_PARM_DESC(fm_port
, "FM port #.");
84 module_param_array(use_cs4232_midi
, bool, NULL
, 0444);
85 MODULE_PARM_DESC(use_cs4232_midi
, "Use CS4232 MPU-401 interface (inaccessibly located inside your computer)");
88 static int isa_registered
;
89 static int pnp_registered
;
91 static struct pnp_card_device_id snd_wavefront_pnpids
[] = {
93 { .id
= "CSC7532", .devs
= { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
95 { .id
= "CSC7632", .devs
= { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
99 MODULE_DEVICE_TABLE(pnp_card
, snd_wavefront_pnpids
);
102 snd_wavefront_pnp (int dev
, snd_wavefront_card_t
*acard
, struct pnp_card_link
*card
,
103 const struct pnp_card_device_id
*id
)
105 struct pnp_dev
*pdev
;
108 /* Check for each logical device. */
110 /* CS4232 chip (aka "windows sound system") is logical device 0 */
112 acard
->wss
= pnp_request_card_device(card
, id
->devs
[0].id
, NULL
);
113 if (acard
->wss
== NULL
)
116 /* there is a game port at logical device 1, but we ignore it completely */
118 /* the control interface is logical device 2, but we ignore it
119 completely. in fact, nobody even seems to know what it
123 /* Only configure the CS4232 MIDI interface if its been
124 specifically requested. It is logical device 3.
127 if (use_cs4232_midi
[dev
]) {
128 acard
->mpu
= pnp_request_card_device(card
, id
->devs
[2].id
, NULL
);
129 if (acard
->mpu
== NULL
)
133 /* The ICS2115 synth is logical device 4 */
135 acard
->synth
= pnp_request_card_device(card
, id
->devs
[3].id
, NULL
);
136 if (acard
->synth
== NULL
)
139 /* PCM/FM initialization */
143 /* An interesting note from the Tropez+ FAQ:
145 Q. [Ports] Why is the base address of the WSS I/O ports off by 4?
147 A. WSS I/O requires a block of 8 I/O addresses ("ports"). Of these, the first
148 4 are used to identify and configure the board. With the advent of PnP,
149 these first 4 addresses have become obsolete, and software applications
150 only use the last 4 addresses to control the codec chip. Therefore, the
151 base address setting "skips past" the 4 unused addresses.
155 err
= pnp_activate_dev(pdev
);
157 snd_printk(KERN_ERR
"PnP WSS pnp configure failure\n");
161 cs4232_pcm_port
[dev
] = pnp_port_start(pdev
, 0);
162 fm_port
[dev
] = pnp_port_start(pdev
, 1);
163 dma1
[dev
] = pnp_dma(pdev
, 0);
164 dma2
[dev
] = pnp_dma(pdev
, 1);
165 cs4232_pcm_irq
[dev
] = pnp_irq(pdev
, 0);
167 /* Synth initialization */
171 err
= pnp_activate_dev(pdev
);
173 snd_printk(KERN_ERR
"PnP ICS2115 pnp configure failure\n");
177 ics2115_port
[dev
] = pnp_port_start(pdev
, 0);
178 ics2115_irq
[dev
] = pnp_irq(pdev
, 0);
180 /* CS4232 MPU initialization. Configure this only if
181 explicitly requested, since its physically inaccessible and
182 consumes another IRQ.
185 if (use_cs4232_midi
[dev
]) {
189 err
= pnp_activate_dev(pdev
);
191 snd_printk(KERN_ERR
"PnP MPU401 pnp configure failure\n");
192 cs4232_mpu_port
[dev
] = SNDRV_AUTO_PORT
;
194 cs4232_mpu_port
[dev
] = pnp_port_start(pdev
, 0);
195 cs4232_mpu_irq
[dev
] = pnp_irq(pdev
, 0);
198 snd_printk (KERN_INFO
"CS4232 MPU: port=0x%lx, irq=%i\n",
199 cs4232_mpu_port
[dev
],
200 cs4232_mpu_irq
[dev
]);
203 snd_printdd ("CS4232: pcm port=0x%lx, fm port=0x%lx, dma1=%i, dma2=%i, irq=%i\nICS2115: port=0x%lx, irq=%i\n",
204 cs4232_pcm_port
[dev
],
215 #endif /* CONFIG_PNP */
217 static irqreturn_t
snd_wavefront_ics2115_interrupt(int irq
, void *dev_id
)
219 snd_wavefront_card_t
*acard
;
221 acard
= (snd_wavefront_card_t
*) dev_id
;
226 if (acard
->wavefront
.interrupts_are_midi
) {
227 snd_wavefront_midi_interrupt (acard
);
229 snd_wavefront_internal_interrupt (acard
);
234 static struct snd_hwdep
*snd_wavefront_new_synth(struct snd_card
*card
,
236 snd_wavefront_card_t
*acard
)
238 struct snd_hwdep
*wavefront_synth
;
240 if (snd_wavefront_detect (acard
) < 0) {
244 if (snd_wavefront_start (&acard
->wavefront
) < 0) {
248 if (snd_hwdep_new(card
, "WaveFront", hw_dev
, &wavefront_synth
) < 0)
250 strcpy (wavefront_synth
->name
,
251 "WaveFront (ICS2115) wavetable synthesizer");
252 wavefront_synth
->ops
.open
= snd_wavefront_synth_open
;
253 wavefront_synth
->ops
.release
= snd_wavefront_synth_release
;
254 wavefront_synth
->ops
.ioctl
= snd_wavefront_synth_ioctl
;
256 return wavefront_synth
;
259 static struct snd_hwdep
*snd_wavefront_new_fx(struct snd_card
*card
,
261 snd_wavefront_card_t
*acard
,
265 struct snd_hwdep
*fx_processor
;
267 if (snd_wavefront_fx_start (&acard
->wavefront
)) {
268 snd_printk (KERN_ERR
"cannot initialize YSS225 FX processor");
272 if (snd_hwdep_new (card
, "YSS225", hw_dev
, &fx_processor
) < 0)
274 sprintf (fx_processor
->name
, "YSS225 FX Processor at 0x%lx", port
);
275 fx_processor
->ops
.open
= snd_wavefront_fx_open
;
276 fx_processor
->ops
.release
= snd_wavefront_fx_release
;
277 fx_processor
->ops
.ioctl
= snd_wavefront_fx_ioctl
;
282 static snd_wavefront_mpu_id internal_id
= internal_mpu
;
283 static snd_wavefront_mpu_id external_id
= external_mpu
;
285 static struct snd_rawmidi
*snd_wavefront_new_midi(struct snd_card
*card
,
287 snd_wavefront_card_t
*acard
,
289 snd_wavefront_mpu_id mpu
)
292 struct snd_rawmidi
*rmidi
;
293 static int first
= 1;
297 acard
->wavefront
.midi
.base
= port
;
298 if (snd_wavefront_midi_start (acard
)) {
299 snd_printk (KERN_ERR
"cannot initialize MIDI interface\n");
304 if (snd_rawmidi_new (card
, "WaveFront MIDI", midi_dev
, 1, 1, &rmidi
) < 0)
307 if (mpu
== internal_mpu
) {
308 strcpy(rmidi
->name
, "WaveFront MIDI (Internal)");
309 rmidi
->private_data
= &internal_id
;
311 strcpy(rmidi
->name
, "WaveFront MIDI (External)");
312 rmidi
->private_data
= &external_id
;
315 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_wavefront_midi_output
);
316 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_wavefront_midi_input
);
318 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_OUTPUT
|
319 SNDRV_RAWMIDI_INFO_INPUT
|
320 SNDRV_RAWMIDI_INFO_DUPLEX
;
326 snd_wavefront_free(struct snd_card
*card
)
328 snd_wavefront_card_t
*acard
= (snd_wavefront_card_t
*)card
->private_data
;
331 release_and_free_resource(acard
->wavefront
.res_base
);
332 if (acard
->wavefront
.irq
> 0)
333 free_irq(acard
->wavefront
.irq
, (void *)acard
);
337 static int snd_wavefront_card_new(struct device
*pdev
, int dev
,
338 struct snd_card
**cardp
)
340 struct snd_card
*card
;
341 snd_wavefront_card_t
*acard
;
344 err
= snd_card_new(pdev
, index
[dev
], id
[dev
], THIS_MODULE
,
345 sizeof(snd_wavefront_card_t
), &card
);
349 acard
= card
->private_data
;
350 acard
->wavefront
.irq
= -1;
351 spin_lock_init(&acard
->wavefront
.irq_lock
);
352 init_waitqueue_head(&acard
->wavefront
.interrupt_sleeper
);
353 spin_lock_init(&acard
->wavefront
.midi
.open
);
354 spin_lock_init(&acard
->wavefront
.midi
.virtual);
355 acard
->wavefront
.card
= card
;
356 card
->private_free
= snd_wavefront_free
;
363 snd_wavefront_probe (struct snd_card
*card
, int dev
)
365 snd_wavefront_card_t
*acard
= card
->private_data
;
366 struct snd_wss
*chip
;
367 struct snd_hwdep
*wavefront_synth
;
368 struct snd_rawmidi
*ics2115_internal_rmidi
= NULL
;
369 struct snd_rawmidi
*ics2115_external_rmidi
= NULL
;
370 struct snd_hwdep
*fx_processor
;
371 int hw_dev
= 0, midi_dev
= 0, err
;
373 /* --------- PCM --------------- */
375 err
= snd_wss_create(card
, cs4232_pcm_port
[dev
], -1,
376 cs4232_pcm_irq
[dev
], dma1
[dev
], dma2
[dev
],
377 WSS_HW_DETECT
, 0, &chip
);
379 snd_printk(KERN_ERR
"can't allocate WSS device\n");
383 err
= snd_wss_pcm(chip
, 0);
387 err
= snd_wss_timer(chip
, 0);
391 /* ---------- OPL3 synth --------- */
393 if (fm_port
[dev
] > 0 && fm_port
[dev
] != SNDRV_AUTO_PORT
) {
394 struct snd_opl3
*opl3
;
396 err
= snd_opl3_create(card
, fm_port
[dev
], fm_port
[dev
] + 2,
397 OPL3_HW_OPL3_CS
, 0, &opl3
);
399 snd_printk (KERN_ERR
"can't allocate or detect OPL3 synth\n");
403 err
= snd_opl3_hwdep_new(opl3
, hw_dev
, 1, NULL
);
409 /* ------- ICS2115 Wavetable synth ------- */
411 acard
->wavefront
.res_base
= request_region(ics2115_port
[dev
], 16,
413 if (acard
->wavefront
.res_base
== NULL
) {
414 snd_printk(KERN_ERR
"unable to grab ICS2115 i/o region 0x%lx-0x%lx\n",
415 ics2115_port
[dev
], ics2115_port
[dev
] + 16 - 1);
418 if (request_irq(ics2115_irq
[dev
], snd_wavefront_ics2115_interrupt
,
419 0, "ICS2115", acard
)) {
420 snd_printk(KERN_ERR
"unable to use ICS2115 IRQ %d\n", ics2115_irq
[dev
]);
424 acard
->wavefront
.irq
= ics2115_irq
[dev
];
425 acard
->wavefront
.base
= ics2115_port
[dev
];
427 wavefront_synth
= snd_wavefront_new_synth(card
, hw_dev
, acard
);
428 if (wavefront_synth
== NULL
) {
429 snd_printk (KERN_ERR
"can't create WaveFront synth device\n");
433 strcpy (wavefront_synth
->name
, "ICS2115 Wavetable MIDI Synthesizer");
434 wavefront_synth
->iface
= SNDRV_HWDEP_IFACE_ICS2115
;
437 /* --------- Mixer ------------ */
439 err
= snd_wss_mixer(chip
);
441 snd_printk (KERN_ERR
"can't allocate mixer device\n");
445 /* -------- CS4232 MPU-401 interface -------- */
447 if (cs4232_mpu_port
[dev
] > 0 && cs4232_mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
448 err
= snd_mpu401_uart_new(card
, midi_dev
, MPU401_HW_CS4232
,
449 cs4232_mpu_port
[dev
], 0,
450 cs4232_mpu_irq
[dev
], NULL
);
452 snd_printk (KERN_ERR
"can't allocate CS4232 MPU-401 device\n");
458 /* ------ ICS2115 internal MIDI ------------ */
460 if (ics2115_port
[dev
] > 0 && ics2115_port
[dev
] != SNDRV_AUTO_PORT
) {
461 ics2115_internal_rmidi
=
462 snd_wavefront_new_midi (card
,
467 if (ics2115_internal_rmidi
== NULL
) {
468 snd_printk (KERN_ERR
"can't setup ICS2115 internal MIDI device\n");
474 /* ------ ICS2115 external MIDI ------------ */
476 if (ics2115_port
[dev
] > 0 && ics2115_port
[dev
] != SNDRV_AUTO_PORT
) {
477 ics2115_external_rmidi
=
478 snd_wavefront_new_midi (card
,
483 if (ics2115_external_rmidi
== NULL
) {
484 snd_printk (KERN_ERR
"can't setup ICS2115 external MIDI device\n");
490 /* FX processor for Tropez+ */
492 if (acard
->wavefront
.has_fx
) {
493 fx_processor
= snd_wavefront_new_fx (card
,
497 if (fx_processor
== NULL
) {
498 snd_printk (KERN_ERR
"can't setup FX device\n");
504 strcpy(card
->driver
, "Tropez+");
505 strcpy(card
->shortname
, "Turtle Beach Tropez+");
507 /* Need a way to distinguish between Maui and Tropez */
508 strcpy(card
->driver
, "WaveFront");
509 strcpy(card
->shortname
, "Turtle Beach WaveFront");
512 /* ----- Register the card --------- */
514 /* Not safe to include "Turtle Beach" in longname, due to
518 sprintf(card
->longname
, "%s PCM 0x%lx irq %d dma %d",
524 if (dma2
[dev
] >= 0 && dma2
[dev
] < 8)
525 sprintf(card
->longname
+ strlen(card
->longname
), "&%d", dma2
[dev
]);
527 if (cs4232_mpu_port
[dev
] > 0 && cs4232_mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
528 sprintf (card
->longname
+ strlen (card
->longname
),
529 " MPU-401 0x%lx irq %d",
530 cs4232_mpu_port
[dev
],
531 cs4232_mpu_irq
[dev
]);
534 sprintf (card
->longname
+ strlen (card
->longname
),
535 " SYNTH 0x%lx irq %d",
539 return snd_card_register(card
);
542 static int snd_wavefront_isa_match(struct device
*pdev
,
551 if (cs4232_pcm_port
[dev
] == SNDRV_AUTO_PORT
) {
552 snd_printk(KERN_ERR
"specify CS4232 port\n");
555 if (ics2115_port
[dev
] == SNDRV_AUTO_PORT
) {
556 snd_printk(KERN_ERR
"specify ICS2115 port\n");
562 static int snd_wavefront_isa_probe(struct device
*pdev
,
565 struct snd_card
*card
;
568 err
= snd_wavefront_card_new(pdev
, dev
, &card
);
571 if ((err
= snd_wavefront_probe(card
, dev
)) < 0) {
576 dev_set_drvdata(pdev
, card
);
580 static int snd_wavefront_isa_remove(struct device
*devptr
,
583 snd_card_free(dev_get_drvdata(devptr
));
587 #define DEV_NAME "wavefront"
589 static struct isa_driver snd_wavefront_driver
= {
590 .match
= snd_wavefront_isa_match
,
591 .probe
= snd_wavefront_isa_probe
,
592 .remove
= snd_wavefront_isa_remove
,
593 /* FIXME: suspend, resume */
601 static int snd_wavefront_pnp_detect(struct pnp_card_link
*pcard
,
602 const struct pnp_card_device_id
*pid
)
605 struct snd_card
*card
;
608 for ( ; dev
< SNDRV_CARDS
; dev
++) {
609 if (enable
[dev
] && isapnp
[dev
])
612 if (dev
>= SNDRV_CARDS
)
615 res
= snd_wavefront_card_new(&pcard
->card
->dev
, dev
, &card
);
619 if (snd_wavefront_pnp (dev
, card
->private_data
, pcard
, pid
) < 0) {
620 if (cs4232_pcm_port
[dev
] == SNDRV_AUTO_PORT
) {
621 snd_printk (KERN_ERR
"isapnp detection failed\n");
622 snd_card_free (card
);
627 if ((res
= snd_wavefront_probe(card
, dev
)) < 0)
630 pnp_set_card_drvdata(pcard
, card
);
635 static void snd_wavefront_pnp_remove(struct pnp_card_link
*pcard
)
637 snd_card_free(pnp_get_card_drvdata(pcard
));
638 pnp_set_card_drvdata(pcard
, NULL
);
641 static struct pnp_card_driver wavefront_pnpc_driver
= {
642 .flags
= PNP_DRIVER_RES_DISABLE
,
644 .id_table
= snd_wavefront_pnpids
,
645 .probe
= snd_wavefront_pnp_detect
,
646 .remove
= snd_wavefront_pnp_remove
,
647 /* FIXME: suspend,resume */
650 #endif /* CONFIG_PNP */
652 static int __init
alsa_card_wavefront_init(void)
656 err
= isa_register_driver(&snd_wavefront_driver
, SNDRV_CARDS
);
661 err
= pnp_register_card_driver(&wavefront_pnpc_driver
);
671 static void __exit
alsa_card_wavefront_exit(void)
675 pnp_unregister_card_driver(&wavefront_pnpc_driver
);
678 isa_unregister_driver(&snd_wavefront_driver
);
681 module_init(alsa_card_wavefront_init
)
682 module_exit(alsa_card_wavefront_exit
)