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] =
41 EXPORT_SYMBOL(scsi_command_size_tbl);
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 jiffies_to_clock_t(q->sg_timeout);
66 static int sg_set_timeout(struct request_queue *q, int __user *p)
68 int timeout, err = get_user(timeout, p);
71 q->sg_timeout = clock_t_to_jiffies(timeout);
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);
92 if (size > (q->max_sectors << 9))
93 size = q->max_sectors << 9;
95 q->sg_reserved_size = size;
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))
197 if (blk_verify_command(&q->cmd_filter, rq->cmd, mode & FMODE_WRITE))
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);
208 rq->timeout = q->sg_timeout;
210 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
211 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
212 rq->timeout = BLK_MIN_SG_TIMEOUT;
217 static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
223 * fill in all the output members
225 hdr->status = rq->errors & 0xff;
226 hdr->masked_status = status_byte(rq->errors);
227 hdr->msg_status = msg_byte(rq->errors);
228 hdr->host_status = host_byte(rq->errors);
229 hdr->driver_status = driver_byte(rq->errors);
231 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
232 hdr->info |= SG_INFO_CHECK;
233 hdr->resid = rq->data_len;
236 if (rq->sense_len && hdr->sbp) {
237 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
239 if (!copy_to_user(hdr->sbp, rq->sense, len))
240 hdr->sb_len_wr = len;
245 blk_rq_unmap_user(bio);
251 static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
252 struct sg_io_hdr *hdr, fmode_t mode)
254 unsigned long start_time;
255 int writing = 0, ret = 0;
257 char sense[SCSI_SENSE_BUFFERSIZE];
260 if (hdr->interface_id != 'S')
262 if (hdr->cmd_len > BLK_MAX_CDB)
265 if (hdr->dxfer_len > (q->max_hw_sectors << 9))
269 switch (hdr->dxfer_direction) {
272 case SG_DXFER_TO_DEV:
275 case SG_DXFER_TO_FROM_DEV:
276 case SG_DXFER_FROM_DEV:
280 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
284 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
289 if (hdr->iovec_count) {
290 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
291 struct sg_iovec *iov;
293 iov = kmalloc(size, GFP_KERNEL);
299 if (copy_from_user(iov, hdr->dxferp, size)) {
305 ret = blk_rq_map_user_iov(q, rq, NULL, iov, hdr->iovec_count,
306 hdr->dxfer_len, GFP_KERNEL);
308 } else if (hdr->dxfer_len)
309 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
316 memset(sense, 0, sizeof(sense));
321 start_time = jiffies;
323 /* ignore return value. All information is passed back to caller
324 * (if he doesn't check that is his problem).
325 * N.B. a non-zero SCSI status is _not_ necessarily an error.
327 blk_execute_rq(q, bd_disk, rq, 0);
329 hdr->duration = jiffies_to_msecs(jiffies - start_time);
331 return blk_complete_sghdr_rq(rq, hdr, bio);
338 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
339 * @file: file this ioctl operates on (optional)
340 * @q: request queue to send scsi commands down
341 * @disk: gendisk to operate on (option)
342 * @sic: userspace structure describing the command to perform
344 * Send down the scsi command described by @sic to the device below
345 * the request queue @q. If @file is non-NULL it's used to perform
346 * fine-grained permission checks that allow users to send down
347 * non-destructive SCSI commands. If the caller has a struct gendisk
348 * available it should be passed in as @disk to allow the low level
349 * driver to use the information contained in it. A non-NULL @disk
350 * is only allowed if the caller knows that the low level driver doesn't
351 * need it (e.g. in the scsi subsystem).
354 * - This interface is deprecated - users should use the SG_IO
355 * interface instead, as this is a more flexible approach to
356 * performing SCSI commands on a device.
357 * - The SCSI command length is determined by examining the 1st byte
358 * of the given command. There is no way to override this.
359 * - Data transfers are limited to PAGE_SIZE
360 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
361 * accommodate the sense buffer when an error occurs.
362 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
363 * old code will not be surprised.
364 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
365 * a negative return and the Unix error code in 'errno'.
366 * If the SCSI command succeeds then 0 is returned.
367 * Positive numbers returned are the compacted SCSI error codes (4
368 * bytes in one int) where the lowest byte is the SCSI status.
370 #define OMAX_SB_LEN 16 /* For backward compatibility */
371 int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
372 struct scsi_ioctl_command __user *sic)
376 unsigned int in_len, out_len, bytes, opcode, cmdlen;
377 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
383 * get in an out lengths, verify they don't exceed a page worth of data
385 if (get_user(in_len, &sic->inlen))
387 if (get_user(out_len, &sic->outlen))
389 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
391 if (get_user(opcode, sic->data))
394 bytes = max(in_len, out_len);
396 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
402 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
404 cmdlen = COMMAND_SIZE(opcode);
407 * get command and data to send to device, if any
410 rq->cmd_len = cmdlen;
411 if (copy_from_user(rq->cmd, sic->data, cmdlen))
414 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
417 err = blk_verify_command(&q->cmd_filter, rq->cmd, mode & FMODE_WRITE);
421 /* default. possible overriden later */
425 case SEND_DIAGNOSTIC:
427 rq->timeout = FORMAT_UNIT_TIMEOUT;
431 rq->timeout = START_STOP_TIMEOUT;
434 rq->timeout = MOVE_MEDIUM_TIMEOUT;
436 case READ_ELEMENT_STATUS:
437 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
439 case READ_DEFECT_DATA:
440 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
444 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
448 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
449 err = DRIVER_ERROR << 24;
453 memset(sense, 0, sizeof(sense));
456 rq->cmd_type = REQ_TYPE_BLOCK_PC;
458 blk_execute_rq(q, disk, rq, 0);
461 err = rq->errors & 0xff; /* only 8 bit SCSI status */
463 if (rq->sense_len && rq->sense) {
464 bytes = (OMAX_SB_LEN > rq->sense_len) ?
465 rq->sense_len : OMAX_SB_LEN;
466 if (copy_to_user(sic->data, rq->sense, bytes))
470 if (copy_to_user(sic->data, buffer, out_len))
479 EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
481 /* Send basic block requests */
482 static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
488 rq = blk_get_request(q, WRITE, __GFP_WAIT);
489 rq->cmd_type = REQ_TYPE_BLOCK_PC;
493 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
497 err = blk_execute_rq(q, bd_disk, rq, 0);
503 static inline int blk_send_start_stop(struct request_queue *q,
504 struct gendisk *bd_disk, int data)
506 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
509 int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
510 unsigned int cmd, void __user *arg)
514 if (!q || blk_get_queue(q))
521 case SG_GET_VERSION_NUM:
522 err = sg_get_version(arg);
524 case SCSI_IOCTL_GET_IDLUN:
525 err = scsi_get_idlun(q, arg);
527 case SCSI_IOCTL_GET_BUS_NUMBER:
528 err = scsi_get_bus(q, arg);
531 err = sg_set_timeout(q, arg);
534 err = sg_get_timeout(q);
536 case SG_GET_RESERVED_SIZE:
537 err = sg_get_reserved_size(q, arg);
539 case SG_SET_RESERVED_SIZE:
540 err = sg_set_reserved_size(q, arg);
542 case SG_EMULATED_HOST:
543 err = sg_emulated_host(q, arg);
546 struct sg_io_hdr hdr;
549 if (copy_from_user(&hdr, arg, sizeof(hdr)))
551 err = sg_io(q, bd_disk, &hdr, mode);
555 if (copy_to_user(arg, &hdr, sizeof(hdr)))
559 case CDROM_SEND_PACKET: {
560 struct cdrom_generic_command cgc;
561 struct sg_io_hdr hdr;
564 if (copy_from_user(&cgc, arg, sizeof(cgc)))
566 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
567 memset(&hdr, 0, sizeof(hdr));
568 hdr.interface_id = 'S';
569 hdr.cmd_len = sizeof(cgc.cmd);
570 hdr.dxfer_len = cgc.buflen;
572 switch (cgc.data_direction) {
573 case CGC_DATA_UNKNOWN:
574 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
577 hdr.dxfer_direction = SG_DXFER_TO_DEV;
580 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
583 hdr.dxfer_direction = SG_DXFER_NONE;
591 hdr.dxferp = cgc.buffer;
594 hdr.mx_sb_len = sizeof(struct request_sense);
595 hdr.timeout = jiffies_to_msecs(cgc.timeout);
596 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
597 hdr.cmd_len = sizeof(cgc.cmd);
599 err = sg_io(q, bd_disk, &hdr, mode);
607 cgc.buflen = hdr.resid;
608 if (copy_to_user(arg, &cgc, sizeof(cgc)))
615 * old junk scsi send command ioctl
617 case SCSI_IOCTL_SEND_COMMAND:
618 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
623 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
626 err = blk_send_start_stop(q, bd_disk, 0x03);
629 err = blk_send_start_stop(q, bd_disk, 0x02);
639 EXPORT_SYMBOL(scsi_cmd_ioctl);