pasemi_mac: Disable interface on close
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / sd.c
blob51a5557f42dda472fd67bb0b7352ddb7ff1d3c7a
1 /*
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>
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 <asm/uaccess.h>
52 #include <scsi/scsi.h>
53 #include <scsi/scsi_cmnd.h>
54 #include <scsi/scsi_dbg.h>
55 #include <scsi/scsi_device.h>
56 #include <scsi/scsi_driver.h>
57 #include <scsi/scsi_eh.h>
58 #include <scsi/scsi_host.h>
59 #include <scsi/scsi_ioctl.h>
60 #include <scsi/scsicam.h>
61 #include <scsi/sd.h>
63 #include "scsi_logging.h"
65 MODULE_AUTHOR("Eric Youngdale");
66 MODULE_DESCRIPTION("SCSI disk (sd) driver");
67 MODULE_LICENSE("GPL");
69 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
70 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
71 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
72 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
73 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
74 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
75 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
76 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
77 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
78 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
79 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
85 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
86 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
87 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
89 static int sd_revalidate_disk(struct gendisk *);
90 static int sd_probe(struct device *);
91 static int sd_remove(struct device *);
92 static void sd_shutdown(struct device *);
93 static int sd_suspend(struct device *, pm_message_t state);
94 static int sd_resume(struct device *);
95 static void sd_rescan(struct device *);
96 static int sd_done(struct scsi_cmnd *);
97 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
98 static void scsi_disk_release(struct class_device *cdev);
99 static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
100 static void sd_print_result(struct scsi_disk *, int);
102 static DEFINE_IDR(sd_index_idr);
103 static DEFINE_SPINLOCK(sd_index_lock);
105 /* This semaphore is used to mediate the 0->1 reference get in the
106 * face of object destruction (i.e. we can't allow a get on an
107 * object after last put) */
108 static DEFINE_MUTEX(sd_ref_mutex);
110 static const char *sd_cache_types[] = {
111 "write through", "none", "write back",
112 "write back, no read (daft)"
115 static ssize_t sd_store_cache_type(struct class_device *cdev, const char *buf,
116 size_t count)
118 int i, ct = -1, rcd, wce, sp;
119 struct scsi_disk *sdkp = to_scsi_disk(cdev);
120 struct scsi_device *sdp = sdkp->device;
121 char buffer[64];
122 char *buffer_data;
123 struct scsi_mode_data data;
124 struct scsi_sense_hdr sshdr;
125 int len;
127 if (sdp->type != TYPE_DISK)
128 /* no cache control on RBC devices; theoretically they
129 * can do it, but there's probably so many exceptions
130 * it's not worth the risk */
131 return -EINVAL;
133 for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
134 const int len = strlen(sd_cache_types[i]);
135 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
136 buf[len] == '\n') {
137 ct = i;
138 break;
141 if (ct < 0)
142 return -EINVAL;
143 rcd = ct & 0x01 ? 1 : 0;
144 wce = ct & 0x02 ? 1 : 0;
145 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
146 SD_MAX_RETRIES, &data, NULL))
147 return -EINVAL;
148 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
149 data.block_descriptor_length);
150 buffer_data = buffer + data.header_length +
151 data.block_descriptor_length;
152 buffer_data[2] &= ~0x05;
153 buffer_data[2] |= wce << 2 | rcd;
154 sp = buffer_data[0] & 0x80 ? 1 : 0;
156 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
157 SD_MAX_RETRIES, &data, &sshdr)) {
158 if (scsi_sense_valid(&sshdr))
159 sd_print_sense_hdr(sdkp, &sshdr);
160 return -EINVAL;
162 sd_revalidate_disk(sdkp->disk);
163 return count;
166 static ssize_t sd_store_manage_start_stop(struct class_device *cdev,
167 const char *buf, size_t count)
169 struct scsi_disk *sdkp = to_scsi_disk(cdev);
170 struct scsi_device *sdp = sdkp->device;
172 if (!capable(CAP_SYS_ADMIN))
173 return -EACCES;
175 sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
177 return count;
180 static ssize_t sd_store_allow_restart(struct class_device *cdev, const char *buf,
181 size_t count)
183 struct scsi_disk *sdkp = to_scsi_disk(cdev);
184 struct scsi_device *sdp = sdkp->device;
186 if (!capable(CAP_SYS_ADMIN))
187 return -EACCES;
189 if (sdp->type != TYPE_DISK)
190 return -EINVAL;
192 sdp->allow_restart = simple_strtoul(buf, NULL, 10);
194 return count;
197 static ssize_t sd_show_cache_type(struct class_device *cdev, char *buf)
199 struct scsi_disk *sdkp = to_scsi_disk(cdev);
200 int ct = sdkp->RCD + 2*sdkp->WCE;
202 return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
205 static ssize_t sd_show_fua(struct class_device *cdev, char *buf)
207 struct scsi_disk *sdkp = to_scsi_disk(cdev);
209 return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
212 static ssize_t sd_show_manage_start_stop(struct class_device *cdev, char *buf)
214 struct scsi_disk *sdkp = to_scsi_disk(cdev);
215 struct scsi_device *sdp = sdkp->device;
217 return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
220 static ssize_t sd_show_allow_restart(struct class_device *cdev, char *buf)
222 struct scsi_disk *sdkp = to_scsi_disk(cdev);
224 return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
227 static struct class_device_attribute sd_disk_attrs[] = {
228 __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
229 sd_store_cache_type),
230 __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
231 __ATTR(allow_restart, S_IRUGO|S_IWUSR, sd_show_allow_restart,
232 sd_store_allow_restart),
233 __ATTR(manage_start_stop, S_IRUGO|S_IWUSR, sd_show_manage_start_stop,
234 sd_store_manage_start_stop),
235 __ATTR_NULL,
238 static struct class sd_disk_class = {
239 .name = "scsi_disk",
240 .owner = THIS_MODULE,
241 .release = scsi_disk_release,
242 .class_dev_attrs = sd_disk_attrs,
245 static struct scsi_driver sd_template = {
246 .owner = THIS_MODULE,
247 .gendrv = {
248 .name = "sd",
249 .probe = sd_probe,
250 .remove = sd_remove,
251 .suspend = sd_suspend,
252 .resume = sd_resume,
253 .shutdown = sd_shutdown,
255 .rescan = sd_rescan,
256 .done = sd_done,
260 * Device no to disk mapping:
262 * major disc2 disc p1
263 * |............|.............|....|....| <- dev_t
264 * 31 20 19 8 7 4 3 0
266 * Inside a major, we have 16k disks, however mapped non-
267 * contiguously. The first 16 disks are for major0, the next
268 * ones with major1, ... Disk 256 is for major0 again, disk 272
269 * for major1, ...
270 * As we stay compatible with our numbering scheme, we can reuse
271 * the well-know SCSI majors 8, 65--71, 136--143.
273 static int sd_major(int major_idx)
275 switch (major_idx) {
276 case 0:
277 return SCSI_DISK0_MAJOR;
278 case 1 ... 7:
279 return SCSI_DISK1_MAJOR + major_idx - 1;
280 case 8 ... 15:
281 return SCSI_DISK8_MAJOR + major_idx - 8;
282 default:
283 BUG();
284 return 0; /* shut up gcc */
288 static inline struct scsi_disk *scsi_disk(struct gendisk *disk)
290 return container_of(disk->private_data, struct scsi_disk, driver);
293 static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
295 struct scsi_disk *sdkp = NULL;
297 if (disk->private_data) {
298 sdkp = scsi_disk(disk);
299 if (scsi_device_get(sdkp->device) == 0)
300 class_device_get(&sdkp->cdev);
301 else
302 sdkp = NULL;
304 return sdkp;
307 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
309 struct scsi_disk *sdkp;
311 mutex_lock(&sd_ref_mutex);
312 sdkp = __scsi_disk_get(disk);
313 mutex_unlock(&sd_ref_mutex);
314 return sdkp;
317 static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
319 struct scsi_disk *sdkp;
321 mutex_lock(&sd_ref_mutex);
322 sdkp = dev_get_drvdata(dev);
323 if (sdkp)
324 sdkp = __scsi_disk_get(sdkp->disk);
325 mutex_unlock(&sd_ref_mutex);
326 return sdkp;
329 static void scsi_disk_put(struct scsi_disk *sdkp)
331 struct scsi_device *sdev = sdkp->device;
333 mutex_lock(&sd_ref_mutex);
334 class_device_put(&sdkp->cdev);
335 scsi_device_put(sdev);
336 mutex_unlock(&sd_ref_mutex);
340 * sd_init_command - build a scsi (read or write) command from
341 * information in the request structure.
342 * @SCpnt: pointer to mid-level's per scsi command structure that
343 * contains request and into which the scsi command is written
345 * Returns 1 if successful and 0 if error (or cannot be done now).
347 static int sd_prep_fn(struct request_queue *q, struct request *rq)
349 struct scsi_cmnd *SCpnt;
350 struct scsi_device *sdp = q->queuedata;
351 struct gendisk *disk = rq->rq_disk;
352 sector_t block = rq->sector;
353 unsigned int this_count = rq->nr_sectors;
354 unsigned int timeout = sdp->timeout;
355 int ret;
357 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
358 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
359 goto out;
360 } else if (rq->cmd_type != REQ_TYPE_FS) {
361 ret = BLKPREP_KILL;
362 goto out;
364 ret = scsi_setup_fs_cmnd(sdp, rq);
365 if (ret != BLKPREP_OK)
366 goto out;
367 SCpnt = rq->special;
369 /* from here on until we're complete, any goto out
370 * is used for a killable error condition */
371 ret = BLKPREP_KILL;
373 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
374 "sd_init_command: block=%llu, "
375 "count=%d\n",
376 (unsigned long long)block,
377 this_count));
379 if (!sdp || !scsi_device_online(sdp) ||
380 block + rq->nr_sectors > get_capacity(disk)) {
381 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
382 "Finishing %ld sectors\n",
383 rq->nr_sectors));
384 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
385 "Retry with 0x%p\n", SCpnt));
386 goto out;
389 if (sdp->changed) {
391 * quietly refuse to do anything to a changed disc until
392 * the changed bit has been reset
394 /* printk("SCSI disk has been changed. Prohibiting further I/O.\n"); */
395 goto out;
399 * Some devices (some sdcards for one) don't like it if the
400 * last sector gets read in a larger then 1 sector read.
402 if (unlikely(sdp->last_sector_bug &&
403 rq->nr_sectors > sdp->sector_size / 512 &&
404 block + this_count == get_capacity(disk)))
405 this_count -= sdp->sector_size / 512;
407 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
408 (unsigned long long)block));
411 * If we have a 1K hardware sectorsize, prevent access to single
412 * 512 byte sectors. In theory we could handle this - in fact
413 * the scsi cdrom driver must be able to handle this because
414 * we typically use 1K blocksizes, and cdroms typically have
415 * 2K hardware sectorsizes. Of course, things are simpler
416 * with the cdrom, since it is read-only. For performance
417 * reasons, the filesystems should be able to handle this
418 * and not force the scsi disk driver to use bounce buffers
419 * for this.
421 if (sdp->sector_size == 1024) {
422 if ((block & 1) || (rq->nr_sectors & 1)) {
423 scmd_printk(KERN_ERR, SCpnt,
424 "Bad block number requested\n");
425 goto out;
426 } else {
427 block = block >> 1;
428 this_count = this_count >> 1;
431 if (sdp->sector_size == 2048) {
432 if ((block & 3) || (rq->nr_sectors & 3)) {
433 scmd_printk(KERN_ERR, SCpnt,
434 "Bad block number requested\n");
435 goto out;
436 } else {
437 block = block >> 2;
438 this_count = this_count >> 2;
441 if (sdp->sector_size == 4096) {
442 if ((block & 7) || (rq->nr_sectors & 7)) {
443 scmd_printk(KERN_ERR, SCpnt,
444 "Bad block number requested\n");
445 goto out;
446 } else {
447 block = block >> 3;
448 this_count = this_count >> 3;
451 if (rq_data_dir(rq) == WRITE) {
452 if (!sdp->writeable) {
453 goto out;
455 SCpnt->cmnd[0] = WRITE_6;
456 SCpnt->sc_data_direction = DMA_TO_DEVICE;
457 } else if (rq_data_dir(rq) == READ) {
458 SCpnt->cmnd[0] = READ_6;
459 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
460 } else {
461 scmd_printk(KERN_ERR, SCpnt, "Unknown command %x\n", rq->cmd_flags);
462 goto out;
465 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
466 "%s %d/%ld 512 byte blocks.\n",
467 (rq_data_dir(rq) == WRITE) ?
468 "writing" : "reading", this_count,
469 rq->nr_sectors));
471 SCpnt->cmnd[1] = 0;
473 if (block > 0xffffffff) {
474 SCpnt->cmnd[0] += READ_16 - READ_6;
475 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
476 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
477 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
478 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
479 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
480 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
481 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
482 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
483 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
484 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
485 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
486 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
487 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
488 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
489 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
490 SCpnt->device->use_10_for_rw) {
491 if (this_count > 0xffff)
492 this_count = 0xffff;
494 SCpnt->cmnd[0] += READ_10 - READ_6;
495 SCpnt->cmnd[1] |= blk_fua_rq(rq) ? 0x8 : 0;
496 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
497 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
498 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
499 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
500 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
501 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
502 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
503 } else {
504 if (unlikely(blk_fua_rq(rq))) {
506 * This happens only if this drive failed
507 * 10byte rw command with ILLEGAL_REQUEST
508 * during operation and thus turned off
509 * use_10_for_rw.
511 scmd_printk(KERN_ERR, SCpnt,
512 "FUA write on READ/WRITE(6) drive\n");
513 goto out;
516 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
517 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
518 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
519 SCpnt->cmnd[4] = (unsigned char) this_count;
520 SCpnt->cmnd[5] = 0;
522 SCpnt->sdb.length = this_count * sdp->sector_size;
525 * We shouldn't disconnect in the middle of a sector, so with a dumb
526 * host adapter, it's safe to assume that we can at least transfer
527 * this many bytes between each connect / disconnect.
529 SCpnt->transfersize = sdp->sector_size;
530 SCpnt->underflow = this_count << 9;
531 SCpnt->allowed = SD_MAX_RETRIES;
532 SCpnt->timeout_per_command = timeout;
535 * This indicates that the command is ready from our end to be
536 * queued.
538 ret = BLKPREP_OK;
539 out:
540 return scsi_prep_return(q, rq, ret);
544 * sd_open - open a scsi disk device
545 * @inode: only i_rdev member may be used
546 * @filp: only f_mode and f_flags may be used
548 * Returns 0 if successful. Returns a negated errno value in case
549 * of error.
551 * Note: This can be called from a user context (e.g. fsck(1) )
552 * or from within the kernel (e.g. as a result of a mount(1) ).
553 * In the latter case @inode and @filp carry an abridged amount
554 * of information as noted above.
556 static int sd_open(struct inode *inode, struct file *filp)
558 struct gendisk *disk = inode->i_bdev->bd_disk;
559 struct scsi_disk *sdkp;
560 struct scsi_device *sdev;
561 int retval;
563 if (!(sdkp = scsi_disk_get(disk)))
564 return -ENXIO;
567 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
569 sdev = sdkp->device;
572 * If the device is in error recovery, wait until it is done.
573 * If the device is offline, then disallow any access to it.
575 retval = -ENXIO;
576 if (!scsi_block_when_processing_errors(sdev))
577 goto error_out;
579 if (sdev->removable || sdkp->write_prot)
580 check_disk_change(inode->i_bdev);
583 * If the drive is empty, just let the open fail.
585 retval = -ENOMEDIUM;
586 if (sdev->removable && !sdkp->media_present &&
587 !(filp->f_flags & O_NDELAY))
588 goto error_out;
591 * If the device has the write protect tab set, have the open fail
592 * if the user expects to be able to write to the thing.
594 retval = -EROFS;
595 if (sdkp->write_prot && (filp->f_mode & FMODE_WRITE))
596 goto error_out;
599 * It is possible that the disk changing stuff resulted in
600 * the device being taken offline. If this is the case,
601 * report this to the user, and don't pretend that the
602 * open actually succeeded.
604 retval = -ENXIO;
605 if (!scsi_device_online(sdev))
606 goto error_out;
608 if (!sdkp->openers++ && sdev->removable) {
609 if (scsi_block_when_processing_errors(sdev))
610 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
613 return 0;
615 error_out:
616 scsi_disk_put(sdkp);
617 return retval;
621 * sd_release - invoked when the (last) close(2) is called on this
622 * scsi disk.
623 * @inode: only i_rdev member may be used
624 * @filp: only f_mode and f_flags may be used
626 * Returns 0.
628 * Note: may block (uninterruptible) if error recovery is underway
629 * on this disk.
631 static int sd_release(struct inode *inode, struct file *filp)
633 struct gendisk *disk = inode->i_bdev->bd_disk;
634 struct scsi_disk *sdkp = scsi_disk(disk);
635 struct scsi_device *sdev = sdkp->device;
637 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
639 if (!--sdkp->openers && sdev->removable) {
640 if (scsi_block_when_processing_errors(sdev))
641 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
645 * XXX and what if there are packets in flight and this close()
646 * XXX is followed by a "rmmod sd_mod"?
648 scsi_disk_put(sdkp);
649 return 0;
652 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
654 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
655 struct scsi_device *sdp = sdkp->device;
656 struct Scsi_Host *host = sdp->host;
657 int diskinfo[4];
659 /* default to most commonly used values */
660 diskinfo[0] = 0x40; /* 1 << 6 */
661 diskinfo[1] = 0x20; /* 1 << 5 */
662 diskinfo[2] = sdkp->capacity >> 11;
664 /* override with calculated, extended default, or driver values */
665 if (host->hostt->bios_param)
666 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
667 else
668 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
670 geo->heads = diskinfo[0];
671 geo->sectors = diskinfo[1];
672 geo->cylinders = diskinfo[2];
673 return 0;
677 * sd_ioctl - process an ioctl
678 * @inode: only i_rdev/i_bdev members may be used
679 * @filp: only f_mode and f_flags may be used
680 * @cmd: ioctl command number
681 * @arg: this is third argument given to ioctl(2) system call.
682 * Often contains a pointer.
684 * Returns 0 if successful (some ioctls return postive numbers on
685 * success as well). Returns a negated errno value in case of error.
687 * Note: most ioctls are forward onto the block subsystem or further
688 * down in the scsi subsystem.
690 static int sd_ioctl(struct inode * inode, struct file * filp,
691 unsigned int cmd, unsigned long arg)
693 struct block_device *bdev = inode->i_bdev;
694 struct gendisk *disk = bdev->bd_disk;
695 struct scsi_device *sdp = scsi_disk(disk)->device;
696 void __user *p = (void __user *)arg;
697 int error;
699 SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
700 disk->disk_name, cmd));
703 * If we are in the middle of error recovery, don't let anyone
704 * else try and use this device. Also, if error recovery fails, it
705 * may try and take the device offline, in which case all further
706 * access to the device is prohibited.
708 error = scsi_nonblockable_ioctl(sdp, cmd, p, filp);
709 if (!scsi_block_when_processing_errors(sdp) || !error)
710 return error;
713 * Send SCSI addressing ioctls directly to mid level, send other
714 * ioctls to block level and then onto mid level if they can't be
715 * resolved.
717 switch (cmd) {
718 case SCSI_IOCTL_GET_IDLUN:
719 case SCSI_IOCTL_GET_BUS_NUMBER:
720 return scsi_ioctl(sdp, cmd, p);
721 default:
722 error = scsi_cmd_ioctl(filp, disk->queue, disk, cmd, p);
723 if (error != -ENOTTY)
724 return error;
726 return scsi_ioctl(sdp, cmd, p);
729 static void set_media_not_present(struct scsi_disk *sdkp)
731 sdkp->media_present = 0;
732 sdkp->capacity = 0;
733 sdkp->device->changed = 1;
737 * sd_media_changed - check if our medium changed
738 * @disk: kernel device descriptor
740 * Returns 0 if not applicable or no change; 1 if change
742 * Note: this function is invoked from the block subsystem.
744 static int sd_media_changed(struct gendisk *disk)
746 struct scsi_disk *sdkp = scsi_disk(disk);
747 struct scsi_device *sdp = sdkp->device;
748 struct scsi_sense_hdr *sshdr = NULL;
749 int retval;
751 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_media_changed\n"));
753 if (!sdp->removable)
754 return 0;
757 * If the device is offline, don't send any commands - just pretend as
758 * if the command failed. If the device ever comes back online, we
759 * can deal with it then. It is only because of unrecoverable errors
760 * that we would ever take a device offline in the first place.
762 if (!scsi_device_online(sdp)) {
763 set_media_not_present(sdkp);
764 retval = 1;
765 goto out;
769 * Using TEST_UNIT_READY enables differentiation between drive with
770 * no cartridge loaded - NOT READY, drive with changed cartridge -
771 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
773 * Drives that auto spin down. eg iomega jaz 1G, will be started
774 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
775 * sd_revalidate() is called.
777 retval = -ENODEV;
779 if (scsi_block_when_processing_errors(sdp)) {
780 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
781 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
782 sshdr);
786 * Unable to test, unit probably not ready. This usually
787 * means there is no disc in the drive. Mark as changed,
788 * and we will figure it out later once the drive is
789 * available again.
791 if (retval || (scsi_sense_valid(sshdr) &&
792 /* 0x3a is medium not present */
793 sshdr->asc == 0x3a)) {
794 set_media_not_present(sdkp);
795 retval = 1;
796 goto out;
800 * For removable scsi disk we have to recognise the presence
801 * of a disk in the drive. This is kept in the struct scsi_disk
802 * struct and tested at open ! Daniel Roche (dan@lectra.fr)
804 sdkp->media_present = 1;
806 retval = sdp->changed;
807 sdp->changed = 0;
808 out:
809 if (retval != sdkp->previous_state)
810 sdev_evt_send_simple(sdp, SDEV_EVT_MEDIA_CHANGE, GFP_KERNEL);
811 sdkp->previous_state = retval;
812 kfree(sshdr);
813 return retval;
816 static int sd_sync_cache(struct scsi_disk *sdkp)
818 int retries, res;
819 struct scsi_device *sdp = sdkp->device;
820 struct scsi_sense_hdr sshdr;
822 if (!scsi_device_online(sdp))
823 return -ENODEV;
826 for (retries = 3; retries > 0; --retries) {
827 unsigned char cmd[10] = { 0 };
829 cmd[0] = SYNCHRONIZE_CACHE;
831 * Leave the rest of the command zero to indicate
832 * flush everything.
834 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
835 SD_TIMEOUT, SD_MAX_RETRIES);
836 if (res == 0)
837 break;
840 if (res) {
841 sd_print_result(sdkp, res);
842 if (driver_byte(res) & DRIVER_SENSE)
843 sd_print_sense_hdr(sdkp, &sshdr);
846 if (res)
847 return -EIO;
848 return 0;
851 static void sd_prepare_flush(struct request_queue *q, struct request *rq)
853 memset(rq->cmd, 0, sizeof(rq->cmd));
854 rq->cmd_type = REQ_TYPE_BLOCK_PC;
855 rq->timeout = SD_TIMEOUT;
856 rq->cmd[0] = SYNCHRONIZE_CACHE;
857 rq->cmd_len = 10;
860 static void sd_rescan(struct device *dev)
862 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
864 if (sdkp) {
865 sd_revalidate_disk(sdkp->disk);
866 scsi_disk_put(sdkp);
871 #ifdef CONFIG_COMPAT
873 * This gets directly called from VFS. When the ioctl
874 * is not recognized we go back to the other translation paths.
876 static long sd_compat_ioctl(struct file *file, unsigned int cmd, unsigned long arg)
878 struct block_device *bdev = file->f_path.dentry->d_inode->i_bdev;
879 struct gendisk *disk = bdev->bd_disk;
880 struct scsi_device *sdev = scsi_disk(disk)->device;
883 * If we are in the middle of error recovery, don't let anyone
884 * else try and use this device. Also, if error recovery fails, it
885 * may try and take the device offline, in which case all further
886 * access to the device is prohibited.
888 if (!scsi_block_when_processing_errors(sdev))
889 return -ENODEV;
891 if (sdev->host->hostt->compat_ioctl) {
892 int ret;
894 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
896 return ret;
900 * Let the static ioctl translation table take care of it.
902 return -ENOIOCTLCMD;
904 #endif
906 static struct block_device_operations sd_fops = {
907 .owner = THIS_MODULE,
908 .open = sd_open,
909 .release = sd_release,
910 .ioctl = sd_ioctl,
911 .getgeo = sd_getgeo,
912 #ifdef CONFIG_COMPAT
913 .compat_ioctl = sd_compat_ioctl,
914 #endif
915 .media_changed = sd_media_changed,
916 .revalidate_disk = sd_revalidate_disk,
920 * sd_done - bottom half handler: called when the lower level
921 * driver has completed (successfully or otherwise) a scsi command.
922 * @SCpnt: mid-level's per command structure.
924 * Note: potentially run from within an ISR. Must not block.
926 static int sd_done(struct scsi_cmnd *SCpnt)
928 int result = SCpnt->result;
929 unsigned int xfer_size = scsi_bufflen(SCpnt);
930 unsigned int good_bytes = result ? 0 : xfer_size;
931 u64 start_lba = SCpnt->request->sector;
932 u64 bad_lba;
933 struct scsi_sense_hdr sshdr;
934 int sense_valid = 0;
935 int sense_deferred = 0;
936 int info_valid;
938 if (result) {
939 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
940 if (sense_valid)
941 sense_deferred = scsi_sense_is_deferred(&sshdr);
943 #ifdef CONFIG_SCSI_LOGGING
944 SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
945 if (sense_valid) {
946 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
947 "sd_done: sb[respc,sk,asc,"
948 "ascq]=%x,%x,%x,%x\n",
949 sshdr.response_code,
950 sshdr.sense_key, sshdr.asc,
951 sshdr.ascq));
953 #endif
954 if (driver_byte(result) != DRIVER_SENSE &&
955 (!sense_valid || sense_deferred))
956 goto out;
958 switch (sshdr.sense_key) {
959 case HARDWARE_ERROR:
960 case MEDIUM_ERROR:
961 if (!blk_fs_request(SCpnt->request))
962 goto out;
963 info_valid = scsi_get_sense_info_fld(SCpnt->sense_buffer,
964 SCSI_SENSE_BUFFERSIZE,
965 &bad_lba);
966 if (!info_valid)
967 goto out;
968 if (xfer_size <= SCpnt->device->sector_size)
969 goto out;
970 switch (SCpnt->device->sector_size) {
971 case 256:
972 start_lba <<= 1;
973 break;
974 case 512:
975 break;
976 case 1024:
977 start_lba >>= 1;
978 break;
979 case 2048:
980 start_lba >>= 2;
981 break;
982 case 4096:
983 start_lba >>= 3;
984 break;
985 default:
986 /* Print something here with limiting frequency. */
987 goto out;
988 break;
990 /* This computation should always be done in terms of
991 * the resolution of the device's medium.
993 good_bytes = (bad_lba - start_lba)*SCpnt->device->sector_size;
994 break;
995 case RECOVERED_ERROR:
996 case NO_SENSE:
997 /* Inform the user, but make sure that it's not treated
998 * as a hard error.
1000 scsi_print_sense("sd", SCpnt);
1001 SCpnt->result = 0;
1002 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1003 good_bytes = xfer_size;
1004 break;
1005 case ILLEGAL_REQUEST:
1006 if (SCpnt->device->use_10_for_rw &&
1007 (SCpnt->cmnd[0] == READ_10 ||
1008 SCpnt->cmnd[0] == WRITE_10))
1009 SCpnt->device->use_10_for_rw = 0;
1010 if (SCpnt->device->use_10_for_ms &&
1011 (SCpnt->cmnd[0] == MODE_SENSE_10 ||
1012 SCpnt->cmnd[0] == MODE_SELECT_10))
1013 SCpnt->device->use_10_for_ms = 0;
1014 break;
1015 default:
1016 break;
1018 out:
1019 return good_bytes;
1022 static int media_not_present(struct scsi_disk *sdkp,
1023 struct scsi_sense_hdr *sshdr)
1026 if (!scsi_sense_valid(sshdr))
1027 return 0;
1028 /* not invoked for commands that could return deferred errors */
1029 if (sshdr->sense_key != NOT_READY &&
1030 sshdr->sense_key != UNIT_ATTENTION)
1031 return 0;
1032 if (sshdr->asc != 0x3A) /* medium not present */
1033 return 0;
1035 set_media_not_present(sdkp);
1036 return 1;
1040 * spinup disk - called only in sd_revalidate_disk()
1042 static void
1043 sd_spinup_disk(struct scsi_disk *sdkp)
1045 unsigned char cmd[10];
1046 unsigned long spintime_expire = 0;
1047 int retries, spintime;
1048 unsigned int the_result;
1049 struct scsi_sense_hdr sshdr;
1050 int sense_valid = 0;
1052 spintime = 0;
1054 /* Spin up drives, as required. Only do this at boot time */
1055 /* Spinup needs to be done for module loads too. */
1056 do {
1057 retries = 0;
1059 do {
1060 cmd[0] = TEST_UNIT_READY;
1061 memset((void *) &cmd[1], 0, 9);
1063 the_result = scsi_execute_req(sdkp->device, cmd,
1064 DMA_NONE, NULL, 0,
1065 &sshdr, SD_TIMEOUT,
1066 SD_MAX_RETRIES);
1069 * If the drive has indicated to us that it
1070 * doesn't have any media in it, don't bother
1071 * with any more polling.
1073 if (media_not_present(sdkp, &sshdr))
1074 return;
1076 if (the_result)
1077 sense_valid = scsi_sense_valid(&sshdr);
1078 retries++;
1079 } while (retries < 3 &&
1080 (!scsi_status_is_good(the_result) ||
1081 ((driver_byte(the_result) & DRIVER_SENSE) &&
1082 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1084 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1085 /* no sense, TUR either succeeded or failed
1086 * with a status error */
1087 if(!spintime && !scsi_status_is_good(the_result)) {
1088 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1089 sd_print_result(sdkp, the_result);
1091 break;
1095 * The device does not want the automatic start to be issued.
1097 if (sdkp->device->no_start_on_add) {
1098 break;
1102 * If manual intervention is required, or this is an
1103 * absent USB storage device, a spinup is meaningless.
1105 if (sense_valid &&
1106 sshdr.sense_key == NOT_READY &&
1107 sshdr.asc == 4 && sshdr.ascq == 3) {
1108 break; /* manual intervention required */
1111 * Issue command to spin up drive when not ready
1113 } else if (sense_valid && sshdr.sense_key == NOT_READY) {
1114 if (!spintime) {
1115 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1116 cmd[0] = START_STOP;
1117 cmd[1] = 1; /* Return immediately */
1118 memset((void *) &cmd[2], 0, 8);
1119 cmd[4] = 1; /* Start spin cycle */
1120 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1121 NULL, 0, &sshdr,
1122 SD_TIMEOUT, SD_MAX_RETRIES);
1123 spintime_expire = jiffies + 100 * HZ;
1124 spintime = 1;
1126 /* Wait 1 second for next try */
1127 msleep(1000);
1128 printk(".");
1131 * Wait for USB flash devices with slow firmware.
1132 * Yes, this sense key/ASC combination shouldn't
1133 * occur here. It's characteristic of these devices.
1135 } else if (sense_valid &&
1136 sshdr.sense_key == UNIT_ATTENTION &&
1137 sshdr.asc == 0x28) {
1138 if (!spintime) {
1139 spintime_expire = jiffies + 5 * HZ;
1140 spintime = 1;
1142 /* Wait 1 second for next try */
1143 msleep(1000);
1144 } else {
1145 /* we don't understand the sense code, so it's
1146 * probably pointless to loop */
1147 if(!spintime) {
1148 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1149 sd_print_sense_hdr(sdkp, &sshdr);
1151 break;
1154 } while (spintime && time_before_eq(jiffies, spintime_expire));
1156 if (spintime) {
1157 if (scsi_status_is_good(the_result))
1158 printk("ready\n");
1159 else
1160 printk("not responding...\n");
1165 * read disk capacity
1167 static void
1168 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
1170 unsigned char cmd[16];
1171 int the_result, retries;
1172 int sector_size = 0;
1173 int longrc = 0;
1174 struct scsi_sense_hdr sshdr;
1175 int sense_valid = 0;
1176 struct scsi_device *sdp = sdkp->device;
1178 repeat:
1179 retries = 3;
1180 do {
1181 if (longrc) {
1182 memset((void *) cmd, 0, 16);
1183 cmd[0] = SERVICE_ACTION_IN;
1184 cmd[1] = SAI_READ_CAPACITY_16;
1185 cmd[13] = 12;
1186 memset((void *) buffer, 0, 12);
1187 } else {
1188 cmd[0] = READ_CAPACITY;
1189 memset((void *) &cmd[1], 0, 9);
1190 memset((void *) buffer, 0, 8);
1193 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1194 buffer, longrc ? 12 : 8, &sshdr,
1195 SD_TIMEOUT, SD_MAX_RETRIES);
1197 if (media_not_present(sdkp, &sshdr))
1198 return;
1200 if (the_result)
1201 sense_valid = scsi_sense_valid(&sshdr);
1202 retries--;
1204 } while (the_result && retries);
1206 if (the_result && !longrc) {
1207 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
1208 sd_print_result(sdkp, the_result);
1209 if (driver_byte(the_result) & DRIVER_SENSE)
1210 sd_print_sense_hdr(sdkp, &sshdr);
1211 else
1212 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1214 /* Set dirty bit for removable devices if not ready -
1215 * sometimes drives will not report this properly. */
1216 if (sdp->removable &&
1217 sense_valid && sshdr.sense_key == NOT_READY)
1218 sdp->changed = 1;
1220 /* Either no media are present but the drive didn't tell us,
1221 or they are present but the read capacity command fails */
1222 /* sdkp->media_present = 0; -- not always correct */
1223 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1225 return;
1226 } else if (the_result && longrc) {
1227 /* READ CAPACITY(16) has been failed */
1228 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
1229 sd_print_result(sdkp, the_result);
1230 sd_printk(KERN_NOTICE, sdkp, "Use 0xffffffff as device size\n");
1232 sdkp->capacity = 1 + (sector_t) 0xffffffff;
1233 goto got_data;
1236 if (!longrc) {
1237 sector_size = (buffer[4] << 24) |
1238 (buffer[5] << 16) | (buffer[6] << 8) | buffer[7];
1239 if (buffer[0] == 0xff && buffer[1] == 0xff &&
1240 buffer[2] == 0xff && buffer[3] == 0xff) {
1241 if(sizeof(sdkp->capacity) > 4) {
1242 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
1243 "Trying to use READ CAPACITY(16).\n");
1244 longrc = 1;
1245 goto repeat;
1247 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use "
1248 "a kernel compiled with support for large "
1249 "block devices.\n");
1250 sdkp->capacity = 0;
1251 goto got_data;
1253 sdkp->capacity = 1 + (((sector_t)buffer[0] << 24) |
1254 (buffer[1] << 16) |
1255 (buffer[2] << 8) |
1256 buffer[3]);
1257 } else {
1258 sdkp->capacity = 1 + (((u64)buffer[0] << 56) |
1259 ((u64)buffer[1] << 48) |
1260 ((u64)buffer[2] << 40) |
1261 ((u64)buffer[3] << 32) |
1262 ((sector_t)buffer[4] << 24) |
1263 ((sector_t)buffer[5] << 16) |
1264 ((sector_t)buffer[6] << 8) |
1265 (sector_t)buffer[7]);
1267 sector_size = (buffer[8] << 24) |
1268 (buffer[9] << 16) | (buffer[10] << 8) | buffer[11];
1271 /* Some devices return the total number of sectors, not the
1272 * highest sector number. Make the necessary adjustment. */
1273 if (sdp->fix_capacity) {
1274 --sdkp->capacity;
1276 /* Some devices have version which report the correct sizes
1277 * and others which do not. We guess size according to a heuristic
1278 * and err on the side of lowering the capacity. */
1279 } else {
1280 if (sdp->guess_capacity)
1281 if (sdkp->capacity & 0x01) /* odd sizes are odd */
1282 --sdkp->capacity;
1285 got_data:
1286 if (sector_size == 0) {
1287 sector_size = 512;
1288 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
1289 "assuming 512.\n");
1292 if (sector_size != 512 &&
1293 sector_size != 1024 &&
1294 sector_size != 2048 &&
1295 sector_size != 4096 &&
1296 sector_size != 256) {
1297 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
1298 sector_size);
1300 * The user might want to re-format the drive with
1301 * a supported sectorsize. Once this happens, it
1302 * would be relatively trivial to set the thing up.
1303 * For this reason, we leave the thing in the table.
1305 sdkp->capacity = 0;
1307 * set a bogus sector size so the normal read/write
1308 * logic in the block layer will eventually refuse any
1309 * request on this device without tripping over power
1310 * of two sector size assumptions
1312 sector_size = 512;
1316 * The msdos fs needs to know the hardware sector size
1317 * So I have created this table. See ll_rw_blk.c
1318 * Jacques Gelinas (Jacques@solucorp.qc.ca)
1320 int hard_sector = sector_size;
1321 sector_t sz = (sdkp->capacity/2) * (hard_sector/256);
1322 struct request_queue *queue = sdp->request_queue;
1323 sector_t mb = sz;
1325 blk_queue_hardsect_size(queue, hard_sector);
1326 /* avoid 64-bit division on 32-bit platforms */
1327 sector_div(sz, 625);
1328 mb -= sz - 974;
1329 sector_div(mb, 1950);
1331 sd_printk(KERN_NOTICE, sdkp,
1332 "%llu %d-byte hardware sectors (%llu MB)\n",
1333 (unsigned long long)sdkp->capacity,
1334 hard_sector, (unsigned long long)mb);
1337 /* Rescale capacity to 512-byte units */
1338 if (sector_size == 4096)
1339 sdkp->capacity <<= 3;
1340 else if (sector_size == 2048)
1341 sdkp->capacity <<= 2;
1342 else if (sector_size == 1024)
1343 sdkp->capacity <<= 1;
1344 else if (sector_size == 256)
1345 sdkp->capacity >>= 1;
1347 sdkp->device->sector_size = sector_size;
1350 /* called with buffer of length 512 */
1351 static inline int
1352 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1353 unsigned char *buffer, int len, struct scsi_mode_data *data,
1354 struct scsi_sense_hdr *sshdr)
1356 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1357 SD_TIMEOUT, SD_MAX_RETRIES, data,
1358 sshdr);
1362 * read write protect setting, if possible - called only in sd_revalidate_disk()
1363 * called with buffer of length SD_BUF_SIZE
1365 static void
1366 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
1368 int res;
1369 struct scsi_device *sdp = sdkp->device;
1370 struct scsi_mode_data data;
1372 set_disk_ro(sdkp->disk, 0);
1373 if (sdp->skip_ms_page_3f) {
1374 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1375 return;
1378 if (sdp->use_192_bytes_for_3f) {
1379 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1380 } else {
1382 * First attempt: ask for all pages (0x3F), but only 4 bytes.
1383 * We have to start carefully: some devices hang if we ask
1384 * for more than is available.
1386 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1389 * Second attempt: ask for page 0 When only page 0 is
1390 * implemented, a request for page 3F may return Sense Key
1391 * 5: Illegal Request, Sense Code 24: Invalid field in
1392 * CDB.
1394 if (!scsi_status_is_good(res))
1395 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1398 * Third attempt: ask 255 bytes, as we did earlier.
1400 if (!scsi_status_is_good(res))
1401 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1402 &data, NULL);
1405 if (!scsi_status_is_good(res)) {
1406 sd_printk(KERN_WARNING, sdkp,
1407 "Test WP failed, assume Write Enabled\n");
1408 } else {
1409 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
1410 set_disk_ro(sdkp->disk, sdkp->write_prot);
1411 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
1412 sdkp->write_prot ? "on" : "off");
1413 sd_printk(KERN_DEBUG, sdkp,
1414 "Mode Sense: %02x %02x %02x %02x\n",
1415 buffer[0], buffer[1], buffer[2], buffer[3]);
1420 * sd_read_cache_type - called only from sd_revalidate_disk()
1421 * called with buffer of length SD_BUF_SIZE
1423 static void
1424 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
1426 int len = 0, res;
1427 struct scsi_device *sdp = sdkp->device;
1429 int dbd;
1430 int modepage;
1431 struct scsi_mode_data data;
1432 struct scsi_sense_hdr sshdr;
1434 if (sdp->skip_ms_page_8)
1435 goto defaults;
1437 if (sdp->type == TYPE_RBC) {
1438 modepage = 6;
1439 dbd = 8;
1440 } else {
1441 modepage = 8;
1442 dbd = 0;
1445 /* cautiously ask */
1446 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, 4, &data, &sshdr);
1448 if (!scsi_status_is_good(res))
1449 goto bad_sense;
1451 if (!data.header_length) {
1452 modepage = 6;
1453 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
1456 /* that went OK, now ask for the proper length */
1457 len = data.length;
1460 * We're only interested in the first three bytes, actually.
1461 * But the data cache page is defined for the first 20.
1463 if (len < 3)
1464 goto bad_sense;
1465 if (len > 20)
1466 len = 20;
1468 /* Take headers and block descriptors into account */
1469 len += data.header_length + data.block_descriptor_length;
1470 if (len > SD_BUF_SIZE)
1471 goto bad_sense;
1473 /* Get the data */
1474 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len, &data, &sshdr);
1476 if (scsi_status_is_good(res)) {
1477 int offset = data.header_length + data.block_descriptor_length;
1479 if (offset >= SD_BUF_SIZE - 2) {
1480 sd_printk(KERN_ERR, sdkp, "Malformed MODE SENSE response\n");
1481 goto defaults;
1484 if ((buffer[offset] & 0x3f) != modepage) {
1485 sd_printk(KERN_ERR, sdkp, "Got wrong page\n");
1486 goto defaults;
1489 if (modepage == 8) {
1490 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
1491 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
1492 } else {
1493 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
1494 sdkp->RCD = 0;
1497 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
1498 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
1499 sd_printk(KERN_NOTICE, sdkp,
1500 "Uses READ/WRITE(6), disabling FUA\n");
1501 sdkp->DPOFUA = 0;
1504 sd_printk(KERN_NOTICE, sdkp,
1505 "Write cache: %s, read cache: %s, %s\n",
1506 sdkp->WCE ? "enabled" : "disabled",
1507 sdkp->RCD ? "disabled" : "enabled",
1508 sdkp->DPOFUA ? "supports DPO and FUA"
1509 : "doesn't support DPO or FUA");
1511 return;
1514 bad_sense:
1515 if (scsi_sense_valid(&sshdr) &&
1516 sshdr.sense_key == ILLEGAL_REQUEST &&
1517 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
1518 /* Invalid field in CDB */
1519 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1520 else
1521 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
1523 defaults:
1524 sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
1525 sdkp->WCE = 0;
1526 sdkp->RCD = 0;
1527 sdkp->DPOFUA = 0;
1531 * sd_revalidate_disk - called the first time a new disk is seen,
1532 * performs disk spin up, read_capacity, etc.
1533 * @disk: struct gendisk we care about
1535 static int sd_revalidate_disk(struct gendisk *disk)
1537 struct scsi_disk *sdkp = scsi_disk(disk);
1538 struct scsi_device *sdp = sdkp->device;
1539 unsigned char *buffer;
1540 unsigned ordered;
1542 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
1543 "sd_revalidate_disk\n"));
1546 * If the device is offline, don't try and read capacity or any
1547 * of the other niceties.
1549 if (!scsi_device_online(sdp))
1550 goto out;
1552 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1553 if (!buffer) {
1554 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
1555 "allocation failure.\n");
1556 goto out;
1559 /* defaults, until the device tells us otherwise */
1560 sdp->sector_size = 512;
1561 sdkp->capacity = 0;
1562 sdkp->media_present = 1;
1563 sdkp->write_prot = 0;
1564 sdkp->WCE = 0;
1565 sdkp->RCD = 0;
1567 sd_spinup_disk(sdkp);
1570 * Without media there is no reason to ask; moreover, some devices
1571 * react badly if we do.
1573 if (sdkp->media_present) {
1574 sd_read_capacity(sdkp, buffer);
1575 sd_read_write_protect_flag(sdkp, buffer);
1576 sd_read_cache_type(sdkp, buffer);
1580 * We now have all cache related info, determine how we deal
1581 * with ordered requests. Note that as the current SCSI
1582 * dispatch function can alter request order, we cannot use
1583 * QUEUE_ORDERED_TAG_* even when ordered tag is supported.
1585 if (sdkp->WCE)
1586 ordered = sdkp->DPOFUA
1587 ? QUEUE_ORDERED_DRAIN_FUA : QUEUE_ORDERED_DRAIN_FLUSH;
1588 else
1589 ordered = QUEUE_ORDERED_DRAIN;
1591 blk_queue_ordered(sdkp->disk->queue, ordered, sd_prepare_flush);
1593 set_capacity(disk, sdkp->capacity);
1594 kfree(buffer);
1596 out:
1597 return 0;
1601 * sd_probe - called during driver initialization and whenever a
1602 * new scsi device is attached to the system. It is called once
1603 * for each scsi device (not just disks) present.
1604 * @dev: pointer to device object
1606 * Returns 0 if successful (or not interested in this scsi device
1607 * (e.g. scanner)); 1 when there is an error.
1609 * Note: this function is invoked from the scsi mid-level.
1610 * This function sets up the mapping between a given
1611 * <host,channel,id,lun> (found in sdp) and new device name
1612 * (e.g. /dev/sda). More precisely it is the block device major
1613 * and minor number that is chosen here.
1615 * Assume sd_attach is not re-entrant (for time being)
1616 * Also think about sd_attach() and sd_remove() running coincidentally.
1618 static int sd_probe(struct device *dev)
1620 struct scsi_device *sdp = to_scsi_device(dev);
1621 struct scsi_disk *sdkp;
1622 struct gendisk *gd;
1623 u32 index;
1624 int error;
1626 error = -ENODEV;
1627 if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
1628 goto out;
1630 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
1631 "sd_attach\n"));
1633 error = -ENOMEM;
1634 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
1635 if (!sdkp)
1636 goto out;
1638 gd = alloc_disk(16);
1639 if (!gd)
1640 goto out_free;
1642 if (!idr_pre_get(&sd_index_idr, GFP_KERNEL))
1643 goto out_put;
1645 spin_lock(&sd_index_lock);
1646 error = idr_get_new(&sd_index_idr, NULL, &index);
1647 spin_unlock(&sd_index_lock);
1649 if (index >= SD_MAX_DISKS)
1650 error = -EBUSY;
1651 if (error)
1652 goto out_put;
1654 sdkp->device = sdp;
1655 sdkp->driver = &sd_template;
1656 sdkp->disk = gd;
1657 sdkp->index = index;
1658 sdkp->openers = 0;
1660 if (!sdp->timeout) {
1661 if (sdp->type != TYPE_MOD)
1662 sdp->timeout = SD_TIMEOUT;
1663 else
1664 sdp->timeout = SD_MOD_TIMEOUT;
1667 class_device_initialize(&sdkp->cdev);
1668 sdkp->cdev.dev = &sdp->sdev_gendev;
1669 sdkp->cdev.class = &sd_disk_class;
1670 strncpy(sdkp->cdev.class_id, sdp->sdev_gendev.bus_id, BUS_ID_SIZE);
1672 if (class_device_add(&sdkp->cdev))
1673 goto out_put;
1675 get_device(&sdp->sdev_gendev);
1677 gd->major = sd_major((index & 0xf0) >> 4);
1678 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
1679 gd->minors = 16;
1680 gd->fops = &sd_fops;
1682 if (index < 26) {
1683 sprintf(gd->disk_name, "sd%c", 'a' + index % 26);
1684 } else if (index < (26 + 1) * 26) {
1685 sprintf(gd->disk_name, "sd%c%c",
1686 'a' + index / 26 - 1,'a' + index % 26);
1687 } else {
1688 const unsigned int m1 = (index / 26 - 1) / 26 - 1;
1689 const unsigned int m2 = (index / 26 - 1) % 26;
1690 const unsigned int m3 = index % 26;
1691 sprintf(gd->disk_name, "sd%c%c%c",
1692 'a' + m1, 'a' + m2, 'a' + m3);
1695 gd->private_data = &sdkp->driver;
1696 gd->queue = sdkp->device->request_queue;
1698 sd_revalidate_disk(gd);
1700 blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
1702 gd->driverfs_dev = &sdp->sdev_gendev;
1703 gd->flags = GENHD_FL_DRIVERFS;
1704 if (sdp->removable)
1705 gd->flags |= GENHD_FL_REMOVABLE;
1707 dev_set_drvdata(dev, sdkp);
1708 add_disk(gd);
1710 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
1711 sdp->removable ? "removable " : "");
1713 return 0;
1715 out_put:
1716 put_disk(gd);
1717 out_free:
1718 kfree(sdkp);
1719 out:
1720 return error;
1724 * sd_remove - called whenever a scsi disk (previously recognized by
1725 * sd_probe) is detached from the system. It is called (potentially
1726 * multiple times) during sd module unload.
1727 * @sdp: pointer to mid level scsi device object
1729 * Note: this function is invoked from the scsi mid-level.
1730 * This function potentially frees up a device name (e.g. /dev/sdc)
1731 * that could be re-used by a subsequent sd_probe().
1732 * This function is not called when the built-in sd driver is "exit-ed".
1734 static int sd_remove(struct device *dev)
1736 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1738 class_device_del(&sdkp->cdev);
1739 del_gendisk(sdkp->disk);
1740 sd_shutdown(dev);
1742 mutex_lock(&sd_ref_mutex);
1743 dev_set_drvdata(dev, NULL);
1744 class_device_put(&sdkp->cdev);
1745 mutex_unlock(&sd_ref_mutex);
1747 return 0;
1751 * scsi_disk_release - Called to free the scsi_disk structure
1752 * @cdev: pointer to embedded class device
1754 * sd_ref_mutex must be held entering this routine. Because it is
1755 * called on last put, you should always use the scsi_disk_get()
1756 * scsi_disk_put() helpers which manipulate the semaphore directly
1757 * and never do a direct class_device_put().
1759 static void scsi_disk_release(struct class_device *cdev)
1761 struct scsi_disk *sdkp = to_scsi_disk(cdev);
1762 struct gendisk *disk = sdkp->disk;
1764 spin_lock(&sd_index_lock);
1765 idr_remove(&sd_index_idr, sdkp->index);
1766 spin_unlock(&sd_index_lock);
1768 disk->private_data = NULL;
1769 put_disk(disk);
1770 put_device(&sdkp->device->sdev_gendev);
1772 kfree(sdkp);
1775 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
1777 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
1778 struct scsi_sense_hdr sshdr;
1779 struct scsi_device *sdp = sdkp->device;
1780 int res;
1782 if (start)
1783 cmd[4] |= 1; /* START */
1785 if (!scsi_device_online(sdp))
1786 return -ENODEV;
1788 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
1789 SD_TIMEOUT, SD_MAX_RETRIES);
1790 if (res) {
1791 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
1792 sd_print_result(sdkp, res);
1793 if (driver_byte(res) & DRIVER_SENSE)
1794 sd_print_sense_hdr(sdkp, &sshdr);
1797 return res;
1801 * Send a SYNCHRONIZE CACHE instruction down to the device through
1802 * the normal SCSI command structure. Wait for the command to
1803 * complete.
1805 static void sd_shutdown(struct device *dev)
1807 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1809 if (!sdkp)
1810 return; /* this can happen */
1812 if (sdkp->WCE) {
1813 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
1814 sd_sync_cache(sdkp);
1817 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
1818 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
1819 sd_start_stop_device(sdkp, 0);
1822 scsi_disk_put(sdkp);
1825 static int sd_suspend(struct device *dev, pm_message_t mesg)
1827 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1828 int ret = 0;
1830 if (!sdkp)
1831 return 0; /* this can happen */
1833 if (sdkp->WCE) {
1834 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
1835 ret = sd_sync_cache(sdkp);
1836 if (ret)
1837 goto done;
1840 if (mesg.event == PM_EVENT_SUSPEND &&
1841 sdkp->device->manage_start_stop) {
1842 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
1843 ret = sd_start_stop_device(sdkp, 0);
1846 done:
1847 scsi_disk_put(sdkp);
1848 return ret;
1851 static int sd_resume(struct device *dev)
1853 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1854 int ret = 0;
1856 if (!sdkp->device->manage_start_stop)
1857 goto done;
1859 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
1860 ret = sd_start_stop_device(sdkp, 1);
1862 done:
1863 scsi_disk_put(sdkp);
1864 return ret;
1868 * init_sd - entry point for this driver (both when built in or when
1869 * a module).
1871 * Note: this function registers this driver with the scsi mid-level.
1873 static int __init init_sd(void)
1875 int majors = 0, i, err;
1877 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
1879 for (i = 0; i < SD_MAJORS; i++)
1880 if (register_blkdev(sd_major(i), "sd") == 0)
1881 majors++;
1883 if (!majors)
1884 return -ENODEV;
1886 err = class_register(&sd_disk_class);
1887 if (err)
1888 goto err_out;
1890 err = scsi_register_driver(&sd_template.gendrv);
1891 if (err)
1892 goto err_out_class;
1894 return 0;
1896 err_out_class:
1897 class_unregister(&sd_disk_class);
1898 err_out:
1899 for (i = 0; i < SD_MAJORS; i++)
1900 unregister_blkdev(sd_major(i), "sd");
1901 return err;
1905 * exit_sd - exit point for this driver (when it is a module).
1907 * Note: this function unregisters this driver from the scsi mid-level.
1909 static void __exit exit_sd(void)
1911 int i;
1913 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
1915 scsi_unregister_driver(&sd_template.gendrv);
1916 class_unregister(&sd_disk_class);
1918 for (i = 0; i < SD_MAJORS; i++)
1919 unregister_blkdev(sd_major(i), "sd");
1922 module_init(init_sd);
1923 module_exit(exit_sd);
1925 static void sd_print_sense_hdr(struct scsi_disk *sdkp,
1926 struct scsi_sense_hdr *sshdr)
1928 sd_printk(KERN_INFO, sdkp, "");
1929 scsi_show_sense_hdr(sshdr);
1930 sd_printk(KERN_INFO, sdkp, "");
1931 scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
1934 static void sd_print_result(struct scsi_disk *sdkp, int result)
1936 sd_printk(KERN_INFO, sdkp, "");
1937 scsi_show_result(result);