[mirror_ubuntu-artful-kernel.git] / block / scsi_ioctl.c

/*
 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 *
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public Licens
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-
 *
 */
#include <linux/kernel.h>
#include <linux/errno.h>
#include <linux/string.h>
#include <linux/module.h>
#include <linux/blkdev.h>
#include <linux/capability.h>
#include <linux/completion.h>
#include <linux/cdrom.h>
#include <linux/slab.h>
#include <linux/times.h>
#include <asm/uaccess.h>

#include <scsi/scsi.h>
#include <scsi/scsi_ioctl.h>
#include <scsi/scsi_cmnd.h>

/* Command group 3 is reserved and should never be used.  */
const unsigned char scsi_command_size_tbl[8] =
{
	6, 10, 10, 12,
	16, 12, 10, 10
};
EXPORT_SYMBOL(scsi_command_size_tbl);

#include <scsi/sg.h>

static int sg_get_version(int __user *p)
{
	static const int sg_version_num = 30527;
	return put_user(sg_version_num, p);
}

static int scsi_get_idlun(struct request_queue *q, int __user *p)
{
	return put_user(0, p);
}

static int scsi_get_bus(struct request_queue *q, int __user *p)
{
	return put_user(0, p);
}

static int sg_get_timeout(struct request_queue *q)
{
	return q->sg_timeout / (HZ / USER_HZ);
}

static int sg_set_timeout(struct request_queue *q, int __user *p)
{
	int timeout, err = get_user(timeout, p);

	if (!err)
		q->sg_timeout = timeout * (HZ / USER_HZ);

	return err;
}

static int sg_get_reserved_size(struct request_queue *q, int __user *p)
{
	unsigned val = min(q->sg_reserved_size, q->max_sectors << 9);

	return put_user(val, p);
}

static int sg_set_reserved_size(struct request_queue *q, int __user *p)
{
	int size, err = get_user(size, p);

	if (err)
		return err;

	if (size < 0)
		return -EINVAL;
	if (size > (q->max_sectors << 9))
		size = q->max_sectors << 9;

	q->sg_reserved_size = size;
	return 0;
}

/*
 * will always return that we are ATAPI even for a real SCSI drive, I'm not
 * so sure this is worth doing anything about (why would you care??)
 */
static int sg_emulated_host(struct request_queue *q, int __user *p)
{
	return put_user(1, p);
}

static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
			     struct sg_io_hdr *hdr, struct file *file)
{
	if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
		return -EFAULT;
	if (blk_verify_command(file, rq->cmd))
		return -EPERM;

	/*
	 * fill in request structure
	 */
	rq->cmd_len = hdr->cmd_len;
	rq->cmd_type = REQ_TYPE_BLOCK_PC;

	rq->timeout = msecs_to_jiffies(hdr->timeout);
	if (!rq->timeout)
		rq->timeout = q->sg_timeout;
	if (!rq->timeout)
		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;

	return 0;
}

/*
 * unmap a request that was previously mapped to this sg_io_hdr. handles
 * both sg and non-sg sg_io_hdr.
 */
static int blk_unmap_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr)
{
	blk_rq_unmap_user(rq->bio);
	blk_put_request(rq);
	return 0;
}

static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
				 struct bio *bio)
{
	int r, ret = 0;

	/*
	 * fill in all the output members
	 */
	hdr->status = rq->errors & 0xff;
	hdr->masked_status = status_byte(rq->errors);
	hdr->msg_status = msg_byte(rq->errors);
	hdr->host_status = host_byte(rq->errors);
	hdr->driver_status = driver_byte(rq->errors);
	hdr->info = 0;
	if (hdr->masked_status || hdr->host_status || hdr->driver_status)
		hdr->info |= SG_INFO_CHECK;
	hdr->resid = rq->data_len;
	hdr->sb_len_wr = 0;

	if (rq->sense_len && hdr->sbp) {
		int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);

		if (!copy_to_user(hdr->sbp, rq->sense, len))
			hdr->sb_len_wr = len;
		else
			ret = -EFAULT;
	}

	rq->bio = bio;
	r = blk_unmap_sghdr_rq(rq, hdr);
	if (ret)
		r = ret;

	return r;
}

static int sg_io(struct file *file, struct request_queue *q,
		struct gendisk *bd_disk, struct sg_io_hdr *hdr)
{
	unsigned long start_time;
	int writing = 0, ret = 0;
	struct request *rq;
	char sense[SCSI_SENSE_BUFFERSIZE];
	struct bio *bio;

	if (hdr->interface_id != 'S')
		return -EINVAL;
	if (hdr->cmd_len > BLK_MAX_CDB)
		return -EINVAL;

