sys/dev/raid/twe/twe_freebsd.c

   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.14 2005/06/10 17:10:26 swildner 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     error = bus_setup_intr(sc->twe_dev, sc->twe_irq,
 278                            INTR_TYPE_BIO | INTR_ENTROPY, twe_pci_intr, sc,
 279                            &sc->twe_intr, NULL);
 280     if (error) {
 281         twe_printf(sc, "can't set up interrupt\n");
 282         twe_free(sc);
 283         return(ENXIO);
 284     }
 285
 286     /*
 287      * Create DMA tag for mapping objects into controller-addressable space.
 288      */
 289     if (bus_dma_tag_create(sc->twe_parent_dmat,         /* parent */
 290                            1, 0,                        /* alignment, boundary */
 291                            BUS_SPACE_MAXADDR,           /* lowaddr */
 292                            BUS_SPACE_MAXADDR,           /* highaddr */
 293                            NULL, NULL,                  /* filter, filterarg */
 294                            MAXBSIZE, TWE_MAX_SGL_LENGTH,/* maxsize, nsegments */
 295                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 296                            0,                           /* flags */
 297                            &sc->twe_buffer_dmat)) {
 298         twe_printf(sc, "can't allocate data buffer DMA tag\n");
 299         twe_free(sc);
 300         return(ENOMEM);
 301     }
 302
 303     /*
 304      * Initialise the controller and driver core.
 305      */
 306     if ((error = twe_setup(sc)))
 307         return(error);
 308
 309     /*
 310      * Print some information about the controller and configuration.
 311      */
 312     twe_describe_controller(sc);
 313
 314     /*
 315      * Create the control device.
 316      */
 317     cdevsw_add(&twe_cdevsw, -1, device_get_unit(sc->twe_dev));
 318     xdev = make_dev(&twe_cdevsw, device_get_unit(sc->twe_dev),
 319                             UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
 320                             "twe%d", device_get_unit(sc->twe_dev));
 321     xdev->si_drv1 = sc;
 322
 323     /*
 324      * Schedule ourselves to bring the controller up once interrupts are available.
 325      * This isn't strictly necessary, since we disable interrupts while probing the
 326      * controller, but it is more in keeping with common practice for other disk
 327      * devices.
 328      */
 329     sc->twe_ich.ich_func = twe_intrhook;
 330     sc->twe_ich.ich_arg = sc;
 331     sc->twe_ich.ich_desc = "twe";
 332     if (config_intrhook_establish(&sc->twe_ich) != 0) {
 333         twe_printf(sc, "can't establish configuration hook\n");
 334         twe_free(sc);
 335         return(ENXIO);
 336     }
 337
 338     return(0);
 339 }
 340
 341 /********************************************************************************
 342  * Free all of the resources associated with (sc).
 343  *
 344  * Should not be called if the controller is active.
 345  */
 346 static void
 347 twe_free(struct twe_softc *sc)
 348 {
 349     struct twe_request  *tr;
 350
 351     debug_called(4);
 352
 353     /* throw away any command buffers */
 354     while ((tr = twe_dequeue_free(sc)) != NULL)
 355         twe_free_request(tr);
 356
 357     /* destroy the data-transfer DMA tag */
 358     if (sc->twe_buffer_dmat)
 359         bus_dma_tag_destroy(sc->twe_buffer_dmat);
 360
 361     /* disconnect the interrupt handler */
 362     if (sc->twe_intr)
 363         bus_teardown_intr(sc->twe_dev, sc->twe_irq, sc->twe_intr);
 364     if (sc->twe_irq != NULL)
 365         bus_release_resource(sc->twe_dev, SYS_RES_IRQ, 0, sc->twe_irq);
 366
 367     /* destroy the parent DMA tag */
 368     if (sc->twe_parent_dmat)
 369         bus_dma_tag_destroy(sc->twe_parent_dmat);
 370
 371     /* release the register window mapping */
 372     if (sc->twe_io != NULL)
 373         bus_release_resource(sc->twe_dev, SYS_RES_IOPORT, TWE_IO_CONFIG_REG, sc->twe_io);
 374
 375     cdevsw_remove(&twe_cdevsw, -1, device_get_unit(sc->twe_dev));
 376
 377     sysctl_ctx_free(&sc->sysctl_ctx);
 378 }
 379
 380 /********************************************************************************
 381  * Disconnect from the controller completely, in preparation for unload.
 382  */
 383 static int
 384 twe_detach(device_t dev)
 385 {
 386     struct twe_softc    *sc = device_get_softc(dev);
 387     int                 error;
 388
 389     debug_called(4);
 390
 391     error = EBUSY;
 392     crit_enter();
 393     if (sc->twe_state & TWE_STATE_OPEN)
 394         goto out;
 395
 396     /*
 397      * Shut the controller down.
 398      */
 399     twe_shutdown(dev);
 400
 401     twe_free(sc);
 402
 403     error = 0;
 404  out:
 405     crit_exit();
 406     return(error);
 407 }
 408
 409 /********************************************************************************
 410  * Bring the controller down to a dormant state and detach all child devices.
 411  *
 412  * Note that we can assume that the bioq on the controller is empty, as we won't
 413  * allow shutdown if any device is open.
 414  */
 415 static void
 416 twe_shutdown(device_t dev)
 417 {
 418     struct twe_softc    *sc = device_get_softc(dev);
 419     int                 i;
 420
 421     debug_called(4);
 422
 423     crit_enter();
 424
 425     /*
 426      * Delete all our child devices.
 427      */
 428     for (i = 0; i < TWE_MAX_UNITS; i++) {
 429         twe_detach_drive(sc, i);
 430     }
 431
 432     /*
 433      * Bring the controller down.
 434      */
 435     twe_deinit(sc);
 436
 437     crit_exit();
 438 }
 439
 440 /********************************************************************************
 441  * Bring the controller to a quiescent state, ready for system suspend.
 442  */
 443 static int
 444 twe_suspend(device_t dev)
 445 {
 446     struct twe_softc    *sc = device_get_softc(dev);
 447
 448     debug_called(4);
 449
 450     crit_enter();
 451     sc->twe_state |= TWE_STATE_SUSPEND;
 452
 453     twe_disable_interrupts(sc);
 454     crit_exit();
 455
 456     return(0);
 457 }
 458
 459 /********************************************************************************
 460  * Bring the controller back to a state ready for operation.
 461  */
 462 static int
 463 twe_resume(device_t dev)
 464 {
 465     struct twe_softc    *sc = device_get_softc(dev);
 466
 467     debug_called(4);
 468
 469     sc->twe_state &= ~TWE_STATE_SUSPEND;
 470     twe_enable_interrupts(sc);
 471
 472     return(0);
 473 }
 474
 475 /*******************************************************************************
 476  * Take an interrupt, or be poked by other code to look for interrupt-worthy
 477  * status.
 478  */
 479 static void
 480 twe_pci_intr(void *arg)
 481 {
 482     twe_intr((struct twe_softc *)arg);
 483 }
 484
 485 /********************************************************************************
 486  * Delayed-startup hook
 487  */
 488 static void
 489 twe_intrhook(void *arg)
 490 {
 491     struct twe_softc            *sc = (struct twe_softc *)arg;
 492
 493     /* pull ourselves off the intrhook chain */
 494     config_intrhook_disestablish(&sc->twe_ich);
 495
 496     /* call core startup routine */
 497     twe_init(sc);
 498 }
 499
 500 /********************************************************************************
 501  * Given a detected drive, attach it to the bio interface.
 502  *
 503  * This is called from twe_add_unit.
 504  */
 505 void
 506 twe_attach_drive(struct twe_softc *sc, struct twe_drive *dr)
 507 {
 508     char        buf[80];
 509     int         error;
 510
 511     dr->td_disk =  device_add_child(sc->twe_dev, NULL, -1);
 512     if (dr->td_disk == NULL) {
 513         twe_printf(sc, "device_add_child failed\n");
 514         return;
 515     }
 516     device_set_ivars(dr->td_disk, dr);
 517
 518     /*
 519      * XXX It would make sense to test the online/initialising bits, but they seem to be
 520      * always set...
 521      */
 522     sprintf(buf, "Unit %d, %s, %s",
 523             dr->td_unit,
 524             twe_describe_code(twe_table_unittype, dr->td_type),
 525             twe_describe_code(twe_table_unitstate, dr->td_state & TWE_PARAM_UNITSTATUS_MASK));
 526     device_set_desc_copy(dr->td_disk, buf);
 527
 528     if ((error = bus_generic_attach(sc->twe_dev)) != 0)
 529         twe_printf(sc, "bus_generic_attach returned %d\n", error);
 530 }
 531
 532 /********************************************************************************
 533  * Detach the specified unit if it exsists
 534  *
 535  * This is called from twe_del_unit.
 536  */
 537 void
 538 twe_detach_drive(struct twe_softc *sc, int unit)
 539 {
 540
 541     if (sc->twe_drive[unit].td_disk != 0) {
 542         if (device_delete_child(sc->twe_dev, sc->twe_drive[unit].td_disk) != 0)
 543             twe_printf(sc, "failed to delete unit %d\n", unit);
 544         sc->twe_drive[unit].td_disk = 0;
 545     }
 546 }
 547
 548 /********************************************************************************
 549  * Clear a PCI parity error.
 550  */
 551 void
 552 twe_clear_pci_parity_error(struct twe_softc *sc)
 553 {
 554     TWE_CONTROL(sc, TWE_CONTROL_CLEAR_PARITY_ERROR);
 555     pci_write_config(sc->twe_dev, PCIR_STATUS, TWE_PCI_CLEAR_PARITY_ERROR, 2);
 556 }
 557
 558 /********************************************************************************
 559  * Clear a PCI abort.
 560  */
 561 void
 562 twe_clear_pci_abort(struct twe_softc *sc)
 563 {
 564     TWE_CONTROL(sc, TWE_CONTROL_CLEAR_PCI_ABORT);
 565     pci_write_config(sc->twe_dev, PCIR_STATUS, TWE_PCI_CLEAR_PCI_ABORT, 2);
 566 }
 567
 568 /********************************************************************************
 569  ********************************************************************************
 570                                                                       Disk device
 571  ********************************************************************************
 572  ********************************************************************************/
 573
 574 /*
 575  * Disk device softc
 576  */
 577 struct twed_softc
 578 {
 579     device_t            twed_dev;
 580     dev_t               twed_dev_t;
 581     struct twe_softc    *twed_controller;       /* parent device softc */
 582     struct twe_drive    *twed_drive;            /* drive data in parent softc */
 583     struct disk         twed_disk;              /* generic disk handle */
 584     struct devstat      twed_stats;             /* accounting */
 585     struct disklabel    twed_label;             /* synthetic label */
 586     int                 twed_flags;
 587 #define TWED_OPEN       (1<<0)                  /* drive is open (can't shut down) */
 588 };
 589
 590 /*
 591  * Disk device bus interface
 592  */
 593 static int twed_probe(device_t dev);
 594 static int twed_attach(device_t dev);
 595 static int twed_detach(device_t dev);
 596
 597 static device_method_t twed_methods[] = {
 598     DEVMETHOD(device_probe,     twed_probe),
 599     DEVMETHOD(device_attach,    twed_attach),
 600     DEVMETHOD(device_detach,    twed_detach),
 601     { 0, 0 }
 602 };
 603
 604 static driver_t twed_driver = {
 605     "twed",
 606     twed_methods,
 607     sizeof(struct twed_softc)
 608 };
 609
 610 static devclass_t       twed_devclass;
 611 #ifdef TWE_OVERRIDE
 612 DRIVER_MODULE(Xtwed, Xtwe, twed_driver, twed_devclass, 0, 0);
 613 #else
 614 DRIVER_MODULE(twed, twe, twed_driver, twed_devclass, 0, 0);
 615 #endif
 616
 617 /*
 618  * Disk device control interface.
 619  */
 620 static  d_open_t        twed_open;
 621 static  d_close_t       twed_close;
 622 static  d_strategy_t    twed_strategy;
 623 static  d_dump_t        twed_dump;
 624
 625 #define TWED_CDEV_MAJOR 147
 626
 627 static struct cdevsw twed_cdevsw = {
 628     "twed",
 629     TWED_CDEV_MAJOR,
 630     D_DISK,
 631     /* port */  NULL,
 632     /* clone */ NULL,
 633     twed_open,
 634     twed_close,
 635     physread,
 636     physwrite,
 637     noioctl,
 638     nopoll,
 639     nommap,
 640     twed_strategy,
 641     twed_dump,
 642     nopsize,
 643 };
 644
 645
 646 /********************************************************************************
 647  * Handle open from generic layer.
 648  *
 649  * Note that this is typically only called by the diskslice code, and not
 650  * for opens on subdevices (eg. slices, partitions).
 651  */
 652 static int
 653 twed_open(dev_t dev, int flags, int fmt, d_thread_t *td)
 654 {
 655     struct twed_softc   *sc = (struct twed_softc *)dev->si_drv1;
 656     struct disklabel    *label;
 657
 658     debug_called(4);
 659
 660     if (sc == NULL)
 661         return (ENXIO);
 662
 663     /* check that the controller is up and running */
 664     if (sc->twed_controller->twe_state & TWE_STATE_SHUTDOWN)
 665         return(ENXIO);
 666
 667     /* build synthetic label */
 668     label = &sc->twed_disk.d_label;
 669     bzero(label, sizeof(*label));
 670     label->d_type = DTYPE_ESDI;
 671     label->d_secsize    = TWE_BLOCK_SIZE;
 672     label->d_nsectors   = sc->twed_drive->td_sectors;
 673     label->d_ntracks    = sc->twed_drive->td_heads;
 674     label->d_ncylinders = sc->twed_drive->td_cylinders;
 675     label->d_secpercyl  = sc->twed_drive->td_sectors * sc->twed_drive->td_heads;
 676     label->d_secperunit = sc->twed_drive->td_size;
 677
 678     sc->twed_flags |= TWED_OPEN;
 679     return (0);
 680 }
 681
 682 /********************************************************************************
 683  * Handle last close of the disk device.
 684  */
 685 static int
 686 twed_close(dev_t dev, int flags, int fmt, d_thread_t *td)
 687 {
 688     struct twed_softc   *sc = (struct twed_softc *)dev->si_drv1;
 689
 690     debug_called(4);
 691
 692     if (sc == NULL)
 693         return (ENXIO);
 694
 695     sc->twed_flags &= ~TWED_OPEN;
 696     return (0);
 697 }
 698
 699 /********************************************************************************
 700  * Handle an I/O request.
 701  */
 702 static void
 703 twed_strategy(twe_bio *bp)
 704 {
 705     struct twed_softc   *sc = (struct twed_softc *)TWE_BIO_SOFTC(bp);
 706
 707     debug_called(4);
 708
 709     TWED_BIO_IN;
 710
 711     /* bogus disk? */
 712     if (sc == NULL) {
 713         TWE_BIO_SET_ERROR(bp, EINVAL);
 714         printf("twe: bio for invalid disk!\n");
 715         TWE_BIO_DONE(bp);
 716         TWED_BIO_OUT;
 717         return;
 718     }
 719
 720     /* perform accounting */
 721     TWE_BIO_STATS_START(bp);
 722
 723     /* queue the bio on the controller */
 724     twe_enqueue_bio(sc->twed_controller, bp);
 725
 726     /* poke the controller to start I/O */
 727     twe_startio(sc->twed_controller);
 728     return;
 729 }
 730
 731 /********************************************************************************
 732  * System crashdump support
 733  */
 734 int
 735 twed_dump(dev_t dev, u_int count, u_int blkno, u_int secsize)
 736 {
 737     struct twed_softc   *twed_sc = (struct twed_softc *)dev->si_drv1;
 738     struct twe_softc    *twe_sc  = (struct twe_softc *)twed_sc->twed_controller;
 739     vm_paddr_t          addr = 0;
 740     long                blkcnt;
 741     int                 dumppages = MAXDUMPPGS;
 742     int                 error;
 743     int                 i;
 744
 745     if (!twed_sc || !twe_sc)
 746         return(ENXIO);
 747
 748     blkcnt = howmany(PAGE_SIZE, secsize);
 749
 750     while (count > 0) {
 751         caddr_t va = NULL;
 752
 753         if ((count / blkcnt) < dumppages)
 754             dumppages = count / blkcnt;
 755
 756         for (i = 0; i < dumppages; ++i) {
 757             vm_paddr_t a = addr + (i * PAGE_SIZE);
 758             if (is_physical_memory(a))
 759                 va = pmap_kenter_temporary(trunc_page(a), i);
 760             else
 761                 va = pmap_kenter_temporary(trunc_page(0), i);
 762         }
 763
 764         if ((error = twe_dump_blocks(twe_sc, twed_sc->twed_drive->td_unit, blkno, va,
 765                                      (PAGE_SIZE * dumppages) / TWE_BLOCK_SIZE)) != 0)
 766             return(error);
 767
 768
 769         if (dumpstatus(addr, (off_t)count * DEV_BSIZE) < 0)
 770             return(EINTR);
 771
 772         blkno += blkcnt * dumppages;
 773         count -= blkcnt * dumppages;
 774         addr += PAGE_SIZE * dumppages;
 775     }
 776     return(0);
 777 }
 778
 779 /********************************************************************************
 780  * Handle completion of an I/O request.
 781  */
 782 void
 783 twed_intr(twe_bio *bp)
 784 {
 785     debug_called(4);
 786
 787     /* if no error, transfer completed */
 788     if (!TWE_BIO_HAS_ERROR(bp))
 789         TWE_BIO_RESID(bp) = 0;
 790
 791     TWE_BIO_STATS_END(bp);
 792     TWE_BIO_DONE(bp);
 793     TWED_BIO_OUT;
 794 }
 795
 796 /********************************************************************************
 797  * Default probe stub.
 798  */
 799 static int
 800 twed_probe(device_t dev)
 801 {
 802     return (0);
 803 }
 804
 805 /********************************************************************************
 806  * Attach a unit to the controller.
 807  */
 808 static int
 809 twed_attach(device_t dev)
 810 {
 811     struct twed_softc   *sc;
 812     device_t            parent;
 813     dev_t               dsk;
 814
 815     debug_called(4);
 816
 817     /* initialise our softc */
 818     sc = device_get_softc(dev);
 819     parent = device_get_parent(dev);
 820     sc->twed_controller = (struct twe_softc *)device_get_softc(parent);
 821     sc->twed_drive = device_get_ivars(dev);
 822     sc->twed_dev = dev;
 823
 824     /* report the drive */
 825     twed_printf(sc, "%uMB (%u sectors)\n",
 826                 sc->twed_drive->td_size / ((1024 * 1024) / TWE_BLOCK_SIZE),
 827                 sc->twed_drive->td_size);
 828
 829     devstat_add_entry(&sc->twed_stats, "twed", device_get_unit(dev), TWE_BLOCK_SIZE,
 830                       DEVSTAT_NO_ORDERED_TAGS,
 831                       DEVSTAT_TYPE_STORARRAY | DEVSTAT_TYPE_IF_OTHER,
 832                       DEVSTAT_PRIORITY_ARRAY);
 833
 834     /* attach a generic disk device to ourselves */
 835     dsk = disk_create(device_get_unit(dev), &sc->twed_disk, 0, &twed_cdevsw);
 836     dsk->si_drv1 = sc;
 837     dsk->si_drv2 = &sc->twed_drive->td_unit;
 838     sc->twed_dev_t = dsk;
 839
 840     /* set the maximum I/O size to the theoretical maximum allowed by the S/G list size */
 841     dsk->si_iosize_max = (TWE_MAX_SGL_LENGTH - 1) * PAGE_SIZE;
 842
 843     return (0);
 844 }
 845
 846 /********************************************************************************
 847  * Disconnect ourselves from the system.
 848  */
 849 static int
 850 twed_detach(device_t dev)
 851 {
 852     struct twed_softc *sc = (struct twed_softc *)device_get_softc(dev);
 853
 854     debug_called(4);
 855
 856     if (sc->twed_flags & TWED_OPEN)
 857         return(EBUSY);
 858
 859     devstat_remove_entry(&sc->twed_stats);
 860     disk_destroy(&sc->twed_disk);
 861
 862     return(0);
 863 }
 864
 865 /********************************************************************************
 866  ********************************************************************************
 867                                                                              Misc
 868  ********************************************************************************
 869  ********************************************************************************/
 870
 871 static void     twe_setup_data_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error);
 872 static void     twe_setup_request_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error);
 873
 874 /********************************************************************************
 875  * Malloc space for a command buffer.
 876  */
 877 MALLOC_DEFINE(TWE_MALLOC_CLASS, "twe commands", "twe commands");
 878
 879 struct twe_request *
 880 twe_allocate_request(struct twe_softc *sc)
 881 {
 882     struct twe_request  *tr;
 883     int aligned_size;
 884
 885     /*
 886      * TWE requires requests to be 512-byte aligned.  Depend on malloc()
 887      * guarenteeing alignment for power-of-2 requests.  Note that the old
 888      * (FreeBSD-4.x) malloc code aligned all requests, but the new slab
 889      * allocator only guarentees same-size alignment for power-of-2 requests.
 890      */
 891     aligned_size = (sizeof(struct twe_request) + TWE_ALIGNMASK) &
 892                     ~TWE_ALIGNMASK;
 893     tr = malloc(aligned_size, TWE_MALLOC_CLASS, M_INTWAIT|M_ZERO);
 894     tr->tr_sc = sc;
 895     if (bus_dmamap_create(sc->twe_buffer_dmat, 0, &tr->tr_cmdmap)) {
 896         twe_free_request(tr);
 897         return(NULL);
 898     }
 899     if (bus_dmamap_create(sc->twe_buffer_dmat, 0, &tr->tr_dmamap)) {
 900         bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_cmdmap);
 901         twe_free_request(tr);
 902         return(NULL);
 903     }
 904     return(tr);
 905 }
 906
 907 /********************************************************************************
 908  * Permanently discard a command buffer.
 909  */
 910 void
 911 twe_free_request(struct twe_request *tr)
 912 {
 913     struct twe_softc    *sc = tr->tr_sc;
 914
 915     debug_called(4);
 916
 917     bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_cmdmap);
 918     bus_dmamap_destroy(sc->twe_buffer_dmat, tr->tr_dmamap);
 919     free(tr, TWE_MALLOC_CLASS);
 920 }
 921
 922 /********************************************************************************
 923  * Map/unmap (tr)'s command and data in the controller's addressable space.
 924  *
 925  * These routines ensure that the data which the controller is going to try to
 926  * access is actually visible to the controller, in a machine-independant
 927  * fashion.  Due to a hardware limitation, I/O buffers must be 512-byte aligned
 928  * and we take care of that here as well.
 929  */
 930 static void
 931 twe_fillin_sgl(TWE_SG_Entry *sgl, bus_dma_segment_t *segs, int nsegments, int max_sgl)
 932 {
 933     int i;
 934
 935     for (i = 0; i < nsegments; i++) {
 936         sgl[i].address = segs[i].ds_addr;
 937         sgl[i].length = segs[i].ds_len;
 938     }
 939     for (; i < max_sgl; i++) {                          /* XXX necessary? */
 940         sgl[i].address = 0;
 941         sgl[i].length = 0;
 942     }
 943 }
 944
 945 static void
 946 twe_setup_data_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
 947 {
 948     struct twe_request  *tr = (struct twe_request *)arg;
 949     TWE_Command         *cmd = &tr->tr_command;
 950
 951     debug_called(4);
 952
 953     /* save base of first segment in command (applicable if there only one segment) */
 954     tr->tr_dataphys = segs[0].ds_addr;
 955
 956     /* correct command size for s/g list size */
 957     tr->tr_command.generic.size += 2 * nsegments;
 958
 959     /*
 960      * Due to the fact that parameter and I/O commands have the scatter/gather list in
 961      * different places, we need to determine which sort of command this actually is
 962      * before we can populate it correctly.
 963      */
 964     switch(cmd->generic.opcode) {
 965     case TWE_OP_GET_PARAM:
 966     case TWE_OP_SET_PARAM:
 967         cmd->generic.sgl_offset = 2;
 968         twe_fillin_sgl(&cmd->param.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
 969         break;
 970     case TWE_OP_READ:
 971     case TWE_OP_WRITE:
 972         cmd->generic.sgl_offset = 3;
 973         twe_fillin_sgl(&cmd->io.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
 974         break;
 975     case TWE_OP_ATA_PASSTHROUGH:
 976         cmd->generic.sgl_offset = 5;
 977         twe_fillin_sgl(&cmd->ata.sgl[0], segs, nsegments, TWE_MAX_ATA_SGL_LENGTH);
 978         break;
 979     default:
 980         /*
 981          * Fall back to what the linux driver does.
 982          * Do this because the API may send an opcode
 983          * the driver knows nothing about and this will
 984          * at least stop PCIABRT's from hosing us.
 985          */
 986         switch (cmd->generic.sgl_offset) {
 987         case 2:
 988             twe_fillin_sgl(&cmd->param.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
 989             break;
 990         case 3:
 991             twe_fillin_sgl(&cmd->io.sgl[0], segs, nsegments, TWE_MAX_SGL_LENGTH);
 992             break;
 993         case 5:
 994             twe_fillin_sgl(&cmd->ata.sgl[0], segs, nsegments, TWE_MAX_ATA_SGL_LENGTH);
 995             break;
 996         }
 997     }
 998 }
 999
1000 static void
1001 twe_setup_request_dmamap(void *arg, bus_dma_segment_t *segs, int nsegments, int error)
1002 {
1003     struct twe_request  *tr = (struct twe_request *)arg;
1004
1005     debug_called(4);
1006
1007     /* command can't cross a page boundary */
1008     tr->tr_cmdphys = segs[0].ds_addr;
1009 }
1010
1011 void
1012 twe_map_request(struct twe_request *tr)
1013 {
1014     struct twe_softc    *sc = tr->tr_sc;
1015
1016     debug_called(4);
1017
1018
1019     /*
1020      * Map the command into bus space.
1021      */
1022     bus_dmamap_load(sc->twe_buffer_dmat, tr->tr_cmdmap, &tr->tr_command, sizeof(tr->tr_command),
1023                     twe_setup_request_dmamap, tr, 0);
1024     bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_cmdmap, BUS_DMASYNC_PREWRITE);
1025
1026     /*
1027      * If the command involves data, map that too.
1028      */
1029     if (tr->tr_data != NULL) {
1030
1031         /*
1032          * Data must be 512-byte aligned; allocate a fixup buffer if it's not.
1033          */
1034         if (((vm_offset_t)tr->tr_data % TWE_ALIGNMENT) != 0) {
1035             int aligned_size;
1036
1037             aligned_size = (tr->tr_length + TWE_ALIGNMASK) & ~TWE_ALIGNMASK;
1038             /* save pointer to 'real' data */
1039             tr->tr_realdata = tr->tr_data;
1040             tr->tr_flags |= TWE_CMD_ALIGNBUF;
1041             tr->tr_data = malloc(aligned_size, TWE_MALLOC_CLASS, M_INTWAIT);
1042         }
1043
1044         /*
1045          * Map the data buffer into bus space and build the s/g list.
1046          */
1047         bus_dmamap_load(sc->twe_buffer_dmat, tr->tr_dmamap, tr->tr_data, tr->tr_length,
1048                         twe_setup_data_dmamap, tr, 0);
1049         if (tr->tr_flags & TWE_CMD_DATAIN)
1050             bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_PREREAD);
1051         if (tr->tr_flags & TWE_CMD_DATAOUT) {
1052             /* if we're using an alignment buffer, and we're writing data, copy the real data out */
1053             if (tr->tr_flags & TWE_CMD_ALIGNBUF)
1054                 bcopy(tr->tr_realdata, tr->tr_data, tr->tr_length);
1055             bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_PREWRITE);
1056         }
1057     }
1058 }
1059
1060 void
1061 twe_unmap_request(struct twe_request *tr)
1062 {
1063     struct twe_softc    *sc = tr->tr_sc;
1064
1065     debug_called(4);
1066
1067     /*
1068      * Unmap the command from bus space.
1069      */
1070     bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_cmdmap, BUS_DMASYNC_POSTWRITE);
1071     bus_dmamap_unload(sc->twe_buffer_dmat, tr->tr_cmdmap);
1072
1073     /*
1074      * If the command involved data, unmap that too.
1075      */
1076     if (tr->tr_data != NULL) {
1077
1078         if (tr->tr_flags & TWE_CMD_DATAIN) {
1079             bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_POSTREAD);
1080             /* if we're using an alignment buffer, and we're reading data, copy the real data in */
1081             if (tr->tr_flags & TWE_CMD_ALIGNBUF)
1082                 bcopy(tr->tr_data, tr->tr_realdata, tr->tr_length);
1083         }
1084         if (tr->tr_flags & TWE_CMD_DATAOUT)
1085             bus_dmamap_sync(sc->twe_buffer_dmat, tr->tr_dmamap, BUS_DMASYNC_POSTWRITE);
1086
1087         bus_dmamap_unload(sc->twe_buffer_dmat, tr->tr_dmamap);
1088     }
1089
1090     /* free alignment buffer if it was used */
1091     if (tr->tr_flags & TWE_CMD_ALIGNBUF) {
1092         free(tr->tr_data, TWE_MALLOC_CLASS);
1093         tr->tr_data = tr->tr_realdata;          /* restore 'real' data pointer */
1094     }
1095 }
1096
1097 #ifdef TWE_DEBUG
1098 /********************************************************************************
1099  * Print current controller status, call from DDB.
1100  */
1101 void
1102 twe_report(void)
1103 {
1104     struct twe_softc    *sc;
1105     int                 i;
1106
1107     crit_enter();
1108     for (i = 0; (sc = devclass_get_softc(twe_devclass, i)) != NULL; i++)
1109         twe_print_controller(sc);
1110     printf("twed: total bio count in %u  out %u\n", twed_bio_in, twed_bio_out);
1111     crit_exit();
1112 }
1113 #endif