scsipi_ioctl.c

Version: - FREEBSD - FREEBSD-13-STABLE - FREEBSD-13-0 - FREEBSD-12-STABLE - FREEBSD-12-0 - FREEBSD-11-STABLE - FREEBSD-11-0 - FREEBSD-10-STABLE - FREEBSD-10-0 - FREEBSD-9-STABLE - FREEBSD-9-0 - FREEBSD-8-STABLE - FREEBSD-8-0 - FREEBSD-7-STABLE - FREEBSD-7-0 - FREEBSD-6-STABLE - FREEBSD-6-0 - FREEBSD-5-STABLE - FREEBSD-5-0 - FREEBSD-4-STABLE - FREEBSD-3-STABLE - FREEBSD22 - l41 - OPENBSD - linux-2.6 - MK84 - PLAN9 - xnu-8792
SearchContext: - none - 3 - 10
    1 /*      $NetBSD: scsipi_ioctl.c,v 1.52.4.1 2005/11/03 10:31:08 tron Exp $       */
    2 
    3 /*-
    4  * Copyright (c) 1998, 2004 The NetBSD Foundation, Inc.
    5  * All rights reserved.
    6  *
    7  * This code is derived from software contributed to The NetBSD Foundation
    8  * by Charles M. Hannum.
    9  *
   10  * Redistribution and use in source and binary forms, with or without
   11  * modification, are permitted provided that the following conditions
   12  * are met:
   13  * 1. Redistributions of source code must retain the above copyright
   14  *    notice, this list of conditions and the following disclaimer.
   15  * 2. Redistributions in binary form must reproduce the above copyright
   16  *    notice, this list of conditions and the following disclaimer in the
   17  *    documentation and/or other materials provided with the distribution.
   18  * 3. All advertising materials mentioning features or use of this software
   19  *    must display the following acknowledgement:
   20  *        This product includes software developed by the NetBSD
   21  *        Foundation, Inc. and its contributors.
   22  * 4. Neither the name of The NetBSD Foundation nor the names of its
   23  *    contributors may be used to endorse or promote products derived
   24  *    from this software without specific prior written permission.
   25  *
   26  * THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
   27  * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
   28  * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
   29  * PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
   30  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
   31  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
   32  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
   33  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
   34  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
   35  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
   36  * POSSIBILITY OF SUCH DAMAGE.
   37  */
   38 
   39 /*
   40  * Contributed by HD Associates (hd@world.std.com).
   41  * Copyright (c) 1992, 1993 HD Associates
   42  *
   43  * Berkeley style copyright.
   44  */
   45 
   46 #include <sys/cdefs.h>
   47 __KERNEL_RCSID(0, "$NetBSD: scsipi_ioctl.c,v 1.52.4.1 2005/11/03 10:31:08 tron Exp $");
   48 
   49 #include "opt_compat_freebsd.h"
   50 #include "opt_compat_netbsd.h"
   51 
   52 #include <sys/param.h>
   53 #include <sys/errno.h>
   54 #include <sys/systm.h>
   55 #include <sys/malloc.h>
   56 #include <sys/buf.h>
   57 #include <sys/proc.h>
   58 #include <sys/device.h>
   59 #include <sys/fcntl.h>
   60 
   61 #include <dev/scsipi/scsipi_all.h>
   62 #include <dev/scsipi/scsipiconf.h>
   63 #include <dev/scsipi/scsipi_base.h>
   64 #include <dev/scsipi/scsiconf.h>
   65 #include <sys/scsiio.h>
   66 
   67 #include "scsibus.h"
   68 #include "atapibus.h"
   69 
   70 struct scsi_ioctl {
   71         LIST_ENTRY(scsi_ioctl) si_list;
   72         struct buf si_bp;
   73         struct uio si_uio;
   74         struct iovec si_iov;
   75         scsireq_t si_screq;
   76         struct scsipi_periph *si_periph;
   77 };
   78 
   79 static LIST_HEAD(, scsi_ioctl) si_head;
   80 
   81 static struct scsi_ioctl *
   82 si_get(void)
   83 {
   84         struct scsi_ioctl *si;
   85         int s;
   86 
   87         si = malloc(sizeof(struct scsi_ioctl), M_TEMP, M_WAITOK|M_ZERO);
   88         simple_lock_init(&si->si_bp.b_interlock);
   89         s = splbio();
   90         LIST_INSERT_HEAD(&si_head, si, si_list);
   91         splx(s);
   92         return (si);
   93 }
   94 
   95 static void
   96 si_free(struct scsi_ioctl *si)
   97 {
   98         int s;
   99 
  100         s = splbio();
  101         LIST_REMOVE(si, si_list);
  102         splx(s);
  103         free(si, M_TEMP);
  104 }
  105 
  106 static struct scsi_ioctl *
  107 si_find(struct buf *bp)
  108 {
  109         struct scsi_ioctl *si;
  110         int s;
  111 
  112         s = splbio();
  113         for (si = si_head.lh_first; si != 0; si = si->si_list.le_next)
  114                 if (bp == &si->si_bp)
  115                         break;
  116         splx(s);
  117         return (si);
  118 }
  119 
  120 /*
  121  * We let the user interpret his own sense in the generic scsi world.
  122  * This routine is called at interrupt time if the XS_CTL_USERCMD bit was set
  123  * in the flags passed to scsi_scsipi_cmd(). No other completion processing
  124  * takes place, even if we are running over another device driver.
  125  * The lower level routines that call us here, will free the xs and restart
  126  * the device's queue if such exists.
  127  */
  128 void
  129 scsipi_user_done(struct scsipi_xfer *xs)
  130 {
  131         struct buf *bp;
  132         struct scsi_ioctl *si;
  133         scsireq_t *screq;
  134         struct scsipi_periph *periph = xs->xs_periph;
  135         int s;
  136 
  137         bp = xs->bp;
  138 #ifdef DIAGNOSTIC
  139         if (bp == NULL) {
  140                 scsipi_printaddr(periph);
  141                 printf("user command with no buf\n");
  142                 panic("scsipi_user_done");
  143         }
  144 #endif
  145         si = si_find(bp);
  146 #ifdef DIAGNOSTIC
  147         if (si == NULL) {
  148                 scsipi_printaddr(periph);
  149                 printf("user command with no ioctl\n");
  150                 panic("scsipi_user_done");
  151         }
  152 #endif
  153 
  154         screq = &si->si_screq;
  155 
  156         SC_DEBUG(xs->xs_periph, SCSIPI_DB2, ("user-done\n"));
  157 
  158         screq->retsts = 0;
  159         screq->status = xs->status;
  160         switch (xs->error) {
  161         case XS_NOERROR:
  162                 SC_DEBUG(periph, SCSIPI_DB3, ("no error\n"));
  163                 screq->datalen_used =
  164                     xs->datalen - xs->resid;    /* probably rubbish */
  165                 screq->retsts = SCCMD_OK;
  166                 break;
  167         case XS_SENSE:
  168                 SC_DEBUG(periph, SCSIPI_DB3, ("have sense\n"));
  169                 screq->senselen_used = min(sizeof(xs->sense.scsi_sense),
  170                     SENSEBUFLEN);
  171                 memcpy(screq->sense, &xs->sense.scsi_sense, screq->senselen);
  172                 screq->retsts = SCCMD_SENSE;
  173                 break;
  174         case XS_SHORTSENSE:
  175                 SC_DEBUG(periph, SCSIPI_DB3, ("have short sense\n"));
  176                 screq->senselen_used = min(sizeof(xs->sense.atapi_sense),
  177                     SENSEBUFLEN);
  178                 memcpy(screq->sense, &xs->sense.scsi_sense, screq->senselen);
  179                 screq->retsts = SCCMD_UNKNOWN; /* XXX need a shortsense here */
  180                 break;
  181         case XS_DRIVER_STUFFUP:
  182                 scsipi_printaddr(periph);
  183                 printf("passthrough: adapter inconsistency\n");
  184                 screq->retsts = SCCMD_UNKNOWN;
  185                 break;
  186         case XS_SELTIMEOUT:
  187                 SC_DEBUG(periph, SCSIPI_DB3, ("seltimeout\n"));
  188                 screq->retsts = SCCMD_TIMEOUT;
  189                 break;
  190         case XS_TIMEOUT:
  191                 SC_DEBUG(periph, SCSIPI_DB3, ("timeout\n"));
  192                 screq->retsts = SCCMD_TIMEOUT;
  193                 break;
  194         case XS_BUSY:
  195                 SC_DEBUG(periph, SCSIPI_DB3, ("busy\n"));
  196                 screq->retsts = SCCMD_BUSY;
  197                 break;
  198         default:
  199                 scsipi_printaddr(periph);
  200                 printf("unknown error category %d from adapter\n",
  201                     xs->error);
  202                 screq->retsts = SCCMD_UNKNOWN;
  203                 break;
  204         }
  205         biodone(bp);    /* we're waiting on it in scsi_strategy() */
  206 
  207         if (xs->xs_control & XS_CTL_ASYNC) {
  208                 s = splbio();
  209                 scsipi_put_xs(xs);
  210                 splx(s);
  211         }
  212 }
  213 
  214 
  215 /* Pseudo strategy function
  216  * Called by scsipi_do_ioctl() via physio/physstrat if there is to
  217  * be data transfered, and directly if there is no data transfer.
  218  *
  219  * Should I reorganize this so it returns to physio instead
  220  * of sleeping in scsiio_scsipi_cmd?  Is there any advantage, other
  221  * than avoiding the probable duplicate wakeup in iodone? [PD]
  222  *
  223  * No, seems ok to me... [JRE]
  224  * (I don't see any duplicate wakeups)
  225  *
  226  * Can't be used with block devices or raw_read/raw_write directly
  227  * from the cdevsw/bdevsw tables because they couldn't have added
  228  * the screq structure. [JRE]
  229  */
  230 static void
  231 scsistrategy(struct buf *bp)
  232 {
  233         struct scsi_ioctl *si;
  234         scsireq_t *screq;
  235         struct scsipi_periph *periph;
  236         int error;
  237         int flags = 0;
  238         int s;
  239 
  240         si = si_find(bp);
  241         if (si == NULL) {
  242                 printf("user_strat: No ioctl\n");
  243                 error = EINVAL;
  244                 goto bad;
  245         }
  246         screq = &si->si_screq;
  247         periph = si->si_periph;
  248         SC_DEBUG(periph, SCSIPI_DB2, ("user_strategy\n"));
  249 
  250         /*
  251          * We're in trouble if physio tried to break up the transfer.
  252          */
  253         if (bp->b_bcount != screq->datalen) {
  254                 scsipi_printaddr(periph);
  255                 printf("physio split the request.. cannot proceed\n");
  256                 error = EIO;
  257                 goto bad;
  258         }
  259 
  260         if (screq->timeout == 0) {
  261                 error = EINVAL;
  262                 goto bad;
  263         }
  264 
  265         if (screq->cmdlen > sizeof(struct scsipi_generic)) {
  266                 scsipi_printaddr(periph);
  267                 printf("cmdlen too big\n");
  268                 error = EFAULT;
  269                 goto bad;
  270         }
  271 
  272         if ((screq->flags & SCCMD_READ) && screq->datalen > 0)
  273                 flags |= XS_CTL_DATA_IN;
  274         if ((screq->flags & SCCMD_WRITE) && screq->datalen > 0)
  275                 flags |= XS_CTL_DATA_OUT;
  276         if (screq->flags & SCCMD_TARGET)
  277                 flags |= XS_CTL_TARGET;
  278         if (screq->flags & SCCMD_ESCAPE)
  279                 flags |= XS_CTL_ESCAPE;
  280 
  281         error = scsipi_command(periph, (void *)screq->cmd, screq->cmdlen,
  282             (void *)bp->b_data, screq->datalen,
  283             0, /* user must do the retries *//* ignored */
  284             screq->timeout, bp, flags | XS_CTL_USERCMD | XS_CTL_ASYNC);
  285 
  286         /* because there is a bp, scsi_scsipi_cmd will return immediatly */
  287         if (error)
  288                 goto bad;
  289 
  290         SC_DEBUG(periph, SCSIPI_DB3, ("about to sleep\n"));
  291         s = splbio();
  292         while ((bp->b_flags & B_DONE) == 0)
  293                 tsleep(bp, PRIBIO, "scistr", 0);
  294         splx(s);
  295         SC_DEBUG(periph, SCSIPI_DB3, ("back from sleep\n"));
  296 
  297         return;
  298 
  299 bad:
  300         bp->b_flags |= B_ERROR;
  301         bp->b_error = error;
  302         biodone(bp);
  303 }
  304 
  305 /*
  306  * Something (e.g. another driver) has called us
  307  * with a periph and a scsi-specific ioctl to perform,
  308  * better try.  If user-level type command, we must
  309  * still be running in the context of the calling process
  310  */
  311 int
  312 scsipi_do_ioctl(struct scsipi_periph *periph, dev_t dev, u_long cmd,
  313     caddr_t addr, int flag, struct proc *p)
  314 {
  315         int error;
  316 
  317         SC_DEBUG(periph, SCSIPI_DB2, ("scsipi_do_ioctl(0x%lx)\n", cmd));
  318 
  319         /* Check for the safe-ness of this request. */
  320         switch (cmd) {
  321         case OSCIOCIDENTIFY:
  322         case SCIOCIDENTIFY:
  323                 break;
  324         case SCIOCCOMMAND:
  325                 if ((((scsireq_t *)addr)->flags & SCCMD_READ) == 0 &&
  326                     (flag & FWRITE) == 0)
  327                         return (EBADF);
  328                 break;
  329         default:
  330                 if ((flag & FWRITE) == 0)
  331                         return (EBADF);
  332         }
  333 
  334         switch (cmd) {
  335         case SCIOCCOMMAND: {
  336                 scsireq_t *screq = (scsireq_t *)addr;
  337                 struct scsi_ioctl *si;
  338                 int len;
  339 
  340                 si = si_get();
  341                 si->si_screq = *screq;
  342                 si->si_periph = periph;
  343                 len = screq->datalen;
  344                 if (len) {
  345                         si->si_iov.iov_base = screq->databuf;
  346                         si->si_iov.iov_len = len;
  347                         si->si_uio.uio_iov = &si->si_iov;
  348                         si->si_uio.uio_iovcnt = 1;
  349                         si->si_uio.uio_resid = len;
  350                         si->si_uio.uio_offset = 0;
  351                         si->si_uio.uio_segflg = UIO_USERSPACE;
  352                         si->si_uio.uio_rw =
  353                             (screq->flags & SCCMD_READ) ? UIO_READ : UIO_WRITE;
  354                         si->si_uio.uio_procp = p;
  355                         error = physio(scsistrategy, &si->si_bp, dev,
  356                             (screq->flags & SCCMD_READ) ? B_READ : B_WRITE,
  357                             periph->periph_channel->chan_adapter->adapt_minphys,
  358                             &si->si_uio);
  359                 } else {
  360                         /* if no data, no need to translate it.. */
  361                         si->si_bp.b_flags = 0;
  362                         si->si_bp.b_data = 0;
  363                         si->si_bp.b_bcount = 0;
  364                         si->si_bp.b_dev = dev;
  365                         si->si_bp.b_proc = p;
  366                         scsistrategy(&si->si_bp);
  367                         error = si->si_bp.b_error;
  368                 }
  369                 *screq = si->si_screq;
  370                 si_free(si);
  371                 return (error);
  372         }
  373         case SCIOCDEBUG: {
  374                 int level = *((int *)addr);
  375 
  376                 SC_DEBUG(periph, SCSIPI_DB3, ("debug set to %d\n", level));
  377                 periph->periph_dbflags = 0;
  378                 if (level & 1)
  379                         periph->periph_dbflags |= SCSIPI_DB1;
  380                 if (level & 2)
  381                         periph->periph_dbflags |= SCSIPI_DB2;
  382                 if (level & 4)
  383                         periph->periph_dbflags |= SCSIPI_DB3;
  384                 if (level & 8)
  385                         periph->periph_dbflags |= SCSIPI_DB4;
  386                 return (0);
  387         }
  388         case SCIOCRECONFIG:
  389         case SCIOCDECONFIG:
  390                 return (EINVAL);
  391         case SCIOCIDENTIFY: {
  392                 struct scsi_addr *sca = (struct scsi_addr *)addr;
  393 
  394                 switch (scsipi_periph_bustype(periph)) {
  395                 case SCSIPI_BUSTYPE_SCSI:
  396                         sca->type = TYPE_SCSI;
  397                         sca->addr.scsi.scbus =
  398                             periph->periph_dev->dv_parent->dv_unit;
  399                         sca->addr.scsi.target = periph->periph_target;
  400                         sca->addr.scsi.lun = periph->periph_lun;
  401                         return (0);
  402                 case SCSIPI_BUSTYPE_ATAPI:
  403                         sca->type = TYPE_ATAPI;
  404                         sca->addr.atapi.atbus =
  405                             periph->periph_dev->dv_parent->dv_unit;
  406                         sca->addr.atapi.drive = periph->periph_target;
  407                         return (0);
  408                 }
  409                 return (ENXIO);
  410         }
  411 #if defined(COMPAT_12) || defined(COMPAT_FREEBSD)
  412         /* SCIOCIDENTIFY before ATAPI staff merge */
  413         case OSCIOCIDENTIFY: {
  414                 struct oscsi_addr *sca = (struct oscsi_addr *)addr;
  415 
  416                 switch (scsipi_periph_bustype(periph)) {
  417                 case SCSIPI_BUSTYPE_SCSI:
  418                         sca->scbus = periph->periph_dev->dv_parent->dv_unit;
  419                         sca->target = periph->periph_target;
  420                         sca->lun = periph->periph_lun;
  421                         return (0);
  422                 }
  423                 return (ENODEV);
  424         }
  425 #endif
  426         default:
  427                 return (ENOTTY);
  428         }
  429 
  430 #ifdef DIAGNOSTIC
  431         panic("scsipi_do_ioctl: impossible");
  432 #endif
  433 }
Cache object: cd7d97894c8d2dd68f6d856100e45dcb
[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]
This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.
FreeBSD/Linux Kernel Cross Reference sys/dev/scsipi/scsipi_ioctl.c

FreeBSD/Linux Kernel Cross Reference
sys/dev/scsipi/scsipi_ioctl.c
