Linux Audio

Check our new training course

Loading...
v4.17
 
  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>
 24#include <linux/capability.h>
 25#include <linux/completion.h>
 26#include <linux/cdrom.h>
 27#include <linux/ratelimit.h>
 28#include <linux/slab.h>
 29#include <linux/times.h>
 30#include <linux/uio.h>
 31#include <linux/uaccess.h>
 32
 33#include <scsi/scsi.h>
 34#include <scsi/scsi_ioctl.h>
 35#include <scsi/scsi_cmnd.h>
 
 36
 37struct blk_cmd_filter {
 38	unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
 39	unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
 40};
 41
 42static struct blk_cmd_filter blk_default_cmd_filter;
 43
 44/* Command group 3 is reserved and should never be used.  */
 45const unsigned char scsi_command_size_tbl[8] =
 46{
 47	6, 10, 10, 12,
 48	16, 12, 10, 10
 49};
 50EXPORT_SYMBOL(scsi_command_size_tbl);
 51
 52#include <scsi/sg.h>
 53
 54static int sg_get_version(int __user *p)
 55{
 56	static const int sg_version_num = 30527;
 57	return put_user(sg_version_num, p);
 58}
 59
 60static int scsi_get_idlun(struct request_queue *q, int __user *p)
 61{
 62	return put_user(0, p);
 63}
 64
 65static int scsi_get_bus(struct request_queue *q, int __user *p)
 66{
 67	return put_user(0, p);
 68}
 69
 70static int sg_get_timeout(struct request_queue *q)
 71{
 72	return jiffies_to_clock_t(q->sg_timeout);
 73}
 74
 75static int sg_set_timeout(struct request_queue *q, int __user *p)
 76{
 77	int timeout, err = get_user(timeout, p);
 78
 79	if (!err)
 80		q->sg_timeout = clock_t_to_jiffies(timeout);
 81
 82	return err;
 83}
 84
 85static int max_sectors_bytes(struct request_queue *q)
 86{
 87	unsigned int max_sectors = queue_max_sectors(q);
 88
 89	max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
 90
 91	return max_sectors << 9;
 92}
 93
 94static int sg_get_reserved_size(struct request_queue *q, int __user *p)
 95{
 96	int val = min_t(int, q->sg_reserved_size, max_sectors_bytes(q));
 97
 98	return put_user(val, p);
 99}
