1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * ALSA card-level driver for Turtle Beach Wavefront cards
4 * (Maui,Tropez,Tropez+)
6 * Copyright (c) 1997-1999 by Paul Barton-Davis <pbd@op.net>
9 #include <linux/init.h>
10 #include <linux/interrupt.h>
11 #include <linux/err.h>
12 #include <linux/isa.h>
13 #include <linux/pnp.h>
14 #include <linux/module.h>
15 #include <sound/core.h>
16 #include <sound/initval.h>
17 #include <sound/opl3.h>
18 #include <sound/wss.h>
19 #include <sound/snd_wavefront.h>
21 MODULE_AUTHOR("Paul Barton-Davis <pbd@op.net>");
22 MODULE_DESCRIPTION("Turtle Beach Wavefront");
23 MODULE_LICENSE("GPL");
24 MODULE_SUPPORTED_DEVICE("{{Turtle Beach,Maui/Tropez/Tropez+}}");
26 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-MAX */
27 static char *id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* ID for this card */
28 static bool enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE
; /* Enable this card */
30 static bool isapnp
[SNDRV_CARDS
] = {[0 ... (SNDRV_CARDS
- 1)] = 1};
32 static long cs4232_pcm_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
33 static int cs4232_pcm_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 5,7,9,11,12,15 */
34 static long cs4232_mpu_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
35 static int cs4232_mpu_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 9,11,12,15 */
36 static long ics2115_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
37 static int ics2115_irq
[SNDRV_CARDS
] = SNDRV_DEFAULT_IRQ
; /* 2,9,11,12,15 */
38 static long fm_port
[SNDRV_CARDS
] = SNDRV_DEFAULT_PORT
; /* PnP setup */
39 static int dma1
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0,1,3,5,6,7 */
40 static int dma2
[SNDRV_CARDS
] = SNDRV_DEFAULT_DMA
; /* 0,1,3,5,6,7 */
41 static bool use_cs4232_midi
[SNDRV_CARDS
];
43 module_param_array(index
, int, NULL
, 0444);
44 MODULE_PARM_DESC(index
, "Index value for WaveFront soundcard.");
45 module_param_array(id
, charp
, NULL
, 0444);
46 MODULE_PARM_DESC(id
, "ID string for WaveFront soundcard.");
47 module_param_array(enable
, bool, NULL
, 0444);
48 MODULE_PARM_DESC(enable
, "Enable WaveFront soundcard.");
50 module_param_array(isapnp
, bool, NULL
, 0444);
51 MODULE_PARM_DESC(isapnp
, "ISA PnP detection for WaveFront soundcards.");
53 module_param_hw_array(cs4232_pcm_port
, long, ioport
, NULL
, 0444);
54 MODULE_PARM_DESC(cs4232_pcm_port
, "Port # for CS4232 PCM interface.");
55 module_param_hw_array(cs4232_pcm_irq
, int, irq
, NULL
, 0444);
56 MODULE_PARM_DESC(cs4232_pcm_irq
, "IRQ # for CS4232 PCM interface.");
57 module_param_hw_array(dma1
, int, dma
, NULL
, 0444);
58 MODULE_PARM_DESC(dma1
, "DMA1 # for CS4232 PCM interface.");
59 module_param_hw_array(dma2
, int, dma
, NULL
, 0444);
60 MODULE_PARM_DESC(dma2
, "DMA2 # for CS4232 PCM interface.");
61 module_param_hw_array(cs4232_mpu_port
, long, ioport
, NULL
, 0444);
62 MODULE_PARM_DESC(cs4232_mpu_port
, "port # for CS4232 MPU-401 interface.");
63 module_param_hw_array(cs4232_mpu_irq
, int, irq
, NULL
, 0444);
64 MODULE_PARM_DESC(cs4232_mpu_irq
, "IRQ # for CS4232 MPU-401 interface.");
65 module_param_hw_array(ics2115_irq
, int, irq
, NULL
, 0444);
66 MODULE_PARM_DESC(ics2115_irq
, "IRQ # for ICS2115.");
67 module_param_hw_array(ics2115_port
, long, ioport
, NULL
, 0444);
68 MODULE_PARM_DESC(ics2115_port
, "Port # for ICS2115.");
69 module_param_hw_array(fm_port
, long, ioport
, NULL
, 0444);
70 MODULE_PARM_DESC(fm_port
, "FM port #.");
71 module_param_array(use_cs4232_midi
, bool, NULL
, 0444);
72 MODULE_PARM_DESC(use_cs4232_midi
, "Use CS4232 MPU-401 interface (inaccessibly located inside your computer)");
75 static int isa_registered
;
76 static int pnp_registered
;
78 static const struct pnp_card_device_id snd_wavefront_pnpids
[] = {
80 { .id
= "CSC7532", .devs
= { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
82 { .id
= "CSC7632", .devs
= { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
86 MODULE_DEVICE_TABLE(pnp_card
, snd_wavefront_pnpids
);
89 snd_wavefront_pnp (int dev
, snd_wavefront_card_t
*acard
, struct pnp_card_link
*card
,
90 const struct pnp_card_device_id
*id
)
95 /* Check for each logical device. */
97 /* CS4232 chip (aka "windows sound system") is logical device 0 */
99 acard
->wss
= pnp_request_card_device(card
, id
->devs
[0].id
, NULL
);
100 if (acard
->wss
== NULL
)
103 /* there is a game port at logical device 1, but we ignore it completely */
105 /* the control interface is logical device 2, but we ignore it
106 completely. in fact, nobody even seems to know what it
110 /* Only configure the CS4232 MIDI interface if its been
111 specifically requested. It is logical device 3.
114 if (use_cs4232_midi
[dev
]) {
115 acard
->mpu
= pnp_request_card_device(card
, id
->devs
[2].id
, NULL
);
116 if (acard
->mpu
== NULL
)
120 /* The ICS2115 synth is logical device 4 */
122 acard
->synth
= pnp_request_card_device(card
, id
->devs
[3].id
, NULL
);
123 if (acard
->synth
== NULL
)
126 /* PCM/FM initialization */
130 /* An interesting note from the Tropez+ FAQ:
132 Q. [Ports] Why is the base address of the WSS I/O ports off by 4?
134 A. WSS I/O requires a block of 8 I/O addresses ("ports"). Of these, the first
135 4 are used to identify and configure the board. With the advent of PnP,
136 these first 4 addresses have become obsolete, and software applications
137 only use the last 4 addresses to control the codec chip. Therefore, the
138 base address setting "skips past" the 4 unused addresses.
142 err
= pnp_activate_dev(pdev
);
144 snd_printk(KERN_ERR
"PnP WSS pnp configure failure\n");
148 cs4232_pcm_port
[dev
] = pnp_port_start(pdev
, 0);
149 fm_port
[dev
] = pnp_port_start(pdev
, 1);
150 dma1
[dev
] = pnp_dma(pdev
, 0);
151 dma2
[dev
] = pnp_dma(pdev
, 1);
152 cs4232_pcm_irq
[dev
] = pnp_irq(pdev
, 0);
154 /* Synth initialization */
158 err
= pnp_activate_dev(pdev
);
160 snd_printk(KERN_ERR
"PnP ICS2115 pnp configure failure\n");
164 ics2115_port
[dev
] = pnp_port_start(pdev
, 0);
165 ics2115_irq
[dev
] = pnp_irq(pdev
, 0);
167 /* CS4232 MPU initialization. Configure this only if
168 explicitly requested, since its physically inaccessible and
169 consumes another IRQ.
172 if (use_cs4232_midi
[dev
]) {
176 err
= pnp_activate_dev(pdev
);
178 snd_printk(KERN_ERR
"PnP MPU401 pnp configure failure\n");
179 cs4232_mpu_port
[dev
] = SNDRV_AUTO_PORT
;
181 cs4232_mpu_port
[dev
] = pnp_port_start(pdev
, 0);
182 cs4232_mpu_irq
[dev
] = pnp_irq(pdev
, 0);
185 snd_printk (KERN_INFO
"CS4232 MPU: port=0x%lx, irq=%i\n",
186 cs4232_mpu_port
[dev
],
187 cs4232_mpu_irq
[dev
]);
190 snd_printdd ("CS4232: pcm port=0x%lx, fm port=0x%lx, dma1=%i, dma2=%i, irq=%i\nICS2115: port=0x%lx, irq=%i\n",
191 cs4232_pcm_port
[dev
],
202 #endif /* CONFIG_PNP */
204 static irqreturn_t
snd_wavefront_ics2115_interrupt(int irq
, void *dev_id
)
206 snd_wavefront_card_t
*acard
;
208 acard
= (snd_wavefront_card_t
*) dev_id
;
213 if (acard
->wavefront
.interrupts_are_midi
) {
214 snd_wavefront_midi_interrupt (acard
);
216 snd_wavefront_internal_interrupt (acard
);
221 static struct snd_hwdep
*snd_wavefront_new_synth(struct snd_card
*card
,
223 snd_wavefront_card_t
*acard
)
225 struct snd_hwdep
*wavefront_synth
;
227 if (snd_wavefront_detect (acard
) < 0) {
231 if (snd_wavefront_start (&acard
->wavefront
) < 0) {
235 if (snd_hwdep_new(card
, "WaveFront", hw_dev
, &wavefront_synth
) < 0)
237 strcpy (wavefront_synth
->name
,
238 "WaveFront (ICS2115) wavetable synthesizer");
239 wavefront_synth
->ops
.open
= snd_wavefront_synth_open
;
240 wavefront_synth
->ops
.release
= snd_wavefront_synth_release
;
241 wavefront_synth
->ops
.ioctl
= snd_wavefront_synth_ioctl
;
243 return wavefront_synth
;
246 static struct snd_hwdep
*snd_wavefront_new_fx(struct snd_card
*card
,
248 snd_wavefront_card_t
*acard
,
252 struct snd_hwdep
*fx_processor
;
254 if (snd_wavefront_fx_start (&acard
->wavefront
)) {
255 snd_printk (KERN_ERR
"cannot initialize YSS225 FX processor");
259 if (snd_hwdep_new (card
, "YSS225", hw_dev
, &fx_processor
) < 0)
261 sprintf (fx_processor
->name
, "YSS225 FX Processor at 0x%lx", port
);
262 fx_processor
->ops
.open
= snd_wavefront_fx_open
;
263 fx_processor
->ops
.release
= snd_wavefront_fx_release
;
264 fx_processor
->ops
.ioctl
= snd_wavefront_fx_ioctl
;
269 static snd_wavefront_mpu_id internal_id
= internal_mpu
;
270 static snd_wavefront_mpu_id external_id
= external_mpu
;
272 static struct snd_rawmidi
*snd_wavefront_new_midi(struct snd_card
*card
,
274 snd_wavefront_card_t
*acard
,
276 snd_wavefront_mpu_id mpu
)
279 struct snd_rawmidi
*rmidi
;
280 static int first
= 1;
284 acard
->wavefront
.midi
.base
= port
;
285 if (snd_wavefront_midi_start (acard
)) {
286 snd_printk (KERN_ERR
"cannot initialize MIDI interface\n");
291 if (snd_rawmidi_new (card
, "WaveFront MIDI", midi_dev
, 1, 1, &rmidi
) < 0)
294 if (mpu
== internal_mpu
) {
295 strcpy(rmidi
->name
, "WaveFront MIDI (Internal)");
296 rmidi
->private_data
= &internal_id
;
298 strcpy(rmidi
->name
, "WaveFront MIDI (External)");
299 rmidi
->private_data
= &external_id
;
302 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_OUTPUT
, &snd_wavefront_midi_output
);
303 snd_rawmidi_set_ops(rmidi
, SNDRV_RAWMIDI_STREAM_INPUT
, &snd_wavefront_midi_input
);
305 rmidi
->info_flags
|= SNDRV_RAWMIDI_INFO_OUTPUT
|
306 SNDRV_RAWMIDI_INFO_INPUT
|
307 SNDRV_RAWMIDI_INFO_DUPLEX
;
313 snd_wavefront_free(struct snd_card
*card
)
315 snd_wavefront_card_t
*acard
= (snd_wavefront_card_t
*)card
->private_data
;
318 release_and_free_resource(acard
->wavefront
.res_base
);
319 if (acard
->wavefront
.irq
> 0)
320 free_irq(acard
->wavefront
.irq
, (void *)acard
);
324 static int snd_wavefront_card_new(struct device
*pdev
, int dev
,
325 struct snd_card
**cardp
)
327 struct snd_card
*card
;
328 snd_wavefront_card_t
*acard
;
331 err
= snd_card_new(pdev
, index
[dev
], id
[dev
], THIS_MODULE
,
332 sizeof(snd_wavefront_card_t
), &card
);
336 acard
= card
->private_data
;
337 acard
->wavefront
.irq
= -1;
338 spin_lock_init(&acard
->wavefront
.irq_lock
);
339 init_waitqueue_head(&acard
->wavefront
.interrupt_sleeper
);
340 spin_lock_init(&acard
->wavefront
.midi
.open
);
341 spin_lock_init(&acard
->wavefront
.midi
.virtual);
342 acard
->wavefront
.card
= card
;
343 card
->private_free
= snd_wavefront_free
;
350 snd_wavefront_probe (struct snd_card
*card
, int dev
)
352 snd_wavefront_card_t
*acard
= card
->private_data
;
353 struct snd_wss
*chip
;
354 struct snd_hwdep
*wavefront_synth
;
355 struct snd_rawmidi
*ics2115_internal_rmidi
= NULL
;
356 struct snd_rawmidi
*ics2115_external_rmidi
= NULL
;
357 struct snd_hwdep
*fx_processor
;
358 int hw_dev
= 0, midi_dev
= 0, err
;
360 /* --------- PCM --------------- */
362 err
= snd_wss_create(card
, cs4232_pcm_port
[dev
], -1,
363 cs4232_pcm_irq
[dev
], dma1
[dev
], dma2
[dev
],
364 WSS_HW_DETECT
, 0, &chip
);
366 snd_printk(KERN_ERR
"can't allocate WSS device\n");
370 err
= snd_wss_pcm(chip
, 0);
374 err
= snd_wss_timer(chip
, 0);
378 /* ---------- OPL3 synth --------- */
380 if (fm_port
[dev
] > 0 && fm_port
[dev
] != SNDRV_AUTO_PORT
) {
381 struct snd_opl3
*opl3
;
383 err
= snd_opl3_create(card
, fm_port
[dev
], fm_port
[dev
] + 2,
384 OPL3_HW_OPL3_CS
, 0, &opl3
);
386 snd_printk (KERN_ERR
"can't allocate or detect OPL3 synth\n");
390 err
= snd_opl3_hwdep_new(opl3
, hw_dev
, 1, NULL
);
396 /* ------- ICS2115 Wavetable synth ------- */
398 acard
->wavefront
.res_base
= request_region(ics2115_port
[dev
], 16,
400 if (acard
->wavefront
.res_base
== NULL
) {
401 snd_printk(KERN_ERR
"unable to grab ICS2115 i/o region 0x%lx-0x%lx\n",
402 ics2115_port
[dev
], ics2115_port
[dev
] + 16 - 1);
405 if (request_irq(ics2115_irq
[dev
], snd_wavefront_ics2115_interrupt
,
406 0, "ICS2115", acard
)) {
407 snd_printk(KERN_ERR
"unable to use ICS2115 IRQ %d\n", ics2115_irq
[dev
]);
411 acard
->wavefront
.irq
= ics2115_irq
[dev
];
412 card
->sync_irq
= acard
->wavefront
.irq
;
413 acard
->wavefront
.base
= ics2115_port
[dev
];
415 wavefront_synth
= snd_wavefront_new_synth(card
, hw_dev
, acard
);
416 if (wavefront_synth
== NULL
) {
417 snd_printk (KERN_ERR
"can't create WaveFront synth device\n");
421 strcpy (wavefront_synth
->name
, "ICS2115 Wavetable MIDI Synthesizer");
422 wavefront_synth
->iface
= SNDRV_HWDEP_IFACE_ICS2115
;
425 /* --------- Mixer ------------ */
427 err
= snd_wss_mixer(chip
);
429 snd_printk (KERN_ERR
"can't allocate mixer device\n");
433 /* -------- CS4232 MPU-401 interface -------- */
435 if (cs4232_mpu_port
[dev
] > 0 && cs4232_mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
436 err
= snd_mpu401_uart_new(card
, midi_dev
, MPU401_HW_CS4232
,
437 cs4232_mpu_port
[dev
], 0,
438 cs4232_mpu_irq
[dev
], NULL
);
440 snd_printk (KERN_ERR
"can't allocate CS4232 MPU-401 device\n");
446 /* ------ ICS2115 internal MIDI ------------ */
448 if (ics2115_port
[dev
] > 0 && ics2115_port
[dev
] != SNDRV_AUTO_PORT
) {
449 ics2115_internal_rmidi
=
450 snd_wavefront_new_midi (card
,
455 if (ics2115_internal_rmidi
== NULL
) {
456 snd_printk (KERN_ERR
"can't setup ICS2115 internal MIDI device\n");
462 /* ------ ICS2115 external MIDI ------------ */
464 if (ics2115_port
[dev
] > 0 && ics2115_port
[dev
] != SNDRV_AUTO_PORT
) {
465 ics2115_external_rmidi
=
466 snd_wavefront_new_midi (card
,
471 if (ics2115_external_rmidi
== NULL
) {
472 snd_printk (KERN_ERR
"can't setup ICS2115 external MIDI device\n");
478 /* FX processor for Tropez+ */
480 if (acard
->wavefront
.has_fx
) {
481 fx_processor
= snd_wavefront_new_fx (card
,
485 if (fx_processor
== NULL
) {
486 snd_printk (KERN_ERR
"can't setup FX device\n");
492 strcpy(card
->driver
, "Tropez+");
493 strcpy(card
->shortname
, "Turtle Beach Tropez+");
495 /* Need a way to distinguish between Maui and Tropez */
496 strcpy(card
->driver
, "WaveFront");
497 strcpy(card
->shortname
, "Turtle Beach WaveFront");
500 /* ----- Register the card --------- */
502 /* Not safe to include "Turtle Beach" in longname, due to
506 sprintf(card
->longname
, "%s PCM 0x%lx irq %d dma %d",
512 if (dma2
[dev
] >= 0 && dma2
[dev
] < 8)
513 sprintf(card
->longname
+ strlen(card
->longname
), "&%d", dma2
[dev
]);
515 if (cs4232_mpu_port
[dev
] > 0 && cs4232_mpu_port
[dev
] != SNDRV_AUTO_PORT
) {
516 sprintf (card
->longname
+ strlen (card
->longname
),
517 " MPU-401 0x%lx irq %d",
518 cs4232_mpu_port
[dev
],
519 cs4232_mpu_irq
[dev
]);
522 sprintf (card
->longname
+ strlen (card
->longname
),
523 " SYNTH 0x%lx irq %d",
527 return snd_card_register(card
);
530 static int snd_wavefront_isa_match(struct device
*pdev
,
539 if (cs4232_pcm_port
[dev
] == SNDRV_AUTO_PORT
) {
540 snd_printk(KERN_ERR
"specify CS4232 port\n");
543 if (ics2115_port
[dev
] == SNDRV_AUTO_PORT
) {
544 snd_printk(KERN_ERR
"specify ICS2115 port\n");
550 static int snd_wavefront_isa_probe(struct device
*pdev
,
553 struct snd_card
*card
;
556 err
= snd_wavefront_card_new(pdev
, dev
, &card
);
559 if ((err
= snd_wavefront_probe(card
, dev
)) < 0) {
564 dev_set_drvdata(pdev
, card
);
568 static int snd_wavefront_isa_remove(struct device
*devptr
,
571 snd_card_free(dev_get_drvdata(devptr
));
575 #define DEV_NAME "wavefront"
577 static struct isa_driver snd_wavefront_driver
= {
578 .match
= snd_wavefront_isa_match
,
579 .probe
= snd_wavefront_isa_probe
,
580 .remove
= snd_wavefront_isa_remove
,
581 /* FIXME: suspend, resume */
589 static int snd_wavefront_pnp_detect(struct pnp_card_link
*pcard
,
590 const struct pnp_card_device_id
*pid
)
593 struct snd_card
*card
;
596 for ( ; dev
< SNDRV_CARDS
; dev
++) {
597 if (enable
[dev
] && isapnp
[dev
])
600 if (dev
>= SNDRV_CARDS
)
603 res
= snd_wavefront_card_new(&pcard
->card
->dev
, dev
, &card
);
607 if (snd_wavefront_pnp (dev
, card
->private_data
, pcard
, pid
) < 0) {
608 if (cs4232_pcm_port
[dev
] == SNDRV_AUTO_PORT
) {
609 snd_printk (KERN_ERR
"isapnp detection failed\n");
610 snd_card_free (card
);
615 if ((res
= snd_wavefront_probe(card
, dev
)) < 0)
618 pnp_set_card_drvdata(pcard
, card
);
623 static void snd_wavefront_pnp_remove(struct pnp_card_link
*pcard
)
625 snd_card_free(pnp_get_card_drvdata(pcard
));
626 pnp_set_card_drvdata(pcard
, NULL
);
629 static struct pnp_card_driver wavefront_pnpc_driver
= {
630 .flags
= PNP_DRIVER_RES_DISABLE
,
632 .id_table
= snd_wavefront_pnpids
,
633 .probe
= snd_wavefront_pnp_detect
,
634 .remove
= snd_wavefront_pnp_remove
,
635 /* FIXME: suspend,resume */
638 #endif /* CONFIG_PNP */
640 static int __init
alsa_card_wavefront_init(void)
644 err
= isa_register_driver(&snd_wavefront_driver
, SNDRV_CARDS
);
649 err
= pnp_register_card_driver(&wavefront_pnpc_driver
);
659 static void __exit
alsa_card_wavefront_exit(void)
663 pnp_unregister_card_driver(&wavefront_pnpc_driver
);
666 isa_unregister_driver(&snd_wavefront_driver
);
669 module_init(alsa_card_wavefront_init
)
670 module_exit(alsa_card_wavefront_exit
)