1 /*- 2 * Copyright (c) 2000 Michael Smith 3 * Copyright (c) 2000 BSDi 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: src/sys/dev/twe/twe_freebsd.c,v 1.2.2.5 2002/03/07 09:57:02 msmith Exp $ 28 * $DragonFly: src/sys/dev/raid/twe/twe_freebsd.c,v 1.12 2005/02/04 02:55:48 dillon Exp $ 29 */ 30 31 /* 32 * FreeBSD-specific code. 33 */ 34 35 #include <sys/param.h> 36 #include <sys/cons.h> 37 #include <machine/bus.h> 38 #include <machine/clock.h> 39 #include <machine/md_var.h> 40 #include <vm/vm.h> 41 #include <vm/pmap.h> 42 #include "twe_compat.h" 43 #include "twereg.h" 44 #include "tweio.h" 45 #include "twevar.h" 46 #include "twe_tables.h" 47 48 #include <sys/devicestat.h> 49 50 static devclass_t twe_devclass; 51 52 #ifdef TWE_DEBUG 53 static u_int32_t twed_bio_in; 54 #define TWED_BIO_IN twed_bio_in++ 55 static u_int32_t twed_bio_out; 56 #define TWED_BIO_OUT twed_bio_out++ 57 #else 58 #define TWED_BIO_IN 59 #define TWED_BIO_OUT 60 #endif 61 62 /******************************************************************************** 63 ******************************************************************************** 64 Control device interface 65 ******************************************************************************** 66 ********************************************************************************/ 67 68 static d_open_t twe_open; 69 static d_close_t twe_close; 70 static d_ioctl_t twe_ioctl_wrapper; 71 72 #define TWE_CDEV_MAJOR 146 73 74 static struct cdevsw twe_cdevsw = { 75 /* name */ "twe", 76 /* cmaj */ TWE_CDEV_MAJOR, 77 /* flags */ 0, 78 /* port */ NULL, 79 /* clone */ NULL, 80 81 twe_open, 82 twe_close, 83 noread, 84 nowrite, 85 twe_ioctl_wrapper, 86 nopoll, 87 nommap, 88 nostrategy, 89 nodump, 90 nopsize, 91 }; 92 93 /******************************************************************************** 94 * Accept an open operation on the control device. 95 */ 96 static int 97 twe_open(dev_t dev, int flags, int fmt, d_thread_t *td) 98 { 99 int unit = minor(dev); 100 struct twe_softc *sc = devclass_get_softc(twe_devclass, unit); 101 102 sc->twe_state |= TWE_STATE_OPEN; 103 return(0); 104 } 105 106 /******************************************************************************** 107 * Accept the last close on the control device. 108 */ 109 static int 110 twe_close(dev_t dev, int flags, int fmt, d_thread_t *td) 111 { 112 int unit = minor(dev); 113 struct twe_softc *sc = devclass_get_softc(twe_devclass, unit); 114 115 sc->twe_state &= ~TWE_STATE_OPEN; 116 return (0); 117 } 118 119 /******************************************************************************** 120 * Handle controller-specific control operations. 121 */ 122 static int 123 twe_ioctl_wrapper(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, d_thread_t *td) 124 { 125 struct twe_softc *sc = (struct twe_softc *)dev->si_drv1; 126 127 return(twe_ioctl(sc, cmd, addr)); 128 } 129 130 /******************************************************************************** 131 ******************************************************************************** 132 PCI device interface 133 ******************************************************************************** 134 ********************************************************************************/ 135 136 static int twe_probe(device_t dev); 137 static int twe_attach(device_t dev); 138 static void twe_free(struct twe_softc *sc); 139 static int twe_detach(device_t dev); 140 static void twe_shutdown(device_t dev); 141 static int twe_suspend(device_t dev); 142 static int twe_resume(device_t dev); 143 static void twe_pci_intr(void *arg); 144 static void twe_intrhook(void *arg); 145 146 static device_method_t twe_methods[] = { 147 /* Device interface */ 148 DEVMETHOD(device_probe, twe_probe), 149 DEVMETHOD(device_attach, twe_attach), 150 DEVMETHOD(device_detach, twe_detach), 151 DEVMETHOD(device_shutdown, twe_shutdown), 152 DEVMETHOD(device_suspend, twe_suspend), 153 DEVMETHOD(device_resume, twe_resume), 154 155 DEVMETHOD(bus_print_child, bus_generic_print_child), 156 DEVMETHOD(bus_driver_added, bus_generic_driver_added), 157 { 0, 0 } 158 }; 159 160 static driver_t twe_pci_driver = { 161 "twe", 162 twe_methods, 163 sizeof(struct twe_softc) 164 }; 165 166 #ifdef TWE_OVERRIDE 167 DRIVER_MODULE(Xtwe, pci, twe_pci_driver, twe_devclass, 0, 0); 168 #else 169 DRIVER_MODULE(twe, pci, twe_pci_driver, twe_devclass, 0, 0); 170 #endif 171 172 /******************************************************************************** 173 * Match a 3ware Escalade ATA RAID controller. 174 */ 175 static int 176 twe_probe(device_t dev) 177 { 178 179 debug_called(4); 180 181 if ((pci_get_vendor(dev) == TWE_VENDOR_ID) && 182 ((pci_get_device(dev) == TWE_DEVICE_ID) || 183 (pci_get_device(dev) == TWE_DEVICE_ID_ASIC))) { 184 device_set_desc(dev, TWE_DEVICE_NAME); 185 #ifdef TWE_OVERRIDE 186 return(0); 187 #else 188 return(-10); 189 #endif 190 } 191 return(ENXIO); 192 } 193 194 /******************************************************************************** 195 * Allocate resources, initialise the controller. 196 */ 197 static int 198 twe_attach(device_t dev) 199 { 200 struct twe_softc *sc; 201 int rid, error; 202 u_int32_t command; 203 dev_t xdev; 204 205 debug_called(4); 206 207 /* 208 * Initialise the softc structure. 209 */ 210 sc = device_get_softc(dev); 211 sc->twe_dev = dev; 212 213 sysctl_ctx_init(&sc->sysctl_ctx); 214 sc->sysctl_tree = SYSCTL_ADD_NODE(&sc->sysctl_ctx, 215 SYSCTL_STATIC_CHILDREN(_hw), OID_AUTO, 216 device_get_nameunit(dev), CTLFLAG_RD, 0, ""); 217 if (sc->sysctl_tree == NULL) { 218 twe_printf(sc, "cannot add sysctl tree node\n"); 219 return (ENXIO); 220 } 221 SYSCTL_ADD_STRING(&sc->sysctl_ctx, SYSCTL_CHILDREN(sc->sysctl_tree), 222 OID_AUTO, "driver_version", CTLFLAG_RD, "$Revision$", 0, 223 "TWE driver version"); 224 225 /* 226 * Make sure we are going to be able to talk to this board. 227 */ 228 command = pci_read_config(dev, PCIR_COMMAND, 2); 229 if ((command & PCIM_CMD_PORTEN) == 0) { 230 twe_printf(sc, "register window not available\n"); 231 return(ENXIO); 232 } 233 /* 234 * Force the busmaster enable bit on, in case the BIOS forgot. 235 */ 236 command |= PCIM_CMD_BUSMASTEREN; 237 pci_write_config(dev, PCIR_COMMAND, command, 2); 238 239 /* 240 * Allocate the PCI register window. 241 */ 242 rid = TWE_IO_CONFIG_REG; 243 if ((sc->twe_io = bus_alloc_resource(dev, SYS_RES_IOPORT, &rid, 0, ~0, 1, RF_ACTIVE)) == NULL) { 244 twe_printf(sc, "can't allocate register window\n"); 245 twe_free(sc); 246 return(ENXIO); 247 } 248 sc->twe_btag = rman_get_bustag(sc->twe_io); 249 sc->twe_bhandle = rman_get_bushandle(sc->twe_io); 250 251 /* 252 * Allocate the parent bus DMA tag appropriate for PCI. 253 */ 254 if (bus_dma_tag_create(NULL, /* parent */ 255 1, 0, /* alignment, boundary */ 256 BUS_SPACE_MAXADDR_32BIT, /* lowaddr */ 257 BUS_SPACE_MAXADDR, /* highaddr */ 258 NULL, NULL, /* filter, filterarg */ 259 MAXBSIZE, TWE_MAX_SGL_LENGTH, /* maxsize, nsegments */ 260 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */ 261 BUS_DMA_ALLOCNOW, /* flags */ 262 &sc->twe_parent_dmat)) { 263 twe_printf(sc, "can't allocate parent DMA tag\n"); 264 twe_free(sc); 265 return(ENOMEM); 266 } 267 268 /* 269 * Allocate and connect our interrupt. 270 */ 271 rid = 0; 272 if ((sc->twe_irq = bus_alloc_resource(sc->twe_dev, SYS_RES_IRQ, &rid, 0, ~0, 1, RF_SHAREABLE | RF_ACTIVE)) == NULL) { 273 twe_printf(sc, "can't allocate interrupt\n"); 274 twe_free(sc); 275 return(ENXIO); 276 } 277 if (bus_setup_intr(sc->twe_dev, sc->twe_irq, INTR_TYPE_BIO | INTR_ENTROPY, twe_pci_intr, sc, &sc->twe_intr)) { 278 twe_printf(sc, "can't set up interrupt\n"); 279 twe_free(sc); 280 return(ENXIO); 281 } 282 283 /* 284 * Create DMA tag for mapping objects into controller-addressable space. 285 */ 286 if (bus_dma_tag_create(sc->twe_parent_dmat, /* parent */ 287 1, 0, /* alignment, boundary */ 288 BUS_SPACE_MAXADDR, /* lowaddr */ 289 BUS_SPACE_MAXADDR, /* highaddr */ 290 NULL, NULL, /* filter, filterarg */ 291 MAXBSIZE, TWE_MAX_SGL_LENGTH,/* maxsize, nsegments */ 292 BUS_SPACE_MAXSIZE_32BIT, /* maxsegsize */ 293 0, /* flags */ 294 &sc->twe_buffer_dmat)) { 295 twe_printf(sc, "can't allocate data buffer DMA tag\n"); 296 twe_free(sc); 297 return(ENOMEM); 298 } 299 300 /* 301 * Initialise the controller and driver core. 302 */ 303 if ((error = twe_setup(sc))) 304 return(error); 305 306 /* 307 * Print some information about the controller and configuration. 308 */ 309 twe_describe_controller(sc); 310 311 /* 312 * Create the control device. 313 */ 314 cdevsw_add(&twe_cdevsw, -1, device_get_unit(sc->twe_dev)); 315 xdev = make_dev(&twe_cdevsw, device_get_unit(sc->twe_dev), 316 UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR, 317 "twe%d", device_get_unit(sc->twe_dev)); 318 xdev->si_drv1 = sc; 319 320 /* 321 * Schedule ourselves to bring the controller up once interrupts are available. 322 * This isn't strictly necessary, since we disable interrupts while probing the 323 * controller, but it is more in keeping with common practice for other disk 324 * devices. 325 */ 326 sc->twe_ich.ich_func = twe_intrhook; 327 sc->twe_ich.ich_arg = sc; 328 sc->twe_ich.ich_desc = "twe"; 329 if (config_intrhook_establish(&sc->twe_ich) != 0) { 330 twe_printf(sc, "can't establish configuration hook\n"); 331 twe_free(sc); 332 return(ENXIO); 333 } 334 335 return(0); 336 } 337 338 /******************************************************************************** 339 * Free all of the resources associated with (sc). 340 * 341 * Should not be called if the controller is active. 342 */ 343 static void 344 twe_free(struct twe_softc *sc) 345 { 346 struct twe_request *tr; 347 348 debug_called(4); 349 350 /* throw away any command buffers */ 351 while ((tr = twe_dequeue_free(sc)) != NULL) 352 twe_free_request(tr); 353 354 /* destroy the data-transfer DMA tag */ 355 if (sc->twe_buffer_dmat) 356 bus_dma_tag_destroy(sc->twe_buffer_dmat); 357 358 /* disconnect the interrupt handler */ 359 if (sc->twe_intr) 360 bus_teardown_intr(sc->twe_dev, sc->twe_irq, sc->twe_intr); 361 if (sc->twe_irq != NULL) 362 bus_release_resource(sc->twe_dev, SYS_RES_IRQ, 0, sc->twe_irq); 363 364 /* destroy the parent DMA tag */ 365 if (sc->twe_parent_dmat) 366 bus_dma_tag_destroy(sc->twe_parent_dmat); 367 368 /* release the register window mapping */ 369 if (sc->twe_io != NULL) 370 bus_release_resource(sc->twe_dev, SYS_RES_IOPORT, TWE_IO_CONFIG_REG, sc->twe_io); 371 372 cdevsw_remove(&twe_cdevsw, -1, device_get_unit(sc->twe_dev)); 373 374 sysctl_ctx_free(&sc->sysctl_ctx); 375 } 376 377 /******************************************************************************** 378 * Disconnect from the controller completely, in preparation for unload. 379 */ 380 static int 381 twe_detach(device_t dev) 382 { 383 struct twe_softc *sc = device_get_softc(dev); 384 int s, error; 385 386 debug_called(4); 387 388 error = EBUSY; 389 s = splbio(); 390 if (sc->twe_state & TWE_STATE_OPEN) 391 goto out; 392 393 /* 394 * Shut the controller down. 395 */ 396 twe_shutdown(dev); 397 398 twe_free(sc); 399 400 error = 0; 401 out: 402 splx(s); 403 return(error); 404 } 405 406 /******************************************************************************** 407 * Bring the controller down to a dormant state and detach all child devices. 408 * 409 * Note that we can assume that the bioq on the controller is empty, as we won't 410 * allow shutdown if any device is open. 411 */ 412 static void 413 twe_shutdown(device_t dev) 414 { 415 struct twe_softc *sc = device_get_softc(dev); 416 int i, s; 417 418 debug_called(4); 419 420 s = splbio(); 421 422 /* 423 * Delete all our child devices. 424 */ 425 for (i = 0; i < TWE_MAX_UNITS; i++) { 426 twe_detach_drive(sc, i); 427 } 428 429 /* 430 * Bring the controller down. 431 */ 432 twe_deinit(sc); 433 434 splx(s); 435 } 436 437 /******************************************************************************** 438 * Bring the controller to a quiescent state, ready for system suspend. 439 */ 440 static int 441 twe_suspend(device_t dev) 442 { 443 struct twe_softc *sc = device_get_softc(dev); 444 int s; 445 446 debug_called(4); 447 448 s = splbio(); 449 sc->twe_state |= TWE_STATE_SUSPEND; 450 451 twe_disable_interrupts(sc); 452 splx(s); 453 454 return(0); 455 } 456 457 /******************************************************************************** 458 * Bring the controller back to a state ready for operation. 459 */ 460 static int 461 twe_resume(device_t dev) 462 { 463 struct twe_softc *sc = device_get_softc(dev); 464 465 debug_called(4); 466 467 sc->twe_state &= ~TWE_STATE_SUSPEND; 468 twe_enable_interrupts(sc); 469 470 return(0); 471 } 472 473 /******************************************************************************* 474 * Take an interrupt, or be poked by other code to look for interrupt-worthy 475 * status. 476 */ 477 static void 478 twe_pci_intr(void *arg) 479 { 480 twe_intr((struct twe_softc *)arg); 481 } 482 483 /******************************************************************************** 484 * Delayed-startup hook 485 */ 486 static void 487 twe_intrhook(void *arg) 488 { 489 struct twe_softc *sc = (struct twe_softc *)arg; 490 491 /* pull ourselves off the intrhook chain */ 492 config_intrhook_disestablish(&sc->twe_ich); 493 494 /* call core startup routine */ 495 twe_init(sc); 496 } 497 498 /******************************************************************************** 499 * Given a detected drive, attach it to the bio interface. 500 * 501 * This is called from twe_add_unit. 502 */ 503 void 504 twe_attach_drive(struct twe_softc *sc, struct twe_drive *dr) 505 { 506 char buf[80]; 507 int error; 508 509 dr->td_disk = device_add_child(sc->twe_dev, NULL, -1); 510 if (dr->td_disk == NULL) { 511 twe_printf(sc, "device_add_child failed\n"); 512 return; 513 } 514 device_set_ivars(dr->td_disk, dr); 515 516 /* 517 * XXX It would make sense to test the online/initialising bits, but they seem to be 518 * always set... 519 */ 520 sprintf(buf, "Unit %d, %s, %s", 521 dr->td_unit, 522 twe_describe_code(twe_table_unittype, dr->td_type), 523 twe_describe_code(twe_table_unitstate, dr->td_state & TWE_PARAM_UNITSTATUS_MASK)); 524 device_set_desc_copy(dr->td_disk, buf); 525 526 if ((error = bus_generic_attach(sc->twe_dev)) != 0) 527 twe_printf(sc, "bus_generic_attach returned %d\n", error); 528 } 529 530 /******************************************************************************** 531 * Detach the specified unit if it exsists 532 * 533 * This is called from twe_del_unit. 534 */ 535 void 536 twe_detach_drive(struct twe_softc *sc, int unit) 537 { 538 539 if (sc->twe_drive[unit].td_disk != 0) { 540 if (device_delete_child(sc->twe_dev, sc->twe_drive[unit].td_disk) != 0) 541 twe_printf(sc, "failed to delete unit %d\n", unit); 542 sc->twe_drive[unit].td_disk = 0; 543 } 544 } 545 546 /******************************************************************************** 547 * Clear a PCI parity error. 548 */ 549 void 550 twe_clear_pci_parity_error(struct twe_softc *sc) 551 { 552 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_PARITY_ERROR); 553 pci_write_config(sc->twe_dev, PCIR_STATUS, TWE_PCI_CLEAR_PARITY_ERROR, 2); 554 } 555 556 /******************************************************************************** 557 * Clear a PCI abort. 558 */ 559 void 560 twe_clear_pci_abort(struct twe_softc *sc) 561 { 562 TWE_CONTROL(sc, TWE_CONTROL_CLEAR_PCI_ABORT); 563 pci_write_config(sc->twe_dev, PCIR_STATUS, TWE_PCI_CLEAR_PCI_ABORT, 2); 564 } 565 566 /******************************************************************************** 567 ******************************************************************************** 568 Disk device 569 ******************************************************************************** 570 ********************************************************************************/ 571 572 /* 573 * Disk device softc 574 */ 575 struct twed_softc 576 { 577 device_t twed_dev; 578 dev_t twed_dev_t; 579 struct twe_softc *twed_controller; /* parent device softc */ 580 struct twe_drive *twed_drive; /* drive data in parent softc */ 581 struct disk twed_disk; /* generic disk handle */ 582 struct devstat twed_stats; /* accounting */ 583 struct disklabel twed_label; /* synthetic label */ 584 int twed_flags; 585 #define TWED_OPEN (1<<0) /* drive is open (can't shut down) */ 586 }; 587 588 /* 589 * Disk device bus interface 590 */ 591 static int twed_probe(device_t dev); 592 static int twed_attach(device_t dev); 593 static int twed_detach(device_t dev); 594 595 static device_method_t twed_methods[] = { 596 DEVMETHOD(device_probe, twed_probe), 597 DEVMETHOD(device_attach, twed_attach), 598 DEVMETHOD(device_detach, twed_detach), 599 { 0, 0 } 600 }; 601 602 static driver_t twed_driver = { 603 "twed", 604 twed_methods, 605 sizeof(struct twed_softc) 606 }; 607 608 static devclass_t twed_devclass; 609 #ifdef TWE_OVERRIDE 610 DRIVER_MODULE(Xtwed, Xtwe, twed_driver, twed_devclass, 0, 0); 611 #else 612 DRIVER_MODULE(twed, twe, twed_driver, twed_devclass, 0, 0); 613 #endif 614 615 /* 616 * Disk device control interface. 617 */ 618 static d_open_t twed_open; 619 static d_close_t twed_close; 620 static d_strategy_t twed_strategy; 621 static d_dump_t twed_dump; 622 623 #define TWED_CDEV_MAJOR 147 624 625 static struct cdevsw twed_cdevsw = { 626 "twed", 627 TWED_CDEV_MAJOR, 628 D_DISK, 629 /* port */ NULL, 630 /* clone */ NULL, 631 twed_open, 632 twed_close, 633 physread, 634 physwrite, 635 noioctl, 636 nopoll, 637 nommap, 638 twed_strategy, 639 twed_dump, 640 nopsize, 641 }; 642 643 644 /******************************************************************************** 645 * Handle open from generic layer. 646 * 647 * Note that this is typically only called by the diskslice code, and not 648 * for opens on subdevices (eg. slices, partitions). 649 */ 650 static int 651 twed_open(dev_t dev, int flags, int fmt, d_thread_t *td) 652 { 653 struct twed_softc *sc = (struct twed_softc *)dev->si_drv1; 654 struct disklabel *label; 655 656 debug_called(4); 657 658 if (sc == NULL) 659 return (ENXIO); 660 661 /* check that the controller is up and running */ 662 if (sc->twed_controller->twe_state & TWE_STATE_SHUTDOWN) 663 return(ENXIO); 664 665 /* build synthetic label */ 666 label = &sc->twed_disk.d_label; 667 bzero(label, sizeof(*label)); 668 label->d_type = DTYPE_ESDI; 669 label->d_secsize = TWE_BLOCK_SIZE; 670 label->d_nsectors = sc->twed_drive->td_sectors; 671 label->d_ntracks = sc->twed_drive->td_heads; 672 label->d_ncylinders = sc->twed_drive->td_cylinders; 673 label->d_secpercyl = sc->twed_drive->td_sectors * sc->twed_drive->td_heads; 674 label->d_secperunit = sc->twed_drive->td_size; 675 676 sc->twed_flags |= TWED_OPEN; 677 return (0); 678 } 679 680 /******************************************************************************** 681 * Handle last close of the disk device. 682 */ 683 static int 684 twed_close(dev_t dev, int flags, int fmt, d_thread_t *td) 685 { 686 struct twed_softc *sc = (struct twed_softc *)dev->si_drv1; 687 688 debug_called(4); 689 690 if (sc == NULL) 691 return (ENXIO); 692 693 sc->twed_flags &= ~TWED_OPEN; 694 return (0); 695 } 696 697 /******************************************************************************** 698 * Handle an I/O request. 699 */ 700 static void 701 twed_strategy(twe_bio *bp) 702 { 703 struct twed_softc *sc = (struct twed_softc *)TWE_BIO_SOFTC(bp); 704 705 debug_called(4); 706 707 TWED_BIO_IN; 708 709 /* bogus disk? */ 710 if (sc == NULL) { 711 TWE_BIO_SET_ERROR(bp, EINVAL); 712 printf("twe: bio for invalid disk!\n"); 713 TWE_BIO_DONE(bp); 714 TWED_BIO_OUT; 715 return; 716 } 717 718 /* perform accounting */ 719 TWE_BIO_STATS_START(bp); 720 721 /* queue the bio on the controller */ 722 twe_enqueue_bio(sc->twed_controller, bp); 723 724 /* poke the controller to start I/O */ 725 twe_startio(sc->twed_controller); 726 return; 727 } 728 729 /******************************************************************************** 730 * System crashdump support 731 */ 732 int 733 twed_dump(dev_t dev, u_int count, u_int blkno, u_int secsize) 734 { 735 struct twed_softc *twed_sc = (struct twed_softc *)dev->si_drv1; 736 struct twe_softc *twe_sc = (struct twe_softc *)twed_sc->twed_controller; 737 vm_paddr_t addr = 0; 738 long blkcnt; 739 int dumppages = MAXDUMPPGS; 740 int error; 741 int i; 742 743 if (!twed_sc || !twe_sc) 744 return(ENXIO); 745 746 blkcnt = howmany(PAGE_SIZE, secsize); 747 748 while (count > 0) { 749 caddr_t va = NULL; 750 751 if ((count / blkcnt) < dumppages) 752 dumppages = count / blkcnt; 753 754 for (i = 0; i < dumppages; ++i) { 755 vm_paddr_t a = addr + (i * PAGE_SIZE); 756 if (is_physical_memory(a)) 757 va = pmap_kenter_temporary(trunc_page(a), i); 758 else 759 va = pmap_kenter_temporary(trunc_page(0), i); 760 } 761 762 if ((error = twe_dump_blocks(twe_sc, twed_sc->twed_drive->td_unit, blkno, va, 763 (PAGE_SIZE * dumppages) / TWE_BLOCK_SIZE)) != 0) 764 return(error); 765 766 767 if (dumpstatus(addr, (off_t)count * DEV_BSIZE) < 0) 768 return(EINTR); 769 770 blkno += blkcnt * dumppages; 771 count -= blkcnt * dumppages; 772 addr += PAGE_SIZE * dumppages; 773 } 774 return(0); 775 } 776 777 /******************************************************************************** 778 * Handle completion of an I/O request. 779 */ 780 void 781 twed_intr(twe_bio *bp) 782 { 783 debug_called(4); 784 785 /* if no error, transfer completed */ 786 if (!TWE_BIO_HAS_ERROR(bp)) 787 TWE_BIO_RESID(bp) = 0; 788 789 TWE_BIO_STATS_END(bp); 790 TWE_BIO_DONE(bp); 791 TWED_BIO_OUT; 792 } 793 794 /******************************************************************************** 795 * Default probe stub. 796 */ 797 static int 798 twed_probe(device_t dev) 799 { 800 return (0); 801 } 802 803 /******************************************************************************** 804 * Attach a unit to the controller. 805 */ 806 static int 807 twed_attach(device_t dev) 808 { 809 struct twed_softc *sc; 810 device_t parent; 811 dev_t dsk; 812 813 debug_called(4); 814 815 /* initialise our softc */ 816 sc = device_get_softc(dev); 817 parent = device_get_parent(dev); 818 sc->twed_controller = (struct twe_softc *)device_get_softc(parent); 819 sc->twed_drive = device_get_ivars(dev); 820 sc->twed_dev = dev; 821 822 /* report the drive */ 823 twed_printf(sc, "%uMB (%u sectors)\n", 824 sc->twed_drive->td_size / ((1024 * 1024) / TWE_BLOCK_SIZE), 825 sc->twed_drive->td_size); 826 827 devstat_add_entry(&sc->twed_stats, "twed", device_get_unit(dev), TWE_BLOCK_SIZE, 828 DEVSTAT_NO_ORDERED_TAGS, 829 DEVSTAT_TYPE_STORARRAY | DEVSTAT_TYPE_IF_OTHER, 830 DEVSTAT_PRIORITY_ARRAY); 831 832 /* attach a generic disk device to ourselves */ 833 dsk = disk_create(device_get_unit(dev), &sc->twed_disk, 0, &twed_cdevsw); 834 dsk->si_drv1 = sc; 835 dsk->si_drv2 = &sc->twed_drive->td_unit; 836 sc->twed_dev_t = dsk; 837 838 /* set the maximum I/O size to the theoretical maximum allowed by the S/G list size */ 839 dsk->si_iosize_max = (TWE_MAX_SGL_LENGTH - 1) * PAGE_SIZE; 840 841 return (0); 842 } 843 844 /******************************************************************************** 845 * Disconnect ourselves from the system. 846 */ 847 static int 848 twed_detach(device_t dev) 849 { 850 struct twed_softc *sc = (struct twed_softc *)device_get_softc(dev); 851 852 debug_called(4); 853 854 if (sc->twed_flags & TWED_OPEN) 855 return(EBUSY); 856 857 devstat_remove_entry(&sc->twed_stats); 858 disk_destroy(&sc->twed_disk); 859 860 return(0); 861 } 862 863 /******************************************************************************** 864 ******************************************************************************** 865 Misc 866 ******************************************************************************** 867 ********************************************************************************/ 868 869 static void twe_setup_data_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error); 870 static void twe_setup_request_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error); 871 872 /******************************************************************************** 873 * Malloc space for a command buffer. 874 */ 875 MALLOC_DEFINE(TWE_MALLOC_CLASS, "twe commands", "twe commands"); 876 877 struct twe_request * 878 twe_allocate_request(struct twe_softc *sc) 879 { 880 struct twe_request *tr; 881 int aligned_size; 882 883 /* 884 * TWE requires requests to be 512-byte aligned. Depend on malloc() 885 * guarenteeing alignment for power-of-2 requests. Note that the old 886 * (FreeBSD-4.x) malloc code aligned all requests, but the new slab 887 * allocator only guarentees same-size alignment for power-of-2 requests. 888 */ 889 aligned_size = (sizeof(struct twe_request) + TWE_ALIGNMASK) & 890 ~TWE_ALIGNMASK; 891 tr = malloc(aligned_size, TWE_MALLOC_CLASS, M_INTWAIT|M_ZERO); 892 tr->tr_sc = sc; 893 if (bus_dmamap_create(sc->twe_buffer_dmat, 0, &tr->tr_cmdmap)) { 894 twe_free_request(tr); 895 return(NULL); 896 } 897 if (bus_dmamap_create(sc->twe_buffer_dmat, 0, &tr->tr_dmamap)) { 898 bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_cmdmap); 899 twe_free_request(tr); 900 return(NULL); 901 } 902 return(tr); 903 } 904 905 /******************************************************************************** 906 * Permanently discard a command buffer. 907 */ 908 void 909 twe_free_request(struct twe_request *tr) 910 { 911 struct twe_softc *sc = tr->tr_sc; 912 913 debug_called(4); 914 915 bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_cmdmap); 916 bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_dmamap); 917 free(tr, TWE_MALLOC_CLASS); 918 } 919 920 /******************************************************************************** 921 * Map/unmap (tr)'s command and data in the controller's addressable space. 922 * 923 * These routines ensure that the data which the controller is going to try to 924 * access is actually visible to the controller, in a machine-independant 925 * fashion. Due to a hardware limitation, I/O buffers must be 512-byte aligned 926 * and we take care of that here as well. 927 */ 928 static void 929 twe_fillin_sgl(TWE_SG_Entry *sgl, bus_dma_segment_t *segs, int nsegments, int max_sgl) 930 { 931 int i; 932 933 for (i = 0; i < nsegments; i++) { 934 sgl[i].address = segs[i].ds_addr; 935 sgl[i].length = segs[i].ds_len; 936 } 937 for (; i < max_sgl; i++) { /* XXX necessary? */ 938 sgl[i].address = 0; 939 sgl[i].length = 0; 940 } 941 } 942 943 static void 944 twe_setup_data_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error) 945 { 946 struct twe_request *tr = (struct twe_request *)arg; 947 TWE_Command *cmd = &tr->tr_command; 948 949 debug_called(4); 950 951 /* save base of first segment in command (applicable if there only one segment) */ 952 tr->tr_dataphys = segs[0].ds_addr; 953 954 /* correct command size for s/g list size */ 955 tr->tr_command.generic.size += 2 * nsegments; 956 957 /* 958 * Due to the fact that parameter and I/O commands have the scatter/gather list in 959 * different places, we need to determine which sort of command this actually is 960 * before we can populate it correctly. 961 */ 962 switch(cmd->generic.opcode) { 963 case TWE_OP_GET_PARAM: 964 case TWE_OP_SET_PARAM: 965 cmd->generic.sgl_offset = 2; 966 twe_fillin_sgl(&cmd->param.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH); 967 break; 968 case TWE_OP_READ: 969 case TWE_OP_WRITE: 970 cmd->generic.sgl_offset = 3; 971 twe_fillin_sgl(&cmd->io.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH); 972 break; 973 case TWE_OP_ATA_PASSTHROUGH: 974 cmd->generic.sgl_offset = 5; 975 twe_fillin_sgl(&cmd->ata.sgl[0], segs, nsegments, TWE_MAX_ATA_SGL_LENGTH); 976 break; 977 default: 978 /* 979 * Fall back to what the linux driver does. 980 * Do this because the API may send an opcode 981 * the driver knows nothing about and this will 982 * at least stop PCIABRT's from hosing us. 983 */ 984 switch (cmd->generic.sgl_offset) { 985 case 2: 986 twe_fillin_sgl(&cmd->param.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH); 987 break; 988 case 3: 989 twe_fillin_sgl(&cmd->io.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH); 990 break; 991 case 5: 992 twe_fillin_sgl(&cmd->ata.sgl[0], segs, nsegments, TWE_MAX_ATA_SGL_LENGTH); 993 break; 994 } 995 } 996 } 997 998 static void 999 twe_setup_request_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error) 1000 { 1001 struct twe_request *tr = (struct twe_request *)arg; 1002 1003 debug_called(4); 1004 1005 /* command can't cross a page boundary */ 1006 tr->tr_cmdphys = segs[0].ds_addr; 1007 } 1008 1009 void 1010 twe_map_request(struct twe_request *tr) 1011 { 1012 struct twe_softc *sc = tr->tr_sc; 1013 1014 debug_called(4); 1015 1016 1017 /* 1018 * Map the command into bus space. 1019 */ 1020 bus_dmamap_load(sc->twe_buffer_dmat, tr->tr_cmdmap, &tr->tr_command, sizeof(tr->tr_command), 1021 twe_setup_request_dmamap, tr, 0); 1022 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_cmdmap, BUS_DMASYNC_PREWRITE); 1023 1024 /* 1025 * If the command involves data, map that too. 1026 */ 1027 if (tr->tr_data != NULL) { 1028 1029 /* 1030 * Data must be 512-byte aligned; allocate a fixup buffer if it's not. 1031 */ 1032 if (((vm_offset_t)tr->tr_data % TWE_ALIGNMENT) != 0) { 1033 int aligned_size; 1034 1035 aligned_size = (tr->tr_length + TWE_ALIGNMASK) & ~TWE_ALIGNMASK; 1036 /* save pointer to 'real' data */ 1037 tr->tr_realdata = tr->tr_data; 1038 tr->tr_flags |= TWE_CMD_ALIGNBUF; 1039 tr->tr_data = malloc(aligned_size, TWE_MALLOC_CLASS, M_INTWAIT); 1040 } 1041 1042 /* 1043 * Map the data buffer into bus space and build the s/g list. 1044 */ 1045 bus_dmamap_load(sc->twe_buffer_dmat, tr->tr_dmamap, tr->tr_data, tr->tr_length, 1046 twe_setup_data_dmamap, tr, 0); 1047 if (tr->tr_flags & TWE_CMD_DATAIN) 1048 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_PREREAD); 1049 if (tr->tr_flags & TWE_CMD_DATAOUT) { 1050 /* if we're using an alignment buffer, and we're writing data, copy the real data out */ 1051 if (tr->tr_flags & TWE_CMD_ALIGNBUF) 1052 bcopy(tr->tr_realdata, tr->tr_data, tr->tr_length); 1053 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_PREWRITE); 1054 } 1055 } 1056 } 1057 1058 void 1059 twe_unmap_request(struct twe_request *tr) 1060 { 1061 struct twe_softc *sc = tr->tr_sc; 1062 1063 debug_called(4); 1064 1065 /* 1066 * Unmap the command from bus space. 1067 */ 1068 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_cmdmap, BUS_DMASYNC_POSTWRITE); 1069 bus_dmamap_unload(sc->twe_buffer_dmat, tr->tr_cmdmap); 1070 1071 /* 1072 * If the command involved data, unmap that too. 1073 */ 1074 if (tr->tr_data != NULL) { 1075 1076 if (tr->tr_flags & TWE_CMD_DATAIN) { 1077 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_POSTREAD); 1078 /* if we're using an alignment buffer, and we're reading data, copy the real data in */ 1079 if (tr->tr_flags & TWE_CMD_ALIGNBUF) 1080 bcopy(tr->tr_data, tr->tr_realdata, tr->tr_length); 1081 } 1082 if (tr->tr_flags & TWE_CMD_DATAOUT) 1083 bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_POSTWRITE); 1084 1085 bus_dmamap_unload(sc->twe_buffer_dmat, tr->tr_dmamap); 1086 } 1087 1088 /* free alignment buffer if it was used */ 1089 if (tr->tr_flags & TWE_CMD_ALIGNBUF) { 1090 free(tr->tr_data, TWE_MALLOC_CLASS); 1091 tr->tr_data = tr->tr_realdata; /* restore 'real' data pointer */ 1092 } 1093 } 1094 1095 #ifdef TWE_DEBUG 1096 /******************************************************************************** 1097 * Print current controller status, call from DDB. 1098 */ 1099 void 1100 twe_report(void) 1101 { 1102 struct twe_softc *sc; 1103 int i, s; 1104 1105 s = splbio(); 1106 for (i = 0; (sc = devclass_get_softc(twe_devclass, i)) != NULL; i++) 1107 twe_print_controller(sc); 1108 printf("twed: total bio count in %u out %u\n", twed_bio_in, twed_bio_out); 1109 splx(s); 1110 } 1111 #endif 1112