Home | History | Annotate | Line # | Download | only in scsipi
scsipi_ioctl.c revision 1.10
      1  1.10      cgd /*	$NetBSD: scsipi_ioctl.c,v 1.10 1994/10/30 21:49:21 cgd Exp $	*/
      2   1.7      cgd 
      3   1.4  mycroft /*
      4   1.4  mycroft  * Copyright (c) 1994 Charles Hannum.  All rights reserved.
      5   1.4  mycroft  *
      6   1.4  mycroft  * Redistribution and use in source and binary forms, with or without
      7   1.4  mycroft  * modification, are permitted provided that the following conditions
      8   1.4  mycroft  * are met:
      9   1.4  mycroft  * 1. Redistributions of source code must retain the above copyright
     10   1.4  mycroft  *    notice, this list of conditions and the following disclaimer.
     11   1.4  mycroft  * 2. Redistributions in binary form must reproduce the above copyright
     12   1.4  mycroft  *    notice, this list of conditions and the following disclaimer in the
     13   1.4  mycroft  *    documentation and/or other materials provided with the distribution.
     14   1.4  mycroft  * 3. All advertising materials mentioning features or use of this software
     15   1.4  mycroft  *    must display the following acknowledgement:
     16   1.4  mycroft  *	This product includes software developed by Charles Hannum.
     17   1.4  mycroft  * 4. The name of the author may not be used to endorse or promote products
     18   1.4  mycroft  *    derived from this software without specific prior written permission.
     19   1.4  mycroft  *
     20   1.4  mycroft  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
     21   1.4  mycroft  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     22   1.4  mycroft  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
     23   1.4  mycroft  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
     24   1.4  mycroft  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
     25   1.4  mycroft  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
     26   1.4  mycroft  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
     27   1.4  mycroft  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
     28   1.4  mycroft  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
     29   1.4  mycroft  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
     30   1.4  mycroft  */
     31   1.4  mycroft 
     32   1.1  mycroft /*
     33   1.1  mycroft  * Contributed by HD Associates (hd (at) world.std.com).
     34   1.1  mycroft  * Copyright (c) 1992, 1993 HD Associates
     35   1.1  mycroft  *
     36   1.1  mycroft  * Berkeley style copyright.
     37   1.1  mycroft  */
     38   1.2  mycroft 
     39   1.1  mycroft #include <sys/types.h>
     40   1.1  mycroft #include <sys/errno.h>
     41   1.1  mycroft #include <sys/param.h>
     42   1.1  mycroft #include <sys/malloc.h>
     43   1.1  mycroft #include <sys/buf.h>
     44   1.1  mycroft #include <sys/proc.h>
     45   1.1  mycroft #include <sys/device.h>
     46   1.1  mycroft 
     47   1.1  mycroft #include <scsi/scsi_all.h>
     48   1.1  mycroft #include <scsi/scsiconf.h>
     49   1.1  mycroft #include <sys/scsiio.h>
     50   1.1  mycroft 
     51   1.4  mycroft void scsierr __P((struct buf *, int));
     52   1.4  mycroft 
     53   1.4  mycroft /*
     54   1.4  mycroft  * We need to maintain an assocation between the buf and the SCSI request
     55   1.4  mycroft  * structure.  We do this with a simple array of scsi_ioctl structures below.
     56   1.4  mycroft  * XXX The free structures should probably be in a linked list.
     57   1.4  mycroft  */
     58   1.4  mycroft #define NIOCTL	16
     59   1.4  mycroft 
     60   1.4  mycroft struct scsi_ioctl {
     61   1.4  mycroft 	struct buf *si_bp;
     62   1.9  mycroft 	scsireq_t si_screq;
     63   1.4  mycroft 	struct scsi_link *si_sc_link;
     64   1.8  mycroft 	struct uio si_uio;
     65   1.8  mycroft 	struct iovec si_iov;
     66   1.4  mycroft } scsi_ioctl[NIOCTL];
     67   1.4  mycroft 
     68   1.4  mycroft struct scsi_ioctl *
     69   1.4  mycroft si_get(bp)
     70   1.4  mycroft 	struct buf *bp;
     71   1.4  mycroft {
     72   1.4  mycroft 	int s = splbio();
     73   1.4  mycroft 	struct scsi_ioctl *si;
     74   1.4  mycroft 	int error;
     75   1.4  mycroft 
     76   1.4  mycroft 	for (;;) {
     77   1.4  mycroft 		for (si = scsi_ioctl; si < &scsi_ioctl[NIOCTL]; si++)
     78   1.4  mycroft 			if (si->si_bp == 0) {
     79   1.4  mycroft 				si->si_bp = bp;
     80   1.4  mycroft 				splx(s);
     81   1.4  mycroft 				return si;
     82   1.4  mycroft 			}
     83   1.4  mycroft 		error = tsleep(scsi_ioctl, PRIBIO | PCATCH, "siget", 0);
     84   1.4  mycroft 		if (error) {
     85   1.4  mycroft 			splx(s);
     86   1.4  mycroft 			return 0;
     87   1.4  mycroft 		}
     88   1.4  mycroft 	}
     89   1.4  mycroft }
     90   1.4  mycroft 
     91   1.4  mycroft void
     92   1.4  mycroft si_free(si)
     93   1.4  mycroft 	struct scsi_ioctl *si;
     94   1.4  mycroft {
     95   1.4  mycroft 	int s = splbio();
     96   1.4  mycroft 
     97   1.4  mycroft 	si->si_bp = 0;
     98   1.4  mycroft 	wakeup(scsi_ioctl);
     99   1.4  mycroft 	splx(s);
    100   1.4  mycroft }
    101   1.4  mycroft 
    102   1.4  mycroft struct scsi_ioctl *
    103   1.4  mycroft si_find(bp)
    104   1.4  mycroft 	struct buf *bp;
    105   1.4  mycroft {
    106   1.4  mycroft 	int s = splbio();
    107   1.4  mycroft 	struct scsi_ioctl *si;
    108   1.4  mycroft 
    109   1.4  mycroft 	for (si = scsi_ioctl; si < &scsi_ioctl[NIOCTL]; si++)
    110   1.4  mycroft 		if (si->si_bp == bp) {
    111   1.4  mycroft 			splx(s);
    112   1.4  mycroft 			return si;
    113   1.4  mycroft 		}
    114   1.4  mycroft 	splx(s);
    115   1.4  mycroft 	return 0;
    116   1.4  mycroft }
    117   1.1  mycroft 
    118   1.1  mycroft /*
    119   1.1  mycroft  * We let the user interpret his own sense in the generic scsi world.
    120   1.1  mycroft  * This routine is called at interrupt time if the SCSI_USER bit was set
    121   1.1  mycroft  * in the flags passed to scsi_scsi_cmd(). No other completion processing
    122   1.1  mycroft  * takes place, even if we are running over another device driver.
    123   1.1  mycroft  * The lower level routines that call us here, will free the xs and restart
    124   1.1  mycroft  * the device's queue if such exists.
    125   1.1  mycroft  */
    126   1.2  mycroft void
    127   1.2  mycroft scsi_user_done(xs)
    128   1.2  mycroft 	struct scsi_xfer *xs;
    129   1.1  mycroft {
    130   1.2  mycroft 	struct buf *bp;
    131   1.1  mycroft 	scsireq_t *screq;
    132   1.4  mycroft 	struct scsi_ioctl *si;
    133   1.1  mycroft 
    134   1.1  mycroft 	bp = xs->bp;
    135   1.2  mycroft 	if (!bp) {	/* ALL user requests must have a buf */
    136   1.1  mycroft 		sc_print_addr(xs->sc_link);
    137   1.1  mycroft 		printf("User command with no buf\n");
    138   1.2  mycroft 		return;
    139   1.1  mycroft 	}
    140   1.4  mycroft 	si = si_find(bp);
    141   1.4  mycroft 	if (!si) {
    142   1.4  mycroft 		sc_print_addr(xs->sc_link);
    143   1.4  mycroft 		printf("User command with no ioctl\n");
    144   1.4  mycroft 		return;
    145   1.4  mycroft 	}
    146   1.9  mycroft 	screq = &si->si_screq;
    147   1.1  mycroft 
    148   1.2  mycroft 	SC_DEBUG(xs->sc_link, SDEV_DB2, ("user-done\n"));
    149   1.1  mycroft 	screq->retsts = 0;
    150   1.1  mycroft 	screq->status = xs->status;
    151   1.9  mycroft 	switch (xs->error) {
    152   1.2  mycroft 	case XS_NOERROR:
    153   1.2  mycroft 		SC_DEBUG(xs->sc_link, SDEV_DB3, ("no error\n"));
    154   1.1  mycroft 		screq->datalen_used = xs->datalen - xs->resid; /* probably rubbish */
    155   1.1  mycroft 		screq->retsts = SCCMD_OK;
    156   1.1  mycroft 		break;
    157   1.2  mycroft 	case XS_SENSE:
    158   1.2  mycroft 		SC_DEBUG(xs->sc_link, SDEV_DB3, ("have sense\n"));
    159   1.2  mycroft 		screq->senselen_used = min(sizeof(xs->sense), SENSEBUFLEN);
    160   1.2  mycroft 		bcopy(&xs->sense, screq->sense, screq->senselen);
    161   1.1  mycroft 		screq->retsts = SCCMD_SENSE;
    162   1.1  mycroft 		break;
    163   1.2  mycroft 	case XS_DRIVER_STUFFUP:
    164   1.1  mycroft 		sc_print_addr(xs->sc_link);
    165   1.1  mycroft 		printf("host adapter code inconsistency\n");
    166   1.1  mycroft 		screq->retsts = SCCMD_UNKNOWN;
    167   1.1  mycroft 		break;
    168   1.2  mycroft 	case XS_TIMEOUT:
    169   1.2  mycroft 		SC_DEBUG(xs->sc_link, SDEV_DB3, ("timeout\n"));
    170   1.1  mycroft 		screq->retsts = SCCMD_TIMEOUT;
    171   1.1  mycroft 		break;
    172   1.2  mycroft 	case XS_BUSY:
    173   1.2  mycroft 		SC_DEBUG(xs->sc_link, SDEV_DB3, ("busy\n"));
    174   1.1  mycroft 		screq->retsts = SCCMD_BUSY;
    175   1.1  mycroft 		break;
    176   1.1  mycroft 	default:
    177   1.1  mycroft 		sc_print_addr(xs->sc_link);
    178   1.1  mycroft 		printf("unknown error category from host adapter code\n");
    179   1.1  mycroft 		screq->retsts = SCCMD_UNKNOWN;
    180   1.1  mycroft 		break;
    181   1.1  mycroft 	}
    182   1.1  mycroft 	biodone(bp); 	/* we're waiting on it in scsi_strategy() */
    183   1.9  mycroft 
    184   1.9  mycroft 	si_free(si);
    185   1.1  mycroft }
    186   1.1  mycroft 
    187   1.1  mycroft 
    188   1.1  mycroft /* Pseudo strategy function
    189   1.1  mycroft  * Called by scsi_do_ioctl() via physio/physstrat if there is to
    190   1.1  mycroft  * be data transfered, and directly if there is no data transfer.
    191   1.1  mycroft  *
    192   1.1  mycroft  * Should I reorganize this so it returns to physio instead
    193   1.1  mycroft  * of sleeping in scsiio_scsi_cmd?  Is there any advantage, other
    194   1.1  mycroft  * than avoiding the probable duplicate wakeup in iodone? [PD]
    195   1.1  mycroft  *
    196   1.1  mycroft  * No, seems ok to me... [JRE]
    197   1.1  mycroft  * (I don't see any duplicate wakeups)
    198   1.1  mycroft  *
    199   1.1  mycroft  * Can't be used with block devices or raw_read/raw_write directly
    200   1.1  mycroft  * from the cdevsw/bdevsw tables because they couldn't have added
    201   1.1  mycroft  * the screq structure. [JRE]
    202   1.1  mycroft  */
    203   1.4  mycroft void
    204   1.4  mycroft scsistrategy(bp)
    205   1.4  mycroft 	struct buf *bp;
    206   1.1  mycroft {
    207   1.2  mycroft 	int err;
    208   1.4  mycroft 	struct scsi_ioctl *si;
    209   1.1  mycroft 	scsireq_t *screq;
    210   1.4  mycroft 	struct scsi_link *sc_link;
    211   1.5  mycroft 	int flags = 0;
    212   1.1  mycroft 	int s;
    213   1.1  mycroft 
    214   1.4  mycroft 	si = si_find(bp);
    215   1.4  mycroft 	if (!si) {
    216   1.4  mycroft 		printf("user_strat: No ioctl\n");
    217   1.4  mycroft 		scsierr(bp, EINVAL);
    218   1.4  mycroft 		return;
    219   1.4  mycroft 	}
    220   1.9  mycroft 	screq = &si->si_screq;
    221   1.9  mycroft 
    222   1.4  mycroft 	sc_link = si->si_sc_link;
    223   1.2  mycroft 	if (!sc_link) {
    224   1.1  mycroft 		printf("user_strat: No link pointer\n");
    225   1.2  mycroft 		scsierr(bp, EINVAL);
    226   1.9  mycroft 		goto out;
    227   1.1  mycroft 	}
    228   1.2  mycroft 	SC_DEBUG(sc_link, SDEV_DB2, ("user_strategy\n"));
    229   1.1  mycroft 
    230   1.4  mycroft 	/*
    231   1.4  mycroft 	 * We're in trouble if physio tried to break up the transfer.
    232   1.1  mycroft 	 */
    233   1.1  mycroft 	if (bp->b_bcount != screq->datalen) {
    234   1.1  mycroft 		sc_print_addr(sc_link);
    235   1.1  mycroft 		printf("physio split the request.. cannot proceed\n");
    236   1.1  mycroft 		scsierr(bp, EIO);
    237   1.9  mycroft 		goto out;
    238   1.1  mycroft 	}
    239   1.1  mycroft 
    240   1.1  mycroft 	if (screq->timeout == 0) {
    241   1.1  mycroft 		scsierr(bp, EINVAL);
    242   1.9  mycroft 		goto out;
    243   1.1  mycroft 	}
    244   1.1  mycroft 
    245   1.1  mycroft 	if (screq->cmdlen > sizeof(struct scsi_generic)) {
    246   1.1  mycroft 		sc_print_addr(sc_link);
    247   1.4  mycroft 		printf("cmdlen too big\n");
    248   1.1  mycroft 		scsierr(bp, EFAULT);
    249   1.9  mycroft 		goto out;
    250   1.1  mycroft 	}
    251   1.1  mycroft 
    252   1.1  mycroft 	if (screq->flags & SCCMD_READ)
    253   1.1  mycroft 		flags |= SCSI_DATA_IN;
    254   1.1  mycroft 	if (screq->flags & SCCMD_WRITE)
    255   1.1  mycroft 		flags |= SCSI_DATA_OUT;
    256   1.1  mycroft 	if (screq->flags & SCCMD_TARGET)
    257   1.1  mycroft 		flags |= SCSI_TARGET;
    258   1.1  mycroft 	if (screq->flags & SCCMD_ESCAPE)
    259   1.1  mycroft 		flags |= SCSI_ESCAPE;
    260   1.2  mycroft 
    261   1.4  mycroft 	err = scsi_scsi_cmd(sc_link, (struct scsi_generic *)screq->cmd,
    262   1.6  mycroft 	    screq->cmdlen, (u_char *)bp->b_data, screq->datalen,
    263   1.4  mycroft 	    0, /* user must do the retries *//* ignored */
    264   1.4  mycroft 	    screq->timeout, bp, flags | SCSI_USER);
    265   1.1  mycroft 
    266   1.2  mycroft 	/* because there is a bp, scsi_scsi_cmd will return immediatly */
    267   1.2  mycroft 	if (err) {
    268   1.1  mycroft 		scsierr(bp, err);
    269   1.9  mycroft 		goto out;
    270   1.1  mycroft 	}
    271   1.2  mycroft 	SC_DEBUG(sc_link, SDEV_DB3, ("about to  sleep\n"));
    272   1.1  mycroft 	s = splbio();
    273   1.2  mycroft 	while (!(bp->b_flags & B_DONE))
    274   1.2  mycroft 		tsleep(bp, PRIBIO, "scistr", 0);
    275   1.1  mycroft 	splx(s);
    276   1.2  mycroft 	SC_DEBUG(sc_link, SDEV_DB3, ("back from sleep\n"));
    277   1.9  mycroft 
    278   1.9  mycroft out:
    279   1.9  mycroft 	si_free(si);
    280   1.1  mycroft }
    281   1.1  mycroft 
    282   1.1  mycroft /*
    283   1.1  mycroft  * Something (e.g. another driver) has called us
    284   1.1  mycroft  * with an sc_link for a target/lun/adapter, and a scsi
    285   1.1  mycroft  * specific ioctl to perform, better try.
    286   1.1  mycroft  * If user-level type command, we must still be running
    287   1.1  mycroft  * in the context of the calling process
    288   1.1  mycroft  */
    289   1.2  mycroft int
    290   1.8  mycroft scsi_do_ioctl(sc_link, dev, cmd, addr, f)
    291   1.4  mycroft 	struct scsi_link *sc_link;
    292   1.8  mycroft 	dev_t dev;
    293  1.10      cgd 	u_long cmd;
    294   1.4  mycroft 	caddr_t addr;
    295   1.4  mycroft 	int f;
    296   1.1  mycroft {
    297   1.4  mycroft 	int error;
    298   1.1  mycroft 
    299  1.10      cgd 	SC_DEBUG(sc_link, SDEV_DB2, ("scsi_do_ioctl(0x%lx)\n", cmd));
    300   1.2  mycroft 	switch(cmd) {
    301   1.4  mycroft 	case SCIOCCOMMAND: {
    302   1.4  mycroft 		/*
    303   1.4  mycroft 		 * You won't believe this, but the arg copied in
    304   1.4  mycroft  		 * from the user space, is on the kernel stack
    305   1.4  mycroft 		 * for this process, so we can't write
    306   1.4  mycroft 		 * to it at interrupt time..
    307   1.4  mycroft 		 * we need to copy it in and out!
    308   1.4  mycroft 		 * Make a static copy using malloc!
    309   1.4  mycroft 		 */
    310   1.4  mycroft 		scsireq_t *screq = (scsireq_t *)addr;
    311   1.4  mycroft 		struct buf *bp;
    312   1.8  mycroft 		struct scsi_ioctl *si;
    313   1.8  mycroft 		caddr_t	daddr;
    314   1.4  mycroft 		int len;
    315   1.4  mycroft 
    316   1.4  mycroft 		bp = malloc(sizeof(struct buf), M_TEMP, M_WAITOK);
    317   1.4  mycroft 		bzero(bp, sizeof(struct buf));
    318   1.8  mycroft 		daddr = screq->databuf;
    319   1.4  mycroft 		bp->b_bcount = len = screq->datalen;
    320   1.4  mycroft 		si = si_get(bp);
    321   1.4  mycroft 		if (!si) {
    322   1.4  mycroft 			scsierr(bp, EINTR);
    323   1.4  mycroft 			return EINTR;
    324   1.4  mycroft 		}
    325   1.9  mycroft 		si->si_screq = *screq;
    326   1.4  mycroft 		si->si_sc_link = sc_link;
    327   1.4  mycroft 		if (len) {
    328   1.8  mycroft 			si->si_iov.iov_base = daddr;
    329   1.8  mycroft 			si->si_iov.iov_len = len;
    330   1.8  mycroft 			si->si_uio.uio_iov = &si->si_iov;
    331   1.8  mycroft 			si->si_uio.uio_iovcnt = 1;
    332   1.8  mycroft 			si->si_uio.uio_offset = 0;
    333   1.8  mycroft 			si->si_uio.uio_segflg = UIO_USERSPACE;
    334   1.8  mycroft 			si->si_uio.uio_rw =
    335   1.8  mycroft 			    (screq->flags & SCCMD_READ) ? UIO_READ : UIO_WRITE;
    336   1.8  mycroft 			si->si_uio.uio_procp = curproc;	/* XXX */
    337   1.8  mycroft 			error = physio(scsistrategy, bp, dev,
    338   1.8  mycroft 			    (screq->flags & SCCMD_READ) ? B_READ : B_WRITE,
    339   1.8  mycroft 			    sc_link->adapter->scsi_minphys, &si->si_uio);
    340   1.4  mycroft 		} else {
    341   1.4  mycroft 			/* if no data, no need to translate it.. */
    342   1.6  mycroft 			bp->b_data = 0;
    343   1.4  mycroft 			bp->b_dev = -1; /* irrelevant info */
    344   1.4  mycroft 			bp->b_flags = 0;
    345   1.4  mycroft 			scsistrategy(bp);
    346   1.4  mycroft 			error = bp->b_error;
    347   1.1  mycroft 		}
    348   1.4  mycroft 		free(bp, M_TEMP);
    349   1.4  mycroft 		return error;
    350   1.4  mycroft 	}
    351   1.4  mycroft 	case SCIOCDEBUG: {
    352   1.4  mycroft 		int level = *((int *)addr);
    353   1.1  mycroft 
    354   1.4  mycroft 		SC_DEBUG(sc_link, SDEV_DB3, ("debug set to %d\n", level));
    355   1.4  mycroft 		sc_link->flags &= ~SDEV_DBX; /* clear debug bits */
    356   1.4  mycroft 		if (level & 1)
    357   1.4  mycroft 			sc_link->flags |= SDEV_DB1;
    358   1.4  mycroft 		if (level & 2)
    359   1.4  mycroft 			sc_link->flags |= SDEV_DB2;
    360   1.4  mycroft 		if (level & 4)
    361   1.4  mycroft 			sc_link->flags |= SDEV_DB3;
    362   1.4  mycroft 		if (level & 8)
    363   1.4  mycroft 			sc_link->flags |= SDEV_DB4;
    364   1.4  mycroft 		return 0;
    365   1.4  mycroft 	}
    366   1.4  mycroft 	case SCIOCREPROBE: {
    367   1.4  mycroft 		struct scsi_addr *sca = (struct scsi_addr *)addr;
    368   1.1  mycroft 
    369   1.4  mycroft 		return scsi_probe_busses(sca->scbus, sca->target, sca->lun);
    370   1.4  mycroft 	}
    371   1.4  mycroft 	case SCIOCRECONFIG:
    372   1.4  mycroft 	case SCIOCDECONFIG:
    373   1.4  mycroft 		return EINVAL;
    374   1.4  mycroft 	case SCIOCIDENTIFY: {
    375   1.4  mycroft 		struct scsi_addr *sca = (struct scsi_addr *)addr;
    376   1.4  mycroft 
    377   1.4  mycroft 		sca->scbus = sc_link->scsibus;
    378   1.4  mycroft 		sca->target = sc_link->target;
    379   1.4  mycroft 		sca->lun = sc_link->lun;
    380   1.4  mycroft 		return 0;
    381   1.4  mycroft 	}
    382   1.4  mycroft 	default:
    383   1.4  mycroft 		return ENOTTY;
    384   1.1  mycroft 	}
    385   1.1  mycroft 
    386   1.4  mycroft #ifdef DIAGNOSTIC
    387   1.4  mycroft 	panic("scsi_do_ioctl: impossible");
    388   1.4  mycroft #endif
    389   1.1  mycroft }
    390   1.1  mycroft 
    391   1.2  mycroft void
    392   1.2  mycroft scsierr(bp, error)
    393   1.2  mycroft 	struct buf *bp;
    394   1.2  mycroft 	int error;
    395   1.1  mycroft {
    396   1.2  mycroft 
    397   1.2  mycroft 	bp->b_flags |= B_ERROR;
    398   1.2  mycroft 	bp->b_error = error;
    399   1.2  mycroft 	biodone(bp);
    400   1.1  mycroft }
    401