Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 1 | /* |
| 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.Dunlap | c59ede7 | 2006-01-11 12:17:46 -0800 | [diff] [blame] | 24 | #include <linux/capability.h> |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 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> |
| 30 | |
| 31 | #include <scsi/scsi.h> |
| 32 | #include <scsi/scsi_ioctl.h> |
| 33 | #include <scsi/scsi_cmnd.h> |
| 34 | |
| 35 | /* Command group 3 is reserved and should never be used. */ |
| 36 | const unsigned char scsi_command_size[8] = |
| 37 | { |
| 38 | 6, 10, 10, 12, |
| 39 | 16, 12, 10, 10 |
| 40 | }; |
| 41 | |
| 42 | EXPORT_SYMBOL(scsi_command_size); |
| 43 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 44 | #include <scsi/sg.h> |
| 45 | |
| 46 | static int sg_get_version(int __user *p) |
| 47 | { |
Arjan van de Ven | 6410009 | 2006-01-06 09:46:02 +0100 | [diff] [blame] | 48 | static const int sg_version_num = 30527; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 49 | return put_user(sg_version_num, p); |
| 50 | } |
| 51 | |
| 52 | static int scsi_get_idlun(request_queue_t *q, int __user *p) |
| 53 | { |
| 54 | return put_user(0, p); |
| 55 | } |
| 56 | |
| 57 | static int scsi_get_bus(request_queue_t *q, int __user *p) |
| 58 | { |
| 59 | return put_user(0, p); |
| 60 | } |
| 61 | |
| 62 | static int sg_get_timeout(request_queue_t *q) |
| 63 | { |
| 64 | return q->sg_timeout / (HZ / USER_HZ); |
| 65 | } |
| 66 | |
| 67 | static int sg_set_timeout(request_queue_t *q, int __user *p) |
| 68 | { |
| 69 | int timeout, err = get_user(timeout, p); |
| 70 | |
| 71 | if (!err) |
| 72 | q->sg_timeout = timeout * (HZ / USER_HZ); |
| 73 | |
| 74 | return err; |
| 75 | } |
| 76 | |
| 77 | static int sg_get_reserved_size(request_queue_t *q, int __user *p) |
| 78 | { |
Alan Stern | 44ec954 | 2007-02-20 11:01:57 -0500 | [diff] [blame] | 79 | unsigned val = min(q->sg_reserved_size, q->max_sectors << 9); |
| 80 | |
| 81 | return put_user(val, p); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 82 | } |
| 83 | |
| 84 | static int sg_set_reserved_size(request_queue_t *q, int __user *p) |
| 85 | { |
| 86 | int size, err = get_user(size, p); |
| 87 | |
| 88 | if (err) |
| 89 | return err; |
| 90 | |
| 91 | if (size < 0) |
| 92 | return -EINVAL; |
| 93 | if (size > (q->max_sectors << 9)) |
| 94 | size = q->max_sectors << 9; |
| 95 | |
| 96 | q->sg_reserved_size = size; |
| 97 | return 0; |
| 98 | } |
| 99 | |
| 100 | /* |
| 101 | * will always return that we are ATAPI even for a real SCSI drive, I'm not |
| 102 | * so sure this is worth doing anything about (why would you care??) |
| 103 | */ |
| 104 | static int sg_emulated_host(request_queue_t *q, int __user *p) |
| 105 | { |
| 106 | return put_user(1, p); |
| 107 | } |
| 108 | |
| 109 | #define CMD_READ_SAFE 0x01 |
| 110 | #define CMD_WRITE_SAFE 0x02 |
| 111 | #define CMD_WARNED 0x04 |
| 112 | #define safe_for_read(cmd) [cmd] = CMD_READ_SAFE |
| 113 | #define safe_for_write(cmd) [cmd] = CMD_WRITE_SAFE |
| 114 | |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 115 | static int verify_command(unsigned char *cmd, int has_write_perm) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 116 | { |
| 117 | static unsigned char cmd_type[256] = { |
| 118 | |
| 119 | /* Basic read-only commands */ |
| 120 | safe_for_read(TEST_UNIT_READY), |
| 121 | safe_for_read(REQUEST_SENSE), |
| 122 | safe_for_read(READ_6), |
| 123 | safe_for_read(READ_10), |
| 124 | safe_for_read(READ_12), |
| 125 | safe_for_read(READ_16), |
| 126 | safe_for_read(READ_BUFFER), |
Douglas Gilbert | 942fc2f | 2005-09-09 20:07:32 +1000 | [diff] [blame] | 127 | safe_for_read(READ_DEFECT_DATA), |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 128 | safe_for_read(READ_LONG), |
| 129 | safe_for_read(INQUIRY), |
| 130 | safe_for_read(MODE_SENSE), |
| 131 | safe_for_read(MODE_SENSE_10), |
| 132 | safe_for_read(LOG_SENSE), |
| 133 | safe_for_read(START_STOP), |
| 134 | safe_for_read(GPCMD_VERIFY_10), |
| 135 | safe_for_read(VERIFY_16), |
| 136 | |
| 137 | /* Audio CD commands */ |
| 138 | safe_for_read(GPCMD_PLAY_CD), |
| 139 | safe_for_read(GPCMD_PLAY_AUDIO_10), |
| 140 | safe_for_read(GPCMD_PLAY_AUDIO_MSF), |
| 141 | safe_for_read(GPCMD_PLAY_AUDIO_TI), |
| 142 | safe_for_read(GPCMD_PAUSE_RESUME), |
| 143 | |
| 144 | /* CD/DVD data reading */ |
| 145 | safe_for_read(GPCMD_READ_BUFFER_CAPACITY), |
| 146 | safe_for_read(GPCMD_READ_CD), |
| 147 | safe_for_read(GPCMD_READ_CD_MSF), |
| 148 | safe_for_read(GPCMD_READ_DISC_INFO), |
| 149 | safe_for_read(GPCMD_READ_CDVD_CAPACITY), |
| 150 | safe_for_read(GPCMD_READ_DVD_STRUCTURE), |
| 151 | safe_for_read(GPCMD_READ_HEADER), |
| 152 | safe_for_read(GPCMD_READ_TRACK_RZONE_INFO), |
| 153 | safe_for_read(GPCMD_READ_SUBCHANNEL), |
| 154 | safe_for_read(GPCMD_READ_TOC_PMA_ATIP), |
| 155 | safe_for_read(GPCMD_REPORT_KEY), |
| 156 | safe_for_read(GPCMD_SCAN), |
| 157 | safe_for_read(GPCMD_GET_CONFIGURATION), |
| 158 | safe_for_read(GPCMD_READ_FORMAT_CAPACITIES), |
| 159 | safe_for_read(GPCMD_GET_EVENT_STATUS_NOTIFICATION), |
| 160 | safe_for_read(GPCMD_GET_PERFORMANCE), |
| 161 | safe_for_read(GPCMD_SEEK), |
| 162 | safe_for_read(GPCMD_STOP_PLAY_SCAN), |
| 163 | |
| 164 | /* Basic writing commands */ |
| 165 | safe_for_write(WRITE_6), |
| 166 | safe_for_write(WRITE_10), |
| 167 | safe_for_write(WRITE_VERIFY), |
| 168 | safe_for_write(WRITE_12), |
| 169 | safe_for_write(WRITE_VERIFY_12), |
| 170 | safe_for_write(WRITE_16), |
| 171 | safe_for_write(WRITE_LONG), |
Thomas Maguin | 0faf3d3 | 2005-09-16 19:27:58 -0700 | [diff] [blame] | 172 | safe_for_write(WRITE_LONG_2), |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 173 | safe_for_write(ERASE), |
| 174 | safe_for_write(GPCMD_MODE_SELECT_10), |
| 175 | safe_for_write(MODE_SELECT), |
| 176 | safe_for_write(LOG_SELECT), |
| 177 | safe_for_write(GPCMD_BLANK), |
| 178 | safe_for_write(GPCMD_CLOSE_TRACK), |
| 179 | safe_for_write(GPCMD_FLUSH_CACHE), |
| 180 | safe_for_write(GPCMD_FORMAT_UNIT), |
| 181 | safe_for_write(GPCMD_REPAIR_RZONE_TRACK), |
| 182 | safe_for_write(GPCMD_RESERVE_RZONE_TRACK), |
| 183 | safe_for_write(GPCMD_SEND_DVD_STRUCTURE), |
| 184 | safe_for_write(GPCMD_SEND_EVENT), |
| 185 | safe_for_write(GPCMD_SEND_KEY), |
| 186 | safe_for_write(GPCMD_SEND_OPC), |
| 187 | safe_for_write(GPCMD_SEND_CUE_SHEET), |
| 188 | safe_for_write(GPCMD_SET_SPEED), |
| 189 | safe_for_write(GPCMD_PREVENT_ALLOW_MEDIUM_REMOVAL), |
| 190 | safe_for_write(GPCMD_LOAD_UNLOAD), |
| 191 | safe_for_write(GPCMD_SET_STREAMING), |
| 192 | }; |
| 193 | unsigned char type = cmd_type[cmd[0]]; |
| 194 | |
| 195 | /* Anybody who can open the device can do a read-safe command */ |
| 196 | if (type & CMD_READ_SAFE) |
| 197 | return 0; |
| 198 | |
| 199 | /* Write-safe commands just require a writable open.. */ |
Jens Axboe | 5a57be8 | 2006-01-09 14:52:21 +0100 | [diff] [blame] | 200 | if ((type & CMD_WRITE_SAFE) && has_write_perm) |
| 201 | return 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 202 | |
Jens Axboe | 3b0e77b | 2005-10-07 19:41:34 +0200 | [diff] [blame] | 203 | /* And root can do any command.. */ |
| 204 | if (capable(CAP_SYS_RAWIO)) |
| 205 | return 0; |
| 206 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 207 | if (!type) { |
| 208 | cmd_type[cmd[0]] = CMD_WARNED; |
| 209 | printk(KERN_WARNING "scsi: unknown opcode 0x%02x\n", cmd[0]); |
| 210 | } |
| 211 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 212 | /* Otherwise fail it with an "Operation not permitted" */ |
| 213 | return -EPERM; |
| 214 | } |
| 215 | |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 216 | int blk_fill_sghdr_rq(request_queue_t *q, struct request *rq, |
| 217 | struct sg_io_hdr *hdr, int has_write_perm) |
| 218 | { |
| 219 | memset(rq->cmd, 0, BLK_MAX_CDB); /* ATAPI hates garbage after CDB */ |
| 220 | |
| 221 | if (copy_from_user(rq->cmd, hdr->cmdp, hdr->cmd_len)) |
| 222 | return -EFAULT; |
| 223 | if (verify_command(rq->cmd, has_write_perm)) |
| 224 | return -EPERM; |
| 225 | |
| 226 | /* |
| 227 | * fill in request structure |
| 228 | */ |
| 229 | rq->cmd_len = hdr->cmd_len; |
| 230 | rq->cmd_type = REQ_TYPE_BLOCK_PC; |
| 231 | |
| 232 | rq->timeout = (hdr->timeout * HZ) / 1000; |
| 233 | if (!rq->timeout) |
| 234 | rq->timeout = q->sg_timeout; |
| 235 | if (!rq->timeout) |
| 236 | rq->timeout = BLK_DEFAULT_SG_TIMEOUT; |
| 237 | |
| 238 | return 0; |
| 239 | } |
| 240 | EXPORT_SYMBOL_GPL(blk_fill_sghdr_rq); |
| 241 | |
| 242 | /* |
| 243 | * unmap a request that was previously mapped to this sg_io_hdr. handles |
| 244 | * both sg and non-sg sg_io_hdr. |
| 245 | */ |
| 246 | int blk_unmap_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr) |
| 247 | { |
| 248 | struct bio *bio = rq->bio; |
| 249 | |
| 250 | /* |
| 251 | * also releases request |
| 252 | */ |
| 253 | if (!hdr->iovec_count) |
| 254 | return blk_rq_unmap_user(bio, hdr->dxfer_len); |
| 255 | |
| 256 | rq_for_each_bio(bio, rq) |
| 257 | bio_unmap_user(bio); |
| 258 | |
| 259 | blk_put_request(rq); |
| 260 | return 0; |
| 261 | } |
| 262 | EXPORT_SYMBOL_GPL(blk_unmap_sghdr_rq); |
| 263 | |
| 264 | int blk_complete_sghdr_rq(struct request *rq, struct sg_io_hdr *hdr, |
| 265 | struct bio *bio) |
| 266 | { |
| 267 | int r, ret = 0; |
| 268 | |
| 269 | /* |
| 270 | * fill in all the output members |
| 271 | */ |
| 272 | hdr->status = rq->errors & 0xff; |
| 273 | hdr->masked_status = status_byte(rq->errors); |
| 274 | hdr->msg_status = msg_byte(rq->errors); |
| 275 | hdr->host_status = host_byte(rq->errors); |
| 276 | hdr->driver_status = driver_byte(rq->errors); |
| 277 | hdr->info = 0; |
| 278 | if (hdr->masked_status || hdr->host_status || hdr->driver_status) |
| 279 | hdr->info |= SG_INFO_CHECK; |
| 280 | hdr->resid = rq->data_len; |
| 281 | hdr->sb_len_wr = 0; |
| 282 | |
| 283 | if (rq->sense_len && hdr->sbp) { |
| 284 | int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len); |
| 285 | |
| 286 | if (!copy_to_user(hdr->sbp, rq->sense, len)) |
| 287 | hdr->sb_len_wr = len; |
| 288 | else |
| 289 | ret = -EFAULT; |
| 290 | } |
| 291 | |
| 292 | rq->bio = bio; |
| 293 | r = blk_unmap_sghdr_rq(rq, hdr); |
| 294 | if (ret) |
| 295 | r = ret; |
| 296 | |
| 297 | return r; |
| 298 | } |
| 299 | EXPORT_SYMBOL_GPL(blk_complete_sghdr_rq); |
| 300 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 301 | static int sg_io(struct file *file, request_queue_t *q, |
| 302 | struct gendisk *bd_disk, struct sg_io_hdr *hdr) |
| 303 | { |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 304 | unsigned long start_time; |
| 305 | int writing = 0, ret = 0, has_write_perm = 0; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 306 | struct request *rq; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 307 | char sense[SCSI_SENSE_BUFFERSIZE]; |
FUJITA Tomonori | 77d172c | 2006-12-11 10:01:34 +0100 | [diff] [blame] | 308 | struct bio *bio; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 309 | |
| 310 | if (hdr->interface_id != 'S') |
| 311 | return -EINVAL; |
| 312 | if (hdr->cmd_len > BLK_MAX_CDB) |
| 313 | return -EINVAL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 314 | |
Mike Christie | defd94b | 2005-12-05 02:37:06 -0600 | [diff] [blame] | 315 | if (hdr->dxfer_len > (q->max_hw_sectors << 9)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 316 | return -EIO; |
| 317 | |
James Bottomley | f1970ba | 2005-06-20 14:06:52 +0200 | [diff] [blame] | 318 | if (hdr->dxfer_len) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 319 | switch (hdr->dxfer_direction) { |
| 320 | default: |
| 321 | return -EINVAL; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 322 | case SG_DXFER_TO_DEV: |
| 323 | writing = 1; |
| 324 | break; |
Jens Axboe | 616e8a0 | 2006-11-13 18:04:59 +0100 | [diff] [blame] | 325 | case SG_DXFER_TO_FROM_DEV: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 326 | case SG_DXFER_FROM_DEV: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 327 | break; |
| 328 | } |
| 329 | |
Jens Axboe | dd1cab9 | 2005-06-20 14:06:01 +0200 | [diff] [blame] | 330 | rq = blk_get_request(q, writing ? WRITE : READ, GFP_KERNEL); |
| 331 | if (!rq) |
| 332 | return -ENOMEM; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 333 | |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 334 | if (file) |
| 335 | has_write_perm = file->f_mode & FMODE_WRITE; |
Mike Christie | 0e75f90 | 2006-12-01 10:40:55 +0100 | [diff] [blame] | 336 | |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 337 | if (blk_fill_sghdr_rq(q, rq, hdr, has_write_perm)) { |
| 338 | blk_rq_unmap_user(bio, hdr->dxfer_len); |
| 339 | blk_put_request(rq); |
| 340 | return -EFAULT; |
| 341 | } |
Mike Christie | 0e75f90 | 2006-12-01 10:40:55 +0100 | [diff] [blame] | 342 | |
James Bottomley | f1970ba | 2005-06-20 14:06:52 +0200 | [diff] [blame] | 343 | if (hdr->iovec_count) { |
| 344 | const int size = sizeof(struct sg_iovec) * hdr->iovec_count; |
| 345 | struct sg_iovec *iov; |
| 346 | |
| 347 | iov = kmalloc(size, GFP_KERNEL); |
| 348 | if (!iov) { |
| 349 | ret = -ENOMEM; |
Jens Axboe | dd1cab9 | 2005-06-20 14:06:01 +0200 | [diff] [blame] | 350 | goto out; |
James Bottomley | f1970ba | 2005-06-20 14:06:52 +0200 | [diff] [blame] | 351 | } |
| 352 | |
| 353 | if (copy_from_user(iov, hdr->dxferp, size)) { |
| 354 | kfree(iov); |
| 355 | ret = -EFAULT; |
| 356 | goto out; |
| 357 | } |
| 358 | |
Mike Christie | 0e75f90 | 2006-12-01 10:40:55 +0100 | [diff] [blame] | 359 | ret = blk_rq_map_user_iov(q, rq, iov, hdr->iovec_count, |
| 360 | hdr->dxfer_len); |
James Bottomley | f1970ba | 2005-06-20 14:06:52 +0200 | [diff] [blame] | 361 | kfree(iov); |
| 362 | } else if (hdr->dxfer_len) |
| 363 | ret = blk_rq_map_user(q, rq, hdr->dxferp, hdr->dxfer_len); |
| 364 | |
| 365 | if (ret) |
| 366 | goto out; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 367 | |
FUJITA Tomonori | 77d172c | 2006-12-11 10:01:34 +0100 | [diff] [blame] | 368 | bio = rq->bio; |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 369 | memset(sense, 0, sizeof(sense)); |
| 370 | rq->sense = sense; |
| 371 | rq->sense_len = 0; |
Jens Axboe | 01840f9 | 2006-02-03 08:37:08 +0100 | [diff] [blame] | 372 | rq->retries = 0; |
| 373 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 374 | start_time = jiffies; |
| 375 | |
| 376 | /* ignore return value. All information is passed back to caller |
| 377 | * (if he doesn't check that is his problem). |
| 378 | * N.B. a non-zero SCSI status is _not_ necessarily an error. |
| 379 | */ |
James Bottomley | 994ca9a | 2005-06-20 14:11:09 +0200 | [diff] [blame] | 380 | blk_execute_rq(q, bd_disk, rq, 0); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 381 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 382 | hdr->duration = ((jiffies - start_time) * 1000) / HZ; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 383 | |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 384 | return blk_complete_sghdr_rq(rq, hdr, bio); |
Jens Axboe | dd1cab9 | 2005-06-20 14:06:01 +0200 | [diff] [blame] | 385 | out: |
| 386 | blk_put_request(rq); |
| 387 | return ret; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 388 | } |
| 389 | |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 390 | /** |
| 391 | * sg_scsi_ioctl -- handle deprecated SCSI_IOCTL_SEND_COMMAND ioctl |
| 392 | * @file: file this ioctl operates on (optional) |
| 393 | * @q: request queue to send scsi commands down |
| 394 | * @disk: gendisk to operate on (option) |
| 395 | * @sic: userspace structure describing the command to perform |
| 396 | * |
| 397 | * Send down the scsi command described by @sic to the device below |
| 398 | * the request queue @q. If @file is non-NULL it's used to perform |
| 399 | * fine-grained permission checks that allow users to send down |
| 400 | * non-destructive SCSI commands. If the caller has a struct gendisk |
| 401 | * available it should be passed in as @disk to allow the low level |
| 402 | * driver to use the information contained in it. A non-NULL @disk |
| 403 | * is only allowed if the caller knows that the low level driver doesn't |
| 404 | * need it (e.g. in the scsi subsystem). |
| 405 | * |
| 406 | * Notes: |
| 407 | * - This interface is deprecated - users should use the SG_IO |
| 408 | * interface instead, as this is a more flexible approach to |
| 409 | * performing SCSI commands on a device. |
| 410 | * - The SCSI command length is determined by examining the 1st byte |
| 411 | * of the given command. There is no way to override this. |
| 412 | * - Data transfers are limited to PAGE_SIZE |
| 413 | * - The length (x + y) must be at least OMAX_SB_LEN bytes long to |
| 414 | * accommodate the sense buffer when an error occurs. |
| 415 | * The sense buffer is truncated to OMAX_SB_LEN (16) bytes so that |
| 416 | * old code will not be surprised. |
| 417 | * - If a Unix error occurs (e.g. ENOMEM) then the user will receive |
| 418 | * a negative return and the Unix error code in 'errno'. |
| 419 | * If the SCSI command succeeds then 0 is returned. |
| 420 | * Positive numbers returned are the compacted SCSI error codes (4 |
| 421 | * bytes in one int) where the lowest byte is the SCSI status. |
| 422 | */ |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 423 | #define OMAX_SB_LEN 16 /* For backward compatibility */ |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 424 | int sg_scsi_ioctl(struct file *file, struct request_queue *q, |
| 425 | struct gendisk *disk, struct scsi_ioctl_command __user *sic) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 426 | { |
| 427 | struct request *rq; |
| 428 | int err; |
| 429 | unsigned int in_len, out_len, bytes, opcode, cmdlen; |
| 430 | char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE]; |
| 431 | |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 432 | if (!sic) |
| 433 | return -EINVAL; |
| 434 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 435 | /* |
| 436 | * get in an out lengths, verify they don't exceed a page worth of data |
| 437 | */ |
| 438 | if (get_user(in_len, &sic->inlen)) |
| 439 | return -EFAULT; |
| 440 | if (get_user(out_len, &sic->outlen)) |
| 441 | return -EFAULT; |
| 442 | if (in_len > PAGE_SIZE || out_len > PAGE_SIZE) |
| 443 | return -EINVAL; |
| 444 | if (get_user(opcode, sic->data)) |
| 445 | return -EFAULT; |
| 446 | |
| 447 | bytes = max(in_len, out_len); |
| 448 | if (bytes) { |
| 449 | buffer = kmalloc(bytes, q->bounce_gfp | GFP_USER| __GFP_NOWARN); |
| 450 | if (!buffer) |
| 451 | return -ENOMEM; |
| 452 | |
| 453 | memset(buffer, 0, bytes); |
| 454 | } |
| 455 | |
| 456 | rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT); |
| 457 | |
| 458 | cmdlen = COMMAND_SIZE(opcode); |
| 459 | |
| 460 | /* |
| 461 | * get command and data to send to device, if any |
| 462 | */ |
| 463 | err = -EFAULT; |
| 464 | rq->cmd_len = cmdlen; |
| 465 | if (copy_from_user(rq->cmd, sic->data, cmdlen)) |
| 466 | goto error; |
| 467 | |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 468 | if (in_len && copy_from_user(buffer, sic->data + cmdlen, in_len)) |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 469 | goto error; |
| 470 | |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 471 | err = verify_command(rq->cmd, file->f_mode & FMODE_WRITE); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 472 | if (err) |
| 473 | goto error; |
| 474 | |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 475 | /* default. possible overriden later */ |
| 476 | rq->retries = 5; |
| 477 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 478 | switch (opcode) { |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 479 | case SEND_DIAGNOSTIC: |
| 480 | case FORMAT_UNIT: |
| 481 | rq->timeout = FORMAT_UNIT_TIMEOUT; |
| 482 | rq->retries = 1; |
| 483 | break; |
| 484 | case START_STOP: |
| 485 | rq->timeout = START_STOP_TIMEOUT; |
| 486 | break; |
| 487 | case MOVE_MEDIUM: |
| 488 | rq->timeout = MOVE_MEDIUM_TIMEOUT; |
| 489 | break; |
| 490 | case READ_ELEMENT_STATUS: |
| 491 | rq->timeout = READ_ELEMENT_STATUS_TIMEOUT; |
| 492 | break; |
| 493 | case READ_DEFECT_DATA: |
| 494 | rq->timeout = READ_DEFECT_DATA_TIMEOUT; |
| 495 | rq->retries = 1; |
| 496 | break; |
| 497 | default: |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 498 | rq->timeout = BLK_DEFAULT_SG_TIMEOUT; |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 499 | break; |
| 500 | } |
| 501 | |
| 502 | if (bytes && blk_rq_map_kern(q, rq, buffer, bytes, __GFP_WAIT)) { |
| 503 | err = DRIVER_ERROR << 24; |
| 504 | goto out; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 505 | } |
| 506 | |
| 507 | memset(sense, 0, sizeof(sense)); |
| 508 | rq->sense = sense; |
| 509 | rq->sense_len = 0; |
Jens Axboe | 4aff5e2 | 2006-08-10 08:44:47 +0200 | [diff] [blame] | 510 | rq->cmd_type = REQ_TYPE_BLOCK_PC; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 511 | |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 512 | blk_execute_rq(q, disk, rq, 0); |
| 513 | |
| 514 | out: |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 515 | err = rq->errors & 0xff; /* only 8 bit SCSI status */ |
| 516 | if (err) { |
| 517 | if (rq->sense_len && rq->sense) { |
| 518 | bytes = (OMAX_SB_LEN > rq->sense_len) ? |
| 519 | rq->sense_len : OMAX_SB_LEN; |
| 520 | if (copy_to_user(sic->data, rq->sense, bytes)) |
| 521 | err = -EFAULT; |
| 522 | } |
| 523 | } else { |
| 524 | if (copy_to_user(sic->data, buffer, out_len)) |
| 525 | err = -EFAULT; |
| 526 | } |
| 527 | |
| 528 | error: |
| 529 | kfree(buffer); |
| 530 | blk_put_request(rq); |
| 531 | return err; |
| 532 | } |
Christoph Hellwig | 21b2f0c | 2006-03-22 17:52:04 +0100 | [diff] [blame] | 533 | EXPORT_SYMBOL_GPL(sg_scsi_ioctl); |
Ben Collins | f98d2df | 2005-12-19 11:49:24 -0800 | [diff] [blame] | 534 | |
| 535 | /* Send basic block requests */ |
| 536 | static int __blk_send_generic(request_queue_t *q, struct gendisk *bd_disk, int cmd, int data) |
| 537 | { |
| 538 | struct request *rq; |
| 539 | int err; |
| 540 | |
| 541 | rq = blk_get_request(q, WRITE, __GFP_WAIT); |
Jens Axboe | 4aff5e2 | 2006-08-10 08:44:47 +0200 | [diff] [blame] | 542 | rq->cmd_type = REQ_TYPE_BLOCK_PC; |
Ben Collins | f98d2df | 2005-12-19 11:49:24 -0800 | [diff] [blame] | 543 | rq->data = NULL; |
| 544 | rq->data_len = 0; |
Jens Axboe | 3d6392c | 2007-07-09 12:38:05 +0200 | [diff] [blame^] | 545 | rq->timeout = BLK_DEFAULT_SG_TIMEOUT; |
Ben Collins | f98d2df | 2005-12-19 11:49:24 -0800 | [diff] [blame] | 546 | memset(rq->cmd, 0, sizeof(rq->cmd)); |
| 547 | rq->cmd[0] = cmd; |
| 548 | rq->cmd[4] = data; |
| 549 | rq->cmd_len = 6; |
| 550 | err = blk_execute_rq(q, bd_disk, rq, 0); |
| 551 | blk_put_request(rq); |
| 552 | |
| 553 | return err; |
| 554 | } |
| 555 | |
| 556 | static inline int blk_send_start_stop(request_queue_t *q, struct gendisk *bd_disk, int data) |
| 557 | { |
| 558 | return __blk_send_generic(q, bd_disk, GPCMD_START_STOP_UNIT, data); |
| 559 | } |
| 560 | |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 561 | int scsi_cmd_ioctl(struct file *file, struct gendisk *bd_disk, unsigned int cmd, void __user *arg) |
| 562 | { |
| 563 | request_queue_t *q; |
Ben Collins | f98d2df | 2005-12-19 11:49:24 -0800 | [diff] [blame] | 564 | int err; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 565 | |
| 566 | q = bd_disk->queue; |
| 567 | if (!q) |
| 568 | return -ENXIO; |
| 569 | |
| 570 | if (blk_get_queue(q)) |
| 571 | return -ENXIO; |
| 572 | |
| 573 | switch (cmd) { |
| 574 | /* |
| 575 | * new sgv3 interface |
| 576 | */ |
| 577 | case SG_GET_VERSION_NUM: |
| 578 | err = sg_get_version(arg); |
| 579 | break; |
| 580 | case SCSI_IOCTL_GET_IDLUN: |
| 581 | err = scsi_get_idlun(q, arg); |
| 582 | break; |
| 583 | case SCSI_IOCTL_GET_BUS_NUMBER: |
| 584 | err = scsi_get_bus(q, arg); |
| 585 | break; |
| 586 | case SG_SET_TIMEOUT: |
| 587 | err = sg_set_timeout(q, arg); |
| 588 | break; |
| 589 | case SG_GET_TIMEOUT: |
| 590 | err = sg_get_timeout(q); |
| 591 | break; |
| 592 | case SG_GET_RESERVED_SIZE: |
| 593 | err = sg_get_reserved_size(q, arg); |
| 594 | break; |
| 595 | case SG_SET_RESERVED_SIZE: |
| 596 | err = sg_set_reserved_size(q, arg); |
| 597 | break; |
| 598 | case SG_EMULATED_HOST: |
| 599 | err = sg_emulated_host(q, arg); |
| 600 | break; |
| 601 | case SG_IO: { |
| 602 | struct sg_io_hdr hdr; |
| 603 | |
| 604 | err = -EFAULT; |
| 605 | if (copy_from_user(&hdr, arg, sizeof(hdr))) |
| 606 | break; |
| 607 | err = sg_io(file, q, bd_disk, &hdr); |
| 608 | if (err == -EFAULT) |
| 609 | break; |
| 610 | |
| 611 | if (copy_to_user(arg, &hdr, sizeof(hdr))) |
| 612 | err = -EFAULT; |
| 613 | break; |
| 614 | } |
| 615 | case CDROM_SEND_PACKET: { |
| 616 | struct cdrom_generic_command cgc; |
| 617 | struct sg_io_hdr hdr; |
| 618 | |
| 619 | err = -EFAULT; |
| 620 | if (copy_from_user(&cgc, arg, sizeof(cgc))) |
| 621 | break; |
| 622 | cgc.timeout = clock_t_to_jiffies(cgc.timeout); |
| 623 | memset(&hdr, 0, sizeof(hdr)); |
| 624 | hdr.interface_id = 'S'; |
| 625 | hdr.cmd_len = sizeof(cgc.cmd); |
| 626 | hdr.dxfer_len = cgc.buflen; |
| 627 | err = 0; |
| 628 | switch (cgc.data_direction) { |
| 629 | case CGC_DATA_UNKNOWN: |
| 630 | hdr.dxfer_direction = SG_DXFER_UNKNOWN; |
| 631 | break; |
| 632 | case CGC_DATA_WRITE: |
| 633 | hdr.dxfer_direction = SG_DXFER_TO_DEV; |
| 634 | break; |
| 635 | case CGC_DATA_READ: |
| 636 | hdr.dxfer_direction = SG_DXFER_FROM_DEV; |
| 637 | break; |
| 638 | case CGC_DATA_NONE: |
| 639 | hdr.dxfer_direction = SG_DXFER_NONE; |
| 640 | break; |
| 641 | default: |
| 642 | err = -EINVAL; |
| 643 | } |
| 644 | if (err) |
| 645 | break; |
| 646 | |
| 647 | hdr.dxferp = cgc.buffer; |
| 648 | hdr.sbp = cgc.sense; |
| 649 | if (hdr.sbp) |
| 650 | hdr.mx_sb_len = sizeof(struct request_sense); |
| 651 | hdr.timeout = cgc.timeout; |
| 652 | hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd; |
| 653 | hdr.cmd_len = sizeof(cgc.cmd); |
| 654 | |
| 655 | err = sg_io(file, q, bd_disk, &hdr); |
| 656 | if (err == -EFAULT) |
| 657 | break; |
| 658 | |
| 659 | if (hdr.status) |
| 660 | err = -EIO; |
| 661 | |
| 662 | cgc.stat = err; |
| 663 | cgc.buflen = hdr.resid; |
| 664 | if (copy_to_user(arg, &cgc, sizeof(cgc))) |
| 665 | err = -EFAULT; |
| 666 | |
| 667 | break; |
| 668 | } |
| 669 | |
| 670 | /* |
| 671 | * old junk scsi send command ioctl |
| 672 | */ |
| 673 | case SCSI_IOCTL_SEND_COMMAND: |
| 674 | printk(KERN_WARNING "program %s is using a deprecated SCSI ioctl, please convert it to SG_IO\n", current->comm); |
| 675 | err = -EINVAL; |
| 676 | if (!arg) |
| 677 | break; |
| 678 | |
| 679 | err = sg_scsi_ioctl(file, q, bd_disk, arg); |
| 680 | break; |
| 681 | case CDROMCLOSETRAY: |
Ben Collins | f98d2df | 2005-12-19 11:49:24 -0800 | [diff] [blame] | 682 | err = blk_send_start_stop(q, bd_disk, 0x03); |
| 683 | break; |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 684 | case CDROMEJECT: |
Ben Collins | f98d2df | 2005-12-19 11:49:24 -0800 | [diff] [blame] | 685 | err = blk_send_start_stop(q, bd_disk, 0x02); |
Linus Torvalds | 1da177e | 2005-04-16 15:20:36 -0700 | [diff] [blame] | 686 | break; |
| 687 | default: |
| 688 | err = -ENOTTY; |
| 689 | } |
| 690 | |
| 691 | blk_put_queue(q); |
| 692 | return err; |
| 693 | } |
| 694 | |
| 695 | EXPORT_SYMBOL(scsi_cmd_ioctl); |