	if (hdr->dxfer_len > (q->max_hw_sectors << 9))
		return -EIO;

	if (hdr->dxfer_len)
		switch (hdr->dxfer_direction) {
		default:
			return -EINVAL;
		case SG_DXFER_TO_DEV:
			writing = 1;
			break;
		case SG_DXFER_TO_FROM_DEV:
		case SG_DXFER_FROM_DEV:
			break;
		}

	rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
	if (!rq)
		return -ENOMEM;

	if (blk_fill_sghdr_rq(q, rq, hdr, file)) {
		blk_put_request(rq);
		return -EFAULT;
	}

	if (hdr->iovec_count) {
		const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
		struct sg_iovec *iov;

		iov = kmalloc(size, GFP_KERNEL);
		if (!iov) {
			ret = -ENOMEM;
			goto out;
		}

		if (copy_from_user(iov, hdr->dxferp, size)) {
			kfree(iov);
			ret = -EFAULT;
			goto out;
		}

		ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count,
					  hdr->dxfer_len);
		kfree(iov);
	} else if (hdr->dxfer_len)
		ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len);

	if (ret)
		goto out;

	bio = rq->bio;
	memset(sense, 0, sizeof(sense));
	rq->sense = sense;
	rq->sense_len = 0;
	rq->retries = 0;

	start_time = jiffies;

	/* ignore return value. All information is passed back to caller
	 * (if he doesn't check that is his problem).
	 * N.B. a non-zero SCSI status is _not_ necessarily an error.
	 */
	blk_execute_rq(q, bd_disk, rq, 0);

	hdr->duration = jiffies_to_msecs(jiffies - start_time);

	return blk_complete_sghdr_rq(rq, hdr, bio);
out:
	blk_put_request(rq);
	return ret;
}

/**
 * sg_scsi_ioctl  --  handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
 * @file:	file this ioctl operates on (optional)
 * @q:		request queue to send scsi commands down
 * @disk:	gendisk to operate on (option)
 * @sic:	userspace structure describing the command to perform
 *
 * Send down the scsi command described by @sic to the device below
 * the request queue @q.  If @file is non-NULL it's used to perform
 * fine-grained permission checks that allow users to send down
 * non-destructive SCSI commands.  If the caller has a struct gendisk
 * available it should be passed in as @disk to allow the low level
 * driver to use the information contained in it.  A non-NULL @disk
 * is only allowed if the caller knows that the low level driver doesn't
 * need it (e.g. in the scsi subsystem).
 *
 * Notes:
 *   -  This interface is deprecated - users should use the SG_IO
 *      interface instead, as this is a more flexible approach to
 *      performing SCSI commands on a device.
 *   -  The SCSI command length is determined by examining the 1st byte
 *      of the given command. There is no way to override this.
 *   -  Data transfers are limited to PAGE_SIZE
 *   -  The length (x + y) must be at least OMAX_SB_LEN bytes long to
 *      accommodate the sense buffer when an error occurs.
 *      The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
 *      old code will not be surprised.
 *   -  If a Unix error occurs (e.g. ENOMEM) then the user will receive
 *      a negative return and the Unix error code in 'errno'.
 *      If the SCSI command succeeds then 0 is returned.
 *      Positive numbers returned are the compacted SCSI error codes (4
 *      bytes in one int) where the lowest byte is the SCSI status.
 */
#define OMAX_SB_LEN 16          /* For backward compatibility */
int sg_scsi_ioctl(struct file *file, struct request_queue *q,
		  struct gendisk *disk, struct scsi_ioctl_command __user *sic)
{
	struct request *rq;
	int err;
	unsigned int in_len, out_len, bytes, opcode, cmdlen;
	char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];

	if (!sic)
		return -EINVAL;

	/*
	 * get in an out lengths, verify they don't exceed a page worth of data
	 */
	if (get_user(in_len, &sic->inlen))
		return -EFAULT;
	if (get_user(out_len, &sic->outlen))
		return -EFAULT;
	if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
		return -EINVAL;
	if (get_user(opcode, sic->data))
		return -EFAULT;

	bytes = max(in_len, out_len);
	if (bytes) {
		buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
		if (!buffer)
			return -ENOMEM;

	}

	rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);

	cmdlen = COMMAND_SIZE(opcode);

	/*
	 * get command and data to send to device, if any
	 */
	err = -EFAULT;
	rq->cmd_len = cmdlen;
	if (copy_from_user(rq->cmd, sic->data, cmdlen))
		goto error;

	if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
		goto error;

	err = blk_verify_command(file, rq->cmd);
	if (err)
		goto error;

	/* default.  possible overriden later */
	rq->retries = 5;

	switch (opcode) {
	case SEND_DIAGNOSTIC:
	case FORMAT_UNIT:
		rq->timeout = FORMAT_UNIT_TIMEOUT;
		rq->retries = 1;
		break;
	case START_STOP:
		rq->timeout = START_STOP_TIMEOUT;
		break;
	case MOVE_MEDIUM:
		rq->timeout = MOVE_MEDIUM_TIMEOUT;
		break;
	case READ_ELEMENT_STATUS:
		rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
		break;
	case READ_DEFECT_DATA:
		rq->timeout = READ_DEFECT_DATA_TIMEOUT;
		rq->retries = 1;
		break;
	default:
		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
		break;
	}

	if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
		err = DRIVER_ERROR << 24;
		goto out;
	}

	memset(sense, 0, sizeof(sense));
	rq->sense = sense;
	rq->sense_len = 0;
	rq->cmd_type = REQ_TYPE_BLOCK_PC;

	blk_execute_rq(q, disk, rq, 0);

