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
28 #include <sys/param.h>
29 #include <sys/systm.h>
30 #include <sys/kernel.h>
32 #include <sys/malloc.h>
33 #include <sys/module.h>
34 #include <machine/resource.h>
35 #include <machine/bus.h>
38 #ifdef HAVE_KERNEL_OPTION_HEADERS
42 #include <dev/sound/pcm/sound.h>
43 #include <dev/sound/chip.h>
46 #include <isa/isavar.h>
47 #include <isa/isa_common.h>
49 SND_DECLARE_FILE("$FreeBSD$");
51 #define LOGICALID_NOPNP 0
52 #define LOGICALID_PCM 0x0000561e
53 #define LOGICALID_OPL 0x0300561e
54 #define LOGICALID_MIDI 0x0400561e
57 static struct isa_pnp_id gusc_ids[] = {
58 {LOGICALID_PCM, "GRV0000 Gravis UltraSound PnP PCM"}, /* GRV0000 */
59 {LOGICALID_OPL, "GRV0003 Gravis UltraSound PnP OPL"}, /* GRV0003 */
60 {LOGICALID_MIDI, "GRV0004 Gravis UltraSound PnP MIDI"}, /* GRV0004 */
63 /* Interrupt handler. */
64 struct gusc_ihandler {
69 /* Here is the parameter structure per a device. */
71 device_t dev; /* device */
72 int io_rid[3]; /* io port rids */
73 struct resource *io[3]; /* io port resources */
74 int io_alloced[3]; /* io port alloc flag */
75 int irq_rid; /* irq rids */
76 struct resource *irq; /* irq resources */
77 int irq_alloced; /* irq alloc flag */
78 int drq_rid[2]; /* drq rids */
79 struct resource *drq[2]; /* drq resources */
80 int drq_alloced[2]; /* drq alloc flag */
82 /* Interrupts are shared (XXX non-PnP only?) */
83 struct gusc_ihandler midi_intr;
84 struct gusc_ihandler pcm_intr;
87 typedef struct gusc_softc *sc_p;
89 static int gusc_probe(device_t dev);
90 static int gusc_attach(device_t dev);
91 static int gusisa_probe(device_t dev);
92 static void gusc_intr(void *);
93 static struct resource *gusc_alloc_resource(device_t bus, device_t child, int type, int *rid,
94 u_long start, u_long end, u_long count, u_int flags);
95 static int gusc_release_resource(device_t bus, device_t child, int type, int rid,
98 static device_t find_masterdev(sc_p scp);
99 static int alloc_resource(sc_p scp);
100 static int release_resource(sc_p scp);
102 static devclass_t gusc_devclass;
105 gusc_probe(device_t dev)
108 u_int32_t logical_id;
110 struct sndcard_func *func;
113 logical_id = isa_get_logicalid(dev);
116 /* Check isapnp ids */
117 if (logical_id != 0 && (ret = ISA_PNP_PROBE(device_get_parent(dev), dev, gusc_ids)) != 0)
121 return gusisa_probe(dev);
124 switch (logical_id) {
126 s = "Gravis UltraSound Plug & Play PCM";
127 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
130 func->func = SCF_PCM;
131 child = device_add_child(dev, "pcm", -1);
132 device_set_ivars(child, func);
135 s = "Gravis UltraSound Plug & Play OPL";
136 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
139 func->func = SCF_SYNTH;
140 child = device_add_child(dev, "midi", -1);
141 device_set_ivars(child, func);
144 s = "Gravis UltraSound Plug & Play MIDI";
145 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
148 func->func = SCF_MIDI;
149 child = device_add_child(dev, "midi", -1);
150 device_set_ivars(child, func);
155 device_set_desc(dev, s);
163 port_wr(struct resource *r, int i, unsigned char v)
165 bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), i, v);
169 port_rd(struct resource *r, int i)
171 return bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), i);
175 * Probe for an old (non-PnP) GUS card on the ISA bus.
179 gusisa_probe(device_t dev)
182 struct resource *res, *res2;
183 int base, rid, rid2, s, flags;
186 base = isa_get_port(dev);
187 flags = device_get_flags(dev);
189 res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, base + 0x100,
190 base + 0x107, 8, RF_ACTIVE);
198 * Check for the presence of some GUS card. Reset the card,
199 * then see if we can access the memory on it.
202 port_wr(res, 3, 0x4c);
206 port_wr(res, 3, 0x4c);
214 port_wr(res, 3, 0x43); /* Register select */
215 port_wr(res, 4, 0); /* Low addr */
216 port_wr(res, 5, 0); /* Med addr */
218 port_wr(res, 3, 0x44); /* Register select */
219 port_wr(res, 4, 0); /* High addr */
220 port_wr(res, 7, 0x55); /* DRAM */
222 /* Read from DRAM. */
224 port_wr(res, 3, 0x43); /* Register select */
225 port_wr(res, 4, 0); /* Low addr */
226 port_wr(res, 5, 0); /* Med addr */
228 port_wr(res, 3, 0x44); /* Register select */
229 port_wr(res, 4, 0); /* High addr */
230 val = port_rd(res, 7); /* DRAM */
238 res2 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid2, base, base, 1,
245 port_wr(res2, 0x0f, 0x20);
246 val = port_rd(res2, 0x0f);
249 if (val == 0xff || (val & 0x06) == 0)
252 val = port_rd(res2, 0x506); /* XXX Out of range. */
257 bus_release_resource(dev, SYS_RES_IOPORT, rid2, res2);
258 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
261 struct sndcard_func *func;
263 /* Looks like a GUS MAX. Set the rest of the resources. */
265 bus_set_resource(dev, SYS_RES_IOPORT, 2, base + 0x10c, 8);
267 if (flags & DV_F_DUAL_DMA)
268 bus_set_resource(dev, SYS_RES_DRQ, 1,
269 flags & DV_F_DRQ_MASK, 1);
271 /* We can support the CS4231 and MIDI devices. */
273 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
276 func->func = SCF_MIDI;
277 child = device_add_child(dev, "midi", -1);
278 device_set_ivars(child, func);
280 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT | M_ZERO);
282 printf("xxx: gus pcm not attached, out of memory\n");
284 func->func = SCF_PCM;
285 child = device_add_child(dev, "pcm", -1);
286 device_set_ivars(child, func);
288 device_set_desc(dev, "Gravis UltraSound MAX");
293 * TODO: Support even older GUS cards. MIDI should work on
300 bus_release_resource(dev, SYS_RES_IOPORT, rid, res);
305 gusc_attach(device_t dev)
310 scp = device_get_softc(dev);
312 bzero(scp, sizeof(*scp));
315 if (alloc_resource(scp)) {
316 release_resource(scp);
320 if (scp->irq != NULL)
321 snd_setup_intr(dev, scp->irq, 0, gusc_intr, scp, &ih);
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, int flags,
424 #if __FreeBSD_version >= 700031
425 driver_filter_t *filter,
427 driver_intr_t *intr, void *arg, void **cookiep)
429 sc_p scp = (sc_p)device_get_softc(dev);
432 #if __FreeBSD_version >= 700031
433 if (filter != NULL) {
434 printf("gusc.c: we cannot use a filter here\n");
438 devclass = device_get_devclass(child);
439 if (strcmp(devclass_get_name(devclass), "midi") == 0) {
440 scp->midi_intr.intr = intr;
441 scp->midi_intr.arg = arg;
443 } else if (strcmp(devclass_get_name(devclass), "pcm") == 0) {
444 scp->pcm_intr.intr = intr;
445 scp->pcm_intr.arg = arg;
448 return bus_generic_setup_intr(dev, child, irq, flags,
449 #if __FreeBSD_version >= 700031
456 find_masterdev(sc_p scp)
462 devclass = device_get_devclass(scp->dev);
463 units = devclass_get_maxunit(devclass);
465 for (i = 0 ; i < units ; i++) {
466 dev = devclass_get_device(devclass, i);
467 if (isa_get_vendorid(dev) == isa_get_vendorid(scp->dev)
468 && isa_get_logicalid(dev) == LOGICALID_PCM
469 && isa_get_serial(dev) == isa_get_serial(scp->dev))
478 static int io_range[3] = {0x10, 0x8 , 0x4 };
479 static int io_offset[3] = {0x0 , 0x100, 0x10c};
481 alloc_resource(sc_p scp)
483 int i, base, lid, flags;
487 if (isa_get_vendorid(scp->dev))
488 lid = isa_get_logicalid(scp->dev);
490 lid = LOGICALID_NOPNP;
491 flags = device_get_flags(scp->dev);
495 case LOGICALID_NOPNP: /* XXX Non-PnP */
496 if (lid == LOGICALID_NOPNP)
497 base = isa_get_port(scp->dev);
500 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) {
501 if (scp->io[i] == NULL) {
504 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
505 0, ~0, io_range[i], RF_ACTIVE);
507 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i],
509 base + io_offset[i] + io_range[i] - 1
510 , io_range[i], RF_ACTIVE);
511 if (scp->io[i] == NULL)
513 scp->io_alloced[i] = 0;
516 if (scp->irq == NULL) {
519 bus_alloc_resource_any(scp->dev, SYS_RES_IRQ,
521 RF_ACTIVE|RF_SHAREABLE);
522 if (scp->irq == NULL)
524 scp->irq_alloced = 0;
526 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) {
527 if (scp->drq[i] == NULL) {
529 if (base == 0 || i == 0)
531 bus_alloc_resource_any(
532 scp->dev, SYS_RES_DRQ,
535 else if ((flags & DV_F_DUAL_DMA) != 0)
536 /* XXX The secondary drq is specified in the flag. */
537 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i],
538 flags & DV_F_DRQ_MASK,
539 flags & DV_F_DRQ_MASK, 1, RF_ACTIVE);
540 if (scp->drq[i] == NULL)
542 scp->drq_alloced[i] = 0;
547 if (scp->io[0] == NULL) {
549 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0],
550 0, ~0, io_range[0], RF_ACTIVE);
551 if (scp->io[0] == NULL)
553 scp->io_alloced[0] = 0;
557 if (scp->io[0] == NULL) {
559 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0],
560 0, ~0, io_range[0], RF_ACTIVE);
561 if (scp->io[0] == NULL)
563 scp->io_alloced[0] = 0;
565 if (scp->irq == NULL) {
566 /* The irq is shared with pcm audio. */
567 dev = find_masterdev(scp);
571 scp->irq = BUS_ALLOC_RESOURCE(dev, NULL, SYS_RES_IRQ, &scp->irq_rid,
572 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE);
573 if (scp->irq == NULL)
575 scp->irq_alloced = 0;
583 release_resource(sc_p scp)
588 if (isa_get_vendorid(scp->dev))
589 lid = isa_get_logicalid(scp->dev);
591 lid = LOGICALID_NOPNP;
595 case LOGICALID_NOPNP: /* XXX Non-PnP */
596 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) {
597 if (scp->io[i] != NULL) {
598 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]);
602 if (scp->irq != NULL) {
603 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid, scp->irq);
606 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) {
607 if (scp->drq[i] != NULL) {
608 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]);
614 if (scp->io[0] != NULL) {
615 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
620 if (scp->io[0] != NULL) {
621 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]);
624 if (scp->irq != NULL) {
625 /* The irq is shared with pcm audio. */
626 dev = find_masterdev(scp);
629 BUS_RELEASE_RESOURCE(dev, NULL, SYS_RES_IOPORT, scp->irq_rid, scp->irq);
637 static device_method_t gusc_methods[] = {
638 /* Device interface */
639 DEVMETHOD(device_probe, gusc_probe),
640 DEVMETHOD(device_attach, gusc_attach),
641 DEVMETHOD(device_detach, bus_generic_detach),
642 DEVMETHOD(device_shutdown, bus_generic_shutdown),
643 DEVMETHOD(device_suspend, bus_generic_suspend),
644 DEVMETHOD(device_resume, bus_generic_resume),
647 DEVMETHOD(bus_alloc_resource, gusc_alloc_resource),
648 DEVMETHOD(bus_release_resource, gusc_release_resource),
649 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource),
650 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource),
651 DEVMETHOD(bus_setup_intr, gusc_setup_intr),
652 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr),
657 static driver_t gusc_driver = {
660 sizeof(struct gusc_softc),
664 * gusc can be attached to an isa bus.
666 DRIVER_MODULE(snd_gusc, isa, gusc_driver, gusc_devclass, 0, 0);
667 DRIVER_MODULE(snd_gusc, acpi, gusc_driver, gusc_devclass, 0, 0);
668 MODULE_DEPEND(snd_gusc, sound, SOUND_MINVER, SOUND_PREFVER, SOUND_MAXVER);
669 MODULE_VERSION(snd_gusc, 1);