100
101static int sg_set_reserved_size(struct request_queue *q, int __user *p)
102{
103	int size, err = get_user(size, p);
104
105	if (err)
106		return err;
107
108	if (size < 0)
109		return -EINVAL;
110
111	q->sg_reserved_size = min(size, max_sectors_bytes(q));
112	return 0;
113}
114
115/*
116 * will always return that we are ATAPI even for a real SCSI drive, I'm not
117 * so sure this is worth doing anything about (why would you care??)
118 */
119static int sg_emulated_host(struct request_queue *q, int __user *p)
120{
121	return put_user(1, p);
122}
123
124static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
125{
126	/* Basic read-only commands */
127	__set_bit(TEST_UNIT_READY, filter->read_ok);
128	__set_bit(REQUEST_SENSE, filter->read_ok);
129	__set_bit(READ_6, filter->read_ok);
130	__set_bit(READ_10, filter->read_ok);
131	__set_bit(READ_12, filter->read_ok);
132	__set_bit(READ_16, filter->read_ok);
133	__set_bit(READ_BUFFER, filter->read_ok);
134	__set_bit(READ_DEFECT_DATA, filter->read_ok);
135	__set_bit(READ_CAPACITY, filter->read_ok);
136	__set_bit(READ_LONG, filter->read_ok);
137	__set_bit(INQUIRY, filter->read_ok);
138	__set_bit(MODE_SENSE, filter->read_ok);
139	__set_bit(MODE_SENSE_10, filter->read_ok);
140	__set_bit(LOG_SENSE, filter->read_ok);
141	__set_bit(START_STOP, filter->read_ok);
142	__set_bit(GPCMD_VERIFY_10, filter->read_ok);
143	__set_bit(VERIFY_16, filter->read_ok);
144	__set_bit(REPORT_LUNS, filter->read_ok);
145	__set_bit(SERVICE_ACTION_IN_16, filter->read_ok);
146	__set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
147	__set_bit(MAINTENANCE_IN, filter->read_ok);
148	__set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
149
150	/* Audio CD commands */
151	__set_bit(GPCMD_PLAY_CD, filter->read_ok);
152	__set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
153	__set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
154	__set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
155	__set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
156
157	/* CD/DVD data reading */
158	__set_bit(GPCMD_READ_CD, filter->read_ok);
159	__set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
160	__set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
161	__set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
162	__set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
163	__set_bit(GPCMD_READ_HEADER, filter->read_ok);
164	__set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
165	__set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
166	__set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
167	__set_bit(GPCMD_REPORT_KEY, filter->read_ok);
168	__set_bit(GPCMD_SCAN, filter->read_ok);
169	__set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
170	__set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
171	__set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
172	__set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
173	__set_bit(GPCMD_SEEK, filter->read_ok);
174	__set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
175
176	/* Basic writing commands */
177	__set_bit(WRITE_6, filter->write_ok);
178	__set_bit(WRITE_10, filter->write_ok);
179	__set_bit(WRITE_VERIFY, filter->write_ok);
180	__set_bit(WRITE_12, filter->write_ok);
181	__set_bit(WRITE_VERIFY_12, filter->write_ok);
182	__set_bit(WRITE_16, filter->write_ok);
183	__set_bit(WRITE_LONG, filter->write_ok);
184	__set_bit(WRITE_LONG_2, filter->write_ok);
185	__set_bit(WRITE_SAME, filter->write_ok);
186	__set_bit(WRITE_SAME_16, filter->write_ok);
187	__set_bit(WRITE_SAME_32, filter->write_ok);
188	__set_bit(ERASE, filter->write_ok);
189	__set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
190	__set_bit(MODE_SELECT, filter->write_ok);
191	__set_bit(LOG_SELECT, filter->write_ok);
192	__set_bit(GPCMD_BLANK, filter->write_ok);
193	__set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
194	__set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
195	__set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
196	__set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
197	__set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
198	__set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
199	__set_bit(GPCMD_SEND_EVENT, filter->write_ok);
200	__set_bit(GPCMD_SEND_KEY, filter->write_ok);
201	__set_bit(GPCMD_SEND_OPC, filter->write_ok);
202	__set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
203	__set_bit(GPCMD_SET_SPEED, filter->write_ok);
204	__set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
205	__set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
206	__set_bit(GPCMD_SET_STREAMING, filter->write_ok);
207	__set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
 
 
 
 
208}
209
210int blk_verify_command(unsigned char *cmd, fmode_t mode)
211{
212	struct blk_cmd_filter *filter = &blk_default_cmd_filter;
213
214	/* root can do any command. */
215	if (capable(CAP_SYS_RAWIO))
216		return 0;
217
218	/* Anybody who can open the device can do a read-safe command */
219	if (test_bit(cmd[0], filter->read_ok))
220		return 0;
221
222	/* Write-safe commands require a writable open */
223	if (test_bit(cmd[0], filter->write_ok) && (mode & FMODE_WRITE))
224		return 0;
225
226	return -EPERM;
227}
228EXPORT_SYMBOL(blk_verify_command);
229
230static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
231			     struct sg_io_hdr *hdr, fmode_t mode)
232{
233	struct scsi_request *req = scsi_req(rq);
234
235	if (copy_from_user(req->cmd, hdr->cmdp, hdr->cmd_len))
236		return -EFAULT;
237	if (blk_verify_command(req->cmd, mode))
238		return -EPERM;
239
240	/*
241	 * fill in request structure
242	 */
243	req->cmd_len = hdr->cmd_len;
244
245	rq->timeout = msecs_to_jiffies(hdr->timeout);
246	if (!rq->timeout)
247		rq->timeout = q->sg_timeout;
248	if (!rq->timeout)
249		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
250	if (rq->timeout < BLK_MIN_SG_TIMEOUT)
251		rq->timeout = BLK_MIN_SG_TIMEOUT;
252
253	return 0;
254}
255
256static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
257				 struct bio *bio)
258{
259	struct scsi_request *req = scsi_req(rq);
260	int r, ret = 0;
261
262	/*
263	 * fill in all the output members
264	 */
265	hdr->status = req->result & 0xff;
266	hdr->masked_status = status_byte(req->result);
267	hdr->msg_status = msg_byte(req->result);
268	hdr->host_status = host_byte(req->result);
269	hdr->driver_status = driver_byte(req->result);
270	hdr->info = 0;
271	if (hdr->masked_status || hdr->host_status || hdr->driver_status)
272		hdr->info |= SG_INFO_CHECK;
273	hdr->resid = req->resid_len;
274	hdr->sb_len_wr = 0;
275
276	if (req->sense_len && hdr->sbp) {
277		int len = min((unsigned int) hdr->mx_sb_len, req->sense_len);
278
279		if (!copy_to_user(hdr->sbp, req->sense, len))
280			hdr->sb_len_wr = len;
281		else
282			ret = -EFAULT;
283	}
284
285	r = blk_rq_unmap_user(bio);
286	if (!ret)
287		ret = r;
288
289	return ret;
290}
291
292static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
293		struct sg_io_hdr *hdr, fmode_t mode)
294{
295	unsigned long start_time;
296	ssize_t ret = 0;
297	int writing = 0;
298	int at_head = 0;
299	struct request *rq;
300	struct scsi_request *req;
301	struct bio *bio;
302
303	if (hdr->interface_id != 'S')
304		return -EINVAL;
305
306	if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
307		return -EIO;
308
309	if (hdr->dxfer_len)
310		switch (hdr->dxfer_direction) {
311		default:
312			return -EINVAL;
313		case SG_DXFER_TO_DEV:
314			writing = 1;
315			break;
316		case SG_DXFER_TO_FROM_DEV:
317		case SG_DXFER_FROM_DEV:
318			break;
319		}
320	if (hdr->flags & SG_FLAG_Q_AT_HEAD)
321		at_head = 1;
322
323	ret = -ENOMEM;
324	rq = blk_get_request(q, writing ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN,
325			GFP_KERNEL);
326	if (IS_ERR(rq))
327		return PTR_ERR(rq);
328	req = scsi_req(rq);
329
330	if (hdr->cmd_len > BLK_MAX_CDB) {
331		req->cmd = kzalloc(hdr->cmd_len, GFP_KERNEL);
332		if (!req->cmd)
333			goto out_put_request;
334	}
335
336	ret = blk_fill_sghdr_rq(q, rq, hdr, mode);
337	if (ret < 0)
338		goto out_free_cdb;
339
340	ret = 0;
341	if (hdr->iovec_count) {
342		struct iov_iter i;
343		struct iovec *iov = NULL;
344
345		ret = import_iovec(rq_data_dir(rq),
 
 
 
 
 
 
 
346				   hdr->dxferp, hdr->iovec_count,
347				   0, &iov, &i);
348		if (ret < 0)
349			goto out_free_cdb;
350
351		/* SG_IO howto says that the shorter of the two wins */
352		iov_iter_truncate(&i, hdr->dxfer_len);
353
354		ret = blk_rq_map_user_iov(q, rq, NULL, &i, GFP_KERNEL);
355		kfree(iov);
356	} else if (hdr->dxfer_len)
357		ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
358				      GFP_KERNEL);
359
360	if (ret)
361		goto out_free_cdb;
362
363	bio = rq->bio;
364	req->retries = 0;
365
366	start_time = jiffies;
367
368	/* ignore return value. All information is passed back to caller
369	 * (if he doesn't check that is his problem).
370	 * N.B. a non-zero SCSI status is _not_ necessarily an error.
371	 */
372	blk_execute_rq(q, bd_disk, rq, at_head);
373
374	hdr->duration = jiffies_to_msecs(jiffies - start_time);
375
376	ret = blk_complete_sghdr_rq(rq, hdr, bio);
377
378out_free_cdb:
379	scsi_req_free_cmd(req);
380out_put_request:
381	blk_put_request(rq);
382	return ret;
383}
384
385/**
386 * sg_scsi_ioctl  --  handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
387 * @q:		request queue to send scsi commands down
388 * @disk:	gendisk to operate on (option)
389 * @mode:	mode used to open the file through which the ioctl has been
390 *		submitted
391 * @sic:	userspace structure describing the command to perform
392 *
393 * Send down the scsi command described by @sic to the device below
394 * the request queue @q.  If @file is non-NULL it's used to perform
395 * fine-grained permission checks that allow users to send down
396 * non-destructive SCSI commands.  If the caller has a struct gendisk
397 * available it should be passed in as @disk to allow the low level
398 * driver to use the information contained in it.  A non-NULL @disk
399 * is only allowed if the caller knows that the low level driver doesn't
400 * need it (e.g. in the scsi subsystem).
401 *
402 * Notes:
403 *   -  This interface is deprecated - users should use the SG_IO
404 *      interface instead, as this is a more flexible approach to
405 *      performing SCSI commands on a device.
406 *   -  The SCSI command length is determined by examining the 1st byte
407 *      of the given command. There is no way to override this.
408 *   -  Data transfers are limited to PAGE_SIZE
409 *   -  The length (x + y) must be at least OMAX_SB_LEN bytes long to
410 *      accommodate the sense buffer when an error occurs.
411 *      The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
412 *      old code will not be surprised.
413 *   -  If a Unix error occurs (e.g. ENOMEM) then the user will receive
414 *      a negative return and the Unix error code in 'errno'.
415 *      If the SCSI command succeeds then 0 is returned.
416 *      Positive numbers returned are the compacted SCSI error codes (4
417 *      bytes in one int) where the lowest byte is the SCSI status.
418 */
419int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
420		struct scsi_ioctl_command __user *sic)
421{
422	enum { OMAX_SB_LEN = 16 };	/* For backward compatibility */
423	struct request *rq;
424	struct scsi_request *req;
425	int err;
426	unsigned int in_len, out_len, bytes, opcode, cmdlen;
427	char *buffer = NULL;
428
429	if (!sic)
430		return -EINVAL;
431
432	/*
433	 * get in an out lengths, verify they don't exceed a page worth of data
434	 */
435	if (get_user(in_len, &sic->inlen))
436		return -EFAULT;
437	if (get_user(out_len, &sic->outlen))
438		return -EFAULT;
439	if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
440		return -EINVAL;
441	if (get_user(opcode, sic->data))
442		return -EFAULT;
443
444	bytes = max(in_len, out_len);
445	if (bytes) {
446		buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
447		if (!buffer)
448			return -ENOMEM;
449
450	}
451
452	rq = blk_get_request(q, in_len ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN,
453			__GFP_RECLAIM);
454	if (IS_ERR(rq)) {
455		err = PTR_ERR(rq);
456		goto error_free_buffer;
457	}
458	req = scsi_req(rq);
459
460	cmdlen = COMMAND_SIZE(opcode);
461
462	/*
463	 * get command and data to send to device, if any
464	 */
465	err = -EFAULT;
466	req->cmd_len = cmdlen;
467	if (copy_from_user(req->cmd, sic->data, cmdlen))
468		goto error;
469
470	if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
471		goto error;
472
473	err = blk_verify_command(req->cmd, mode);
474	if (err)
475		goto error;
476
477	/* default.  possible overriden later */
478	req->retries = 5;
479
480	switch (opcode) {
481	case SEND_DIAGNOSTIC:
482	case FORMAT_UNIT:
483		rq->timeout = FORMAT_UNIT_TIMEOUT;
484		req->retries = 1;
485		break;
486	case START_STOP:
487		rq->timeout = START_STOP_TIMEOUT;
488		break;
489	case MOVE_MEDIUM:
490		rq->timeout = MOVE_MEDIUM_TIMEOUT;
491		break;
492	case READ_ELEMENT_STATUS:
493		rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
494		break;
495	case READ_DEFECT_DATA:
496		rq->timeout = READ_DEFECT_DATA_TIMEOUT;
497		req->retries = 1;
498		break;
499	default:
500		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
501		break;
502	}
503
504	if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_RECLAIM)) {
505		err = DRIVER_ERROR << 24;
506		goto error;
507	}
508
509	blk_execute_rq(q, disk, rq, 0);
510
511	err = req->result & 0xff;	/* only 8 bit SCSI status */
512	if (err) {
513		if (req->sense_len && req->sense) {
514			bytes = (OMAX_SB_LEN > req->sense_len) ?
515				req->sense_len : OMAX_SB_LEN;
516			if (copy_to_user(sic->data, req->sense, bytes))
517				err = -EFAULT;
518		}
519	} else {
520		if (copy_to_user(sic->data, buffer, out_len))
521			err = -EFAULT;
522	}
523	
524error:
525	blk_put_request(rq);
526
527error_free_buffer:
528	kfree(buffer);
529
530	return err;
531}
532EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
533
534/* Send basic block requests */
535static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
536			      int cmd, int data)
537{
538	struct request *rq;
539	int err;
540
541	rq = blk_get_request(q, REQ_OP_SCSI_OUT, __GFP_RECLAIM);
542	if (IS_ERR(rq))
543		return PTR_ERR(rq);
544	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
545	scsi_req(rq)->cmd[0] = cmd;
546	scsi_req(rq)->cmd[4] = data;
547	scsi_req(rq)->cmd_len = 6;
548	blk_execute_rq(q, bd_disk, rq, 0);
549	err = scsi_req(rq)->result ? -EIO : 0;
550	blk_put_request(rq);
551
552	return err;
553}
554
555static inline int blk_send_start_stop(struct request_queue *q,
556				      struct gendisk *bd_disk, int data)
557{
558	return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
559}
560
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
561int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
562		   unsigned int cmd, void __user *arg)
563{
564	int err;
565
566	if (!q)
567		return -ENXIO;
568
569	switch (cmd) {
570		/*
571		 * new sgv3 interface
572		 */
573		case SG_GET_VERSION_NUM:
574			err = sg_get_version(arg);
575			break;
576		case SCSI_IOCTL_GET_IDLUN:
577			err = scsi_get_idlun(q, arg);
578			break;
579		case SCSI_IOCTL_GET_BUS_NUMBER:
580			err = scsi_get_bus(q, arg);
581			break;
582		case SG_SET_TIMEOUT:
583			err = sg_set_timeout(q, arg);
584			break;
585		case SG_GET_TIMEOUT:
586			err = sg_get_timeout(q);
587			break;
588		case SG_GET_RESERVED_SIZE:
589			err = sg_get_reserved_size(q, arg);
590			break;
591		case SG_SET_RESERVED_SIZE:
592			err = sg_set_reserved_size(q, arg);
593			break;
594		case SG_EMULATED_HOST:
595			err = sg_emulated_host(q, arg);
596			break;
597		case SG_IO: {
598			struct sg_io_hdr hdr;
599
600			err = -EFAULT;
601			if (copy_from_user(&hdr, arg, sizeof(hdr)))
602				break;
603			err = sg_io(q, bd_disk, &hdr, mode);
604			if (err == -EFAULT)
605				break;
606
607			if (copy_to_user(arg, &hdr, sizeof(hdr)))
608				err = -EFAULT;
609			break;
610		}
611		case CDROM_SEND_PACKET: {
612			struct cdrom_generic_command cgc;
613			struct sg_io_hdr hdr;
614
615			err = -EFAULT;
616			if (copy_from_user(&cgc, arg, sizeof(cgc)))
617				break;
618			cgc.timeout = clock_t_to_jiffies(cgc.timeout);
619			memset(&hdr, 0, sizeof(hdr));
620			hdr.interface_id = 'S';
621			hdr.cmd_len = sizeof(cgc.cmd);
622			hdr.dxfer_len = cgc.buflen;
623			err = 0;
624			switch (cgc.data_direction) {
625				case CGC_DATA_UNKNOWN:
626					hdr.dxfer_direction = SG_DXFER_UNKNOWN;
627					break;
628				case CGC_DATA_WRITE:
629					hdr.dxfer_direction = SG_DXFER_TO_DEV;
630					break;
631				case CGC_DATA_READ:
632					hdr.dxfer_direction = SG_DXFER_FROM_DEV;
633					break;
634				case CGC_DATA_NONE:
635					hdr.dxfer_direction = SG_DXFER_NONE;
636					break;
637				default:
638					err = -EINVAL;
639			}
640			if (err)
641				break;
642
643			hdr.dxferp = cgc.buffer;
644			hdr.sbp = cgc.sense;
645			if (hdr.sbp)
646				hdr.mx_sb_len = sizeof(struct request_sense);
647			hdr.timeout = jiffies_to_msecs(cgc.timeout);
648			hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
649			hdr.cmd_len = sizeof(cgc.cmd);
650
651			err = sg_io(q, bd_disk, &hdr, mode);
652			if (err == -EFAULT)
653				break;
654
655			if (hdr.status)
656				err = -EIO;
657
658			cgc.stat = err;
659			cgc.buflen = hdr.resid;
660			if (copy_to_user(arg, &cgc, sizeof(cgc)))
661				err = -EFAULT;
662
663			break;
664		}
 
 
 
665
666		/*
667		 * old junk scsi send command ioctl
668		 */
669		case SCSI_IOCTL_SEND_COMMAND:
670			printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
671			err = -EINVAL;
672			if (!arg)
673				break;
674
675			err = sg_scsi_ioctl(q, bd_disk, mode, arg);
676			break;
677		case CDROMCLOSETRAY:
678			err = blk_send_start_stop(q, bd_disk, 0x03);
679			break;
680		case CDROMEJECT:
681			err = blk_send_start_stop(q, bd_disk, 0x02);
682			break;
683		default:
684			err = -ENOTTY;
685	}
686
687	return err;
688}
689EXPORT_SYMBOL(scsi_cmd_ioctl);
690
691int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
692{
693	if (bd && bd == bd->bd_contains)
694		return 0;
695
696	if (capable(CAP_SYS_RAWIO))
697		return 0;
698
699	return -ENOIOCTLCMD;
700}
701EXPORT_SYMBOL(scsi_verify_blk_ioctl);
702
703int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
704		       unsigned int cmd, void __user *arg)
705{
706	int ret;
707
708	ret = scsi_verify_blk_ioctl(bd, cmd);
709	if (ret < 0)
710		return ret;
711
712	return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
713}
714EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
715
716/**
717 * scsi_req_init - initialize certain fields of a scsi_request structure
718 * @req: Pointer to a scsi_request structure.
719 * Initializes .__cmd[], .cmd, .cmd_len and .sense_len but no other members
720 * of struct scsi_request.
721 */
722void scsi_req_init(struct scsi_request *req)
723{
724	memset(req->__cmd, 0, sizeof(req->__cmd));
725	req->cmd = req->__cmd;
726	req->cmd_len = BLK_MAX_CDB;
727	req->sense_len = 0;
728}
729EXPORT_SYMBOL(scsi_req_init);
730
731static int __init blk_scsi_ioctl_init(void)
732{
733	blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
734	return 0;
735}
736fs_initcall(blk_scsi_ioctl_init);
v5.9
  1// SPDX-License-Identifier: GPL-2.0
  2/*
  3 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
  4 */
  5#include <linux/compat.h>
  6#include <linux/kernel.h>
  7#include <linux/errno.h>
  8#include <linux/string.h>
  9#include <linux/module.h>
 10#include <linux/blkdev.h>
 11#include <linux/capability.h>
 12#include <linux/completion.h>
 13#include <linux/cdrom.h>
 14#include <linux/ratelimit.h>
 15#include <linux/slab.h>
 16#include <linux/times.h>
 17#include <linux/uio.h>
 18#include <linux/uaccess.h>
 19
 20#include <scsi/scsi.h>
 21#include <scsi/scsi_ioctl.h>
 22#include <scsi/scsi_cmnd.h>
 23#include <scsi/sg.h>
 24
 25struct blk_cmd_filter {
 26	unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
 27	unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
 28};
 29
 30static struct blk_cmd_filter blk_default_cmd_filter;
 31
 32/* Command group 3 is reserved and should never be used.  */
 33const unsigned char scsi_command_size_tbl[8] =
 34{
 35	6, 10, 10, 12,
 36	16, 12, 10, 10
 37};
 38EXPORT_SYMBOL(scsi_command_size_tbl);
 39
 40#include <scsi/sg.h>
 41
 42static int sg_get_version(int __user *p)
 43{
 44	static const int sg_version_num = 30527;
 45	return put_user(sg_version_num, p);
 46}
 47
 48static int scsi_get_idlun(struct request_queue *q, int __user *p)
 49{
 50	return put_user(0, p);
 51}
 52
 53static int scsi_get_bus(struct request_queue *q, int __user *p)
 54{
 55	return put_user(0, p);
 56}
 57
 58static int sg_get_timeout(struct request_queue *q)
 59{
 60	return jiffies_to_clock_t(q->sg_timeout);
 61}
 62
 63static int sg_set_timeout(struct request_queue *q, int __user *p)
 64{
 65	int timeout, err = get_user(timeout, p);
 66
 67	if (!err)
 68		q->sg_timeout = clock_t_to_jiffies(timeout);
 69
 70	return err;
 71}
 72
 73static int max_sectors_bytes(struct request_queue *q)
 74{
 75	unsigned int max_sectors = queue_max_sectors(q);
 76
 77	max_sectors = min_t(unsigned int, max_sectors, INT_MAX >> 9);
 78
 79	return max_sectors << 9;
 80}
 81
 82static int sg_get_reserved_size(struct request_queue *q, int __user *p)
 83{
 84	int val = min_t(int, q->sg_reserved_size, max_sectors_bytes(q));
 85
 86	return put_user(val, p);
 87}
 88
 89static int sg_set_reserved_size(struct request_queue *q, int __user *p)
 90{
 91	int size, err = get_user(size, p);
 92
 93	if (err)
 94		return err;
 95
 96	if (size < 0)
 97		return -EINVAL;
 98
 99	q->sg_reserved_size = min(size, max_sectors_bytes(q));
100	return 0;
101}
102
103/*
104 * will always return that we are ATAPI even for a real SCSI drive, I'm not
105 * so sure this is worth doing anything about (why would you care??)
106 */
107static int sg_emulated_host(struct request_queue *q, int __user *p)
108{
109	return put_user(1, p);
110}
111
112static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
113{
114	/* Basic read-only commands */
115	__set_bit(TEST_UNIT_READY, filter->read_ok);
116	__set_bit(REQUEST_SENSE, filter->read_ok);
117	__set_bit(READ_6, filter->read_ok);
118	__set_bit(READ_10, filter->read_ok);
119	__set_bit(READ_12, filter->read_ok);
120	__set_bit(READ_16, filter->read_ok);
121	__set_bit(READ_BUFFER, filter->read_ok);
122	__set_bit(READ_DEFECT_DATA, filter->read_ok);
123	__set_bit(READ_CAPACITY, filter->read_ok);
124	__set_bit(READ_LONG, filter->read_ok);
125	__set_bit(INQUIRY, filter->read_ok);
126	__set_bit(MODE_SENSE, filter->read_ok);
127	__set_bit(MODE_SENSE_10, filter->read_ok);
128	__set_bit(LOG_SENSE, filter->read_ok);
129	__set_bit(START_STOP, filter->read_ok);
130	__set_bit(GPCMD_VERIFY_10, filter->read_ok);
131	__set_bit(VERIFY_16, filter->read_ok);
132	__set_bit(REPORT_LUNS, filter->read_ok);
133	__set_bit(SERVICE_ACTION_IN_16, filter->read_ok);
134	__set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
135	__set_bit(MAINTENANCE_IN, filter->read_ok);
136	__set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
137
138	/* Audio CD commands */
139	__set_bit(GPCMD_PLAY_CD, filter->read_ok);
140	__set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
141	__set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
142	__set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
143	__set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
144
145	/* CD/DVD data reading */
146	__set_bit(GPCMD_READ_CD, filter->read_ok);
147	__set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
148	__set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
149	__set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
150	__set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
151	__set_bit(GPCMD_READ_HEADER, filter->read_ok);
152	__set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
153	__set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
154	__set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
155	__set_bit(GPCMD_REPORT_KEY, filter->read_ok);
156	__set_bit(GPCMD_SCAN, filter->read_ok);
157	__set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
158	__set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
159	__set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
160	__set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
161	__set_bit(GPCMD_SEEK, filter->read_ok);
162	__set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
163
164	/* Basic writing commands */
165	__set_bit(WRITE_6, filter->write_ok);
166	__set_bit(WRITE_10, filter->write_ok);
167	__set_bit(WRITE_VERIFY, filter->write_ok);
168	__set_bit(WRITE_12, filter->write_ok);
169	__set_bit(WRITE_VERIFY_12, filter->write_ok);
170	__set_bit(WRITE_16, filter->write_ok);
171	__set_bit(WRITE_LONG, filter->write_ok);
172	__set_bit(WRITE_LONG_2, filter->write_ok);
173	__set_bit(WRITE_SAME, filter->write_ok);
174	__set_bit(WRITE_SAME_16, filter->write_ok);
175	__set_bit(WRITE_SAME_32, filter->write_ok);
176	__set_bit(ERASE, filter->write_ok);
177	__set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
178	__set_bit(MODE_SELECT, filter->write_ok);
179	__set_bit(LOG_SELECT, filter->write_ok);
180	__set_bit(GPCMD_BLANK, filter->write_ok);
181	__set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
182	__set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
183	__set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
184	__set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
185	__set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
186	__set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
187	__set_bit(GPCMD_SEND_EVENT, filter->write_ok);
188	__set_bit(GPCMD_SEND_KEY, filter->write_ok);
189	__set_bit(GPCMD_SEND_OPC, filter->write_ok);
190	__set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
191	__set_bit(GPCMD_SET_SPEED, filter->write_ok);
192	__set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
193	__set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
194	__set_bit(GPCMD_SET_STREAMING, filter->write_ok);
195	__set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
196
197	/* ZBC Commands */
198	__set_bit(ZBC_OUT, filter->write_ok);
199	__set_bit(ZBC_IN, filter->read_ok);
200}
201
202int blk_verify_command(unsigned char *cmd, fmode_t mode)
203{
204	struct blk_cmd_filter *filter = &blk_default_cmd_filter;
205
206	/* root can do any command. */
207	if (capable(CAP_SYS_RAWIO))
208		return 0;
209
210	/* Anybody who can open the device can do a read-safe command */
211	if (test_bit(cmd[0], filter->read_ok))
212		return 0;
213
214	/* Write-safe commands require a writable open */
215	if (test_bit(cmd[0], filter->write_ok) && (mode & FMODE_WRITE))
216		return 0;
217
218	return -EPERM;
219}
220EXPORT_SYMBOL(blk_verify_command);
221
222static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
223			     struct sg_io_hdr *hdr, fmode_t mode)
224{
225	struct scsi_request *req = scsi_req(rq);
226
227	if (copy_from_user(req->cmd, hdr->cmdp, hdr->cmd_len))
228		return -EFAULT;
229	if (blk_verify_command(req->cmd, mode))
230		return -EPERM;
231
232	/*
233	 * fill in request structure
234	 */
235	req->cmd_len = hdr->cmd_len;
236
237	rq->timeout = msecs_to_jiffies(hdr->timeout);
238	if (!rq->timeout)
239		rq->timeout = q->sg_timeout;
240	if (!rq->timeout)
241		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
242	if (rq->timeout < BLK_MIN_SG_TIMEOUT)
243		rq->timeout = BLK_MIN_SG_TIMEOUT;
244
245	return 0;
246}
247
248static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
249				 struct bio *bio)
250{
251	struct scsi_request *req = scsi_req(rq);
252	int r, ret = 0;
253
254	/*
255	 * fill in all the output members
256	 */
257	hdr->status = req->result & 0xff;
258	hdr->masked_status = status_byte(req->result);
259	hdr->msg_status = msg_byte(req->result);
260	hdr->host_status = host_byte(req->result);
261	hdr->driver_status = driver_byte(req->result);
262	hdr->info = 0;
263	if (hdr->masked_status || hdr->host_status || hdr->driver_status)
264		hdr->info |= SG_INFO_CHECK;
265	hdr->resid = req->resid_len;
266	hdr->sb_len_wr = 0;
267
268	if (req->sense_len && hdr->sbp) {
269		int len = min((unsigned int) hdr->mx_sb_len, req->sense_len);
270
271		if (!copy_to_user(hdr->sbp, req->sense, len))
272			hdr->sb_len_wr = len;
273		else
274			ret = -EFAULT;
275	}
276
277	r = blk_rq_unmap_user(bio);
278	if (!ret)
279		ret = r;
280
281	return ret;
282}
283
284static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
285		struct sg_io_hdr *hdr, fmode_t mode)
286{
287	unsigned long start_time;
288	ssize_t ret = 0;
289	int writing = 0;
290	int at_head = 0;
291	struct request *rq;
292	struct scsi_request *req;
293	struct bio *bio;
294
295	if (hdr->interface_id != 'S')
296		return -EINVAL;
297
298	if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
299		return -EIO;
300
301	if (hdr->dxfer_len)
302		switch (hdr->dxfer_direction) {
303		default:
304			return -EINVAL;
305		case SG_DXFER_TO_DEV:
306			writing = 1;
307			break;
308		case SG_DXFER_TO_FROM_DEV:
309		case SG_DXFER_FROM_DEV:
310			break;
311		}
312	if (hdr->flags & SG_FLAG_Q_AT_HEAD)
313		at_head = 1;
314
315	ret = -ENOMEM;
316	rq = blk_get_request(q, writing ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
 
317	if (IS_ERR(rq))
318		return PTR_ERR(rq);
319	req = scsi_req(rq);
320
321	if (hdr->cmd_len > BLK_MAX_CDB) {
322		req->cmd = kzalloc(hdr->cmd_len, GFP_KERNEL);
323		if (!req->cmd)
324			goto out_put_request;
325	}
326
327	ret = blk_fill_sghdr_rq(q, rq, hdr, mode);
328	if (ret < 0)
329		goto out_free_cdb;
330
331	ret = 0;
332	if (hdr->iovec_count) {
333		struct iov_iter i;
334		struct iovec *iov = NULL;
335
336#ifdef CONFIG_COMPAT
337		if (in_compat_syscall())
338			ret = compat_import_iovec(rq_data_dir(rq),
339				   hdr->dxferp, hdr->iovec_count,
340				   0, &iov, &i);
341		else
342#endif
343			ret = import_iovec(rq_data_dir(rq),
344				   hdr->dxferp, hdr->iovec_count,
345				   0, &iov, &i);
346		if (ret < 0)
347			goto out_free_cdb;
348
349		/* SG_IO howto says that the shorter of the two wins */
350		iov_iter_truncate(&i, hdr->dxfer_len);
351
352		ret = blk_rq_map_user_iov(q, rq, NULL, &i, GFP_KERNEL);
353		kfree(iov);
354	} else if (hdr->dxfer_len)
355		ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
356				      GFP_KERNEL);
357
358	if (ret)
359		goto out_free_cdb;
360
361	bio = rq->bio;
362	req->retries = 0;
363
364	start_time = jiffies;
365
366	/* ignore return value. All information is passed back to caller
367	 * (if he doesn't check that is his problem).
368	 * N.B. a non-zero SCSI status is _not_ necessarily an error.
369	 */
370	blk_execute_rq(q, bd_disk, rq, at_head);
371
372	hdr->duration = jiffies_to_msecs(jiffies - start_time);
373
374	ret = blk_complete_sghdr_rq(rq, hdr, bio);
375
376out_free_cdb:
377	scsi_req_free_cmd(req);
378out_put_request:
379	blk_put_request(rq);
380	return ret;
381}
382
383/**
384 * sg_scsi_ioctl  --  handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
385 * @q:		request queue to send scsi commands down
386 * @disk:	gendisk to operate on (option)
387 * @mode:	mode used to open the file through which the ioctl has been
388 *		submitted
389 * @sic:	userspace structure describing the command to perform
390 *
391 * Send down the scsi command described by @sic to the device below
392 * the request queue @q.  If @file is non-NULL it's used to perform
393 * fine-grained permission checks that allow users to send down
394 * non-destructive SCSI commands.  If the caller has a struct gendisk
395 * available it should be passed in as @disk to allow the low level
396 * driver to use the information contained in it.  A non-NULL @disk
397 * is only allowed if the caller knows that the low level driver doesn't
398 * need it (e.g. in the scsi subsystem).
399 *
400 * Notes:
401 *   -  This interface is deprecated - users should use the SG_IO
402 *      interface instead, as this is a more flexible approach to
403 *      performing SCSI commands on a device.
404 *   -  The SCSI command length is determined by examining the 1st byte
405 *      of the given command. There is no way to override this.
406 *   -  Data transfers are limited to PAGE_SIZE
407 *   -  The length (x + y) must be at least OMAX_SB_LEN bytes long to
408 *      accommodate the sense buffer when an error occurs.
409 *      The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
410 *      old code will not be surprised.
411 *   -  If a Unix error occurs (e.g. ENOMEM) then the user will receive
412 *      a negative return and the Unix error code in 'errno'.
413 *      If the SCSI command succeeds then 0 is returned.
414 *      Positive numbers returned are the compacted SCSI error codes (4
415 *      bytes in one int) where the lowest byte is the SCSI status.
416 */
417int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
418		struct scsi_ioctl_command __user *sic)
419{
420	enum { OMAX_SB_LEN = 16 };	/* For backward compatibility */
421	struct request *rq;
422	struct scsi_request *req;
423	int err;
424	unsigned int in_len, out_len, bytes, opcode, cmdlen;
425	char *buffer = NULL;
426
427	if (!sic)
428		return -EINVAL;
429
430	/*
431	 * get in an out lengths, verify they don't exceed a page worth of data
432	 */
433	if (get_user(in_len, &sic->inlen))
434		return -EFAULT;
435	if (get_user(out_len, &sic->outlen))
436		return -EFAULT;
437	if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
438		return -EINVAL;
439	if (get_user(opcode, sic->data))
440		return -EFAULT;
441
442	bytes = max(in_len, out_len);
443	if (bytes) {
444		buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
445		if (!buffer)
446			return -ENOMEM;
447
448	}
449
450	rq = blk_get_request(q, in_len ? REQ_OP_SCSI_OUT : REQ_OP_SCSI_IN, 0);
 
451	if (IS_ERR(rq)) {
452		err = PTR_ERR(rq);
453		goto error_free_buffer;
454	}
455	req = scsi_req(rq);
456
457	cmdlen = COMMAND_SIZE(opcode);
458
459	/*
460	 * get command and data to send to device, if any
461	 */
462	err = -EFAULT;
463	req->cmd_len = cmdlen;
464	if (copy_from_user(req->cmd, sic->data, cmdlen))
465		goto error;
466
467	if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
468		goto error;
469
470	err = blk_verify_command(req->cmd, mode);
471	if (err)
472		goto error;
473
474	/* default.  possible overriden later */
475	req->retries = 5;
476
477	switch (opcode) {
478	case SEND_DIAGNOSTIC:
479	case FORMAT_UNIT:
480		rq->timeout = FORMAT_UNIT_TIMEOUT;
481		req->retries = 1;
482		break;
483	case START_STOP:
484		rq->timeout = START_STOP_TIMEOUT;
485		break;
486	case MOVE_MEDIUM:
487		rq->timeout = MOVE_MEDIUM_TIMEOUT;
488		break;
489	case READ_ELEMENT_STATUS:
490		rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
491		break;
492	case READ_DEFECT_DATA:
493		rq->timeout = READ_DEFECT_DATA_TIMEOUT;
494		req->retries = 1;
495		break;
496	default:
497		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
498		break;
499	}
500
501	if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, GFP_NOIO)) {
502		err = DRIVER_ERROR << 24;
503		goto error;
504	}
505
506	blk_execute_rq(q, disk, rq, 0);
507
508	err = req->result & 0xff;	/* only 8 bit SCSI status */
509	if (err) {
510		if (req->sense_len && req->sense) {
511			bytes = (OMAX_SB_LEN > req->sense_len) ?
512				req->sense_len : OMAX_SB_LEN;
513			if (copy_to_user(sic->data, req->sense, bytes))
514				err = -EFAULT;
515		}
516	} else {
517		if (copy_to_user(sic->data, buffer, out_len))
518			err = -EFAULT;
519	}
520	
521error:
522	blk_put_request(rq);
523
524error_free_buffer:
525	kfree(buffer);
526
527	return err;
528}
529EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
530
531/* Send basic block requests */
532static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
533			      int cmd, int data)
534{
535	struct request *rq;
536	int err;
537
538	rq = blk_get_request(q, REQ_OP_SCSI_OUT, 0);
539	if (IS_ERR(rq))
540		return PTR_ERR(rq);
541	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
542	scsi_req(rq)->cmd[0] = cmd;
543	scsi_req(rq)->cmd[4] = data;
544	scsi_req(rq)->cmd_len = 6;
545	blk_execute_rq(q, bd_disk, rq, 0);
546	err = scsi_req(rq)->result ? -EIO : 0;
547	blk_put_request(rq);
548
549	return err;
550}
551
552static inline int blk_send_start_stop(struct request_queue *q,
553				      struct gendisk *bd_disk, int data)
554{
555	return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
556}
557
558int put_sg_io_hdr(const struct sg_io_hdr *hdr, void __user *argp)
559{
560#ifdef CONFIG_COMPAT
561	if (in_compat_syscall()) {
562		struct compat_sg_io_hdr hdr32 =  {
563			.interface_id	 = hdr->interface_id,
564			.dxfer_direction = hdr->dxfer_direction,
565			.cmd_len	 = hdr->cmd_len,
566			.mx_sb_len	 = hdr->mx_sb_len,
567			.iovec_count	 = hdr->iovec_count,
568			.dxfer_len	 = hdr->dxfer_len,
569			.dxferp		 = (uintptr_t)hdr->dxferp,
570			.cmdp		 = (uintptr_t)hdr->cmdp,
571			.sbp		 = (uintptr_t)hdr->sbp,
572			.timeout	 = hdr->timeout,
573			.flags		 = hdr->flags,
574			.pack_id	 = hdr->pack_id,
575			.usr_ptr	 = (uintptr_t)hdr->usr_ptr,
576			.status		 = hdr->status,
577			.masked_status	 = hdr->masked_status,
578			.msg_status	 = hdr->msg_status,
579			.sb_len_wr	 = hdr->sb_len_wr,
580			.host_status	 = hdr->host_status,
581			.driver_status	 = hdr->driver_status,
582			.resid		 = hdr->resid,
583			.duration	 = hdr->duration,
584			.info		 = hdr->info,
585		};
586
587		if (copy_to_user(argp, &hdr32, sizeof(hdr32)))
588			return -EFAULT;
589
590		return 0;
591	}
592#endif
593
594	if (copy_to_user(argp, hdr, sizeof(*hdr)))
595		return -EFAULT;
596
597	return 0;
598}
599EXPORT_SYMBOL(put_sg_io_hdr);
600
601int get_sg_io_hdr(struct sg_io_hdr *hdr, const void __user *argp)
602{
603#ifdef CONFIG_COMPAT
604	struct compat_sg_io_hdr hdr32;
605
606	if (in_compat_syscall()) {
607		if (copy_from_user(&hdr32, argp, sizeof(hdr32)))
608			return -EFAULT;
609
610		*hdr = (struct sg_io_hdr) {
611			.interface_id	 = hdr32.interface_id,
612			.dxfer_direction = hdr32.dxfer_direction,
613			.cmd_len	 = hdr32.cmd_len,
614			.mx_sb_len	 = hdr32.mx_sb_len,
615			.iovec_count	 = hdr32.iovec_count,
616			.dxfer_len	 = hdr32.dxfer_len,
617			.dxferp		 = compat_ptr(hdr32.dxferp),
618			.cmdp		 = compat_ptr(hdr32.cmdp),
619			.sbp		 = compat_ptr(hdr32.sbp),
620			.timeout	 = hdr32.timeout,
621			.flags		 = hdr32.flags,
622			.pack_id	 = hdr32.pack_id,
623			.usr_ptr	 = compat_ptr(hdr32.usr_ptr),
624			.status		 = hdr32.status,
625			.masked_status	 = hdr32.masked_status,
626			.msg_status	 = hdr32.msg_status,
627			.sb_len_wr	 = hdr32.sb_len_wr,
628			.host_status	 = hdr32.host_status,
629			.driver_status	 = hdr32.driver_status,
630			.resid		 = hdr32.resid,
631			.duration	 = hdr32.duration,
632			.info		 = hdr32.info,
633		};
634
635		return 0;
636	}
637#endif
638
639	if (copy_from_user(hdr, argp, sizeof(*hdr)))
640		return -EFAULT;
641
642	return 0;
643}
644EXPORT_SYMBOL(get_sg_io_hdr);
645
646#ifdef CONFIG_COMPAT
647struct compat_cdrom_generic_command {
648	unsigned char	cmd[CDROM_PACKET_SIZE];
649	compat_caddr_t	buffer;
650	compat_uint_t	buflen;
651	compat_int_t	stat;
652	compat_caddr_t	sense;
653	unsigned char	data_direction;
654	unsigned char	pad[3];
655	compat_int_t	quiet;
656	compat_int_t	timeout;
657	compat_caddr_t	reserved[1];
658};
659#endif
660
661static int scsi_get_cdrom_generic_arg(struct cdrom_generic_command *cgc,
662				      const void __user *arg)
663{
664#ifdef CONFIG_COMPAT
665	if (in_compat_syscall()) {
666		struct compat_cdrom_generic_command cgc32;
667
668		if (copy_from_user(&cgc32, arg, sizeof(cgc32)))
669			return -EFAULT;
670
671		*cgc = (struct cdrom_generic_command) {
672			.buffer		= compat_ptr(cgc32.buffer),
673			.buflen		= cgc32.buflen,
674			.stat		= cgc32.stat,
675			.sense		= compat_ptr(cgc32.sense),
676			.data_direction	= cgc32.data_direction,
677			.quiet		= cgc32.quiet,
678			.timeout	= cgc32.timeout,
679			.reserved[0]	= compat_ptr(cgc32.reserved[0]),
680		};
681		memcpy(&cgc->cmd, &cgc32.cmd, CDROM_PACKET_SIZE);
682		return 0;
683	}
684#endif
685	if (copy_from_user(cgc, arg, sizeof(*cgc)))
686		return -EFAULT;
687
688	return 0;
689}
690
691static int scsi_put_cdrom_generic_arg(const struct cdrom_generic_command *cgc,
692				      void __user *arg)
693{
694#ifdef CONFIG_COMPAT
695	if (in_compat_syscall()) {
696		struct compat_cdrom_generic_command cgc32 = {
697			.buffer		= (uintptr_t)(cgc->buffer),
698			.buflen		= cgc->buflen,
699			.stat		= cgc->stat,
700			.sense		= (uintptr_t)(cgc->sense),
701			.data_direction	= cgc->data_direction,
702			.quiet		= cgc->quiet,
703			.timeout	= cgc->timeout,
704			.reserved[0]	= (uintptr_t)(cgc->reserved[0]),
705		};
706		memcpy(&cgc32.cmd, &cgc->cmd, CDROM_PACKET_SIZE);
707
708		if (copy_to_user(arg, &cgc32, sizeof(cgc32)))
709			return -EFAULT;
710
711		return 0;
712	}
713#endif
714	if (copy_to_user(arg, cgc, sizeof(*cgc)))
715		return -EFAULT;
716
717	return 0;
718}
719
720static int scsi_cdrom_send_packet(struct request_queue *q,
721				  struct gendisk *bd_disk,
722				  fmode_t mode, void __user *arg)
723{
724	struct cdrom_generic_command cgc;
725	struct sg_io_hdr hdr;
726	int err;
727
728	err = scsi_get_cdrom_generic_arg(&cgc, arg);
729	if (err)
730		return err;
731
732	cgc.timeout = clock_t_to_jiffies(cgc.timeout);
733	memset(&hdr, 0, sizeof(hdr));
734	hdr.interface_id = 'S';
735	hdr.cmd_len = sizeof(cgc.cmd);
736	hdr.dxfer_len = cgc.buflen;
737	switch (cgc.data_direction) {
738		case CGC_DATA_UNKNOWN:
739			hdr.dxfer_direction = SG_DXFER_UNKNOWN;
740			break;
741		case CGC_DATA_WRITE:
742			hdr.dxfer_direction = SG_DXFER_TO_DEV;
743			break;
744		case CGC_DATA_READ:
745			hdr.dxfer_direction = SG_DXFER_FROM_DEV;
746			break;
747		case CGC_DATA_NONE:
748			hdr.dxfer_direction = SG_DXFER_NONE;
749			break;
750		default:
751			return -EINVAL;
752	}
753
754	hdr.dxferp = cgc.buffer;
755	hdr.sbp = cgc.sense;
756	if (hdr.sbp)
757		hdr.mx_sb_len = sizeof(struct request_sense);
758	hdr.timeout = jiffies_to_msecs(cgc.timeout);
759	hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
760	hdr.cmd_len = sizeof(cgc.cmd);
761
762	err = sg_io(q, bd_disk, &hdr, mode);
763	if (err == -EFAULT)
764		return -EFAULT;
765
766	if (hdr.status)
767		return -EIO;
768
769	cgc.stat = err;
770	cgc.buflen = hdr.resid;
771	if (scsi_put_cdrom_generic_arg(&cgc, arg))
772		return -EFAULT;
773
774	return err;
775}
776
777int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
778		   unsigned int cmd, void __user *arg)
779{
780	int err;
781
782	if (!q)
783		return -ENXIO;
784
785	switch (cmd) {
786		/*
787		 * new sgv3 interface
788		 */
789		case SG_GET_VERSION_NUM:
790			err = sg_get_version(arg);
791			break;
792		case SCSI_IOCTL_GET_IDLUN:
793			err = scsi_get_idlun(q, arg);
794			break;
795		case SCSI_IOCTL_GET_BUS_NUMBER:
796			err = scsi_get_bus(q, arg);
797			break;
798		case SG_SET_TIMEOUT:
799			err = sg_set_timeout(q, arg);
800			break;
801		case SG_GET_TIMEOUT:
802			err = sg_get_timeout(q);
803			break;
804		case SG_GET_RESERVED_SIZE:
805			err = sg_get_reserved_size(q, arg);
806			break;
807		case SG_SET_RESERVED_SIZE:
808			err = sg_set_reserved_size(q, arg);
809			break;
810		case SG_EMULATED_HOST:
811			err = sg_emulated_host(q, arg);
812			break;
813		case SG_IO: {
814			struct sg_io_hdr hdr;
815
816			err = get_sg_io_hdr(&hdr, arg);
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
817			if (err)
818				break;
 
 
 
 
 
 
 
 
 
819			err = sg_io(q, bd_disk, &hdr, mode);
820			if (err == -EFAULT)
821				break;
822
823			if (put_sg_io_hdr(&hdr, arg))
 
 
 
 
 
824				err = -EFAULT;
 
825			break;
826		}
827		case CDROM_SEND_PACKET:
828			err = scsi_cdrom_send_packet(q, bd_disk, mode, arg);
829			break;
830
831		/*
832		 * old junk scsi send command ioctl
833		 */
834		case SCSI_IOCTL_SEND_COMMAND:
835			printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
836			err = -EINVAL;
837			if (!arg)
838				break;
839
840			err = sg_scsi_ioctl(q, bd_disk, mode, arg);
841			break;
842		case CDROMCLOSETRAY:
843			err = blk_send_start_stop(q, bd_disk, 0x03);
844			break;
845		case CDROMEJECT:
846			err = blk_send_start_stop(q, bd_disk, 0x02);
847			break;
848		default:
849			err = -ENOTTY;
850	}
851
852	return err;
853}
854EXPORT_SYMBOL(scsi_cmd_ioctl);
855
856int scsi_verify_blk_ioctl(struct block_device *bd, unsigned int cmd)
857{
858	if (bd && bd == bd->bd_contains)
859		return 0;
860
861	if (capable(CAP_SYS_RAWIO))
862		return 0;
863
864	return -ENOIOCTLCMD;
865}
866EXPORT_SYMBOL(scsi_verify_blk_ioctl);
867
868int scsi_cmd_blk_ioctl(struct block_device *bd, fmode_t mode,
869		       unsigned int cmd, void __user *arg)
870{
871	int ret;
872
873	ret = scsi_verify_blk_ioctl(bd, cmd);
874	if (ret < 0)
875		return ret;
876
877	return scsi_cmd_ioctl(bd->bd_disk->queue, bd->bd_disk, mode, cmd, arg);
878}
879EXPORT_SYMBOL(scsi_cmd_blk_ioctl);
880
881/**
882 * scsi_req_init - initialize certain fields of a scsi_request structure
883 * @req: Pointer to a scsi_request structure.
884 * Initializes .__cmd[], .cmd, .cmd_len and .sense_len but no other members
885 * of struct scsi_request.
886 */
887void scsi_req_init(struct scsi_request *req)
888{
889	memset(req->__cmd, 0, sizeof(req->__cmd));
890	req->cmd = req->__cmd;
891	req->cmd_len = BLK_MAX_CDB;
892	req->sense_len = 0;
893}
894EXPORT_SYMBOL(scsi_req_init);
895
896static int __init blk_scsi_ioctl_init(void)
897{
898	blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
899	return 0;
900}
901fs_initcall(blk_scsi_ioctl_init);