sbc.c revision 54846
1/*- 2 * Copyright (c) 1999 Seigo Tanimura 3 * All rights reserved. 4 * 5 * Redistribution and use in source and binary forms, with or without 6 * modification, are permitted provided that the following conditions 7 * are met: 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 14 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 15 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 16 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 17 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 18 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 19 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 20 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 21 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 22 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 23 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 24 * SUCH DAMAGE. 25 * 26 * $FreeBSD: head/sys/dev/sound/isa/sbc.c 54846 1999-12-19 22:28:31Z cg $ 27 */ 28 29#include "isa.h" 30 31#include <dev/sound/chip.h> 32#include <dev/sound/pcm/sound.h> 33#include <dev/sound/isa/sb.h> 34 35#define IO_MAX 3 36#define IRQ_MAX 1 37#define DRQ_MAX 2 38#define INTR_MAX 2 39 40struct sbc_ihl { 41 driver_intr_t *intr[INTR_MAX]; 42 void *intr_arg[INTR_MAX]; 43}; 44 45/* Here is the parameter structure per a device. */ 46struct sbc_softc { 47 device_t dev; /* device */ 48 49 int io_rid[IO_MAX]; /* io port rids */ 50 struct resource *io[IO_MAX]; /* io port resources */ 51 int io_alloced[IO_MAX]; /* io port alloc flag */ 52 53 int irq_rid[IRQ_MAX]; /* irq rids */ 54 struct resource *irq[IRQ_MAX]; /* irq resources */ 55 int irq_alloced[IRQ_MAX]; /* irq alloc flag */ 56 57 int drq_rid[DRQ_MAX]; /* drq rids */ 58 struct resource *drq[DRQ_MAX]; /* drq resources */ 59 int drq_alloced[DRQ_MAX]; /* drq alloc flag */ 60 61 struct sbc_ihl ihl[IRQ_MAX]; 62 63 void *ih; 64 65 u_int32_t bd_ver; 66}; 67 68static int sbc_probe(device_t dev); 69static int sbc_attach(device_t dev); 70static void sbc_intr(void *p); 71 72static struct resource *sbc_alloc_resource(device_t bus, device_t child, int type, int *rid, 73 u_long start, u_long end, u_long count, u_int flags); 74static int sbc_release_resource(device_t bus, device_t child, int type, int rid, 75 struct resource *r); 76static int sbc_setup_intr(device_t dev, device_t child, struct resource *irq, 77 int flags, driver_intr_t *intr, void *arg, 78 void **cookiep); 79static int sbc_teardown_intr(device_t dev, device_t child, struct resource *irq, 80 void *cookie); 81 82static int alloc_resource(struct sbc_softc *scp); 83static int release_resource(struct sbc_softc *scp); 84 85static devclass_t sbc_devclass; 86 87static int io_range[3] = {0x10, 0x2, 0x4}; 88 89static int sb_rd(struct resource *io, int reg); 90static void sb_wr(struct resource *io, int reg, u_int8_t val); 91static int sb_dspready(struct resource *io); 92static int sb_cmd(struct resource *io, u_char val); 93static u_int sb_get_byte(struct resource *io); 94static void sb_setmixer(struct resource *io, u_int port, u_int value); 95 96static int 97sb_rd(struct resource *io, int reg) 98{ 99 return bus_space_read_1(rman_get_bustag(io), 100 rman_get_bushandle(io), 101 reg); 102} 103 104static void 105sb_wr(struct resource *io, int reg, u_int8_t val) 106{ 107 return bus_space_write_1(rman_get_bustag(io), 108 rman_get_bushandle(io), 109 reg, val); 110} 111 112static int 113sb_dspready(struct resource *io) 114{ 115 return ((sb_rd(io, SBDSP_STATUS) & 0x80) == 0); 116} 117 118static int 119sb_dspwr(struct resource *io, u_char val) 120{ 121 int i; 122 123 for (i = 0; i < 1000; i++) { 124 if (sb_dspready(io)) { 125 sb_wr(io, SBDSP_CMD, val); 126 return 1; 127 } 128 if (i > 10) DELAY((i > 100)? 1000 : 10); 129 } 130 printf("sb_dspwr(0x%02x) timed out.\n", val); 131 return 0; 132} 133 134static int 135sb_cmd(struct resource *io, u_char val) 136{ 137 return sb_dspwr(io, val); 138} 139 140static void 141sb_setmixer(struct resource *io, u_int port, u_int value) 142{ 143 u_long flags; 144 145 flags = spltty(); 146 sb_wr(io, SB_MIX_ADDR, (u_char) (port & 0xff)); /* Select register */ 147 DELAY(10); 148 sb_wr(io, SB_MIX_DATA, (u_char) (value & 0xff)); 149 DELAY(10); 150 splx(flags); 151} 152 153static u_int 154sb_get_byte(struct resource *io) 155{ 156 int i; 157 158 for (i = 1000; i > 0; i--) { 159 if (sb_rd(io, DSP_DATA_AVAIL) & 0x80) 160 return sb_rd(io, DSP_READ); 161 else 162 DELAY(20); 163 } 164 return 0xffff; 165} 166 167static int 168sb_reset_dsp(struct resource *io) 169{ 170 sb_wr(io, SBDSP_RST, 3); 171 DELAY(100); 172 sb_wr(io, SBDSP_RST, 0); 173 return (sb_get_byte(io) == 0xAA)? 0 : ENXIO; 174} 175 176static int 177sb_identify_board(struct resource *io) 178{ 179 int ver, essver, rev; 180 181 sb_cmd(io, DSP_CMD_GETVER); /* Get version */ 182 ver = (sb_get_byte(io) << 8) | sb_get_byte(io); 183 if (ver < 0x100 || ver > 0x4ff) return 0; 184 if (ver == 0x0301) { 185 /* Try to detect ESS chips. */ 186 sb_cmd(io, DSP_CMD_GETID); /* Return ident. bytes. */ 187 essver = (sb_get_byte(io) << 8) | sb_get_byte(io); 188 rev = essver & 0x000f; 189 essver &= 0xfff0; 190 if (essver == 0x4880) ver |= 0x1000; 191 else if (essver == 0x6880) ver = 0x0500 | rev; 192 } 193 return ver; 194} 195 196static struct isa_pnp_id sbc_ids[] = { 197 {0x01008c0e, "Creative ViBRA16C"}, 198 {0x31008c0e, "Creative SB16/SB32"}, 199 {0x41008c0e, "Creative SB16/SB32"}, 200 {0x42008c0e, "Creative SB AWE64"}, /* CTL00c1 */ 201 {0x43008c0e, "Creative ViBRA16X"}, 202 {0x44008c0e, "Creative SB AWE64 Gold"}, 203 {0x45008c0e, "Creative SB AWE64"}, /* CTL0045 */ 204 205 {0x01000000, "Avance Asound 100"}, 206 {0x01100000, "Avance Asound 110"}, 207 {0x01200001, "Avance Logic ALS120"}, 208 209 {0x68187316, "ESS ES1868"}, /* ESS1868 */ 210 {0x69187316, "ESS ES1869"}, /* ESS1869 */ 211 {0xacb0110e, "ESS ES1869 (Compaq OEM)"}, 212 {0x79187316, "ESS ES1879"}, /* ESS1879 */ 213 {0x88187316, "ESS ES1888"}, /* ESS1888 */ 214 215 {0} 216}; 217 218static int 219sbc_probe(device_t dev) 220{ 221 char *s = NULL; 222 u_int32_t logical_id = isa_get_logicalid(dev); 223 if (logical_id) { 224 /* Check pnp ids */ 225 return ISA_PNP_PROBE(device_get_parent(dev), dev, sbc_ids); 226 } else { 227 int rid = 0, ver; 228 struct resource *io; 229 230 io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 231 0, ~0, 16, RF_ACTIVE); 232 if (!io) goto bad; 233 if (sb_reset_dsp(io)) goto bad2; 234 ver = sb_identify_board(io); 235 if (ver == 0) goto bad2; 236 switch ((ver & 0x00000f00) >> 8) { 237 case 1: 238 case 2: 239 s = "Soundblaster"; 240 break; 241 242 case 3: 243 s = (ver & 0x0000f000)? "ESS 488" : "Soundblaster Pro"; 244 break; 245 246 case 4: 247 s = "Soundblaster 16"; 248 break; 249 250 case 5: 251 s = (ver & 0x00000008)? "ESS 688" : "ESS 1688"; 252 break; 253 } 254 if (s) device_set_desc(dev, s); 255bad2: bus_release_resource(dev, SYS_RES_IOPORT, rid, io); 256bad: return s? 0 : ENXIO; 257 } 258} 259 260static int 261sbc_attach(device_t dev) 262{ 263 char *err = NULL; 264 struct sbc_softc *scp; 265 struct sndcard_func *func; 266 device_t child; 267 u_int32_t logical_id = isa_get_logicalid(dev); 268 int flags = device_get_flags(dev); 269 int f, dh, dl, x, irq, i; 270 271 if (!logical_id && (flags & DV_F_DUAL_DMA)) { 272 bus_set_resource(dev, SYS_RES_DRQ, 1, 273 flags & DV_F_DRQ_MASK, 1); 274 } 275 276 scp = device_get_softc(dev); 277 bzero(scp, sizeof(*scp)); 278 scp->dev = dev; 279 err = "alloc_resource"; 280 if (alloc_resource(scp)) goto bad; 281 282 err = "sb_reset_dsp"; 283 if (sb_reset_dsp(scp->io[0])) goto bad; 284 err = "sb_identify_board"; 285 scp->bd_ver = sb_identify_board(scp->io[0]) & 0x00000fff; 286 if (scp->bd_ver == 0) goto bad; 287 f = 0; 288 switch ((scp->bd_ver & 0x0f00) >> 8) { 289 case 1: /* old sound blaster has nothing... */ 290 break; 291 292 case 2: 293 f |= BD_F_DUP_MIDI; 294 if (scp->bd_ver > 0x200) f |= BD_F_MIX_CT1335; 295 break; 296 297 case 5: 298 f |= BD_F_ESS; 299 scp->bd_ver = 0x0301; 300 case 3: 301 f |= BD_F_DUP_MIDI | BD_F_MIX_CT1345; 302 break; 303 304 case 4: 305 f |= BD_F_SB16 | BD_F_MIX_CT1745; 306 if (scp->drq[0]) dl = rman_get_start(scp->drq[0]); else dl = -1; 307 if (scp->drq[1]) dh = rman_get_start(scp->drq[1]); else dh = dl; 308 if (!logical_id && (dh < dl)) { 309 struct resource *r; 310 r = scp->drq[0]; 311 scp->drq[0] = scp->drq[1]; 312 scp->drq[1] = r; 313 dl = rman_get_start(scp->drq[0]); 314 dh = rman_get_start(scp->drq[1]); 315 } 316 /* soft irq/dma configuration */ 317 x = -1; 318 irq = rman_get_start(scp->irq[0]); 319 if (irq == 5) x = 2; 320 else if (irq == 7) x = 4; 321 else if (irq == 9) x = 1; 322 else if (irq == 10) x = 8; 323 if (x == -1) { 324 err = "bad irq (5/7/9/10 valid)"; 325 goto bad; 326 } 327 else sb_setmixer(scp->io[0], IRQ_NR, x); 328 sb_setmixer(scp->io[0], DMA_NR, (1 << dh) | (1 << dl)); 329 device_printf(dev, "setting card to irq %d, drq %d", irq, dl); 330 if (dl != dh) printf(", %d", dh); 331 printf("\n"); 332 break; 333 } 334 335 switch (logical_id) { 336 case 0x43008c0e: /* CTL0043 */ 337 f |= BD_F_SB16X; 338 break; 339 } 340 scp->bd_ver |= f << 16; 341 342 err = "setup_intr"; 343 for (i = 0; i < IRQ_MAX; i++) { 344 if (bus_setup_intr(dev, scp->irq[i], INTR_TYPE_TTY, sbc_intr, &scp->ihl[i], &scp->ih)) 345 goto bad; 346 } 347 348 /* PCM Audio */ 349 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 350 if (func == NULL) goto bad; 351 bzero(func, sizeof(*func)); 352 func->func = SCF_PCM; 353 child = device_add_child(dev, "pcm", -1); 354 device_set_ivars(child, func); 355 356#if notyet 357 /* Midi Interface */ 358 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 359 if (func == NULL) goto bad; 360 bzero(func, sizeof(*func)); 361 func->func = SCF_MIDI; 362 child = device_add_child(dev, "midi", -1); 363 device_set_ivars(child, func); 364 365 /* OPL FM Synthesizer */ 366 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 367 if (func == NULL) goto bad; 368 bzero(func, sizeof(*func)); 369 func->func = SCF_SYNTH; 370 child = device_add_child(dev, "midi", -1); 371 device_set_ivars(child, func); 372#endif /* notyet */ 373 374 /* probe/attach kids */ 375 bus_generic_attach(dev); 376 377 return (0); 378 379bad: if (err) device_printf(dev, "%s\n", err); 380 release_resource(scp); 381 return (ENXIO); 382} 383 384static void 385sbc_intr(void *p) 386{ 387 struct sbc_ihl *ihl = p; 388 int i; 389 390 i = 0; 391 while (i < INTR_MAX) { 392 if (ihl->intr[i] != NULL) ihl->intr[i](ihl->intr_arg[i]); 393 i++; 394 } 395} 396 397static int 398sbc_setup_intr(device_t dev, device_t child, struct resource *irq, 399 int flags, driver_intr_t *intr, void *arg, 400 void **cookiep) 401{ 402 struct sbc_softc *scp = device_get_softc(dev); 403 struct sbc_ihl *ihl = NULL; 404 int i; 405 406 i = 0; 407 while (i < IRQ_MAX) { 408 if (irq == scp->irq[i]) ihl = &scp->ihl[i]; 409 i++; 410 } 411 if (ihl == NULL) return (EINVAL); 412 i = 0; 413 while (i < INTR_MAX) { 414 if (ihl->intr[i] == NULL) { 415 ihl->intr[i] = intr; 416 ihl->intr_arg[i] = arg; 417 *cookiep = &ihl->intr[i]; 418 return 0; 419 } else i++; 420 } 421 return (EINVAL); 422} 423 424static int 425sbc_teardown_intr(device_t dev, device_t child, struct resource *irq, 426 void *cookie) 427{ 428 struct sbc_softc *scp = device_get_softc(dev); 429 struct sbc_ihl *ihl = NULL; 430 int i; 431 432 i = 0; 433 while (i < IRQ_MAX) { 434 if (irq == scp->irq[i]) ihl = &scp->ihl[i]; 435 i++; 436 } 437 if (ihl == NULL) return (EINVAL); 438 i = 0; 439 while (i < INTR_MAX) { 440 if (cookie == &ihl->intr[i]) { 441 ihl->intr[i] = NULL; 442 ihl->intr_arg[i] = NULL; 443 return 0; 444 } else i++; 445 } 446 return (EINVAL); 447} 448 449static struct resource * 450sbc_alloc_resource(device_t bus, device_t child, int type, int *rid, 451 u_long start, u_long end, u_long count, u_int flags) 452{ 453 struct sbc_softc *scp; 454 int *alloced, rid_max, alloced_max; 455 struct resource **res; 456 457 scp = device_get_softc(bus); 458 switch (type) { 459 case SYS_RES_IOPORT: 460 alloced = scp->io_alloced; 461 res = scp->io; 462 rid_max = IO_MAX - 1; 463 alloced_max = 1; 464 break; 465 case SYS_RES_DRQ: 466 alloced = scp->drq_alloced; 467 res = scp->drq; 468 rid_max = DRQ_MAX - 1; 469 alloced_max = 1; 470 break; 471 case SYS_RES_IRQ: 472 alloced = scp->irq_alloced; 473 res = scp->irq; 474 rid_max = IRQ_MAX - 1; 475 alloced_max = INTR_MAX; /* pcm and mpu may share the irq. */ 476 break; 477 default: 478 return (NULL); 479 } 480 481 if (*rid > rid_max || alloced[*rid] == alloced_max) 482 return (NULL); 483 484 alloced[*rid]++; 485 return (res[*rid]); 486} 487 488static int 489sbc_release_resource(device_t bus, device_t child, int type, int rid, 490 struct resource *r) 491{ 492 struct sbc_softc *scp; 493 int *alloced, rid_max; 494 495 scp = device_get_softc(bus); 496 switch (type) { 497 case SYS_RES_IOPORT: 498 alloced = scp->io_alloced; 499 rid_max = IO_MAX - 1; 500 break; 501 case SYS_RES_DRQ: 502 alloced = scp->drq_alloced; 503 rid_max = DRQ_MAX - 1; 504 break; 505 case SYS_RES_IRQ: 506 alloced = scp->irq_alloced; 507 rid_max = IRQ_MAX - 1; 508 break; 509 default: 510 return (1); 511 } 512 513 if (rid > rid_max || alloced[rid] == 0) 514 return (1); 515 516 alloced[rid]--; 517 return (0); 518} 519 520static int 521sbc_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result) 522{ 523 struct sbc_softc *scp = device_get_softc(bus); 524 struct sndcard_func *func = device_get_ivars(dev); 525 526 switch (index) { 527 case 0: 528 *result = func->func; 529 break; 530 531 case 1: 532 *result = scp->bd_ver; 533 break; 534 535 default: 536 return ENOENT; 537 } 538 539 return 0; 540} 541 542static int 543sbc_write_ivar(device_t bus, device_t dev, 544 int index, uintptr_t value) 545{ 546 switch (index) { 547 case 0: 548 case 1: 549 return EINVAL; 550 551 default: 552 return (ENOENT); 553 } 554} 555 556static int 557alloc_resource(struct sbc_softc *scp) 558{ 559 int i; 560 561 for (i = 0 ; i < IO_MAX ; i++) { 562 if (scp->io[i] == NULL) { 563 scp->io_rid[i] = i; 564 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i], 565 0, ~0, io_range[i], RF_ACTIVE); 566 if (i == 0 && scp->io[i] == NULL) 567 return (1); 568 scp->io_alloced[i] = 0; 569 } 570 } 571 for (i = 0 ; i < DRQ_MAX ; i++) { 572 if (scp->drq[i] == NULL) { 573 scp->drq_rid[i] = i; 574 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i], 575 0, ~0, 1, RF_ACTIVE); 576 if (i == 0 && scp->drq[i] == NULL) 577 return (1); 578 scp->drq_alloced[i] = 0; 579 } 580 } 581 for (i = 0 ; i < IRQ_MAX ; i++) { 582 if (scp->irq[i] == NULL) { 583 scp->irq_rid[i] = i; 584 scp->irq[i] = bus_alloc_resource(scp->dev, SYS_RES_IRQ, &scp->irq_rid[i], 585 0, ~0, 1, RF_ACTIVE); 586 if (i == 0 && scp->irq[i] == NULL) 587 return (1); 588 scp->irq_alloced[i] = 0; 589 } 590 } 591 return (0); 592} 593 594static int 595release_resource(struct sbc_softc *scp) 596{ 597 int i; 598 599 for (i = 0 ; i < IO_MAX ; i++) { 600 if (scp->io[i] != NULL) { 601 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]); 602 scp->io[i] = NULL; 603 } 604 } 605 for (i = 0 ; i < DRQ_MAX ; i++) { 606 if (scp->drq[i] != NULL) { 607 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]); 608 scp->drq[i] = NULL; 609 } 610 } 611 for (i = 0 ; i < IRQ_MAX ; i++) { 612 if (scp->irq[i] != NULL) { 613 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid[i], scp->irq[i]); 614 scp->irq[i] = NULL; 615 } 616 } 617 return (0); 618} 619 620static device_method_t sbc_methods[] = { 621 /* Device interface */ 622 DEVMETHOD(device_probe, sbc_probe), 623 DEVMETHOD(device_attach, sbc_attach), 624 DEVMETHOD(device_detach, bus_generic_detach), 625 DEVMETHOD(device_shutdown, bus_generic_shutdown), 626 DEVMETHOD(device_suspend, bus_generic_suspend), 627 DEVMETHOD(device_resume, bus_generic_resume), 628 629 /* Bus interface */ 630 DEVMETHOD(bus_read_ivar, sbc_read_ivar), 631 DEVMETHOD(bus_write_ivar, sbc_write_ivar), 632 DEVMETHOD(bus_print_child, bus_generic_print_child), 633 DEVMETHOD(bus_alloc_resource, sbc_alloc_resource), 634 DEVMETHOD(bus_release_resource, sbc_release_resource), 635 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 636 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 637 DEVMETHOD(bus_setup_intr, sbc_setup_intr), 638 DEVMETHOD(bus_teardown_intr, sbc_teardown_intr), 639 640 { 0, 0 } 641}; 642 643static driver_t sbc_driver = { 644 "sbc", 645 sbc_methods, 646 sizeof(struct sbc_softc), 647}; 648 649/* sbc can be attached to an isa bus. */ 650DRIVER_MODULE(sbc, isa, sbc_driver, sbc_devclass, 0, 0); 651 652