out:
	err = rq->errors & 0xff;	/* only 8 bit SCSI status */
	if (err) {
		if (rq->sense_len && rq->sense) {
			bytes = (OMAX_SB_LEN > rq->sense_len) ?
				rq->sense_len : OMAX_SB_LEN;
			if (copy_to_user(sic->data, rq->sense, bytes))
				err = -EFAULT;
		}
	} else {
		if (copy_to_user(sic->data, buffer, out_len))
			err = -EFAULT;
	}
	
error:
	kfree(buffer);
	blk_put_request(rq);
	return err;
}
EXPORT_SYMBOL_GPL(sg_scsi_ioctl);

/* Send basic block requests */
static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
			      int cmd, int data)
{
	struct request *rq;
	int err;

	rq = blk_get_request(q, WRITE, __GFP_WAIT);
	rq->cmd_type = REQ_TYPE_BLOCK_PC;
	rq->data = NULL;
	rq->data_len = 0;
	rq->extra_len = 0;
	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
	rq->cmd[0] = cmd;
	rq->cmd[4] = data;
	rq->cmd_len = 6;
	err = blk_execute_rq(q, bd_disk, rq, 0);
	blk_put_request(rq);

	return err;
}

static inline int blk_send_start_stop(struct request_queue *q,
				      struct gendisk *bd_disk, int data)
{
	return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
}

