xref: /src/sys/dev/scsipi/scsipi_ioctl.c

/*
 * Contributed by HD Associates (hd (at) 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>

#define	b_screq av_forw		/* XXX */
#define	b_sc_link av_back	/* XXX */

/*
 * 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.
 */
#ifndef min
#define min(A,B) ((A<B) ? A : B)
#endif

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

void
scsi_user_done(xs)
	struct scsi_xfer *xs;
{
	struct buf *bp;
	scsireq_t *screq;

	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;
	}
	screq = bp->b_screq;
	if (!screq) {	/* Is it one of ours? (the SCSI_USER bit says it is) */
		sc_print_addr(xs->sc_link);
		printf("User command with no request\n");
		return;
	}

	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() */
	return;		/* it'll free the xs and restart any queue */
}


/* 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(struct buf *bp)
{
	int err;
	struct	scsi_link *sc_link = bp->b_sc_link;
	scsireq_t *screq;
	u_int32	flags = 0;
	int s;

	if (!sc_link) {
		printf("user_strat: No link pointer\n");
		scsierr(bp, EINVAL);
		return;
	}
	SC_DEBUG(sc_link, SDEV_DB2, ("user_strategy\n"));
	screq = bp->b_screq;
	if (!screq) {
		sc_print_addr(sc_link);
		printf("No request block\n");
		scsierr(bp, EINVAL);
		return;
	}

	/* 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);
		return;
	}

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

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

	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_un.b_addr,
			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);
		return;
	}
	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"));
	return;
}

void scsiminphys(struct buf *bp)
{
	/*XXX*//* call the adapter's minphys */
}


/*
 * 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(struct scsi_link *sc_link, int cmd, caddr_t addr, int f)
{
	int error = 0;
	int phys;

	SC_DEBUG(sc_link, SDEV_DB2, ("scsi_do_ioctl(0x%x)\n", cmd));
	switch(cmd) {
#ifndef __NetBSD__
		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 *screq2 = (scsireq_t *)addr;
			scsireq_t *screq = (scsireq_t *)addr;
			int rwflag = (screq->flags & SCCMD_READ) ? B_READ : B_WRITE;
			struct buf *bp;
			caddr_t	d_addr;
			int	len;

			if ((unsigned int)screq < KERNBASE) {
				screq = malloc(sizeof(scsireq_t),
					       M_TEMP, M_WAITOK);
				bcopy(screq2, screq, sizeof(scsireq_t));
			}
			bp = malloc(sizeof (struct buf), M_TEMP, M_WAITOK);
			bzero(bp, sizeof(struct buf));
			d_addr = screq->databuf;
			bp->b_bcount = len = screq->datalen;
			bp->b_screq = screq;
			bp->b_sc_link = sc_link;
			if (len) {
				/* have data, translate it. (physio)*/
#ifdef	__NetBSD__
#error "dev, mincntfn & uio need defining"
				error = physio(scsistrategy, bp, dev, rwflag,
					mincntfn, uio);
#else
				error = physio(scsistrategy, 0, bp, 0, rwflag,
						d_addr, &len, curproc);
#endif
			} else {
				/* if no data, no need to translate it.. */
				bp->b_un.b_addr = 0;
				bp->b_dev = -1; /* irrelevant info */
				bp->b_flags = 0;

				scsistrategy(bp);
				error =  bp->b_error;
			}
			free(bp, M_TEMP);
			if ((unsigned int)screq2 < KERNBASE) {
				bcopy(screq, screq2, sizeof(scsireq_t));
				free(screq, M_TEMP);
			}
			break;
		}
#endif /* !NetBSD */
		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;
			error = 0;
			break;
		}
		case SCIOCREPROBE:
		{
			extern int scsibus;
			struct scsi_addr *sca = (struct scsi_addr *) addr;

			error = scsi_probe_busses(sca->scbus, sca->target, sca->lun);
			break;
		}
		case SCIOCRECONFIG:
		case SCIOCDECONFIG:
			error = EINVAL;
			break;
		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;
			break;
		}

		default:
			error = ENOTTY;
		break;
	}

	return error;
}

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

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