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 <linux/string.h>
14 #include <sound/core.h>
16 #include <sound/sb16_csp.h>
17 #include <sound/mpu401.h>
18 #include <sound/opl3.h>
19 #include <sound/emu8000.h>
20 #include <sound/seq_device.h>
21 #define SNDRV_LEGACY_FIND_FREE_IRQ
22 #define SNDRV_LEGACY_FIND_FREE_DMA
23 #include <sound/initval.h>
25 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
26 MODULE_LICENSE("GPL");
28 MODULE_DESCRIPTION("Sound Blaster 16");
30 MODULE_DESCRIPTION("Sound Blaster AWE");
34 #define SNDRV_DEBUG_IRQ
37 #if defined(SNDRV_SBAWE) && IS_ENABLED(CONFIG_SND_SEQUENCER)
38 #define SNDRV_SBAWE_EMU8000
41 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */
42 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */
43 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_ISAPNP; /* Enable this card */
45 static bool isapnp[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
47 static long port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x220,0x240,0x260,0x280 */
48 static long mpu_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT; /* 0x330,0x300 */
49 static long fm_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
50 #ifdef SNDRV_SBAWE_EMU8000
51 static long awe_port[SNDRV_CARDS] = SNDRV_DEFAULT_PORT;
53 static int irq[SNDRV_CARDS] = SNDRV_DEFAULT_IRQ; /* 5,7,9,10 */
54 static int dma8[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 0,1,3 */
55 static int dma16[SNDRV_CARDS] = SNDRV_DEFAULT_DMA; /* 5,6,7 */
56 static int mic_agc[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 1};
57 #ifdef CONFIG_SND_SB16_CSP
58 static int csp[SNDRV_CARDS];
60 #ifdef SNDRV_SBAWE_EMU8000
61 static int seq_ports[SNDRV_CARDS] = {[0 ... (SNDRV_CARDS - 1)] = 4};
64 module_param_array(index, int, NULL, 0444);
65 MODULE_PARM_DESC(index, "Index value for SoundBlaster 16 soundcard.");
66 module_param_array(id, charp, NULL, 0444);
67 MODULE_PARM_DESC(id, "ID string for SoundBlaster 16 soundcard.");
68 module_param_array(enable, bool, NULL, 0444);
69 MODULE_PARM_DESC(enable, "Enable SoundBlaster 16 soundcard.");
71 module_param_array(isapnp, bool, NULL, 0444);
72 MODULE_PARM_DESC(isapnp, "PnP detection for specified soundcard.");
74 module_param_hw_array(port, long, ioport, NULL, 0444);
75 MODULE_PARM_DESC(port, "Port # for SB16 driver.");
76 module_param_hw_array(mpu_port, long, ioport, NULL, 0444);
77 MODULE_PARM_DESC(mpu_port, "MPU-401 port # for SB16 driver.");
78 module_param_hw_array(fm_port, long, ioport, NULL, 0444);
79 MODULE_PARM_DESC(fm_port, "FM port # for SB16 PnP driver.");
80 #ifdef SNDRV_SBAWE_EMU8000
81 module_param_hw_array(awe_port, long, ioport, NULL, 0444);
82 MODULE_PARM_DESC(awe_port, "AWE port # for SB16 PnP driver.");
84 module_param_hw_array(irq, int, irq, NULL, 0444);
85 MODULE_PARM_DESC(irq, "IRQ # for SB16 driver.");
86 module_param_hw_array(dma8, int, dma, NULL, 0444);
87 MODULE_PARM_DESC(dma8, "8-bit DMA # for SB16 driver.");
88 module_param_hw_array(dma16, int, dma, NULL, 0444);
89 MODULE_PARM_DESC(dma16, "16-bit DMA # for SB16 driver.");
90 module_param_array(mic_agc, int, NULL, 0444);
91 MODULE_PARM_DESC(mic_agc, "Mic Auto-Gain-Control switch.");
92 #ifdef CONFIG_SND_SB16_CSP
93 module_param_array(csp, int, NULL, 0444);
94 MODULE_PARM_DESC(csp, "ASP/CSP chip support.");
96 #ifdef SNDRV_SBAWE_EMU8000
97 module_param_array(seq_ports, int, NULL, 0444);
98 MODULE_PARM_DESC(seq_ports, "Number of sequencer ports for WaveTable synth.");
102 static int isa_registered;
103 static int pnp_registered;
106 struct snd_card_sb16 {
107 struct resource *fm_res; /* used to block FM i/o region for legacy cards */
112 #ifdef SNDRV_SBAWE_EMU8000
113 struct pnp_dev *devwt;
120 static const struct pnp_card_device_id snd_sb16_pnpids[] = {
122 /* Sound Blaster 16 PnP */
123 { .id = "CTL0024", .devs = { { "CTL0031" } } },
124 /* Sound Blaster 16 PnP */
125 { .id = "CTL0025", .devs = { { "CTL0031" } } },
126 /* Sound Blaster 16 PnP */
127 { .id = "CTL0026", .devs = { { "CTL0031" } } },
128 /* Sound Blaster 16 PnP */
129 { .id = "CTL0027", .devs = { { "CTL0031" } } },
130 /* Sound Blaster 16 PnP */
131 { .id = "CTL0028", .devs = { { "CTL0031" } } },
132 /* Sound Blaster 16 PnP */
133 { .id = "CTL0029", .devs = { { "CTL0031" } } },
134 /* Sound Blaster 16 PnP */
135 { .id = "CTL002a", .devs = { { "CTL0031" } } },
136 /* Sound Blaster 16 PnP */
137 /* Note: This card has also a CTL0051:StereoEnhance device!!! */
138 { .id = "CTL002b", .devs = { { "CTL0031" } } },
139 /* Sound Blaster 16 PnP */
140 { .id = "CTL002c", .devs = { { "CTL0031" } } },
141 /* Sound Blaster Vibra16S */
142 { .id = "CTL0051", .devs = { { "CTL0001" } } },
143 /* Sound Blaster Vibra16C */
144 { .id = "CTL0070", .devs = { { "CTL0001" } } },
145 /* Sound Blaster Vibra16CL - added by ctm@ardi.com */
146 { .id = "CTL0080", .devs = { { "CTL0041" } } },
147 /* Sound Blaster 16 'value' PnP. It says model ct4130 on the pcb, */
148 /* but ct4131 on a sticker on the board.. */
149 { .id = "CTL0086", .devs = { { "CTL0041" } } },
150 /* Sound Blaster Vibra16X */
151 { .id = "CTL00f0", .devs = { { "CTL0043" } } },
152 /* Sound Blaster 16 (Virtual PC 2004) */
153 { .id = "tBA03b0", .devs = { {.id="PNPb003" } } },
154 #else /* SNDRV_SBAWE defined */
155 /* Sound Blaster AWE 32 PnP */
156 { .id = "CTL0035", .devs = { { "CTL0031" }, { "CTL0021" } } },
157 /* Sound Blaster AWE 32 PnP */
158 { .id = "CTL0039", .devs = { { "CTL0031" }, { "CTL0021" } } },
159 /* Sound Blaster AWE 32 PnP */
160 { .id = "CTL0042", .devs = { { "CTL0031" }, { "CTL0021" } } },
161 /* Sound Blaster AWE 32 PnP */
162 { .id = "CTL0043", .devs = { { "CTL0031" }, { "CTL0021" } } },
163 /* Sound Blaster AWE 32 PnP */
164 /* Note: This card has also a CTL0051:StereoEnhance device!!! */
165 { .id = "CTL0044", .devs = { { "CTL0031" }, { "CTL0021" } } },
166 /* Sound Blaster AWE 32 PnP */
167 /* Note: This card has also a CTL0051:StereoEnhance device!!! */
168 { .id = "CTL0045", .devs = { { "CTL0031" }, { "CTL0021" } } },
169 /* Sound Blaster AWE 32 PnP */
170 { .id = "CTL0046", .devs = { { "CTL0031" }, { "CTL0021" } } },
171 /* Sound Blaster AWE 32 PnP */
172 { .id = "CTL0047", .devs = { { "CTL0031" }, { "CTL0021" } } },
173 /* Sound Blaster AWE 32 PnP */
174 { .id = "CTL0048", .devs = { { "CTL0031" }, { "CTL0021" } } },
175 /* Sound Blaster AWE 32 PnP */
176 { .id = "CTL0054", .devs = { { "CTL0031" }, { "CTL0021" } } },
177 /* Sound Blaster AWE 32 PnP */
178 { .id = "CTL009a", .devs = { { "CTL0041" }, { "CTL0021" } } },
179 /* Sound Blaster AWE 32 PnP */
180 { .id = "CTL009c", .devs = { { "CTL0041" }, { "CTL0021" } } },
181 /* Sound Blaster 32 PnP */
182 { .id = "CTL009f", .devs = { { "CTL0041" }, { "CTL0021" } } },
183 /* Sound Blaster AWE 64 PnP */
184 { .id = "CTL009d", .devs = { { "CTL0042" }, { "CTL0022" } } },
185 /* Sound Blaster AWE 64 PnP Gold */
186 { .id = "CTL009e", .devs = { { "CTL0044" }, { "CTL0023" } } },
187 /* Sound Blaster AWE 64 PnP Gold */
188 { .id = "CTL00b2", .devs = { { "CTL0044" }, { "CTL0023" } } },
189 /* Sound Blaster AWE 64 PnP */
190 { .id = "CTL00c1", .devs = { { "CTL0042" }, { "CTL0022" } } },
191 /* Sound Blaster AWE 64 PnP */
192 { .id = "CTL00c3", .devs = { { "CTL0045" }, { "CTL0022" } } },
193 /* Sound Blaster AWE 64 PnP */
194 { .id = "CTL00c5", .devs = { { "CTL0045" }, { "CTL0022" } } },
195 /* Sound Blaster AWE 64 PnP */
196 { .id = "CTL00c7", .devs = { { "CTL0045" }, { "CTL0022" } } },
197 /* Sound Blaster AWE 64 PnP */
198 { .id = "CTL00e4", .devs = { { "CTL0045" }, { "CTL0022" } } },
199 /* Sound Blaster AWE 64 PnP */
200 { .id = "CTL00e9", .devs = { { "CTL0045" }, { "CTL0022" } } },
201 /* Sound Blaster 16 PnP (AWE) */
202 { .id = "CTL00ed", .devs = { { "CTL0041" }, { "CTL0070" } } },
203 /* Generic entries */
204 { .id = "CTLXXXX" , .devs = { { "CTL0031" }, { "CTL0021" } } },
205 { .id = "CTLXXXX" , .devs = { { "CTL0041" }, { "CTL0021" } } },
206 { .id = "CTLXXXX" , .devs = { { "CTL0042" }, { "CTL0022" } } },
207 { .id = "CTLXXXX" , .devs = { { "CTL0044" }, { "CTL0023" } } },
208 { .id = "CTLXXXX" , .devs = { { "CTL0045" }, { "CTL0022" } } },
209 #endif /* SNDRV_SBAWE */
213 MODULE_DEVICE_TABLE(pnp_card, snd_sb16_pnpids);
215 #endif /* CONFIG_PNP */
217 #ifdef SNDRV_SBAWE_EMU8000
218 #define DRIVER_NAME "snd-card-sbawe"
220 #define DRIVER_NAME "snd-card-sb16"
225 static int snd_card_sb16_pnp(int dev, struct snd_card_sb16 *acard,
226 struct pnp_card_link *card,
227 const struct pnp_card_device_id *id)
229 struct pnp_dev *pdev;
232 acard->dev = pnp_request_card_device(card, id->devs[0].id, NULL);
233 if (acard->dev == NULL)
236 #ifdef SNDRV_SBAWE_EMU8000
237 acard->devwt = pnp_request_card_device(card, id->devs[1].id, acard->dev);
239 /* Audio initialization */
242 err = pnp_activate_dev(pdev);
244 dev_err(&pdev->dev, "AUDIO pnp configure failure\n");
247 port[dev] = pnp_port_start(pdev, 0);
248 mpu_port[dev] = pnp_port_start(pdev, 1);
249 fm_port[dev] = pnp_port_start(pdev, 2);
250 dma8[dev] = pnp_dma(pdev, 0);
251 dma16[dev] = pnp_dma(pdev, 1);
252 irq[dev] = pnp_irq(pdev, 0);
253 dev_dbg(&pdev->dev, "pnp SB16: port=0x%lx, mpu port=0x%lx, fm port=0x%lx\n",
254 port[dev], mpu_port[dev], fm_port[dev]);
255 dev_dbg(&pdev->dev, "pnp SB16: dma1=%i, dma2=%i, irq=%i\n",
256 dma8[dev], dma16[dev], irq[dev]);
257 #ifdef SNDRV_SBAWE_EMU8000
258 /* WaveTable initialization */
261 err = pnp_activate_dev(pdev);
265 awe_port[dev] = pnp_port_start(pdev, 0);
266 dev_dbg(&pdev->dev, "pnp SB16: wavetable port=0x%llx\n",
267 (unsigned long long)pnp_port_start(pdev, 0));
271 pnp_release_card_device(pdev);
272 dev_err(&pdev->dev, "WaveTable pnp configure failure\n");
281 #endif /* CONFIG_PNP */
284 #define is_isapnp_selected(dev) isapnp[dev]
286 #define is_isapnp_selected(dev) 0
289 static int snd_sb16_card_new(struct device *devptr, int dev,
290 struct snd_card **cardp)
292 struct snd_card *card;
295 err = snd_devm_card_new(devptr, index[dev], id[dev], THIS_MODULE,
296 sizeof(struct snd_card_sb16), &card);
303 static int snd_sb16_probe(struct snd_card *card, int dev)
305 int xirq, xdma8, xdma16;
307 struct snd_card_sb16 *acard = card->private_data;
308 struct snd_opl3 *opl3;
309 struct snd_hwdep *synth = NULL;
310 #ifdef CONFIG_SND_SB16_CSP
311 struct snd_hwdep *xcsp = NULL;
320 err = snd_sbdsp_create(card, port[dev], xirq, snd_sb16dsp_interrupt,
321 xdma8, xdma16, SB_HW_AUTO, &chip);
326 if (chip->hardware != SB_HW_16) {
327 dev_err(card->dev, "SB 16 chip was not detected at 0x%lx\n", port[dev]);
330 chip->mpu_port = mpu_port[dev];
331 if (!is_isapnp_selected(dev)) {
332 err = snd_sb16dsp_configure(chip);
337 err = snd_sb16dsp_pcm(chip, 0);
341 strscpy(card->driver,
342 #ifdef SNDRV_SBAWE_EMU8000
343 awe_port[dev] > 0 ? "SB AWE" :
346 strscpy(card->shortname, chip->name);
347 sprintf(card->longname, "%s at 0x%lx, irq %i, dma ",
352 sprintf(card->longname + strlen(card->longname), "%d", xdma8);
354 sprintf(card->longname + strlen(card->longname), "%s%d",
355 xdma8 >= 0 ? "&" : "", xdma16);
357 if (chip->mpu_port > 0 && chip->mpu_port != SNDRV_AUTO_PORT) {
358 err = snd_mpu401_uart_new(card, 0, MPU401_HW_SB,
360 MPU401_INFO_IRQ_HOOK, -1,
364 chip->rmidi_callback = snd_mpu401_uart_interrupt;
367 #ifdef SNDRV_SBAWE_EMU8000
368 if (awe_port[dev] == SNDRV_AUTO_PORT)
369 awe_port[dev] = 0; /* disable */
372 if (fm_port[dev] > 0 && fm_port[dev] != SNDRV_AUTO_PORT) {
373 if (snd_opl3_create(card, fm_port[dev], fm_port[dev] + 2,
375 acard->fm_res != NULL || fm_port[dev] == port[dev],
377 dev_err(card->dev, "no OPL device at 0x%lx-0x%lx\n",
378 fm_port[dev], fm_port[dev] + 2);
380 #ifdef SNDRV_SBAWE_EMU8000
381 int seqdev = awe_port[dev] > 0 ? 2 : 1;
385 err = snd_opl3_hwdep_new(opl3, 0, seqdev, &synth);
391 err = snd_sbmixer_new(chip);
395 #ifdef CONFIG_SND_SB16_CSP
396 /* CSP chip on SB16ASP/AWE32 */
397 if ((chip->hardware == SB_HW_16) && csp[dev]) {
398 snd_sb_csp_new(chip, synth != NULL ? 1 : 0, &xcsp);
400 chip->csp = xcsp->private_data;
401 chip->hardware = SB_HW_16CSP;
404 "warning - CSP chip not detected on soundcard #%i\n",
409 #ifdef SNDRV_SBAWE_EMU8000
410 if (awe_port[dev] > 0) {
411 err = snd_emu8000_new(card, 1, awe_port[dev],
412 seq_ports[dev], NULL);
415 "fatal error - EMU-8000 synthesizer not detected at 0x%lx\n",
424 spin_lock_irqsave(&chip->mixer_lock, flags);
425 snd_sbmixer_write(chip, SB_DSP4_MIC_AGC,
426 (snd_sbmixer_read(chip, SB_DSP4_MIC_AGC) & 0x01) |
427 (mic_agc[dev] ? 0x00 : 0x01));
428 spin_unlock_irqrestore(&chip->mixer_lock, flags);
430 err = snd_card_register(card);
438 static int snd_sb16_suspend(struct snd_card *card, pm_message_t state)
440 struct snd_card_sb16 *acard = card->private_data;
441 struct snd_sb *chip = acard->chip;
443 snd_power_change_state(card, SNDRV_CTL_POWER_D3hot);
444 snd_sbmixer_suspend(chip);
448 static int snd_sb16_resume(struct snd_card *card)
450 struct snd_card_sb16 *acard = card->private_data;
451 struct snd_sb *chip = acard->chip;
453 snd_sbdsp_reset(chip);
454 snd_sbmixer_resume(chip);
455 snd_power_change_state(card, SNDRV_CTL_POWER_D0);
460 static int snd_sb16_isa_probe1(int dev, struct device *pdev)
462 struct snd_card_sb16 *acard;
463 struct snd_card *card;
466 err = snd_sb16_card_new(pdev, dev, &card);
470 acard = card->private_data;
471 /* non-PnP FM port address is hardwired with base port address */
472 fm_port[dev] = port[dev];
473 /* block the 0x388 port to avoid PnP conflicts */
474 acard->fm_res = devm_request_region(card->dev, 0x388, 4,
476 #ifdef SNDRV_SBAWE_EMU8000
477 /* non-PnP AWE port address is hardwired with base port address */
478 awe_port[dev] = port[dev] + 0x400;
481 err = snd_sb16_probe(card, dev);
484 dev_set_drvdata(pdev, card);
489 static int snd_sb16_isa_match(struct device *pdev, unsigned int dev)
491 return enable[dev] && !is_isapnp_selected(dev);
494 static int snd_sb16_isa_probe(struct device *pdev, unsigned int dev)
497 static const int possible_irqs[] = {5, 9, 10, 7, -1};
498 static const int possible_dmas8[] = {1, 3, 0, -1};
499 static const int possible_dmas16[] = {5, 6, 7, -1};
501 if (irq[dev] == SNDRV_AUTO_IRQ) {
502 irq[dev] = snd_legacy_find_free_irq(possible_irqs);
504 dev_err(pdev, "unable to find a free IRQ\n");
508 if (dma8[dev] == SNDRV_AUTO_DMA) {
509 dma8[dev] = snd_legacy_find_free_dma(possible_dmas8);
511 dev_err(pdev, "unable to find a free 8-bit DMA\n");
515 if (dma16[dev] == SNDRV_AUTO_DMA) {
516 dma16[dev] = snd_legacy_find_free_dma(possible_dmas16);
517 if (dma16[dev] < 0) {
518 dev_err(pdev, "unable to find a free 16-bit DMA\n");
523 if (port[dev] != SNDRV_AUTO_PORT)
524 return snd_sb16_isa_probe1(dev, pdev);
526 static const int possible_ports[] = {0x220, 0x240, 0x260, 0x280};
528 for (i = 0; i < ARRAY_SIZE(possible_ports); i++) {
529 port[dev] = possible_ports[i];
530 err = snd_sb16_isa_probe1(dev, pdev);
539 static int snd_sb16_isa_suspend(struct device *dev, unsigned int n,
542 return snd_sb16_suspend(dev_get_drvdata(dev), state);
545 static int snd_sb16_isa_resume(struct device *dev, unsigned int n)
547 return snd_sb16_resume(dev_get_drvdata(dev));
552 #define DEV_NAME "sbawe"
554 #define DEV_NAME "sb16"
557 static struct isa_driver snd_sb16_isa_driver = {
558 .match = snd_sb16_isa_match,
559 .probe = snd_sb16_isa_probe,
561 .suspend = snd_sb16_isa_suspend,
562 .resume = snd_sb16_isa_resume,
571 static int snd_sb16_pnp_detect(struct pnp_card_link *pcard,
572 const struct pnp_card_device_id *pid)
575 struct snd_card *card;
578 for ( ; dev < SNDRV_CARDS; dev++) {
579 if (!enable[dev] || !isapnp[dev])
581 res = snd_sb16_card_new(&pcard->card->dev, dev, &card);
584 res = snd_card_sb16_pnp(dev, card->private_data, pcard, pid);
587 res = snd_sb16_probe(card, dev);
590 pnp_set_card_drvdata(pcard, card);
599 static int snd_sb16_pnp_suspend(struct pnp_card_link *pcard, pm_message_t state)
601 return snd_sb16_suspend(pnp_get_card_drvdata(pcard), state);
603 static int snd_sb16_pnp_resume(struct pnp_card_link *pcard)
605 return snd_sb16_resume(pnp_get_card_drvdata(pcard));
609 static struct pnp_card_driver sb16_pnpc_driver = {
610 .flags = PNP_DRIVER_RES_DISABLE,
616 .id_table = snd_sb16_pnpids,
617 .probe = snd_sb16_pnp_detect,
619 .suspend = snd_sb16_pnp_suspend,
620 .resume = snd_sb16_pnp_resume,
624 #endif /* CONFIG_PNP */
626 static int __init alsa_card_sb16_init(void)
630 err = isa_register_driver(&snd_sb16_isa_driver, SNDRV_CARDS);
635 err = pnp_register_card_driver(&sb16_pnpc_driver);
645 static void __exit alsa_card_sb16_exit(void)
649 pnp_unregister_card_driver(&sb16_pnpc_driver);
652 isa_unregister_driver(&snd_sb16_isa_driver);
655 module_init(alsa_card_sb16_init)
656 module_exit(alsa_card_sb16_exit)