[linux-2.6-block.git] / drivers / scsi / scsi_ioctl.c

/*
 * Changes:
 * Arnaldo Carvalho de Melo <acme@conectiva.com.br> 08/23/2000
 * - get rid of some verify_areas and use __copy*user and __get/put_user
 *   for the ones that remain
 */
#include <linux/module.h>
#include <linux/blkdev.h>
#include <linux/interrupt.h>
#include <linux/errno.h>
#include <linux/kernel.h>
#include <linux/sched.h>
#include <linux/mm.h>
#include <linux/string.h>
#include <linux/uaccess.h>

#include <scsi/scsi.h>
#include <scsi/scsi_cmnd.h>
#include <scsi/scsi_device.h>
#include <scsi/scsi_eh.h>
#include <scsi/scsi_host.h>
#include <scsi/scsi_ioctl.h>
#include <scsi/sg.h>
#include <scsi/scsi_dbg.h>

#include "scsi_logging.h"

#define NORMAL_RETRIES			5
#define IOCTL_NORMAL_TIMEOUT			(10 * HZ)

#define MAX_BUF PAGE_SIZE

/**
 * ioctl_probe  --  return host identification
 * @host:	host to identify
 * @buffer:	userspace buffer for identification
 *
 * Return an identifying string at @buffer, if @buffer is non-NULL, filling
 * to the length stored at * (int *) @buffer.
 */
static int ioctl_probe(struct Scsi_Host *host, void __user *buffer)
{
	unsigned int len, slen;
	const char *string;

	if (buffer) {
		if (get_user(len, (unsigned int __user *) buffer))
			return -EFAULT;

		if (host->hostt->info)
			string = host->hostt->info(host);
		else
			string = host->hostt->name;
		if (string) {
			slen = strlen(string);
			if (len > slen)
				len = slen + 1;
			if (copy_to_user(buffer, string, len))
				return -EFAULT;
		}
	}
	return 1;
}

/*

 * The SCSI_IOCTL_SEND_COMMAND ioctl sends a command out to the SCSI host.
 * The IOCTL_NORMAL_TIMEOUT and NORMAL_RETRIES  variables are used.  
 * 
 * dev is the SCSI device struct ptr, *(int *) arg is the length of the
 * input data, if any, not including the command string & counts, 
 * *((int *)arg + 1) is the output buffer size in bytes.
 * 
 * *(char *) ((int *) arg)[2] the actual command byte.   
 * 
 * Note that if more than MAX_BUF bytes are requested to be transferred,
 * the ioctl will fail with error EINVAL.
 * 
 * This size *does not* include the initial lengths that were passed.
 * 
 * The SCSI command is read from the memory location immediately after the
 * length words, and the input data is right after the command.  The SCSI
 * routines know the command size based on the opcode decode.  
 * 
 * The output area is then filled in starting from the command byte. 
 */

static int ioctl_internal_command(struct scsi_device *sdev, char *cmd,
				  int timeout, int retries)
{
	int result;
	struct scsi_sense_hdr sshdr;

	SCSI_LOG_IOCTL(1, sdev_printk(KERN_INFO, sdev,
				      "Trying ioctl with scsi command %d\n", *cmd));

	result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0,
				  &sshdr, timeout, retries, NULL);

	SCSI_LOG_IOCTL(2, sdev_printk(KERN_INFO, sdev,
				      "Ioctl returned  0x%x\n", result));

	if (driver_byte(result) == DRIVER_SENSE &&
	    scsi_sense_valid(&sshdr)) {
		switch (sshdr.sense_key) {
		case ILLEGAL_REQUEST:
			if (cmd[0] == ALLOW_MEDIUM_REMOVAL)
				sdev->lockable = 0;
			else
				sdev_printk(KERN_INFO, sdev,
					    "ioctl_internal_command: "
					    "ILLEGAL REQUEST "
					    "asc=0x%x ascq=0x%x\n",
					    sshdr.asc, sshdr.ascq);
			break;
		case NOT_READY:	/* This happens if there is no disc in drive */
			if (sdev->removable)
				break;
			/* FALLTHROUGH */
		case UNIT_ATTENTION:
			if (sdev->removable) {
				sdev->changed = 1;
				result = 0;	/* This is no longer considered an error */
				break;
			}
			/* FALLTHROUGH -- for non-removable media */
		default:
			sdev_printk(KERN_INFO, sdev,
				    "ioctl_internal_command return code = %x\n",
				    result);
			scsi_print_sense_hdr(sdev, NULL, &sshdr);
			break;
		}
	}

	SCSI_LOG_IOCTL(2, sdev_printk(KERN_INFO, sdev,
				      "IOCTL Releasing command\n"));
	return result;
}

