sys/dev/raid/ciss/ciss.c

   1 /*-
   2  * Copyright (c) 2001 Michael Smith
   3  * All rights reserved.
   4  *
   5  * Redistribution and use in source and binary forms, with or without
   6  * modification, are permitted provided that the following conditions
   7  * are met:
   8  * 1. Redistributions of source code must retain the above copyright
   9  *    notice, this list of conditions and the following disclaimer.
  10  * 2. Redistributions in binary form must reproduce the above copyright
  11  *    notice, this list of conditions and the following disclaimer in the
  12  *    documentation and/or other materials provided with the distribution.
  13  *
  14  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  15  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  16  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  17  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  18  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  19  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  20  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  21  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  22  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  23  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  24  * SUCH DAMAGE.
  25  *
  26  *      $FreeBSD: src/sys/dev/ciss/ciss.c,v 1.2.2.6 2003/02/18 22:27:41 ps Exp $
  27  *      $DragonFly: src/sys/dev/raid/ciss/ciss.c,v 1.16 2005/10/12 17:35:54 dillon Exp $
  28  */
  29
  30 /*
  31  * Common Interface for SCSI-3 Support driver.
  32  *
  33  * CISS claims to provide a common interface between a generic SCSI
  34  * transport and an intelligent host adapter.
  35  *
  36  * This driver supports CISS as defined in the document "CISS Command
  37  * Interface for SCSI-3 Support Open Specification", Version 1.04,
  38  * Valence Number 1, dated 20001127, produced by Compaq Computer
  39  * Corporation.  This document appears to be a hastily and somewhat
  40  * arbitrarlily cut-down version of a larger (and probably even more
  41  * chaotic and inconsistent) Compaq internal document.  Various
  42  * details were also gleaned from Compaq's "cciss" driver for Linux.
  43  *
  44  * We provide a shim layer between the CISS interface and CAM,
  45  * offloading most of the queueing and being-a-disk chores onto CAM.
  46  * Entry to the driver is via the PCI bus attachment (ciss_probe,
  47  * ciss_attach, etc) and via the CAM interface (ciss_cam_action,
  48  * ciss_cam_poll).  The Compaq CISS adapters are, however, poor SCSI
  49  * citizens and we have to fake up some responses to get reasonable
  50  * behaviour out of them.  In addition, the CISS command set is by no
  51  * means adequate to support the functionality of a RAID controller,
  52  * and thus the supported Compaq adapters utilise portions of the
  53  * control protocol from earlier Compaq adapter families.
  54  *
  55  * Note that we only support the "simple" transport layer over PCI.
  56  * This interface (ab)uses the I2O register set (specifically the post
  57  * queues) to exchange commands with the adapter.  Other interfaces
  58  * are available, but we aren't supposed to know about them, and it is
  59  * dubious whether they would provide major performance improvements
  60  * except under extreme load.
  61  *
  62  * Currently the only supported CISS adapters are the Compaq Smart
  63  * Array 5* series (5300, 5i, 532).  Even with only three adapters,
  64  * Compaq still manage to have interface variations.
  65  *
  66  *
  67  * Thanks must go to Fred Harris and Darryl DeVinney at Compaq, as
  68  * well as Paul Saab at Yahoo! for their assistance in making this
  69  * driver happen.
  70  */
  71
  72 #include <sys/param.h>
  73 #include <sys/systm.h>
  74 #include <sys/malloc.h>
  75 #include <sys/kernel.h>
  76 #include <sys/bus.h>
  77 #include <sys/conf.h>
  78 #include <sys/devicestat.h>
  79 #include <sys/stat.h>
  80
  81 #include <bus/cam/cam.h>
  82 #include <bus/cam/cam_ccb.h>
  83 #include <bus/cam/cam_periph.h>
  84 #include <bus/cam/cam_sim.h>
  85 #include <bus/cam/cam_xpt_sim.h>
  86 #include <bus/cam/scsi/scsi_all.h>
  87 #include <bus/cam/scsi/scsi_message.h>
  88
  89 #include <machine/clock.h>
  90 #include <machine/bus_memio.h>
  91 #include <machine/bus.h>
  92 #include <machine/endian.h>
  93 #include <machine/resource.h>
  94 #include <sys/rman.h>
  95
  96 #include <bus/pci/pcireg.h>
  97 #include <bus/pci/pcivar.h>
  98
  99 #include "cissreg.h"
 100 #include "cissvar.h"
 101 #include "cissio.h"
 102
 103 MALLOC_DEFINE(CISS_MALLOC_CLASS, "ciss_data", "ciss internal data buffers");
 104
 105 /* pci interface */
 106 static int      ciss_lookup(device_t dev);
 107 static int      ciss_probe(device_t dev);
 108 static int      ciss_attach(device_t dev);
 109 static int      ciss_detach(device_t dev);
 110 static int      ciss_shutdown(device_t dev);
 111
 112 /* (de)initialisation functions, control wrappers */
 113 static int      ciss_init_pci(struct ciss_softc *sc);
 114 static int      ciss_wait_adapter(struct ciss_softc *sc);
 115 static int      ciss_flush_adapter(struct ciss_softc *sc);
 116 static int      ciss_init_requests(struct ciss_softc *sc);
 117 static void     ciss_command_map_helper(void *arg, bus_dma_segment_t *segs,
 118                                         int nseg, int error);
 119 static int      ciss_identify_adapter(struct ciss_softc *sc);
 120 static int      ciss_init_logical(struct ciss_softc *sc);
 121 static int      ciss_identify_logical(struct ciss_softc *sc, struct ciss_ldrive *ld);
 122 static int      ciss_get_ldrive_status(struct ciss_softc *sc,  struct ciss_ldrive *ld);
 123 static int      ciss_update_config(struct ciss_softc *sc);
 124 static int      ciss_accept_media(struct ciss_softc *sc, int ldrive, int async);
 125 static void     ciss_accept_media_complete(struct ciss_request *cr);
 126 static void     ciss_free(struct ciss_softc *sc);
 127
 128 /* request submission/completion */
 129 static int      ciss_start(struct ciss_request *cr);
 130 static void     ciss_done(struct ciss_softc *sc);
 131 static void     ciss_intr(void *arg);
 132 static void     ciss_complete(struct ciss_softc *sc);
 133 static int      ciss_report_request(struct ciss_request *cr, int *command_status,
 134                                     int *scsi_status);
 135 static int      ciss_synch_request(struct ciss_request *cr, int timeout);
 136 static int      ciss_poll_request(struct ciss_request *cr, int timeout);
 137 static int      ciss_wait_request(struct ciss_request *cr, int timeout);
 138 #if 0
 139 static int      ciss_abort_request(struct ciss_request *cr);
 140 #endif
 141
 142 /* request queueing */
 143 static int      ciss_get_request(struct ciss_softc *sc, struct ciss_request **crp);
 144 static void     ciss_preen_command(struct ciss_request *cr);
 145 static void     ciss_release_request(struct ciss_request *cr);
 146
 147 /* request helpers */
 148 static int      ciss_get_bmic_request(struct ciss_softc *sc, struct ciss_request **crp,
 149                                       int opcode, void **bufp, size_t bufsize);
 150 static int      ciss_user_command(struct ciss_softc *sc, IOCTL_Command_struct *ioc);
 151
 152 /* DMA map/unmap */
 153 static int      ciss_map_request(struct ciss_request *cr);
 154 static void     ciss_request_map_helper(void *arg, bus_dma_segment_t *segs,
 155                                         int nseg, int error);
 156 static void     ciss_unmap_request(struct ciss_request *cr);
 157
 158 /* CAM interface */
 159 static int      ciss_cam_init(struct ciss_softc *sc);
 160 static void     ciss_cam_rescan_target(struct ciss_softc *sc, int target);
 161 static void     ciss_cam_rescan_all(struct ciss_softc *sc);
 162 static void     ciss_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb);
 163 static void     ciss_cam_action(struct cam_sim *sim, union ccb *ccb);
 164 static int      ciss_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio);
 165 static int      ciss_cam_emulate(struct ciss_softc *sc, struct ccb_scsiio *csio);
 166 static void     ciss_cam_poll(struct cam_sim *sim);
 167 static void     ciss_cam_complete(struct ciss_request *cr);
 168 static void     ciss_cam_complete_fixup(struct ciss_softc *sc, struct ccb_scsiio *csio);
 169 static struct cam_periph *ciss_find_periph(struct ciss_softc *sc, int target);
 170 static int      ciss_name_device(struct ciss_softc *sc, int target);
 171
 172 /* periodic status monitoring */
 173 static void     ciss_periodic(void *arg);
 174 static void     ciss_notify_event(struct ciss_softc *sc);
 175 static void     ciss_notify_complete(struct ciss_request *cr);
 176 static int      ciss_notify_abort(struct ciss_softc *sc);
 177 static int      ciss_notify_abort_bmic(struct ciss_softc *sc);
 178 static void     ciss_notify_logical(struct ciss_softc *sc, struct ciss_notify *cn);
 179 static void     ciss_notify_physical(struct ciss_softc *sc, struct ciss_notify *cn);
 180
 181 /* debugging output */
 182 static void     ciss_print_request(struct ciss_request *cr);
 183 static void     ciss_print_ldrive(struct ciss_softc *sc, struct ciss_ldrive *ld);
 184 static const char *ciss_name_ldrive_status(int status);
 185 static int      ciss_decode_ldrive_status(int status);
 186 static const char *ciss_name_ldrive_org(int org);
 187 static const char *ciss_name_command_status(int status);
 188
 189 /*
 190  * PCI bus interface.
 191  */
 192 static device_method_t ciss_methods[] = {
 193     /* Device interface */
 194     DEVMETHOD(device_probe,     ciss_probe),
 195     DEVMETHOD(device_attach,    ciss_attach),
 196     DEVMETHOD(device_detach,    ciss_detach),
 197     DEVMETHOD(device_shutdown,  ciss_shutdown),
 198     { 0, 0 }
 199 };
 200
 201 static driver_t ciss_pci_driver = {
 202     "ciss",
 203     ciss_methods,
 204     sizeof(struct ciss_softc)
 205 };
 206
 207 static devclass_t       ciss_devclass;
 208
 209 DECLARE_DUMMY_MODULE(ciss);
 210 DRIVER_MODULE(ciss, pci, ciss_pci_driver, ciss_devclass, 0, 0);
 211
 212 /*
 213  * Control device interface.
 214  */
 215 static d_open_t         ciss_open;
 216 static d_close_t        ciss_close;
 217 static d_ioctl_t        ciss_ioctl;
 218
 219 #define CISS_CDEV_MAJOR  166
 220
 221 static struct cdevsw ciss_cdevsw = {
 222     /* name */          "ciss",
 223     /* cmaj */          CISS_CDEV_MAJOR,
 224     /* flags */         0,
 225     /* port */          NULL,
 226     /* clone */         NULL,
 227     ciss_open, ciss_close, noread, nowrite, ciss_ioctl,
 228     nopoll, nommap, nostrategy,
 229     nodump, nopsize, nokqfilter
 230 };
 231
 232 /************************************************************************
 233  * CISS adapters amazingly don't have a defined programming interface
 234  * value.  (One could say some very despairing things about PCI and
 235  * people just not getting the general idea.)  So we are forced to
 236  * stick with matching against subvendor/subdevice, and thus have to
 237  * be updated for every new CISS adapter that appears.
 238  */
 239 #define CISS_BOARD_SA5  (1<<0)
 240 #define CISS_BOARD_SA5B (1<<1)
 241
 242 static struct
 243 {
 244     u_int16_t   subvendor;
 245     u_int16_t   subdevice;
 246     int         flags;
 247     char        *desc;
 248 } ciss_vendor_data[] = {
 249     { 0x0e11, 0x4070, CISS_BOARD_SA5,   "Compaq Smart Array 5300" },
 250     { 0x0e11, 0x4080, CISS_BOARD_SA5B,  "Compaq Smart Array 5i" },
 251     { 0x0e11, 0x4082, CISS_BOARD_SA5B,  "Compaq Smart Array 532" },
 252     { 0x0e11, 0x4083, CISS_BOARD_SA5B,  "HP Smart Array 5312" },
 253     { 0x0e11, 0x409A, CISS_BOARD_SA5B,  "HP Smart Array 641" },
 254     { 0x0e11, 0x409B, CISS_BOARD_SA5B,  "HP Smart Array 642" },
 255     { 0x0e11, 0x409C, CISS_BOARD_SA5B,  "HP Smart Array 6400" },
 256     { 0, 0, 0, NULL }
 257 };
 258
 259 /************************************************************************
 260  * Find a match for the device in our list of known adapters.
 261  */
 262 static int
 263 ciss_lookup(device_t dev)
 264 {
 265     int         i;
 266
 267     for (i = 0; ciss_vendor_data[i].desc != NULL; i++)
 268         if ((pci_get_subvendor(dev) == ciss_vendor_data[i].subvendor) &&
 269             (pci_get_subdevice(dev) == ciss_vendor_data[i].subdevice)) {
 270             return(i);
 271         }
 272     return(-1);
 273 }
 274
 275 /************************************************************************
 276  * Match a known CISS adapter.
 277  */
 278 static int
 279 ciss_probe(device_t dev)
 280 {
 281     int         i;
 282
 283     i = ciss_lookup(dev);
 284     if (i != -1) {
 285         device_set_desc(dev, ciss_vendor_data[i].desc);
 286         return(-10);
 287     }
 288     return(ENOENT);
 289 }
 290
 291 /************************************************************************
 292  * Attach the driver to this adapter.
 293  */
 294 static int
 295 ciss_attach(device_t dev)
 296 {
 297     struct ciss_softc   *sc;
 298     int                 i, error;
 299
 300     debug_called(1);
 301
 302 #ifdef CISS_DEBUG
 303     /* print structure/union sizes */
 304     debug_struct(ciss_command);
 305     debug_struct(ciss_header);
 306     debug_union(ciss_device_address);
 307     debug_struct(ciss_cdb);
 308     debug_struct(ciss_report_cdb);
 309     debug_struct(ciss_notify_cdb);
 310     debug_struct(ciss_notify);
 311     debug_struct(ciss_message_cdb);
 312     debug_struct(ciss_error_info_pointer);
 313     debug_struct(ciss_error_info);
 314     debug_struct(ciss_sg_entry);
 315     debug_struct(ciss_config_table);
 316     debug_struct(ciss_bmic_cdb);
 317     debug_struct(ciss_bmic_id_ldrive);
 318     debug_struct(ciss_bmic_id_lstatus);
 319     debug_struct(ciss_bmic_id_table);
 320     debug_struct(ciss_bmic_id_pdrive);
 321     debug_struct(ciss_bmic_blink_pdrive);
 322     debug_struct(ciss_bmic_flush_cache);
 323     debug_const(CISS_MAX_REQUESTS);
 324     debug_const(CISS_MAX_LOGICAL);
 325     debug_const(CISS_INTERRUPT_COALESCE_DELAY);
 326     debug_const(CISS_INTERRUPT_COALESCE_COUNT);
 327     debug_const(CISS_COMMAND_ALLOC_SIZE);
 328     debug_const(CISS_COMMAND_SG_LENGTH);
 329
 330     debug_type(cciss_pci_info_struct);
 331     debug_type(cciss_coalint_struct);
 332     debug_type(cciss_coalint_struct);
 333     debug_type(NodeName_type);
 334     debug_type(NodeName_type);
 335     debug_type(Heartbeat_type);
 336     debug_type(BusTypes_type);
 337     debug_type(FirmwareVer_type);
 338     debug_type(DriverVer_type);
 339     debug_type(IOCTL_Command_struct);
 340 #endif
 341
 342     sc = device_get_softc(dev);
 343     sc->ciss_dev = dev;
 344     callout_init(&sc->ciss_periodic);
 345
 346     /*
 347      * Work out adapter type.
 348      */
 349     i = ciss_lookup(dev);
 350     if (ciss_vendor_data[i].flags & CISS_BOARD_SA5) {
 351         sc->ciss_interrupt_mask = CISS_TL_SIMPLE_INTR_OPQ_SA5;
 352     } else if (ciss_vendor_data[i].flags & CISS_BOARD_SA5B) {
 353         sc->ciss_interrupt_mask = CISS_TL_SIMPLE_INTR_OPQ_SA5B;
 354     } else {
 355         /* really an error on our part */
 356         ciss_printf(sc, "unable to determine hardware type\n");
 357         error = ENXIO;
 358         goto out;
 359     }
 360
 361     /*
 362      * Do PCI-specific init.
 363      */
 364     if ((error = ciss_init_pci(sc)) != 0)
 365         goto out;
 366
 367     /*
 368      * Initialise driver queues.
 369      */
 370     ciss_initq_free(sc);
 371     ciss_initq_busy(sc);
 372     ciss_initq_complete(sc);
 373
 374     /*
 375      * Initialise command/request pool.
 376      */
 377     if ((error = ciss_init_requests(sc)) != 0)
 378         goto out;
 379
 380     /*
 381      * Get adapter information.
 382      */
 383     if ((error = ciss_identify_adapter(sc)) != 0)
 384         goto out;
 385
 386     /*
 387      * Build our private table of logical devices.
 388      */
 389     if ((error = ciss_init_logical(sc)) != 0)
 390         goto out;
 391
 392     /*
 393      * Enable interrupts so that the CAM scan can complete.
 394      */
 395     CISS_TL_SIMPLE_ENABLE_INTERRUPTS(sc);
 396
 397     /*
 398      * Initialise the CAM interface.
 399      */
 400     if ((error = ciss_cam_init(sc)) != 0)
 401         goto out;
 402
 403     /*
 404      * Start the heartbeat routine and event chain.
 405      */
 406     ciss_periodic(sc);
 407
 408    /*
 409      * Create the control device.
 410      */
 411     cdevsw_add(&ciss_cdevsw, -1, device_get_unit(sc->ciss_dev));
 412     sc->ciss_dev_t = make_dev(&ciss_cdevsw, device_get_unit(sc->ciss_dev),
 413                               UID_ROOT, GID_OPERATOR, S_IRUSR | S_IWUSR,
 414                               "ciss%d", device_get_unit(sc->ciss_dev));
 415     sc->ciss_dev_t->si_drv1 = sc;
 416
 417     /*
 418      * The adapter is running; synchronous commands can now sleep
 419      * waiting for an interrupt to signal completion.
 420      */
 421     sc->ciss_flags |= CISS_FLAG_RUNNING;
 422
 423     error = 0;
 424  out:
 425     if (error != 0)
 426         ciss_free(sc);
 427     return(error);
 428 }
 429
 430 /************************************************************************
 431  * Detach the driver from this adapter.
 432  */
 433 static int
 434 ciss_detach(device_t dev)
 435 {
 436     struct ciss_softc   *sc = device_get_softc(dev);
 437
 438     debug_called(1);
 439
 440     /* flush adapter cache */
 441     ciss_flush_adapter(sc);
 442
 443     /* release all resources */
 444     ciss_free(sc);
 445
 446     return(0);
 447
 448 }
 449
 450 /************************************************************************
 451  * Prepare adapter for system shutdown.
 452  */
 453 static int
 454 ciss_shutdown(device_t dev)
 455 {
 456     struct ciss_softc   *sc = device_get_softc(dev);
 457
 458     debug_called(1);
 459
 460     /* flush adapter cache */
 461     ciss_flush_adapter(sc);
 462
 463     return(0);
 464 }
 465
 466 /************************************************************************
 467  * Perform PCI-specific attachment actions.
 468  */
 469 static int
 470 ciss_init_pci(struct ciss_softc *sc)
 471 {
 472     uintptr_t           cbase, csize, cofs;
 473     int                 error;
 474
 475     debug_called(1);
 476
 477     /*
 478      * Allocate register window first (we need this to find the config
 479      * struct).
 480      */
 481     error = ENXIO;
 482     sc->ciss_regs_rid = CISS_TL_SIMPLE_BAR_REGS;
 483     if ((sc->ciss_regs_resource =
 484          bus_alloc_resource(sc->ciss_dev, SYS_RES_MEMORY, &sc->ciss_regs_rid,
 485                             0, ~0, 1, RF_ACTIVE)) == NULL) {
 486         ciss_printf(sc, "can't allocate register window\n");
 487         return(ENXIO);
 488     }
 489     sc->ciss_regs_bhandle = rman_get_bushandle(sc->ciss_regs_resource);
 490     sc->ciss_regs_btag = rman_get_bustag(sc->ciss_regs_resource);
 491
 492     /*
 493      * Find the BAR holding the config structure.  If it's not the one
 494      * we already mapped for registers, map it too.
 495      */
 496     sc->ciss_cfg_rid = CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_CFG_BAR) & 0xffff;
 497     if (sc->ciss_cfg_rid != sc->ciss_regs_rid) {
 498         if ((sc->ciss_cfg_resource =
 499              bus_alloc_resource(sc->ciss_dev, SYS_RES_MEMORY, &sc->ciss_cfg_rid,
 500                                 0, ~0, 1, RF_ACTIVE)) == NULL) {
 501             ciss_printf(sc, "can't allocate config window\n");
 502             return(ENXIO);
 503         }
 504         cbase = (uintptr_t)rman_get_virtual(sc->ciss_cfg_resource);
 505         csize = rman_get_end(sc->ciss_cfg_resource) -
 506             rman_get_start(sc->ciss_cfg_resource) + 1;
 507     } else {
 508         cbase = (uintptr_t)rman_get_virtual(sc->ciss_regs_resource);
 509         csize = rman_get_end(sc->ciss_regs_resource) -
 510             rman_get_start(sc->ciss_regs_resource) + 1;
 511     }
 512     cofs = CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_CFG_OFF);
 513
 514     /*
 515      * Use the base/size/offset values we just calculated to
 516      * sanity-check the config structure.  If it's OK, point to it.
 517      */
 518     if ((cofs + sizeof(struct ciss_config_table)) > csize) {
 519         ciss_printf(sc, "config table outside window\n");
 520         return(ENXIO);
 521     }
 522     sc->ciss_cfg = (struct ciss_config_table *)(cbase + cofs);
 523     debug(1, "config struct at %p", sc->ciss_cfg);
 524
 525     /*
 526      * Validate the config structure.  If we supported other transport
 527      * methods, we could select amongst them at this point in time.
 528      */
 529     if (strncmp(sc->ciss_cfg->signature, "CISS", 4)) {
 530         ciss_printf(sc, "config signature mismatch (got '%c%c%c%c')\n",
 531                     sc->ciss_cfg->signature[0], sc->ciss_cfg->signature[1],
 532                     sc->ciss_cfg->signature[2], sc->ciss_cfg->signature[3]);
 533         return(ENXIO);
 534     }
 535     if ((sc->ciss_cfg->valence < CISS_MIN_VALENCE) ||
 536         (sc->ciss_cfg->valence > CISS_MAX_VALENCE)) {
 537         ciss_printf(sc, "adapter interface specification (%d) unsupported\n",
 538                     sc->ciss_cfg->valence);
 539         return(ENXIO);
 540     }
 541
 542     /*
 543      * Put the board into simple mode, and tell it we're using the low
 544      * 4GB of RAM.  Set the default interrupt coalescing options.
 545      */
 546     if (!(sc->ciss_cfg->supported_methods & CISS_TRANSPORT_METHOD_SIMPLE)) {
 547         ciss_printf(sc, "adapter does not support 'simple' transport layer\n");
 548         return(ENXIO);
 549     }
 550     sc->ciss_cfg->requested_method = CISS_TRANSPORT_METHOD_SIMPLE;
 551     sc->ciss_cfg->command_physlimit = 0;
 552     sc->ciss_cfg->interrupt_coalesce_delay = CISS_INTERRUPT_COALESCE_DELAY;
 553     sc->ciss_cfg->interrupt_coalesce_count = CISS_INTERRUPT_COALESCE_COUNT;
 554
 555     if (ciss_update_config(sc)) {
 556         ciss_printf(sc, "adapter refuses to accept config update (IDBR 0x%x)\n",
 557                     CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IDBR));
 558         return(ENXIO);
 559     }
 560     if (!(sc->ciss_cfg->active_method != CISS_TRANSPORT_METHOD_SIMPLE)) {
 561         ciss_printf(sc,
 562                     "adapter refuses to go into 'simple' transport mode (0x%x, 0x%x)\n",
 563                     sc->ciss_cfg->supported_methods, sc->ciss_cfg->active_method);
 564         return(ENXIO);
 565     }
 566
 567     /*
 568      * Wait for the adapter to come ready.
 569      */
 570     if ((error = ciss_wait_adapter(sc)) != 0)
 571         return(error);
 572
 573     /*
 574      * Turn off interrupts before we go routing anything.
 575      */
 576     CISS_TL_SIMPLE_DISABLE_INTERRUPTS(sc);
 577
 578     /*
 579      * Allocate and set up our interrupt.
 580      */
 581     sc->ciss_irq_rid = 0;
 582     if ((sc->ciss_irq_resource =
 583          bus_alloc_resource(sc->ciss_dev, SYS_RES_IRQ, &sc->ciss_irq_rid, 0, ~0, 1,
 584                             RF_ACTIVE | RF_SHAREABLE)) == NULL) {
 585         ciss_printf(sc, "can't allocate interrupt\n");
 586         return(ENXIO);
 587     }
 588     error = bus_setup_intr(sc->ciss_dev, sc->ciss_irq_resource,
 589                            0, ciss_intr, sc,
 590                            &sc->ciss_intr, NULL);
 591     if (error) {
 592         ciss_printf(sc, "can't set up interrupt\n");
 593         return(ENXIO);
 594     }
 595
 596     /*
 597      * Allocate the parent bus DMA tag appropriate for our PCI
 598      * interface.
 599      *
 600      * Note that "simple" adapters can only address within a 32-bit
 601      * span.
 602      */
 603     if (bus_dma_tag_create(NULL,                        /* parent */
 604                            1, 0,                        /* alignment, boundary */
 605                            BUS_SPACE_MAXADDR_32BIT,     /* lowaddr */
 606                            BUS_SPACE_MAXADDR,           /* highaddr */
 607                            NULL, NULL,                  /* filter, filterarg */
 608                            MAXBSIZE, CISS_COMMAND_SG_LENGTH,    /* maxsize, nsegments */
 609                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 610                            BUS_DMA_ALLOCNOW,            /* flags */
 611                            &sc->ciss_parent_dmat)) {
 612         ciss_printf(sc, "can't allocate parent DMA tag\n");
 613         return(ENOMEM);
 614     }
 615
 616     /*
 617      * Create DMA tag for mapping buffers into adapter-addressable
 618      * space.
 619      */
 620     if (bus_dma_tag_create(sc->ciss_parent_dmat,        /* parent */
 621                            1, 0,                        /* alignment, boundary */
 622                            BUS_SPACE_MAXADDR,           /* lowaddr */
 623                            BUS_SPACE_MAXADDR,           /* highaddr */
 624                            NULL, NULL,                  /* filter, filterarg */
 625                            MAXBSIZE, CISS_COMMAND_SG_LENGTH,    /* maxsize, nsegments */
 626                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 627                            0,                           /* flags */
 628                            &sc->ciss_buffer_dmat)) {
 629         ciss_printf(sc, "can't allocate buffer DMA tag\n");
 630         return(ENOMEM);
 631     }
 632     return(0);
 633 }
 634
 635 /************************************************************************
 636  * Wait for the adapter to come ready.
 637  */
 638 static int
 639 ciss_wait_adapter(struct ciss_softc *sc)
 640 {
 641     int         i;
 642
 643     debug_called(1);
 644
 645     /*
 646      * Wait for the adapter to come ready.
 647      */
 648     if (!(sc->ciss_cfg->active_method & CISS_TRANSPORT_METHOD_READY)) {
 649         ciss_printf(sc, "waiting for adapter to come ready...\n");
 650         for (i = 0; !(sc->ciss_cfg->active_method & CISS_TRANSPORT_METHOD_READY); i++) {
 651             DELAY(1000000);     /* one second */
 652             if (i > 30) {
 653                 ciss_printf(sc, "timed out waiting for adapter to come ready\n");
 654                 return(EIO);
 655             }
 656         }
 657     }
 658     return(0);
 659 }
 660
 661 /************************************************************************
 662  * Flush the adapter cache.
 663  */
 664 static int
 665 ciss_flush_adapter(struct ciss_softc *sc)
 666 {
 667     struct ciss_request                 *cr;
 668     struct ciss_bmic_flush_cache        *cbfc;
 669     int                                 error, command_status;
 670
 671     debug_called(1);
 672
 673     cr = NULL;
 674     cbfc = NULL;
 675
 676     /*
 677      * Build a BMIC request to flush the cache.  We don't disable
 678      * it, as we may be going to do more I/O (eg. we are emulating
 679      * the Synchronise Cache command).
 680      */
 681     cbfc = malloc(sizeof(*cbfc), CISS_MALLOC_CLASS, M_INTWAIT | M_ZERO);
 682     if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_FLUSH_CACHE,
 683                                        (void **)&cbfc, sizeof(*cbfc))) != 0)
 684         goto out;
 685
 686     /*
 687      * Submit the request and wait for it to complete.
 688      */
 689     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
 690         ciss_printf(sc, "error sending BMIC FLUSH_CACHE command (%d)\n", error);
 691         goto out;
 692     }
 693
 694     /*
 695      * Check response.
 696      */
 697     ciss_report_request(cr, &command_status, NULL);
 698     switch(command_status) {
 699     case CISS_CMD_STATUS_SUCCESS:
 700         break;
 701     default:
 702         ciss_printf(sc, "error flushing cache (%s)\n",
 703                     ciss_name_command_status(command_status));
 704         error = EIO;
 705         goto out;
 706     }
 707
 708 out:
 709     if (cbfc != NULL)
 710         free(cbfc, CISS_MALLOC_CLASS);
 711     if (cr != NULL)
 712         ciss_release_request(cr);
 713     return(error);
 714 }
 715
 716 /************************************************************************
 717  * Allocate memory for the adapter command structures, initialise
 718  * the request structures.
 719  *
 720  * Note that the entire set of commands are allocated in a single
 721  * contiguous slab.
 722  */
 723 static int
 724 ciss_init_requests(struct ciss_softc *sc)
 725 {
 726     struct ciss_request *cr;
 727     int                 i;
 728
 729     debug_called(1);
 730
 731     /*
 732      * Calculate the number of request structures/commands we are
 733      * going to provide for this adapter.
 734      */
 735     sc->ciss_max_requests = min(CISS_MAX_REQUESTS, sc->ciss_cfg->max_outstanding_commands);
 736
 737     if (1/*bootverbose*/)
 738         ciss_printf(sc, "using %d of %d available commands\n",
 739                     sc->ciss_max_requests, sc->ciss_cfg->max_outstanding_commands);
 740
 741     /*
 742      * Create the DMA tag for commands.
 743      */
 744     if (bus_dma_tag_create(sc->ciss_parent_dmat,        /* parent */
 745                            1, 0,                        /* alignment, boundary */
 746                            BUS_SPACE_MAXADDR,           /* lowaddr */
 747                            BUS_SPACE_MAXADDR,           /* highaddr */
 748                            NULL, NULL,                  /* filter, filterarg */
 749                            CISS_COMMAND_ALLOC_SIZE *
 750                            sc->ciss_max_requests, 1,    /* maxsize, nsegments */
 751                            BUS_SPACE_MAXSIZE_32BIT,     /* maxsegsize */
 752                            0,                           /* flags */
 753                            &sc->ciss_command_dmat)) {
 754         ciss_printf(sc, "can't allocate command DMA tag\n");
 755         return(ENOMEM);
 756     }
 757     /*
 758      * Allocate memory and make it available for DMA.
 759      */
 760     if (bus_dmamem_alloc(sc->ciss_command_dmat, (void **)&sc->ciss_command,
 761                          BUS_DMA_NOWAIT, &sc->ciss_command_map)) {
 762         ciss_printf(sc, "can't allocate command memory\n");
 763         return(ENOMEM);
 764     }
 765     bus_dmamap_create(sc->ciss_command_dmat, 0, &sc->ciss_command_map);
 766     bus_dmamap_load(sc->ciss_command_dmat, sc->ciss_command_map, sc->ciss_command,
 767                     sizeof(struct ciss_command) * sc->ciss_max_requests,
 768                     ciss_command_map_helper, sc, 0);
 769     bzero(sc->ciss_command, CISS_COMMAND_ALLOC_SIZE * sc->ciss_max_requests);
 770
 771     /*
 772      * Set up the request and command structures, push requests onto
 773      * the free queue.
 774      */
 775     for (i = 1; i < sc->ciss_max_requests; i++) {
 776         cr = &sc->ciss_request[i];
 777         cr->cr_sc = sc;
 778         cr->cr_tag = i;
 779         ciss_enqueue_free(cr);
 780     }
 781     return(0);
 782 }
 783
 784 static void
 785 ciss_command_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
 786 {
 787     struct ciss_softc   *sc = (struct ciss_softc *)arg;
 788
 789     sc->ciss_command_phys = segs->ds_addr;
 790 }
 791
 792 /************************************************************************
 793  * Identify the adapter, print some information about it.
 794  */
 795 static int
 796 ciss_identify_adapter(struct ciss_softc *sc)
 797 {
 798     struct ciss_request *cr;
 799     int                 error, command_status;
 800
 801     debug_called(1);
 802
 803     cr = NULL;
 804
 805     /*
 806      * Get a request, allocate storage for the adapter data.
 807      */
 808     if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_CTLR,
 809                                        (void **)&sc->ciss_id,
 810                                        sizeof(*sc->ciss_id))) != 0)
 811         goto out;
 812
 813     /*
 814      * Submit the request and wait for it to complete.
 815      */
 816     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
 817         ciss_printf(sc, "error sending BMIC ID_CTLR command (%d)\n", error);
 818         goto out;
 819     }
 820
 821     /*
 822      * Check response.
 823      */
 824     ciss_report_request(cr, &command_status, NULL);
 825     switch(command_status) {
 826     case CISS_CMD_STATUS_SUCCESS:               /* buffer right size */
 827         break;
 828     case CISS_CMD_STATUS_DATA_UNDERRUN:
 829     case CISS_CMD_STATUS_DATA_OVERRUN:
 830         ciss_printf(sc, "data over/underrun reading adapter information\n");
 831     default:
 832         ciss_printf(sc, "error reading adapter information (%s)\n",
 833                     ciss_name_command_status(command_status));
 834         error = EIO;
 835         goto out;
 836     }
 837
 838     /* sanity-check reply */
 839     if (!sc->ciss_id->big_map_supported) {
 840         ciss_printf(sc, "adapter does not support BIG_MAP\n");
 841         error = ENXIO;
 842         goto out;
 843     }
 844
 845 #if 0
 846     /* XXX later revisions may not need this */
 847     sc->ciss_flags |= CISS_FLAG_FAKE_SYNCH;
 848 #endif
 849
 850     /* XXX only really required for old 5300 adapters? */
 851     sc->ciss_flags |= CISS_FLAG_BMIC_ABORT;
 852
 853     /* print information */
 854     if (1/*bootverbose*/) {
 855         ciss_printf(sc, "  %d logical drive%s configured\n",
 856                     sc->ciss_id->configured_logical_drives,
 857                     (sc->ciss_id->configured_logical_drives == 1) ? "" : "s");
 858         ciss_printf(sc, "  firmware %4.4s\n", sc->ciss_id->running_firmware_revision);
 859         ciss_printf(sc, "  %d SCSI channels\n", sc->ciss_id->scsi_bus_count);
 860
 861         ciss_printf(sc, "  signature '%.4s'\n", sc->ciss_cfg->signature);
 862         ciss_printf(sc, "  valence %d\n", sc->ciss_cfg->valence);
 863         ciss_printf(sc, "  supported I/O methods 0x%b\n",
 864                     sc->ciss_cfg->supported_methods,
 865                     "\20\1READY\2simple\3performant\4MEMQ\n");
 866         ciss_printf(sc, "  active I/O method 0x%b\n",
 867                     sc->ciss_cfg->active_method, "\20\2simple\3performant\4MEMQ\n");
 868         ciss_printf(sc, "  4G page base 0x%08x\n",
 869                     sc->ciss_cfg->command_physlimit);
 870         ciss_printf(sc, "  interrupt coalesce delay %dus\n",
 871                     sc->ciss_cfg->interrupt_coalesce_delay);
 872         ciss_printf(sc, "  interrupt coalesce count %d\n",
 873                     sc->ciss_cfg->interrupt_coalesce_count);
 874         ciss_printf(sc, "  max outstanding commands %d\n",
 875                     sc->ciss_cfg->max_outstanding_commands);
 876         ciss_printf(sc, "  bus types 0x%b\n", sc->ciss_cfg->bus_types,
 877                     "\20\1ultra2\2ultra3\10fibre1\11fibre2\n");
 878         ciss_printf(sc, "  server name '%.16s'\n", sc->ciss_cfg->server_name);
 879         ciss_printf(sc, "  heartbeat 0x%x\n", sc->ciss_cfg->heartbeat);
 880     }
 881
 882 out:
 883     if (error) {
 884         if (sc->ciss_id != NULL) {
 885             free(sc->ciss_id, CISS_MALLOC_CLASS);
 886             sc->ciss_id = NULL;
 887         }
 888     }
 889     if (cr != NULL)
 890         ciss_release_request(cr);
 891     return(error);
 892 }
 893
 894 /************************************************************************
 895  * Find logical drives on the adapter.
 896  */
 897 static int
 898 ciss_init_logical(struct ciss_softc *sc)
 899 {
 900     struct ciss_request         *cr;
 901     struct ciss_command         *cc;
 902     struct ciss_report_cdb      *crc;
 903     struct ciss_lun_report      *cll;
 904     int                         error, i;
 905     size_t                      report_size;
 906     int                         ndrives;
 907     int                         command_status;
 908
 909     debug_called(1);
 910
 911     cr = NULL;
 912     cll = NULL;
 913
 914     /*
 915      * Get a request, allocate storage for the address list.
 916      */
 917     if ((error = ciss_get_request(sc, &cr)) != 0)
 918         goto out;
 919     report_size = sizeof(*cll) + CISS_MAX_LOGICAL * sizeof(union ciss_device_address);
 920     cll = malloc(report_size, CISS_MALLOC_CLASS, M_INTWAIT | M_ZERO);
 921
 922     /*
 923      * Build the Report Logical LUNs command.
 924      */
 925     cc = CISS_FIND_COMMAND(cr);
 926     cr->cr_data = cll;
 927     cr->cr_length = report_size;
 928     cr->cr_flags = CISS_REQ_DATAIN;
 929
 930     cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
 931     cc->header.address.physical.bus = 0;
 932     cc->header.address.physical.target = 0;
 933     cc->cdb.cdb_length = sizeof(*crc);
 934     cc->cdb.type = CISS_CDB_TYPE_COMMAND;
 935     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
 936     cc->cdb.direction = CISS_CDB_DIRECTION_READ;
 937     cc->cdb.timeout = 30;       /* XXX better suggestions? */
 938
 939     crc = (struct ciss_report_cdb *)&(cc->cdb.cdb[0]);
 940     bzero(crc, sizeof(*crc));
 941     crc->opcode = CISS_OPCODE_REPORT_LOGICAL_LUNS;
 942     crc->length = htonl(report_size);                   /* big-endian field */
 943     cll->list_size = htonl(report_size - sizeof(*cll)); /* big-endian field */
 944
 945     /*
 946      * Submit the request and wait for it to complete.  (timeout
 947      * here should be much greater than above)
 948      */
 949     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
 950         ciss_printf(sc, "error sending Report Logical LUNs command (%d)\n", error);
 951         goto out;
 952     }
 953
 954     /*
 955      * Check response.  Note that data over/underrun is OK.
 956      */
 957     ciss_report_request(cr, &command_status, NULL);
 958     switch(command_status) {
 959     case CISS_CMD_STATUS_SUCCESS:       /* buffer right size */
 960     case CISS_CMD_STATUS_DATA_UNDERRUN: /* buffer too large, not bad */
 961         break;
 962     case CISS_CMD_STATUS_DATA_OVERRUN:
 963         ciss_printf(sc, "WARNING: more logical drives than driver limit (%d), adjust CISS_MAX_LOGICAL\n",
 964                     CISS_MAX_LOGICAL);
 965         break;
 966     default:
 967         ciss_printf(sc, "error detecting logical drive configuration (%s)\n",
 968                     ciss_name_command_status(command_status));
 969         error = EIO;
 970         goto out;
 971     }
 972     ciss_release_request(cr);
 973     cr = NULL;
 974
 975     /* sanity-check reply */
 976     ndrives = (ntohl(cll->list_size) / sizeof(union ciss_device_address));
 977     if ((ndrives < 0) || (ndrives > CISS_MAX_LOGICAL)) {
 978         ciss_printf(sc, "adapter claims to report absurd number of logical drives (%d > %d)\n",
 979                     ndrives, CISS_MAX_LOGICAL);
 980         return(ENXIO);
 981     }
 982
 983     /*
 984      * Save logical drive information.
 985      */
 986     if (1/*bootverbose*/)
 987         ciss_printf(sc, "%d logical drive%s\n", ndrives, (ndrives > 1) ? "s" : "");
 988     if (ndrives != sc->ciss_id->configured_logical_drives)
 989         ciss_printf(sc, "logical drive map claims %d drives, but adapter claims %d\n",
 990                     ndrives, sc->ciss_id->configured_logical_drives);
 991     for (i = 0; i < CISS_MAX_LOGICAL; i++) {
 992         if (i < ndrives) {
 993             sc->ciss_logical[i].cl_address = cll->lun[i];       /* XXX endianness? */
 994             if (ciss_identify_logical(sc, &sc->ciss_logical[i]) != 0)
 995                 continue;
 996             /*
 997              * If the drive has had media exchanged, we should bring it online.
 998              */
 999             if (sc->ciss_logical[i].cl_lstatus->media_exchanged)
1000                 ciss_accept_media(sc, i, 0);
1001
1002         } else {
1003             sc->ciss_logical[i].cl_status = CISS_LD_NONEXISTENT;
1004         }
1005     }
1006     error = 0;
1007
1008  out:
1009     /*
1010      * Note that if the error is a timeout, we are taking a slight
1011      * risk here and assuming that the adapter will not respond at a
1012      * later time, scribbling over host memory.
1013      */
1014     if (cr != NULL)
1015         ciss_release_request(cr);
1016     if (cll != NULL)
1017         free(cll, CISS_MALLOC_CLASS);
1018     return(error);
1019 }
1020
1021 static int
1022 ciss_inquiry_logical(struct ciss_softc *sc, struct ciss_ldrive *ld)
1023 {
1024     struct ciss_request                 *cr;
1025     struct ciss_command                 *cc;
1026     struct scsi_inquiry                 *inq;
1027     int                                 error;
1028     int                                 command_status;
1029     int                                 lun;
1030
1031     cr = NULL;
1032     lun = ld->cl_address.logical.lun;
1033
1034     bzero(&ld->cl_geometry, sizeof(ld->cl_geometry));
1035
1036     if ((error = ciss_get_request(sc, &cr)) != 0)
1037         goto out;
1038
1039     cc = CISS_FIND_COMMAND(cr);
1040     cr->cr_data = &ld->cl_geometry;
1041     cr->cr_length = sizeof(ld->cl_geometry);
1042     cr->cr_flags = CISS_REQ_DATAIN;
1043
1044     cc->header.address.logical.mode = CISS_HDR_ADDRESS_MODE_LOGICAL;
1045     cc->header.address.logical.lun  = lun;
1046     cc->cdb.cdb_length = 6;
1047     cc->cdb.type = CISS_CDB_TYPE_COMMAND;
1048     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1049     cc->cdb.direction = CISS_CDB_DIRECTION_READ;
1050     cc->cdb.timeout = 30;
1051
1052     inq = (struct scsi_inquiry *)&(cc->cdb.cdb[0]);
1053     inq->opcode = INQUIRY;
1054     inq->byte2 = SI_EVPD;
1055     inq->page_code = CISS_VPD_LOGICAL_DRIVE_GEOMETRY;
1056     inq->length = sizeof(ld->cl_geometry);
1057
1058     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1059         ciss_printf(sc, "error getting geometry (%d)\n", error);
1060         goto out;
1061     }
1062
1063     ciss_report_request(cr, &command_status, NULL);
1064     switch(command_status) {
1065     case CISS_CMD_STATUS_SUCCESS:
1066     case CISS_CMD_STATUS_DATA_UNDERRUN:
1067         break;
1068     case CISS_CMD_STATUS_DATA_OVERRUN:
1069         ciss_printf(sc, "WARNING: Data overrun\n");
1070         break;
1071     default:
1072         ciss_printf(sc, "Error detecting logical drive geometry (%s)\n",
1073                     ciss_name_command_status(command_status));
1074         break;
1075     }
1076
1077 out:
1078     if (cr != NULL)
1079         ciss_release_request(cr);
1080     return(error);
1081 }
1082 /************************************************************************
1083  * Identify a logical drive, initialise state related to it.
1084  */
1085 static int
1086 ciss_identify_logical(struct ciss_softc *sc, struct ciss_ldrive *ld)
1087 {
1088     struct ciss_request         *cr;
1089     struct ciss_command         *cc;
1090     struct ciss_bmic_cdb        *cbc;
1091     int                         error, command_status;
1092
1093     debug_called(1);
1094
1095     cr = NULL;
1096
1097     /*
1098      * Build a BMIC request to fetch the drive ID.
1099      */
1100     if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_LDRIVE,
1101                                        (void **)&ld->cl_ldrive,
1102                                        sizeof(*ld->cl_ldrive))) != 0)
1103         goto out;
1104     cc = CISS_FIND_COMMAND(cr);
1105     cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1106     cbc->log_drive = ld->cl_address.logical.lun;
1107
1108     /*
1109      * Submit the request and wait for it to complete.
1110      */
1111     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1112         ciss_printf(sc, "error sending BMIC LDRIVE command (%d)\n", error);
1113         goto out;
1114     }
1115
1116     /*
1117      * Check response.
1118      */
1119     ciss_report_request(cr, &command_status, NULL);
1120     switch(command_status) {
1121     case CISS_CMD_STATUS_SUCCESS:               /* buffer right size */
1122         break;
1123     case CISS_CMD_STATUS_DATA_UNDERRUN:
1124     case CISS_CMD_STATUS_DATA_OVERRUN:
1125         ciss_printf(sc, "data over/underrun reading logical drive ID\n");
1126     default:
1127         ciss_printf(sc, "error reading logical drive ID (%s)\n",
1128                     ciss_name_command_status(command_status));
1129         error = EIO;
1130         goto out;
1131     }
1132     ciss_release_request(cr);
1133     cr = NULL;
1134
1135     /*
1136      * Build a CISS BMIC command to get the logical drive status.
1137      */
1138     if ((error = ciss_get_ldrive_status(sc, ld)) != 0)
1139         goto out;
1140
1141     /*
1142      * Get the logical drive geometry.
1143      */
1144     if ((error = ciss_inquiry_logical(sc, ld)) != 0)
1145         goto out;
1146
1147     /*
1148      * Print the drive's basic characteristics.
1149      */
1150     if (1/*bootverbose*/) {
1151         ciss_printf(sc, "logical drive %d: %s, %dMB ",
1152                     cbc->log_drive, ciss_name_ldrive_org(ld->cl_ldrive->fault_tolerance),
1153                     ((ld->cl_ldrive->blocks_available / (1024 * 1024)) *
1154                      ld->cl_ldrive->block_size));
1155
1156         ciss_print_ldrive(sc, ld);
1157     }
1158 out:
1159     if (error != 0) {
1160         /* make the drive not-exist */
1161         ld->cl_status = CISS_LD_NONEXISTENT;
1162         if (ld->cl_ldrive != NULL) {
1163             free(ld->cl_ldrive, CISS_MALLOC_CLASS);
1164             ld->cl_ldrive = NULL;
1165         }
1166         if (ld->cl_lstatus != NULL) {
1167             free(ld->cl_lstatus, CISS_MALLOC_CLASS);
1168             ld->cl_lstatus = NULL;
1169         }
1170     }
1171     if (cr != NULL)
1172         ciss_release_request(cr);
1173
1174     return(error);
1175 }
1176
1177 /************************************************************************
1178  * Get status for a logical drive.
1179  *
1180  * XXX should we also do this in response to Test Unit Ready?
1181  */
1182 static int
1183 ciss_get_ldrive_status(struct ciss_softc *sc,  struct ciss_ldrive *ld)
1184 {
1185     struct ciss_request         *cr;
1186     struct ciss_command         *cc;
1187     struct ciss_bmic_cdb        *cbc;
1188     int                         error, command_status;
1189
1190     /*
1191      * Build a CISS BMIC command to get the logical drive status.
1192      */
1193     if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ID_LSTATUS,
1194                                        (void **)&ld->cl_lstatus,
1195                                        sizeof(*ld->cl_lstatus))) != 0)
1196         goto out;
1197     cc = CISS_FIND_COMMAND(cr);
1198     cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1199     cbc->log_drive = ld->cl_address.logical.lun;
1200
1201     /*
1202      * Submit the request and wait for it to complete.
1203      */
1204     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1205         ciss_printf(sc, "error sending BMIC LSTATUS command (%d)\n", error);
1206         goto out;
1207     }
1208
1209     /*
1210      * Check response.
1211      */
1212     ciss_report_request(cr, &command_status, NULL);
1213     switch(command_status) {
1214     case CISS_CMD_STATUS_SUCCESS:               /* buffer right size */
1215         break;
1216     case CISS_CMD_STATUS_DATA_UNDERRUN:
1217     case CISS_CMD_STATUS_DATA_OVERRUN:
1218         ciss_printf(sc, "data over/underrun reading logical drive status\n");
1219     default:
1220         ciss_printf(sc, "error reading logical drive status (%s)\n",
1221                     ciss_name_command_status(command_status));
1222         error = EIO;
1223         goto out;
1224     }
1225
1226     /*
1227      * Set the drive's summary status based on the returned status.
1228      *
1229      * XXX testing shows that a failed JBOD drive comes back at next
1230      * boot in "queued for expansion" mode.  WTF?
1231      */
1232     ld->cl_status = ciss_decode_ldrive_status(ld->cl_lstatus->status);
1233
1234 out:
1235     if (cr != NULL)
1236         ciss_release_request(cr);
1237     return(error);
1238 }
1239
1240 /************************************************************************
1241  * Notify the adapter of a config update.
1242  */
1243 static int
1244 ciss_update_config(struct ciss_softc *sc)
1245 {
1246     int         i;
1247
1248     debug_called(1);
1249
1250     CISS_TL_SIMPLE_WRITE(sc, CISS_TL_SIMPLE_IDBR, CISS_TL_SIMPLE_IDBR_CFG_TABLE);
1251     for (i = 0; i < 1000; i++) {
1252         if (!(CISS_TL_SIMPLE_READ(sc, CISS_TL_SIMPLE_IDBR) &
1253               CISS_TL_SIMPLE_IDBR_CFG_TABLE)) {
1254             return(0);
1255         }
1256         DELAY(1000);
1257     }
1258     return(1);
1259 }
1260
1261 /************************************************************************
1262  * Accept new media into a logical drive.
1263  *
1264  * XXX The drive has previously been offline; it would be good if we
1265  *     could make sure it's not open right now.
1266  */
1267 static int
1268 ciss_accept_media(struct ciss_softc *sc, int ldrive, int async)
1269 {
1270     struct ciss_request         *cr;
1271     struct ciss_command         *cc;
1272     struct ciss_bmic_cdb        *cbc;
1273     int                         error;
1274
1275     debug(0, "bringing logical drive %d back online %ssynchronously",
1276           ldrive, async ? "a" : "");
1277
1278     /*
1279      * Build a CISS BMIC command to bring the drive back online.
1280      */
1281     if ((error = ciss_get_bmic_request(sc, &cr, CISS_BMIC_ACCEPT_MEDIA,
1282                                        NULL, 0)) != 0)
1283         goto out;
1284     cc = CISS_FIND_COMMAND(cr);
1285     cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1286     cbc->log_drive = ldrive;
1287
1288     /*
1289      * Dispatch the request asynchronously if we can't sleep waiting
1290      * for it to complete.
1291      */
1292     if (async) {
1293         cr->cr_complete = ciss_accept_media_complete;
1294         if ((error = ciss_start(cr)) != 0)
1295             goto out;
1296         return(0);
1297     } else {
1298         /*
1299          * Submit the request and wait for it to complete.
1300          */
1301         if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
1302             ciss_printf(sc, "error sending BMIC LSTATUS command (%d)\n", error);
1303             goto out;
1304         }
1305     }
1306
1307     /*
1308      * Call the completion callback manually.
1309      */
1310     ciss_accept_media_complete(cr);
1311     return(0);
1312
1313 out:
1314     if (cr != NULL)
1315         ciss_release_request(cr);
1316     return(error);
1317 }
1318
1319 static void
1320 ciss_accept_media_complete(struct ciss_request *cr)
1321 {
1322     int                         command_status;
1323
1324     /*
1325      * Check response.
1326      */
1327     ciss_report_request(cr, &command_status, NULL);
1328     switch(command_status) {
1329     case CISS_CMD_STATUS_SUCCESS:               /* all OK */
1330         /* we should get a logical drive status changed event here */
1331         break;
1332     default:
1333         ciss_printf(cr->cr_sc, "error accepting media into failed logical drive (%s)\n",
1334                     ciss_name_command_status(command_status));
1335         break;
1336     }
1337     ciss_release_request(cr);
1338 }
1339
1340 /************************************************************************
1341  * Release adapter resources.
1342  */
1343 static void
1344 ciss_free(struct ciss_softc *sc)
1345 {
1346     debug_called(1);
1347
1348     /* we're going away */
1349     sc->ciss_flags |= CISS_FLAG_ABORTING;
1350
1351     /* terminate the periodic heartbeat routine */
1352     callout_stop(&sc->ciss_periodic);
1353
1354     /* cancel the Event Notify chain */
1355     ciss_notify_abort(sc);
1356
1357     /* free the controller data */
1358     if (sc->ciss_id != NULL)
1359         free(sc->ciss_id, CISS_MALLOC_CLASS);
1360
1361     /* release I/O resources */
1362     if (sc->ciss_regs_resource != NULL)
1363         bus_release_resource(sc->ciss_dev, SYS_RES_MEMORY,
1364                              sc->ciss_regs_rid, sc->ciss_regs_resource);
1365     if (sc->ciss_cfg_resource != NULL)
1366         bus_release_resource(sc->ciss_dev, SYS_RES_MEMORY,
1367                              sc->ciss_cfg_rid, sc->ciss_cfg_resource);
1368     if (sc->ciss_intr != NULL)
1369         bus_teardown_intr(sc->ciss_dev, sc->ciss_irq_resource, sc->ciss_intr);
1370     if (sc->ciss_irq_resource != NULL)
1371         bus_release_resource(sc->ciss_dev, SYS_RES_IRQ,
1372                              sc->ciss_irq_rid, sc->ciss_irq_resource);
1373
1374     /* destroy DMA tags */
1375     if (sc->ciss_parent_dmat)
1376         bus_dma_tag_destroy(sc->ciss_parent_dmat);
1377     if (sc->ciss_buffer_dmat)
1378         bus_dma_tag_destroy(sc->ciss_buffer_dmat);
1379
1380     /* destroy command memory and DMA tag */
1381     if (sc->ciss_command != NULL) {
1382         bus_dmamap_unload(sc->ciss_command_dmat, sc->ciss_command_map);
1383         bus_dmamem_free(sc->ciss_command_dmat, sc->ciss_command, sc->ciss_command_map);
1384         bus_dmamap_destroy(sc->ciss_command_dmat, sc->ciss_command_map);
1385     }
1386     if (sc->ciss_buffer_dmat)
1387         bus_dma_tag_destroy(sc->ciss_command_dmat);
1388
1389     /* disconnect from CAM */
1390     if (sc->ciss_cam_sim) {
1391         xpt_bus_deregister(cam_sim_path(sc->ciss_cam_sim));
1392         cam_sim_free(sc->ciss_cam_sim);
1393     }
1394     if (sc->ciss_cam_devq)
1395         cam_simq_release(sc->ciss_cam_devq);
1396     /* XXX what about ciss_cam_path? */
1397 }
1398
1399 /************************************************************************
1400  * Give a command to the adapter.
1401  *
1402  * Note that this uses the simple transport layer directly.  If we
1403  * want to add support for other layers, we'll need a switch of some
1404  * sort.
1405  *
1406  * Note that the simple transport layer has no way of refusing a
1407  * command; we only have as many request structures as the adapter
1408  * supports commands, so we don't have to check (this presumes that
1409  * the adapter can handle commands as fast as we throw them at it).
1410  */
1411 static int
1412 ciss_start(struct ciss_request *cr)
1413 {
1414     struct ciss_command *cc;    /* XXX debugging only */
1415     int                 error;
1416
1417     cc = CISS_FIND_COMMAND(cr);
1418     debug(2, "post command %d tag %d ", cr->cr_tag, cc->header.host_tag);
1419
1420     /*
1421      * Map the request's data.
1422      */
1423     if ((error = ciss_map_request(cr)))
1424         return(error);
1425
1426 #if 0
1427     ciss_print_request(cr);
1428 #endif
1429
1430     /*
1431      * Post the command to the adapter.
1432      */
1433     ciss_enqueue_busy(cr);
1434     CISS_TL_SIMPLE_POST_CMD(cr->cr_sc, CISS_FIND_COMMANDPHYS(cr));
1435
1436     return(0);
1437 }
1438
1439 /************************************************************************
1440  * Fetch completed request(s) from the adapter, queue them for
1441  * completion handling.
1442  *
1443  * Note that this uses the simple transport layer directly.  If we
1444  * want to add support for other layers, we'll need a switch of some
1445  * sort.
1446  *
1447  * Note that the simple transport mechanism does not require any
1448  * reentrancy protection; the OPQ read is atomic.  If there is a
1449  * chance of a race with something else that might move the request
1450  * off the busy list, then we will have to lock against that
1451  * (eg. timeouts, etc.)
1452  */
1453 static void
1454 ciss_done(struct ciss_softc *sc)
1455 {
1456     struct ciss_request *cr;
1457     struct ciss_command *cc;
1458     u_int32_t           tag, index;
1459     int                 complete;
1460
1461     debug_called(3);
1462
1463     /*
1464      * Loop quickly taking requests from the adapter and moving them
1465      * from the busy queue to the completed queue.
1466      */
1467     complete = 0;
1468     for (;;) {
1469
1470         /* see if the OPQ contains anything */
1471         if (!CISS_TL_SIMPLE_OPQ_INTERRUPT(sc))
1472             break;
1473
1474         tag = CISS_TL_SIMPLE_FETCH_CMD(sc);
1475         if (tag == CISS_TL_SIMPLE_OPQ_EMPTY)
1476             break;
1477         index = tag >> 2;
1478         debug(2, "completed command %d%s", index,
1479               (tag & CISS_HDR_HOST_TAG_ERROR) ? " with error" : "");
1480         if (index >= sc->ciss_max_requests) {
1481             ciss_printf(sc, "completed invalid request %d (0x%x)\n", index, tag);
1482             continue;
1483         }
1484         cr = &(sc->ciss_request[index]);
1485         cc = CISS_FIND_COMMAND(cr);
1486         cc->header.host_tag = tag;      /* not updated by adapter */
1487         if (ciss_remove_busy(cr)) {
1488             /* assume this is garbage out of the adapter */
1489             ciss_printf(sc, "completed nonbusy request %d\n", index);
1490         } else {
1491             ciss_enqueue_complete(cr);
1492         }
1493         complete = 1;
1494     }
1495
1496     /*
1497      * Invoke completion processing.  If we can defer this out of
1498      * interrupt context, that'd be good.
1499      */
1500     if (complete)
1501         ciss_complete(sc);
1502 }
1503
1504 /************************************************************************
1505  * Take an interrupt from the adapter.
1506  */
1507 static void
1508 ciss_intr(void *arg)
1509 {
1510     struct ciss_softc   *sc = (struct ciss_softc *)arg;
1511
1512     /*
1513      * The only interrupt we recognise indicates that there are
1514      * entries in the outbound post queue.
1515      */
1516     ciss_done(sc);
1517 }
1518
1519 /************************************************************************
1520  * Process completed requests.
1521  *
1522  * Requests can be completed in three fashions:
1523  *
1524  * - by invoking a callback function (cr_complete is non-null)
1525  * - by waking up a sleeper (cr_flags has CISS_REQ_SLEEP set)
1526  * - by clearing the CISS_REQ_POLL flag in interrupt/timeout context
1527  */
1528 static void
1529 ciss_complete(struct ciss_softc *sc)
1530 {
1531     struct ciss_request *cr;
1532
1533     debug_called(2);
1534
1535     /*
1536      * Loop taking requests off the completed queue and performing
1537      * completion processing on them.
1538      */
1539     for (;;) {
1540         if ((cr = ciss_dequeue_complete(sc)) == NULL)
1541             break;
1542         ciss_unmap_request(cr);
1543
1544         /*
1545          * If the request has a callback, invoke it.
1546          */
1547         if (cr->cr_complete != NULL) {
1548             cr->cr_complete(cr);
1549             continue;
1550         }
1551
1552         /*
1553          * If someone is sleeping on this request, wake them up.
1554          */
1555         if (cr->cr_flags & CISS_REQ_SLEEP) {
1556             cr->cr_flags &= ~CISS_REQ_SLEEP;
1557             wakeup(cr);
1558             continue;
1559         }
1560
1561         /*
1562          * If someone is polling this request for completion, signal.
1563          */
1564         if (cr->cr_flags & CISS_REQ_POLL) {
1565             cr->cr_flags &= ~CISS_REQ_POLL;
1566             continue;
1567         }
1568
1569         /*
1570          * Give up and throw the request back on the free queue.  This
1571          * should never happen; resources will probably be lost.
1572          */
1573         ciss_printf(sc, "WARNING: completed command with no submitter\n");
1574         ciss_enqueue_free(cr);
1575     }
1576 }
1577
1578 /************************************************************************
1579  * Report on the completion status of a request, and pass back SCSI
1580  * and command status values.
1581  */
1582 static int
1583 ciss_report_request(struct ciss_request *cr, int *command_status, int *scsi_status)
1584 {
1585     struct ciss_command         *cc;
1586     struct ciss_error_info      *ce;
1587
1588     debug_called(2);
1589
1590     cc = CISS_FIND_COMMAND(cr);
1591     ce = (struct ciss_error_info *)&(cc->sg[0]);
1592
1593     /*
1594      * We don't consider data under/overrun an error for the Report
1595      * Logical/Physical LUNs commands.
1596      */
1597     if ((cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) &&
1598         ((cc->cdb.cdb[0] == CISS_OPCODE_REPORT_LOGICAL_LUNS) ||
1599          (cc->cdb.cdb[0] == CISS_OPCODE_REPORT_PHYSICAL_LUNS))) {
1600         cc->header.host_tag &= ~CISS_HDR_HOST_TAG_ERROR;
1601         debug(2, "ignoring irrelevant under/overrun error");
1602     }
1603
1604     /*
1605      * Check the command's error bit, if clear, there's no status and
1606      * everything is OK.
1607      */
1608     if (!(cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR)) {
1609         if (scsi_status != NULL)
1610             *scsi_status = SCSI_STATUS_OK;
1611         if (command_status != NULL)
1612             *command_status = CISS_CMD_STATUS_SUCCESS;
1613         return(0);
1614     } else {
1615         if (command_status != NULL)
1616             *command_status = ce->command_status;
1617         if (scsi_status != NULL) {
1618             if (ce->command_status == CISS_CMD_STATUS_TARGET_STATUS) {
1619                 *scsi_status = ce->scsi_status;
1620             } else {
1621                 *scsi_status = -1;
1622             }
1623         }
1624         if (bootverbose)
1625             ciss_printf(cr->cr_sc, "command status 0x%x (%s) scsi status 0x%x\n",
1626                         ce->command_status, ciss_name_command_status(ce->command_status),
1627                         ce->scsi_status);
1628         if (ce->command_status == CISS_CMD_STATUS_INVALID_COMMAND) {
1629             ciss_printf(cr->cr_sc, "invalid command, offense size %d at %d, value 0x%x\n",
1630                         ce->additional_error_info.invalid_command.offense_size,
1631                         ce->additional_error_info.invalid_command.offense_offset,
1632                         ce->additional_error_info.invalid_command.offense_value);
1633         }
1634     }
1635     return(1);
1636 }
1637
1638 /************************************************************************
1639  * Issue a request and don't return until it's completed.
1640  *
1641  * Depending on adapter status, we may poll or sleep waiting for
1642  * completion.
1643  */
1644 static int
1645 ciss_synch_request(struct ciss_request *cr, int timeout)
1646 {
1647     if (cr->cr_sc->ciss_flags & CISS_FLAG_RUNNING) {
1648         return(ciss_wait_request(cr, timeout));
1649     } else {
1650         return(ciss_poll_request(cr, timeout));
1651     }
1652 }
1653
1654 /************************************************************************
1655  * Issue a request and poll for completion.
1656  *
1657  * Timeout in milliseconds.
1658  */
1659 static int
1660 ciss_poll_request(struct ciss_request *cr, int timeout)
1661 {
1662     int         error;
1663
1664     debug_called(2);
1665
1666     cr->cr_flags |= CISS_REQ_POLL;
1667     if ((error = ciss_start(cr)) != 0)
1668         return(error);
1669
1670     do {
1671         ciss_done(cr->cr_sc);
1672         if (!(cr->cr_flags & CISS_REQ_POLL))
1673             return(0);
1674         DELAY(1000);
1675     } while (timeout-- >= 0);
1676     return(EWOULDBLOCK);
1677 }
1678
1679 /************************************************************************
1680  * Issue a request and sleep waiting for completion.
1681  *
1682  * Timeout in milliseconds.  Note that a spurious wakeup will reset
1683  * the timeout.
1684  */
1685 static int
1686 ciss_wait_request(struct ciss_request *cr, int timeout)
1687 {
1688     int         error;
1689
1690     debug_called(2);
1691
1692     cr->cr_flags |= CISS_REQ_SLEEP;
1693     if ((error = ciss_start(cr)) != 0)
1694         return(error);
1695
1696     crit_enter();
1697     while (cr->cr_flags & CISS_REQ_SLEEP) {
1698         error = tsleep(cr, PCATCH, "cissREQ", (timeout * hz) / 1000);
1699         /*
1700          * On wakeup or interruption due to restartable activity, go
1701          * back and check to see if we're done.
1702          */
1703         if ((error == 0) || (error == ERESTART)) {
1704             error = 0;
1705             continue;
1706         }
1707         /*
1708          * Timeout, interrupted system call, etc.
1709          */
1710         break;
1711     }
1712     crit_exit();
1713     return(error);
1714 }
1715
1716 #if 0
1717 /************************************************************************
1718  * Abort a request.  Note that a potential exists here to race the
1719  * request being completed; the caller must deal with this.
1720  */
1721 static int
1722 ciss_abort_request(struct ciss_request *ar)
1723 {
1724     struct ciss_request         *cr;
1725     struct ciss_command         *cc;
1726     struct ciss_message_cdb     *cmc;
1727     int                         error;
1728
1729     debug_called(1);
1730
1731     /* get a request */
1732     if ((error = ciss_get_request(ar->cr_sc, &cr)) != 0)
1733         return(error);
1734
1735     /* build the abort command */
1736     cc = CISS_FIND_COMMAND(cr);
1737     cc->header.address.mode.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;    /* addressing? */
1738     cc->header.address.physical.target = 0;
1739     cc->header.address.physical.bus = 0;
1740     cc->cdb.cdb_length = sizeof(*cmc);
1741     cc->cdb.type = CISS_CDB_TYPE_MESSAGE;
1742     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1743     cc->cdb.direction = CISS_CDB_DIRECTION_NONE;
1744     cc->cdb.timeout = 30;
1745
1746     cmc = (struct ciss_message_cdb *)&(cc->cdb.cdb[0]);
1747     cmc->opcode = CISS_OPCODE_MESSAGE_ABORT;
1748     cmc->type = CISS_MESSAGE_ABORT_TASK;
1749     cmc->abort_tag = ar->cr_tag;        /* endianness?? */
1750
1751     /*
1752      * Send the request and wait for a response.  If we believe we
1753      * aborted the request OK, clear the flag that indicates it's
1754      * running.
1755      */
1756     error = ciss_synch_request(cr, 35 * 1000);
1757     if (!error)
1758         error = ciss_report_request(cr, NULL, NULL);
1759     ciss_release_request(cr);
1760
1761     return(error);
1762 }
1763 #endif
1764
1765
1766 /************************************************************************
1767  * Fetch and initialise a request
1768  */
1769 static int
1770 ciss_get_request(struct ciss_softc *sc, struct ciss_request **crp)
1771 {
1772     struct ciss_request *cr;
1773
1774     debug_called(2);
1775
1776     /*
1777      * Get a request and clean it up.
1778      */
1779     if ((cr = ciss_dequeue_free(sc)) == NULL)
1780         return(ENOMEM);
1781
1782     cr->cr_data = NULL;
1783     cr->cr_flags = 0;
1784     cr->cr_complete = NULL;
1785
1786     ciss_preen_command(cr);
1787     *crp = cr;
1788     return(0);
1789 }
1790
1791 static void
1792 ciss_preen_command(struct ciss_request *cr)
1793 {
1794     struct ciss_command *cc;
1795     u_int32_t           cmdphys;
1796
1797     /*
1798      * Clean up the command structure.
1799      *
1800      * Note that we set up the error_info structure here, since the
1801      * length can be overwritten by any command.
1802      */
1803     cc = CISS_FIND_COMMAND(cr);
1804     cc->header.sg_in_list = 0;          /* kinda inefficient this way */
1805     cc->header.sg_total = 0;
1806     cc->header.host_tag = cr->cr_tag << 2;
1807     cc->header.host_tag_zeroes = 0;
1808     cmdphys = CISS_FIND_COMMANDPHYS(cr);
1809     cc->error_info.error_info_address = cmdphys + sizeof(struct ciss_command);
1810     cc->error_info.error_info_length = CISS_COMMAND_ALLOC_SIZE - sizeof(struct ciss_command);
1811
1812 }
1813
1814 /************************************************************************
1815  * Release a request to the free list.
1816  */
1817 static void
1818 ciss_release_request(struct ciss_request *cr)
1819 {
1820     struct ciss_softc   *sc;
1821
1822     debug_called(2);
1823
1824     sc = cr->cr_sc;
1825
1826     /* release the request to the free queue */
1827     ciss_requeue_free(cr);
1828 }
1829
1830 /************************************************************************
1831  * Allocate a request that will be used to send a BMIC command.  Do some
1832  * of the common setup here to avoid duplicating it everywhere else.
1833  */
1834 static int
1835 ciss_get_bmic_request(struct ciss_softc *sc, struct ciss_request **crp,
1836                       int opcode, void **bufp, size_t bufsize)
1837 {
1838     struct ciss_request         *cr;
1839     struct ciss_command         *cc;
1840     struct ciss_bmic_cdb        *cbc;
1841     void                        *buf;
1842     int                         error;
1843     int                         dataout;
1844
1845     debug_called(2);
1846
1847     cr = NULL;
1848     buf = NULL;
1849
1850     /*
1851      * Get a request.
1852      */
1853     if ((error = ciss_get_request(sc, &cr)) != 0)
1854         goto out;
1855
1856     /*
1857      * Allocate data storage if requested, determine the data direction.
1858      */
1859     dataout = 0;
1860     if ((bufsize > 0) && (bufp != NULL)) {
1861         if (*bufp == NULL) {
1862             buf = malloc(bufsize, CISS_MALLOC_CLASS, M_INTWAIT | M_ZERO);
1863         } else {
1864             buf = *bufp;
1865             dataout = 1;        /* we are given a buffer, so we are writing */
1866         }
1867     }
1868
1869     /*
1870      * Build a CISS BMIC command to get the logical drive ID.
1871      */
1872     cr->cr_data = buf;
1873     cr->cr_length = bufsize;
1874     if (!dataout)
1875         cr->cr_flags = CISS_REQ_DATAIN;
1876
1877     cc = CISS_FIND_COMMAND(cr);
1878     cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
1879     cc->header.address.physical.bus = 0;
1880     cc->header.address.physical.target = 0;
1881     cc->cdb.cdb_length = sizeof(*cbc);
1882     cc->cdb.type = CISS_CDB_TYPE_COMMAND;
1883     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
1884     cc->cdb.direction = dataout ? CISS_CDB_DIRECTION_WRITE : CISS_CDB_DIRECTION_READ;
1885     cc->cdb.timeout = 0;
1886
1887     cbc = (struct ciss_bmic_cdb *)&(cc->cdb.cdb[0]);
1888     bzero(cbc, sizeof(*cbc));
1889     cbc->opcode = dataout ? CISS_ARRAY_CONTROLLER_WRITE : CISS_ARRAY_CONTROLLER_READ;
1890     cbc->bmic_opcode = opcode;
1891     cbc->size = htons((u_int16_t)bufsize);
1892
1893 out:
1894     if (error) {
1895         if (cr != NULL)
1896             ciss_release_request(cr);
1897         if ((bufp != NULL) && (*bufp == NULL) && (buf != NULL))
1898             free(buf, CISS_MALLOC_CLASS);
1899     } else {
1900         *crp = cr;
1901         if ((bufp != NULL) && (*bufp == NULL) && (buf != NULL))
1902             *bufp = buf;
1903     }
1904     return(error);
1905 }
1906
1907 /************************************************************************
1908  * Handle a command passed in from userspace.
1909  */
1910 static int
1911 ciss_user_command(struct ciss_softc *sc, IOCTL_Command_struct *ioc)
1912 {
1913     struct ciss_request         *cr;
1914     struct ciss_command         *cc;
1915     struct ciss_error_info      *ce;
1916     int                         error;
1917
1918     debug_called(1);
1919
1920     cr = NULL;
1921
1922     /*
1923      * Get a request.
1924      */
1925     if ((error = ciss_get_request(sc, &cr)) != 0)
1926         goto out;
1927     cc = CISS_FIND_COMMAND(cr);
1928
1929     /*
1930      * Allocate an in-kernel databuffer if required, copy in user data.
1931      */
1932     cr->cr_length = ioc->buf_size;
1933     if (ioc->buf_size > 0) {
1934         if ((cr->cr_data = malloc(ioc->buf_size, CISS_MALLOC_CLASS, M_WAITOK)) == NULL) {
1935             error = ENOMEM;
1936             goto out;
1937         }
1938         if ((error = copyin(ioc->buf, cr->cr_data, ioc->buf_size))) {
1939             debug(0, "copyin: bad data buffer %p/%d", ioc->buf, ioc->buf_size);
1940             goto out;
1941         }
1942     }
1943
1944     /*
1945      * Build the request based on the user command.
1946      */
1947     bcopy(&ioc->LUN_info, &cc->header.address, sizeof(cc->header.address));
1948     bcopy(&ioc->Request, &cc->cdb, sizeof(cc->cdb));
1949
1950     /* XXX anything else to populate here? */
1951
1952     /*
1953      * Run the command.
1954      */
1955     if ((error = ciss_synch_request(cr, 60 * 1000))) {
1956         debug(0, "request failed - %d", error);
1957         goto out;
1958     }
1959
1960     /*
1961      * Copy the results back to the user.
1962      */
1963     ce = (struct ciss_error_info *)&(cc->sg[0]);
1964     bcopy(ce, &ioc->error_info, sizeof(*ce));
1965     if ((ioc->buf_size > 0) &&
1966         (error = copyout(cr->cr_data, ioc->buf, ioc->buf_size))) {
1967         debug(0, "copyout: bad data buffer %p/%d", ioc->buf, ioc->buf_size);
1968         goto out;
1969     }
1970
1971     /* done OK */
1972     error = 0;
1973
1974 out:
1975     if ((cr != NULL) && (cr->cr_data != NULL))
1976         free(cr->cr_data, CISS_MALLOC_CLASS);
1977     if (cr != NULL)
1978         ciss_release_request(cr);
1979     return(error);
1980 }
1981
1982 /************************************************************************
1983  * Map a request into bus-visible space, initialise the scatter/gather
1984  * list.
1985  */
1986 static int
1987 ciss_map_request(struct ciss_request *cr)
1988 {
1989     struct ciss_softc   *sc;
1990
1991     debug_called(2);
1992
1993     sc = cr->cr_sc;
1994
1995     /* check that mapping is necessary */
1996     if ((cr->cr_flags & CISS_REQ_MAPPED) || (cr->cr_data == NULL))
1997         return(0);
1998
1999     bus_dmamap_create(sc->ciss_buffer_dmat, 0, &cr->cr_datamap);
2000     bus_dmamap_load(sc->ciss_buffer_dmat, cr->cr_datamap, cr->cr_data, cr->cr_length,
2001                     ciss_request_map_helper, CISS_FIND_COMMAND(cr), 0);
2002
2003     if (cr->cr_flags & CISS_REQ_DATAIN)
2004         bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_PREREAD);
2005     if (cr->cr_flags & CISS_REQ_DATAOUT)
2006         bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_PREWRITE);
2007
2008     cr->cr_flags |= CISS_REQ_MAPPED;
2009     return(0);
2010 }
2011
2012 static void
2013 ciss_request_map_helper(void *arg, bus_dma_segment_t *segs, int nseg, int error)
2014 {
2015     struct ciss_command *cc;
2016     int                 i;
2017
2018     debug_called(2);
2019
2020     cc = (struct ciss_command *)arg;
2021     for (i = 0; i < nseg; i++) {
2022         cc->sg[i].address = segs[i].ds_addr;
2023         cc->sg[i].length = segs[i].ds_len;
2024         cc->sg[i].extension = 0;
2025     }
2026     /* we leave the s/g table entirely within the command */
2027     cc->header.sg_in_list = nseg;
2028     cc->header.sg_total = nseg;
2029 }
2030
2031 /************************************************************************
2032  * Unmap a request from bus-visible space.
2033  */
2034 static void
2035 ciss_unmap_request(struct ciss_request *cr)
2036 {
2037     struct ciss_softc   *sc;
2038
2039     debug_called(2);
2040
2041     sc = cr->cr_sc;
2042
2043     /* check that unmapping is necessary */
2044     if (!(cr->cr_flags & CISS_REQ_MAPPED) || (cr->cr_data == NULL))
2045         return;
2046
2047     if (cr->cr_flags & CISS_REQ_DATAIN)
2048         bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_POSTREAD);
2049     if (cr->cr_flags & CISS_REQ_DATAOUT)
2050         bus_dmamap_sync(sc->ciss_buffer_dmat, cr->cr_datamap, BUS_DMASYNC_POSTWRITE);
2051
2052     bus_dmamap_unload(sc->ciss_buffer_dmat, cr->cr_datamap);
2053     bus_dmamap_destroy(sc->ciss_buffer_dmat, cr->cr_datamap);
2054     cr->cr_flags &= ~CISS_REQ_MAPPED;
2055 }
2056
2057 /************************************************************************
2058  * Attach the driver to CAM.
2059  *
2060  * We put all the logical drives on a single SCSI bus.
2061  */
2062 static int
2063 ciss_cam_init(struct ciss_softc *sc)
2064 {
2065
2066     debug_called(1);
2067
2068     /*
2069      * Allocate a devq.  We can reuse this for the masked physical
2070      * devices if we decide to export these as well.
2071      */
2072     if ((sc->ciss_cam_devq = cam_simq_alloc(sc->ciss_max_requests)) == NULL) {
2073         ciss_printf(sc, "can't allocate CAM SIM queue\n");
2074         return(ENOMEM);
2075     }
2076
2077     /*
2078      * Create a SIM.
2079      */
2080     if ((sc->ciss_cam_sim = cam_sim_alloc(ciss_cam_action, ciss_cam_poll, "ciss", sc,
2081                                           device_get_unit(sc->ciss_dev),
2082                                           sc->ciss_max_requests - 2,
2083                                           1,
2084                                           sc->ciss_cam_devq)) == NULL) {
2085         ciss_printf(sc, "can't allocate CAM SIM\n");
2086         return(ENOMEM);
2087     }
2088
2089     /*
2090      * Register bus 0 (the 'logical drives' bus) with this SIM.
2091      */
2092     if (xpt_bus_register(sc->ciss_cam_sim, 0) != 0) {
2093         ciss_printf(sc, "can't register SCSI bus 0\n");
2094         return(ENXIO);
2095     }
2096
2097     /*
2098      * Initiate a rescan of the bus.
2099      */
2100     ciss_cam_rescan_all(sc);
2101
2102     return(0);
2103 }
2104
2105 /************************************************************************
2106  * Initiate a rescan of the 'logical devices' SIM
2107  */
2108 static void
2109 ciss_cam_rescan_target(struct ciss_softc *sc, int target)
2110 {
2111     union ccb   *ccb;
2112
2113     debug_called(1);
2114
2115     if ((ccb = malloc(sizeof(union ccb), M_TEMP, M_WAITOK | M_ZERO)) == NULL) {
2116         ciss_printf(sc, "rescan failed (can't allocate CCB)\n");
2117         return;
2118     }
2119
2120     if (xpt_create_path(&sc->ciss_cam_path, xpt_periph, cam_sim_path(sc->ciss_cam_sim), target, 0)
2121         != CAM_REQ_CMP) {
2122         ciss_printf(sc, "rescan failed (can't create path)\n");
2123         return;
2124     }
2125
2126     xpt_setup_ccb(&ccb->ccb_h, sc->ciss_cam_path, 5/*priority (low)*/);
2127     ccb->ccb_h.func_code = XPT_SCAN_BUS;
2128     ccb->ccb_h.cbfcnp = ciss_cam_rescan_callback;
2129     ccb->crcn.flags = CAM_FLAG_NONE;
2130     xpt_action(ccb);
2131
2132     /* scan is now in progress */
2133 }
2134
2135 static void
2136 ciss_cam_rescan_all(struct ciss_softc *sc)
2137 {
2138     return(ciss_cam_rescan_target(sc, 0));
2139 }
2140
2141 static void
2142 ciss_cam_rescan_callback(struct cam_periph *periph, union ccb *ccb)
2143 {
2144     xpt_free_path(ccb->ccb_h.path);
2145     free(ccb, M_TEMP);
2146 }
2147
2148 /************************************************************************
2149  * Handle requests coming from CAM
2150  */
2151 static void
2152 ciss_cam_action(struct cam_sim *sim, union ccb *ccb)
2153 {
2154     struct ciss_softc   *sc;
2155     struct ccb_scsiio   *csio;
2156     int                 target;
2157
2158     sc = cam_sim_softc(sim);
2159     csio = (struct ccb_scsiio *)&ccb->csio;
2160     target = csio->ccb_h.target_id;
2161
2162     switch (ccb->ccb_h.func_code) {
2163
2164         /* perform SCSI I/O */
2165     case XPT_SCSI_IO:
2166         if (!ciss_cam_action_io(sim, csio))
2167             return;
2168         break;
2169
2170         /* perform geometry calculations */
2171     case XPT_CALC_GEOMETRY:
2172     {
2173         struct ccb_calc_geometry        *ccg = &ccb->ccg;
2174         struct ciss_ldrive              *ld = &sc->ciss_logical[target];
2175
2176         debug(1, "XPT_CALC_GEOMETRY %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2177
2178         /*
2179          * Use the cached geometry settings unless the fault tolerance
2180          * is invalid.
2181          */
2182         if (ld->cl_geometry.fault_tolerance == 0xFF) {
2183             u_int32_t                   secs_per_cylinder;
2184
2185             ccg->heads = 255;
2186             ccg->secs_per_track = 32;
2187             secs_per_cylinder = ccg->heads * ccg->secs_per_track;
2188             ccg->cylinders = ccg->volume_size / secs_per_cylinder;
2189         } else {
2190             ccg->heads = ld->cl_geometry.heads;
2191             ccg->secs_per_track = ld->cl_geometry.sectors;
2192             ccg->cylinders = ntohs(ld->cl_geometry.cylinders);
2193         }
2194         ccb->ccb_h.status = CAM_REQ_CMP;
2195         break;
2196     }
2197
2198         /* handle path attribute inquiry */
2199     case XPT_PATH_INQ:
2200     {
2201         struct ccb_pathinq      *cpi = &ccb->cpi;
2202
2203         debug(1, "XPT_PATH_INQ %d:%d:%d", cam_sim_bus(sim), ccb->ccb_h.target_id, ccb->ccb_h.target_lun);
2204
2205         cpi->version_num = 1;
2206         cpi->hba_inquiry = PI_TAG_ABLE; /* XXX is this correct? */
2207         cpi->target_sprt = 0;
2208         cpi->hba_misc = 0;
2209         cpi->max_target = CISS_MAX_LOGICAL;
2210         cpi->max_lun = 0;               /* 'logical drive' channel only */
2211         cpi->initiator_id = CISS_MAX_LOGICAL;
2212         strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
2213         strncpy(cpi->hba_vid, "msmith@freebsd.org", HBA_IDLEN);
2214         strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
2215         cpi->unit_number = cam_sim_unit(sim);
2216         cpi->bus_id = cam_sim_bus(sim);
2217         cpi->base_transfer_speed = 132 * 1024;  /* XXX what to set this to? */
2218         ccb->ccb_h.status = CAM_REQ_CMP;
2219         break;
2220     }
2221
2222     case XPT_GET_TRAN_SETTINGS:
2223     {
2224         struct ccb_trans_settings       *cts = &ccb->cts;
2225         int                             bus, target;
2226
2227         bus = cam_sim_bus(sim);
2228         target = cts->ccb_h.target_id;
2229
2230         debug(1, "XPT_GET_TRAN_SETTINGS %d:%d", bus, target);
2231         cts->valid = 0;
2232
2233         /* disconnect always OK */
2234         cts->flags |= CCB_TRANS_DISC_ENB;
2235         cts->valid |= CCB_TRANS_DISC_VALID;
2236
2237         cts->ccb_h.status = CAM_REQ_CMP;
2238         break;
2239     }
2240
2241     default:            /* we can't do this */
2242         debug(1, "unspported func_code = 0x%x", ccb->ccb_h.func_code);
2243         ccb->ccb_h.status = CAM_REQ_INVALID;
2244         break;
2245     }
2246
2247     xpt_done(ccb);
2248 }
2249
2250 /************************************************************************
2251  * Handle a CAM SCSI I/O request.
2252  */
2253 static int
2254 ciss_cam_action_io(struct cam_sim *sim, struct ccb_scsiio *csio)
2255 {
2256     struct ciss_softc   *sc;
2257     int                 bus, target;
2258     struct ciss_request *cr;
2259     struct ciss_command *cc;
2260     int                 error;
2261
2262     sc = cam_sim_softc(sim);
2263     bus = cam_sim_bus(sim);
2264     target = csio->ccb_h.target_id;
2265
2266     debug(2, "XPT_SCSI_IO %d:%d:%d", bus, target, csio->ccb_h.target_lun);
2267
2268     /* check for I/O attempt to nonexistent device */
2269     if ((bus != 0) ||
2270         (target > CISS_MAX_LOGICAL) ||
2271         (sc->ciss_logical[target].cl_status == CISS_LD_NONEXISTENT)) {
2272         debug(3, "  device does not exist");
2273         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2274     }
2275
2276     /* firmware does not support commands > 10 bytes */
2277     if (csio->cdb_len > 12/*CISS_CDB_BUFFER_SIZE*/) {
2278         debug(3, "  command too large (%d > %d)", csio->cdb_len, CISS_CDB_BUFFER_SIZE);
2279         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2280     }
2281
2282     /* check that the CDB pointer is not to a physical address */
2283     if ((csio->ccb_h.flags & CAM_CDB_POINTER) && (csio->ccb_h.flags & CAM_CDB_PHYS)) {
2284         debug(3, "  CDB pointer is to physical address");
2285         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2286     }
2287
2288     /* if there is data transfer, it must be to/from a virtual address */
2289     if ((csio->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
2290         if (csio->ccb_h.flags & CAM_DATA_PHYS) {                /* we can't map it */
2291             debug(3, "  data pointer is to physical address");
2292             csio->ccb_h.status = CAM_REQ_CMP_ERR;
2293         }
2294         if (csio->ccb_h.flags & CAM_SCATTER_VALID) {    /* we want to do the s/g setup */
2295             debug(3, "  data has premature s/g setup");
2296             csio->ccb_h.status = CAM_REQ_CMP_ERR;
2297         }
2298     }
2299
2300     /* abandon aborted ccbs or those that have failed validation */
2301     if ((csio->ccb_h.status & CAM_STATUS_MASK) != CAM_REQ_INPROG) {
2302         debug(3, "abandoning CCB due to abort/validation failure");
2303         return(EINVAL);
2304     }
2305
2306     /* handle emulation of some SCSI commands ourself */
2307     if (ciss_cam_emulate(sc, csio))
2308         return(0);
2309
2310     /*
2311      * Get a request to manage this command.  If we can't, return the
2312      * ccb, freeze the queue and flag so that we unfreeze it when a
2313      * request completes.
2314      */
2315     if ((error = ciss_get_request(sc, &cr)) != 0) {
2316         xpt_freeze_simq(sc->ciss_cam_sim, 1);
2317         csio->ccb_h.status |= CAM_REQUEUE_REQ;
2318         return(error);
2319     }
2320
2321     /*
2322      * Build the command.
2323      */
2324     cc = CISS_FIND_COMMAND(cr);
2325     cr->cr_data = csio->data_ptr;
2326     cr->cr_length = csio->dxfer_len;
2327     cr->cr_complete = ciss_cam_complete;
2328     cr->cr_private = csio;
2329
2330     cc->header.address.logical.mode = CISS_HDR_ADDRESS_MODE_LOGICAL;
2331     cc->header.address.logical.lun = target;
2332     cc->cdb.cdb_length = csio->cdb_len;
2333     cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2334     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;      /* XXX ordered tags? */
2335     if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_OUT) {
2336         cr->cr_flags = CISS_REQ_DATAOUT;
2337         cc->cdb.direction = CISS_CDB_DIRECTION_WRITE;
2338     } else if ((csio->ccb_h.flags & CAM_DIR_MASK) == CAM_DIR_IN) {
2339         cr->cr_flags = CISS_REQ_DATAIN;
2340         cc->cdb.direction = CISS_CDB_DIRECTION_READ;
2341     } else {
2342         cr->cr_flags = 0;
2343         cc->cdb.direction = CISS_CDB_DIRECTION_NONE;
2344     }
2345     cc->cdb.timeout = (csio->ccb_h.timeout / 1000) + 1;
2346     if (csio->ccb_h.flags & CAM_CDB_POINTER) {
2347         bcopy(csio->cdb_io.cdb_ptr, &cc->cdb.cdb[0], csio->cdb_len);
2348     } else {
2349         bcopy(csio->cdb_io.cdb_bytes, &cc->cdb.cdb[0], csio->cdb_len);
2350     }
2351
2352     /*
2353      * Submit the request to the adapter.
2354      *
2355      * Note that this may fail if we're unable to map the request (and
2356      * if we ever learn a transport layer other than simple, may fail
2357      * if the adapter rejects the command).
2358      */
2359     if ((error = ciss_start(cr)) != 0) {
2360         xpt_freeze_simq(sc->ciss_cam_sim, 1);
2361         csio->ccb_h.status |= CAM_REQUEUE_REQ;
2362         ciss_release_request(cr);
2363         return(error);
2364     }
2365
2366     return(0);
2367 }
2368
2369 /************************************************************************
2370  * Emulate SCSI commands the adapter doesn't handle as we might like.
2371  */
2372 static int
2373 ciss_cam_emulate(struct ciss_softc *sc, struct ccb_scsiio *csio)
2374 {
2375     int         target;
2376     u_int8_t    opcode;
2377
2378
2379     target = csio->ccb_h.target_id;
2380     opcode = (csio->ccb_h.flags & CAM_CDB_POINTER) ?
2381         *(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0];
2382
2383     /*
2384      * Handle requests for volumes that don't exist.  A selection timeout
2385      * is slightly better than an illegal request.  Other errors might be
2386      * better.
2387      */
2388     if (sc->ciss_logical[target].cl_status == CISS_LD_NONEXISTENT) {
2389         csio->ccb_h.status = CAM_SEL_TIMEOUT;
2390         xpt_done((union ccb *)csio);
2391         return(1);
2392     }
2393
2394     /*
2395      * Handle requests for volumes that exist but are offline.
2396      *
2397      * I/O operations should fail, everything else should work.
2398      */
2399     if (sc->ciss_logical[target].cl_status == CISS_LD_OFFLINE) {
2400         switch(opcode) {
2401         case READ_6:
2402         case READ_10:
2403         case READ_12:
2404         case WRITE_6:
2405         case WRITE_10:
2406         case WRITE_12:
2407             csio->ccb_h.status = CAM_SEL_TIMEOUT;
2408             xpt_done((union ccb *)csio);
2409             return(1);
2410         }
2411     }
2412
2413
2414     /* if we have to fake Synchronise Cache */
2415     if (sc->ciss_flags & CISS_FLAG_FAKE_SYNCH) {
2416
2417         /*
2418          * If this is a Synchronise Cache command, typically issued when
2419          * a device is closed, flush the adapter and complete now.
2420          */
2421         if (((csio->ccb_h.flags & CAM_CDB_POINTER) ?
2422              *(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0]) == SYNCHRONIZE_CACHE) {
2423             ciss_flush_adapter(sc);
2424             csio->ccb_h.status = CAM_REQ_CMP;
2425             xpt_done((union ccb *)csio);
2426             return(1);
2427         }
2428     }
2429
2430     return(0);
2431 }
2432
2433 /************************************************************************
2434  * Check for possibly-completed commands.
2435  */
2436 static void
2437 ciss_cam_poll(struct cam_sim *sim)
2438 {
2439     struct ciss_softc   *sc = cam_sim_softc(sim);
2440
2441     debug_called(2);
2442
2443     ciss_done(sc);
2444 }
2445
2446 /************************************************************************
2447  * Handle completion of a command - pass results back through the CCB
2448  */
2449 static void
2450 ciss_cam_complete(struct ciss_request *cr)
2451 {
2452     struct ciss_softc           *sc;
2453     struct ciss_command         *cc;
2454     struct ciss_error_info      *ce;
2455     struct ccb_scsiio           *csio;
2456     int                         scsi_status;
2457     int                         command_status;
2458
2459     debug_called(2);
2460
2461     sc = cr->cr_sc;
2462     cc = CISS_FIND_COMMAND(cr);
2463     ce = (struct ciss_error_info *)&(cc->sg[0]);
2464     csio = (struct ccb_scsiio *)cr->cr_private;
2465
2466     /*
2467      * Extract status values from request.
2468      */
2469     ciss_report_request(cr, &command_status, &scsi_status);
2470     csio->scsi_status = scsi_status;
2471
2472     /*
2473      * Handle specific SCSI status values.
2474      */
2475     switch(scsi_status) {
2476         /* no status due to adapter error */
2477     case -1:
2478         debug(0, "adapter error");
2479         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2480         break;
2481
2482         /* no status due to command completed OK */
2483     case SCSI_STATUS_OK:                /* CISS_SCSI_STATUS_GOOD */
2484         debug(2, "SCSI_STATUS_OK");
2485         csio->ccb_h.status = CAM_REQ_CMP;
2486         break;
2487
2488         /* check condition, sense data included */
2489     case SCSI_STATUS_CHECK_COND:        /* CISS_SCSI_STATUS_CHECK_CONDITION */
2490         debug(0, "SCSI_STATUS_CHECK_COND  sense size %d  resid %d",
2491               ce->sense_length, ce->residual_count);
2492         bzero(&csio->sense_data, SSD_FULL_SIZE);
2493         bcopy(&ce->sense_info[0], &csio->sense_data, ce->sense_length);
2494         csio->sense_len = ce->sense_length;
2495         csio->resid = ce->residual_count;
2496         csio->ccb_h.status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
2497 #ifdef CISS_DEBUG
2498         {
2499             struct scsi_sense_data      *sns = (struct scsi_sense_data *)&ce->sense_info[0];
2500             debug(0, "sense key %x", sns->flags & SSD_KEY);
2501         }
2502 #endif
2503         break;
2504
2505     case SCSI_STATUS_BUSY:              /* CISS_SCSI_STATUS_BUSY */
2506         debug(0, "SCSI_STATUS_BUSY");
2507         csio->ccb_h.status = CAM_SCSI_BUSY;
2508         break;
2509
2510     default:
2511         debug(0, "unknown status 0x%x", csio->scsi_status);
2512         csio->ccb_h.status = CAM_REQ_CMP_ERR;
2513         break;
2514     }
2515
2516     /* handle post-command fixup */
2517     ciss_cam_complete_fixup(sc, csio);
2518
2519     /* tell CAM we're ready for more commands */
2520     csio->ccb_h.status |= CAM_RELEASE_SIMQ;
2521
2522     xpt_done((union ccb *)csio);
2523     ciss_release_request(cr);
2524 }
2525
2526 /********************************************************************************
2527  * Fix up the result of some commands here.
2528  */
2529 static void
2530 ciss_cam_complete_fixup(struct ciss_softc *sc, struct ccb_scsiio *csio)
2531 {
2532     struct scsi_inquiry_data    *inq;
2533     struct ciss_ldrive          *cl;
2534     int                         target;
2535
2536     if (((csio->ccb_h.flags & CAM_CDB_POINTER) ?
2537          *(u_int8_t *)csio->cdb_io.cdb_ptr : csio->cdb_io.cdb_bytes[0]) == INQUIRY) {
2538
2539         inq = (struct scsi_inquiry_data *)csio->data_ptr;
2540         target = csio->ccb_h.target_id;
2541         cl = &sc->ciss_logical[target];
2542
2543         padstr(inq->vendor, "COMPAQ", 8);
2544         padstr(inq->product, ciss_name_ldrive_org(cl->cl_ldrive->fault_tolerance), 8);
2545         padstr(inq->revision, ciss_name_ldrive_status(cl->cl_lstatus->status), 16);
2546     }
2547 }
2548
2549
2550 /********************************************************************************
2551  * Find a peripheral attached at (target)
2552  */
2553 static struct cam_periph *
2554 ciss_find_periph(struct ciss_softc *sc, int target)
2555 {
2556     struct cam_periph   *periph;
2557     struct cam_path     *path;
2558     int                 status;
2559
2560     status = xpt_create_path(&path, NULL, cam_sim_path(sc->ciss_cam_sim), target, 0);
2561     if (status == CAM_REQ_CMP) {
2562         periph = cam_periph_find(path, NULL);
2563         xpt_free_path(path);
2564     } else {
2565         periph = NULL;
2566     }
2567     return(periph);
2568 }
2569
2570 /********************************************************************************
2571  * Name the device at (target)
2572  *
2573  * XXX is this strictly correct?
2574  */
2575 int
2576 ciss_name_device(struct ciss_softc *sc, int target)
2577 {
2578     struct cam_periph   *periph;
2579
2580     if ((periph = ciss_find_periph(sc, target)) != NULL) {
2581         sprintf(sc->ciss_logical[target].cl_name, "%s%d", periph->periph_name, periph->unit_number);
2582         return(0);
2583     }
2584     sc->ciss_logical[target].cl_name[0] = 0;
2585     return(ENOENT);
2586 }
2587
2588 /************************************************************************
2589  * Periodic status monitoring.
2590  */
2591 static void
2592 ciss_periodic(void *arg)
2593 {
2594     struct ciss_softc   *sc;
2595
2596     debug_called(1);
2597
2598     sc = (struct ciss_softc *)arg;
2599
2600     /*
2601      * Check the adapter heartbeat.
2602      */
2603     if (sc->ciss_cfg->heartbeat == sc->ciss_heartbeat) {
2604         sc->ciss_heart_attack++;
2605         debug(0, "adapter heart attack in progress 0x%x/%d",
2606               sc->ciss_heartbeat, sc->ciss_heart_attack);
2607         if (sc->ciss_heart_attack == 3) {
2608             ciss_printf(sc, "ADAPTER HEARTBEAT FAILED\n");
2609             /* XXX should reset adapter here */
2610         }
2611     } else {
2612         sc->ciss_heartbeat = sc->ciss_cfg->heartbeat;
2613         sc->ciss_heart_attack = 0;
2614         debug(3, "new heartbeat 0x%x", sc->ciss_heartbeat);
2615     }
2616
2617     /*
2618      * If the notify event request has died for some reason, or has
2619      * not started yet, restart it.
2620      */
2621     if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK)) {
2622         debug(0, "(re)starting Event Notify chain");
2623         ciss_notify_event(sc);
2624     }
2625
2626     /*
2627      * Reschedule.
2628      */
2629     if (!(sc->ciss_flags & CISS_FLAG_ABORTING))
2630         callout_reset(&sc->ciss_periodic, CISS_HEARTBEAT_RATE * hz,
2631                       ciss_periodic, sc);
2632 }
2633
2634 /************************************************************************
2635  * Request a notification response from the adapter.
2636  *
2637  * If (cr) is NULL, this is the first request of the adapter, so
2638  * reset the adapter's message pointer and start with the oldest
2639  * message available.
2640  */
2641 static void
2642 ciss_notify_event(struct ciss_softc *sc)
2643 {
2644     struct ciss_request         *cr;
2645     struct ciss_command         *cc;
2646     struct ciss_notify_cdb      *cnc;
2647     int                         error;
2648
2649     debug_called(1);
2650
2651     cr = sc->ciss_periodic_notify;
2652
2653     /* get a request if we don't already have one */
2654     if (cr == NULL) {
2655         if ((error = ciss_get_request(sc, &cr)) != 0) {
2656             debug(0, "can't get notify event request");
2657             goto out;
2658         }
2659         sc->ciss_periodic_notify = cr;
2660         cr->cr_complete = ciss_notify_complete;
2661         debug(1, "acquired request %d", cr->cr_tag);
2662     }
2663
2664     /*
2665      * Get a databuffer if we don't already have one, note that the
2666      * adapter command wants a larger buffer than the actual
2667      * structure.
2668      */
2669     if (cr->cr_data == NULL) {
2670         cr->cr_data = malloc(CISS_NOTIFY_DATA_SIZE, CISS_MALLOC_CLASS, M_INTWAIT);
2671         cr->cr_length = CISS_NOTIFY_DATA_SIZE;
2672     }
2673
2674     /* re-setup the request's command (since we never release it) XXX overkill*/
2675     ciss_preen_command(cr);
2676
2677     /* (re)build the notify event command */
2678     cc = CISS_FIND_COMMAND(cr);
2679     cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
2680     cc->header.address.physical.bus = 0;
2681     cc->header.address.physical.target = 0;
2682
2683     cc->cdb.cdb_length = sizeof(*cnc);
2684     cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2685     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
2686     cc->cdb.direction = CISS_CDB_DIRECTION_READ;
2687     cc->cdb.timeout = 0;        /* no timeout, we hope */
2688
2689     cnc = (struct ciss_notify_cdb *)&(cc->cdb.cdb[0]);
2690     bzero(cr->cr_data, CISS_NOTIFY_DATA_SIZE);
2691     cnc->opcode = CISS_OPCODE_READ;
2692     cnc->command = CISS_COMMAND_NOTIFY_ON_EVENT;
2693     cnc->timeout = 0;           /* no timeout, we hope */
2694     cnc->synchronous = 0;
2695     cnc->ordered = 0;
2696     cnc->seek_to_oldest = 0;
2697     cnc->new_only = 0;
2698     cnc->length = htonl(CISS_NOTIFY_DATA_SIZE);
2699
2700     /* submit the request */
2701     error = ciss_start(cr);
2702
2703  out:
2704     if (error) {
2705         if (cr != NULL) {
2706             if (cr->cr_data != NULL)
2707                 free(cr->cr_data, CISS_MALLOC_CLASS);
2708             ciss_release_request(cr);
2709         }
2710         sc->ciss_periodic_notify = NULL;
2711         debug(0, "can't submit notify event request");
2712         sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2713     } else {
2714         debug(1, "notify event submitted");
2715         sc->ciss_flags |= CISS_FLAG_NOTIFY_OK;
2716     }
2717 }
2718
2719 static void
2720 ciss_notify_complete(struct ciss_request *cr)
2721 {
2722     struct ciss_command *cc;
2723     struct ciss_notify  *cn;
2724     struct ciss_softc   *sc;
2725     int                 scsi_status;
2726     int                 command_status;
2727
2728     debug_called(1);
2729
2730     cc = CISS_FIND_COMMAND(cr);
2731     cn = (struct ciss_notify *)cr->cr_data;
2732     sc = cr->cr_sc;
2733
2734     /*
2735      * Report request results, decode status.
2736      */
2737     ciss_report_request(cr, &command_status, &scsi_status);
2738
2739     /*
2740      * Abort the chain on a fatal error.
2741      *
2742      * XXX which of these are actually errors?
2743      */
2744     if ((command_status != CISS_CMD_STATUS_SUCCESS) &&
2745         (command_status != CISS_CMD_STATUS_TARGET_STATUS) &&
2746         (command_status != CISS_CMD_STATUS_TIMEOUT)) {  /* XXX timeout? */
2747         ciss_printf(sc, "fatal error in Notify Event request (%s)\n",
2748                     ciss_name_command_status(command_status));
2749         ciss_release_request(cr);
2750         sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2751         return;
2752     }
2753
2754     /*
2755      * If the adapter gave us a text message, print it.
2756      */
2757     if (cn->message[0] != 0)
2758         ciss_printf(sc, "*** %.80s\n", cn->message);
2759
2760     debug(0, "notify event class %d subclass %d detail %d",
2761                 cn->class, cn->subclass, cn->detail);
2762
2763     /*
2764      * If there's room, save the event for a user-level tool.
2765      */
2766     if (((sc->ciss_notify_head + 1) % CISS_MAX_EVENTS) != sc->ciss_notify_tail) {
2767         sc->ciss_notify[sc->ciss_notify_head] = *cn;
2768         sc->ciss_notify_head = (sc->ciss_notify_head + 1) % CISS_MAX_EVENTS;
2769     }
2770
2771     /*
2772      * Some events are directly of interest to us.
2773      */
2774     switch (cn->class) {
2775     case CISS_NOTIFY_LOGICAL:
2776         ciss_notify_logical(sc, cn);
2777         break;
2778     case CISS_NOTIFY_PHYSICAL:
2779         ciss_notify_physical(sc, cn);
2780         break;
2781     }
2782
2783     /*
2784      * If the response indicates that the notifier has been aborted,
2785      * release the notifier command.
2786      */
2787     if ((cn->class == CISS_NOTIFY_NOTIFIER) &&
2788         (cn->subclass == CISS_NOTIFY_NOTIFIER_STATUS) &&
2789         (cn->detail == 1)) {
2790         debug(0, "notifier exiting");
2791         sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2792         ciss_release_request(cr);
2793         sc->ciss_periodic_notify = NULL;
2794         wakeup(&sc->ciss_periodic_notify);
2795     }
2796
2797     /*
2798      * Send a new notify event command, if we're not aborting.
2799      */
2800     if (!(sc->ciss_flags & CISS_FLAG_ABORTING)) {
2801         ciss_notify_event(sc);
2802     }
2803 }
2804
2805 /************************************************************************
2806  * Abort the Notify Event chain.
2807  *
2808  * Note that we can't just abort the command in progress; we have to
2809  * explicitly issue an Abort Notify Event command in order for the
2810  * adapter to clean up correctly.
2811  *
2812  * If we are called with CISS_FLAG_ABORTING set in the adapter softc,
2813  * the chain will not restart itself.
2814  */
2815 static int
2816 ciss_notify_abort(struct ciss_softc *sc)
2817 {
2818     struct ciss_request         *cr;
2819     struct ciss_command         *cc;
2820     struct ciss_notify_cdb      *cnc;
2821     int                         error, command_status, scsi_status;
2822
2823     debug_called(1);
2824
2825     cr = NULL;
2826     error = 0;
2827
2828     /* verify that there's an outstanding command */
2829     if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK))
2830         goto out;
2831
2832     /* get a command to issue the abort with */
2833     if ((error = ciss_get_request(sc, &cr)))
2834         goto out;
2835
2836     /* get a buffer for the result */
2837     cr->cr_data = malloc(CISS_NOTIFY_DATA_SIZE, CISS_MALLOC_CLASS, M_INTWAIT);
2838     cr->cr_length = CISS_NOTIFY_DATA_SIZE;
2839
2840     /* build the CDB */
2841     cc = CISS_FIND_COMMAND(cr);
2842     cc->header.address.physical.mode = CISS_HDR_ADDRESS_MODE_PERIPHERAL;
2843     cc->header.address.physical.bus = 0;
2844     cc->header.address.physical.target = 0;
2845     cc->cdb.cdb_length = sizeof(*cnc);
2846     cc->cdb.type = CISS_CDB_TYPE_COMMAND;
2847     cc->cdb.attribute = CISS_CDB_ATTRIBUTE_SIMPLE;
2848     cc->cdb.direction = CISS_CDB_DIRECTION_READ;
2849     cc->cdb.timeout = 0;        /* no timeout, we hope */
2850
2851     cnc = (struct ciss_notify_cdb *)&(cc->cdb.cdb[0]);
2852     bzero(cnc, sizeof(*cnc));
2853     cnc->opcode = CISS_OPCODE_WRITE;
2854     cnc->command = CISS_COMMAND_ABORT_NOTIFY;
2855     cnc->length = htonl(CISS_NOTIFY_DATA_SIZE);
2856
2857     ciss_print_request(cr);
2858
2859     /*
2860      * Submit the request and wait for it to complete.
2861      */
2862     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
2863         ciss_printf(sc, "Abort Notify Event command failed (%d)\n", error);
2864         goto out;
2865     }
2866
2867     /*
2868      * Check response.
2869      */
2870     ciss_report_request(cr, &command_status, &scsi_status);
2871     switch(command_status) {
2872     case CISS_CMD_STATUS_SUCCESS:
2873         break;
2874     case CISS_CMD_STATUS_INVALID_COMMAND:
2875         /*
2876          * Some older adapters don't support the CISS version of this
2877          * command.  Fall back to using the BMIC version.
2878          */
2879         error = ciss_notify_abort_bmic(sc);
2880         if (error != 0)
2881             goto out;
2882         break;
2883
2884     case CISS_CMD_STATUS_TARGET_STATUS:
2885         /*
2886          * This can happen if the adapter thinks there wasn't an outstanding
2887          * Notify Event command but we did.  We clean up here.
2888          */
2889         if (scsi_status == CISS_SCSI_STATUS_CHECK_CONDITION) {
2890             if (sc->ciss_periodic_notify != NULL)
2891                 ciss_release_request(sc->ciss_periodic_notify);
2892             error = 0;
2893             goto out;
2894         }
2895         /* FALLTHROUGH */
2896
2897     default:
2898         ciss_printf(sc, "Abort Notify Event command failed (%s)\n",
2899                     ciss_name_command_status(command_status));
2900         error = EIO;
2901         goto out;
2902     }
2903
2904     /*
2905      * Sleep waiting for the notifier command to complete.  Note
2906      * that if it doesn't, we may end up in a bad situation, since
2907      * the adapter may deliver it later.  Also note that the adapter
2908      * requires the Notify Event command to be cancelled in order to
2909      * maintain internal bookkeeping.
2910      */
2911     crit_enter();
2912     while (sc->ciss_periodic_notify != NULL) {
2913         error = tsleep(&sc->ciss_periodic_notify, 0, "cissNEA", hz * 5);
2914         if (error == EWOULDBLOCK) {
2915             ciss_printf(sc, "Notify Event command failed to abort, adapter may wedge.\n");
2916             break;
2917         }
2918     }
2919     crit_exit();
2920
2921  out:
2922     /* release the cancel request */
2923     if (cr != NULL) {
2924         if (cr->cr_data != NULL)
2925             free(cr->cr_data, CISS_MALLOC_CLASS);
2926         ciss_release_request(cr);
2927     }
2928     if (error == 0)
2929         sc->ciss_flags &= ~CISS_FLAG_NOTIFY_OK;
2930     return(error);
2931 }
2932
2933 /************************************************************************
2934  * Abort the Notify Event chain using a BMIC command.
2935  */
2936 static int
2937 ciss_notify_abort_bmic(struct ciss_softc *sc)
2938 {
2939     struct ciss_request                 *cr;
2940     int                                 error, command_status;
2941
2942     debug_called(1);
2943
2944     cr = NULL;
2945     error = 0;
2946
2947     /* verify that there's an outstanding command */
2948     if (!(sc->ciss_flags & CISS_FLAG_NOTIFY_OK))
2949         goto out;
2950
2951     /*
2952      * Build a BMIC command to cancel the Notify on Event command.
2953      *
2954      * Note that we are sending a CISS opcode here.  Odd.
2955      */
2956     if ((error = ciss_get_bmic_request(sc, &cr, CISS_COMMAND_ABORT_NOTIFY,
2957                                        NULL, 0)) != 0)
2958         goto out;
2959
2960     /*
2961      * Submit the request and wait for it to complete.
2962      */
2963     if ((error = ciss_synch_request(cr, 60 * 1000)) != 0) {
2964         ciss_printf(sc, "error sending BMIC Cancel Notify on Event command (%d)\n", error);
2965         goto out;
2966     }
2967
2968     /*
2969      * Check response.
2970      */
2971     ciss_report_request(cr, &command_status, NULL);
2972     switch(command_status) {
2973     case CISS_CMD_STATUS_SUCCESS:
2974         break;
2975     default:
2976         ciss_printf(sc, "error cancelling Notify on Event (%s)\n",
2977                     ciss_name_command_status(command_status));
2978         error = EIO;
2979         goto out;
2980     }
2981
2982 out:
2983     if (cr != NULL)
2984         ciss_release_request(cr);
2985     return(error);
2986 }
2987
2988 /************************************************************************
2989  * Handle a notify event relating to the status of a logical drive.
2990  *
2991  * XXX need to be able to defer some of these to properly handle
2992  *     calling the "ID Physical drive" command, unless the 'extended'
2993  *     drive IDs are always in BIG_MAP format.
2994  */
2995 static void
2996 ciss_notify_logical(struct ciss_softc *sc, struct ciss_notify *cn)
2997 {
2998     struct ciss_ldrive  *ld;
2999     int                 ostatus;
3000
3001     debug_called(2);
3002
3003     ld = &sc->ciss_logical[cn->data.logical_status.logical_drive];
3004
3005     switch (cn->subclass) {
3006     case CISS_NOTIFY_LOGICAL_STATUS:
3007         switch (cn->detail) {
3008         case 0:
3009             ciss_name_device(sc, cn->data.logical_status.logical_drive);
3010             ciss_printf(sc, "logical drive %d (%s) changed status %s->%s, spare status 0x%b\n",
3011                         cn->data.logical_status.logical_drive, ld->cl_name,
3012                         ciss_name_ldrive_status(cn->data.logical_status.previous_state),
3013                         ciss_name_ldrive_status(cn->data.logical_status.new_state),
3014                         cn->data.logical_status.spare_state,
3015                         "\20\1configured\2rebuilding\3failed\4in use\5available\n");
3016
3017             /*
3018              * Update our idea of the drive's status.
3019              */
3020             ostatus = ciss_decode_ldrive_status(cn->data.logical_status.previous_state);
3021             ld->cl_status = ciss_decode_ldrive_status(cn->data.logical_status.new_state);
3022             if (ld->cl_lstatus != NULL)
3023                 ld->cl_lstatus->status = cn->data.logical_status.new_state;
3024
3025 #if 0
3026             /*
3027              * Have CAM rescan the drive if its status has changed.
3028              */
3029             if (ostatus != ld->cl_status)
3030                 ciss_cam_rescan_target(sc, cn->data.logical_status.logical_drive);
3031 #endif
3032
3033             break;
3034
3035         case 1: /* logical drive has recognised new media, needs Accept Media Exchange */
3036             ciss_name_device(sc, cn->data.logical_status.logical_drive);
3037             ciss_printf(sc, "logical drive %d (%s) media exchanged, ready to go online\n",
3038                         cn->data.logical_status.logical_drive, ld->cl_name);
3039             ciss_accept_media(sc, cn->data.logical_status.logical_drive, 1);
3040             break;
3041
3042         case 2:
3043         case 3:
3044             ciss_printf(sc, "rebuild of logical drive %d (%s) failed due to %s error\n",
3045                         cn->data.rebuild_aborted.logical_drive,
3046                         sc->ciss_logical[cn->data.rebuild_aborted.logical_drive].cl_name,
3047                         (cn->detail == 2) ? "read" : "write");
3048             break;
3049         }
3050         break;
3051
3052     case CISS_NOTIFY_LOGICAL_ERROR:
3053         if (cn->detail == 0) {
3054             ciss_printf(sc, "FATAL I/O ERROR on logical drive %d (%s), SCSI port %d ID %d\n",
3055                         cn->data.io_error.logical_drive,
3056                         sc->ciss_logical[cn->data.io_error.logical_drive].cl_name,
3057                         cn->data.io_error.failure_bus,
3058                         cn->data.io_error.failure_drive);
3059             /* XXX should we take the drive down at this point, or will we be told? */
3060         }
3061         break;
3062
3063     case CISS_NOTIFY_LOGICAL_SURFACE:
3064         if (cn->detail == 0)
3065             ciss_printf(sc, "logical drive %d (%s) completed consistency initialisation\n",
3066                         cn->data.consistency_completed.logical_drive,
3067                         sc->ciss_logical[cn->data.consistency_completed.logical_drive].cl_name);
3068         break;
3069     }
3070 }
3071
3072 /************************************************************************
3073  * Handle a notify event relating to the status of a physical drive.
3074  */
3075 static void
3076 ciss_notify_physical(struct ciss_softc *sc, struct ciss_notify *cn)
3077 {
3078
3079 }
3080
3081 /************************************************************************
3082  * Print a request.
3083  */
3084 static void
3085 ciss_print_request(struct ciss_request *cr)
3086 {
3087     struct ciss_softc   *sc;
3088     struct ciss_command *cc;
3089     int                 i;
3090
3091     sc = cr->cr_sc;
3092     cc = CISS_FIND_COMMAND(cr);
3093
3094     ciss_printf(sc, "REQUEST @ %p\n", cr);
3095     ciss_printf(sc, "  data %p/%d  tag %d  flags %b\n",
3096               cr->cr_data, cr->cr_length, cr->cr_tag, cr->cr_flags,
3097               "\20\1mapped\2sleep\3poll\4dataout\5datain\n");
3098     ciss_printf(sc, "  sg list/total %d/%d  host tag 0x%x\n",
3099                 cc->header.sg_in_list, cc->header.sg_total, cc->header.host_tag);
3100     switch(cc->header.address.mode.mode) {
3101     case CISS_HDR_ADDRESS_MODE_PERIPHERAL:
3102     case CISS_HDR_ADDRESS_MODE_MASK_PERIPHERAL:
3103         ciss_printf(sc, "  physical bus %d target %d\n",
3104                     cc->header.address.physical.bus, cc->header.address.physical.target);
3105         break;
3106     case CISS_HDR_ADDRESS_MODE_LOGICAL:
3107         ciss_printf(sc, "  logical unit %d\n", cc->header.address.logical.lun);
3108         break;
3109     }
3110     ciss_printf(sc, "  %s cdb length %d type %s attribute %s\n",
3111                 (cc->cdb.direction == CISS_CDB_DIRECTION_NONE) ? "no-I/O" :
3112                 (cc->cdb.direction == CISS_CDB_DIRECTION_READ) ? "READ" :
3113                 (cc->cdb.direction == CISS_CDB_DIRECTION_WRITE) ? "WRITE" : "??",
3114                 cc->cdb.cdb_length,
3115                 (cc->cdb.type == CISS_CDB_TYPE_COMMAND) ? "command" :
3116                 (cc->cdb.type == CISS_CDB_TYPE_MESSAGE) ? "message" : "??",
3117                 (cc->cdb.attribute == CISS_CDB_ATTRIBUTE_UNTAGGED) ? "untagged" :
3118                 (cc->cdb.attribute == CISS_CDB_ATTRIBUTE_SIMPLE) ? "simple" :
3119                 (cc->cdb.attribute == CISS_CDB_ATTRIBUTE_HEAD_OF_QUEUE) ? "head-of-queue" :
3120                 (cc->cdb.attribute == CISS_CDB_ATTRIBUTE_ORDERED) ? "ordered" :
3121                 (cc->cdb.attribute == CISS_CDB_ATTRIBUTE_AUTO_CONTINGENT) ? "auto-contingent" : "??");
3122     ciss_printf(sc, "  %*D\n", cc->cdb.cdb_length, &cc->cdb.cdb[0], " ");
3123
3124     if (cc->header.host_tag & CISS_HDR_HOST_TAG_ERROR) {
3125         /* XXX print error info */
3126     } else {
3127         /* since we don't use chained s/g, don't support it here */
3128         for (i = 0; i < cc->header.sg_in_list; i++) {
3129             if ((i % 4) == 0)
3130                 ciss_printf(sc, "   ");
3131             printf("0x%08x/%d ", (u_int32_t)cc->sg[i].address, cc->sg[i].length);
3132             if ((((i + 1) % 4) == 0) || (i == (cc->header.sg_in_list - 1)))
3133                 printf("\n");
3134         }
3135     }
3136 }
3137
3138 /************************************************************************
3139  * Print information about the status of a logical drive.
3140  */
3141 static void
3142 ciss_print_ldrive(struct ciss_softc *sc, struct ciss_ldrive *ld)
3143 {
3144     int         bus, target, i;
3145
3146     if (ld->cl_lstatus == NULL) {
3147         printf("does not exist\n");
3148         return;
3149     }
3150
3151     /* print drive status */
3152     switch(ld->cl_lstatus->status) {
3153     case CISS_LSTATUS_OK:
3154         printf("online\n");
3155         break;
3156     case CISS_LSTATUS_INTERIM_RECOVERY:
3157         printf("in interim recovery mode\n");
3158         break;
3159     case CISS_LSTATUS_READY_RECOVERY:
3160         printf("ready to begin recovery\n");
3161         break;
3162     case CISS_LSTATUS_RECOVERING:
3163         bus = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_rebuilding);
3164         target = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_rebuilding);
3165         printf("being recovered, working on physical drive %d.%d, %u blocks remaining\n",
3166                bus, target, ld->cl_lstatus->blocks_to_recover);
3167         break;
3168     case CISS_LSTATUS_EXPANDING:
3169         printf("being expanded, %u blocks remaining\n",
3170                ld->cl_lstatus->blocks_to_recover);
3171         break;
3172     case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
3173         printf("queued for expansion\n");
3174         break;
3175     case CISS_LSTATUS_FAILED:
3176         printf("queued for expansion\n");
3177         break;
3178     case CISS_LSTATUS_WRONG_PDRIVE:
3179         printf("wrong physical drive inserted\n");
3180         break;
3181     case CISS_LSTATUS_MISSING_PDRIVE:
3182         printf("missing a needed physical drive\n");
3183         break;
3184     case CISS_LSTATUS_BECOMING_READY:
3185         printf("becoming ready\n");
3186         break;
3187     }
3188
3189     /* print failed physical drives */
3190     for (i = 0; i < CISS_BIG_MAP_ENTRIES / 8; i++) {
3191         bus = CISS_BIG_MAP_BUS(sc, ld->cl_lstatus->drive_failure_map[i]);
3192         target = CISS_BIG_MAP_TARGET(sc, ld->cl_lstatus->drive_failure_map[i]);
3193         if (bus == -1)
3194             continue;
3195         ciss_printf(sc, "physical drive %d:%d (%x) failed\n", bus, target,
3196                     ld->cl_lstatus->drive_failure_map[i]);
3197     }
3198 }
3199
3200 #ifdef CISS_DEBUG
3201 /************************************************************************
3202  * Print information about the controller/driver.
3203  */
3204 static void
3205 ciss_print_adapter(struct ciss_softc *sc)
3206 {
3207     int         i;
3208
3209     ciss_printf(sc, "ADAPTER:\n");
3210     for (i = 0; i < CISSQ_COUNT; i++) {
3211         ciss_printf(sc, "%s     %d/%d\n",
3212             i == 0 ? "free" :
3213             i == 1 ? "busy" : "complete",
3214             sc->ciss_qstat[i].q_length,
3215             sc->ciss_qstat[i].q_max);
3216     }
3217     ciss_printf(sc, "max_requests %d\n", sc->ciss_max_requests);
3218     ciss_printf(sc, "notify_head/tail %d/%d\n",
3219         sc->ciss_notify_head, sc->ciss_notify_tail);
3220     ciss_printf(sc, "flags %b\n", sc->ciss_flags,
3221         "\20\1notify_ok\2control_open\3aborting\4running\21fake_synch\22bmic_abort\n");
3222
3223     for (i = 0; i < CISS_MAX_LOGICAL; i++) {
3224         ciss_printf(sc, "LOGICAL DRIVE %d:  ", i);
3225         ciss_print_ldrive(sc, sc->ciss_logical + i);
3226     }
3227
3228     for (i = 1; i < sc->ciss_max_requests; i++)
3229         ciss_print_request(sc->ciss_request + i);
3230
3231 }
3232
3233 void    ciss_print0(void);
3234
3235 /* DDB hook */
3236 void
3237 ciss_print0(void)
3238 {
3239     struct ciss_softc   *sc;
3240
3241     sc = devclass_get_softc(devclass_find("ciss"), 0);
3242     if (sc == NULL) {
3243         printf("no ciss controllers\n");
3244     } else {
3245         ciss_print_adapter(sc);
3246     }
3247 }
3248 #endif
3249
3250 /************************************************************************
3251  * Return a name for a logical drive status value.
3252  */
3253 static const char *
3254 ciss_name_ldrive_status(int status)
3255 {
3256     switch (status) {
3257     case CISS_LSTATUS_OK:
3258         return("OK");
3259     case CISS_LSTATUS_FAILED:
3260         return("failed");
3261     case CISS_LSTATUS_NOT_CONFIGURED:
3262         return("not configured");
3263     case CISS_LSTATUS_INTERIM_RECOVERY:
3264         return("interim recovery");
3265     case CISS_LSTATUS_READY_RECOVERY:
3266         return("ready for recovery");
3267     case CISS_LSTATUS_RECOVERING:
3268         return("recovering");
3269     case CISS_LSTATUS_WRONG_PDRIVE:
3270         return("wrong physical drive inserted");
3271     case CISS_LSTATUS_MISSING_PDRIVE:
3272         return("missing physical drive");
3273     case CISS_LSTATUS_EXPANDING:
3274         return("expanding");
3275     case CISS_LSTATUS_BECOMING_READY:
3276         return("becoming ready");
3277     case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
3278         return("queued for expansion");
3279     }
3280     return("unknown status");
3281 }
3282
3283 /************************************************************************
3284  * Return an online/offline/nonexistent value for a logical drive
3285  * status value.
3286  */
3287 static int
3288 ciss_decode_ldrive_status(int status)
3289 {
3290     switch(status) {
3291     case CISS_LSTATUS_NOT_CONFIGURED:
3292         return(CISS_LD_NONEXISTENT);
3293
3294     case CISS_LSTATUS_OK:
3295     case CISS_LSTATUS_INTERIM_RECOVERY:
3296     case CISS_LSTATUS_READY_RECOVERY:
3297     case CISS_LSTATUS_RECOVERING:
3298     case CISS_LSTATUS_EXPANDING:
3299     case CISS_LSTATUS_QUEUED_FOR_EXPANSION:
3300         return(CISS_LD_ONLINE);
3301
3302     case CISS_LSTATUS_FAILED:
3303     case CISS_LSTATUS_WRONG_PDRIVE:
3304     case CISS_LSTATUS_MISSING_PDRIVE:
3305     case CISS_LSTATUS_BECOMING_READY:
3306     default:
3307         return(CISS_LD_OFFLINE);
3308     }
3309 }
3310
3311
3312 /************************************************************************
3313  * Return a name for a logical drive's organisation.
3314  */
3315 static const char *
3316 ciss_name_ldrive_org(int org)
3317 {
3318     switch(org) {
3319     case CISS_LDRIVE_RAID0:
3320         return("RAID 0");
3321     case CISS_LDRIVE_RAID1:
3322         return("RAID 1");
3323     case CISS_LDRIVE_RAID4:
3324         return("RAID 4");
3325     case CISS_LDRIVE_RAID5:
3326         return("RAID 5");
3327     }
3328     return("unkown");
3329 }
3330
3331 /************************************************************************
3332  * Return a name for a command status value.
3333  */
3334 static const char *
3335 ciss_name_command_status(int status)
3336 {
3337     switch(status) {
3338     case CISS_CMD_STATUS_SUCCESS:
3339         return("success");
3340     case CISS_CMD_STATUS_TARGET_STATUS:
3341         return("target status");
3342     case CISS_CMD_STATUS_DATA_UNDERRUN:
3343         return("data underrun");
3344     case CISS_CMD_STATUS_DATA_OVERRUN:
3345         return("data overrun");
3346     case CISS_CMD_STATUS_INVALID_COMMAND:
3347         return("invalid command");
3348     case CISS_CMD_STATUS_PROTOCOL_ERROR:
3349         return("protocol error");
3350     case CISS_CMD_STATUS_HARDWARE_ERROR:
3351         return("hardware error");
3352     case CISS_CMD_STATUS_CONNECTION_LOST:
3353         return("connection lost");
3354     case CISS_CMD_STATUS_ABORTED:
3355         return("aborted");
3356     case CISS_CMD_STATUS_ABORT_FAILED:
3357         return("abort failed");
3358     case CISS_CMD_STATUS_UNSOLICITED_ABORT:
3359         return("unsolicited abort");
3360     case CISS_CMD_STATUS_TIMEOUT:
3361         return("timeout");
3362     case CISS_CMD_STATUS_UNABORTABLE:
3363         return("unabortable");
3364     }
3365     return("unknown status");
3366 }
3367
3368 /************************************************************************
3369  * Handle an open on the control device.
3370  */
3371 static int
3372 ciss_open(dev_t dev, int flags, int fmt, d_thread_t *p)
3373 {
3374     struct ciss_softc   *sc;
3375
3376     debug_called(1);
3377
3378     sc = (struct ciss_softc *)dev->si_drv1;
3379
3380     /* we might want to veto if someone already has us open */
3381
3382     sc->ciss_flags |= CISS_FLAG_CONTROL_OPEN;
3383     return(0);
3384 }
3385
3386 /************************************************************************
3387  * Handle the last close on the control device.
3388  */
3389 static int
3390 ciss_close(dev_t dev, int flags, int fmt, d_thread_t *p)
3391 {
3392     struct ciss_softc   *sc;
3393
3394     debug_called(1);
3395
3396     sc = (struct ciss_softc *)dev->si_drv1;
3397
3398     sc->ciss_flags &= ~CISS_FLAG_CONTROL_OPEN;
3399     return (0);
3400 }
3401
3402 /********************************************************************************
3403  * Handle adapter-specific control operations.
3404  *
3405  * Note that the API here is compatible with the Linux driver, in order to
3406  * simplify the porting of Compaq's userland tools.
3407  */
3408 static int
3409 ciss_ioctl(dev_t dev, u_long cmd, caddr_t addr, int32_t flag, d_thread_t *p)
3410 {
3411     struct ciss_softc           *sc;
3412     int                         error;
3413
3414     debug_called(1);
3415
3416     sc = (struct ciss_softc *)dev->si_drv1;
3417     error = 0;
3418
3419     switch(cmd) {
3420     case CCISS_GETPCIINFO:
3421     {
3422         cciss_pci_info_struct   *pis = (cciss_pci_info_struct *)addr;
3423
3424         pis->bus = pci_get_bus(sc->ciss_dev);
3425         pis->dev_fn = pci_get_slot(sc->ciss_dev);
3426         pis->board_id = pci_get_devid(sc->ciss_dev);
3427
3428         break;
3429     }
3430
3431     case CCISS_GETINTINFO:
3432     {
3433         cciss_coalint_struct    *cis = (cciss_coalint_struct *)addr;
3434
3435         cis->delay = sc->ciss_cfg->interrupt_coalesce_delay;
3436         cis->count = sc->ciss_cfg->interrupt_coalesce_count;
3437
3438         break;
3439     }
3440
3441     case CCISS_SETINTINFO:
3442     {
3443         cciss_coalint_struct    *cis = (cciss_coalint_struct *)addr;
3444
3445         if ((cis->delay == 0) && (cis->count == 0)) {
3446             error = EINVAL;
3447             break;
3448         }
3449
3450         /*
3451          * XXX apparently this is only safe if the controller is idle,
3452          *     we should suspend it before doing this.
3453          */
3454         sc->ciss_cfg->interrupt_coalesce_delay = cis->delay;
3455         sc->ciss_cfg->interrupt_coalesce_count = cis->count;
3456
3457         if (ciss_update_config(sc))
3458             error = EIO;
3459
3460         /* XXX resume the controller here */
3461         break;
3462     }
3463
3464     case CCISS_GETNODENAME:
3465         bcopy(sc->ciss_cfg->server_name, (NodeName_type *)addr,
3466               sizeof(NodeName_type));
3467         break;
3468
3469     case CCISS_SETNODENAME:
3470         bcopy((NodeName_type *)addr, sc->ciss_cfg->server_name,
3471               sizeof(NodeName_type));
3472         if (ciss_update_config(sc))
3473             error = EIO;
3474         break;
3475
3476     case CCISS_GETHEARTBEAT:
3477         *(Heartbeat_type *)addr = sc->ciss_cfg->heartbeat;
3478         break;
3479
3480     case CCISS_GETBUSTYPES:
3481         *(BusTypes_type *)addr = sc->ciss_cfg->bus_types;
3482         break;
3483
3484     case CCISS_GETFIRMVER:
3485         bcopy(sc->ciss_id->running_firmware_revision, (FirmwareVer_type *)addr,
3486               sizeof(FirmwareVer_type));
3487         break;
3488
3489     case CCISS_GETDRIVERVER:
3490         *(DriverVer_type *)addr = CISS_DRIVER_VERSION;
3491         break;
3492
3493     case CCISS_REVALIDVOLS:
3494         /*
3495          * This is a bit ugly; to do it "right" we really need
3496          * to find any disks that have changed, kick CAM off them,
3497          * then rescan only these disks.  It'd be nice if they
3498          * a) told us which disk(s) they were going to play with,
3499          * and b) which ones had arrived. 8(
3500          */
3501         break;
3502
3503     case CCISS_PASSTHRU:
3504         error = ciss_user_command(sc, (IOCTL_Command_struct *)addr);
3505         break;
3506
3507     default:
3508         debug(0, "unknown ioctl 0x%lx", cmd);
3509
3510         debug(1, "CCISS_GETPCIINFO:   0x%lx", CCISS_GETPCIINFO);
3511         debug(1, "CCISS_GETINTINFO:   0x%lx", CCISS_GETINTINFO);
3512         debug(1, "CCISS_SETINTINFO:   0x%lx", CCISS_SETINTINFO);
3513         debug(1, "CCISS_GETNODENAME:  0x%lx", CCISS_GETNODENAME);
3514         debug(1, "CCISS_SETNODENAME:  0x%lx", CCISS_SETNODENAME);
3515         debug(1, "CCISS_GETHEARTBEAT: 0x%lx", CCISS_GETHEARTBEAT);
3516         debug(1, "CCISS_GETBUSTYPES:  0x%lx", CCISS_GETBUSTYPES);
3517         debug(1, "CCISS_GETFIRMVER:   0x%lx", CCISS_GETFIRMVER);
3518         debug(1, "CCISS_GETDRIVERVER: 0x%lx", CCISS_GETDRIVERVER);
3519         debug(1, "CCISS_REVALIDVOLS:  0x%lx", CCISS_REVALIDVOLS);
3520         debug(1, "CCISS_PASSTHRU:     0x%lx", CCISS_PASSTHRU);
3521
3522         error = ENOIOCTL;
3523         break;
3524     }
3525
3526     return(error);
3527 }