int scsi_cmd_ioctl(struct file *file, struct request_queue *q,
		   struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
{
	int err;

	if (!q || blk_get_queue(q))
		return -ENXIO;

	switch (cmd) {
		/*
		 * new sgv3 interface
		 */
		case SG_GET_VERSION_NUM:
			err = sg_get_version(arg);
			break;
		case SCSI_IOCTL_GET_IDLUN:
			err = scsi_get_idlun(q, arg);
			break;
		case SCSI_IOCTL_GET_BUS_NUMBER:
			err = scsi_get_bus(q, arg);
			break;
		case SG_SET_TIMEOUT:
			err = sg_set_timeout(q, arg);
			break;
		case SG_GET_TIMEOUT:
			err = sg_get_timeout(q);
			break;
		case SG_GET_RESERVED_SIZE:
			err = sg_get_reserved_size(q, arg);
			break;
		case SG_SET_RESERVED_SIZE:
			err = sg_set_reserved_size(q, arg);
			break;
		case SG_EMULATED_HOST:
			err = sg_emulated_host(q, arg);
			break;
		case SG_IO: {
			struct sg_io_hdr hdr;

			err = -EFAULT;
			if (copy_from_user(&hdr, arg, sizeof(hdr)))
				break;
			err = sg_io(file, q, bd_disk, &hdr);
			if (err == -EFAULT)
				break;

			if (copy_to_user(arg, &hdr, sizeof(hdr)))
				err = -EFAULT;
			break;
		}
		case CDROM_SEND_PACKET: {
			struct cdrom_generic_command cgc;
			struct sg_io_hdr hdr;

			err = -EFAULT;
			if (copy_from_user(&cgc, arg, sizeof(cgc)))
				break;
			cgc.timeout = clock_t_to_jiffies(cgc.timeout);
			memset(&hdr, 0, sizeof(hdr));
			hdr.interface_id = 'S';
			hdr.cmd_len = sizeof(cgc.cmd);
			hdr.dxfer_len = cgc.buflen;
			err = 0;
			switch (cgc.data_direction) {
				case CGC_DATA_UNKNOWN:
					hdr.dxfer_direction = SG_DXFER_UNKNOWN;
					break;
				case CGC_DATA_WRITE:
					hdr.dxfer_direction = SG_DXFER_TO_DEV;
					break;
				case CGC_DATA_READ:
					hdr.dxfer_direction = SG_DXFER_FROM_DEV;
					break;
				case CGC_DATA_NONE:
					hdr.dxfer_direction = SG_DXFER_NONE;
					break;
				default:
					err = -EINVAL;
			}
			if (err)
				break;

			hdr.dxferp = cgc.buffer;
			hdr.sbp = cgc.sense;
			if (hdr.sbp)
				hdr.mx_sb_len = sizeof(struct request_sense);
			hdr.timeout = jiffies_to_msecs(cgc.timeout);
			hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
			hdr.cmd_len = sizeof(cgc.cmd);

			err = sg_io(file, q, bd_disk, &hdr);
			if (err == -EFAULT)
				break;

			if (hdr.status)
				err = -EIO;

			cgc.stat = err;
			cgc.buflen = hdr.resid;
			if (copy_to_user(arg, &cgc, sizeof(cgc)))
				err = -EFAULT;

			break;
		}

		/*
		 * old junk scsi send command ioctl
		 */
		case SCSI_IOCTL_SEND_COMMAND:
			printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
			err = -EINVAL;
			if (!arg)
				break;

			err = sg_scsi_ioctl(file, q, bd_disk, arg);
			break;
		case CDROMCLOSETRAY:
			err = blk_send_start_stop(q, bd_disk, 0x03);
			break;
		case CDROMEJECT:
			err = blk_send_start_stop(q, bd_disk, 0x02);
			break;
		default:
			err = -ENOTTY;
	}

	blk_put_queue(q);
	return err;
}

EXPORT_SYMBOL(scsi_cmd_ioctl);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Copyright (C) 2001 Jens Axboe <axboe@suse.de>
	3	*
	4	* This program is free software; you can redistribute it and/or modify
	5	* it under the terms of the GNU General Public License version 2 as
	6	* published by the Free Software Foundation.
	7	*
	8	* This program is distributed in the hope that it will be useful,
	9	* but WITHOUT ANY WARRANTY; without even the implied warranty of
	10	*
	11	* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
	12	* GNU General Public License for more details.
	13	*
	14	* You should have received a copy of the GNU General Public Licens
	15	* along with this program; if not, write to the Free Software
	16	* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-
	17	*
	18	*/
	19	#include <linux/kernel.h>
	20	#include <linux/errno.h>
	21	#include <linux/string.h>
	22	#include <linux/module.h>
	23	#include <linux/blkdev.h>
c59ede7b	24	#include <linux/capability.h>
1da177e4 LT	25	#include <linux/completion.h>
	26	#include <linux/cdrom.h>
	27	#include <linux/slab.h>
	28	#include <linux/times.h>
	29	#include <asm/uaccess.h>
	30
	31	#include <scsi/scsi.h>
	32	#include <scsi/scsi_ioctl.h>
	33	#include <scsi/scsi_cmnd.h>
	34
	35	/* Command group 3 is reserved and should never be used. */
db4742dd	36	const unsigned char scsi_command_size_tbl[8] =
1da177e4 LT	37	{
	38	6, 10, 10, 12,
	39	16, 12, 10, 10
	40	};
db4742dd	41	EXPORT_SYMBOL(scsi_command_size_tbl);
1da177e4	42
1da177e4 LT	43	#include <scsi/sg.h>
	44
	45	static int sg_get_version(int __user *p)
	46	{
64100099	47	static const int sg_version_num = 30527;
1da177e4 LT	48	return put_user(sg_version_num, p);
	49	}
	50
165125e1	51	static int scsi_get_idlun(struct request_queue q, int __user p)
1da177e4 LT	52	{
	53	return put_user(0, p);
	54	}
	55
165125e1	56	static int scsi_get_bus(struct request_queue q, int __user p)
1da177e4 LT	57	{
	58	return put_user(0, p);
	59	}
	60
165125e1	61	static int sg_get_timeout(struct request_queue *q)
1da177e4 LT	62	{
	63	return q->sg_timeout / (HZ / USER_HZ);
	64	}
	65
165125e1	66	static int sg_set_timeout(struct request_queue q, int __user p)
1da177e4 LT	67	{
	68	int timeout, err = get_user(timeout, p);
	69
	70	if (!err)
	71	q->sg_timeout = timeout * (HZ / USER_HZ);
	72
	73	return err;
	74	}
	75
165125e1	76	static int sg_get_reserved_size(struct request_queue q, int __user p)
1da177e4	77	{
44ec9542 AS	78	unsigned val = min(q->sg_reserved_size, q->max_sectors << 9);
	79
	80	return put_user(val, p);
1da177e4 LT	81	}
1da177e4 LT	82
165125e1	83	static int sg_set_reserved_size(struct request_queue q, int __user p)
1da177e4 LT	84	{
	85	int size, err = get_user(size, p);
	86
	87	if (err)
	88	return err;
	89
	90	if (size < 0)
	91	return -EINVAL;
	92	if (size > (q->max_sectors << 9))
	93	size = q->max_sectors << 9;
	94
	95	q->sg_reserved_size = size;
	96	return 0;
	97	}
	98
	99	/*
	100	* will always return that we are ATAPI even for a real SCSI drive, I'm not
	101	* so sure this is worth doing anything about (why would you care??)
	102	*/
165125e1	103	static int sg_emulated_host(struct request_queue q, int __user p)
1da177e4 LT	104	{
	105	return put_user(1, p);
	106	}
	107
165125e1	108	static int blk_fill_sghdr_rq(struct request_queue q, struct request rq,
0b07de85	109	struct sg_io_hdr hdr, struct file file)
3d6392cf	110	{
3d6392cf JA	111	if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
3d6392cf JA	112	return -EFAULT;
0b07de85	113	if (blk_verify_command(file, rq->cmd))
3d6392cf JA	114	return -EPERM;
	115
	116	/*
	117	* fill in request structure
	118	*/
	119	rq->cmd_len = hdr->cmd_len;
	120	rq->cmd_type = REQ_TYPE_BLOCK_PC;
	121
24bb8fb9	122	rq->timeout = msecs_to_jiffies(hdr->timeout);
3d6392cf JA	123	if (!rq->timeout)
	124	rq->timeout = q->sg_timeout;
	125	if (!rq->timeout)
	126	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
	127
	128	return 0;
	129	}
3d6392cf JA	130
	131	/*
	132	* unmap a request that was previously mapped to this sg_io_hdr. handles
	133	* both sg and non-sg sg_io_hdr.
	134	*/
41e1703b	135	static int blk_unmap_sghdr_rq(struct request rq, struct sg_io_hdr hdr)
3d6392cf	136	{
ac6b91b8	137	blk_rq_unmap_user(rq->bio);
3d6392cf JA	138	blk_put_request(rq);
	139	return 0;
	140	}
3d6392cf	141
41e1703b FT	142	static int blk_complete_sghdr_rq(struct request rq, struct sg_io_hdr hdr,
41e1703b FT	143	struct bio *bio)
3d6392cf JA	144	{
	145	int r, ret = 0;
	146
	147	/*
	148	* fill in all the output members
	149	*/
	150	hdr->status = rq->errors & 0xff;
	151	hdr->masked_status = status_byte(rq->errors);
	152	hdr->msg_status = msg_byte(rq->errors);
	153	hdr->host_status = host_byte(rq->errors);
	154	hdr->driver_status = driver_byte(rq->errors);
	155	hdr->info = 0;
	156	if (hdr->masked_status \|\| hdr->host_status \|\| hdr->driver_status)
	157	hdr->info \|= SG_INFO_CHECK;
7a85f889	158	hdr->resid = rq->data_len;
3d6392cf JA	159	hdr->sb_len_wr = 0;
	160
	161	if (rq->sense_len && hdr->sbp) {
	162	int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
	163
	164	if (!copy_to_user(hdr->sbp, rq->sense, len))
	165	hdr->sb_len_wr = len;
	166	else
	167	ret = -EFAULT;
	168	}
	169
	170	rq->bio = bio;
	171	r = blk_unmap_sghdr_rq(rq, hdr);
	172	if (ret)
	173	r = ret;
	174
	175	return r;
	176	}
3d6392cf	177
165125e1	178	static int sg_io(struct file file, struct request_queue q,
1da177e4 LT	179	struct gendisk bd_disk, struct sg_io_hdr hdr)
1da177e4 LT	180	{
3d6392cf	181	unsigned long start_time;
0b07de85	182	int writing = 0, ret = 0;
1da177e4	183	struct request *rq;
1da177e4	184	char sense[SCSI_SENSE_BUFFERSIZE];
77d172ce	185	struct bio *bio;
1da177e4 LT	186
	187	if (hdr->interface_id != 'S')
	188	return -EINVAL;
	189	if (hdr->cmd_len > BLK_MAX_CDB)
	190	return -EINVAL;
1da177e4	191
defd94b7	192	if (hdr->dxfer_len > (q->max_hw_sectors << 9))
1da177e4 LT	193	return -EIO;
1da177e4 LT	194
f1970baf	195	if (hdr->dxfer_len)
1da177e4 LT	196	switch (hdr->dxfer_direction) {
	197	default:
	198	return -EINVAL;
1da177e4 LT	199	case SG_DXFER_TO_DEV:
	200	writing = 1;
	201	break;
616e8a09	202	case SG_DXFER_TO_FROM_DEV:
1da177e4	203	case SG_DXFER_FROM_DEV:
1da177e4 LT	204	break;
	205	}
	206
dd1cab95 JA	207	rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
	208	if (!rq)
	209	return -ENOMEM;
1da177e4	210
0b07de85	211	if (blk_fill_sghdr_rq(q, rq, hdr, file)) {
3d6392cf JA	212	blk_put_request(rq);
	213	return -EFAULT;
	214	}
1da177e4	215
0e75f906 MC	216	if (hdr->iovec_count) {
	217	const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
	218	struct sg_iovec *iov;
	219
	220	iov = kmalloc(size, GFP_KERNEL);
	221	if (!iov) {
	222	ret = -ENOMEM;
	223	goto out;
	224	}
	225
	226	if (copy_from_user(iov, hdr->dxferp, size)) {
	227	kfree(iov);
	228	ret = -EFAULT;
	229	goto out;
	230	}
	231
	232	ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count,
	233	hdr->dxfer_len);
	234	kfree(iov);
	235	} else if (hdr->dxfer_len)
	236	ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len);
	237
	238	if (ret)
	239	goto out;
	240
