sys/dev/mly/mly.c

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