int scsi_set_medium_removal(struct scsi_device *sdev, char state)
{
	char scsi_cmd[MAX_COMMAND_SIZE];
	int ret;

	if (!sdev->removable || !sdev->lockable)
	       return 0;

	scsi_cmd[0] = ALLOW_MEDIUM_REMOVAL;
	scsi_cmd[1] = 0;
	scsi_cmd[2] = 0;
	scsi_cmd[3] = 0;
	scsi_cmd[4] = state;
	scsi_cmd[5] = 0;

	ret = ioctl_internal_command(sdev, scsi_cmd,
			IOCTL_NORMAL_TIMEOUT, NORMAL_RETRIES);
	if (ret == 0)
		sdev->locked = (state == SCSI_REMOVAL_PREVENT);
	return ret;
}
EXPORT_SYMBOL(scsi_set_medium_removal);

/*
 * The scsi_ioctl_get_pci() function places into arg the value
 * pci_dev::slot_name (8 characters) for the PCI device (if any).
 * Returns: 0 on success
 *          -ENXIO if there isn't a PCI device pointer
 *                 (could be because the SCSI driver hasn't been
 *                  updated yet, or because it isn't a SCSI
 *                  device)
 *          any copy_to_user() error on failure there
 */
static int scsi_ioctl_get_pci(struct scsi_device *sdev, void __user *arg)
{
	struct device *dev = scsi_get_device(sdev->host);
	const char *name;

        if (!dev)
		return -ENXIO;

	name = dev_name(dev);

	/* compatibility with old ioctl which only returned
	 * 20 characters */
        return copy_to_user(arg, name, min(strlen(name), (size_t)20))
		? -EFAULT: 0;
}


/**
 * scsi_ioctl - Dispatch ioctl to scsi device
 * @sdev: scsi device receiving ioctl
 * @cmd: which ioctl is it
 * @arg: data associated with ioctl
 *
 * Description: The scsi_ioctl() function differs from most ioctls in that it
 * does not take a major/minor number as the dev field.  Rather, it takes
 * a pointer to a &struct scsi_device.
 */
