sys/dev/mly/mly.c

   1 /*-
   2  * Copyright (c) 2000, 2001 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$
  28  */
  29
  30 #include <sys/param.h>
  31 #include <sys/systm.h>
  32 #include <sys/malloc.h>
  33 #include <sys/kernel.h>
  34 #include <sys/bus.h>
  35 #include <sys/conf.h>
  36 #include <sys/ctype.h>
  37 #include <sys/devicestat.h>
  38 #include <sys/ioccom.h>
  39 #include <sys/stat.h>
  40
  41 #include <machine/bus_memio.h>
  42 #include <machine/bus.h>
  43 #include <machine/resource.h>
  44 #include <sys/rman.h>
  45
  46 #include <cam/cam.h>
  47 #include <cam/cam_ccb.h>
  48 #include <cam/cam_periph.h>
  49 #include <cam/cam_sim.h>
  50 #include <cam/cam_xpt_sim.h>
  51 #include <cam/scsi/scsi_all.h>
  52 #include <cam/scsi/scsi_message.h>
  53
  54 #include <pci/pcireg.h>
  55 #include <pci/pcivar.h>
  56
  57 #include <dev/mly/mlyreg.h>
  58 #include <dev/mly/mlyio.h>
  59 #include <dev/mly/mlyvar.h>
  60 #include <dev/mly/mly_tables.h>
  61
  62 static int      mly_probe(device_t dev);
  63 static int      mly_attach(device_t dev);
  64 static int      mly_pci_attach(struct mly_softc *sc);
  65 static int      mly_detach(device_t dev);
  66 static int      mly_shutdown(device_t dev);
  67 static void     mly_intr(void *arg);
  68
  69 static int      mly_sg_map(struct mly_softc *sc);
  70 static void     mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
  71 static int      mly_mmbox_map(struct mly_softc *sc);
  72 static void     mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error);
  73 static void     mly_free(struct mly_softc *sc);
  74
  75 static int      mly_get_controllerinfo(struct mly_softc *sc);
  76 static void     mly_scan_devices(struct mly_softc *sc);
  77 static void     mly_rescan_btl(struct mly_softc *sc, int bus, int target);
  78 static void     mly_complete_rescan(struct mly_command *mc);
  79 static int      mly_get_eventstatus(struct mly_softc *sc);
  80 static int      mly_enable_mmbox(struct mly_softc *sc);
  81 static int      mly_flush(struct mly_softc *sc);
  82 static int      mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data,
  83                           size_t datasize, u_int8_t *status, void *sense_buffer, size_t *sense_length);
  84 static void     mly_check_event(struct mly_softc *sc);
  85 static void     mly_fetch_event(struct mly_softc *sc);
  86 static void     mly_complete_event(struct mly_command *mc);
  87 static void     mly_process_event(struct mly_softc *sc, struct mly_event *me);
  88 static void     mly_periodic(void *data);
  89
  90 static int      mly_immediate_command(struct mly_command *mc);
  91 static int      mly_start(struct mly_command *mc);
  92 static void     mly_done(struct mly_softc *sc);
  93 static void     mly_complete(void *context, int pending);
  94
  95 static int      mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp);
  96 static void     mly_release_command(struct mly_command *mc);
  97 static void     mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error);
  98 static int      mly_alloc_commands(struct mly_softc *sc);
  99 static void     mly_release_commands(struct mly_softc *sc);
 100 static void     mly_map_command(struct mly_command *mc);
 101 static void     mly_unmap_command(struct mly_command *mc);
 102
 103 static int      mly_cam_attach(struct mly_softc *sc);
 104 static void     mly_cam_detach(struct mly_softc *sc);
 105 static void     mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target);
 106 static void     mly_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb);
 107 static void     mly_cam_action(struct cam_sim *sim, union ccb *ccb);
 108 static int      mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
 109 static void     mly_cam_poll(struct cam_sim *sim);
 110 static void     mly_cam_complete(struct mly_command *mc);
 111 static struct cam_periph *mly_find_periph(struct mly_softc *sc, int bus, int target);
 112 static int      mly_name_device(struct mly_softc *sc, int bus, int target);
 113
 114 static int      mly_fwhandshake(struct mly_softc *sc);
 115
 116 static void     mly_describe_controller(struct mly_softc *sc);
 117 #ifdef MLY_DEBUG
 118 static void     mly_printstate(struct mly_softc *sc);
 119 static void     mly_print_command(struct mly_command *mc);
 120 static void     mly_print_packet(struct mly_command *mc);
 121 static void     mly_panic(struct mly_softc *sc, char *reason);
 122 #endif
 123 void            mly_print_controller(int controller);
 124
 125
 126 static d_open_t         mly_user_open;
 127 static d_close_t        mly_user_close;
 128 static d_ioctl_t        mly_user_ioctl;
 129 static int      mly_user_command(struct mly_softc *sc, struct mly_user_command *uc);
 130 static int      mly_user_health(struct mly_softc *sc, struct mly_user_health *uh);
 131
 132
 133 static device_method_t mly_methods[] = {
 134     /* Device interface */
 135     DEVMETHOD(device_probe,     mly_probe),
 136     DEVMETHOD(device_attach,    mly_attach),
 137     DEVMETHOD(device_detach,    mly_detach),
 138     DEVMETHOD(device_shutdown,  mly_shutdown),
 139     { 0, 0 }
 140 };
 141
 142 static driver_t mly_pci_driver = {
 143         "mly",
 144         mly_methods,
 145         sizeof(struct mly_softc)
 146 };
 147
 148 static devclass_t       mly_devclass;
 149 DRIVER_MODULE(mly, pci, mly_pci_driver, mly_devclass, 0, 0);
 150
 151 #define MLY_CDEV_MAJOR  158
 152
 153 static struct cdevsw mly_cdevsw = {
 154     mly_user_open,
 155     mly_user_close,
 156     noread,
 157     nowrite,
 158     mly_user_ioctl,
 159     nopoll,
 160     nommap,
 161     nostrategy,
 162     "mly",
 163     MLY_CDEV_MAJOR,
 164     nodump,
 165     nopsize,
 166     0
 167 };
 168
 169 /********************************************************************************
 170  ********************************************************************************
 171                                                                  Device Interface
 172  ********************************************************************************
 173  ********************************************************************************/
 174
 175 static struct mly_ident
 176 {
 177     u_int16_t           vendor;
 178     u_int16_t           device;
 179     u_int16_t           subvendor;
 180     u_int16_t           subdevice;
 181     int                 hwif;
 182     char                *desc;
 183 } mly_identifiers[] = {
 184     {0x1069, 0xba56, 0x1069, 0x0040, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 2000"},
 185     {0x1069, 0xba56, 0x1069, 0x0030, MLY_HWIF_STRONGARM, "Mylex eXtremeRAID 3000"},
 186     {0x1069, 0x0050, 0x1069, 0x0050, MLY_HWIF_I960RX,    "Mylex AcceleRAID 352"},
 187     {0x1069, 0x0050, 0x1069, 0x0052, MLY_HWIF_I960RX,    "Mylex AcceleRAID 170"},
 188     {0x1069, 0x0050, 0x1069, 0x0054, MLY_HWIF_I960RX,    "Mylex AcceleRAID 160"},
 189     {0, 0, 0, 0, 0, 0}
 190 };
 191
 192 /********************************************************************************
 193  * Compare the provided PCI device with the list we support.
 194  */
 195 static int
 196 mly_probe(device_t dev)
 197 {
 198     struct mly_ident    *m;
 199
 200     debug_called(1);
 201
 202     for (m = mly_identifiers; m->vendor != 0; m++) {
 203         if ((m->vendor == pci_get_vendor(dev)) &&
 204             (m->device == pci_get_device(dev)) &&
 205             ((m->subvendor == 0) || ((m->subvendor == pci_get_subvendor(dev)) &&
 206                                      (m->subdevice == pci_get_subdevice(dev))))) {
 207
 208             device_set_desc(dev, m->desc);
 209 #ifdef MLY_MODULE
 210             return(-5);
 211 #else
 212             return(-10);        /* allow room to be overridden */
 213 #endif
 214         }
 215     }
 216     return(ENXIO);
 217 }
 218
 219 /********************************************************************************
 220  * Initialise the controller and softc
 221  */
 222 static int
 223 mly_attach(device_t dev)
 224 {
 225     struct mly_softc    *sc = device_get_softc(dev);
 226     int                 error;
 227
 228     debug_called(1);
 229
 230     sc->mly_dev = dev;
 231
 232 #ifdef MLY_DEBUG
 233     if (device_get_unit(sc->mly_dev) == 0)
 234         mly_softc0 = sc;
 235 #endif
 236
 237     /*
 238      * Do PCI-specific initialisation.
 239      */
 240     if ((error = mly_pci_attach(sc)) != 0)
 241         goto out;
 242
 243     /*
 244      * Initialise per-controller queues.
 245      */
 246     mly_initq_free(sc);
 247     mly_initq_busy(sc);
 248     mly_initq_complete(sc);
 249
 250 #if __FreeBSD_version >= 500005
 251     /*
 252      * Initialise command-completion task.
 253      */
 254     TASK_INIT(&sc->mly_task_complete, 0, mly_complete, sc);
 255 #endif
 256
 257     /* disable interrupts before we start talking to the controller */
 258     MLY_MASK_INTERRUPTS(sc);
 259
 260     /*
 261      * Wait for the controller to come ready, handshake with the firmware if required.
 262      * This is typically only necessary on platforms where the controller BIOS does not
 263      * run.
 264      */
 265     if ((error = mly_fwhandshake(sc)))
 266         goto out;
 267
 268     /*
 269      * Allocate initial command buffers.
 270      */
 271     if ((error = mly_alloc_commands(sc)))
 272         goto out;
 273
 274     /*
 275      * Obtain controller feature information
 276      */
 277     if ((error = mly_get_controllerinfo(sc)))
 278         goto out;
 279
 280     /*
 281      * Reallocate command buffers now we know how many we want.
 282      */
 283     mly_release_commands(sc);
 284     if ((error = mly_alloc_commands(sc)))
 285         goto out;
 286
 287     /*
 288      * Get the current event counter for health purposes, populate the initial
 289      * health status buffer.
 290      */
 291     if ((error = mly_get_eventstatus(sc)))
 292         goto out;
 293
 294     /*
 295      * Enable memory-mailbox mode.
 296      */
 297     if ((error = mly_enable_mmbox(sc)))
 298         goto out;
 299
 300     /*
 301      * Attach to CAM.
 302      */
 303     if ((error = mly_cam_attach(sc)))
 304         goto out;
 305
 306     /*
 307      * Print a little information about the controller
 308      */
 309     mly_describe_controller(sc);
 310
 311     /*
 312      * Mark all attached devices for rescan.
 313      */
 314     mly_scan_devices(sc);
 315
 316     /*
 317      * Instigate the first status poll immediately.  Rescan completions won't
 318      * happen until interrupts are enabled, which should still be before
 319      * the SCSI subsystem gets to us, courtesy of the "SCSI settling delay".
 320      */
 321     mly_periodic((void *)sc);
 322
 323     /*
 324      * Create the control device.
 325      */
 326     sc->mly_dev_t = make_dev(&mly_cdevsw, device_get_unit(sc->mly_dev), UID_ROOT, GID_OPERATOR,
 327                              S_IRUSR | S_IWUSR, "mly%d", device_get_unit(sc->mly_dev));
 328     sc->mly_dev_t->si_drv1 = sc;
 329
 330     /* enable interrupts now */
 331     MLY_UNMASK_INTERRUPTS(sc);
 332
 333  out:
 334     if (error != 0)
 335         mly_free(sc);
 336     return(error);
 337 }
 338
 339 /********************************************************************************
 340  * Perform PCI-specific initialisation.
 341  */
 342 static int
 343 mly_pci_attach(struct mly_softc *sc)
 344 {
 345     int                 i, error;
 346     u_int32_t           command;
 347
 348     debug_called(1);
 349
 350     /* assume failure is 'not configured' */
 351     error = ENXIO;
 352
 353     /*
 354      * Verify that the adapter is correctly set up in PCI space.
 355      *
 356      * XXX we shouldn't do this; the PCI code should.
 357      */
 358     command = pci_read_config(sc->mly_dev, PCIR_COMMAND, 2);
 359     command |= PCIM_CMD_BUSMASTEREN;
 360     pci_write_config(sc->mly_dev, PCIR_COMMAND, command, 2);
 361     command = pci_read_config(sc->mly_dev, PCIR_COMMAND, 2);
 362     if (!(command & PCIM_CMD_BUSMASTEREN)) {
 363         mly_printf(sc, "can't enable busmaster feature\n");
 364         goto fail;
 365     }
 366     if ((command & PCIM_CMD_MEMEN) == 0) {
 367         mly_printf(sc, "memory window not available\n");
 368         goto fail;
 369     }
 370
 371     /*
 372      * Allocate the PCI register window.
 373      */
 374     sc->mly_regs_rid = PCIR_MAPS;       /* first base address register */
 375     if ((sc->mly_regs_resource = bus_alloc_resource(sc->mly_dev, SYS_RES_MEMORY, &sc->mly_regs_rid,
 376                                                     0, ~0, 1, RF_ACTIVE)) == NULL) {
 377         mly_printf(sc, "can't allocate register window\n");
 378         goto fail;
 379     }
 380     sc->mly_btag = rman_get_bustag(sc->mly_regs_resource);
 381     sc->mly_bhandle = rman_get_bushandle(sc->mly_regs_resource);
 382
 383     /*
 384      * Allocate and connect our interrupt.
 385      */
 386     sc->mly_irq_rid = 0;
 387     if ((sc->mly_irq = bus_alloc_resource(sc->mly_dev, SYS_RES_IRQ, &sc->mly_irq_rid,
 388                                           0, ~0, 1, RF_SHAREABLE | RF_ACTIVE)) == NULL) {
 389         mly_printf(sc, "can't allocate interrupt\n");
 390         goto fail;
 391     }
 392     if (bus_setup_intr(sc->mly_dev, sc->mly_irq, INTR_TYPE_CAM | INTR_ENTROPY,  mly_intr, sc, &sc->mly_intr)) {
 393         mly_printf(sc, "can't set up interrupt\n");
 394         goto fail;
 395     }
 396
 397     /* assume failure is 'out of memory' */
 398     error = ENOMEM;
 399
 400     /*
 401      * Allocate the parent bus DMA tag appropriate for our PCI interface.
 402      *
 403      * Note that all of these controllers are 64-bit capable.
 404      */
 405     if (bus_dma_tag_create(NULL,                        /* parent */
 406                            1, 0,                        /* alignment, boundary */
 407                            BUS_SPACE_MAXADDR_32BIT,     /* lowaddr */
 408                            BUS_SPACE_MAXADDR,           /* highaddr */
 409                            NULL, NULL,                  /* filter, filterarg */
 410                            MAXBSIZE, MLY_MAX_SGENTRIES, /* maxsize, nsegments */
 411                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 412                            BUS_DMA_ALLOCNOW,            /* flags */
 413                            &sc->mly_parent_dmat)) {
 414         mly_printf(sc, "can't allocate parent DMA tag\n");
 415         goto fail;
 416     }
 417
 418     /*
 419      * Create DMA tag for mapping buffers into controller-addressable space.
 420      */
 421     if (bus_dma_tag_create(sc->mly_parent_dmat,         /* parent */
 422                            1, 0,                        /* alignment, boundary */
 423                            BUS_SPACE_MAXADDR,           /* lowaddr */
 424                            BUS_SPACE_MAXADDR,           /* highaddr */
 425                            NULL, NULL,                  /* filter, filterarg */
 426                            MAXBSIZE, MLY_MAX_SGENTRIES, /* maxsize, nsegments */
 427                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 428                            0,                           /* flags */
 429                            &sc->mly_buffer_dmat)) {
 430         mly_printf(sc, "can't allocate buffer DMA tag\n");
 431         goto fail;
 432     }
 433
 434     /*
 435      * Initialise the DMA tag for command packets.
 436      */
 437     if (bus_dma_tag_create(sc->mly_parent_dmat,         /* parent */
 438                            1, 0,                        /* alignment, boundary */
 439                            BUS_SPACE_MAXADDR,           /* lowaddr */
 440                            BUS_SPACE_MAXADDR,           /* highaddr */
 441                            NULL, NULL,                  /* filter, filterarg */
 442                            sizeof(union mly_command_packet) * MLY_MAX_COMMANDS, 1,      /* maxsize, nsegments */
 443                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 444                            0,                           /* flags */
 445                            &sc->mly_packet_dmat)) {
 446         mly_printf(sc, "can't allocate command packet DMA tag\n");
 447         goto fail;
 448     }
 449
 450     /*
 451      * Detect the hardware interface version
 452      */
 453     for (i = 0; mly_identifiers[i].vendor != 0; i++) {
 454         if ((mly_identifiers[i].vendor == pci_get_vendor(sc->mly_dev)) &&
 455             (mly_identifiers[i].device == pci_get_device(sc->mly_dev))) {
 456             sc->mly_hwif = mly_identifiers[i].hwif;
 457             switch(sc->mly_hwif) {
 458             case MLY_HWIF_I960RX:
 459                 debug(1, "set hardware up for i960RX");
 460                 sc->mly_doorbell_true = 0x00;
 461                 sc->mly_command_mailbox =  MLY_I960RX_COMMAND_MAILBOX;
 462                 sc->mly_status_mailbox =   MLY_I960RX_STATUS_MAILBOX;
 463                 sc->mly_idbr =             MLY_I960RX_IDBR;
 464                 sc->mly_odbr =             MLY_I960RX_ODBR;
 465                 sc->mly_error_status =     MLY_I960RX_ERROR_STATUS;
 466                 sc->mly_interrupt_status = MLY_I960RX_INTERRUPT_STATUS;
 467                 sc->mly_interrupt_mask =   MLY_I960RX_INTERRUPT_MASK;
 468                 break;
 469             case MLY_HWIF_STRONGARM:
 470                 debug(1, "set hardware up for StrongARM");
 471                 sc->mly_doorbell_true = 0xff;           /* doorbell 'true' is 0 */
 472                 sc->mly_command_mailbox =  MLY_STRONGARM_COMMAND_MAILBOX;
 473                 sc->mly_status_mailbox =   MLY_STRONGARM_STATUS_MAILBOX;
 474                 sc->mly_idbr =             MLY_STRONGARM_IDBR;
 475                 sc->mly_odbr =             MLY_STRONGARM_ODBR;
 476                 sc->mly_error_status =     MLY_STRONGARM_ERROR_STATUS;
 477                 sc->mly_interrupt_status = MLY_STRONGARM_INTERRUPT_STATUS;
 478                 sc->mly_interrupt_mask =   MLY_STRONGARM_INTERRUPT_MASK;
 479                 break;
 480             }
 481             break;
 482         }
 483     }
 484
 485     /*
 486      * Create the scatter/gather mappings.
 487      */
 488     if ((error = mly_sg_map(sc)))
 489         goto fail;
 490
 491     /*
 492      * Allocate and map the memory mailbox
 493      */
 494     if ((error = mly_mmbox_map(sc)))
 495         goto fail;
 496
 497     error = 0;
 498
 499 fail:
 500     return(error);
 501 }
 502
 503 /********************************************************************************
 504  * Shut the controller down and detach all our resources.
 505  */
 506 static int
 507 mly_detach(device_t dev)
 508 {
 509     int                 error;
 510
 511     if ((error = mly_shutdown(dev)) != 0)
 512         return(error);
 513
 514     mly_free(device_get_softc(dev));
 515     return(0);
 516 }
 517
 518 /********************************************************************************
 519  * Bring the controller to a state where it can be safely left alone.
 520  *
 521  * Note that it should not be necessary to wait for any outstanding commands,
 522  * as they should be completed prior to calling here.
 523  *
 524  * XXX this applies for I/O, but not status polls; we should beware of
 525  *     the case where a status command is running while we detach.
 526  */
 527 static int
 528 mly_shutdown(device_t dev)
 529 {
 530     struct mly_softc    *sc = device_get_softc(dev);
 531
 532     debug_called(1);
 533
 534     if (sc->mly_state & MLY_STATE_OPEN)
 535         return(EBUSY);
 536
 537     /* kill the periodic event */
 538     untimeout(mly_periodic, sc, sc->mly_periodic);
 539
 540     /* flush controller */
 541     mly_printf(sc, "flushing cache...");
 542     printf("%s\n", mly_flush(sc) ? "failed" : "done");
 543
 544     MLY_MASK_INTERRUPTS(sc);
 545
 546     return(0);
 547 }
 548
 549 /*******************************************************************************
 550  * Take an interrupt, or be poked by other code to look for interrupt-worthy
 551  * status.
 552  */
 553 static void
 554 mly_intr(void *arg)
 555 {
 556     struct mly_softc    *sc = (struct mly_softc *)arg;
 557
 558     debug_called(2);
 559
 560     mly_done(sc);
 561 };
 562
 563 /********************************************************************************
 564  ********************************************************************************
 565                                                 Bus-dependant Resource Management
 566  ********************************************************************************
 567  ********************************************************************************/
 568
 569 /********************************************************************************
 570  * Allocate memory for the scatter/gather tables
 571  */
 572 static int
 573 mly_sg_map(struct mly_softc *sc)
 574 {
 575     size_t      segsize;
 576
 577     debug_called(1);
 578
 579     /*
 580      * Create a single tag describing a region large enough to hold all of
 581      * the s/g lists we will need.
 582      */
 583     segsize = sizeof(struct mly_sg_entry) * MLY_MAX_COMMANDS * MLY_MAX_SGENTRIES;
 584     if (bus_dma_tag_create(sc->mly_parent_dmat,         /* parent */
 585                            1, 0,                        /* alignment, boundary */
 586                            BUS_SPACE_MAXADDR,           /* lowaddr */
 587                            BUS_SPACE_MAXADDR,           /* highaddr */
 588                            NULL, NULL,                  /* filter, filterarg */
 589                            segsize, 1,                  /* maxsize, nsegments */
 590                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 591                            0,                           /* flags */
 592                            &sc->mly_sg_dmat)) {
 593         mly_printf(sc, "can't allocate scatter/gather DMA tag\n");
 594         return(ENOMEM);
 595     }
 596
 597     /*
 598      * Allocate enough s/g maps for all commands and permanently map them into
 599      * controller-visible space.
 600      *
 601      * XXX this assumes we can get enough space for all the s/g maps in one
 602      * contiguous slab.
 603      */
 604     if (bus_dmamem_alloc(sc->mly_sg_dmat, (void **)&sc->mly_sg_table, BUS_DMA_NOWAIT, &sc->mly_sg_dmamap)) {
 605         mly_printf(sc, "can't allocate s/g table\n");
 606         return(ENOMEM);
 607     }
 608     bus_dmamap_load(sc->mly_sg_dmat, sc->mly_sg_dmamap, sc->mly_sg_table, segsize, mly_sg_map_helper, sc, 0);
 609     return(0);
 610 }
 611
 612 /********************************************************************************
 613  * Save the physical address of the base of the s/g table.
 614  */
 615 static void
 616 mly_sg_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
 617 {
 618     struct mly_softc    *sc = (struct mly_softc *)arg;
 619
 620     debug_called(1);
 621
 622     /* save base of s/g table's address in bus space */
 623     sc->mly_sg_busaddr = segs->ds_addr;
 624 }
 625
 626 /********************************************************************************
 627  * Allocate memory for the memory-mailbox interface
 628  */
 629 static int
 630 mly_mmbox_map(struct mly_softc *sc)
 631 {
 632
 633     /*
 634      * Create a DMA tag for a single contiguous region large enough for the
 635      * memory mailbox structure.
 636      */
 637     if (bus_dma_tag_create(sc->mly_parent_dmat,         /* parent */
 638                            1, 0,                        /* alignment, boundary */
 639                            BUS_SPACE_MAXADDR,           /* lowaddr */
 640                            BUS_SPACE_MAXADDR,           /* highaddr */
 641                            NULL, NULL,                  /* filter, filterarg */
 642                            sizeof(struct mly_mmbox), 1, /* maxsize, nsegments */
 643                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 644                            0,                           /* flags */
 645                            &sc->mly_mmbox_dmat)) {
 646         mly_printf(sc, "can't allocate memory mailbox DMA tag\n");
 647         return(ENOMEM);
 648     }
 649
 650     /*
 651      * Allocate the buffer
 652      */
 653     if (bus_dmamem_alloc(sc->mly_mmbox_dmat, (void **)&sc->mly_mmbox, BUS_DMA_NOWAIT, &sc->mly_mmbox_dmamap)) {
 654         mly_printf(sc, "can't allocate memory mailbox\n");
 655         return(ENOMEM);
 656     }
 657     bus_dmamap_load(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap, sc->mly_mmbox, sizeof(struct mly_mmbox),
 658                     mly_mmbox_map_helper, sc, 0);
 659     bzero(sc->mly_mmbox, sizeof(*sc->mly_mmbox));
 660     return(0);
 661
 662 }
 663
 664 /********************************************************************************
 665  * Save the physical address of the memory mailbox
 666  */
 667 static void
 668 mly_mmbox_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
 669 {
 670     struct mly_softc    *sc = (struct mly_softc *)arg;
 671
 672     debug_called(1);
 673
 674     sc->mly_mmbox_busaddr = segs->ds_addr;
 675 }
 676
 677 /********************************************************************************
 678  * Free all of the resources associated with (sc)
 679  *
 680  * Should not be called if the controller is active.
 681  */
 682 static void
 683 mly_free(struct mly_softc *sc)
 684 {
 685
 686     debug_called(1);
 687
 688     /* detach from CAM */
 689     mly_cam_detach(sc);
 690
 691     /* release command memory */
 692     mly_release_commands(sc);
 693
 694     /* throw away the controllerinfo structure */
 695     if (sc->mly_controllerinfo != NULL)
 696         free(sc->mly_controllerinfo, M_DEVBUF);
 697
 698     /* throw away the controllerparam structure */
 699     if (sc->mly_controllerparam != NULL)
 700         free(sc->mly_controllerparam, M_DEVBUF);
 701
 702     /* destroy data-transfer DMA tag */
 703     if (sc->mly_buffer_dmat)
 704         bus_dma_tag_destroy(sc->mly_buffer_dmat);
 705
 706     /* free and destroy DMA memory and tag for s/g lists */
 707     if (sc->mly_sg_table) {
 708         bus_dmamap_unload(sc->mly_sg_dmat, sc->mly_sg_dmamap);
 709         bus_dmamem_free(sc->mly_sg_dmat, sc->mly_sg_table, sc->mly_sg_dmamap);
 710     }
 711     if (sc->mly_sg_dmat)
 712         bus_dma_tag_destroy(sc->mly_sg_dmat);
 713
 714     /* free and destroy DMA memory and tag for memory mailbox */
 715     if (sc->mly_mmbox) {
 716         bus_dmamap_unload(sc->mly_mmbox_dmat, sc->mly_mmbox_dmamap);
 717         bus_dmamem_free(sc->mly_mmbox_dmat, sc->mly_mmbox, sc->mly_mmbox_dmamap);
 718     }
 719     if (sc->mly_mmbox_dmat)
 720         bus_dma_tag_destroy(sc->mly_mmbox_dmat);
 721
 722     /* disconnect the interrupt handler */
 723     if (sc->mly_intr)
 724         bus_teardown_intr(sc->mly_dev, sc->mly_irq, sc->mly_intr);
 725     if (sc->mly_irq != NULL)
 726         bus_release_resource(sc->mly_dev, SYS_RES_IRQ, sc->mly_irq_rid, sc->mly_irq);
 727
 728     /* destroy the parent DMA tag */
 729     if (sc->mly_parent_dmat)
 730         bus_dma_tag_destroy(sc->mly_parent_dmat);
 731
 732     /* release the register window mapping */
 733     if (sc->mly_regs_resource != NULL)
 734         bus_release_resource(sc->mly_dev, SYS_RES_MEMORY, sc->mly_regs_rid, sc->mly_regs_resource);
 735 }
 736
 737 /********************************************************************************
 738  ********************************************************************************
 739                                                                  Command Wrappers
 740  ********************************************************************************
 741  ********************************************************************************/
 742
 743 /********************************************************************************
 744  * Fill in the mly_controllerinfo and mly_controllerparam fields in the softc.
 745  */
 746 static int
 747 mly_get_controllerinfo(struct mly_softc *sc)
 748 {
 749     struct mly_command_ioctl    mci;
 750     u_int8_t                    status;
 751     int                         error;
 752
 753     debug_called(1);
 754
 755     if (sc->mly_controllerinfo != NULL)
 756         free(sc->mly_controllerinfo, M_DEVBUF);
 757
 758     /* build the getcontrollerinfo ioctl and send it */
 759     bzero(&mci, sizeof(mci));
 760     sc->mly_controllerinfo = NULL;
 761     mci.sub_ioctl = MDACIOCTL_GETCONTROLLERINFO;
 762     if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerinfo, sizeof(*sc->mly_controllerinfo),
 763                            &status, NULL, NULL)))
 764         return(error);
 765     if (status != 0)
 766         return(EIO);
 767
 768     if (sc->mly_controllerparam != NULL)
 769         free(sc->mly_controllerparam, M_DEVBUF);
 770
 771     /* build the getcontrollerparameter ioctl and send it */
 772     bzero(&mci, sizeof(mci));
 773     sc->mly_controllerparam = NULL;
 774     mci.sub_ioctl = MDACIOCTL_GETCONTROLLERPARAMETER;
 775     if ((error = mly_ioctl(sc, &mci, (void **)&sc->mly_controllerparam, sizeof(*sc->mly_controllerparam),
 776                            &status, NULL, NULL)))
 777         return(error);
 778     if (status != 0)
 779         return(EIO);
 780
 781     return(0);
 782 }
 783
 784 /********************************************************************************
 785  * Schedule all possible devices for a rescan.
 786  *
 787  */
 788 static void
 789 mly_scan_devices(struct mly_softc *sc)
 790 {
 791     int         bus, target;
 792
 793     debug_called(1);
 794
 795     /*
 796      * Clear any previous BTL information.
 797      */
 798     bzero(&sc->mly_btl, sizeof(sc->mly_btl));
 799
 800     /*
 801      * Mark all devices as requiring a rescan, and let the next
 802      * periodic scan collect them.
 803      */
 804     for (bus = 0; bus < sc->mly_cam_channels; bus++)
 805         if (MLY_BUS_IS_VALID(sc, bus))
 806             for (target = 0; target < MLY_MAX_TARGETS; target++)
 807                 sc->mly_btl[bus][target].mb_flags = MLY_BTL_RESCAN;
 808
 809 }
 810
 811 /********************************************************************************
 812  * Rescan a device, possibly as a consequence of getting an event which suggests
 813  * that it may have changed.
 814  *
 815  * If we suffer resource starvation, we can abandon the rescan as we'll be
 816  * retried.
 817  */
 818 static void
 819 mly_rescan_btl(struct mly_softc *sc, int bus, int target)
 820 {
 821     struct mly_command          *mc;
 822     struct mly_command_ioctl    *mci;
 823
 824     debug_called(1);
 825
 826     /* check that this bus is valid */
 827     if (!MLY_BUS_IS_VALID(sc, bus))
 828         return;
 829
 830     /* get a command */
 831     if (mly_alloc_command(sc, &mc))
 832         return;
 833
 834     /* set up the data buffer */
 835     if ((mc->mc_data = malloc(sizeof(union mly_devinfo), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
 836         mly_release_command(mc);
 837         return;
 838     }
 839     mc->mc_flags |= MLY_CMD_DATAIN;
 840     mc->mc_complete = mly_complete_rescan;
 841
 842     /*
 843      * Build the ioctl.
 844      */
 845     mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
 846     mci->opcode = MDACMD_IOCTL;
 847     mci->addr.phys.controller = 0;
 848     mci->timeout.value = 30;
 849     mci->timeout.scale = MLY_TIMEOUT_SECONDS;
 850     if (MLY_BUS_IS_VIRTUAL(sc, bus)) {
 851         mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getlogdevinfovalid);
 852         mci->sub_ioctl = MDACIOCTL_GETLOGDEVINFOVALID;
 853         mci->addr.log.logdev = MLY_LOGDEV_ID(sc, bus, target);
 854         debug(1, "logical device %d", mci->addr.log.logdev);
 855     } else {
 856         mc->mc_length = mci->data_size = sizeof(struct mly_ioctl_getphysdevinfovalid);
 857         mci->sub_ioctl = MDACIOCTL_GETPHYSDEVINFOVALID;
 858         mci->addr.phys.lun = 0;
 859         mci->addr.phys.target = target;
 860         mci->addr.phys.channel = bus;
 861         debug(1, "physical device %d:%d", mci->addr.phys.channel, mci->addr.phys.target);
 862     }
 863
 864     /*
 865      * Dispatch the command.  If we successfully send the command, clear the rescan
 866      * bit.
 867      */
 868     if (mly_start(mc) != 0) {
 869         mly_release_command(mc);
 870     } else {
 871         sc->mly_btl[bus][target].mb_flags &= ~MLY_BTL_RESCAN;   /* success */
 872     }
 873 }
 874
 875 /********************************************************************************
 876  * Handle the completion of a rescan operation
 877  */
 878 static void
 879 mly_complete_rescan(struct mly_command *mc)
 880 {
 881     struct mly_softc                            *sc = mc->mc_sc;
 882     struct mly_ioctl_getlogdevinfovalid         *ldi;
 883     struct mly_ioctl_getphysdevinfovalid        *pdi;
 884     struct mly_command_ioctl                    *mci;
 885     struct mly_btl                              btl, *btlp;
 886     int                                         bus, target, rescan;
 887
 888     debug_called(1);
 889
 890     /*
 891      * Recover the bus and target from the command.  We need these even in
 892      * the case where we don't have a useful response.
 893      */
 894     mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
 895     if (mci->sub_ioctl == MDACIOCTL_GETLOGDEVINFOVALID) {
 896         bus = MLY_LOGDEV_BUS(sc, mci->addr.log.logdev);
 897         target = MLY_LOGDEV_TARGET(sc, mci->addr.log.logdev);
 898     } else {
 899         bus = mci->addr.phys.channel;
 900         target = mci->addr.phys.target;
 901     }
 902     /* XXX validate bus/target? */
 903
 904     /* the default result is 'no device' */
 905     bzero(&btl, sizeof(btl));
 906
 907     /* if the rescan completed OK, we have possibly-new BTL data */
 908     if (mc->mc_status == 0) {
 909         if (mc->mc_length == sizeof(*ldi)) {
 910             ldi = (struct mly_ioctl_getlogdevinfovalid *)mc->mc_data;
 911             if ((MLY_LOGDEV_BUS(sc, ldi->logical_device_number) != bus) ||
 912                 (MLY_LOGDEV_TARGET(sc, ldi->logical_device_number) != target)) {
 913                 mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
 914                            bus, target, MLY_LOGDEV_BUS(sc, ldi->logical_device_number),
 915                            MLY_LOGDEV_TARGET(sc, ldi->logical_device_number));
 916                 /* XXX what can we do about this? */
 917             }
 918             btl.mb_flags = MLY_BTL_LOGICAL;
 919             btl.mb_type = ldi->raid_level;
 920             btl.mb_state = ldi->state;
 921             debug(1, "BTL rescan for %d returns %s, %s", ldi->logical_device_number,
 922                   mly_describe_code(mly_table_device_type, ldi->raid_level),
 923                   mly_describe_code(mly_table_device_state, ldi->state));
 924         } else if (mc->mc_length == sizeof(*pdi)) {
 925             pdi = (struct mly_ioctl_getphysdevinfovalid *)mc->mc_data;
 926             if ((pdi->channel != bus) || (pdi->target != target)) {
 927                 mly_printf(sc, "WARNING: BTL rescan for %d:%d returned data for %d:%d instead\n",
 928                            bus, target, pdi->channel, pdi->target);
 929                 /* XXX what can we do about this? */
 930             }
 931             btl.mb_flags = MLY_BTL_PHYSICAL;
 932             btl.mb_type = MLY_DEVICE_TYPE_PHYSICAL;
 933             btl.mb_state = pdi->state;
 934             btl.mb_speed = pdi->speed;
 935             btl.mb_width = pdi->width;
 936             if (pdi->state != MLY_DEVICE_STATE_UNCONFIGURED)
 937                 sc->mly_btl[bus][target].mb_flags |= MLY_BTL_PROTECTED;
 938             debug(1, "BTL rescan for %d:%d returns %s", bus, target,
 939                   mly_describe_code(mly_table_device_state, pdi->state));
 940         } else {
 941             mly_printf(sc, "BTL rescan result invalid\n");
 942         }
 943     }
 944
 945     free(mc->mc_data, M_DEVBUF);
 946     mly_release_command(mc);
 947
 948     /*
 949      * Decide whether we need to rescan the device.
 950      */
 951     rescan = 0;
 952
 953     /* device type changes (usually between 'nothing' and 'something') */
 954     btlp = &sc->mly_btl[bus][target];
 955     if (btl.mb_flags != btlp->mb_flags) {
 956         debug(1, "flags changed, rescanning");
 957         rescan = 1;
 958     }
 959
 960     /* XXX other reasons? */
 961
 962     /*
 963      * Update BTL information.
 964      */
 965     *btlp = btl;
 966
 967     /*
 968      * Perform CAM rescan if required.
 969      */
 970     if (rescan)
 971         mly_cam_rescan_btl(sc, bus, target);
 972 }
 973
 974 /********************************************************************************
 975  * Get the current health status and set the 'next event' counter to suit.
 976  */
 977 static int
 978 mly_get_eventstatus(struct mly_softc *sc)
 979 {
 980     struct mly_command_ioctl    mci;
 981     struct mly_health_status    *mh;
 982     u_int8_t                    status;
 983     int                         error;
 984
 985     /* build the gethealthstatus ioctl and send it */
 986     bzero(&mci, sizeof(mci));
 987     mh = NULL;
 988     mci.sub_ioctl = MDACIOCTL_GETHEALTHSTATUS;
 989
 990     if ((error = mly_ioctl(sc, &mci, (void **)&mh, sizeof(*mh), &status, NULL, NULL)))
 991         return(error);
 992     if (status != 0)
 993         return(EIO);
 994
 995     /* get the event counter */
 996     sc->mly_event_change = mh->change_counter;
 997     sc->mly_event_waiting = mh->next_event;
 998     sc->mly_event_counter = mh->next_event;
 999
1000     /* save the health status into the memory mailbox */
1001     bcopy(mh, &sc->mly_mmbox->mmm_health.status, sizeof(*mh));
1002
1003     debug(1, "initial change counter %d, event counter %d", mh->change_counter, mh->next_event);
1004
1005     free(mh, M_DEVBUF);
1006     return(0);
1007 }
1008
1009 /********************************************************************************
1010  * Enable the memory mailbox mode.
1011  */
1012 static int
1013 mly_enable_mmbox(struct mly_softc *sc)
1014 {
1015     struct mly_command_ioctl    mci;
1016     u_int8_t                    *sp, status;
1017     int                         error;
1018
1019     debug_called(1);
1020
1021     /* build the ioctl and send it */
1022     bzero(&mci, sizeof(mci));
1023     mci.sub_ioctl = MDACIOCTL_SETMEMORYMAILBOX;
1024     /* set buffer addresses */
1025     mci.param.setmemorymailbox.command_mailbox_physaddr =
1026         sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_command);
1027     mci.param.setmemorymailbox.status_mailbox_physaddr =
1028         sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_status);
1029     mci.param.setmemorymailbox.health_buffer_physaddr =
1030         sc->mly_mmbox_busaddr + offsetof(struct mly_mmbox, mmm_health);
1031
1032     /* set buffer sizes - abuse of data_size field is revolting */
1033     sp = (u_int8_t *)&mci.data_size;
1034     sp[0] = ((sizeof(union mly_command_packet) * MLY_MMBOX_COMMANDS) / 1024);
1035     sp[1] = (sizeof(union mly_status_packet) * MLY_MMBOX_STATUS) / 1024;
1036     mci.param.setmemorymailbox.health_buffer_size = sizeof(union mly_health_region) / 1024;
1037
1038     debug(1, "memory mailbox at %p (0x%llx/%d 0x%llx/%d 0x%llx/%d", sc->mly_mmbox,
1039           mci.param.setmemorymailbox.command_mailbox_physaddr, sp[0],
1040           mci.param.setmemorymailbox.status_mailbox_physaddr, sp[1],
1041           mci.param.setmemorymailbox.health_buffer_physaddr,
1042           mci.param.setmemorymailbox.health_buffer_size);
1043
1044     if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1045         return(error);
1046     if (status != 0)
1047         return(EIO);
1048     sc->mly_state |= MLY_STATE_MMBOX_ACTIVE;
1049     debug(1, "memory mailbox active");
1050     return(0);
1051 }
1052
1053 /********************************************************************************
1054  * Flush all pending I/O from the controller.
1055  */
1056 static int
1057 mly_flush(struct mly_softc *sc)
1058 {
1059     struct mly_command_ioctl    mci;
1060     u_int8_t                    status;
1061     int                         error;
1062
1063     debug_called(1);
1064
1065     /* build the ioctl */
1066     bzero(&mci, sizeof(mci));
1067     mci.sub_ioctl = MDACIOCTL_FLUSHDEVICEDATA;
1068     mci.param.deviceoperation.operation_device = MLY_OPDEVICE_PHYSICAL_CONTROLLER;
1069
1070     /* pass it off to the controller */
1071     if ((error = mly_ioctl(sc, &mci, NULL, 0, &status, NULL, NULL)))
1072         return(error);
1073
1074     return((status == 0) ? 0 : EIO);
1075 }
1076
1077 /********************************************************************************
1078  * Perform an ioctl command.
1079  *
1080  * If (data) is not NULL, the command requires data transfer.  If (*data) is NULL
1081  * the command requires data transfer from the controller, and we will allocate
1082  * a buffer for it.  If (*data) is not NULL, the command requires data transfer
1083  * to the controller.
1084  *
1085  * XXX passing in the whole ioctl structure is ugly.  Better ideas?
1086  *
1087  * XXX we don't even try to handle the case where datasize > 4k.  We should.
1088  */
1089 static int
1090 mly_ioctl(struct mly_softc *sc, struct mly_command_ioctl *ioctl, void **data, size_t datasize,
1091           u_int8_t *status, void *sense_buffer, size_t *sense_length)
1092 {
1093     struct mly_command          *mc;
1094     struct mly_command_ioctl    *mci;
1095     int                         error;
1096
1097     debug_called(1);
1098
1099     mc = NULL;
1100     if (mly_alloc_command(sc, &mc)) {
1101         error = ENOMEM;
1102         goto out;
1103     }
1104
1105     /* copy the ioctl structure, but save some important fields and then fixup */
1106     mci = &mc->mc_packet->ioctl;
1107     ioctl->sense_buffer_address = mci->sense_buffer_address;
1108     ioctl->maximum_sense_size = mci->maximum_sense_size;
1109     *mci = *ioctl;
1110     mci->opcode = MDACMD_IOCTL;
1111     mci->timeout.value = 30;
1112     mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1113
1114     /* handle the data buffer */
1115     if (data != NULL) {
1116         if (*data == NULL) {
1117             /* allocate data buffer */
1118             if ((mc->mc_data = malloc(datasize, M_DEVBUF, M_NOWAIT)) == NULL) {
1119                 error = ENOMEM;
1120                 goto out;
1121             }
1122             mc->mc_flags |= MLY_CMD_DATAIN;
1123         } else {
1124             mc->mc_data = *data;
1125             mc->mc_flags |= MLY_CMD_DATAOUT;
1126         }
1127         mc->mc_length = datasize;
1128         mc->mc_packet->generic.data_size = datasize;
1129     }
1130
1131     /* run the command */
1132     if ((error = mly_immediate_command(mc)))
1133         goto out;
1134
1135     /* clean up and return any data */
1136     *status = mc->mc_status;
1137     if ((mc->mc_sense > 0) && (sense_buffer != NULL)) {
1138         bcopy(mc->mc_packet, sense_buffer, mc->mc_sense);
1139         *sense_length = mc->mc_sense;
1140         goto out;
1141     }
1142
1143     /* should we return a data pointer? */
1144     if ((data != NULL) && (*data == NULL))
1145         *data = mc->mc_data;
1146
1147     /* command completed OK */
1148     error = 0;
1149
1150 out:
1151     if (mc != NULL) {
1152         /* do we need to free a data buffer we allocated? */
1153         if (error && (mc->mc_data != NULL) && (*data == NULL))
1154             free(mc->mc_data, M_DEVBUF);
1155         mly_release_command(mc);
1156     }
1157     return(error);
1158 }
1159
1160 /********************************************************************************
1161  * Check for event(s) outstanding in the controller.
1162  */
1163 static void
1164 mly_check_event(struct mly_softc *sc)
1165 {
1166
1167     /*
1168      * The controller may have updated the health status information,
1169      * so check for it here.  Note that the counters are all in host memory,
1170      * so this check is very cheap.  Also note that we depend on checking on
1171      * completion
1172      */
1173     if (sc->mly_mmbox->mmm_health.status.change_counter != sc->mly_event_change) {
1174         sc->mly_event_change = sc->mly_mmbox->mmm_health.status.change_counter;
1175         debug(1, "event change %d, event status update, %d -> %d", sc->mly_event_change,
1176               sc->mly_event_waiting, sc->mly_mmbox->mmm_health.status.next_event);
1177         sc->mly_event_waiting = sc->mly_mmbox->mmm_health.status.next_event;
1178
1179         /* wake up anyone that might be interested in this */
1180         wakeup(&sc->mly_event_change);
1181     }
1182     if (sc->mly_event_counter != sc->mly_event_waiting)
1183     mly_fetch_event(sc);
1184 }
1185
1186 /********************************************************************************
1187  * Fetch one event from the controller.
1188  *
1189  * If we fail due to resource starvation, we'll be retried the next time a
1190  * command completes.
1191  */
1192 static void
1193 mly_fetch_event(struct mly_softc *sc)
1194 {
1195     struct mly_command          *mc;
1196     struct mly_command_ioctl    *mci;
1197     int                         s;
1198     u_int32_t                   event;
1199
1200     debug_called(1);
1201
1202     /* get a command */
1203     if (mly_alloc_command(sc, &mc))
1204         return;
1205
1206     /* set up the data buffer */
1207     if ((mc->mc_data = malloc(sizeof(struct mly_event), M_DEVBUF, M_NOWAIT | M_ZERO)) == NULL) {
1208         mly_release_command(mc);
1209         return;
1210     }
1211     mc->mc_length = sizeof(struct mly_event);
1212     mc->mc_flags |= MLY_CMD_DATAIN;
1213     mc->mc_complete = mly_complete_event;
1214
1215     /*
1216      * Get an event number to fetch.  It's possible that we've raced with another
1217      * context for the last event, in which case there will be no more events.
1218      */
1219     s = splcam();
1220     if (sc->mly_event_counter == sc->mly_event_waiting) {
1221         mly_release_command(mc);
1222         splx(s);
1223         return;
1224     }
1225     event = sc->mly_event_counter++;
1226     splx(s);
1227
1228     /*
1229      * Build the ioctl.
1230      *
1231      * At this point we are committed to sending this request, as it
1232      * will be the only one constructed for this particular event number.
1233      */
1234     mci = (struct mly_command_ioctl *)&mc->mc_packet->ioctl;
1235     mci->opcode = MDACMD_IOCTL;
1236     mci->data_size = sizeof(struct mly_event);
1237     mci->addr.phys.lun = (event >> 16) & 0xff;
1238     mci->addr.phys.target = (event >> 24) & 0xff;
1239     mci->addr.phys.channel = 0;
1240     mci->addr.phys.controller = 0;
1241     mci->timeout.value = 30;
1242     mci->timeout.scale = MLY_TIMEOUT_SECONDS;
1243     mci->sub_ioctl = MDACIOCTL_GETEVENT;
1244     mci->param.getevent.sequence_number_low = event & 0xffff;
1245
1246     debug(1, "fetch event %u", event);
1247
1248     /*
1249      * Submit the command.
1250      *
1251      * Note that failure of mly_start() will result in this event never being
1252      * fetched.
1253      */
1254     if (mly_start(mc) != 0) {
1255         mly_printf(sc, "couldn't fetch event %u\n", event);
1256         mly_release_command(mc);
1257     }
1258 }
1259
1260 /********************************************************************************
1261  * Handle the completion of an event poll.
1262  */
1263 static void
1264 mly_complete_event(struct mly_command *mc)
1265 {
1266     struct mly_softc    *sc = mc->mc_sc;
1267     struct mly_event    *me = (struct mly_event *)mc->mc_data;
1268
1269     debug_called(1);
1270
1271     /*
1272      * If the event was successfully fetched, process it.
1273      */
1274     if (mc->mc_status == SCSI_STATUS_OK) {
1275         mly_process_event(sc, me);
1276         free(me, M_DEVBUF);
1277     }
1278     mly_release_command(mc);
1279
1280     /*
1281      * Check for another event.
1282      */
1283     mly_check_event(sc);
1284 }
1285
1286 /********************************************************************************
1287  * Process a controller event.
1288  */
1289 static void
1290 mly_process_event(struct mly_softc *sc, struct mly_event *me)
1291 {
1292     struct scsi_sense_data      *ssd = (struct scsi_sense_data *)&me->sense[0];
1293     char                        *fp, *tp;
1294     int                         bus, target, event, class, action;
1295
1296     /*
1297      * Errors can be reported using vendor-unique sense data.  In this case, the
1298      * event code will be 0x1c (Request sense data present), the sense key will
1299      * be 0x09 (vendor specific), the MSB of the ASC will be set, and the
1300      * actual event code will be a 16-bit value comprised of the ASCQ (low byte)
1301      * and low seven bits of the ASC (low seven bits of the high byte).
1302      */
1303     if ((me->code == 0x1c) &&
1304         ((ssd->flags & SSD_KEY) == SSD_KEY_Vendor_Specific) &&
1305         (ssd->add_sense_code & 0x80)) {
1306         event = ((int)(ssd->add_sense_code & ~0x80) << 8) + ssd->add_sense_code_qual;
1307     } else {
1308         event = me->code;
1309     }
1310
1311     /* look up event, get codes */
1312     fp = mly_describe_code(mly_table_event, event);
1313
1314     debug(1, "Event %d  code 0x%x", me->sequence_number, me->code);
1315
1316     /* quiet event? */
1317     class = fp[0];
1318     if (isupper(class) && bootverbose)
1319         class = tolower(class);
1320
1321     /* get action code, text string */
1322     action = fp[1];
1323     tp = &fp[2];
1324
1325     /*
1326      * Print some information about the event.
1327      *
1328      * This code uses a table derived from the corresponding portion of the Linux
1329      * driver, and thus the parser is very similar.
1330      */
1331     switch(class) {
1332     case 'p':           /* error on physical device */
1333         mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1334         if (action == 'r')
1335             sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1336         break;
1337     case 'l':           /* error on logical unit */
1338     case 'm':           /* message about logical unit */
1339         bus = MLY_LOGDEV_BUS(sc, me->lun);
1340         target = MLY_LOGDEV_TARGET(sc, me->lun);
1341         mly_name_device(sc, bus, target);
1342         mly_printf(sc, "logical device %d (%s) %s\n", me->lun, sc->mly_btl[bus][target].mb_name, tp);
1343         if (action == 'r')
1344             sc->mly_btl[bus][target].mb_flags |= MLY_BTL_RESCAN;
1345         break;
1346       break;
1347     case 's':           /* report of sense data */
1348         if (((ssd->flags & SSD_KEY) == SSD_KEY_NO_SENSE) ||
1349             (((ssd->flags & SSD_KEY) == SSD_KEY_NOT_READY) &&
1350              (ssd->add_sense_code == 0x04) &&
1351              ((ssd->add_sense_code_qual == 0x01) || (ssd->add_sense_code_qual == 0x02))))
1352             break;      /* ignore NO_SENSE or NOT_READY in one case */
1353
1354         mly_printf(sc, "physical device %d:%d %s\n", me->channel, me->target, tp);
1355         mly_printf(sc, "  sense key %d  asc %02x  ascq %02x\n",
1356                       ssd->flags & SSD_KEY, ssd->add_sense_code, ssd->add_sense_code_qual);
1357         mly_printf(sc, "  info %4D  csi %4D\n", ssd->info, "", ssd->cmd_spec_info, "");
1358         if (action == 'r')
1359             sc->mly_btl[me->channel][me->target].mb_flags |= MLY_BTL_RESCAN;
1360         break;
1361     case 'e':
1362         mly_printf(sc, tp, me->target, me->lun);
1363         break;
1364     case 'c':
1365         mly_printf(sc, "controller %s\n", tp);
1366         break;
1367     case '?':
1368         mly_printf(sc, "%s - %d\n", tp, me->code);
1369         break;
1370     default:    /* probably a 'noisy' event being ignored */
1371         break;
1372     }
1373 }
1374
1375 /********************************************************************************
1376  * Perform periodic activities.
1377  */
1378 static void
1379 mly_periodic(void *data)
1380 {
1381     struct mly_softc    *sc = (struct mly_softc *)data;
1382     int                 bus, target;
1383
1384     debug_called(2);
1385
1386     /*
1387      * Scan devices.
1388      */
1389     for (bus = 0; bus < sc->mly_cam_channels; bus++) {
1390         if (MLY_BUS_IS_VALID(sc, bus)) {
1391             for (target = 0; target < MLY_MAX_TARGETS; target++) {
1392
1393                 /* ignore the controller in this scan */
1394                 if (target == sc->mly_controllerparam->initiator_id)
1395                     continue;
1396
1397                 /* perform device rescan? */
1398                 if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_RESCAN)
1399                     mly_rescan_btl(sc, bus, target);
1400             }
1401         }
1402     }
1403
1404     /* check for controller events */
1405     mly_check_event(sc);
1406
1407     /* reschedule ourselves */
1408     sc->mly_periodic = timeout(mly_periodic, sc, MLY_PERIODIC_INTERVAL * hz);
1409 }
1410
1411 /********************************************************************************
1412  ********************************************************************************
1413                                                                Command Processing
1414  ********************************************************************************
1415  ********************************************************************************/
1416
1417 /********************************************************************************
1418  * Run a command and wait for it to complete.
1419  *
1420  */
1421 static int
1422 mly_immediate_command(struct mly_command *mc)
1423 {
1424     struct mly_softc    *sc = mc->mc_sc;
1425     int                 error, s;
1426
1427     debug_called(1);
1428
1429     /* spinning at splcam is ugly, but we're only used during controller init */
1430     s = splcam();
1431     if ((error = mly_start(mc))) {
1432         splx(s);
1433         return(error);
1434     }
1435
1436     if (sc->mly_state & MLY_STATE_INTERRUPTS_ON) {
1437         /* sleep on the command */
1438         while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1439             tsleep(mc, PRIBIO, "mlywait", 0);
1440         }
1441     } else {
1442         /* spin and collect status while we do */
1443         while(!(mc->mc_flags & MLY_CMD_COMPLETE)) {
1444             mly_done(mc->mc_sc);
1445         }
1446     }
1447     splx(s);
1448     return(0);
1449 }
1450
1451 /********************************************************************************
1452  * Deliver a command to the controller.
1453  *
1454  * XXX it would be good to just queue commands that we can't submit immediately
1455  *     and send them later, but we probably want a wrapper for that so that
1456  *     we don't hang on a failed submission for an immediate command.
1457  */
1458 static int
1459 mly_start(struct mly_command *mc)
1460 {
1461     struct mly_softc            *sc = mc->mc_sc;
1462     union mly_command_packet    *pkt;
1463     int                         s;
1464
1465     debug_called(2);
1466
1467     /*
1468      * Set the command up for delivery to the controller.
1469      */
1470     mly_map_command(mc);
1471     mc->mc_packet->generic.command_id = mc->mc_slot;
1472
1473     s = splcam();
1474
1475     /*
1476      * Do we have to use the hardware mailbox?
1477      */
1478     if (!(sc->mly_state & MLY_STATE_MMBOX_ACTIVE)) {
1479         /*
1480          * Check to see if the controller is ready for us.
1481          */
1482         if (MLY_IDBR_TRUE(sc, MLY_HM_CMDSENT)) {
1483             splx(s);
1484             return(EBUSY);
1485         }
1486         mc->mc_flags |= MLY_CMD_BUSY;
1487
1488         /*
1489          * It's ready, send the command.
1490          */
1491         MLY_SET_MBOX(sc, sc->mly_command_mailbox, &mc->mc_packetphys);
1492         MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_CMDSENT);
1493
1494     } else {    /* use memory-mailbox mode */
1495
1496         pkt = &sc->mly_mmbox->mmm_command[sc->mly_mmbox_command_index];
1497
1498         /* check to see if the next index is free yet */
1499         if (pkt->mmbox.flag != 0) {
1500             splx(s);
1501             return(EBUSY);
1502         }
1503         mc->mc_flags |= MLY_CMD_BUSY;
1504
1505         /* copy in new command */
1506         bcopy(mc->mc_packet->mmbox.data, pkt->mmbox.data, sizeof(pkt->mmbox.data));
1507         /* barrier to ensure completion of previous write before we write the flag */
1508         bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1509             BUS_SPACE_BARRIER_WRITE);
1510         /* copy flag last */
1511         pkt->mmbox.flag = mc->mc_packet->mmbox.flag;
1512         /* barrier to ensure completion of previous write before we notify the controller */
1513         bus_space_barrier(sc->mly_btag, sc->mly_bhandle, 0, 0,
1514             BUS_SPACE_BARRIER_WRITE);
1515
1516         /* signal controller, update index */
1517         MLY_SET_REG(sc, sc->mly_idbr, MLY_AM_CMDSENT);
1518         sc->mly_mmbox_command_index = (sc->mly_mmbox_command_index + 1) % MLY_MMBOX_COMMANDS;
1519     }
1520
1521     mly_enqueue_busy(mc);
1522     splx(s);
1523     return(0);
1524 }
1525
1526 /********************************************************************************
1527  * Pick up command status from the controller, schedule a completion event
1528  */
1529 static void
1530 mly_done(struct mly_softc *sc)
1531 {
1532     struct mly_command          *mc;
1533     union mly_status_packet     *sp;
1534     u_int16_t                   slot;
1535     int                         s, worked;
1536
1537     s = splcam();
1538     worked = 0;
1539
1540     /* pick up hardware-mailbox commands */
1541     if (MLY_ODBR_TRUE(sc, MLY_HM_STSREADY)) {
1542         slot = MLY_GET_REG2(sc, sc->mly_status_mailbox);
1543         if (slot < MLY_SLOT_MAX) {
1544             mc = &sc->mly_command[slot - MLY_SLOT_START];
1545             mc->mc_status = MLY_GET_REG(sc, sc->mly_status_mailbox + 2);
1546             mc->mc_sense = MLY_GET_REG(sc, sc->mly_status_mailbox + 3);
1547             mc->mc_resid = MLY_GET_REG4(sc, sc->mly_status_mailbox + 4);
1548             mly_remove_busy(mc);
1549             mc->mc_flags &= ~MLY_CMD_BUSY;
1550             mly_enqueue_complete(mc);
1551             worked = 1;
1552         } else {
1553             /* slot 0xffff may mean "extremely bogus command" */
1554             mly_printf(sc, "got HM completion for illegal slot %u\n", slot);
1555         }
1556         /* unconditionally acknowledge status */
1557         MLY_SET_REG(sc, sc->mly_odbr, MLY_HM_STSREADY);
1558         MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
1559     }
1560
1561     /* pick up memory-mailbox commands */
1562     if (MLY_ODBR_TRUE(sc, MLY_AM_STSREADY)) {
1563         for (;;) {
1564             sp = &sc->mly_mmbox->mmm_status[sc->mly_mmbox_status_index];
1565
1566             /* check for more status */
1567             if (sp->mmbox.flag == 0)
1568                 break;
1569
1570             /* get slot number */
1571             slot = sp->status.command_id;
1572             if (slot < MLY_SLOT_MAX) {
1573                 mc = &sc->mly_command[slot - MLY_SLOT_START];
1574                 mc->mc_status = sp->status.status;
1575                 mc->mc_sense = sp->status.sense_length;
1576                 mc->mc_resid = sp->status.residue;
1577                 mly_remove_busy(mc);
1578                 mc->mc_flags &= ~MLY_CMD_BUSY;
1579                 mly_enqueue_complete(mc);
1580                 worked = 1;
1581             } else {
1582                 /* slot 0xffff may mean "extremely bogus command" */
1583                 mly_printf(sc, "got AM completion for illegal slot %u at %d\n",
1584                            slot, sc->mly_mmbox_status_index);
1585             }
1586
1587             /* clear and move to next index */
1588             sp->mmbox.flag = 0;
1589             sc->mly_mmbox_status_index = (sc->mly_mmbox_status_index + 1) % MLY_MMBOX_STATUS;
1590         }
1591         /* acknowledge that we have collected status value(s) */
1592         MLY_SET_REG(sc, sc->mly_odbr, MLY_AM_STSREADY);
1593     }
1594
1595     splx(s);
1596     if (worked) {
1597 #if __FreeBSD_version >= 500005
1598         if (sc->mly_state & MLY_STATE_INTERRUPTS_ON)
1599             taskqueue_enqueue(taskqueue_swi, &sc->mly_task_complete);
1600         else
1601 #endif
1602             mly_complete(sc, 0);
1603     }
1604 }
1605
1606 /********************************************************************************
1607  * Process completed commands
1608  */
1609 static void
1610 mly_complete(void *context, int pending)
1611 {
1612     struct mly_softc    *sc = (struct mly_softc *)context;
1613     struct mly_command  *mc;
1614     void                (* mc_complete)(struct mly_command *mc);
1615
1616
1617     debug_called(2);
1618
1619     /*
1620      * Spin pulling commands off the completed queue and processing them.
1621      */
1622     while ((mc = mly_dequeue_complete(sc)) != NULL) {
1623
1624         /*
1625          * Free controller resources, mark command complete.
1626          *
1627          * Note that as soon as we mark the command complete, it may be freed
1628          * out from under us, so we need to save the mc_complete field in
1629          * order to later avoid dereferencing mc.  (We would not expect to
1630          * have a polling/sleeping consumer with mc_complete != NULL).
1631          */
1632         mly_unmap_command(mc);
1633         mc_complete = mc->mc_complete;
1634         mc->mc_flags |= MLY_CMD_COMPLETE;
1635
1636         /*
1637          * Call completion handler or wake up sleeping consumer.
1638          */
1639         if (mc_complete != NULL) {
1640             mc_complete(mc);
1641         } else {
1642             wakeup(mc);
1643         }
1644     }
1645
1646     /*
1647      * XXX if we are deferring commands due to controller-busy status, we should
1648      *     retry submitting them here.
1649      */
1650 }
1651
1652 /********************************************************************************
1653  ********************************************************************************
1654                                                         Command Buffer Management
1655  ********************************************************************************
1656  ********************************************************************************/
1657
1658 /********************************************************************************
1659  * Allocate a command.
1660  */
1661 static int
1662 mly_alloc_command(struct mly_softc *sc, struct mly_command **mcp)
1663 {
1664     struct mly_command  *mc;
1665
1666     debug_called(3);
1667
1668     if ((mc = mly_dequeue_free(sc)) == NULL)
1669         return(ENOMEM);
1670
1671     *mcp = mc;
1672     return(0);
1673 }
1674
1675 /********************************************************************************
1676  * Release a command back to the freelist.
1677  */
1678 static void
1679 mly_release_command(struct mly_command *mc)
1680 {
1681     debug_called(3);
1682
1683     /*
1684      * Fill in parts of the command that may cause confusion if
1685      * a consumer doesn't when we are later allocated.
1686      */
1687     mc->mc_data = NULL;
1688     mc->mc_flags = 0;
1689     mc->mc_complete = NULL;
1690     mc->mc_private = NULL;
1691
1692     /*
1693      * By default, we set up to overwrite the command packet with
1694      * sense information.
1695      */
1696     mc->mc_packet->generic.sense_buffer_address = mc->mc_packetphys;
1697     mc->mc_packet->generic.maximum_sense_size = sizeof(union mly_command_packet);
1698
1699     mly_enqueue_free(mc);
1700 }
1701
1702 /********************************************************************************
1703  * Map helper for command allocation.
1704  */
1705 static void
1706 mly_alloc_commands_map(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1707 {
1708     struct mly_softc    *sc = (struct mly_softc *)arg;
1709
1710     debug_called(1);
1711
1712     sc->mly_packetphys = segs[0].ds_addr;
1713 }
1714
1715 /********************************************************************************
1716  * Allocate and initialise command and packet structures.
1717  *
1718  * If the controller supports fewer than MLY_MAX_COMMANDS commands, limit our
1719  * allocation to that number.  If we don't yet know how many commands the
1720  * controller supports, allocate a very small set (suitable for initialisation
1721  * purposes only).
1722  */
1723 static int
1724 mly_alloc_commands(struct mly_softc *sc)
1725 {
1726     struct mly_command          *mc;
1727     int                         i, ncmd;
1728
1729     if (sc->mly_controllerinfo == NULL) {
1730         ncmd = 4;
1731     } else {
1732         ncmd = min(MLY_MAX_COMMANDS, sc->mly_controllerinfo->maximum_parallel_commands);
1733     }
1734
1735     /*
1736      * Allocate enough space for all the command packets in one chunk and
1737      * map them permanently into controller-visible space.
1738      */
1739     if (bus_dmamem_alloc(sc->mly_packet_dmat, (void **)&sc->mly_packet,
1740                          BUS_DMA_NOWAIT, &sc->mly_packetmap)) {
1741         return(ENOMEM);
1742     }
1743     bus_dmamap_load(sc->mly_packet_dmat, sc->mly_packetmap, sc->mly_packet,
1744                     ncmd * sizeof(union mly_command_packet),
1745                     mly_alloc_commands_map, sc, 0);
1746
1747     for (i = 0; i < ncmd; i++) {
1748         mc = &sc->mly_command[i];
1749         bzero(mc, sizeof(*mc));
1750         mc->mc_sc = sc;
1751         mc->mc_slot = MLY_SLOT_START + i;
1752         mc->mc_packet = sc->mly_packet + i;
1753         mc->mc_packetphys = sc->mly_packetphys + (i * sizeof(union mly_command_packet));
1754         if (!bus_dmamap_create(sc->mly_buffer_dmat, 0, &mc->mc_datamap))
1755             mly_release_command(mc);
1756     }
1757     return(0);
1758 }
1759
1760 /********************************************************************************
1761  * Free all the storage held by commands.
1762  *
1763  * Must be called with all commands on the free list.
1764  */
1765 static void
1766 mly_release_commands(struct mly_softc *sc)
1767 {
1768     struct mly_command  *mc;
1769
1770     /* throw away command buffer DMA maps */
1771     while (mly_alloc_command(sc, &mc) == 0)
1772         bus_dmamap_destroy(sc->mly_buffer_dmat, mc->mc_datamap);
1773
1774     /* release the packet storage */
1775     if (sc->mly_packet != NULL) {
1776         bus_dmamap_unload(sc->mly_packet_dmat, sc->mly_packetmap);
1777         bus_dmamem_free(sc->mly_packet_dmat, sc->mly_packet, sc->mly_packetmap);
1778         sc->mly_packet = NULL;
1779     }
1780 }
1781
1782
1783 /********************************************************************************
1784  * Command-mapping helper function - populate this command's s/g table
1785  * with the s/g entries for its data.
1786  */
1787 static void
1788 mly_map_command_sg(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1789 {
1790     struct mly_command          *mc = (struct mly_command *)arg;
1791     struct mly_softc            *sc = mc->mc_sc;
1792     struct mly_command_generic  *gen = &(mc->mc_packet->generic);
1793     struct mly_sg_entry         *sg;
1794     int                         i, tabofs;
1795
1796     debug_called(2);
1797
1798     /* can we use the transfer structure directly? */
1799     if (nseg <= 2) {
1800         sg = &gen->transfer.direct.sg[0];
1801         gen->command_control.extended_sg_table = 0;
1802     } else {
1803         tabofs = ((mc->mc_slot - MLY_SLOT_START) * MLY_MAX_SGENTRIES);
1804         sg = sc->mly_sg_table + tabofs;
1805         gen->transfer.indirect.entries[0] = nseg;
1806         gen->transfer.indirect.table_physaddr[0] = sc->mly_sg_busaddr + (tabofs * sizeof(struct mly_sg_entry));
1807         gen->command_control.extended_sg_table = 1;
1808     }
1809
1810     /* copy the s/g table */
1811     for (i = 0; i < nseg; i++) {
1812         sg[i].physaddr = segs[i].ds_addr;
1813         sg[i].length = segs[i].ds_len;
1814     }
1815
1816 }
1817
1818 #if 0
1819 /********************************************************************************
1820  * Command-mapping helper function - save the cdb's physical address.
1821  *
1822  * We don't support 'large' SCSI commands at this time, so this is unused.
1823  */
1824 static void
1825 mly_map_command_cdb(void *arg, bus_dma_segment_t *segs, int nseg, int error)
1826 {
1827     struct mly_command                  *mc = (struct mly_command *)arg;
1828
1829     debug_called(2);
1830
1831     /* XXX can we safely assume that a CDB will never cross a page boundary? */
1832     if ((segs[0].ds_addr % PAGE_SIZE) >
1833         ((segs[0].ds_addr + mc->mc_packet->scsi_large.cdb_length) % PAGE_SIZE))
1834         panic("cdb crosses page boundary");
1835
1836     /* fix up fields in the command packet */
1837     mc->mc_packet->scsi_large.cdb_physaddr = segs[0].ds_addr;
1838 }
1839 #endif
1840
1841 /********************************************************************************
1842  * Map a command into controller-visible space
1843  */
1844 static void
1845 mly_map_command(struct mly_command *mc)
1846 {
1847     struct mly_softc    *sc = mc->mc_sc;
1848
1849     debug_called(2);
1850
1851     /* don't map more than once */
1852     if (mc->mc_flags & MLY_CMD_MAPPED)
1853         return;
1854
1855     /* does the command have a data buffer? */
1856     if (mc->mc_data != NULL) {
1857         bus_dmamap_load(sc->mly_buffer_dmat, mc->mc_datamap, mc->mc_data, mc->mc_length,
1858                         mly_map_command_sg, mc, 0);
1859
1860         if (mc->mc_flags & MLY_CMD_DATAIN)
1861             bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREREAD);
1862         if (mc->mc_flags & MLY_CMD_DATAOUT)
1863             bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_PREWRITE);
1864     }
1865     mc->mc_flags |= MLY_CMD_MAPPED;
1866 }
1867
1868 /********************************************************************************
1869  * Unmap a command from controller-visible space
1870  */
1871 static void
1872 mly_unmap_command(struct mly_command *mc)
1873 {
1874     struct mly_softc    *sc = mc->mc_sc;
1875
1876     debug_called(2);
1877
1878     if (!(mc->mc_flags & MLY_CMD_MAPPED))
1879         return;
1880
1881     /* does the command have a data buffer? */
1882     if (mc->mc_data != NULL) {
1883         if (mc->mc_flags & MLY_CMD_DATAIN)
1884             bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTREAD);
1885         if (mc->mc_flags & MLY_CMD_DATAOUT)
1886             bus_dmamap_sync(sc->mly_buffer_dmat, mc->mc_datamap, BUS_DMASYNC_POSTWRITE);
1887
1888         bus_dmamap_unload(sc->mly_buffer_dmat, mc->mc_datamap);
1889     }
1890     mc->mc_flags &= ~MLY_CMD_MAPPED;
1891 }
1892
1893
1894 /********************************************************************************
1895  ********************************************************************************
1896                                                                     CAM interface
1897  ********************************************************************************
1898  ********************************************************************************/
1899
1900 /********************************************************************************
1901  * Attach the physical and virtual SCSI busses to CAM.
1902  *
1903  * Physical bus numbering starts from 0, virtual bus numbering from one greater
1904  * than the highest physical bus.  Physical busses are only registered if
1905  * the kernel environment variable "hw.mly.register_physical_channels" is set.
1906  *
1907  * When we refer to a "bus", we are referring to the bus number registered with
1908  * the SIM, wheras a "channel" is a channel number given to the adapter.  In order
1909  * to keep things simple, we map these 1:1, so "bus" and "channel" may be used
1910  * interchangeably.
1911  */
1912 static int
1913 mly_cam_attach(struct mly_softc *sc)
1914 {
1915     struct cam_devq     *devq;
1916     int                 chn, i;
1917
1918     debug_called(1);
1919
1920     /*
1921      * Allocate a devq for all our channels combined.
1922      */
1923     if ((devq = cam_simq_alloc(sc->mly_controllerinfo->maximum_parallel_commands)) == NULL) {
1924         mly_printf(sc, "can't allocate CAM SIM queue\n");
1925         return(ENOMEM);
1926     }
1927
1928     /*
1929      * If physical channel registration has been requested, register these first.
1930      * Note that we enable tagged command queueing for physical channels.
1931      */
1932     if (testenv("hw.mly.register_physical_channels")) {
1933         chn = 0;
1934         for (i = 0; i < sc->mly_controllerinfo->physical_channels_present; i++, chn++) {
1935
1936             if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1937                                                       device_get_unit(sc->mly_dev),
1938                                                       sc->mly_controllerinfo->maximum_parallel_commands,
1939                                                       1, devq)) == NULL) {
1940                 return(ENOMEM);
1941             }
1942             if (xpt_bus_register(sc->mly_cam_sim[chn], chn)) {
1943                 mly_printf(sc, "CAM XPT phsyical channel registration failed\n");
1944                 return(ENXIO);
1945             }
1946             debug(1, "registered physical channel %d", chn);
1947         }
1948     }
1949
1950     /*
1951      * Register our virtual channels, with bus numbers matching channel numbers.
1952      */
1953     chn = sc->mly_controllerinfo->physical_channels_present;
1954     for (i = 0; i < sc->mly_controllerinfo->virtual_channels_present; i++, chn++) {
1955         if ((sc->mly_cam_sim[chn] = cam_sim_alloc(mly_cam_action, mly_cam_poll, "mly", sc,
1956                                                   device_get_unit(sc->mly_dev),
1957                                                   sc->mly_controllerinfo->maximum_parallel_commands,
1958                                                   0, devq)) == NULL) {
1959             return(ENOMEM);
1960         }
1961         if (xpt_bus_register(sc->mly_cam_sim[chn], chn)) {
1962             mly_printf(sc, "CAM XPT virtual channel registration failed\n");
1963             return(ENXIO);
1964         }
1965         debug(1, "registered virtual channel %d", chn);
1966     }
1967
1968     /*
1969      * This is the total number of channels that (might have been) registered with
1970      * CAM.  Some may not have been; check the mly_cam_sim array to be certain.
1971      */
1972     sc->mly_cam_channels = sc->mly_controllerinfo->physical_channels_present +
1973         sc->mly_controllerinfo->virtual_channels_present;
1974
1975     return(0);
1976 }
1977
1978 /********************************************************************************
1979  * Detach from CAM
1980  */
1981 static void
1982 mly_cam_detach(struct mly_softc *sc)
1983 {
1984     int         i;
1985
1986     debug_called(1);
1987
1988     for (i = 0; i < sc->mly_cam_channels; i++) {
1989         if (sc->mly_cam_sim[i] != NULL) {
1990             xpt_bus_deregister(cam_sim_path(sc->mly_cam_sim[i]));
1991             cam_sim_free(sc->mly_cam_sim[i], 0);
1992         }
1993     }
1994     if (sc->mly_cam_devq != NULL)
1995         cam_simq_free(sc->mly_cam_devq);
1996 }
1997
1998 /************************************************************************
1999  * Rescan a device.
2000  */
2001 static void
2002 mly_cam_rescan_btl(struct mly_softc *sc, int bus, int target)
2003 {
2004     union ccb   *ccb;
2005
2006     debug_called(1);
2007
2008     if ((ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK | M_ZERO)) == NULL) {
2009         mly_printf(sc, "rescan failed (can't allocate CCB)\n");
2010         return;
2011     }
2012
2013     if (xpt_create_path(&sc->mly_cam_path, xpt_periph,
2014                         cam_sim_path(sc->mly_cam_sim[bus]), target, 0) != CAM_REQ_CMP) {
2015         mly_printf(sc, "rescan failed (can't create path)\n");
2016         return;
2017     }
2018     xpt_setup_ccb(&ccb->ccb_h, sc->mly_cam_path, 5/*priority (low)*/);
2019     ccb->ccb_h.func_code = XPT_SCAN_LUN;
2020     ccb->ccb_h.cbfcnp = mly_cam_rescan_callback;
2021     ccb->crcn.flags = CAM_FLAG_NONE;
2022     debug(1, "rescan target %d:%d", bus, target);
2023     xpt_action(ccb);
2024 }
2025
2026 static void
2027 mly_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2028 {
2029     free(ccb, M_TEMP);
2030 }
2031
2032 /********************************************************************************
2033  * Handle an action requested by CAM
2034  */
2035 static void
2036 mly_cam_action(struct cam_sim *sim, union ccb *ccb)
2037 {
2038     struct mly_softc    *sc = cam_sim_softc(sim);
2039
2040     debug_called(2);
2041
2042     switch (ccb->ccb_h.func_code) {
2043
2044         /* perform SCSI I/O */
2045     case XPT_SCSI_IO:
2046         if (!mly_cam_action_io(sim, (struct ccb_scsiio *)&ccb->csio))
2047             return;
2048         break;
2049
2050         /* perform geometry calculations */
2051     case XPT_CALC_GEOMETRY:
2052     {
2053         struct ccb_calc_geometry        *ccg = &ccb->ccg;
2054         u_int32_t                       secs_per_cylinder;
2055
2056         debug(2, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2057
2058         if (sc->mly_controllerparam->bios_geometry == MLY_BIOSGEOM_8G) {
2059             ccg->heads = 255;
2060             ccg->secs_per_track = 63;
2061         } else {                                /* MLY_BIOSGEOM_2G */
2062             ccg->heads = 128;
2063             ccg->secs_per_track = 32;
2064         }
2065         secs_per_cylinder = ccg->heads * ccg->secs_per_track;
2066         ccg->cylinders = ccg->volume_size / secs_per_cylinder;
2067         ccb->ccb_h.status = CAM_REQ_CMP;
2068         break;
2069     }
2070
2071         /* handle path attribute inquiry */
2072     case XPT_PATH_INQ:
2073     {
2074         struct ccb_pathinq      *cpi = &ccb->cpi;
2075
2076         debug(2, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2077
2078         cpi->version_num = 1;
2079         cpi->hba_inquiry = PI_TAG_ABLE;         /* XXX extra flags for physical channels? */
2080         cpi->target_sprt = 0;
2081         cpi->hba_misc = 0;
2082         cpi->max_target = MLY_MAX_TARGETS - 1;
2083         cpi->max_lun = MLY_MAX_LUNS - 1;
2084         cpi->initiator_id = sc->mly_controllerparam->initiator_id;
2085         strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2086         strncpy(cpi->hba_vid, "FreeBSD", HBA_IDLEN);
2087         strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2088         cpi->unit_number = cam_sim_unit(sim);
2089         cpi->bus_id = cam_sim_bus(sim);
2090         cpi->base_transfer_speed = 132 * 1024;  /* XXX what to set this to? */
2091         ccb->ccb_h.status = CAM_REQ_CMP;
2092         break;
2093     }
2094
2095     case XPT_GET_TRAN_SETTINGS:
2096     {
2097         struct ccb_trans_settings       *cts = &ccb->cts;
2098         int                             bus, target;
2099
2100         bus = cam_sim_bus(sim);
2101         target = cts->ccb_h.target_id;
2102         /* XXX validate bus/target? */
2103
2104         debug(2, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
2105         cts->valid = 0;
2106
2107         /* logical device? */
2108         if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2109             /* nothing special for these */
2110
2111         /* physical device? */
2112         } else if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PHYSICAL) {
2113             /* allow CAM to try tagged transactions */
2114             cts->flags |= CCB_TRANS_TAG_ENB;
2115             cts->valid |= CCB_TRANS_TQ_VALID;
2116
2117             /* convert speed (MHz) to usec */
2118             if (sc->mly_btl[bus][target].mb_speed == 0) {
2119                 cts->sync_period = 1000000 / 5;
2120             } else {
2121                 cts->sync_period = 1000000 / sc->mly_btl[bus][target].mb_speed;
2122             }
2123
2124             /* convert bus width to CAM internal encoding */
2125             switch (sc->mly_btl[bus][target].mb_width) {
2126             case 32:
2127                 cts->bus_width = MSG_EXT_WDTR_BUS_32_BIT;
2128                 break;
2129             case 16:
2130                 cts->bus_width = MSG_EXT_WDTR_BUS_16_BIT;
2131                 break;
2132             case 8:
2133             default:
2134                 cts->bus_width = MSG_EXT_WDTR_BUS_8_BIT;
2135                 break;
2136             }
2137             cts->valid |= CCB_TRANS_SYNC_RATE_VALID | CCB_TRANS_BUS_WIDTH_VALID;
2138
2139             /* not a device, bail out */
2140         } else {
2141             cts->ccb_h.status = CAM_REQ_CMP_ERR;
2142             break;
2143         }
2144
2145         /* disconnect always OK */
2146         cts->flags |= CCB_TRANS_DISC_ENB;
2147         cts->valid |= CCB_TRANS_DISC_VALID;
2148
2149         cts->ccb_h.status = CAM_REQ_CMP;
2150         break;
2151     }
2152
2153     default:            /* we can't do this */
2154         debug(2, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
2155         ccb->ccb_h.status = CAM_REQ_INVALID;
2156         break;
2157     }
2158
2159     xpt_done(ccb);
2160 }
2161
2162 /********************************************************************************
2163  * Handle an I/O operation requested by CAM
2164  */
2165 static int
2166 mly_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
2167 {
2168     struct mly_softc                    *sc = cam_sim_softc(sim);
2169     struct mly_command                  *mc;
2170     struct mly_command_scsi_small       *ss;
2171     int                                 bus, target;
2172     int                                 error;
2173
2174     bus = cam_sim_bus(sim);
2175     target = csio->ccb_h.target_id;
2176
2177     debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
2178
2179     /* validate bus number */
2180     if (!MLY_BUS_IS_VALID(sc, bus)) {
2181         debug(0, " invalid bus %d", bus);
2182         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2183     }
2184
2185     /*  check for I/O attempt to a protected device */
2186     if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_PROTECTED) {
2187         debug(2, "  device protected");
2188         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2189     }
2190
2191     /* check for I/O attempt to nonexistent device */
2192     if (!(sc->mly_btl[bus][target].mb_flags & (MLY_BTL_LOGICAL | MLY_BTL_PHYSICAL))) {
2193         debug(2, "  device %d:%d does not exist", bus, target);
2194         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2195     }
2196
2197     /* XXX increase if/when we support large SCSI commands */
2198     if (csio->cdb_len > MLY_CMD_SCSI_SMALL_CDB) {
2199         debug(0, "  command too large (%d > %d)", csio->cdb_len, MLY_CMD_SCSI_SMALL_CDB);
2200         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2201     }
2202
2203     /* check that the CDB pointer is not to a physical address */
2204     if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
2205         debug(0, "  CDB pointer is to physical address");
2206         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2207     }
2208
2209     /* if there is data transfer, it must be to/from a virtual address */
2210     if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
2211         if (csio->ccb_h.flags & CAM_DATA_PHYS) {                /* we can't map it */
2212             debug(0, "  data pointer is to physical address");
2213             csio->ccb_h.status = CAM_REQ_CMP_ERR;
2214         }
2215         if (csio->ccb_h.flags & CAM_SCATTER_VALID) {    /* we want to do the s/g setup */
2216             debug(0, "  data has premature s/g setup");
2217             csio->ccb_h.status = CAM_REQ_CMP_ERR;
2218         }
2219     }
2220
2221     /* abandon aborted ccbs or those that have failed validation */
2222     if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
2223         debug(2, "abandoning CCB due to abort/validation failure");
2224         return(EINVAL);
2225     }
2226
2227     /*
2228      * Get a command, or push the ccb back to CAM and freeze the queue.
2229      */
2230     if ((error = mly_alloc_command(sc, &mc))) {
2231         xpt_freeze_simq(sim, 1);
2232         csio->ccb_h.status |= CAM_REQUEUE_REQ;
2233         return(error);
2234     }
2235
2236     /* build the command */
2237     mc->mc_data = csio->data_ptr;
2238     mc->mc_length = csio->dxfer_len;
2239     mc->mc_complete = mly_cam_complete;
2240     mc->mc_private = csio;
2241
2242     /* save the bus number in the ccb for later recovery XXX should be a better way */
2243      csio->ccb_h.sim_priv.entries[0].field = bus;
2244
2245     /* build the packet for the controller */
2246     ss = &mc->mc_packet->scsi_small;
2247     ss->opcode = MDACMD_SCSI;
2248     if (csio->ccb_h.flags & CAM_DIS_DISCONNECT)
2249         ss->command_control.disable_disconnect = 1;
2250     if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT)
2251         ss->command_control.data_direction = MLY_CCB_WRITE;
2252     ss->data_size = csio->dxfer_len;
2253     ss->addr.phys.lun = csio->ccb_h.target_lun;
2254     ss->addr.phys.target = csio->ccb_h.target_id;
2255     ss->addr.phys.channel = bus;
2256     if (csio->ccb_h.timeout < (60 * 1000)) {
2257         ss->timeout.value = csio->ccb_h.timeout / 1000;
2258         ss->timeout.scale = MLY_TIMEOUT_SECONDS;
2259     } else if (csio->ccb_h.timeout < (60 * 60 * 1000)) {
2260         ss->timeout.value = csio->ccb_h.timeout / (60 * 1000);
2261         ss->timeout.scale = MLY_TIMEOUT_MINUTES;
2262     } else {
2263         ss->timeout.value = csio->ccb_h.timeout / (60 * 60 * 1000);     /* overflow? */
2264         ss->timeout.scale = MLY_TIMEOUT_HOURS;
2265     }
2266     ss->maximum_sense_size = csio->sense_len;
2267     ss->cdb_length = csio->cdb_len;
2268     if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2269         bcopy(csio->cdb_io.cdb_ptr, ss->cdb, csio->cdb_len);
2270     } else {
2271         bcopy(csio->cdb_io.cdb_bytes, ss->cdb, csio->cdb_len);
2272     }
2273
2274     /* give the command to the controller */
2275     if ((error = mly_start(mc))) {
2276         xpt_freeze_simq(sim, 1);
2277         csio->ccb_h.status |= CAM_REQUEUE_REQ;
2278         return(error);
2279     }
2280
2281     return(0);
2282 }
2283
2284 /********************************************************************************
2285  * Check for possibly-completed commands.
2286  */
2287 static void
2288 mly_cam_poll(struct cam_sim *sim)
2289 {
2290     struct mly_softc    *sc = cam_sim_softc(sim);
2291
2292     debug_called(2);
2293
2294     mly_done(sc);
2295 }
2296
2297 /********************************************************************************
2298  * Handle completion of a command - pass results back through the CCB
2299  */
2300 static void
2301 mly_cam_complete(struct mly_command *mc)
2302 {
2303     struct mly_softc            *sc = mc->mc_sc;
2304     struct ccb_scsiio           *csio = (struct ccb_scsiio *)mc->mc_private;
2305     struct scsi_inquiry_data    *inq = (struct scsi_inquiry_data *)csio->data_ptr;
2306     struct mly_btl              *btl;
2307     u_int8_t                    cmd;
2308     int                         bus, target;
2309
2310     debug_called(2);
2311
2312     csio->scsi_status = mc->mc_status;
2313     switch(mc->mc_status) {
2314     case SCSI_STATUS_OK:
2315         /*
2316          * In order to report logical device type and status, we overwrite
2317          * the result of the INQUIRY command to logical devices.
2318          */
2319         bus = csio->ccb_h.sim_priv.entries[0].field;
2320         target = csio->ccb_h.target_id;
2321         /* XXX validate bus/target? */
2322         if (sc->mly_btl[bus][target].mb_flags & MLY_BTL_LOGICAL) {
2323             if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2324                 cmd = *csio->cdb_io.cdb_ptr;
2325             } else {
2326                 cmd = csio->cdb_io.cdb_bytes[0];
2327             }
2328             if (cmd == INQUIRY) {
2329                 btl = &sc->mly_btl[bus][target];
2330                 padstr(inq->vendor, mly_describe_code(mly_table_device_type, btl->mb_type), 8);
2331                 padstr(inq->product, mly_describe_code(mly_table_device_state, btl->mb_state), 16);
2332                 padstr(inq->revision, "", 4);
2333             }
2334         }
2335
2336         debug(2, "SCSI_STATUS_OK");
2337         csio->ccb_h.status = CAM_REQ_CMP;
2338         break;
2339
2340     case SCSI_STATUS_CHECK_COND:
2341         debug(1, "SCSI_STATUS_CHECK_COND  sense %d  resid %d", mc->mc_sense, mc->mc_resid);
2342         csio->ccb_h.status = CAM_SCSI_STATUS_ERROR;
2343         bzero(&csio->sense_data, SSD_FULL_SIZE);
2344         bcopy(mc->mc_packet, &csio->sense_data, mc->mc_sense);
2345         csio->sense_len = mc->mc_sense;
2346         csio->ccb_h.status |= CAM_AUTOSNS_VALID;
2347         csio->resid = mc->mc_resid;     /* XXX this is a signed value... */
2348         break;
2349
2350     case SCSI_STATUS_BUSY:
2351         debug(1, "SCSI_STATUS_BUSY");
2352         csio->ccb_h.status = CAM_SCSI_BUSY;
2353         break;
2354
2355     default:
2356         debug(1, "unknown status 0x%x", csio->scsi_status);
2357         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2358         break;
2359     }
2360     xpt_done((union ccb *)csio);
2361     mly_release_command(mc);
2362 }
2363
2364 /********************************************************************************
2365  * Find a peripheral attahed at (bus),(target)
2366  */
2367 static struct cam_periph *
2368 mly_find_periph(struct mly_softc *sc, int bus, int target)
2369 {
2370     struct cam_periph   *periph;
2371     struct cam_path     *path;
2372     int                 status;
2373
2374     status = xpt_create_path(&path, NULL, cam_sim_path(sc->mly_cam_sim[bus]), target, 0);
2375     if (status == CAM_REQ_CMP) {
2376         periph = cam_periph_find(path, NULL);
2377         xpt_free_path(path);
2378     } else {
2379         periph = NULL;
2380     }
2381     return(periph);
2382 }
2383
2384 /********************************************************************************
2385  * Name the device at (bus)(target)
2386  */
2387 static int
2388 mly_name_device(struct mly_softc *sc, int bus, int target)
2389 {
2390     struct cam_periph   *periph;
2391
2392     if ((periph = mly_find_periph(sc, bus, target)) != NULL) {
2393         sprintf(sc->mly_btl[bus][target].mb_name, "%s%d", periph->periph_name, periph->unit_number);
2394         return(0);
2395     }
2396     sc->mly_btl[bus][target].mb_name[0] = 0;
2397     return(ENOENT);
2398 }
2399
2400 /********************************************************************************
2401  ********************************************************************************
2402                                                                  Hardware Control
2403  ********************************************************************************
2404  ********************************************************************************/
2405
2406 /********************************************************************************
2407  * Handshake with the firmware while the card is being initialised.
2408  */
2409 static int
2410 mly_fwhandshake(struct mly_softc *sc)
2411 {
2412     u_int8_t    error, param0, param1;
2413     int         spinup = 0;
2414
2415     debug_called(1);
2416
2417     /* set HM_STSACK and let the firmware initialise */
2418     MLY_SET_REG(sc, sc->mly_idbr, MLY_HM_STSACK);
2419     DELAY(1000);        /* too short? */
2420
2421     /* if HM_STSACK is still true, the controller is initialising */
2422     if (!MLY_IDBR_TRUE(sc, MLY_HM_STSACK))
2423         return(0);
2424     mly_printf(sc, "controller initialisation started\n");
2425
2426     /* spin waiting for initialisation to finish, or for a message to be delivered */
2427     while (MLY_IDBR_TRUE(sc, MLY_HM_STSACK)) {
2428         /* check for a message */
2429         if (MLY_ERROR_VALID(sc)) {
2430             error = MLY_GET_REG(sc, sc->mly_error_status) & ~MLY_MSG_EMPTY;
2431             param0 = MLY_GET_REG(sc, sc->mly_command_mailbox);
2432             param1 = MLY_GET_REG(sc, sc->mly_command_mailbox + 1);
2433
2434             switch(error) {
2435             case MLY_MSG_SPINUP:
2436                 if (!spinup) {
2437                     mly_printf(sc, "drive spinup in progress\n");
2438                     spinup = 1;                 /* only print this once (should print drive being spun?) */
2439                 }
2440                 break;
2441             case MLY_MSG_RACE_RECOVERY_FAIL:
2442                 mly_printf(sc, "mirror race recovery failed, one or more drives offline\n");
2443                 break;
2444             case MLY_MSG_RACE_IN_PROGRESS:
2445                 mly_printf(sc, "mirror race recovery in progress\n");
2446                 break;
2447             case MLY_MSG_RACE_ON_CRITICAL:
2448                 mly_printf(sc, "mirror race recovery on a critical drive\n");
2449                 break;
2450             case MLY_MSG_PARITY_ERROR:
2451                 mly_printf(sc, "FATAL MEMORY PARITY ERROR\n");
2452                 return(ENXIO);
2453             default:
2454                 mly_printf(sc, "unknown initialisation code 0x%x\n", error);
2455             }
2456         }
2457     }
2458     return(0);
2459 }
2460
2461 /********************************************************************************
2462  ********************************************************************************
2463                                                         Debugging and Diagnostics
2464  ********************************************************************************
2465  ********************************************************************************/
2466
2467 /********************************************************************************
2468  * Print some information about the controller.
2469  */
2470 static void
2471 mly_describe_controller(struct mly_softc *sc)
2472 {
2473     struct mly_ioctl_getcontrollerinfo  *mi = sc->mly_controllerinfo;
2474
2475     mly_printf(sc, "%16s, %d channel%s, firmware %d.%02d-%d-%02d (%02d%02d%02d%02d), %dMB RAM\n",
2476                mi->controller_name, mi->physical_channels_present, (mi->physical_channels_present) > 1 ? "s" : "",
2477                mi->fw_major, mi->fw_minor, mi->fw_turn, mi->fw_build,   /* XXX turn encoding? */
2478                mi->fw_century, mi->fw_year, mi->fw_month, mi->fw_day,
2479                mi->memory_size);
2480
2481     if (bootverbose) {
2482         mly_printf(sc, "%s %s (%x), %dMHz %d-bit %.16s\n",
2483                    mly_describe_code(mly_table_oemname, mi->oem_information),
2484                    mly_describe_code(mly_table_controllertype, mi->controller_type), mi->controller_type,
2485                    mi->interface_speed, mi->interface_width, mi->interface_name);
2486         mly_printf(sc, "%dMB %dMHz %d-bit %s%s%s, cache %dMB\n",
2487                    mi->memory_size, mi->memory_speed, mi->memory_width,
2488                    mly_describe_code(mly_table_memorytype, mi->memory_type),
2489                    mi->memory_parity ? "+parity": "",mi->memory_ecc ? "+ECC": "",
2490                    mi->cache_size);
2491         mly_printf(sc, "CPU: %s @ %dMHZ\n",
2492                    mly_describe_code(mly_table_cputype, mi->cpu[0].type), mi->cpu[0].speed);
2493         if (mi->l2cache_size != 0)
2494             mly_printf(sc, "%dKB L2 cache\n", mi->l2cache_size);
2495         if (mi->exmemory_size != 0)
2496             mly_printf(sc, "%dMB %dMHz %d-bit private %s%s%s\n",
2497                        mi->exmemory_size, mi->exmemory_speed, mi->exmemory_width,
2498                        mly_describe_code(mly_table_memorytype, mi->exmemory_type),
2499                        mi->exmemory_parity ? "+parity": "",mi->exmemory_ecc ? "+ECC": "");
2500         mly_printf(sc, "battery backup %s\n", mi->bbu_present ? "present" : "not installed");
2501         mly_printf(sc, "maximum data transfer %d blocks, maximum sg entries/command %d\n",
2502                    mi->maximum_block_count, mi->maximum_sg_entries);
2503         mly_printf(sc, "logical devices present/critical/offline %d/%d/%d\n",
2504                    mi->logical_devices_present, mi->logical_devices_critical, mi->logical_devices_offline);
2505         mly_printf(sc, "physical devices present %d\n",
2506                    mi->physical_devices_present);
2507         mly_printf(sc, "physical disks present/offline %d/%d\n",
2508                    mi->physical_disks_present, mi->physical_disks_offline);
2509         mly_printf(sc, "%d physical channel%s, %d virtual channel%s of %d possible\n",
2510                    mi->physical_channels_present, mi->physical_channels_present == 1 ? "" : "s",
2511                    mi->virtual_channels_present, mi->virtual_channels_present == 1 ? "" : "s",
2512                    mi->virtual_channels_possible);
2513         mly_printf(sc, "%d parallel commands supported\n", mi->maximum_parallel_commands);
2514         mly_printf(sc, "%dMB flash ROM, %d of %d maximum cycles\n",
2515                    mi->flash_size, mi->flash_age, mi->flash_maximum_age);
2516     }
2517 }
2518
2519 #ifdef MLY_DEBUG
2520 /********************************************************************************
2521  * Print some controller state
2522  */
2523 static void
2524 mly_printstate(struct mly_softc *sc)
2525 {
2526     mly_printf(sc, "IDBR %02x  ODBR %02x  ERROR %02x  (%x %x %x)\n",
2527                   MLY_GET_REG(sc, sc->mly_idbr),
2528                   MLY_GET_REG(sc, sc->mly_odbr),
2529                   MLY_GET_REG(sc, sc->mly_error_status),
2530                   sc->mly_idbr,
2531                   sc->mly_odbr,
2532                   sc->mly_error_status);
2533     mly_printf(sc, "IMASK %02x  ISTATUS %02x\n",
2534                   MLY_GET_REG(sc, sc->mly_interrupt_mask),
2535                   MLY_GET_REG(sc, sc->mly_interrupt_status));
2536     mly_printf(sc, "COMMAND %02x %02x %02x %02x %02x %02x %02x %02x\n",
2537                   MLY_GET_REG(sc, sc->mly_command_mailbox),
2538                   MLY_GET_REG(sc, sc->mly_command_mailbox + 1),
2539                   MLY_GET_REG(sc, sc->mly_command_mailbox + 2),
2540                   MLY_GET_REG(sc, sc->mly_command_mailbox + 3),
2541                   MLY_GET_REG(sc, sc->mly_command_mailbox + 4),
2542                   MLY_GET_REG(sc, sc->mly_command_mailbox + 5),
2543                   MLY_GET_REG(sc, sc->mly_command_mailbox + 6),
2544                   MLY_GET_REG(sc, sc->mly_command_mailbox + 7));
2545     mly_printf(sc, "STATUS  %02x %02x %02x %02x %02x %02x %02x %02x\n",
2546                   MLY_GET_REG(sc, sc->mly_status_mailbox),
2547                   MLY_GET_REG(sc, sc->mly_status_mailbox + 1),
2548                   MLY_GET_REG(sc, sc->mly_status_mailbox + 2),
2549                   MLY_GET_REG(sc, sc->mly_status_mailbox + 3),
2550                   MLY_GET_REG(sc, sc->mly_status_mailbox + 4),
2551                   MLY_GET_REG(sc, sc->mly_status_mailbox + 5),
2552                   MLY_GET_REG(sc, sc->mly_status_mailbox + 6),
2553                   MLY_GET_REG(sc, sc->mly_status_mailbox + 7));
2554     mly_printf(sc, "        %04x        %08x\n",
2555                   MLY_GET_REG2(sc, sc->mly_status_mailbox),
2556                   MLY_GET_REG4(sc, sc->mly_status_mailbox + 4));
2557 }
2558
2559 struct mly_softc        *mly_softc0 = NULL;
2560 void
2561 mly_printstate0(void)
2562 {
2563     if (mly_softc0 != NULL)
2564         mly_printstate(mly_softc0);
2565 }
2566
2567 /********************************************************************************
2568  * Print a command
2569  */
2570 static void
2571 mly_print_command(struct mly_command *mc)
2572 {
2573     struct mly_softc    *sc = mc->mc_sc;
2574
2575     mly_printf(sc, "COMMAND @ %p\n", mc);
2576     mly_printf(sc, "  slot      %d\n", mc->mc_slot);
2577     mly_printf(sc, "  status    0x%x\n", mc->mc_status);
2578     mly_printf(sc, "  sense len %d\n", mc->mc_sense);
2579     mly_printf(sc, "  resid     %d\n", mc->mc_resid);
2580     mly_printf(sc, "  packet    %p/0x%llx\n", mc->mc_packet, mc->mc_packetphys);
2581     if (mc->mc_packet != NULL)
2582         mly_print_packet(mc);
2583     mly_printf(sc, "  data      %p/%d\n", mc->mc_data, mc->mc_length);
2584     mly_printf(sc, "  flags     %b\n", mc->mc_flags, "\20\1busy\2complete\3slotted\4mapped\5datain\6dataout\n");
2585     mly_printf(sc, "  complete  %p\n", mc->mc_complete);
2586     mly_printf(sc, "  private   %p\n", mc->mc_private);
2587 }
2588
2589 /********************************************************************************
2590  * Print a command packet
2591  */
2592 static void
2593 mly_print_packet(struct mly_command *mc)
2594 {
2595     struct mly_softc                    *sc = mc->mc_sc;
2596     struct mly_command_generic          *ge = (struct mly_command_generic *)mc->mc_packet;
2597     struct mly_command_scsi_small       *ss = (struct mly_command_scsi_small *)mc->mc_packet;
2598     struct mly_command_scsi_large       *sl = (struct mly_command_scsi_large *)mc->mc_packet;
2599     struct mly_command_ioctl            *io = (struct mly_command_ioctl *)mc->mc_packet;
2600     int                                 transfer;
2601
2602     mly_printf(sc, "   command_id           %d\n", ge->command_id);
2603     mly_printf(sc, "   opcode               %d\n", ge->opcode);
2604     mly_printf(sc, "   command_control      fua %d  dpo %d  est %d  dd %s  nas %d ddis %d\n",
2605                   ge->command_control.force_unit_access,
2606                   ge->command_control.disable_page_out,
2607                   ge->command_control.extended_sg_table,
2608                   (ge->command_control.data_direction == MLY_CCB_WRITE) ? "WRITE" : "READ",
2609                   ge->command_control.no_auto_sense,
2610                   ge->command_control.disable_disconnect);
2611     mly_printf(sc, "   data_size            %d\n", ge->data_size);
2612     mly_printf(sc, "   sense_buffer_address 0x%llx\n", ge->sense_buffer_address);
2613     mly_printf(sc, "   lun                  %d\n", ge->addr.phys.lun);
2614     mly_printf(sc, "   target               %d\n", ge->addr.phys.target);
2615     mly_printf(sc, "   channel              %d\n", ge->addr.phys.channel);
2616     mly_printf(sc, "   logical device       %d\n", ge->addr.log.logdev);
2617     mly_printf(sc, "   controller           %d\n", ge->addr.phys.controller);
2618     mly_printf(sc, "   timeout              %d %s\n",
2619                   ge->timeout.value,
2620                   (ge->timeout.scale == MLY_TIMEOUT_SECONDS) ? "seconds" :
2621                   ((ge->timeout.scale == MLY_TIMEOUT_MINUTES) ? "minutes" : "hours"));
2622     mly_printf(sc, "   maximum_sense_size   %d\n", ge->maximum_sense_size);
2623     switch(ge->opcode) {
2624     case MDACMD_SCSIPT:
2625     case MDACMD_SCSI:
2626         mly_printf(sc, "   cdb length           %d\n", ss->cdb_length);
2627         mly_printf(sc, "   cdb                  %*D\n", ss->cdb_length, ss->cdb, " ");
2628         transfer = 1;
2629         break;
2630     case MDACMD_SCSILC:
2631     case MDACMD_SCSILCPT:
2632         mly_printf(sc, "   cdb length           %d\n", sl->cdb_length);
2633         mly_printf(sc, "   cdb                  0x%llx\n", sl->cdb_physaddr);
2634         transfer = 1;
2635         break;
2636     case MDACMD_IOCTL:
2637         mly_printf(sc, "   sub_ioctl            0x%x\n", io->sub_ioctl);
2638         switch(io->sub_ioctl) {
2639         case MDACIOCTL_SETMEMORYMAILBOX:
2640             mly_printf(sc, "   health_buffer_size   %d\n",
2641                           io->param.setmemorymailbox.health_buffer_size);
2642             mly_printf(sc, "   health_buffer_phys   0x%llx\n",
2643                           io->param.setmemorymailbox.health_buffer_physaddr);
2644             mly_printf(sc, "   command_mailbox      0x%llx\n",
2645                           io->param.setmemorymailbox.command_mailbox_physaddr);
2646             mly_printf(sc, "   status_mailbox       0x%llx\n",
2647                           io->param.setmemorymailbox.status_mailbox_physaddr);
2648             transfer = 0;
2649             break;
2650
2651         case MDACIOCTL_SETREALTIMECLOCK:
2652         case MDACIOCTL_GETHEALTHSTATUS:
2653         case MDACIOCTL_GETCONTROLLERINFO:
2654         case MDACIOCTL_GETLOGDEVINFOVALID:
2655         case MDACIOCTL_GETPHYSDEVINFOVALID:
2656         case MDACIOCTL_GETPHYSDEVSTATISTICS:
2657         case MDACIOCTL_GETLOGDEVSTATISTICS:
2658         case MDACIOCTL_GETCONTROLLERSTATISTICS:
2659         case MDACIOCTL_GETBDT_FOR_SYSDRIVE:
2660         case MDACIOCTL_CREATENEWCONF:
2661         case MDACIOCTL_ADDNEWCONF:
2662         case MDACIOCTL_GETDEVCONFINFO:
2663         case MDACIOCTL_GETFREESPACELIST:
2664         case MDACIOCTL_MORE:
2665         case MDACIOCTL_SETPHYSDEVPARAMETER:
2666         case MDACIOCTL_GETPHYSDEVPARAMETER:
2667         case MDACIOCTL_GETLOGDEVPARAMETER:
2668         case MDACIOCTL_SETLOGDEVPARAMETER:
2669             mly_printf(sc, "   param                %10D\n", io->param.data.param, " ");
2670             transfer = 1;
2671             break;
2672
2673         case MDACIOCTL_GETEVENT:
2674             mly_printf(sc, "   event                %d\n",
2675                        io->param.getevent.sequence_number_low + ((u_int32_t)io->addr.log.logdev << 16));
2676             transfer = 1;
2677             break;
2678
2679         case MDACIOCTL_SETRAIDDEVSTATE:
2680             mly_printf(sc, "   state                %d\n", io->param.setraiddevstate.state);
2681             transfer = 0;
2682             break;
2683
2684         case MDACIOCTL_XLATEPHYSDEVTORAIDDEV:
2685             mly_printf(sc, "   raid_device          %d\n", io->param.xlatephysdevtoraiddev.raid_device);
2686             mly_printf(sc, "   controller           %d\n", io->param.xlatephysdevtoraiddev.controller);
2687             mly_printf(sc, "   channel              %d\n", io->param.xlatephysdevtoraiddev.channel);
2688             mly_printf(sc, "   target               %d\n", io->param.xlatephysdevtoraiddev.target);
2689             mly_printf(sc, "   lun                  %d\n", io->param.xlatephysdevtoraiddev.lun);
2690             transfer = 0;
2691             break;
2692
2693         case MDACIOCTL_GETGROUPCONFINFO:
2694             mly_printf(sc, "   group                %d\n", io->param.getgroupconfinfo.group);
2695             transfer = 1;
2696             break;
2697
2698         case MDACIOCTL_GET_SUBSYSTEM_DATA:
2699         case MDACIOCTL_SET_SUBSYSTEM_DATA:
2700         case MDACIOCTL_STARTDISOCVERY:
2701         case MDACIOCTL_INITPHYSDEVSTART:
2702         case MDACIOCTL_INITPHYSDEVSTOP:
2703         case MDACIOCTL_INITRAIDDEVSTART:
2704         case MDACIOCTL_INITRAIDDEVSTOP:
2705         case MDACIOCTL_REBUILDRAIDDEVSTART:
2706         case MDACIOCTL_REBUILDRAIDDEVSTOP:
2707         case MDACIOCTL_MAKECONSISTENTDATASTART:
2708         case MDACIOCTL_MAKECONSISTENTDATASTOP:
2709         case MDACIOCTL_CONSISTENCYCHECKSTART:
2710         case MDACIOCTL_CONSISTENCYCHECKSTOP:
2711         case MDACIOCTL_RESETDEVICE:
2712         case MDACIOCTL_FLUSHDEVICEDATA:
2713         case MDACIOCTL_PAUSEDEVICE:
2714         case MDACIOCTL_UNPAUSEDEVICE:
2715         case MDACIOCTL_LOCATEDEVICE:
2716         case MDACIOCTL_SETMASTERSLAVEMODE:
2717         case MDACIOCTL_DELETERAIDDEV:
2718         case MDACIOCTL_REPLACEINTERNALDEV:
2719         case MDACIOCTL_CLEARCONF:
2720         case MDACIOCTL_GETCONTROLLERPARAMETER:
2721         case MDACIOCTL_SETCONTRLLERPARAMETER:
2722         case MDACIOCTL_CLEARCONFSUSPMODE:
2723         case MDACIOCTL_STOREIMAGE:
2724         case MDACIOCTL_READIMAGE:
2725         case MDACIOCTL_FLASHIMAGES:
2726         case MDACIOCTL_RENAMERAIDDEV:
2727         default:                        /* no idea what to print */
2728             transfer = 0;
2729             break;
2730         }
2731         break;
2732
2733     case MDACMD_IOCTLCHECK:
2734     case MDACMD_MEMCOPY:
2735     default:
2736         transfer = 0;
2737         break;  /* print nothing */
2738     }
2739     if (transfer) {
2740         if (ge->command_control.extended_sg_table) {
2741             mly_printf(sc, "   sg table             0x%llx/%d\n",
2742                           ge->transfer.indirect.table_physaddr[0], ge->transfer.indirect.entries[0]);
2743         } else {
2744             mly_printf(sc, "   0000                 0x%llx/%lld\n",
2745                           ge->transfer.direct.sg[0].physaddr, ge->transfer.direct.sg[0].length);
2746             mly_printf(sc, "   0001                 0x%llx/%lld\n",
2747                           ge->transfer.direct.sg[1].physaddr, ge->transfer.direct.sg[1].length);
2748         }
2749     }
2750 }
2751
2752 /********************************************************************************
2753  * Panic in a slightly informative fashion
2754  */
2755 static void
2756 mly_panic(struct mly_softc *sc, char *reason)
2757 {
2758     mly_printstate(sc);
2759     panic(reason);
2760 }
2761
2762 /********************************************************************************
2763  * Print queue statistics, callable from DDB.
2764  */
2765 void
2766 mly_print_controller(int controller)
2767 {
2768     struct mly_softc    *sc;
2769
2770     if ((sc = devclass_get_softc(devclass_find("mly"), controller)) == NULL) {
2771         printf("mly: controller %d invalid\n", controller);
2772     } else {
2773         device_printf(sc->mly_dev, "queue    curr max\n");
2774         device_printf(sc->mly_dev, "free     %04d/%04d\n",
2775                       sc->mly_qstat[MLYQ_FREE].q_length, sc->mly_qstat[MLYQ_FREE].q_max);
2776         device_printf(sc->mly_dev, "busy     %04d/%04d\n",
2777                       sc->mly_qstat[MLYQ_BUSY].q_length, sc->mly_qstat[MLYQ_BUSY].q_max);
2778         device_printf(sc->mly_dev, "complete %04d/%04d\n",
2779                       sc->mly_qstat[MLYQ_COMPLETE].q_length, sc->mly_qstat[MLYQ_COMPLETE].q_max);
2780     }
2781 }
2782 #endif
2783
2784
2785 /********************************************************************************
2786  ********************************************************************************
2787                                                          Control device interface
2788  ********************************************************************************
2789  ********************************************************************************/
2790
2791 /********************************************************************************
2792  * Accept an open operation on the control device.
2793  */
2794 static int
2795 mly_user_open(dev_t dev, int flags, int fmt, struct thread *td)
2796 {
2797     int                 unit = minor(dev);
2798     struct mly_softc    *sc = devclass_get_softc(devclass_find("mly"), unit);
2799
2800     sc->mly_state |= MLY_STATE_OPEN;
2801     return(0);
2802 }
2803
2804 /********************************************************************************
2805  * Accept the last close on the control device.
2806  */
2807 static int
2808 mly_user_close(dev_t dev, int flags, int fmt, struct thread *td)
2809 {
2810     int                 unit = minor(dev);
2811     struct mly_softc    *sc = devclass_get_softc(devclass_find("mly"), unit);
2812
2813     sc->mly_state &= ~MLY_STATE_OPEN;
2814     return (0);
2815 }
2816
2817 /********************************************************************************
2818  * Handle controller-specific control operations.
2819  */
2820 static int
2821 mly_user_ioctl(dev_t dev, u_long cmd, caddr_t addr,
2822                                 int32_t flag, struct thread *td)
2823 {
2824     struct mly_softc            *sc = (struct mly_softc *)dev->si_drv1;
2825     struct mly_user_command     *uc = (struct mly_user_command *)addr;
2826     struct mly_user_health      *uh = (struct mly_user_health *)addr;
2827
2828     switch(cmd) {
2829     case MLYIO_COMMAND:
2830         return(mly_user_command(sc, uc));
2831     case MLYIO_HEALTH:
2832         return(mly_user_health(sc, uh));
2833     default:
2834         return(ENOIOCTL);
2835     }
2836 }
2837
2838 /********************************************************************************
2839  * Execute a command passed in from userspace.
2840  *
2841  * The control structure contains the actual command for the controller, as well
2842  * as the user-space data pointer and data size, and an optional sense buffer
2843  * size/pointer.  On completion, the data size is adjusted to the command
2844  * residual, and the sense buffer size to the size of the returned sense data.
2845  *
2846  */
2847 static int
2848 mly_user_command(struct mly_softc *sc, struct mly_user_command *uc)
2849 {
2850     struct mly_command  *mc;
2851     int                 error, s;
2852
2853     /* allocate a command */
2854     if (mly_alloc_command(sc, &mc)) {
2855         error = ENOMEM;
2856         goto out;               /* XXX Linux version will wait for a command */
2857     }
2858
2859     /* handle data size/direction */
2860     mc->mc_length = (uc->DataTransferLength >= 0) ? uc->DataTransferLength : -uc->DataTransferLength;
2861     if (mc->mc_length > 0) {
2862         if ((mc->mc_data = malloc(mc->mc_length, M_DEVBUF, M_NOWAIT)) == NULL) {
2863             error = ENOMEM;
2864             goto out;
2865         }
2866     }
2867     if (uc->DataTransferLength > 0) {
2868         mc->mc_flags |= MLY_CMD_DATAIN;
2869         bzero(mc->mc_data, mc->mc_length);
2870     }
2871     if (uc->DataTransferLength < 0) {
2872         mc->mc_flags |= MLY_CMD_DATAOUT;
2873         if ((error = copyin(uc->DataTransferBuffer, mc->mc_data, mc->mc_length)) != 0)
2874             goto out;
2875     }
2876
2877     /* copy the controller command */
2878     bcopy(&uc->CommandMailbox, mc->mc_packet, sizeof(uc->CommandMailbox));
2879
2880     /* clear command completion handler so that we get woken up */
2881     mc->mc_complete = NULL;
2882
2883     /* execute the command */
2884     if ((error = mly_start(mc)) != 0)
2885         goto out;
2886     s = splcam();
2887     while (!(mc->mc_flags & MLY_CMD_COMPLETE))
2888         tsleep(mc, PRIBIO, "mlyioctl", 0);
2889     splx(s);
2890
2891     /* return the data to userspace */
2892     if (uc->DataTransferLength > 0)
2893         if ((error = copyout(mc->mc_data, uc->DataTransferBuffer, mc->mc_length)) != 0)
2894             goto out;
2895
2896     /* return the sense buffer to userspace */
2897     if ((uc->RequestSenseLength > 0) && (mc->mc_sense > 0)) {
2898         if ((error = copyout(mc->mc_packet, uc->RequestSenseBuffer,
2899                              min(uc->RequestSenseLength, mc->mc_sense))) != 0)
2900             goto out;
2901     }
2902
2903     /* return command results to userspace (caller will copy out) */
2904     uc->DataTransferLength = mc->mc_resid;
2905     uc->RequestSenseLength = min(uc->RequestSenseLength, mc->mc_sense);
2906     uc->CommandStatus = mc->mc_status;
2907     error = 0;
2908
2909  out:
2910     if (mc->mc_data != NULL)
2911         free(mc->mc_data, M_DEVBUF);
2912     if (mc != NULL)
2913         mly_release_command(mc);
2914     return(error);
2915 }
2916
2917 /********************************************************************************
2918  * Return health status to userspace.  If the health change index in the user
2919  * structure does not match that currently exported by the controller, we
2920  * return the current status immediately.  Otherwise, we block until either
2921  * interrupted or new status is delivered.
2922  */
2923 static int
2924 mly_user_health(struct mly_softc *sc, struct mly_user_health *uh)
2925 {
2926     struct mly_health_status            mh;
2927     int                                 error, s;
2928
2929     /* fetch the current health status from userspace */
2930     if ((error = copyin(uh->HealthStatusBuffer, &mh, sizeof(mh))) != 0)
2931         return(error);
2932
2933     /* spin waiting for a status update */
2934     s = splcam();
2935     error = EWOULDBLOCK;
2936     while ((error != 0) && (sc->mly_event_change == mh.change_counter))
2937         error = tsleep(&sc->mly_event_change, PRIBIO | PCATCH, "mlyhealth", 0);
2938     splx(s);
2939
2940     /* copy the controller's health status buffer out (there is a race here if it changes again) */
2941     error = copyout(&sc->mly_mmbox->mmm_health.status, uh->HealthStatusBuffer,
2942                     sizeof(uh->HealthStatusBuffer));
2943     return(error);
2944 }