sbc.c revision 54961
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 54961 1999-12-21 14:04:14Z peter $ 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"}, /* CTL0001 */ 198 {0x31008c0e, "Creative SB16/SB32"}, /* CTL0031 */ 199 {0x41008c0e, "Creative SB16/SB32"}, /* CTL0041 */ 200 {0x42008c0e, "Creative SB AWE64"}, /* CTL0042 */ 201 {0x43008c0e, "Creative ViBRA16X"}, /* CTL0043 */ 202 {0x44008c0e, "Creative SB AWE64 Gold"}, /* CTL0044 */ 203 {0x45008c0e, "Creative SB AWE64"}, /* CTL0045 */ 204 205 {0x01100000, "Avance Asound 110"}, /* @@@1001 */ 206 {0x01200001, "Avance Logic ALS120"}, /* @@@2001 */ 207 208 {0x68187316, "ESS ES1868"}, /* ESS1868 */ 209 {0x69187316, "ESS ES1869"}, /* ESS1869 */ 210 {0xacb0110e, "ESS ES1869 (Compaq OEM)"}, /* CPQb0ac */ 211 {0x79187316, "ESS ES1879"}, /* ESS1879 */ 212 {0x88187316, "ESS ES1888"}, /* ESS1888 */ 213 {0x07017316, "ESS ES1888 (DEC OEM)"}, /* ESS0107 */ 214 {0} 215}; 216 217static int 218sbc_probe(device_t dev) 219{ 220 char *s = NULL; 221 u_int32_t logical_id = isa_get_logicalid(dev); 222 if (logical_id) { 223 /* Check pnp ids */ 224 return ISA_PNP_PROBE(device_get_parent(dev), dev, sbc_ids); 225 } else { 226 int rid = 0, ver; 227 struct resource *io; 228 229 io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 230 0, ~0, 16, RF_ACTIVE); 231 if (!io) goto bad; 232 if (sb_reset_dsp(io)) goto bad2; 233 ver = sb_identify_board(io); 234 if (ver == 0) goto bad2; 235 switch ((ver & 0x00000f00) >> 8) { 236 case 1: 237 case 2: 238 s = "Soundblaster"; 239 break; 240 241 case 3: 242 s = (ver & 0x0000f000)? "ESS 488" : "Soundblaster Pro"; 243 break; 244 245 case 4: 246 s = "Soundblaster 16"; 247 break; 248 249 case 5: 250 s = (ver & 0x00000008)? "ESS 688" : "ESS 1688"; 251 break; 252 } 253 if (s) device_set_desc(dev, s); 254bad2: bus_release_resource(dev, SYS_RES_IOPORT, rid, io); 255bad: return s? 0 : ENXIO; 256 } 257} 258 259static int 260sbc_attach(device_t dev) 261{ 262 char *err = NULL; 263 struct sbc_softc *scp; 264 struct sndcard_func *func; 265 device_t child; 266 u_int32_t logical_id = isa_get_logicalid(dev); 267 int flags = device_get_flags(dev); 268 int f, dh, dl, x, irq, i; 269 270 if (!logical_id && (flags & DV_F_DUAL_DMA)) { 271 bus_set_resource(dev, SYS_RES_DRQ, 1, 272 flags & DV_F_DRQ_MASK, 1); 273 } 274 275 scp = device_get_softc(dev); 276 bzero(scp, sizeof(*scp)); 277 scp->dev = dev; 278 err = "alloc_resource"; 279 if (alloc_resource(scp)) goto bad; 280 281 err = "sb_reset_dsp"; 282 if (sb_reset_dsp(scp->io[0])) goto bad; 283 err = "sb_identify_board"; 284 scp->bd_ver = sb_identify_board(scp->io[0]) & 0x00000fff; 285 if (scp->bd_ver == 0) goto bad; 286 f = 0; 287 switch ((scp->bd_ver & 0x0f00) >> 8) { 288 case 1: /* old sound blaster has nothing... */ 289 break; 290 291 case 2: 292 f |= BD_F_DUP_MIDI; 293 if (scp->bd_ver > 0x200) f |= BD_F_MIX_CT1335; 294 break; 295 296 case 5: 297 f |= BD_F_ESS; 298 scp->bd_ver = 0x0301; 299 case 3: 300 f |= BD_F_DUP_MIDI | BD_F_MIX_CT1345; 301 break; 302 303 case 4: 304 f |= BD_F_SB16 | BD_F_MIX_CT1745; 305 if (scp->drq[0]) dl = rman_get_start(scp->drq[0]); else dl = -1; 306 if (scp->drq[1]) dh = rman_get_start(scp->drq[1]); else dh = dl; 307 if (!logical_id && (dh < dl)) { 308 struct resource *r; 309 r = scp->drq[0]; 310 scp->drq[0] = scp->drq[1]; 311 scp->drq[1] = r; 312 dl = rman_get_start(scp->drq[0]); 313 dh = rman_get_start(scp->drq[1]); 314 } 315 /* soft irq/dma configuration */ 316 x = -1; 317 irq = rman_get_start(scp->irq[0]); 318 if (irq == 5) x = 2; 319 else if (irq == 7) x = 4; 320 else if (irq == 9) x = 1; 321 else if (irq == 10) x = 8; 322 if (x == -1) { 323 err = "bad irq (5/7/9/10 valid)"; 324 goto bad; 325 } 326 else sb_setmixer(scp->io[0], IRQ_NR, x); 327 sb_setmixer(scp->io[0], DMA_NR, (1 << dh) | (1 << dl)); 328 device_printf(dev, "setting card to irq %d, drq %d", irq, dl); 329 if (dl != dh) printf(", %d", dh); 330 printf("\n"); 331 break; 332 } 333 334 switch (logical_id) { 335 case 0x43008c0e: /* CTL0043 */ 336 f |= BD_F_SB16X; 337 break; 338 } 339 scp->bd_ver |= f << 16; 340 341 err = "setup_intr"; 342 for (i = 0; i < IRQ_MAX; i++) { 343 if (bus_setup_intr(dev, scp->irq[i], INTR_TYPE_TTY, sbc_intr, &scp->ihl[i], &scp->ih)) 344 goto bad; 345 } 346 347 /* PCM Audio */ 348 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 349 if (func == NULL) goto bad; 350 bzero(func, sizeof(*func)); 351 func->func = SCF_PCM; 352 child = device_add_child(dev, "pcm", -1); 353 device_set_ivars(child, func); 354 355#if notyet 356 /* Midi Interface */ 357 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 358 if (func == NULL) goto bad; 359 bzero(func, sizeof(*func)); 360 func->func = SCF_MIDI; 361 child = device_add_child(dev, "midi", -1); 362 device_set_ivars(child, func); 363 364 /* OPL FM Synthesizer */ 365 func = malloc(sizeof(struct sndcard_func), M_DEVBUF, M_NOWAIT); 366 if (func == NULL) goto bad; 367 bzero(func, sizeof(*func)); 368 func->func = SCF_SYNTH; 369 child = device_add_child(dev, "midi", -1); 370 device_set_ivars(child, func); 371#endif /* notyet */ 372 373 /* probe/attach kids */ 374 bus_generic_attach(dev); 375 376 return (0); 377 378bad: if (err) device_printf(dev, "%s\n", err); 379 release_resource(scp); 380 return (ENXIO); 381} 382 383static void 384sbc_intr(void *p) 385{ 386 struct sbc_ihl *ihl = p; 387 int i; 388 389 i = 0; 390 while (i < INTR_MAX) { 391 if (ihl->intr[i] != NULL) ihl->intr[i](ihl->intr_arg[i]); 392 i++; 393 } 394} 395 396static int 397sbc_setup_intr(device_t dev, device_t child, struct resource *irq, 398 int flags, driver_intr_t *intr, void *arg, 399 void **cookiep) 400{ 401 struct sbc_softc *scp = device_get_softc(dev); 402 struct sbc_ihl *ihl = NULL; 403 int i; 404 405 i = 0; 406 while (i < IRQ_MAX) { 407 if (irq == scp->irq[i]) ihl = &scp->ihl[i]; 408 i++; 409 } 410 if (ihl == NULL) return (EINVAL); 411 i = 0; 412 while (i < INTR_MAX) { 413 if (ihl->intr[i] == NULL) { 414 ihl->intr[i] = intr; 415 ihl->intr_arg[i] = arg; 416 *cookiep = &ihl->intr[i]; 417 return 0; 418 } else i++; 419 } 420 return (EINVAL); 421} 422 423static int 424sbc_teardown_intr(device_t dev, device_t child, struct resource *irq, 425 void *cookie) 426{ 427 struct sbc_softc *scp = device_get_softc(dev); 428 struct sbc_ihl *ihl = NULL; 429 int i; 430 431 i = 0; 432 while (i < IRQ_MAX) { 433 if (irq == scp->irq[i]) ihl = &scp->ihl[i]; 434 i++; 435 } 436 if (ihl == NULL) return (EINVAL); 437 i = 0; 438 while (i < INTR_MAX) { 439 if (cookie == &ihl->intr[i]) { 440 ihl->intr[i] = NULL; 441 ihl->intr_arg[i] = NULL; 442 return 0; 443 } else i++; 444 } 445 return (EINVAL); 446} 447 448static struct resource * 449sbc_alloc_resource(device_t bus, device_t child, int type, int *rid, 450 u_long start, u_long end, u_long count, u_int flags) 451{ 452 struct sbc_softc *scp; 453 int *alloced, rid_max, alloced_max; 454 struct resource **res; 455 456 scp = device_get_softc(bus); 457 switch (type) { 458 case SYS_RES_IOPORT: 459 alloced = scp->io_alloced; 460 res = scp->io; 461 rid_max = IO_MAX - 1; 462 alloced_max = 1; 463 break; 464 case SYS_RES_DRQ: 465 alloced = scp->drq_alloced; 466 res = scp->drq; 467 rid_max = DRQ_MAX - 1; 468 alloced_max = 1; 469 break; 470 case SYS_RES_IRQ: 471 alloced = scp->irq_alloced; 472 res = scp->irq; 473 rid_max = IRQ_MAX - 1; 474 alloced_max = INTR_MAX; /* pcm and mpu may share the irq. */ 475 break; 476 default: 477 return (NULL); 478 } 479 480 if (*rid > rid_max || alloced[*rid] == alloced_max) 481 return (NULL); 482 483 alloced[*rid]++; 484 return (res[*rid]); 485} 486 487static int 488sbc_release_resource(device_t bus, device_t child, int type, int rid, 489 struct resource *r) 490{ 491 struct sbc_softc *scp; 492 int *alloced, rid_max; 493 494 scp = device_get_softc(bus); 495 switch (type) { 496 case SYS_RES_IOPORT: 497 alloced = scp->io_alloced; 498 rid_max = IO_MAX - 1; 499 break; 500 case SYS_RES_DRQ: 501 alloced = scp->drq_alloced; 502 rid_max = DRQ_MAX - 1; 503 break; 504 case SYS_RES_IRQ: 505 alloced = scp->irq_alloced; 506 rid_max = IRQ_MAX - 1; 507 break; 508 default: 509 return (1); 510 } 511 512 if (rid > rid_max || alloced[rid] == 0) 513 return (1); 514 515 alloced[rid]--; 516 return (0); 517} 518 519static int 520sbc_read_ivar(device_t bus, device_t dev, int index, uintptr_t * result) 521{ 522 struct sbc_softc *scp = device_get_softc(bus); 523 struct sndcard_func *func = device_get_ivars(dev); 524 525 switch (index) { 526 case 0: 527 *result = func->func; 528 break; 529 530 case 1: 531 *result = scp->bd_ver; 532 break; 533 534 default: 535 return ENOENT; 536 } 537 538 return 0; 539} 540 541static int 542sbc_write_ivar(device_t bus, device_t dev, 543 int index, uintptr_t value) 544{ 545 switch (index) { 546 case 0: 547 case 1: 548 return EINVAL; 549 550 default: 551 return (ENOENT); 552 } 553} 554 555static int 556alloc_resource(struct sbc_softc *scp) 557{ 558 int i; 559 560 for (i = 0 ; i < IO_MAX ; i++) { 561 if (scp->io[i] == NULL) { 562 scp->io_rid[i] = i; 563 scp->io[i] = bus_alloc_resource(scp->dev, SYS_RES_IOPORT, &scp->io_rid[i], 564 0, ~0, io_range[i], RF_ACTIVE); 565 if (i == 0 && scp->io[i] == NULL) 566 return (1); 567 scp->io_alloced[i] = 0; 568 } 569 } 570 for (i = 0 ; i < DRQ_MAX ; i++) { 571 if (scp->drq[i] == NULL) { 572 scp->drq_rid[i] = i; 573 scp->drq[i] = bus_alloc_resource(scp->dev, SYS_RES_DRQ, &scp->drq_rid[i], 574 0, ~0, 1, RF_ACTIVE); 575 if (i == 0 && scp->drq[i] == NULL) 576 return (1); 577 scp->drq_alloced[i] = 0; 578 } 579 } 580 for (i = 0 ; i < IRQ_MAX ; i++) { 581 if (scp->irq[i] == NULL) { 582 scp->irq_rid[i] = i; 583 scp->irq[i] = bus_alloc_resource(scp->dev, SYS_RES_IRQ, &scp->irq_rid[i], 584 0, ~0, 1, RF_ACTIVE); 585 if (i == 0 && scp->irq[i] == NULL) 586 return (1); 587 scp->irq_alloced[i] = 0; 588 } 589 } 590 return (0); 591} 592 593static int 594release_resource(struct sbc_softc *scp) 595{ 596 int i; 597 598 for (i = 0 ; i < IO_MAX ; i++) { 599 if (scp->io[i] != NULL) { 600 bus_release_resource(scp->dev, SYS_RES_IOPORT, scp->io_rid[i], scp->io[i]); 601 scp->io[i] = NULL; 602 } 603 } 604 for (i = 0 ; i < DRQ_MAX ; i++) { 605 if (scp->drq[i] != NULL) { 606 bus_release_resource(scp->dev, SYS_RES_DRQ, scp->drq_rid[i], scp->drq[i]); 607 scp->drq[i] = NULL; 608 } 609 } 610 for (i = 0 ; i < IRQ_MAX ; i++) { 611 if (scp->irq[i] != NULL) { 612 bus_release_resource(scp->dev, SYS_RES_IRQ, scp->irq_rid[i], scp->irq[i]); 613 scp->irq[i] = NULL; 614 } 615 } 616 return (0); 617} 618 619static device_method_t sbc_methods[] = { 620 /* Device interface */ 621 DEVMETHOD(device_probe, sbc_probe), 622 DEVMETHOD(device_attach, sbc_attach), 623 DEVMETHOD(device_detach, bus_generic_detach), 624 DEVMETHOD(device_shutdown, bus_generic_shutdown), 625 DEVMETHOD(device_suspend, bus_generic_suspend), 626 DEVMETHOD(device_resume, bus_generic_resume), 627 628 /* Bus interface */ 629 DEVMETHOD(bus_read_ivar, sbc_read_ivar), 630 DEVMETHOD(bus_write_ivar, sbc_write_ivar), 631 DEVMETHOD(bus_print_child, bus_generic_print_child), 632 DEVMETHOD(bus_alloc_resource, sbc_alloc_resource), 633 DEVMETHOD(bus_release_resource, sbc_release_resource), 634 DEVMETHOD(bus_activate_resource, bus_generic_activate_resource), 635 DEVMETHOD(bus_deactivate_resource, bus_generic_deactivate_resource), 636 DEVMETHOD(bus_setup_intr, sbc_setup_intr), 637 DEVMETHOD(bus_teardown_intr, sbc_teardown_intr), 638 639 { 0, 0 } 640}; 641 642static driver_t sbc_driver = { 643 "sbc", 644 sbc_methods, 645 sizeof(struct sbc_softc), 646}; 647 648/* sbc can be attached to an isa bus. */ 649DRIVER_MODULE(sbc, isa, sbc_driver, sbc_devclass, 0, 0); 650