Blame view

block/scsi_ioctl.c 18 KB
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
  /*
   * Copyright (C) 2001 Jens Axboe <axboe@suse.de>
   *
   * This program is free software; you can redistribute it and/or modify
   * it under the terms of the GNU General Public License version 2 as
   * published by the Free Software Foundation.
   *
   * This program is distributed in the hope that it will be useful,
   * but WITHOUT ANY WARRANTY; without even the implied warranty of
   *
   * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   * GNU General Public License for more details.
   *
   * You should have received a copy of the GNU General Public Licens
   * along with this program; if not, write to the Free Software
   * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-
   *
   */
  #include <linux/kernel.h>
  #include <linux/errno.h>
  #include <linux/string.h>
  #include <linux/module.h>
  #include <linux/blkdev.h>
c59ede7b7   Randy.Dunlap   [PATCH] move capa...
24
  #include <linux/capability.h>
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
25
26
27
28
29
30
31
32
33
  #include <linux/completion.h>
  #include <linux/cdrom.h>
  #include <linux/slab.h>
  #include <linux/times.h>
  #include <asm/uaccess.h>
  
  #include <scsi/scsi.h>
  #include <scsi/scsi_ioctl.h>
  #include <scsi/scsi_cmnd.h>
018e04468   Jens Axboe   block: get rid of...
34
35
36
  struct blk_cmd_filter {
  	unsigned long read_ok[BLK_SCSI_CMD_PER_LONG];
  	unsigned long write_ok[BLK_SCSI_CMD_PER_LONG];
476d42f13   H Hartley Sweeten   block/scsi_ioctl....
37
38
39
  };
  
  static struct blk_cmd_filter blk_default_cmd_filter;
018e04468   Jens Axboe   block: get rid of...
40

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
41
  /* Command group 3 is reserved and should never be used.  */
db4742dd8   Boaz Harrosh   [SCSI] add suppor...
42
  const unsigned char scsi_command_size_tbl[8] =
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
43
44
45
46
  {
  	6, 10, 10, 12,
  	16, 12, 10, 10
  };
db4742dd8   Boaz Harrosh   [SCSI] add suppor...
47
  EXPORT_SYMBOL(scsi_command_size_tbl);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
48

