2 * Copyright (c) 1999 Seigo Tanimura
3 * Copyright (c) 1999 Ville-Pertti Keinonen
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
9 * 1. Redistributions of source code must retain the above copyright
10 * notice, this list of conditions and the following disclaimer.
11 * 2. Redistributions in binary form must reproduce the above copyright
12 * notice, this list of conditions and the following disclaimer in the
13 * documentation and/or other materials provided with the distribution.
15 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * $FreeBSD: src/sys/dev/sound/isa/gusc.c,v 1.5.2.6 2002/04/22 15:49:30 cg Exp $
28 * $DragonFly: src/sys/dev/sound/isa/gusc.c,v 1.10 2006/12/22 23:26:25 swildner Exp $
31 #include <sys/param.h>
32 #include <sys/systm.h>
33 #include <sys/kernel.h>
35 #include <sys/malloc.h>
36 #include <sys/module.h>
38 #include <sys/soundcard.h>
40 #include <dev/sound/pcm/sound.h>
41 #include <dev/sound/chip.h>
44 #include <bus/isa/isavar.h>
45 #include <bus/isa/isa_common.h>
47 SND_DECLARE_FILE("$DragonFly: src/sys/dev/sound/isa/gusc.c,v 1.10 2006/12/22 23:26:25 swildner Exp $");
49 #define LOGICALID_NOPNP 0
50 #define LOGICALID_PCM 0x0000561e
51 #define LOGICALID_OPL 0x0300561e
52 #define LOGICALID_MIDI 0x0400561e
55 static struct isa_pnp_id gusc_ids[] = {
56 {LOGICALID_PCM, "GRV0000 Gravis UltraSound PnP PCM"}, /* GRV0000 */
57 {LOGICALID_OPL, "GRV0003 Gravis UltraSound PnP OPL"}, /* GRV0003 */
58 {LOGICALID_MIDI, "GRV0004 Gravis UltraSound PnP MIDI"}, /* GRV0004 */
61 /* Interrupt handler. */
62 struct gusc_ihandler {
67 /* Here is the parameter structure per a device. */
69 device_t dev; /* device */
70 int io_rid[3]; /* io port rids */
71 struct resource *io[3]; /* io port resources */
72 int io_alloced[3]; /* io port alloc flag */
73 int irq_rid; /* irq rids */
74 struct resource *irq; /* irq resources */
75 int irq_alloced; /* irq alloc flag */
76 int drq_rid[2]; /* drq rids */
77 struct resource *drq[2]; /* drq resources */
78 int drq_alloced[2]; /* drq alloc flag */
80 /* Interrupts are shared (XXX non-PnP only?) */
81 struct gusc_ihandler midi_intr;
82 struct gusc_ihandler pcm_intr;
85 typedef struct gusc_softc *sc_p;
87 static int gusc_probe(device_t dev);
88 static int gusc_attach(device_t dev);
89 static int gusisa_probe(device_t dev);
90 static void gusc_intr(void *);
91 static struct resource *gusc_alloc_resource(device_t bus, device_t child, int type, int *rid,
92 u_long start, u_long end, u_long count, u_int flags);
93 static int gusc_release_resource(device_t bus, device_t child, int type, int rid,
96 static device_t find_masterdev(sc_p scp);
97 static int alloc_resource(sc_p scp);
98 static int release_resource(sc_p scp);
100 static devclass_t gusc_devclass;
103 gusc_probe(device_t dev)
106 u_int32_t logical_id;
108 struct sndcard_func *func;
111 logical_id = isa_get_logicalid(dev);
114 /* Check isapnp ids */
115 if (logical_id != 0 && (ret = ISA_PNP_PROBE(device_get_parent(dev), dev, gusc_ids)) != 0)
119 return gusisa_probe(dev);
122 switch (logical_id) {
124 s = "Gravis UltraSound Plug & Play PCM";
125 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
128 func->func = SCF_PCM;
129 child = device_add_child(dev, "pcm", -1);
130 device_set_ivars(child, func);
133 s = "Gravis UltraSound Plug & Play OPL";
134 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
137 func->func = SCF_SYNTH;
138 child = device_add_child(dev, "midi", -1);
139 device_set_ivars(child, func);
142 s = "Gravis UltraSound Plug & Play MIDI";
143 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
146 func->func = SCF_MIDI;
147 child = device_add_child(dev, "midi", -1);
148 device_set_ivars(child, func);
153 device_set_desc(dev, s);
161 port_wr(struct resource *r, int i, unsigned char v)
163 bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), i, v);
167 port_rd(struct resource *r, int i)
169 return bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), i);
173 * Probe for an old (non-PnP) GUS card on the ISA bus.
177 gusisa_probe(device_t dev)
180 struct resource *res, *res2;
181 int base, rid, rid2, flags;
184 base = isa_get_port(dev);
185 flags = device_get_flags(dev);
187 res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, base + 0x100,
188 base + 0x107, 8, RF_ACTIVE);
196 * Check for the presence of some GUS card. Reset the card,
197 * then see if we can access the memory on it.
200 port_wr(res, 3, 0x4c);
204 port_wr(res, 3, 0x4c);
212 port_wr(res, 3, 0x43); /* Register select */
213 port_wr(res, 4, 0); /* Low addr */
214 port_wr(res, 5, 0); /* Med addr */
216 port_wr(res, 3, 0x44); /* Register select */
217 port_wr(res, 4, 0); /* High addr */
218 port_wr(res, 7, 0x55); /* DRAM */
220 /* Read from DRAM. */
222 port_wr(res, 3, 0x43); /* Register select */
223 port_wr(res, 4, 0); /* Low addr */
224 port_wr(res, 5, 0); /* Med addr */
226 port_wr(res, 3, 0x44); /* Register select */
227 port_wr(res, 4, 0); /* High addr */
228 val = port_rd(res, 7); /* DRAM */
236 res2 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid2, base, base, 1,
243 port_wr(res2, 0x0f, 0x20);
244 val = port_rd(res2, 0x0f);
247 if (val == 0xff || (val & 0x06) == 0)
250 val = port_rd(res2, 0x506); /* XXX Out of range. */
255 bus_release_resource(dev, SYS_RES_IOPORT, rid2, res2);
256 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
259 struct sndcard_func *func;
261 /* Looks like a GUS MAX. Set the rest of the resources. */
263 bus_set_resource(dev, SYS_RES_IOPORT, 2, base + 0x10c, 8);
265 if (flags & DV_F_DUAL_DMA)
266 bus_set_resource(dev, SYS_RES_DRQ, 1,
267 flags & DV_F_DRQ_MASK, 1);
269 /* We can support the CS4231 and MIDI devices. */
271 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
274 func->func = SCF_MIDI;
275 child = device_add_child(dev, "midi", -1);
276 device_set_ivars(child, func);
278 func = kmalloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
280 kprintf("xxx: gus pcm not attached, out of memory\n");
282 func->func = SCF_PCM;
283 child = device_add_child(dev, "pcm", -1);
284 device_set_ivars(child, func);
286 device_set_desc(dev, "Gravis UltraSound MAX");
291 * TODO: Support even older GUS cards. MIDI should work on
298 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
303 gusc_attach(device_t dev)
309 scp = device_get_softc(dev);
310 unit = device_get_unit(dev);
312 bzero(scp, sizeof(*scp));
315 if (alloc_resource(scp)) {
316 release_resource(scp);
320 if (scp->irq != NULL) {
321 bus_setup_intr(dev, scp->irq, 0, gusc_intr, scp, &ih, NULL);
323 bus_generic_attach(dev);
329 * Handle interrupts on GUS devices until there aren't any left.
334 sc_p scp = (sc_p)arg;
339 if (scp->pcm_intr.intr != NULL &&
340 (port_rd(scp->io[2], 2) & 1)) {
341 (*scp->pcm_intr.intr)(scp->pcm_intr.arg);
344 if (scp->midi_intr.intr != NULL &&
345 (port_rd(scp->io[1], 0) & 0x80)) {
346 (*scp->midi_intr.intr)(scp->midi_intr.arg);
349 } while (did_something != 0);
352 static struct resource *
353 gusc_alloc_resource(device_t bus, device_t child, int type, int *rid,
354 u_long start, u_long end, u_long count, u_int flags)
357 int *alloced, rid_max, alloced_max;
358 struct resource **res;
360 scp = device_get_softc(bus);
363 alloced = scp->io_alloced;
366 alloced_max = 2; /* pcm + midi (more to include synth) */
369 alloced = &scp->irq_alloced;
372 alloced_max = 2; /* pcm and midi share the single irq. */
375 alloced = scp->drq_alloced;
384 if (*rid > rid_max || alloced[*rid] == alloced_max)
392 gusc_release_resource(device_t bus, device_t child, int type, int rid,
396 int *alloced, rid_max;
398 scp = device_get_softc(bus);
401 alloced = scp->io_alloced;
405 alloced = &scp->irq_alloced;
409 alloced = scp->drq_alloced;
416 if (rid > rid_max || alloced[rid] == 0)
424 gusc_setup_intr(device_t dev, device_t child, struct resource *irq,
425 int flags, driver_intr_t *intr, void *arg,
426 void **cookiep, lwkt_serialize_t serializer)
428 sc_p scp = (sc_p)device_get_softc(dev);
431 devclass = device_get_devclass(child);
432 if (strcmp(devclass_get_name(devclass), "midi") == 0) {
433 scp->midi_intr.intr = intr;
434 scp->midi_intr.arg = arg;
436 } else if (strcmp(devclass_get_name(devclass), "pcm") == 0) {
437 scp->pcm_intr.intr = intr;
438 scp->pcm_intr.arg = arg;
441 return bus_generic_setup_intr(dev, child, irq, flags, intr,
442 arg, cookiep, serializer);
446 find_masterdev(sc_p scp)
452 devclass = device_get_devclass(scp->dev);
453 units = devclass_get_maxunit(devclass);
455 for (i = 0 ; i < units ; i++) {
456 dev = devclass_get_device(devclass, i);
457 if (isa_get_vendorid(dev) == isa_get_vendorid(scp->dev)
458 && isa_get_logicalid(dev) == LOGICALID_PCM
459 && isa_get_serial(dev) == isa_get_serial(scp->dev))
468 static int io_range[3] = {0x10, 0x8 , 0x4 };
469 static int io_offset[3] = {0x0 , 0x100, 0x10c};
471 alloc_resource(sc_p scp)
473 int i, base, lid, flags;
477 if (isa_get_vendorid(scp->dev))
478 lid = isa_get_logicalid(scp->dev);
480 lid = LOGICALID_NOPNP;
481 flags = device_get_flags(scp->dev);
485 case LOGICALID_NOPNP: /* XXX Non-PnP */
486 if (lid == LOGICALID_NOPNP)
487 base = isa_get_port(scp->dev);
490 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) {
491 if (scp->io[i] == NULL) {
494 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
495 0, ~0, io_range[i], RF_ACTIVE);
497 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
499 base + io_offset[i] + io_range[i] - 1
500 , io_range[i], RF_ACTIVE);
501 if (scp->io[i] == NULL)
503 scp->io_alloced[i] = 0;
506 if (scp->irq == NULL) {
508 scp->irq = bus_alloc_resource(scp->dev, SYS_RES_IRQ, &scp->irq_rid,
509 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
510 if (scp->irq == NULL)
512 scp->irq_alloced = 0;
514 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) {
515 if (scp->drq[i] == NULL) {
517 if (base == 0 || i == 0)
518 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i],
519 0, ~0, 1, RF_ACTIVE);
520 else if ((flags & DV_F_DUAL_DMA) != 0)
521 /* XXX The secondary drq is specified in the flag. */
522 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i],
523 flags & DV_F_DRQ_MASK,
524 flags & DV_F_DRQ_MASK, 1, RF_ACTIVE);
525 if (scp->drq[i] == NULL)
527 scp->drq_alloced[i] = 0;
532 if (scp->io[0] == NULL) {
534 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0],
535 0, ~0, io_range[0], RF_ACTIVE);
536 if (scp->io[0] == NULL)
538 scp->io_alloced[0] = 0;
542 if (scp->io[0] == NULL) {
544 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0],
545 0, ~0, io_range[0], RF_ACTIVE);
546 if (scp->io[0] == NULL)
548 scp->io_alloced[0] = 0;
550 if (scp->irq == NULL) {
551 /* The irq is shared with pcm audio. */
552 dev = find_masterdev(scp);
556 scp->irq = BUS_ALLOC_RESOURCE(dev, NULL, SYS_RES_IRQ, &scp->irq_rid,
557 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
558 if (scp->irq == NULL)
560 scp->irq_alloced = 0;
568 release_resource(sc_p scp)
574 if (isa_get_vendorid(scp->dev))
575 lid = isa_get_logicalid(scp->dev);
577 lid = LOGICALID_NOPNP;
578 flags = device_get_flags(scp->dev);
582 case LOGICALID_NOPNP: /* XXX Non-PnP */
583 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) {
584 if (scp->io[i] != NULL) {
585 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
589 if (scp->irq != NULL) {
590 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid, scp->irq);
593 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) {
594 if (scp->drq[i] != NULL) {
595 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
601 if (scp->io[0] != NULL) {
602 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
607 if (scp->io[0] != NULL) {
608 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
611 if (scp->irq != NULL) {
612 /* The irq is shared with pcm audio. */
613 dev = find_masterdev(scp);
616 BUS_RELEASE_RESOURCE(dev, NULL, SYS_RES_IOPORT, scp->irq_rid, scp->irq);
624 static device_method_t gusc_methods[] = {
625 /* Device interface */
626 DEVMETHOD(device_probe, gusc_probe),
627 DEVMETHOD(device_attach, gusc_attach),
628 DEVMETHOD(device_detach, bus_generic_detach),
629 DEVMETHOD(device_shutdown, bus_generic_shutdown),
630 DEVMETHOD(device_suspend, bus_generic_suspend),
631 DEVMETHOD(device_resume, bus_generic_resume),
634 DEVMETHOD(bus_print_child, bus_generic_print_child),
635 DEVMETHOD(bus_alloc_resource, gusc_alloc_resource),
636 DEVMETHOD(bus_release_resource, gusc_release_resource),
637 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
638 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
639 DEVMETHOD(bus_setup_intr, gusc_setup_intr),
640 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
645 static driver_t gusc_driver = {
648 sizeof(struct gusc_softc),
652 * gusc can be attached to an isa bus.
654 DRIVER_MODULE(snd_gusc, isa, gusc_driver, gusc_devclass, 0, 0);
655 MODULE_DEPEND(snd_gusc, snd_pcm, PCM_MINVER, PCM_PREFVER, PCM_MAXVER);
656 MODULE_VERSION(snd_gusc, 1);