77d172ce	241	bio = rq->bio;
3d6392cf JA	242	memset(sense, 0, sizeof(sense));
	243	rq->sense = sense;
	244	rq->sense_len = 0;
01840f9c JA	245	rq->retries = 0;
01840f9c JA	246
1da177e4 LT	247	start_time = jiffies;
	248
	249	/* ignore return value. All information is passed back to caller
	250	* (if he doesn't check that is his problem).
	251	* N.B. a non-zero SCSI status is _not_ necessarily an error.
	252	*/
994ca9a1	253	blk_execute_rq(q, bd_disk, rq, 0);
1da177e4	254
24bb8fb9	255	hdr->duration = jiffies_to_msecs(jiffies - start_time);
1da177e4	256
3d6392cf	257	return blk_complete_sghdr_rq(rq, hdr, bio);
dd1cab95 JA	258	out:
	259	blk_put_request(rq);
	260	return ret;
1da177e4 LT	261	}
1da177e4 LT	262
21b2f0c8 CH	263	/**
	264	* sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
	265	* @file: file this ioctl operates on (optional)
	266	* @q: request queue to send scsi commands down
	267	* @disk: gendisk to operate on (option)
	268	* @sic: userspace structure describing the command to perform
	269	*
	270	* Send down the scsi command described by @sic to the device below
	271	* the request queue @q. If @file is non-NULL it's used to perform
	272	* fine-grained permission checks that allow users to send down
	273	* non-destructive SCSI commands. If the caller has a struct gendisk
	274	* available it should be passed in as @disk to allow the low level
	275	* driver to use the information contained in it. A non-NULL @disk
	276	* is only allowed if the caller knows that the low level driver doesn't
	277	* need it (e.g. in the scsi subsystem).
	278	*
	279	* Notes:
	280	* - This interface is deprecated - users should use the SG_IO
	281	* interface instead, as this is a more flexible approach to
	282	* performing SCSI commands on a device.
	283	* - The SCSI command length is determined by examining the 1st byte
	284	* of the given command. There is no way to override this.
	285	* - Data transfers are limited to PAGE_SIZE
	286	* - The length (x + y) must be at least OMAX_SB_LEN bytes long to
	287	* accommodate the sense buffer when an error occurs.
	288	* The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
	289	* old code will not be surprised.
	290	* - If a Unix error occurs (e.g. ENOMEM) then the user will receive
	291	* a negative return and the Unix error code in 'errno'.
	292	* If the SCSI command succeeds then 0 is returned.
	293	* Positive numbers returned are the compacted SCSI error codes (4
	294	* bytes in one int) where the lowest byte is the SCSI status.
	295	*/
