sys/bus/cam/scsi/scsi_pass.c

   1 /*
   2  * Copyright (c) 1997, 1998, 2000 Justin T. Gibbs.
   3  * Copyright (c) 1997, 1998, 1999 Kenneth D. Merry.
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions, and the following disclaimer,
  11  *    without modification, immediately at the beginning of the file.
  12  * 2. The name of the author may not be used to endorse or promote products
  13  *    derived from this software without specific prior written permission.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE FOR
  19  * ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD: src/sys/cam/scsi/scsi_pass.c,v 1.19 2000/01/17 06:27:37 mjacob Exp $
  28  * $DragonFly: src/sys/bus/cam/scsi/scsi_pass.c,v 1.27 2008/05/18 20:30:20 pavalos Exp $
  29  */
  30
  31 #include <sys/param.h>
  32 #include <sys/systm.h>
  33 #include <sys/kernel.h>
  34 #include <sys/types.h>
  35 #include <sys/buf.h>
  36 #include <sys/malloc.h>
  37 #include <sys/fcntl.h>
  38 #include <sys/stat.h>
  39 #include <sys/conf.h>
  40 #include <sys/errno.h>
  41 #include <sys/devicestat.h>
  42 #include <sys/buf2.h>
  43 #include <sys/thread2.h>
  44
  45 #include "../cam.h"
  46 #include "../cam_ccb.h"
  47 #include "../cam_extend.h"
  48 #include "../cam_periph.h"
  49 #include "../cam_queue.h"
  50 #include "../cam_xpt_periph.h"
  51 #include "../cam_debug.h"
  52 #include "../cam_sim.h"
  53
  54 #include "scsi_all.h"
  55 #include "scsi_message.h"
  56 #include "scsi_da.h"
  57 #include "scsi_pass.h"
  58
  59 typedef enum {
  60         PASS_FLAG_OPEN                  = 0x01,
  61         PASS_FLAG_LOCKED                = 0x02,
  62         PASS_FLAG_INVALID               = 0x04
  63 } pass_flags;
  64
  65 typedef enum {
  66         PASS_STATE_NORMAL
  67 } pass_state;
  68
  69 typedef enum {
  70         PASS_CCB_BUFFER_IO,
  71         PASS_CCB_WAITING
  72 } pass_ccb_types;
  73
  74 #define ccb_type        ppriv_field0
  75 #define ccb_bio         ppriv_ptr1
  76
  77 struct pass_softc {
  78         pass_state      state;
  79         pass_flags      flags;
  80         u_int8_t        pd_type;
  81         union ccb       saved_ccb;
  82         struct devstat  device_stats;
  83 };
  84
  85 #define PASS_CDEV_MAJOR 31
  86
  87 static  d_open_t        passopen;
  88 static  d_close_t       passclose;
  89 static  d_ioctl_t       passioctl;
  90
  91 static  periph_init_t   passinit;
  92 static  periph_ctor_t   passregister;
  93 static  periph_oninv_t  passoninvalidate;
  94 static  periph_dtor_t   passcleanup;
  95 static  periph_start_t  passstart;
  96 static  void            passasync(void *callback_arg, u_int32_t code,
  97                                   struct cam_path *path, void *arg);
  98 static  void            passdone(struct cam_periph *periph,
  99                                  union ccb *done_ccb);
 100 static  int             passerror(union ccb *ccb, u_int32_t cam_flags,
 101                                   u_int32_t sense_flags);
 102 static  int             passsendccb(struct cam_periph *periph, union ccb *ccb,
 103                                     union ccb *inccb);
 104
 105 static struct periph_driver passdriver =
 106 {
 107         passinit, "pass",
 108         TAILQ_HEAD_INITIALIZER(passdriver.units), /* generation */ 0
 109 };
 110
 111 PERIPHDRIVER_DECLARE(pass, passdriver);
 112
 113 static struct dev_ops pass_ops = {
 114         { "pass", PASS_CDEV_MAJOR, 0 },
 115         .d_open =       passopen,
 116         .d_close =      passclose,
 117         .d_read =       noread,
 118         .d_write =      nowrite,
 119         .d_ioctl =      passioctl,
 120         .d_strategy =   nostrategy,
 121 };
 122
 123 static struct extend_array *passperiphs;
 124
 125 static void
 126 passinit(void)
 127 {
 128         cam_status status;
 129
 130         /*
 131          * Create our extend array for storing the devices we attach to.
 132          */
 133         passperiphs = cam_extend_new();
 134         if (passperiphs == NULL) {
 135                 kprintf("passm: Failed to alloc extend array!\n");
 136                 return;
 137         }
 138
 139         /*
 140          * Install a global async callback.  This callback will
 141          * receive async callbacks like "new device found".
 142          */
 143         status = xpt_register_async(AC_FOUND_DEVICE, passasync, NULL, NULL);
 144
 145         if (status != CAM_REQ_CMP) {
 146                 kprintf("pass: Failed to attach master async callback "
 147                        "due to status 0x%x!\n", status);
 148         }
 149
 150 }
 151
 152 static void
 153 passoninvalidate(struct cam_periph *periph)
 154 {
 155         struct pass_softc *softc;
 156
 157         softc = (struct pass_softc *)periph->softc;
 158
 159         /*
 160          * De-register any async callbacks.
 161          */
 162         xpt_register_async(0, passasync, periph, periph->path);
 163
 164         softc->flags |= PASS_FLAG_INVALID;
 165
 166         if (bootverbose) {
 167                 xpt_print(periph->path, "lost device\n");
 168         }
 169
 170 }
 171
 172 static void
 173 passcleanup(struct cam_periph *periph)
 174 {
 175         struct pass_softc *softc;
 176
 177         softc = (struct pass_softc *)periph->softc;
 178
 179         devstat_remove_entry(&softc->device_stats);
 180
 181         cam_extend_release(passperiphs, periph->unit_number);
 182
 183         if (bootverbose) {
 184                 xpt_print(periph->path, "removing device entry\n");
 185         }
 186         dev_ops_remove(&pass_ops, -1, periph->unit_number);
 187         kfree(softc, M_DEVBUF);
 188 }
 189
 190 static void
 191 passasync(void *callback_arg, u_int32_t code,
 192           struct cam_path *path, void *arg)
 193 {
 194         struct cam_periph *periph;
 195         struct cam_sim *sim;
 196
 197         periph = (struct cam_periph *)callback_arg;
 198
 199         switch (code) {
 200         case AC_FOUND_DEVICE:
 201         {
 202                 struct ccb_getdev *cgd;
 203                 cam_status status;
 204
 205                 cgd = (struct ccb_getdev *)arg;
 206                 if (cgd == NULL)
 207                         break;
 208
 209                 /*
 210                  * Don't complain if a valid peripheral is already attached.
 211                  */
 212                 periph = cam_periph_find(cgd->ccb_h.path, "pass");
 213                 if (periph && (periph->flags & CAM_PERIPH_INVALID) == 0)
 214                         break;
 215
 216                 /*
 217                  * Allocate a peripheral instance for
 218                  * this device and start the probe
 219                  * process.
 220                  */
 221                 sim = xpt_path_sim(cgd->ccb_h.path);
 222                 status = cam_periph_alloc(passregister, passoninvalidate,
 223                                           passcleanup, passstart, "pass",
 224                                           CAM_PERIPH_BIO, cgd->ccb_h.path,
 225                                           passasync, AC_FOUND_DEVICE, cgd);
 226
 227                 if (status != CAM_REQ_CMP && status != CAM_REQ_INPROG) {
 228                         const struct cam_status_entry *entry;
 229
 230                         entry = cam_fetch_status_entry(status);
 231
 232                         kprintf("passasync: Unable to attach new device "
 233                                 "due to status %#x: %s\n", status, entry ?
 234                                 entry->status_text : "Unknown");
 235                 }
 236
 237                 break;
 238         }
 239         default:
 240                 cam_periph_async(periph, code, path, arg);
 241                 break;
 242         }
 243 }
 244
 245 static cam_status
 246 passregister(struct cam_periph *periph, void *arg)
 247 {
 248         struct pass_softc *softc;
 249         struct ccb_getdev *cgd;
 250         int    no_tags;
 251
 252         cgd = (struct ccb_getdev *)arg;
 253         if (periph == NULL) {
 254                 kprintf("passregister: periph was NULL!!\n");
 255                 return(CAM_REQ_CMP_ERR);
 256         }
 257
 258         if (cgd == NULL) {
 259                 kprintf("passregister: no getdev CCB, can't register device\n");
 260                 return(CAM_REQ_CMP_ERR);
 261         }
 262
 263         softc = kmalloc(sizeof(*softc), M_DEVBUF, M_INTWAIT | M_ZERO);
 264         softc->state = PASS_STATE_NORMAL;
 265         softc->pd_type = SID_TYPE(&cgd->inq_data);
 266
 267         periph->softc = softc;
 268         cam_extend_set(passperiphs, periph->unit_number, periph);
 269
 270         /*
 271          * We pass in 0 for a blocksize, since we don't
 272          * know what the blocksize of this device is, if
 273          * it even has a blocksize.
 274          */
 275         CAM_SIM_UNLOCK(periph->sim);
 276         no_tags = (cgd->inq_data.flags & SID_CmdQue) == 0;
 277         devstat_add_entry(&softc->device_stats, "pass", periph->unit_number, 0,
 278                           DEVSTAT_NO_BLOCKSIZE
 279                           | (no_tags ? DEVSTAT_NO_ORDERED_TAGS : 0),
 280                           softc->pd_type |
 281                           DEVSTAT_TYPE_IF_SCSI |
 282                           DEVSTAT_TYPE_PASS,
 283                           DEVSTAT_PRIORITY_PASS);
 284
 285         /* Register the device */
 286         dev_ops_add(&pass_ops, -1, periph->unit_number);
 287         make_dev(&pass_ops, periph->unit_number, UID_ROOT,
 288                   GID_OPERATOR, 0600, "%s%d", periph->periph_name,
 289                   periph->unit_number);
 290         CAM_SIM_LOCK(periph->sim);
 291         /*
 292          * Add an async callback so that we get
 293          * notified if this device goes away.
 294          */
 295         xpt_register_async(AC_LOST_DEVICE, passasync, periph, periph->path);
 296
 297         if (bootverbose)
 298                 xpt_announce_periph(periph, NULL);
 299
 300         return(CAM_REQ_CMP);
 301 }
 302
 303 static int
 304 passopen(struct dev_open_args *ap)
 305 {
 306         cdev_t dev = ap->a_head.a_dev;
 307         struct cam_periph *periph;
 308         struct pass_softc *softc;
 309         int unit, error;
 310
 311         error = 0; /* default to no error */
 312
 313         /* unit = dkunit(dev); */
 314         /* XXX KDM fix this */
 315         unit = minor(dev) & 0xff;
 316
 317         periph = cam_extend_get(passperiphs, unit);
 318
 319         if (cam_periph_acquire(periph) != CAM_REQ_CMP)
 320                 return (ENXIO);
 321
 322         cam_periph_lock(periph);
 323
 324         softc = (struct pass_softc *)periph->softc;
 325
 326         if (softc->flags & PASS_FLAG_INVALID) {
 327                 cam_periph_unlock(periph);
 328                 cam_periph_release(periph);
 329                 return(ENXIO);
 330         }
 331
 332         /*
 333          * Don't allow access when we're running at a high securelevel.
 334          */
 335         if (securelevel > 1) {
 336                 cam_periph_unlock(periph);
 337                 cam_periph_release(periph);
 338                 return(EPERM);
 339         }
 340
 341         /*
 342          * Only allow read-write access.
 343          */
 344         if (((ap->a_oflags & FWRITE) == 0) || ((ap->a_oflags & FREAD) == 0)) {
 345                 cam_periph_unlock(periph);
 346                 cam_periph_release(periph);
 347                 return(EPERM);
 348         }
 349
 350         /*
 351          * We don't allow nonblocking access.
 352          */
 353         if ((ap->a_oflags & O_NONBLOCK) != 0) {
 354                 xpt_print(periph->path, "can't do nonblocking access\n");
 355                 cam_periph_unlock(periph);
 356                 cam_periph_release(periph);
 357                 return(EINVAL);
 358         }
 359
 360         if ((softc->flags & PASS_FLAG_OPEN) == 0) {
 361                 softc->flags |= PASS_FLAG_OPEN;
 362         } else {
 363                 /* Device closes aren't symmertical, so fix up the refcount */
 364                 cam_periph_release(periph);
 365         }
 366
 367         cam_periph_unlock(periph);
 368
 369         return (error);
 370 }
 371
 372 static int
 373 passclose(struct dev_close_args *ap)
 374 {
 375         cdev_t dev = ap->a_head.a_dev;
 376         struct  cam_periph *periph;
 377         struct  pass_softc *softc;
 378         int     unit;
 379
 380         /* unit = dkunit(dev); */
 381         /* XXX KDM fix this */
 382         unit = minor(dev) & 0xff;
 383
 384         periph = cam_extend_get(passperiphs, unit);
 385         if (periph == NULL)
 386                 return (ENXIO);
 387
 388         cam_periph_lock(periph);
 389
 390         softc = (struct pass_softc *)periph->softc;
 391         softc->flags &= ~PASS_FLAG_OPEN;
 392
 393         cam_periph_unlock(periph);
 394         cam_periph_release(periph);
 395
 396         return (0);
 397 }
 398
 399 static void
 400 passstart(struct cam_periph *periph, union ccb *start_ccb)
 401 {
 402         struct pass_softc *softc;
 403
 404         softc = (struct pass_softc *)periph->softc;
 405
 406         switch (softc->state) {
 407         case PASS_STATE_NORMAL:
 408                 start_ccb->ccb_h.ccb_type = PASS_CCB_WAITING;
 409                 SLIST_INSERT_HEAD(&periph->ccb_list, &start_ccb->ccb_h,
 410                                   periph_links.sle);
 411                 periph->immediate_priority = CAM_PRIORITY_NONE;
 412                 wakeup(&periph->ccb_list);
 413                 break;
 414         }
 415 }
 416
 417 static void
 418 passdone(struct cam_periph *periph, union ccb *done_ccb)
 419 {
 420         struct pass_softc *softc;
 421         struct ccb_scsiio *csio;
 422
 423         softc = (struct pass_softc *)periph->softc;
 424         csio = &done_ccb->csio;
 425         switch (csio->ccb_h.ccb_type) {
 426         case PASS_CCB_WAITING:
 427                 /* Caller will release the CCB */
 428                 wakeup(&done_ccb->ccb_h.cbfcnp);
 429                 return;
 430         }
 431         xpt_release_ccb(done_ccb);
 432 }
 433
 434 static int
 435 passioctl(struct dev_ioctl_args *ap)
 436 {
 437         cdev_t dev = ap->a_head.a_dev;
 438         caddr_t addr = ap->a_data;
 439         struct  cam_periph *periph;
 440         struct  pass_softc *softc;
 441         u_int8_t unit;
 442         int      error;
 443
 444
 445         /* unit = dkunit(dev); */
 446         /* XXX KDM fix this */
 447         unit = minor(dev) & 0xff;
 448
 449         periph = cam_extend_get(passperiphs, unit);
 450
 451         if (periph == NULL)
 452                 return(ENXIO);
 453
 454         cam_periph_lock(periph);
 455         softc = (struct pass_softc *)periph->softc;
 456
 457         error = 0;
 458
 459         switch (ap->a_cmd) {
 460
 461         case CAMIOCOMMAND:
 462         {
 463                 union ccb *inccb;
 464                 union ccb *ccb;
 465                 int ccb_malloced;
 466
 467                 inccb = (union ccb *)addr;
 468
 469                 /*
 470                  * Some CCB types, like scan bus and scan lun can only go
 471                  * through the transport layer device.
 472                  */
 473                 if (inccb->ccb_h.func_code & XPT_FC_XPT_ONLY) {
 474                         xpt_print(periph->path, "CCB function code %#x is "
 475                             "restricted to the XPT device\n",
 476                             inccb->ccb_h.func_code);
 477                         error = ENODEV;
 478                         break;
 479                 }
 480
 481                 /*
 482                  * Non-immediate CCBs need a CCB from the per-device pool
 483                  * of CCBs, which is scheduled by the transport layer.
 484                  * Immediate CCBs and user-supplied CCBs should just be
 485                  * malloced.
 486                  */
 487                 if ((inccb->ccb_h.func_code & XPT_FC_QUEUED)
 488                  && ((inccb->ccb_h.func_code & XPT_FC_USER_CCB) == 0)) {
 489                         ccb = cam_periph_getccb(periph,
 490                                                 inccb->ccb_h.pinfo.priority);
 491                         ccb_malloced = 0;
 492                 } else {
 493                         ccb = xpt_alloc_ccb();
 494
 495                         if (ccb != NULL)
 496                                 xpt_setup_ccb(&ccb->ccb_h, periph->path,
 497                                               inccb->ccb_h.pinfo.priority);
 498                         ccb_malloced = 1;
 499                 }
 500
 501                 if (ccb == NULL) {
 502                         xpt_print(periph->path, "unable to allocate CCB\n");
 503                         error = ENOMEM;
 504                         break;
 505                 }
 506
 507                 error = passsendccb(periph, ccb, inccb);
 508
 509                 if (ccb_malloced)
 510                         xpt_free_ccb(ccb);
 511                 else
 512                         xpt_release_ccb(ccb);
 513
 514                 break;
 515         }
 516         default:
 517                 error = cam_periph_ioctl(periph, ap->a_cmd, addr, passerror);
 518                 break;
 519         }
 520
 521         cam_periph_unlock(periph);
 522         return(error);
 523 }
 524
 525 /*
 526  * Generally, "ccb" should be the CCB supplied by the kernel.  "inccb"
 527  * should be the CCB that is copied in from the user.
 528  */
 529 static int
 530 passsendccb(struct cam_periph *periph, union ccb *ccb, union ccb *inccb)
 531 {
 532         struct pass_softc *softc;
 533         struct cam_periph_map_info mapinfo;
 534         int error, need_unmap;
 535
 536         softc = (struct pass_softc *)periph->softc;
 537
 538         need_unmap = 0;
 539
 540         /*
 541          * There are some fields in the CCB header that need to be
 542          * preserved, the rest we get from the user.
 543          */
 544         xpt_merge_ccb(ccb, inccb);
 545
 546         /*
 547          * There's no way for the user to have a completion
 548          * function, so we put our own completion function in here.
 549          */
 550         ccb->ccb_h.cbfcnp = passdone;
 551
 552         /*
 553          * We only attempt to map the user memory into kernel space
 554          * if they haven't passed in a physical memory pointer,
 555          * and if there is actually an I/O operation to perform.
 556          * Right now cam_periph_mapmem() only supports SCSI and device
 557          * match CCBs.  For the SCSI CCBs, we only pass the CCB in if
 558          * there's actually data to map.  cam_periph_mapmem() will do the
 559          * right thing, even if there isn't data to map, but since CCBs
 560          * without data are a reasonably common occurance (e.g. test unit
 561          * ready), it will save a few cycles if we check for it here.
 562          */
 563         if (((ccb->ccb_h.flags & CAM_DATA_PHYS) == 0)
 564          && (((ccb->ccb_h.func_code == XPT_SCSI_IO)
 565             && ((ccb->ccb_h.flags & CAM_DIR_MASK) != CAM_DIR_NONE))
 566           || (ccb->ccb_h.func_code == XPT_DEV_MATCH))) {
 567
 568                 bzero(&mapinfo, sizeof(mapinfo));
 569
 570                 /*
 571                  * cam_periph_mapmem calls into proc and vm functions that can
 572                  * sleep as well as trigger I/O, so we can't hold the lock.
 573                  * Dropping it here is reasonably safe.
 574                  */
 575                 cam_periph_unlock(periph);
 576                 error = cam_periph_mapmem(ccb, &mapinfo);
 577                 cam_periph_lock(periph);
 578
 579                 /*
 580                  * cam_periph_mapmem returned an error, we can't continue.
 581                  * Return the error to the user.
 582                  */
 583                 if (error)
 584                         return(error);
 585
 586                 /*
 587                  * We successfully mapped the memory in, so we need to
 588                  * unmap it when the transaction is done.
 589                  */
 590                 need_unmap = 1;
 591         }
 592
 593         /*
 594          * If the user wants us to perform any error recovery, then honor
 595          * that request.  Otherwise, it's up to the user to perform any
 596          * error recovery.
 597          */
 598         error = cam_periph_runccb(ccb,
 599                                   (ccb->ccb_h.flags & CAM_PASS_ERR_RECOVER) ?
 600                                   passerror : NULL,
 601                                   /* cam_flags */ CAM_RETRY_SELTO,
 602                                   /* sense_flags */SF_RETRY_UA,
 603                                   &softc->device_stats);
 604
 605         if (need_unmap != 0)
 606                 cam_periph_unmapmem(ccb, &mapinfo);
 607
 608         ccb->ccb_h.cbfcnp = NULL;
 609         ccb->ccb_h.periph_priv = inccb->ccb_h.periph_priv;
 610         bcopy(ccb, inccb, sizeof(union ccb));
 611
 612         return(error);
 613 }
 614
 615 static int
 616 passerror(union ccb *ccb, u_int32_t cam_flags, u_int32_t sense_flags)
 617 {
 618         struct cam_periph *periph;
 619         struct pass_softc *softc;
 620
 621         periph = xpt_path_periph(ccb->ccb_h.path);
 622         softc = (struct pass_softc *)periph->softc;
 623
 624         return(cam_periph_error(ccb, cam_flags, sense_flags,
 625                                  &softc->saved_ccb));
 626 }