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
27 #include <dev/sound/chip.h>
28 #include <dev/sound/pcm/sound.h>
29 #include <dev/sound/isa/sb.h>
31 SND_DECLARE_FILE("$FreeBSD: src/sys/dev/sound/isa/sbc.c,v 1.19.2.12 2002/12/24 21:17:42 semenu Exp $");
41 driver_intr_t *intr[INTR_MAX];
42 void *intr_arg[INTR_MAX];
43 struct sbc_softc *parent;
46 /* Here is the parameter structure per a device. */
48 device_t dev; /* device */
49 device_t child_pcm, child_midi1, child_midi2;
51 int io_rid[IO_MAX]; /* io port rids */
52 struct resource *io[IO_MAX]; /* io port resources */
53 int io_alloced[IO_MAX]; /* io port alloc flag */
55 int irq_rid[IRQ_MAX]; /* irq rids */
56 struct resource *irq[IRQ_MAX]; /* irq resources */
57 int irq_alloced[IRQ_MAX]; /* irq alloc flag */
59 int drq_rid[DRQ_MAX]; /* drq rids */
60 struct resource *drq[DRQ_MAX]; /* drq resources */
61 int drq_alloced[DRQ_MAX]; /* drq alloc flag */
63 struct sbc_ihl ihl[IRQ_MAX];
72 static int sbc_probe(device_t dev);
73 static int sbc_attach(device_t dev);
74 static void sbc_intr(void *p);
76 static struct resource *sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
77 u_long start, u_long end, u_long count, u_int flags);
78 static int sbc_release_resource(device_t bus, device_t child, int type, int rid,
80 static int sbc_setup_intr(device_t dev, device_t child, struct resource *irq,
81 int flags, driver_intr_t *intr, void *arg,
83 static int sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
86 static int alloc_resource(struct sbc_softc *scp);
87 static int release_resource(struct sbc_softc *scp);
89 static devclass_t sbc_devclass;
91 static int io_range[3] = {0x10, 0x2, 0x4};
93 #ifdef PC98 /* I/O address table for PC98 */
94 static bus_addr_t pcm_iat[] = {
95 0x000, 0x100, 0x200, 0x300, 0x400, 0x500, 0x600, 0x700,
96 0x800, 0x900, 0xa00, 0xb00, 0xc00, 0xd00, 0xe00, 0xf00
98 static bus_addr_t midi_iat[] = {
101 static bus_addr_t opl_iat[] = {
102 0x000, 0x100, 0x200, 0x300
104 static bus_addr_t *sb_iat[] = { pcm_iat, midi_iat, opl_iat };
107 static int sb_rd(struct resource *io, int reg);
108 static void sb_wr(struct resource *io, int reg, u_int8_t val);
109 static int sb_dspready(struct resource *io);
110 static int sb_cmd(struct resource *io, u_char val);
111 static u_int sb_get_byte(struct resource *io);
112 static void sb_setmixer(struct resource *io, u_int port, u_int value);
115 sbc_lockinit(struct sbc_softc *scp)
117 scp->lock = snd_mtxcreate(device_get_nameunit(scp->dev), "sound softc");
121 sbc_lockdestroy(struct sbc_softc *scp)
123 snd_mtxfree(scp->lock);
127 sbc_lock(struct sbc_softc *scp)
129 snd_mtxlock(scp->lock);
133 sbc_unlock(struct sbc_softc *scp)
135 snd_mtxunlock(scp->lock);
139 sb_rd(struct resource *io, int reg)
141 return bus_space_read_1(rman_get_bustag(io),
142 rman_get_bushandle(io),
147 sb_wr(struct resource *io, int reg, u_int8_t val)
149 bus_space_write_1(rman_get_bustag(io),
150 rman_get_bushandle(io),
155 sb_dspready(struct resource *io)
157 return ((sb_rd(io, SBDSP_STATUS) & 0x80) == 0);
161 sb_dspwr(struct resource *io, u_char val)
165 for (i = 0; i < 1000; i++) {
166 if (sb_dspready(io)) {
167 sb_wr(io, SBDSP_CMD, val);
170 if (i > 10) DELAY((i > 100)? 1000 : 10);
172 printf("sb_dspwr(0x%02x) timed out.\n", val);
177 sb_cmd(struct resource *io, u_char val)
179 return sb_dspwr(io, val);
183 sb_setmixer(struct resource *io, u_int port, u_int value)
188 sb_wr(io, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */
190 sb_wr(io, SB_MIX_DATA, (u_char) (value & 0xff));
196 sb_get_byte(struct resource *io)
200 for (i = 1000; i > 0; i--) {
201 if (sb_rd(io, DSP_DATA_AVAIL) & 0x80)
202 return sb_rd(io, DSP_READ);
210 sb_reset_dsp(struct resource *io)
212 sb_wr(io, SBDSP_RST, 3);
214 sb_wr(io, SBDSP_RST, 0);
215 return (sb_get_byte(io) == 0xAA)? 0 : ENXIO;
219 sb_identify_board(struct resource *io)
221 int ver, essver, rev;
223 sb_cmd(io, DSP_CMD_GETVER); /* Get version */
224 ver = (sb_get_byte(io) << 8) | sb_get_byte(io);
225 if (ver < 0x100 || ver > 0x4ff) return 0;
227 /* Try to detect ESS chips. */
228 sb_cmd(io, DSP_CMD_GETID); /* Return ident. bytes. */
229 essver = (sb_get_byte(io) << 8) | sb_get_byte(io);
230 rev = essver & 0x000f;
232 if (essver == 0x4880) ver |= 0x1000;
233 else if (essver == 0x6880) ver = 0x0500 | rev;
238 static struct isa_pnp_id sbc_ids[] = {
239 {0x01008c0e, "Creative ViBRA16C"}, /* CTL0001 */
240 {0x31008c0e, "Creative SB16/SB32"}, /* CTL0031 */
241 {0x41008c0e, "Creative SB16/SB32"}, /* CTL0041 */
242 {0x42008c0e, "Creative SB AWE64"}, /* CTL0042 */
243 {0x43008c0e, "Creative ViBRA16X"}, /* CTL0043 */
244 {0x44008c0e, "Creative SB AWE64 Gold"}, /* CTL0044 */
245 {0x45008c0e, "Creative SB AWE64"}, /* CTL0045 */
246 {0x46008c0e, "Creative SB AWE64"}, /* CTL0046 */
248 {0x01000000, "Avance Logic ALS100+"}, /* @@@0001 - ViBRA16X clone */
249 {0x01100000, "Avance Asound 110"}, /* @@@1001 */
250 {0x01200000, "Avance Logic ALS120"}, /* @@@2001 - ViBRA16X clone */
252 {0x81167316, "ESS ES1681"}, /* ESS1681 */
253 {0x02017316, "ESS ES1688"}, /* ESS1688 */
254 {0x68187316, "ESS ES1868"}, /* ESS1868 */
255 {0x03007316, "ESS ES1869"}, /* ESS1869 */
256 {0x69187316, "ESS ES1869"}, /* ESS1869 */
257 {0xabb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ab */
258 {0xacb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ac */
259 {0x78187316, "ESS ES1878"}, /* ESS1878 */
260 {0x79187316, "ESS ES1879"}, /* ESS1879 */
261 {0x88187316, "ESS ES1888"}, /* ESS1888 */
262 {0x07017316, "ESS ES1888 (DEC OEM)"}, /* ESS0107 */
263 {0x06017316, "ESS ES1888 (Dell OEM)"}, /* ESS0106 */
268 sbc_probe(device_t dev)
273 lid = isa_get_logicalid(dev);
274 vid = isa_get_vendorid(dev);
276 if (lid == 0x01000000 && vid != 0x01009305) /* ALS0001 */
279 return ISA_PNP_PROBE(device_get_parent(dev), dev, sbc_ids);
285 io = isa_alloc_resourcev(dev, SYS_RES_IOPORT, &rid,
286 pcm_iat, 16, RF_ACTIVE);
288 io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
289 0, ~0, 16, RF_ACTIVE);
293 isa_load_resourcev(io, pcm_iat, 16);
295 if (sb_reset_dsp(io)) goto bad2;
296 ver = sb_identify_board(io);
297 if (ver == 0) goto bad2;
298 switch ((ver & 0x00000f00) >> 8) {
300 device_set_desc(dev, "SoundBlaster 1.0 (not supported)");
305 s = "SoundBlaster 2.0";
309 s = (ver & 0x0000f000)? "ESS 488" : "SoundBlaster Pro";
313 s = "SoundBlaster 16";
317 s = (ver & 0x00000008)? "ESS 688" : "ESS 1688";
320 if (s) device_set_desc(dev, s);
321 bad2: bus_release_resource(dev, SYS_RES_IOPORT, rid, io);
322 bad: return s? 0 : ENXIO;
327 sbc_attach(device_t dev)
330 struct sbc_softc *scp;
331 struct sndcard_func *func;
332 u_int32_t logical_id = isa_get_logicalid(dev);
333 int flags = device_get_flags(dev);
334 int f, dh, dl, x, irq, i;
336 if (!logical_id && (flags & DV_F_DUAL_DMA)) {
337 bus_set_resource(dev, SYS_RES_DRQ, 1,
338 flags & DV_F_DRQ_MASK, 1);
341 scp = device_get_softc(dev);
342 bzero(scp, sizeof(*scp));
345 err = "alloc_resource";
346 if (alloc_resource(scp)) goto bad;
348 err = "sb_reset_dsp";
349 if (sb_reset_dsp(scp->io[0])) goto bad;
350 err = "sb_identify_board";
351 scp->bd_ver = sb_identify_board(scp->io[0]) & 0x00000fff;
352 if (scp->bd_ver == 0) goto bad;
354 if (logical_id == 0x01200000 && scp->bd_ver < 0x0400) scp->bd_ver = 0x0499;
355 switch ((scp->bd_ver & 0x0f00) >> 8) {
356 case 1: /* old sound blaster has nothing... */
361 if (scp->bd_ver > 0x200) f |= BD_F_MIX_CT1335;
366 scp->bd_ver = 0x0301;
368 f |= BD_F_DUP_MIDI | BD_F_MIX_CT1345;
372 f |= BD_F_SB16 | BD_F_MIX_CT1745;
373 if (scp->drq[0]) dl = rman_get_start(scp->drq[0]); else dl = -1;
374 if (scp->drq[1]) dh = rman_get_start(scp->drq[1]); else dh = dl;
375 if (!logical_id && (dh < dl)) {
378 scp->drq[0] = scp->drq[1];
380 dl = rman_get_start(scp->drq[0]);
381 dh = rman_get_start(scp->drq[1]);
383 /* soft irq/dma configuration */
385 irq = rman_get_start(scp->irq[0]);
387 /* SB16 in PC98 use different IRQ table */
389 else if (irq == 5) x = 8;
390 else if (irq == 10) x = 2;
391 else if (irq == 12) x = 4;
393 err = "bad irq (3/5/10/12 valid)";
396 else sb_setmixer(scp->io[0], IRQ_NR, x);
397 /* SB16 in PC98 use different dma setting */
398 sb_setmixer(scp->io[0], DMA_NR, dh == 0 ? 1 : 2);
401 else if (irq == 7) x = 4;
402 else if (irq == 9) x = 1;
403 else if (irq == 10) x = 8;
405 err = "bad irq (5/7/9/10 valid)";
408 else sb_setmixer(scp->io[0], IRQ_NR, x);
409 sb_setmixer(scp->io[0], DMA_NR, (1 << dh) | (1 << dl));
412 device_printf(dev, "setting card to irq %d, drq %d", irq, dl);
413 if (dl != dh) printf(", %d", dh);
419 switch (logical_id) {
420 case 0x43008c0e: /* CTL0043 */
426 scp->bd_ver |= f << 16;
429 for (i = 0; i < IRQ_MAX; i++) {
430 scp->ihl[i].parent = scp;
431 if (snd_setup_intr(dev, scp->irq[i], INTR_MPSAFE, sbc_intr, &scp->ihl[i], &scp->ih[i]))
436 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
437 if (func == NULL) goto bad;
438 func->func = SCF_PCM;
439 scp->child_pcm = device_add_child(dev, "pcm", -1);
440 device_set_ivars(scp->child_pcm, func);
443 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
444 if (func == NULL) goto bad;
445 func->func = SCF_MIDI;
446 scp->child_midi1 = device_add_child(dev, "midi", -1);
447 device_set_ivars(scp->child_midi1, func);
449 /* OPL FM Synthesizer */
450 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
451 if (func == NULL) goto bad;
452 func->func = SCF_SYNTH;
453 scp->child_midi2 = device_add_child(dev, "midi", -1);
454 device_set_ivars(scp->child_midi2, func);
456 /* probe/attach kids */
457 bus_generic_attach(dev);
461 bad: if (err) device_printf(dev, "%s\n", err);
462 release_resource(scp);
467 sbc_detach(device_t dev)
469 struct sbc_softc *scp = device_get_softc(dev);
472 device_delete_child(dev, scp->child_midi2);
473 device_delete_child(dev, scp->child_midi1);
474 device_delete_child(dev, scp->child_pcm);
475 release_resource(scp);
476 sbc_lockdestroy(scp);
477 return bus_generic_detach(dev);
483 struct sbc_ihl *ihl = p;
486 /* sbc_lock(ihl->parent); */
488 while (i < INTR_MAX) {
489 if (ihl->intr[i] != NULL) ihl->intr[i](ihl->intr_arg[i]);
492 /* sbc_unlock(ihl->parent); */
496 sbc_setup_intr(device_t dev, device_t child, struct resource *irq,
497 int flags, driver_intr_t *intr, void *arg,
500 struct sbc_softc *scp = device_get_softc(dev);
501 struct sbc_ihl *ihl = NULL;
506 while (i < IRQ_MAX) {
507 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
511 if (ihl == NULL) ret = EINVAL;
513 while ((ret == 0) && (i < INTR_MAX)) {
514 if (ihl->intr[i] == NULL) {
516 ihl->intr_arg[i] = arg;
517 *cookiep = &ihl->intr[i];
522 return (ret > 0)? EINVAL : 0;
526 sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
529 struct sbc_softc *scp = device_get_softc(dev);
530 struct sbc_ihl *ihl = NULL;
535 while (i < IRQ_MAX) {
536 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
540 if (ihl == NULL) ret = EINVAL;
542 while ((ret == 0) && (i < INTR_MAX)) {
543 if (cookie == &ihl->intr[i]) {
545 ihl->intr_arg[i] = NULL;
550 return (ret > 0)? EINVAL : 0;
553 static struct resource *
554 sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
555 u_long start, u_long end, u_long count, u_int flags)
557 struct sbc_softc *scp;
558 int *alloced, rid_max, alloced_max;
559 struct resource **res;
564 scp = device_get_softc(bus);
567 alloced = scp->io_alloced;
571 for (i = 0; i < IO_MAX; i++)
572 rid_max += io_range[i];
574 rid_max = IO_MAX - 1;
579 alloced = scp->drq_alloced;
581 rid_max = DRQ_MAX - 1;
585 alloced = scp->irq_alloced;
587 rid_max = IRQ_MAX - 1;
588 alloced_max = INTR_MAX; /* pcm and mpu may share the irq. */
594 if (*rid > rid_max || alloced[*rid] == alloced_max)
602 sbc_release_resource(device_t bus, device_t child, int type, int rid,
605 struct sbc_softc *scp;
606 int *alloced, rid_max;
608 scp = device_get_softc(bus);
611 alloced = scp->io_alloced;
612 rid_max = IO_MAX - 1;
615 alloced = scp->drq_alloced;
616 rid_max = DRQ_MAX - 1;
619 alloced = scp->irq_alloced;
620 rid_max = IRQ_MAX - 1;
626 if (rid > rid_max || alloced[rid] == 0)
634 sbc_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result)
636 struct sbc_softc *scp = device_get_softc(bus);
637 struct sndcard_func *func = device_get_ivars(dev);
641 *result = func->func;
645 *result = scp->bd_ver;
656 sbc_write_ivar(device_t bus, device_t dev,
657 int index, uintptr_t value)
670 alloc_resource(struct sbc_softc *scp)
674 for (i = 0 ; i < IO_MAX ; i++) {
675 if (scp->io[i] == NULL) {
677 scp->io_rid[i] = i > 0 ?
678 scp->io_rid[i - 1] + io_range[i - 1] : 0;
679 scp->io[i] = isa_alloc_resourcev(scp->dev,
685 if (scp->io[i] != NULL)
686 isa_load_resourcev(scp->io[i], sb_iat[i],
690 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
691 0, ~0, io_range[i], RF_ACTIVE);
693 if (i == 0 && scp->io[i] == NULL)
695 scp->io_alloced[i] = 0;
698 for (i = 0 ; i < DRQ_MAX ; i++) {
699 if (scp->drq[i] == NULL) {
701 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i],
702 0, ~0, 1, RF_ACTIVE);
703 if (i == 0 && scp->drq[i] == NULL)
705 scp->drq_alloced[i] = 0;
708 for (i = 0 ; i < IRQ_MAX ; i++) {
709 if (scp->irq[i] == NULL) {
711 scp->irq[i] = bus_alloc_resource(scp->dev, SYS_RES_IRQ, &scp->irq_rid[i],
712 0, ~0, 1, RF_ACTIVE);
713 if (i == 0 && scp->irq[i] == NULL)
715 scp->irq_alloced[i] = 0;
722 release_resource(struct sbc_softc *scp)
726 for (i = 0 ; i < IO_MAX ; i++) {
727 if (scp->io[i] != NULL) {
728 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
732 for (i = 0 ; i < DRQ_MAX ; i++) {
733 if (scp->drq[i] != NULL) {
734 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
738 for (i = 0 ; i < IRQ_MAX ; i++) {
739 if (scp->irq[i] != NULL) {
740 if (scp->ih[i] != NULL)
741 bus_teardown_intr(scp->dev, scp->irq[i], scp->ih[i]);
743 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid[i], scp->irq[i]);
750 static device_method_t sbc_methods[] = {
751 /* Device interface */
752 DEVMETHOD(device_probe, sbc_probe),
753 DEVMETHOD(device_attach, sbc_attach),
754 DEVMETHOD(device_detach, sbc_detach),
755 DEVMETHOD(device_shutdown, bus_generic_shutdown),
756 DEVMETHOD(device_suspend, bus_generic_suspend),
757 DEVMETHOD(device_resume, bus_generic_resume),
760 DEVMETHOD(bus_read_ivar, sbc_read_ivar),
761 DEVMETHOD(bus_write_ivar, sbc_write_ivar),
762 DEVMETHOD(bus_print_child, bus_generic_print_child),
763 DEVMETHOD(bus_alloc_resource, sbc_alloc_resource),
764 DEVMETHOD(bus_release_resource, sbc_release_resource),
765 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
766 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
767 DEVMETHOD(bus_setup_intr, sbc_setup_intr),
768 DEVMETHOD(bus_teardown_intr, sbc_teardown_intr),
773 static driver_t sbc_driver = {
776 sizeof(struct sbc_softc),
779 /* sbc can be attached to an isa bus. */
780 DRIVER_MODULE(snd_sbc, isa, sbc_driver, sbc_devclass, 0, 0);
781 MODULE_DEPEND(snd_sbc, snd_pcm, PCM_MINVER, PCM_PREFVER, PCM_MAXVER);
782 MODULE_VERSION(snd_sbc, 1);