1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * Driver for SoundBlaster 16/AWE32/AWE64 soundcards
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
8 #include <linux/init.h>
10 #include <linux/err.h>
11 #include <linux/isa.h>
12 #include <linux/module.h>
13 #include <sound/core.h>
15 #include <sound/sb16_csp.h>
16 #include <sound/mpu401.h>
17 #include <sound/opl3.h>
18 #include <sound/emu8000.h>
19 #include <sound/seq_device.h>
20 #define SNDRV_LEGACY_FIND_FREE_IRQ
21 #define SNDRV_LEGACY_FIND_FREE_DMA
22 #include <sound/initval.h>
30 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
31 MODULE_LICENSE("GPL");
33 MODULE_DESCRIPTION("Sound Blaster 16");
35 MODULE_DESCRIPTION("Sound Blaster AWE");
39 #define SNDRV_DEBUG_IRQ
42 #if defined(SNDRV_SBAWE) && IS_ENABLED(CONFIG_SND_SEQUENCER)
43 #define SNDRV_SBAWE_EMU8000
46 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
47 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
48 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
50 static bool isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
52 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x240,0x260,0x280 */
53 static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x330,0x300 */
54 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
55 #ifdef SNDRV_SBAWE_EMU8000
56 static long awe_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
58 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,10 */
59 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3 */
60 static int dma16[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 5,6,7 */
61 static int mic_agc[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
62 #ifdef CONFIG_SND_SB16_CSP
63 static int csp[SNDRV_CARDS];
65 #ifdef SNDRV_SBAWE_EMU8000
66 static int seq_ports[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 4};
69 module_param_array(index, int, NULL, 0444);
70 MODULE_PARM_DESC(index, "Index value for SoundBlaster 16 soundcard.");
71 module_param_array(id, charp, NULL, 0444);
72 MODULE_PARM_DESC(id, "ID string for SoundBlaster 16 soundcard.");
73 module_param_array(enable, bool, NULL, 0444);
74 MODULE_PARM_DESC(enable, "Enable SoundBlaster 16 soundcard.");
76 module_param_array(isapnp, bool, NULL, 0444);
77 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
79 module_param_hw_array(port, long, ioport, NULL, 0444);
80 MODULE_PARM_DESC(port, "Port # for SB16 driver.");
81 module_param_hw_array(mpu_port, long, ioport, NULL, 0444);
82 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for SB16 driver.");
83 module_param_hw_array(fm_port, long, ioport, NULL, 0444);
84 MODULE_PARM_DESC(fm_port, "FM port # for SB16 PnP driver.");
85 #ifdef SNDRV_SBAWE_EMU8000
86 module_param_hw_array(awe_port, long, ioport, NULL, 0444);
87 MODULE_PARM_DESC(awe_port, "AWE port # for SB16 PnP driver.");
89 module_param_hw_array(irq, int, irq, NULL, 0444);
90 MODULE_PARM_DESC(irq, "IRQ # for SB16 driver.");
91 module_param_hw_array(dma8, int, dma, NULL, 0444);
92 MODULE_PARM_DESC(dma8, "8-bit DMA # for SB16 driver.");
93 module_param_hw_array(dma16, int, dma, NULL, 0444);
94 MODULE_PARM_DESC(dma16, "16-bit DMA # for SB16 driver.");
95 module_param_array(mic_agc, int, NULL, 0444);
96 MODULE_PARM_DESC(mic_agc, "Mic Auto-Gain-Control switch.");
97 #ifdef CONFIG_SND_SB16_CSP
98 module_param_array(csp, int, NULL, 0444);
99 MODULE_PARM_DESC(csp, "ASP/CSP chip support.");
101 #ifdef SNDRV_SBAWE_EMU8000
102 module_param_array(seq_ports, int, NULL, 0444);
103 MODULE_PARM_DESC(seq_ports, "Number of sequencer ports for WaveTable synth.");
107 static int isa_registered;
108 static int pnp_registered;
111 struct snd_card_sb16 {
112 struct resource *fm_res; /* used to block FM i/o region for legacy cards */
117 #ifdef SNDRV_SBAWE_EMU8000
118 struct pnp_dev *devwt;
125 static const struct pnp_card_device_id snd_sb16_pnpids[] = {
127 /* Sound Blaster 16 PnP */
128 { .id = "CTL0024", .devs = { { "CTL0031" } } },
129 /* Sound Blaster 16 PnP */
130 { .id = "CTL0025", .devs = { { "CTL0031" } } },
131 /* Sound Blaster 16 PnP */
132 { .id = "CTL0026", .devs = { { "CTL0031" } } },
133 /* Sound Blaster 16 PnP */
134 { .id = "CTL0027", .devs = { { "CTL0031" } } },
135 /* Sound Blaster 16 PnP */
136 { .id = "CTL0028", .devs = { { "CTL0031" } } },
137 /* Sound Blaster 16 PnP */
138 { .id = "CTL0029", .devs = { { "CTL0031" } } },
139 /* Sound Blaster 16 PnP */
140 { .id = "CTL002a", .devs = { { "CTL0031" } } },
141 /* Sound Blaster 16 PnP */
142 /* Note: This card has also a CTL0051:StereoEnhance device!!! */
143 { .id = "CTL002b", .devs = { { "CTL0031" } } },
144 /* Sound Blaster 16 PnP */
145 { .id = "CTL002c", .devs = { { "CTL0031" } } },
146 /* Sound Blaster Vibra16S */
147 { .id = "CTL0051", .devs = { { "CTL0001" } } },
148 /* Sound Blaster Vibra16C */
149 { .id = "CTL0070", .devs = { { "CTL0001" } } },
150 /* Sound Blaster Vibra16CL - added by ctm@ardi.com */
151 { .id = "CTL0080", .devs = { { "CTL0041" } } },
152 /* Sound Blaster 16 'value' PnP. It says model ct4130 on the pcb, */
153 /* but ct4131 on a sticker on the board.. */
154 { .id = "CTL0086", .devs = { { "CTL0041" } } },
155 /* Sound Blaster Vibra16X */
156 { .id = "CTL00f0", .devs = { { "CTL0043" } } },
157 /* Sound Blaster 16 (Virtual PC 2004) */
158 { .id = "tBA03b0", .devs = { {.id="PNPb003" } } },
159 #else /* SNDRV_SBAWE defined */
160 /* Sound Blaster AWE 32 PnP */
161 { .id = "CTL0035", .devs = { { "CTL0031" }, { "CTL0021" } } },
162 /* Sound Blaster AWE 32 PnP */
163 { .id = "CTL0039", .devs = { { "CTL0031" }, { "CTL0021" } } },
164 /* Sound Blaster AWE 32 PnP */
165 { .id = "CTL0042", .devs = { { "CTL0031" }, { "CTL0021" } } },
166 /* Sound Blaster AWE 32 PnP */
167 { .id = "CTL0043", .devs = { { "CTL0031" }, { "CTL0021" } } },
168 /* Sound Blaster AWE 32 PnP */
169 /* Note: This card has also a CTL0051:StereoEnhance device!!! */
170 { .id = "CTL0044", .devs = { { "CTL0031" }, { "CTL0021" } } },
171 /* Sound Blaster AWE 32 PnP */
172 /* Note: This card has also a CTL0051:StereoEnhance device!!! */
173 { .id = "CTL0045", .devs = { { "CTL0031" }, { "CTL0021" } } },
174 /* Sound Blaster AWE 32 PnP */
175 { .id = "CTL0046", .devs = { { "CTL0031" }, { "CTL0021" } } },
176 /* Sound Blaster AWE 32 PnP */
177 { .id = "CTL0047", .devs = { { "CTL0031" }, { "CTL0021" } } },
178 /* Sound Blaster AWE 32 PnP */
179 { .id = "CTL0048", .devs = { { "CTL0031" }, { "CTL0021" } } },
180 /* Sound Blaster AWE 32 PnP */
181 { .id = "CTL0054", .devs = { { "CTL0031" }, { "CTL0021" } } },
182 /* Sound Blaster AWE 32 PnP */
183 { .id = "CTL009a", .devs = { { "CTL0041" }, { "CTL0021" } } },
184 /* Sound Blaster AWE 32 PnP */
185 { .id = "CTL009c", .devs = { { "CTL0041" }, { "CTL0021" } } },
186 /* Sound Blaster 32 PnP */
187 { .id = "CTL009f", .devs = { { "CTL0041" }, { "CTL0021" } } },
188 /* Sound Blaster AWE 64 PnP */
189 { .id = "CTL009d", .devs = { { "CTL0042" }, { "CTL0022" } } },
190 /* Sound Blaster AWE 64 PnP Gold */
191 { .id = "CTL009e", .devs = { { "CTL0044" }, { "CTL0023" } } },
192 /* Sound Blaster AWE 64 PnP Gold */
193 { .id = "CTL00b2", .devs = { { "CTL0044" }, { "CTL0023" } } },
194 /* Sound Blaster AWE 64 PnP */
195 { .id = "CTL00c1", .devs = { { "CTL0042" }, { "CTL0022" } } },
196 /* Sound Blaster AWE 64 PnP */
197 { .id = "CTL00c3", .devs = { { "CTL0045" }, { "CTL0022" } } },
198 /* Sound Blaster AWE 64 PnP */
199 { .id = "CTL00c5", .devs = { { "CTL0045" }, { "CTL0022" } } },
200 /* Sound Blaster AWE 64 PnP */
201 { .id = "CTL00c7", .devs = { { "CTL0045" }, { "CTL0022" } } },
202 /* Sound Blaster AWE 64 PnP */
203 { .id = "CTL00e4", .devs = { { "CTL0045" }, { "CTL0022" } } },
204 /* Sound Blaster AWE 64 PnP */
205 { .id = "CTL00e9", .devs = { { "CTL0045" }, { "CTL0022" } } },
206 /* Sound Blaster 16 PnP (AWE) */
207 { .id = "CTL00ed", .devs = { { "CTL0041" }, { "CTL0070" } } },
208 /* Generic entries */
209 { .id = "CTLXXXX" , .devs = { { "CTL0031" }, { "CTL0021" } } },
210 { .id = "CTLXXXX" , .devs = { { "CTL0041" }, { "CTL0021" } } },
211 { .id = "CTLXXXX" , .devs = { { "CTL0042" }, { "CTL0022" } } },
212 { .id = "CTLXXXX" , .devs = { { "CTL0044" }, { "CTL0023" } } },
213 { .id = "CTLXXXX" , .devs = { { "CTL0045" }, { "CTL0022" } } },
214 #endif /* SNDRV_SBAWE */
218 MODULE_DEVICE_TABLE(pnp_card, snd_sb16_pnpids);
220 #endif /* CONFIG_PNP */
222 #ifdef SNDRV_SBAWE_EMU8000
223 #define DRIVER_NAME "snd-card-sbawe"
225 #define DRIVER_NAME "snd-card-sb16"
230 static int snd_card_sb16_pnp(int dev, struct snd_card_sb16 *acard,
231 struct pnp_card_link *card,
232 const struct pnp_card_device_id *id)
234 struct pnp_dev *pdev;
237 acard->dev = pnp_request_card_device(card, id->devs[0].id, NULL);
238 if (acard->dev == NULL)
241 #ifdef SNDRV_SBAWE_EMU8000
242 acard->devwt = pnp_request_card_device(card, id->devs[1].id, acard->dev);
244 /* Audio initialization */
247 err = pnp_activate_dev(pdev);
249 snd_printk(KERN_ERR PFX "AUDIO pnp configure failure\n");
252 port[dev] = pnp_port_start(pdev, 0);
253 mpu_port[dev] = pnp_port_start(pdev, 1);
254 fm_port[dev] = pnp_port_start(pdev, 2);
255 dma8[dev] = pnp_dma(pdev, 0);
256 dma16[dev] = pnp_dma(pdev, 1);
257 irq[dev] = pnp_irq(pdev, 0);
258 snd_printdd("pnp SB16: port=0x%lx, mpu port=0x%lx, fm port=0x%lx\n",
259 port[dev], mpu_port[dev], fm_port[dev]);
260 snd_printdd("pnp SB16: dma1=%i, dma2=%i, irq=%i\n",
261 dma8[dev], dma16[dev], irq[dev]);
262 #ifdef SNDRV_SBAWE_EMU8000
263 /* WaveTable initialization */
266 err = pnp_activate_dev(pdev);
270 awe_port[dev] = pnp_port_start(pdev, 0);
271 snd_printdd("pnp SB16: wavetable port=0x%llx\n",
272 (unsigned long long)pnp_port_start(pdev, 0));
276 pnp_release_card_device(pdev);
277 snd_printk(KERN_ERR PFX "WaveTable pnp configure failure\n");
286 #endif /* CONFIG_PNP */
288 static void snd_sb16_free(struct snd_card *card)
290 struct snd_card_sb16 *acard = card->private_data;
294 release_and_free_resource(acard->fm_res);
298 #define is_isapnp_selected(dev) isapnp[dev]
300 #define is_isapnp_selected(dev) 0
303 static int snd_sb16_card_new(struct device *devptr, int dev,
304 struct snd_card **cardp)
306 struct snd_card *card;
309 err = snd_card_new(devptr, index[dev], id[dev], THIS_MODULE,
310 sizeof(struct snd_card_sb16), &card);
313 card->private_free = snd_sb16_free;
318 static int snd_sb16_probe(struct snd_card *card, int dev)
320 int xirq, xdma8, xdma16;
322 struct snd_card_sb16 *acard = card->private_data;
323 struct snd_opl3 *opl3;
324 struct snd_hwdep *synth = NULL;
325 #ifdef CONFIG_SND_SB16_CSP
326 struct snd_hwdep *xcsp = NULL;
335 if ((err = snd_sbdsp_create(card,
338 snd_sb16dsp_interrupt,
346 if (chip->hardware != SB_HW_16) {
347 snd_printk(KERN_ERR PFX "SB 16 chip was not detected at 0x%lx\n", port[dev]);
350 chip->mpu_port = mpu_port[dev];
351 if (! is_isapnp_selected(dev) && (err = snd_sb16dsp_configure(chip)) < 0)
354 if ((err = snd_sb16dsp_pcm(chip, 0)) < 0)
358 #ifdef SNDRV_SBAWE_EMU8000
359 awe_port[dev] > 0 ? "SB AWE" :
362 strcpy(card->shortname, chip->name);
363 sprintf(card->longname, "%s at 0x%lx, irq %i, dma ",
368 sprintf(card->longname + strlen(card->longname), "%d", xdma8);
370 sprintf(card->longname + strlen(card->longname), "%s%d",
371 xdma8 >= 0 ? "&" : "", xdma16);
373 if (chip->mpu_port > 0 && chip->mpu_port != SNDRV_AUTO_PORT) {
374 if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_SB,
376 MPU401_INFO_IRQ_HOOK, -1,
379 chip->rmidi_callback = snd_mpu401_uart_interrupt;
382 #ifdef SNDRV_SBAWE_EMU8000
383 if (awe_port[dev] == SNDRV_AUTO_PORT)
384 awe_port[dev] = 0; /* disable */
387 if (fm_port[dev] > 0 && fm_port[dev] != SNDRV_AUTO_PORT) {
388 if (snd_opl3_create(card, fm_port[dev], fm_port[dev] + 2,
390 acard->fm_res != NULL || fm_port[dev] == port[dev],
392 snd_printk(KERN_ERR PFX "no OPL device at 0x%lx-0x%lx\n",
393 fm_port[dev], fm_port[dev] + 2);
395 #ifdef SNDRV_SBAWE_EMU8000
396 int seqdev = awe_port[dev] > 0 ? 2 : 1;
400 if ((err = snd_opl3_hwdep_new(opl3, 0, seqdev, &synth)) < 0)
405 if ((err = snd_sbmixer_new(chip)) < 0)
408 #ifdef CONFIG_SND_SB16_CSP
409 /* CSP chip on SB16ASP/AWE32 */
410 if ((chip->hardware == SB_HW_16) && csp[dev]) {
411 snd_sb_csp_new(chip, synth != NULL ? 1 : 0, &xcsp);
413 chip->csp = xcsp->private_data;
414 chip->hardware = SB_HW_16CSP;
416 snd_printk(KERN_INFO PFX "warning - CSP chip not detected on soundcard #%i\n", dev + 1);
420 #ifdef SNDRV_SBAWE_EMU8000
421 if (awe_port[dev] > 0) {
422 if ((err = snd_emu8000_new(card, 1, awe_port[dev],
423 seq_ports[dev], NULL)) < 0) {
424 snd_printk(KERN_ERR PFX "fatal error - EMU-8000 synthesizer not detected at 0x%lx\n", awe_port[dev]);
432 spin_lock_irqsave(&chip->mixer_lock, flags);
433 snd_sbmixer_write(chip, SB_DSP4_MIC_AGC,
434 (snd_sbmixer_read(chip, SB_DSP4_MIC_AGC) & 0x01) |
435 (mic_agc[dev] ? 0x00 : 0x01));
436 spin_unlock_irqrestore(&chip->mixer_lock, flags);
438 if ((err = snd_card_register(card)) < 0)
445 static int snd_sb16_suspend(struct snd_card *card, pm_message_t state)
447 struct snd_card_sb16 *acard = card->private_data;
448 struct snd_sb *chip = acard->chip;
450 snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
451 snd_sbmixer_suspend(chip);
455 static int snd_sb16_resume(struct snd_card *card)
457 struct snd_card_sb16 *acard = card->private_data;
458 struct snd_sb *chip = acard->chip;
460 snd_sbdsp_reset(chip);
461 snd_sbmixer_resume(chip);
462 snd_power_change_state(card, SNDRV_CTL_POWER_D0);
467 static int snd_sb16_isa_probe1(int dev, struct device *pdev)
469 struct snd_card_sb16 *acard;
470 struct snd_card *card;
473 err = snd_sb16_card_new(pdev, dev, &card);
477 acard = card->private_data;
478 /* non-PnP FM port address is hardwired with base port address */
479 fm_port[dev] = port[dev];
480 /* block the 0x388 port to avoid PnP conflicts */
481 acard->fm_res = request_region(0x388, 4, "SoundBlaster FM");
482 #ifdef SNDRV_SBAWE_EMU8000
483 /* non-PnP AWE port address is hardwired with base port address */
484 awe_port[dev] = port[dev] + 0x400;
487 if ((err = snd_sb16_probe(card, dev)) < 0) {
491 dev_set_drvdata(pdev, card);
496 static int snd_sb16_isa_match(struct device *pdev, unsigned int dev)
498 return enable[dev] && !is_isapnp_selected(dev);
501 static int snd_sb16_isa_probe(struct device *pdev, unsigned int dev)
504 static const int possible_irqs[] = {5, 9, 10, 7, -1};
505 static const int possible_dmas8[] = {1, 3, 0, -1};
506 static const int possible_dmas16[] = {5, 6, 7, -1};
508 if (irq[dev] == SNDRV_AUTO_IRQ) {
509 if ((irq[dev] = snd_legacy_find_free_irq(possible_irqs)) < 0) {
510 snd_printk(KERN_ERR PFX "unable to find a free IRQ\n");
514 if (dma8[dev] == SNDRV_AUTO_DMA) {
515 if ((dma8[dev] = snd_legacy_find_free_dma(possible_dmas8)) < 0) {
516 snd_printk(KERN_ERR PFX "unable to find a free 8-bit DMA\n");
520 if (dma16[dev] == SNDRV_AUTO_DMA) {
521 if ((dma16[dev] = snd_legacy_find_free_dma(possible_dmas16)) < 0) {
522 snd_printk(KERN_ERR PFX "unable to find a free 16-bit DMA\n");
527 if (port[dev] != SNDRV_AUTO_PORT)
528 return snd_sb16_isa_probe1(dev, pdev);
530 static const int possible_ports[] = {0x220, 0x240, 0x260, 0x280};
532 for (i = 0; i < ARRAY_SIZE(possible_ports); i++) {
533 port[dev] = possible_ports[i];
534 err = snd_sb16_isa_probe1(dev, pdev);
542 static void snd_sb16_isa_remove(struct device *pdev, unsigned int dev)
544 snd_card_free(dev_get_drvdata(pdev));
548 static int snd_sb16_isa_suspend(struct device *dev, unsigned int n,
551 return snd_sb16_suspend(dev_get_drvdata(dev), state);
554 static int snd_sb16_isa_resume(struct device *dev, unsigned int n)
556 return snd_sb16_resume(dev_get_drvdata(dev));
561 #define DEV_NAME "sbawe"
563 #define DEV_NAME "sb16"
566 static struct isa_driver snd_sb16_isa_driver = {
567 .match = snd_sb16_isa_match,
568 .probe = snd_sb16_isa_probe,
569 .remove = snd_sb16_isa_remove,
571 .suspend = snd_sb16_isa_suspend,
572 .resume = snd_sb16_isa_resume,
581 static int snd_sb16_pnp_detect(struct pnp_card_link *pcard,
582 const struct pnp_card_device_id *pid)
585 struct snd_card *card;
588 for ( ; dev < SNDRV_CARDS; dev++) {
589 if (!enable[dev] || !isapnp[dev])
591 res = snd_sb16_card_new(&pcard->card->dev, dev, &card);
594 if ((res = snd_card_sb16_pnp(dev, card->private_data, pcard, pid)) < 0 ||
595 (res = snd_sb16_probe(card, dev)) < 0) {
599 pnp_set_card_drvdata(pcard, card);
607 static void snd_sb16_pnp_remove(struct pnp_card_link *pcard)
609 snd_card_free(pnp_get_card_drvdata(pcard));
610 pnp_set_card_drvdata(pcard, NULL);
614 static int snd_sb16_pnp_suspend(struct pnp_card_link *pcard, pm_message_t state)
616 return snd_sb16_suspend(pnp_get_card_drvdata(pcard), state);
618 static int snd_sb16_pnp_resume(struct pnp_card_link *pcard)
620 return snd_sb16_resume(pnp_get_card_drvdata(pcard));
624 static struct pnp_card_driver sb16_pnpc_driver = {
625 .flags = PNP_DRIVER_RES_DISABLE,
631 .id_table = snd_sb16_pnpids,
632 .probe = snd_sb16_pnp_detect,
633 .remove = snd_sb16_pnp_remove,
635 .suspend = snd_sb16_pnp_suspend,
636 .resume = snd_sb16_pnp_resume,
640 #endif /* CONFIG_PNP */
642 static int __init alsa_card_sb16_init(void)
646 err = isa_register_driver(&snd_sb16_isa_driver, SNDRV_CARDS);
651 err = pnp_register_card_driver(&sb16_pnpc_driver);
661 static void __exit alsa_card_sb16_exit(void)
665 pnp_unregister_card_driver(&sb16_pnpc_driver);
668 isa_unregister_driver(&snd_sb16_isa_driver);
671 module_init(alsa_card_sb16_init)
672 module_exit(alsa_card_sb16_exit)