2 * Copyright (c) 1999 Seigo Tanimura
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
8 * 1. Redistributions of source code must retain the above copyright
9 * notice, this list of conditions and the following disclaimer.
10 * 2. Redistributions in binary form must reproduce the above copyright
11 * notice, this list of conditions and the following disclaimer in the
12 * documentation and/or other materials provided with the distribution.
14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26 * $FreeBSD: src/sys/dev/sound/isa/sbc.c,v 1.44.2.1 2005/12/30 19:55:53 netchild Exp $
29 #include <dev/sound/chip.h>
30 #include <dev/sound/pcm/sound.h>
31 #include <dev/sound/isa/sb.h>
33 #include <bus/isa/isavar.h>
35 SND_DECLARE_FILE("$DragonFly: src/sys/dev/sound/isa/sbc.c,v 1.10 2007/06/16 20:07:18 dillon Exp $");
45 driver_intr_t *intr[INTR_MAX];
46 void *intr_arg[INTR_MAX];
47 struct sbc_softc *parent;
50 /* Here is the parameter structure per a device. */
52 device_t dev; /* device */
53 device_t child_pcm, child_midi1, child_midi2;
55 int io_rid[IO_MAX]; /* io port rids */
56 struct resource *io[IO_MAX]; /* io port resources */
57 int io_alloced[IO_MAX]; /* io port alloc flag */
59 int irq_rid[IRQ_MAX]; /* irq rids */
60 struct resource *irq[IRQ_MAX]; /* irq resources */
61 int irq_alloced[IRQ_MAX]; /* irq alloc flag */
63 int drq_rid[DRQ_MAX]; /* drq rids */
64 struct resource *drq[DRQ_MAX]; /* drq resources */
65 int drq_alloced[DRQ_MAX]; /* drq alloc flag */
67 struct sbc_ihl ihl[IRQ_MAX];
76 static int sbc_probe(device_t dev);
77 static int sbc_attach(device_t dev);
78 static void sbc_intr(void *p);
80 static struct resource *sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
81 u_long start, u_long end, u_long count, u_int flags);
82 static int sbc_release_resource(device_t bus, device_t child, int type, int rid,
84 static int sbc_setup_intr(device_t dev, device_t child, struct resource *irq,
85 int flags, driver_intr_t *intr, void *arg,
87 static int sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
90 static int alloc_resource(struct sbc_softc *scp);
91 static int release_resource(struct sbc_softc *scp);
93 static devclass_t sbc_devclass;
95 static int io_range[3] = {0x10, 0x2, 0x4};
97 static int sb_rd(struct resource *io, int reg);
98 static void sb_wr(struct resource *io, int reg, u_int8_t val);
99 static int sb_dspready(struct resource *io);
100 static int sb_cmd(struct resource *io, u_char val);
101 static u_int sb_get_byte(struct resource *io);
102 static void sb_setmixer(struct resource *io, u_int port, u_int value);
105 sbc_lockinit(struct sbc_softc *scp)
107 scp->lock = snd_mtxcreate(device_get_nameunit(scp->dev), "sound softc");
111 sbc_lockdestroy(struct sbc_softc *scp)
113 snd_mtxfree(scp->lock);
117 sbc_lock(struct sbc_softc *scp)
119 snd_mtxlock(scp->lock);
123 sbc_lockassert(struct sbc_softc *scp)
125 snd_mtxassert(scp->lock);
129 sbc_unlock(struct sbc_softc *scp)
131 snd_mtxunlock(scp->lock);
135 sb_rd(struct resource *io, int reg)
137 return bus_space_read_1(rman_get_bustag(io),
138 rman_get_bushandle(io),
143 sb_wr(struct resource *io, int reg, u_int8_t val)
145 bus_space_write_1(rman_get_bustag(io),
146 rman_get_bushandle(io),
151 sb_dspready(struct resource *io)
153 return ((sb_rd(io, SBDSP_STATUS) & 0x80) == 0);
157 sb_dspwr(struct resource *io, u_char val)
161 for (i = 0; i < 1000; i++) {
162 if (sb_dspready(io)) {
163 sb_wr(io, SBDSP_CMD, val);
166 if (i > 10) DELAY((i > 100)? 1000 : 10);
168 kprintf("sb_dspwr(0x%02x) timed out.\n", val);
173 sb_cmd(struct resource *io, u_char val)
175 return sb_dspwr(io, val);
179 sb_setmixer(struct resource *io, u_int port, u_int value)
182 sb_wr(io, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */
184 sb_wr(io, SB_MIX_DATA, (u_char) (value & 0xff));
190 sb_get_byte(struct resource *io)
194 for (i = 1000; i > 0; i--) {
195 if (sb_rd(io, DSP_DATA_AVAIL) & 0x80)
196 return sb_rd(io, DSP_READ);
204 sb_reset_dsp(struct resource *io)
206 sb_wr(io, SBDSP_RST, 3);
208 sb_wr(io, SBDSP_RST, 0);
209 return (sb_get_byte(io) == 0xAA)? 0 : ENXIO;
213 sb_identify_board(struct resource *io)
215 int ver, essver, rev;
217 sb_cmd(io, DSP_CMD_GETVER); /* Get version */
218 ver = (sb_get_byte(io) << 8) | sb_get_byte(io);
219 if (ver < 0x100 || ver > 0x4ff) return 0;
221 /* Try to detect ESS chips. */
222 sb_cmd(io, DSP_CMD_GETID); /* Return ident. bytes. */
223 essver = (sb_get_byte(io) << 8) | sb_get_byte(io);
224 rev = essver & 0x000f;
226 if (essver == 0x4880) ver |= 0x1000;
227 else if (essver == 0x6880) ver = 0x0500 | rev;
232 static struct isa_pnp_id sbc_ids[] = {
233 {0x01008c0e, "Creative ViBRA16C"}, /* CTL0001 */
234 {0x31008c0e, "Creative SB16/SB32"}, /* CTL0031 */
235 {0x41008c0e, "Creative SB16/SB32"}, /* CTL0041 */
236 {0x42008c0e, "Creative SB AWE64"}, /* CTL0042 */
237 {0x43008c0e, "Creative ViBRA16X"}, /* CTL0043 */
238 {0x44008c0e, "Creative SB AWE64 Gold"}, /* CTL0044 */
239 {0x45008c0e, "Creative SB AWE64"}, /* CTL0045 */
240 {0x46008c0e, "Creative SB AWE64"}, /* CTL0046 */
242 {0x01000000, "Avance Logic ALS100+"}, /* @@@0001 - ViBRA16X clone */
243 {0x01100000, "Avance Asound 110"}, /* @@@1001 */
244 {0x01200000, "Avance Logic ALS120"}, /* @@@2001 - ViBRA16X clone */
246 {0x81167316, "ESS ES1681"}, /* ESS1681 */
247 {0x02017316, "ESS ES1688"}, /* ESS1688 */
248 {0x68097316, "ESS ES1688"}, /* ESS1688 */
249 {0x68187316, "ESS ES1868"}, /* ESS1868 */
250 {0x03007316, "ESS ES1869"}, /* ESS1869 */
251 {0x69187316, "ESS ES1869"}, /* ESS1869 */
252 {0xabb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ab */
253 {0xacb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ac */
254 {0x78187316, "ESS ES1878"}, /* ESS1878 */
255 {0x79187316, "ESS ES1879"}, /* ESS1879 */
256 {0x88187316, "ESS ES1888"}, /* ESS1888 */
257 {0x07017316, "ESS ES1888 (DEC OEM)"}, /* ESS0107 */
258 {0x06017316, "ESS ES1888 (Dell OEM)"}, /* ESS0106 */
263 sbc_probe(device_t dev)
268 lid = isa_get_logicalid(dev);
269 vid = isa_get_vendorid(dev);
271 if (lid == 0x01000000 && vid != 0x01009305) /* ALS0001 */
274 return ISA_PNP_PROBE(device_get_parent(dev), dev, sbc_ids);
279 io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
280 0, ~0, 16, RF_ACTIVE);
282 if (sb_reset_dsp(io)) goto bad2;
283 ver = sb_identify_board(io);
284 if (ver == 0) goto bad2;
285 switch ((ver & 0x00000f00) >> 8) {
287 device_set_desc(dev, "SoundBlaster 1.0 (not supported)");
292 s = "SoundBlaster 2.0";
296 s = (ver & 0x0000f000)? "ESS 488" : "SoundBlaster Pro";
300 s = "SoundBlaster 16";
304 s = (ver & 0x00000008)? "ESS 688" : "ESS 1688";
307 if (s) device_set_desc(dev, s);
308 bad2: bus_release_resource(dev, SYS_RES_IOPORT, rid, io);
309 bad: return s? 0 : ENXIO;
314 sbc_attach(device_t dev)
317 struct sbc_softc *scp;
318 struct sndcard_func *func;
319 u_int32_t logical_id = isa_get_logicalid(dev);
320 int flags = device_get_flags(dev);
321 int f, dh, dl, x, irq, i;
323 if (!logical_id && (flags & DV_F_DUAL_DMA)) {
324 bus_set_resource(dev, SYS_RES_DRQ, 1,
325 flags & DV_F_DRQ_MASK, 1);
328 scp = device_get_softc(dev);
329 bzero(scp, sizeof(*scp));
332 err = "alloc_resource";
333 if (alloc_resource(scp)) goto bad;
335 err = "sb_reset_dsp";
336 if (sb_reset_dsp(scp->io[0])) goto bad;
337 err = "sb_identify_board";
338 scp->bd_ver = sb_identify_board(scp->io[0]) & 0x00000fff;
339 if (scp->bd_ver == 0) goto bad;
341 if (logical_id == 0x01200000 && scp->bd_ver < 0x0400) scp->bd_ver = 0x0499;
342 switch ((scp->bd_ver & 0x0f00) >> 8) {
343 case 1: /* old sound blaster has nothing... */
348 if (scp->bd_ver > 0x200) f |= BD_F_MIX_CT1335;
353 scp->bd_ver = 0x0301;
355 f |= BD_F_DUP_MIDI | BD_F_MIX_CT1345;
359 f |= BD_F_SB16 | BD_F_MIX_CT1745;
360 if (scp->drq[0]) dl = rman_get_start(scp->drq[0]); else dl = -1;
361 if (scp->drq[1]) dh = rman_get_start(scp->drq[1]); else dh = dl;
362 if (!logical_id && (dh < dl)) {
365 scp->drq[0] = scp->drq[1];
367 dl = rman_get_start(scp->drq[0]);
368 dh = rman_get_start(scp->drq[1]);
370 /* soft irq/dma configuration */
372 irq = rman_get_start(scp->irq[0]);
374 else if (irq == 7) x = 4;
375 else if (irq == 9) x = 1;
376 else if (irq == 10) x = 8;
378 err = "bad irq (5/7/9/10 valid)";
381 else sb_setmixer(scp->io[0], IRQ_NR, x);
382 sb_setmixer(scp->io[0], DMA_NR, (1 << dh) | (1 << dl));
384 device_printf(dev, "setting card to irq %d, drq %d", irq, dl);
385 if (dl != dh) kprintf(", %d", dh);
391 switch (logical_id) {
392 case 0x43008c0e: /* CTL0043 */
398 scp->bd_ver |= f << 16;
401 for (i = 0; i < IRQ_MAX; i++) {
402 scp->ihl[i].parent = scp;
403 if (snd_setup_intr(dev, scp->irq[i], 0, sbc_intr, &scp->ihl[i], &scp->ih[i]))
408 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
409 if (func == NULL) goto bad;
410 func->func = SCF_PCM;
411 scp->child_pcm = device_add_child(dev, "pcm", -1);
412 device_set_ivars(scp->child_pcm, func);
415 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
416 if (func == NULL) goto bad;
417 func->func = SCF_MIDI;
418 scp->child_midi1 = device_add_child(dev, "midi", -1);
419 device_set_ivars(scp->child_midi1, func);
421 /* OPL FM Synthesizer */
422 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
423 if (func == NULL) goto bad;
424 func->func = SCF_SYNTH;
425 scp->child_midi2 = device_add_child(dev, "midi", -1);
426 device_set_ivars(scp->child_midi2, func);
428 /* probe/attach kids */
429 bus_generic_attach(dev);
433 bad: if (err) device_printf(dev, "%s\n", err);
434 release_resource(scp);
439 sbc_detach(device_t dev)
441 struct sbc_softc *scp = device_get_softc(dev);
444 device_delete_child(dev, scp->child_midi2);
445 device_delete_child(dev, scp->child_midi1);
446 device_delete_child(dev, scp->child_pcm);
447 release_resource(scp);
448 sbc_lockdestroy(scp);
449 return bus_generic_detach(dev);
455 struct sbc_ihl *ihl = p;
458 /* sbc_lock(ihl->parent); */
460 while (i < INTR_MAX) {
461 if (ihl->intr[i] != NULL) ihl->intr[i](ihl->intr_arg[i]);
464 /* sbc_unlock(ihl->parent); */
468 sbc_setup_intr(device_t dev, device_t child, struct resource *irq,
469 int flags, driver_intr_t *intr, void *arg,
472 struct sbc_softc *scp = device_get_softc(dev);
473 struct sbc_ihl *ihl = NULL;
478 while (i < IRQ_MAX) {
479 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
483 if (ihl == NULL) ret = EINVAL;
485 while ((ret == 0) && (i < INTR_MAX)) {
486 if (ihl->intr[i] == NULL) {
488 ihl->intr_arg[i] = arg;
489 *cookiep = &ihl->intr[i];
494 return (ret > 0)? EINVAL : 0;
498 sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
501 struct sbc_softc *scp = device_get_softc(dev);
502 struct sbc_ihl *ihl = NULL;
507 while (i < IRQ_MAX) {
508 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
512 if (ihl == NULL) ret = EINVAL;
514 while ((ret == 0) && (i < INTR_MAX)) {
515 if (cookie == &ihl->intr[i]) {
517 ihl->intr_arg[i] = NULL;
522 return (ret > 0)? EINVAL : 0;
525 static struct resource *
526 sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
527 u_long start, u_long end, u_long count, u_int flags)
529 struct sbc_softc *scp;
530 int *alloced, rid_max, alloced_max;
531 struct resource **res;
533 scp = device_get_softc(bus);
536 alloced = scp->io_alloced;
538 rid_max = IO_MAX - 1;
542 alloced = scp->drq_alloced;
544 rid_max = DRQ_MAX - 1;
548 alloced = scp->irq_alloced;
550 rid_max = IRQ_MAX - 1;
551 alloced_max = INTR_MAX; /* pcm and mpu may share the irq. */
557 if (*rid > rid_max || alloced[*rid] == alloced_max)
565 sbc_release_resource(device_t bus, device_t child, int type, int rid,
568 struct sbc_softc *scp;
569 int *alloced, rid_max;
571 scp = device_get_softc(bus);
574 alloced = scp->io_alloced;
575 rid_max = IO_MAX - 1;
578 alloced = scp->drq_alloced;
579 rid_max = DRQ_MAX - 1;
582 alloced = scp->irq_alloced;
583 rid_max = IRQ_MAX - 1;
589 if (rid > rid_max || alloced[rid] == 0)
597 sbc_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result)
599 struct sbc_softc *scp = device_get_softc(bus);
600 struct sndcard_func *func = device_get_ivars(dev);
604 *result = func->func;
608 *result = scp->bd_ver;
619 sbc_write_ivar(device_t bus, device_t dev,
620 int index, uintptr_t value)
633 alloc_resource(struct sbc_softc *scp)
637 for (i = 0 ; i < IO_MAX ; i++) {
638 if (scp->io[i] == NULL) {
640 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
641 0, ~0, io_range[i], RF_ACTIVE);
642 if (i == 0 && scp->io[i] == NULL)
644 scp->io_alloced[i] = 0;
647 for (i = 0 ; i < DRQ_MAX ; i++) {
648 if (scp->drq[i] == NULL) {
650 scp->drq[i] = bus_alloc_resource_any(scp->dev,
654 if (i == 0 && scp->drq[i] == NULL)
656 scp->drq_alloced[i] = 0;
659 for (i = 0 ; i < IRQ_MAX ; i++) {
660 if (scp->irq[i] == NULL) {
662 scp->irq[i] = bus_alloc_resource_any(scp->dev,
666 if (i == 0 && scp->irq[i] == NULL)
668 scp->irq_alloced[i] = 0;
675 release_resource(struct sbc_softc *scp)
679 for (i = 0 ; i < IO_MAX ; i++) {
680 if (scp->io[i] != NULL) {
681 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
685 for (i = 0 ; i < DRQ_MAX ; i++) {
686 if (scp->drq[i] != NULL) {
687 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
691 for (i = 0 ; i < IRQ_MAX ; i++) {
692 if (scp->irq[i] != NULL) {
693 if (scp->ih[i] != NULL)
694 bus_teardown_intr(scp->dev, scp->irq[i], scp->ih[i]);
696 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid[i], scp->irq[i]);
703 static device_method_t sbc_methods[] = {
704 /* Device interface */
705 DEVMETHOD(device_probe, sbc_probe),
706 DEVMETHOD(device_attach, sbc_attach),
707 DEVMETHOD(device_detach, sbc_detach),
708 DEVMETHOD(device_shutdown, bus_generic_shutdown),
709 DEVMETHOD(device_suspend, bus_generic_suspend),
710 DEVMETHOD(device_resume, bus_generic_resume),
713 DEVMETHOD(bus_read_ivar, sbc_read_ivar),
714 DEVMETHOD(bus_write_ivar, sbc_write_ivar),
715 DEVMETHOD(bus_print_child, bus_generic_print_child),
716 DEVMETHOD(bus_alloc_resource, sbc_alloc_resource),
717 DEVMETHOD(bus_release_resource, sbc_release_resource),
718 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
719 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
720 DEVMETHOD(bus_setup_intr, sbc_setup_intr),
721 DEVMETHOD(bus_teardown_intr, sbc_teardown_intr),
726 static driver_t sbc_driver = {
729 sizeof(struct sbc_softc),
732 /* sbc can be attached to an isa bus. */
733 DRIVER_MODULE(snd_sbc, isa, sbc_driver, sbc_devclass, 0, 0);
734 DRIVER_MODULE(snd_sbc, acpi, sbc_driver, sbc_devclass, 0, 0);
735 MODULE_DEPEND(snd_sbc, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
736 MODULE_VERSION(snd_sbc, 1);