Merge branch 'for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git/geert/linux...
[linux-2.6/zen-sources.git] / block / scsi_ioctl.c
blob5963cf91a3a0c4f67dc709f9a6b98fdd87235f53
1 /*
2 * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
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.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
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-
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/slab.h>
28 #include <linux/times.h>
29 #include <asm/uaccess.h>
31 #include <scsi/scsi.h>
32 #include <scsi/scsi_ioctl.h>
33 #include <scsi/scsi_cmnd.h>
35 /* Command group 3 is reserved and should never be used. */
36 const unsigned char scsi_command_size_tbl[8] =
38 6, 10, 10, 12,
39 16, 12, 10, 10
41 EXPORT_SYMBOL(scsi_command_size_tbl);
43 #include <scsi/sg.h>
45 static int sg_get_version(int __user *p)
47 static const int sg_version_num = 30527;
48 return put_user(sg_version_num, p);
51 static int scsi_get_idlun(struct request_queue *q, int __user *p)
53 return put_user(0, p);
56 static int scsi_get_bus(struct request_queue *q, int __user *p)
58 return put_user(0, p);
61 static int sg_get_timeout(struct request_queue *q)
63 return q->sg_timeout / (HZ / USER_HZ);
66 static int sg_set_timeout(struct request_queue *q, int __user *p)
68 int timeout, err = get_user(timeout, p);
70 if (!err)
71 q->sg_timeout = timeout * (HZ / USER_HZ);
73 return err;
76 static int sg_get_reserved_size(struct request_queue *q, int __user *p)
78 unsigned val = min(q->sg_reserved_size, q->max_sectors << 9);
80 return put_user(val, p);
83 static int sg_set_reserved_size(struct request_queue *q, int __user *p)
85 int size, err = get_user(size, p);
87 if (err)
88 return err;
90 if (size < 0)
91 return -EINVAL;
92 if (size > (q->max_sectors << 9))
93 size = q->max_sectors << 9;
95 q->sg_reserved_size = size;
96 return 0;
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??)
103 static int sg_emulated_host(struct request_queue *q, int __user *p)
105 return put_user(1, p);
108 void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
110 /* Basic read-only commands */
111 __set_bit(TEST_UNIT_READY, filter->read_ok);
112 __set_bit(REQUEST_SENSE, filter->read_ok);
113 __set_bit(READ_6, filter->read_ok);
114 __set_bit(READ_10, filter->read_ok);
115 __set_bit(READ_12, filter->read_ok);
116 __set_bit(READ_16, filter->read_ok);
117 __set_bit(READ_BUFFER, filter->read_ok);
118 __set_bit(READ_DEFECT_DATA, filter->read_ok);
119 __set_bit(READ_CAPACITY, filter->read_ok);
120 __set_bit(READ_LONG, filter->read_ok);
121 __set_bit(INQUIRY, filter->read_ok);
122 __set_bit(MODE_SENSE, filter->read_ok);
123 __set_bit(MODE_SENSE_10, filter->read_ok);
124 __set_bit(LOG_SENSE, filter->read_ok);
125 __set_bit(START_STOP, filter->read_ok);
126 __set_bit(GPCMD_VERIFY_10, filter->read_ok);
127 __set_bit(VERIFY_16, filter->read_ok);
128 __set_bit(REPORT_LUNS, filter->read_ok);
129 __set_bit(SERVICE_ACTION_IN, filter->read_ok);
130 __set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
131 __set_bit(MAINTENANCE_IN, filter->read_ok);
132 __set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
134 /* Audio CD commands */
135 __set_bit(GPCMD_PLAY_CD, filter->read_ok);
136 __set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
137 __set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
138 __set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
139 __set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
141 /* CD/DVD data reading */
142 __set_bit(GPCMD_READ_CD, filter->read_ok);
143 __set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
144 __set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
145 __set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
146 __set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
147 __set_bit(GPCMD_READ_HEADER, filter->read_ok);
148 __set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
149 __set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
150 __set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
151 __set_bit(GPCMD_REPORT_KEY, filter->read_ok);
152 __set_bit(GPCMD_SCAN, filter->read_ok);
153 __set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
154 __set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
155 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
156 __set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
157 __set_bit(GPCMD_SEEK, filter->read_ok);
158 __set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
160 /* Basic writing commands */
161 __set_bit(WRITE_6, filter->write_ok);
162 __set_bit(WRITE_10, filter->write_ok);
163 __set_bit(WRITE_VERIFY, filter->write_ok);
164 __set_bit(WRITE_12, filter->write_ok);
165 __set_bit(WRITE_VERIFY_12, filter->write_ok);
166 __set_bit(WRITE_16, filter->write_ok);
167 __set_bit(WRITE_LONG, filter->write_ok);
168 __set_bit(WRITE_LONG_2, filter->write_ok);
169 __set_bit(ERASE, filter->write_ok);
170 __set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
171 __set_bit(MODE_SELECT, filter->write_ok);
172 __set_bit(LOG_SELECT, filter->write_ok);
173 __set_bit(GPCMD_BLANK, filter->write_ok);
174 __set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
175 __set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
176 __set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
177 __set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
178 __set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
179 __set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
180 __set_bit(GPCMD_SEND_EVENT, filter->write_ok);
181 __set_bit(GPCMD_SEND_KEY, filter->write_ok);
182 __set_bit(GPCMD_SEND_OPC, filter->write_ok);
183 __set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
184 __set_bit(GPCMD_SET_SPEED, filter->write_ok);
185 __set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
186 __set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
187 __set_bit(GPCMD_SET_STREAMING, filter->write_ok);
188 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
190 EXPORT_SYMBOL_GPL(blk_set_cmd_filter_defaults);
192 static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
193 struct sg_io_hdr *hdr, fmode_t mode)
195 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
196 return -EFAULT;
197 if (blk_verify_command(&q->cmd_filter, rq->cmd, mode & FMODE_WRITE))
198 return -EPERM;
201 * fill in request structure
203 rq->cmd_len = hdr->cmd_len;
204 rq->cmd_type = REQ_TYPE_BLOCK_PC;
206 rq->timeout = msecs_to_jiffies(hdr->timeout);
207 if (!rq->timeout)
208 rq->timeout = q->sg_timeout;
209 if (!rq->timeout)
210 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
212 return 0;
216 * unmap a request that was previously mapped to this sg_io_hdr. handles
217 * both sg and non-sg sg_io_hdr.
219 static int blk_unmap_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr)
221 blk_rq_unmap_user(rq->bio);
222 blk_put_request(rq);
223 return 0;
226 static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
227 struct bio *bio)
229 int r, ret = 0;
232 * fill in all the output members
234 hdr->status = rq->errors & 0xff;
235 hdr->masked_status = status_byte(rq->errors);
236 hdr->msg_status = msg_byte(rq->errors);
237 hdr->host_status = host_byte(rq->errors);
238 hdr->driver_status = driver_byte(rq->errors);
239 hdr->info = 0;
240 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
241 hdr->info |= SG_INFO_CHECK;
242 hdr->resid = rq->data_len;
243 hdr->sb_len_wr = 0;
245 if (rq->sense_len && hdr->sbp) {
246 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
248 if (!copy_to_user(hdr->sbp, rq->sense, len))
249 hdr->sb_len_wr = len;
250 else
251 ret = -EFAULT;
254 rq->bio = bio;
255 r = blk_unmap_sghdr_rq(rq, hdr);
256 if (ret)
257 r = ret;
259 return r;
262 static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
263 struct sg_io_hdr *hdr, fmode_t mode)
265 unsigned long start_time;
266 int writing = 0, ret = 0;
267 struct request *rq;
268 char sense[SCSI_SENSE_BUFFERSIZE];
269 struct bio *bio;
271 if (hdr->interface_id != 'S')
272 return -EINVAL;
273 if (hdr->cmd_len > BLK_MAX_CDB)
274 return -EINVAL;
276 if (hdr->dxfer_len > (q->max_hw_sectors << 9))
277 return -EIO;
279 if (hdr->dxfer_len)
280 switch (hdr->dxfer_direction) {
281 default:
282 return -EINVAL;
283 case SG_DXFER_TO_DEV:
284 writing = 1;
285 break;
286 case SG_DXFER_TO_FROM_DEV:
287 case SG_DXFER_FROM_DEV:
288 break;
291 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
292 if (!rq)
293 return -ENOMEM;
295 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
296 blk_put_request(rq);
297 return -EFAULT;
300 if (hdr->iovec_count) {
301 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
302 struct sg_iovec *iov;
304 iov = kmalloc(size, GFP_KERNEL);
305 if (!iov) {
306 ret = -ENOMEM;
307 goto out;
310 if (copy_from_user(iov, hdr->dxferp, size)) {
311 kfree(iov);
312 ret = -EFAULT;
313 goto out;
316 ret = blk_rq_map_user_iov(q, rq, NULL, iov, hdr->iovec_count,
317 hdr->dxfer_len, GFP_KERNEL);
318 kfree(iov);
319 } else if (hdr->dxfer_len)
320 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
321 GFP_KERNEL);
323 if (ret)
324 goto out;
326 bio = rq->bio;
327 memset(sense, 0, sizeof(sense));
328 rq->sense = sense;
329 rq->sense_len = 0;
330 rq->retries = 0;
332 start_time = jiffies;
334 /* ignore return value. All information is passed back to caller
335 * (if he doesn't check that is his problem).
336 * N.B. a non-zero SCSI status is _not_ necessarily an error.
338 blk_execute_rq(q, bd_disk, rq, 0);
340 hdr->duration = jiffies_to_msecs(jiffies - start_time);
342 return blk_complete_sghdr_rq(rq, hdr, bio);
343 out:
344 blk_put_request(rq);
345 return ret;
349 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
350 * @file: file this ioctl operates on (optional)
351 * @q: request queue to send scsi commands down
352 * @disk: gendisk to operate on (option)
353 * @sic: userspace structure describing the command to perform
355 * Send down the scsi command described by @sic to the device below
356 * the request queue @q. If @file is non-NULL it's used to perform
357 * fine-grained permission checks that allow users to send down
358 * non-destructive SCSI commands. If the caller has a struct gendisk
359 * available it should be passed in as @disk to allow the low level
360 * driver to use the information contained in it. A non-NULL @disk
361 * is only allowed if the caller knows that the low level driver doesn't
362 * need it (e.g. in the scsi subsystem).
364 * Notes:
365 * - This interface is deprecated - users should use the SG_IO
366 * interface instead, as this is a more flexible approach to
367 * performing SCSI commands on a device.
368 * - The SCSI command length is determined by examining the 1st byte
369 * of the given command. There is no way to override this.
370 * - Data transfers are limited to PAGE_SIZE
371 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
372 * accommodate the sense buffer when an error occurs.
373 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
374 * old code will not be surprised.
375 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
376 * a negative return and the Unix error code in 'errno'.
377 * If the SCSI command succeeds then 0 is returned.
378 * Positive numbers returned are the compacted SCSI error codes (4
379 * bytes in one int) where the lowest byte is the SCSI status.
381 #define OMAX_SB_LEN 16 /* For backward compatibility */
382 int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
383 struct scsi_ioctl_command __user *sic)
385 struct request *rq;
386 int err;
387 unsigned int in_len, out_len, bytes, opcode, cmdlen;
388 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
390 if (!sic)
391 return -EINVAL;
394 * get in an out lengths, verify they don't exceed a page worth of data
396 if (get_user(in_len, &sic->inlen))
397 return -EFAULT;
398 if (get_user(out_len, &sic->outlen))
399 return -EFAULT;
400 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
401 return -EINVAL;
402 if (get_user(opcode, sic->data))
403 return -EFAULT;
405 bytes = max(in_len, out_len);
406 if (bytes) {
407 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
408 if (!buffer)
409 return -ENOMEM;
413 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
415 cmdlen = COMMAND_SIZE(opcode);
418 * get command and data to send to device, if any
420 err = -EFAULT;
421 rq->cmd_len = cmdlen;
422 if (copy_from_user(rq->cmd, sic->data, cmdlen))
423 goto error;
425 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
426 goto error;
428 err = blk_verify_command(&q->cmd_filter, rq->cmd, mode & FMODE_WRITE);
429 if (err)
430 goto error;
432 /* default. possible overriden later */
433 rq->retries = 5;
435 switch (opcode) {
436 case SEND_DIAGNOSTIC:
437 case FORMAT_UNIT:
438 rq->timeout = FORMAT_UNIT_TIMEOUT;
439 rq->retries = 1;
440 break;
441 case START_STOP:
442 rq->timeout = START_STOP_TIMEOUT;
443 break;
444 case MOVE_MEDIUM:
445 rq->timeout = MOVE_MEDIUM_TIMEOUT;
446 break;
447 case READ_ELEMENT_STATUS:
448 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
449 break;
450 case READ_DEFECT_DATA:
451 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
452 rq->retries = 1;
453 break;
454 default:
455 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
456 break;
459 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
460 err = DRIVER_ERROR << 24;
461 goto out;
464 memset(sense, 0, sizeof(sense));
465 rq->sense = sense;
466 rq->sense_len = 0;
467 rq->cmd_type = REQ_TYPE_BLOCK_PC;
469 blk_execute_rq(q, disk, rq, 0);
471 out:
472 err = rq->errors & 0xff; /* only 8 bit SCSI status */
473 if (err) {
474 if (rq->sense_len && rq->sense) {
475 bytes = (OMAX_SB_LEN > rq->sense_len) ?
476 rq->sense_len : OMAX_SB_LEN;
477 if (copy_to_user(sic->data, rq->sense, bytes))
478 err = -EFAULT;
480 } else {
481 if (copy_to_user(sic->data, buffer, out_len))
482 err = -EFAULT;
485 error:
486 kfree(buffer);
487 blk_put_request(rq);
488 return err;
490 EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
492 /* Send basic block requests */
493 static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
494 int cmd, int data)
496 struct request *rq;
497 int err;
499 rq = blk_get_request(q, WRITE, __GFP_WAIT);
500 rq->cmd_type = REQ_TYPE_BLOCK_PC;
501 rq->data = NULL;
502 rq->data_len = 0;
503 rq->extra_len = 0;
504 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
505 rq->cmd[0] = cmd;
506 rq->cmd[4] = data;
507 rq->cmd_len = 6;
508 err = blk_execute_rq(q, bd_disk, rq, 0);
509 blk_put_request(rq);
511 return err;
514 static inline int blk_send_start_stop(struct request_queue *q,
515 struct gendisk *bd_disk, int data)
517 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
520 int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
521 unsigned int cmd, void __user *arg)
523 int err;
525 if (!q || blk_get_queue(q))
526 return -ENXIO;
528 switch (cmd) {
530 * new sgv3 interface
532 case SG_GET_VERSION_NUM:
533 err = sg_get_version(arg);
534 break;
535 case SCSI_IOCTL_GET_IDLUN:
536 err = scsi_get_idlun(q, arg);
537 break;
538 case SCSI_IOCTL_GET_BUS_NUMBER:
539 err = scsi_get_bus(q, arg);
540 break;
541 case SG_SET_TIMEOUT:
542 err = sg_set_timeout(q, arg);
543 break;
544 case SG_GET_TIMEOUT:
545 err = sg_get_timeout(q);
546 break;
547 case SG_GET_RESERVED_SIZE:
548 err = sg_get_reserved_size(q, arg);
549 break;
550 case SG_SET_RESERVED_SIZE:
551 err = sg_set_reserved_size(q, arg);
552 break;
553 case SG_EMULATED_HOST:
554 err = sg_emulated_host(q, arg);
555 break;
556 case SG_IO: {
557 struct sg_io_hdr hdr;
559 err = -EFAULT;
560 if (copy_from_user(&hdr, arg, sizeof(hdr)))
561 break;
562 err = sg_io(q, bd_disk, &hdr, mode);
563 if (err == -EFAULT)
564 break;
566 if (copy_to_user(arg, &hdr, sizeof(hdr)))
567 err = -EFAULT;
568 break;
570 case CDROM_SEND_PACKET: {
571 struct cdrom_generic_command cgc;
572 struct sg_io_hdr hdr;
574 err = -EFAULT;
575 if (copy_from_user(&cgc, arg, sizeof(cgc)))
576 break;
577 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
578 memset(&hdr, 0, sizeof(hdr));
579 hdr.interface_id = 'S';
580 hdr.cmd_len = sizeof(cgc.cmd);
581 hdr.dxfer_len = cgc.buflen;
582 err = 0;
583 switch (cgc.data_direction) {
584 case CGC_DATA_UNKNOWN:
585 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
586 break;
587 case CGC_DATA_WRITE:
588 hdr.dxfer_direction = SG_DXFER_TO_DEV;
589 break;
590 case CGC_DATA_READ:
591 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
592 break;
593 case CGC_DATA_NONE:
594 hdr.dxfer_direction = SG_DXFER_NONE;
595 break;
596 default:
597 err = -EINVAL;
599 if (err)
600 break;
602 hdr.dxferp = cgc.buffer;
603 hdr.sbp = cgc.sense;
604 if (hdr.sbp)
605 hdr.mx_sb_len = sizeof(struct request_sense);
606 hdr.timeout = jiffies_to_msecs(cgc.timeout);
607 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
608 hdr.cmd_len = sizeof(cgc.cmd);
610 err = sg_io(q, bd_disk, &hdr, mode);
611 if (err == -EFAULT)
612 break;
614 if (hdr.status)
615 err = -EIO;
617 cgc.stat = err;
618 cgc.buflen = hdr.resid;
619 if (copy_to_user(arg, &cgc, sizeof(cgc)))
620 err = -EFAULT;
622 break;
626 * old junk scsi send command ioctl
628 case SCSI_IOCTL_SEND_COMMAND:
629 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
630 err = -EINVAL;
631 if (!arg)
632 break;
634 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
635 break;
636 case CDROMCLOSETRAY:
637 err = blk_send_start_stop(q, bd_disk, 0x03);
638 break;
639 case CDROMEJECT:
640 err = blk_send_start_stop(q, bd_disk, 0x02);
641 break;
642 default:
643 err = -ENOTTY;
646 blk_put_queue(q);
647 return err;
650 EXPORT_SYMBOL(scsi_cmd_ioctl);