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 #ifdef HAVE_KERNEL_OPTION_HEADERS
31 #include <dev/sound/chip.h>
32 #include <dev/sound/pcm/sound.h>
33 #include <dev/sound/isa/sb.h>
35 #include <isa/isavar.h>
37 SND_DECLARE_FILE("$FreeBSD$");
47 driver_intr_t *intr[INTR_MAX];
48 void *intr_arg[INTR_MAX];
49 struct sbc_softc *parent;
52 /* Here is the parameter structure per a device. */
54 device_t dev; /* device */
55 device_t child_pcm, child_midi1, child_midi2;
57 int io_rid[IO_MAX]; /* io port rids */
58 struct resource *io[IO_MAX]; /* io port resources */
59 int io_alloced[IO_MAX]; /* io port alloc flag */
61 int irq_rid[IRQ_MAX]; /* irq rids */
62 struct resource *irq[IRQ_MAX]; /* irq resources */
63 int irq_alloced[IRQ_MAX]; /* irq alloc flag */
65 int drq_rid[DRQ_MAX]; /* drq rids */
66 struct resource *drq[DRQ_MAX]; /* drq resources */
67 int drq_alloced[DRQ_MAX]; /* drq alloc flag */
69 struct sbc_ihl ihl[IRQ_MAX];
78 static int sbc_probe(device_t dev);
79 static int sbc_attach(device_t dev);
80 static void sbc_intr(void *p);
82 static struct resource *sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
83 u_long start, u_long end, u_long count, u_int flags);
84 static int sbc_release_resource(device_t bus, device_t child, int type, int rid,
86 static int sbc_setup_intr(device_t dev, device_t child, struct resource *irq,
88 driver_filter_t *filter,
90 void *arg, void **cookiep);
91 static int sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
94 static int alloc_resource(struct sbc_softc *scp);
95 static int release_resource(struct sbc_softc *scp);
97 static devclass_t sbc_devclass;
99 static int io_range[3] = {0x10, 0x2, 0x4};
101 #ifdef PC98 /* I/O address table for PC98 */
102 static bus_addr_t pcm_iat[] = {
103 0x000, 0x100, 0x200, 0x300, 0x400, 0x500, 0x600, 0x700,
104 0x800, 0x900, 0xa00, 0xb00, 0xc00, 0xd00, 0xe00, 0xf00
106 static bus_addr_t midi_iat[] = {
109 static bus_addr_t opl_iat[] = {
110 0x000, 0x100, 0x200, 0x300
112 static bus_addr_t *sb_iat[] = { pcm_iat, midi_iat, opl_iat };
115 static int sb_rd(struct resource *io, int reg);
116 static void sb_wr(struct resource *io, int reg, u_int8_t val);
117 static int sb_dspready(struct resource *io);
118 static int sb_cmd(struct resource *io, u_char val);
119 static u_int sb_get_byte(struct resource *io);
120 static void sb_setmixer(struct resource *io, u_int port, u_int value);
123 sbc_lockinit(struct sbc_softc *scp)
125 scp->lock = snd_mtxcreate(device_get_nameunit(scp->dev),
130 sbc_lockdestroy(struct sbc_softc *scp)
132 snd_mtxfree(scp->lock);
136 sbc_lock(struct sbc_softc *scp)
138 snd_mtxlock(scp->lock);
142 sbc_lockassert(struct sbc_softc *scp)
144 snd_mtxassert(scp->lock);
148 sbc_unlock(struct sbc_softc *scp)
150 snd_mtxunlock(scp->lock);
154 sb_rd(struct resource *io, int reg)
156 return bus_space_read_1(rman_get_bustag(io),
157 rman_get_bushandle(io),
162 sb_wr(struct resource *io, int reg, u_int8_t val)
164 bus_space_write_1(rman_get_bustag(io),
165 rman_get_bushandle(io),
170 sb_dspready(struct resource *io)
172 return ((sb_rd(io, SBDSP_STATUS) & 0x80) == 0);
176 sb_dspwr(struct resource *io, u_char val)
180 for (i = 0; i < 1000; i++) {
181 if (sb_dspready(io)) {
182 sb_wr(io, SBDSP_CMD, val);
185 if (i > 10) DELAY((i > 100)? 1000 : 10);
187 printf("sb_dspwr(0x%02x) timed out.\n", val);
192 sb_cmd(struct resource *io, u_char val)
194 return sb_dspwr(io, val);
198 sb_setmixer(struct resource *io, u_int port, u_int value)
203 sb_wr(io, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */
205 sb_wr(io, SB_MIX_DATA, (u_char) (value & 0xff));
211 sb_get_byte(struct resource *io)
215 for (i = 1000; i > 0; i--) {
216 if (sb_rd(io, DSP_DATA_AVAIL) & 0x80)
217 return sb_rd(io, DSP_READ);
225 sb_reset_dsp(struct resource *io)
227 sb_wr(io, SBDSP_RST, 3);
229 sb_wr(io, SBDSP_RST, 0);
230 return (sb_get_byte(io) == 0xAA)? 0 : ENXIO;
234 sb_identify_board(struct resource *io)
236 int ver, essver, rev;
238 sb_cmd(io, DSP_CMD_GETVER); /* Get version */
239 ver = (sb_get_byte(io) << 8) | sb_get_byte(io);
240 if (ver < 0x100 || ver > 0x4ff) return 0;
242 /* Try to detect ESS chips. */
243 sb_cmd(io, DSP_CMD_GETID); /* Return ident. bytes. */
244 essver = (sb_get_byte(io) << 8) | sb_get_byte(io);
245 rev = essver & 0x000f;
247 if (essver == 0x4880) ver |= 0x1000;
248 else if (essver == 0x6880) ver = 0x0500 | rev;
253 static struct isa_pnp_id sbc_ids[] = {
254 {0x01008c0e, "Creative ViBRA16C"}, /* CTL0001 */
255 {0x31008c0e, "Creative SB16/SB32"}, /* CTL0031 */
256 {0x41008c0e, "Creative SB16/SB32"}, /* CTL0041 */
257 {0x42008c0e, "Creative SB AWE64"}, /* CTL0042 */
258 {0x43008c0e, "Creative ViBRA16X"}, /* CTL0043 */
259 {0x44008c0e, "Creative SB AWE64 Gold"}, /* CTL0044 */
260 {0x45008c0e, "Creative SB AWE64"}, /* CTL0045 */
261 {0x46008c0e, "Creative SB AWE64"}, /* CTL0046 */
263 {0x01000000, "Avance Logic ALS100+"}, /* @@@0001 - ViBRA16X clone */
264 {0x01100000, "Avance Asound 110"}, /* @@@1001 */
265 {0x01200000, "Avance Logic ALS120"}, /* @@@2001 - ViBRA16X clone */
267 {0x81167316, "ESS ES1681"}, /* ESS1681 */
268 {0x02017316, "ESS ES1688"}, /* ESS1688 */
269 {0x68097316, "ESS ES1688"}, /* ESS1688 */
270 {0x68187316, "ESS ES1868"}, /* ESS1868 */
271 {0x03007316, "ESS ES1869"}, /* ESS1869 */
272 {0x69187316, "ESS ES1869"}, /* ESS1869 */
273 {0xabb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ab */
274 {0xacb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ac */
275 {0x78187316, "ESS ES1878"}, /* ESS1878 */
276 {0x79187316, "ESS ES1879"}, /* ESS1879 */
277 {0x88187316, "ESS ES1888"}, /* ESS1888 */
278 {0x07017316, "ESS ES1888 (DEC OEM)"}, /* ESS0107 */
279 {0x06017316, "ESS ES1888 (Dell OEM)"}, /* ESS0106 */
284 sbc_probe(device_t dev)
289 lid = isa_get_logicalid(dev);
290 vid = isa_get_vendorid(dev);
292 if (lid == 0x01000000 && vid != 0x01009305) /* ALS0001 */
295 return ISA_PNP_PROBE(device_get_parent(dev), dev, sbc_ids);
301 io = isa_alloc_resourcev(dev, SYS_RES_IOPORT, &rid,
302 pcm_iat, 16, RF_ACTIVE);
304 io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid,
305 0, ~0, 16, RF_ACTIVE);
309 isa_load_resourcev(io, pcm_iat, 16);
311 if (sb_reset_dsp(io)) goto bad2;
312 ver = sb_identify_board(io);
313 if (ver == 0) goto bad2;
314 switch ((ver & 0x00000f00) >> 8) {
316 device_set_desc(dev, "SoundBlaster 1.0 (not supported)");
321 s = "SoundBlaster 2.0";
325 s = (ver & 0x0000f000)? "ESS 488" : "SoundBlaster Pro";
329 s = "SoundBlaster 16";
333 s = (ver & 0x00000008)? "ESS 688" : "ESS 1688";
336 if (s) device_set_desc(dev, s);
337 bad2: bus_release_resource(dev, SYS_RES_IOPORT, rid, io);
338 bad: return s? 0 : ENXIO;
343 sbc_attach(device_t dev)
346 struct sbc_softc *scp;
347 struct sndcard_func *func;
348 u_int32_t logical_id = isa_get_logicalid(dev);
349 int flags = device_get_flags(dev);
350 int f, dh, dl, x, irq, i;
352 if (!logical_id && (flags & DV_F_DUAL_DMA)) {
353 bus_set_resource(dev, SYS_RES_DRQ, 1,
354 flags & DV_F_DRQ_MASK, 1);
357 scp = device_get_softc(dev);
358 bzero(scp, sizeof(*scp));
361 err = "alloc_resource";
362 if (alloc_resource(scp)) goto bad;
364 err = "sb_reset_dsp";
365 if (sb_reset_dsp(scp->io[0])) goto bad;
366 err = "sb_identify_board";
367 scp->bd_ver = sb_identify_board(scp->io[0]) & 0x00000fff;
368 if (scp->bd_ver == 0) goto bad;
370 if (logical_id == 0x01200000 && scp->bd_ver < 0x0400) scp->bd_ver = 0x0499;
371 switch ((scp->bd_ver & 0x0f00) >> 8) {
372 case 1: /* old sound blaster has nothing... */
377 if (scp->bd_ver > 0x200) f |= BD_F_MIX_CT1335;
382 scp->bd_ver = 0x0301;
384 f |= BD_F_DUP_MIDI | BD_F_MIX_CT1345;
388 f |= BD_F_SB16 | BD_F_MIX_CT1745;
389 if (scp->drq[0]) dl = rman_get_start(scp->drq[0]); else dl = -1;
390 if (scp->drq[1]) dh = rman_get_start(scp->drq[1]); else dh = dl;
391 if (!logical_id && (dh < dl)) {
394 scp->drq[0] = scp->drq[1];
396 dl = rman_get_start(scp->drq[0]);
397 dh = rman_get_start(scp->drq[1]);
399 /* soft irq/dma configuration */
401 irq = rman_get_start(scp->irq[0]);
403 /* SB16 in PC98 use different IRQ table */
405 else if (irq == 5) x = 8;
406 else if (irq == 10) x = 2;
407 else if (irq == 12) x = 4;
409 err = "bad irq (3/5/10/12 valid)";
412 else sb_setmixer(scp->io[0], IRQ_NR, x);
413 /* SB16 in PC98 use different dma setting */
414 sb_setmixer(scp->io[0], DMA_NR, dh == 0 ? 1 : 2);
417 else if (irq == 7) x = 4;
418 else if (irq == 9) x = 1;
419 else if (irq == 10) x = 8;
421 err = "bad irq (5/7/9/10 valid)";
424 else sb_setmixer(scp->io[0], IRQ_NR, x);
425 sb_setmixer(scp->io[0], DMA_NR, (1 << dh) | (1 << dl));
428 device_printf(dev, "setting card to irq %d, drq %d", irq, dl);
429 if (dl != dh) printf(", %d", dh);
435 switch (logical_id) {
436 case 0x43008c0e: /* CTL0043 */
442 scp->bd_ver |= f << 16;
445 for (i = 0; i < IRQ_MAX; i++) {
446 scp->ihl[i].parent = scp;
447 if (snd_setup_intr(dev, scp->irq[i], 0, sbc_intr, &scp->ihl[i], &scp->ih[i]))
452 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
453 if (func == NULL) goto bad;
454 func->func = SCF_PCM;
455 scp->child_pcm = device_add_child(dev, "pcm", -1);
456 device_set_ivars(scp->child_pcm, func);
459 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
460 if (func == NULL) goto bad;
461 func->func = SCF_MIDI;
462 scp->child_midi1 = device_add_child(dev, "midi", -1);
463 device_set_ivars(scp->child_midi1, func);
465 /* OPL FM Synthesizer */
466 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
467 if (func == NULL) goto bad;
468 func->func = SCF_SYNTH;
469 scp->child_midi2 = device_add_child(dev, "midi", -1);
470 device_set_ivars(scp->child_midi2, func);
472 /* probe/attach kids */
473 bus_generic_attach(dev);
477 bad: if (err) device_printf(dev, "%s\n", err);
478 release_resource(scp);
483 sbc_detach(device_t dev)
485 struct sbc_softc *scp = device_get_softc(dev);
488 device_delete_child(dev, scp->child_midi2);
489 device_delete_child(dev, scp->child_midi1);
490 device_delete_child(dev, scp->child_pcm);
491 release_resource(scp);
492 sbc_lockdestroy(scp);
493 return bus_generic_detach(dev);
499 struct sbc_ihl *ihl = p;
502 /* sbc_lock(ihl->parent); */
504 while (i < INTR_MAX) {
505 if (ihl->intr[i] != NULL) ihl->intr[i](ihl->intr_arg[i]);
508 /* sbc_unlock(ihl->parent); */
512 sbc_setup_intr(device_t dev, device_t child, struct resource *irq, int flags,
513 driver_filter_t *filter,
515 void *arg, void **cookiep)
517 struct sbc_softc *scp = device_get_softc(dev);
518 struct sbc_ihl *ihl = NULL;
521 if (filter != NULL) {
522 printf("sbc.c: we cannot use a filter here\n");
527 while (i < IRQ_MAX) {
528 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
532 if (ihl == NULL) ret = EINVAL;
534 while ((ret == 0) && (i < INTR_MAX)) {
535 if (ihl->intr[i] == NULL) {
537 ihl->intr_arg[i] = arg;
538 *cookiep = &ihl->intr[i];
543 return (ret > 0)? EINVAL : 0;
547 sbc_teardown_intr(device_t dev, device_t child, struct resource *irq,
550 struct sbc_softc *scp = device_get_softc(dev);
551 struct sbc_ihl *ihl = NULL;
556 while (i < IRQ_MAX) {
557 if (irq == scp->irq[i]) ihl = &scp->ihl[i];
561 if (ihl == NULL) ret = EINVAL;
563 while ((ret == 0) && (i < INTR_MAX)) {
564 if (cookie == &ihl->intr[i]) {
566 ihl->intr_arg[i] = NULL;
571 return (ret > 0)? EINVAL : 0;
574 static struct resource *
575 sbc_alloc_resource(device_t bus, device_t child, int type, int *rid,
576 u_long start, u_long end, u_long count, u_int flags)
578 struct sbc_softc *scp;
579 int *alloced, rid_max, alloced_max;
580 struct resource **res;
585 scp = device_get_softc(bus);
588 alloced = scp->io_alloced;
592 for (i = 0; i < IO_MAX; i++)
593 rid_max += io_range[i];
595 rid_max = IO_MAX - 1;
600 alloced = scp->drq_alloced;
602 rid_max = DRQ_MAX - 1;
606 alloced = scp->irq_alloced;
608 rid_max = IRQ_MAX - 1;
609 alloced_max = INTR_MAX; /* pcm and mpu may share the irq. */
615 if (*rid > rid_max || alloced[*rid] == alloced_max)
623 sbc_release_resource(device_t bus, device_t child, int type, int rid,
626 struct sbc_softc *scp;
627 int *alloced, rid_max;
629 scp = device_get_softc(bus);
632 alloced = scp->io_alloced;
633 rid_max = IO_MAX - 1;
636 alloced = scp->drq_alloced;
637 rid_max = DRQ_MAX - 1;
640 alloced = scp->irq_alloced;
641 rid_max = IRQ_MAX - 1;
647 if (rid > rid_max || alloced[rid] == 0)
655 sbc_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result)
657 struct sbc_softc *scp = device_get_softc(bus);
658 struct sndcard_func *func = device_get_ivars(dev);
662 *result = func->func;
666 *result = scp->bd_ver;
677 sbc_write_ivar(device_t bus, device_t dev,
678 int index, uintptr_t value)
691 alloc_resource(struct sbc_softc *scp)
695 for (i = 0 ; i < IO_MAX ; i++) {
696 if (scp->io[i] == NULL) {
698 scp->io_rid[i] = i > 0 ?
699 scp->io_rid[i - 1] + io_range[i - 1] : 0;
700 scp->io[i] = isa_alloc_resourcev(scp->dev,
706 if (scp->io[i] != NULL)
707 isa_load_resourcev(scp->io[i], sb_iat[i],
711 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
712 0, ~0, io_range[i], RF_ACTIVE);
714 if (i == 0 && scp->io[i] == NULL)
716 scp->io_alloced[i] = 0;
719 for (i = 0 ; i < DRQ_MAX ; i++) {
720 if (scp->drq[i] == NULL) {
722 scp->drq[i] = bus_alloc_resource_any(scp->dev,
726 if (i == 0 && scp->drq[i] == NULL)
728 scp->drq_alloced[i] = 0;
731 for (i = 0 ; i < IRQ_MAX ; i++) {
732 if (scp->irq[i] == NULL) {
734 scp->irq[i] = bus_alloc_resource_any(scp->dev,
738 if (i == 0 && scp->irq[i] == NULL)
740 scp->irq_alloced[i] = 0;
747 release_resource(struct sbc_softc *scp)
751 for (i = 0 ; i < IO_MAX ; i++) {
752 if (scp->io[i] != NULL) {
753 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
757 for (i = 0 ; i < DRQ_MAX ; i++) {
758 if (scp->drq[i] != NULL) {
759 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
763 for (i = 0 ; i < IRQ_MAX ; i++) {
764 if (scp->irq[i] != NULL) {
765 if (scp->ih[i] != NULL)
766 bus_teardown_intr(scp->dev, scp->irq[i], scp->ih[i]);
768 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid[i], scp->irq[i]);
775 static device_method_t sbc_methods[] = {
776 /* Device interface */
777 DEVMETHOD(device_probe, sbc_probe),
778 DEVMETHOD(device_attach, sbc_attach),
779 DEVMETHOD(device_detach, sbc_detach),
780 DEVMETHOD(device_shutdown, bus_generic_shutdown),
781 DEVMETHOD(device_suspend, bus_generic_suspend),
782 DEVMETHOD(device_resume, bus_generic_resume),
785 DEVMETHOD(bus_read_ivar, sbc_read_ivar),
786 DEVMETHOD(bus_write_ivar, sbc_write_ivar),
787 DEVMETHOD(bus_alloc_resource, sbc_alloc_resource),
788 DEVMETHOD(bus_release_resource, sbc_release_resource),
789 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
790 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
791 DEVMETHOD(bus_setup_intr, sbc_setup_intr),
792 DEVMETHOD(bus_teardown_intr, sbc_teardown_intr),
797 static driver_t sbc_driver = {
800 sizeof(struct sbc_softc),
803 /* sbc can be attached to an isa bus. */
804 DRIVER_MODULE(snd_sbc, isa, sbc_driver, sbc_devclass, 0, 0);
805 DRIVER_MODULE(snd_sbc, acpi, sbc_driver, sbc_devclass, 0, 0);
806 MODULE_DEPEND(snd_sbc, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
807 MODULE_VERSION(snd_sbc, 1);