NetBSD/sys/dev/scsipi/scsipi_ioctl.c

/*	$NetBSD: scsipi_ioctl.c,v 1.10 1994/10/30 21:49:21 cgd Exp $	*/

/*
 * Copyright (c) 1994 Charles Hannum.  All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 * 3. All advertising materials mentioning features or use of this software
 *    must display the following acknowledgement:
 *	This product includes software developed by Charles Hannum.
 * 4. The name of the author may not be used to endorse or promote products
 *    derived from this software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
 * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
 * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

/* 
 * Contributed by HD Associates (hd@world.std.com).
 * Copyright (c) 1992, 1993 HD Associates
 *
 * Berkeley style copyright.  
 */

#include <sys/types.h>
#include <sys/errno.h>
#include <sys/param.h>
#include <sys/malloc.h>
#include <sys/buf.h>
#include <sys/proc.h>
#include <sys/device.h>

#include <scsi/scsi_all.h>
#include <scsi/scsiconf.h>
#include <sys/scsiio.h>

void scsierr __P((struct buf *, int));

/*
 * We need to maintain an assocation between the buf and the SCSI request
 * structure.  We do this with a simple array of scsi_ioctl structures below.
 * XXX The free structures should probably be in a linked list.
 */
#define NIOCTL	16

struct scsi_ioctl {
	struct buf *si_bp;
	scsireq_t si_screq;
	struct scsi_link *si_sc_link;
	struct uio si_uio;
	struct iovec si_iov;
} scsi_ioctl[NIOCTL];

struct scsi_ioctl *
si_get(bp)
	struct buf *bp;
{
	int s = splbio();
	struct scsi_ioctl *si;
	int error;

	for (;;) {
		for (si = scsi_ioctl; si < &scsi_ioctl[NIOCTL]; si++)
			if (si->si_bp == 0) {
				si->si_bp = bp;
				splx(s);
				return si;
			}
		error = tsleep(scsi_ioctl, PRIBIO | PCATCH, "siget", 0);
		if (error) {
			splx(s);
			return 0;
		}
	}
}

void
si_free(si)
	struct scsi_ioctl *si;
{
	int s = splbio();

	si->si_bp = 0;
	wakeup(scsi_ioctl);
	splx(s);
}

struct scsi_ioctl *
si_find(bp)
	struct buf *bp;
{
	int s = splbio();
	struct scsi_ioctl *si;

	for (si = scsi_ioctl; si < &scsi_ioctl[NIOCTL]; si++)
		if (si->si_bp == bp) {
			splx(s);
			return si;
		}
	splx(s);
	return 0;
}

/*
 * We let the user interpret his own sense in the generic scsi world.
 * This routine is called at interrupt time if the SCSI_USER bit was set
 * in the flags passed to scsi_scsi_cmd(). No other completion processing
 * takes place, even if we are running over another device driver.
 * The lower level routines that call us here, will free the xs and restart
 * the device's queue if such exists.
 */
void
scsi_user_done(xs)
	struct scsi_xfer *xs;
{
	struct buf *bp;
	scsireq_t *screq;
	struct scsi_ioctl *si;

	bp = xs->bp;
	if (!bp) {	/* ALL user requests must have a buf */
		sc_print_addr(xs->sc_link);
		printf("User command with no buf\n");
		return;
	}
	si = si_find(bp);
	if (!si) {
		sc_print_addr(xs->sc_link);
		printf("User command with no ioctl\n");
		return;
	}
	screq = &si->si_screq;

