blob: a8b5a10eb5b04cc15cdd8ddd26ed23fe7c55bc78 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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>
Randy.Dunlapc59ede72006-01-11 12:17:46 -080024#include <linux/capability.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070025#include <linux/completion.h>
26#include <linux/cdrom.h>
27#include <linux/slab.h>
28#include <linux/times.h>
29#include <asm/uaccess.h>
30
31#include <scsi/scsi.h>
32#include <scsi/scsi_ioctl.h>
33#include <scsi/scsi_cmnd.h>
34
Jens Axboe018e0442009-06-26 16:27:10 +020035struct blk_cmd_filter {
36 unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
37 unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
H Hartley Sweeten476d42f2009-11-04 09:10:33 +010038};
39
40static struct blk_cmd_filter blk_default_cmd_filter;
Jens Axboe018e0442009-06-26 16:27:10 +020041
Linus Torvalds1da177e2005-04-16 15:20:36 -070042/* Command group 3 is reserved and should never be used. */
Boaz Harroshdb4742d2008-04-30 11:27:26 +030043const unsigned char scsi_command_size_tbl[8] =
Linus Torvalds1da177e2005-04-16 15:20:36 -070044{
45 6, 10, 10, 12,
46 16, 12, 10, 10
47};
Boaz Harroshdb4742d2008-04-30 11:27:26 +030048EXPORT_SYMBOL(scsi_command_size_tbl);
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Linus Torvalds1da177e2005-04-16 15:20:36 -070050#include <scsi/sg.h>
51
52static int sg_get_version(int __user *p)
53{
Arjan van de Ven64100092006-01-06 09:46:02 +010054 static const int sg_version_num = 30527;
Linus Torvalds1da177e2005-04-16 15:20:36 -070055 return put_user(sg_version_num, p);
56}
57
Jens Axboe165125e2007-07-24 09:28:11 +020058static int scsi_get_idlun(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070059{
60 return put_user(0, p);
61}
62
Jens Axboe165125e2007-07-24 09:28:11 +020063static int scsi_get_bus(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070064{
65 return put_user(0, p);
66}
67
Jens Axboe165125e2007-07-24 09:28:11 +020068static int sg_get_timeout(struct request_queue *q)
Linus Torvalds1da177e2005-04-16 15:20:36 -070069{
Milton Miller2b91baf2008-11-17 13:10:34 +010070 return jiffies_to_clock_t(q->sg_timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070071}
72
Jens Axboe165125e2007-07-24 09:28:11 +020073static int sg_set_timeout(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070074{
75 int timeout, err = get_user(timeout, p);
76
77 if (!err)
Milton Miller2b91baf2008-11-17 13:10:34 +010078 q->sg_timeout = clock_t_to_jiffies(timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -070079
80 return err;
81}
82
Jens Axboe165125e2007-07-24 09:28:11 +020083static int sg_get_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070084{
Martin K. Petersenae03bf62009-05-22 17:17:50 -040085 unsigned val = min(q->sg_reserved_size, queue_max_sectors(q) << 9);
Alan Stern44ec9542007-02-20 11:01:57 -050086
87 return put_user(val, p);
Linus Torvalds1da177e2005-04-16 15:20:36 -070088}
89
Jens Axboe165125e2007-07-24 09:28:11 +020090static int sg_set_reserved_size(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -070091{
92 int size, err = get_user(size, p);
93
94 if (err)
95 return err;
96
97 if (size < 0)
98 return -EINVAL;
Martin K. Petersenae03bf62009-05-22 17:17:50 -040099 if (size > (queue_max_sectors(q) << 9))
100 size = queue_max_sectors(q) << 9;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700101
102 q->sg_reserved_size = size;
103 return 0;
104}
105
106/*
107 * will always return that we are ATAPI even for a real SCSI drive, I'm not
108 * so sure this is worth doing anything about (why would you care??)
109 */
Jens Axboe165125e2007-07-24 09:28:11 +0200110static int sg_emulated_host(struct request_queue *q, int __user *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111{
112 return put_user(1, p);
113}
114
Jens Axboe018e0442009-06-26 16:27:10 +0200115static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900116{
117 /* Basic read-only commands */
118 __set_bit(TEST_UNIT_READY, filter->read_ok);
119 __set_bit(REQUEST_SENSE, filter->read_ok);
120 __set_bit(READ_6, filter->read_ok);
121 __set_bit(READ_10, filter->read_ok);
122 __set_bit(READ_12, filter->read_ok);
123 __set_bit(READ_16, filter->read_ok);
124 __set_bit(READ_BUFFER, filter->read_ok);
125 __set_bit(READ_DEFECT_DATA, filter->read_ok);
126 __set_bit(READ_CAPACITY, filter->read_ok);
127 __set_bit(READ_LONG, filter->read_ok);
128 __set_bit(INQUIRY, filter->read_ok);
129 __set_bit(MODE_SENSE, filter->read_ok);
130 __set_bit(MODE_SENSE_10, filter->read_ok);
131 __set_bit(LOG_SENSE, filter->read_ok);
132 __set_bit(START_STOP, filter->read_ok);
133 __set_bit(GPCMD_VERIFY_10, filter->read_ok);
134 __set_bit(VERIFY_16, filter->read_ok);
135 __set_bit(REPORT_LUNS, filter->read_ok);
136 __set_bit(SERVICE_ACTION_IN, filter->read_ok);
137 __set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
138 __set_bit(MAINTENANCE_IN, filter->read_ok);
139 __set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
140
141 /* Audio CD commands */
142 __set_bit(GPCMD_PLAY_CD, filter->read_ok);
143 __set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
144 __set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
145 __set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
146 __set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
147
148 /* CD/DVD data reading */
149 __set_bit(GPCMD_READ_CD, filter->read_ok);
150 __set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
151 __set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
152 __set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
153 __set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
154 __set_bit(GPCMD_READ_HEADER, filter->read_ok);
155 __set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
156 __set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
157 __set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
158 __set_bit(GPCMD_REPORT_KEY, filter->read_ok);
159 __set_bit(GPCMD_SCAN, filter->read_ok);
160 __set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
161 __set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
162 __set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
163 __set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
164 __set_bit(GPCMD_SEEK, filter->read_ok);
165 __set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
166
167 /* Basic writing commands */
168 __set_bit(WRITE_6, filter->write_ok);
169 __set_bit(WRITE_10, filter->write_ok);
170 __set_bit(WRITE_VERIFY, filter->write_ok);
171 __set_bit(WRITE_12, filter->write_ok);
172 __set_bit(WRITE_VERIFY_12, filter->write_ok);
173 __set_bit(WRITE_16, filter->write_ok);
174 __set_bit(WRITE_LONG, filter->write_ok);
175 __set_bit(WRITE_LONG_2, 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);
xiphmont@xiph.org35e396c2008-08-22 11:12:21 +0200195 __set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900196}
Jens Axboe018e0442009-06-26 16:27:10 +0200197
198int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm)
199{
200 struct blk_cmd_filter *filter = &blk_default_cmd_filter;
201
202 /* root can do any command. */
203 if (capable(CAP_SYS_RAWIO))
204 return 0;
205
206 /* if there's no filter set, assume we're filtering everything out */
207 if (!filter)
208 return -EPERM;
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) && has_write_perm)
216 return 0;
217
218 return -EPERM;
219}
220EXPORT_SYMBOL(blk_verify_command);
FUJITA Tomonoriabf54392008-08-16 14:10:05 +0900221
Jens Axboe165125e2007-07-24 09:28:11 +0200222static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
Al Viro5842e512008-09-02 16:35:55 -0400223 struct sg_io_hdr *hdr, fmode_t mode)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200224{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200225 if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
226 return -EFAULT;
Jens Axboe018e0442009-06-26 16:27:10 +0200227 if (blk_verify_command(rq->cmd, mode & FMODE_WRITE))
Jens Axboe3d6392c2007-07-09 12:38:05 +0200228 return -EPERM;
229
230 /*
231 * fill in request structure
232 */
233 rq->cmd_len = hdr->cmd_len;
234 rq->cmd_type = REQ_TYPE_BLOCK_PC;
235
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100236 rq->timeout = msecs_to_jiffies(hdr->timeout);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200237 if (!rq->timeout)
238 rq->timeout = q->sg_timeout;
239 if (!rq->timeout)
240 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Linus Torvaldsf2f1fa72008-12-05 14:49:18 -0800241 if (rq->timeout < BLK_MIN_SG_TIMEOUT)
242 rq->timeout = BLK_MIN_SG_TIMEOUT;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200243
244 return 0;
245}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200246
FUJITA Tomonori41e17032007-07-22 10:06:50 +0900247static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
248 struct bio *bio)
Jens Axboe3d6392c2007-07-09 12:38:05 +0200249{
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200250 int r, ret = 0;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200251
252 /*
253 * fill in all the output members
254 */
255 hdr->status = rq->errors & 0xff;
256 hdr->masked_status = status_byte(rq->errors);
257 hdr->msg_status = msg_byte(rq->errors);
258 hdr->host_status = host_byte(rq->errors);
259 hdr->driver_status = driver_byte(rq->errors);
260 hdr->info = 0;
261 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
262 hdr->info |= SG_INFO_CHECK;
Tejun Heoc3a4d782009-05-07 22:24:37 +0900263 hdr->resid = rq->resid_len;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200264 hdr->sb_len_wr = 0;
265
266 if (rq->sense_len && hdr->sbp) {
267 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
268
269 if (!copy_to_user(hdr->sbp, rq->sense, len))
270 hdr->sb_len_wr = len;
271 else
272 ret = -EFAULT;
273 }
274
FUJITA Tomonori91e463c2009-04-13 20:03:10 +0200275 r = blk_rq_unmap_user(bio);
276 if (!ret)
277 ret = r;
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100278 blk_put_request(rq);
Jens Axboe3d6392c2007-07-09 12:38:05 +0200279
Boaz Harrosh1cd96c22009-03-24 12:35:07 +0100280 return ret;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200281}
Jens Axboe3d6392c2007-07-09 12:38:05 +0200282
Al Viro5842e512008-09-02 16:35:55 -0400283static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
284 struct sg_io_hdr *hdr, fmode_t mode)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Jens Axboe3d6392c2007-07-09 12:38:05 +0200286 unsigned long start_time;
Adel Gadllah0b07de82008-06-26 13:48:27 +0200287 int writing = 0, ret = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700288 struct request *rq;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700289 char sense[SCSI_SENSE_BUFFERSIZE];
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100290 struct bio *bio;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
292 if (hdr->interface_id != 'S')
293 return -EINVAL;
294 if (hdr->cmd_len > BLK_MAX_CDB)
295 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296
Martin K. Petersenae03bf62009-05-22 17:17:50 -0400297 if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700298 return -EIO;
299
James Bottomley f1970ba2005-06-20 14:06:52 +0200300 if (hdr->dxfer_len)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 switch (hdr->dxfer_direction) {
302 default:
303 return -EINVAL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 case SG_DXFER_TO_DEV:
305 writing = 1;
306 break;
Jens Axboe616e8a02006-11-13 18:04:59 +0100307 case SG_DXFER_TO_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308 case SG_DXFER_FROM_DEV:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 break;
310 }
311
Jens Axboedd1cab92005-06-20 14:06:01 +0200312 rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
313 if (!rq)
314 return -ENOMEM;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315
Al Viro5842e512008-09-02 16:35:55 -0400316 if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
Jens Axboe3d6392c2007-07-09 12:38:05 +0200317 blk_put_request(rq);
318 return -EFAULT;
319 }
Mike Christie0e75f902006-12-01 10:40:55 +0100320
James Bottomley f1970ba2005-06-20 14:06:52 +0200321 if (hdr->iovec_count) {
322 const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
Tejun Heo25636e22009-04-15 22:10:24 +0900323 size_t iov_data_len;
James Bottomley f1970ba2005-06-20 14:06:52 +0200324 struct sg_iovec *iov;
325
326 iov = kmalloc(size, GFP_KERNEL);
327 if (!iov) {
328 ret = -ENOMEM;
Jens Axboedd1cab92005-06-20 14:06:01 +0200329 goto out;
James Bottomley f1970ba2005-06-20 14:06:52 +0200330 }
331
332 if (copy_from_user(iov, hdr->dxferp, size)) {
333 kfree(iov);
334 ret = -EFAULT;
335 goto out;
336 }
337
Tejun Heo25636e22009-04-15 22:10:24 +0900338 /* SG_IO howto says that the shorter of the two wins */
339 iov_data_len = iov_length((struct iovec *)iov,
340 hdr->iovec_count);
341 if (hdr->dxfer_len < iov_data_len) {
342 hdr->iovec_count = iov_shorten((struct iovec *)iov,
343 hdr->iovec_count,
344 hdr->dxfer_len);
345 iov_data_len = hdr->dxfer_len;
346 }
347
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900348 ret = blk_rq_map_user_iov(q, rq, NULL, iov, hdr->iovec_count,
Tejun Heo25636e22009-04-15 22:10:24 +0900349 iov_data_len, GFP_KERNEL);
James Bottomley f1970ba2005-06-20 14:06:52 +0200350 kfree(iov);
351 } else if (hdr->dxfer_len)
FUJITA Tomonori152e2832008-08-28 16:17:06 +0900352 ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
FUJITA Tomonoria3bce902008-08-28 16:17:05 +0900353 GFP_KERNEL);
James Bottomley f1970ba2005-06-20 14:06:52 +0200354
355 if (ret)
356 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700357
FUJITA Tomonori77d172c2006-12-11 10:01:34 +0100358 bio = rq->bio;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200359 memset(sense, 0, sizeof(sense));
360 rq->sense = sense;
361 rq->sense_len = 0;
Jens Axboe01840f92006-02-03 08:37:08 +0100362 rq->retries = 0;
363
Linus Torvalds1da177e2005-04-16 15:20:36 -0700364 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 */
James Bottomley 994ca9a2005-06-20 14:11:09 +0200370 blk_execute_rq(q, bd_disk, rq, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700371
Tejun Heo24bb8fb2007-12-05 21:28:24 +0100372 hdr->duration = jiffies_to_msecs(jiffies - start_time);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700373
Jens Axboe3d6392c2007-07-09 12:38:05 +0200374 return blk_complete_sghdr_rq(rq, hdr, bio);
Jens Axboedd1cab92005-06-20 14:06:01 +0200375out:
376 blk_put_request(rq);
377 return ret;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700378}
379
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100380/**
381 * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
382 * @file: file this ioctl operates on (optional)
383 * @q: request queue to send scsi commands down
384 * @disk: gendisk to operate on (option)
385 * @sic: userspace structure describing the command to perform
386 *
387 * Send down the scsi command described by @sic to the device below
388 * the request queue @q. If @file is non-NULL it's used to perform
389 * fine-grained permission checks that allow users to send down
390 * non-destructive SCSI commands. If the caller has a struct gendisk
391 * available it should be passed in as @disk to allow the low level
392 * driver to use the information contained in it. A non-NULL @disk
393 * is only allowed if the caller knows that the low level driver doesn't
394 * need it (e.g. in the scsi subsystem).
395 *
396 * Notes:
397 * - This interface is deprecated - users should use the SG_IO
398 * interface instead, as this is a more flexible approach to
399 * performing SCSI commands on a device.
400 * - The SCSI command length is determined by examining the 1st byte
401 * of the given command. There is no way to override this.
402 * - Data transfers are limited to PAGE_SIZE
403 * - The length (x + y) must be at least OMAX_SB_LEN bytes long to
404 * accommodate the sense buffer when an error occurs.
405 * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
406 * old code will not be surprised.
407 * - If a Unix error occurs (e.g. ENOMEM) then the user will receive
408 * a negative return and the Unix error code in 'errno'.
409 * If the SCSI command succeeds then 0 is returned.
410 * Positive numbers returned are the compacted SCSI error codes (4
411 * bytes in one int) where the lowest byte is the SCSI status.
412 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413#define OMAX_SB_LEN 16 /* For backward compatibility */
Al Viroe915e872008-09-02 17:16:41 -0400414int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
415 struct scsi_ioctl_command __user *sic)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700416{
417 struct request *rq;
Al Viroaeb5d722008-09-02 15:28:45 -0400418 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419 unsigned int in_len, out_len, bytes, opcode, cmdlen;
420 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
421
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100422 if (!sic)
423 return -EINVAL;
424
Linus Torvalds1da177e2005-04-16 15:20:36 -0700425 /*
426 * get in an out lengths, verify they don't exceed a page worth of data
427 */
428 if (get_user(in_len, &sic->inlen))
429 return -EFAULT;
430 if (get_user(out_len, &sic->outlen))
431 return -EFAULT;
432 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
433 return -EINVAL;
434 if (get_user(opcode, sic->data))
435 return -EFAULT;
436
437 bytes = max(in_len, out_len);
438 if (bytes) {
Yoann Padioleaudd00cc42007-07-19 01:49:03 -0700439 buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700440 if (!buffer)
441 return -ENOMEM;
442
Linus Torvalds1da177e2005-04-16 15:20:36 -0700443 }
444
445 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
446
447 cmdlen = COMMAND_SIZE(opcode);
448
449 /*
450 * get command and data to send to device, if any
451 */
452 err = -EFAULT;
453 rq->cmd_len = cmdlen;
454 if (copy_from_user(rq->cmd, sic->data, cmdlen))
455 goto error;
456
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100457 if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700458 goto error;
459
Jens Axboe018e0442009-06-26 16:27:10 +0200460 err = blk_verify_command(rq->cmd, mode & FMODE_WRITE);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700461 if (err)
462 goto error;
463
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100464 /* default. possible overriden later */
465 rq->retries = 5;
466
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 switch (opcode) {
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100468 case SEND_DIAGNOSTIC:
469 case FORMAT_UNIT:
470 rq->timeout = FORMAT_UNIT_TIMEOUT;
471 rq->retries = 1;
472 break;
473 case START_STOP:
474 rq->timeout = START_STOP_TIMEOUT;
475 break;
476 case MOVE_MEDIUM:
477 rq->timeout = MOVE_MEDIUM_TIMEOUT;
478 break;
479 case READ_ELEMENT_STATUS:
480 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
481 break;
482 case READ_DEFECT_DATA:
483 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
484 rq->retries = 1;
485 break;
486 default:
Jens Axboe3d6392c2007-07-09 12:38:05 +0200487 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100488 break;
489 }
490
491 if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
492 err = DRIVER_ERROR << 24;
493 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700494 }
495
496 memset(sense, 0, sizeof(sense));
497 rq->sense = sense;
498 rq->sense_len = 0;
Jens Axboe4aff5e22006-08-10 08:44:47 +0200499 rq->cmd_type = REQ_TYPE_BLOCK_PC;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100501 blk_execute_rq(q, disk, rq, 0);
502
503out:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504 err = rq->errors & 0xff; /* only 8 bit SCSI status */
505 if (err) {
506 if (rq->sense_len && rq->sense) {
507 bytes = (OMAX_SB_LEN > rq->sense_len) ?
508 rq->sense_len : OMAX_SB_LEN;
509 if (copy_to_user(sic->data, rq->sense, bytes))
510 err = -EFAULT;
511 }
512 } else {
513 if (copy_to_user(sic->data, buffer, out_len))
514 err = -EFAULT;
515 }
516
517error:
518 kfree(buffer);
519 blk_put_request(rq);
520 return err;
521}
Christoph Hellwig21b2f0c2006-03-22 17:52:04 +0100522EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
Ben Collinsf98d2df2005-12-19 11:49:24 -0800523
524/* Send basic block requests */
Jens Axboe165125e2007-07-24 09:28:11 +0200525static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
526 int cmd, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800527{
528 struct request *rq;
529 int err;
530
531 rq = blk_get_request(q, WRITE, __GFP_WAIT);
Jens Axboe4aff5e22006-08-10 08:44:47 +0200532 rq->cmd_type = REQ_TYPE_BLOCK_PC;
Jens Axboe3d6392c2007-07-09 12:38:05 +0200533 rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
Ben Collinsf98d2df2005-12-19 11:49:24 -0800534 rq->cmd[0] = cmd;
535 rq->cmd[4] = data;
536 rq->cmd_len = 6;
537 err = blk_execute_rq(q, bd_disk, rq, 0);
538 blk_put_request(rq);
539
540 return err;
541}
542
Jens Axboe165125e2007-07-24 09:28:11 +0200543static inline int blk_send_start_stop(struct request_queue *q,
544 struct gendisk *bd_disk, int data)
Ben Collinsf98d2df2005-12-19 11:49:24 -0800545{
546 return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
547}
548
Al Viro74f3c8a2007-08-27 15:38:10 -0400549int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
550 unsigned int cmd, void __user *arg)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551{
Ben Collinsf98d2df2005-12-19 11:49:24 -0800552 int err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
FUJITA Tomonori45e79a32007-07-09 12:39:20 +0200554 if (!q || blk_get_queue(q))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700555 return -ENXIO;
556
557 switch (cmd) {
558 /*
559 * new sgv3 interface
560 */
561 case SG_GET_VERSION_NUM:
562 err = sg_get_version(arg);
563 break;
564 case SCSI_IOCTL_GET_IDLUN:
565 err = scsi_get_idlun(q, arg);
566 break;
567 case SCSI_IOCTL_GET_BUS_NUMBER:
568 err = scsi_get_bus(q, arg);
569 break;
570 case SG_SET_TIMEOUT:
571 err = sg_set_timeout(q, arg);
572 break;
573 case SG_GET_TIMEOUT:
574 err = sg_get_timeout(q);
575 break;
576 case SG_GET_RESERVED_SIZE:
577 err = sg_get_reserved_size(q, arg);
578 break;
579 case SG_SET_RESERVED_SIZE:
580 err = sg_set_reserved_size(q, arg);
581 break;
582 case SG_EMULATED_HOST:
583 err = sg_emulated_host(q, arg);
584 break;
585 case SG_IO: {
586 struct sg_io_hdr hdr;
587
588 err = -EFAULT;
589 if (copy_from_user(&hdr, arg, sizeof(hdr)))
590 break;
Al Viro74f3c8a2007-08-27 15:38:10 -0400591 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700592 if (err == -EFAULT)
593 break;
594
595 if (copy_to_user(arg, &hdr, sizeof(hdr)))
596 err = -EFAULT;
597 break;
598 }
599 case CDROM_SEND_PACKET: {
600 struct cdrom_generic_command cgc;
601 struct sg_io_hdr hdr;
602
603 err = -EFAULT;
604 if (copy_from_user(&cgc, arg, sizeof(cgc)))
605 break;
606 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
607 memset(&hdr, 0, sizeof(hdr));
608 hdr.interface_id = 'S';
609 hdr.cmd_len = sizeof(cgc.cmd);
610 hdr.dxfer_len = cgc.buflen;
611 err = 0;
612 switch (cgc.data_direction) {
613 case CGC_DATA_UNKNOWN:
614 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
615 break;
616 case CGC_DATA_WRITE:
617 hdr.dxfer_direction = SG_DXFER_TO_DEV;
618 break;
619 case CGC_DATA_READ:
620 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
621 break;
622 case CGC_DATA_NONE:
623 hdr.dxfer_direction = SG_DXFER_NONE;
624 break;
625 default:
626 err = -EINVAL;
627 }
628 if (err)
629 break;
630
631 hdr.dxferp = cgc.buffer;
632 hdr.sbp = cgc.sense;
633 if (hdr.sbp)
634 hdr.mx_sb_len = sizeof(struct request_sense);
Tim Wrightad337592008-07-27 17:50:38 -0700635 hdr.timeout = jiffies_to_msecs(cgc.timeout);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
637 hdr.cmd_len = sizeof(cgc.cmd);
638
Al Viro74f3c8a2007-08-27 15:38:10 -0400639 err = sg_io(q, bd_disk, &hdr, mode);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 if (err == -EFAULT)
641 break;
642
643 if (hdr.status)
644 err = -EIO;
645
646 cgc.stat = err;
647 cgc.buflen = hdr.resid;
648 if (copy_to_user(arg, &cgc, sizeof(cgc)))
649 err = -EFAULT;
650
651 break;
652 }
653
654 /*
655 * old junk scsi send command ioctl
656 */
657 case SCSI_IOCTL_SEND_COMMAND:
658 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
659 err = -EINVAL;
660 if (!arg)
661 break;
662
Al Viro74f3c8a2007-08-27 15:38:10 -0400663 err = sg_scsi_ioctl(q, bd_disk, mode, arg);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700664 break;
665 case CDROMCLOSETRAY:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800666 err = blk_send_start_stop(q, bd_disk, 0x03);
667 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 case CDROMEJECT:
Ben Collinsf98d2df2005-12-19 11:49:24 -0800669 err = blk_send_start_stop(q, bd_disk, 0x02);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700670 break;
671 default:
672 err = -ENOTTY;
673 }
674
675 blk_put_queue(q);
676 return err;
677}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678EXPORT_SYMBOL(scsi_cmd_ioctl);
Jens Axboe018e0442009-06-26 16:27:10 +0200679
H Hartley Sweeten476d42f2009-11-04 09:10:33 +0100680static int __init blk_scsi_ioctl_init(void)
Jens Axboe018e0442009-06-26 16:27:10 +0200681{
682 blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
683 return 0;
684}
FUJITA Tomonori76da0342009-07-09 09:48:28 +0200685fs_initcall(blk_scsi_ioctl_init);