int scsi_ioctl(struct scsi_device *sdev, int cmd, void __user *arg)
{
	char scsi_cmd[MAX_COMMAND_SIZE];
	struct scsi_sense_hdr sense_hdr;

	/* Check for deprecated ioctls ... all the ioctls which don't
	 * follow the new unique numbering scheme are deprecated */
	switch (cmd) {
	case SCSI_IOCTL_SEND_COMMAND:
	case SCSI_IOCTL_TEST_UNIT_READY:
	case SCSI_IOCTL_BENCHMARK_COMMAND:
	case SCSI_IOCTL_SYNC:
	case SCSI_IOCTL_START_UNIT:
	case SCSI_IOCTL_STOP_UNIT:
		printk(KERN_WARNING "program %s is using a deprecated SCSI "
		       "ioctl, please convert it to SG_IO\n", current->comm);
		break;
	default:
		break;
	}

	switch (cmd) {
	case SCSI_IOCTL_GET_IDLUN:
		if (!access_ok(arg, sizeof(struct scsi_idlun)))
			return -EFAULT;

		__put_user((sdev->id & 0xff)
			 + ((sdev->lun & 0xff) << 8)
			 + ((sdev->channel & 0xff) << 16)
			 + ((sdev->host->host_no & 0xff) << 24),
			 &((struct scsi_idlun __user *)arg)->dev_id);
		__put_user(sdev->host->unique_id,
			 &((struct scsi_idlun __user *)arg)->host_unique_id);
		return 0;
	case SCSI_IOCTL_GET_BUS_NUMBER:
		return put_user(sdev->host->host_no, (int __user *)arg);
	case SCSI_IOCTL_PROBE_HOST:
		return ioctl_probe(sdev->host, arg);
	case SCSI_IOCTL_SEND_COMMAND:
		if (!capable(CAP_SYS_ADMIN) || !capable(CAP_SYS_RAWIO))
			return -EACCES;
		return sg_scsi_ioctl(sdev->request_queue, NULL, 0, arg);
	case SCSI_IOCTL_DOORLOCK:
		return scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
	case SCSI_IOCTL_DOORUNLOCK:
		return scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
	case SCSI_IOCTL_TEST_UNIT_READY:
		return scsi_test_unit_ready(sdev, IOCTL_NORMAL_TIMEOUT,
					    NORMAL_RETRIES, &sense_hdr);
	case SCSI_IOCTL_START_UNIT:
		scsi_cmd[0] = START_STOP;
		scsi_cmd[1] = 0;
		scsi_cmd[2] = scsi_cmd[3] = scsi_cmd[5] = 0;
		scsi_cmd[4] = 1;
		return ioctl_internal_command(sdev, scsi_cmd,
				     START_STOP_TIMEOUT, NORMAL_RETRIES);
	case SCSI_IOCTL_STOP_UNIT:
		scsi_cmd[0] = START_STOP;
		scsi_cmd[1] = 0;
		scsi_cmd[2] = scsi_cmd[3] = scsi_cmd[5] = 0;
		scsi_cmd[4] = 0;
		return ioctl_internal_command(sdev, scsi_cmd,
				     START_STOP_TIMEOUT, NORMAL_RETRIES);
        case SCSI_IOCTL_GET_PCI:
                return scsi_ioctl_get_pci(sdev, arg);
	case SG_SCSI_RESET:
		return scsi_ioctl_reset(sdev, arg);
	default:
		if (sdev->host->hostt->ioctl)
			return sdev->host->hostt->ioctl(sdev, cmd, arg);
	}
	return -EINVAL;
}
EXPORT_SYMBOL(scsi_ioctl);

/*
 * We can process a reset even when a device isn't fully operable.
 */
int scsi_ioctl_block_when_processing_errors(struct scsi_device *sdev, int cmd,
		bool ndelay)
{
	if (cmd == SG_SCSI_RESET && ndelay) {
		if (scsi_host_in_recovery(sdev->host))
			return -EAGAIN;
	} else {
		if (!scsi_block_when_processing_errors(sdev))
			return -ENODEV;
	}

	return 0;
}
EXPORT_SYMBOL_GPL(scsi_ioctl_block_when_processing_errors);
Commit	Line	Data
1da177e4 LT	1	/*
	2	* Changes:
	3	* Arnaldo Carvalho de Melo <acme@conectiva.com.br> 08/23/2000
	4	* - get rid of some verify_areas and use __copy*user and __get/put_user
	5	* for the ones that remain
	6	*/
	7	#include <linux/module.h>
	8	#include <linux/blkdev.h>
	9	#include <linux/interrupt.h>
	10	#include <linux/errno.h>
	11	#include <linux/kernel.h>
	12	#include <linux/sched.h>
	13	#include <linux/mm.h>
	14	#include <linux/string.h>
7c0f6ba6	15	#include <linux/uaccess.h>
1da177e4 LT	16
1da177e4 LT	17	#include <scsi/scsi.h>
beb40487	18	#include <scsi/scsi_cmnd.h>
1da177e4 LT	19	#include <scsi/scsi_device.h>
	20	#include <scsi/scsi_eh.h>
	21	#include <scsi/scsi_host.h>
	22	#include <scsi/scsi_ioctl.h>
1da177e4 LT	23	#include <scsi/sg.h>
	24	#include <scsi/scsi_dbg.h>
	25
	26	#include "scsi_logging.h"
	27
	28	#define NORMAL_RETRIES 5
	29	#define IOCTL_NORMAL_TIMEOUT (10 * HZ)
1da177e4 LT	30
	31	#define MAX_BUF PAGE_SIZE
	32