1da177e4	296	#define OMAX_SB_LEN 16 /* For backward compatibility */
21b2f0c8 CH	297	int sg_scsi_ioctl(struct file file, struct request_queue q,
21b2f0c8 CH	298	struct gendisk disk, struct scsi_ioctl_command __user sic)
1da177e4 LT	299	{
	300	struct request *rq;
	301	int err;
	302	unsigned int in_len, out_len, bytes, opcode, cmdlen;
	303	char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
	304
21b2f0c8 CH	305	if (!sic)
	306	return -EINVAL;
	307
1da177e4 LT	308	/*
	309	* get in an out lengths, verify they don't exceed a page worth of data
	310	*/
	311	if (get_user(in_len, &sic->inlen))
	312	return -EFAULT;
	313	if (get_user(out_len, &sic->outlen))
	314	return -EFAULT;
	315	if (in_len > PAGE_SIZE \|\| out_len > PAGE_SIZE)
	316	return -EINVAL;
	317	if (get_user(opcode, sic->data))
	318	return -EFAULT;
	319
	320	bytes = max(in_len, out_len);
	321	if (bytes) {
dd00cc48	322	buffer = kzalloc(bytes, q->bounce_gfp \| GFP_USER\| __GFP_NOWARN);
1da177e4 LT	323	if (!buffer)
	324	return -ENOMEM;
	325
1da177e4 LT	326	}
	327
	328	rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
	329
	330	cmdlen = COMMAND_SIZE(opcode);
	331
	332	/*
	333	* get command and data to send to device, if any
	334	*/
	335	err = -EFAULT;
	336	rq->cmd_len = cmdlen;
	337	if (copy_from_user(rq->cmd, sic->data, cmdlen))
	338	goto error;
	339
21b2f0c8	340	if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
1da177e4 LT	341	goto error;
1da177e4 LT	342
0b07de85	343	err = blk_verify_command(file, rq->cmd);
1da177e4 LT	344	if (err)
	345	goto error;
	346
21b2f0c8 CH	347	/* default. possible overriden later */
	348	rq->retries = 5;
	349
1da177e4	350	switch (opcode) {
21b2f0c8 CH	351	case SEND_DIAGNOSTIC:
	352	case FORMAT_UNIT:
	353	rq->timeout = FORMAT_UNIT_TIMEOUT;
	354	rq->retries = 1;
	355	break;
	356	case START_STOP:
	357	rq->timeout = START_STOP_TIMEOUT;
	358	break;
	359	case MOVE_MEDIUM:
	360	rq->timeout = MOVE_MEDIUM_TIMEOUT;
	361	break;
	362	case READ_ELEMENT_STATUS:
	363	rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
	364	break;
	365	case READ_DEFECT_DATA:
	366	rq->timeout = READ_DEFECT_DATA_TIMEOUT;
	367	rq->retries = 1;
	368	break;
	369	default:
3d6392cf	370	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
21b2f0c8 CH	371	break;
	372	}
	373
	374	if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
	375	err = DRIVER_ERROR << 24;
	376	goto out;
1da177e4 LT	377	}
	378
	379	memset(sense, 0, sizeof(sense));
	380	rq->sense = sense;
	381	rq->sense_len = 0;
