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