PM / sleep: Asynchronous threads for suspend_noirq
[linux/fpc-iii.git] / drivers / scsi / sd.c
blob470954aba7289a758a650cd82b2f1dfe50ae54f1
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 <linux/slab.h>
53 #include <linux/pm_runtime.h>
54 #include <asm/uaccess.h>
55 #include <asm/unaligned.h>
57 #include <scsi/scsi.h>
58 #include <scsi/scsi_cmnd.h>
59 #include <scsi/scsi_dbg.h>
60 #include <scsi/scsi_device.h>
61 #include <scsi/scsi_driver.h>
62 #include <scsi/scsi_eh.h>
63 #include <scsi/scsi_host.h>
64 #include <scsi/scsi_ioctl.h>
65 #include <scsi/scsicam.h>
67 #include "sd.h"
68 #include "scsi_priv.h"
69 #include "scsi_logging.h"
71 MODULE_AUTHOR("Eric Youngdale");
72 MODULE_DESCRIPTION("SCSI disk (sd) driver");
73 MODULE_LICENSE("GPL");
75 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
76 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
77 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
78 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
79 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
85 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
86 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
87 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
88 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
89 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
90 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
91 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
92 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
93 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
95 #if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
96 #define SD_MINORS 16
97 #else
98 #define SD_MINORS 0
99 #endif
101 static void sd_config_discard(struct scsi_disk *, unsigned int);
102 static void sd_config_write_same(struct scsi_disk *);
103 static int sd_revalidate_disk(struct gendisk *);
104 static void sd_unlock_native_capacity(struct gendisk *disk);
105 static int sd_probe(struct device *);
106 static int sd_remove(struct device *);
107 static void sd_shutdown(struct device *);
108 static int sd_suspend_system(struct device *);
109 static int sd_suspend_runtime(struct device *);
110 static int sd_resume(struct device *);
111 static void sd_rescan(struct device *);
112 static int sd_done(struct scsi_cmnd *);
113 static int sd_eh_action(struct scsi_cmnd *, int);
114 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
115 static void scsi_disk_release(struct device *cdev);
116 static void sd_print_sense_hdr(struct scsi_disk *, struct scsi_sense_hdr *);
117 static void sd_print_result(struct scsi_disk *, int);
119 static DEFINE_SPINLOCK(sd_index_lock);
120 static DEFINE_IDA(sd_index_ida);
122 /* This semaphore is used to mediate the 0->1 reference get in the
123 * face of object destruction (i.e. we can't allow a get on an
124 * object after last put) */
125 static DEFINE_MUTEX(sd_ref_mutex);
127 static struct kmem_cache *sd_cdb_cache;
128 static mempool_t *sd_cdb_pool;
130 static const char *sd_cache_types[] = {
131 "write through", "none", "write back",
132 "write back, no read (daft)"
135 static ssize_t
136 cache_type_store(struct device *dev, struct device_attribute *attr,
137 const char *buf, size_t count)
139 int i, ct = -1, rcd, wce, sp;
140 struct scsi_disk *sdkp = to_scsi_disk(dev);
141 struct scsi_device *sdp = sdkp->device;
142 char buffer[64];
143 char *buffer_data;
144 struct scsi_mode_data data;
145 struct scsi_sense_hdr sshdr;
146 static const char temp[] = "temporary ";
147 int len;
149 if (sdp->type != TYPE_DISK)
150 /* no cache control on RBC devices; theoretically they
151 * can do it, but there's probably so many exceptions
152 * it's not worth the risk */
153 return -EINVAL;
155 if (strncmp(buf, temp, sizeof(temp) - 1) == 0) {
156 buf += sizeof(temp) - 1;
157 sdkp->cache_override = 1;
158 } else {
159 sdkp->cache_override = 0;
162 for (i = 0; i < ARRAY_SIZE(sd_cache_types); i++) {
163 len = strlen(sd_cache_types[i]);
164 if (strncmp(sd_cache_types[i], buf, len) == 0 &&
165 buf[len] == '\n') {
166 ct = i;
167 break;
170 if (ct < 0)
171 return -EINVAL;
172 rcd = ct & 0x01 ? 1 : 0;
173 wce = ct & 0x02 ? 1 : 0;
175 if (sdkp->cache_override) {
176 sdkp->WCE = wce;
177 sdkp->RCD = rcd;
178 return count;
181 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
182 SD_MAX_RETRIES, &data, NULL))
183 return -EINVAL;
184 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
185 data.block_descriptor_length);
186 buffer_data = buffer + data.header_length +
187 data.block_descriptor_length;
188 buffer_data[2] &= ~0x05;
189 buffer_data[2] |= wce << 2 | rcd;
190 sp = buffer_data[0] & 0x80 ? 1 : 0;
192 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
193 SD_MAX_RETRIES, &data, &sshdr)) {
194 if (scsi_sense_valid(&sshdr))
195 sd_print_sense_hdr(sdkp, &sshdr);
196 return -EINVAL;
198 revalidate_disk(sdkp->disk);
199 return count;
202 static ssize_t
203 manage_start_stop_show(struct device *dev, struct device_attribute *attr,
204 char *buf)
206 struct scsi_disk *sdkp = to_scsi_disk(dev);
207 struct scsi_device *sdp = sdkp->device;
209 return snprintf(buf, 20, "%u\n", sdp->manage_start_stop);
212 static ssize_t
213 manage_start_stop_store(struct device *dev, struct device_attribute *attr,
214 const char *buf, size_t count)
216 struct scsi_disk *sdkp = to_scsi_disk(dev);
217 struct scsi_device *sdp = sdkp->device;
219 if (!capable(CAP_SYS_ADMIN))
220 return -EACCES;
222 sdp->manage_start_stop = simple_strtoul(buf, NULL, 10);
224 return count;
226 static DEVICE_ATTR_RW(manage_start_stop);
228 static ssize_t
229 allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
231 struct scsi_disk *sdkp = to_scsi_disk(dev);
233 return snprintf(buf, 40, "%d\n", sdkp->device->allow_restart);
236 static ssize_t
237 allow_restart_store(struct device *dev, struct device_attribute *attr,
238 const char *buf, size_t count)
240 struct scsi_disk *sdkp = to_scsi_disk(dev);
241 struct scsi_device *sdp = sdkp->device;
243 if (!capable(CAP_SYS_ADMIN))
244 return -EACCES;
246 if (sdp->type != TYPE_DISK)
247 return -EINVAL;
249 sdp->allow_restart = simple_strtoul(buf, NULL, 10);
251 return count;
253 static DEVICE_ATTR_RW(allow_restart);
255 static ssize_t
256 cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
258 struct scsi_disk *sdkp = to_scsi_disk(dev);
259 int ct = sdkp->RCD + 2*sdkp->WCE;
261 return snprintf(buf, 40, "%s\n", sd_cache_types[ct]);
263 static DEVICE_ATTR_RW(cache_type);
265 static ssize_t
266 FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
268 struct scsi_disk *sdkp = to_scsi_disk(dev);
270 return snprintf(buf, 20, "%u\n", sdkp->DPOFUA);
272 static DEVICE_ATTR_RO(FUA);
274 static ssize_t
275 protection_type_show(struct device *dev, struct device_attribute *attr,
276 char *buf)
278 struct scsi_disk *sdkp = to_scsi_disk(dev);
280 return snprintf(buf, 20, "%u\n", sdkp->protection_type);
283 static ssize_t
284 protection_type_store(struct device *dev, struct device_attribute *attr,
285 const char *buf, size_t count)
287 struct scsi_disk *sdkp = to_scsi_disk(dev);
288 unsigned int val;
289 int err;
291 if (!capable(CAP_SYS_ADMIN))
292 return -EACCES;
294 err = kstrtouint(buf, 10, &val);
296 if (err)
297 return err;
299 if (val >= 0 && val <= SD_DIF_TYPE3_PROTECTION)
300 sdkp->protection_type = val;
302 return count;
304 static DEVICE_ATTR_RW(protection_type);
306 static ssize_t
307 protection_mode_show(struct device *dev, struct device_attribute *attr,
308 char *buf)
310 struct scsi_disk *sdkp = to_scsi_disk(dev);
311 struct scsi_device *sdp = sdkp->device;
312 unsigned int dif, dix;
314 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
315 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
317 if (!dix && scsi_host_dix_capable(sdp->host, SD_DIF_TYPE0_PROTECTION)) {
318 dif = 0;
319 dix = 1;
322 if (!dif && !dix)
323 return snprintf(buf, 20, "none\n");
325 return snprintf(buf, 20, "%s%u\n", dix ? "dix" : "dif", dif);
327 static DEVICE_ATTR_RO(protection_mode);
329 static ssize_t
330 app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
332 struct scsi_disk *sdkp = to_scsi_disk(dev);
334 return snprintf(buf, 20, "%u\n", sdkp->ATO);
336 static DEVICE_ATTR_RO(app_tag_own);
338 static ssize_t
339 thin_provisioning_show(struct device *dev, struct device_attribute *attr,
340 char *buf)
342 struct scsi_disk *sdkp = to_scsi_disk(dev);
344 return snprintf(buf, 20, "%u\n", sdkp->lbpme);
346 static DEVICE_ATTR_RO(thin_provisioning);
348 static const char *lbp_mode[] = {
349 [SD_LBP_FULL] = "full",
350 [SD_LBP_UNMAP] = "unmap",
351 [SD_LBP_WS16] = "writesame_16",
352 [SD_LBP_WS10] = "writesame_10",
353 [SD_LBP_ZERO] = "writesame_zero",
354 [SD_LBP_DISABLE] = "disabled",
357 static ssize_t
358 provisioning_mode_show(struct device *dev, struct device_attribute *attr,
359 char *buf)
361 struct scsi_disk *sdkp = to_scsi_disk(dev);
363 return snprintf(buf, 20, "%s\n", lbp_mode[sdkp->provisioning_mode]);
366 static ssize_t
367 provisioning_mode_store(struct device *dev, struct device_attribute *attr,
368 const char *buf, size_t count)
370 struct scsi_disk *sdkp = to_scsi_disk(dev);
371 struct scsi_device *sdp = sdkp->device;
373 if (!capable(CAP_SYS_ADMIN))
374 return -EACCES;
376 if (sdp->type != TYPE_DISK)
377 return -EINVAL;
379 if (!strncmp(buf, lbp_mode[SD_LBP_UNMAP], 20))
380 sd_config_discard(sdkp, SD_LBP_UNMAP);
381 else if (!strncmp(buf, lbp_mode[SD_LBP_WS16], 20))
382 sd_config_discard(sdkp, SD_LBP_WS16);
383 else if (!strncmp(buf, lbp_mode[SD_LBP_WS10], 20))
384 sd_config_discard(sdkp, SD_LBP_WS10);
385 else if (!strncmp(buf, lbp_mode[SD_LBP_ZERO], 20))
386 sd_config_discard(sdkp, SD_LBP_ZERO);
387 else if (!strncmp(buf, lbp_mode[SD_LBP_DISABLE], 20))
388 sd_config_discard(sdkp, SD_LBP_DISABLE);
389 else
390 return -EINVAL;
392 return count;
394 static DEVICE_ATTR_RW(provisioning_mode);
396 static ssize_t
397 max_medium_access_timeouts_show(struct device *dev,
398 struct device_attribute *attr, char *buf)
400 struct scsi_disk *sdkp = to_scsi_disk(dev);
402 return snprintf(buf, 20, "%u\n", sdkp->max_medium_access_timeouts);
405 static ssize_t
406 max_medium_access_timeouts_store(struct device *dev,
407 struct device_attribute *attr, const char *buf,
408 size_t count)
410 struct scsi_disk *sdkp = to_scsi_disk(dev);
411 int err;
413 if (!capable(CAP_SYS_ADMIN))
414 return -EACCES;
416 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
418 return err ? err : count;
420 static DEVICE_ATTR_RW(max_medium_access_timeouts);
422 static ssize_t
423 max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
424 char *buf)
426 struct scsi_disk *sdkp = to_scsi_disk(dev);
428 return snprintf(buf, 20, "%u\n", sdkp->max_ws_blocks);
431 static ssize_t
432 max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
433 const char *buf, size_t count)
435 struct scsi_disk *sdkp = to_scsi_disk(dev);
436 struct scsi_device *sdp = sdkp->device;
437 unsigned long max;
438 int err;
440 if (!capable(CAP_SYS_ADMIN))
441 return -EACCES;
443 if (sdp->type != TYPE_DISK)
444 return -EINVAL;
446 err = kstrtoul(buf, 10, &max);
448 if (err)
449 return err;
451 if (max == 0)
452 sdp->no_write_same = 1;
453 else if (max <= SD_MAX_WS16_BLOCKS) {
454 sdp->no_write_same = 0;
455 sdkp->max_ws_blocks = max;
458 sd_config_write_same(sdkp);
460 return count;
462 static DEVICE_ATTR_RW(max_write_same_blocks);
464 static struct attribute *sd_disk_attrs[] = {
465 &dev_attr_cache_type.attr,
466 &dev_attr_FUA.attr,
467 &dev_attr_allow_restart.attr,
468 &dev_attr_manage_start_stop.attr,
469 &dev_attr_protection_type.attr,
470 &dev_attr_protection_mode.attr,
471 &dev_attr_app_tag_own.attr,
472 &dev_attr_thin_provisioning.attr,
473 &dev_attr_provisioning_mode.attr,
474 &dev_attr_max_write_same_blocks.attr,
475 &dev_attr_max_medium_access_timeouts.attr,
476 NULL,
478 ATTRIBUTE_GROUPS(sd_disk);
480 static struct class sd_disk_class = {
481 .name = "scsi_disk",
482 .owner = THIS_MODULE,
483 .dev_release = scsi_disk_release,
484 .dev_groups = sd_disk_groups,
487 static const struct dev_pm_ops sd_pm_ops = {
488 .suspend = sd_suspend_system,
489 .resume = sd_resume,
490 .poweroff = sd_suspend_system,
491 .restore = sd_resume,
492 .runtime_suspend = sd_suspend_runtime,
493 .runtime_resume = sd_resume,
496 static struct scsi_driver sd_template = {
497 .owner = THIS_MODULE,
498 .gendrv = {
499 .name = "sd",
500 .probe = sd_probe,
501 .remove = sd_remove,
502 .shutdown = sd_shutdown,
503 .pm = &sd_pm_ops,
505 .rescan = sd_rescan,
506 .done = sd_done,
507 .eh_action = sd_eh_action,
511 * Dummy kobj_map->probe function.
512 * The default ->probe function will call modprobe, which is
513 * pointless as this module is already loaded.
515 static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
517 return NULL;
521 * Device no to disk mapping:
523 * major disc2 disc p1
524 * |............|.............|....|....| <- dev_t
525 * 31 20 19 8 7 4 3 0
527 * Inside a major, we have 16k disks, however mapped non-
528 * contiguously. The first 16 disks are for major0, the next
529 * ones with major1, ... Disk 256 is for major0 again, disk 272
530 * for major1, ...
531 * As we stay compatible with our numbering scheme, we can reuse
532 * the well-know SCSI majors 8, 65--71, 136--143.
534 static int sd_major(int major_idx)
536 switch (major_idx) {
537 case 0:
538 return SCSI_DISK0_MAJOR;
539 case 1 ... 7:
540 return SCSI_DISK1_MAJOR + major_idx - 1;
541 case 8 ... 15:
542 return SCSI_DISK8_MAJOR + major_idx - 8;
543 default:
544 BUG();
545 return 0; /* shut up gcc */
549 static struct scsi_disk *__scsi_disk_get(struct gendisk *disk)
551 struct scsi_disk *sdkp = NULL;
553 if (disk->private_data) {
554 sdkp = scsi_disk(disk);
555 if (scsi_device_get(sdkp->device) == 0)
556 get_device(&sdkp->dev);
557 else
558 sdkp = NULL;
560 return sdkp;
563 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
565 struct scsi_disk *sdkp;
567 mutex_lock(&sd_ref_mutex);
568 sdkp = __scsi_disk_get(disk);
569 mutex_unlock(&sd_ref_mutex);
570 return sdkp;
573 static struct scsi_disk *scsi_disk_get_from_dev(struct device *dev)
575 struct scsi_disk *sdkp;
577 mutex_lock(&sd_ref_mutex);
578 sdkp = dev_get_drvdata(dev);
579 if (sdkp)
580 sdkp = __scsi_disk_get(sdkp->disk);
581 mutex_unlock(&sd_ref_mutex);
582 return sdkp;
585 static void scsi_disk_put(struct scsi_disk *sdkp)
587 struct scsi_device *sdev = sdkp->device;
589 mutex_lock(&sd_ref_mutex);
590 put_device(&sdkp->dev);
591 scsi_device_put(sdev);
592 mutex_unlock(&sd_ref_mutex);
595 static void sd_prot_op(struct scsi_cmnd *scmd, unsigned int dif)
597 unsigned int prot_op = SCSI_PROT_NORMAL;
598 unsigned int dix = scsi_prot_sg_count(scmd);
600 if (scmd->sc_data_direction == DMA_FROM_DEVICE) {
601 if (dif && dix)
602 prot_op = SCSI_PROT_READ_PASS;
603 else if (dif && !dix)
604 prot_op = SCSI_PROT_READ_STRIP;
605 else if (!dif && dix)
606 prot_op = SCSI_PROT_READ_INSERT;
607 } else {
608 if (dif && dix)
609 prot_op = SCSI_PROT_WRITE_PASS;
610 else if (dif && !dix)
611 prot_op = SCSI_PROT_WRITE_INSERT;
612 else if (!dif && dix)
613 prot_op = SCSI_PROT_WRITE_STRIP;
616 scsi_set_prot_op(scmd, prot_op);
617 scsi_set_prot_type(scmd, dif);
620 static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
622 struct request_queue *q = sdkp->disk->queue;
623 unsigned int logical_block_size = sdkp->device->sector_size;
624 unsigned int max_blocks = 0;
626 q->limits.discard_zeroes_data = sdkp->lbprz;
627 q->limits.discard_alignment = sdkp->unmap_alignment *
628 logical_block_size;
629 q->limits.discard_granularity =
630 max(sdkp->physical_block_size,
631 sdkp->unmap_granularity * logical_block_size);
633 sdkp->provisioning_mode = mode;
635 switch (mode) {
637 case SD_LBP_DISABLE:
638 q->limits.max_discard_sectors = 0;
639 queue_flag_clear_unlocked(QUEUE_FLAG_DISCARD, q);
640 return;
642 case SD_LBP_UNMAP:
643 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
644 (u32)SD_MAX_WS16_BLOCKS);
645 break;
647 case SD_LBP_WS16:
648 max_blocks = min_not_zero(sdkp->max_ws_blocks,
649 (u32)SD_MAX_WS16_BLOCKS);
650 break;
652 case SD_LBP_WS10:
653 max_blocks = min_not_zero(sdkp->max_ws_blocks,
654 (u32)SD_MAX_WS10_BLOCKS);
655 break;
657 case SD_LBP_ZERO:
658 max_blocks = min_not_zero(sdkp->max_ws_blocks,
659 (u32)SD_MAX_WS10_BLOCKS);
660 q->limits.discard_zeroes_data = 1;
661 break;
664 q->limits.max_discard_sectors = max_blocks * (logical_block_size >> 9);
665 queue_flag_set_unlocked(QUEUE_FLAG_DISCARD, q);
669 * sd_setup_discard_cmnd - unmap blocks on thinly provisioned device
670 * @sdp: scsi device to operate one
671 * @rq: Request to prepare
673 * Will issue either UNMAP or WRITE SAME(16) depending on preference
674 * indicated by target device.
676 static int sd_setup_discard_cmnd(struct scsi_device *sdp, struct request *rq)
678 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
679 sector_t sector = blk_rq_pos(rq);
680 unsigned int nr_sectors = blk_rq_sectors(rq);
681 unsigned int nr_bytes = blk_rq_bytes(rq);
682 unsigned int len;
683 int ret;
684 char *buf;
685 struct page *page;
687 sector >>= ilog2(sdp->sector_size) - 9;
688 nr_sectors >>= ilog2(sdp->sector_size) - 9;
689 rq->timeout = SD_TIMEOUT;
691 memset(rq->cmd, 0, rq->cmd_len);
693 page = alloc_page(GFP_ATOMIC | __GFP_ZERO);
694 if (!page)
695 return BLKPREP_DEFER;
697 switch (sdkp->provisioning_mode) {
698 case SD_LBP_UNMAP:
699 buf = page_address(page);
701 rq->cmd_len = 10;
702 rq->cmd[0] = UNMAP;
703 rq->cmd[8] = 24;
705 put_unaligned_be16(6 + 16, &buf[0]);
706 put_unaligned_be16(16, &buf[2]);
707 put_unaligned_be64(sector, &buf[8]);
708 put_unaligned_be32(nr_sectors, &buf[16]);
710 len = 24;
711 break;
713 case SD_LBP_WS16:
714 rq->cmd_len = 16;
715 rq->cmd[0] = WRITE_SAME_16;
716 rq->cmd[1] = 0x8; /* UNMAP */
717 put_unaligned_be64(sector, &rq->cmd[2]);
718 put_unaligned_be32(nr_sectors, &rq->cmd[10]);
720 len = sdkp->device->sector_size;
721 break;
723 case SD_LBP_WS10:
724 case SD_LBP_ZERO:
725 rq->cmd_len = 10;
726 rq->cmd[0] = WRITE_SAME;
727 if (sdkp->provisioning_mode == SD_LBP_WS10)
728 rq->cmd[1] = 0x8; /* UNMAP */
729 put_unaligned_be32(sector, &rq->cmd[2]);
730 put_unaligned_be16(nr_sectors, &rq->cmd[7]);
732 len = sdkp->device->sector_size;
733 break;
735 default:
736 ret = BLKPREP_KILL;
737 goto out;
740 blk_add_request_payload(rq, page, len);
741 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
742 rq->buffer = page_address(page);
743 rq->__data_len = nr_bytes;
745 out:
746 if (ret != BLKPREP_OK) {
747 __free_page(page);
748 rq->buffer = NULL;
750 return ret;
753 static void sd_config_write_same(struct scsi_disk *sdkp)
755 struct request_queue *q = sdkp->disk->queue;
756 unsigned int logical_block_size = sdkp->device->sector_size;
758 if (sdkp->device->no_write_same) {
759 sdkp->max_ws_blocks = 0;
760 goto out;
763 /* Some devices can not handle block counts above 0xffff despite
764 * supporting WRITE SAME(16). Consequently we default to 64k
765 * blocks per I/O unless the device explicitly advertises a
766 * bigger limit.
768 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
769 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
770 (u32)SD_MAX_WS16_BLOCKS);
771 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
772 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
773 (u32)SD_MAX_WS10_BLOCKS);
774 else {
775 sdkp->device->no_write_same = 1;
776 sdkp->max_ws_blocks = 0;
779 out:
780 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
781 (logical_block_size >> 9));
785 * sd_setup_write_same_cmnd - write the same data to multiple blocks
786 * @sdp: scsi device to operate one
787 * @rq: Request to prepare
789 * Will issue either WRITE SAME(10) or WRITE SAME(16) depending on
790 * preference indicated by target device.
792 static int sd_setup_write_same_cmnd(struct scsi_device *sdp, struct request *rq)
794 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
795 struct bio *bio = rq->bio;
796 sector_t sector = blk_rq_pos(rq);
797 unsigned int nr_sectors = blk_rq_sectors(rq);
798 unsigned int nr_bytes = blk_rq_bytes(rq);
799 int ret;
801 if (sdkp->device->no_write_same)
802 return BLKPREP_KILL;
804 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
806 sector >>= ilog2(sdp->sector_size) - 9;
807 nr_sectors >>= ilog2(sdp->sector_size) - 9;
809 rq->__data_len = sdp->sector_size;
810 rq->timeout = SD_WRITE_SAME_TIMEOUT;
811 memset(rq->cmd, 0, rq->cmd_len);
813 if (sdkp->ws16 || sector > 0xffffffff || nr_sectors > 0xffff) {
814 rq->cmd_len = 16;
815 rq->cmd[0] = WRITE_SAME_16;
816 put_unaligned_be64(sector, &rq->cmd[2]);
817 put_unaligned_be32(nr_sectors, &rq->cmd[10]);
818 } else {
819 rq->cmd_len = 10;
820 rq->cmd[0] = WRITE_SAME;
821 put_unaligned_be32(sector, &rq->cmd[2]);
822 put_unaligned_be16(nr_sectors, &rq->cmd[7]);
825 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
826 rq->__data_len = nr_bytes;
828 return ret;
831 static int scsi_setup_flush_cmnd(struct scsi_device *sdp, struct request *rq)
833 rq->timeout *= SD_FLUSH_TIMEOUT_MULTIPLIER;
834 rq->retries = SD_MAX_RETRIES;
835 rq->cmd[0] = SYNCHRONIZE_CACHE;
836 rq->cmd_len = 10;
838 return scsi_setup_blk_pc_cmnd(sdp, rq);
841 static void sd_unprep_fn(struct request_queue *q, struct request *rq)
843 struct scsi_cmnd *SCpnt = rq->special;
845 if (rq->cmd_flags & REQ_DISCARD) {
846 free_page((unsigned long)rq->buffer);
847 rq->buffer = NULL;
849 if (SCpnt->cmnd != rq->cmd) {
850 mempool_free(SCpnt->cmnd, sd_cdb_pool);
851 SCpnt->cmnd = NULL;
852 SCpnt->cmd_len = 0;
857 * sd_prep_fn - build a scsi (read or write) command from
858 * information in the request structure.
859 * @SCpnt: pointer to mid-level's per scsi command structure that
860 * contains request and into which the scsi command is written
862 * Returns 1 if successful and 0 if error (or cannot be done now).
864 static int sd_prep_fn(struct request_queue *q, struct request *rq)
866 struct scsi_cmnd *SCpnt;
867 struct scsi_device *sdp = q->queuedata;
868 struct gendisk *disk = rq->rq_disk;
869 struct scsi_disk *sdkp;
870 sector_t block = blk_rq_pos(rq);
871 sector_t threshold;
872 unsigned int this_count = blk_rq_sectors(rq);
873 int ret, host_dif;
874 unsigned char protect;
877 * Discard request come in as REQ_TYPE_FS but we turn them into
878 * block PC requests to make life easier.
880 if (rq->cmd_flags & REQ_DISCARD) {
881 ret = sd_setup_discard_cmnd(sdp, rq);
882 goto out;
883 } else if (rq->cmd_flags & REQ_WRITE_SAME) {
884 ret = sd_setup_write_same_cmnd(sdp, rq);
885 goto out;
886 } else if (rq->cmd_flags & REQ_FLUSH) {
887 ret = scsi_setup_flush_cmnd(sdp, rq);
888 goto out;
889 } else if (rq->cmd_type == REQ_TYPE_BLOCK_PC) {
890 ret = scsi_setup_blk_pc_cmnd(sdp, rq);
891 goto out;
892 } else if (rq->cmd_type != REQ_TYPE_FS) {
893 ret = BLKPREP_KILL;
894 goto out;
896 ret = scsi_setup_fs_cmnd(sdp, rq);
897 if (ret != BLKPREP_OK)
898 goto out;
899 SCpnt = rq->special;
900 sdkp = scsi_disk(disk);
902 /* from here on until we're complete, any goto out
903 * is used for a killable error condition */
904 ret = BLKPREP_KILL;
906 SCSI_LOG_HLQUEUE(1, scmd_printk(KERN_INFO, SCpnt,
907 "sd_prep_fn: block=%llu, "
908 "count=%d\n",
909 (unsigned long long)block,
910 this_count));
912 if (!sdp || !scsi_device_online(sdp) ||
913 block + blk_rq_sectors(rq) > get_capacity(disk)) {
914 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
915 "Finishing %u sectors\n",
916 blk_rq_sectors(rq)));
917 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
918 "Retry with 0x%p\n", SCpnt));
919 goto out;
922 if (sdp->changed) {
924 * quietly refuse to do anything to a changed disc until
925 * the changed bit has been reset
927 /* printk("SCSI disk has been changed or is not present. Prohibiting further I/O.\n"); */
928 goto out;
932 * Some SD card readers can't handle multi-sector accesses which touch
933 * the last one or two hardware sectors. Split accesses as needed.
935 threshold = get_capacity(disk) - SD_LAST_BUGGY_SECTORS *
936 (sdp->sector_size / 512);
938 if (unlikely(sdp->last_sector_bug && block + this_count > threshold)) {
939 if (block < threshold) {
940 /* Access up to the threshold but not beyond */
941 this_count = threshold - block;
942 } else {
943 /* Access only a single hardware sector */
944 this_count = sdp->sector_size / 512;
948 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt, "block=%llu\n",
949 (unsigned long long)block));
952 * If we have a 1K hardware sectorsize, prevent access to single
953 * 512 byte sectors. In theory we could handle this - in fact
954 * the scsi cdrom driver must be able to handle this because
955 * we typically use 1K blocksizes, and cdroms typically have
956 * 2K hardware sectorsizes. Of course, things are simpler
957 * with the cdrom, since it is read-only. For performance
958 * reasons, the filesystems should be able to handle this
959 * and not force the scsi disk driver to use bounce buffers
960 * for this.
962 if (sdp->sector_size == 1024) {
963 if ((block & 1) || (blk_rq_sectors(rq) & 1)) {
964 scmd_printk(KERN_ERR, SCpnt,
965 "Bad block number requested\n");
966 goto out;
967 } else {
968 block = block >> 1;
969 this_count = this_count >> 1;
972 if (sdp->sector_size == 2048) {
973 if ((block & 3) || (blk_rq_sectors(rq) & 3)) {
974 scmd_printk(KERN_ERR, SCpnt,
975 "Bad block number requested\n");
976 goto out;
977 } else {
978 block = block >> 2;
979 this_count = this_count >> 2;
982 if (sdp->sector_size == 4096) {
983 if ((block & 7) || (blk_rq_sectors(rq) & 7)) {
984 scmd_printk(KERN_ERR, SCpnt,
985 "Bad block number requested\n");
986 goto out;
987 } else {
988 block = block >> 3;
989 this_count = this_count >> 3;
992 if (rq_data_dir(rq) == WRITE) {
993 if (!sdp->writeable) {
994 goto out;
996 SCpnt->cmnd[0] = WRITE_6;
997 SCpnt->sc_data_direction = DMA_TO_DEVICE;
999 if (blk_integrity_rq(rq))
1000 sd_dif_prepare(rq, block, sdp->sector_size);
1002 } else if (rq_data_dir(rq) == READ) {
1003 SCpnt->cmnd[0] = READ_6;
1004 SCpnt->sc_data_direction = DMA_FROM_DEVICE;
1005 } else {
1006 scmd_printk(KERN_ERR, SCpnt, "Unknown command %llx\n", (unsigned long long) rq->cmd_flags);
1007 goto out;
1010 SCSI_LOG_HLQUEUE(2, scmd_printk(KERN_INFO, SCpnt,
1011 "%s %d/%u 512 byte blocks.\n",
1012 (rq_data_dir(rq) == WRITE) ?
1013 "writing" : "reading", this_count,
1014 blk_rq_sectors(rq)));
1016 /* Set RDPROTECT/WRPROTECT if disk is formatted with DIF */
1017 host_dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
1018 if (host_dif)
1019 protect = 1 << 5;
1020 else
1021 protect = 0;
1023 if (host_dif == SD_DIF_TYPE2_PROTECTION) {
1024 SCpnt->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1026 if (unlikely(SCpnt->cmnd == NULL)) {
1027 ret = BLKPREP_DEFER;
1028 goto out;
1031 SCpnt->cmd_len = SD_EXT_CDB_SIZE;
1032 memset(SCpnt->cmnd, 0, SCpnt->cmd_len);
1033 SCpnt->cmnd[0] = VARIABLE_LENGTH_CMD;
1034 SCpnt->cmnd[7] = 0x18;
1035 SCpnt->cmnd[9] = (rq_data_dir(rq) == READ) ? READ_32 : WRITE_32;
1036 SCpnt->cmnd[10] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
1038 /* LBA */
1039 SCpnt->cmnd[12] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
1040 SCpnt->cmnd[13] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
1041 SCpnt->cmnd[14] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
1042 SCpnt->cmnd[15] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
1043 SCpnt->cmnd[16] = (unsigned char) (block >> 24) & 0xff;
1044 SCpnt->cmnd[17] = (unsigned char) (block >> 16) & 0xff;
1045 SCpnt->cmnd[18] = (unsigned char) (block >> 8) & 0xff;
1046 SCpnt->cmnd[19] = (unsigned char) block & 0xff;
1048 /* Expected Indirect LBA */
1049 SCpnt->cmnd[20] = (unsigned char) (block >> 24) & 0xff;
1050 SCpnt->cmnd[21] = (unsigned char) (block >> 16) & 0xff;
1051 SCpnt->cmnd[22] = (unsigned char) (block >> 8) & 0xff;
1052 SCpnt->cmnd[23] = (unsigned char) block & 0xff;
1054 /* Transfer length */
1055 SCpnt->cmnd[28] = (unsigned char) (this_count >> 24) & 0xff;
1056 SCpnt->cmnd[29] = (unsigned char) (this_count >> 16) & 0xff;
1057 SCpnt->cmnd[30] = (unsigned char) (this_count >> 8) & 0xff;
1058 SCpnt->cmnd[31] = (unsigned char) this_count & 0xff;
1059 } else if (sdp->use_16_for_rw) {
1060 SCpnt->cmnd[0] += READ_16 - READ_6;
1061 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
1062 SCpnt->cmnd[2] = sizeof(block) > 4 ? (unsigned char) (block >> 56) & 0xff : 0;
1063 SCpnt->cmnd[3] = sizeof(block) > 4 ? (unsigned char) (block >> 48) & 0xff : 0;
1064 SCpnt->cmnd[4] = sizeof(block) > 4 ? (unsigned char) (block >> 40) & 0xff : 0;
1065 SCpnt->cmnd[5] = sizeof(block) > 4 ? (unsigned char) (block >> 32) & 0xff : 0;
1066 SCpnt->cmnd[6] = (unsigned char) (block >> 24) & 0xff;
1067 SCpnt->cmnd[7] = (unsigned char) (block >> 16) & 0xff;
1068 SCpnt->cmnd[8] = (unsigned char) (block >> 8) & 0xff;
1069 SCpnt->cmnd[9] = (unsigned char) block & 0xff;
1070 SCpnt->cmnd[10] = (unsigned char) (this_count >> 24) & 0xff;
1071 SCpnt->cmnd[11] = (unsigned char) (this_count >> 16) & 0xff;
1072 SCpnt->cmnd[12] = (unsigned char) (this_count >> 8) & 0xff;
1073 SCpnt->cmnd[13] = (unsigned char) this_count & 0xff;
1074 SCpnt->cmnd[14] = SCpnt->cmnd[15] = 0;
1075 } else if ((this_count > 0xff) || (block > 0x1fffff) ||
1076 scsi_device_protection(SCpnt->device) ||
1077 SCpnt->device->use_10_for_rw) {
1078 if (this_count > 0xffff)
1079 this_count = 0xffff;
1081 SCpnt->cmnd[0] += READ_10 - READ_6;
1082 SCpnt->cmnd[1] = protect | ((rq->cmd_flags & REQ_FUA) ? 0x8 : 0);
1083 SCpnt->cmnd[2] = (unsigned char) (block >> 24) & 0xff;
1084 SCpnt->cmnd[3] = (unsigned char) (block >> 16) & 0xff;
1085 SCpnt->cmnd[4] = (unsigned char) (block >> 8) & 0xff;
1086 SCpnt->cmnd[5] = (unsigned char) block & 0xff;
1087 SCpnt->cmnd[6] = SCpnt->cmnd[9] = 0;
1088 SCpnt->cmnd[7] = (unsigned char) (this_count >> 8) & 0xff;
1089 SCpnt->cmnd[8] = (unsigned char) this_count & 0xff;
1090 } else {
1091 if (unlikely(rq->cmd_flags & REQ_FUA)) {
1093 * This happens only if this drive failed
1094 * 10byte rw command with ILLEGAL_REQUEST
1095 * during operation and thus turned off
1096 * use_10_for_rw.
1098 scmd_printk(KERN_ERR, SCpnt,
1099 "FUA write on READ/WRITE(6) drive\n");
1100 goto out;
1103 SCpnt->cmnd[1] |= (unsigned char) ((block >> 16) & 0x1f);
1104 SCpnt->cmnd[2] = (unsigned char) ((block >> 8) & 0xff);
1105 SCpnt->cmnd[3] = (unsigned char) block & 0xff;
1106 SCpnt->cmnd[4] = (unsigned char) this_count;
1107 SCpnt->cmnd[5] = 0;
1109 SCpnt->sdb.length = this_count * sdp->sector_size;
1111 /* If DIF or DIX is enabled, tell HBA how to handle request */
1112 if (host_dif || scsi_prot_sg_count(SCpnt))
1113 sd_prot_op(SCpnt, host_dif);
1116 * We shouldn't disconnect in the middle of a sector, so with a dumb
1117 * host adapter, it's safe to assume that we can at least transfer
1118 * this many bytes between each connect / disconnect.
1120 SCpnt->transfersize = sdp->sector_size;
1121 SCpnt->underflow = this_count << 9;
1122 SCpnt->allowed = SD_MAX_RETRIES;
1125 * This indicates that the command is ready from our end to be
1126 * queued.
1128 ret = BLKPREP_OK;
1129 out:
1130 return scsi_prep_return(q, rq, ret);
1134 * sd_open - open a scsi disk device
1135 * @inode: only i_rdev member may be used
1136 * @filp: only f_mode and f_flags may be used
1138 * Returns 0 if successful. Returns a negated errno value in case
1139 * of error.
1141 * Note: This can be called from a user context (e.g. fsck(1) )
1142 * or from within the kernel (e.g. as a result of a mount(1) ).
1143 * In the latter case @inode and @filp carry an abridged amount
1144 * of information as noted above.
1146 * Locking: called with bdev->bd_mutex held.
1148 static int sd_open(struct block_device *bdev, fmode_t mode)
1150 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1151 struct scsi_device *sdev;
1152 int retval;
1154 if (!sdkp)
1155 return -ENXIO;
1157 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1159 sdev = sdkp->device;
1162 * If the device is in error recovery, wait until it is done.
1163 * If the device is offline, then disallow any access to it.
1165 retval = -ENXIO;
1166 if (!scsi_block_when_processing_errors(sdev))
1167 goto error_out;
1169 if (sdev->removable || sdkp->write_prot)
1170 check_disk_change(bdev);
1173 * If the drive is empty, just let the open fail.
1175 retval = -ENOMEDIUM;
1176 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1177 goto error_out;
1180 * If the device has the write protect tab set, have the open fail
1181 * if the user expects to be able to write to the thing.
1183 retval = -EROFS;
1184 if (sdkp->write_prot && (mode & FMODE_WRITE))
1185 goto error_out;
1188 * It is possible that the disk changing stuff resulted in
1189 * the device being taken offline. If this is the case,
1190 * report this to the user, and don't pretend that the
1191 * open actually succeeded.
1193 retval = -ENXIO;
1194 if (!scsi_device_online(sdev))
1195 goto error_out;
1197 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1198 if (scsi_block_when_processing_errors(sdev))
1199 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1202 return 0;
1204 error_out:
1205 scsi_disk_put(sdkp);
1206 return retval;
1210 * sd_release - invoked when the (last) close(2) is called on this
1211 * scsi disk.
1212 * @inode: only i_rdev member may be used
1213 * @filp: only f_mode and f_flags may be used
1215 * Returns 0.
1217 * Note: may block (uninterruptible) if error recovery is underway
1218 * on this disk.
1220 * Locking: called with bdev->bd_mutex held.
1222 static void sd_release(struct gendisk *disk, fmode_t mode)
1224 struct scsi_disk *sdkp = scsi_disk(disk);
1225 struct scsi_device *sdev = sdkp->device;
1227 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1229 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1230 if (scsi_block_when_processing_errors(sdev))
1231 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1235 * XXX and what if there are packets in flight and this close()
1236 * XXX is followed by a "rmmod sd_mod"?
1239 scsi_disk_put(sdkp);
1242 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1244 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1245 struct scsi_device *sdp = sdkp->device;
1246 struct Scsi_Host *host = sdp->host;
1247 int diskinfo[4];
1249 /* default to most commonly used values */
1250 diskinfo[0] = 0x40; /* 1 << 6 */
1251 diskinfo[1] = 0x20; /* 1 << 5 */
1252 diskinfo[2] = sdkp->capacity >> 11;
1254 /* override with calculated, extended default, or driver values */
1255 if (host->hostt->bios_param)
1256 host->hostt->bios_param(sdp, bdev, sdkp->capacity, diskinfo);
1257 else
1258 scsicam_bios_param(bdev, sdkp->capacity, diskinfo);
1260 geo->heads = diskinfo[0];
1261 geo->sectors = diskinfo[1];
1262 geo->cylinders = diskinfo[2];
1263 return 0;
1267 * sd_ioctl - process an ioctl
1268 * @inode: only i_rdev/i_bdev members may be used
1269 * @filp: only f_mode and f_flags may be used
1270 * @cmd: ioctl command number
1271 * @arg: this is third argument given to ioctl(2) system call.
1272 * Often contains a pointer.
1274 * Returns 0 if successful (some ioctls return positive numbers on
1275 * success as well). Returns a negated errno value in case of error.
1277 * Note: most ioctls are forward onto the block subsystem or further
1278 * down in the scsi subsystem.
1280 static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1281 unsigned int cmd, unsigned long arg)
1283 struct gendisk *disk = bdev->bd_disk;
1284 struct scsi_disk *sdkp = scsi_disk(disk);
1285 struct scsi_device *sdp = sdkp->device;
1286 void __user *p = (void __user *)arg;
1287 int error;
1289 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1290 "cmd=0x%x\n", disk->disk_name, cmd));
1292 error = scsi_verify_blk_ioctl(bdev, cmd);
1293 if (error < 0)
1294 return error;
1297 * If we are in the middle of error recovery, don't let anyone
1298 * else try and use this device. Also, if error recovery fails, it
1299 * may try and take the device offline, in which case all further
1300 * access to the device is prohibited.
1302 error = scsi_nonblockable_ioctl(sdp, cmd, p,
1303 (mode & FMODE_NDELAY) != 0);
1304 if (!scsi_block_when_processing_errors(sdp) || !error)
1305 goto out;
1308 * Send SCSI addressing ioctls directly to mid level, send other
1309 * ioctls to block level and then onto mid level if they can't be
1310 * resolved.
1312 switch (cmd) {
1313 case SCSI_IOCTL_GET_IDLUN:
1314 case SCSI_IOCTL_GET_BUS_NUMBER:
1315 error = scsi_ioctl(sdp, cmd, p);
1316 break;
1317 default:
1318 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1319 if (error != -ENOTTY)
1320 break;
1321 error = scsi_ioctl(sdp, cmd, p);
1322 break;
1324 out:
1325 return error;
1328 static void set_media_not_present(struct scsi_disk *sdkp)
1330 if (sdkp->media_present)
1331 sdkp->device->changed = 1;
1333 if (sdkp->device->removable) {
1334 sdkp->media_present = 0;
1335 sdkp->capacity = 0;
1339 static int media_not_present(struct scsi_disk *sdkp,
1340 struct scsi_sense_hdr *sshdr)
1342 if (!scsi_sense_valid(sshdr))
1343 return 0;
1345 /* not invoked for commands that could return deferred errors */
1346 switch (sshdr->sense_key) {
1347 case UNIT_ATTENTION:
1348 case NOT_READY:
1349 /* medium not present */
1350 if (sshdr->asc == 0x3A) {
1351 set_media_not_present(sdkp);
1352 return 1;
1355 return 0;
1359 * sd_check_events - check media events
1360 * @disk: kernel device descriptor
1361 * @clearing: disk events currently being cleared
1363 * Returns mask of DISK_EVENT_*.
1365 * Note: this function is invoked from the block subsystem.
1367 static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1369 struct scsi_disk *sdkp = scsi_disk(disk);
1370 struct scsi_device *sdp = sdkp->device;
1371 struct scsi_sense_hdr *sshdr = NULL;
1372 int retval;
1374 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1377 * If the device is offline, don't send any commands - just pretend as
1378 * if the command failed. If the device ever comes back online, we
1379 * can deal with it then. It is only because of unrecoverable errors
1380 * that we would ever take a device offline in the first place.
1382 if (!scsi_device_online(sdp)) {
1383 set_media_not_present(sdkp);
1384 goto out;
1388 * Using TEST_UNIT_READY enables differentiation between drive with
1389 * no cartridge loaded - NOT READY, drive with changed cartridge -
1390 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1392 * Drives that auto spin down. eg iomega jaz 1G, will be started
1393 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1394 * sd_revalidate() is called.
1396 retval = -ENODEV;
1398 if (scsi_block_when_processing_errors(sdp)) {
1399 sshdr = kzalloc(sizeof(*sshdr), GFP_KERNEL);
1400 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
1401 sshdr);
1404 /* failed to execute TUR, assume media not present */
1405 if (host_byte(retval)) {
1406 set_media_not_present(sdkp);
1407 goto out;
1410 if (media_not_present(sdkp, sshdr))
1411 goto out;
1414 * For removable scsi disk we have to recognise the presence
1415 * of a disk in the drive.
1417 if (!sdkp->media_present)
1418 sdp->changed = 1;
1419 sdkp->media_present = 1;
1420 out:
1422 * sdp->changed is set under the following conditions:
1424 * Medium present state has changed in either direction.
1425 * Device has indicated UNIT_ATTENTION.
1427 kfree(sshdr);
1428 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1429 sdp->changed = 0;
1430 return retval;
1433 static int sd_sync_cache(struct scsi_disk *sdkp)
1435 int retries, res;
1436 struct scsi_device *sdp = sdkp->device;
1437 const int timeout = sdp->request_queue->rq_timeout
1438 * SD_FLUSH_TIMEOUT_MULTIPLIER;
1439 struct scsi_sense_hdr sshdr;
1441 if (!scsi_device_online(sdp))
1442 return -ENODEV;
1444 for (retries = 3; retries > 0; --retries) {
1445 unsigned char cmd[10] = { 0 };
1447 cmd[0] = SYNCHRONIZE_CACHE;
1449 * Leave the rest of the command zero to indicate
1450 * flush everything.
1452 res = scsi_execute_req_flags(sdp, cmd, DMA_NONE, NULL, 0,
1453 &sshdr, timeout, SD_MAX_RETRIES,
1454 NULL, REQ_PM);
1455 if (res == 0)
1456 break;
1459 if (res) {
1460 sd_print_result(sdkp, res);
1462 if (driver_byte(res) & DRIVER_SENSE)
1463 sd_print_sense_hdr(sdkp, &sshdr);
1464 /* we need to evaluate the error return */
1465 if (scsi_sense_valid(&sshdr) &&
1466 /* 0x3a is medium not present */
1467 sshdr.asc == 0x3a)
1468 /* this is no error here */
1469 return 0;
1471 switch (host_byte(res)) {
1472 /* ignore errors due to racing a disconnection */
1473 case DID_BAD_TARGET:
1474 case DID_NO_CONNECT:
1475 return 0;
1476 /* signal the upper layer it might try again */
1477 case DID_BUS_BUSY:
1478 case DID_IMM_RETRY:
1479 case DID_REQUEUE:
1480 case DID_SOFT_ERROR:
1481 return -EBUSY;
1482 default:
1483 return -EIO;
1486 return 0;
1489 static void sd_rescan(struct device *dev)
1491 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
1493 if (sdkp) {
1494 revalidate_disk(sdkp->disk);
1495 scsi_disk_put(sdkp);
1500 #ifdef CONFIG_COMPAT
1502 * This gets directly called from VFS. When the ioctl
1503 * is not recognized we go back to the other translation paths.
1505 static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1506 unsigned int cmd, unsigned long arg)
1508 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1509 int ret;
1511 ret = scsi_verify_blk_ioctl(bdev, cmd);
1512 if (ret < 0)
1513 return ret;
1516 * If we are in the middle of error recovery, don't let anyone
1517 * else try and use this device. Also, if error recovery fails, it
1518 * may try and take the device offline, in which case all further
1519 * access to the device is prohibited.
1521 if (!scsi_block_when_processing_errors(sdev))
1522 return -ENODEV;
1524 if (sdev->host->hostt->compat_ioctl) {
1525 ret = sdev->host->hostt->compat_ioctl(sdev, cmd, (void __user *)arg);
1527 return ret;
1531 * Let the static ioctl translation table take care of it.
1533 return -ENOIOCTLCMD;
1535 #endif
1537 static const struct block_device_operations sd_fops = {
1538 .owner = THIS_MODULE,
1539 .open = sd_open,
1540 .release = sd_release,
1541 .ioctl = sd_ioctl,
1542 .getgeo = sd_getgeo,
1543 #ifdef CONFIG_COMPAT
1544 .compat_ioctl = sd_compat_ioctl,
1545 #endif
1546 .check_events = sd_check_events,
1547 .revalidate_disk = sd_revalidate_disk,
1548 .unlock_native_capacity = sd_unlock_native_capacity,
1552 * sd_eh_action - error handling callback
1553 * @scmd: sd-issued command that has failed
1554 * @eh_disp: The recovery disposition suggested by the midlayer
1556 * This function is called by the SCSI midlayer upon completion of an
1557 * error test command (currently TEST UNIT READY). The result of sending
1558 * the eh command is passed in eh_disp. We're looking for devices that
1559 * fail medium access commands but are OK with non access commands like
1560 * test unit ready (so wrongly see the device as having a successful
1561 * recovery)
1563 static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
1565 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1567 if (!scsi_device_online(scmd->device) ||
1568 !scsi_medium_access_command(scmd) ||
1569 host_byte(scmd->result) != DID_TIME_OUT ||
1570 eh_disp != SUCCESS)
1571 return eh_disp;
1574 * The device has timed out executing a medium access command.
1575 * However, the TEST UNIT READY command sent during error
1576 * handling completed successfully. Either the device is in the
1577 * process of recovering or has it suffered an internal failure
1578 * that prevents access to the storage medium.
1580 sdkp->medium_access_timed_out++;
1583 * If the device keeps failing read/write commands but TEST UNIT
1584 * READY always completes successfully we assume that medium
1585 * access is no longer possible and take the device offline.
1587 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1588 scmd_printk(KERN_ERR, scmd,
1589 "Medium access timeout failure. Offlining disk!\n");
1590 scsi_device_set_state(scmd->device, SDEV_OFFLINE);
1592 return FAILED;
1595 return eh_disp;
1598 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1600 u64 start_lba = blk_rq_pos(scmd->request);
1601 u64 end_lba = blk_rq_pos(scmd->request) + (scsi_bufflen(scmd) / 512);
1602 u64 bad_lba;
1603 int info_valid;
1605 * resid is optional but mostly filled in. When it's unused,
1606 * its value is zero, so we assume the whole buffer transferred
1608 unsigned int transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1609 unsigned int good_bytes;
1611 if (scmd->request->cmd_type != REQ_TYPE_FS)
1612 return 0;
1614 info_valid = scsi_get_sense_info_fld(scmd->sense_buffer,
1615 SCSI_SENSE_BUFFERSIZE,
1616 &bad_lba);
1617 if (!info_valid)
1618 return 0;
1620 if (scsi_bufflen(scmd) <= scmd->device->sector_size)
1621 return 0;
1623 if (scmd->device->sector_size < 512) {
1624 /* only legitimate sector_size here is 256 */
1625 start_lba <<= 1;
1626 end_lba <<= 1;
1627 } else {
1628 /* be careful ... don't want any overflows */
1629 unsigned int factor = scmd->device->sector_size / 512;
1630 do_div(start_lba, factor);
1631 do_div(end_lba, factor);
1634 /* The bad lba was reported incorrectly, we have no idea where
1635 * the error is.
1637 if (bad_lba < start_lba || bad_lba >= end_lba)
1638 return 0;
1640 /* This computation should always be done in terms of
1641 * the resolution of the device's medium.
1643 good_bytes = (bad_lba - start_lba) * scmd->device->sector_size;
1644 return min(good_bytes, transferred);
1648 * sd_done - bottom half handler: called when the lower level
1649 * driver has completed (successfully or otherwise) a scsi command.
1650 * @SCpnt: mid-level's per command structure.
1652 * Note: potentially run from within an ISR. Must not block.
1654 static int sd_done(struct scsi_cmnd *SCpnt)
1656 int result = SCpnt->result;
1657 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1658 struct scsi_sense_hdr sshdr;
1659 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
1660 struct request *req = SCpnt->request;
1661 int sense_valid = 0;
1662 int sense_deferred = 0;
1663 unsigned char op = SCpnt->cmnd[0];
1664 unsigned char unmap = SCpnt->cmnd[1] & 8;
1666 if (req->cmd_flags & REQ_DISCARD || req->cmd_flags & REQ_WRITE_SAME) {
1667 if (!result) {
1668 good_bytes = blk_rq_bytes(req);
1669 scsi_set_resid(SCpnt, 0);
1670 } else {
1671 good_bytes = 0;
1672 scsi_set_resid(SCpnt, blk_rq_bytes(req));
1676 if (result) {
1677 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
1678 if (sense_valid)
1679 sense_deferred = scsi_sense_is_deferred(&sshdr);
1681 #ifdef CONFIG_SCSI_LOGGING
1682 SCSI_LOG_HLCOMPLETE(1, scsi_print_result(SCpnt));
1683 if (sense_valid) {
1684 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
1685 "sd_done: sb[respc,sk,asc,"
1686 "ascq]=%x,%x,%x,%x\n",
1687 sshdr.response_code,
1688 sshdr.sense_key, sshdr.asc,
1689 sshdr.ascq));
1691 #endif
1692 if (driver_byte(result) != DRIVER_SENSE &&
1693 (!sense_valid || sense_deferred))
1694 goto out;
1696 sdkp->medium_access_timed_out = 0;
1698 switch (sshdr.sense_key) {
1699 case HARDWARE_ERROR:
1700 case MEDIUM_ERROR:
1701 good_bytes = sd_completed_bytes(SCpnt);
1702 break;
1703 case RECOVERED_ERROR:
1704 good_bytes = scsi_bufflen(SCpnt);
1705 break;
1706 case NO_SENSE:
1707 /* This indicates a false check condition, so ignore it. An
1708 * unknown amount of data was transferred so treat it as an
1709 * error.
1711 scsi_print_sense("sd", SCpnt);
1712 SCpnt->result = 0;
1713 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
1714 break;
1715 case ABORTED_COMMAND:
1716 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
1717 good_bytes = sd_completed_bytes(SCpnt);
1718 break;
1719 case ILLEGAL_REQUEST:
1720 if (sshdr.asc == 0x10) /* DIX: Host detected corruption */
1721 good_bytes = sd_completed_bytes(SCpnt);
1722 /* INVALID COMMAND OPCODE or INVALID FIELD IN CDB */
1723 if (sshdr.asc == 0x20 || sshdr.asc == 0x24) {
1724 switch (op) {
1725 case UNMAP:
1726 sd_config_discard(sdkp, SD_LBP_DISABLE);
1727 break;
1728 case WRITE_SAME_16:
1729 case WRITE_SAME:
1730 if (unmap)
1731 sd_config_discard(sdkp, SD_LBP_DISABLE);
1732 else {
1733 sdkp->device->no_write_same = 1;
1734 sd_config_write_same(sdkp);
1736 good_bytes = 0;
1737 req->__data_len = blk_rq_bytes(req);
1738 req->cmd_flags |= REQ_QUIET;
1742 break;
1743 default:
1744 break;
1746 out:
1747 if (rq_data_dir(SCpnt->request) == READ && scsi_prot_sg_count(SCpnt))
1748 sd_dif_complete(SCpnt, good_bytes);
1750 return good_bytes;
1754 * spinup disk - called only in sd_revalidate_disk()
1756 static void
1757 sd_spinup_disk(struct scsi_disk *sdkp)
1759 unsigned char cmd[10];
1760 unsigned long spintime_expire = 0;
1761 int retries, spintime;
1762 unsigned int the_result;
1763 struct scsi_sense_hdr sshdr;
1764 int sense_valid = 0;
1766 spintime = 0;
1768 /* Spin up drives, as required. Only do this at boot time */
1769 /* Spinup needs to be done for module loads too. */
1770 do {
1771 retries = 0;
1773 do {
1774 cmd[0] = TEST_UNIT_READY;
1775 memset((void *) &cmd[1], 0, 9);
1777 the_result = scsi_execute_req(sdkp->device, cmd,
1778 DMA_NONE, NULL, 0,
1779 &sshdr, SD_TIMEOUT,
1780 SD_MAX_RETRIES, NULL);
1783 * If the drive has indicated to us that it
1784 * doesn't have any media in it, don't bother
1785 * with any more polling.
1787 if (media_not_present(sdkp, &sshdr))
1788 return;
1790 if (the_result)
1791 sense_valid = scsi_sense_valid(&sshdr);
1792 retries++;
1793 } while (retries < 3 &&
1794 (!scsi_status_is_good(the_result) ||
1795 ((driver_byte(the_result) & DRIVER_SENSE) &&
1796 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
1798 if ((driver_byte(the_result) & DRIVER_SENSE) == 0) {
1799 /* no sense, TUR either succeeded or failed
1800 * with a status error */
1801 if(!spintime && !scsi_status_is_good(the_result)) {
1802 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1803 sd_print_result(sdkp, the_result);
1805 break;
1809 * The device does not want the automatic start to be issued.
1811 if (sdkp->device->no_start_on_add)
1812 break;
1814 if (sense_valid && sshdr.sense_key == NOT_READY) {
1815 if (sshdr.asc == 4 && sshdr.ascq == 3)
1816 break; /* manual intervention required */
1817 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
1818 break; /* standby */
1819 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
1820 break; /* unavailable */
1822 * Issue command to spin up drive when not ready
1824 if (!spintime) {
1825 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
1826 cmd[0] = START_STOP;
1827 cmd[1] = 1; /* Return immediately */
1828 memset((void *) &cmd[2], 0, 8);
1829 cmd[4] = 1; /* Start spin cycle */
1830 if (sdkp->device->start_stop_pwr_cond)
1831 cmd[4] |= 1 << 4;
1832 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
1833 NULL, 0, &sshdr,
1834 SD_TIMEOUT, SD_MAX_RETRIES,
1835 NULL);
1836 spintime_expire = jiffies + 100 * HZ;
1837 spintime = 1;
1839 /* Wait 1 second for next try */
1840 msleep(1000);
1841 printk(".");
1844 * Wait for USB flash devices with slow firmware.
1845 * Yes, this sense key/ASC combination shouldn't
1846 * occur here. It's characteristic of these devices.
1848 } else if (sense_valid &&
1849 sshdr.sense_key == UNIT_ATTENTION &&
1850 sshdr.asc == 0x28) {
1851 if (!spintime) {
1852 spintime_expire = jiffies + 5 * HZ;
1853 spintime = 1;
1855 /* Wait 1 second for next try */
1856 msleep(1000);
1857 } else {
1858 /* we don't understand the sense code, so it's
1859 * probably pointless to loop */
1860 if(!spintime) {
1861 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
1862 sd_print_sense_hdr(sdkp, &sshdr);
1864 break;
1867 } while (spintime && time_before_eq(jiffies, spintime_expire));
1869 if (spintime) {
1870 if (scsi_status_is_good(the_result))
1871 printk("ready\n");
1872 else
1873 printk("not responding...\n");
1879 * Determine whether disk supports Data Integrity Field.
1881 static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
1883 struct scsi_device *sdp = sdkp->device;
1884 u8 type;
1885 int ret = 0;
1887 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0)
1888 return ret;
1890 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
1892 if (type > SD_DIF_TYPE3_PROTECTION)
1893 ret = -ENODEV;
1894 else if (scsi_host_dif_capable(sdp->host, type))
1895 ret = 1;
1897 if (sdkp->first_scan || type != sdkp->protection_type)
1898 switch (ret) {
1899 case -ENODEV:
1900 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
1901 " protection type %u. Disabling disk!\n",
1902 type);
1903 break;
1904 case 1:
1905 sd_printk(KERN_NOTICE, sdkp,
1906 "Enabling DIF Type %u protection\n", type);
1907 break;
1908 case 0:
1909 sd_printk(KERN_NOTICE, sdkp,
1910 "Disabling DIF Type %u protection\n", type);
1911 break;
1914 sdkp->protection_type = type;
1916 return ret;
1919 static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
1920 struct scsi_sense_hdr *sshdr, int sense_valid,
1921 int the_result)
1923 sd_print_result(sdkp, the_result);
1924 if (driver_byte(the_result) & DRIVER_SENSE)
1925 sd_print_sense_hdr(sdkp, sshdr);
1926 else
1927 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
1930 * Set dirty bit for removable devices if not ready -
1931 * sometimes drives will not report this properly.
1933 if (sdp->removable &&
1934 sense_valid && sshdr->sense_key == NOT_READY)
1935 set_media_not_present(sdkp);
1938 * We used to set media_present to 0 here to indicate no media
1939 * in the drive, but some drives fail read capacity even with
1940 * media present, so we can't do that.
1942 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
1945 #define RC16_LEN 32
1946 #if RC16_LEN > SD_BUF_SIZE
1947 #error RC16_LEN must not be more than SD_BUF_SIZE
1948 #endif
1950 #define READ_CAPACITY_RETRIES_ON_RESET 10
1952 static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
1953 unsigned char *buffer)
1955 unsigned char cmd[16];
1956 struct scsi_sense_hdr sshdr;
1957 int sense_valid = 0;
1958 int the_result;
1959 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
1960 unsigned int alignment;
1961 unsigned long long lba;
1962 unsigned sector_size;
1964 if (sdp->no_read_capacity_16)
1965 return -EINVAL;
1967 do {
1968 memset(cmd, 0, 16);
1969 cmd[0] = SERVICE_ACTION_IN;
1970 cmd[1] = SAI_READ_CAPACITY_16;
1971 cmd[13] = RC16_LEN;
1972 memset(buffer, 0, RC16_LEN);
1974 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
1975 buffer, RC16_LEN, &sshdr,
1976 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1978 if (media_not_present(sdkp, &sshdr))
1979 return -ENODEV;
1981 if (the_result) {
1982 sense_valid = scsi_sense_valid(&sshdr);
1983 if (sense_valid &&
1984 sshdr.sense_key == ILLEGAL_REQUEST &&
1985 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
1986 sshdr.ascq == 0x00)
1987 /* Invalid Command Operation Code or
1988 * Invalid Field in CDB, just retry
1989 * silently with RC10 */
1990 return -EINVAL;
1991 if (sense_valid &&
1992 sshdr.sense_key == UNIT_ATTENTION &&
1993 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
1994 /* Device reset might occur several times,
1995 * give it one more chance */
1996 if (--reset_retries > 0)
1997 continue;
1999 retries--;
2001 } while (the_result && retries);
2003 if (the_result) {
2004 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY(16) failed\n");
2005 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2006 return -EINVAL;
2009 sector_size = get_unaligned_be32(&buffer[8]);
2010 lba = get_unaligned_be64(&buffer[0]);
2012 if (sd_read_protection_type(sdkp, buffer) < 0) {
2013 sdkp->capacity = 0;
2014 return -ENODEV;
2017 if ((sizeof(sdkp->capacity) == 4) && (lba >= 0xffffffffULL)) {
2018 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2019 "kernel compiled with support for large block "
2020 "devices.\n");
2021 sdkp->capacity = 0;
2022 return -EOVERFLOW;
2025 /* Logical blocks per physical block exponent */
2026 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
2028 /* Lowest aligned logical block */
2029 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2030 blk_queue_alignment_offset(sdp->request_queue, alignment);
2031 if (alignment && sdkp->first_scan)
2032 sd_printk(KERN_NOTICE, sdkp,
2033 "physical block alignment offset: %u\n", alignment);
2035 if (buffer[14] & 0x80) { /* LBPME */
2036 sdkp->lbpme = 1;
2038 if (buffer[14] & 0x40) /* LBPRZ */
2039 sdkp->lbprz = 1;
2041 sd_config_discard(sdkp, SD_LBP_WS16);
2044 sdkp->capacity = lba + 1;
2045 return sector_size;
2048 static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2049 unsigned char *buffer)
2051 unsigned char cmd[16];
2052 struct scsi_sense_hdr sshdr;
2053 int sense_valid = 0;
2054 int the_result;
2055 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2056 sector_t lba;
2057 unsigned sector_size;
2059 do {
2060 cmd[0] = READ_CAPACITY;
2061 memset(&cmd[1], 0, 9);
2062 memset(buffer, 0, 8);
2064 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2065 buffer, 8, &sshdr,
2066 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2068 if (media_not_present(sdkp, &sshdr))
2069 return -ENODEV;
2071 if (the_result) {
2072 sense_valid = scsi_sense_valid(&sshdr);
2073 if (sense_valid &&
2074 sshdr.sense_key == UNIT_ATTENTION &&
2075 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2076 /* Device reset might occur several times,
2077 * give it one more chance */
2078 if (--reset_retries > 0)
2079 continue;
2081 retries--;
2083 } while (the_result && retries);
2085 if (the_result) {
2086 sd_printk(KERN_NOTICE, sdkp, "READ CAPACITY failed\n");
2087 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2088 return -EINVAL;
2091 sector_size = get_unaligned_be32(&buffer[4]);
2092 lba = get_unaligned_be32(&buffer[0]);
2094 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2095 /* Some buggy (usb cardreader) devices return an lba of
2096 0xffffffff when the want to report a size of 0 (with
2097 which they really mean no media is present) */
2098 sdkp->capacity = 0;
2099 sdkp->physical_block_size = sector_size;
2100 return sector_size;
2103 if ((sizeof(sdkp->capacity) == 4) && (lba == 0xffffffff)) {
2104 sd_printk(KERN_ERR, sdkp, "Too big for this kernel. Use a "
2105 "kernel compiled with support for large block "
2106 "devices.\n");
2107 sdkp->capacity = 0;
2108 return -EOVERFLOW;
2111 sdkp->capacity = lba + 1;
2112 sdkp->physical_block_size = sector_size;
2113 return sector_size;
2116 static int sd_try_rc16_first(struct scsi_device *sdp)
2118 if (sdp->host->max_cmd_len < 16)
2119 return 0;
2120 if (sdp->try_rc_10_first)
2121 return 0;
2122 if (sdp->scsi_level > SCSI_SPC_2)
2123 return 1;
2124 if (scsi_device_protection(sdp))
2125 return 1;
2126 return 0;
2130 * read disk capacity
2132 static void
2133 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2135 int sector_size;
2136 struct scsi_device *sdp = sdkp->device;
2137 sector_t old_capacity = sdkp->capacity;
2139 if (sd_try_rc16_first(sdp)) {
2140 sector_size = read_capacity_16(sdkp, sdp, buffer);
2141 if (sector_size == -EOVERFLOW)
2142 goto got_data;
2143 if (sector_size == -ENODEV)
2144 return;
2145 if (sector_size < 0)
2146 sector_size = read_capacity_10(sdkp, sdp, buffer);
2147 if (sector_size < 0)
2148 return;
2149 } else {
2150 sector_size = read_capacity_10(sdkp, sdp, buffer);
2151 if (sector_size == -EOVERFLOW)
2152 goto got_data;
2153 if (sector_size < 0)
2154 return;
2155 if ((sizeof(sdkp->capacity) > 4) &&
2156 (sdkp->capacity > 0xffffffffULL)) {
2157 int old_sector_size = sector_size;
2158 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2159 "Trying to use READ CAPACITY(16).\n");
2160 sector_size = read_capacity_16(sdkp, sdp, buffer);
2161 if (sector_size < 0) {
2162 sd_printk(KERN_NOTICE, sdkp,
2163 "Using 0xffffffff as device size\n");
2164 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2165 sector_size = old_sector_size;
2166 goto got_data;
2171 /* Some devices are known to return the total number of blocks,
2172 * not the highest block number. Some devices have versions
2173 * which do this and others which do not. Some devices we might
2174 * suspect of doing this but we don't know for certain.
2176 * If we know the reported capacity is wrong, decrement it. If
2177 * we can only guess, then assume the number of blocks is even
2178 * (usually true but not always) and err on the side of lowering
2179 * the capacity.
2181 if (sdp->fix_capacity ||
2182 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2183 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2184 "from its reported value: %llu\n",
2185 (unsigned long long) sdkp->capacity);
2186 --sdkp->capacity;
2189 got_data:
2190 if (sector_size == 0) {
2191 sector_size = 512;
2192 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2193 "assuming 512.\n");
2196 if (sector_size != 512 &&
2197 sector_size != 1024 &&
2198 sector_size != 2048 &&
2199 sector_size != 4096 &&
2200 sector_size != 256) {
2201 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2202 sector_size);
2204 * The user might want to re-format the drive with
2205 * a supported sectorsize. Once this happens, it
2206 * would be relatively trivial to set the thing up.
2207 * For this reason, we leave the thing in the table.
2209 sdkp->capacity = 0;
2211 * set a bogus sector size so the normal read/write
2212 * logic in the block layer will eventually refuse any
2213 * request on this device without tripping over power
2214 * of two sector size assumptions
2216 sector_size = 512;
2218 blk_queue_logical_block_size(sdp->request_queue, sector_size);
2221 char cap_str_2[10], cap_str_10[10];
2222 u64 sz = (u64)sdkp->capacity << ilog2(sector_size);
2224 string_get_size(sz, STRING_UNITS_2, cap_str_2,
2225 sizeof(cap_str_2));
2226 string_get_size(sz, STRING_UNITS_10, cap_str_10,
2227 sizeof(cap_str_10));
2229 if (sdkp->first_scan || old_capacity != sdkp->capacity) {
2230 sd_printk(KERN_NOTICE, sdkp,
2231 "%llu %d-byte logical blocks: (%s/%s)\n",
2232 (unsigned long long)sdkp->capacity,
2233 sector_size, cap_str_10, cap_str_2);
2235 if (sdkp->physical_block_size != sector_size)
2236 sd_printk(KERN_NOTICE, sdkp,
2237 "%u-byte physical blocks\n",
2238 sdkp->physical_block_size);
2242 sdp->use_16_for_rw = (sdkp->capacity > 0xffffffff);
2244 /* Rescale capacity to 512-byte units */
2245 if (sector_size == 4096)
2246 sdkp->capacity <<= 3;
2247 else if (sector_size == 2048)
2248 sdkp->capacity <<= 2;
2249 else if (sector_size == 1024)
2250 sdkp->capacity <<= 1;
2251 else if (sector_size == 256)
2252 sdkp->capacity >>= 1;
2254 blk_queue_physical_block_size(sdp->request_queue,
2255 sdkp->physical_block_size);
2256 sdkp->device->sector_size = sector_size;
2259 /* called with buffer of length 512 */
2260 static inline int
2261 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2262 unsigned char *buffer, int len, struct scsi_mode_data *data,
2263 struct scsi_sense_hdr *sshdr)
2265 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
2266 SD_TIMEOUT, SD_MAX_RETRIES, data,
2267 sshdr);
2271 * read write protect setting, if possible - called only in sd_revalidate_disk()
2272 * called with buffer of length SD_BUF_SIZE
2274 static void
2275 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
2277 int res;
2278 struct scsi_device *sdp = sdkp->device;
2279 struct scsi_mode_data data;
2280 int old_wp = sdkp->write_prot;
2282 set_disk_ro(sdkp->disk, 0);
2283 if (sdp->skip_ms_page_3f) {
2284 sd_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
2285 return;
2288 if (sdp->use_192_bytes_for_3f) {
2289 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
2290 } else {
2292 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2293 * We have to start carefully: some devices hang if we ask
2294 * for more than is available.
2296 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
2299 * Second attempt: ask for page 0 When only page 0 is
2300 * implemented, a request for page 3F may return Sense Key
2301 * 5: Illegal Request, Sense Code 24: Invalid field in
2302 * CDB.
2304 if (!scsi_status_is_good(res))
2305 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
2308 * Third attempt: ask 255 bytes, as we did earlier.
2310 if (!scsi_status_is_good(res))
2311 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2312 &data, NULL);
2315 if (!scsi_status_is_good(res)) {
2316 sd_printk(KERN_WARNING, sdkp,
2317 "Test WP failed, assume Write Enabled\n");
2318 } else {
2319 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
2320 set_disk_ro(sdkp->disk, sdkp->write_prot);
2321 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2322 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2323 sdkp->write_prot ? "on" : "off");
2324 sd_printk(KERN_DEBUG, sdkp,
2325 "Mode Sense: %02x %02x %02x %02x\n",
2326 buffer[0], buffer[1], buffer[2], buffer[3]);
2332 * sd_read_cache_type - called only from sd_revalidate_disk()
2333 * called with buffer of length SD_BUF_SIZE
2335 static void
2336 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
2338 int len = 0, res;
2339 struct scsi_device *sdp = sdkp->device;
2341 int dbd;
2342 int modepage;
2343 int first_len;
2344 struct scsi_mode_data data;
2345 struct scsi_sense_hdr sshdr;
2346 int old_wce = sdkp->WCE;
2347 int old_rcd = sdkp->RCD;
2348 int old_dpofua = sdkp->DPOFUA;
2351 if (sdkp->cache_override)
2352 return;
2354 first_len = 4;
2355 if (sdp->skip_ms_page_8) {
2356 if (sdp->type == TYPE_RBC)
2357 goto defaults;
2358 else {
2359 if (sdp->skip_ms_page_3f)
2360 goto defaults;
2361 modepage = 0x3F;
2362 if (sdp->use_192_bytes_for_3f)
2363 first_len = 192;
2364 dbd = 0;
2366 } else if (sdp->type == TYPE_RBC) {
2367 modepage = 6;
2368 dbd = 8;
2369 } else {
2370 modepage = 8;
2371 dbd = 0;
2374 /* cautiously ask */
2375 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2376 &data, &sshdr);
2378 if (!scsi_status_is_good(res))
2379 goto bad_sense;
2381 if (!data.header_length) {
2382 modepage = 6;
2383 first_len = 0;
2384 sd_printk(KERN_ERR, sdkp, "Missing header in MODE_SENSE response\n");
2387 /* that went OK, now ask for the proper length */
2388 len = data.length;
2391 * We're only interested in the first three bytes, actually.
2392 * But the data cache page is defined for the first 20.
2394 if (len < 3)
2395 goto bad_sense;
2396 else if (len > SD_BUF_SIZE) {
2397 sd_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
2398 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2399 len = SD_BUF_SIZE;
2401 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2402 len = 192;
2404 /* Get the data */
2405 if (len > first_len)
2406 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2407 &data, &sshdr);
2409 if (scsi_status_is_good(res)) {
2410 int offset = data.header_length + data.block_descriptor_length;
2412 while (offset < len) {
2413 u8 page_code = buffer[offset] & 0x3F;
2414 u8 spf = buffer[offset] & 0x40;
2416 if (page_code == 8 || page_code == 6) {
2417 /* We're interested only in the first 3 bytes.
2419 if (len - offset <= 2) {
2420 sd_printk(KERN_ERR, sdkp, "Incomplete "
2421 "mode parameter data\n");
2422 goto defaults;
2423 } else {
2424 modepage = page_code;
2425 goto Page_found;
2427 } else {
2428 /* Go to the next page */
2429 if (spf && len - offset > 3)
2430 offset += 4 + (buffer[offset+2] << 8) +
2431 buffer[offset+3];
2432 else if (!spf && len - offset > 1)
2433 offset += 2 + buffer[offset+1];
2434 else {
2435 sd_printk(KERN_ERR, sdkp, "Incomplete "
2436 "mode parameter data\n");
2437 goto defaults;
2442 sd_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
2443 goto defaults;
2445 Page_found:
2446 if (modepage == 8) {
2447 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2448 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2449 } else {
2450 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2451 sdkp->RCD = 0;
2454 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
2455 if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw) {
2456 sd_printk(KERN_NOTICE, sdkp,
2457 "Uses READ/WRITE(6), disabling FUA\n");
2458 sdkp->DPOFUA = 0;
2461 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2462 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2463 sd_printk(KERN_NOTICE, sdkp,
2464 "Write cache: %s, read cache: %s, %s\n",
2465 sdkp->WCE ? "enabled" : "disabled",
2466 sdkp->RCD ? "disabled" : "enabled",
2467 sdkp->DPOFUA ? "supports DPO and FUA"
2468 : "doesn't support DPO or FUA");
2470 return;
2473 bad_sense:
2474 if (scsi_sense_valid(&sshdr) &&
2475 sshdr.sense_key == ILLEGAL_REQUEST &&
2476 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
2477 /* Invalid field in CDB */
2478 sd_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
2479 else
2480 sd_printk(KERN_ERR, sdkp, "Asking for cache data failed\n");
2482 defaults:
2483 if (sdp->wce_default_on) {
2484 sd_printk(KERN_NOTICE, sdkp, "Assuming drive cache: write back\n");
2485 sdkp->WCE = 1;
2486 } else {
2487 sd_printk(KERN_ERR, sdkp, "Assuming drive cache: write through\n");
2488 sdkp->WCE = 0;
2490 sdkp->RCD = 0;
2491 sdkp->DPOFUA = 0;
2495 * The ATO bit indicates whether the DIF application tag is available
2496 * for use by the operating system.
2498 static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
2500 int res, offset;
2501 struct scsi_device *sdp = sdkp->device;
2502 struct scsi_mode_data data;
2503 struct scsi_sense_hdr sshdr;
2505 if (sdp->type != TYPE_DISK)
2506 return;
2508 if (sdkp->protection_type == 0)
2509 return;
2511 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2512 SD_MAX_RETRIES, &data, &sshdr);
2514 if (!scsi_status_is_good(res) || !data.header_length ||
2515 data.length < 6) {
2516 sd_printk(KERN_WARNING, sdkp,
2517 "getting Control mode page failed, assume no ATO\n");
2519 if (scsi_sense_valid(&sshdr))
2520 sd_print_sense_hdr(sdkp, &sshdr);
2522 return;
2525 offset = data.header_length + data.block_descriptor_length;
2527 if ((buffer[offset] & 0x3f) != 0x0a) {
2528 sd_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
2529 return;
2532 if ((buffer[offset + 5] & 0x80) == 0)
2533 return;
2535 sdkp->ATO = 1;
2537 return;
2541 * sd_read_block_limits - Query disk device for preferred I/O sizes.
2542 * @disk: disk to query
2544 static void sd_read_block_limits(struct scsi_disk *sdkp)
2546 unsigned int sector_sz = sdkp->device->sector_size;
2547 const int vpd_len = 64;
2548 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
2550 if (!buffer ||
2551 /* Block Limits VPD */
2552 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2553 goto out;
2555 blk_queue_io_min(sdkp->disk->queue,
2556 get_unaligned_be16(&buffer[6]) * sector_sz);
2557 blk_queue_io_opt(sdkp->disk->queue,
2558 get_unaligned_be32(&buffer[12]) * sector_sz);
2560 if (buffer[3] == 0x3c) {
2561 unsigned int lba_count, desc_count;
2563 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
2565 if (!sdkp->lbpme)
2566 goto out;
2568 lba_count = get_unaligned_be32(&buffer[20]);
2569 desc_count = get_unaligned_be32(&buffer[24]);
2571 if (lba_count && desc_count)
2572 sdkp->max_unmap_blocks = lba_count;
2574 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
2576 if (buffer[32] & 0x80)
2577 sdkp->unmap_alignment =
2578 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
2580 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2582 if (sdkp->max_unmap_blocks)
2583 sd_config_discard(sdkp, SD_LBP_UNMAP);
2584 else
2585 sd_config_discard(sdkp, SD_LBP_WS16);
2587 } else { /* LBP VPD page tells us what to use */
2589 if (sdkp->lbpu && sdkp->max_unmap_blocks)
2590 sd_config_discard(sdkp, SD_LBP_UNMAP);
2591 else if (sdkp->lbpws)
2592 sd_config_discard(sdkp, SD_LBP_WS16);
2593 else if (sdkp->lbpws10)
2594 sd_config_discard(sdkp, SD_LBP_WS10);
2595 else
2596 sd_config_discard(sdkp, SD_LBP_DISABLE);
2600 out:
2601 kfree(buffer);
2605 * sd_read_block_characteristics - Query block dev. characteristics
2606 * @disk: disk to query
2608 static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2610 unsigned char *buffer;
2611 u16 rot;
2612 const int vpd_len = 64;
2614 buffer = kmalloc(vpd_len, GFP_KERNEL);
2616 if (!buffer ||
2617 /* Block Device Characteristics VPD */
2618 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2619 goto out;
2621 rot = get_unaligned_be16(&buffer[4]);
2623 if (rot == 1)
2624 queue_flag_set_unlocked(QUEUE_FLAG_NONROT, sdkp->disk->queue);
2626 out:
2627 kfree(buffer);
2631 * sd_read_block_provisioning - Query provisioning VPD page
2632 * @disk: disk to query
2634 static void sd_read_block_provisioning(struct scsi_disk *sdkp)
2636 unsigned char *buffer;
2637 const int vpd_len = 8;
2639 if (sdkp->lbpme == 0)
2640 return;
2642 buffer = kmalloc(vpd_len, GFP_KERNEL);
2644 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
2645 goto out;
2647 sdkp->lbpvpd = 1;
2648 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
2649 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
2650 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
2652 out:
2653 kfree(buffer);
2656 static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
2658 struct scsi_device *sdev = sdkp->device;
2660 if (sdev->host->no_write_same) {
2661 sdev->no_write_same = 1;
2663 return;
2666 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
2667 /* too large values might cause issues with arcmsr */
2668 int vpd_buf_len = 64;
2670 sdev->no_report_opcodes = 1;
2672 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
2673 * CODES is unsupported and the device has an ATA
2674 * Information VPD page (SAT).
2676 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
2677 sdev->no_write_same = 1;
2680 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
2681 sdkp->ws16 = 1;
2683 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
2684 sdkp->ws10 = 1;
2687 static int sd_try_extended_inquiry(struct scsi_device *sdp)
2690 * Although VPD inquiries can go to SCSI-2 type devices,
2691 * some USB ones crash on receiving them, and the pages
2692 * we currently ask for are for SPC-3 and beyond
2694 if (sdp->scsi_level > SCSI_SPC_2 && !sdp->skip_vpd_pages)
2695 return 1;
2696 return 0;
2700 * sd_revalidate_disk - called the first time a new disk is seen,
2701 * performs disk spin up, read_capacity, etc.
2702 * @disk: struct gendisk we care about
2704 static int sd_revalidate_disk(struct gendisk *disk)
2706 struct scsi_disk *sdkp = scsi_disk(disk);
2707 struct scsi_device *sdp = sdkp->device;
2708 unsigned char *buffer;
2709 unsigned flush = 0;
2711 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
2712 "sd_revalidate_disk\n"));
2715 * If the device is offline, don't try and read capacity or any
2716 * of the other niceties.
2718 if (!scsi_device_online(sdp))
2719 goto out;
2721 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
2722 if (!buffer) {
2723 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
2724 "allocation failure.\n");
2725 goto out;
2728 sd_spinup_disk(sdkp);
2731 * Without media there is no reason to ask; moreover, some devices
2732 * react badly if we do.
2734 if (sdkp->media_present) {
2735 sd_read_capacity(sdkp, buffer);
2737 if (sd_try_extended_inquiry(sdp)) {
2738 sd_read_block_provisioning(sdkp);
2739 sd_read_block_limits(sdkp);
2740 sd_read_block_characteristics(sdkp);
2743 sd_read_write_protect_flag(sdkp, buffer);
2744 sd_read_cache_type(sdkp, buffer);
2745 sd_read_app_tag_own(sdkp, buffer);
2746 sd_read_write_same(sdkp, buffer);
2749 sdkp->first_scan = 0;
2752 * We now have all cache related info, determine how we deal
2753 * with flush requests.
2755 if (sdkp->WCE) {
2756 flush |= REQ_FLUSH;
2757 if (sdkp->DPOFUA)
2758 flush |= REQ_FUA;
2761 blk_queue_flush(sdkp->disk->queue, flush);
2763 set_capacity(disk, sdkp->capacity);
2764 sd_config_write_same(sdkp);
2765 kfree(buffer);
2767 out:
2768 return 0;
2772 * sd_unlock_native_capacity - unlock native capacity
2773 * @disk: struct gendisk to set capacity for
2775 * Block layer calls this function if it detects that partitions
2776 * on @disk reach beyond the end of the device. If the SCSI host
2777 * implements ->unlock_native_capacity() method, it's invoked to
2778 * give it a chance to adjust the device capacity.
2780 * CONTEXT:
2781 * Defined by block layer. Might sleep.
2783 static void sd_unlock_native_capacity(struct gendisk *disk)
2785 struct scsi_device *sdev = scsi_disk(disk)->device;
2787 if (sdev->host->hostt->unlock_native_capacity)
2788 sdev->host->hostt->unlock_native_capacity(sdev);
2792 * sd_format_disk_name - format disk name
2793 * @prefix: name prefix - ie. "sd" for SCSI disks
2794 * @index: index of the disk to format name for
2795 * @buf: output buffer
2796 * @buflen: length of the output buffer
2798 * SCSI disk names starts at sda. The 26th device is sdz and the
2799 * 27th is sdaa. The last one for two lettered suffix is sdzz
2800 * which is followed by sdaaa.
2802 * This is basically 26 base counting with one extra 'nil' entry
2803 * at the beginning from the second digit on and can be
2804 * determined using similar method as 26 base conversion with the
2805 * index shifted -1 after each digit is computed.
2807 * CONTEXT:
2808 * Don't care.
2810 * RETURNS:
2811 * 0 on success, -errno on failure.
2813 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
2815 const int base = 'z' - 'a' + 1;
2816 char *begin = buf + strlen(prefix);
2817 char *end = buf + buflen;
2818 char *p;
2819 int unit;
2821 p = end - 1;
2822 *p = '\0';
2823 unit = base;
2824 do {
2825 if (p == begin)
2826 return -EINVAL;
2827 *--p = 'a' + (index % unit);
2828 index = (index / unit) - 1;
2829 } while (index >= 0);
2831 memmove(begin, p, end - p);
2832 memcpy(buf, prefix, strlen(prefix));
2834 return 0;
2838 * The asynchronous part of sd_probe
2840 static void sd_probe_async(void *data, async_cookie_t cookie)
2842 struct scsi_disk *sdkp = data;
2843 struct scsi_device *sdp;
2844 struct gendisk *gd;
2845 u32 index;
2846 struct device *dev;
2848 sdp = sdkp->device;
2849 gd = sdkp->disk;
2850 index = sdkp->index;
2851 dev = &sdp->sdev_gendev;
2853 gd->major = sd_major((index & 0xf0) >> 4);
2854 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
2855 gd->minors = SD_MINORS;
2857 gd->fops = &sd_fops;
2858 gd->private_data = &sdkp->driver;
2859 gd->queue = sdkp->device->request_queue;
2861 /* defaults, until the device tells us otherwise */
2862 sdp->sector_size = 512;
2863 sdkp->capacity = 0;
2864 sdkp->media_present = 1;
2865 sdkp->write_prot = 0;
2866 sdkp->cache_override = 0;
2867 sdkp->WCE = 0;
2868 sdkp->RCD = 0;
2869 sdkp->ATO = 0;
2870 sdkp->first_scan = 1;
2871 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
2873 sd_revalidate_disk(gd);
2875 blk_queue_prep_rq(sdp->request_queue, sd_prep_fn);
2876 blk_queue_unprep_rq(sdp->request_queue, sd_unprep_fn);
2878 gd->driverfs_dev = &sdp->sdev_gendev;
2879 gd->flags = GENHD_FL_EXT_DEVT;
2880 if (sdp->removable) {
2881 gd->flags |= GENHD_FL_REMOVABLE;
2882 gd->events |= DISK_EVENT_MEDIA_CHANGE;
2885 blk_pm_runtime_init(sdp->request_queue, dev);
2886 add_disk(gd);
2887 if (sdkp->capacity)
2888 sd_dif_config_host(sdkp);
2890 sd_revalidate_disk(gd);
2892 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
2893 sdp->removable ? "removable " : "");
2894 scsi_autopm_put_device(sdp);
2895 put_device(&sdkp->dev);
2899 * sd_probe - called during driver initialization and whenever a
2900 * new scsi device is attached to the system. It is called once
2901 * for each scsi device (not just disks) present.
2902 * @dev: pointer to device object
2904 * Returns 0 if successful (or not interested in this scsi device
2905 * (e.g. scanner)); 1 when there is an error.
2907 * Note: this function is invoked from the scsi mid-level.
2908 * This function sets up the mapping between a given
2909 * <host,channel,id,lun> (found in sdp) and new device name
2910 * (e.g. /dev/sda). More precisely it is the block device major
2911 * and minor number that is chosen here.
2913 * Assume sd_probe is not re-entrant (for time being)
2914 * Also think about sd_probe() and sd_remove() running coincidentally.
2916 static int sd_probe(struct device *dev)
2918 struct scsi_device *sdp = to_scsi_device(dev);
2919 struct scsi_disk *sdkp;
2920 struct gendisk *gd;
2921 int index;
2922 int error;
2924 error = -ENODEV;
2925 if (sdp->type != TYPE_DISK && sdp->type != TYPE_MOD && sdp->type != TYPE_RBC)
2926 goto out;
2928 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
2929 "sd_probe\n"));
2931 error = -ENOMEM;
2932 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
2933 if (!sdkp)
2934 goto out;
2936 gd = alloc_disk(SD_MINORS);
2937 if (!gd)
2938 goto out_free;
2940 do {
2941 if (!ida_pre_get(&sd_index_ida, GFP_KERNEL))
2942 goto out_put;
2944 spin_lock(&sd_index_lock);
2945 error = ida_get_new(&sd_index_ida, &index);
2946 spin_unlock(&sd_index_lock);
2947 } while (error == -EAGAIN);
2949 if (error) {
2950 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
2951 goto out_put;
2954 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
2955 if (error) {
2956 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
2957 goto out_free_index;
2960 sdkp->device = sdp;
2961 sdkp->driver = &sd_template;
2962 sdkp->disk = gd;
2963 sdkp->index = index;
2964 atomic_set(&sdkp->openers, 0);
2965 atomic_set(&sdkp->device->ioerr_cnt, 0);
2967 if (!sdp->request_queue->rq_timeout) {
2968 if (sdp->type != TYPE_MOD)
2969 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
2970 else
2971 blk_queue_rq_timeout(sdp->request_queue,
2972 SD_MOD_TIMEOUT);
2975 device_initialize(&sdkp->dev);
2976 sdkp->dev.parent = dev;
2977 sdkp->dev.class = &sd_disk_class;
2978 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
2980 if (device_add(&sdkp->dev))
2981 goto out_free_index;
2983 get_device(dev);
2984 dev_set_drvdata(dev, sdkp);
2986 get_device(&sdkp->dev); /* prevent release before async_schedule */
2987 async_schedule_domain(sd_probe_async, sdkp, &scsi_sd_probe_domain);
2989 return 0;
2991 out_free_index:
2992 spin_lock(&sd_index_lock);
2993 ida_remove(&sd_index_ida, index);
2994 spin_unlock(&sd_index_lock);
2995 out_put:
2996 put_disk(gd);
2997 out_free:
2998 kfree(sdkp);
2999 out:
3000 return error;
3004 * sd_remove - called whenever a scsi disk (previously recognized by
3005 * sd_probe) is detached from the system. It is called (potentially
3006 * multiple times) during sd module unload.
3007 * @sdp: pointer to mid level scsi device object
3009 * Note: this function is invoked from the scsi mid-level.
3010 * This function potentially frees up a device name (e.g. /dev/sdc)
3011 * that could be re-used by a subsequent sd_probe().
3012 * This function is not called when the built-in sd driver is "exit-ed".
3014 static int sd_remove(struct device *dev)
3016 struct scsi_disk *sdkp;
3017 dev_t devt;
3019 sdkp = dev_get_drvdata(dev);
3020 devt = disk_devt(sdkp->disk);
3021 scsi_autopm_get_device(sdkp->device);
3023 async_synchronize_full_domain(&scsi_sd_probe_domain);
3024 blk_queue_prep_rq(sdkp->device->request_queue, scsi_prep_fn);
3025 blk_queue_unprep_rq(sdkp->device->request_queue, NULL);
3026 device_del(&sdkp->dev);
3027 del_gendisk(sdkp->disk);
3028 sd_shutdown(dev);
3030 blk_register_region(devt, SD_MINORS, NULL,
3031 sd_default_probe, NULL, NULL);
3033 mutex_lock(&sd_ref_mutex);
3034 dev_set_drvdata(dev, NULL);
3035 put_device(&sdkp->dev);
3036 mutex_unlock(&sd_ref_mutex);
3038 return 0;
3042 * scsi_disk_release - Called to free the scsi_disk structure
3043 * @dev: pointer to embedded class device
3045 * sd_ref_mutex must be held entering this routine. Because it is
3046 * called on last put, you should always use the scsi_disk_get()
3047 * scsi_disk_put() helpers which manipulate the semaphore directly
3048 * and never do a direct put_device.
3050 static void scsi_disk_release(struct device *dev)
3052 struct scsi_disk *sdkp = to_scsi_disk(dev);
3053 struct gendisk *disk = sdkp->disk;
3055 spin_lock(&sd_index_lock);
3056 ida_remove(&sd_index_ida, sdkp->index);
3057 spin_unlock(&sd_index_lock);
3059 disk->private_data = NULL;
3060 put_disk(disk);
3061 put_device(&sdkp->device->sdev_gendev);
3063 kfree(sdkp);
3066 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
3068 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3069 struct scsi_sense_hdr sshdr;
3070 struct scsi_device *sdp = sdkp->device;
3071 int res;
3073 if (start)
3074 cmd[4] |= 1; /* START */
3076 if (sdp->start_stop_pwr_cond)
3077 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3079 if (!scsi_device_online(sdp))
3080 return -ENODEV;
3082 res = scsi_execute_req_flags(sdp, cmd, DMA_NONE, NULL, 0, &sshdr,
3083 SD_TIMEOUT, SD_MAX_RETRIES, NULL, REQ_PM);
3084 if (res) {
3085 sd_printk(KERN_WARNING, sdkp, "START_STOP FAILED\n");
3086 sd_print_result(sdkp, res);
3087 if (driver_byte(res) & DRIVER_SENSE)
3088 sd_print_sense_hdr(sdkp, &sshdr);
3089 if (scsi_sense_valid(&sshdr) &&
3090 /* 0x3a is medium not present */
3091 sshdr.asc == 0x3a)
3092 res = 0;
3095 /* SCSI error codes must not go to the generic layer */
3096 if (res)
3097 return -EIO;
3099 return 0;
3103 * Send a SYNCHRONIZE CACHE instruction down to the device through
3104 * the normal SCSI command structure. Wait for the command to
3105 * complete.
3107 static void sd_shutdown(struct device *dev)
3109 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
3111 if (!sdkp)
3112 return; /* this can happen */
3114 if (pm_runtime_suspended(dev))
3115 goto exit;
3117 if (sdkp->WCE && sdkp->media_present) {
3118 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3119 sd_sync_cache(sdkp);
3122 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3123 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3124 sd_start_stop_device(sdkp, 0);
3127 exit:
3128 scsi_disk_put(sdkp);
3131 static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
3133 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
3134 int ret = 0;
3136 if (!sdkp)
3137 return 0; /* this can happen */
3139 if (sdkp->WCE && sdkp->media_present) {
3140 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3141 ret = sd_sync_cache(sdkp);
3142 if (ret) {
3143 /* ignore OFFLINE device */
3144 if (ret == -ENODEV)
3145 ret = 0;
3146 goto done;
3150 if (sdkp->device->manage_start_stop) {
3151 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3152 /* an error is not worth aborting a system sleep */
3153 ret = sd_start_stop_device(sdkp, 0);
3154 if (ignore_stop_errors)
3155 ret = 0;
3158 done:
3159 scsi_disk_put(sdkp);
3160 return ret;
3163 static int sd_suspend_system(struct device *dev)
3165 return sd_suspend_common(dev, true);
3168 static int sd_suspend_runtime(struct device *dev)
3170 return sd_suspend_common(dev, false);
3173 static int sd_resume(struct device *dev)
3175 struct scsi_disk *sdkp = scsi_disk_get_from_dev(dev);
3176 int ret = 0;
3178 if (!sdkp->device->manage_start_stop)
3179 goto done;
3181 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
3182 ret = sd_start_stop_device(sdkp, 1);
3184 done:
3185 scsi_disk_put(sdkp);
3186 return ret;
3190 * init_sd - entry point for this driver (both when built in or when
3191 * a module).
3193 * Note: this function registers this driver with the scsi mid-level.
3195 static int __init init_sd(void)
3197 int majors = 0, i, err;
3199 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3201 for (i = 0; i < SD_MAJORS; i++) {
3202 if (register_blkdev(sd_major(i), "sd") != 0)
3203 continue;
3204 majors++;
3205 blk_register_region(sd_major(i), SD_MINORS, NULL,
3206 sd_default_probe, NULL, NULL);
3209 if (!majors)
3210 return -ENODEV;
3212 err = class_register(&sd_disk_class);
3213 if (err)
3214 goto err_out;
3216 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3217 0, 0, NULL);
3218 if (!sd_cdb_cache) {
3219 printk(KERN_ERR "sd: can't init extended cdb cache\n");
3220 goto err_out_class;
3223 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3224 if (!sd_cdb_pool) {
3225 printk(KERN_ERR "sd: can't init extended cdb pool\n");
3226 goto err_out_cache;
3229 err = scsi_register_driver(&sd_template.gendrv);
3230 if (err)
3231 goto err_out_driver;
3233 return 0;
3235 err_out_driver:
3236 mempool_destroy(sd_cdb_pool);
3238 err_out_cache:
3239 kmem_cache_destroy(sd_cdb_cache);
3241 err_out_class:
3242 class_unregister(&sd_disk_class);
3243 err_out:
3244 for (i = 0; i < SD_MAJORS; i++)
3245 unregister_blkdev(sd_major(i), "sd");
3246 return err;
3250 * exit_sd - exit point for this driver (when it is a module).
3252 * Note: this function unregisters this driver from the scsi mid-level.
3254 static void __exit exit_sd(void)
3256 int i;
3258 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3260 scsi_unregister_driver(&sd_template.gendrv);
3261 mempool_destroy(sd_cdb_pool);
3262 kmem_cache_destroy(sd_cdb_cache);
3264 class_unregister(&sd_disk_class);
3266 for (i = 0; i < SD_MAJORS; i++) {
3267 blk_unregister_region(sd_major(i), SD_MINORS);
3268 unregister_blkdev(sd_major(i), "sd");
3272 module_init(init_sd);
3273 module_exit(exit_sd);
3275 static void sd_print_sense_hdr(struct scsi_disk *sdkp,
3276 struct scsi_sense_hdr *sshdr)
3278 sd_printk(KERN_INFO, sdkp, " ");
3279 scsi_show_sense_hdr(sshdr);
3280 sd_printk(KERN_INFO, sdkp, " ");
3281 scsi_show_extd_sense(sshdr->asc, sshdr->ascq);
3284 static void sd_print_result(struct scsi_disk *sdkp, int result)
3286 sd_printk(KERN_INFO, sdkp, " ");
3287 scsi_show_result(result);