blob: 681871ca5d60a89af6978c4727daac1853314d5c [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>
24#include <linux/completion.h>
25#include <linux/cdrom.h>
26#include <linux/slab.h>
27#include <linux/times.h>
28#include <asm/uaccess.h>
29
30#include <scsi/scsi.h>
31#include <scsi/scsi_ioctl.h>
32#include <scsi/scsi_cmnd.h>
33
34/* Command group 3 is reserved and should never be used. */
35const unsigned char scsi_command_size[8] =
36{
37 6, 10, 10, 12,
38 16, 12, 10, 10
39};
40
41EXPORT_SYMBOL(scsi_command_size);
42
43#define BLK_DEFAULT_TIMEOUT (60 * HZ)
44
45#include <scsi/sg.h>
46
47static int sg_get_version(int __user *p)
48{
49 static int sg_version_num = 30527;
50 return put_user(sg_version_num, p);
51}
52
53static int scsi_get_idlun(request_queue_t *q, int __user *p)
54{
55 return put_user(0, p);
56}
57
58static int scsi_get_bus(request_queue_t *q, int __user *p)
59{
60 return put_user(0, p);
61}
62
63static int sg_get_timeout(request_queue_t *q)
64{
65 return q->sg_timeout / (HZ / USER_HZ);
66}
67
68static int sg_set_timeout(request_queue_t *q, int __user *p)
69{
70 int timeout, err = get_user(timeout, p);
71
72 if (!err)
73 q->sg_timeout = timeout * (HZ / USER_HZ);
74
75 return err;
76}
77
78static int sg_get_reserved_size(request_queue_t *q, int __user *p)
79{
80 return put_user(q->sg_reserved_size, p);
81}
82
83static int sg_set_reserved_size(request_queue_t *q, int __user *p)
84{
85 int size, err = get_user(size, p);
86
87 if (err)
88 return err;
89
90 if (size < 0)
91 return -EINVAL;
92 if (size > (q->max_sectors << 9))
93 size = q->max_sectors << 9;
94
95 q->sg_reserved_size = size;
96 return 0;
97}
98
99/*
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??)
102 */
103static int sg_emulated_host(request_queue_t *q, int __user *p)
104{
105 return put_user(1, p);
106}
107
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
113
114static int verify_command(struct file *file, unsigned char *cmd)
115{
116 static unsigned char cmd_type[256] = {
117
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_LONG),
127 safe_for_read(INQUIRY),
128 safe_for_read(MODE_SENSE),
129 safe_for_read(MODE_SENSE_10),
130 safe_for_read(LOG_SENSE),
131 safe_for_read(START_STOP),
132 safe_for_read(GPCMD_VERIFY_10),
133 safe_for_read(VERIFY_16),
134
135 /* Audio CD commands */
136 safe_for_read(GPCMD_PLAY_CD),
137 safe_for_read(GPCMD_PLAY_AUDIO_10),
138 safe_for_read(GPCMD_PLAY_AUDIO_MSF),
139 safe_for_read(GPCMD_PLAY_AUDIO_TI),
140 safe_for_read(GPCMD_PAUSE_RESUME),
141
142 /* CD/DVD data reading */
143 safe_for_read(GPCMD_READ_BUFFER_CAPACITY),
144 safe_for_read(GPCMD_READ_CD),
145 safe_for_read(GPCMD_READ_CD_MSF),
146 safe_for_read(GPCMD_READ_DISC_INFO),
147 safe_for_read(GPCMD_READ_CDVD_CAPACITY),
148 safe_for_read(GPCMD_READ_DVD_STRUCTURE),
149 safe_for_read(GPCMD_READ_HEADER),
150 safe_for_read(GPCMD_READ_TRACK_RZONE_INFO),
151 safe_for_read(GPCMD_READ_SUBCHANNEL),
152 safe_for_read(GPCMD_READ_TOC_PMA_ATIP),
153 safe_for_read(GPCMD_REPORT_KEY),
154 safe_for_read(GPCMD_SCAN),
155 safe_for_read(GPCMD_GET_CONFIGURATION),
156 safe_for_read(GPCMD_READ_FORMAT_CAPACITIES),
157 safe_for_read(GPCMD_GET_EVENT_STATUS_NOTIFICATION),
158 safe_for_read(GPCMD_GET_PERFORMANCE),
159 safe_for_read(GPCMD_SEEK),
160 safe_for_read(GPCMD_STOP_PLAY_SCAN),
161
162 /* Basic writing commands */
163 safe_for_write(WRITE_6),
164 safe_for_write(WRITE_10),
165 safe_for_write(WRITE_VERIFY),
166 safe_for_write(WRITE_12),
167 safe_for_write(WRITE_VERIFY_12),
168 safe_for_write(WRITE_16),
169 safe_for_write(WRITE_LONG),
170 safe_for_write(ERASE),
171 safe_for_write(GPCMD_MODE_SELECT_10),
172 safe_for_write(MODE_SELECT),
173 safe_for_write(LOG_SELECT),
174 safe_for_write(GPCMD_BLANK),
175 safe_for_write(GPCMD_CLOSE_TRACK),
176 safe_for_write(GPCMD_FLUSH_CACHE),
177 safe_for_write(GPCMD_FORMAT_UNIT),
178 safe_for_write(GPCMD_REPAIR_RZONE_TRACK),
179 safe_for_write(GPCMD_RESERVE_RZONE_TRACK),
180 safe_for_write(GPCMD_SEND_DVD_STRUCTURE),
181 safe_for_write(GPCMD_SEND_EVENT),
182 safe_for_write(GPCMD_SEND_KEY),
183 safe_for_write(GPCMD_SEND_OPC),
184 safe_for_write(GPCMD_SEND_CUE_SHEET),
185 safe_for_write(GPCMD_SET_SPEED),
186 safe_for_write(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL),
187 safe_for_write(GPCMD_LOAD_UNLOAD),
188 safe_for_write(GPCMD_SET_STREAMING),
189 };
190 unsigned char type = cmd_type[cmd[0]];
191
192 /* Anybody who can open the device can do a read-safe command */
193 if (type & CMD_READ_SAFE)
194 return 0;
195
196 /* Write-safe commands just require a writable open.. */
197 if (type & CMD_WRITE_SAFE) {
198 if (file->f_mode & FMODE_WRITE)
199 return 0;
200 }
201
202 if (!type) {
203 cmd_type[cmd[0]] = CMD_WARNED;
204 printk(KERN_WARNING "scsi: unknown opcode 0x%02x\n", cmd[0]);
205 }
206
207 /* And root can do any command.. */
208 if (capable(CAP_SYS_RAWIO))
209 return 0;
210
211 /* Otherwise fail it with an "Operation not permitted" */
212 return -EPERM;
213}
214
215static int sg_io(struct file *file, request_queue_t *q,
216 struct gendisk *bd_disk, struct sg_io_hdr *hdr)
217{
218 unsigned long start_time;
219 int reading, writing;
220 struct request *rq;
221 struct bio *bio;
222 char sense[SCSI_SENSE_BUFFERSIZE];
223 unsigned char cmd[BLK_MAX_CDB];
224
225 if (hdr->interface_id != 'S')
226 return -EINVAL;
227 if (hdr->cmd_len > BLK_MAX_CDB)
228 return -EINVAL;
229 if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
230 return -EFAULT;
231 if (verify_command(file, cmd))
232 return -EPERM;
233
234 /*
235 * we'll do that later
236 */
237 if (hdr->iovec_count)
238 return -EOPNOTSUPP;
239
240 if (hdr->dxfer_len > (q->max_sectors << 9))
241 return -EIO;
242
243 reading = writing = 0;
244 if (hdr->dxfer_len) {
245 switch (hdr->dxfer_direction) {
246 default:
247 return -EINVAL;
248 case SG_DXFER_TO_FROM_DEV:
249 reading = 1;
250 /* fall through */
251 case SG_DXFER_TO_DEV:
252 writing = 1;
253 break;
254 case SG_DXFER_FROM_DEV:
255 reading = 1;
256 break;
257 }
258
259 rq = blk_rq_map_user(q, writing ? WRITE : READ, hdr->dxferp,
260 hdr->dxfer_len);
261
262 if (IS_ERR(rq))
263 return PTR_ERR(rq);
264 } else
265 rq = blk_get_request(q, READ, __GFP_WAIT);
266
267 /*
268 * fill in request structure
269 */
270 rq->cmd_len = hdr->cmd_len;
271 memcpy(rq->cmd, cmd, hdr->cmd_len);
272 if (sizeof(rq->cmd) != hdr->cmd_len)
273 memset(rq->cmd + hdr->cmd_len, 0, sizeof(rq->cmd) - hdr->cmd_len);
274
275 memset(sense, 0, sizeof(sense));
276 rq->sense = sense;
277 rq->sense_len = 0;
278
279 rq->flags |= REQ_BLOCK_PC;
280 bio = rq->bio;
281
282 /*
283 * bounce this after holding a reference to the original bio, it's
284 * needed for proper unmapping
285 */
286 if (rq->bio)
287 blk_queue_bounce(q, &rq->bio);
288
289 rq->timeout = (hdr->timeout * HZ) / 1000;
290 if (!rq->timeout)
291 rq->timeout = q->sg_timeout;
292 if (!rq->timeout)
293 rq->timeout = BLK_DEFAULT_TIMEOUT;
294
295 start_time = jiffies;
296
297 /* ignore return value. All information is passed back to caller
298 * (if he doesn't check that is his problem).
299 * N.B. a non-zero SCSI status is _not_ necessarily an error.
300 */
301 blk_execute_rq(q, bd_disk, rq);
302
303 /* write to all output members */
304 hdr->status = 0xff & rq->errors;
305 hdr->masked_status = status_byte(rq->errors);
306 hdr->msg_status = msg_byte(rq->errors);
307 hdr->host_status = host_byte(rq->errors);
308 hdr->driver_status = driver_byte(rq->errors);
309 hdr->info = 0;
310 if (hdr->masked_status || hdr->host_status || hdr->driver_status)
311 hdr->info |= SG_INFO_CHECK;
312 hdr->resid = rq->data_len;
313 hdr->duration = ((jiffies - start_time) * 1000) / HZ;
314 hdr->sb_len_wr = 0;
315
316 if (rq->sense_len && hdr->sbp) {
317 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
318
319 if (!copy_to_user(hdr->sbp, rq->sense, len))
320 hdr->sb_len_wr = len;
321 }
322
323 if (blk_rq_unmap_user(rq, bio, hdr->dxfer_len))
324 return -EFAULT;
325
326 /* may not have succeeded, but output values written to control
327 * structure (struct sg_io_hdr). */
328 return 0;
329}
330
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331#define OMAX_SB_LEN 16 /* For backward compatibility */
332
333static int sg_scsi_ioctl(struct file *file, request_queue_t *q,
334 struct gendisk *bd_disk, Scsi_Ioctl_Command __user *sic)
335{
336 struct request *rq;
337 int err;
338 unsigned int in_len, out_len, bytes, opcode, cmdlen;
339 char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
340
341 /*
342 * get in an out lengths, verify they don't exceed a page worth of data
343 */
344 if (get_user(in_len, &sic->inlen))
345 return -EFAULT;
346 if (get_user(out_len, &sic->outlen))
347 return -EFAULT;
348 if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
349 return -EINVAL;
350 if (get_user(opcode, sic->data))
351 return -EFAULT;
352
353 bytes = max(in_len, out_len);
354 if (bytes) {
355 buffer = kmalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN);
356 if (!buffer)
357 return -ENOMEM;
358
359 memset(buffer, 0, bytes);
360 }
361
362 rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
363
364 cmdlen = COMMAND_SIZE(opcode);
365
366 /*
367 * get command and data to send to device, if any
368 */
369 err = -EFAULT;
370 rq->cmd_len = cmdlen;
371 if (copy_from_user(rq->cmd, sic->data, cmdlen))
372 goto error;
373
374 if (copy_from_user(buffer, sic->data + cmdlen, in_len))
375 goto error;
376
377 err = verify_command(file, rq->cmd);
378 if (err)
379 goto error;
380
381 switch (opcode) {
382 case SEND_DIAGNOSTIC:
383 case FORMAT_UNIT:
384 rq->timeout = FORMAT_UNIT_TIMEOUT;
385 break;
386 case START_STOP:
387 rq->timeout = START_STOP_TIMEOUT;
388 break;
389 case MOVE_MEDIUM:
390 rq->timeout = MOVE_MEDIUM_TIMEOUT;
391 break;
392 case READ_ELEMENT_STATUS:
393 rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
394 break;
395 case READ_DEFECT_DATA:
396 rq->timeout = READ_DEFECT_DATA_TIMEOUT;
397 break;
398 default:
399 rq->timeout = BLK_DEFAULT_TIMEOUT;
400 break;
401 }
402
403 memset(sense, 0, sizeof(sense));
404 rq->sense = sense;
405 rq->sense_len = 0;
406
407 rq->data = buffer;
408 rq->data_len = bytes;
409 rq->flags |= REQ_BLOCK_PC;
410
411 blk_execute_rq(q, bd_disk, rq);
412 err = rq->errors & 0xff; /* only 8 bit SCSI status */
413 if (err) {
414 if (rq->sense_len && rq->sense) {
415 bytes = (OMAX_SB_LEN > rq->sense_len) ?
416 rq->sense_len : OMAX_SB_LEN;
417 if (copy_to_user(sic->data, rq->sense, bytes))
418 err = -EFAULT;
419 }
420 } else {
421 if (copy_to_user(sic->data, buffer, out_len))
422 err = -EFAULT;
423 }
424
425error:
426 kfree(buffer);
427 blk_put_request(rq);
428 return err;
429}
430
431int scsi_cmd_ioctl(struct file *file, struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
432{
433 request_queue_t *q;
434 struct request *rq;
435 int close = 0, err;
436
437 q = bd_disk->queue;
438 if (!q)
439 return -ENXIO;
440
441 if (blk_get_queue(q))
442 return -ENXIO;
443
444 switch (cmd) {
445 /*
446 * new sgv3 interface
447 */
448 case SG_GET_VERSION_NUM:
449 err = sg_get_version(arg);
450 break;
451 case SCSI_IOCTL_GET_IDLUN:
452 err = scsi_get_idlun(q, arg);
453 break;
454 case SCSI_IOCTL_GET_BUS_NUMBER:
455 err = scsi_get_bus(q, arg);
456 break;
457 case SG_SET_TIMEOUT:
458 err = sg_set_timeout(q, arg);
459 break;
460 case SG_GET_TIMEOUT:
461 err = sg_get_timeout(q);
462 break;
463 case SG_GET_RESERVED_SIZE:
464 err = sg_get_reserved_size(q, arg);
465 break;
466 case SG_SET_RESERVED_SIZE:
467 err = sg_set_reserved_size(q, arg);
468 break;
469 case SG_EMULATED_HOST:
470 err = sg_emulated_host(q, arg);
471 break;
472 case SG_IO: {
473 struct sg_io_hdr hdr;
474
475 err = -EFAULT;
476 if (copy_from_user(&hdr, arg, sizeof(hdr)))
477 break;
478 err = sg_io(file, q, bd_disk, &hdr);
479 if (err == -EFAULT)
480 break;
481
482 if (copy_to_user(arg, &hdr, sizeof(hdr)))
483 err = -EFAULT;
484 break;
485 }
486 case CDROM_SEND_PACKET: {
487 struct cdrom_generic_command cgc;
488 struct sg_io_hdr hdr;
489
490 err = -EFAULT;
491 if (copy_from_user(&cgc, arg, sizeof(cgc)))
492 break;
493 cgc.timeout = clock_t_to_jiffies(cgc.timeout);
494 memset(&hdr, 0, sizeof(hdr));
495 hdr.interface_id = 'S';
496 hdr.cmd_len = sizeof(cgc.cmd);
497 hdr.dxfer_len = cgc.buflen;
498 err = 0;
499 switch (cgc.data_direction) {
500 case CGC_DATA_UNKNOWN:
501 hdr.dxfer_direction = SG_DXFER_UNKNOWN;
502 break;
503 case CGC_DATA_WRITE:
504 hdr.dxfer_direction = SG_DXFER_TO_DEV;
505 break;
506 case CGC_DATA_READ:
507 hdr.dxfer_direction = SG_DXFER_FROM_DEV;
508 break;
509 case CGC_DATA_NONE:
510 hdr.dxfer_direction = SG_DXFER_NONE;
511 break;
512 default:
513 err = -EINVAL;
514 }
515 if (err)
516 break;
517
518 hdr.dxferp = cgc.buffer;
519 hdr.sbp = cgc.sense;
520 if (hdr.sbp)
521 hdr.mx_sb_len = sizeof(struct request_sense);
522 hdr.timeout = cgc.timeout;
523 hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
524 hdr.cmd_len = sizeof(cgc.cmd);
525
526 err = sg_io(file, q, bd_disk, &hdr);
527 if (err == -EFAULT)
528 break;
529
530 if (hdr.status)
531 err = -EIO;
532
533 cgc.stat = err;
534 cgc.buflen = hdr.resid;
535 if (copy_to_user(arg, &cgc, sizeof(cgc)))
536 err = -EFAULT;
537
538 break;
539 }
540
541 /*
542 * old junk scsi send command ioctl
543 */
544 case SCSI_IOCTL_SEND_COMMAND:
545 printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm);
546 err = -EINVAL;
547 if (!arg)
548 break;
549
550 err = sg_scsi_ioctl(file, q, bd_disk, arg);
551 break;
552 case CDROMCLOSETRAY:
553 close = 1;
554 case CDROMEJECT:
555 rq = blk_get_request(q, WRITE, __GFP_WAIT);
556 rq->flags |= REQ_BLOCK_PC;
557 rq->data = NULL;
558 rq->data_len = 0;
559 rq->timeout = BLK_DEFAULT_TIMEOUT;
560 memset(rq->cmd, 0, sizeof(rq->cmd));
561 rq->cmd[0] = GPCMD_START_STOP_UNIT;
562 rq->cmd[4] = 0x02 + (close != 0);
563 rq->cmd_len = 6;
564 err = blk_execute_rq(q, bd_disk, rq);
565 blk_put_request(rq);
566 break;
567 default:
568 err = -ENOTTY;
569 }
570
571 blk_put_queue(q);
572 return err;
573}
574
575EXPORT_SYMBOL(scsi_cmd_ioctl);