	SC_DEBUG(xs->sc_link, SDEV_DB2, ("user-done\n"));
	screq->retsts = 0;
	screq->status = xs->status;
	switch (xs->error) {
	case XS_NOERROR:
		SC_DEBUG(xs->sc_link, SDEV_DB3, ("no error\n"));
		screq->datalen_used = xs->datalen - xs->resid; /* probably rubbish */
		screq->retsts = SCCMD_OK;
		break;
	case XS_SENSE:
		SC_DEBUG(xs->sc_link, SDEV_DB3, ("have sense\n"));
		screq->senselen_used = min(sizeof(xs->sense), SENSEBUFLEN);
		bcopy(&xs->sense, screq->sense, screq->senselen);
		screq->retsts = SCCMD_SENSE;
		break;
	case XS_DRIVER_STUFFUP:
		sc_print_addr(xs->sc_link);
		printf("host adapter code inconsistency\n");
		screq->retsts = SCCMD_UNKNOWN;
		break;
	case XS_TIMEOUT:
		SC_DEBUG(xs->sc_link, SDEV_DB3, ("timeout\n"));
		screq->retsts = SCCMD_TIMEOUT;
		break;
	case XS_BUSY:
		SC_DEBUG(xs->sc_link, SDEV_DB3, ("busy\n"));
		screq->retsts = SCCMD_BUSY;
		break;
	default:
		sc_print_addr(xs->sc_link);
		printf("unknown error category from host adapter code\n");
		screq->retsts = SCCMD_UNKNOWN;
		break;
	}
	biodone(bp); 	/* we're waiting on it in scsi_strategy() */

	si_free(si);
}


/* Pseudo strategy function
 * Called by scsi_do_ioctl() via physio/physstrat if there is to
 * be data transfered, and directly if there is no data transfer.
 * 
 * Should I reorganize this so it returns to physio instead
 * of sleeping in scsiio_scsi_cmd?  Is there any advantage, other
 * than avoiding the probable duplicate wakeup in iodone? [PD]
 *
 * No, seems ok to me... [JRE]
 * (I don't see any duplicate wakeups)
 *
 * Can't be used with block devices or raw_read/raw_write directly
 * from the cdevsw/bdevsw tables because they couldn't have added
 * the screq structure. [JRE]
 */
void
scsistrategy(bp)
	struct buf *bp;
{
	int err;
	struct scsi_ioctl *si;
	scsireq_t *screq;
	struct scsi_link *sc_link;
	int flags = 0;
	int s;

	si = si_find(bp);
	if (!si) {
		printf("user_strat: No ioctl\n");
		scsierr(bp, EINVAL);
		return;
	}
	screq = &si->si_screq;

	sc_link = si->si_sc_link;
	if (!sc_link) {
		printf("user_strat: No link pointer\n");
		scsierr(bp, EINVAL);
		goto out;
	}
	SC_DEBUG(sc_link, SDEV_DB2, ("user_strategy\n"));

	/*
	 * We're in trouble if physio tried to break up the transfer.
	 */
	if (bp->b_bcount != screq->datalen) {
		sc_print_addr(sc_link);
		printf("physio split the request.. cannot proceed\n");
		scsierr(bp, EIO);
		goto out;
	}

	if (screq->timeout == 0) {
		scsierr(bp, EINVAL);
		goto out;
	}

	if (screq->cmdlen > sizeof(struct scsi_generic)) {
		sc_print_addr(sc_link);
		printf("cmdlen too big\n");
		scsierr(bp, EFAULT);
		goto out;
	}

	if (screq->flags & SCCMD_READ)
		flags |= SCSI_DATA_IN;
	if (screq->flags & SCCMD_WRITE)
		flags |= SCSI_DATA_OUT;
	if (screq->flags & SCCMD_TARGET)
		flags |= SCSI_TARGET;
	if (screq->flags & SCCMD_ESCAPE)
		flags |= SCSI_ESCAPE;

	err = scsi_scsi_cmd(sc_link, (struct scsi_generic *)screq->cmd,
	    screq->cmdlen, (u_char *)bp->b_data, screq->datalen,
	    0, /* user must do the retries *//* ignored */
	    screq->timeout, bp, flags | SCSI_USER);

	/* because there is a bp, scsi_scsi_cmd will return immediatly */
	if (err) {
		scsierr(bp, err);
		goto out;
	}
	SC_DEBUG(sc_link, SDEV_DB3, ("about to  sleep\n"));
	s = splbio();
	while (!(bp->b_flags & B_DONE))
		tsleep(bp, PRIBIO, "scistr", 0);
	splx(s);
	SC_DEBUG(sc_link, SDEV_DB3, ("back from sleep\n"));

out:
	si_free(si);
}

