sys/dev/mfi/mfi_cam.c

   1 /*-
   2  * Copyright 2007 Scott Long
   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
  27 #include <sys/cdefs.h>
  28 __FBSDID("$FreeBSD$");
  29
  30 #include "opt_mfi.h"
  31
  32 #include <sys/param.h>
  33 #include <sys/systm.h>
  34 #include <sys/kernel.h>
  35 #include <sys/malloc.h>
  36 #include <sys/module.h>
  37 #include <sys/selinfo.h>
  38 #include <sys/bus.h>
  39 #include <sys/conf.h>
  40 #include <sys/eventhandler.h>
  41 #include <sys/rman.h>
  42 #include <sys/bus_dma.h>
  43 #include <sys/bio.h>
  44 #include <sys/ioccom.h>
  45 #include <sys/uio.h>
  46 #include <sys/proc.h>
  47 #include <sys/signalvar.h>
  48 #include <sys/sysctl.h>
  49
  50 #include <cam/cam.h>
  51 #include <cam/cam_ccb.h>
  52 #include <cam/cam_debug.h>
  53 #include <cam/cam_periph.h>
  54 #include <cam/cam_sim.h>
  55 #include <cam/cam_xpt_periph.h>
  56 #include <cam/cam_xpt_sim.h>
  57 #include <cam/scsi/scsi_all.h>
  58 #include <cam/scsi/scsi_message.h>
  59
  60 #include <sys/bus.h>
  61 #include <sys/conf.h>
  62 #include <machine/md_var.h>
  63 #include <machine/bus.h>
  64 #include <machine/resource.h>
  65 #include <sys/rman.h>
  66
  67 #include <dev/mfi/mfireg.h>
  68 #include <dev/mfi/mfi_ioctl.h>
  69 #include <dev/mfi/mfivar.h>
  70
  71 enum mfip_state {
  72         MFIP_STATE_NONE,
  73         MFIP_STATE_DETACH,
  74         MFIP_STATE_RESCAN
  75 };
  76
  77 struct mfip_softc {
  78         device_t        dev;
  79         struct mfi_softc *mfi_sc;
  80         struct cam_devq *devq;
  81         struct cam_sim  *sim;
  82         struct cam_path *path;
  83         enum mfip_state state;
  84 };
  85
  86 static int      mfip_probe(device_t);
  87 static int      mfip_attach(device_t);
  88 static int      mfip_detach(device_t);
  89 static void     mfip_cam_action(struct cam_sim *, union ccb *);
  90 static void     mfip_cam_poll(struct cam_sim *);
  91 static void     mfip_cam_rescan(struct mfi_softc *, uint32_t tid);
  92 static struct mfi_command * mfip_start(void *);
  93 static void     mfip_done(struct mfi_command *cm);
  94
  95 static int mfi_allow_disks = 0;
  96 TUNABLE_INT("hw.mfi.allow_cam_disk_passthrough", &mfi_allow_disks);
  97 SYSCTL_INT(_hw_mfi, OID_AUTO, allow_cam_disk_passthrough, CTLFLAG_RD,
  98     &mfi_allow_disks, 0, "event message locale");
  99
 100 static devclass_t       mfip_devclass;
 101 static device_method_t  mfip_methods[] = {
 102         DEVMETHOD(device_probe,         mfip_probe),
 103         DEVMETHOD(device_attach,        mfip_attach),
 104         DEVMETHOD(device_detach,        mfip_detach),
 105         {0, 0}
 106 };
 107 static driver_t mfip_driver = {
 108         "mfip",
 109         mfip_methods,
 110         sizeof(struct mfip_softc)
 111 };
 112 DRIVER_MODULE(mfip, mfi, mfip_driver, mfip_devclass, 0, 0);
 113 MODULE_DEPEND(mfip, cam, 1, 1, 1);
 114 MODULE_DEPEND(mfip, mfi, 1, 1, 1);
 115
 116 #define ccb_mfip_ptr sim_priv.entries[0].ptr
 117
 118 static int
 119 mfip_probe(device_t dev)
 120 {
 121
 122         device_set_desc(dev, "SCSI Passthrough Bus");
 123         return (0);
 124 }
 125
 126 static int
 127 mfip_attach(device_t dev)
 128 {
 129         struct mfip_softc *sc;
 130         struct mfi_softc *mfisc;
 131
 132         sc = device_get_softc(dev);
 133         if (sc == NULL)
 134                 return (EINVAL);
 135
 136         mfisc = device_get_softc(device_get_parent(dev));
 137         sc->dev = dev;
 138         sc->state = MFIP_STATE_NONE;
 139         sc->mfi_sc = mfisc;
 140         mfisc->mfi_cam_start = mfip_start;
 141
 142         if ((sc->devq = cam_simq_alloc(MFI_SCSI_MAX_CMDS)) == NULL)
 143                 return (ENOMEM);
 144
 145         sc->sim = cam_sim_alloc(mfip_cam_action, mfip_cam_poll, "mfi", sc,
 146                                 device_get_unit(dev), &mfisc->mfi_io_lock, 1,
 147                                 MFI_SCSI_MAX_CMDS, sc->devq);
 148         if (sc->sim == NULL) {
 149                 cam_simq_free(sc->devq);
 150                 sc->devq = NULL;
 151                 device_printf(dev, "CAM SIM attach failed\n");
 152                 return (EINVAL);
 153         }
 154
 155         mfisc->mfi_cam_rescan_cb = mfip_cam_rescan;
 156
 157         mtx_lock(&mfisc->mfi_io_lock);
 158         if (xpt_bus_register(sc->sim, dev, 0) != 0) {
 159                 device_printf(dev, "XPT bus registration failed\n");
 160                 cam_sim_free(sc->sim, FALSE);
 161                 sc->sim = NULL;
 162                 cam_simq_free(sc->devq);
 163                 sc->devq = NULL;
 164                 mtx_unlock(&mfisc->mfi_io_lock);
 165                 return (EINVAL);
 166         }
 167         mtx_unlock(&mfisc->mfi_io_lock);
 168
 169         return (0);
 170 }
 171
 172 static int
 173 mfip_detach(device_t dev)
 174 {
 175         struct mfip_softc *sc;
 176
 177         sc = device_get_softc(dev);
 178         if (sc == NULL)
 179                 return (EINVAL);
 180
 181         mtx_lock(&sc->mfi_sc->mfi_io_lock);
 182         if (sc->state == MFIP_STATE_RESCAN) {
 183                 mtx_unlock(&sc->mfi_sc->mfi_io_lock);
 184                 return (EBUSY);
 185         }
 186         sc->state = MFIP_STATE_DETACH;
 187         mtx_unlock(&sc->mfi_sc->mfi_io_lock);
 188
 189         sc->mfi_sc->mfi_cam_rescan_cb = NULL;
 190
 191         if (sc->sim != NULL) {
 192                 mtx_lock(&sc->mfi_sc->mfi_io_lock);
 193                 xpt_bus_deregister(cam_sim_path(sc->sim));
 194                 cam_sim_free(sc->sim, FALSE);
 195                 sc->sim = NULL;
 196                 mtx_unlock(&sc->mfi_sc->mfi_io_lock);
 197         }
 198
 199         if (sc->devq != NULL) {
 200                 cam_simq_free(sc->devq);
 201                 sc->devq = NULL;
 202         }
 203
 204         return (0);
 205 }
 206
 207 static void
 208 mfip_cam_action(struct cam_sim *sim, union ccb *ccb)
 209 {
 210         struct mfip_softc *sc = cam_sim_softc(sim);
 211         struct mfi_softc *mfisc = sc->mfi_sc;
 212
 213         mtx_assert(&mfisc->mfi_io_lock, MA_OWNED);
 214
 215         switch (ccb->ccb_h.func_code) {
 216         case XPT_PATH_INQ:
 217         {
 218                 struct ccb_pathinq *cpi = &ccb->cpi;
 219
 220                 cpi->version_num = 1;
 221                 cpi->hba_inquiry = PI_SDTR_ABLE|PI_TAG_ABLE|PI_WIDE_16;
 222                 cpi->target_sprt = 0;
 223                 cpi->hba_misc = PIM_NOBUSRESET|PIM_SEQSCAN;
 224                 cpi->hba_eng_cnt = 0;
 225                 cpi->max_target = MFI_SCSI_MAX_TARGETS;
 226                 cpi->max_lun = MFI_SCSI_MAX_LUNS;
 227                 cpi->initiator_id = MFI_SCSI_INITIATOR_ID;
 228                 strncpy(cpi->sim_vid, "FreeBSD", SIM_IDLEN);
 229                 strncpy(cpi->hba_vid, "LSI", HBA_IDLEN);
 230                 strncpy(cpi->dev_name, cam_sim_name(sim), DEV_IDLEN);
 231                 cpi->unit_number = cam_sim_unit(sim);
 232                 cpi->bus_id = cam_sim_bus(sim);
 233                 cpi->base_transfer_speed = 150000;
 234                 cpi->transport = XPORT_SAS;
 235                 cpi->transport_version = 0;
 236                 cpi->protocol = PROTO_SCSI;
 237                 cpi->protocol_version = SCSI_REV_2;
 238                 cpi->ccb_h.status = CAM_REQ_CMP;
 239                 break;
 240         }
 241         case XPT_RESET_BUS:
 242                 ccb->ccb_h.status = CAM_REQ_CMP;
 243                 break;
 244         case XPT_RESET_DEV:
 245                 ccb->ccb_h.status = CAM_REQ_CMP;
 246                 break;
 247         case XPT_GET_TRAN_SETTINGS:
 248         {
 249                 struct ccb_trans_settings_sas *sas =
 250                     &ccb->cts.xport_specific.sas;
 251
 252                 ccb->cts.protocol = PROTO_SCSI;
 253                 ccb->cts.protocol_version = SCSI_REV_2;
 254                 ccb->cts.transport = XPORT_SAS;
 255                 ccb->cts.transport_version = 0;
 256
 257                 sas->valid &= ~CTS_SAS_VALID_SPEED;
 258                 sas->bitrate = 150000;
 259
 260                 ccb->ccb_h.status = CAM_REQ_CMP;
 261                 break;
 262         }
 263         case XPT_SET_TRAN_SETTINGS:
 264                 ccb->ccb_h.status = CAM_FUNC_NOTAVAIL;
 265                 break;
 266         case XPT_SCSI_IO:
 267         {
 268                 struct ccb_hdr          *ccbh = &ccb->ccb_h;
 269                 struct ccb_scsiio       *csio = &ccb->csio;
 270
 271                 ccbh->status = CAM_REQ_INPROG;
 272                 if (csio->cdb_len > MFI_SCSI_MAX_CDB_LEN) {
 273                         ccbh->status = CAM_REQ_INVALID;
 274                         break;
 275                 }
 276                 if ((ccbh->flags & CAM_DIR_MASK) != CAM_DIR_NONE) {
 277                         if (ccbh->flags & CAM_DATA_PHYS) {
 278                                 ccbh->status = CAM_REQ_INVALID;
 279                                 break;
 280                         }
 281                         if (ccbh->flags & CAM_SCATTER_VALID) {
 282                                 ccbh->status = CAM_REQ_INVALID;
 283                                 break;
 284                         }
 285                 }
 286
 287                 ccbh->ccb_mfip_ptr = sc;
 288                 TAILQ_INSERT_TAIL(&mfisc->mfi_cam_ccbq, ccbh, sim_links.tqe);
 289                 mfi_startio(mfisc);
 290                 return;
 291         }
 292         default:
 293                 ccb->ccb_h.status = CAM_REQ_INVALID;
 294                 break;
 295         }
 296
 297         xpt_done(ccb);
 298         return;
 299 }
 300
 301 static void
 302 mfip_cam_rescan(struct mfi_softc *sc, uint32_t tid)
 303 {
 304         union ccb *ccb;
 305         struct mfip_softc *camsc;
 306         struct cam_sim *sim;
 307         device_t mfip_dev;
 308
 309         mtx_lock(&Giant);
 310         mfip_dev = device_find_child(sc->mfi_dev, "mfip", -1);
 311         mtx_unlock(&Giant);
 312         if (mfip_dev == NULL) {
 313                 device_printf(sc->mfi_dev, "Couldn't find mfip child device!\n");
 314                 return;
 315         }
 316
 317         mtx_lock(&sc->mfi_io_lock);
 318         camsc = device_get_softc(mfip_dev);
 319         if (camsc->state == MFIP_STATE_DETACH) {
 320                 mtx_unlock(&sc->mfi_io_lock);
 321                 return;
 322         }
 323         camsc->state = MFIP_STATE_RESCAN;
 324
 325         ccb = xpt_alloc_ccb_nowait();
 326         if (ccb == NULL) {
 327                 mtx_unlock(&sc->mfi_io_lock);
 328                 device_printf(sc->mfi_dev,
 329                     "Cannot allocate ccb for bus rescan.\n");
 330                 return;
 331         }
 332
 333         sim = camsc->sim;
 334         if (xpt_create_path(&ccb->ccb_h.path, xpt_periph, cam_sim_path(sim),
 335             tid, CAM_LUN_WILDCARD) != CAM_REQ_CMP) {
 336                 xpt_free_ccb(ccb);
 337                 mtx_unlock(&sc->mfi_io_lock);
 338                 device_printf(sc->mfi_dev,
 339                     "Cannot create path for bus rescan.\n");
 340                 return;
 341         }
 342         xpt_rescan(ccb);
 343
 344         camsc->state = MFIP_STATE_NONE;
 345         mtx_unlock(&sc->mfi_io_lock);
 346 }
 347
 348 static struct mfi_command *
 349 mfip_start(void *data)
 350 {
 351         union ccb *ccb = data;
 352         struct ccb_hdr *ccbh = &ccb->ccb_h;
 353         struct ccb_scsiio *csio = &ccb->csio;
 354         struct mfip_softc *sc;
 355         struct mfi_pass_frame *pt;
 356         struct mfi_command *cm;
 357         uint32_t context = 0;
 358
 359         sc = ccbh->ccb_mfip_ptr;
 360
 361         if ((cm = mfi_dequeue_free(sc->mfi_sc)) == NULL)
 362                 return (NULL);
 363
 364         /* Zero out the MFI frame */
 365         context = cm->cm_frame->header.context;
 366         bzero(cm->cm_frame, sizeof(union mfi_frame));
 367         cm->cm_frame->header.context = context;
 368
 369         pt = &cm->cm_frame->pass;
 370         pt->header.cmd = MFI_CMD_PD_SCSI_IO;
 371         pt->header.cmd_status = 0;
 372         pt->header.scsi_status = 0;
 373         pt->header.target_id = ccbh->target_id;
 374         pt->header.lun_id = ccbh->target_lun;
 375         pt->header.flags = 0;
 376         pt->header.timeout = 0;
 377         pt->header.data_len = csio->dxfer_len;
 378         pt->header.sense_len = MFI_SENSE_LEN;
 379         pt->header.cdb_len = csio->cdb_len;
 380         pt->sense_addr_lo = (uint32_t)cm->cm_sense_busaddr;
 381         pt->sense_addr_hi = (uint32_t)((uint64_t)cm->cm_sense_busaddr >> 32);
 382         if (ccbh->flags & CAM_CDB_POINTER)
 383                 bcopy(csio->cdb_io.cdb_ptr, &pt->cdb[0], csio->cdb_len);
 384         else
 385                 bcopy(csio->cdb_io.cdb_bytes, &pt->cdb[0], csio->cdb_len);
 386         cm->cm_complete = mfip_done;
 387         cm->cm_private = ccb;
 388         cm->cm_sg = &pt->sgl;
 389         cm->cm_total_frame_size = MFI_PASS_FRAME_SIZE;
 390         cm->cm_data = csio->data_ptr;
 391         cm->cm_len = csio->dxfer_len;
 392         switch (ccbh->flags & CAM_DIR_MASK) {
 393         case CAM_DIR_IN:
 394                 cm->cm_flags = MFI_CMD_DATAIN;
 395                 break;
 396         case CAM_DIR_OUT:
 397                 cm->cm_flags = MFI_CMD_DATAOUT;
 398                 break;
 399         case CAM_DIR_NONE:
 400         default:
 401                 cm->cm_data = NULL;
 402                 cm->cm_len = 0;
 403                 cm->cm_flags = 0;
 404                 break;
 405         }
 406
 407         TAILQ_REMOVE(&sc->mfi_sc->mfi_cam_ccbq, ccbh, sim_links.tqe);
 408         return (cm);
 409 }
 410
 411 static void
 412 mfip_done(struct mfi_command *cm)
 413 {
 414         union ccb *ccb = cm->cm_private;
 415         struct ccb_hdr *ccbh = &ccb->ccb_h;
 416         struct ccb_scsiio *csio = &ccb->csio;
 417         struct mfip_softc *sc;
 418         struct mfi_pass_frame *pt;
 419
 420         sc = ccbh->ccb_mfip_ptr;
 421         pt = &cm->cm_frame->pass;
 422
 423         switch (pt->header.cmd_status) {
 424         case MFI_STAT_OK:
 425         {
 426                 uint8_t command, device;
 427
 428                 ccbh->status = CAM_REQ_CMP;
 429                 csio->scsi_status = pt->header.scsi_status;
 430                 if (ccbh->flags & CAM_CDB_POINTER)
 431                         command = csio->cdb_io.cdb_ptr[0];
 432                 else
 433                         command = csio->cdb_io.cdb_bytes[0];
 434                 if (command == INQUIRY) {
 435                         device = csio->data_ptr[0] & 0x1f;
 436                         if ((!mfi_allow_disks && device == T_DIRECT) ||
 437                             (device == T_PROCESSOR))
 438                                 csio->data_ptr[0] =
 439                                      (csio->data_ptr[0] & 0xe0) | T_NODEVICE;
 440                 }
 441                 break;
 442         }
 443         case MFI_STAT_SCSI_DONE_WITH_ERROR:
 444         {
 445                 int sense_len;
 446
 447                 ccbh->status = CAM_SCSI_STATUS_ERROR | CAM_AUTOSNS_VALID;
 448                 csio->scsi_status = pt->header.scsi_status;
 449                 if (pt->header.sense_len < csio->sense_len)
 450                         csio->sense_resid = csio->sense_len -
 451                             pt->header.sense_len;
 452                 else
 453                         csio->sense_resid = 0;
 454                 sense_len = min(pt->header.sense_len,
 455                     sizeof(struct scsi_sense_data));
 456                 bzero(&csio->sense_data, sizeof(struct scsi_sense_data));
 457                 bcopy(&cm->cm_sense->data[0], &csio->sense_data, sense_len);
 458                 break;
 459         }
 460         case MFI_STAT_DEVICE_NOT_FOUND:
 461                 ccbh->status = CAM_SEL_TIMEOUT;
 462                 break;
 463         case MFI_STAT_SCSI_IO_FAILED:
 464                 ccbh->status = CAM_REQ_CMP_ERR;
 465                 csio->scsi_status = pt->header.scsi_status;
 466                 break;
 467         default:
 468                 ccbh->status = CAM_REQ_CMP_ERR;
 469                 csio->scsi_status = pt->header.scsi_status;
 470                 break;
 471         }
 472
 473         mfi_release_command(cm);
 474         xpt_done(ccb);
 475 }
 476
 477 static void
 478 mfip_cam_poll(struct cam_sim *sim)
 479 {
 480         struct mfip_softc *sc = cam_sim_softc(sim);
 481         struct mfi_softc *mfisc = sc->mfi_sc;
 482
 483         mfisc->mfi_intr_ptr(mfisc);
 484 }
 485