ACPI: thinkpad-acpi: add development version tag
[linux-2.6/linux-acpi-2.6/ibm-acpi-2.6.git] / drivers / scsi / sd.c
blob568d3638925966cf28d2597b5d06cb46e6e586cb
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 <linux/string_helpers.h>
51 #include <linux/async.h>
52 #include <asm/uaccess.h>
53 #include <asm/unaligned.h>
55 #include <scsi/scsi.h>
56 #include <scsi/scsi_cmnd.h>
57 #include <scsi/scsi_dbg.h>
58 #include <scsi/scsi_device.h>
59 #include <scsi/scsi_driver.h>
60 #include <scsi/scsi_eh.h>
61 #include <scsi/scsi_host.h>
62 #include <scsi/scsi_ioctl.h>
63 #include <scsi/scsicam.h>
65 #include "sd.h"
66 #include "scsi_logging.h"
68 MODULE_AUTHOR("Eric Youngdale");
69 MODULE_DESCRIPTION("SCSI disk (sd) driver");
70 MODULE_LICENSE("GPL");
72 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
73 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
74 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
75 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
76 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
77 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
78 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
79 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
85 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
86 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
87 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
88 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
89 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
90 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
92 #if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
93 #define SD_MINORS 16
94 #else
95 #define SD_MINORS 0
96 #endif
98 static int sd_revalidate_disk(struct gendisk *);
99 static int sd_probe(struct device *);
100 static int sd_remove(struct device *);
101 static void sd_shutdown(struct device *);
102 static int sd_suspend(struct device *, pm_message_t state);
103 static int sd_resume(struct device *);
104 static void sd_rescan(struct device *);
105 static int sd_done(struct scsi_cmnd *);
106 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
107 static void scsi_disk_release(struct device *cdev);
108 static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
109 static void sd_print_result(struct scsi_disk *, int);
111 static DEFINE_SPINLOCK(sd_index_lock);
112 static DEFINE_IDA(sd_index_ida);
114 /* This semaphore is used to mediate the 0->1 reference get in the
115 * face of object destruction (i.e. we can't allow a get on an
116 * object after last put) */
117 static DEFINE_MUTEX(sd_ref_mutex);
119 struct kmem_cache *sd_cdb_cache;
120 mempool_t *sd_cdb_pool;
122 static const char *sd_cache_types[] = {
123 "write through", "none", "write back",
124 "write back, no read (daft)"
127 static ssize_t
128 sd_store_cache_type(struct device *dev, struct device_attribute *attr,
129 const char *buf, size_t count)
131 int i, ct = -1, rcd, wce, sp;
132 struct scsi_disk *sdkp = to_scsi_disk(dev);
133 struct scsi_device *sdp = sdkp->device;
134 char buffer[64];
135 char *buffer_data;
136 struct scsi_mode_data data;
137 struct scsi_sense_hdr sshdr;
138 int len;
140 if (sdp->type != TYPE_DISK)
141 /* no cache control on RBC devices; theoretically they
142 * can do it, but there's probably so many exceptions
143 * it's not worth the risk */
144 return -EINVAL;
146 for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
147 const int len = strlen(sd_cache_types[i]);
148 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
149 buf[len] == '\n') {
150 ct = i;
151 break;
154 if (ct < 0)
155 return -EINVAL;
156 rcd = ct & 0x01 ? 1 : 0;
157 wce = ct & 0x02 ? 1 : 0;
158 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
159 SD_MAX_RETRIES, &data, NULL))
160 return -EINVAL;
161 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
162 data.block_descriptor_length);
163 buffer_data = buffer + data.header_length +
164 data.block_descriptor_length;
165 buffer_data[2] &= ~0x05;
166 buffer_data[2] |= wce << 2 | rcd;
167 sp = buffer_data[0] & 0x80 ? 1 : 0;
169 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
170 SD_MAX_RETRIES, &data, &sshdr)) {
171 if (scsi_sense_valid(&sshdr))
172 sd_print_sense_hdr(sdkp, &sshdr);
173 return -EINVAL;
175 revalidate_disk(sdkp->disk);
176 return count;
179 static ssize_t
180 sd_store_manage_start_stop(struct device *dev, struct device_attribute *attr,
181 const char *buf, size_t count)
183 struct scsi_disk *sdkp = to_scsi_disk(dev);
184 struct scsi_device *sdp = sdkp->device;
186 if (!capable(CAP_SYS_ADMIN))
187 return -EACCES;
189 sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
191 return count;
194 static ssize_t
195 sd_store_allow_restart(struct device *dev, struct device_attribute *attr,
196 const char *buf, size_t count)
198 struct scsi_disk *sdkp = to_scsi_disk(dev);
199 struct scsi_device *sdp = sdkp->device;
201 if (!capable(CAP_SYS_ADMIN))
202 return -EACCES;
204 if (sdp->type != TYPE_DISK)
205 return -EINVAL;
207 sdp->allow_restart = simple_strtoul(buf, NULL, 10);
209 return count;
212 static ssize_t
213 sd_show_cache_type(struct device *dev, struct device_attribute *attr,
214 char *buf)
216 struct scsi_disk *sdkp = to_scsi_disk(dev);
217 int ct = sdkp->RCD + 2*sdkp->WCE;
219 return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
222 static ssize_t
223 sd_show_fua(struct device *dev, struct device_attribute *attr, char *buf)
225 struct scsi_disk *sdkp = to_scsi_disk(dev);
227 return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
230 static ssize_t
231 sd_show_manage_start_stop(struct device *dev, struct device_attribute *attr,
232 char *buf)
234 struct scsi_disk *sdkp = to_scsi_disk(dev);
235 struct scsi_device *sdp = sdkp->device;
237 return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
240 static ssize_t
241 sd_show_allow_restart(struct device *dev, struct device_attribute *attr,
242 char *buf)
244 struct scsi_disk *sdkp = to_scsi_disk(dev);
246 return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
249 static ssize_t
250 sd_show_protection_type(struct device *dev, struct device_attribute *attr,
251 char *buf)
253 struct scsi_disk *sdkp = to_scsi_disk(dev);
255 return snprintf(buf, 20, "%u\n", sdkp->protection_type);
258 static ssize_t
259 sd_show_app_tag_own(struct device *dev, struct device_attribute *attr,
260 char *buf)
262 struct scsi_disk *sdkp = to_scsi_disk(dev);
264 return snprintf(buf, 20, "%u\n", sdkp->ATO);
267 static struct device_attribute sd_disk_attrs[] = {
268 __ATTR(cache_type, S_IRUGO|S_IWUSR, sd_show_cache_type,
269 sd_store_cache_type),
270 __ATTR(FUA, S_IRUGO, sd_show_fua, NULL),
271 __ATTR(allow_restart, S_IRUGO|S_IWUSR, sd_show_allow_restart,
272 sd_store_allow_restart),
273 __ATTR(manage_start_stop, S_IRUGO|S_IWUSR, sd_show_manage_start_stop,
274 sd_store_manage_start_stop),
275 __ATTR(protection_type, S_IRUGO, sd_show_protection_type, NULL),
276 __ATTR(app_tag_own, S_IRUGO, sd_show_app_tag_own, NULL),
277 __ATTR_NULL,
280 static struct class sd_disk_class = {
281 .name = "scsi_disk",
282 .owner = THIS_MODULE,
283 .dev_release = scsi_disk_release,
284 .dev_attrs = sd_disk_attrs,
287 static struct scsi_driver sd_template = {
288 .owner = THIS_MODULE,
289 .gendrv = {
290 .name = "sd",
291 .probe = sd_probe,
292 .remove = sd_remove,
293 .suspend = sd_suspend,
294 .resume = sd_resume,
295 .shutdown = sd_shutdown,
297 .rescan = sd_rescan,
298 .done = sd_done,
302 * Device no to disk mapping:
304 * major disc2 disc p1
305 * |............|.............|....|....| <- dev_t
306 * 31 20 19 8 7 4 3 0
308 * Inside a major, we have 16k disks, however mapped non-
309 * contiguously. The first 16 disks are for major0, the next
310 * ones with major1, ... Disk 256 is for major0 again, disk 272
311 * for major1, ...
312 * As we stay compatible with our numbering scheme, we can reuse
313 * the well-know SCSI majors 8, 65--71, 136--143.
315 static int sd_major(int major_idx)
317 switch (major_idx) {
318 case 0:
319 return SCSI_DISK0_MAJOR;
320 case 1 ... 7:
321 return SCSI_DISK1_MAJOR + major_idx - 1;
322 case 8 ... 15:
323 return SCSI_DISK8_MAJOR + major_idx - 8;
324 default:
325 BUG();
326 return 0; /* shut up gcc */
330 static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
332 struct scsi_disk *sdkp = NULL;
334 if (disk->private_data) {
335 sdkp = scsi_disk(disk);
336 if (scsi_device_get(sdkp->device) == 0)
337 get_device(&sdkp->dev);
338 else
339 sdkp = NULL;
341 return sdkp;
344 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
346 struct scsi_disk *sdkp;
348 mutex_lock(&sd_ref_mutex);
349 sdkp = __scsi_disk_get(disk);
350 mutex_unlock(&sd_ref_mutex);
351 return sdkp;
354 static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
356 struct scsi_disk *sdkp;
358 mutex_lock(&sd_ref_mutex);
359 sdkp = dev_get_drvdata(dev);
360 if (sdkp)
361 sdkp = __scsi_disk_get(sdkp->disk);
362 mutex_unlock(&sd_ref_mutex);
363 return sdkp;
366 static void scsi_disk_put(struct scsi_disk *sdkp)
368 struct scsi_device *sdev = sdkp->device;
370 mutex_lock(&sd_ref_mutex);
371 put_device(&sdkp->dev);
372 scsi_device_put(sdev);
373 mutex_unlock(&sd_ref_mutex);
376 static void sd_prot_op(struct scsi_cmnd *scmd, unsigned int dif)
378 unsigned int prot_op = SCSI_PROT_NORMAL;
379 unsigned int dix = scsi_prot_sg_count(scmd);
381 if (scmd->sc_data_direction == DMA_FROM_DEVICE) {
382 if (dif && dix)
383 prot_op = SCSI_PROT_READ_PASS;
384 else if (dif && !dix)
385 prot_op = SCSI_PROT_READ_STRIP;
386 else if (!dif && dix)
387 prot_op = SCSI_PROT_READ_INSERT;
388 } else {
389 if (dif && dix)
390 prot_op = SCSI_PROT_WRITE_PASS;
391 else if (dif && !dix)
392 prot_op = SCSI_PROT_WRITE_INSERT;
393 else if (!dif && dix)
394 prot_op = SCSI_PROT_WRITE_STRIP;
397 scsi_set_prot_op(scmd, prot_op);
398 scsi_set_prot_type(scmd, dif);
402 * sd_init_command - build a scsi (read or write) command from
403 * information in the request structure.
404 * @SCpnt: pointer to mid-level's per scsi command structure that
405 * contains request and into which the scsi command is written
407 * Returns 1 if successful and 0 if error (or cannot be done now).
409 static int sd_prep_fn(struct request_queue *q, struct request *rq)
411 struct scsi_cmnd *SCpnt;
412 struct scsi_device *sdp = q->queuedata;
413 struct gendisk *disk = rq->rq_disk;
414 struct scsi_disk *sdkp;
415 sector_t block = blk_rq_pos(rq);
416 sector_t threshold;
417 unsigned int this_count = blk_rq_sectors(rq);
418 int ret, host_dif;
419 unsigned char protect;
421 if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
422 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
423 goto out;
424 } else if (rq->cmd_type != REQ_TYPE_FS) {
425 ret = BLKPREP_KILL;
426 goto out;
428 ret = scsi_setup_fs_cmnd(sdp, rq);
429 if (ret != BLKPREP_OK)
430 goto out;
431 SCpnt = rq->special;
432 sdkp = scsi_disk(disk);
434 /* from here on until we're complete, any goto out
435 * is used for a killable error condition */
436 ret = BLKPREP_KILL;
438 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
439 "sd_init_command: block=%llu, "
440 "count=%d\n",
441 (unsigned long long)block,
442 this_count));
444 if (!sdp || !scsi_device_online(sdp) ||
445 block + blk_rq_sectors(rq) > get_capacity(disk)) {
446 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
447 "Finishing %u sectors\n",
448 blk_rq_sectors(rq)));
449 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
450 "Retry with 0x%p\n", SCpnt));
451 goto out;
454 if (sdp->changed) {
456 * quietly refuse to do anything to a changed disc until
457 * the changed bit has been reset
459 /* printk("SCSI disk has been changed. Prohibiting further I/O.\n"); */
460 goto out;
464 * Some SD card readers can't handle multi-sector accesses which touch
465 * the last one or two hardware sectors. Split accesses as needed.
467 threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
468 (sdp->sector_size / 512);
470 if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
471 if (block < threshold) {
472 /* Access up to the threshold but not beyond */
473 this_count = threshold - block;
474 } else {
475 /* Access only a single hardware sector */
476 this_count = sdp->sector_size / 512;
480 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
481 (unsigned long long)block));
484 * If we have a 1K hardware sectorsize, prevent access to single
485 * 512 byte sectors. In theory we could handle this - in fact
486 * the scsi cdrom driver must be able to handle this because
487 * we typically use 1K blocksizes, and cdroms typically have
488 * 2K hardware sectorsizes. Of course, things are simpler
489 * with the cdrom, since it is read-only. For performance
490 * reasons, the filesystems should be able to handle this
491 * and not force the scsi disk driver to use bounce buffers
492 * for this.
494 if (sdp->sector_size == 1024) {
495 if ((block & 1) || (blk_rq_sectors(rq) & 1)) {
496 scmd_printk(KERN_ERR, SCpnt,
497 "Bad block number requested\n");
498 goto out;
499 } else {
500 block = block >> 1;
501 this_count = this_count >> 1;
504 if (sdp->sector_size == 2048) {
505 if ((block & 3) || (blk_rq_sectors(rq) & 3)) {
506 scmd_printk(KERN_ERR, SCpnt,
507 "Bad block number requested\n");
508 goto out;
509 } else {
510 block = block >> 2;
511 this_count = this_count >> 2;
514 if (sdp->sector_size == 4096) {
515 if ((block & 7) || (blk_rq_sectors(rq) & 7)) {
516 scmd_printk(KERN_ERR, SCpnt,
517 "Bad block number requested\n");
518 goto out;
519 } else {
520 block = block >> 3;
521 this_count = this_count >> 3;
524 if (rq_data_dir(rq) == WRITE) {
525 if (!sdp->writeable) {
526 goto out;
528 SCpnt->cmnd[0] = WRITE_6;
529 SCpnt->sc_data_direction = DMA_TO_DEVICE;
531 if (blk_integrity_rq(rq) &&
532 sd_dif_prepare(rq, block, sdp->sector_size) == -EIO)
533 goto out;
535 } else if (rq_data_dir(rq) == READ) {
536 SCpnt->cmnd[0] = READ_6;
537 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
538 } else {
539 scmd_printk(KERN_ERR, SCpnt, "Unknown command %x\n", rq->cmd_flags);
540 goto out;
543 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
544 "%s %d/%u 512 byte blocks.\n",
545 (rq_data_dir(rq) == WRITE) ?
546 "writing" : "reading", this_count,
547 blk_rq_sectors(rq)));
549 /* Set RDPROTECT/WRPROTECT if disk is formatted with DIF */
550 host_dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
551 if (host_dif)
552 protect = 1 << 5;
553 else
554 protect = 0;
556 if (host_dif == SD_DIF_TYPE2_PROTECTION) {
557 SCpnt->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
559 if (unlikely(SCpnt->cmnd == NULL)) {
560 ret = BLKPREP_DEFER;
561 goto out;
564 SCpnt->cmd_len = SD_EXT_CDB_SIZE;
565 memset(SCpnt->cmnd, 0, SCpnt->cmd_len);
566 SCpnt->cmnd[0] = VARIABLE_LENGTH_CMD;
567 SCpnt->cmnd[7] = 0x18;
568 SCpnt->cmnd[9] = (rq_data_dir(rq) == READ) ? READ_32 : WRITE_32;
569 SCpnt->cmnd[10] = protect | (blk_fua_rq(rq) ? 0x8 : 0);
571 /* LBA */
572 SCpnt->cmnd[12] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
573 SCpnt->cmnd[13] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
574 SCpnt->cmnd[14] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
575 SCpnt->cmnd[15] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
576 SCpnt->cmnd[16] = (unsigned char) (block >> 24) & 0xff;
577 SCpnt->cmnd[17] = (unsigned char) (block >> 16) & 0xff;
578 SCpnt->cmnd[18] = (unsigned char) (block >> 8) & 0xff;
579 SCpnt->cmnd[19] = (unsigned char) block & 0xff;
581 /* Expected Indirect LBA */
582 SCpnt->cmnd[20] = (unsigned char) (block >> 24) & 0xff;
583 SCpnt->cmnd[21] = (unsigned char) (block >> 16) & 0xff;
584 SCpnt->cmnd[22] = (unsigned char) (block >> 8) & 0xff;
585 SCpnt->cmnd[23] = (unsigned char) block & 0xff;
587 /* Transfer length */
588 SCpnt->cmnd[28] = (unsigned char) (this_count >> 24) & 0xff;
589 SCpnt->cmnd[29] = (unsigned char) (this_count >> 16) & 0xff;
590 SCpnt->cmnd[30] = (unsigned char) (this_count >> 8) & 0xff;
591 SCpnt->cmnd[31] = (unsigned char) this_count & 0xff;
592 } else if (block > 0xffffffff) {
593 SCpnt->cmnd[0] += READ_16 - READ_6;
594 SCpnt->cmnd[1] = protect | (blk_fua_rq(rq) ? 0x8 : 0);
595 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
596 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
597 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
598 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
599 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
600 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
601 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
602 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
603 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
604 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
605 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
606 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
607 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
608 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
609 scsi_device_protection(SCpnt->device) ||
610 SCpnt->device->use_10_for_rw) {
611 if (this_count > 0xffff)
612 this_count = 0xffff;
614 SCpnt->cmnd[0] += READ_10 - READ_6;
615 SCpnt->cmnd[1] = protect | (blk_fua_rq(rq) ? 0x8 : 0);
616 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
617 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
618 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
619 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
620 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
621 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
622 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
623 } else {
624 if (unlikely(blk_fua_rq(rq))) {
626 * This happens only if this drive failed
627 * 10byte rw command with ILLEGAL_REQUEST
628 * during operation and thus turned off
629 * use_10_for_rw.
631 scmd_printk(KERN_ERR, SCpnt,
632 "FUA write on READ/WRITE(6) drive\n");
633 goto out;
636 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
637 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
638 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
639 SCpnt->cmnd[4] = (unsigned char) this_count;
640 SCpnt->cmnd[5] = 0;
642 SCpnt->sdb.length = this_count * sdp->sector_size;
644 /* If DIF or DIX is enabled, tell HBA how to handle request */
645 if (host_dif || scsi_prot_sg_count(SCpnt))
646 sd_prot_op(SCpnt, host_dif);
649 * We shouldn't disconnect in the middle of a sector, so with a dumb
650 * host adapter, it's safe to assume that we can at least transfer
651 * this many bytes between each connect / disconnect.
653 SCpnt->transfersize = sdp->sector_size;
654 SCpnt->underflow = this_count << 9;
655 SCpnt->allowed = SD_MAX_RETRIES;
658 * This indicates that the command is ready from our end to be
659 * queued.
661 ret = BLKPREP_OK;
662 out:
663 return scsi_prep_return(q, rq, ret);
667 * sd_open - open a scsi disk device
668 * @inode: only i_rdev member may be used
669 * @filp: only f_mode and f_flags may be used
671 * Returns 0 if successful. Returns a negated errno value in case
672 * of error.
674 * Note: This can be called from a user context (e.g. fsck(1) )
675 * or from within the kernel (e.g. as a result of a mount(1) ).
676 * In the latter case @inode and @filp carry an abridged amount
677 * of information as noted above.
679 static int sd_open(struct block_device *bdev, fmode_t mode)
681 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
682 struct scsi_device *sdev;
683 int retval;
685 if (!sdkp)
686 return -ENXIO;
688 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
690 sdev = sdkp->device;
693 * If the device is in error recovery, wait until it is done.
694 * If the device is offline, then disallow any access to it.
696 retval = -ENXIO;
697 if (!scsi_block_when_processing_errors(sdev))
698 goto error_out;
700 if (sdev->removable || sdkp->write_prot)
701 check_disk_change(bdev);
704 * If the drive is empty, just let the open fail.
706 retval = -ENOMEDIUM;
707 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
708 goto error_out;
711 * If the device has the write protect tab set, have the open fail
712 * if the user expects to be able to write to the thing.
714 retval = -EROFS;
715 if (sdkp->write_prot && (mode & FMODE_WRITE))
716 goto error_out;
719 * It is possible that the disk changing stuff resulted in
720 * the device being taken offline. If this is the case,
721 * report this to the user, and don't pretend that the
722 * open actually succeeded.
724 retval = -ENXIO;
725 if (!scsi_device_online(sdev))
726 goto error_out;
728 if (!sdkp->openers++ && sdev->removable) {
729 if (scsi_block_when_processing_errors(sdev))
730 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
733 return 0;
735 error_out:
736 scsi_disk_put(sdkp);
737 return retval;
741 * sd_release - invoked when the (last) close(2) is called on this
742 * scsi disk.
743 * @inode: only i_rdev member may be used
744 * @filp: only f_mode and f_flags may be used
746 * Returns 0.
748 * Note: may block (uninterruptible) if error recovery is underway
749 * on this disk.
751 static int sd_release(struct gendisk *disk, fmode_t mode)
753 struct scsi_disk *sdkp = scsi_disk(disk);
754 struct scsi_device *sdev = sdkp->device;
756 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
758 if (!--sdkp->openers && sdev->removable) {
759 if (scsi_block_when_processing_errors(sdev))
760 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
764 * XXX and what if there are packets in flight and this close()
765 * XXX is followed by a "rmmod sd_mod"?
767 scsi_disk_put(sdkp);
768 return 0;
771 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
773 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
774 struct scsi_device *sdp = sdkp->device;
775 struct Scsi_Host *host = sdp->host;
776 int diskinfo[4];
778 /* default to most commonly used values */
779 diskinfo[0] = 0x40; /* 1 << 6 */
780 diskinfo[1] = 0x20; /* 1 << 5 */
781 diskinfo[2] = sdkp->capacity >> 11;
783 /* override with calculated, extended default, or driver values */
784 if (host->hostt->bios_param)
785 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
786 else
787 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
789 geo->heads = diskinfo[0];
790 geo->sectors = diskinfo[1];
791 geo->cylinders = diskinfo[2];
792 return 0;
796 * sd_ioctl - process an ioctl
797 * @inode: only i_rdev/i_bdev members may be used
798 * @filp: only f_mode and f_flags may be used
799 * @cmd: ioctl command number
800 * @arg: this is third argument given to ioctl(2) system call.
801 * Often contains a pointer.
803 * Returns 0 if successful (some ioctls return postive numbers on
804 * success as well). Returns a negated errno value in case of error.
806 * Note: most ioctls are forward onto the block subsystem or further
807 * down in the scsi subsystem.
809 static int sd_ioctl(struct block_device *bdev, fmode_t mode,
810 unsigned int cmd, unsigned long arg)
812 struct gendisk *disk = bdev->bd_disk;
813 struct scsi_device *sdp = scsi_disk(disk)->device;
814 void __user *p = (void __user *)arg;
815 int error;
817 SCSI_LOG_IOCTL(1, printk("sd_ioctl: disk=%s, cmd=0x%x\n",
818 disk->disk_name, cmd));
821 * If we are in the middle of error recovery, don't let anyone
822 * else try and use this device. Also, if error recovery fails, it
823 * may try and take the device offline, in which case all further
824 * access to the device is prohibited.
826 error = scsi_nonblockable_ioctl(sdp, cmd, p,
827 (mode & FMODE_NDELAY) != 0);
828 if (!scsi_block_when_processing_errors(sdp) || !error)
829 return error;
832 * Send SCSI addressing ioctls directly to mid level, send other
833 * ioctls to block level and then onto mid level if they can't be
834 * resolved.
836 switch (cmd) {
837 case SCSI_IOCTL_GET_IDLUN:
838 case SCSI_IOCTL_GET_BUS_NUMBER:
839 return scsi_ioctl(sdp, cmd, p);
840 default:
841 error = scsi_cmd_ioctl(disk->queue, disk, mode, cmd, p);
842 if (error != -ENOTTY)
843 return error;
845 return scsi_ioctl(sdp, cmd, p);
848 static void set_media_not_present(struct scsi_disk *sdkp)
850 sdkp->media_present = 0;
851 sdkp->capacity = 0;
852 sdkp->device->changed = 1;
856 * sd_media_changed - check if our medium changed
857 * @disk: kernel device descriptor
859 * Returns 0 if not applicable or no change; 1 if change
861 * Note: this function is invoked from the block subsystem.
863 static int sd_media_changed(struct gendisk *disk)
865 struct scsi_disk *sdkp = scsi_disk(disk);
866 struct scsi_device *sdp = sdkp->device;
867 struct scsi_sense_hdr *sshdr = NULL;
868 int retval;
870 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_media_changed\n"));
872 if (!sdp->removable)
873 return 0;
876 * If the device is offline, don't send any commands - just pretend as
877 * if the command failed. If the device ever comes back online, we
878 * can deal with it then. It is only because of unrecoverable errors
879 * that we would ever take a device offline in the first place.
881 if (!scsi_device_online(sdp)) {
882 set_media_not_present(sdkp);
883 retval = 1;
884 goto out;
888 * Using TEST_UNIT_READY enables differentiation between drive with
889 * no cartridge loaded - NOT READY, drive with changed cartridge -
890 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
892 * Drives that auto spin down. eg iomega jaz 1G, will be started
893 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
894 * sd_revalidate() is called.
896 retval = -ENODEV;
898 if (scsi_block_when_processing_errors(sdp)) {
899 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
900 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
901 sshdr);
905 * Unable to test, unit probably not ready. This usually
906 * means there is no disc in the drive. Mark as changed,
907 * and we will figure it out later once the drive is
908 * available again.
910 if (retval || (scsi_sense_valid(sshdr) &&
911 /* 0x3a is medium not present */
912 sshdr->asc == 0x3a)) {
913 set_media_not_present(sdkp);
914 retval = 1;
915 goto out;
919 * For removable scsi disk we have to recognise the presence
920 * of a disk in the drive. This is kept in the struct scsi_disk
921 * struct and tested at open ! Daniel Roche (dan@lectra.fr)
923 sdkp->media_present = 1;
925 retval = sdp->changed;
926 sdp->changed = 0;
927 out:
928 if (retval != sdkp->previous_state)
929 sdev_evt_send_simple(sdp, SDEV_EVT_MEDIA_CHANGE, GFP_KERNEL);
930 sdkp->previous_state = retval;
931 kfree(sshdr);
932 return retval;
935 static int sd_sync_cache(struct scsi_disk *sdkp)
937 int retries, res;
938 struct scsi_device *sdp = sdkp->device;
939 struct scsi_sense_hdr sshdr;
941 if (!scsi_device_online(sdp))
942 return -ENODEV;
945 for (retries = 3; retries > 0; --retries) {
946 unsigned char cmd[10] = { 0 };
948 cmd[0] = SYNCHRONIZE_CACHE;
950 * Leave the rest of the command zero to indicate
951 * flush everything.
953 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
954 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
955 if (res == 0)
956 break;
959 if (res) {
960 sd_print_result(sdkp, res);
961 if (driver_byte(res) & DRIVER_SENSE)
962 sd_print_sense_hdr(sdkp, &sshdr);
965 if (res)
966 return -EIO;
967 return 0;
970 static void sd_prepare_flush(struct request_queue *q, struct request *rq)
972 rq->cmd_type = REQ_TYPE_BLOCK_PC;
973 rq->timeout = SD_TIMEOUT;
974 rq->retries = SD_MAX_RETRIES;
975 rq->cmd[0] = SYNCHRONIZE_CACHE;
976 rq->cmd_len = 10;
979 static void sd_rescan(struct device *dev)
981 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
983 if (sdkp) {
984 revalidate_disk(sdkp->disk);
985 scsi_disk_put(sdkp);
990 #ifdef CONFIG_COMPAT
992 * This gets directly called from VFS. When the ioctl
993 * is not recognized we go back to the other translation paths.
995 static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
996 unsigned int cmd, unsigned long arg)
998 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1001 * If we are in the middle of error recovery, don't let anyone
1002 * else try and use this device. Also, if error recovery fails, it
1003 * may try and take the device offline, in which case all further
1004 * access to the device is prohibited.
1006 if (!scsi_block_when_processing_errors(sdev))
1007 return -ENODEV;
1009 if (sdev->host->hostt->compat_ioctl) {
1010 int ret;
1012 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
1014 return ret;
1018 * Let the static ioctl translation table take care of it.
1020 return -ENOIOCTLCMD;
1022 #endif
1024 static const struct block_device_operations sd_fops = {
1025 .owner = THIS_MODULE,
1026 .open = sd_open,
1027 .release = sd_release,
1028 .locked_ioctl = sd_ioctl,
1029 .getgeo = sd_getgeo,
1030 #ifdef CONFIG_COMPAT
1031 .compat_ioctl = sd_compat_ioctl,
1032 #endif
1033 .media_changed = sd_media_changed,
1034 .revalidate_disk = sd_revalidate_disk,
1037 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1039 u64 start_lba = blk_rq_pos(scmd->request);
1040 u64 end_lba = blk_rq_pos(scmd->request) + (scsi_bufflen(scmd) / 512);
1041 u64 bad_lba;
1042 int info_valid;
1044 * resid is optional but mostly filled in. When it's unused,
1045 * its value is zero, so we assume the whole buffer transferred
1047 unsigned int transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1048 unsigned int good_bytes;
1050 if (!blk_fs_request(scmd->request))
1051 return 0;
1053 info_valid = scsi_get_sense_info_fld(scmd->sense_buffer,
1054 SCSI_SENSE_BUFFERSIZE,
1055 &bad_lba);
1056 if (!info_valid)
1057 return 0;
1059 if (scsi_bufflen(scmd) <= scmd->device->sector_size)
1060 return 0;
1062 if (scmd->device->sector_size < 512) {
1063 /* only legitimate sector_size here is 256 */
1064 start_lba <<= 1;
1065 end_lba <<= 1;
1066 } else {
1067 /* be careful ... don't want any overflows */
1068 u64 factor = scmd->device->sector_size / 512;
1069 do_div(start_lba, factor);
1070 do_div(end_lba, factor);
1073 /* The bad lba was reported incorrectly, we have no idea where
1074 * the error is.
1076 if (bad_lba < start_lba || bad_lba >= end_lba)
1077 return 0;
1079 /* This computation should always be done in terms of
1080 * the resolution of the device's medium.
1082 good_bytes = (bad_lba - start_lba) * scmd->device->sector_size;
1083 return min(good_bytes, transferred);
1087 * sd_done - bottom half handler: called when the lower level
1088 * driver has completed (successfully or otherwise) a scsi command.
1089 * @SCpnt: mid-level's per command structure.
1091 * Note: potentially run from within an ISR. Must not block.
1093 static int sd_done(struct scsi_cmnd *SCpnt)
1095 int result = SCpnt->result;
1096 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1097 struct scsi_sense_hdr sshdr;
1098 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
1099 int sense_valid = 0;
1100 int sense_deferred = 0;
1102 if (result) {
1103 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1104 if (sense_valid)
1105 sense_deferred = scsi_sense_is_deferred(&sshdr);
1107 #ifdef CONFIG_SCSI_LOGGING
1108 SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
1109 if (sense_valid) {
1110 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
1111 "sd_done: sb[respc,sk,asc,"
1112 "ascq]=%x,%x,%x,%x\n",
1113 sshdr.response_code,
1114 sshdr.sense_key, sshdr.asc,
1115 sshdr.ascq));
1117 #endif
1118 if (driver_byte(result) != DRIVER_SENSE &&
1119 (!sense_valid || sense_deferred))
1120 goto out;
1122 switch (sshdr.sense_key) {
1123 case HARDWARE_ERROR:
1124 case MEDIUM_ERROR:
1125 good_bytes = sd_completed_bytes(SCpnt);
1126 break;
1127 case RECOVERED_ERROR:
1128 good_bytes = scsi_bufflen(SCpnt);
1129 break;
1130 case NO_SENSE:
1131 /* This indicates a false check condition, so ignore it. An
1132 * unknown amount of data was transferred so treat it as an
1133 * error.
1135 scsi_print_sense("sd", SCpnt);
1136 SCpnt->result = 0;
1137 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1138 break;
1139 case ABORTED_COMMAND:
1140 if (sshdr.asc == 0x10) { /* DIF: Disk detected corruption */
1141 scsi_print_result(SCpnt);
1142 scsi_print_sense("sd", SCpnt);
1143 good_bytes = sd_completed_bytes(SCpnt);
1145 break;
1146 case ILLEGAL_REQUEST:
1147 if (sshdr.asc == 0x10) { /* DIX: HBA detected corruption */
1148 scsi_print_result(SCpnt);
1149 scsi_print_sense("sd", SCpnt);
1150 good_bytes = sd_completed_bytes(SCpnt);
1152 break;
1153 default:
1154 break;
1156 out:
1157 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt))
1158 sd_dif_complete(SCpnt, good_bytes);
1160 if (scsi_host_dif_capable(sdkp->device->host, sdkp->protection_type)
1161 == SD_DIF_TYPE2_PROTECTION && SCpnt->cmnd != SCpnt->request->cmd)
1162 mempool_free(SCpnt->cmnd, sd_cdb_pool);
1164 return good_bytes;
1167 static int media_not_present(struct scsi_disk *sdkp,
1168 struct scsi_sense_hdr *sshdr)
1171 if (!scsi_sense_valid(sshdr))
1172 return 0;
1173 /* not invoked for commands that could return deferred errors */
1174 if (sshdr->sense_key != NOT_READY &&
1175 sshdr->sense_key != UNIT_ATTENTION)
1176 return 0;
1177 if (sshdr->asc != 0x3A) /* medium not present */
1178 return 0;
1180 set_media_not_present(sdkp);
1181 return 1;
1185 * spinup disk - called only in sd_revalidate_disk()
1187 static void
1188 sd_spinup_disk(struct scsi_disk *sdkp)
1190 unsigned char cmd[10];
1191 unsigned long spintime_expire = 0;
1192 int retries, spintime;
1193 unsigned int the_result;
1194 struct scsi_sense_hdr sshdr;
1195 int sense_valid = 0;
1197 spintime = 0;
1199 /* Spin up drives, as required. Only do this at boot time */
1200 /* Spinup needs to be done for module loads too. */
1201 do {
1202 retries = 0;
1204 do {
1205 cmd[0] = TEST_UNIT_READY;
1206 memset((void *) &cmd[1], 0, 9);
1208 the_result = scsi_execute_req(sdkp->device, cmd,
1209 DMA_NONE, NULL, 0,
1210 &sshdr, SD_TIMEOUT,
1211 SD_MAX_RETRIES, NULL);
1214 * If the drive has indicated to us that it
1215 * doesn't have any media in it, don't bother
1216 * with any more polling.
1218 if (media_not_present(sdkp, &sshdr))
1219 return;
1221 if (the_result)
1222 sense_valid = scsi_sense_valid(&sshdr);
1223 retries++;
1224 } while (retries < 3 &&
1225 (!scsi_status_is_good(the_result) ||
1226 ((driver_byte(the_result) & DRIVER_SENSE) &&
1227 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1229 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1230 /* no sense, TUR either succeeded or failed
1231 * with a status error */
1232 if(!spintime && !scsi_status_is_good(the_result)) {
1233 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1234 sd_print_result(sdkp, the_result);
1236 break;
1240 * The device does not want the automatic start to be issued.
1242 if (sdkp->device->no_start_on_add)
1243 break;
1245 if (sense_valid && sshdr.sense_key == NOT_READY) {
1246 if (sshdr.asc == 4 && sshdr.ascq == 3)
1247 break; /* manual intervention required */
1248 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
1249 break; /* standby */
1250 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
1251 break; /* unavailable */
1253 * Issue command to spin up drive when not ready
1255 if (!spintime) {
1256 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1257 cmd[0] = START_STOP;
1258 cmd[1] = 1; /* Return immediately */
1259 memset((void *) &cmd[2], 0, 8);
1260 cmd[4] = 1; /* Start spin cycle */
1261 if (sdkp->device->start_stop_pwr_cond)
1262 cmd[4] |= 1 << 4;
1263 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1264 NULL, 0, &sshdr,
1265 SD_TIMEOUT, SD_MAX_RETRIES,
1266 NULL);
1267 spintime_expire = jiffies + 100 * HZ;
1268 spintime = 1;
1270 /* Wait 1 second for next try */
1271 msleep(1000);
1272 printk(".");
1275 * Wait for USB flash devices with slow firmware.
1276 * Yes, this sense key/ASC combination shouldn't
1277 * occur here. It's characteristic of these devices.
1279 } else if (sense_valid &&
1280 sshdr.sense_key == UNIT_ATTENTION &&
1281 sshdr.asc == 0x28) {
1282 if (!spintime) {
1283 spintime_expire = jiffies + 5 * HZ;
1284 spintime = 1;
1286 /* Wait 1 second for next try */
1287 msleep(1000);
1288 } else {
1289 /* we don't understand the sense code, so it's
1290 * probably pointless to loop */
1291 if(!spintime) {
1292 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1293 sd_print_sense_hdr(sdkp, &sshdr);
1295 break;
1298 } while (spintime && time_before_eq(jiffies, spintime_expire));
1300 if (spintime) {
1301 if (scsi_status_is_good(the_result))
1302 printk("ready\n");
1303 else
1304 printk("not responding...\n");
1310 * Determine whether disk supports Data Integrity Field.
1312 void sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
1314 struct scsi_device *sdp = sdkp->device;
1315 u8 type;
1317 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
1318 return;
1320 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
1322 if (type == sdkp->protection_type || !sdkp->first_scan)
1323 return;
1325 sdkp->protection_type = type;
1327 if (type > SD_DIF_TYPE3_PROTECTION) {
1328 sd_printk(KERN_ERR, sdkp, "formatted with unsupported " \
1329 "protection type %u. Disabling disk!\n", type);
1330 sdkp->capacity = 0;
1331 return;
1334 if (scsi_host_dif_capable(sdp->host, type))
1335 sd_printk(KERN_NOTICE, sdkp,
1336 "Enabling DIF Type %u protection\n", type);
1337 else
1338 sd_printk(KERN_NOTICE, sdkp,
1339 "Disabling DIF Type %u protection\n", type);
1342 static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
1343 struct scsi_sense_hdr *sshdr, int sense_valid,
1344 int the_result)
1346 sd_print_result(sdkp, the_result);
1347 if (driver_byte(the_result) & DRIVER_SENSE)
1348 sd_print_sense_hdr(sdkp, sshdr);
1349 else
1350 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1353 * Set dirty bit for removable devices if not ready -
1354 * sometimes drives will not report this properly.
1356 if (sdp->removable &&
1357 sense_valid && sshdr->sense_key == NOT_READY)
1358 sdp->changed = 1;
1361 * We used to set media_present to 0 here to indicate no media
1362 * in the drive, but some drives fail read capacity even with
1363 * media present, so we can't do that.
1365 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1368 #define RC16_LEN 32
1369 #if RC16_LEN > SD_BUF_SIZE
1370 #error RC16_LEN must not be more than SD_BUF_SIZE
1371 #endif
1373 static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
1374 unsigned char *buffer)
1376 unsigned char cmd[16];
1377 struct scsi_sense_hdr sshdr;
1378 int sense_valid = 0;
1379 int the_result;
1380 int retries = 3;
1381 unsigned int alignment;
1382 unsigned long long lba;
1383 unsigned sector_size;
1385 do {
1386 memset(cmd, 0, 16);
1387 cmd[0] = SERVICE_ACTION_IN;
1388 cmd[1] = SAI_READ_CAPACITY_16;
1389 cmd[13] = RC16_LEN;
1390 memset(buffer, 0, RC16_LEN);
1392 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1393 buffer, RC16_LEN, &sshdr,
1394 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1396 if (media_not_present(sdkp, &sshdr))
1397 return -ENODEV;
1399 if (the_result) {
1400 sense_valid = scsi_sense_valid(&sshdr);
1401 if (sense_valid &&
1402 sshdr.sense_key == ILLEGAL_REQUEST &&
1403 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
1404 sshdr.ascq == 0x00)
1405 /* Invalid Command Operation Code or
1406 * Invalid Field in CDB, just retry
1407 * silently with RC10 */
1408 return -EINVAL;
1410 retries--;
1412 } while (the_result && retries);
1414 if (the_result) {
1415 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
1416 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
1417 return -EINVAL;
1420 sector_size = get_unaligned_be32(&buffer[8]);
1421 lba = get_unaligned_be64(&buffer[0]);
1423 sd_read_protection_type(sdkp, buffer);
1425 if ((sizeof(sdkp->capacity) == 4) && (lba >= 0xffffffffULL)) {
1426 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
1427 "kernel compiled with support for large block "
1428 "devices.\n");
1429 sdkp->capacity = 0;
1430 return -EOVERFLOW;
1433 /* Logical blocks per physical block exponent */
1434 sdkp->hw_sector_size = (1 << (buffer[13] & 0xf)) * sector_size;
1436 /* Lowest aligned logical block */
1437 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
1438 blk_queue_alignment_offset(sdp->request_queue, alignment);
1439 if (alignment && sdkp->first_scan)
1440 sd_printk(KERN_NOTICE, sdkp,
1441 "physical block alignment offset: %u\n", alignment);
1443 sdkp->capacity = lba + 1;
1444 return sector_size;
1447 static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
1448 unsigned char *buffer)
1450 unsigned char cmd[16];
1451 struct scsi_sense_hdr sshdr;
1452 int sense_valid = 0;
1453 int the_result;
1454 int retries = 3;
1455 sector_t lba;
1456 unsigned sector_size;
1458 do {
1459 cmd[0] = READ_CAPACITY;
1460 memset(&cmd[1], 0, 9);
1461 memset(buffer, 0, 8);
1463 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1464 buffer, 8, &sshdr,
1465 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1467 if (media_not_present(sdkp, &sshdr))
1468 return -ENODEV;
1470 if (the_result)
1471 sense_valid = scsi_sense_valid(&sshdr);
1472 retries--;
1474 } while (the_result && retries);
1476 if (the_result) {
1477 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
1478 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
1479 return -EINVAL;
1482 sector_size = get_unaligned_be32(&buffer[4]);
1483 lba = get_unaligned_be32(&buffer[0]);
1485 if ((sizeof(sdkp->capacity) == 4) && (lba == 0xffffffff)) {
1486 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
1487 "kernel compiled with support for large block "
1488 "devices.\n");
1489 sdkp->capacity = 0;
1490 return -EOVERFLOW;
1493 sdkp->capacity = lba + 1;
1494 sdkp->hw_sector_size = sector_size;
1495 return sector_size;
1498 static int sd_try_rc16_first(struct scsi_device *sdp)
1500 if (sdp->scsi_level > SCSI_SPC_2)
1501 return 1;
1502 if (scsi_device_protection(sdp))
1503 return 1;
1504 return 0;
1508 * read disk capacity
1510 static void
1511 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
1513 int sector_size;
1514 struct scsi_device *sdp = sdkp->device;
1515 sector_t old_capacity = sdkp->capacity;
1517 if (sd_try_rc16_first(sdp)) {
1518 sector_size = read_capacity_16(sdkp, sdp, buffer);
1519 if (sector_size == -EOVERFLOW)
1520 goto got_data;
1521 if (sector_size == -ENODEV)
1522 return;
1523 if (sector_size < 0)
1524 sector_size = read_capacity_10(sdkp, sdp, buffer);
1525 if (sector_size < 0)
1526 return;
1527 } else {
1528 sector_size = read_capacity_10(sdkp, sdp, buffer);
1529 if (sector_size == -EOVERFLOW)
1530 goto got_data;
1531 if (sector_size < 0)
1532 return;
1533 if ((sizeof(sdkp->capacity) > 4) &&
1534 (sdkp->capacity > 0xffffffffULL)) {
1535 int old_sector_size = sector_size;
1536 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
1537 "Trying to use READ CAPACITY(16).\n");
1538 sector_size = read_capacity_16(sdkp, sdp, buffer);
1539 if (sector_size < 0) {
1540 sd_printk(KERN_NOTICE, sdkp,
1541 "Using 0xffffffff as device size\n");
1542 sdkp->capacity = 1 + (sector_t) 0xffffffff;
1543 sector_size = old_sector_size;
1544 goto got_data;
1549 /* Some devices are known to return the total number of blocks,
1550 * not the highest block number. Some devices have versions
1551 * which do this and others which do not. Some devices we might
1552 * suspect of doing this but we don't know for certain.
1554 * If we know the reported capacity is wrong, decrement it. If
1555 * we can only guess, then assume the number of blocks is even
1556 * (usually true but not always) and err on the side of lowering
1557 * the capacity.
1559 if (sdp->fix_capacity ||
1560 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
1561 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
1562 "from its reported value: %llu\n",
1563 (unsigned long long) sdkp->capacity);
1564 --sdkp->capacity;
1567 got_data:
1568 if (sector_size == 0) {
1569 sector_size = 512;
1570 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
1571 "assuming 512.\n");
1574 if (sector_size != 512 &&
1575 sector_size != 1024 &&
1576 sector_size != 2048 &&
1577 sector_size != 4096 &&
1578 sector_size != 256) {
1579 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
1580 sector_size);
1582 * The user might want to re-format the drive with
1583 * a supported sectorsize. Once this happens, it
1584 * would be relatively trivial to set the thing up.
1585 * For this reason, we leave the thing in the table.
1587 sdkp->capacity = 0;
1589 * set a bogus sector size so the normal read/write
1590 * logic in the block layer will eventually refuse any
1591 * request on this device without tripping over power
1592 * of two sector size assumptions
1594 sector_size = 512;
1596 blk_queue_logical_block_size(sdp->request_queue, sector_size);
1599 char cap_str_2[10], cap_str_10[10];
1600 u64 sz = (u64)sdkp->capacity << ilog2(sector_size);
1602 string_get_size(sz, STRING_UNITS_2, cap_str_2,
1603 sizeof(cap_str_2));
1604 string_get_size(sz, STRING_UNITS_10, cap_str_10,
1605 sizeof(cap_str_10));
1607 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
1608 sd_printk(KERN_NOTICE, sdkp,
1609 "%llu %d-byte logical blocks: (%s/%s)\n",
1610 (unsigned long long)sdkp->capacity,
1611 sector_size, cap_str_10, cap_str_2);
1613 if (sdkp->hw_sector_size != sector_size)
1614 sd_printk(KERN_NOTICE, sdkp,
1615 "%u-byte physical blocks\n",
1616 sdkp->hw_sector_size);
1620 /* Rescale capacity to 512-byte units */
1621 if (sector_size == 4096)
1622 sdkp->capacity <<= 3;
1623 else if (sector_size == 2048)
1624 sdkp->capacity <<= 2;
1625 else if (sector_size == 1024)
1626 sdkp->capacity <<= 1;
1627 else if (sector_size == 256)
1628 sdkp->capacity >>= 1;
1630 blk_queue_physical_block_size(sdp->request_queue, sdkp->hw_sector_size);
1631 sdkp->device->sector_size = sector_size;
1634 /* called with buffer of length 512 */
1635 static inline int
1636 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
1637 unsigned char *buffer, int len, struct scsi_mode_data *data,
1638 struct scsi_sense_hdr *sshdr)
1640 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
1641 SD_TIMEOUT, SD_MAX_RETRIES, data,
1642 sshdr);
1646 * read write protect setting, if possible - called only in sd_revalidate_disk()
1647 * called with buffer of length SD_BUF_SIZE
1649 static void
1650 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
1652 int res;
1653 struct scsi_device *sdp = sdkp->device;
1654 struct scsi_mode_data data;
1655 int old_wp = sdkp->write_prot;
1657 set_disk_ro(sdkp->disk, 0);
1658 if (sdp->skip_ms_page_3f) {
1659 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
1660 return;
1663 if (sdp->use_192_bytes_for_3f) {
1664 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
1665 } else {
1667 * First attempt: ask for all pages (0x3F), but only 4 bytes.
1668 * We have to start carefully: some devices hang if we ask
1669 * for more than is available.
1671 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
1674 * Second attempt: ask for page 0 When only page 0 is
1675 * implemented, a request for page 3F may return Sense Key
1676 * 5: Illegal Request, Sense Code 24: Invalid field in
1677 * CDB.
1679 if (!scsi_status_is_good(res))
1680 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
1683 * Third attempt: ask 255 bytes, as we did earlier.
1685 if (!scsi_status_is_good(res))
1686 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
1687 &data, NULL);
1690 if (!scsi_status_is_good(res)) {
1691 sd_printk(KERN_WARNING, sdkp,
1692 "Test WP failed, assume Write Enabled\n");
1693 } else {
1694 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
1695 set_disk_ro(sdkp->disk, sdkp->write_prot);
1696 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
1697 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
1698 sdkp->write_prot ? "on" : "off");
1699 sd_printk(KERN_DEBUG, sdkp,
1700 "Mode Sense: %02x %02x %02x %02x\n",
1701 buffer[0], buffer[1], buffer[2], buffer[3]);
1707 * sd_read_cache_type - called only from sd_revalidate_disk()
1708 * called with buffer of length SD_BUF_SIZE
1710 static void
1711 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
1713 int len = 0, res;
1714 struct scsi_device *sdp = sdkp->device;
1716 int dbd;
1717 int modepage;
1718 struct scsi_mode_data data;
1719 struct scsi_sense_hdr sshdr;
1720 int old_wce = sdkp->WCE;
1721 int old_rcd = sdkp->RCD;
1722 int old_dpofua = sdkp->DPOFUA;
1724 if (sdp->skip_ms_page_8)
1725 goto defaults;
1727 if (sdp->type == TYPE_RBC) {
1728 modepage = 6;
1729 dbd = 8;
1730 } else {
1731 modepage = 8;
1732 dbd = 0;
1735 /* cautiously ask */
1736 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, 4, &data, &sshdr);
1738 if (!scsi_status_is_good(res))
1739 goto bad_sense;
1741 if (!data.header_length) {
1742 modepage = 6;
1743 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
1746 /* that went OK, now ask for the proper length */
1747 len = data.length;
1750 * We're only interested in the first three bytes, actually.
1751 * But the data cache page is defined for the first 20.
1753 if (len < 3)
1754 goto bad_sense;
1755 if (len > 20)
1756 len = 20;
1758 /* Take headers and block descriptors into account */
1759 len += data.header_length + data.block_descriptor_length;
1760 if (len > SD_BUF_SIZE)
1761 goto bad_sense;
1763 /* Get the data */
1764 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len, &data, &sshdr);
1766 if (scsi_status_is_good(res)) {
1767 int offset = data.header_length + data.block_descriptor_length;
1769 if (offset >= SD_BUF_SIZE - 2) {
1770 sd_printk(KERN_ERR, sdkp, "Malformed MODE SENSE response\n");
1771 goto defaults;
1774 if ((buffer[offset] & 0x3f) != modepage) {
1775 sd_printk(KERN_ERR, sdkp, "Got wrong page\n");
1776 goto defaults;
1779 if (modepage == 8) {
1780 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
1781 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
1782 } else {
1783 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
1784 sdkp->RCD = 0;
1787 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
1788 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
1789 sd_printk(KERN_NOTICE, sdkp,
1790 "Uses READ/WRITE(6), disabling FUA\n");
1791 sdkp->DPOFUA = 0;
1794 if (sdkp->first_scan || old_wce != sdkp->WCE ||
1795 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
1796 sd_printk(KERN_NOTICE, sdkp,
1797 "Write cache: %s, read cache: %s, %s\n",
1798 sdkp->WCE ? "enabled" : "disabled",
1799 sdkp->RCD ? "disabled" : "enabled",
1800 sdkp->DPOFUA ? "supports DPO and FUA"
1801 : "doesn't support DPO or FUA");
1803 return;
1806 bad_sense:
1807 if (scsi_sense_valid(&sshdr) &&
1808 sshdr.sense_key == ILLEGAL_REQUEST &&
1809 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
1810 /* Invalid field in CDB */
1811 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
1812 else
1813 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
1815 defaults:
1816 sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
1817 sdkp->WCE = 0;
1818 sdkp->RCD = 0;
1819 sdkp->DPOFUA = 0;
1823 * The ATO bit indicates whether the DIF application tag is available
1824 * for use by the operating system.
1826 void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
1828 int res, offset;
1829 struct scsi_device *sdp = sdkp->device;
1830 struct scsi_mode_data data;
1831 struct scsi_sense_hdr sshdr;
1833 if (sdp->type != TYPE_DISK)
1834 return;
1836 if (sdkp->protection_type == 0)
1837 return;
1839 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
1840 SD_MAX_RETRIES, &data, &sshdr);
1842 if (!scsi_status_is_good(res) || !data.header_length ||
1843 data.length < 6) {
1844 sd_printk(KERN_WARNING, sdkp,
1845 "getting Control mode page failed, assume no ATO\n");
1847 if (scsi_sense_valid(&sshdr))
1848 sd_print_sense_hdr(sdkp, &sshdr);
1850 return;
1853 offset = data.header_length + data.block_descriptor_length;
1855 if ((buffer[offset] & 0x3f) != 0x0a) {
1856 sd_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
1857 return;
1860 if ((buffer[offset + 5] & 0x80) == 0)
1861 return;
1863 sdkp->ATO = 1;
1865 return;
1869 * sd_read_block_limits - Query disk device for preferred I/O sizes.
1870 * @disk: disk to query
1872 static void sd_read_block_limits(struct scsi_disk *sdkp)
1874 unsigned int sector_sz = sdkp->device->sector_size;
1875 char *buffer;
1877 /* Block Limits VPD */
1878 buffer = scsi_get_vpd_page(sdkp->device, 0xb0);
1880 if (buffer == NULL)
1881 return;
1883 blk_queue_io_min(sdkp->disk->queue,
1884 get_unaligned_be16(&buffer[6]) * sector_sz);
1885 blk_queue_io_opt(sdkp->disk->queue,
1886 get_unaligned_be32(&buffer[12]) * sector_sz);
1888 kfree(buffer);
1892 * sd_read_block_characteristics - Query block dev. characteristics
1893 * @disk: disk to query
1895 static void sd_read_block_characteristics(struct scsi_disk *sdkp)
1897 char *buffer;
1898 u16 rot;
1900 /* Block Device Characteristics VPD */
1901 buffer = scsi_get_vpd_page(sdkp->device, 0xb1);
1903 if (buffer == NULL)
1904 return;
1906 rot = get_unaligned_be16(&buffer[4]);
1908 if (rot == 1)
1909 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, sdkp->disk->queue);
1911 kfree(buffer);
1914 static int sd_try_extended_inquiry(struct scsi_device *sdp)
1917 * Although VPD inquiries can go to SCSI-2 type devices,
1918 * some USB ones crash on receiving them, and the pages
1919 * we currently ask for are for SPC-3 and beyond
1921 if (sdp->scsi_level > SCSI_SPC_2)
1922 return 1;
1923 return 0;
1927 * sd_revalidate_disk - called the first time a new disk is seen,
1928 * performs disk spin up, read_capacity, etc.
1929 * @disk: struct gendisk we care about
1931 static int sd_revalidate_disk(struct gendisk *disk)
1933 struct scsi_disk *sdkp = scsi_disk(disk);
1934 struct scsi_device *sdp = sdkp->device;
1935 unsigned char *buffer;
1936 unsigned ordered;
1938 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
1939 "sd_revalidate_disk\n"));
1942 * If the device is offline, don't try and read capacity or any
1943 * of the other niceties.
1945 if (!scsi_device_online(sdp))
1946 goto out;
1948 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
1949 if (!buffer) {
1950 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
1951 "allocation failure.\n");
1952 goto out;
1955 sd_spinup_disk(sdkp);
1958 * Without media there is no reason to ask; moreover, some devices
1959 * react badly if we do.
1961 if (sdkp->media_present) {
1962 sd_read_capacity(sdkp, buffer);
1964 if (sd_try_extended_inquiry(sdp)) {
1965 sd_read_block_limits(sdkp);
1966 sd_read_block_characteristics(sdkp);
1969 sd_read_write_protect_flag(sdkp, buffer);
1970 sd_read_cache_type(sdkp, buffer);
1971 sd_read_app_tag_own(sdkp, buffer);
1974 sdkp->first_scan = 0;
1977 * We now have all cache related info, determine how we deal
1978 * with ordered requests. Note that as the current SCSI
1979 * dispatch function can alter request order, we cannot use
1980 * QUEUE_ORDERED_TAG_* even when ordered tag is supported.
1982 if (sdkp->WCE)
1983 ordered = sdkp->DPOFUA
1984 ? QUEUE_ORDERED_DRAIN_FUA : QUEUE_ORDERED_DRAIN_FLUSH;
1985 else
1986 ordered = QUEUE_ORDERED_DRAIN;
1988 blk_queue_ordered(sdkp->disk->queue, ordered, sd_prepare_flush);
1990 set_capacity(disk, sdkp->capacity);
1991 kfree(buffer);
1993 out:
1994 return 0;
1998 * sd_format_disk_name - format disk name
1999 * @prefix: name prefix - ie. "sd" for SCSI disks
2000 * @index: index of the disk to format name for
2001 * @buf: output buffer
2002 * @buflen: length of the output buffer
2004 * SCSI disk names starts at sda. The 26th device is sdz and the
2005 * 27th is sdaa. The last one for two lettered suffix is sdzz
2006 * which is followed by sdaaa.
2008 * This is basically 26 base counting with one extra 'nil' entry
2009 * at the beggining from the second digit on and can be
2010 * determined using similar method as 26 base conversion with the
2011 * index shifted -1 after each digit is computed.
2013 * CONTEXT:
2014 * Don't care.
2016 * RETURNS:
2017 * 0 on success, -errno on failure.
2019 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
2021 const int base = 'z' - 'a' + 1;
2022 char *begin = buf + strlen(prefix);
2023 char *end = buf + buflen;
2024 char *p;
2025 int unit;
2027 p = end - 1;
2028 *p = '\0';
2029 unit = base;
2030 do {
2031 if (p == begin)
2032 return -EINVAL;
2033 *--p = 'a' + (index % unit);
2034 index = (index / unit) - 1;
2035 } while (index >= 0);
2037 memmove(begin, p, end - p);
2038 memcpy(buf, prefix, strlen(prefix));
2040 return 0;
2044 * The asynchronous part of sd_probe
2046 static void sd_probe_async(void *data, async_cookie_t cookie)
2048 struct scsi_disk *sdkp = data;
2049 struct scsi_device *sdp;
2050 struct gendisk *gd;
2051 u32 index;
2052 struct device *dev;
2054 sdp = sdkp->device;
2055 gd = sdkp->disk;
2056 index = sdkp->index;
2057 dev = &sdp->sdev_gendev;
2059 gd->major = sd_major((index & 0xf0) >> 4);
2060 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
2061 gd->minors = SD_MINORS;
2063 gd->fops = &sd_fops;
2064 gd->private_data = &sdkp->driver;
2065 gd->queue = sdkp->device->request_queue;
2067 /* defaults, until the device tells us otherwise */
2068 sdp->sector_size = 512;
2069 sdkp->capacity = 0;
2070 sdkp->media_present = 1;
2071 sdkp->write_prot = 0;
2072 sdkp->WCE = 0;
2073 sdkp->RCD = 0;
2074 sdkp->ATO = 0;
2075 sdkp->first_scan = 1;
2077 sd_revalidate_disk(gd);
2079 blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
2081 gd->driverfs_dev = &sdp->sdev_gendev;
2082 gd->flags = GENHD_FL_EXT_DEVT | GENHD_FL_DRIVERFS;
2083 if (sdp->removable)
2084 gd->flags |= GENHD_FL_REMOVABLE;
2086 dev_set_drvdata(dev, sdkp);
2087 add_disk(gd);
2088 sd_dif_config_host(sdkp);
2090 sd_revalidate_disk(gd);
2092 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
2093 sdp->removable ? "removable " : "");
2094 put_device(&sdkp->dev);
2098 * sd_probe - called during driver initialization and whenever a
2099 * new scsi device is attached to the system. It is called once
2100 * for each scsi device (not just disks) present.
2101 * @dev: pointer to device object
2103 * Returns 0 if successful (or not interested in this scsi device
2104 * (e.g. scanner)); 1 when there is an error.
2106 * Note: this function is invoked from the scsi mid-level.
2107 * This function sets up the mapping between a given
2108 * <host,channel,id,lun> (found in sdp) and new device name
2109 * (e.g. /dev/sda). More precisely it is the block device major
2110 * and minor number that is chosen here.
2112 * Assume sd_attach is not re-entrant (for time being)
2113 * Also think about sd_attach() and sd_remove() running coincidentally.
2115 static int sd_probe(struct device *dev)
2117 struct scsi_device *sdp = to_scsi_device(dev);
2118 struct scsi_disk *sdkp;
2119 struct gendisk *gd;
2120 u32 index;
2121 int error;
2123 error = -ENODEV;
2124 if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
2125 goto out;
2127 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
2128 "sd_attach\n"));
2130 error = -ENOMEM;
2131 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
2132 if (!sdkp)
2133 goto out;
2135 gd = alloc_disk(SD_MINORS);
2136 if (!gd)
2137 goto out_free;
2139 do {
2140 if (!ida_pre_get(&sd_index_ida, GFP_KERNEL))
2141 goto out_put;
2143 spin_lock(&sd_index_lock);
2144 error = ida_get_new(&sd_index_ida, &index);
2145 spin_unlock(&sd_index_lock);
2146 } while (error == -EAGAIN);
2148 if (error)
2149 goto out_put;
2151 if (index >= SD_MAX_DISKS) {
2152 error = -ENODEV;
2153 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name space exhausted.\n");
2154 goto out_free_index;
2157 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
2158 if (error)
2159 goto out_free_index;
2161 sdkp->device = sdp;
2162 sdkp->driver = &sd_template;
2163 sdkp->disk = gd;
2164 sdkp->index = index;
2165 sdkp->openers = 0;
2166 sdkp->previous_state = 1;
2168 if (!sdp->request_queue->rq_timeout) {
2169 if (sdp->type != TYPE_MOD)
2170 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
2171 else
2172 blk_queue_rq_timeout(sdp->request_queue,
2173 SD_MOD_TIMEOUT);
2176 device_initialize(&sdkp->dev);
2177 sdkp->dev.parent = &sdp->sdev_gendev;
2178 sdkp->dev.class = &sd_disk_class;
2179 dev_set_name(&sdkp->dev, dev_name(&sdp->sdev_gendev));
2181 if (device_add(&sdkp->dev))
2182 goto out_free_index;
2184 get_device(&sdp->sdev_gendev);
2186 get_device(&sdkp->dev); /* prevent release before async_schedule */
2187 async_schedule(sd_probe_async, sdkp);
2189 return 0;
2191 out_free_index:
2192 spin_lock(&sd_index_lock);
2193 ida_remove(&sd_index_ida, index);
2194 spin_unlock(&sd_index_lock);
2195 out_put:
2196 put_disk(gd);
2197 out_free:
2198 kfree(sdkp);
2199 out:
2200 return error;
2204 * sd_remove - called whenever a scsi disk (previously recognized by
2205 * sd_probe) is detached from the system. It is called (potentially
2206 * multiple times) during sd module unload.
2207 * @sdp: pointer to mid level scsi device object
2209 * Note: this function is invoked from the scsi mid-level.
2210 * This function potentially frees up a device name (e.g. /dev/sdc)
2211 * that could be re-used by a subsequent sd_probe().
2212 * This function is not called when the built-in sd driver is "exit-ed".
2214 static int sd_remove(struct device *dev)
2216 struct scsi_disk *sdkp;
2218 async_synchronize_full();
2219 sdkp = dev_get_drvdata(dev);
2220 blk_queue_prep_rq(sdkp->device->request_queue, scsi_prep_fn);
2221 device_del(&sdkp->dev);
2222 del_gendisk(sdkp->disk);
2223 sd_shutdown(dev);
2225 mutex_lock(&sd_ref_mutex);
2226 dev_set_drvdata(dev, NULL);
2227 put_device(&sdkp->dev);
2228 mutex_unlock(&sd_ref_mutex);
2230 return 0;
2234 * scsi_disk_release - Called to free the scsi_disk structure
2235 * @dev: pointer to embedded class device
2237 * sd_ref_mutex must be held entering this routine. Because it is
2238 * called on last put, you should always use the scsi_disk_get()
2239 * scsi_disk_put() helpers which manipulate the semaphore directly
2240 * and never do a direct put_device.
2242 static void scsi_disk_release(struct device *dev)
2244 struct scsi_disk *sdkp = to_scsi_disk(dev);
2245 struct gendisk *disk = sdkp->disk;
2247 spin_lock(&sd_index_lock);
2248 ida_remove(&sd_index_ida, sdkp->index);
2249 spin_unlock(&sd_index_lock);
2251 disk->private_data = NULL;
2252 put_disk(disk);
2253 put_device(&sdkp->device->sdev_gendev);
2255 kfree(sdkp);
2258 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
2260 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
2261 struct scsi_sense_hdr sshdr;
2262 struct scsi_device *sdp = sdkp->device;
2263 int res;
2265 if (start)
2266 cmd[4] |= 1; /* START */
2268 if (sdp->start_stop_pwr_cond)
2269 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
2271 if (!scsi_device_online(sdp))
2272 return -ENODEV;
2274 res = scsi_execute_req(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
2275 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2276 if (res) {
2277 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
2278 sd_print_result(sdkp, res);
2279 if (driver_byte(res) & DRIVER_SENSE)
2280 sd_print_sense_hdr(sdkp, &sshdr);
2283 return res;
2287 * Send a SYNCHRONIZE CACHE instruction down to the device through
2288 * the normal SCSI command structure. Wait for the command to
2289 * complete.
2291 static void sd_shutdown(struct device *dev)
2293 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2295 if (!sdkp)
2296 return; /* this can happen */
2298 if (sdkp->WCE) {
2299 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2300 sd_sync_cache(sdkp);
2303 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
2304 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2305 sd_start_stop_device(sdkp, 0);
2308 scsi_disk_put(sdkp);
2311 static int sd_suspend(struct device *dev, pm_message_t mesg)
2313 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2314 int ret = 0;
2316 if (!sdkp)
2317 return 0; /* this can happen */
2319 if (sdkp->WCE) {
2320 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
2321 ret = sd_sync_cache(sdkp);
2322 if (ret)
2323 goto done;
2326 if ((mesg.event & PM_EVENT_SLEEP) && sdkp->device->manage_start_stop) {
2327 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
2328 ret = sd_start_stop_device(sdkp, 0);
2331 done:
2332 scsi_disk_put(sdkp);
2333 return ret;
2336 static int sd_resume(struct device *dev)
2338 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
2339 int ret = 0;
2341 if (!sdkp->device->manage_start_stop)
2342 goto done;
2344 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
2345 ret = sd_start_stop_device(sdkp, 1);
2347 done:
2348 scsi_disk_put(sdkp);
2349 return ret;
2353 * init_sd - entry point for this driver (both when built in or when
2354 * a module).
2356 * Note: this function registers this driver with the scsi mid-level.
2358 static int __init init_sd(void)
2360 int majors = 0, i, err;
2362 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
2364 for (i = 0; i < SD_MAJORS; i++)
2365 if (register_blkdev(sd_major(i), "sd") == 0)
2366 majors++;
2368 if (!majors)
2369 return -ENODEV;
2371 err = class_register(&sd_disk_class);
2372 if (err)
2373 goto err_out;
2375 err = scsi_register_driver(&sd_template.gendrv);
2376 if (err)
2377 goto err_out_class;
2379 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
2380 0, 0, NULL);
2381 if (!sd_cdb_cache) {
2382 printk(KERN_ERR "sd: can't init extended cdb cache\n");
2383 goto err_out_class;
2386 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
2387 if (!sd_cdb_pool) {
2388 printk(KERN_ERR "sd: can't init extended cdb pool\n");
2389 goto err_out_cache;
2392 return 0;
2394 err_out_cache:
2395 kmem_cache_destroy(sd_cdb_cache);
2397 err_out_class:
2398 class_unregister(&sd_disk_class);
2399 err_out:
2400 for (i = 0; i < SD_MAJORS; i++)
2401 unregister_blkdev(sd_major(i), "sd");
2402 return err;
2406 * exit_sd - exit point for this driver (when it is a module).
2408 * Note: this function unregisters this driver from the scsi mid-level.
2410 static void __exit exit_sd(void)
2412 int i;
2414 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
2416 mempool_destroy(sd_cdb_pool);
2417 kmem_cache_destroy(sd_cdb_cache);
2419 scsi_unregister_driver(&sd_template.gendrv);
2420 class_unregister(&sd_disk_class);
2422 for (i = 0; i < SD_MAJORS; i++)
2423 unregister_blkdev(sd_major(i), "sd");
2426 module_init(init_sd);
2427 module_exit(exit_sd);
2429 static void sd_print_sense_hdr(struct scsi_disk *sdkp,
2430 struct scsi_sense_hdr *sshdr)
2432 sd_printk(KERN_INFO, sdkp, "");
2433 scsi_show_sense_hdr(sshdr);
2434 sd_printk(KERN_INFO, sdkp, "");
2435 scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
2438 static void sd_print_result(struct scsi_disk *sdkp, int result)
2440 sd_printk(KERN_INFO, sdkp, "");
2441 scsi_show_result(result);