32993523 CH	33	/**
	34	* ioctl_probe -- return host identification
	35	* @host: host to identify
	36	* @buffer: userspace buffer for identification
	37	*
	38	* Return an identifying string at @buffer, if @buffer is non-NULL, filling
	39	* to the length stored at * (int *) @buffer.
1da177e4	40	*/
1da177e4 LT	41	static int ioctl_probe(struct Scsi_Host host, void __user buffer)
	42	{
	43	unsigned int len, slen;
	44	const char *string;
1da177e4	45
32993523	46	if (buffer) {
1da177e4 LT	47	if (get_user(len, (unsigned int __user *) buffer))
	48	return -EFAULT;
	49
	50	if (host->hostt->info)
	51	string = host->hostt->info(host);
	52	else
	53	string = host->hostt->name;
	54	if (string) {
	55	slen = strlen(string);
	56	if (len > slen)
	57	len = slen + 1;
	58	if (copy_to_user(buffer, string, len))
	59	return -EFAULT;
	60	}
	61	}
32993523	62	return 1;
1da177e4 LT	63	}
	64
	65	/*
	66
	67	* The SCSI_IOCTL_SEND_COMMAND ioctl sends a command out to the SCSI host.
	68	* The IOCTL_NORMAL_TIMEOUT and NORMAL_RETRIES variables are used.
	69	*
	70	* dev is the SCSI device struct ptr, (int ) arg is the length of the
	71	* input data, if any, not including the command string & counts,
	72	* ((int )arg + 1) is the output buffer size in bytes.
	73	*
	74	* (char ) ((int *) arg)[2] the actual command byte.
	75	*
	76	* Note that if more than MAX_BUF bytes are requested to be transferred,
	77	* the ioctl will fail with error EINVAL.
	78	*
	79	* This size does not include the initial lengths that were passed.
	80	*
	81	* The SCSI command is read from the memory location immediately after the
	82	* length words, and the input data is right after the command. The SCSI
	83	* routines know the command size based on the opcode decode.
	84	*
	85	* The output area is then filled in starting from the command byte.
	86	*/
	87
	88	static int ioctl_internal_command(struct scsi_device sdev, char cmd,
	89	int timeout, int retries)
	90	{
1da177e4 LT	91	int result;
	92	struct scsi_sense_hdr sshdr;
	93
e5f73ce3 HR	94	SCSI_LOG_IOCTL(1, sdev_printk(KERN_INFO, sdev,
e5f73ce3 HR	95	"Trying ioctl with scsi command %d\n", *cmd));
1da177e4	96
1cf72699	97	result = scsi_execute_req(sdev, cmd, DMA_NONE, NULL, 0,
f4f4e47e	98	&sshdr, timeout, retries, NULL);
1da177e4	99
e5f73ce3 HR	100	SCSI_LOG_IOCTL(2, sdev_printk(KERN_INFO, sdev,
e5f73ce3 HR	101	"Ioctl returned 0x%x\n", result));
1da177e4	102
c65be1a6 JT	103	if (driver_byte(result) == DRIVER_SENSE &&
c65be1a6 JT	104	scsi_sense_valid(&sshdr)) {
1da177e4 LT	105	switch (sshdr.sense_key) {
	106	case ILLEGAL_REQUEST:
	107	if (cmd[0] == ALLOW_MEDIUM_REMOVAL)
	108	sdev->lockable = 0;
	109	else
e5f73ce3 HR	110	sdev_printk(KERN_INFO, sdev,
	111	"ioctl_internal_command: "
	112	"ILLEGAL REQUEST "
	113	"asc=0x%x ascq=0x%x\n",
	114	sshdr.asc, sshdr.ascq);
1da177e4 LT	115	break;
1da177e4 LT	116	case NOT_READY: /* This happens if there is no disc in drive */
a75ad3c2	117	if (sdev->removable)
1da177e4	118	break;
3bf2ff67	119	/* FALLTHROUGH */
1da177e4 LT	120	case UNIT_ATTENTION:
	121	if (sdev->removable) {
	122	sdev->changed = 1;
1cf72699	123	result = 0; /* This is no longer considered an error */
1da177e4 LT	124	break;
1da177e4 LT	125	}
3bf2ff67 BVA	126	/* FALLTHROUGH -- for non-removable media */
3bf2ff67 BVA	127	default:
9ccfc756 JB	128	sdev_printk(KERN_INFO, sdev,
	129	"ioctl_internal_command return code = %x\n",
	130	result);
d811b848	131	scsi_print_sense_hdr(sdev, NULL, &sshdr);
1da177e4 LT	132	break;
	133	}
	134	}
	135
e5f73ce3 HR	136	SCSI_LOG_IOCTL(2, sdev_printk(KERN_INFO, sdev,
e5f73ce3 HR	137	"IOCTL Releasing command\n"));
1da177e4 LT	138	return result;
	139	}
	140
	141	int scsi_set_medium_removal(struct scsi_device *sdev, char state)
	142	{
	143	char scsi_cmd[MAX_COMMAND_SIZE];
	144	int ret;
	145
	146	if (!sdev->removable \|\| !sdev->lockable)
	147	return 0;
	148
	149	scsi_cmd[0] = ALLOW_MEDIUM_REMOVAL;
	150	scsi_cmd[1] = 0;
	151	scsi_cmd[2] = 0;
	152	scsi_cmd[3] = 0;
	153	scsi_cmd[4] = state;
	154	scsi_cmd[5] = 0;
	155
	156	ret = ioctl_internal_command(sdev, scsi_cmd,
	157	IOCTL_NORMAL_TIMEOUT, NORMAL_RETRIES);
	158	if (ret == 0)
	159	sdev->locked = (state == SCSI_REMOVAL_PREVENT);
	160	return ret;
	161	}
	162	EXPORT_SYMBOL(scsi_set_medium_removal);
	163