4aff5e23	382	rq->cmd_type = REQ_TYPE_BLOCK_PC;
1da177e4	383
21b2f0c8 CH	384	blk_execute_rq(q, disk, rq, 0);
	385
	386	out:
1da177e4 LT	387	err = rq->errors & 0xff; /* only 8 bit SCSI status */
	388	if (err) {
	389	if (rq->sense_len && rq->sense) {
	390	bytes = (OMAX_SB_LEN > rq->sense_len) ?
	391	rq->sense_len : OMAX_SB_LEN;
	392	if (copy_to_user(sic->data, rq->sense, bytes))
	393	err = -EFAULT;
	394	}
	395	} else {
	396	if (copy_to_user(sic->data, buffer, out_len))
	397	err = -EFAULT;
	398	}
	399
	400	error:
	401	kfree(buffer);
	402	blk_put_request(rq);
	403	return err;
	404	}
21b2f0c8	405	EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
f98d2dfd BC	406
f98d2dfd BC	407	/* Send basic block requests */
165125e1 JA	408	static int __blk_send_generic(struct request_queue q, struct gendisk bd_disk,
165125e1 JA	409	int cmd, int data)
f98d2dfd BC	410	{
	411	struct request *rq;
	412	int err;
	413
	414	rq = blk_get_request(q, WRITE, __GFP_WAIT);
4aff5e23	415	rq->cmd_type = REQ_TYPE_BLOCK_PC;
f98d2dfd BC	416	rq->data = NULL;
f98d2dfd BC	417	rq->data_len = 0;
7a85f889	418	rq->extra_len = 0;
3d6392cf	419	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
f98d2dfd BC	420	rq->cmd[0] = cmd;
	421	rq->cmd[4] = data;
	422	rq->cmd_len = 6;
	423	err = blk_execute_rq(q, bd_disk, rq, 0);
	424	blk_put_request(rq);
	425
	426	return err;
	427	}
	428
165125e1 JA	429	static inline int blk_send_start_stop(struct request_queue *q,
165125e1 JA	430	struct gendisk *bd_disk, int data)
f98d2dfd BC	431	{
	432	return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
	433	}
	434