1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
49
50
51
52
  #include <scsi/sg.h>
  
  static int sg_get_version(int __user *p)
  {
64100099e   Arjan van de Ven   [BLOCK] mark some...
53
  	static const int sg_version_num = 30527;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
54
55
  	return put_user(sg_version_num, p);
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
56
  static int scsi_get_idlun(struct request_queue *q, int __user *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
57
58
59
  {
  	return put_user(0, p);
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
60
  static int scsi_get_bus(struct request_queue *q, int __user *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
61
62
63
  {
  	return put_user(0, p);
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
64
  static int sg_get_timeout(struct request_queue *q)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
65
  {
2b91bafcc   Milton Miller   scsi-ioctl: use c...
66
  	return jiffies_to_clock_t(q->sg_timeout);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
67
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
68
  static int sg_set_timeout(struct request_queue *q, int __user *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
69
70
71
72
  {
  	int timeout, err = get_user(timeout, p);
  
  	if (!err)
2b91bafcc   Milton Miller   scsi-ioctl: use c...
73
  		q->sg_timeout = clock_t_to_jiffies(timeout);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
74
75
76
  
  	return err;
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
77
  static int sg_get_reserved_size(struct request_queue *q, int __user *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
78
  {
ae03bf639   Martin K. Petersen   block: Use access...
79
  	unsigned val = min(q->sg_reserved_size, queue_max_sectors(q) << 9);
44ec95425   Alan Stern   [SCSI] sg: cap re...
80
81
  
  	return put_user(val, p);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
82
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
83
  static int sg_set_reserved_size(struct request_queue *q, int __user *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
84
85
86
87
88
89
90
91
  {
  	int size, err = get_user(size, p);
  
  	if (err)
  		return err;
  
  	if (size < 0)
  		return -EINVAL;
ae03bf639   Martin K. Petersen   block: Use access...
92
93
  	if (size > (queue_max_sectors(q) << 9))
  		size = queue_max_sectors(q) << 9;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
94
95
96
97
98
99
100
101
102
  
  	q->sg_reserved_size = size;
  	return 0;
  }
  
  /*
   * will always return that we are ATAPI even for a real SCSI drive, I'm not
   * so sure this is worth doing anything about (why would you care??)
   */
165125e1e   Jens Axboe   [BLOCK] Get rid o...
103
  static int sg_emulated_host(struct request_queue *q, int __user *p)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
104
105
106
  {
  	return put_user(1, p);
  }
018e04468   Jens Axboe   block: get rid of...
107
  static void blk_set_cmd_filter_defaults(struct blk_cmd_filter *filter)
abf543937   FUJITA Tomonori   block: move cmdfi...
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
  {
  	/* Basic read-only commands */
  	__set_bit(TEST_UNIT_READY, filter->read_ok);
  	__set_bit(REQUEST_SENSE, filter->read_ok);
  	__set_bit(READ_6, filter->read_ok);
  	__set_bit(READ_10, filter->read_ok);
  	__set_bit(READ_12, filter->read_ok);
  	__set_bit(READ_16, filter->read_ok);
  	__set_bit(READ_BUFFER, filter->read_ok);
  	__set_bit(READ_DEFECT_DATA, filter->read_ok);
  	__set_bit(READ_CAPACITY, filter->read_ok);
  	__set_bit(READ_LONG, filter->read_ok);
  	__set_bit(INQUIRY, filter->read_ok);
  	__set_bit(MODE_SENSE, filter->read_ok);
  	__set_bit(MODE_SENSE_10, filter->read_ok);
  	__set_bit(LOG_SENSE, filter->read_ok);
  	__set_bit(START_STOP, filter->read_ok);
  	__set_bit(GPCMD_VERIFY_10, filter->read_ok);
  	__set_bit(VERIFY_16, filter->read_ok);
  	__set_bit(REPORT_LUNS, filter->read_ok);
  	__set_bit(SERVICE_ACTION_IN, filter->read_ok);
  	__set_bit(RECEIVE_DIAGNOSTIC, filter->read_ok);
  	__set_bit(MAINTENANCE_IN, filter->read_ok);
  	__set_bit(GPCMD_READ_BUFFER_CAPACITY, filter->read_ok);
  
  	/* Audio CD commands */
  	__set_bit(GPCMD_PLAY_CD, filter->read_ok);
  	__set_bit(GPCMD_PLAY_AUDIO_10, filter->read_ok);
  	__set_bit(GPCMD_PLAY_AUDIO_MSF, filter->read_ok);
  	__set_bit(GPCMD_PLAY_AUDIO_TI, filter->read_ok);
  	__set_bit(GPCMD_PAUSE_RESUME, filter->read_ok);
  
  	/* CD/DVD data reading */
  	__set_bit(GPCMD_READ_CD, filter->read_ok);
  	__set_bit(GPCMD_READ_CD_MSF, filter->read_ok);
  	__set_bit(GPCMD_READ_DISC_INFO, filter->read_ok);
  	__set_bit(GPCMD_READ_CDVD_CAPACITY, filter->read_ok);
  	__set_bit(GPCMD_READ_DVD_STRUCTURE, filter->read_ok);
  	__set_bit(GPCMD_READ_HEADER, filter->read_ok);
  	__set_bit(GPCMD_READ_TRACK_RZONE_INFO, filter->read_ok);
  	__set_bit(GPCMD_READ_SUBCHANNEL, filter->read_ok);
  	__set_bit(GPCMD_READ_TOC_PMA_ATIP, filter->read_ok);
  	__set_bit(GPCMD_REPORT_KEY, filter->read_ok);
  	__set_bit(GPCMD_SCAN, filter->read_ok);
  	__set_bit(GPCMD_GET_CONFIGURATION, filter->read_ok);
  	__set_bit(GPCMD_READ_FORMAT_CAPACITIES, filter->read_ok);
  	__set_bit(GPCMD_GET_EVENT_STATUS_NOTIFICATION, filter->read_ok);
  	__set_bit(GPCMD_GET_PERFORMANCE, filter->read_ok);
  	__set_bit(GPCMD_SEEK, filter->read_ok);
  	__set_bit(GPCMD_STOP_PLAY_SCAN, filter->read_ok);
  
  	/* Basic writing commands */
  	__set_bit(WRITE_6, filter->write_ok);
  	__set_bit(WRITE_10, filter->write_ok);
  	__set_bit(WRITE_VERIFY, filter->write_ok);
  	__set_bit(WRITE_12, filter->write_ok);
  	__set_bit(WRITE_VERIFY_12, filter->write_ok);
  	__set_bit(WRITE_16, filter->write_ok);
  	__set_bit(WRITE_LONG, filter->write_ok);
  	__set_bit(WRITE_LONG_2, filter->write_ok);
  	__set_bit(ERASE, filter->write_ok);
  	__set_bit(GPCMD_MODE_SELECT_10, filter->write_ok);
  	__set_bit(MODE_SELECT, filter->write_ok);
  	__set_bit(LOG_SELECT, filter->write_ok);
  	__set_bit(GPCMD_BLANK, filter->write_ok);
  	__set_bit(GPCMD_CLOSE_TRACK, filter->write_ok);
  	__set_bit(GPCMD_FLUSH_CACHE, filter->write_ok);
  	__set_bit(GPCMD_FORMAT_UNIT, filter->write_ok);
  	__set_bit(GPCMD_REPAIR_RZONE_TRACK, filter->write_ok);
  	__set_bit(GPCMD_RESERVE_RZONE_TRACK, filter->write_ok);
  	__set_bit(GPCMD_SEND_DVD_STRUCTURE, filter->write_ok);
  	__set_bit(GPCMD_SEND_EVENT, filter->write_ok);
  	__set_bit(GPCMD_SEND_KEY, filter->write_ok);
  	__set_bit(GPCMD_SEND_OPC, filter->write_ok);
  	__set_bit(GPCMD_SEND_CUE_SHEET, filter->write_ok);
  	__set_bit(GPCMD_SET_SPEED, filter->write_ok);
  	__set_bit(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL, filter->write_ok);
  	__set_bit(GPCMD_LOAD_UNLOAD, filter->write_ok);
  	__set_bit(GPCMD_SET_STREAMING, filter->write_ok);
35e396cd1   xiphmont@xiph.org   SG_IO block filte...
187
  	__set_bit(GPCMD_SET_READ_AHEAD, filter->write_ok);
abf543937   FUJITA Tomonori   block: move cmdfi...
188
  }
018e04468   Jens Axboe   block: get rid of...
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
  
  int blk_verify_command(unsigned char *cmd, fmode_t has_write_perm)
  {
  	struct blk_cmd_filter *filter = &blk_default_cmd_filter;
  
  	/* root can do any command. */
  	if (capable(CAP_SYS_RAWIO))
  		return 0;
  
  	/* if there's no filter set, assume we're filtering everything out */
  	if (!filter)
  		return -EPERM;
  
  	/* Anybody who can open the device can do a read-safe command */
  	if (test_bit(cmd[0], filter->read_ok))
  		return 0;
  
  	/* Write-safe commands require a writable open */
  	if (test_bit(cmd[0], filter->write_ok) && has_write_perm)
  		return 0;
  
  	return -EPERM;
  }
  EXPORT_SYMBOL(blk_verify_command);
abf543937   FUJITA Tomonori   block: move cmdfi...
213

165125e1e   Jens Axboe   [BLOCK] Get rid o...
214
  static int blk_fill_sghdr_rq(struct request_queue *q, struct request *rq,
5842e51ff   Al Viro   [PATCH] pass mode...
215
  			     struct sg_io_hdr *hdr, fmode_t mode)
3d6392cfb   Jens Axboe   bsg: support for ...
216
  {
3d6392cfb   Jens Axboe   bsg: support for ...
217
218
  	if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len))
  		return -EFAULT;
018e04468   Jens Axboe   block: get rid of...
219
  	if (blk_verify_command(rq->cmd, mode & FMODE_WRITE))
3d6392cfb   Jens Axboe   bsg: support for ...
220
221
222
223
224
225
226
  		return -EPERM;
  
  	/*
  	 * fill in request structure
  	 */
  	rq->cmd_len = hdr->cmd_len;
  	rq->cmd_type = REQ_TYPE_BLOCK_PC;
24bb8fb99   Tejun Heo   block: use jiffie...
227
  	rq->timeout = msecs_to_jiffies(hdr->timeout);
3d6392cfb   Jens Axboe   bsg: support for ...
228
229
230
231
  	if (!rq->timeout)
  		rq->timeout = q->sg_timeout;
  	if (!rq->timeout)
  		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
f2f1fa78a   Linus Torvalds   Enforce a minimum...
232
233
  	if (rq->timeout < BLK_MIN_SG_TIMEOUT)
  		rq->timeout = BLK_MIN_SG_TIMEOUT;
3d6392cfb   Jens Axboe   bsg: support for ...
234
235
236
  
  	return 0;
  }
3d6392cfb   Jens Axboe   bsg: support for ...
237

41e1703b9   FUJITA Tomonori   [SCSI] bsg: unexp...
238
239
  static int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr,
  				 struct bio *bio)
3d6392cfb   Jens Axboe   bsg: support for ...
240
  {
91e463c8f   FUJITA Tomonori   block: fix SG_IO ...
241
  	int r, ret = 0;
3d6392cfb   Jens Axboe   bsg: support for ...
242
243
244
245
246
247
248
249
250
251
252
253
  
  	/*
  	 * fill in all the output members
  	 */
  	hdr->status = rq->errors & 0xff;
  	hdr->masked_status = status_byte(rq->errors);
  	hdr->msg_status = msg_byte(rq->errors);
  	hdr->host_status = host_byte(rq->errors);
  	hdr->driver_status = driver_byte(rq->errors);
  	hdr->info = 0;
  	if (hdr->masked_status || hdr->host_status || hdr->driver_status)
  		hdr->info |= SG_INFO_CHECK;
c3a4d78c5   Tejun Heo   block: add rq->re...
254
  	hdr->resid = rq->resid_len;
3d6392cfb   Jens Axboe   bsg: support for ...
255
256
257
258
259
260
261
262
263
264
  	hdr->sb_len_wr = 0;
  
  	if (rq->sense_len && hdr->sbp) {
  		int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
  
  		if (!copy_to_user(hdr->sbp, rq->sense, len))
  			hdr->sb_len_wr = len;
  		else
  			ret = -EFAULT;
  	}
91e463c8f   FUJITA Tomonori   block: fix SG_IO ...
265
266
267
  	r = blk_rq_unmap_user(bio);
  	if (!ret)
  		ret = r;
1cd96c242   Boaz Harrosh   block: WARN in __...
268
  	blk_put_request(rq);
3d6392cfb   Jens Axboe   bsg: support for ...
269

1cd96c242   Boaz Harrosh   block: WARN in __...
270
  	return ret;
3d6392cfb   Jens Axboe   bsg: support for ...
271
  }
3d6392cfb   Jens Axboe   bsg: support for ...
272

5842e51ff   Al Viro   [PATCH] pass mode...
273
274
  static int sg_io(struct request_queue *q, struct gendisk *bd_disk,
  		struct sg_io_hdr *hdr, fmode_t mode)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
275
  {
3d6392cfb   Jens Axboe   bsg: support for ...
276
  	unsigned long start_time;
0b07de85a   Adel Gadllah   allow userspace t...
277
  	int writing = 0, ret = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
278
  	struct request *rq;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
279
  	char sense[SCSI_SENSE_BUFFERSIZE];
77d172ce2   FUJITA Tomonori   [PATCH] fix SG_IO...
280
  	struct bio *bio;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
281
282
283
284
285
  
  	if (hdr->interface_id != 'S')
  		return -EINVAL;
  	if (hdr->cmd_len > BLK_MAX_CDB)
  		return -EINVAL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
286

ae03bf639   Martin K. Petersen   block: Use access...
287
  	if (hdr->dxfer_len > (queue_max_hw_sectors(q) << 9))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
288
  		return -EIO;
f1970baf6   James Bottomley   [PATCH] Add scatt...
289
  	if (hdr->dxfer_len)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
290
291
292
  		switch (hdr->dxfer_direction) {
  		default:
  			return -EINVAL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
293
294
295
  		case SG_DXFER_TO_DEV:
  			writing = 1;
  			break;
616e8a091   Jens Axboe   [PATCH] Fix bad d...
296
  		case SG_DXFER_TO_FROM_DEV:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
297
  		case SG_DXFER_FROM_DEV:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
298
299
  			break;
  		}
dd1cab95f   Jens Axboe   [PATCH] Cleanup b...
300
301
302
  	rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL);
  	if (!rq)
  		return -ENOMEM;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
303

5842e51ff   Al Viro   [PATCH] pass mode...
304
  	if (blk_fill_sghdr_rq(q, rq, hdr, mode)) {
3d6392cfb   Jens Axboe   bsg: support for ...
305
306
307
  		blk_put_request(rq);
  		return -EFAULT;
  	}
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
308

0e75f9063   Mike Christie   [PATCH] block: su...
309
310
  	if (hdr->iovec_count) {
  		const int size = sizeof(struct sg_iovec) * hdr->iovec_count;
25636e282   Tejun Heo   block: fix SG_IO ...
311
  		size_t iov_data_len;
0e75f9063   Mike Christie   [PATCH] block: su...
312
313
314
315
316
317
318
319
320
321
322
323
324
  		struct sg_iovec *iov;
  
  		iov = kmalloc(size, GFP_KERNEL);
  		if (!iov) {
  			ret = -ENOMEM;
  			goto out;
  		}
  
  		if (copy_from_user(iov, hdr->dxferp, size)) {
  			kfree(iov);
  			ret = -EFAULT;
  			goto out;
  		}
25636e282   Tejun Heo   block: fix SG_IO ...
325
326
327
328
329
330
331
332
333
  		/* SG_IO howto says that the shorter of the two wins */
  		iov_data_len = iov_length((struct iovec *)iov,
  					  hdr->iovec_count);
  		if (hdr->dxfer_len < iov_data_len) {
  			hdr->iovec_count = iov_shorten((struct iovec *)iov,
  						       hdr->iovec_count,
  						       hdr->dxfer_len);
  			iov_data_len = hdr->dxfer_len;
  		}
152e283fd   FUJITA Tomonori   block: introduce ...
334
  		ret = blk_rq_map_user_iov(q, rq, NULL, iov, hdr->iovec_count,
25636e282   Tejun Heo   block: fix SG_IO ...
335
  					  iov_data_len, GFP_KERNEL);
0e75f9063   Mike Christie   [PATCH] block: su...
336
337
  		kfree(iov);
  	} else if (hdr->dxfer_len)
152e283fd   FUJITA Tomonori   block: introduce ...
338
  		ret = blk_rq_map_user(q, rq, NULL, hdr->dxferp, hdr->dxfer_len,
a3bce90ed   FUJITA Tomonori   block: add gfp_ma...
339
  				      GFP_KERNEL);
0e75f9063   Mike Christie   [PATCH] block: su...
340
341
342
  
  	if (ret)
  		goto out;
77d172ce2   FUJITA Tomonori   [PATCH] fix SG_IO...
343
  	bio = rq->bio;
3d6392cfb   Jens Axboe   bsg: support for ...
344
345
346
  	memset(sense, 0, sizeof(sense));
  	rq->sense = sense;
  	rq->sense_len = 0;
01840f9c9   Jens Axboe   [PATCH] blk: Fix ...
347
  	rq->retries = 0;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
348
349
350
351
352
353
  	start_time = jiffies;
  
  	/* ignore return value. All information is passed back to caller
  	 * (if he doesn't check that is his problem).
  	 * N.B. a non-zero SCSI status is _not_ necessarily an error.
  	 */
994ca9a19   James Bottomley   [PATCH] update bl...
354
  	blk_execute_rq(q, bd_disk, rq, 0);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
355

24bb8fb99   Tejun Heo   block: use jiffie...
356
  	hdr->duration = jiffies_to_msecs(jiffies - start_time);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
357

3d6392cfb   Jens Axboe   bsg: support for ...
358
  	return blk_complete_sghdr_rq(rq, hdr, bio);
dd1cab95f   Jens Axboe   [PATCH] Cleanup b...
359
360
361
  out:
  	blk_put_request(rq);
  	return ret;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
362
  }
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
  /**
   * sg_scsi_ioctl  --  handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl
   * @file:	file this ioctl operates on (optional)
   * @q:		request queue to send scsi commands down
   * @disk:	gendisk to operate on (option)
   * @sic:	userspace structure describing the command to perform
   *
   * Send down the scsi command described by @sic to the device below
   * the request queue @q.  If @file is non-NULL it's used to perform
   * fine-grained permission checks that allow users to send down
   * non-destructive SCSI commands.  If the caller has a struct gendisk
   * available it should be passed in as @disk to allow the low level
   * driver to use the information contained in it.  A non-NULL @disk
   * is only allowed if the caller knows that the low level driver doesn't
   * need it (e.g. in the scsi subsystem).
   *
   * Notes:
   *   -  This interface is deprecated - users should use the SG_IO
   *      interface instead, as this is a more flexible approach to
   *      performing SCSI commands on a device.
   *   -  The SCSI command length is determined by examining the 1st byte
   *      of the given command. There is no way to override this.
   *   -  Data transfers are limited to PAGE_SIZE
   *   -  The length (x + y) must be at least OMAX_SB_LEN bytes long to
   *      accommodate the sense buffer when an error occurs.
   *      The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that
   *      old code will not be surprised.
   *   -  If a Unix error occurs (e.g. ENOMEM) then the user will receive
   *      a negative return and the Unix error code in 'errno'.
   *      If the SCSI command succeeds then 0 is returned.
   *      Positive numbers returned are the compacted SCSI error codes (4
   *      bytes in one int) where the lowest byte is the SCSI status.
   */
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
396
  #define OMAX_SB_LEN 16          /* For backward compatibility */
e915e872e   Al Viro   [PATCH] switch sg...
397
398
  int sg_scsi_ioctl(struct request_queue *q, struct gendisk *disk, fmode_t mode,
  		struct scsi_ioctl_command __user *sic)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
399
400
  {
  	struct request *rq;
aeb5d7270   Al Viro   [PATCH] introduce...
401
  	int err;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
402
403
  	unsigned int in_len, out_len, bytes, opcode, cmdlen;
  	char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
404
405
  	if (!sic)
  		return -EINVAL;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
406
407
408
409
410
411
412
413
414
415
416
417
418
419
  	/*
  	 * get in an out lengths, verify they don't exceed a page worth of data
  	 */
  	if (get_user(in_len, &sic->inlen))
  		return -EFAULT;
  	if (get_user(out_len, &sic->outlen))
  		return -EFAULT;
  	if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
  		return -EINVAL;
  	if (get_user(opcode, sic->data))
  		return -EFAULT;
  
  	bytes = max(in_len, out_len);
  	if (bytes) {
dd00cc486   Yoann Padioleau   some kmalloc/mems...
420
  		buffer = kzalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
421
422
  		if (!buffer)
  			return -ENOMEM;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
423
424
425
426
427
428
429
430
431
432
433
434
435
  	}
  
  	rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
  
  	cmdlen = COMMAND_SIZE(opcode);
  
  	/*
  	 * get command and data to send to device, if any
  	 */
  	err = -EFAULT;
  	rq->cmd_len = cmdlen;
  	if (copy_from_user(rq->cmd, sic->data, cmdlen))
  		goto error;
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
436
  	if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
437
  		goto error;
018e04468   Jens Axboe   block: get rid of...
438
  	err = blk_verify_command(rq->cmd, mode & FMODE_WRITE);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
439
440
  	if (err)
  		goto error;
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
441
442
  	/* default.  possible overriden later */
  	rq->retries = 5;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
443
  	switch (opcode) {
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
  	case SEND_DIAGNOSTIC:
  	case FORMAT_UNIT:
  		rq->timeout = FORMAT_UNIT_TIMEOUT;
  		rq->retries = 1;
  		break;
  	case START_STOP:
  		rq->timeout = START_STOP_TIMEOUT;
  		break;
  	case MOVE_MEDIUM:
  		rq->timeout = MOVE_MEDIUM_TIMEOUT;
  		break;
  	case READ_ELEMENT_STATUS:
  		rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
  		break;
  	case READ_DEFECT_DATA:
  		rq->timeout = READ_DEFECT_DATA_TIMEOUT;
  		rq->retries = 1;
  		break;
  	default:
3d6392cfb   Jens Axboe   bsg: support for ...
463
  		rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
464
465
466
467
468
469
  		break;
  	}
  
  	if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) {
  		err = DRIVER_ERROR << 24;
  		goto out;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
470
471
472
473
474
  	}
  
  	memset(sense, 0, sizeof(sense));
  	rq->sense = sense;
  	rq->sense_len = 0;
4aff5e233   Jens Axboe   [PATCH] Split str...
475
  	rq->cmd_type = REQ_TYPE_BLOCK_PC;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
476

21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
477
478
479
  	blk_execute_rq(q, disk, rq, 0);
  
  out:
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
  	err = rq->errors & 0xff;	/* only 8 bit SCSI status */
  	if (err) {
  		if (rq->sense_len && rq->sense) {
  			bytes = (OMAX_SB_LEN > rq->sense_len) ?
  				rq->sense_len : OMAX_SB_LEN;
  			if (copy_to_user(sic->data, rq->sense, bytes))
  				err = -EFAULT;
  		}
  	} else {
  		if (copy_to_user(sic->data, buffer, out_len))
  			err = -EFAULT;
  	}
  	
  error:
  	kfree(buffer);
  	blk_put_request(rq);
  	return err;
  }
21b2f0c80   Christoph Hellwig   [SCSI] unify SCSI...
498
  EXPORT_SYMBOL_GPL(sg_scsi_ioctl);
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
499
500
  
  /* Send basic block requests */
165125e1e   Jens Axboe   [BLOCK] Get rid o...
501
502
  static int __blk_send_generic(struct request_queue *q, struct gendisk *bd_disk,
  			      int cmd, int data)
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
503
504
505
506
507
  {
  	struct request *rq;
  	int err;
  
  	rq = blk_get_request(q, WRITE, __GFP_WAIT);
4aff5e233   Jens Axboe   [PATCH] Split str...
508
  	rq->cmd_type = REQ_TYPE_BLOCK_PC;
3d6392cfb   Jens Axboe   bsg: support for ...
509
  	rq->timeout = BLK_DEFAULT_SG_TIMEOUT;
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
510
511
512
513
514
515
516
517
  	rq->cmd[0] = cmd;
  	rq->cmd[4] = data;
  	rq->cmd_len = 6;
  	err = blk_execute_rq(q, bd_disk, rq, 0);
  	blk_put_request(rq);
  
  	return err;
  }
165125e1e   Jens Axboe   [BLOCK] Get rid o...
518
519
  static inline int blk_send_start_stop(struct request_queue *q,
  				      struct gendisk *bd_disk, int data)
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
520
521
522
  {
  	return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data);
  }
74f3c8aff   Al Viro   [PATCH] switch sc...
523
524
  int scsi_cmd_ioctl(struct request_queue *q, struct gendisk *bd_disk, fmode_t mode,
  		   unsigned int cmd, void __user *arg)
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
525
  {
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
526
  	int err;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
527

45e79a3ac   FUJITA Tomonori   bsg: add a reques...
528
  	if (!q || blk_get_queue(q))
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
  		return -ENXIO;
  
  	switch (cmd) {
  		/*
  		 * new sgv3 interface
  		 */
  		case SG_GET_VERSION_NUM:
  			err = sg_get_version(arg);
  			break;
  		case SCSI_IOCTL_GET_IDLUN:
  			err = scsi_get_idlun(q, arg);
  			break;
  		case SCSI_IOCTL_GET_BUS_NUMBER:
  			err = scsi_get_bus(q, arg);
  			break;
  		case SG_SET_TIMEOUT:
  			err = sg_set_timeout(q, arg);
  			break;
  		case SG_GET_TIMEOUT:
  			err = sg_get_timeout(q);
  			break;
  		case SG_GET_RESERVED_SIZE:
  			err = sg_get_reserved_size(q, arg);
  			break;
  		case SG_SET_RESERVED_SIZE:
  			err = sg_set_reserved_size(q, arg);
  			break;
  		case SG_EMULATED_HOST:
  			err = sg_emulated_host(q, arg);
  			break;
  		case SG_IO: {
  			struct sg_io_hdr hdr;
  
  			err = -EFAULT;
  			if (copy_from_user(&hdr, arg, sizeof(hdr)))
  				break;
74f3c8aff   Al Viro   [PATCH] switch sc...
565
  			err = sg_io(q, bd_disk, &hdr, mode);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
  			if (err == -EFAULT)
  				break;
  
  			if (copy_to_user(arg, &hdr, sizeof(hdr)))
  				err = -EFAULT;
  			break;
  		}
  		case CDROM_SEND_PACKET: {
  			struct cdrom_generic_command cgc;
  			struct sg_io_hdr hdr;
  
  			err = -EFAULT;
  			if (copy_from_user(&cgc, arg, sizeof(cgc)))
  				break;
  			cgc.timeout = clock_t_to_jiffies(cgc.timeout);
  			memset(&hdr, 0, sizeof(hdr));
  			hdr.interface_id = 'S';
  			hdr.cmd_len = sizeof(cgc.cmd);
  			hdr.dxfer_len = cgc.buflen;
  			err = 0;
  			switch (cgc.data_direction) {
  				case CGC_DATA_UNKNOWN:
  					hdr.dxfer_direction = SG_DXFER_UNKNOWN;
  					break;
  				case CGC_DATA_WRITE:
  					hdr.dxfer_direction = SG_DXFER_TO_DEV;
  					break;
  				case CGC_DATA_READ:
  					hdr.dxfer_direction = SG_DXFER_FROM_DEV;
  					break;
  				case CGC_DATA_NONE:
  					hdr.dxfer_direction = SG_DXFER_NONE;
  					break;
  				default:
  					err = -EINVAL;
  			}
  			if (err)
  				break;
  
  			hdr.dxferp = cgc.buffer;
  			hdr.sbp = cgc.sense;
  			if (hdr.sbp)
  				hdr.mx_sb_len = sizeof(struct request_sense);
ad337591f   Tim Wright   [SCSI] block: Fix...
609
  			hdr.timeout = jiffies_to_msecs(cgc.timeout);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
610
611
  			hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
  			hdr.cmd_len = sizeof(cgc.cmd);
74f3c8aff   Al Viro   [PATCH] switch sc...
612
  			err = sg_io(q, bd_disk, &hdr, mode);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
  			if (err == -EFAULT)
  				break;
  
  			if (hdr.status)
  				err = -EIO;
  
  			cgc.stat = err;
  			cgc.buflen = hdr.resid;
  			if (copy_to_user(arg, &cgc, sizeof(cgc)))
  				err = -EFAULT;
  
  			break;
  		}
  
  		/*
  		 * old junk scsi send command ioctl
  		 */
  		case SCSI_IOCTL_SEND_COMMAND:
  			printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO
  ", current->comm);
  			err = -EINVAL;
  			if (!arg)
  				break;
74f3c8aff   Al Viro   [PATCH] switch sc...
636
  			err = sg_scsi_ioctl(q, bd_disk, mode, arg);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
637
638
  			break;
  		case CDROMCLOSETRAY:
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
639
640
  			err = blk_send_start_stop(q, bd_disk, 0x03);
  			break;
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
641
  		case CDROMEJECT:
f98d2dfd0   Ben Collins   [PATCH] block: Cl...
642
  			err = blk_send_start_stop(q, bd_disk, 0x02);
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
643
644
645
646
647
648
649
650
  			break;
  		default:
  			err = -ENOTTY;
  	}
  
  	blk_put_queue(q);
  	return err;
  }
1da177e4c   Linus Torvalds   Linux-2.6.12-rc2
651
  EXPORT_SYMBOL(scsi_cmd_ioctl);
018e04468   Jens Axboe   block: get rid of...
652

476d42f13   H Hartley Sweeten   block/scsi_ioctl....
653
  static int __init blk_scsi_ioctl_init(void)
018e04468   Jens Axboe   block: get rid of...
654
655
656
657
  {
  	blk_set_cmd_filter_defaults(&blk_default_cmd_filter);
  	return 0;
  }
76da03467   FUJITA Tomonori   block: call blk_s...
658
  fs_initcall(blk_scsi_ioctl_init);