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