45e79a3a FT	435	int scsi_cmd_ioctl(struct file file, struct request_queue q,
45e79a3a FT	436	struct gendisk bd_disk, unsigned int cmd, void __user arg)
1da177e4	437	{
f98d2dfd	438	int err;
1da177e4	439
45e79a3a	440	if (!q \|\| blk_get_queue(q))
1da177e4 LT	441	return -ENXIO;
	442
	443	switch (cmd) {
	444	/*
	445	* new sgv3 interface
	446	*/
	447	case SG_GET_VERSION_NUM:
	448	err = sg_get_version(arg);
	449	break;
	450	case SCSI_IOCTL_GET_IDLUN:
	451	err = scsi_get_idlun(q, arg);
	452	break;
	453	case SCSI_IOCTL_GET_BUS_NUMBER:
	454	err = scsi_get_bus(q, arg);
	455	break;
	456	case SG_SET_TIMEOUT:
	457	err = sg_set_timeout(q, arg);
	458	break;
	459	case SG_GET_TIMEOUT:
	460	err = sg_get_timeout(q);
	461	break;
	462	case SG_GET_RESERVED_SIZE:
	463	err = sg_get_reserved_size(q, arg);
	464	break;
	465	case SG_SET_RESERVED_SIZE:
	466	err = sg_set_reserved_size(q, arg);
	467	break;
	468	case SG_EMULATED_HOST:
	469	err = sg_emulated_host(q, arg);
	470	break;
	471	case SG_IO: {
	472	struct sg_io_hdr hdr;
	473
	474	err = -EFAULT;
	475	if (copy_from_user(&hdr, arg, sizeof(hdr)))
	476	break;
	477	err = sg_io(file, q, bd_disk, &hdr);
	478	if (err == -EFAULT)
	479	break;
	480
	481	if (copy_to_user(arg, &hdr, sizeof(hdr)))
	482	err = -EFAULT;
	483	break;
	484	}
	485	case CDROM_SEND_PACKET: {
	486	struct cdrom_generic_command cgc;
	487	struct sg_io_hdr hdr;
	488
	489	err = -EFAULT;
	490	if (copy_from_user(&cgc, arg, sizeof(cgc)))
	491	break;
	492	cgc.timeout = clock_t_to_jiffies(cgc.timeout);
	493	memset(&hdr, 0, sizeof(hdr));
	494	hdr.interface_id = 'S';
	495	hdr.cmd_len = sizeof(cgc.cmd);
	496	hdr.dxfer_len = cgc.buflen;
	497	err = 0;
	498	switch (cgc.data_direction) {
	499	case CGC_DATA_UNKNOWN:
	500	hdr.dxfer_direction = SG_DXFER_UNKNOWN;
	501	break;
	502	case CGC_DATA_WRITE:
	503	hdr.dxfer_direction = SG_DXFER_TO_DEV;
	504	break;
505	case CGC_DATA_READ:
506	hdr.dxfer_direction = SG_DXFER_FROM_DEV;
507	break;
508	case CGC_DATA_NONE:
509	hdr.dxfer_direction = SG_DXFER_NONE;
510	break;
511	default:
512	err = -EINVAL;
513	}
514	if (err)
515	break;
516
517	hdr.dxferp = cgc.buffer;
518	hdr.sbp = cgc.sense;
519	if (hdr.sbp)
520	hdr.mx_sb_len = sizeof(struct request_sense);
ad337591	521	hdr.timeout = jiffies_to_msecs(cgc.timeout);
1da177e4 LT	522	hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
	523	hdr.cmd_len = sizeof(cgc.cmd);
	524
	525	err = sg_io(file, q, bd_disk, &hdr);
	526	if (err == -EFAULT)
	527	break;
	528
	529	if (hdr.status)
	530	err = -EIO;
	531
	532	cgc.stat = err;
	533	cgc.buflen = hdr.resid;
	534	if (copy_to_user(arg, &cgc, sizeof(cgc)))
	535	err = -EFAULT;
	536
	537	break;
	538	}
	539
	540	/*
	541	* old junk scsi send command ioctl
	542	*/
	543	case SCSI_IOCTL_SEND_COMMAND:
	544	printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
	545	err = -EINVAL;
	546	if (!arg)
	547	break;
	548
	549	err = sg_scsi_ioctl(file, q, bd_disk, arg);
	550	break;
	551	case CDROMCLOSETRAY:
f98d2dfd BC	552	err = blk_send_start_stop(q, bd_disk, 0x03);
f98d2dfd BC	553	break;
1da177e4	554	case CDROMEJECT:
f98d2dfd	555	err = blk_send_start_stop(q, bd_disk, 0x02);
1da177e4 LT	556	break;
	557	default:
	558	err = -ENOTTY;
	559	}
	560
	561	blk_put_queue(q);
	562	return err;
	563	}
	564
	565	EXPORT_SYMBOL(scsi_cmd_ioctl);