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/slab.h>
25 #include <linux/err.h>
26 #include <linux/isa.h>
27 #include <linux/pnp.h>
28 #include <linux/moduleparam.h>
29 #include <sound/core.h>
30 #include <sound/initval.h>
31 #include <sound/opl3.h>
32 #include <sound/wss.h>
33 #include <sound/snd_wavefront.h>
35 MODULE_AUTHOR("Paul Barton-Davis <pbd@op.net>");
36 MODULE_DESCRIPTION("Turtle Beach Wavefront");
37 MODULE_LICENSE("GPL");
38 MODULE_SUPPORTED_DEVICE("{{Turtle Beach,Maui/Tropez/Tropez+}}");
40 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
41 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
42 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE
; /* Enable this card */
44 static int isapnp
[SNDRV_CARDS
] = {[0 ... (SNDRV_CARDS
- 1)] = 1};
46 static long cs4232_pcm_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
47 static int cs4232_pcm_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5,7,9,11,12,15 */
48 static long cs4232_mpu_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
49 static int cs4232_mpu_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 9,11,12,15 */
50 static long ics2115_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
51 static int ics2115_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 2,9,11,12,15 */
52 static long fm_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
53 static int dma1
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0,1,3,5,6,7 */
54 static int dma2
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0,1,3,5,6,7 */
55 static int use_cs4232_midi
[SNDRV_CARDS
];
57 module_param_array(index
, int, NULL
, 0444);
58 MODULE_PARM_DESC(index
, "Index value for WaveFront soundcard.");
59 module_param_array(id
, charp
, NULL
, 0444);
60 MODULE_PARM_DESC(id
, "ID string for WaveFront soundcard.");
61 module_param_array(enable
, bool, NULL
, 0444);
62 MODULE_PARM_DESC(enable
, "Enable WaveFront soundcard.");
64 module_param_array(isapnp
, bool, NULL
, 0444);
65 MODULE_PARM_DESC(isapnp
, "ISA PnP detection for WaveFront soundcards.");
67 module_param_array(cs4232_pcm_port
, long, NULL
, 0444);
68 MODULE_PARM_DESC(cs4232_pcm_port
, "Port # for CS4232 PCM interface.");
69 module_param_array(cs4232_pcm_irq
, int, NULL
, 0444);
70 MODULE_PARM_DESC(cs4232_pcm_irq
, "IRQ # for CS4232 PCM interface.");
71 module_param_array(dma1
, int, NULL
, 0444);
72 MODULE_PARM_DESC(dma1
, "DMA1 # for CS4232 PCM interface.");
73 module_param_array(dma2
, int, NULL
, 0444);
74 MODULE_PARM_DESC(dma2
, "DMA2 # for CS4232 PCM interface.");
75 module_param_array(cs4232_mpu_port
, long, NULL
, 0444);
76 MODULE_PARM_DESC(cs4232_mpu_port
, "port # for CS4232 MPU-401 interface.");
77 module_param_array(cs4232_mpu_irq
, int, NULL
, 0444);
78 MODULE_PARM_DESC(cs4232_mpu_irq
, "IRQ # for CS4232 MPU-401 interface.");
79 module_param_array(ics2115_irq
, int, NULL
, 0444);
80 MODULE_PARM_DESC(ics2115_irq
, "IRQ # for ICS2115.");
81 module_param_array(ics2115_port
, long, NULL
, 0444);
82 MODULE_PARM_DESC(ics2115_port
, "Port # for ICS2115.");
83 module_param_array(fm_port
, long, NULL
, 0444);
84 MODULE_PARM_DESC(fm_port
, "FM port #.");
85 module_param_array(use_cs4232_midi
, bool, NULL
, 0444);
86 MODULE_PARM_DESC(use_cs4232_midi
, "Use CS4232 MPU-401 interface (inaccessibly located inside your computer)");
89 static int isa_registered
;
90 static int pnp_registered
;
92 static struct pnp_card_device_id snd_wavefront_pnpids
[] = {
94 { .id
= "CSC7532", .devs
= { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
96 { .id
= "CSC7632", .devs
= { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
100 MODULE_DEVICE_TABLE(pnp_card
, snd_wavefront_pnpids
);
103 snd_wavefront_pnp (int dev
, snd_wavefront_card_t
*acard
, struct pnp_card_link
*card
,
104 const struct pnp_card_device_id
*id
)
106 struct pnp_dev
*pdev
;
109 /* Check for each logical device. */
111 /* CS4232 chip (aka "windows sound system") is logical device 0 */
113 acard
->wss
= pnp_request_card_device(card
, id
->devs
[0].id
, NULL
);
114 if (acard
->wss
== NULL
)
117 /* there is a game port at logical device 1, but we ignore it completely */
119 /* the control interface is logical device 2, but we ignore it
120 completely. in fact, nobody even seems to know what it
124 /* Only configure the CS4232 MIDI interface if its been
125 specifically requested. It is logical device 3.
128 if (use_cs4232_midi
[dev
]) {
129 acard
->mpu
= pnp_request_card_device(card
, id
->devs
[2].id
, NULL
);
130 if (acard
->mpu
== NULL
)
134 /* The ICS2115 synth is logical device 4 */
136 acard
->synth
= pnp_request_card_device(card
, id
->devs
[3].id
, NULL
);
137 if (acard
->synth
== NULL
)
140 /* PCM/FM initialization */
144 /* An interesting note from the Tropez+ FAQ:
146 Q. [Ports] Why is the base address of the WSS I/O ports off by 4?
148 A. WSS I/O requires a block of 8 I/O addresses ("ports"). Of these, the first
149 4 are used to identify and configure the board. With the advent of PnP,
150 these first 4 addresses have become obsolete, and software applications
151 only use the last 4 addresses to control the codec chip. Therefore, the
152 base address setting "skips past" the 4 unused addresses.
156 err
= pnp_activate_dev(pdev
);
158 snd_printk(KERN_ERR
"PnP WSS pnp configure failure\n");
162 cs4232_pcm_port
[dev
] = pnp_port_start(pdev
, 0);
163 fm_port
[dev
] = pnp_port_start(pdev
, 1);
164 dma1
[dev
] = pnp_dma(pdev
, 0);
165 dma2
[dev
] = pnp_dma(pdev
, 1);
166 cs4232_pcm_irq
[dev
] = pnp_irq(pdev
, 0);
168 /* Synth initialization */
172 err
= pnp_activate_dev(pdev
);
174 snd_printk(KERN_ERR
"PnP ICS2115 pnp configure failure\n");
178 ics2115_port
[dev
] = pnp_port_start(pdev
, 0);
179 ics2115_irq
[dev
] = pnp_irq(pdev
, 0);
181 /* CS4232 MPU initialization. Configure this only if
182 explicitly requested, since its physically inaccessible and
183 consumes another IRQ.
186 if (use_cs4232_midi
[dev
]) {
190 err
= pnp_activate_dev(pdev
);
192 snd_printk(KERN_ERR
"PnP MPU401 pnp configure failure\n");
193 cs4232_mpu_port
[dev
] = SNDRV_AUTO_PORT
;
195 cs4232_mpu_port
[dev
] = pnp_port_start(pdev
, 0);
196 cs4232_mpu_irq
[dev
] = pnp_irq(pdev
, 0);
199 snd_printk (KERN_INFO
"CS4232 MPU: port=0x%lx, irq=%i\n",
200 cs4232_mpu_port
[dev
],
201 cs4232_mpu_irq
[dev
]);
204 snd_printdd ("CS4232: pcm port=0x%lx, fm port=0x%lx, dma1=%i, dma2=%i, irq=%i\nICS2115: port=0x%lx, irq=%i\n",
205 cs4232_pcm_port
[dev
],
216 #endif /* CONFIG_PNP */
218 static irqreturn_t
snd_wavefront_ics2115_interrupt(int irq
, void *dev_id
)
220 snd_wavefront_card_t
*acard
;
222 acard
= (snd_wavefront_card_t
*) dev_id
;
227 if (acard
->wavefront
.interrupts_are_midi
) {
228 snd_wavefront_midi_interrupt (acard
);
230 snd_wavefront_internal_interrupt (acard
);
235 static struct snd_hwdep
* __devinit
236 snd_wavefront_new_synth (struct snd_card
*card
,
238 snd_wavefront_card_t
*acard
)
240 struct snd_hwdep
*wavefront_synth
;
242 if (snd_wavefront_detect (acard
) < 0) {
246 if (snd_wavefront_start (&acard
->wavefront
) < 0) {
250 if (snd_hwdep_new(card
, "WaveFront", hw_dev
, &wavefront_synth
) < 0)
252 strcpy (wavefront_synth
->name
,
253 "WaveFront (ICS2115) wavetable synthesizer");
254 wavefront_synth
->ops
.open
= snd_wavefront_synth_open
;
255 wavefront_synth
->ops
.release
= snd_wavefront_synth_release
;
256 wavefront_synth
->ops
.ioctl
= snd_wavefront_synth_ioctl
;
258 return wavefront_synth
;
261 static struct snd_hwdep
* __devinit
262 snd_wavefront_new_fx (struct snd_card
*card
,
264 snd_wavefront_card_t
*acard
,
268 struct snd_hwdep
*fx_processor
;
270 if (snd_wavefront_fx_start (&acard
->wavefront
)) {
271 snd_printk (KERN_ERR
"cannot initialize YSS225 FX processor");
275 if (snd_hwdep_new (card
, "YSS225", hw_dev
, &fx_processor
) < 0)
277 sprintf (fx_processor
->name
, "YSS225 FX Processor at 0x%lx", port
);
278 fx_processor
->ops
.open
= snd_wavefront_fx_open
;
279 fx_processor
->ops
.release
= snd_wavefront_fx_release
;
280 fx_processor
->ops
.ioctl
= snd_wavefront_fx_ioctl
;
285 static snd_wavefront_mpu_id internal_id
= internal_mpu
;
286 static snd_wavefront_mpu_id external_id
= external_mpu
;
288 static struct snd_rawmidi
*__devinit
289 snd_wavefront_new_midi (struct snd_card
*card
,
291 snd_wavefront_card_t
*acard
,
293 snd_wavefront_mpu_id mpu
)
296 struct snd_rawmidi
*rmidi
;
297 static int first
= 1;
301 acard
->wavefront
.midi
.base
= port
;
302 if (snd_wavefront_midi_start (acard
)) {
303 snd_printk (KERN_ERR
"cannot initialize MIDI interface\n");
308 if (snd_rawmidi_new (card
, "WaveFront MIDI", midi_dev
, 1, 1, &rmidi
) < 0)
311 if (mpu
== internal_mpu
) {
312 strcpy(rmidi
->name
, "WaveFront MIDI (Internal)");
313 rmidi
->private_data
= &internal_id
;
315 strcpy(rmidi
->name
, "WaveFront MIDI (External)");
316 rmidi
->private_data
= &external_id
;
319 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_wavefront_midi_output
);
320 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_wavefront_midi_input
);
322 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_OUTPUT
|
323 SNDRV_RAWMIDI_INFO_INPUT
|
324 SNDRV_RAWMIDI_INFO_DUPLEX
;
330 snd_wavefront_free(struct snd_card
*card
)
332 snd_wavefront_card_t
*acard
= (snd_wavefront_card_t
*)card
->private_data
;
335 release_and_free_resource(acard
->wavefront
.res_base
);
336 if (acard
->wavefront
.irq
> 0)
337 free_irq(acard
->wavefront
.irq
, (void *)acard
);
341 static int snd_wavefront_card_new(int dev
, struct snd_card
**cardp
)
343 struct snd_card
*card
;
344 snd_wavefront_card_t
*acard
;
347 err
= snd_card_create(index
[dev
], id
[dev
], THIS_MODULE
,
348 sizeof(snd_wavefront_card_t
), &card
);
352 acard
= card
->private_data
;
353 acard
->wavefront
.irq
= -1;
354 spin_lock_init(&acard
->wavefront
.irq_lock
);
355 init_waitqueue_head(&acard
->wavefront
.interrupt_sleeper
);
356 spin_lock_init(&acard
->wavefront
.midi
.open
);
357 spin_lock_init(&acard
->wavefront
.midi
.virtual);
358 acard
->wavefront
.card
= card
;
359 card
->private_free
= snd_wavefront_free
;
366 snd_wavefront_probe (struct snd_card
*card
, int dev
)
368 snd_wavefront_card_t
*acard
= card
->private_data
;
369 struct snd_wss
*chip
;
370 struct snd_hwdep
*wavefront_synth
;
371 struct snd_rawmidi
*ics2115_internal_rmidi
= NULL
;
372 struct snd_rawmidi
*ics2115_external_rmidi
= NULL
;
373 struct snd_hwdep
*fx_processor
;
374 int hw_dev
= 0, midi_dev
= 0, err
;
376 /* --------- PCM --------------- */
378 err
= snd_wss_create(card
, cs4232_pcm_port
[dev
], -1,
379 cs4232_pcm_irq
[dev
], dma1
[dev
], dma2
[dev
],
380 WSS_HW_DETECT
, 0, &chip
);
382 snd_printk(KERN_ERR
"can't allocate WSS device\n");
386 err
= snd_wss_pcm(chip
, 0, NULL
);
390 err
= snd_wss_timer(chip
, 0, NULL
);
394 /* ---------- OPL3 synth --------- */
396 if (fm_port
[dev
] > 0 && fm_port
[dev
] != SNDRV_AUTO_PORT
) {
397 struct snd_opl3
*opl3
;
399 err
= snd_opl3_create(card
, fm_port
[dev
], fm_port
[dev
] + 2,
400 OPL3_HW_OPL3_CS
, 0, &opl3
);
402 snd_printk (KERN_ERR
"can't allocate or detect OPL3 synth\n");
406 err
= snd_opl3_hwdep_new(opl3
, hw_dev
, 1, NULL
);
412 /* ------- ICS2115 Wavetable synth ------- */
414 acard
->wavefront
.res_base
= request_region(ics2115_port
[dev
], 16,
416 if (acard
->wavefront
.res_base
== NULL
) {
417 snd_printk(KERN_ERR
"unable to grab ICS2115 i/o region 0x%lx-0x%lx\n",
418 ics2115_port
[dev
], ics2115_port
[dev
] + 16 - 1);
421 if (request_irq(ics2115_irq
[dev
], snd_wavefront_ics2115_interrupt
,
422 IRQF_DISABLED
, "ICS2115", acard
)) {
423 snd_printk(KERN_ERR
"unable to use ICS2115 IRQ %d\n", ics2115_irq
[dev
]);
427 acard
->wavefront
.irq
= ics2115_irq
[dev
];
428 acard
->wavefront
.base
= ics2115_port
[dev
];
430 wavefront_synth
= snd_wavefront_new_synth(card
, hw_dev
, acard
);
431 if (wavefront_synth
== NULL
) {
432 snd_printk (KERN_ERR
"can't create WaveFront synth device\n");
436 strcpy (wavefront_synth
->name
, "ICS2115 Wavetable MIDI Synthesizer");
437 wavefront_synth
->iface
= SNDRV_HWDEP_IFACE_ICS2115
;
440 /* --------- Mixer ------------ */
442 err
= snd_wss_mixer(chip
);
444 snd_printk (KERN_ERR
"can't allocate mixer device\n");
448 /* -------- CS4232 MPU-401 interface -------- */
450 if (cs4232_mpu_port
[dev
] > 0 && cs4232_mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
451 err
= snd_mpu401_uart_new(card
, midi_dev
, MPU401_HW_CS4232
,
452 cs4232_mpu_port
[dev
], 0,
453 cs4232_mpu_irq
[dev
], IRQF_DISABLED
,
456 snd_printk (KERN_ERR
"can't allocate CS4232 MPU-401 device\n");
462 /* ------ ICS2115 internal MIDI ------------ */
464 if (ics2115_port
[dev
] > 0 && ics2115_port
[dev
] != SNDRV_AUTO_PORT
) {
465 ics2115_internal_rmidi
=
466 snd_wavefront_new_midi (card
,
471 if (ics2115_internal_rmidi
== NULL
) {
472 snd_printk (KERN_ERR
"can't setup ICS2115 internal MIDI device\n");
478 /* ------ ICS2115 external MIDI ------------ */
480 if (ics2115_port
[dev
] > 0 && ics2115_port
[dev
] != SNDRV_AUTO_PORT
) {
481 ics2115_external_rmidi
=
482 snd_wavefront_new_midi (card
,
487 if (ics2115_external_rmidi
== NULL
) {
488 snd_printk (KERN_ERR
"can't setup ICS2115 external MIDI device\n");
494 /* FX processor for Tropez+ */
496 if (acard
->wavefront
.has_fx
) {
497 fx_processor
= snd_wavefront_new_fx (card
,
501 if (fx_processor
== NULL
) {
502 snd_printk (KERN_ERR
"can't setup FX device\n");
508 strcpy(card
->driver
, "Tropez+");
509 strcpy(card
->shortname
, "Turtle Beach Tropez+");
511 /* Need a way to distinguish between Maui and Tropez */
512 strcpy(card
->driver
, "WaveFront");
513 strcpy(card
->shortname
, "Turtle Beach WaveFront");
516 /* ----- Register the card --------- */
518 /* Not safe to include "Turtle Beach" in longname, due to
522 sprintf(card
->longname
, "%s PCM 0x%lx irq %d dma %d",
528 if (dma2
[dev
] >= 0 && dma2
[dev
] < 8)
529 sprintf(card
->longname
+ strlen(card
->longname
), "&%d", dma2
[dev
]);
531 if (cs4232_mpu_port
[dev
] > 0 && cs4232_mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
532 sprintf (card
->longname
+ strlen (card
->longname
),
533 " MPU-401 0x%lx irq %d",
534 cs4232_mpu_port
[dev
],
535 cs4232_mpu_irq
[dev
]);
538 sprintf (card
->longname
+ strlen (card
->longname
),
539 " SYNTH 0x%lx irq %d",
543 return snd_card_register(card
);
546 static int __devinit
snd_wavefront_isa_match(struct device
*pdev
,
555 if (cs4232_pcm_port
[dev
] == SNDRV_AUTO_PORT
) {
556 snd_printk(KERN_ERR
"specify CS4232 port\n");
559 if (ics2115_port
[dev
] == SNDRV_AUTO_PORT
) {
560 snd_printk(KERN_ERR
"specify ICS2115 port\n");
566 static int __devinit
snd_wavefront_isa_probe(struct device
*pdev
,
569 struct snd_card
*card
;
572 err
= snd_wavefront_card_new(dev
, &card
);
575 snd_card_set_dev(card
, pdev
);
576 if ((err
= snd_wavefront_probe(card
, dev
)) < 0) {
581 dev_set_drvdata(pdev
, card
);
585 static int __devexit
snd_wavefront_isa_remove(struct device
*devptr
,
588 snd_card_free(dev_get_drvdata(devptr
));
589 dev_set_drvdata(devptr
, NULL
);
593 #define DEV_NAME "wavefront"
595 static struct isa_driver snd_wavefront_driver
= {
596 .match
= snd_wavefront_isa_match
,
597 .probe
= snd_wavefront_isa_probe
,
598 .remove
= __devexit_p(snd_wavefront_isa_remove
),
599 /* FIXME: suspend, resume */
607 static int __devinit
snd_wavefront_pnp_detect(struct pnp_card_link
*pcard
,
608 const struct pnp_card_device_id
*pid
)
611 struct snd_card
*card
;
614 for ( ; dev
< SNDRV_CARDS
; dev
++) {
615 if (enable
[dev
] && isapnp
[dev
])
618 if (dev
>= SNDRV_CARDS
)
621 res
= snd_wavefront_card_new(dev
, &card
);
625 if (snd_wavefront_pnp (dev
, card
->private_data
, pcard
, pid
) < 0) {
626 if (cs4232_pcm_port
[dev
] == SNDRV_AUTO_PORT
) {
627 snd_printk (KERN_ERR
"isapnp detection failed\n");
628 snd_card_free (card
);
632 snd_card_set_dev(card
, &pcard
->card
->dev
);
634 if ((res
= snd_wavefront_probe(card
, dev
)) < 0)
637 pnp_set_card_drvdata(pcard
, card
);
642 static void __devexit
snd_wavefront_pnp_remove(struct pnp_card_link
* pcard
)
644 snd_card_free(pnp_get_card_drvdata(pcard
));
645 pnp_set_card_drvdata(pcard
, NULL
);
648 static struct pnp_card_driver wavefront_pnpc_driver
= {
649 .flags
= PNP_DRIVER_RES_DISABLE
,
651 .id_table
= snd_wavefront_pnpids
,
652 .probe
= snd_wavefront_pnp_detect
,
653 .remove
= __devexit_p(snd_wavefront_pnp_remove
),
654 /* FIXME: suspend,resume */
657 #endif /* CONFIG_PNP */
659 static int __init
alsa_card_wavefront_init(void)
663 err
= isa_register_driver(&snd_wavefront_driver
, SNDRV_CARDS
);
668 err
= pnp_register_card_driver(&wavefront_pnpc_driver
);
678 static void __exit
alsa_card_wavefront_exit(void)
682 pnp_unregister_card_driver(&wavefront_pnpc_driver
);
685 isa_unregister_driver(&snd_wavefront_driver
);
688 module_init(alsa_card_wavefront_init
)
689 module_exit(alsa_card_wavefront_exit
)