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");
25 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
26 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
27 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE; /* Enable this card */
29 static bool isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
31 static long cs4232_pcm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
32 static int cs4232_pcm_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,11,12,15 */
33 static long cs4232_mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
34 static int cs4232_mpu_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 9,11,12,15 */
35 static long ics2115_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
36 static int ics2115_irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 2,9,11,12,15 */
37 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* PnP setup */
38 static int dma1[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3,5,6,7 */
39 static int dma2[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3,5,6,7 */
40 static bool use_cs4232_midi[SNDRV_CARDS];
42 module_param_array(index, int, NULL, 0444);
43 MODULE_PARM_DESC(index, "Index value for WaveFront soundcard.");
44 module_param_array(id, charp, NULL, 0444);
45 MODULE_PARM_DESC(id, "ID string for WaveFront soundcard.");
46 module_param_array(enable, bool, NULL, 0444);
47 MODULE_PARM_DESC(enable, "Enable WaveFront soundcard.");
49 module_param_array(isapnp, bool, NULL, 0444);
50 MODULE_PARM_DESC(isapnp, "ISA PnP detection for WaveFront soundcards.");
52 module_param_hw_array(cs4232_pcm_port, long, ioport, NULL, 0444);
53 MODULE_PARM_DESC(cs4232_pcm_port, "Port # for CS4232 PCM interface.");
54 module_param_hw_array(cs4232_pcm_irq, int, irq, NULL, 0444);
55 MODULE_PARM_DESC(cs4232_pcm_irq, "IRQ # for CS4232 PCM interface.");
56 module_param_hw_array(dma1, int, dma, NULL, 0444);
57 MODULE_PARM_DESC(dma1, "DMA1 # for CS4232 PCM interface.");
58 module_param_hw_array(dma2, int, dma, NULL, 0444);
59 MODULE_PARM_DESC(dma2, "DMA2 # for CS4232 PCM interface.");
60 module_param_hw_array(cs4232_mpu_port, long, ioport, NULL, 0444);
61 MODULE_PARM_DESC(cs4232_mpu_port, "port # for CS4232 MPU-401 interface.");
62 module_param_hw_array(cs4232_mpu_irq, int, irq, NULL, 0444);
63 MODULE_PARM_DESC(cs4232_mpu_irq, "IRQ # for CS4232 MPU-401 interface.");
64 module_param_hw_array(ics2115_irq, int, irq, NULL, 0444);
65 MODULE_PARM_DESC(ics2115_irq, "IRQ # for ICS2115.");
66 module_param_hw_array(ics2115_port, long, ioport, NULL, 0444);
67 MODULE_PARM_DESC(ics2115_port, "Port # for ICS2115.");
68 module_param_hw_array(fm_port, long, ioport, NULL, 0444);
69 MODULE_PARM_DESC(fm_port, "FM port #.");
70 module_param_array(use_cs4232_midi, bool, NULL, 0444);
71 MODULE_PARM_DESC(use_cs4232_midi, "Use CS4232 MPU-401 interface (inaccessibly located inside your computer)");
74 static int isa_registered;
75 static int pnp_registered;
77 static const struct pnp_card_device_id snd_wavefront_pnpids[] = {
79 { .id = "CSC7532", .devs = { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
81 { .id = "CSC7632", .devs = { { "CSC0000" }, { "CSC0010" }, { "PnPb006" }, { "CSC0004" } } },
85 MODULE_DEVICE_TABLE(pnp_card, snd_wavefront_pnpids);
88 snd_wavefront_pnp (int dev, snd_wavefront_card_t *acard, struct pnp_card_link *card,
89 const struct pnp_card_device_id *id)
94 /* Check for each logical device. */
96 /* CS4232 chip (aka "windows sound system") is logical device 0 */
98 acard->wss = pnp_request_card_device(card, id->devs[0].id, NULL);
99 if (acard->wss == NULL)
102 /* there is a game port at logical device 1, but we ignore it completely */
104 /* the control interface is logical device 2, but we ignore it
105 completely. in fact, nobody even seems to know what it
109 /* Only configure the CS4232 MIDI interface if its been
110 specifically requested. It is logical device 3.
113 if (use_cs4232_midi[dev]) {
114 acard->mpu = pnp_request_card_device(card, id->devs[2].id, NULL);
115 if (acard->mpu == NULL)
119 /* The ICS2115 synth is logical device 4 */
121 acard->synth = pnp_request_card_device(card, id->devs[3].id, NULL);
122 if (acard->synth == NULL)
125 /* PCM/FM initialization */
129 /* An interesting note from the Tropez+ FAQ:
131 Q. [Ports] Why is the base address of the WSS I/O ports off by 4?
133 A. WSS I/O requires a block of 8 I/O addresses ("ports"). Of these, the first
134 4 are used to identify and configure the board. With the advent of PnP,
135 these first 4 addresses have become obsolete, and software applications
136 only use the last 4 addresses to control the codec chip. Therefore, the
137 base address setting "skips past" the 4 unused addresses.
141 err = pnp_activate_dev(pdev);
143 snd_printk(KERN_ERR "PnP WSS pnp configure failure\n");
147 cs4232_pcm_port[dev] = pnp_port_start(pdev, 0);
148 fm_port[dev] = pnp_port_start(pdev, 1);
149 dma1[dev] = pnp_dma(pdev, 0);
150 dma2[dev] = pnp_dma(pdev, 1);
151 cs4232_pcm_irq[dev] = pnp_irq(pdev, 0);
153 /* Synth initialization */
157 err = pnp_activate_dev(pdev);
159 snd_printk(KERN_ERR "PnP ICS2115 pnp configure failure\n");
163 ics2115_port[dev] = pnp_port_start(pdev, 0);
164 ics2115_irq[dev] = pnp_irq(pdev, 0);
166 /* CS4232 MPU initialization. Configure this only if
167 explicitly requested, since its physically inaccessible and
168 consumes another IRQ.
171 if (use_cs4232_midi[dev]) {
175 err = pnp_activate_dev(pdev);
177 snd_printk(KERN_ERR "PnP MPU401 pnp configure failure\n");
178 cs4232_mpu_port[dev] = SNDRV_AUTO_PORT;
180 cs4232_mpu_port[dev] = pnp_port_start(pdev, 0);
181 cs4232_mpu_irq[dev] = pnp_irq(pdev, 0);
184 snd_printk (KERN_INFO "CS4232 MPU: port=0x%lx, irq=%i\n",
185 cs4232_mpu_port[dev],
186 cs4232_mpu_irq[dev]);
189 snd_printdd ("CS4232: pcm port=0x%lx, fm port=0x%lx, dma1=%i, dma2=%i, irq=%i\nICS2115: port=0x%lx, irq=%i\n",
190 cs4232_pcm_port[dev],
201 #endif /* CONFIG_PNP */
203 static irqreturn_t snd_wavefront_ics2115_interrupt(int irq, void *dev_id)
205 snd_wavefront_card_t *acard;
207 acard = (snd_wavefront_card_t *) dev_id;
212 if (acard->wavefront.interrupts_are_midi) {
213 snd_wavefront_midi_interrupt (acard);
215 snd_wavefront_internal_interrupt (acard);
220 static struct snd_hwdep *snd_wavefront_new_synth(struct snd_card *card,
222 snd_wavefront_card_t *acard)
224 struct snd_hwdep *wavefront_synth;
226 if (snd_wavefront_detect (acard) < 0) {
230 if (snd_wavefront_start (&acard->wavefront) < 0) {
234 if (snd_hwdep_new(card, "WaveFront", hw_dev, &wavefront_synth) < 0)
236 strcpy (wavefront_synth->name,
237 "WaveFront (ICS2115) wavetable synthesizer");
238 wavefront_synth->ops.open = snd_wavefront_synth_open;
239 wavefront_synth->ops.release = snd_wavefront_synth_release;
240 wavefront_synth->ops.ioctl = snd_wavefront_synth_ioctl;
242 return wavefront_synth;
245 static struct snd_hwdep *snd_wavefront_new_fx(struct snd_card *card,
247 snd_wavefront_card_t *acard,
251 struct snd_hwdep *fx_processor;
253 if (snd_wavefront_fx_start (&acard->wavefront)) {
254 snd_printk (KERN_ERR "cannot initialize YSS225 FX processor");
258 if (snd_hwdep_new (card, "YSS225", hw_dev, &fx_processor) < 0)
260 sprintf (fx_processor->name, "YSS225 FX Processor at 0x%lx", port);
261 fx_processor->ops.open = snd_wavefront_fx_open;
262 fx_processor->ops.release = snd_wavefront_fx_release;
263 fx_processor->ops.ioctl = snd_wavefront_fx_ioctl;
268 static snd_wavefront_mpu_id internal_id = internal_mpu;
269 static snd_wavefront_mpu_id external_id = external_mpu;
271 static struct snd_rawmidi *snd_wavefront_new_midi(struct snd_card *card,
273 snd_wavefront_card_t *acard,
275 snd_wavefront_mpu_id mpu)
278 struct snd_rawmidi *rmidi;
279 static int first = 1;
283 acard->wavefront.midi.base = port;
284 if (snd_wavefront_midi_start (acard)) {
285 snd_printk (KERN_ERR "cannot initialize MIDI interface\n");
290 if (snd_rawmidi_new (card, "WaveFront MIDI", midi_dev, 1, 1, &rmidi) < 0)
293 if (mpu == internal_mpu) {
294 strcpy(rmidi->name, "WaveFront MIDI (Internal)");
295 rmidi->private_data = &internal_id;
297 strcpy(rmidi->name, "WaveFront MIDI (External)");
298 rmidi->private_data = &external_id;
301 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &snd_wavefront_midi_output);
302 snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &snd_wavefront_midi_input);
304 rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT |
305 SNDRV_RAWMIDI_INFO_INPUT |
306 SNDRV_RAWMIDI_INFO_DUPLEX;
312 snd_wavefront_free(struct snd_card *card)
314 snd_wavefront_card_t *acard = (snd_wavefront_card_t *)card->private_data;
317 release_and_free_resource(acard->wavefront.res_base);
318 if (acard->wavefront.irq > 0)
319 free_irq(acard->wavefront.irq, (void *)acard);
323 static int snd_wavefront_card_new(struct device *pdev, int dev,
324 struct snd_card **cardp)
326 struct snd_card *card;
327 snd_wavefront_card_t *acard;
330 err = snd_card_new(pdev, index[dev], id[dev], THIS_MODULE,
331 sizeof(snd_wavefront_card_t), &card);
335 acard = card->private_data;
336 acard->wavefront.irq = -1;
337 spin_lock_init(&acard->wavefront.irq_lock);
338 init_waitqueue_head(&acard->wavefront.interrupt_sleeper);
339 spin_lock_init(&acard->wavefront.midi.open);
340 spin_lock_init(&acard->wavefront.midi.virtual);
341 acard->wavefront.card = card;
342 card->private_free = snd_wavefront_free;
349 snd_wavefront_probe (struct snd_card *card, int dev)
351 snd_wavefront_card_t *acard = card->private_data;
352 struct snd_wss *chip;
353 struct snd_hwdep *wavefront_synth;
354 struct snd_rawmidi *ics2115_internal_rmidi = NULL;
355 struct snd_rawmidi *ics2115_external_rmidi = NULL;
356 struct snd_hwdep *fx_processor;
357 int hw_dev = 0, midi_dev = 0, err;
359 /* --------- PCM --------------- */
361 err = snd_wss_create(card, cs4232_pcm_port[dev], -1,
362 cs4232_pcm_irq[dev], dma1[dev], dma2[dev],
363 WSS_HW_DETECT, 0, &chip);
365 snd_printk(KERN_ERR "can't allocate WSS device\n");
369 err = snd_wss_pcm(chip, 0);
373 err = snd_wss_timer(chip, 0);
377 /* ---------- OPL3 synth --------- */
379 if (fm_port[dev] > 0 && fm_port[dev] != SNDRV_AUTO_PORT) {
380 struct snd_opl3 *opl3;
382 err = snd_opl3_create(card, fm_port[dev], fm_port[dev] + 2,
383 OPL3_HW_OPL3_CS, 0, &opl3);
385 snd_printk (KERN_ERR "can't allocate or detect OPL3 synth\n");
389 err = snd_opl3_hwdep_new(opl3, hw_dev, 1, NULL);
395 /* ------- ICS2115 Wavetable synth ------- */
397 acard->wavefront.res_base = request_region(ics2115_port[dev], 16,
399 if (acard->wavefront.res_base == NULL) {
400 snd_printk(KERN_ERR "unable to grab ICS2115 i/o region 0x%lx-0x%lx\n",
401 ics2115_port[dev], ics2115_port[dev] + 16 - 1);
404 if (request_irq(ics2115_irq[dev], snd_wavefront_ics2115_interrupt,
405 0, "ICS2115", acard)) {
406 snd_printk(KERN_ERR "unable to use ICS2115 IRQ %d\n", ics2115_irq[dev]);
410 acard->wavefront.irq = ics2115_irq[dev];
411 card->sync_irq = acard->wavefront.irq;
412 acard->wavefront.base = ics2115_port[dev];
414 wavefront_synth = snd_wavefront_new_synth(card, hw_dev, acard);
415 if (wavefront_synth == NULL) {
416 snd_printk (KERN_ERR "can't create WaveFront synth device\n");
420 strcpy (wavefront_synth->name, "ICS2115 Wavetable MIDI Synthesizer");
421 wavefront_synth->iface = SNDRV_HWDEP_IFACE_ICS2115;
424 /* --------- Mixer ------------ */
426 err = snd_wss_mixer(chip);
428 snd_printk (KERN_ERR "can't allocate mixer device\n");
432 /* -------- CS4232 MPU-401 interface -------- */
434 if (cs4232_mpu_port[dev] > 0 && cs4232_mpu_port[dev] != SNDRV_AUTO_PORT) {
435 err = snd_mpu401_uart_new(card, midi_dev, MPU401_HW_CS4232,
436 cs4232_mpu_port[dev], 0,
437 cs4232_mpu_irq[dev], NULL);
439 snd_printk (KERN_ERR "can't allocate CS4232 MPU-401 device\n");
445 /* ------ ICS2115 internal MIDI ------------ */
447 if (ics2115_port[dev] > 0 && ics2115_port[dev] != SNDRV_AUTO_PORT) {
448 ics2115_internal_rmidi =
449 snd_wavefront_new_midi (card,
454 if (ics2115_internal_rmidi == NULL) {
455 snd_printk (KERN_ERR "can't setup ICS2115 internal MIDI device\n");
461 /* ------ ICS2115 external MIDI ------------ */
463 if (ics2115_port[dev] > 0 && ics2115_port[dev] != SNDRV_AUTO_PORT) {
464 ics2115_external_rmidi =
465 snd_wavefront_new_midi (card,
470 if (ics2115_external_rmidi == NULL) {
471 snd_printk (KERN_ERR "can't setup ICS2115 external MIDI device\n");
477 /* FX processor for Tropez+ */
479 if (acard->wavefront.has_fx) {
480 fx_processor = snd_wavefront_new_fx (card,
484 if (fx_processor == NULL) {
485 snd_printk (KERN_ERR "can't setup FX device\n");
491 strcpy(card->driver, "Tropez+");
492 strcpy(card->shortname, "Turtle Beach Tropez+");
494 /* Need a way to distinguish between Maui and Tropez */
495 strcpy(card->driver, "WaveFront");
496 strcpy(card->shortname, "Turtle Beach WaveFront");
499 /* ----- Register the card --------- */
501 /* Not safe to include "Turtle Beach" in longname, due to
505 sprintf(card->longname, "%s PCM 0x%lx irq %d dma %d",
511 if (dma2[dev] >= 0 && dma2[dev] < 8)
512 sprintf(card->longname + strlen(card->longname), "&%d", dma2[dev]);
514 if (cs4232_mpu_port[dev] > 0 && cs4232_mpu_port[dev] != SNDRV_AUTO_PORT) {
515 sprintf (card->longname + strlen (card->longname),
516 " MPU-401 0x%lx irq %d",
517 cs4232_mpu_port[dev],
518 cs4232_mpu_irq[dev]);
521 sprintf (card->longname + strlen (card->longname),
522 " SYNTH 0x%lx irq %d",
526 return snd_card_register(card);
529 static int snd_wavefront_isa_match(struct device *pdev,
538 if (cs4232_pcm_port[dev] == SNDRV_AUTO_PORT) {
539 snd_printk(KERN_ERR "specify CS4232 port\n");
542 if (ics2115_port[dev] == SNDRV_AUTO_PORT) {
543 snd_printk(KERN_ERR "specify ICS2115 port\n");
549 static int snd_wavefront_isa_probe(struct device *pdev,
552 struct snd_card *card;
555 err = snd_wavefront_card_new(pdev, dev, &card);
558 if ((err = snd_wavefront_probe(card, dev)) < 0) {
563 dev_set_drvdata(pdev, card);
567 static void snd_wavefront_isa_remove(struct device *devptr,
570 snd_card_free(dev_get_drvdata(devptr));
573 #define DEV_NAME "wavefront"
575 static struct isa_driver snd_wavefront_driver = {
576 .match = snd_wavefront_isa_match,
577 .probe = snd_wavefront_isa_probe,
578 .remove = snd_wavefront_isa_remove,
579 /* FIXME: suspend, resume */
587 static int snd_wavefront_pnp_detect(struct pnp_card_link *pcard,
588 const struct pnp_card_device_id *pid)
591 struct snd_card *card;
594 for ( ; dev < SNDRV_CARDS; dev++) {
595 if (enable[dev] && isapnp[dev])
598 if (dev >= SNDRV_CARDS)
601 res = snd_wavefront_card_new(&pcard->card->dev, dev, &card);
605 if (snd_wavefront_pnp (dev, card->private_data, pcard, pid) < 0) {
606 if (cs4232_pcm_port[dev] == SNDRV_AUTO_PORT) {
607 snd_printk (KERN_ERR "isapnp detection failed\n");
608 snd_card_free (card);
613 if ((res = snd_wavefront_probe(card, dev)) < 0)
616 pnp_set_card_drvdata(pcard, card);
621 static void snd_wavefront_pnp_remove(struct pnp_card_link *pcard)
623 snd_card_free(pnp_get_card_drvdata(pcard));
624 pnp_set_card_drvdata(pcard, NULL);
627 static struct pnp_card_driver wavefront_pnpc_driver = {
628 .flags = PNP_DRIVER_RES_DISABLE,
630 .id_table = snd_wavefront_pnpids,
631 .probe = snd_wavefront_pnp_detect,
632 .remove = snd_wavefront_pnp_remove,
633 /* FIXME: suspend,resume */
636 #endif /* CONFIG_PNP */
638 static int __init alsa_card_wavefront_init(void)
642 err = isa_register_driver(&snd_wavefront_driver, SNDRV_CARDS);
647 err = pnp_register_card_driver(&wavefront_pnpc_driver);
657 static void __exit alsa_card_wavefront_exit(void)
661 pnp_unregister_card_driver(&wavefront_pnpc_driver);
664 isa_unregister_driver(&snd_wavefront_driver);
667 module_init(alsa_card_wavefront_init)
668 module_exit(alsa_card_wavefront_exit)