drivers/block/scsi_ioctl.c

   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>
  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.  */
  35 const unsigned char scsi_command_size[8] =
  36 {
  37         6, 10, 10, 12,
  38         16, 12, 10, 10
  39 };
  40
  41 EXPORT_SYMBOL(scsi_command_size);
  42
  43 #define BLK_DEFAULT_TIMEOUT     (60 * HZ)
  44
  45 #include <scsi/sg.h>
  46
  47 static 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
  53 static int scsi_get_idlun(request_queue_t *q, int __user *p)
  54 {
  55         return put_user(0, p);
  56 }
  57
  58 static int scsi_get_bus(request_queue_t *q, int __user *p)
  59 {
  60         return put_user(0, p);
  61 }
  62
  63 static int sg_get_timeout(request_queue_t *q)
  64 {
  65         return q->sg_timeout / (HZ / USER_HZ);
  66 }
  67
  68 static 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
  78 static int sg_get_reserved_size(request_queue_t *q, int __user *p)
  79 {
  80         return put_user(q->sg_reserved_size, p);
  81 }
  82
  83 static 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                 return -EINVAL;
  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  */
 103 static int sg_emulated_host(request_queue_t *q, int __user *p)
 104 {
 105         return put_user(1, p);
 106 }
 107
 108 static int sg_io(request_queue_t *q, struct gendisk *bd_disk,
 109                  struct sg_io_hdr *hdr)
 110 {
 111         unsigned long start_time;
 112         int reading, writing;
 113         struct request *rq;
 114         struct bio *bio;
 115         char sense[SCSI_SENSE_BUFFERSIZE];
 116         unsigned char cmd[BLK_MAX_CDB];
 117
 118         if (hdr->interface_id != 'S')
 119                 return -EINVAL;
 120         if (hdr->cmd_len > BLK_MAX_CDB)
 121                 return -EINVAL;
 122         if (copy_from_user(cmd, hdr->cmdp, hdr->cmd_len))
 123                 return -EFAULT;
 124
 125         /*
 126          * we'll do that later
 127          */
 128         if (hdr->iovec_count)
 129                 return -EOPNOTSUPP;
 130
 131         if (hdr->dxfer_len > (q->max_sectors << 9))
 132                 return -EIO;
 133
 134         reading = writing = 0;
 135         if (hdr->dxfer_len) {
 136                 switch (hdr->dxfer_direction) {
 137                 default:
 138                         return -EINVAL;
 139                 case SG_DXFER_TO_FROM_DEV:
 140                         reading = 1;
 141                         /* fall through */
 142                 case SG_DXFER_TO_DEV:
 143                         writing = 1;
 144                         break;
 145                 case SG_DXFER_FROM_DEV:
 146                         reading = 1;
 147                         break;
 148                 }
 149
 150                 rq = blk_rq_map_user(q, writing ? WRITE : READ, hdr->dxferp,
 151                                      hdr->dxfer_len);
 152
 153                 if (IS_ERR(rq))
 154                         return PTR_ERR(rq);
 155         } else
 156                 rq = blk_get_request(q, READ, __GFP_WAIT);
 157
 158         /*
 159          * fill in request structure
 160          */
 161         rq->cmd_len = hdr->cmd_len;
 162         memcpy(rq->cmd, cmd, hdr->cmd_len);
 163         if (sizeof(rq->cmd) != hdr->cmd_len)
 164                 memset(rq->cmd + hdr->cmd_len, 0, sizeof(rq->cmd) - hdr->cmd_len);
 165
 166         memset(sense, 0, sizeof(sense));
 167         rq->sense = sense;
 168         rq->sense_len = 0;
 169
 170         rq->flags |= REQ_BLOCK_PC;
 171         bio = rq->bio;
 172
 173         rq->timeout = (hdr->timeout * HZ) / 1000;
 174         if (!rq->timeout)
 175                 rq->timeout = q->sg_timeout;
 176         if (!rq->timeout)
 177                 rq->timeout = BLK_DEFAULT_TIMEOUT;
 178
 179         start_time = jiffies;
 180
 181         /* ignore return value. All information is passed back to caller
 182          * (if he doesn't check that is his problem).
 183          * N.B. a non-zero SCSI status is _not_ necessarily an error.
 184          */
 185         blk_execute_rq(q, bd_disk, rq);
 186
 187         /* write to all output members */
 188         hdr->status = rq->errors;
 189         hdr->masked_status = (hdr->status >> 1) & 0x1f;
 190         hdr->msg_status = 0;
 191         hdr->host_status = 0;
 192         hdr->driver_status = 0;
 193         hdr->info = 0;
 194         if (hdr->masked_status || hdr->host_status || hdr->driver_status)
 195                 hdr->info |= SG_INFO_CHECK;
 196         hdr->resid = rq->data_len;
 197         hdr->duration = ((jiffies - start_time) * 1000) / HZ;
 198         hdr->sb_len_wr = 0;
 199
 200         if (rq->sense_len && hdr->sbp) {
 201                 int len = min((unsigned int) hdr->mx_sb_len, rq->sense_len);
 202
 203                 if (!copy_to_user(hdr->sbp, rq->sense, len))
 204                         hdr->sb_len_wr = len;
 205         }
 206
 207         if (blk_rq_unmap_user(rq, hdr->dxferp, bio, hdr->dxfer_len))
 208                 return -EFAULT;
 209
 210         /* may not have succeeded, but output values written to control
 211          * structure (struct sg_io_hdr).  */
 212         return 0;
 213 }
 214
 215 #define FORMAT_UNIT_TIMEOUT             (2 * 60 * 60 * HZ)
 216 #define START_STOP_TIMEOUT              (60 * HZ)
 217 #define MOVE_MEDIUM_TIMEOUT             (5 * 60 * HZ)
 218 #define READ_ELEMENT_STATUS_TIMEOUT     (5 * 60 * HZ)
 219 #define READ_DEFECT_DATA_TIMEOUT        (60 * HZ )
 220 #define OMAX_SB_LEN 16          /* For backward compatibility */
 221
 222 static int sg_scsi_ioctl(request_queue_t *q, struct gendisk *bd_disk,
 223                          Scsi_Ioctl_Command __user *sic)
 224 {
 225         struct request *rq;
 226         int err, in_len, out_len, bytes, opcode, cmdlen;
 227         char *buffer = NULL, sense[SCSI_SENSE_BUFFERSIZE];
 228
 229         /*
 230          * get in an out lengths, verify they don't exceed a page worth of data
 231          */
 232         if (get_user(in_len, &sic->inlen))
 233                 return -EFAULT;
 234         if (get_user(out_len, &sic->outlen))
 235                 return -EFAULT;
 236         if (in_len > PAGE_SIZE || out_len > PAGE_SIZE)
 237                 return -EINVAL;
 238         if (get_user(opcode, sic->data))
 239                 return -EFAULT;
 240
 241         bytes = max(in_len, out_len);
 242         if (bytes) {
 243                 buffer = kmalloc(bytes, q->bounce_gfp | GFP_USER);
 244                 if (!buffer)
 245                         return -ENOMEM;
 246
 247                 memset(buffer, 0, bytes);
 248         }
 249
 250         rq = blk_get_request(q, in_len ? WRITE : READ, __GFP_WAIT);
 251
 252         cmdlen = COMMAND_SIZE(opcode);
 253
 254         /*
 255          * get command and data to send to device, if any
 256          */
 257         err = -EFAULT;
 258         rq->cmd_len = cmdlen;
 259         if (copy_from_user(rq->cmd, sic->data, cmdlen))
 260                 goto error;
 261
 262         if (copy_from_user(buffer, sic->data + cmdlen, in_len))
 263                 goto error;
 264
 265         switch (opcode) {
 266                 case SEND_DIAGNOSTIC:
 267                 case FORMAT_UNIT:
 268                         rq->timeout = FORMAT_UNIT_TIMEOUT;
 269                         break;
 270                 case START_STOP:
 271                         rq->timeout = START_STOP_TIMEOUT;
 272                         break;
 273                 case MOVE_MEDIUM:
 274                         rq->timeout = MOVE_MEDIUM_TIMEOUT;
 275                         break;
 276                 case READ_ELEMENT_STATUS:
 277                         rq->timeout = READ_ELEMENT_STATUS_TIMEOUT;
 278                         break;
 279                 case READ_DEFECT_DATA:
 280                         rq->timeout = READ_DEFECT_DATA_TIMEOUT;
 281                         break;
 282                 default:
 283                         rq->timeout = BLK_DEFAULT_TIMEOUT;
 284                         break;
 285         }
 286
 287         memset(sense, 0, sizeof(sense));
 288         rq->sense = sense;
 289         rq->sense_len = 0;
 290
 291         rq->data = buffer;
 292         rq->data_len = bytes;
 293         rq->flags |= REQ_BLOCK_PC;
 294
 295         blk_execute_rq(q, bd_disk, rq);
 296         err = rq->errors & 0xff;        /* only 8 bit SCSI status */
 297         if (err) {
 298                 if (rq->sense_len && rq->sense) {
 299                         bytes = (OMAX_SB_LEN > rq->sense_len) ?
 300                                 rq->sense_len : OMAX_SB_LEN;
 301                         if (copy_to_user(sic->data, rq->sense, bytes))
 302                                 err = -EFAULT;
 303                 }
 304         } else {
 305                 if (copy_to_user(sic->data, buffer, out_len))
 306                         err = -EFAULT;
 307         }
 308
 309 error:
 310         kfree(buffer);
 311         blk_put_request(rq);
 312         return err;
 313 }
 314
 315 int scsi_cmd_ioctl(struct gendisk *bd_disk, unsigned int cmd, void __user *arg)
 316 {
 317         request_queue_t *q;
 318         struct request *rq;
 319         int close = 0, err;
 320
 321         q = bd_disk->queue;
 322         if (!q)
 323                 return -ENXIO;
 324
 325         if (blk_get_queue(q))
 326                 return -ENXIO;
 327
 328         switch (cmd) {
 329                 /*
 330                  * new sgv3 interface
 331                  */
 332                 case SG_GET_VERSION_NUM:
 333                         err = sg_get_version(arg);
 334                         break;
 335                 case SCSI_IOCTL_GET_IDLUN:
 336                         err = scsi_get_idlun(q, arg);
 337                         break;
 338                 case SCSI_IOCTL_GET_BUS_NUMBER:
 339                         err = scsi_get_bus(q, arg);
 340                         break;
 341                 case SG_SET_TIMEOUT:
 342                         err = sg_set_timeout(q, arg);
 343                         break;
 344                 case SG_GET_TIMEOUT:
 345                         err = sg_get_timeout(q);
 346                         break;
 347                 case SG_GET_RESERVED_SIZE:
 348                         err = sg_get_reserved_size(q, arg);
 349                         break;
 350                 case SG_SET_RESERVED_SIZE:
 351                         err = sg_set_reserved_size(q, arg);
 352                         break;
 353                 case SG_EMULATED_HOST:
 354                         err = sg_emulated_host(q, arg);
 355                         break;
 356                 case SG_IO: {
 357                         struct sg_io_hdr hdr;
 358
 359                         err = -EFAULT;
 360                         if (copy_from_user(&hdr, arg, sizeof(hdr)))
 361                                 break;
 362                         err = sg_io(q, bd_disk, &hdr);
 363                         if (err == -EFAULT)
 364                                 break;
 365
 366                         if (copy_to_user(arg, &hdr, sizeof(hdr)))
 367                                 err = -EFAULT;
 368                         break;
 369                 }
 370                 case CDROM_SEND_PACKET: {
 371                         struct cdrom_generic_command cgc;
 372                         struct sg_io_hdr hdr;
 373
 374                         err = -EFAULT;
 375                         if (copy_from_user(&cgc, arg, sizeof(cgc)))
 376                                 break;
 377                         cgc.timeout = clock_t_to_jiffies(cgc.timeout);
 378                         memset(&hdr, 0, sizeof(hdr));
 379                         hdr.interface_id = 'S';
 380                         hdr.cmd_len = sizeof(cgc.cmd);
 381                         hdr.dxfer_len = cgc.buflen;
 382                         err = 0;
 383                         switch (cgc.data_direction) {
 384                                 case CGC_DATA_UNKNOWN:
 385                                         hdr.dxfer_direction = SG_DXFER_UNKNOWN;
 386                                         break;
 387                                 case CGC_DATA_WRITE:
 388                                         hdr.dxfer_direction = SG_DXFER_TO_DEV;
 389                                         break;
 390                                 case CGC_DATA_READ:
 391                                         hdr.dxfer_direction = SG_DXFER_FROM_DEV;
 392                                         break;
 393                                 case CGC_DATA_NONE:
 394                                         hdr.dxfer_direction = SG_DXFER_NONE;
 395                                         break;
 396                                 default:
 397                                         err = -EINVAL;
 398                         }
 399                         if (err)
 400                                 break;
 401
 402                         hdr.dxferp = cgc.buffer;
 403                         hdr.sbp = cgc.sense;
 404                         if (hdr.sbp)
 405                                 hdr.mx_sb_len = sizeof(struct request_sense);
 406                         hdr.timeout = cgc.timeout;
 407                         hdr.cmdp = ((struct cdrom_generic_command __user*) arg)->cmd;
 408                         hdr.cmd_len = sizeof(cgc.cmd);
 409
 410                         err = sg_io(q, bd_disk, &hdr);
 411                         if (err == -EFAULT)
 412                                 break;
 413
 414                         if (hdr.status)
 415                                 err = -EIO;
 416
 417                         cgc.stat = err;
 418                         cgc.buflen = hdr.resid;
 419                         if (copy_to_user(arg, &cgc, sizeof(cgc)))
 420                                 err = -EFAULT;
 421
 422                         break;
 423                 }
 424
 425                 /*
 426                  * old junk scsi send command ioctl
 427                  */
 428                 case SCSI_IOCTL_SEND_COMMAND:
 429                         err = -EINVAL;
 430                         if (!arg)
 431                                 break;
 432
 433                         err = sg_scsi_ioctl(q, bd_disk, arg);
 434                         break;
 435                 case CDROMCLOSETRAY:
 436                         close = 1;
 437                 case CDROMEJECT:
 438                         rq = blk_get_request(q, WRITE, __GFP_WAIT);
 439                         rq->flags |= REQ_BLOCK_PC;
 440                         rq->data = NULL;
 441                         rq->data_len = 0;
 442                         rq->timeout = BLK_DEFAULT_TIMEOUT;
 443                         memset(rq->cmd, 0, sizeof(rq->cmd));
 444                         rq->cmd[0] = GPCMD_START_STOP_UNIT;
 445                         rq->cmd[4] = 0x02 + (close != 0);
 446                         rq->cmd_len = 6;
 447                         err = blk_execute_rq(q, bd_disk, rq);
 448                         blk_put_request(rq);
 449                         break;
 450                 default:
 451                         err = -ENOTTY;
 452         }
 453
 454         blk_put_queue(q);
 455         return err;
 456 }
 457
 458 EXPORT_SYMBOL(scsi_cmd_ioctl);