2 * sd.c Copyright (C) 1992 Drew Eckhardt
3 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
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.
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.
35 #include <linux/module.h>
37 #include <linux/kernel.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 <linux/async.h>
52 #include <asm/uaccess.h>
54 #include <scsi/scsi.h>
55 #include <scsi/scsi_cmnd.h>
56 #include <scsi/scsi_dbg.h>
57 #include <scsi/scsi_device.h>
58 #include <scsi/scsi_driver.h>
59 #include <scsi/scsi_eh.h>
60 #include <scsi/scsi_host.h>
61 #include <scsi/scsi_ioctl.h>
62 #include <scsi/scsicam.h>
65 #include "scsi_logging.h"
67 MODULE_AUTHOR("Eric Youngdale");
68 MODULE_DESCRIPTION("SCSI disk (sd) driver");
69 MODULE_LICENSE("GPL");
71 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
72 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
73 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
74 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
75 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
76 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
77 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
78 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
79 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
85 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
86 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
87 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
88 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
89 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
91 #if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
97 static int sd_revalidate_disk(struct gendisk *);
98 static int sd_probe(struct device *);
99 static int sd_remove(struct device *);
100 static void sd_shutdown(struct device *);
101 static int sd_suspend(struct device *, pm_message_t state);
102 static int sd_resume(struct device *);
103 static void sd_rescan(struct device *);
104 static int sd_done(struct scsi_cmnd *);
105 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
106 static void scsi_disk_release(struct device *cdev);
107 static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
108 static void sd_print_result(struct scsi_disk *, int);
110 static DEFINE_SPINLOCK(sd_index_lock);
111 static DEFINE_IDA(sd_index_ida);
113 /* This semaphore is used to mediate the 0->1 reference get in the
114 * face of object destruction (i.e. we can't allow a get on an
115 * object after last put) */
116 static DEFINE_MUTEX(sd_ref_mutex);
118 static const char *sd_cache_types[] = {
119 "write through", "none", "write back",
120 "write back, no read (daft)"
124 sd_store_cache_type(struct device *dev, struct device_attribute *attr,
125 const char *buf, size_t count)
127 int i, ct = -1, rcd, wce, sp;
128 struct scsi_disk *sdkp = to_scsi_disk(dev);
129 struct scsi_device *sdp = sdkp->device;
132 struct scsi_mode_data data;
133 struct scsi_sense_hdr sshdr;
136 if (sdp->type != TYPE_DISK)
137 /* no cache control on RBC devices; theoretically they
138 * can do it, but there's probably so many exceptions
139 * it's not worth the risk */
142 for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
143 const int len = strlen(sd_cache_types[i]);
144 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
152 rcd = ct & 0x01 ? 1 : 0;
153 wce = ct & 0x02 ? 1 : 0;
154 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
155 SD_MAX_RETRIES, &data, NULL))
157 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
158 data.block_descriptor_length);
159 buffer_data = buffer + data.header_length +
160 data.block_descriptor_length;
161 buffer_data[2] &= ~0x05;
162 buffer_data[2] |= wce << 2 | rcd;
163 sp = buffer_data[0] & 0x80 ? 1 : 0;
165 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
166 SD_MAX_RETRIES, &data, &sshdr)) {
167 if (scsi_sense_valid(&sshdr))
168 sd_print_sense_hdr(sdkp, &sshdr);
171 revalidate_disk(sdkp->disk);
176 sd_store_manage_start_stop(struct device *dev, struct device_attribute *attr,
177 const char *buf, size_t count)
179 struct scsi_disk *sdkp = to_scsi_disk(dev);
180 struct scsi_device *sdp = sdkp->device;
182 if (!capable(CAP_SYS_ADMIN))
185 sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
191 sd_store_allow_restart(struct device *dev, struct device_attribute *attr,
192 const char *buf, size_t count)
194 struct scsi_disk *sdkp = to_scsi_disk(dev);
195 struct scsi_device *sdp = sdkp->device;
197 if (!capable(CAP_SYS_ADMIN))
200 if (sdp->type != TYPE_DISK)
203 sdp->allow_restart = simple_strtoul(buf, NULL, 10);
209 sd_show_cache_type(struct device *dev, struct device_attribute *attr,
212 struct scsi_disk *sdkp = to_scsi_disk(dev);
213 int ct = sdkp->RCD + 2*sdkp->WCE;
215 return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
219 sd_show_fua(struct device *dev, struct device_attribute *attr, char *buf)
221 struct scsi_disk *sdkp = to_scsi_disk(dev);
223 return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
227 sd_show_manage_start_stop(struct device *dev, struct device_attribute *attr,
230 struct scsi_disk *sdkp = to_scsi_disk(dev);
231 struct scsi_device *sdp = sdkp->device;
233 return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
237 sd_show_allow_restart(struct device *dev, struct device_attribute *attr,
240 struct scsi_disk *sdkp = to_scsi_disk(dev);
242 return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
246 sd_show_protection_type(struct device *dev, struct device_attribute *attr,
249 struct scsi_disk *sdkp = to_scsi_disk(dev);
251 return snprintf(buf, 20, "%u\n", sdkp->protection_type);
255 sd_show_app_tag_own(struct device *dev, struct device_attribute *attr,
258 struct scsi_disk *sdkp = to_scsi_disk(dev);
260 return snprintf(buf, 20, "%u\n", sdkp->ATO);
263 static struct device_attribute sd_disk_attrs[] = {
264 __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
265 sd_store_cache_type),
266 __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
267 __ATTR(allow_restart, S_IRUGO|S_IWUSR, sd_show_allow_restart,
268 sd_store_allow_restart),
269 __ATTR(manage_start_stop, S_IRUGO|S_IWUSR, sd_show_manage_start_stop,
270 sd_store_manage_start_stop),
271 __ATTR(protection_type, S_IRUGO, sd_show_protection_type, NULL),
272 __ATTR(app_tag_own, S_IRUGO, sd_show_app_tag_own, NULL),
276 static struct class sd_disk_class = {
278 .owner = THIS_MODULE,
279 .dev_release = scsi_disk_release,
280 .dev_attrs = sd_disk_attrs,
283 static struct scsi_driver sd_template = {
284 .owner = THIS_MODULE,
289 .suspend = sd_suspend,
291 .shutdown = sd_shutdown,
298 * Device no to disk mapping:
300 * major disc2 disc p1
301 * |............|.............|....|....| <- dev_t
304 * Inside a major, we have 16k disks, however mapped non-
305 * contiguously. The first 16 disks are for major0, the next
306 * ones with major1, ... Disk 256 is for major0 again, disk 272
308 * As we stay compatible with our numbering scheme, we can reuse
309 * the well-know SCSI majors 8, 65--71, 136--143.
311 static int sd_major(int major_idx)
315 return SCSI_DISK0_MAJOR;
317 return SCSI_DISK1_MAJOR + major_idx - 1;
319 return SCSI_DISK8_MAJOR + major_idx - 8;
322 return 0; /* shut up gcc */
326 static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
328 struct scsi_disk *sdkp = NULL;
330 if (disk->private_data) {
331 sdkp = scsi_disk(disk);
332 if (scsi_device_get(sdkp->device) == 0)
333 get_device(&sdkp->dev);
340 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
342 struct scsi_disk *sdkp;
344 mutex_lock(&sd_ref_mutex);
345 sdkp = __scsi_disk_get(disk);
346 mutex_unlock(&sd_ref_mutex);
350 static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
352 struct scsi_disk *sdkp;
354 mutex_lock(&sd_ref_mutex);
355 sdkp = dev_get_drvdata(dev);
357 sdkp = __scsi_disk_get(sdkp->disk);
358 mutex_unlock(&sd_ref_mutex);
362 static void scsi_disk_put(struct scsi_disk *sdkp)
364 struct scsi_device *sdev = sdkp->device;
366 mutex_lock(&sd_ref_mutex);
367 put_device(&sdkp->dev);
368 scsi_device_put(sdev);
369 mutex_unlock(&sd_ref_mutex);
373 * sd_init_command - build a scsi (read or write) command from
374 * information in the request structure.
375 * @SCpnt: pointer to mid-level's per scsi command structure that
376 * contains request and into which the scsi command is written
378 * Returns 1 if successful and 0 if error (or cannot be done now).
380 static int sd_prep_fn(struct request_queue *q, struct request *rq)
382 struct scsi_cmnd *SCpnt;
383 struct scsi_device *sdp = q->queuedata;
384 struct gendisk *disk = rq->rq_disk;
385 struct scsi_disk *sdkp;
386 sector_t block = rq->sector;
388 unsigned int this_count = rq->nr_sectors;
391 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
392 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
394 } else if (rq->cmd_type != REQ_TYPE_FS) {
398 ret = scsi_setup_fs_cmnd(sdp, rq);
399 if (ret != BLKPREP_OK)
402 sdkp = scsi_disk(disk);
404 /* from here on until we're complete, any goto out
405 * is used for a killable error condition */
408 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
409 "sd_init_command: block=%llu, "
411 (unsigned long long)block,
414 if (!sdp || !scsi_device_online(sdp) ||
415 block + rq->nr_sectors > get_capacity(disk)) {
416 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
417 "Finishing %ld sectors\n",
419 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
420 "Retry with 0x%p\n", SCpnt));
426 * quietly refuse to do anything to a changed disc until
427 * the changed bit has been reset
429 /* printk("SCSI disk has been changed. Prohibiting further I/O.\n"); */
434 * Some SD card readers can't handle multi-sector accesses which touch
435 * the last one or two hardware sectors. Split accesses as needed.
437 threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
438 (sdp->sector_size / 512);
440 if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
441 if (block < threshold) {
442 /* Access up to the threshold but not beyond */
443 this_count = threshold - block;
445 /* Access only a single hardware sector */
446 this_count = sdp->sector_size / 512;
450 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
451 (unsigned long long)block));
454 * If we have a 1K hardware sectorsize, prevent access to single
455 * 512 byte sectors. In theory we could handle this - in fact
456 * the scsi cdrom driver must be able to handle this because
457 * we typically use 1K blocksizes, and cdroms typically have
458 * 2K hardware sectorsizes. Of course, things are simpler
459 * with the cdrom, since it is read-only. For performance
460 * reasons, the filesystems should be able to handle this
461 * and not force the scsi disk driver to use bounce buffers
464 if (sdp->sector_size == 1024) {
465 if ((block & 1) || (rq->nr_sectors & 1)) {
466 scmd_printk(KERN_ERR, SCpnt,
467 "Bad block number requested\n");
471 this_count = this_count >> 1;
474 if (sdp->sector_size == 2048) {
475 if ((block & 3) || (rq->nr_sectors & 3)) {
476 scmd_printk(KERN_ERR, SCpnt,
477 "Bad block number requested\n");
481 this_count = this_count >> 2;
484 if (sdp->sector_size == 4096) {
485 if ((block & 7) || (rq->nr_sectors & 7)) {
486 scmd_printk(KERN_ERR, SCpnt,
487 "Bad block number requested\n");
491 this_count = this_count >> 3;
494 if (rq_data_dir(rq) == WRITE) {
495 if (!sdp->writeable) {
498 SCpnt->cmnd[0] = WRITE_6;
499 SCpnt->sc_data_direction = DMA_TO_DEVICE;
501 if (blk_integrity_rq(rq) &&
502 sd_dif_prepare(rq, block, sdp->sector_size) == -EIO)
505 } else if (rq_data_dir(rq) == READ) {
506 SCpnt->cmnd[0] = READ_6;
507 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
509 scmd_printk(KERN_ERR, SCpnt, "Unknown command %x\n", rq->cmd_flags);
513 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
514 "%s %d/%ld 512 byte blocks.\n",
515 (rq_data_dir(rq) == WRITE) ?
516 "writing" : "reading", this_count,
519 /* Set RDPROTECT/WRPROTECT if disk is formatted with DIF */
520 host_dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
522 SCpnt->cmnd[1] = 1 << 5;
526 if (block > 0xffffffff) {
527 SCpnt->cmnd[0] += READ_16 - READ_6;
528 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
529 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
530 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
531 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
532 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
533 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
534 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
535 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
536 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
537 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
538 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
539 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
540 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
541 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
542 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
543 scsi_device_protection(SCpnt->device) ||
544 SCpnt->device->use_10_for_rw) {
545 if (this_count > 0xffff)
548 SCpnt->cmnd[0] += READ_10 - READ_6;
549 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
550 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
551 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
552 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
553 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
554 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
555 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
556 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
558 if (unlikely(blk_fua_rq(rq))) {
560 * This happens only if this drive failed
561 * 10byte rw command with ILLEGAL_REQUEST
562 * during operation and thus turned off
565 scmd_printk(KERN_ERR, SCpnt,
566 "FUA write on READ/WRITE(6) drive\n");
570 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
571 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
572 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
573 SCpnt->cmnd[4] = (unsigned char) this_count;
576 SCpnt->sdb.length = this_count * sdp->sector_size;
578 /* If DIF or DIX is enabled, tell HBA how to handle request */
579 if (host_dif || scsi_prot_sg_count(SCpnt))
580 sd_dif_op(SCpnt, host_dif, scsi_prot_sg_count(SCpnt),
581 sdkp->protection_type);
584 * We shouldn't disconnect in the middle of a sector, so with a dumb
585 * host adapter, it's safe to assume that we can at least transfer
586 * this many bytes between each connect / disconnect.
588 SCpnt->transfersize = sdp->sector_size;
589 SCpnt->underflow = this_count << 9;
590 SCpnt->allowed = SD_MAX_RETRIES;
593 * This indicates that the command is ready from our end to be
598 return scsi_prep_return(q, rq, ret);
602 * sd_open - open a scsi disk device
603 * @inode: only i_rdev member may be used
604 * @filp: only f_mode and f_flags may be used
606 * Returns 0 if successful. Returns a negated errno value in case
609 * Note: This can be called from a user context (e.g. fsck(1) )
610 * or from within the kernel (e.g. as a result of a mount(1) ).
611 * In the latter case @inode and @filp carry an abridged amount
612 * of information as noted above.
614 static int sd_open(struct block_device *bdev, fmode_t mode)
616 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
617 struct scsi_device *sdev;
623 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
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.
632 if (!scsi_block_when_processing_errors(sdev))
635 if (sdev->removable || sdkp->write_prot)
636 check_disk_change(bdev);
639 * If the drive is empty, just let the open fail.
642 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
646 * If the device has the write protect tab set, have the open fail
647 * if the user expects to be able to write to the thing.
650 if (sdkp->write_prot && (mode & FMODE_WRITE))
654 * It is possible that the disk changing stuff resulted in
655 * the device being taken offline. If this is the case,
656 * report this to the user, and don't pretend that the
657 * open actually succeeded.
660 if (!scsi_device_online(sdev))
663 if (!sdkp->openers++ && sdev->removable) {
664 if (scsi_block_when_processing_errors(sdev))
665 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
676 * sd_release - invoked when the (last) close(2) is called on this
678 * @inode: only i_rdev member may be used
679 * @filp: only f_mode and f_flags may be used
683 * Note: may block (uninterruptible) if error recovery is underway
686 static int sd_release(struct gendisk *disk, fmode_t mode)
688 struct scsi_disk *sdkp = scsi_disk(disk);
689 struct scsi_device *sdev = sdkp->device;
691 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
693 if (!--sdkp->openers && sdev->removable) {
694 if (scsi_block_when_processing_errors(sdev))
695 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
699 * XXX and what if there are packets in flight and this close()
700 * XXX is followed by a "rmmod sd_mod"?
706 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
708 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
709 struct scsi_device *sdp = sdkp->device;
710 struct Scsi_Host *host = sdp->host;
713 /* default to most commonly used values */
714 diskinfo[0] = 0x40; /* 1 << 6 */
715 diskinfo[1] = 0x20; /* 1 << 5 */
716 diskinfo[2] = sdkp->capacity >> 11;
718 /* override with calculated, extended default, or driver values */
719 if (host->hostt->bios_param)
720 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
722 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
724 geo->heads = diskinfo[0];
725 geo->sectors = diskinfo[1];
726 geo->cylinders = diskinfo[2];
731 * sd_ioctl - process an ioctl
732 * @inode: only i_rdev/i_bdev members may be used
733 * @filp: only f_mode and f_flags may be used
734 * @cmd: ioctl command number
735 * @arg: this is third argument given to ioctl(2) system call.
736 * Often contains a pointer.
738 * Returns 0 if successful (some ioctls return postive numbers on
739 * success as well). Returns a negated errno value in case of error.
741 * Note: most ioctls are forward onto the block subsystem or further
742 * down in the scsi subsystem.
744 static int sd_ioctl(struct block_device *bdev, fmode_t mode,
745 unsigned int cmd, unsigned long arg)
747 struct gendisk *disk = bdev->bd_disk;
748 struct scsi_device *sdp = scsi_disk(disk)->device;
749 void __user *p = (void __user *)arg;
752 SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
753 disk->disk_name, cmd));
756 * If we are in the middle of error recovery, don't let anyone
757 * else try and use this device. Also, if error recovery fails, it
758 * may try and take the device offline, in which case all further
759 * access to the device is prohibited.
761 error = scsi_nonblockable_ioctl(sdp, cmd, p,
762 (mode & FMODE_NDELAY) != 0);
763 if (!scsi_block_when_processing_errors(sdp) || !error)
767 * Send SCSI addressing ioctls directly to mid level, send other
768 * ioctls to block level and then onto mid level if they can't be
772 case SCSI_IOCTL_GET_IDLUN:
773 case SCSI_IOCTL_GET_BUS_NUMBER:
774 return scsi_ioctl(sdp, cmd, p);
776 error = scsi_cmd_ioctl(disk->queue, disk, mode, cmd, p);
777 if (error != -ENOTTY)
780 return scsi_ioctl(sdp, cmd, p);
783 static void set_media_not_present(struct scsi_disk *sdkp)
785 sdkp->media_present = 0;
787 sdkp->device->changed = 1;
791 * sd_media_changed - check if our medium changed
792 * @disk: kernel device descriptor
794 * Returns 0 if not applicable or no change; 1 if change
796 * Note: this function is invoked from the block subsystem.
798 static int sd_media_changed(struct gendisk *disk)
800 struct scsi_disk *sdkp = scsi_disk(disk);
801 struct scsi_device *sdp = sdkp->device;
802 struct scsi_sense_hdr *sshdr = NULL;
805 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_media_changed\n"));
811 * If the device is offline, don't send any commands - just pretend as
812 * if the command failed. If the device ever comes back online, we
813 * can deal with it then. It is only because of unrecoverable errors
814 * that we would ever take a device offline in the first place.
816 if (!scsi_device_online(sdp)) {
817 set_media_not_present(sdkp);
823 * Using TEST_UNIT_READY enables differentiation between drive with
824 * no cartridge loaded - NOT READY, drive with changed cartridge -
825 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
827 * Drives that auto spin down. eg iomega jaz 1G, will be started
828 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
829 * sd_revalidate() is called.
833 if (scsi_block_when_processing_errors(sdp)) {
834 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
835 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
840 * Unable to test, unit probably not ready. This usually
841 * means there is no disc in the drive. Mark as changed,
842 * and we will figure it out later once the drive is
845 if (retval || (scsi_sense_valid(sshdr) &&
846 /* 0x3a is medium not present */
847 sshdr->asc == 0x3a)) {
848 set_media_not_present(sdkp);
854 * For removable scsi disk we have to recognise the presence
855 * of a disk in the drive. This is kept in the struct scsi_disk
856 * struct and tested at open ! Daniel Roche (dan@lectra.fr)
858 sdkp->media_present = 1;
860 retval = sdp->changed;
863 if (retval != sdkp->previous_state)
864 sdev_evt_send_simple(sdp, SDEV_EVT_MEDIA_CHANGE, GFP_KERNEL);
865 sdkp->previous_state = retval;
870 static int sd_sync_cache(struct scsi_disk *sdkp)
873 struct scsi_device *sdp = sdkp->device;
874 struct scsi_sense_hdr sshdr;
876 if (!scsi_device_online(sdp))
880 for (retries = 3; retries > 0; --retries) {
881 unsigned char cmd[10] = { 0 };
883 cmd[0] = SYNCHRONIZE_CACHE;
885 * Leave the rest of the command zero to indicate
888 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
889 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
895 sd_print_result(sdkp, res);
896 if (driver_byte(res) & DRIVER_SENSE)
897 sd_print_sense_hdr(sdkp, &sshdr);
905 static void sd_prepare_flush(struct request_queue *q, struct request *rq)
907 rq->cmd_type = REQ_TYPE_BLOCK_PC;
908 rq->timeout = SD_TIMEOUT;
909 rq->cmd[0] = SYNCHRONIZE_CACHE;
913 static void sd_rescan(struct device *dev)
915 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
918 revalidate_disk(sdkp->disk);
926 * This gets directly called from VFS. When the ioctl
927 * is not recognized we go back to the other translation paths.
929 static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
930 unsigned int cmd, unsigned long arg)
932 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
935 * If we are in the middle of error recovery, don't let anyone
936 * else try and use this device. Also, if error recovery fails, it
937 * may try and take the device offline, in which case all further
938 * access to the device is prohibited.
940 if (!scsi_block_when_processing_errors(sdev))
943 if (sdev->host->hostt->compat_ioctl) {
946 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
952 * Let the static ioctl translation table take care of it.
958 static struct block_device_operations sd_fops = {
959 .owner = THIS_MODULE,
961 .release = sd_release,
962 .locked_ioctl = sd_ioctl,
965 .compat_ioctl = sd_compat_ioctl,
967 .media_changed = sd_media_changed,
968 .revalidate_disk = sd_revalidate_disk,
971 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
973 u64 start_lba = scmd->request->sector;
974 u64 end_lba = scmd->request->sector + (scsi_bufflen(scmd) / 512);
978 if (!blk_fs_request(scmd->request))
981 info_valid = scsi_get_sense_info_fld(scmd->sense_buffer,
982 SCSI_SENSE_BUFFERSIZE,
987 if (scsi_bufflen(scmd) <= scmd->device->sector_size)
990 if (scmd->device->sector_size < 512) {
991 /* only legitimate sector_size here is 256 */
995 /* be careful ... don't want any overflows */
996 u64 factor = scmd->device->sector_size / 512;
997 do_div(start_lba, factor);
998 do_div(end_lba, factor);
1001 /* The bad lba was reported incorrectly, we have no idea where
1004 if (bad_lba < start_lba || bad_lba >= end_lba)
1007 /* This computation should always be done in terms of
1008 * the resolution of the device's medium.
1010 return (bad_lba - start_lba) * scmd->device->sector_size;
1014 * sd_done - bottom half handler: called when the lower level
1015 * driver has completed (successfully or otherwise) a scsi command.
1016 * @SCpnt: mid-level's per command structure.
1018 * Note: potentially run from within an ISR. Must not block.
1020 static int sd_done(struct scsi_cmnd *SCpnt)
1022 int result = SCpnt->result;
1023 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1024 struct scsi_sense_hdr sshdr;
1025 int sense_valid = 0;
1026 int sense_deferred = 0;
1029 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1031 sense_deferred = scsi_sense_is_deferred(&sshdr);
1033 #ifdef CONFIG_SCSI_LOGGING
1034 SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
1036 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
1037 "sd_done: sb[respc,sk,asc,"
1038 "ascq]=%x,%x,%x,%x\n",
1039 sshdr.response_code,
1040 sshdr.sense_key, sshdr.asc,
1044 if (driver_byte(result) != DRIVER_SENSE &&
1045 (!sense_valid || sense_deferred))
1048 switch (sshdr.sense_key) {
1049 case HARDWARE_ERROR:
1051 good_bytes = sd_completed_bytes(SCpnt);
1053 case RECOVERED_ERROR:
1054 good_bytes = scsi_bufflen(SCpnt);
1057 /* This indicates a false check condition, so ignore it. An
1058 * unknown amount of data was transferred so treat it as an
1061 scsi_print_sense("sd", SCpnt);
1063 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1065 case ABORTED_COMMAND:
1066 if (sshdr.asc == 0x10) { /* DIF: Disk detected corruption */
1067 scsi_print_result(SCpnt);
1068 scsi_print_sense("sd", SCpnt);
1069 good_bytes = sd_completed_bytes(SCpnt);
1072 case ILLEGAL_REQUEST:
1073 if (sshdr.asc == 0x10) { /* DIX: HBA detected corruption */
1074 scsi_print_result(SCpnt);
1075 scsi_print_sense("sd", SCpnt);
1076 good_bytes = sd_completed_bytes(SCpnt);
1083 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt))
1084 sd_dif_complete(SCpnt, good_bytes);
1089 static int media_not_present(struct scsi_disk *sdkp,
1090 struct scsi_sense_hdr *sshdr)
1093 if (!scsi_sense_valid(sshdr))
1095 /* not invoked for commands that could return deferred errors */
1096 if (sshdr->sense_key != NOT_READY &&
1097 sshdr->sense_key != UNIT_ATTENTION)
1099 if (sshdr->asc != 0x3A) /* medium not present */
1102 set_media_not_present(sdkp);
1107 * spinup disk - called only in sd_revalidate_disk()
1110 sd_spinup_disk(struct scsi_disk *sdkp)
1112 unsigned char cmd[10];
1113 unsigned long spintime_expire = 0;
1114 int retries, spintime;
1115 unsigned int the_result;
1116 struct scsi_sense_hdr sshdr;
1117 int sense_valid = 0;
1121 /* Spin up drives, as required. Only do this at boot time */
1122 /* Spinup needs to be done for module loads too. */
1127 cmd[0] = TEST_UNIT_READY;
1128 memset((void *) &cmd[1], 0, 9);
1130 the_result = scsi_execute_req(sdkp->device, cmd,
1133 SD_MAX_RETRIES, NULL);
1136 * If the drive has indicated to us that it
1137 * doesn't have any media in it, don't bother
1138 * with any more polling.
1140 if (media_not_present(sdkp, &sshdr))
1144 sense_valid = scsi_sense_valid(&sshdr);
1146 } while (retries < 3 &&
1147 (!scsi_status_is_good(the_result) ||
1148 ((driver_byte(the_result) & DRIVER_SENSE) &&
1149 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1151 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1152 /* no sense, TUR either succeeded or failed
1153 * with a status error */
1154 if(!spintime && !scsi_status_is_good(the_result)) {
1155 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1156 sd_print_result(sdkp, the_result);
1162 * The device does not want the automatic start to be issued.
1164 if (sdkp->device->no_start_on_add)
1167 if (sense_valid && sshdr.sense_key == NOT_READY) {
1168 if (sshdr.asc == 4 && sshdr.ascq == 3)
1169 break; /* manual intervention required */
1170 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
1171 break; /* standby */
1172 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
1173 break; /* unavailable */
1175 * Issue command to spin up drive when not ready
1178 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1179 cmd[0] = START_STOP;
1180 cmd[1] = 1; /* Return immediately */
1181 memset((void *) &cmd[2], 0, 8);
1182 cmd[4] = 1; /* Start spin cycle */
1183 if (sdkp->device->start_stop_pwr_cond)
1185 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1187 SD_TIMEOUT, SD_MAX_RETRIES,
1189 spintime_expire = jiffies + 100 * HZ;
1192 /* Wait 1 second for next try */
1197 * Wait for USB flash devices with slow firmware.
1198 * Yes, this sense key/ASC combination shouldn't
1199 * occur here. It's characteristic of these devices.
1201 } else if (sense_valid &&
1202 sshdr.sense_key == UNIT_ATTENTION &&
1203 sshdr.asc == 0x28) {
1205 spintime_expire = jiffies + 5 * HZ;
1208 /* Wait 1 second for next try */
1211 /* we don't understand the sense code, so it's
1212 * probably pointless to loop */
1214 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1215 sd_print_sense_hdr(sdkp, &sshdr);
1220 } while (spintime && time_before_eq(jiffies, spintime_expire));
1223 if (scsi_status_is_good(the_result))
1226 printk("not responding...\n");
1232 * Determine whether disk supports Data Integrity Field.
1234 void sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
1236 struct scsi_device *sdp = sdkp->device;
1239 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
1242 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
1244 sdkp->protection_type = type;
1247 case SD_DIF_TYPE0_PROTECTION:
1248 case SD_DIF_TYPE1_PROTECTION:
1249 case SD_DIF_TYPE3_PROTECTION:
1252 case SD_DIF_TYPE2_PROTECTION:
1253 sd_printk(KERN_ERR, sdkp, "formatted with DIF Type 2 " \
1254 "protection which is currently unsupported. " \
1255 "Disabling disk!\n");
1259 sd_printk(KERN_ERR, sdkp, "formatted with unknown " \
1260 "protection type %d. Disabling disk!\n", type);
1270 static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
1271 struct scsi_sense_hdr *sshdr, int sense_valid,
1274 sd_print_result(sdkp, the_result);
1275 if (driver_byte(the_result) & DRIVER_SENSE)
1276 sd_print_sense_hdr(sdkp, sshdr);
1278 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1281 * Set dirty bit for removable devices if not ready -
1282 * sometimes drives will not report this properly.
1284 if (sdp->removable &&
1285 sense_valid && sshdr->sense_key == NOT_READY)
1289 * We used to set media_present to 0 here to indicate no media
1290 * in the drive, but some drives fail read capacity even with
1291 * media present, so we can't do that.
1293 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1297 #if RC16_LEN > SD_BUF_SIZE
1298 #error RC16_LEN must not be more than SD_BUF_SIZE
1301 static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
1302 unsigned char *buffer)
1304 unsigned char cmd[16];
1305 struct scsi_sense_hdr sshdr;
1306 int sense_valid = 0;
1309 unsigned long long lba;
1310 unsigned sector_size;
1314 cmd[0] = SERVICE_ACTION_IN;
1315 cmd[1] = SAI_READ_CAPACITY_16;
1317 memset(buffer, 0, RC16_LEN);
1319 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1320 buffer, RC16_LEN, &sshdr,
1321 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1323 if (media_not_present(sdkp, &sshdr))
1327 sense_valid = scsi_sense_valid(&sshdr);
1329 sshdr.sense_key == ILLEGAL_REQUEST &&
1330 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
1332 /* Invalid Command Operation Code or
1333 * Invalid Field in CDB, just retry
1334 * silently with RC10 */
1339 } while (the_result && retries);
1342 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
1343 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
1347 sector_size = (buffer[8] << 24) | (buffer[9] << 16) |
1348 (buffer[10] << 8) | buffer[11];
1349 lba = (((u64)buffer[0] << 56) | ((u64)buffer[1] << 48) |
1350 ((u64)buffer[2] << 40) | ((u64)buffer[3] << 32) |
1351 ((u64)buffer[4] << 24) | ((u64)buffer[5] << 16) |
1352 ((u64)buffer[6] << 8) | (u64)buffer[7]);
1354 sd_read_protection_type(sdkp, buffer);
1356 if ((sizeof(sdkp->capacity) == 4) && (lba >= 0xffffffffULL)) {
1357 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
1358 "kernel compiled with support for large block "
1364 sdkp->capacity = lba + 1;
1368 static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
1369 unsigned char *buffer)
1371 unsigned char cmd[16];
1372 struct scsi_sense_hdr sshdr;
1373 int sense_valid = 0;
1377 unsigned sector_size;
1380 cmd[0] = READ_CAPACITY;
1381 memset(&cmd[1], 0, 9);
1382 memset(buffer, 0, 8);
1384 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1386 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1388 if (media_not_present(sdkp, &sshdr))
1392 sense_valid = scsi_sense_valid(&sshdr);
1395 } while (the_result && retries);
1398 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
1399 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
1403 sector_size = (buffer[4] << 24) | (buffer[5] << 16) |
1404 (buffer[6] << 8) | buffer[7];
1405 lba = (buffer[0] << 24) | (buffer[1] << 16) |
1406 (buffer[2] << 8) | buffer[3];
1408 if ((sizeof(sdkp->capacity) == 4) && (lba == 0xffffffff)) {
1409 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
1410 "kernel compiled with support for large block "
1416 sdkp->capacity = lba + 1;
1420 static int sd_try_rc16_first(struct scsi_device *sdp)
1422 if (sdp->scsi_level > SCSI_SPC_2)
1424 if (scsi_device_protection(sdp))
1430 * read disk capacity
1433 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
1436 struct scsi_device *sdp = sdkp->device;
1437 sector_t old_capacity = sdkp->capacity;
1439 if (sd_try_rc16_first(sdp)) {
1440 sector_size = read_capacity_16(sdkp, sdp, buffer);
1441 if (sector_size == -EOVERFLOW)
1443 if (sector_size == -ENODEV)
1445 if (sector_size < 0)
1446 sector_size = read_capacity_10(sdkp, sdp, buffer);
1447 if (sector_size < 0)
1450 sector_size = read_capacity_10(sdkp, sdp, buffer);
1451 if (sector_size == -EOVERFLOW)
1453 if (sector_size < 0)
1455 if ((sizeof(sdkp->capacity) > 4) &&
1456 (sdkp->capacity > 0xffffffffULL)) {
1457 int old_sector_size = sector_size;
1458 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
1459 "Trying to use READ CAPACITY(16).\n");
1460 sector_size = read_capacity_16(sdkp, sdp, buffer);
1461 if (sector_size < 0) {
1462 sd_printk(KERN_NOTICE, sdkp,
1463 "Using 0xffffffff as device size\n");
1464 sdkp->capacity = 1 + (sector_t) 0xffffffff;
1465 sector_size = old_sector_size;
1471 /* Some devices are known to return the total number of blocks,
1472 * not the highest block number. Some devices have versions
1473 * which do this and others which do not. Some devices we might
1474 * suspect of doing this but we don't know for certain.
1476 * If we know the reported capacity is wrong, decrement it. If
1477 * we can only guess, then assume the number of blocks is even
1478 * (usually true but not always) and err on the side of lowering
1481 if (sdp->fix_capacity ||
1482 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
1483 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
1484 "from its reported value: %llu\n",
1485 (unsigned long long) sdkp->capacity);
1490 if (sector_size == 0) {
1492 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
1496 if (sector_size != 512 &&
1497 sector_size != 1024 &&
1498 sector_size != 2048 &&
1499 sector_size != 4096 &&
1500 sector_size != 256) {
1501 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
1504 * The user might want to re-format the drive with
1505 * a supported sectorsize. Once this happens, it
1506 * would be relatively trivial to set the thing up.
1507 * For this reason, we leave the thing in the table.
1511 * set a bogus sector size so the normal read/write
1512 * logic in the block layer will eventually refuse any
1513 * request on this device without tripping over power
1514 * of two sector size assumptions
1518 blk_queue_hardsect_size(sdp->request_queue, sector_size);
1521 char cap_str_2[10], cap_str_10[10];
1522 u64 sz = (u64)sdkp->capacity << ilog2(sector_size);
1524 string_get_size(sz, STRING_UNITS_2, cap_str_2,
1526 string_get_size(sz, STRING_UNITS_10, cap_str_10,
1527 sizeof(cap_str_10));
1529 if (sdkp->first_scan || old_capacity != sdkp->capacity)
1530 sd_printk(KERN_NOTICE, sdkp,
1531 "%llu %d-byte hardware sectors: (%s/%s)\n",
1532 (unsigned long long)sdkp->capacity,
1533 sector_size, cap_str_10, cap_str_2);
1536 /* Rescale capacity to 512-byte units */
1537 if (sector_size == 4096)
1538 sdkp->capacity <<= 3;
1539 else if (sector_size == 2048)
1540 sdkp->capacity <<= 2;
1541 else if (sector_size == 1024)
1542 sdkp->capacity <<= 1;
1543 else if (sector_size == 256)
1544 sdkp->capacity >>= 1;
1546 sdkp->device->sector_size = sector_size;
1549 /* called with buffer of length 512 */
1551 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1552 unsigned char *buffer, int len, struct scsi_mode_data *data,
1553 struct scsi_sense_hdr *sshdr)
1555 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1556 SD_TIMEOUT, SD_MAX_RETRIES, data,
1561 * read write protect setting, if possible - called only in sd_revalidate_disk()
1562 * called with buffer of length SD_BUF_SIZE
1565 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
1568 struct scsi_device *sdp = sdkp->device;
1569 struct scsi_mode_data data;
1570 int old_wp = sdkp->write_prot;
1572 set_disk_ro(sdkp->disk, 0);
1573 if (sdp->skip_ms_page_3f) {
1574 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1578 if (sdp->use_192_bytes_for_3f) {
1579 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1582 * First attempt: ask for all pages (0x3F), but only 4 bytes.
1583 * We have to start carefully: some devices hang if we ask
1584 * for more than is available.
1586 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1589 * Second attempt: ask for page 0 When only page 0 is
1590 * implemented, a request for page 3F may return Sense Key
1591 * 5: Illegal Request, Sense Code 24: Invalid field in
1594 if (!scsi_status_is_good(res))
1595 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1598 * Third attempt: ask 255 bytes, as we did earlier.
1600 if (!scsi_status_is_good(res))
1601 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1605 if (!scsi_status_is_good(res)) {
1606 sd_printk(KERN_WARNING, sdkp,
1607 "Test WP failed, assume Write Enabled\n");
1609 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
1610 set_disk_ro(sdkp->disk, sdkp->write_prot);
1611 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
1612 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
1613 sdkp->write_prot ? "on" : "off");
1614 sd_printk(KERN_DEBUG, sdkp,
1615 "Mode Sense: %02x %02x %02x %02x\n",
1616 buffer[0], buffer[1], buffer[2], buffer[3]);
1622 * sd_read_cache_type - called only from sd_revalidate_disk()
1623 * called with buffer of length SD_BUF_SIZE
1626 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
1629 struct scsi_device *sdp = sdkp->device;
1633 struct scsi_mode_data data;
1634 struct scsi_sense_hdr sshdr;
1635 int old_wce = sdkp->WCE;
1636 int old_rcd = sdkp->RCD;
1637 int old_dpofua = sdkp->DPOFUA;
1639 if (sdp->skip_ms_page_8)
1642 if (sdp->type == TYPE_RBC) {
1650 /* cautiously ask */
1651 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, 4, &data, &sshdr);
1653 if (!scsi_status_is_good(res))
1656 if (!data.header_length) {
1658 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
1661 /* that went OK, now ask for the proper length */
1665 * We're only interested in the first three bytes, actually.
1666 * But the data cache page is defined for the first 20.
1673 /* Take headers and block descriptors into account */
1674 len += data.header_length + data.block_descriptor_length;
1675 if (len > SD_BUF_SIZE)
1679 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len, &data, &sshdr);
1681 if (scsi_status_is_good(res)) {
1682 int offset = data.header_length + data.block_descriptor_length;
1684 if (offset >= SD_BUF_SIZE - 2) {
1685 sd_printk(KERN_ERR, sdkp, "Malformed MODE SENSE response\n");
1689 if ((buffer[offset] & 0x3f) != modepage) {
1690 sd_printk(KERN_ERR, sdkp, "Got wrong page\n");
1694 if (modepage == 8) {
1695 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
1696 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
1698 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
1702 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
1703 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
1704 sd_printk(KERN_NOTICE, sdkp,
1705 "Uses READ/WRITE(6), disabling FUA\n");
1709 if (sdkp->first_scan || old_wce != sdkp->WCE ||
1710 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
1711 sd_printk(KERN_NOTICE, sdkp,
1712 "Write cache: %s, read cache: %s, %s\n",
1713 sdkp->WCE ? "enabled" : "disabled",
1714 sdkp->RCD ? "disabled" : "enabled",
1715 sdkp->DPOFUA ? "supports DPO and FUA"
1716 : "doesn't support DPO or FUA");
1722 if (scsi_sense_valid(&sshdr) &&
1723 sshdr.sense_key == ILLEGAL_REQUEST &&
1724 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
1725 /* Invalid field in CDB */
1726 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1728 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
1731 sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
1738 * The ATO bit indicates whether the DIF application tag is available
1739 * for use by the operating system.
1741 void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
1744 struct scsi_device *sdp = sdkp->device;
1745 struct scsi_mode_data data;
1746 struct scsi_sense_hdr sshdr;
1748 if (sdp->type != TYPE_DISK)
1751 if (sdkp->protection_type == 0)
1754 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
1755 SD_MAX_RETRIES, &data, &sshdr);
1757 if (!scsi_status_is_good(res) || !data.header_length ||
1759 sd_printk(KERN_WARNING, sdkp,
1760 "getting Control mode page failed, assume no ATO\n");
1762 if (scsi_sense_valid(&sshdr))
1763 sd_print_sense_hdr(sdkp, &sshdr);
1768 offset = data.header_length + data.block_descriptor_length;
1770 if ((buffer[offset] & 0x3f) != 0x0a) {
1771 sd_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
1775 if ((buffer[offset + 5] & 0x80) == 0)
1784 * sd_revalidate_disk - called the first time a new disk is seen,
1785 * performs disk spin up, read_capacity, etc.
1786 * @disk: struct gendisk we care about
1788 static int sd_revalidate_disk(struct gendisk *disk)
1790 struct scsi_disk *sdkp = scsi_disk(disk);
1791 struct scsi_device *sdp = sdkp->device;
1792 unsigned char *buffer;
1795 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
1796 "sd_revalidate_disk\n"));
1799 * If the device is offline, don't try and read capacity or any
1800 * of the other niceties.
1802 if (!scsi_device_online(sdp))
1805 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1807 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
1808 "allocation failure.\n");
1812 sd_spinup_disk(sdkp);
1815 * Without media there is no reason to ask; moreover, some devices
1816 * react badly if we do.
1818 if (sdkp->media_present) {
1819 sd_read_capacity(sdkp, buffer);
1820 sd_read_write_protect_flag(sdkp, buffer);
1821 sd_read_cache_type(sdkp, buffer);
1822 sd_read_app_tag_own(sdkp, buffer);
1825 sdkp->first_scan = 0;
1828 * We now have all cache related info, determine how we deal
1829 * with ordered requests. Note that as the current SCSI
1830 * dispatch function can alter request order, we cannot use
1831 * QUEUE_ORDERED_TAG_* even when ordered tag is supported.
1834 ordered = sdkp->DPOFUA
1835 ? QUEUE_ORDERED_DRAIN_FUA : QUEUE_ORDERED_DRAIN_FLUSH;
1837 ordered = QUEUE_ORDERED_DRAIN;
1839 blk_queue_ordered(sdkp->disk->queue, ordered, sd_prepare_flush);
1841 set_capacity(disk, sdkp->capacity);
1849 * sd_format_disk_name - format disk name
1850 * @prefix: name prefix - ie. "sd" for SCSI disks
1851 * @index: index of the disk to format name for
1852 * @buf: output buffer
1853 * @buflen: length of the output buffer
1855 * SCSI disk names starts at sda. The 26th device is sdz and the
1856 * 27th is sdaa. The last one for two lettered suffix is sdzz
1857 * which is followed by sdaaa.
1859 * This is basically 26 base counting with one extra 'nil' entry
1860 * at the beggining from the second digit on and can be
1861 * determined using similar method as 26 base conversion with the
1862 * index shifted -1 after each digit is computed.
1868 * 0 on success, -errno on failure.
1870 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
1872 const int base = 'z' - 'a' + 1;
1873 char *begin = buf + strlen(prefix);
1874 char *end = buf + buflen;
1884 *--p = 'a' + (index % unit);
1885 index = (index / unit) - 1;
1886 } while (index >= 0);
1888 memmove(begin, p, end - p);
1889 memcpy(buf, prefix, strlen(prefix));
1895 * The asynchronous part of sd_probe
1897 static void sd_probe_async(void *data, async_cookie_t cookie)
1899 struct scsi_disk *sdkp = data;
1900 struct scsi_device *sdp;
1907 index = sdkp->index;
1908 dev = &sdp->sdev_gendev;
1910 if (!sdp->request_queue->rq_timeout) {
1911 if (sdp->type != TYPE_MOD)
1912 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
1914 blk_queue_rq_timeout(sdp->request_queue,
1918 device_initialize(&sdkp->dev);
1919 sdkp->dev.parent = &sdp->sdev_gendev;
1920 sdkp->dev.class = &sd_disk_class;
1921 dev_set_name(&sdkp->dev, dev_name(&sdp->sdev_gendev));
1923 if (device_add(&sdkp->dev))
1924 goto out_free_index;
1926 get_device(&sdp->sdev_gendev);
1928 if (index < SD_MAX_DISKS) {
1929 gd->major = sd_major((index & 0xf0) >> 4);
1930 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1931 gd->minors = SD_MINORS;
1933 gd->fops = &sd_fops;
1934 gd->private_data = &sdkp->driver;
1935 gd->queue = sdkp->device->request_queue;
1937 /* defaults, until the device tells us otherwise */
1938 sdp->sector_size = 512;
1940 sdkp->media_present = 1;
1941 sdkp->write_prot = 0;
1945 sdkp->first_scan = 1;
1947 sd_revalidate_disk(gd);
1949 blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
1951 gd->driverfs_dev = &sdp->sdev_gendev;
1952 gd->flags = GENHD_FL_EXT_DEVT | GENHD_FL_DRIVERFS;
1954 gd->flags |= GENHD_FL_REMOVABLE;
1956 dev_set_drvdata(dev, sdkp);
1958 sd_dif_config_host(sdkp);
1960 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
1961 sdp->removable ? "removable " : "");
1966 ida_remove(&sd_index_ida, index);
1970 * sd_probe - called during driver initialization and whenever a
1971 * new scsi device is attached to the system. It is called once
1972 * for each scsi device (not just disks) present.
1973 * @dev: pointer to device object
1975 * Returns 0 if successful (or not interested in this scsi device
1976 * (e.g. scanner)); 1 when there is an error.
1978 * Note: this function is invoked from the scsi mid-level.
1979 * This function sets up the mapping between a given
1980 * <host,channel,id,lun> (found in sdp) and new device name
1981 * (e.g. /dev/sda). More precisely it is the block device major
1982 * and minor number that is chosen here.
1984 * Assume sd_attach is not re-entrant (for time being)
1985 * Also think about sd_attach() and sd_remove() running coincidentally.
1987 static int sd_probe(struct device *dev)
1989 struct scsi_device *sdp = to_scsi_device(dev);
1990 struct scsi_disk *sdkp;
1996 if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
1999 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
2003 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
2007 gd = alloc_disk(SD_MINORS);
2012 if (!ida_pre_get(&sd_index_ida, GFP_KERNEL))
2015 spin_lock(&sd_index_lock);
2016 error = ida_get_new(&sd_index_ida, &index);
2017 spin_unlock(&sd_index_lock);
2018 } while (error == -EAGAIN);
2023 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
2025 goto out_free_index;
2028 sdkp->driver = &sd_template;
2030 sdkp->index = index;
2032 sdkp->previous_state = 1;
2034 async_schedule(sd_probe_async, sdkp);
2039 spin_lock(&sd_index_lock);
2040 ida_remove(&sd_index_ida, index);
2041 spin_unlock(&sd_index_lock);
2051 * sd_remove - called whenever a scsi disk (previously recognized by
2052 * sd_probe) is detached from the system. It is called (potentially
2053 * multiple times) during sd module unload.
2054 * @sdp: pointer to mid level scsi device object
2056 * Note: this function is invoked from the scsi mid-level.
2057 * This function potentially frees up a device name (e.g. /dev/sdc)
2058 * that could be re-used by a subsequent sd_probe().
2059 * This function is not called when the built-in sd driver is "exit-ed".
2061 static int sd_remove(struct device *dev)
2063 struct scsi_disk *sdkp = dev_get_drvdata(dev);
2065 device_del(&sdkp->dev);
2066 del_gendisk(sdkp->disk);
2069 mutex_lock(&sd_ref_mutex);
2070 dev_set_drvdata(dev, NULL);
2071 put_device(&sdkp->dev);
2072 mutex_unlock(&sd_ref_mutex);
2078 * scsi_disk_release - Called to free the scsi_disk structure
2079 * @dev: pointer to embedded class device
2081 * sd_ref_mutex must be held entering this routine. Because it is
2082 * called on last put, you should always use the scsi_disk_get()
2083 * scsi_disk_put() helpers which manipulate the semaphore directly
2084 * and never do a direct put_device.
2086 static void scsi_disk_release(struct device *dev)
2088 struct scsi_disk *sdkp = to_scsi_disk(dev);
2089 struct gendisk *disk = sdkp->disk;
2091 spin_lock(&sd_index_lock);
2092 ida_remove(&sd_index_ida, sdkp->index);
2093 spin_unlock(&sd_index_lock);
2095 disk->private_data = NULL;
2097 put_device(&sdkp->device->sdev_gendev);
2102 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
2104 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
2105 struct scsi_sense_hdr sshdr;
2106 struct scsi_device *sdp = sdkp->device;
2110 cmd[4] |= 1; /* START */
2112 if (sdp->start_stop_pwr_cond)
2113 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
2115 if (!scsi_device_online(sdp))
2118 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
2119 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2121 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
2122 sd_print_result(sdkp, res);
2123 if (driver_byte(res) & DRIVER_SENSE)
2124 sd_print_sense_hdr(sdkp, &sshdr);
2131 * Send a SYNCHRONIZE CACHE instruction down to the device through
2132 * the normal SCSI command structure. Wait for the command to
2135 static void sd_shutdown(struct device *dev)
2137 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2140 return; /* this can happen */
2143 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2144 sd_sync_cache(sdkp);
2147 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
2148 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2149 sd_start_stop_device(sdkp, 0);
2152 scsi_disk_put(sdkp);
2155 static int sd_suspend(struct device *dev, pm_message_t mesg)
2157 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2161 return 0; /* this can happen */
2164 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2165 ret = sd_sync_cache(sdkp);
2170 if ((mesg.event & PM_EVENT_SLEEP) && sdkp->device->manage_start_stop) {
2171 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2172 ret = sd_start_stop_device(sdkp, 0);
2176 scsi_disk_put(sdkp);
2180 static int sd_resume(struct device *dev)
2182 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2185 if (!sdkp->device->manage_start_stop)
2188 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
2189 ret = sd_start_stop_device(sdkp, 1);
2192 scsi_disk_put(sdkp);
2197 * init_sd - entry point for this driver (both when built in or when
2200 * Note: this function registers this driver with the scsi mid-level.
2202 static int __init init_sd(void)
2204 int majors = 0, i, err;
2206 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
2208 for (i = 0; i < SD_MAJORS; i++)
2209 if (register_blkdev(sd_major(i), "sd") == 0)
2215 err = class_register(&sd_disk_class);
2219 err = scsi_register_driver(&sd_template.gendrv);
2226 class_unregister(&sd_disk_class);
2228 for (i = 0; i < SD_MAJORS; i++)
2229 unregister_blkdev(sd_major(i), "sd");
2234 * exit_sd - exit point for this driver (when it is a module).
2236 * Note: this function unregisters this driver from the scsi mid-level.
2238 static void __exit exit_sd(void)
2242 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
2244 scsi_unregister_driver(&sd_template.gendrv);
2245 class_unregister(&sd_disk_class);
2247 for (i = 0; i < SD_MAJORS; i++)
2248 unregister_blkdev(sd_major(i), "sd");
2251 module_init(init_sd);
2252 module_exit(exit_sd);
2254 static void sd_print_sense_hdr(struct scsi_disk *sdkp,
2255 struct scsi_sense_hdr *sshdr)
2257 sd_printk(KERN_INFO, sdkp, "");
2258 scsi_show_sense_hdr(sshdr);
2259 sd_printk(KERN_INFO, sdkp, "");
2260 scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
2263 static void sd_print_result(struct scsi_disk *sdkp, int result)
2265 sd_printk(KERN_INFO, sdkp, "");
2266 scsi_show_result(result);