drivers/scsi/sd.c

   1 /*
   2  *      sd.c Copyright (C) 1992 Drew Eckhardt
   3  *           Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
   4  *
   5  *      Linux scsi disk driver
   6  *              Initial versions: Drew Eckhardt
   7  *              Subsequent revisions: Eric Youngdale
   8  *      Modification history:
   9  *       - Drew Eckhardt <drew@colorado.edu> original
  10  *       - Eric Youngdale <eric@andante.org> add scatter-gather, multiple
  11  *         outstanding request, and other enhancements.
  12  *         Support loadable low-level scsi drivers.
  13  *       - Jirka Hanika <geo@ff.cuni.cz> support more scsi disks using
  14  *         eight major numbers.
  15  *       - Richard Gooch <rgooch@atnf.csiro.au> support devfs.
  16  *       - Torben Mathiasen <tmm@image.dk> Resource allocation fixes in
  17  *         sd_init and cleanups.
  18  *       - Alex Davis <letmein@erols.com> Fix problem where partition info
  19  *         not being read in sd_open. Fix problem where removable media
  20  *         could be ejected after sd_open.
  21  *       - Douglas Gilbert <dgilbert@interlog.com> cleanup for lk 2.5.x
  22  *       - Badari Pulavarty <pbadari@us.ibm.com>, Matthew Wilcox
  23  *         <willy@debian.org>, Kurt Garloff <garloff@suse.de>:
  24  *         Support 32k/1M disks.
  25  *
  26  *      Logging policy (needs CONFIG_SCSI_LOGGING defined):
  27  *       - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
  28  *       - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
  29  *       - entering sd_ioctl: SCSI_LOG_IOCTL level 1
  30  *       - entering other commands: SCSI_LOG_HLQUEUE level 3
  31  *      Note: when the logging level is set by the user, it must be greater
  32  *      than the level indicated above to trigger output.
  33  */
  34
  35 #include <linux/module.h>
  36 #include <linux/fs.h>
  37 #include <linux/kernel.h>
  38 #include <linux/mm.h>
  39 #include <linux/bio.h>
  40 #include <linux/genhd.h>
  41 #include <linux/hdreg.h>
  42 #include <linux/errno.h>
  43 #include <linux/idr.h>
  44 #include <linux/interrupt.h>
  45 #include <linux/init.h>
  46 #include <linux/blkdev.h>
  47 #include <linux/blkpg.h>
  48 #include <linux/delay.h>
  49 #include <linux/mutex.h>
  50 #include <linux/string_helpers.h>
  51 #include <asm/uaccess.h>
  52
  53 #include <scsi/scsi.h>
  54 #include <scsi/scsi_cmnd.h>
  55 #include <scsi/scsi_dbg.h>
  56 #include <scsi/scsi_device.h>
  57 #include <scsi/scsi_driver.h>
  58 #include <scsi/scsi_eh.h>
  59 #include <scsi/scsi_host.h>
  60 #include <scsi/scsi_ioctl.h>
  61 #include <scsi/scsicam.h>
  62
  63 #include "sd.h"
  64 #include "scsi_logging.h"
  65
  66 MODULE_AUTHOR("Eric Youngdale");
  67 MODULE_DESCRIPTION("SCSI disk (sd) driver");
  68 MODULE_LICENSE("GPL");
  69
  70 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
  71 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
  72 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
  73 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
  74 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
  75 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
  76 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
  77 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
  78 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
  79 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
  80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
  81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
  82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
  83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
  84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
  85 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
  86 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
  87 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
  88 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
  89
  90 #if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
  91 #define SD_MINORS       16
  92 #else
  93 #define SD_MINORS       0
  94 #endif
  95
  96 static int  sd_revalidate_disk(struct gendisk *);
  97 static int  sd_probe(struct device *);
  98 static int  sd_remove(struct device *);
  99 static void sd_shutdown(struct device *);
 100 static int sd_suspend(struct device *, pm_message_t state);
 101 static int sd_resume(struct device *);
 102 static void sd_rescan(struct device *);
 103 static int sd_done(struct scsi_cmnd *);
 104 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
 105 static void scsi_disk_release(struct device *cdev);
 106 static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
 107 static void sd_print_result(struct scsi_disk *, int);
 108
 109 static DEFINE_IDA(sd_index_ida);
 110
 111 /* This semaphore is used to mediate the 0->1 reference get in the
 112  * face of object destruction (i.e. we can't allow a get on an
 113  * object after last put) */
 114 static DEFINE_MUTEX(sd_ref_mutex);
 115
 116 static const char *sd_cache_types[] = {
 117         "write through", "none", "write back",
 118         "write back, no read (daft)"
 119 };
 120
 121 static ssize_t
 122 sd_store_cache_type(struct device *dev, struct device_attribute *attr,
 123                     const char *buf, size_t count)
 124 {
 125         int i, ct = -1, rcd, wce, sp;
 126         struct scsi_disk *sdkp = to_scsi_disk(dev);
 127         struct scsi_device *sdp = sdkp->device;
 128         char buffer[64];
 129         char *buffer_data;
 130         struct scsi_mode_data data;
 131         struct scsi_sense_hdr sshdr;
 132         int len;
 133
 134         if (sdp->type != TYPE_DISK)
 135                 /* no cache control on RBC devices; theoretically they
 136                  * can do it, but there's probably so many exceptions
 137                  * it's not worth the risk */
 138                 return -EINVAL;
 139
 140         for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
 141                 const int len = strlen(sd_cache_types[i]);
 142                 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
 143                     buf[len] == '\n') {
 144                         ct = i;
 145                         break;
 146                 }
 147         }
 148         if (ct < 0)
 149                 return -EINVAL;
 150         rcd = ct & 0x01 ? 1 : 0;
 151         wce = ct & 0x02 ? 1 : 0;
 152         if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
 153                             SD_MAX_RETRIES, &data, NULL))
 154                 return -EINVAL;
 155         len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
 156                   data.block_descriptor_length);
 157         buffer_data = buffer + data.header_length +
 158                 data.block_descriptor_length;
 159         buffer_data[2] &= ~0x05;
 160         buffer_data[2] |= wce << 2 | rcd;
 161         sp = buffer_data[0] & 0x80 ? 1 : 0;
 162
 163         if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
 164                              SD_MAX_RETRIES, &data, &sshdr)) {
 165                 if (scsi_sense_valid(&sshdr))
 166                         sd_print_sense_hdr(sdkp, &sshdr);
 167                 return -EINVAL;
 168         }
 169         revalidate_disk(sdkp->disk);
 170         return count;
 171 }
 172
 173 static ssize_t
 174 sd_store_manage_start_stop(struct device *dev, struct device_attribute *attr,
 175                            const char *buf, size_t count)
 176 {
 177         struct scsi_disk *sdkp = to_scsi_disk(dev);
 178         struct scsi_device *sdp = sdkp->device;
 179
 180         if (!capable(CAP_SYS_ADMIN))
 181                 return -EACCES;
 182
 183         sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
 184
 185         return count;
 186 }
 187
 188 static ssize_t
 189 sd_store_allow_restart(struct device *dev, struct device_attribute *attr,
 190                        const char *buf, size_t count)
 191 {
 192         struct scsi_disk *sdkp = to_scsi_disk(dev);
 193         struct scsi_device *sdp = sdkp->device;
 194
 195         if (!capable(CAP_SYS_ADMIN))
 196                 return -EACCES;
 197
 198         if (sdp->type != TYPE_DISK)
 199                 return -EINVAL;
 200
 201         sdp->allow_restart = simple_strtoul(buf, NULL, 10);
 202
 203         return count;
 204 }
 205
 206 static ssize_t
 207 sd_show_cache_type(struct device *dev, struct device_attribute *attr,
 208                    char *buf)
 209 {
 210         struct scsi_disk *sdkp = to_scsi_disk(dev);
 211         int ct = sdkp->RCD + 2*sdkp->WCE;
 212
 213         return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
 214 }
 215
 216 static ssize_t
 217 sd_show_fua(struct device *dev, struct device_attribute *attr, char *buf)
 218 {
 219         struct scsi_disk *sdkp = to_scsi_disk(dev);
 220
 221         return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
 222 }
 223
 224 static ssize_t
 225 sd_show_manage_start_stop(struct device *dev, struct device_attribute *attr,
 226                           char *buf)
 227 {
 228         struct scsi_disk *sdkp = to_scsi_disk(dev);
 229         struct scsi_device *sdp = sdkp->device;
 230
 231         return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
 232 }
 233
 234 static ssize_t
 235 sd_show_allow_restart(struct device *dev, struct device_attribute *attr,
 236                       char *buf)
 237 {
 238         struct scsi_disk *sdkp = to_scsi_disk(dev);
 239
 240         return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
 241 }
 242
 243 static ssize_t
 244 sd_show_protection_type(struct device *dev, struct device_attribute *attr,
 245                         char *buf)
 246 {
 247         struct scsi_disk *sdkp = to_scsi_disk(dev);
 248
 249         return snprintf(buf, 20, "%u\n", sdkp->protection_type);
 250 }
 251
 252 static ssize_t
 253 sd_show_app_tag_own(struct device *dev, struct device_attribute *attr,
 254                     char *buf)
 255 {
 256         struct scsi_disk *sdkp = to_scsi_disk(dev);
 257
 258         return snprintf(buf, 20, "%u\n", sdkp->ATO);
 259 }
 260
 261 static struct device_attribute sd_disk_attrs[] = {
 262         __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
 263                sd_store_cache_type),
 264         __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
 265         __ATTR(allow_restart, S_IRUGO|S_IWUSR, sd_show_allow_restart,
 266                sd_store_allow_restart),
 267         __ATTR(manage_start_stop, S_IRUGO|S_IWUSR, sd_show_manage_start_stop,
 268                sd_store_manage_start_stop),
 269         __ATTR(protection_type, S_IRUGO, sd_show_protection_type, NULL),
 270         __ATTR(app_tag_own, S_IRUGO, sd_show_app_tag_own, NULL),
 271         __ATTR_NULL,
 272 };
 273
 274 static struct class sd_disk_class = {
 275         .name           = "scsi_disk",
 276         .owner          = THIS_MODULE,
 277         .dev_release    = scsi_disk_release,
 278         .dev_attrs      = sd_disk_attrs,
 279 };
 280
 281 static struct scsi_driver sd_template = {
 282         .owner                  = THIS_MODULE,
 283         .gendrv = {
 284                 .name           = "sd",
 285                 .probe          = sd_probe,
 286                 .remove         = sd_remove,
 287                 .suspend        = sd_suspend,
 288                 .resume         = sd_resume,
 289                 .shutdown       = sd_shutdown,
 290         },
 291         .rescan                 = sd_rescan,
 292         .done                   = sd_done,
 293 };
 294
 295 /*
 296  * Device no to disk mapping:
 297  *
 298  *       major         disc2     disc  p1
 299  *   |............|.............|....|....| <- dev_t
 300  *    31        20 19          8 7  4 3  0
 301  *
 302  * Inside a major, we have 16k disks, however mapped non-
 303  * contiguously. The first 16 disks are for major0, the next
 304  * ones with major1, ... Disk 256 is for major0 again, disk 272
 305  * for major1, ...
 306  * As we stay compatible with our numbering scheme, we can reuse
 307  * the well-know SCSI majors 8, 65--71, 136--143.
 308  */
 309 static int sd_major(int major_idx)
 310 {
 311         switch (major_idx) {
 312         case 0:
 313                 return SCSI_DISK0_MAJOR;
 314         case 1 ... 7:
 315                 return SCSI_DISK1_MAJOR + major_idx - 1;
 316         case 8 ... 15:
 317                 return SCSI_DISK8_MAJOR + major_idx - 8;
 318         default:
 319                 BUG();
 320                 return 0;       /* shut up gcc */
 321         }
 322 }
 323
 324 static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
 325 {
 326         struct scsi_disk *sdkp = NULL;
 327
 328         if (disk->private_data) {
 329                 sdkp = scsi_disk(disk);
 330                 if (scsi_device_get(sdkp->device) == 0)
 331                         get_device(&sdkp->dev);
 332                 else
 333                         sdkp = NULL;
 334         }
 335         return sdkp;
 336 }
 337
 338 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
 339 {
 340         struct scsi_disk *sdkp;
 341
 342         mutex_lock(&sd_ref_mutex);
 343         sdkp = __scsi_disk_get(disk);
 344         mutex_unlock(&sd_ref_mutex);
 345         return sdkp;
 346 }
 347
 348 static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
 349 {
 350         struct scsi_disk *sdkp;
 351
 352         mutex_lock(&sd_ref_mutex);
 353         sdkp = dev_get_drvdata(dev);
 354         if (sdkp)
 355                 sdkp = __scsi_disk_get(sdkp->disk);
 356         mutex_unlock(&sd_ref_mutex);
 357         return sdkp;
 358 }
 359
 360 static void scsi_disk_put(struct scsi_disk *sdkp)
 361 {
 362         struct scsi_device *sdev = sdkp->device;
 363
 364         mutex_lock(&sd_ref_mutex);
 365         put_device(&sdkp->dev);
 366         scsi_device_put(sdev);
 367         mutex_unlock(&sd_ref_mutex);
 368 }
 369
 370 /**
 371  *      sd_init_command - build a scsi (read or write) command from
 372  *      information in the request structure.
 373  *      @SCpnt: pointer to mid-level's per scsi command structure that
 374  *      contains request and into which the scsi command is written
 375  *
 376  *      Returns 1 if successful and 0 if error (or cannot be done now).
 377  **/
 378 static int sd_prep_fn(struct request_queue *q, struct request *rq)
 379 {
 380         struct scsi_cmnd *SCpnt;
 381         struct scsi_device *sdp = q->queuedata;
 382         struct gendisk *disk = rq->rq_disk;
 383         struct scsi_disk *sdkp;
 384         sector_t block = rq->sector;
 385         sector_t threshold;
 386         unsigned int this_count = rq->nr_sectors;
 387         int ret, host_dif;
 388
 389         if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
 390                 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
 391                 goto out;
 392         } else if (rq->cmd_type != REQ_TYPE_FS) {
 393                 ret = BLKPREP_KILL;
 394                 goto out;
 395         }
 396         ret = scsi_setup_fs_cmnd(sdp, rq);
 397         if (ret != BLKPREP_OK)
 398                 goto out;
 399         SCpnt = rq->special;
 400         sdkp = scsi_disk(disk);
 401
 402         /* from here on until we're complete, any goto out
 403          * is used for a killable error condition */
 404         ret = BLKPREP_KILL;
 405
 406         SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
 407                                         "sd_init_command: block=%llu, "
 408                                         "count=%d\n",
 409                                         (unsigned long long)block,
 410                                         this_count));
 411
 412         if (!sdp || !scsi_device_online(sdp) ||
 413             block + rq->nr_sectors > get_capacity(disk)) {
 414                 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
 415                                                 "Finishing %ld sectors\n",
 416                                                 rq->nr_sectors));
 417                 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
 418                                                 "Retry with 0x%p\n", SCpnt));
 419                 goto out;
 420         }
 421
 422         if (sdp->changed) {
 423                 /*
 424                  * quietly refuse to do anything to a changed disc until
 425                  * the changed bit has been reset
 426                  */
 427                 /* printk("SCSI disk has been changed. Prohibiting further I/O.\n"); */
 428                 goto out;
 429         }
 430
 431         /*
 432          * Some SD card readers can't handle multi-sector accesses which touch
 433          * the last one or two hardware sectors.  Split accesses as needed.
 434          */
 435         threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
 436                 (sdp->sector_size / 512);
 437
 438         if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
 439                 if (block < threshold) {
 440                         /* Access up to the threshold but not beyond */
 441                         this_count = threshold - block;
 442                 } else {
 443                         /* Access only a single hardware sector */
 444                         this_count = sdp->sector_size / 512;
 445                 }
 446         }
 447
 448         SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
 449                                         (unsigned long long)block));
 450
 451         /*
 452          * If we have a 1K hardware sectorsize, prevent access to single
 453          * 512 byte sectors.  In theory we could handle this - in fact
 454          * the scsi cdrom driver must be able to handle this because
 455          * we typically use 1K blocksizes, and cdroms typically have
 456          * 2K hardware sectorsizes.  Of course, things are simpler
 457          * with the cdrom, since it is read-only.  For performance
 458          * reasons, the filesystems should be able to handle this
 459          * and not force the scsi disk driver to use bounce buffers
 460          * for this.
 461          */
 462         if (sdp->sector_size == 1024) {
 463                 if ((block & 1) || (rq->nr_sectors & 1)) {
 464                         scmd_printk(KERN_ERR, SCpnt,
 465                                     "Bad block number requested\n");
 466                         goto out;
 467                 } else {
 468                         block = block >> 1;
 469                         this_count = this_count >> 1;
 470                 }
 471         }
 472         if (sdp->sector_size == 2048) {
 473                 if ((block & 3) || (rq->nr_sectors & 3)) {
 474                         scmd_printk(KERN_ERR, SCpnt,
 475                                     "Bad block number requested\n");
 476                         goto out;
 477                 } else {
 478                         block = block >> 2;
 479                         this_count = this_count >> 2;
 480                 }
 481         }
 482         if (sdp->sector_size == 4096) {
 483                 if ((block & 7) || (rq->nr_sectors & 7)) {
 484                         scmd_printk(KERN_ERR, SCpnt,
 485                                     "Bad block number requested\n");
 486                         goto out;
 487                 } else {
 488                         block = block >> 3;
 489                         this_count = this_count >> 3;
 490                 }
 491         }
 492         if (rq_data_dir(rq) == WRITE) {
 493                 if (!sdp->writeable) {
 494                         goto out;
 495                 }
 496                 SCpnt->cmnd[0] = WRITE_6;
 497                 SCpnt->sc_data_direction = DMA_TO_DEVICE;
 498
 499                 if (blk_integrity_rq(rq) &&
 500                     sd_dif_prepare(rq, block, sdp->sector_size) == -EIO)
 501                         goto out;
 502
 503         } else if (rq_data_dir(rq) == READ) {
 504                 SCpnt->cmnd[0] = READ_6;
 505                 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
 506         } else {
 507                 scmd_printk(KERN_ERR, SCpnt, "Unknown command %x\n", rq->cmd_flags);
 508                 goto out;
 509         }
 510
 511         SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
 512                                         "%s %d/%ld 512 byte blocks.\n",
 513                                         (rq_data_dir(rq) == WRITE) ?
 514                                         "writing" : "reading", this_count,
 515                                         rq->nr_sectors));
 516
 517         /* Set RDPROTECT/WRPROTECT if disk is formatted with DIF */
 518         host_dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
 519         if (host_dif)
 520                 SCpnt->cmnd[1] = 1 << 5;
 521         else
 522                 SCpnt->cmnd[1] = 0;
 523
 524         if (block > 0xffffffff) {
 525                 SCpnt->cmnd[0] += READ_16 - READ_6;
 526                 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
 527                 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
 528                 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
 529                 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
 530                 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
 531                 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
 532                 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
 533                 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
 534                 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
 535                 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
 536                 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
 537                 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
 538                 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
 539                 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
 540         } else if ((this_count > 0xff) || (block > 0x1fffff) ||
 541                    scsi_device_protection(SCpnt->device) ||
 542                    SCpnt->device->use_10_for_rw) {
 543                 if (this_count > 0xffff)
 544                         this_count = 0xffff;
 545
 546                 SCpnt->cmnd[0] += READ_10 - READ_6;
 547                 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
 548                 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
 549                 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
 550                 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
 551                 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
 552                 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
 553                 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
 554                 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
 555         } else {
 556                 if (unlikely(blk_fua_rq(rq))) {
 557                         /*
 558                          * This happens only if this drive failed
 559                          * 10byte rw command with ILLEGAL_REQUEST
 560                          * during operation and thus turned off
 561                          * use_10_for_rw.
 562                          */
 563                         scmd_printk(KERN_ERR, SCpnt,
 564                                     "FUA write on READ/WRITE(6) drive\n");
 565                         goto out;
 566                 }
 567
 568                 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
 569                 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
 570                 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
 571                 SCpnt->cmnd[4] = (unsigned char) this_count;
 572                 SCpnt->cmnd[5] = 0;
 573         }
 574         SCpnt->sdb.length = this_count * sdp->sector_size;
 575
 576         /* If DIF or DIX is enabled, tell HBA how to handle request */
 577         if (host_dif || scsi_prot_sg_count(SCpnt))
 578                 sd_dif_op(SCpnt, host_dif, scsi_prot_sg_count(SCpnt),
 579                           sdkp->protection_type);
 580
 581         /*
 582          * We shouldn't disconnect in the middle of a sector, so with a dumb
 583          * host adapter, it's safe to assume that we can at least transfer
 584          * this many bytes between each connect / disconnect.
 585          */
 586         SCpnt->transfersize = sdp->sector_size;
 587         SCpnt->underflow = this_count << 9;
 588         SCpnt->allowed = SD_MAX_RETRIES;
 589
 590         /*
 591          * This indicates that the command is ready from our end to be
 592          * queued.
 593          */
 594         ret = BLKPREP_OK;
 595  out:
 596         return scsi_prep_return(q, rq, ret);
 597 }
 598
 599 /**
 600  *      sd_open - open a scsi disk device
 601  *      @inode: only i_rdev member may be used
 602  *      @filp: only f_mode and f_flags may be used
 603  *
 604  *      Returns 0 if successful. Returns a negated errno value in case
 605  *      of error.
 606  *
 607  *      Note: This can be called from a user context (e.g. fsck(1) )
 608  *      or from within the kernel (e.g. as a result of a mount(1) ).
 609  *      In the latter case @inode and @filp carry an abridged amount
 610  *      of information as noted above.
 611  **/
 612 static int sd_open(struct inode *inode, struct file *filp)
 613 {
 614         struct gendisk *disk = inode->i_bdev->bd_disk;
 615         struct scsi_disk *sdkp;
 616         struct scsi_device *sdev;
 617         int retval;
 618
 619         if (!(sdkp = scsi_disk_get(disk)))
 620                 return -ENXIO;
 621
 622
 623         SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
 624
 625         sdev = sdkp->device;
 626
 627         /*
 628          * If the device is in error recovery, wait until it is done.
 629          * If the device is offline, then disallow any access to it.
 630          */
 631         retval = -ENXIO;
 632         if (!scsi_block_when_processing_errors(sdev))
 633                 goto error_out;
 634
 635         if (sdev->removable || sdkp->write_prot)
 636                 check_disk_change(inode->i_bdev);
 637
 638         /*
 639          * If the drive is empty, just let the open fail.
 640          */
 641         retval = -ENOMEDIUM;
 642         if (sdev->removable && !sdkp->media_present &&
 643             !(filp->f_flags & O_NDELAY))
 644                 goto error_out;
 645
 646         /*
 647          * If the device has the write protect tab set, have the open fail
 648          * if the user expects to be able to write to the thing.
 649          */
 650         retval = -EROFS;
 651         if (sdkp->write_prot && (filp->f_mode & FMODE_WRITE))
 652                 goto error_out;
 653
 654         /*
 655          * It is possible that the disk changing stuff resulted in
 656          * the device being taken offline.  If this is the case,
 657          * report this to the user, and don't pretend that the
 658          * open actually succeeded.
 659          */
 660         retval = -ENXIO;
 661         if (!scsi_device_online(sdev))
 662                 goto error_out;
 663
 664         if (!sdkp->openers++ && sdev->removable) {
 665                 if (scsi_block_when_processing_errors(sdev))
 666                         scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
 667         }
 668
 669         return 0;
 670
 671 error_out:
 672         scsi_disk_put(sdkp);
 673         return retval;
 674 }
 675
 676 /**
 677  *      sd_release - invoked when the (last) close(2) is called on this
 678  *      scsi disk.
 679  *      @inode: only i_rdev member may be used
 680  *      @filp: only f_mode and f_flags may be used
 681  *
 682  *      Returns 0.
 683  *
 684  *      Note: may block (uninterruptible) if error recovery is underway
 685  *      on this disk.
 686  **/
 687 static int sd_release(struct inode *inode, struct file *filp)
 688 {
 689         struct gendisk *disk = inode->i_bdev->bd_disk;
 690         struct scsi_disk *sdkp = scsi_disk(disk);
 691         struct scsi_device *sdev = sdkp->device;
 692
 693         SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
 694
 695         if (!--sdkp->openers && sdev->removable) {
 696                 if (scsi_block_when_processing_errors(sdev))
 697                         scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
 698         }
 699
 700         /*
 701          * XXX and what if there are packets in flight and this close()
 702          * XXX is followed by a "rmmod sd_mod"?
 703          */
 704         scsi_disk_put(sdkp);
 705         return 0;
 706 }
 707
 708 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
 709 {
 710         struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
 711         struct scsi_device *sdp = sdkp->device;
 712         struct Scsi_Host *host = sdp->host;
 713         int diskinfo[4];
 714
 715         /* default to most commonly used values */
 716         diskinfo[0] = 0x40;     /* 1 << 6 */
 717         diskinfo[1] = 0x20;     /* 1 << 5 */
 718         diskinfo[2] = sdkp->capacity >> 11;
 719
 720         /* override with calculated, extended default, or driver values */
 721         if (host->hostt->bios_param)
 722                 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
 723         else
 724                 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
 725
 726         geo->heads = diskinfo[0];
 727         geo->sectors = diskinfo[1];
 728         geo->cylinders = diskinfo[2];
 729         return 0;
 730 }
 731
 732 /**
 733  *      sd_ioctl - process an ioctl
 734  *      @inode: only i_rdev/i_bdev members may be used
 735  *      @filp: only f_mode and f_flags may be used
 736  *      @cmd: ioctl command number
 737  *      @arg: this is third argument given to ioctl(2) system call.
 738  *      Often contains a pointer.
 739  *
 740  *      Returns 0 if successful (some ioctls return postive numbers on
 741  *      success as well). Returns a negated errno value in case of error.
 742  *
 743  *      Note: most ioctls are forward onto the block subsystem or further
 744  *      down in the scsi subsystem.
 745  **/
 746 static int sd_ioctl(struct inode * inode, struct file * filp,
 747                     unsigned int cmd, unsigned long arg)
 748 {
 749         struct block_device *bdev = inode->i_bdev;
 750         struct gendisk *disk = bdev->bd_disk;
 751         struct scsi_device *sdp = scsi_disk(disk)->device;
 752         void __user *p = (void __user *)arg;
 753         int error;
 754
 755         SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
 756                                                 disk->disk_name, cmd));
 757
 758         /*
 759          * If we are in the middle of error recovery, don't let anyone
 760          * else try and use this device.  Also, if error recovery fails, it
 761          * may try and take the device offline, in which case all further
 762          * access to the device is prohibited.
 763          */
 764         error = scsi_nonblockable_ioctl(sdp, cmd, p, filp);
 765         if (!scsi_block_when_processing_errors(sdp) || !error)
 766                 return error;
 767
 768         /*
 769          * Send SCSI addressing ioctls directly to mid level, send other
 770          * ioctls to block level and then onto mid level if they can't be
 771          * resolved.
 772          */
 773         switch (cmd) {
 774                 case SCSI_IOCTL_GET_IDLUN:
 775                 case SCSI_IOCTL_GET_BUS_NUMBER:
 776                         return scsi_ioctl(sdp, cmd, p);
 777                 default:
 778                         error = scsi_cmd_ioctl(filp, disk->queue, disk, cmd, p);
 779                         if (error != -ENOTTY)
 780                                 return error;
 781         }
 782         return scsi_ioctl(sdp, cmd, p);
 783 }
 784
 785 static void set_media_not_present(struct scsi_disk *sdkp)
 786 {
 787         sdkp->media_present = 0;
 788         sdkp->capacity = 0;
 789         sdkp->device->changed = 1;
 790 }
 791
 792 /**
 793  *      sd_media_changed - check if our medium changed
 794  *      @disk: kernel device descriptor
 795  *
 796  *      Returns 0 if not applicable or no change; 1 if change
 797  *
 798  *      Note: this function is invoked from the block subsystem.
 799  **/
 800 static int sd_media_changed(struct gendisk *disk)
 801 {
 802         struct scsi_disk *sdkp = scsi_disk(disk);
 803         struct scsi_device *sdp = sdkp->device;
 804         struct scsi_sense_hdr *sshdr = NULL;
 805         int retval;
 806
 807         SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_media_changed\n"));
 808
 809         if (!sdp->removable)
 810                 return 0;
 811
 812         /*
 813          * If the device is offline, don't send any commands - just pretend as
 814          * if the command failed.  If the device ever comes back online, we
 815          * can deal with it then.  It is only because of unrecoverable errors
 816          * that we would ever take a device offline in the first place.
 817          */
 818         if (!scsi_device_online(sdp)) {
 819                 set_media_not_present(sdkp);
 820                 retval = 1;
 821                 goto out;
 822         }
 823
 824         /*
 825          * Using TEST_UNIT_READY enables differentiation between drive with
 826          * no cartridge loaded - NOT READY, drive with changed cartridge -
 827          * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
 828          *
 829          * Drives that auto spin down. eg iomega jaz 1G, will be started
 830          * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
 831          * sd_revalidate() is called.
 832          */
 833         retval = -ENODEV;
 834
 835         if (scsi_block_when_processing_errors(sdp)) {
 836                 sshdr  = kzalloc(sizeof(*sshdr), GFP_KERNEL);
 837                 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
 838                                               sshdr);
 839         }
 840
 841         /*
 842          * Unable to test, unit probably not ready.   This usually
 843          * means there is no disc in the drive.  Mark as changed,
 844          * and we will figure it out later once the drive is
 845          * available again.
 846          */
 847         if (retval || (scsi_sense_valid(sshdr) &&
 848                        /* 0x3a is medium not present */
 849                        sshdr->asc == 0x3a)) {
 850                 set_media_not_present(sdkp);
 851                 retval = 1;
 852                 goto out;
 853         }
 854
 855         /*
 856          * For removable scsi disk we have to recognise the presence
 857          * of a disk in the drive. This is kept in the struct scsi_disk
 858          * struct and tested at open !  Daniel Roche (dan@lectra.fr)
 859          */
 860         sdkp->media_present = 1;
 861
 862         retval = sdp->changed;
 863         sdp->changed = 0;
 864 out:
 865         if (retval != sdkp->previous_state)
 866                 sdev_evt_send_simple(sdp, SDEV_EVT_MEDIA_CHANGE, GFP_KERNEL);
 867         sdkp->previous_state = retval;
 868         kfree(sshdr);
 869         return retval;
 870 }
 871
 872 static int sd_sync_cache(struct scsi_disk *sdkp)
 873 {
 874         int retries, res;
 875         struct scsi_device *sdp = sdkp->device;
 876         struct scsi_sense_hdr sshdr;
 877
 878         if (!scsi_device_online(sdp))
 879                 return -ENODEV;
 880
 881
 882         for (retries = 3; retries > 0; --retries) {
 883                 unsigned char cmd[10] = { 0 };
 884
 885                 cmd[0] = SYNCHRONIZE_CACHE;
 886                 /*
 887                  * Leave the rest of the command zero to indicate
 888                  * flush everything.
 889                  */
 890                 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
 891                                        SD_TIMEOUT, SD_MAX_RETRIES);
 892                 if (res == 0)
 893                         break;
 894         }
 895
 896         if (res) {
 897                 sd_print_result(sdkp, res);
 898                 if (driver_byte(res) & DRIVER_SENSE)
 899                         sd_print_sense_hdr(sdkp, &sshdr);
 900         }
 901
 902         if (res)
 903                 return -EIO;
 904         return 0;
 905 }
 906
 907 static void sd_prepare_flush(struct request_queue *q, struct request *rq)
 908 {
 909         rq->cmd_type = REQ_TYPE_BLOCK_PC;
 910         rq->timeout = SD_TIMEOUT;
 911         rq->cmd[0] = SYNCHRONIZE_CACHE;
 912         rq->cmd_len = 10;
 913 }
 914
 915 static void sd_rescan(struct device *dev)
 916 {
 917         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
 918
 919         if (sdkp) {
 920                 revalidate_disk(sdkp->disk);
 921                 scsi_disk_put(sdkp);
 922         }
 923 }
 924
 925
 926 #ifdef CONFIG_COMPAT
 927 /*
 928  * This gets directly called from VFS. When the ioctl
 929  * is not recognized we go back to the other translation paths.
 930  */
 931 static long sd_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
 932 {
 933         struct block_device *bdev = file->f_path.dentry->d_inode->i_bdev;
 934         struct gendisk *disk = bdev->bd_disk;
 935         struct scsi_device *sdev = scsi_disk(disk)->device;
 936
 937         /*
 938          * If we are in the middle of error recovery, don't let anyone
 939          * else try and use this device.  Also, if error recovery fails, it
 940          * may try and take the device offline, in which case all further
 941          * access to the device is prohibited.
 942          */
 943         if (!scsi_block_when_processing_errors(sdev))
 944                 return -ENODEV;
 945
 946         if (sdev->host->hostt->compat_ioctl) {
 947                 int ret;
 948
 949                 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
 950
 951                 return ret;
 952         }
 953
 954         /*
 955          * Let the static ioctl translation table take care of it.
 956          */
 957         return -ENOIOCTLCMD;
 958 }
 959 #endif
 960
 961 static struct block_device_operations sd_fops = {
 962         .owner                  = THIS_MODULE,
 963         .open                   = sd_open,
 964         .release                = sd_release,
 965         .ioctl                  = sd_ioctl,
 966         .getgeo                 = sd_getgeo,
 967 #ifdef CONFIG_COMPAT
 968         .compat_ioctl           = sd_compat_ioctl,
 969 #endif
 970         .media_changed          = sd_media_changed,
 971         .revalidate_disk        = sd_revalidate_disk,
 972 };
 973
 974 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
 975 {
 976         u64 start_lba = scmd->request->sector;
 977         u64 end_lba = scmd->request->sector + (scsi_bufflen(scmd) / 512);
 978         u64 bad_lba;
 979         int info_valid;
 980
 981         if (!blk_fs_request(scmd->request))
 982                 return 0;
 983
 984         info_valid = scsi_get_sense_info_fld(scmd->sense_buffer,
 985                                              SCSI_SENSE_BUFFERSIZE,
 986                                              &bad_lba);
 987         if (!info_valid)
 988                 return 0;
 989
 990         if (scsi_bufflen(scmd) <= scmd->device->sector_size)
 991                 return 0;
 992
 993         if (scmd->device->sector_size < 512) {
 994                 /* only legitimate sector_size here is 256 */
 995                 start_lba <<= 1;
 996                 end_lba <<= 1;
 997         } else {
 998                 /* be careful ... don't want any overflows */
 999                 u64 factor = scmd->device->sector_size / 512;
1000                 do_div(start_lba, factor);
1001                 do_div(end_lba, factor);
1002         }
1003
1004         /* The bad lba was reported incorrectly, we have no idea where
1005          * the error is.
1006          */
1007         if (bad_lba < start_lba  || bad_lba >= end_lba)
1008                 return 0;
1009
1010         /* This computation should always be done in terms of
1011          * the resolution of the device's medium.
1012          */
1013         return (bad_lba - start_lba) * scmd->device->sector_size;
1014 }
1015
1016 /**
1017  *      sd_done - bottom half handler: called when the lower level
1018  *      driver has completed (successfully or otherwise) a scsi command.
1019  *      @SCpnt: mid-level's per command structure.
1020  *
1021  *      Note: potentially run from within an ISR. Must not block.
1022  **/
1023 static int sd_done(struct scsi_cmnd *SCpnt)
1024 {
1025         int result = SCpnt->result;
1026         unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1027         struct scsi_sense_hdr sshdr;
1028         int sense_valid = 0;
1029         int sense_deferred = 0;
1030
1031         if (result) {
1032                 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1033                 if (sense_valid)
1034                         sense_deferred = scsi_sense_is_deferred(&sshdr);
1035         }
1036 #ifdef CONFIG_SCSI_LOGGING
1037         SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
1038         if (sense_valid) {
1039                 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
1040                                                    "sd_done: sb[respc,sk,asc,"
1041                                                    "ascq]=%x,%x,%x,%x\n",
1042                                                    sshdr.response_code,
1043                                                    sshdr.sense_key, sshdr.asc,
1044                                                    sshdr.ascq));
1045         }
1046 #endif
1047         if (driver_byte(result) != DRIVER_SENSE &&
1048             (!sense_valid || sense_deferred))
1049                 goto out;
1050
1051         switch (sshdr.sense_key) {
1052         case HARDWARE_ERROR:
1053         case MEDIUM_ERROR:
1054                 good_bytes = sd_completed_bytes(SCpnt);
1055                 break;
1056         case RECOVERED_ERROR:
1057         case NO_SENSE:
1058                 /* Inform the user, but make sure that it's not treated
1059                  * as a hard error.
1060                  */
1061                 scsi_print_sense("sd", SCpnt);
1062                 SCpnt->result = 0;
1063                 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1064                 good_bytes = scsi_bufflen(SCpnt);
1065                 break;
1066         case ABORTED_COMMAND:
1067                 if (sshdr.asc == 0x10) { /* DIF: Disk detected corruption */
1068                         scsi_print_result(SCpnt);
1069                         scsi_print_sense("sd", SCpnt);
1070                         good_bytes = sd_completed_bytes(SCpnt);
1071                 }
1072                 break;
1073         case ILLEGAL_REQUEST:
1074                 if (sshdr.asc == 0x10) { /* DIX: HBA detected corruption */
1075                         scsi_print_result(SCpnt);
1076                         scsi_print_sense("sd", SCpnt);
1077                         good_bytes = sd_completed_bytes(SCpnt);
1078                 }
1079                 if (!scsi_device_protection(SCpnt->device) &&
1080                     SCpnt->device->use_10_for_rw &&
1081                     (SCpnt->cmnd[0] == READ_10 ||
1082                      SCpnt->cmnd[0] == WRITE_10))
1083                         SCpnt->device->use_10_for_rw = 0;
1084                 if (SCpnt->device->use_10_for_ms &&
1085                     (SCpnt->cmnd[0] == MODE_SENSE_10 ||
1086                      SCpnt->cmnd[0] == MODE_SELECT_10))
1087                         SCpnt->device->use_10_for_ms = 0;
1088                 break;
1089         default:
1090                 break;
1091         }
1092  out:
1093         if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt))
1094                 sd_dif_complete(SCpnt, good_bytes);
1095
1096         return good_bytes;
1097 }
1098
1099 static int media_not_present(struct scsi_disk *sdkp,
1100                              struct scsi_sense_hdr *sshdr)
1101 {
1102
1103         if (!scsi_sense_valid(sshdr))
1104                 return 0;
1105         /* not invoked for commands that could return deferred errors */
1106         if (sshdr->sense_key != NOT_READY &&
1107             sshdr->sense_key != UNIT_ATTENTION)
1108                 return 0;
1109         if (sshdr->asc != 0x3A) /* medium not present */
1110                 return 0;
1111
1112         set_media_not_present(sdkp);
1113         return 1;
1114 }
1115
1116 /*
1117  * spinup disk - called only in sd_revalidate_disk()
1118  */
1119 static void
1120 sd_spinup_disk(struct scsi_disk *sdkp)
1121 {
1122         unsigned char cmd[10];
1123         unsigned long spintime_expire = 0;
1124         int retries, spintime;
1125         unsigned int the_result;
1126         struct scsi_sense_hdr sshdr;
1127         int sense_valid = 0;
1128
1129         spintime = 0;
1130
1131         /* Spin up drives, as required.  Only do this at boot time */
1132         /* Spinup needs to be done for module loads too. */
1133         do {
1134                 retries = 0;
1135
1136                 do {
1137                         cmd[0] = TEST_UNIT_READY;
1138                         memset((void *) &cmd[1], 0, 9);
1139
1140                         the_result = scsi_execute_req(sdkp->device, cmd,
1141                                                       DMA_NONE, NULL, 0,
1142                                                       &sshdr, SD_TIMEOUT,
1143                                                       SD_MAX_RETRIES);
1144
1145                         /*
1146                          * If the drive has indicated to us that it
1147                          * doesn't have any media in it, don't bother
1148                          * with any more polling.
1149                          */
1150                         if (media_not_present(sdkp, &sshdr))
1151                                 return;
1152
1153                         if (the_result)
1154                                 sense_valid = scsi_sense_valid(&sshdr);
1155                         retries++;
1156                 } while (retries < 3 &&
1157                          (!scsi_status_is_good(the_result) ||
1158                           ((driver_byte(the_result) & DRIVER_SENSE) &&
1159                           sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1160
1161                 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1162                         /* no sense, TUR either succeeded or failed
1163                          * with a status error */
1164                         if(!spintime && !scsi_status_is_good(the_result)) {
1165                                 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1166                                 sd_print_result(sdkp, the_result);
1167                         }
1168                         break;
1169                 }
1170
1171                 /*
1172                  * The device does not want the automatic start to be issued.
1173                  */
1174                 if (sdkp->device->no_start_on_add) {
1175                         break;
1176                 }
1177
1178                 /*
1179                  * If manual intervention is required, or this is an
1180                  * absent USB storage device, a spinup is meaningless.
1181                  */
1182                 if (sense_valid &&
1183                     sshdr.sense_key == NOT_READY &&
1184                     sshdr.asc == 4 && sshdr.ascq == 3) {
1185                         break;          /* manual intervention required */
1186
1187                 /*
1188                  * Issue command to spin up drive when not ready
1189                  */
1190                 } else if (sense_valid && sshdr.sense_key == NOT_READY) {
1191                         if (!spintime) {
1192                                 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1193                                 cmd[0] = START_STOP;
1194                                 cmd[1] = 1;     /* Return immediately */
1195                                 memset((void *) &cmd[2], 0, 8);
1196                                 cmd[4] = 1;     /* Start spin cycle */
1197                                 if (sdkp->device->start_stop_pwr_cond)
1198                                         cmd[4] |= 1 << 4;
1199                                 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1200                                                  NULL, 0, &sshdr,
1201                                                  SD_TIMEOUT, SD_MAX_RETRIES);
1202                                 spintime_expire = jiffies + 100 * HZ;
1203                                 spintime = 1;
1204                         }
1205                         /* Wait 1 second for next try */
1206                         msleep(1000);
1207                         printk(".");
1208
1209                 /*
1210                  * Wait for USB flash devices with slow firmware.
1211                  * Yes, this sense key/ASC combination shouldn't
1212                  * occur here.  It's characteristic of these devices.
1213                  */
1214                 } else if (sense_valid &&
1215                                 sshdr.sense_key == UNIT_ATTENTION &&
1216                                 sshdr.asc == 0x28) {
1217                         if (!spintime) {
1218                                 spintime_expire = jiffies + 5 * HZ;
1219                                 spintime = 1;
1220                         }
1221                         /* Wait 1 second for next try */
1222                         msleep(1000);
1223                 } else {
1224                         /* we don't understand the sense code, so it's
1225                          * probably pointless to loop */
1226                         if(!spintime) {
1227                                 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1228                                 sd_print_sense_hdr(sdkp, &sshdr);
1229                         }
1230                         break;
1231                 }
1232
1233         } while (spintime && time_before_eq(jiffies, spintime_expire));
1234
1235         if (spintime) {
1236                 if (scsi_status_is_good(the_result))
1237                         printk("ready\n");
1238                 else
1239                         printk("not responding...\n");
1240         }
1241 }
1242
1243
1244 /*
1245  * Determine whether disk supports Data Integrity Field.
1246  */
1247 void sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
1248 {
1249         struct scsi_device *sdp = sdkp->device;
1250         u8 type;
1251
1252         if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
1253                 type = 0;
1254         else
1255                 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
1256
1257         sdkp->protection_type = type;
1258
1259         switch (type) {
1260         case SD_DIF_TYPE0_PROTECTION:
1261         case SD_DIF_TYPE1_PROTECTION:
1262         case SD_DIF_TYPE3_PROTECTION:
1263                 break;
1264
1265         case SD_DIF_TYPE2_PROTECTION:
1266                 sd_printk(KERN_ERR, sdkp, "formatted with DIF Type 2 "  \
1267                           "protection which is currently unsupported. " \
1268                           "Disabling disk!\n");
1269                 goto disable;
1270
1271         default:
1272                 sd_printk(KERN_ERR, sdkp, "formatted with unknown "     \
1273                           "protection type %d. Disabling disk!\n", type);
1274                 goto disable;
1275         }
1276
1277         return;
1278
1279 disable:
1280         sdkp->capacity = 0;
1281 }
1282
1283 /*
1284  * read disk capacity
1285  */
1286 static void
1287 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
1288 {
1289         unsigned char cmd[16];
1290         int the_result, retries;
1291         int sector_size = 0;
1292         /* Force READ CAPACITY(16) when PROTECT=1 */
1293         int longrc = scsi_device_protection(sdkp->device) ? 1 : 0;
1294         struct scsi_sense_hdr sshdr;
1295         int sense_valid = 0;
1296         struct scsi_device *sdp = sdkp->device;
1297
1298 repeat:
1299         retries = 3;
1300         do {
1301                 if (longrc) {
1302                         memset((void *) cmd, 0, 16);
1303                         cmd[0] = SERVICE_ACTION_IN;
1304                         cmd[1] = SAI_READ_CAPACITY_16;
1305                         cmd[13] = 13;
1306                         memset((void *) buffer, 0, 13);
1307                 } else {
1308                         cmd[0] = READ_CAPACITY;
1309                         memset((void *) &cmd[1], 0, 9);
1310                         memset((void *) buffer, 0, 8);
1311                 }
1312
1313                 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1314                                               buffer, longrc ? 13 : 8, &sshdr,
1315                                               SD_TIMEOUT, SD_MAX_RETRIES);
1316
1317                 if (media_not_present(sdkp, &sshdr))
1318                         return;
1319
1320                 if (the_result)
1321                         sense_valid = scsi_sense_valid(&sshdr);
1322                 retries--;
1323
1324         } while (the_result && retries);
1325
1326         if (the_result && !longrc) {
1327                 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
1328                 sd_print_result(sdkp, the_result);
1329                 if (driver_byte(the_result) & DRIVER_SENSE)
1330                         sd_print_sense_hdr(sdkp, &sshdr);
1331                 else
1332                         sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1333
1334                 /* Set dirty bit for removable devices if not ready -
1335                  * sometimes drives will not report this properly. */
1336                 if (sdp->removable &&
1337                     sense_valid && sshdr.sense_key == NOT_READY)
1338                         sdp->changed = 1;
1339
1340                 /* Either no media are present but the drive didn't tell us,
1341                    or they are present but the read capacity command fails */
1342                 /* sdkp->media_present = 0; -- not always correct */
1343                 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1344
1345                 return;
1346         } else if (the_result && longrc) {
1347                 /* READ CAPACITY(16) has been failed */
1348                 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
1349                 sd_print_result(sdkp, the_result);
1350                 sd_printk(KERN_NOTICE, sdkp, "Use 0xffffffff as device size\n");
1351
1352                 sdkp->capacity = 1 + (sector_t) 0xffffffff;
1353                 goto got_data;
1354         }
1355
1356         if (!longrc) {
1357                 sector_size = (buffer[4] << 24) |
1358                         (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
1359                 if (buffer[0] == 0xff && buffer[1] == 0xff &&
1360                     buffer[2] == 0xff && buffer[3] == 0xff) {
1361                         if(sizeof(sdkp->capacity) > 4) {
1362                                 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
1363                                           "Trying to use READ CAPACITY(16).\n");
1364                                 longrc = 1;
1365                                 goto repeat;
1366                         }
1367                         sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use "
1368                                   "a kernel compiled with support for large "
1369                                   "block devices.\n");
1370                         sdkp->capacity = 0;
1371                         goto got_data;
1372                 }
1373                 sdkp->capacity = 1 + (((sector_t)buffer[0] << 24) |
1374                         (buffer[1] << 16) |
1375                         (buffer[2] << 8) |
1376                         buffer[3]);
1377         } else {
1378                 sdkp->capacity = 1 + (((u64)buffer[0] << 56) |
1379                         ((u64)buffer[1] << 48) |
1380                         ((u64)buffer[2] << 40) |
1381                         ((u64)buffer[3] << 32) |
1382                         ((sector_t)buffer[4] << 24) |
1383                         ((sector_t)buffer[5] << 16) |
1384                         ((sector_t)buffer[6] << 8)  |
1385                         (sector_t)buffer[7]);
1386
1387                 sector_size = (buffer[8] << 24) |
1388                         (buffer[9] << 16) | (buffer[10] << 8) | buffer[11];
1389
1390                 sd_read_protection_type(sdkp, buffer);
1391         }
1392
1393         /* Some devices return the total number of sectors, not the
1394          * highest sector number.  Make the necessary adjustment. */
1395         if (sdp->fix_capacity) {
1396                 --sdkp->capacity;
1397
1398         /* Some devices have version which report the correct sizes
1399          * and others which do not. We guess size according to a heuristic
1400          * and err on the side of lowering the capacity. */
1401         } else {
1402                 if (sdp->guess_capacity)
1403                         if (sdkp->capacity & 0x01) /* odd sizes are odd */
1404                                 --sdkp->capacity;
1405         }
1406
1407 got_data:
1408         if (sector_size == 0) {
1409                 sector_size = 512;
1410                 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
1411                           "assuming 512.\n");
1412         }
1413
1414         if (sector_size != 512 &&
1415             sector_size != 1024 &&
1416             sector_size != 2048 &&
1417             sector_size != 4096 &&
1418             sector_size != 256) {
1419                 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
1420                           sector_size);
1421                 /*
1422                  * The user might want to re-format the drive with
1423                  * a supported sectorsize.  Once this happens, it
1424                  * would be relatively trivial to set the thing up.
1425                  * For this reason, we leave the thing in the table.
1426                  */
1427                 sdkp->capacity = 0;
1428                 /*
1429                  * set a bogus sector size so the normal read/write
1430                  * logic in the block layer will eventually refuse any
1431                  * request on this device without tripping over power
1432                  * of two sector size assumptions
1433                  */
1434                 sector_size = 512;
1435         }
1436         blk_queue_hardsect_size(sdp->request_queue, sector_size);
1437
1438         {
1439                 char cap_str_2[10], cap_str_10[10];
1440                 u64 sz = sdkp->capacity << ffz(~sector_size);
1441
1442                 string_get_size(sz, STRING_UNITS_2, cap_str_2,
1443                                 sizeof(cap_str_2));
1444                 string_get_size(sz, STRING_UNITS_10, cap_str_10,
1445                                 sizeof(cap_str_10));
1446
1447                 sd_printk(KERN_NOTICE, sdkp,
1448                           "%llu %d-byte hardware sectors: (%s/%s)\n",
1449                           (unsigned long long)sdkp->capacity,
1450                           sector_size, cap_str_10, cap_str_2);
1451         }
1452
1453         /* Rescale capacity to 512-byte units */
1454         if (sector_size == 4096)
1455                 sdkp->capacity <<= 3;
1456         else if (sector_size == 2048)
1457                 sdkp->capacity <<= 2;
1458         else if (sector_size == 1024)
1459                 sdkp->capacity <<= 1;
1460         else if (sector_size == 256)
1461                 sdkp->capacity >>= 1;
1462
1463         sdkp->device->sector_size = sector_size;
1464 }
1465
1466 /* called with buffer of length 512 */
1467 static inline int
1468 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1469                  unsigned char *buffer, int len, struct scsi_mode_data *data,
1470                  struct scsi_sense_hdr *sshdr)
1471 {
1472         return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1473                                SD_TIMEOUT, SD_MAX_RETRIES, data,
1474                                sshdr);
1475 }
1476
1477 /*
1478  * read write protect setting, if possible - called only in sd_revalidate_disk()
1479  * called with buffer of length SD_BUF_SIZE
1480  */
1481 static void
1482 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
1483 {
1484         int res;
1485         struct scsi_device *sdp = sdkp->device;
1486         struct scsi_mode_data data;
1487
1488         set_disk_ro(sdkp->disk, 0);
1489         if (sdp->skip_ms_page_3f) {
1490                 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1491                 return;
1492         }
1493
1494         if (sdp->use_192_bytes_for_3f) {
1495                 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1496         } else {
1497                 /*
1498                  * First attempt: ask for all pages (0x3F), but only 4 bytes.
1499                  * We have to start carefully: some devices hang if we ask
1500                  * for more than is available.
1501                  */
1502                 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1503
1504                 /*
1505                  * Second attempt: ask for page 0 When only page 0 is
1506                  * implemented, a request for page 3F may return Sense Key
1507                  * 5: Illegal Request, Sense Code 24: Invalid field in
1508                  * CDB.
1509                  */
1510                 if (!scsi_status_is_good(res))
1511                         res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1512
1513                 /*
1514                  * Third attempt: ask 255 bytes, as we did earlier.
1515                  */
1516                 if (!scsi_status_is_good(res))
1517                         res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1518                                                &data, NULL);
1519         }
1520
1521         if (!scsi_status_is_good(res)) {
1522                 sd_printk(KERN_WARNING, sdkp,
1523                           "Test WP failed, assume Write Enabled\n");
1524         } else {
1525                 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
1526                 set_disk_ro(sdkp->disk, sdkp->write_prot);
1527                 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
1528                           sdkp->write_prot ? "on" : "off");
1529                 sd_printk(KERN_DEBUG, sdkp,
1530                           "Mode Sense: %02x %02x %02x %02x\n",
1531                           buffer[0], buffer[1], buffer[2], buffer[3]);
1532         }
1533 }
1534
1535 /*
1536  * sd_read_cache_type - called only from sd_revalidate_disk()
1537  * called with buffer of length SD_BUF_SIZE
1538  */
1539 static void
1540 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
1541 {
1542         int len = 0, res;
1543         struct scsi_device *sdp = sdkp->device;
1544
1545         int dbd;
1546         int modepage;
1547         struct scsi_mode_data data;
1548         struct scsi_sense_hdr sshdr;
1549
1550         if (sdp->skip_ms_page_8)
1551                 goto defaults;
1552
1553         if (sdp->type == TYPE_RBC) {
1554                 modepage = 6;
1555                 dbd = 8;
1556         } else {
1557                 modepage = 8;
1558                 dbd = 0;
1559         }
1560
1561         /* cautiously ask */
1562         res = sd_do_mode_sense(sdp, dbd, modepage, buffer, 4, &data, &sshdr);
1563
1564         if (!scsi_status_is_good(res))
1565                 goto bad_sense;
1566
1567         if (!data.header_length) {
1568                 modepage = 6;
1569                 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
1570         }
1571
1572         /* that went OK, now ask for the proper length */
1573         len = data.length;
1574
1575         /*
1576          * We're only interested in the first three bytes, actually.
1577          * But the data cache page is defined for the first 20.
1578          */
1579         if (len < 3)
1580                 goto bad_sense;
1581         if (len > 20)
1582                 len = 20;
1583
1584         /* Take headers and block descriptors into account */
1585         len += data.header_length + data.block_descriptor_length;
1586         if (len > SD_BUF_SIZE)
1587                 goto bad_sense;
1588
1589         /* Get the data */
1590         res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len, &data, &sshdr);
1591
1592         if (scsi_status_is_good(res)) {
1593                 int offset = data.header_length + data.block_descriptor_length;
1594
1595                 if (offset >= SD_BUF_SIZE - 2) {
1596                         sd_printk(KERN_ERR, sdkp, "Malformed MODE SENSE response\n");
1597                         goto defaults;
1598                 }
1599
1600                 if ((buffer[offset] & 0x3f) != modepage) {
1601                         sd_printk(KERN_ERR, sdkp, "Got wrong page\n");
1602                         goto defaults;
1603                 }
1604
1605                 if (modepage == 8) {
1606                         sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
1607                         sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
1608                 } else {
1609                         sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
1610                         sdkp->RCD = 0;
1611                 }
1612
1613                 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
1614                 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
1615                         sd_printk(KERN_NOTICE, sdkp,
1616                                   "Uses READ/WRITE(6), disabling FUA\n");
1617                         sdkp->DPOFUA = 0;
1618                 }
1619
1620                 sd_printk(KERN_NOTICE, sdkp,
1621                        "Write cache: %s, read cache: %s, %s\n",
1622                        sdkp->WCE ? "enabled" : "disabled",
1623                        sdkp->RCD ? "disabled" : "enabled",
1624                        sdkp->DPOFUA ? "supports DPO and FUA"
1625                        : "doesn't support DPO or FUA");
1626
1627                 return;
1628         }
1629
1630 bad_sense:
1631         if (scsi_sense_valid(&sshdr) &&
1632             sshdr.sense_key == ILLEGAL_REQUEST &&
1633             sshdr.asc == 0x24 && sshdr.ascq == 0x0)
1634                 /* Invalid field in CDB */
1635                 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1636         else
1637                 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
1638
1639 defaults:
1640         sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
1641         sdkp->WCE = 0;
1642         sdkp->RCD = 0;
1643         sdkp->DPOFUA = 0;
1644 }
1645
1646 /*
1647  * The ATO bit indicates whether the DIF application tag is available
1648  * for use by the operating system.
1649  */
1650 void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
1651 {
1652         int res, offset;
1653         struct scsi_device *sdp = sdkp->device;
1654         struct scsi_mode_data data;
1655         struct scsi_sense_hdr sshdr;
1656
1657         if (sdp->type != TYPE_DISK)
1658                 return;
1659
1660         if (sdkp->protection_type == 0)
1661                 return;
1662
1663         res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
1664                               SD_MAX_RETRIES, &data, &sshdr);
1665
1666         if (!scsi_status_is_good(res) || !data.header_length ||
1667             data.length < 6) {
1668                 sd_printk(KERN_WARNING, sdkp,
1669                           "getting Control mode page failed, assume no ATO\n");
1670
1671                 if (scsi_sense_valid(&sshdr))
1672                         sd_print_sense_hdr(sdkp, &sshdr);
1673
1674                 return;
1675         }
1676
1677         offset = data.header_length + data.block_descriptor_length;
1678
1679         if ((buffer[offset] & 0x3f) != 0x0a) {
1680                 sd_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
1681                 return;
1682         }
1683
1684         if ((buffer[offset + 5] & 0x80) == 0)
1685                 return;
1686
1687         sdkp->ATO = 1;
1688
1689         return;
1690 }
1691
1692 /**
1693  *      sd_revalidate_disk - called the first time a new disk is seen,
1694  *      performs disk spin up, read_capacity, etc.
1695  *      @disk: struct gendisk we care about
1696  **/
1697 static int sd_revalidate_disk(struct gendisk *disk)
1698 {
1699         struct scsi_disk *sdkp = scsi_disk(disk);
1700         struct scsi_device *sdp = sdkp->device;
1701         unsigned char *buffer;
1702         unsigned ordered;
1703
1704         SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
1705                                       "sd_revalidate_disk\n"));
1706
1707         /*
1708          * If the device is offline, don't try and read capacity or any
1709          * of the other niceties.
1710          */
1711         if (!scsi_device_online(sdp))
1712                 goto out;
1713
1714         buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1715         if (!buffer) {
1716                 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
1717                           "allocation failure.\n");
1718                 goto out;
1719         }
1720
1721         /* defaults, until the device tells us otherwise */
1722         sdp->sector_size = 512;
1723         sdkp->capacity = 0;
1724         sdkp->media_present = 1;
1725         sdkp->write_prot = 0;
1726         sdkp->WCE = 0;
1727         sdkp->RCD = 0;
1728         sdkp->ATO = 0;
1729
1730         sd_spinup_disk(sdkp);
1731
1732         /*
1733          * Without media there is no reason to ask; moreover, some devices
1734          * react badly if we do.
1735          */
1736         if (sdkp->media_present) {
1737                 sd_read_capacity(sdkp, buffer);
1738                 sd_read_write_protect_flag(sdkp, buffer);
1739                 sd_read_cache_type(sdkp, buffer);
1740                 sd_read_app_tag_own(sdkp, buffer);
1741         }
1742
1743         /*
1744          * We now have all cache related info, determine how we deal
1745          * with ordered requests.  Note that as the current SCSI
1746          * dispatch function can alter request order, we cannot use
1747          * QUEUE_ORDERED_TAG_* even when ordered tag is supported.
1748          */
1749         if (sdkp->WCE)
1750                 ordered = sdkp->DPOFUA
1751                         ? QUEUE_ORDERED_DRAIN_FUA : QUEUE_ORDERED_DRAIN_FLUSH;
1752         else
1753                 ordered = QUEUE_ORDERED_DRAIN;
1754
1755         blk_queue_ordered(sdkp->disk->queue, ordered, sd_prepare_flush);
1756
1757         set_capacity(disk, sdkp->capacity);
1758         kfree(buffer);
1759
1760  out:
1761         return 0;
1762 }
1763
1764 /**
1765  *      sd_format_disk_name - format disk name
1766  *      @prefix: name prefix - ie. "sd" for SCSI disks
1767  *      @index: index of the disk to format name for
1768  *      @buf: output buffer
1769  *      @buflen: length of the output buffer
1770  *
1771  *      SCSI disk names starts at sda.  The 26th device is sdz and the
1772  *      27th is sdaa.  The last one for two lettered suffix is sdzz
1773  *      which is followed by sdaaa.
1774  *
1775  *      This is basically 26 base counting with one extra 'nil' entry
1776  *      at the beggining from the second digit on and can be
1777  *      determined using similar method as 26 base conversion with the
1778  *      index shifted -1 after each digit is computed.
1779  *
1780  *      CONTEXT:
1781  *      Don't care.
1782  *
1783  *      RETURNS:
1784  *      0 on success, -errno on failure.
1785  */
1786 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
1787 {
1788         const int base = 'z' - 'a' + 1;
1789         char *begin = buf + strlen(prefix);
1790         char *end = buf + buflen;
1791         char *p;
1792         int unit;
1793
1794         p = end - 1;
1795         *p = '\0';
1796         unit = base;
1797         do {
1798                 if (p == begin)
1799                         return -EINVAL;
1800                 *--p = 'a' + (index % unit);
1801                 index = (index / unit) - 1;
1802         } while (index >= 0);
1803
1804         memmove(begin, p, end - p);
1805         memcpy(buf, prefix, strlen(prefix));
1806
1807         return 0;
1808 }
1809
1810 /**
1811  *      sd_probe - called during driver initialization and whenever a
1812  *      new scsi device is attached to the system. It is called once
1813  *      for each scsi device (not just disks) present.
1814  *      @dev: pointer to device object
1815  *
1816  *      Returns 0 if successful (or not interested in this scsi device
1817  *      (e.g. scanner)); 1 when there is an error.
1818  *
1819  *      Note: this function is invoked from the scsi mid-level.
1820  *      This function sets up the mapping between a given
1821  *      <host,channel,id,lun> (found in sdp) and new device name
1822  *      (e.g. /dev/sda). More precisely it is the block device major
1823  *      and minor number that is chosen here.
1824  *
1825  *      Assume sd_attach is not re-entrant (for time being)
1826  *      Also think about sd_attach() and sd_remove() running coincidentally.
1827  **/
1828 static int sd_probe(struct device *dev)
1829 {
1830         struct scsi_device *sdp = to_scsi_device(dev);
1831         struct scsi_disk *sdkp;
1832         struct gendisk *gd;
1833         u32 index;
1834         int error;
1835
1836         error = -ENODEV;
1837         if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
1838                 goto out;
1839
1840         SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
1841                                         "sd_attach\n"));
1842
1843         error = -ENOMEM;
1844         sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
1845         if (!sdkp)
1846                 goto out;
1847
1848         gd = alloc_disk(SD_MINORS);
1849         if (!gd)
1850                 goto out_free;
1851
1852         do {
1853                 if (!ida_pre_get(&sd_index_ida, GFP_KERNEL))
1854                         goto out_put;
1855
1856                 error = ida_get_new(&sd_index_ida, &index);
1857         } while (error == -EAGAIN);
1858
1859         if (error)
1860                 goto out_put;
1861
1862         error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
1863         if (error)
1864                 goto out_free_index;
1865
1866         sdkp->device = sdp;
1867         sdkp->driver = &sd_template;
1868         sdkp->disk = gd;
1869         sdkp->index = index;
1870         sdkp->openers = 0;
1871         sdkp->previous_state = 1;
1872
1873         if (!sdp->request_queue->rq_timeout) {
1874                 if (sdp->type != TYPE_MOD)
1875                         blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
1876                 else
1877                         blk_queue_rq_timeout(sdp->request_queue,
1878                                              SD_MOD_TIMEOUT);
1879         }
1880
1881         device_initialize(&sdkp->dev);
1882         sdkp->dev.parent = &sdp->sdev_gendev;
1883         sdkp->dev.class = &sd_disk_class;
1884         strncpy(sdkp->dev.bus_id, sdp->sdev_gendev.bus_id, BUS_ID_SIZE);
1885
1886         if (device_add(&sdkp->dev))
1887                 goto out_free_index;
1888
1889         get_device(&sdp->sdev_gendev);
1890
1891         if (index < SD_MAX_DISKS) {
1892                 gd->major = sd_major((index & 0xf0) >> 4);
1893                 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1894                 gd->minors = SD_MINORS;
1895         }
1896         gd->fops = &sd_fops;
1897         gd->private_data = &sdkp->driver;
1898         gd->queue = sdkp->device->request_queue;
1899
1900         sd_revalidate_disk(gd);
1901
1902         blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
1903
1904         gd->driverfs_dev = &sdp->sdev_gendev;
1905         gd->flags = GENHD_FL_EXT_DEVT | GENHD_FL_DRIVERFS;
1906         if (sdp->removable)
1907                 gd->flags |= GENHD_FL_REMOVABLE;
1908
1909         dev_set_drvdata(dev, sdkp);
1910         add_disk(gd);
1911         sd_dif_config_host(sdkp);
1912
1913         sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
1914                   sdp->removable ? "removable " : "");
1915
1916         return 0;
1917
1918  out_free_index:
1919         ida_remove(&sd_index_ida, index);
1920  out_put:
1921         put_disk(gd);
1922  out_free:
1923         kfree(sdkp);
1924  out:
1925         return error;
1926 }
1927
1928 /**
1929  *      sd_remove - called whenever a scsi disk (previously recognized by
1930  *      sd_probe) is detached from the system. It is called (potentially
1931  *      multiple times) during sd module unload.
1932  *      @sdp: pointer to mid level scsi device object
1933  *
1934  *      Note: this function is invoked from the scsi mid-level.
1935  *      This function potentially frees up a device name (e.g. /dev/sdc)
1936  *      that could be re-used by a subsequent sd_probe().
1937  *      This function is not called when the built-in sd driver is "exit-ed".
1938  **/
1939 static int sd_remove(struct device *dev)
1940 {
1941         struct scsi_disk *sdkp = dev_get_drvdata(dev);
1942
1943         device_del(&sdkp->dev);
1944         del_gendisk(sdkp->disk);
1945         sd_shutdown(dev);
1946
1947         mutex_lock(&sd_ref_mutex);
1948         dev_set_drvdata(dev, NULL);
1949         put_device(&sdkp->dev);
1950         mutex_unlock(&sd_ref_mutex);
1951
1952         return 0;
1953 }
1954
1955 /**
1956  *      scsi_disk_release - Called to free the scsi_disk structure
1957  *      @dev: pointer to embedded class device
1958  *
1959  *      sd_ref_mutex must be held entering this routine.  Because it is
1960  *      called on last put, you should always use the scsi_disk_get()
1961  *      scsi_disk_put() helpers which manipulate the semaphore directly
1962  *      and never do a direct put_device.
1963  **/
1964 static void scsi_disk_release(struct device *dev)
1965 {
1966         struct scsi_disk *sdkp = to_scsi_disk(dev);
1967         struct gendisk *disk = sdkp->disk;
1968
1969         ida_remove(&sd_index_ida, sdkp->index);
1970
1971         disk->private_data = NULL;
1972         put_disk(disk);
1973         put_device(&sdkp->device->sdev_gendev);
1974
1975         kfree(sdkp);
1976 }
1977
1978 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
1979 {
1980         unsigned char cmd[6] = { START_STOP };  /* START_VALID */
1981         struct scsi_sense_hdr sshdr;
1982         struct scsi_device *sdp = sdkp->device;
1983         int res;
1984
1985         if (start)
1986                 cmd[4] |= 1;    /* START */
1987
1988         if (sdp->start_stop_pwr_cond)
1989                 cmd[4] |= start ? 1 << 4 : 3 << 4;      /* Active or Standby */
1990
1991         if (!scsi_device_online(sdp))
1992                 return -ENODEV;
1993
1994         res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
1995                                SD_TIMEOUT, SD_MAX_RETRIES);
1996         if (res) {
1997                 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
1998                 sd_print_result(sdkp, res);
1999                 if (driver_byte(res) & DRIVER_SENSE)
2000                         sd_print_sense_hdr(sdkp, &sshdr);
2001         }
2002
2003         return res;
2004 }
2005
2006 /*
2007  * Send a SYNCHRONIZE CACHE instruction down to the device through
2008  * the normal SCSI command structure.  Wait for the command to
2009  * complete.
2010  */
2011 static void sd_shutdown(struct device *dev)
2012 {
2013         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2014
2015         if (!sdkp)
2016                 return;         /* this can happen */
2017
2018         if (sdkp->WCE) {
2019                 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2020                 sd_sync_cache(sdkp);
2021         }
2022
2023         if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
2024                 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2025                 sd_start_stop_device(sdkp, 0);
2026         }
2027
2028         scsi_disk_put(sdkp);
2029 }
2030
2031 static int sd_suspend(struct device *dev, pm_message_t mesg)
2032 {
2033         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2034         int ret = 0;
2035
2036         if (!sdkp)
2037                 return 0;       /* this can happen */
2038
2039         if (sdkp->WCE) {
2040                 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2041                 ret = sd_sync_cache(sdkp);
2042                 if (ret)
2043                         goto done;
2044         }
2045
2046         if ((mesg.event & PM_EVENT_SLEEP) && sdkp->device->manage_start_stop) {
2047                 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2048                 ret = sd_start_stop_device(sdkp, 0);
2049         }
2050
2051 done:
2052         scsi_disk_put(sdkp);
2053         return ret;
2054 }
2055
2056 static int sd_resume(struct device *dev)
2057 {
2058         struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2059         int ret = 0;
2060
2061         if (!sdkp->device->manage_start_stop)
2062                 goto done;
2063
2064         sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
2065         ret = sd_start_stop_device(sdkp, 1);
2066
2067 done:
2068         scsi_disk_put(sdkp);
2069         return ret;
2070 }
2071
2072 /**
2073  *      init_sd - entry point for this driver (both when built in or when
2074  *      a module).
2075  *
2076  *      Note: this function registers this driver with the scsi mid-level.
2077  **/
2078 static int __init init_sd(void)
2079 {
2080         int majors = 0, i, err;
2081
2082         SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
2083
2084         for (i = 0; i < SD_MAJORS; i++)
2085                 if (register_blkdev(sd_major(i), "sd") == 0)
2086                         majors++;
2087
2088         if (!majors)
2089                 return -ENODEV;
2090
2091         err = class_register(&sd_disk_class);
2092         if (err)
2093                 goto err_out;
2094
2095         err = scsi_register_driver(&sd_template.gendrv);
2096         if (err)
2097                 goto err_out_class;
2098
2099         return 0;
2100
2101 err_out_class:
2102         class_unregister(&sd_disk_class);
2103 err_out:
2104         for (i = 0; i < SD_MAJORS; i++)
2105                 unregister_blkdev(sd_major(i), "sd");
2106         return err;
2107 }
2108
2109 /**
2110  *      exit_sd - exit point for this driver (when it is a module).
2111  *
2112  *      Note: this function unregisters this driver from the scsi mid-level.
2113  **/
2114 static void __exit exit_sd(void)
2115 {
2116         int i;
2117
2118         SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
2119
2120         scsi_unregister_driver(&sd_template.gendrv);
2121         class_unregister(&sd_disk_class);
2122
2123         for (i = 0; i < SD_MAJORS; i++)
2124                 unregister_blkdev(sd_major(i), "sd");
2125 }
2126
2127 module_init(init_sd);
2128 module_exit(exit_sd);
2129
2130 static void sd_print_sense_hdr(struct scsi_disk *sdkp,
2131                                struct scsi_sense_hdr *sshdr)
2132 {
2133         sd_printk(KERN_INFO, sdkp, "");
2134         scsi_show_sense_hdr(sshdr);
2135         sd_printk(KERN_INFO, sdkp, "");
2136         scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
2137 }
2138
2139 static void sd_print_result(struct scsi_disk *sdkp, int result)
2140 {
2141         sd_printk(KERN_INFO, sdkp, "");
2142         scsi_show_result(result);
2143 }
2144