gusc.c revision 67164
1/*- 2 * Copyright (c) 1999 Seigo Tanimura 3 * Copyright (c) 1999 Ville-Pertti Keinonen 4 * All rights reserved. 5 * 6 * Redistribution and use in source and binary forms, with or without 7 * modification, are permitted provided that the following conditions 8 * are met: 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. 14 * 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 25 * SUCH DAMAGE. 26 * 27 * $FreeBSD: head/sys/dev/sound/isa/gusc.c 67164 2000-10-15 14:19:01Z phk $ 28 */ 29 30#include <sys/param.h> 31#include <sys/systm.h> 32#include <sys/kernel.h> 33#include <sys/bus.h> 34#include <sys/malloc.h> 35#include <sys/module.h> 36#include <machine/resource.h> 37#include <machine/bus.h> 38#include <sys/rman.h> 39#include <sys/soundcard.h> 40#include <dev/sound/pcm/sound.h> 41#include <dev/sound/chip.h> 42#include "bus_if.h" 43 44#include <isa/isavar.h> 45#include <isa/isa_common.h> 46#ifdef __alpha__ /* XXX workaround a stupid warning */ 47#include <alpha/isa/isavar.h> 48#endif 49 50#define LOGICALID_NOPNP 0 51#define LOGICALID_PCM 0x0000561e 52#define LOGICALID_OPL 0x0300561e 53#define LOGICALID_MIDI 0x0400561e 54 55/* PnP IDs */ 56static struct isa_pnp_id gusc_ids[] = { 57 {LOGICALID_PCM, "GRV0000 Gravis UltraSound PnP PCM"}, /* GRV0000 */ 58 {LOGICALID_OPL, "GRV0003 Gravis UltraSound PnP OPL"}, /* GRV0003 */ 59 {LOGICALID_MIDI, "GRV0004 Gravis UltraSound PnP MIDI"}, /* GRV0004 */ 60}; 61 62/* Interrupt handler. */ 63struct gusc_ihandler { 64 void (*intr)(void *); 65 void *arg; 66}; 67 68/* Here is the parameter structure per a device. */ 69struct gusc_softc { 70 device_t dev; /* device */ 71 int io_rid[3]; /* io port rids */ 72 struct resource *io[3]; /* io port resources */ 73 int io_alloced[3]; /* io port alloc flag */ 74 int irq_rid; /* irq rids */ 75 struct resource *irq; /* irq resources */ 76 int irq_alloced; /* irq alloc flag */ 77 int drq_rid[2]; /* drq rids */ 78 struct resource *drq[2]; /* drq resources */ 79 int drq_alloced[2]; /* drq alloc flag */ 80 81 /* Interrupts are shared (XXX non-PnP only?) */ 82 struct gusc_ihandler midi_intr; 83 struct gusc_ihandler pcm_intr; 84}; 85 86typedef struct gusc_softc *sc_p; 87 88static int gusc_probe(device_t dev); 89static int gusc_attach(device_t dev); 90static int gusisa_probe(device_t dev); 91static void gusc_intr(void *); 92static struct resource *gusc_alloc_resource(device_t bus, device_t child, int type, int *rid, 93 u_long start, u_long end, u_long count, u_int flags); 94static int gusc_release_resource(device_t bus, device_t child, int type, int rid, 95 struct resource *r); 96 97static device_t find_masterdev(sc_p scp); 98static int alloc_resource(sc_p scp); 99static int release_resource(sc_p scp); 100 101static devclass_t gusc_devclass; 102 103static int 104gusc_probe(device_t dev) 105{ 106 device_t child; 107 u_int32_t logical_id; 108 char *s; 109 struct sndcard_func *func; 110 int ret; 111 112 logical_id = isa_get_logicalid(dev); 113 s = NULL; 114 115 /* Check isapnp ids */ 116 if (logical_id != 0 && (ret = ISA_PNP_PROBE(device_get_parent(dev), dev, gusc_ids)) != 0) 117 return (ret); 118 else { 119 if (logical_id == 0) 120 return gusisa_probe(dev); 121 } 122 123 switch (logical_id) { 124 case LOGICALID_PCM: 125 s = "Gravis UltraSound Plug & Play PCM"; 126 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 127 if (func == NULL) 128 return (ENOMEM); 129 bzero(func, sizeof(*func)); 130 func->func = SCF_PCM; 131 child = device_add_child(dev, "pcm", -1); 132 device_set_ivars(child, func); 133 break; 134 case LOGICALID_OPL: 135 s = "Gravis UltraSound Plug & Play OPL"; 136 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 137 if (func == NULL) 138 return (ENOMEM); 139 bzero(func, sizeof(*func)); 140 func->func = SCF_SYNTH; 141 child = device_add_child(dev, "midi", -1); 142 device_set_ivars(child, func); 143 break; 144 case LOGICALID_MIDI: 145 s = "Gravis UltraSound Plug & Play MIDI"; 146 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 147 if (func == NULL) 148 return (ENOMEM); 149 bzero(func, sizeof(*func)); 150 func->func = SCF_MIDI; 151 child = device_add_child(dev, "midi", -1); 152 device_set_ivars(child, func); 153 break; 154 } 155 156 if (s != NULL) { 157 device_set_desc(dev, s); 158 return (0); 159 } 160 161 return (ENXIO); 162} 163 164static void 165port_wr(struct resource *r, int i, unsigned char v) 166{ 167 bus_space_write_1(rman_get_bustag(r), rman_get_bushandle(r), i, v); 168} 169 170static int 171port_rd(struct resource *r, int i) 172{ 173 return bus_space_read_1(rman_get_bustag(r), rman_get_bushandle(r), i); 174} 175 176/* 177 * Probe for an old (non-PnP) GUS card on the ISA bus. 178 */ 179 180static int 181gusisa_probe(device_t dev) 182{ 183 device_t child; 184 struct resource *res, *res2; 185 int base, rid, rid2, s, flags; 186 unsigned char val; 187 188 base = isa_get_port(dev); 189 flags = device_get_flags(dev); 190 rid = 1; 191 res = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, base + 0x100, 192 base + 0x107, 8, RF_ACTIVE); 193 194 if (res == NULL) 195 return ENXIO; 196 197 res2 = NULL; 198 199 /* 200 * Check for the presence of some GUS card. Reset the card, 201 * then see if we can access the memory on it. 202 */ 203 204 port_wr(res, 3, 0x4c); 205 port_wr(res, 5, 0); 206 DELAY(30 * 1000); 207 208 port_wr(res, 3, 0x4c); 209 port_wr(res, 5, 1); 210 DELAY(30 * 1000); 211 212 s = splhigh(); 213 214 /* Write to DRAM. */ 215 216 port_wr(res, 3, 0x43); /* Register select */ 217 port_wr(res, 4, 0); /* Low addr */ 218 port_wr(res, 5, 0); /* Med addr */ 219 220 port_wr(res, 3, 0x44); /* Register select */ 221 port_wr(res, 4, 0); /* High addr */ 222 port_wr(res, 7, 0x55); /* DRAM */ 223 224 /* Read from DRAM. */ 225 226 port_wr(res, 3, 0x43); /* Register select */ 227 port_wr(res, 4, 0); /* Low addr */ 228 port_wr(res, 5, 0); /* Med addr */ 229 230 port_wr(res, 3, 0x44); /* Register select */ 231 port_wr(res, 4, 0); /* High addr */ 232 val = port_rd(res, 7); /* DRAM */ 233 234 splx(s); 235 236 if (val != 0x55) 237 goto fail; 238 239 rid2 = 0; 240 res2 = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid2, base, base, 1, 241 RF_ACTIVE); 242 243 if (res2 == NULL) 244 goto fail; 245 246 s = splhigh(); 247 port_wr(res2, 0x0f, 0x20); 248 val = port_rd(res2, 0x0f); 249 splx(s); 250 251 if (val == 0xff || (val & 0x06) == 0) 252 val = 0; 253 else { 254 val = port_rd(res2, 0x506); /* XXX Out of range. */ 255 if (val == 0xff) 256 val = 0; 257 } 258 259 bus_release_resource(dev, SYS_RES_IOPORT, rid2, res2); 260 bus_release_resource(dev, SYS_RES_IOPORT, rid, res); 261 262 if (val >= 10) { 263 struct sndcard_func *func; 264 265 /* Looks like a GUS MAX. Set the rest of the resources. */ 266 267 bus_set_resource(dev, SYS_RES_IOPORT, 2, base + 0x10c, 8); 268 269 if (flags & DV_F_DUAL_DMA) 270 bus_set_resource(dev, SYS_RES_DRQ, 1, 271 flags & DV_F_DRQ_MASK, 1); 272 273 /* We can support the CS4231 and MIDI devices. */ 274 275 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 276 if (func == NULL) 277 return ENOMEM; 278 bzero(func, sizeof *func); 279 func->func = SCF_MIDI; 280 child = device_add_child(dev, "midi", -1); 281 device_set_ivars(child, func); 282 283 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 284 if (func == NULL) 285 printf("xxx: gus pcm not attached, out of memory\n"); 286 else { 287 bzero(func, sizeof *func); 288 func->func = SCF_PCM; 289 child = device_add_child(dev, "pcm", -1); 290 device_set_ivars(child, func); 291 } 292 device_set_desc(dev, "Gravis UltraSound MAX"); 293 return 0; 294 } else { 295 296 /* 297 * TODO: Support even older GUS cards. MIDI should work on 298 * all models. 299 */ 300 return ENXIO; 301 } 302 303fail: 304 bus_release_resource(dev, SYS_RES_IOPORT, rid, res); 305 return ENXIO; 306} 307 308static int 309gusc_attach(device_t dev) 310{ 311 sc_p scp; 312 int unit; 313 void *ih; 314 315 scp = device_get_softc(dev); 316 unit = device_get_unit(dev); 317 318 bzero(scp, sizeof(*scp)); 319 320 scp->dev = dev; 321 if (alloc_resource(scp)) { 322 release_resource(scp); 323 return (ENXIO); 324 } 325 326 if (scp->irq != NULL) 327 bus_setup_intr(dev, scp->irq, INTR_TYPE_TTY, gusc_intr, scp, &ih); 328 bus_generic_attach(dev); 329 330 return (0); 331} 332 333/* 334 * Handle interrupts on GUS devices until there aren't any left. 335 */ 336static void 337gusc_intr(void *arg) 338{ 339 sc_p scp = (sc_p)arg; 340 int did_something; 341 342 do { 343 did_something = 0; 344 if (scp->pcm_intr.intr != NULL && 345 (port_rd(scp->io[2], 2) & 1)) { 346 (*scp->pcm_intr.intr)(scp->pcm_intr.arg); 347 did_something = 1; 348 } 349 if (scp->midi_intr.intr != NULL && 350 (port_rd(scp->io[1], 0) & 0x80)) { 351 (*scp->midi_intr.intr)(scp->midi_intr.arg); 352 did_something = 1; 353 } 354 } while (did_something != 0); 355} 356 357static struct resource * 358gusc_alloc_resource(device_t bus, device_t child, int type, int *rid, 359 u_long start, u_long end, u_long count, u_int flags) 360{ 361 sc_p scp; 362 int *alloced, rid_max, alloced_max; 363 struct resource **res; 364 365 scp = device_get_softc(bus); 366 switch (type) { 367 case SYS_RES_IOPORT: 368 alloced = scp->io_alloced; 369 res = scp->io; 370 rid_max = 2; 371 alloced_max = 2; /* pcm + midi (more to include synth) */ 372 break; 373 case SYS_RES_IRQ: 374 alloced = &scp->irq_alloced; 375 res = &scp->irq; 376 rid_max = 0; 377 alloced_max = 2; /* pcm and midi share the single irq. */ 378 break; 379 case SYS_RES_DRQ: 380 alloced = scp->drq_alloced; 381 res = scp->drq; 382 rid_max = 1; 383 alloced_max = 1; 384 break; 385 default: 386 return (NULL); 387 } 388 389 if (*rid > rid_max || alloced[*rid] == alloced_max) 390 return (NULL); 391 392 alloced[*rid]++; 393 return (res[*rid]); 394} 395 396static int 397gusc_release_resource(device_t bus, device_t child, int type, int rid, 398 struct resource *r) 399{ 400 sc_p scp; 401 int *alloced, rid_max; 402 403 scp = device_get_softc(bus); 404 switch (type) { 405 case SYS_RES_IOPORT: 406 alloced = scp->io_alloced; 407 rid_max = 2; 408 break; 409 case SYS_RES_IRQ: 410 alloced = &scp->irq_alloced; 411 rid_max = 0; 412 break; 413 case SYS_RES_DRQ: 414 alloced = scp->drq_alloced; 415 rid_max = 1; 416 break; 417 default: 418 return (1); 419 } 420 421 if (rid > rid_max || alloced[rid] == 0) 422 return (1); 423 424 alloced[rid]--; 425 return (0); 426} 427 428static int 429gusc_setup_intr(device_t dev, device_t child, struct resource *irq, 430 int flags, driver_intr_t *intr, void *arg, void **cookiep) 431{ 432 sc_p scp = (sc_p)device_get_softc(dev); 433 devclass_t devclass; 434 435 devclass = device_get_devclass(child); 436 if (strcmp(devclass_get_name(devclass), "midi") == 0) { 437 scp->midi_intr.intr = intr; 438 scp->midi_intr.arg = arg; 439 return 0; 440 } else if (strcmp(devclass_get_name(devclass), "pcm") == 0) { 441 scp->pcm_intr.intr = intr; 442 scp->pcm_intr.arg = arg; 443 return 0; 444 } 445 return bus_generic_setup_intr(dev, child, irq, flags, intr, 446 arg, cookiep); 447} 448 449static device_t 450find_masterdev(sc_p scp) 451{ 452 int i, units; 453 devclass_t devclass; 454 device_t dev; 455 456 devclass = device_get_devclass(scp->dev); 457 units = devclass_get_maxunit(devclass); 458 dev = NULL; 459 for (i = 0 ; i < units ; i++) { 460 dev = devclass_get_device(devclass, i); 461 if (isa_get_vendorid(dev) == isa_get_vendorid(scp->dev) 462 && isa_get_logicalid(dev) == LOGICALID_PCM 463 && isa_get_serial(dev) == isa_get_serial(scp->dev)) 464 break; 465 } 466 if (i == units) 467 return (NULL); 468 469 return (dev); 470} 471 472static int io_range[3] = {0x10, 0x8 , 0x4 }; 473static int io_offset[3] = {0x0 , 0x100, 0x10c}; 474static int 475alloc_resource(sc_p scp) 476{ 477 int i, base, lid, flags; 478 device_t dev; 479 480 flags = 0; 481 if (isa_get_vendorid(scp->dev)) 482 lid = isa_get_logicalid(scp->dev); 483 else { 484 lid = LOGICALID_NOPNP; 485 flags = device_get_flags(scp->dev); 486 } 487 switch(lid) { 488 case LOGICALID_PCM: 489 case LOGICALID_NOPNP: /* XXX Non-PnP */ 490 if (lid == LOGICALID_NOPNP) 491 base = isa_get_port(scp->dev); 492 else 493 base = 0; 494 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) { 495 if (scp->io[i] == NULL) { 496 scp->io_rid[i] = i; 497 if (base == 0) 498 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i], 499 0, ~0, io_range[i], RF_ACTIVE); 500 else 501 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i], 502 base + io_offset[i], 503 base + io_offset[i] + io_range[i] - 1 504 , io_range[i], RF_ACTIVE); 505 if (scp->io[i] == NULL) 506 return (1); 507 scp->io_alloced[i] = 0; 508 } 509 } 510 if (scp->irq == NULL) { 511 scp->irq_rid = 0; 512 scp->irq = bus_alloc_resource(scp->dev, SYS_RES_IRQ, &scp->irq_rid, 513 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE); 514 if (scp->irq == NULL) 515 return (1); 516 scp->irq_alloced = 0; 517 } 518 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) { 519 if (scp->drq[i] == NULL) { 520 scp->drq_rid[i] = i; 521 if (base == 0 || i == 0) 522 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i], 523 0, ~0, 1, RF_ACTIVE); 524 else if ((flags & DV_F_DUAL_DMA) != 0) 525 /* XXX The secondary drq is specified in the flag. */ 526 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i], 527 flags & DV_F_DRQ_MASK, 528 flags & DV_F_DRQ_MASK, 1, RF_ACTIVE); 529 if (scp->drq[i] == NULL) 530 return (1); 531 scp->drq_alloced[i] = 0; 532 } 533 } 534 break; 535 case LOGICALID_OPL: 536 if (scp->io[0] == NULL) { 537 scp->io_rid[0] = 0; 538 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0], 539 0, ~0, io_range[0], RF_ACTIVE); 540 if (scp->io[0] == NULL) 541 return (1); 542 scp->io_alloced[0] = 0; 543 } 544 break; 545 case LOGICALID_MIDI: 546 if (scp->io[0] == NULL) { 547 scp->io_rid[0] = 0; 548 scp->io[0] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[0], 549 0, ~0, io_range[0], RF_ACTIVE); 550 if (scp->io[0] == NULL) 551 return (1); 552 scp->io_alloced[0] = 0; 553 } 554 if (scp->irq == NULL) { 555 /* The irq is shared with pcm audio. */ 556 dev = find_masterdev(scp); 557 if (dev == NULL) 558 return (1); 559 scp->irq_rid = 0; 560 scp->irq = BUS_ALLOC_RESOURCE(dev, NULL, SYS_RES_IRQ, &scp->irq_rid, 561 0, ~0, 1, RF_ACTIVE | RF_SHAREABLE); 562 if (scp->irq == NULL) 563 return (1); 564 scp->irq_alloced = 0; 565 } 566 break; 567 } 568 return (0); 569} 570 571static int 572release_resource(sc_p scp) 573{ 574 int i, lid, flags; 575 device_t dev; 576 577 flags = 0; 578 if (isa_get_vendorid(scp->dev)) 579 lid = isa_get_logicalid(scp->dev); 580 else { 581 lid = LOGICALID_NOPNP; 582 flags = device_get_flags(scp->dev); 583 } 584 switch(lid) { 585 case LOGICALID_PCM: 586 case LOGICALID_NOPNP: /* XXX Non-PnP */ 587 for (i = 0 ; i < sizeof(scp->io) / sizeof(*scp->io) ; i++) { 588 if (scp->io[i] != NULL) { 589 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]); 590 scp->io[i] = NULL; 591 } 592 } 593 if (scp->irq != NULL) { 594 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid, scp->irq); 595 scp->irq = NULL; 596 } 597 for (i = 0 ; i < sizeof(scp->drq) / sizeof(*scp->drq) ; i++) { 598 if (scp->drq[i] != NULL) { 599 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]); 600 scp->drq[i] = NULL; 601 } 602 } 603 break; 604 case LOGICALID_OPL: 605 if (scp->io[0] != NULL) { 606 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]); 607 scp->io[0] = NULL; 608 } 609 break; 610 case LOGICALID_MIDI: 611 if (scp->io[0] != NULL) { 612 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[0], scp->io[0]); 613 scp->io[0] = NULL; 614 } 615 if (scp->irq != NULL) { 616 /* The irq is shared with pcm audio. */ 617 dev = find_masterdev(scp); 618 if (dev == NULL) 619 return (1); 620 BUS_RELEASE_RESOURCE(dev, NULL, SYS_RES_IOPORT, scp->irq_rid, scp->irq); 621 scp->irq = NULL; 622 } 623 break; 624 } 625 return (0); 626} 627 628static device_method_t gusc_methods[] = { 629 /* Device interface */ 630 DEVMETHOD(device_probe, gusc_probe), 631 DEVMETHOD(device_attach, gusc_attach), 632 DEVMETHOD(device_detach, bus_generic_detach), 633 DEVMETHOD(device_shutdown, bus_generic_shutdown), 634 DEVMETHOD(device_suspend, bus_generic_suspend), 635 DEVMETHOD(device_resume, bus_generic_resume), 636 637 /* Bus interface */ 638 DEVMETHOD(bus_print_child, bus_generic_print_child), 639 DEVMETHOD(bus_alloc_resource, gusc_alloc_resource), 640 DEVMETHOD(bus_release_resource, gusc_release_resource), 641 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 642 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 643 DEVMETHOD(bus_setup_intr, gusc_setup_intr), 644 DEVMETHOD(bus_teardown_intr, bus_generic_teardown_intr), 645 646 { 0, 0 } 647}; 648 649static driver_t gusc_driver = { 650 "gusc", 651 gusc_methods, 652 sizeof(struct gusc_softc), 653}; 654 655/* 656 * gusc can be attached to an isa bus. 657 */ 658DRIVER_MODULE(snd_gusc, isa, gusc_driver, gusc_devclass, 0, 0); 659MODULE_DEPEND(snd_gusc, snd_pcm, PCM_MINVER, PCM_PREFVER, PCM_MAXVER); 660MODULE_VERSION(snd_gusc, 1); 661 662 663