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