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.16 2005/01/06 01:43:17 imp Exp $
28 * $DragonFly: src/sys/dev/sound/isa/gusc.c,v 1.11 2007/01/04 21:47:02 corecode 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.11 2007/01/04 21:47:02 corecode 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, INTR_TYPE_AV, gusc_intr, scp, &ih, NULL);
322 bus_generic_attach(dev);
328 * Handle interrupts on GUS devices until there aren't any left.
333 sc_p scp = (sc_p)arg;
338 if (scp->pcm_intr.intr != NULL &&
339 (port_rd(scp->io[2], 2) & 1)) {
340 (*scp->pcm_intr.intr)(scp->pcm_intr.arg);
343 if (scp->midi_intr.intr != NULL &&
344 (port_rd(scp->io[1], 0) & 0x80)) {
345 (*scp->midi_intr.intr)(scp->midi_intr.arg);
348 } while (did_something != 0);
351 static struct resource *
352 gusc_alloc_resource(device_t bus, device_t child, int type, int *rid,
353 u_long start, u_long end, u_long count, u_int flags)
356 int *alloced, rid_max, alloced_max;
357 struct resource **res;
359 scp = device_get_softc(bus);
362 alloced = scp->io_alloced;
365 alloced_max = 2; /* pcm + midi (more to include synth) */
368 alloced = &scp->irq_alloced;
371 alloced_max = 2; /* pcm and midi share the single irq. */
374 alloced = scp->drq_alloced;
383 if (*rid > rid_max || alloced[*rid] == alloced_max)
391 gusc_release_resource(device_t bus, device_t child, int type, int rid,
395 int *alloced, rid_max;
397 scp = device_get_softc(bus);
400 alloced = scp->io_alloced;
404 alloced = &scp->irq_alloced;
408 alloced = scp->drq_alloced;
415 if (rid > rid_max || alloced[rid] == 0)
423 gusc_setup_intr(device_t dev, device_t child, struct resource *irq,
424 int flags, driver_intr_t *intr, void *arg, void **cookiep)
426 sc_p scp = (sc_p)device_get_softc(dev);
429 devclass = device_get_devclass(child);
430 if (strcmp(devclass_get_name(devclass), "midi") == 0) {
431 scp->midi_intr.intr = intr;
432 scp->midi_intr.arg = arg;
434 } else if (strcmp(devclass_get_name(devclass), "pcm") == 0) {
435 scp->pcm_intr.intr = intr;
436 scp->pcm_intr.arg = arg;
439 return bus_generic_setup_intr(dev, child, irq, flags, intr,
444 find_masterdev(sc_p scp)
450 devclass = device_get_devclass(scp->dev);
451 units = devclass_get_maxunit(devclass);
453 for (i = 0 ; i < units ; i++) {
454 dev = devclass_get_device(devclass, i);
455 if (isa_get_vendorid(dev) == isa_get_vendorid(scp->dev)
456 && isa_get_logicalid(dev) == LOGICALID_PCM
457 && isa_get_serial(dev) == isa_get_serial(scp->dev))
466 static int io_range[3] = {0x10, 0x8 , 0x4 };
467 static int io_offset[3] = {0x0 , 0x100, 0x10c};
469 alloc_resource(sc_p scp)
471 int i, base, lid, flags;
475 if (isa_get_vendorid(scp->dev))
476 lid = isa_get_logicalid(scp->dev);
478 lid = LOGICALID_NOPNP;
479 flags = device_get_flags(scp->dev);
483 case LOGICALID_NOPNP: /* XXX Non-PnP */
484 if (lid == LOGICALID_NOPNP)
485 base = isa_get_port(scp->dev);
488 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) {
489 if (scp->io[i] == NULL) {
492 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
493 0, ~0, io_range[i], RF_ACTIVE);
495 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
497 base + io_offset[i] + io_range[i] - 1
498 , io_range[i], RF_ACTIVE);
499 if (scp->io[i] == NULL)
501 scp->io_alloced[i] = 0;
504 if (scp->irq == NULL) {
507 bus_alloc_resource_any(scp->dev, SYS_RES_IRQ,
509 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)
519 bus_alloc_resource_any(
520 scp->dev, SYS_RES_DRQ,
523 else if ((flags & DV_F_DUAL_DMA) != 0)
524 /* XXX The secondary drq is specified in the flag. */
525 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i],
526 flags & DV_F_DRQ_MASK,
527 flags & DV_F_DRQ_MASK, 1, RF_ACTIVE);
528 if (scp->drq[i] == NULL)
530 scp->drq_alloced[i] = 0;
535 if (scp->io[0] == NULL) {
537 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0],
538 0, ~0, io_range[0], RF_ACTIVE);
539 if (scp->io[0] == NULL)
541 scp->io_alloced[0] = 0;
545 if (scp->io[0] == NULL) {
547 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0],
548 0, ~0, io_range[0], RF_ACTIVE);
549 if (scp->io[0] == NULL)
551 scp->io_alloced[0] = 0;
553 if (scp->irq == NULL) {
554 /* The irq is shared with pcm audio. */
555 dev = find_masterdev(scp);
559 scp->irq = BUS_ALLOC_RESOURCE(dev, NULL, SYS_RES_IRQ, &scp->irq_rid,
560 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
561 if (scp->irq == NULL)
563 scp->irq_alloced = 0;
571 release_resource(sc_p scp)
577 if (isa_get_vendorid(scp->dev))
578 lid = isa_get_logicalid(scp->dev);
580 lid = LOGICALID_NOPNP;
581 flags = device_get_flags(scp->dev);
585 case LOGICALID_NOPNP: /* XXX Non-PnP */
586 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) {
587 if (scp->io[i] != NULL) {
588 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
592 if (scp->irq != NULL) {
593 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid, scp->irq);
596 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) {
597 if (scp->drq[i] != NULL) {
598 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
604 if (scp->io[0] != NULL) {
605 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
610 if (scp->io[0] != NULL) {
611 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
614 if (scp->irq != NULL) {
615 /* The irq is shared with pcm audio. */
616 dev = find_masterdev(scp);
619 BUS_RELEASE_RESOURCE(dev, NULL, SYS_RES_IOPORT, scp->irq_rid, scp->irq);
627 static device_method_t gusc_methods[] = {
628 /* Device interface */
629 DEVMETHOD(device_probe, gusc_probe),
630 DEVMETHOD(device_attach, gusc_attach),
631 DEVMETHOD(device_detach, bus_generic_detach),
632 DEVMETHOD(device_shutdown, bus_generic_shutdown),
633 DEVMETHOD(device_suspend, bus_generic_suspend),
634 DEVMETHOD(device_resume, bus_generic_resume),
637 DEVMETHOD(bus_print_child, bus_generic_print_child),
638 DEVMETHOD(bus_alloc_resource, gusc_alloc_resource),
639 DEVMETHOD(bus_release_resource, gusc_release_resource),
640 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
641 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
642 DEVMETHOD(bus_setup_intr, gusc_setup_intr),
643 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
648 static driver_t gusc_driver = {
651 sizeof(struct gusc_softc),
655 * gusc can be attached to an isa bus.
657 DRIVER_MODULE(snd_gusc, isa, gusc_driver, gusc_devclass, 0, 0);
658 DRIVER_MODULE(snd_gusc, acpi, gusc_driver, gusc_devclass, 0, 0);
659 MODULE_DEPEND(snd_gusc, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
660 MODULE_VERSION(snd_gusc, 1);