/*
 * Something (e.g. another driver) has called us
 * with an sc_link for a target/lun/adapter, and a scsi
 * specific ioctl to perform, better try.
 * If user-level type command, we must still be running
 * in the context of the calling process
 */
int
scsi_do_ioctl(sc_link, dev, cmd, addr, f)
	struct scsi_link *sc_link;
	dev_t dev;
	u_long cmd;
	caddr_t addr;
	int f;
{
	int error;

	SC_DEBUG(sc_link, SDEV_DB2, ("scsi_do_ioctl(0x%lx)\n", cmd));
	switch(cmd) {
	case SCIOCCOMMAND: {
		/*
		 * You won't believe this, but the arg copied in
 		 * from the user space, is on the kernel stack
		 * for this process, so we can't write
		 * to it at interrupt time..
		 * we need to copy it in and out!
		 * Make a static copy using malloc!
		 */
		scsireq_t *screq = (scsireq_t *)addr;
		struct buf *bp;
		struct scsi_ioctl *si;
		caddr_t	daddr;
		int len;

		bp = malloc(sizeof(struct buf), M_TEMP, M_WAITOK);
		bzero(bp, sizeof(struct buf));
		daddr = screq->databuf;
		bp->b_bcount = len = screq->datalen;
		si = si_get(bp);
		if (!si) {
			scsierr(bp, EINTR);
			return EINTR;
		}
		si->si_screq = *screq;
		si->si_sc_link = sc_link;
		if (len) {
			si->si_iov.iov_base = daddr;
			si->si_iov.iov_len = len;
			si->si_uio.uio_iov = &si->si_iov;
			si->si_uio.uio_iovcnt = 1;
			si->si_uio.uio_offset = 0;
			si->si_uio.uio_segflg = UIO_USERSPACE;
			si->si_uio.uio_rw = 
			    (screq->flags & SCCMD_READ) ? UIO_READ : UIO_WRITE;
			si->si_uio.uio_procp = curproc;	/* XXX */
			error = physio(scsistrategy, bp, dev,
			    (screq->flags & SCCMD_READ) ? B_READ : B_WRITE,
			    sc_link->adapter->scsi_minphys, &si->si_uio);
		} else {
			/* if no data, no need to translate it.. */
			bp->b_data = 0;
			bp->b_dev = -1; /* irrelevant info */
			bp->b_flags = 0;
			scsistrategy(bp);
			error = bp->b_error;
		}
		free(bp, M_TEMP);
		return error;
	}
	case SCIOCDEBUG: {
		int level = *((int *)addr);

		SC_DEBUG(sc_link, SDEV_DB3, ("debug set to %d\n", level));
		sc_link->flags &= ~SDEV_DBX; /* clear debug bits */
		if (level & 1)
			sc_link->flags |= SDEV_DB1;
		if (level & 2)
			sc_link->flags |= SDEV_DB2;
		if (level & 4)
			sc_link->flags |= SDEV_DB3;
		if (level & 8)
			sc_link->flags |= SDEV_DB4;
		return 0;
	}
	case SCIOCREPROBE: {
		struct scsi_addr *sca = (struct scsi_addr *)addr;

		return scsi_probe_busses(sca->scbus, sca->target, sca->lun);
	}
	case SCIOCRECONFIG:
	case SCIOCDECONFIG:
		return EINVAL;
	case SCIOCIDENTIFY: {
		struct scsi_addr *sca = (struct scsi_addr *)addr;

		sca->scbus = sc_link->scsibus;
		sca->target = sc_link->target;
		sca->lun = sc_link->lun;
		return 0;
	}
	default:
		return ENOTTY;
	}

#ifdef DIAGNOSTIC
	panic("scsi_do_ioctl: impossible");
#endif
}

void
scsierr(bp, error)
	struct buf *bp;
	int error;
{

	bp->b_flags |= B_ERROR;
	bp->b_error = error;
	biodone(bp);
}