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