1da177e4 LT	164	/*
	165	* The scsi_ioctl_get_pci() function places into arg the value
	166	* pci_dev::slot_name (8 characters) for the PCI device (if any).
	167	* Returns: 0 on success
	168	* -ENXIO if there isn't a PCI device pointer
	169	* (could be because the SCSI driver hasn't been
	170	* updated yet, or because it isn't a SCSI
	171	* device)
	172	* any copy_to_user() error on failure there
	173	*/
	174	static int scsi_ioctl_get_pci(struct scsi_device sdev, void __user arg)
	175	{
	176	struct device *dev = scsi_get_device(sdev->host);
71610f55	177	const char *name;
1da177e4 LT	178
	179	if (!dev)
	180	return -ENXIO;
71610f55 KS	181
	182	name = dev_name(dev);
	183
	184	/* compatibility with old ioctl which only returned
	185	* 20 characters */
	186	return copy_to_user(arg, name, min(strlen(name), (size_t)20))
	187	? -EFAULT: 0;
1da177e4 LT	188	}
	189
	190
eb44820c RL	191	/**
	192	* scsi_ioctl - Dispatch ioctl to scsi device
	193	* @sdev: scsi device receiving ioctl
	194	* @cmd: which ioctl is it
	195	* @arg: data associated with ioctl
	196	*
	197	* Description: The scsi_ioctl() function differs from most ioctls in that it
	198	* does not take a major/minor number as the dev field. Rather, it takes
	199	* a pointer to a &struct scsi_device.
1da177e4 LT	200	*/
	201	int scsi_ioctl(struct scsi_device sdev, int cmd, void __user arg)
	202	{
	203	char scsi_cmd[MAX_COMMAND_SIZE];
74a78ebd	204	struct scsi_sense_hdr sense_hdr;
1da177e4	205
1da177e4 LT	206	/* Check for deprecated ioctls ... all the ioctls which don't
	207	* follow the new unique numbering scheme are deprecated */
	208	switch (cmd) {
	209	case SCSI_IOCTL_SEND_COMMAND:
	210	case SCSI_IOCTL_TEST_UNIT_READY:
	211	case SCSI_IOCTL_BENCHMARK_COMMAND:
	212	case SCSI_IOCTL_SYNC:
	213	case SCSI_IOCTL_START_UNIT:
	214	case SCSI_IOCTL_STOP_UNIT:
	215	printk(KERN_WARNING "program %s is using a deprecated SCSI "
	216	"ioctl, please convert it to SG_IO\n", current->comm);
	217	break;
	218	default:
	219	break;
	220	}
	221
	222	switch (cmd) {
	223	case SCSI_IOCTL_GET_IDLUN:
96d4f267	224	if (!access_ok(arg, sizeof(struct scsi_idlun)))
1da177e4 LT	225	return -EFAULT;
	226
	227	__put_user((sdev->id & 0xff)
	228	+ ((sdev->lun & 0xff) << 8)
	229	+ ((sdev->channel & 0xff) << 16)
	230	+ ((sdev->host->host_no & 0xff) << 24),
	231	&((struct scsi_idlun __user *)arg)->dev_id);
	232	__put_user(sdev->host->unique_id,
	233	&((struct scsi_idlun __user *)arg)->host_unique_id);
	234	return 0;
	235	case SCSI_IOCTL_GET_BUS_NUMBER:
	236	return put_user(sdev->host->host_no, (int __user *)arg);
	237	case SCSI_IOCTL_PROBE_HOST:
	238	return ioctl_probe(sdev->host, arg);
	239	case SCSI_IOCTL_SEND_COMMAND:
	240	if (!capable(CAP_SYS_ADMIN) \|\| !capable(CAP_SYS_RAWIO))
	241	return -EACCES;
e915e872	242	return sg_scsi_ioctl(sdev->request_queue, NULL, 0, arg);
1da177e4 LT	243	case SCSI_IOCTL_DOORLOCK:
	244	return scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
	245	case SCSI_IOCTL_DOORUNLOCK:
	246	return scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
	247	case SCSI_IOCTL_TEST_UNIT_READY:
	248	return scsi_test_unit_ready(sdev, IOCTL_NORMAL_TIMEOUT,
74a78ebd	249	NORMAL_RETRIES, &sense_hdr);
1da177e4 LT	250	case SCSI_IOCTL_START_UNIT:
	251	scsi_cmd[0] = START_STOP;
	252	scsi_cmd[1] = 0;
	253	scsi_cmd[2] = scsi_cmd[3] = scsi_cmd[5] = 0;
	254	scsi_cmd[4] = 1;
	255	return ioctl_internal_command(sdev, scsi_cmd,
	256	START_STOP_TIMEOUT, NORMAL_RETRIES);
	257	case SCSI_IOCTL_STOP_UNIT:
	258	scsi_cmd[0] = START_STOP;
	259	scsi_cmd[1] = 0;
	260	scsi_cmd[2] = scsi_cmd[3] = scsi_cmd[5] = 0;
	261	scsi_cmd[4] = 0;
	262	return ioctl_internal_command(sdev, scsi_cmd,
	263	START_STOP_TIMEOUT, NORMAL_RETRIES);
	264	case SCSI_IOCTL_GET_PCI:
	265	return scsi_ioctl_get_pci(sdev, arg);
906d15fb CH	266	case SG_SCSI_RESET:
906d15fb CH	267	return scsi_ioctl_reset(sdev, arg);
1da177e4 LT	268	default:
	269	if (sdev->host->hostt->ioctl)
	270	return sdev->host->hostt->ioctl(sdev, cmd, arg);
	271	}
	272	return -EINVAL;
	273	}
	274	EXPORT_SYMBOL(scsi_ioctl);
	275
906d15fb CH	276	/*
906d15fb CH	277	* We can process a reset even when a device isn't fully operable.
1da177e4	278	*/
906d15fb CH	279	int scsi_ioctl_block_when_processing_errors(struct scsi_device *sdev, int cmd,
906d15fb CH	280	bool ndelay)
1da177e4	281	{
906d15fb	282	if (cmd == SG_SCSI_RESET && ndelay) {
939647ee	283	if (scsi_host_in_recovery(sdev->host))
e9afccc5	284	return -EAGAIN;
906d15fb CH	285	} else {
	286	if (!scsi_block_when_processing_errors(sdev))
	287	return -ENODEV;
1da177e4	288	}
906d15fb CH	289
906d15fb CH	290	return 0;
1da177e4	291	}
906d15fb	292	EXPORT_SYMBOL_GPL(scsi_ioctl_block_when_processing_errors);