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 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);
71 q->sg_timeout = timeout * (HZ / USER_HZ);
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 #define CMD_READ_SAFE 0x01
109 #define CMD_WRITE_SAFE 0x02
110 #define CMD_WARNED 0x04
111 #define safe_for_read(cmd) [cmd] = CMD_READ_SAFE
112 #define safe_for_write(cmd) [cmd] = CMD_WRITE_SAFE
114 int blk_verify_command(unsigned char *cmd, int has_write_perm)
116 static unsigned char cmd_type[256] = {
118 /* Basic read-only commands */
119 safe_for_read(TEST_UNIT_READY),
120 safe_for_read(REQUEST_SENSE),
121 safe_for_read(READ_6),
122 safe_for_read(READ_10),
123 safe_for_read(READ_12),
124 safe_for_read(READ_16),
125 safe_for_read(READ_BUFFER),
126 safe_for_read(READ_DEFECT_DATA),
127 safe_for_read(READ_LONG),
128 safe_for_read(INQUIRY),
129 safe_for_read(MODE_SENSE),
130 safe_for_read(MODE_SENSE_10),
131 safe_for_read(LOG_SENSE),
132 safe_for_read(START_STOP),
133 safe_for_read(GPCMD_VERIFY_10),
134 safe_for_read(VERIFY_16),
136 /* Audio CD commands */
137 safe_for_read(GPCMD_PLAY_CD),
138 safe_for_read(GPCMD_PLAY_AUDIO_10),
139 safe_for_read(GPCMD_PLAY_AUDIO_MSF),
140 safe_for_read(GPCMD_PLAY_AUDIO_TI),
141 safe_for_read(GPCMD_PAUSE_RESUME),
143 /* CD/DVD data reading */
144 safe_for_read(GPCMD_READ_BUFFER_CAPACITY),
145 safe_for_read(GPCMD_READ_CD),
146 safe_for_read(GPCMD_READ_CD_MSF),
147 safe_for_read(GPCMD_READ_DISC_INFO),
148 safe_for_read(GPCMD_READ_CDVD_CAPACITY),
149 safe_for_read(GPCMD_READ_DVD_STRUCTURE),
150 safe_for_read(GPCMD_READ_HEADER),
151 safe_for_read(GPCMD_READ_TRACK_RZONE_INFO),
152 safe_for_read(GPCMD_READ_SUBCHANNEL),
153 safe_for_read(GPCMD_READ_TOC_PMA_ATIP),
154 safe_for_read(GPCMD_REPORT_KEY),
155 safe_for_read(GPCMD_SCAN),
156 safe_for_read(GPCMD_GET_CONFIGURATION),
157 safe_for_read(GPCMD_READ_FORMAT_CAPACITIES),
158 safe_for_read(GPCMD_GET_EVENT_STATUS_NOTIFICATION),
159 safe_for_read(GPCMD_GET_PERFORMANCE),
160 safe_for_read(GPCMD_SEEK),
161 safe_for_read(GPCMD_STOP_PLAY_SCAN),
163 /* Basic writing commands */
164 safe_for_write(WRITE_6),
165 safe_for_write(WRITE_10),
166 safe_for_write(WRITE_VERIFY),
167 safe_for_write(WRITE_12),
168 safe_for_write(WRITE_VERIFY_12),
169 safe_for_write(WRITE_16),
170 safe_for_write(WRITE_LONG),
171 safe_for_write(WRITE_LONG_2),
172 safe_for_write(ERASE),
173 safe_for_write(GPCMD_MODE_SELECT_10),
174 safe_for_write(MODE_SELECT),
175 safe_for_write(LOG_SELECT),
176 safe_for_write(GPCMD_BLANK),
177 safe_for_write(GPCMD_CLOSE_TRACK),
178 safe_for_write(GPCMD_FLUSH_CACHE),
179 safe_for_write(GPCMD_FORMAT_UNIT),
180 safe_for_write(GPCMD_REPAIR_RZONE_TRACK),
181 safe_for_write(GPCMD_RESERVE_RZONE_TRACK),
182 safe_for_write(GPCMD_SEND_DVD_STRUCTURE),
183 safe_for_write(GPCMD_SEND_EVENT),
184 safe_for_write(GPCMD_SEND_KEY),
185 safe_for_write(GPCMD_SEND_OPC),
186 safe_for_write(GPCMD_SEND_CUE_SHEET),
187 safe_for_write(GPCMD_SET_SPEED),
188 safe_for_write(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL),
189 safe_for_write(GPCMD_LOAD_UNLOAD),
190 safe_for_write(GPCMD_SET_STREAMING),
192 unsigned char type = cmd_type[cmd[0]];
194 /* Anybody who can open the device can do a read-safe command */
195 if (type & CMD_READ_SAFE)
198 /* Write-safe commands just require a writable open.. */
199 if ((type & CMD_WRITE_SAFE) && has_write_perm)
202 /* And root can do any command.. */
203 if (capable(CAP_SYS_RAWIO))
207 cmd_type[cmd[0]] = CMD_WARNED;
208 printk(KERN_WARNING "scsi: unknown opcode 0x%02x\n", cmd[0]);
211 /* Otherwise fail it with an "Operation not permitted" */
214 EXPORT_SYMBOL_GPL(blk_verify_command);
216 static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
217 struct sg_io_hdr *hdr, int has_write_perm)
219 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
221 if (blk_verify_command(rq->cmd, has_write_perm))
225 * fill in request structure
227 rq->cmd_len = hdr->cmd_len;
228 rq->cmd_type = REQ_TYPE_BLOCK_PC;
230 rq->timeout = msecs_to_jiffies(hdr->timeout);
232 rq->timeout = q->sg_timeout;
234 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
240 * unmap a request that was previously mapped to this sg_io_hdr. handles
241 * both sg and non-sg sg_io_hdr.
243 static int blk_unmap_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr)
245 blk_rq_unmap_user(rq->bio);
250 static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
256 * fill in all the output members
258 hdr->status = rq->errors & 0xff;
259 hdr->masked_status = status_byte(rq->errors);
260 hdr->msg_status = msg_byte(rq->errors);
261 hdr->host_status = host_byte(rq->errors);
262 hdr->driver_status = driver_byte(rq->errors);
264 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
265 hdr->info |= SG_INFO_CHECK;
266 hdr->resid = rq->data_len;
269 if (rq->sense_len && hdr->sbp) {
270 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
272 if (!copy_to_user(hdr->sbp, rq->sense, len))
273 hdr->sb_len_wr = len;
279 r = blk_unmap_sghdr_rq(rq, hdr);
286 static int sg_io(struct file *file, struct request_queue *q,
287 struct gendisk *bd_disk, struct sg_io_hdr *hdr)
289 unsigned long start_time;
290 int writing = 0, ret = 0, has_write_perm = 0;
292 char sense[SCSI_SENSE_BUFFERSIZE];
295 if (hdr->interface_id != 'S')
297 if (hdr->cmd_len > BLK_MAX_CDB)
300 if (hdr->dxfer_len > (q->max_hw_sectors << 9))
304 switch (hdr->dxfer_direction) {
307 case SG_DXFER_TO_DEV:
310 case SG_DXFER_TO_FROM_DEV:
311 case SG_DXFER_FROM_DEV:
315 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
320 has_write_perm = file->f_mode & FMODE_WRITE;
322 if (blk_fill_sghdr_rq(q, rq, hdr, has_write_perm)) {
327 if (hdr->iovec_count) {
328 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
329 struct sg_iovec *iov;
331 iov = kmalloc(size, GFP_KERNEL);
337 if (copy_from_user(iov, hdr->dxferp, size)) {
343 ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count,
346 } else if (hdr->dxfer_len)
347 ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len);
353 memset(sense, 0, sizeof(sense));
358 start_time = jiffies;
360 /* ignore return value. All information is passed back to caller
361 * (if he doesn't check that is his problem).
362 * N.B. a non-zero SCSI status is _not_ necessarily an error.
364 blk_execute_rq(q, bd_disk, rq, 0);
366 hdr->duration = jiffies_to_msecs(jiffies - start_time);
368 return blk_complete_sghdr_rq(rq, hdr, bio);
375 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
376 * @file: file this ioctl operates on (optional)
377 * @q: request queue to send scsi commands down
378 * @disk: gendisk to operate on (option)
379 * @sic: userspace structure describing the command to perform
381 * Send down the scsi command described by @sic to the device below
382 * the request queue @q. If @file is non-NULL it's used to perform
383 * fine-grained permission checks that allow users to send down
384 * non-destructive SCSI commands. If the caller has a struct gendisk
385 * available it should be passed in as @disk to allow the low level
386 * driver to use the information contained in it. A non-NULL @disk
387 * is only allowed if the caller knows that the low level driver doesn't
388 * need it (e.g. in the scsi subsystem).
391 * - This interface is deprecated - users should use the SG_IO
392 * interface instead, as this is a more flexible approach to
393 * performing SCSI commands on a device.
394 * - The SCSI command length is determined by examining the 1st byte
395 * of the given command. There is no way to override this.
396 * - Data transfers are limited to PAGE_SIZE
397 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
398 * accommodate the sense buffer when an error occurs.
399 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
400 * old code will not be surprised.
401 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
402 * a negative return and the Unix error code in 'errno'.
403 * If the SCSI command succeeds then 0 is returned.
404 * Positive numbers returned are the compacted SCSI error codes (4
405 * bytes in one int) where the lowest byte is the SCSI status.
407 #define OMAX_SB_LEN 16 /* For backward compatibility */
408 int sg_scsi_ioctl(struct file *file, struct request_queue *q,
409 struct gendisk *disk, struct scsi_ioctl_command __user *sic)
413 unsigned int in_len, out_len, bytes, opcode, cmdlen;
414 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
420 * get in an out lengths, verify they don't exceed a page worth of data
422 if (get_user(in_len, &sic->inlen))
424 if (get_user(out_len, &sic->outlen))
426 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
428 if (get_user(opcode, sic->data))
431 bytes = max(in_len, out_len);
433 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
439 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
441 cmdlen = COMMAND_SIZE(opcode);
444 * get command and data to send to device, if any
447 rq->cmd_len = cmdlen;
448 if (copy_from_user(rq->cmd, sic->data, cmdlen))
451 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
454 err = blk_verify_command(rq->cmd, file->f_mode & FMODE_WRITE);
458 /* default. possible overriden later */
462 case SEND_DIAGNOSTIC:
464 rq->timeout = FORMAT_UNIT_TIMEOUT;
468 rq->timeout = START_STOP_TIMEOUT;
471 rq->timeout = MOVE_MEDIUM_TIMEOUT;
473 case READ_ELEMENT_STATUS:
474 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
476 case READ_DEFECT_DATA:
477 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
481 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
485 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
486 err = DRIVER_ERROR << 24;
490 memset(sense, 0, sizeof(sense));
493 rq->cmd_type = REQ_TYPE_BLOCK_PC;
495 blk_execute_rq(q, disk, rq, 0);
498 err = rq->errors & 0xff; /* only 8 bit SCSI status */
500 if (rq->sense_len && rq->sense) {
501 bytes = (OMAX_SB_LEN > rq->sense_len) ?
502 rq->sense_len : OMAX_SB_LEN;
503 if (copy_to_user(sic->data, rq->sense, bytes))
507 if (copy_to_user(sic->data, buffer, out_len))
516 EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
518 /* Send basic block requests */
519 static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
525 rq = blk_get_request(q, WRITE, __GFP_WAIT);
526 rq->cmd_type = REQ_TYPE_BLOCK_PC;
530 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
534 err = blk_execute_rq(q, bd_disk, rq, 0);
540 static inline int blk_send_start_stop(struct request_queue *q,
541 struct gendisk *bd_disk, int data)
543 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
546 int scsi_cmd_ioctl(struct file *file, struct request_queue *q,
547 struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
551 if (!q || blk_get_queue(q))
558 case SG_GET_VERSION_NUM:
559 err = sg_get_version(arg);
561 case SCSI_IOCTL_GET_IDLUN:
562 err = scsi_get_idlun(q, arg);
564 case SCSI_IOCTL_GET_BUS_NUMBER:
565 err = scsi_get_bus(q, arg);
568 err = sg_set_timeout(q, arg);
571 err = sg_get_timeout(q);
573 case SG_GET_RESERVED_SIZE:
574 err = sg_get_reserved_size(q, arg);
576 case SG_SET_RESERVED_SIZE:
577 err = sg_set_reserved_size(q, arg);
579 case SG_EMULATED_HOST:
580 err = sg_emulated_host(q, arg);
583 struct sg_io_hdr hdr;
586 if (copy_from_user(&hdr, arg, sizeof(hdr)))
588 err = sg_io(file, q, bd_disk, &hdr);
592 if (copy_to_user(arg, &hdr, sizeof(hdr)))
596 case CDROM_SEND_PACKET: {
597 struct cdrom_generic_command cgc;
598 struct sg_io_hdr hdr;
601 if (copy_from_user(&cgc, arg, sizeof(cgc)))
603 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
604 memset(&hdr, 0, sizeof(hdr));
605 hdr.interface_id = 'S';
606 hdr.cmd_len = sizeof(cgc.cmd);
607 hdr.dxfer_len = cgc.buflen;
609 switch (cgc.data_direction) {
610 case CGC_DATA_UNKNOWN:
611 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
614 hdr.dxfer_direction = SG_DXFER_TO_DEV;
617 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
620 hdr.dxfer_direction = SG_DXFER_NONE;
628 hdr.dxferp = cgc.buffer;
631 hdr.mx_sb_len = sizeof(struct request_sense);
632 hdr.timeout = cgc.timeout;
633 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
634 hdr.cmd_len = sizeof(cgc.cmd);
636 err = sg_io(file, q, bd_disk, &hdr);
644 cgc.buflen = hdr.resid;
645 if (copy_to_user(arg, &cgc, sizeof(cgc)))
652 * old junk scsi send command ioctl
654 case SCSI_IOCTL_SEND_COMMAND:
655 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
660 err = sg_scsi_ioctl(file, q, bd_disk, arg);
663 err = blk_send_start_stop(q, bd_disk, 0x03);
666 err = blk_send_start_stop(q, bd_disk, 0x02);
676 EXPORT_SYMBOL(scsi_cmd_ioctl);