2 * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
4 * Copyright (c) 1999 Seigo Tanimura
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
10 * 1. Redistributions of source code must retain the above copyright
11 * notice, this list of conditions and the following disclaimer.
12 * 2. Redistributions in binary form must reproduce the above copyright
13 * notice, this list of conditions and the following disclaimer in the
14 * documentation and/or other materials provided with the distribution.
16 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
29 #ifdef HAVE_KERNEL_OPTION_HEADERS
33 #include <dev/sound/chip.h>
34 #include <dev/sound/pcm/sound.h>
35 #include <dev/sound/isa/sb.h>
37 #include <isa/isavar.h>
39 SND_DECLARE_FILE("$FreeBSD$");
49 driver_intr_t *intr[INTR_MAX];
50 void *intr_arg[INTR_MAX];
51 struct sbc_softc *parent;
54 /* Here is the parameter structure per a device. */
56 device_t dev; /* device */
57 device_t child_pcm, child_midi1, child_midi2;
59 int io_rid[IO_MAX]; /* io port rids */
60 struct resource *io[IO_MAX]; /* io port resources */
61 int io_alloced[IO_MAX]; /* io port alloc flag */
63 int irq_rid[IRQ_MAX]; /* irq rids */
64 struct resource *irq[IRQ_MAX]; /* irq resources */
65 int irq_alloced[IRQ_MAX]; /* irq alloc flag */
67 int drq_rid[DRQ_MAX]; /* drq rids */
68 struct resource *drq[DRQ_MAX]; /* drq resources */
69 int drq_alloced[DRQ_MAX]; /* drq alloc flag */
71 struct sbc_ihl ihl[IRQ_MAX];
80 static int sbc_probe(device_t dev);
81 static int sbc_attach(device_t dev);
82 static void sbc_intr(void *p);
84 static struct resource *sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
85 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags);
86 static int sbc_release_resource(device_t bus, device_t child, int type, int rid,
88 static int sbc_setup_intr(device_t dev, device_t child, struct resource *irq,
90 driver_filter_t *filter,
92 void *arg, void **cookiep);
93 static int sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
96 static int alloc_resource(struct sbc_softc *scp);
97 static int release_resource(struct sbc_softc *scp);
99 static devclass_t sbc_devclass;
101 static int io_range[3] = {0x10, 0x2, 0x4};
103 static int sb_rd(struct resource *io, int reg);
104 static void sb_wr(struct resource *io, int reg, u_int8_t val);
105 static int sb_dspready(struct resource *io);
106 static int sb_cmd(struct resource *io, u_char val);
107 static u_int sb_get_byte(struct resource *io);
108 static void sb_setmixer(struct resource *io, u_int port, u_int value);
111 sbc_lockinit(struct sbc_softc *scp)
113 scp->lock = snd_mtxcreate(device_get_nameunit(scp->dev),
118 sbc_lockdestroy(struct sbc_softc *scp)
120 snd_mtxfree(scp->lock);
124 sbc_lock(struct sbc_softc *scp)
126 snd_mtxlock(scp->lock);
130 sbc_lockassert(struct sbc_softc *scp)
132 snd_mtxassert(scp->lock);
136 sbc_unlock(struct sbc_softc *scp)
138 snd_mtxunlock(scp->lock);
142 sb_rd(struct resource *io, int reg)
144 return bus_space_read_1(rman_get_bustag(io),
145 rman_get_bushandle(io),
150 sb_wr(struct resource *io, int reg, u_int8_t val)
152 bus_space_write_1(rman_get_bustag(io),
153 rman_get_bushandle(io),
158 sb_dspready(struct resource *io)
160 return ((sb_rd(io, SBDSP_STATUS) & 0x80) == 0);
164 sb_dspwr(struct resource *io, u_char val)
168 for (i = 0; i < 1000; i++) {
169 if (sb_dspready(io)) {
170 sb_wr(io, SBDSP_CMD, val);
173 if (i > 10) DELAY((i > 100)? 1000 : 10);
175 printf("sb_dspwr(0x%02x) timed out.\n", val);
180 sb_cmd(struct resource *io, u_char val)
182 return sb_dspwr(io, val);
186 sb_setmixer(struct resource *io, u_int port, u_int value)
191 sb_wr(io, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */
193 sb_wr(io, SB_MIX_DATA, (u_char) (value & 0xff));
199 sb_get_byte(struct resource *io)
203 for (i = 1000; i > 0; i--) {
204 if (sb_rd(io, DSP_DATA_AVAIL) & 0x80)
205 return sb_rd(io, DSP_READ);
213 sb_reset_dsp(struct resource *io)
215 sb_wr(io, SBDSP_RST, 3);
217 sb_wr(io, SBDSP_RST, 0);
218 return (sb_get_byte(io) == 0xAA)? 0 : ENXIO;
222 sb_identify_board(struct resource *io)
224 int ver, essver, rev;
226 sb_cmd(io, DSP_CMD_GETVER); /* Get version */
227 ver = (sb_get_byte(io) << 8) | sb_get_byte(io);
228 if (ver < 0x100 || ver > 0x4ff) return 0;
230 /* Try to detect ESS chips. */
231 sb_cmd(io, DSP_CMD_GETID); /* Return ident. bytes. */
232 essver = (sb_get_byte(io) << 8) | sb_get_byte(io);
233 rev = essver & 0x000f;
235 if (essver == 0x4880) ver |= 0x1000;
236 else if (essver == 0x6880) ver = 0x0500 | rev;
241 static struct isa_pnp_id sbc_ids[] = {
242 {0x01008c0e, "Creative ViBRA16C"}, /* CTL0001 */
243 {0x31008c0e, "Creative SB16/SB32"}, /* CTL0031 */
244 {0x41008c0e, "Creative SB16/SB32"}, /* CTL0041 */
245 {0x42008c0e, "Creative SB AWE64"}, /* CTL0042 */
246 {0x43008c0e, "Creative ViBRA16X"}, /* CTL0043 */
247 {0x44008c0e, "Creative SB AWE64 Gold"}, /* CTL0044 */
248 {0x45008c0e, "Creative SB AWE64"}, /* CTL0045 */
249 {0x46008c0e, "Creative SB AWE64"}, /* CTL0046 */
251 {0x01000000, "Avance Logic ALS100+"}, /* @@@0001 - ViBRA16X clone */
252 {0x01100000, "Avance Asound 110"}, /* @@@1001 */
253 {0x01200000, "Avance Logic ALS120"}, /* @@@2001 - ViBRA16X clone */
255 {0x81167316, "ESS ES1681"}, /* ESS1681 */
256 {0x02017316, "ESS ES1688"}, /* ESS1688 */
257 {0x68097316, "ESS ES1688"}, /* ESS1688 */
258 {0x68187316, "ESS ES1868"}, /* ESS1868 */
259 {0x03007316, "ESS ES1869"}, /* ESS1869 */
260 {0x69187316, "ESS ES1869"}, /* ESS1869 */
261 {0xabb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ab */
262 {0xacb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ac */
263 {0x78187316, "ESS ES1878"}, /* ESS1878 */
264 {0x79187316, "ESS ES1879"}, /* ESS1879 */
265 {0x88187316, "ESS ES1888"}, /* ESS1888 */
266 {0x07017316, "ESS ES1888 (DEC OEM)"}, /* ESS0107 */
267 {0x06017316, "ESS ES1888 (Dell OEM)"}, /* ESS0106 */
272 sbc_probe(device_t dev)
277 lid = isa_get_logicalid(dev);
278 vid = isa_get_vendorid(dev);
280 if (lid == 0x01000000 && vid != 0x01009305) /* ALS0001 */
283 return ISA_PNP_PROBE(device_get_parent(dev), dev, sbc_ids);
288 io = bus_alloc_resource_anywhere(dev, SYS_RES_IOPORT, &rid,
291 if (sb_reset_dsp(io)) goto bad2;
292 ver = sb_identify_board(io);
293 if (ver == 0) goto bad2;
294 switch ((ver & 0x00000f00) >> 8) {
296 device_set_desc(dev, "SoundBlaster 1.0 (not supported)");
301 s = "SoundBlaster 2.0";
305 s = (ver & 0x0000f000)? "ESS 488" : "SoundBlaster Pro";
309 s = "SoundBlaster 16";
313 s = (ver & 0x00000008)? "ESS 688" : "ESS 1688";
316 if (s) device_set_desc(dev, s);
317 bad2: bus_release_resource(dev, SYS_RES_IOPORT, rid, io);
318 bad: return s? 0 : ENXIO;
323 sbc_attach(device_t dev)
326 struct sbc_softc *scp;
327 struct sndcard_func *func;
328 u_int32_t logical_id = isa_get_logicalid(dev);
329 int flags = device_get_flags(dev);
330 int f, dh, dl, x, irq, i;
332 if (!logical_id && (flags & DV_F_DUAL_DMA)) {
333 bus_set_resource(dev, SYS_RES_DRQ, 1,
334 flags & DV_F_DRQ_MASK, 1);
337 scp = device_get_softc(dev);
338 bzero(scp, sizeof(*scp));
341 err = "alloc_resource";
342 if (alloc_resource(scp)) goto bad;
344 err = "sb_reset_dsp";
345 if (sb_reset_dsp(scp->io[0])) goto bad;
346 err = "sb_identify_board";
347 scp->bd_ver = sb_identify_board(scp->io[0]) & 0x00000fff;
348 if (scp->bd_ver == 0) goto bad;
350 if (logical_id == 0x01200000 && scp->bd_ver < 0x0400) scp->bd_ver = 0x0499;
351 switch ((scp->bd_ver & 0x0f00) >> 8) {
352 case 1: /* old sound blaster has nothing... */
357 if (scp->bd_ver > 0x200) f |= BD_F_MIX_CT1335;
362 scp->bd_ver = 0x0301;
364 f |= BD_F_DUP_MIDI | BD_F_MIX_CT1345;
368 f |= BD_F_SB16 | BD_F_MIX_CT1745;
369 if (scp->drq[0]) dl = rman_get_start(scp->drq[0]); else dl = -1;
370 if (scp->drq[1]) dh = rman_get_start(scp->drq[1]); else dh = dl;
371 if (!logical_id && (dh < dl)) {
374 scp->drq[0] = scp->drq[1];
376 dl = rman_get_start(scp->drq[0]);
377 dh = rman_get_start(scp->drq[1]);
379 /* soft irq/dma configuration */
381 irq = rman_get_start(scp->irq[0]);
383 else if (irq == 7) x = 4;
384 else if (irq == 9) x = 1;
385 else if (irq == 10) x = 8;
387 err = "bad irq (5/7/9/10 valid)";
390 else sb_setmixer(scp->io[0], IRQ_NR, x);
391 sb_setmixer(scp->io[0], DMA_NR, (1 << dh) | (1 << dl));
393 device_printf(dev, "setting card to irq %d, drq %d", irq, dl);
394 if (dl != dh) printf(", %d", dh);
400 switch (logical_id) {
401 case 0x43008c0e: /* CTL0043 */
407 scp->bd_ver |= f << 16;
410 for (i = 0; i < IRQ_MAX; i++) {
411 scp->ihl[i].parent = scp;
412 if (snd_setup_intr(dev, scp->irq[i], 0, sbc_intr, &scp->ihl[i], &scp->ih[i]))
417 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
418 if (func == NULL) goto bad;
419 func->func = SCF_PCM;
420 scp->child_pcm = device_add_child(dev, "pcm", -1);
421 device_set_ivars(scp->child_pcm, func);
424 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
425 if (func == NULL) goto bad;
426 func->func = SCF_MIDI;
427 scp->child_midi1 = device_add_child(dev, "midi", -1);
428 device_set_ivars(scp->child_midi1, func);
430 /* OPL FM Synthesizer */
431 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
432 if (func == NULL) goto bad;
433 func->func = SCF_SYNTH;
434 scp->child_midi2 = device_add_child(dev, "midi", -1);
435 device_set_ivars(scp->child_midi2, func);
437 /* probe/attach kids */
438 bus_generic_attach(dev);
442 bad: if (err) device_printf(dev, "%s\n", err);
443 release_resource(scp);
448 sbc_detach(device_t dev)
450 struct sbc_softc *scp = device_get_softc(dev);
453 device_delete_child(dev, scp->child_midi2);
454 device_delete_child(dev, scp->child_midi1);
455 device_delete_child(dev, scp->child_pcm);
456 release_resource(scp);
457 sbc_lockdestroy(scp);
458 return bus_generic_detach(dev);
464 struct sbc_ihl *ihl = p;
467 /* sbc_lock(ihl->parent); */
469 while (i < INTR_MAX) {
470 if (ihl->intr[i] != NULL) ihl->intr[i](ihl->intr_arg[i]);
473 /* sbc_unlock(ihl->parent); */
477 sbc_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
478 driver_filter_t *filter,
480 void *arg, void **cookiep)
482 struct sbc_softc *scp = device_get_softc(dev);
483 struct sbc_ihl *ihl = NULL;
486 if (filter != NULL) {
487 printf("sbc.c: we cannot use a filter here\n");
492 while (i < IRQ_MAX) {
493 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
497 if (ihl == NULL) ret = EINVAL;
499 while ((ret == 0) && (i < INTR_MAX)) {
500 if (ihl->intr[i] == NULL) {
502 ihl->intr_arg[i] = arg;
503 *cookiep = &ihl->intr[i];
508 return (ret > 0)? EINVAL : 0;
512 sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
515 struct sbc_softc *scp = device_get_softc(dev);
516 struct sbc_ihl *ihl = NULL;
521 while (i < IRQ_MAX) {
522 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
526 if (ihl == NULL) ret = EINVAL;
528 while ((ret == 0) && (i < INTR_MAX)) {
529 if (cookie == &ihl->intr[i]) {
531 ihl->intr_arg[i] = NULL;
536 return (ret > 0)? EINVAL : 0;
539 static struct resource *
540 sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
541 rman_res_t start, rman_res_t end, rman_res_t count, u_int flags)
543 struct sbc_softc *scp;
544 int *alloced, rid_max, alloced_max;
545 struct resource **res;
547 scp = device_get_softc(bus);
550 alloced = scp->io_alloced;
552 rid_max = IO_MAX - 1;
556 alloced = scp->drq_alloced;
558 rid_max = DRQ_MAX - 1;
562 alloced = scp->irq_alloced;
564 rid_max = IRQ_MAX - 1;
565 alloced_max = INTR_MAX; /* pcm and mpu may share the irq. */
571 if (*rid > rid_max || alloced[*rid] == alloced_max)
579 sbc_release_resource(device_t bus, device_t child, int type, int rid,
582 struct sbc_softc *scp;
583 int *alloced, rid_max;
585 scp = device_get_softc(bus);
588 alloced = scp->io_alloced;
589 rid_max = IO_MAX - 1;
592 alloced = scp->drq_alloced;
593 rid_max = DRQ_MAX - 1;
596 alloced = scp->irq_alloced;
597 rid_max = IRQ_MAX - 1;
603 if (rid > rid_max || alloced[rid] == 0)
611 sbc_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result)
613 struct sbc_softc *scp = device_get_softc(bus);
614 struct sndcard_func *func = device_get_ivars(dev);
618 *result = func->func;
622 *result = scp->bd_ver;
633 sbc_write_ivar(device_t bus, device_t dev,
634 int index, uintptr_t value)
647 alloc_resource(struct sbc_softc *scp)
651 for (i = 0 ; i < IO_MAX ; i++) {
652 if (scp->io[i] == NULL) {
654 scp->io[i] = bus_alloc_resource_anywhere(scp->dev,
659 if (i == 0 && scp->io[i] == NULL)
661 scp->io_alloced[i] = 0;
664 for (i = 0 ; i < DRQ_MAX ; i++) {
665 if (scp->drq[i] == NULL) {
667 scp->drq[i] = bus_alloc_resource_any(scp->dev,
671 if (i == 0 && scp->drq[i] == NULL)
673 scp->drq_alloced[i] = 0;
676 for (i = 0 ; i < IRQ_MAX ; i++) {
677 if (scp->irq[i] == NULL) {
679 scp->irq[i] = bus_alloc_resource_any(scp->dev,
683 if (i == 0 && scp->irq[i] == NULL)
685 scp->irq_alloced[i] = 0;
692 release_resource(struct sbc_softc *scp)
696 for (i = 0 ; i < IO_MAX ; i++) {
697 if (scp->io[i] != NULL) {
698 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
702 for (i = 0 ; i < DRQ_MAX ; i++) {
703 if (scp->drq[i] != NULL) {
704 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
708 for (i = 0 ; i < IRQ_MAX ; i++) {
709 if (scp->irq[i] != NULL) {
710 if (scp->ih[i] != NULL)
711 bus_teardown_intr(scp->dev, scp->irq[i], scp->ih[i]);
713 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid[i], scp->irq[i]);
720 static device_method_t sbc_methods[] = {
721 /* Device interface */
722 DEVMETHOD(device_probe, sbc_probe),
723 DEVMETHOD(device_attach, sbc_attach),
724 DEVMETHOD(device_detach, sbc_detach),
725 DEVMETHOD(device_shutdown, bus_generic_shutdown),
726 DEVMETHOD(device_suspend, bus_generic_suspend),
727 DEVMETHOD(device_resume, bus_generic_resume),
730 DEVMETHOD(bus_read_ivar, sbc_read_ivar),
731 DEVMETHOD(bus_write_ivar, sbc_write_ivar),
732 DEVMETHOD(bus_alloc_resource, sbc_alloc_resource),
733 DEVMETHOD(bus_release_resource, sbc_release_resource),
734 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
735 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
736 DEVMETHOD(bus_setup_intr, sbc_setup_intr),
737 DEVMETHOD(bus_teardown_intr, sbc_teardown_intr),
742 static driver_t sbc_driver = {
745 sizeof(struct sbc_softc),
748 /* sbc can be attached to an isa bus. */
749 DRIVER_MODULE(snd_sbc, isa, sbc_driver, sbc_devclass, 0, 0);
750 DRIVER_MODULE(snd_sbc, acpi, sbc_driver, sbc_devclass, 0, 0);
751 MODULE_DEPEND(snd_sbc, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
752 MODULE_VERSION(snd_sbc, 1);
753 ISA_PNP_INFO(sbc_ids);