1 // SPDX-License-Identifier: GPL-2.0-only
3 * sd.c Copyright (C) 1992 Drew Eckhardt
4 * Copyright (C) 1993, 1994, 1995, 1999 Eric Youngdale
6 * Linux scsi disk driver
7 * Initial versions: Drew Eckhardt
8 * Subsequent revisions: Eric Youngdale
9 * Modification history:
12 * outstanding request, and other enhancements.
13 * Support loadable low-level scsi drivers.
15 * eight major numbers.
18 * sd_init and cleanups.
20 * not being read in sd_open. Fix problem where removable media
21 * could be ejected after sd_open.
25 * Support 32k/1M disks.
27 * Logging policy (needs CONFIG_SCSI_LOGGING defined):
28 * - setting up transfer: SCSI_LOG_HLQUEUE levels 1 and 2
29 * - end of transfer (bh + scsi_lib): SCSI_LOG_HLCOMPLETE level 1
30 * - entering sd_ioctl: SCSI_LOG_IOCTL level 1
31 * - entering other commands: SCSI_LOG_HLQUEUE level 3
32 * Note: when the logging level is set by the user, it must be greater
33 * than the level indicated above to trigger output.
36 #include <linux/module.h>
38 #include <linux/kernel.h>
40 #include <linux/bio.h>
41 #include <linux/genhd.h>
42 #include <linux/hdreg.h>
43 #include <linux/errno.h>
44 #include <linux/idr.h>
45 #include <linux/interrupt.h>
46 #include <linux/init.h>
47 #include <linux/blkdev.h>
48 #include <linux/blkpg.h>
49 #include <linux/blk-pm.h>
50 #include <linux/delay.h>
51 #include <linux/mutex.h>
52 #include <linux/string_helpers.h>
53 #include <linux/async.h>
54 #include <linux/slab.h>
55 #include <linux/sed-opal.h>
56 #include <linux/pm_runtime.h>
58 #include <linux/t10-pi.h>
59 #include <linux/uaccess.h>
60 #include <asm/unaligned.h>
62 #include <scsi/scsi.h>
63 #include <scsi/scsi_cmnd.h>
64 #include <scsi/scsi_dbg.h>
65 #include <scsi/scsi_device.h>
66 #include <scsi/scsi_driver.h>
67 #include <scsi/scsi_eh.h>
68 #include <scsi/scsi_host.h>
69 #include <scsi/scsi_ioctl.h>
70 #include <scsi/scsicam.h>
73 #include "scsi_priv.h"
74 #include "scsi_logging.h"
76 MODULE_AUTHOR("Eric Youngdale");
77 MODULE_DESCRIPTION("SCSI disk (sd) driver");
78 MODULE_LICENSE("GPL");
80 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK0_MAJOR);
81 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK1_MAJOR);
82 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK2_MAJOR);
83 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK3_MAJOR);
84 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK4_MAJOR);
85 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK5_MAJOR);
86 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK6_MAJOR);
87 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK7_MAJOR);
88 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK8_MAJOR);
89 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK9_MAJOR);
90 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK10_MAJOR);
91 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK11_MAJOR);
92 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK12_MAJOR);
93 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK13_MAJOR);
94 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK14_MAJOR);
95 MODULE_ALIAS_BLOCKDEV_MAJOR(SCSI_DISK15_MAJOR);
96 MODULE_ALIAS_SCSI_DEVICE(TYPE_DISK);
97 MODULE_ALIAS_SCSI_DEVICE(TYPE_MOD);
98 MODULE_ALIAS_SCSI_DEVICE(TYPE_RBC);
99 MODULE_ALIAS_SCSI_DEVICE(TYPE_ZBC);
101 #if !defined(CONFIG_DEBUG_BLOCK_EXT_DEVT)
107 static void sd_config_discard(struct scsi_disk *, unsigned int);
108 static void sd_config_write_same(struct scsi_disk *);
109 static int sd_revalidate_disk(struct gendisk *);
110 static void sd_unlock_native_capacity(struct gendisk *disk);
111 static int sd_probe(struct device *);
112 static int sd_remove(struct device *);
113 static void sd_shutdown(struct device *);
114 static int sd_suspend_system(struct device *);
115 static int sd_suspend_runtime(struct device *);
116 static int sd_resume(struct device *);
117 static void sd_rescan(struct device *);
118 static blk_status_t sd_init_command(struct scsi_cmnd *SCpnt);
119 static void sd_uninit_command(struct scsi_cmnd *SCpnt);
120 static int sd_done(struct scsi_cmnd *);
121 static void sd_eh_reset(struct scsi_cmnd *);
122 static int sd_eh_action(struct scsi_cmnd *, int);
123 static void sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer);
124 static void scsi_disk_release(struct device *cdev);
126 static DEFINE_IDA(sd_index_ida);
128 /* This semaphore is used to mediate the 0->1 reference get in the
129 * face of object destruction (i.e. we can't allow a get on an
130 * object after last put) */
131 static DEFINE_MUTEX(sd_ref_mutex);
133 static struct kmem_cache *sd_cdb_cache;
134 static mempool_t *sd_cdb_pool;
135 static mempool_t *sd_page_pool;
137 static const char *sd_cache_types[] = {
138 "write through", "none", "write back",
139 "write back, no read (daft)"
142 static void sd_set_flush_flag(struct scsi_disk *sdkp)
144 bool wc = false, fua = false;
152 blk_queue_write_cache(sdkp->disk->queue, wc, fua);
156 cache_type_store(struct device *dev, struct device_attribute *attr,
157 const char *buf, size_t count)
159 int ct, rcd, wce, sp;
160 struct scsi_disk *sdkp = to_scsi_disk(dev);
161 struct scsi_device *sdp = sdkp->device;
164 struct scsi_mode_data data;
165 struct scsi_sense_hdr sshdr;
166 static const char temp[] = "temporary ";
169 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
170 /* no cache control on RBC devices; theoretically they
171 * can do it, but there's probably so many exceptions
172 * it's not worth the risk */
175 if (strncmp(buf, temp, sizeof(temp) - 1) == 0) {
176 buf += sizeof(temp) - 1;
177 sdkp->cache_override = 1;
179 sdkp->cache_override = 0;
182 ct = sysfs_match_string(sd_cache_types, buf);
186 rcd = ct & 0x01 ? 1 : 0;
187 wce = (ct & 0x02) && !sdkp->write_prot ? 1 : 0;
189 if (sdkp->cache_override) {
192 sd_set_flush_flag(sdkp);
196 if (scsi_mode_sense(sdp, 0x08, 8, buffer, sizeof(buffer), SD_TIMEOUT,
197 sdkp->max_retries, &data, NULL))
199 len = min_t(size_t, sizeof(buffer), data.length - data.header_length -
200 data.block_descriptor_length);
201 buffer_data = buffer + data.header_length +
202 data.block_descriptor_length;
203 buffer_data[2] &= ~0x05;
204 buffer_data[2] |= wce << 2 | rcd;
205 sp = buffer_data[0] & 0x80 ? 1 : 0;
206 buffer_data[0] &= ~0x80;
209 * Ensure WP, DPOFUA, and RESERVED fields are cleared in
210 * received mode parameter buffer before doing MODE SELECT.
212 data.device_specific = 0;
214 if (scsi_mode_select(sdp, 1, sp, 8, buffer_data, len, SD_TIMEOUT,
215 sdkp->max_retries, &data, &sshdr)) {
216 if (scsi_sense_valid(&sshdr))
217 sd_print_sense_hdr(sdkp, &sshdr);
220 sd_revalidate_disk(sdkp->disk);
225 manage_start_stop_show(struct device *dev, struct device_attribute *attr,
228 struct scsi_disk *sdkp = to_scsi_disk(dev);
229 struct scsi_device *sdp = sdkp->device;
231 return sprintf(buf, "%u\n", sdp->manage_start_stop);
235 manage_start_stop_store(struct device *dev, struct device_attribute *attr,
236 const char *buf, size_t count)
238 struct scsi_disk *sdkp = to_scsi_disk(dev);
239 struct scsi_device *sdp = sdkp->device;
242 if (!capable(CAP_SYS_ADMIN))
245 if (kstrtobool(buf, &v))
248 sdp->manage_start_stop = v;
252 static DEVICE_ATTR_RW(manage_start_stop);
255 allow_restart_show(struct device *dev, struct device_attribute *attr, char *buf)
257 struct scsi_disk *sdkp = to_scsi_disk(dev);
259 return sprintf(buf, "%u\n", sdkp->device->allow_restart);
263 allow_restart_store(struct device *dev, struct device_attribute *attr,
264 const char *buf, size_t count)
267 struct scsi_disk *sdkp = to_scsi_disk(dev);
268 struct scsi_device *sdp = sdkp->device;
270 if (!capable(CAP_SYS_ADMIN))
273 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
276 if (kstrtobool(buf, &v))
279 sdp->allow_restart = v;
283 static DEVICE_ATTR_RW(allow_restart);
286 cache_type_show(struct device *dev, struct device_attribute *attr, char *buf)
288 struct scsi_disk *sdkp = to_scsi_disk(dev);
289 int ct = sdkp->RCD + 2*sdkp->WCE;
291 return sprintf(buf, "%s\n", sd_cache_types[ct]);
293 static DEVICE_ATTR_RW(cache_type);
296 FUA_show(struct device *dev, struct device_attribute *attr, char *buf)
298 struct scsi_disk *sdkp = to_scsi_disk(dev);
300 return sprintf(buf, "%u\n", sdkp->DPOFUA);
302 static DEVICE_ATTR_RO(FUA);
305 protection_type_show(struct device *dev, struct device_attribute *attr,
308 struct scsi_disk *sdkp = to_scsi_disk(dev);
310 return sprintf(buf, "%u\n", sdkp->protection_type);
314 protection_type_store(struct device *dev, struct device_attribute *attr,
315 const char *buf, size_t count)
317 struct scsi_disk *sdkp = to_scsi_disk(dev);
321 if (!capable(CAP_SYS_ADMIN))
324 err = kstrtouint(buf, 10, &val);
329 if (val <= T10_PI_TYPE3_PROTECTION)
330 sdkp->protection_type = val;
334 static DEVICE_ATTR_RW(protection_type);
337 protection_mode_show(struct device *dev, struct device_attribute *attr,
340 struct scsi_disk *sdkp = to_scsi_disk(dev);
341 struct scsi_device *sdp = sdkp->device;
342 unsigned int dif, dix;
344 dif = scsi_host_dif_capable(sdp->host, sdkp->protection_type);
345 dix = scsi_host_dix_capable(sdp->host, sdkp->protection_type);
347 if (!dix && scsi_host_dix_capable(sdp->host, T10_PI_TYPE0_PROTECTION)) {
353 return sprintf(buf, "none\n");
355 return sprintf(buf, "%s%u\n", dix ? "dix" : "dif", dif);
357 static DEVICE_ATTR_RO(protection_mode);
360 app_tag_own_show(struct device *dev, struct device_attribute *attr, char *buf)
362 struct scsi_disk *sdkp = to_scsi_disk(dev);
364 return sprintf(buf, "%u\n", sdkp->ATO);
366 static DEVICE_ATTR_RO(app_tag_own);
369 thin_provisioning_show(struct device *dev, struct device_attribute *attr,
372 struct scsi_disk *sdkp = to_scsi_disk(dev);
374 return sprintf(buf, "%u\n", sdkp->lbpme);
376 static DEVICE_ATTR_RO(thin_provisioning);
378 /* sysfs_match_string() requires dense arrays */
379 static const char *lbp_mode[] = {
380 [SD_LBP_FULL] = "full",
381 [SD_LBP_UNMAP] = "unmap",
382 [SD_LBP_WS16] = "writesame_16",
383 [SD_LBP_WS10] = "writesame_10",
384 [SD_LBP_ZERO] = "writesame_zero",
385 [SD_LBP_DISABLE] = "disabled",
389 provisioning_mode_show(struct device *dev, struct device_attribute *attr,
392 struct scsi_disk *sdkp = to_scsi_disk(dev);
394 return sprintf(buf, "%s\n", lbp_mode[sdkp->provisioning_mode]);
398 provisioning_mode_store(struct device *dev, struct device_attribute *attr,
399 const char *buf, size_t count)
401 struct scsi_disk *sdkp = to_scsi_disk(dev);
402 struct scsi_device *sdp = sdkp->device;
405 if (!capable(CAP_SYS_ADMIN))
408 if (sd_is_zoned(sdkp)) {
409 sd_config_discard(sdkp, SD_LBP_DISABLE);
413 if (sdp->type != TYPE_DISK)
416 mode = sysfs_match_string(lbp_mode, buf);
420 sd_config_discard(sdkp, mode);
424 static DEVICE_ATTR_RW(provisioning_mode);
426 /* sysfs_match_string() requires dense arrays */
427 static const char *zeroing_mode[] = {
428 [SD_ZERO_WRITE] = "write",
429 [SD_ZERO_WS] = "writesame",
430 [SD_ZERO_WS16_UNMAP] = "writesame_16_unmap",
431 [SD_ZERO_WS10_UNMAP] = "writesame_10_unmap",
435 zeroing_mode_show(struct device *dev, struct device_attribute *attr,
438 struct scsi_disk *sdkp = to_scsi_disk(dev);
440 return sprintf(buf, "%s\n", zeroing_mode[sdkp->zeroing_mode]);
444 zeroing_mode_store(struct device *dev, struct device_attribute *attr,
445 const char *buf, size_t count)
447 struct scsi_disk *sdkp = to_scsi_disk(dev);
450 if (!capable(CAP_SYS_ADMIN))
453 mode = sysfs_match_string(zeroing_mode, buf);
457 sdkp->zeroing_mode = mode;
461 static DEVICE_ATTR_RW(zeroing_mode);
464 max_medium_access_timeouts_show(struct device *dev,
465 struct device_attribute *attr, char *buf)
467 struct scsi_disk *sdkp = to_scsi_disk(dev);
469 return sprintf(buf, "%u\n", sdkp->max_medium_access_timeouts);
473 max_medium_access_timeouts_store(struct device *dev,
474 struct device_attribute *attr, const char *buf,
477 struct scsi_disk *sdkp = to_scsi_disk(dev);
480 if (!capable(CAP_SYS_ADMIN))
483 err = kstrtouint(buf, 10, &sdkp->max_medium_access_timeouts);
485 return err ? err : count;
487 static DEVICE_ATTR_RW(max_medium_access_timeouts);
490 max_write_same_blocks_show(struct device *dev, struct device_attribute *attr,
493 struct scsi_disk *sdkp = to_scsi_disk(dev);
495 return sprintf(buf, "%u\n", sdkp->max_ws_blocks);
499 max_write_same_blocks_store(struct device *dev, struct device_attribute *attr,
500 const char *buf, size_t count)
502 struct scsi_disk *sdkp = to_scsi_disk(dev);
503 struct scsi_device *sdp = sdkp->device;
507 if (!capable(CAP_SYS_ADMIN))
510 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
513 err = kstrtoul(buf, 10, &max);
519 sdp->no_write_same = 1;
520 else if (max <= SD_MAX_WS16_BLOCKS) {
521 sdp->no_write_same = 0;
522 sdkp->max_ws_blocks = max;
525 sd_config_write_same(sdkp);
529 static DEVICE_ATTR_RW(max_write_same_blocks);
532 zoned_cap_show(struct device *dev, struct device_attribute *attr, char *buf)
534 struct scsi_disk *sdkp = to_scsi_disk(dev);
536 if (sdkp->device->type == TYPE_ZBC)
537 return sprintf(buf, "host-managed\n");
538 if (sdkp->zoned == 1)
539 return sprintf(buf, "host-aware\n");
540 if (sdkp->zoned == 2)
541 return sprintf(buf, "drive-managed\n");
542 return sprintf(buf, "none\n");
544 static DEVICE_ATTR_RO(zoned_cap);
547 max_retries_store(struct device *dev, struct device_attribute *attr,
548 const char *buf, size_t count)
550 struct scsi_disk *sdkp = to_scsi_disk(dev);
551 struct scsi_device *sdev = sdkp->device;
554 err = kstrtoint(buf, 10, &retries);
558 if (retries == SCSI_CMD_RETRIES_NO_LIMIT || retries <= SD_MAX_RETRIES) {
559 sdkp->max_retries = retries;
563 sdev_printk(KERN_ERR, sdev, "max_retries must be between -1 and %d\n",
569 max_retries_show(struct device *dev, struct device_attribute *attr,
572 struct scsi_disk *sdkp = to_scsi_disk(dev);
574 return sprintf(buf, "%d\n", sdkp->max_retries);
577 static DEVICE_ATTR_RW(max_retries);
579 static struct attribute *sd_disk_attrs[] = {
580 &dev_attr_cache_type.attr,
582 &dev_attr_allow_restart.attr,
583 &dev_attr_manage_start_stop.attr,
584 &dev_attr_protection_type.attr,
585 &dev_attr_protection_mode.attr,
586 &dev_attr_app_tag_own.attr,
587 &dev_attr_thin_provisioning.attr,
588 &dev_attr_provisioning_mode.attr,
589 &dev_attr_zeroing_mode.attr,
590 &dev_attr_max_write_same_blocks.attr,
591 &dev_attr_max_medium_access_timeouts.attr,
592 &dev_attr_zoned_cap.attr,
593 &dev_attr_max_retries.attr,
596 ATTRIBUTE_GROUPS(sd_disk);
598 static struct class sd_disk_class = {
600 .owner = THIS_MODULE,
601 .dev_release = scsi_disk_release,
602 .dev_groups = sd_disk_groups,
605 static const struct dev_pm_ops sd_pm_ops = {
606 .suspend = sd_suspend_system,
608 .poweroff = sd_suspend_system,
609 .restore = sd_resume,
610 .runtime_suspend = sd_suspend_runtime,
611 .runtime_resume = sd_resume,
614 static struct scsi_driver sd_template = {
617 .owner = THIS_MODULE,
619 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
621 .shutdown = sd_shutdown,
625 .init_command = sd_init_command,
626 .uninit_command = sd_uninit_command,
628 .eh_action = sd_eh_action,
629 .eh_reset = sd_eh_reset,
633 * Don't request a new module, as that could deadlock in multipath
636 static void sd_default_probe(dev_t devt)
641 * Device no to disk mapping:
643 * major disc2 disc p1
644 * |............|.............|....|....| <- dev_t
647 * Inside a major, we have 16k disks, however mapped non-
648 * contiguously. The first 16 disks are for major0, the next
649 * ones with major1, ... Disk 256 is for major0 again, disk 272
651 * As we stay compatible with our numbering scheme, we can reuse
652 * the well-know SCSI majors 8, 65--71, 136--143.
654 static int sd_major(int major_idx)
658 return SCSI_DISK0_MAJOR;
660 return SCSI_DISK1_MAJOR + major_idx - 1;
662 return SCSI_DISK8_MAJOR + major_idx - 8;
665 return 0; /* shut up gcc */
669 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
671 struct scsi_disk *sdkp = NULL;
673 mutex_lock(&sd_ref_mutex);
675 if (disk->private_data) {
676 sdkp = scsi_disk(disk);
677 if (scsi_device_get(sdkp->device) == 0)
678 get_device(&sdkp->dev);
682 mutex_unlock(&sd_ref_mutex);
686 static void scsi_disk_put(struct scsi_disk *sdkp)
688 struct scsi_device *sdev = sdkp->device;
690 mutex_lock(&sd_ref_mutex);
691 put_device(&sdkp->dev);
692 scsi_device_put(sdev);
693 mutex_unlock(&sd_ref_mutex);
696 #ifdef CONFIG_BLK_SED_OPAL
697 static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
698 size_t len, bool send)
700 struct scsi_disk *sdkp = data;
701 struct scsi_device *sdev = sdkp->device;
705 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
707 put_unaligned_be16(spsp, &cdb[2]);
708 put_unaligned_be32(len, &cdb[6]);
710 ret = scsi_execute(sdev, cdb, send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
711 buffer, len, NULL, NULL, SD_TIMEOUT, sdkp->max_retries, 0,
713 return ret <= 0 ? ret : -EIO;
715 #endif /* CONFIG_BLK_SED_OPAL */
718 * Look up the DIX operation based on whether the command is read or
719 * write and whether dix and dif are enabled.
721 static unsigned int sd_prot_op(bool write, bool dix, bool dif)
723 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
724 static const unsigned int ops[] = { /* wrt dix dif */
725 SCSI_PROT_NORMAL, /* 0 0 0 */
726 SCSI_PROT_READ_STRIP, /* 0 0 1 */
727 SCSI_PROT_READ_INSERT, /* 0 1 0 */
728 SCSI_PROT_READ_PASS, /* 0 1 1 */
729 SCSI_PROT_NORMAL, /* 1 0 0 */
730 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
731 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
732 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
735 return ops[write << 2 | dix << 1 | dif];
739 * Returns a mask of the protection flags that are valid for a given DIX
742 static unsigned int sd_prot_flag_mask(unsigned int prot_op)
744 static const unsigned int flag_mask[] = {
745 [SCSI_PROT_NORMAL] = 0,
747 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
748 SCSI_PROT_GUARD_CHECK |
749 SCSI_PROT_REF_CHECK |
750 SCSI_PROT_REF_INCREMENT,
752 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
753 SCSI_PROT_IP_CHECKSUM,
755 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
756 SCSI_PROT_GUARD_CHECK |
757 SCSI_PROT_REF_CHECK |
758 SCSI_PROT_REF_INCREMENT |
759 SCSI_PROT_IP_CHECKSUM,
761 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
762 SCSI_PROT_REF_INCREMENT,
764 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
765 SCSI_PROT_REF_CHECK |
766 SCSI_PROT_REF_INCREMENT |
767 SCSI_PROT_IP_CHECKSUM,
769 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
770 SCSI_PROT_GUARD_CHECK |
771 SCSI_PROT_REF_CHECK |
772 SCSI_PROT_REF_INCREMENT |
773 SCSI_PROT_IP_CHECKSUM,
776 return flag_mask[prot_op];
779 static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
780 unsigned int dix, unsigned int dif)
782 struct bio *bio = scmd->request->bio;
783 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
784 unsigned int protect = 0;
786 if (dix) { /* DIX Type 0, 1, 2, 3 */
787 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
788 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
790 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
791 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
794 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
795 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
797 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
798 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
801 if (dif) { /* DIX/DIF Type 1, 2, 3 */
802 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
804 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
805 protect = 3 << 5; /* Disable target PI checking */
807 protect = 1 << 5; /* Enable target PI checking */
810 scsi_set_prot_op(scmd, prot_op);
811 scsi_set_prot_type(scmd, dif);
812 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
817 static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
819 struct request_queue *q = sdkp->disk->queue;
820 unsigned int logical_block_size = sdkp->device->sector_size;
821 unsigned int max_blocks = 0;
823 q->limits.discard_alignment =
824 sdkp->unmap_alignment * logical_block_size;
825 q->limits.discard_granularity =
826 max(sdkp->physical_block_size,
827 sdkp->unmap_granularity * logical_block_size);
828 sdkp->provisioning_mode = mode;
834 blk_queue_max_discard_sectors(q, 0);
835 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
839 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
840 (u32)SD_MAX_WS16_BLOCKS);
844 if (sdkp->device->unmap_limit_for_ws)
845 max_blocks = sdkp->max_unmap_blocks;
847 max_blocks = sdkp->max_ws_blocks;
849 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
853 if (sdkp->device->unmap_limit_for_ws)
854 max_blocks = sdkp->max_unmap_blocks;
856 max_blocks = sdkp->max_ws_blocks;
858 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
862 max_blocks = min_not_zero(sdkp->max_ws_blocks,
863 (u32)SD_MAX_WS10_BLOCKS);
867 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
868 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
871 static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
873 struct scsi_device *sdp = cmd->device;
874 struct request *rq = cmd->request;
875 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
876 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
877 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
878 unsigned int data_len = 24;
881 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
882 if (!rq->special_vec.bv_page)
883 return BLK_STS_RESOURCE;
884 clear_highpage(rq->special_vec.bv_page);
885 rq->special_vec.bv_offset = 0;
886 rq->special_vec.bv_len = data_len;
887 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
890 cmd->cmnd[0] = UNMAP;
893 buf = page_address(rq->special_vec.bv_page);
894 put_unaligned_be16(6 + 16, &buf[0]);
895 put_unaligned_be16(16, &buf[2]);
896 put_unaligned_be64(lba, &buf[8]);
897 put_unaligned_be32(nr_blocks, &buf[16]);
899 cmd->allowed = sdkp->max_retries;
900 cmd->transfersize = data_len;
901 rq->timeout = SD_TIMEOUT;
903 return scsi_alloc_sgtables(cmd);
906 static blk_status_t sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd,
909 struct scsi_device *sdp = cmd->device;
910 struct request *rq = cmd->request;
911 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
912 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
913 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
914 u32 data_len = sdp->sector_size;
916 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
917 if (!rq->special_vec.bv_page)
918 return BLK_STS_RESOURCE;
919 clear_highpage(rq->special_vec.bv_page);
920 rq->special_vec.bv_offset = 0;
921 rq->special_vec.bv_len = data_len;
922 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
925 cmd->cmnd[0] = WRITE_SAME_16;
927 cmd->cmnd[1] = 0x8; /* UNMAP */
928 put_unaligned_be64(lba, &cmd->cmnd[2]);
929 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
931 cmd->allowed = sdkp->max_retries;
932 cmd->transfersize = data_len;
933 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
935 return scsi_alloc_sgtables(cmd);
938 static blk_status_t sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd,
941 struct scsi_device *sdp = cmd->device;
942 struct request *rq = cmd->request;
943 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
944 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
945 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
946 u32 data_len = sdp->sector_size;
948 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
949 if (!rq->special_vec.bv_page)
950 return BLK_STS_RESOURCE;
951 clear_highpage(rq->special_vec.bv_page);
952 rq->special_vec.bv_offset = 0;
953 rq->special_vec.bv_len = data_len;
954 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
957 cmd->cmnd[0] = WRITE_SAME;
959 cmd->cmnd[1] = 0x8; /* UNMAP */
960 put_unaligned_be32(lba, &cmd->cmnd[2]);
961 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
963 cmd->allowed = sdkp->max_retries;
964 cmd->transfersize = data_len;
965 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
967 return scsi_alloc_sgtables(cmd);
970 static blk_status_t sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
972 struct request *rq = cmd->request;
973 struct scsi_device *sdp = cmd->device;
974 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
975 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
976 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
978 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
979 switch (sdkp->zeroing_mode) {
980 case SD_ZERO_WS16_UNMAP:
981 return sd_setup_write_same16_cmnd(cmd, true);
982 case SD_ZERO_WS10_UNMAP:
983 return sd_setup_write_same10_cmnd(cmd, true);
987 if (sdp->no_write_same) {
988 rq->rq_flags |= RQF_QUIET;
989 return BLK_STS_TARGET;
992 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff)
993 return sd_setup_write_same16_cmnd(cmd, false);
995 return sd_setup_write_same10_cmnd(cmd, false);
998 static void sd_config_write_same(struct scsi_disk *sdkp)
1000 struct request_queue *q = sdkp->disk->queue;
1001 unsigned int logical_block_size = sdkp->device->sector_size;
1003 if (sdkp->device->no_write_same) {
1004 sdkp->max_ws_blocks = 0;
1008 /* Some devices can not handle block counts above 0xffff despite
1009 * supporting WRITE SAME(16). Consequently we default to 64k
1010 * blocks per I/O unless the device explicitly advertises a
1013 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
1014 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
1015 (u32)SD_MAX_WS16_BLOCKS);
1016 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
1017 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
1018 (u32)SD_MAX_WS10_BLOCKS);
1020 sdkp->device->no_write_same = 1;
1021 sdkp->max_ws_blocks = 0;
1024 if (sdkp->lbprz && sdkp->lbpws)
1025 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
1026 else if (sdkp->lbprz && sdkp->lbpws10)
1027 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
1028 else if (sdkp->max_ws_blocks)
1029 sdkp->zeroing_mode = SD_ZERO_WS;
1031 sdkp->zeroing_mode = SD_ZERO_WRITE;
1033 if (sdkp->max_ws_blocks &&
1034 sdkp->physical_block_size > logical_block_size) {
1036 * Reporting a maximum number of blocks that is not aligned
1037 * on the device physical size would cause a large write same
1038 * request to be split into physically unaligned chunks by
1039 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
1040 * even if the caller of these functions took care to align the
1041 * large request. So make sure the maximum reported is aligned
1042 * to the device physical block size. This is only an optional
1043 * optimization for regular disks, but this is mandatory to
1044 * avoid failure of large write same requests directed at
1045 * sequential write required zones of host-managed ZBC disks.
1047 sdkp->max_ws_blocks =
1048 round_down(sdkp->max_ws_blocks,
1049 bytes_to_logical(sdkp->device,
1050 sdkp->physical_block_size));
1054 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
1055 (logical_block_size >> 9));
1056 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
1057 (logical_block_size >> 9));
1061 * sd_setup_write_same_cmnd - write the same data to multiple blocks
1062 * @cmd: command to prepare
1064 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
1065 * the preference indicated by the target device.
1067 static blk_status_t sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
1069 struct request *rq = cmd->request;
1070 struct scsi_device *sdp = cmd->device;
1071 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1072 struct bio *bio = rq->bio;
1073 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1074 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
1077 if (sdkp->device->no_write_same)
1078 return BLK_STS_TARGET;
1080 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
1082 rq->timeout = SD_WRITE_SAME_TIMEOUT;
1084 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff) {
1086 cmd->cmnd[0] = WRITE_SAME_16;
1087 put_unaligned_be64(lba, &cmd->cmnd[2]);
1088 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1091 cmd->cmnd[0] = WRITE_SAME;
1092 put_unaligned_be32(lba, &cmd->cmnd[2]);
1093 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1096 cmd->transfersize = sdp->sector_size;
1097 cmd->allowed = sdkp->max_retries;
1100 * For WRITE SAME the data transferred via the DATA OUT buffer is
1101 * different from the amount of data actually written to the target.
1103 * We set up __data_len to the amount of data transferred via the
1104 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
1105 * to transfer a single sector of data first, but then reset it to
1106 * the amount of data to be written right after so that the I/O path
1107 * knows how much to actually write.
1109 rq->__data_len = sdp->sector_size;
1110 ret = scsi_alloc_sgtables(cmd);
1111 rq->__data_len = blk_rq_bytes(rq);
1116 static blk_status_t sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
1118 struct request *rq = cmd->request;
1119 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1121 /* flush requests don't perform I/O, zero the S/G table */
1122 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1124 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1126 cmd->transfersize = 0;
1127 cmd->allowed = sdkp->max_retries;
1129 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
1133 static blk_status_t sd_setup_rw32_cmnd(struct scsi_cmnd *cmd, bool write,
1134 sector_t lba, unsigned int nr_blocks,
1135 unsigned char flags)
1137 cmd->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1138 if (unlikely(cmd->cmnd == NULL))
1139 return BLK_STS_RESOURCE;
1141 cmd->cmd_len = SD_EXT_CDB_SIZE;
1142 memset(cmd->cmnd, 0, cmd->cmd_len);
1144 cmd->cmnd[0] = VARIABLE_LENGTH_CMD;
1145 cmd->cmnd[7] = 0x18; /* Additional CDB len */
1146 cmd->cmnd[9] = write ? WRITE_32 : READ_32;
1147 cmd->cmnd[10] = flags;
1148 put_unaligned_be64(lba, &cmd->cmnd[12]);
1149 put_unaligned_be32(lba, &cmd->cmnd[20]); /* Expected Indirect LBA */
1150 put_unaligned_be32(nr_blocks, &cmd->cmnd[28]);
1155 static blk_status_t sd_setup_rw16_cmnd(struct scsi_cmnd *cmd, bool write,
1156 sector_t lba, unsigned int nr_blocks,
1157 unsigned char flags)
1160 cmd->cmnd[0] = write ? WRITE_16 : READ_16;
1161 cmd->cmnd[1] = flags;
1164 put_unaligned_be64(lba, &cmd->cmnd[2]);
1165 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1170 static blk_status_t sd_setup_rw10_cmnd(struct scsi_cmnd *cmd, bool write,
1171 sector_t lba, unsigned int nr_blocks,
1172 unsigned char flags)
1175 cmd->cmnd[0] = write ? WRITE_10 : READ_10;
1176 cmd->cmnd[1] = flags;
1179 put_unaligned_be32(lba, &cmd->cmnd[2]);
1180 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1185 static blk_status_t sd_setup_rw6_cmnd(struct scsi_cmnd *cmd, bool write,
1186 sector_t lba, unsigned int nr_blocks,
1187 unsigned char flags)
1189 /* Avoid that 0 blocks gets translated into 256 blocks. */
1190 if (WARN_ON_ONCE(nr_blocks == 0))
1191 return BLK_STS_IOERR;
1193 if (unlikely(flags & 0x8)) {
1195 * This happens only if this drive failed 10byte rw
1196 * command with ILLEGAL_REQUEST during operation and
1197 * thus turned off use_10_for_rw.
1199 scmd_printk(KERN_ERR, cmd, "FUA write on READ/WRITE(6) drive\n");
1200 return BLK_STS_IOERR;
1204 cmd->cmnd[0] = write ? WRITE_6 : READ_6;
1205 cmd->cmnd[1] = (lba >> 16) & 0x1f;
1206 cmd->cmnd[2] = (lba >> 8) & 0xff;
1207 cmd->cmnd[3] = lba & 0xff;
1208 cmd->cmnd[4] = nr_blocks;
1214 static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *cmd)
1216 struct request *rq = cmd->request;
1217 struct scsi_device *sdp = cmd->device;
1218 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1219 sector_t lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1221 unsigned int nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
1222 unsigned int mask = logical_to_sectors(sdp, 1) - 1;
1223 bool write = rq_data_dir(rq) == WRITE;
1224 unsigned char protect, fua;
1229 ret = scsi_alloc_sgtables(cmd);
1230 if (ret != BLK_STS_OK)
1233 ret = BLK_STS_IOERR;
1234 if (!scsi_device_online(sdp) || sdp->changed) {
1235 scmd_printk(KERN_ERR, cmd, "device offline or changed\n");
1239 if (blk_rq_pos(rq) + blk_rq_sectors(rq) > get_capacity(rq->rq_disk)) {
1240 scmd_printk(KERN_ERR, cmd, "access beyond end of device\n");
1244 if ((blk_rq_pos(rq) & mask) || (blk_rq_sectors(rq) & mask)) {
1245 scmd_printk(KERN_ERR, cmd, "request not aligned to the logical block size\n");
1250 * Some SD card readers can't handle accesses which touch the
1251 * last one or two logical blocks. Split accesses as needed.
1253 threshold = sdkp->capacity - SD_LAST_BUGGY_SECTORS;
1255 if (unlikely(sdp->last_sector_bug && lba + nr_blocks > threshold)) {
1256 if (lba < threshold) {
1257 /* Access up to the threshold but not beyond */
1258 nr_blocks = threshold - lba;
1260 /* Access only a single logical block */
1265 if (req_op(rq) == REQ_OP_ZONE_APPEND) {
1266 ret = sd_zbc_prepare_zone_append(cmd, &lba, nr_blocks);
1271 fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
1272 dix = scsi_prot_sg_count(cmd);
1273 dif = scsi_host_dif_capable(cmd->device->host, sdkp->protection_type);
1276 protect = sd_setup_protect_cmnd(cmd, dix, dif);
1280 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
1281 ret = sd_setup_rw32_cmnd(cmd, write, lba, nr_blocks,
1283 } else if (sdp->use_16_for_rw || (nr_blocks > 0xffff)) {
1284 ret = sd_setup_rw16_cmnd(cmd, write, lba, nr_blocks,
1286 } else if ((nr_blocks > 0xff) || (lba > 0x1fffff) ||
1287 sdp->use_10_for_rw || protect) {
1288 ret = sd_setup_rw10_cmnd(cmd, write, lba, nr_blocks,
1291 ret = sd_setup_rw6_cmnd(cmd, write, lba, nr_blocks,
1295 if (unlikely(ret != BLK_STS_OK))
1299 * We shouldn't disconnect in the middle of a sector, so with a dumb
1300 * host adapter, it's safe to assume that we can at least transfer
1301 * this many bytes between each connect / disconnect.
1303 cmd->transfersize = sdp->sector_size;
1304 cmd->underflow = nr_blocks << 9;
1305 cmd->allowed = sdkp->max_retries;
1306 cmd->sdb.length = nr_blocks * sdp->sector_size;
1309 scmd_printk(KERN_INFO, cmd,
1310 "%s: block=%llu, count=%d\n", __func__,
1311 (unsigned long long)blk_rq_pos(rq),
1312 blk_rq_sectors(rq)));
1314 scmd_printk(KERN_INFO, cmd,
1315 "%s %d/%u 512 byte blocks.\n",
1316 write ? "writing" : "reading", nr_blocks,
1317 blk_rq_sectors(rq)));
1320 * This indicates that the command is ready from our end to be queued.
1324 scsi_free_sgtables(cmd);
1328 static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
1330 struct request *rq = cmd->request;
1332 switch (req_op(rq)) {
1333 case REQ_OP_DISCARD:
1334 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1336 return sd_setup_unmap_cmnd(cmd);
1338 return sd_setup_write_same16_cmnd(cmd, true);
1340 return sd_setup_write_same10_cmnd(cmd, true);
1342 return sd_setup_write_same10_cmnd(cmd, false);
1344 return BLK_STS_TARGET;
1346 case REQ_OP_WRITE_ZEROES:
1347 return sd_setup_write_zeroes_cmnd(cmd);
1348 case REQ_OP_WRITE_SAME:
1349 return sd_setup_write_same_cmnd(cmd);
1351 return sd_setup_flush_cmnd(cmd);
1354 case REQ_OP_ZONE_APPEND:
1355 return sd_setup_read_write_cmnd(cmd);
1356 case REQ_OP_ZONE_RESET:
1357 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
1359 case REQ_OP_ZONE_RESET_ALL:
1360 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
1362 case REQ_OP_ZONE_OPEN:
1363 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_OPEN_ZONE, false);
1364 case REQ_OP_ZONE_CLOSE:
1365 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_CLOSE_ZONE, false);
1366 case REQ_OP_ZONE_FINISH:
1367 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_FINISH_ZONE, false);
1370 return BLK_STS_NOTSUPP;
1374 static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1376 struct request *rq = SCpnt->request;
1379 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1380 mempool_free(rq->special_vec.bv_page, sd_page_pool);
1382 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
1386 mempool_free(cmnd, sd_cdb_pool);
1390 static bool sd_need_revalidate(struct block_device *bdev,
1391 struct scsi_disk *sdkp)
1393 if (sdkp->device->removable || sdkp->write_prot) {
1394 if (bdev_check_media_change(bdev))
1399 * Force a full rescan after ioctl(BLKRRPART). While the disk state has
1400 * nothing to do with partitions, BLKRRPART is used to force a full
1401 * revalidate after things like a format for historical reasons.
1403 return test_bit(GD_NEED_PART_SCAN, &bdev->bd_disk->state);
1407 * sd_open - open a scsi disk device
1408 * @bdev: Block device of the scsi disk to open
1409 * @mode: FMODE_* mask
1411 * Returns 0 if successful. Returns a negated errno value in case
1414 * Note: This can be called from a user context (e.g. fsck(1) )
1415 * or from within the kernel (e.g. as a result of a mount(1) ).
1416 * In the latter case @inode and @filp carry an abridged amount
1417 * of information as noted above.
1419 * Locking: called with bdev->bd_disk->open_mutex held.
1421 static int sd_open(struct block_device *bdev, fmode_t mode)
1423 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1424 struct scsi_device *sdev;
1430 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1432 sdev = sdkp->device;
1435 * If the device is in error recovery, wait until it is done.
1436 * If the device is offline, then disallow any access to it.
1439 if (!scsi_block_when_processing_errors(sdev))
1442 if (sd_need_revalidate(bdev, sdkp))
1443 sd_revalidate_disk(bdev->bd_disk);
1446 * If the drive is empty, just let the open fail.
1448 retval = -ENOMEDIUM;
1449 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1453 * If the device has the write protect tab set, have the open fail
1454 * if the user expects to be able to write to the thing.
1457 if (sdkp->write_prot && (mode & FMODE_WRITE))
1461 * It is possible that the disk changing stuff resulted in
1462 * the device being taken offline. If this is the case,
1463 * report this to the user, and don't pretend that the
1464 * open actually succeeded.
1467 if (!scsi_device_online(sdev))
1470 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1471 if (scsi_block_when_processing_errors(sdev))
1472 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1478 scsi_disk_put(sdkp);
1483 * sd_release - invoked when the (last) close(2) is called on this
1485 * @disk: disk to release
1486 * @mode: FMODE_* mask
1490 * Note: may block (uninterruptible) if error recovery is underway
1493 * Locking: called with bdev->bd_disk->open_mutex held.
1495 static void sd_release(struct gendisk *disk, fmode_t mode)
1497 struct scsi_disk *sdkp = scsi_disk(disk);
1498 struct scsi_device *sdev = sdkp->device;
1500 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1502 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1503 if (scsi_block_when_processing_errors(sdev))
1504 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1507 scsi_disk_put(sdkp);
1510 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1512 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1513 struct scsi_device *sdp = sdkp->device;
1514 struct Scsi_Host *host = sdp->host;
1515 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
1518 /* default to most commonly used values */
1519 diskinfo[0] = 0x40; /* 1 << 6 */
1520 diskinfo[1] = 0x20; /* 1 << 5 */
1521 diskinfo[2] = capacity >> 11;
1523 /* override with calculated, extended default, or driver values */
1524 if (host->hostt->bios_param)
1525 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
1527 scsicam_bios_param(bdev, capacity, diskinfo);
1529 geo->heads = diskinfo[0];
1530 geo->sectors = diskinfo[1];
1531 geo->cylinders = diskinfo[2];
1536 * sd_ioctl_common - process an ioctl
1537 * @bdev: target block device
1538 * @mode: FMODE_* mask
1539 * @cmd: ioctl command number
1540 * @p: this is third argument given to ioctl(2) system call.
1541 * Often contains a pointer.
1543 * Returns 0 if successful (some ioctls return positive numbers on
1544 * success as well). Returns a negated errno value in case of error.
1546 * Note: most ioctls are forward onto the block subsystem or further
1547 * down in the scsi subsystem.
1549 static int sd_ioctl_common(struct block_device *bdev, fmode_t mode,
1550 unsigned int cmd, void __user *p)
1552 struct gendisk *disk = bdev->bd_disk;
1553 struct scsi_disk *sdkp = scsi_disk(disk);
1554 struct scsi_device *sdp = sdkp->device;
1557 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1558 "cmd=0x%x\n", disk->disk_name, cmd));
1560 error = scsi_verify_blk_ioctl(bdev, cmd);
1565 * If we are in the middle of error recovery, don't let anyone
1566 * else try and use this device. Also, if error recovery fails, it
1567 * may try and take the device offline, in which case all further
1568 * access to the device is prohibited.
1570 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1571 (mode & FMODE_NDELAY) != 0);
1575 if (is_sed_ioctl(cmd))
1576 return sed_ioctl(sdkp->opal_dev, cmd, p);
1579 * Send SCSI addressing ioctls directly to mid level, send other
1580 * ioctls to block level and then onto mid level if they can't be
1584 case SCSI_IOCTL_GET_IDLUN:
1585 case SCSI_IOCTL_GET_BUS_NUMBER:
1586 error = scsi_ioctl(sdp, cmd, p);
1589 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1596 static void set_media_not_present(struct scsi_disk *sdkp)
1598 if (sdkp->media_present)
1599 sdkp->device->changed = 1;
1601 if (sdkp->device->removable) {
1602 sdkp->media_present = 0;
1607 static int media_not_present(struct scsi_disk *sdkp,
1608 struct scsi_sense_hdr *sshdr)
1610 if (!scsi_sense_valid(sshdr))
1613 /* not invoked for commands that could return deferred errors */
1614 switch (sshdr->sense_key) {
1615 case UNIT_ATTENTION:
1617 /* medium not present */
1618 if (sshdr->asc == 0x3A) {
1619 set_media_not_present(sdkp);
1627 * sd_check_events - check media events
1628 * @disk: kernel device descriptor
1629 * @clearing: disk events currently being cleared
1631 * Returns mask of DISK_EVENT_*.
1633 * Note: this function is invoked from the block subsystem.
1635 static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1637 struct scsi_disk *sdkp = scsi_disk_get(disk);
1638 struct scsi_device *sdp;
1646 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1649 * If the device is offline, don't send any commands - just pretend as
1650 * if the command failed. If the device ever comes back online, we
1651 * can deal with it then. It is only because of unrecoverable errors
1652 * that we would ever take a device offline in the first place.
1654 if (!scsi_device_online(sdp)) {
1655 set_media_not_present(sdkp);
1660 * Using TEST_UNIT_READY enables differentiation between drive with
1661 * no cartridge loaded - NOT READY, drive with changed cartridge -
1662 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1664 * Drives that auto spin down. eg iomega jaz 1G, will be started
1665 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1666 * sd_revalidate() is called.
1668 if (scsi_block_when_processing_errors(sdp)) {
1669 struct scsi_sense_hdr sshdr = { 0, };
1671 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, sdkp->max_retries,
1674 /* failed to execute TUR, assume media not present */
1675 if (retval < 0 || host_byte(retval)) {
1676 set_media_not_present(sdkp);
1680 if (media_not_present(sdkp, &sshdr))
1685 * For removable scsi disk we have to recognise the presence
1686 * of a disk in the drive.
1688 if (!sdkp->media_present)
1690 sdkp->media_present = 1;
1693 * sdp->changed is set under the following conditions:
1695 * Medium present state has changed in either direction.
1696 * Device has indicated UNIT_ATTENTION.
1698 disk_changed = sdp->changed;
1700 scsi_disk_put(sdkp);
1701 return disk_changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1704 static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
1707 struct scsi_device *sdp = sdkp->device;
1708 const int timeout = sdp->request_queue->rq_timeout
1709 * SD_FLUSH_TIMEOUT_MULTIPLIER;
1710 struct scsi_sense_hdr my_sshdr;
1712 if (!scsi_device_online(sdp))
1715 /* caller might not be interested in sense, but we need it */
1719 for (retries = 3; retries > 0; --retries) {
1720 unsigned char cmd[10] = { 0 };
1722 cmd[0] = SYNCHRONIZE_CACHE;
1724 * Leave the rest of the command zero to indicate
1727 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
1728 timeout, sdkp->max_retries, 0, RQF_PM, NULL);
1734 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
1739 if (scsi_status_is_check_condition(res) &&
1740 scsi_sense_valid(sshdr)) {
1741 sd_print_sense_hdr(sdkp, sshdr);
1743 /* we need to evaluate the error return */
1744 if (sshdr->asc == 0x3a || /* medium not present */
1745 sshdr->asc == 0x20 || /* invalid command */
1746 (sshdr->asc == 0x74 && sshdr->ascq == 0x71)) /* drive is password locked */
1747 /* this is no error here */
1751 switch (host_byte(res)) {
1752 /* ignore errors due to racing a disconnection */
1753 case DID_BAD_TARGET:
1754 case DID_NO_CONNECT:
1756 /* signal the upper layer it might try again */
1760 case DID_SOFT_ERROR:
1769 static void sd_rescan(struct device *dev)
1771 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1773 sd_revalidate_disk(sdkp->disk);
1776 static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1777 unsigned int cmd, unsigned long arg)
1779 void __user *p = (void __user *)arg;
1782 ret = sd_ioctl_common(bdev, mode, cmd, p);
1786 return scsi_ioctl(scsi_disk(bdev->bd_disk)->device, cmd, p);
1789 #ifdef CONFIG_COMPAT
1790 static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1791 unsigned int cmd, unsigned long arg)
1793 void __user *p = compat_ptr(arg);
1796 ret = sd_ioctl_common(bdev, mode, cmd, p);
1800 return scsi_compat_ioctl(scsi_disk(bdev->bd_disk)->device, cmd, p);
1804 static char sd_pr_type(enum pr_type type)
1807 case PR_WRITE_EXCLUSIVE:
1809 case PR_EXCLUSIVE_ACCESS:
1811 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1813 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1815 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1817 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1824 static int sd_pr_command(struct block_device *bdev, u8 sa,
1825 u64 key, u64 sa_key, u8 type, u8 flags)
1827 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1828 struct scsi_device *sdev = sdkp->device;
1829 struct scsi_sense_hdr sshdr;
1831 u8 cmd[16] = { 0, };
1832 u8 data[24] = { 0, };
1834 cmd[0] = PERSISTENT_RESERVE_OUT;
1837 put_unaligned_be32(sizeof(data), &cmd[5]);
1839 put_unaligned_be64(key, &data[0]);
1840 put_unaligned_be64(sa_key, &data[8]);
1843 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1844 &sshdr, SD_TIMEOUT, sdkp->max_retries, NULL);
1846 if (scsi_status_is_check_condition(result) &&
1847 scsi_sense_valid(&sshdr)) {
1848 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1849 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1855 static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1858 if (flags & ~PR_FL_IGNORE_KEY)
1860 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1861 old_key, new_key, 0,
1862 (1 << 0) /* APTPL */);
1865 static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1870 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1873 static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1875 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1878 static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1879 enum pr_type type, bool abort)
1881 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1882 sd_pr_type(type), 0);
1885 static int sd_pr_clear(struct block_device *bdev, u64 key)
1887 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1890 static const struct pr_ops sd_pr_ops = {
1891 .pr_register = sd_pr_register,
1892 .pr_reserve = sd_pr_reserve,
1893 .pr_release = sd_pr_release,
1894 .pr_preempt = sd_pr_preempt,
1895 .pr_clear = sd_pr_clear,
1898 static const struct block_device_operations sd_fops = {
1899 .owner = THIS_MODULE,
1901 .release = sd_release,
1903 .getgeo = sd_getgeo,
1904 #ifdef CONFIG_COMPAT
1905 .compat_ioctl = sd_compat_ioctl,
1907 .check_events = sd_check_events,
1908 .unlock_native_capacity = sd_unlock_native_capacity,
1909 .report_zones = sd_zbc_report_zones,
1910 .pr_ops = &sd_pr_ops,
1914 * sd_eh_reset - reset error handling callback
1915 * @scmd: sd-issued command that has failed
1917 * This function is called by the SCSI midlayer before starting
1918 * SCSI EH. When counting medium access failures we have to be
1919 * careful to register it only only once per device and SCSI EH run;
1920 * there might be several timed out commands which will cause the
1921 * 'max_medium_access_timeouts' counter to trigger after the first
1922 * SCSI EH run already and set the device to offline.
1923 * So this function resets the internal counter before starting SCSI EH.
1925 static void sd_eh_reset(struct scsi_cmnd *scmd)
1927 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1929 /* New SCSI EH run, reset gate variable */
1930 sdkp->ignore_medium_access_errors = false;
1934 * sd_eh_action - error handling callback
1935 * @scmd: sd-issued command that has failed
1936 * @eh_disp: The recovery disposition suggested by the midlayer
1938 * This function is called by the SCSI midlayer upon completion of an
1939 * error test command (currently TEST UNIT READY). The result of sending
1940 * the eh command is passed in eh_disp. We're looking for devices that
1941 * fail medium access commands but are OK with non access commands like
1942 * test unit ready (so wrongly see the device as having a successful
1945 static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
1947 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1948 struct scsi_device *sdev = scmd->device;
1950 if (!scsi_device_online(sdev) ||
1951 !scsi_medium_access_command(scmd) ||
1952 host_byte(scmd->result) != DID_TIME_OUT ||
1957 * The device has timed out executing a medium access command.
1958 * However, the TEST UNIT READY command sent during error
1959 * handling completed successfully. Either the device is in the
1960 * process of recovering or has it suffered an internal failure
1961 * that prevents access to the storage medium.
1963 if (!sdkp->ignore_medium_access_errors) {
1964 sdkp->medium_access_timed_out++;
1965 sdkp->ignore_medium_access_errors = true;
1969 * If the device keeps failing read/write commands but TEST UNIT
1970 * READY always completes successfully we assume that medium
1971 * access is no longer possible and take the device offline.
1973 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1974 scmd_printk(KERN_ERR, scmd,
1975 "Medium access timeout failure. Offlining disk!\n");
1976 mutex_lock(&sdev->state_mutex);
1977 scsi_device_set_state(sdev, SDEV_OFFLINE);
1978 mutex_unlock(&sdev->state_mutex);
1986 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1988 struct request *req = scmd->request;
1989 struct scsi_device *sdev = scmd->device;
1990 unsigned int transferred, good_bytes;
1991 u64 start_lba, end_lba, bad_lba;
1994 * Some commands have a payload smaller than the device logical
1995 * block size (e.g. INQUIRY on a 4K disk).
1997 if (scsi_bufflen(scmd) <= sdev->sector_size)
2000 /* Check if we have a 'bad_lba' information */
2001 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
2002 SCSI_SENSE_BUFFERSIZE,
2007 * If the bad lba was reported incorrectly, we have no idea where
2010 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
2011 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
2012 if (bad_lba < start_lba || bad_lba >= end_lba)
2016 * resid is optional but mostly filled in. When it's unused,
2017 * its value is zero, so we assume the whole buffer transferred
2019 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
2021 /* This computation should always be done in terms of the
2022 * resolution of the device's medium.
2024 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
2026 return min(good_bytes, transferred);
2030 * sd_done - bottom half handler: called when the lower level
2031 * driver has completed (successfully or otherwise) a scsi command.
2032 * @SCpnt: mid-level's per command structure.
2034 * Note: potentially run from within an ISR. Must not block.
2036 static int sd_done(struct scsi_cmnd *SCpnt)
2038 int result = SCpnt->result;
2039 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
2040 unsigned int sector_size = SCpnt->device->sector_size;
2042 struct scsi_sense_hdr sshdr;
2043 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
2044 struct request *req = SCpnt->request;
2045 int sense_valid = 0;
2046 int sense_deferred = 0;
2048 switch (req_op(req)) {
2049 case REQ_OP_DISCARD:
2050 case REQ_OP_WRITE_ZEROES:
2051 case REQ_OP_WRITE_SAME:
2052 case REQ_OP_ZONE_RESET:
2053 case REQ_OP_ZONE_RESET_ALL:
2054 case REQ_OP_ZONE_OPEN:
2055 case REQ_OP_ZONE_CLOSE:
2056 case REQ_OP_ZONE_FINISH:
2058 good_bytes = blk_rq_bytes(req);
2059 scsi_set_resid(SCpnt, 0);
2062 scsi_set_resid(SCpnt, blk_rq_bytes(req));
2067 * In case of bogus fw or device, we could end up having
2068 * an unaligned partial completion. Check this here and force
2071 resid = scsi_get_resid(SCpnt);
2072 if (resid & (sector_size - 1)) {
2073 sd_printk(KERN_INFO, sdkp,
2074 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
2075 resid, sector_size);
2076 scsi_print_command(SCpnt);
2077 resid = min(scsi_bufflen(SCpnt),
2078 round_up(resid, sector_size));
2079 scsi_set_resid(SCpnt, resid);
2084 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
2086 sense_deferred = scsi_sense_is_deferred(&sshdr);
2088 sdkp->medium_access_timed_out = 0;
2090 if (!scsi_status_is_check_condition(result) &&
2091 (!sense_valid || sense_deferred))
2094 switch (sshdr.sense_key) {
2095 case HARDWARE_ERROR:
2097 good_bytes = sd_completed_bytes(SCpnt);
2099 case RECOVERED_ERROR:
2100 good_bytes = scsi_bufflen(SCpnt);
2103 /* This indicates a false check condition, so ignore it. An
2104 * unknown amount of data was transferred so treat it as an
2108 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2110 case ABORTED_COMMAND:
2111 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
2112 good_bytes = sd_completed_bytes(SCpnt);
2114 case ILLEGAL_REQUEST:
2115 switch (sshdr.asc) {
2116 case 0x10: /* DIX: Host detected corruption */
2117 good_bytes = sd_completed_bytes(SCpnt);
2119 case 0x20: /* INVALID COMMAND OPCODE */
2120 case 0x24: /* INVALID FIELD IN CDB */
2121 switch (SCpnt->cmnd[0]) {
2123 sd_config_discard(sdkp, SD_LBP_DISABLE);
2127 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
2128 sd_config_discard(sdkp, SD_LBP_DISABLE);
2130 sdkp->device->no_write_same = 1;
2131 sd_config_write_same(sdkp);
2132 req->rq_flags |= RQF_QUIET;
2143 if (sd_is_zoned(sdkp))
2144 good_bytes = sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2146 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2147 "sd_done: completed %d of %d bytes\n",
2148 good_bytes, scsi_bufflen(SCpnt)));
2154 * spinup disk - called only in sd_revalidate_disk()
2157 sd_spinup_disk(struct scsi_disk *sdkp)
2159 unsigned char cmd[10];
2160 unsigned long spintime_expire = 0;
2161 int retries, spintime;
2162 unsigned int the_result;
2163 struct scsi_sense_hdr sshdr;
2164 int sense_valid = 0;
2168 /* Spin up drives, as required. Only do this at boot time */
2169 /* Spinup needs to be done for module loads too. */
2174 cmd[0] = TEST_UNIT_READY;
2175 memset((void *) &cmd[1], 0, 9);
2177 the_result = scsi_execute_req(sdkp->device, cmd,
2180 sdkp->max_retries, NULL);
2183 * If the drive has indicated to us that it
2184 * doesn't have any media in it, don't bother
2185 * with any more polling.
2187 if (media_not_present(sdkp, &sshdr))
2191 sense_valid = scsi_sense_valid(&sshdr);
2193 } while (retries < 3 &&
2194 (!scsi_status_is_good(the_result) ||
2195 (scsi_status_is_check_condition(the_result) &&
2196 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2198 if (!scsi_status_is_check_condition(the_result)) {
2199 /* no sense, TUR either succeeded or failed
2200 * with a status error */
2201 if(!spintime && !scsi_status_is_good(the_result)) {
2202 sd_print_result(sdkp, "Test Unit Ready failed",
2209 * The device does not want the automatic start to be issued.
2211 if (sdkp->device->no_start_on_add)
2214 if (sense_valid && sshdr.sense_key == NOT_READY) {
2215 if (sshdr.asc == 4 && sshdr.ascq == 3)
2216 break; /* manual intervention required */
2217 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2218 break; /* standby */
2219 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2220 break; /* unavailable */
2221 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2222 break; /* sanitize in progress */
2224 * Issue command to spin up drive when not ready
2227 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
2228 cmd[0] = START_STOP;
2229 cmd[1] = 1; /* Return immediately */
2230 memset((void *) &cmd[2], 0, 8);
2231 cmd[4] = 1; /* Start spin cycle */
2232 if (sdkp->device->start_stop_pwr_cond)
2234 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2236 SD_TIMEOUT, sdkp->max_retries,
2238 spintime_expire = jiffies + 100 * HZ;
2241 /* Wait 1 second for next try */
2243 printk(KERN_CONT ".");
2246 * Wait for USB flash devices with slow firmware.
2247 * Yes, this sense key/ASC combination shouldn't
2248 * occur here. It's characteristic of these devices.
2250 } else if (sense_valid &&
2251 sshdr.sense_key == UNIT_ATTENTION &&
2252 sshdr.asc == 0x28) {
2254 spintime_expire = jiffies + 5 * HZ;
2257 /* Wait 1 second for next try */
2260 /* we don't understand the sense code, so it's
2261 * probably pointless to loop */
2263 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2264 sd_print_sense_hdr(sdkp, &sshdr);
2269 } while (spintime && time_before_eq(jiffies, spintime_expire));
2272 if (scsi_status_is_good(the_result))
2273 printk(KERN_CONT "ready\n");
2275 printk(KERN_CONT "not responding...\n");
2280 * Determine whether disk supports Data Integrity Field.
2282 static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
2284 struct scsi_device *sdp = sdkp->device;
2288 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0) {
2289 sdkp->protection_type = 0;
2293 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2295 if (type > T10_PI_TYPE3_PROTECTION)
2297 else if (scsi_host_dif_capable(sdp->host, type))
2300 if (sdkp->first_scan || type != sdkp->protection_type)
2303 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2304 " protection type %u. Disabling disk!\n",
2308 sd_printk(KERN_NOTICE, sdkp,
2309 "Enabling DIF Type %u protection\n", type);
2312 sd_printk(KERN_NOTICE, sdkp,
2313 "Disabling DIF Type %u protection\n", type);
2317 sdkp->protection_type = type;
2322 static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2323 struct scsi_sense_hdr *sshdr, int sense_valid,
2327 sd_print_sense_hdr(sdkp, sshdr);
2329 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2332 * Set dirty bit for removable devices if not ready -
2333 * sometimes drives will not report this properly.
2335 if (sdp->removable &&
2336 sense_valid && sshdr->sense_key == NOT_READY)
2337 set_media_not_present(sdkp);
2340 * We used to set media_present to 0 here to indicate no media
2341 * in the drive, but some drives fail read capacity even with
2342 * media present, so we can't do that.
2344 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2348 #if RC16_LEN > SD_BUF_SIZE
2349 #error RC16_LEN must not be more than SD_BUF_SIZE
2352 #define READ_CAPACITY_RETRIES_ON_RESET 10
2354 static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2355 unsigned char *buffer)
2357 unsigned char cmd[16];
2358 struct scsi_sense_hdr sshdr;
2359 int sense_valid = 0;
2361 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2362 unsigned int alignment;
2363 unsigned long long lba;
2364 unsigned sector_size;
2366 if (sdp->no_read_capacity_16)
2371 cmd[0] = SERVICE_ACTION_IN_16;
2372 cmd[1] = SAI_READ_CAPACITY_16;
2374 memset(buffer, 0, RC16_LEN);
2376 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2377 buffer, RC16_LEN, &sshdr,
2378 SD_TIMEOUT, sdkp->max_retries, NULL);
2380 if (media_not_present(sdkp, &sshdr))
2383 if (the_result > 0) {
2384 sense_valid = scsi_sense_valid(&sshdr);
2386 sshdr.sense_key == ILLEGAL_REQUEST &&
2387 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2389 /* Invalid Command Operation Code or
2390 * Invalid Field in CDB, just retry
2391 * silently with RC10 */
2394 sshdr.sense_key == UNIT_ATTENTION &&
2395 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2396 /* Device reset might occur several times,
2397 * give it one more chance */
2398 if (--reset_retries > 0)
2403 } while (the_result && retries);
2406 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
2407 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2411 sector_size = get_unaligned_be32(&buffer[8]);
2412 lba = get_unaligned_be64(&buffer[0]);
2414 if (sd_read_protection_type(sdkp, buffer) < 0) {
2419 /* Logical blocks per physical block exponent */
2420 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
2423 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2425 /* Lowest aligned logical block */
2426 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2427 blk_queue_alignment_offset(sdp->request_queue, alignment);
2428 if (alignment && sdkp->first_scan)
2429 sd_printk(KERN_NOTICE, sdkp,
2430 "physical block alignment offset: %u\n", alignment);
2432 if (buffer[14] & 0x80) { /* LBPME */
2435 if (buffer[14] & 0x40) /* LBPRZ */
2438 sd_config_discard(sdkp, SD_LBP_WS16);
2441 sdkp->capacity = lba + 1;
2445 static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2446 unsigned char *buffer)
2448 unsigned char cmd[16];
2449 struct scsi_sense_hdr sshdr;
2450 int sense_valid = 0;
2452 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2454 unsigned sector_size;
2457 cmd[0] = READ_CAPACITY;
2458 memset(&cmd[1], 0, 9);
2459 memset(buffer, 0, 8);
2461 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2463 SD_TIMEOUT, sdkp->max_retries, NULL);
2465 if (media_not_present(sdkp, &sshdr))
2468 if (the_result > 0) {
2469 sense_valid = scsi_sense_valid(&sshdr);
2471 sshdr.sense_key == UNIT_ATTENTION &&
2472 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2473 /* Device reset might occur several times,
2474 * give it one more chance */
2475 if (--reset_retries > 0)
2480 } while (the_result && retries);
2483 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
2484 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2488 sector_size = get_unaligned_be32(&buffer[4]);
2489 lba = get_unaligned_be32(&buffer[0]);
2491 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2492 /* Some buggy (usb cardreader) devices return an lba of
2493 0xffffffff when the want to report a size of 0 (with
2494 which they really mean no media is present) */
2496 sdkp->physical_block_size = sector_size;
2500 sdkp->capacity = lba + 1;
2501 sdkp->physical_block_size = sector_size;
2505 static int sd_try_rc16_first(struct scsi_device *sdp)
2507 if (sdp->host->max_cmd_len < 16)
2509 if (sdp->try_rc_10_first)
2511 if (sdp->scsi_level > SCSI_SPC_2)
2513 if (scsi_device_protection(sdp))
2519 * read disk capacity
2522 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2525 struct scsi_device *sdp = sdkp->device;
2527 if (sd_try_rc16_first(sdp)) {
2528 sector_size = read_capacity_16(sdkp, sdp, buffer);
2529 if (sector_size == -EOVERFLOW)
2531 if (sector_size == -ENODEV)
2533 if (sector_size < 0)
2534 sector_size = read_capacity_10(sdkp, sdp, buffer);
2535 if (sector_size < 0)
2538 sector_size = read_capacity_10(sdkp, sdp, buffer);
2539 if (sector_size == -EOVERFLOW)
2541 if (sector_size < 0)
2543 if ((sizeof(sdkp->capacity) > 4) &&
2544 (sdkp->capacity > 0xffffffffULL)) {
2545 int old_sector_size = sector_size;
2546 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2547 "Trying to use READ CAPACITY(16).\n");
2548 sector_size = read_capacity_16(sdkp, sdp, buffer);
2549 if (sector_size < 0) {
2550 sd_printk(KERN_NOTICE, sdkp,
2551 "Using 0xffffffff as device size\n");
2552 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2553 sector_size = old_sector_size;
2556 /* Remember that READ CAPACITY(16) succeeded */
2557 sdp->try_rc_10_first = 0;
2561 /* Some devices are known to return the total number of blocks,
2562 * not the highest block number. Some devices have versions
2563 * which do this and others which do not. Some devices we might
2564 * suspect of doing this but we don't know for certain.
2566 * If we know the reported capacity is wrong, decrement it. If
2567 * we can only guess, then assume the number of blocks is even
2568 * (usually true but not always) and err on the side of lowering
2571 if (sdp->fix_capacity ||
2572 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2573 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2574 "from its reported value: %llu\n",
2575 (unsigned long long) sdkp->capacity);
2580 if (sector_size == 0) {
2582 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2586 if (sector_size != 512 &&
2587 sector_size != 1024 &&
2588 sector_size != 2048 &&
2589 sector_size != 4096) {
2590 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2593 * The user might want to re-format the drive with
2594 * a supported sectorsize. Once this happens, it
2595 * would be relatively trivial to set the thing up.
2596 * For this reason, we leave the thing in the table.
2600 * set a bogus sector size so the normal read/write
2601 * logic in the block layer will eventually refuse any
2602 * request on this device without tripping over power
2603 * of two sector size assumptions
2607 blk_queue_logical_block_size(sdp->request_queue, sector_size);
2608 blk_queue_physical_block_size(sdp->request_queue,
2609 sdkp->physical_block_size);
2610 sdkp->device->sector_size = sector_size;
2612 if (sdkp->capacity > 0xffffffff)
2613 sdp->use_16_for_rw = 1;
2618 * Print disk capacity
2621 sd_print_capacity(struct scsi_disk *sdkp,
2622 sector_t old_capacity)
2624 int sector_size = sdkp->device->sector_size;
2625 char cap_str_2[10], cap_str_10[10];
2627 if (!sdkp->first_scan && old_capacity == sdkp->capacity)
2630 string_get_size(sdkp->capacity, sector_size,
2631 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2632 string_get_size(sdkp->capacity, sector_size,
2633 STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
2635 sd_printk(KERN_NOTICE, sdkp,
2636 "%llu %d-byte logical blocks: (%s/%s)\n",
2637 (unsigned long long)sdkp->capacity,
2638 sector_size, cap_str_10, cap_str_2);
2640 if (sdkp->physical_block_size != sector_size)
2641 sd_printk(KERN_NOTICE, sdkp,
2642 "%u-byte physical blocks\n",
2643 sdkp->physical_block_size);
2646 /* called with buffer of length 512 */
2648 sd_do_mode_sense(struct scsi_disk *sdkp, int dbd, int modepage,
2649 unsigned char *buffer, int len, struct scsi_mode_data *data,
2650 struct scsi_sense_hdr *sshdr)
2652 return scsi_mode_sense(sdkp->device, dbd, modepage, buffer, len,
2653 SD_TIMEOUT, sdkp->max_retries, data,
2658 * read write protect setting, if possible - called only in sd_revalidate_disk()
2659 * called with buffer of length SD_BUF_SIZE
2662 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
2665 struct scsi_device *sdp = sdkp->device;
2666 struct scsi_mode_data data;
2667 int old_wp = sdkp->write_prot;
2669 set_disk_ro(sdkp->disk, 0);
2670 if (sdp->skip_ms_page_3f) {
2671 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
2675 if (sdp->use_192_bytes_for_3f) {
2676 res = sd_do_mode_sense(sdkp, 0, 0x3F, buffer, 192, &data, NULL);
2679 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2680 * We have to start carefully: some devices hang if we ask
2681 * for more than is available.
2683 res = sd_do_mode_sense(sdkp, 0, 0x3F, buffer, 4, &data, NULL);
2686 * Second attempt: ask for page 0 When only page 0 is
2687 * implemented, a request for page 3F may return Sense Key
2688 * 5: Illegal Request, Sense Code 24: Invalid field in
2692 res = sd_do_mode_sense(sdkp, 0, 0, buffer, 4, &data, NULL);
2695 * Third attempt: ask 255 bytes, as we did earlier.
2698 res = sd_do_mode_sense(sdkp, 0, 0x3F, buffer, 255,
2703 sd_first_printk(KERN_WARNING, sdkp,
2704 "Test WP failed, assume Write Enabled\n");
2706 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
2707 set_disk_ro(sdkp->disk, sdkp->write_prot);
2708 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2709 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2710 sdkp->write_prot ? "on" : "off");
2711 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
2717 * sd_read_cache_type - called only from sd_revalidate_disk()
2718 * called with buffer of length SD_BUF_SIZE
2721 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
2724 struct scsi_device *sdp = sdkp->device;
2729 struct scsi_mode_data data;
2730 struct scsi_sense_hdr sshdr;
2731 int old_wce = sdkp->WCE;
2732 int old_rcd = sdkp->RCD;
2733 int old_dpofua = sdkp->DPOFUA;
2736 if (sdkp->cache_override)
2740 if (sdp->skip_ms_page_8) {
2741 if (sdp->type == TYPE_RBC)
2744 if (sdp->skip_ms_page_3f)
2747 if (sdp->use_192_bytes_for_3f)
2751 } else if (sdp->type == TYPE_RBC) {
2759 /* cautiously ask */
2760 res = sd_do_mode_sense(sdkp, dbd, modepage, buffer, first_len,
2766 if (!data.header_length) {
2769 sd_first_printk(KERN_ERR, sdkp,
2770 "Missing header in MODE_SENSE response\n");
2773 /* that went OK, now ask for the proper length */
2777 * We're only interested in the first three bytes, actually.
2778 * But the data cache page is defined for the first 20.
2782 else if (len > SD_BUF_SIZE) {
2783 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
2784 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2787 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2791 if (len > first_len)
2792 res = sd_do_mode_sense(sdkp, dbd, modepage, buffer, len,
2796 int offset = data.header_length + data.block_descriptor_length;
2798 while (offset < len) {
2799 u8 page_code = buffer[offset] & 0x3F;
2800 u8 spf = buffer[offset] & 0x40;
2802 if (page_code == 8 || page_code == 6) {
2803 /* We're interested only in the first 3 bytes.
2805 if (len - offset <= 2) {
2806 sd_first_printk(KERN_ERR, sdkp,
2807 "Incomplete mode parameter "
2811 modepage = page_code;
2815 /* Go to the next page */
2816 if (spf && len - offset > 3)
2817 offset += 4 + (buffer[offset+2] << 8) +
2819 else if (!spf && len - offset > 1)
2820 offset += 2 + buffer[offset+1];
2822 sd_first_printk(KERN_ERR, sdkp,
2824 "parameter data\n");
2830 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
2834 if (modepage == 8) {
2835 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2836 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2838 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2842 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
2843 if (sdp->broken_fua) {
2844 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2846 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2847 !sdkp->device->use_16_for_rw) {
2848 sd_first_printk(KERN_NOTICE, sdkp,
2849 "Uses READ/WRITE(6), disabling FUA\n");
2853 /* No cache flush allowed for write protected devices */
2854 if (sdkp->WCE && sdkp->write_prot)
2857 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2858 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2859 sd_printk(KERN_NOTICE, sdkp,
2860 "Write cache: %s, read cache: %s, %s\n",
2861 sdkp->WCE ? "enabled" : "disabled",
2862 sdkp->RCD ? "disabled" : "enabled",
2863 sdkp->DPOFUA ? "supports DPO and FUA"
2864 : "doesn't support DPO or FUA");
2870 if (scsi_sense_valid(&sshdr) &&
2871 sshdr.sense_key == ILLEGAL_REQUEST &&
2872 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
2873 /* Invalid field in CDB */
2874 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
2876 sd_first_printk(KERN_ERR, sdkp,
2877 "Asking for cache data failed\n");
2880 if (sdp->wce_default_on) {
2881 sd_first_printk(KERN_NOTICE, sdkp,
2882 "Assuming drive cache: write back\n");
2885 sd_first_printk(KERN_ERR, sdkp,
2886 "Assuming drive cache: write through\n");
2894 * The ATO bit indicates whether the DIF application tag is available
2895 * for use by the operating system.
2897 static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
2900 struct scsi_device *sdp = sdkp->device;
2901 struct scsi_mode_data data;
2902 struct scsi_sense_hdr sshdr;
2904 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
2907 if (sdkp->protection_type == 0)
2910 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2911 sdkp->max_retries, &data, &sshdr);
2913 if (res < 0 || !data.header_length ||
2915 sd_first_printk(KERN_WARNING, sdkp,
2916 "getting Control mode page failed, assume no ATO\n");
2918 if (scsi_sense_valid(&sshdr))
2919 sd_print_sense_hdr(sdkp, &sshdr);
2924 offset = data.header_length + data.block_descriptor_length;
2926 if ((buffer[offset] & 0x3f) != 0x0a) {
2927 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
2931 if ((buffer[offset + 5] & 0x80) == 0)
2940 * sd_read_block_limits - Query disk device for preferred I/O sizes.
2941 * @sdkp: disk to query
2943 static void sd_read_block_limits(struct scsi_disk *sdkp)
2945 unsigned int sector_sz = sdkp->device->sector_size;
2946 const int vpd_len = 64;
2947 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
2950 /* Block Limits VPD */
2951 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2954 blk_queue_io_min(sdkp->disk->queue,
2955 get_unaligned_be16(&buffer[6]) * sector_sz);
2957 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2958 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
2960 if (buffer[3] == 0x3c) {
2961 unsigned int lba_count, desc_count;
2963 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
2968 lba_count = get_unaligned_be32(&buffer[20]);
2969 desc_count = get_unaligned_be32(&buffer[24]);
2971 if (lba_count && desc_count)
2972 sdkp->max_unmap_blocks = lba_count;
2974 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
2976 if (buffer[32] & 0x80)
2977 sdkp->unmap_alignment =
2978 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
2980 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2982 if (sdkp->max_unmap_blocks)
2983 sd_config_discard(sdkp, SD_LBP_UNMAP);
2985 sd_config_discard(sdkp, SD_LBP_WS16);
2987 } else { /* LBP VPD page tells us what to use */
2988 if (sdkp->lbpu && sdkp->max_unmap_blocks)
2989 sd_config_discard(sdkp, SD_LBP_UNMAP);
2990 else if (sdkp->lbpws)
2991 sd_config_discard(sdkp, SD_LBP_WS16);
2992 else if (sdkp->lbpws10)
2993 sd_config_discard(sdkp, SD_LBP_WS10);
2995 sd_config_discard(sdkp, SD_LBP_DISABLE);
3004 * sd_read_block_characteristics - Query block dev. characteristics
3005 * @sdkp: disk to query
3007 static void sd_read_block_characteristics(struct scsi_disk *sdkp)
3009 struct request_queue *q = sdkp->disk->queue;
3010 unsigned char *buffer;
3012 const int vpd_len = 64;
3014 buffer = kmalloc(vpd_len, GFP_KERNEL);
3017 /* Block Device Characteristics VPD */
3018 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
3021 rot = get_unaligned_be16(&buffer[4]);
3024 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
3025 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
3028 if (sdkp->device->type == TYPE_ZBC) {
3030 blk_queue_set_zoned(sdkp->disk, BLK_ZONED_HM);
3032 sdkp->zoned = (buffer[8] >> 4) & 3;
3033 if (sdkp->zoned == 1) {
3035 blk_queue_set_zoned(sdkp->disk, BLK_ZONED_HA);
3037 /* Regular disk or drive managed disk */
3038 blk_queue_set_zoned(sdkp->disk, BLK_ZONED_NONE);
3042 if (!sdkp->first_scan)
3045 if (blk_queue_is_zoned(q)) {
3046 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
3047 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
3049 if (sdkp->zoned == 1)
3050 sd_printk(KERN_NOTICE, sdkp,
3051 "Host-aware SMR disk used as regular disk\n");
3052 else if (sdkp->zoned == 2)
3053 sd_printk(KERN_NOTICE, sdkp,
3054 "Drive-managed SMR disk\n");
3062 * sd_read_block_provisioning - Query provisioning VPD page
3063 * @sdkp: disk to query
3065 static void sd_read_block_provisioning(struct scsi_disk *sdkp)
3067 unsigned char *buffer;
3068 const int vpd_len = 8;
3070 if (sdkp->lbpme == 0)
3073 buffer = kmalloc(vpd_len, GFP_KERNEL);
3075 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
3079 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3080 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3081 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
3087 static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3089 struct scsi_device *sdev = sdkp->device;
3091 if (sdev->host->no_write_same) {
3092 sdev->no_write_same = 1;
3097 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
3098 /* too large values might cause issues with arcmsr */
3099 int vpd_buf_len = 64;
3101 sdev->no_report_opcodes = 1;
3103 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3104 * CODES is unsupported and the device has an ATA
3105 * Information VPD page (SAT).
3107 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
3108 sdev->no_write_same = 1;
3111 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
3114 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3118 static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3120 struct scsi_device *sdev = sdkp->device;
3122 if (!sdev->security_supported)
3125 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3126 SECURITY_PROTOCOL_IN) == 1 &&
3127 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3128 SECURITY_PROTOCOL_OUT) == 1)
3133 * Determine the device's preferred I/O size for reads and writes
3134 * unless the reported value is unreasonably small, large, not a
3135 * multiple of the physical block size, or simply garbage.
3137 static bool sd_validate_opt_xfer_size(struct scsi_disk *sdkp,
3138 unsigned int dev_max)
3140 struct scsi_device *sdp = sdkp->device;
3141 unsigned int opt_xfer_bytes =
3142 logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3144 if (sdkp->opt_xfer_blocks == 0)
3147 if (sdkp->opt_xfer_blocks > dev_max) {
3148 sd_first_printk(KERN_WARNING, sdkp,
3149 "Optimal transfer size %u logical blocks " \
3150 "> dev_max (%u logical blocks)\n",
3151 sdkp->opt_xfer_blocks, dev_max);
3155 if (sdkp->opt_xfer_blocks > SD_DEF_XFER_BLOCKS) {
3156 sd_first_printk(KERN_WARNING, sdkp,
3157 "Optimal transfer size %u logical blocks " \
3158 "> sd driver limit (%u logical blocks)\n",
3159 sdkp->opt_xfer_blocks, SD_DEF_XFER_BLOCKS);
3163 if (opt_xfer_bytes < PAGE_SIZE) {
3164 sd_first_printk(KERN_WARNING, sdkp,
3165 "Optimal transfer size %u bytes < " \
3166 "PAGE_SIZE (%u bytes)\n",
3167 opt_xfer_bytes, (unsigned int)PAGE_SIZE);
3171 if (opt_xfer_bytes & (sdkp->physical_block_size - 1)) {
3172 sd_first_printk(KERN_WARNING, sdkp,
3173 "Optimal transfer size %u bytes not a " \
3174 "multiple of physical block size (%u bytes)\n",
3175 opt_xfer_bytes, sdkp->physical_block_size);
3179 sd_first_printk(KERN_INFO, sdkp, "Optimal transfer size %u bytes\n",
3185 * sd_revalidate_disk - called the first time a new disk is seen,
3186 * performs disk spin up, read_capacity, etc.
3187 * @disk: struct gendisk we care about
3189 static int sd_revalidate_disk(struct gendisk *disk)
3191 struct scsi_disk *sdkp = scsi_disk(disk);
3192 struct scsi_device *sdp = sdkp->device;
3193 struct request_queue *q = sdkp->disk->queue;
3194 sector_t old_capacity = sdkp->capacity;
3195 unsigned char *buffer;
3196 unsigned int dev_max, rw_max;
3198 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3199 "sd_revalidate_disk\n"));
3202 * If the device is offline, don't try and read capacity or any
3203 * of the other niceties.
3205 if (!scsi_device_online(sdp))
3208 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
3210 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3211 "allocation failure.\n");
3215 sd_spinup_disk(sdkp);
3218 * Without media there is no reason to ask; moreover, some devices
3219 * react badly if we do.
3221 if (sdkp->media_present) {
3222 sd_read_capacity(sdkp, buffer);
3225 * set the default to rotational. All non-rotational devices
3226 * support the block characteristics VPD page, which will
3227 * cause this to be updated correctly and any device which
3228 * doesn't support it should be treated as rotational.
3230 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
3231 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
3233 if (scsi_device_supports_vpd(sdp)) {
3234 sd_read_block_provisioning(sdkp);
3235 sd_read_block_limits(sdkp);
3236 sd_read_block_characteristics(sdkp);
3237 sd_zbc_read_zones(sdkp, buffer);
3240 sd_print_capacity(sdkp, old_capacity);
3242 sd_read_write_protect_flag(sdkp, buffer);
3243 sd_read_cache_type(sdkp, buffer);
3244 sd_read_app_tag_own(sdkp, buffer);
3245 sd_read_write_same(sdkp, buffer);
3246 sd_read_security(sdkp, buffer);
3250 * We now have all cache related info, determine how we deal
3251 * with flush requests.
3253 sd_set_flush_flag(sdkp);
3255 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3256 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
3258 /* Some devices report a maximum block count for READ/WRITE requests. */
3259 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3260 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3262 if (sd_validate_opt_xfer_size(sdkp, dev_max)) {
3263 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3264 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3266 q->limits.io_opt = 0;
3267 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3268 (sector_t)BLK_DEF_MAX_SECTORS);
3271 /* Do not exceed controller limit */
3272 rw_max = min(rw_max, queue_max_hw_sectors(q));
3275 * Only update max_sectors if previously unset or if the current value
3276 * exceeds the capabilities of the hardware.
3278 if (sdkp->first_scan ||
3279 q->limits.max_sectors > q->limits.max_dev_sectors ||
3280 q->limits.max_sectors > q->limits.max_hw_sectors)
3281 q->limits.max_sectors = rw_max;
3283 sdkp->first_scan = 0;
3285 set_capacity_and_notify(disk, logical_to_sectors(sdp, sdkp->capacity));
3286 sd_config_write_same(sdkp);
3290 * For a zoned drive, revalidating the zones can be done only once
3291 * the gendisk capacity is set. So if this fails, set back the gendisk
3294 if (sd_zbc_revalidate_zones(sdkp))
3295 set_capacity_and_notify(disk, 0);
3302 * sd_unlock_native_capacity - unlock native capacity
3303 * @disk: struct gendisk to set capacity for
3305 * Block layer calls this function if it detects that partitions
3306 * on @disk reach beyond the end of the device. If the SCSI host
3307 * implements ->unlock_native_capacity() method, it's invoked to
3308 * give it a chance to adjust the device capacity.
3311 * Defined by block layer. Might sleep.
3313 static void sd_unlock_native_capacity(struct gendisk *disk)
3315 struct scsi_device *sdev = scsi_disk(disk)->device;
3317 if (sdev->host->hostt->unlock_native_capacity)
3318 sdev->host->hostt->unlock_native_capacity(sdev);
3322 * sd_format_disk_name - format disk name
3323 * @prefix: name prefix - ie. "sd" for SCSI disks
3324 * @index: index of the disk to format name for
3325 * @buf: output buffer
3326 * @buflen: length of the output buffer
3328 * SCSI disk names starts at sda. The 26th device is sdz and the
3329 * 27th is sdaa. The last one for two lettered suffix is sdzz
3330 * which is followed by sdaaa.
3332 * This is basically 26 base counting with one extra 'nil' entry
3333 * at the beginning from the second digit on and can be
3334 * determined using similar method as 26 base conversion with the
3335 * index shifted -1 after each digit is computed.
3341 * 0 on success, -errno on failure.
3343 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3345 const int base = 'z' - 'a' + 1;
3346 char *begin = buf + strlen(prefix);
3347 char *end = buf + buflen;
3357 *--p = 'a' + (index % unit);
3358 index = (index / unit) - 1;
3359 } while (index >= 0);
3361 memmove(begin, p, end - p);
3362 memcpy(buf, prefix, strlen(prefix));
3368 * sd_probe - called during driver initialization and whenever a
3369 * new scsi device is attached to the system. It is called once
3370 * for each scsi device (not just disks) present.
3371 * @dev: pointer to device object
3373 * Returns 0 if successful (or not interested in this scsi device
3374 * (e.g. scanner)); 1 when there is an error.
3376 * Note: this function is invoked from the scsi mid-level.
3377 * This function sets up the mapping between a given
3378 * <host,channel,id,lun> (found in sdp) and new device name
3379 * (e.g. /dev/sda). More precisely it is the block device major
3380 * and minor number that is chosen here.
3382 * Assume sd_probe is not re-entrant (for time being)
3383 * Also think about sd_probe() and sd_remove() running coincidentally.
3385 static int sd_probe(struct device *dev)
3387 struct scsi_device *sdp = to_scsi_device(dev);
3388 struct scsi_disk *sdkp;
3393 scsi_autopm_get_device(sdp);
3395 if (sdp->type != TYPE_DISK &&
3396 sdp->type != TYPE_ZBC &&
3397 sdp->type != TYPE_MOD &&
3398 sdp->type != TYPE_RBC)
3401 if (!IS_ENABLED(CONFIG_BLK_DEV_ZONED) && sdp->type == TYPE_ZBC) {
3402 sdev_printk(KERN_WARNING, sdp,
3403 "Unsupported ZBC host-managed device.\n");
3407 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
3411 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
3415 gd = alloc_disk(SD_MINORS);
3419 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3421 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
3425 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
3427 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
3428 goto out_free_index;
3432 sdkp->driver = &sd_template;
3434 sdkp->index = index;
3435 sdkp->max_retries = SD_MAX_RETRIES;
3436 atomic_set(&sdkp->openers, 0);
3437 atomic_set(&sdkp->device->ioerr_cnt, 0);
3439 if (!sdp->request_queue->rq_timeout) {
3440 if (sdp->type != TYPE_MOD)
3441 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3443 blk_queue_rq_timeout(sdp->request_queue,
3447 device_initialize(&sdkp->dev);
3448 sdkp->dev.parent = dev;
3449 sdkp->dev.class = &sd_disk_class;
3450 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
3452 error = device_add(&sdkp->dev);
3454 goto out_free_index;
3457 dev_set_drvdata(dev, sdkp);
3459 gd->major = sd_major((index & 0xf0) >> 4);
3460 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
3462 gd->fops = &sd_fops;
3463 gd->private_data = &sdkp->driver;
3464 gd->queue = sdkp->device->request_queue;
3466 /* defaults, until the device tells us otherwise */
3467 sdp->sector_size = 512;
3469 sdkp->media_present = 1;
3470 sdkp->write_prot = 0;
3471 sdkp->cache_override = 0;
3475 sdkp->first_scan = 1;
3476 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
3478 sd_revalidate_disk(gd);
3480 gd->flags = GENHD_FL_EXT_DEVT;
3481 if (sdp->removable) {
3482 gd->flags |= GENHD_FL_REMOVABLE;
3483 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3484 gd->event_flags = DISK_EVENT_FLAG_POLL | DISK_EVENT_FLAG_UEVENT;
3487 blk_pm_runtime_init(sdp->request_queue, dev);
3488 if (sdp->rpm_autosuspend) {
3489 pm_runtime_set_autosuspend_delay(dev,
3490 sdp->host->hostt->rpm_autosuspend_delay);
3492 device_add_disk(dev, gd, NULL);
3494 sd_dif_config_host(sdkp);
3496 sd_revalidate_disk(gd);
3498 if (sdkp->security) {
3499 sdkp->opal_dev = init_opal_dev(sdkp, &sd_sec_submit);
3501 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3504 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3505 sdp->removable ? "removable " : "");
3506 scsi_autopm_put_device(sdp);
3511 ida_free(&sd_index_ida, index);
3515 sd_zbc_release_disk(sdkp);
3518 scsi_autopm_put_device(sdp);
3523 * sd_remove - called whenever a scsi disk (previously recognized by
3524 * sd_probe) is detached from the system. It is called (potentially
3525 * multiple times) during sd module unload.
3526 * @dev: pointer to device object
3528 * Note: this function is invoked from the scsi mid-level.
3529 * This function potentially frees up a device name (e.g. /dev/sdc)
3530 * that could be re-used by a subsequent sd_probe().
3531 * This function is not called when the built-in sd driver is "exit-ed".
3533 static int sd_remove(struct device *dev)
3535 struct scsi_disk *sdkp;
3537 sdkp = dev_get_drvdata(dev);
3538 scsi_autopm_get_device(sdkp->device);
3540 async_synchronize_full_domain(&scsi_sd_pm_domain);
3541 device_del(&sdkp->dev);
3542 del_gendisk(sdkp->disk);
3545 free_opal_dev(sdkp->opal_dev);
3547 mutex_lock(&sd_ref_mutex);
3548 dev_set_drvdata(dev, NULL);
3549 put_device(&sdkp->dev);
3550 mutex_unlock(&sd_ref_mutex);
3556 * scsi_disk_release - Called to free the scsi_disk structure
3557 * @dev: pointer to embedded class device
3559 * sd_ref_mutex must be held entering this routine. Because it is
3560 * called on last put, you should always use the scsi_disk_get()
3561 * scsi_disk_put() helpers which manipulate the semaphore directly
3562 * and never do a direct put_device.
3564 static void scsi_disk_release(struct device *dev)
3566 struct scsi_disk *sdkp = to_scsi_disk(dev);
3567 struct gendisk *disk = sdkp->disk;
3568 struct request_queue *q = disk->queue;
3570 ida_free(&sd_index_ida, sdkp->index);
3573 * Wait until all requests that are in progress have completed.
3574 * This is necessary to avoid that e.g. scsi_end_request() crashes
3575 * due to clearing the disk->private_data pointer. Wait from inside
3576 * scsi_disk_release() instead of from sd_release() to avoid that
3577 * freezing and unfreezing the request queue affects user space I/O
3578 * in case multiple processes open a /dev/sd... node concurrently.
3580 blk_mq_freeze_queue(q);
3581 blk_mq_unfreeze_queue(q);
3583 disk->private_data = NULL;
3585 put_device(&sdkp->device->sdev_gendev);
3587 sd_zbc_release_disk(sdkp);
3592 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
3594 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3595 struct scsi_sense_hdr sshdr;
3596 struct scsi_device *sdp = sdkp->device;
3600 cmd[4] |= 1; /* START */
3602 if (sdp->start_stop_pwr_cond)
3603 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3605 if (!scsi_device_online(sdp))
3608 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3609 SD_TIMEOUT, sdkp->max_retries, 0, RQF_PM, NULL);
3611 sd_print_result(sdkp, "Start/Stop Unit failed", res);
3612 if (res > 0 && scsi_sense_valid(&sshdr)) {
3613 sd_print_sense_hdr(sdkp, &sshdr);
3614 /* 0x3a is medium not present */
3615 if (sshdr.asc == 0x3a)
3620 /* SCSI error codes must not go to the generic layer */
3628 * Send a SYNCHRONIZE CACHE instruction down to the device through
3629 * the normal SCSI command structure. Wait for the command to
3632 static void sd_shutdown(struct device *dev)
3634 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3637 return; /* this can happen */
3639 if (pm_runtime_suspended(dev))
3642 if (sdkp->WCE && sdkp->media_present) {
3643 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3644 sd_sync_cache(sdkp, NULL);
3647 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3648 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3649 sd_start_stop_device(sdkp, 0);
3653 static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
3655 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3656 struct scsi_sense_hdr sshdr;
3659 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3662 if (sdkp->WCE && sdkp->media_present) {
3663 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3664 ret = sd_sync_cache(sdkp, &sshdr);
3667 /* ignore OFFLINE device */
3671 if (!scsi_sense_valid(&sshdr) ||
3672 sshdr.sense_key != ILLEGAL_REQUEST)
3676 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3677 * doesn't support sync. There's not much to do and
3678 * suspend shouldn't fail.
3684 if (sdkp->device->manage_start_stop) {
3685 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3686 /* an error is not worth aborting a system sleep */
3687 ret = sd_start_stop_device(sdkp, 0);
3688 if (ignore_stop_errors)
3695 static int sd_suspend_system(struct device *dev)
3697 return sd_suspend_common(dev, true);
3700 static int sd_suspend_runtime(struct device *dev)
3702 return sd_suspend_common(dev, false);
3705 static int sd_resume(struct device *dev)
3707 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3710 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3713 if (!sdkp->device->manage_start_stop)
3716 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
3717 ret = sd_start_stop_device(sdkp, 1);
3719 opal_unlock_from_suspend(sdkp->opal_dev);
3724 * init_sd - entry point for this driver (both when built in or when
3727 * Note: this function registers this driver with the scsi mid-level.
3729 static int __init init_sd(void)
3731 int majors = 0, i, err;
3733 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3735 for (i = 0; i < SD_MAJORS; i++) {
3736 if (__register_blkdev(sd_major(i), "sd", sd_default_probe))
3744 err = class_register(&sd_disk_class);
3748 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3750 if (!sd_cdb_cache) {
3751 printk(KERN_ERR "sd: can't init extended cdb cache\n");
3756 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3758 printk(KERN_ERR "sd: can't init extended cdb pool\n");
3763 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3764 if (!sd_page_pool) {
3765 printk(KERN_ERR "sd: can't init discard page pool\n");
3770 err = scsi_register_driver(&sd_template.gendrv);
3772 goto err_out_driver;
3777 mempool_destroy(sd_page_pool);
3780 mempool_destroy(sd_cdb_pool);
3783 kmem_cache_destroy(sd_cdb_cache);
3786 class_unregister(&sd_disk_class);
3788 for (i = 0; i < SD_MAJORS; i++)
3789 unregister_blkdev(sd_major(i), "sd");
3794 * exit_sd - exit point for this driver (when it is a module).
3796 * Note: this function unregisters this driver from the scsi mid-level.
3798 static void __exit exit_sd(void)
3802 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3804 scsi_unregister_driver(&sd_template.gendrv);
3805 mempool_destroy(sd_cdb_pool);
3806 mempool_destroy(sd_page_pool);
3807 kmem_cache_destroy(sd_cdb_cache);
3809 class_unregister(&sd_disk_class);
3811 for (i = 0; i < SD_MAJORS; i++)
3812 unregister_blkdev(sd_major(i), "sd");
3815 module_init(init_sd);
3816 module_exit(exit_sd);
3818 void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
3820 scsi_print_sense_hdr(sdkp->device,
3821 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
3824 void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result)
3826 const char *hb_string = scsi_hostbyte_string(result);
3829 sd_printk(KERN_INFO, sdkp,
3830 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3831 hb_string ? hb_string : "invalid",
3834 sd_printk(KERN_INFO, sdkp,
3835 "%s: Result: hostbyte=0x%02x driverbyte=%s\n",
3836 msg, host_byte(result), "DRIVER_OK");