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 SD_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 SD_MAX_RETRIES, &data, &sshdr)) {
216 if (scsi_sense_valid(&sshdr))
217 sd_print_sense_hdr(sdkp, &sshdr);
220 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);
546 static struct attribute *sd_disk_attrs[] = {
547 &dev_attr_cache_type.attr,
549 &dev_attr_allow_restart.attr,
550 &dev_attr_manage_start_stop.attr,
551 &dev_attr_protection_type.attr,
552 &dev_attr_protection_mode.attr,
553 &dev_attr_app_tag_own.attr,
554 &dev_attr_thin_provisioning.attr,
555 &dev_attr_provisioning_mode.attr,
556 &dev_attr_zeroing_mode.attr,
557 &dev_attr_max_write_same_blocks.attr,
558 &dev_attr_max_medium_access_timeouts.attr,
559 &dev_attr_zoned_cap.attr,
562 ATTRIBUTE_GROUPS(sd_disk);
564 static struct class sd_disk_class = {
566 .owner = THIS_MODULE,
567 .dev_release = scsi_disk_release,
568 .dev_groups = sd_disk_groups,
571 static const struct dev_pm_ops sd_pm_ops = {
572 .suspend = sd_suspend_system,
574 .poweroff = sd_suspend_system,
575 .restore = sd_resume,
576 .runtime_suspend = sd_suspend_runtime,
577 .runtime_resume = sd_resume,
580 static struct scsi_driver sd_template = {
583 .owner = THIS_MODULE,
585 .probe_type = PROBE_PREFER_ASYNCHRONOUS,
587 .shutdown = sd_shutdown,
591 .init_command = sd_init_command,
592 .uninit_command = sd_uninit_command,
594 .eh_action = sd_eh_action,
595 .eh_reset = sd_eh_reset,
599 * Dummy kobj_map->probe function.
600 * The default ->probe function will call modprobe, which is
601 * pointless as this module is already loaded.
603 static struct kobject *sd_default_probe(dev_t devt, int *partno, void *data)
609 * Device no to disk mapping:
611 * major disc2 disc p1
612 * |............|.............|....|....| <- dev_t
615 * Inside a major, we have 16k disks, however mapped non-
616 * contiguously. The first 16 disks are for major0, the next
617 * ones with major1, ... Disk 256 is for major0 again, disk 272
619 * As we stay compatible with our numbering scheme, we can reuse
620 * the well-know SCSI majors 8, 65--71, 136--143.
622 static int sd_major(int major_idx)
626 return SCSI_DISK0_MAJOR;
628 return SCSI_DISK1_MAJOR + major_idx - 1;
630 return SCSI_DISK8_MAJOR + major_idx - 8;
633 return 0; /* shut up gcc */
637 static struct scsi_disk *scsi_disk_get(struct gendisk *disk)
639 struct scsi_disk *sdkp = NULL;
641 mutex_lock(&sd_ref_mutex);
643 if (disk->private_data) {
644 sdkp = scsi_disk(disk);
645 if (scsi_device_get(sdkp->device) == 0)
646 get_device(&sdkp->dev);
650 mutex_unlock(&sd_ref_mutex);
654 static void scsi_disk_put(struct scsi_disk *sdkp)
656 struct scsi_device *sdev = sdkp->device;
658 mutex_lock(&sd_ref_mutex);
659 put_device(&sdkp->dev);
660 scsi_device_put(sdev);
661 mutex_unlock(&sd_ref_mutex);
664 #ifdef CONFIG_BLK_SED_OPAL
665 static int sd_sec_submit(void *data, u16 spsp, u8 secp, void *buffer,
666 size_t len, bool send)
668 struct scsi_device *sdev = data;
672 cdb[0] = send ? SECURITY_PROTOCOL_OUT : SECURITY_PROTOCOL_IN;
674 put_unaligned_be16(spsp, &cdb[2]);
675 put_unaligned_be32(len, &cdb[6]);
677 ret = scsi_execute_req(sdev, cdb,
678 send ? DMA_TO_DEVICE : DMA_FROM_DEVICE,
679 buffer, len, NULL, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
680 return ret <= 0 ? ret : -EIO;
682 #endif /* CONFIG_BLK_SED_OPAL */
685 * Look up the DIX operation based on whether the command is read or
686 * write and whether dix and dif are enabled.
688 static unsigned int sd_prot_op(bool write, bool dix, bool dif)
690 /* Lookup table: bit 2 (write), bit 1 (dix), bit 0 (dif) */
691 static const unsigned int ops[] = { /* wrt dix dif */
692 SCSI_PROT_NORMAL, /* 0 0 0 */
693 SCSI_PROT_READ_STRIP, /* 0 0 1 */
694 SCSI_PROT_READ_INSERT, /* 0 1 0 */
695 SCSI_PROT_READ_PASS, /* 0 1 1 */
696 SCSI_PROT_NORMAL, /* 1 0 0 */
697 SCSI_PROT_WRITE_INSERT, /* 1 0 1 */
698 SCSI_PROT_WRITE_STRIP, /* 1 1 0 */
699 SCSI_PROT_WRITE_PASS, /* 1 1 1 */
702 return ops[write << 2 | dix << 1 | dif];
706 * Returns a mask of the protection flags that are valid for a given DIX
709 static unsigned int sd_prot_flag_mask(unsigned int prot_op)
711 static const unsigned int flag_mask[] = {
712 [SCSI_PROT_NORMAL] = 0,
714 [SCSI_PROT_READ_STRIP] = SCSI_PROT_TRANSFER_PI |
715 SCSI_PROT_GUARD_CHECK |
716 SCSI_PROT_REF_CHECK |
717 SCSI_PROT_REF_INCREMENT,
719 [SCSI_PROT_READ_INSERT] = SCSI_PROT_REF_INCREMENT |
720 SCSI_PROT_IP_CHECKSUM,
722 [SCSI_PROT_READ_PASS] = SCSI_PROT_TRANSFER_PI |
723 SCSI_PROT_GUARD_CHECK |
724 SCSI_PROT_REF_CHECK |
725 SCSI_PROT_REF_INCREMENT |
726 SCSI_PROT_IP_CHECKSUM,
728 [SCSI_PROT_WRITE_INSERT] = SCSI_PROT_TRANSFER_PI |
729 SCSI_PROT_REF_INCREMENT,
731 [SCSI_PROT_WRITE_STRIP] = SCSI_PROT_GUARD_CHECK |
732 SCSI_PROT_REF_CHECK |
733 SCSI_PROT_REF_INCREMENT |
734 SCSI_PROT_IP_CHECKSUM,
736 [SCSI_PROT_WRITE_PASS] = SCSI_PROT_TRANSFER_PI |
737 SCSI_PROT_GUARD_CHECK |
738 SCSI_PROT_REF_CHECK |
739 SCSI_PROT_REF_INCREMENT |
740 SCSI_PROT_IP_CHECKSUM,
743 return flag_mask[prot_op];
746 static unsigned char sd_setup_protect_cmnd(struct scsi_cmnd *scmd,
747 unsigned int dix, unsigned int dif)
749 struct bio *bio = scmd->request->bio;
750 unsigned int prot_op = sd_prot_op(rq_data_dir(scmd->request), dix, dif);
751 unsigned int protect = 0;
753 if (dix) { /* DIX Type 0, 1, 2, 3 */
754 if (bio_integrity_flagged(bio, BIP_IP_CHECKSUM))
755 scmd->prot_flags |= SCSI_PROT_IP_CHECKSUM;
757 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
758 scmd->prot_flags |= SCSI_PROT_GUARD_CHECK;
761 if (dif != T10_PI_TYPE3_PROTECTION) { /* DIX/DIF Type 0, 1, 2 */
762 scmd->prot_flags |= SCSI_PROT_REF_INCREMENT;
764 if (bio_integrity_flagged(bio, BIP_CTRL_NOCHECK) == false)
765 scmd->prot_flags |= SCSI_PROT_REF_CHECK;
768 if (dif) { /* DIX/DIF Type 1, 2, 3 */
769 scmd->prot_flags |= SCSI_PROT_TRANSFER_PI;
771 if (bio_integrity_flagged(bio, BIP_DISK_NOCHECK))
772 protect = 3 << 5; /* Disable target PI checking */
774 protect = 1 << 5; /* Enable target PI checking */
777 scsi_set_prot_op(scmd, prot_op);
778 scsi_set_prot_type(scmd, dif);
779 scmd->prot_flags &= sd_prot_flag_mask(prot_op);
784 static void sd_config_discard(struct scsi_disk *sdkp, unsigned int mode)
786 struct request_queue *q = sdkp->disk->queue;
787 unsigned int logical_block_size = sdkp->device->sector_size;
788 unsigned int max_blocks = 0;
790 q->limits.discard_alignment =
791 sdkp->unmap_alignment * logical_block_size;
792 q->limits.discard_granularity =
793 max(sdkp->physical_block_size,
794 sdkp->unmap_granularity * logical_block_size);
795 sdkp->provisioning_mode = mode;
801 blk_queue_max_discard_sectors(q, 0);
802 blk_queue_flag_clear(QUEUE_FLAG_DISCARD, q);
806 max_blocks = min_not_zero(sdkp->max_unmap_blocks,
807 (u32)SD_MAX_WS16_BLOCKS);
811 if (sdkp->device->unmap_limit_for_ws)
812 max_blocks = sdkp->max_unmap_blocks;
814 max_blocks = sdkp->max_ws_blocks;
816 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS16_BLOCKS);
820 if (sdkp->device->unmap_limit_for_ws)
821 max_blocks = sdkp->max_unmap_blocks;
823 max_blocks = sdkp->max_ws_blocks;
825 max_blocks = min_not_zero(max_blocks, (u32)SD_MAX_WS10_BLOCKS);
829 max_blocks = min_not_zero(sdkp->max_ws_blocks,
830 (u32)SD_MAX_WS10_BLOCKS);
834 blk_queue_max_discard_sectors(q, max_blocks * (logical_block_size >> 9));
835 blk_queue_flag_set(QUEUE_FLAG_DISCARD, q);
838 static blk_status_t sd_setup_unmap_cmnd(struct scsi_cmnd *cmd)
840 struct scsi_device *sdp = cmd->device;
841 struct request *rq = cmd->request;
842 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
843 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
844 unsigned int data_len = 24;
847 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
848 if (!rq->special_vec.bv_page)
849 return BLK_STS_RESOURCE;
850 clear_highpage(rq->special_vec.bv_page);
851 rq->special_vec.bv_offset = 0;
852 rq->special_vec.bv_len = data_len;
853 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
856 cmd->cmnd[0] = UNMAP;
859 buf = page_address(rq->special_vec.bv_page);
860 put_unaligned_be16(6 + 16, &buf[0]);
861 put_unaligned_be16(16, &buf[2]);
862 put_unaligned_be64(lba, &buf[8]);
863 put_unaligned_be32(nr_blocks, &buf[16]);
865 cmd->allowed = SD_MAX_RETRIES;
866 cmd->transfersize = data_len;
867 rq->timeout = SD_TIMEOUT;
869 return scsi_init_io(cmd);
872 static blk_status_t sd_setup_write_same16_cmnd(struct scsi_cmnd *cmd,
875 struct scsi_device *sdp = cmd->device;
876 struct request *rq = cmd->request;
877 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
878 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
879 u32 data_len = sdp->sector_size;
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] = WRITE_SAME_16;
892 cmd->cmnd[1] = 0x8; /* UNMAP */
893 put_unaligned_be64(lba, &cmd->cmnd[2]);
894 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
896 cmd->allowed = SD_MAX_RETRIES;
897 cmd->transfersize = data_len;
898 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
900 return scsi_init_io(cmd);
903 static blk_status_t sd_setup_write_same10_cmnd(struct scsi_cmnd *cmd,
906 struct scsi_device *sdp = cmd->device;
907 struct request *rq = cmd->request;
908 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
909 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
910 u32 data_len = sdp->sector_size;
912 rq->special_vec.bv_page = mempool_alloc(sd_page_pool, GFP_ATOMIC);
913 if (!rq->special_vec.bv_page)
914 return BLK_STS_RESOURCE;
915 clear_highpage(rq->special_vec.bv_page);
916 rq->special_vec.bv_offset = 0;
917 rq->special_vec.bv_len = data_len;
918 rq->rq_flags |= RQF_SPECIAL_PAYLOAD;
921 cmd->cmnd[0] = WRITE_SAME;
923 cmd->cmnd[1] = 0x8; /* UNMAP */
924 put_unaligned_be32(lba, &cmd->cmnd[2]);
925 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
927 cmd->allowed = SD_MAX_RETRIES;
928 cmd->transfersize = data_len;
929 rq->timeout = unmap ? SD_TIMEOUT : SD_WRITE_SAME_TIMEOUT;
931 return scsi_init_io(cmd);
934 static blk_status_t sd_setup_write_zeroes_cmnd(struct scsi_cmnd *cmd)
936 struct request *rq = cmd->request;
937 struct scsi_device *sdp = cmd->device;
938 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
939 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
940 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
942 if (!(rq->cmd_flags & REQ_NOUNMAP)) {
943 switch (sdkp->zeroing_mode) {
944 case SD_ZERO_WS16_UNMAP:
945 return sd_setup_write_same16_cmnd(cmd, true);
946 case SD_ZERO_WS10_UNMAP:
947 return sd_setup_write_same10_cmnd(cmd, true);
951 if (sdp->no_write_same)
952 return BLK_STS_TARGET;
954 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff)
955 return sd_setup_write_same16_cmnd(cmd, false);
957 return sd_setup_write_same10_cmnd(cmd, false);
960 static void sd_config_write_same(struct scsi_disk *sdkp)
962 struct request_queue *q = sdkp->disk->queue;
963 unsigned int logical_block_size = sdkp->device->sector_size;
965 if (sdkp->device->no_write_same) {
966 sdkp->max_ws_blocks = 0;
970 /* Some devices can not handle block counts above 0xffff despite
971 * supporting WRITE SAME(16). Consequently we default to 64k
972 * blocks per I/O unless the device explicitly advertises a
975 if (sdkp->max_ws_blocks > SD_MAX_WS10_BLOCKS)
976 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
977 (u32)SD_MAX_WS16_BLOCKS);
978 else if (sdkp->ws16 || sdkp->ws10 || sdkp->device->no_report_opcodes)
979 sdkp->max_ws_blocks = min_not_zero(sdkp->max_ws_blocks,
980 (u32)SD_MAX_WS10_BLOCKS);
982 sdkp->device->no_write_same = 1;
983 sdkp->max_ws_blocks = 0;
986 if (sdkp->lbprz && sdkp->lbpws)
987 sdkp->zeroing_mode = SD_ZERO_WS16_UNMAP;
988 else if (sdkp->lbprz && sdkp->lbpws10)
989 sdkp->zeroing_mode = SD_ZERO_WS10_UNMAP;
990 else if (sdkp->max_ws_blocks)
991 sdkp->zeroing_mode = SD_ZERO_WS;
993 sdkp->zeroing_mode = SD_ZERO_WRITE;
995 if (sdkp->max_ws_blocks &&
996 sdkp->physical_block_size > logical_block_size) {
998 * Reporting a maximum number of blocks that is not aligned
999 * on the device physical size would cause a large write same
1000 * request to be split into physically unaligned chunks by
1001 * __blkdev_issue_write_zeroes() and __blkdev_issue_write_same()
1002 * even if the caller of these functions took care to align the
1003 * large request. So make sure the maximum reported is aligned
1004 * to the device physical block size. This is only an optional
1005 * optimization for regular disks, but this is mandatory to
1006 * avoid failure of large write same requests directed at
1007 * sequential write required zones of host-managed ZBC disks.
1009 sdkp->max_ws_blocks =
1010 round_down(sdkp->max_ws_blocks,
1011 bytes_to_logical(sdkp->device,
1012 sdkp->physical_block_size));
1016 blk_queue_max_write_same_sectors(q, sdkp->max_ws_blocks *
1017 (logical_block_size >> 9));
1018 blk_queue_max_write_zeroes_sectors(q, sdkp->max_ws_blocks *
1019 (logical_block_size >> 9));
1023 * sd_setup_write_same_cmnd - write the same data to multiple blocks
1024 * @cmd: command to prepare
1026 * Will set up either WRITE SAME(10) or WRITE SAME(16) depending on
1027 * the preference indicated by the target device.
1029 static blk_status_t sd_setup_write_same_cmnd(struct scsi_cmnd *cmd)
1031 struct request *rq = cmd->request;
1032 struct scsi_device *sdp = cmd->device;
1033 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1034 struct bio *bio = rq->bio;
1035 u64 lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1036 u32 nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
1039 if (sdkp->device->no_write_same)
1040 return BLK_STS_TARGET;
1042 BUG_ON(bio_offset(bio) || bio_iovec(bio).bv_len != sdp->sector_size);
1044 rq->timeout = SD_WRITE_SAME_TIMEOUT;
1046 if (sdkp->ws16 || lba > 0xffffffff || nr_blocks > 0xffff) {
1048 cmd->cmnd[0] = WRITE_SAME_16;
1049 put_unaligned_be64(lba, &cmd->cmnd[2]);
1050 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1053 cmd->cmnd[0] = WRITE_SAME;
1054 put_unaligned_be32(lba, &cmd->cmnd[2]);
1055 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1058 cmd->transfersize = sdp->sector_size;
1059 cmd->allowed = SD_MAX_RETRIES;
1062 * For WRITE SAME the data transferred via the DATA OUT buffer is
1063 * different from the amount of data actually written to the target.
1065 * We set up __data_len to the amount of data transferred via the
1066 * DATA OUT buffer so that blk_rq_map_sg sets up the proper S/G list
1067 * to transfer a single sector of data first, but then reset it to
1068 * the amount of data to be written right after so that the I/O path
1069 * knows how much to actually write.
1071 rq->__data_len = sdp->sector_size;
1072 ret = scsi_init_io(cmd);
1073 rq->__data_len = blk_rq_bytes(rq);
1078 static blk_status_t sd_setup_flush_cmnd(struct scsi_cmnd *cmd)
1080 struct request *rq = cmd->request;
1082 /* flush requests don't perform I/O, zero the S/G table */
1083 memset(&cmd->sdb, 0, sizeof(cmd->sdb));
1085 cmd->cmnd[0] = SYNCHRONIZE_CACHE;
1087 cmd->transfersize = 0;
1088 cmd->allowed = SD_MAX_RETRIES;
1090 rq->timeout = rq->q->rq_timeout * SD_FLUSH_TIMEOUT_MULTIPLIER;
1094 static blk_status_t sd_setup_rw32_cmnd(struct scsi_cmnd *cmd, bool write,
1095 sector_t lba, unsigned int nr_blocks,
1096 unsigned char flags)
1098 cmd->cmnd = mempool_alloc(sd_cdb_pool, GFP_ATOMIC);
1099 if (unlikely(cmd->cmnd == NULL))
1100 return BLK_STS_RESOURCE;
1102 cmd->cmd_len = SD_EXT_CDB_SIZE;
1103 memset(cmd->cmnd, 0, cmd->cmd_len);
1105 cmd->cmnd[0] = VARIABLE_LENGTH_CMD;
1106 cmd->cmnd[7] = 0x18; /* Additional CDB len */
1107 cmd->cmnd[9] = write ? WRITE_32 : READ_32;
1108 cmd->cmnd[10] = flags;
1109 put_unaligned_be64(lba, &cmd->cmnd[12]);
1110 put_unaligned_be32(lba, &cmd->cmnd[20]); /* Expected Indirect LBA */
1111 put_unaligned_be32(nr_blocks, &cmd->cmnd[28]);
1116 static blk_status_t sd_setup_rw16_cmnd(struct scsi_cmnd *cmd, bool write,
1117 sector_t lba, unsigned int nr_blocks,
1118 unsigned char flags)
1121 cmd->cmnd[0] = write ? WRITE_16 : READ_16;
1122 cmd->cmnd[1] = flags;
1125 put_unaligned_be64(lba, &cmd->cmnd[2]);
1126 put_unaligned_be32(nr_blocks, &cmd->cmnd[10]);
1131 static blk_status_t sd_setup_rw10_cmnd(struct scsi_cmnd *cmd, bool write,
1132 sector_t lba, unsigned int nr_blocks,
1133 unsigned char flags)
1136 cmd->cmnd[0] = write ? WRITE_10 : READ_10;
1137 cmd->cmnd[1] = flags;
1140 put_unaligned_be32(lba, &cmd->cmnd[2]);
1141 put_unaligned_be16(nr_blocks, &cmd->cmnd[7]);
1146 static blk_status_t sd_setup_rw6_cmnd(struct scsi_cmnd *cmd, bool write,
1147 sector_t lba, unsigned int nr_blocks,
1148 unsigned char flags)
1150 /* Avoid that 0 blocks gets translated into 256 blocks. */
1151 if (WARN_ON_ONCE(nr_blocks == 0))
1152 return BLK_STS_IOERR;
1154 if (unlikely(flags & 0x8)) {
1156 * This happens only if this drive failed 10byte rw
1157 * command with ILLEGAL_REQUEST during operation and
1158 * thus turned off use_10_for_rw.
1160 scmd_printk(KERN_ERR, cmd, "FUA write on READ/WRITE(6) drive\n");
1161 return BLK_STS_IOERR;
1165 cmd->cmnd[0] = write ? WRITE_6 : READ_6;
1166 cmd->cmnd[1] = (lba >> 16) & 0x1f;
1167 cmd->cmnd[2] = (lba >> 8) & 0xff;
1168 cmd->cmnd[3] = lba & 0xff;
1169 cmd->cmnd[4] = nr_blocks;
1175 static blk_status_t sd_setup_read_write_cmnd(struct scsi_cmnd *cmd)
1177 struct request *rq = cmd->request;
1178 struct scsi_device *sdp = cmd->device;
1179 struct scsi_disk *sdkp = scsi_disk(rq->rq_disk);
1180 sector_t lba = sectors_to_logical(sdp, blk_rq_pos(rq));
1182 unsigned int nr_blocks = sectors_to_logical(sdp, blk_rq_sectors(rq));
1183 unsigned int mask = logical_to_sectors(sdp, 1) - 1;
1184 bool write = rq_data_dir(rq) == WRITE;
1185 unsigned char protect, fua;
1190 ret = scsi_init_io(cmd);
1191 if (ret != BLK_STS_OK)
1194 if (!scsi_device_online(sdp) || sdp->changed) {
1195 scmd_printk(KERN_ERR, cmd, "device offline or changed\n");
1196 return BLK_STS_IOERR;
1199 if (blk_rq_pos(rq) + blk_rq_sectors(rq) > get_capacity(rq->rq_disk)) {
1200 scmd_printk(KERN_ERR, cmd, "access beyond end of device\n");
1201 return BLK_STS_IOERR;
1204 if ((blk_rq_pos(rq) & mask) || (blk_rq_sectors(rq) & mask)) {
1205 scmd_printk(KERN_ERR, cmd, "request not aligned to the logical block size\n");
1206 return BLK_STS_IOERR;
1210 * Some SD card readers can't handle accesses which touch the
1211 * last one or two logical blocks. Split accesses as needed.
1213 threshold = sdkp->capacity - SD_LAST_BUGGY_SECTORS;
1215 if (unlikely(sdp->last_sector_bug && lba + nr_blocks > threshold)) {
1216 if (lba < threshold) {
1217 /* Access up to the threshold but not beyond */
1218 nr_blocks = threshold - lba;
1220 /* Access only a single logical block */
1225 if (req_op(rq) == REQ_OP_ZONE_APPEND) {
1226 ret = sd_zbc_prepare_zone_append(cmd, &lba, nr_blocks);
1231 fua = rq->cmd_flags & REQ_FUA ? 0x8 : 0;
1232 dix = scsi_prot_sg_count(cmd);
1233 dif = scsi_host_dif_capable(cmd->device->host, sdkp->protection_type);
1236 protect = sd_setup_protect_cmnd(cmd, dix, dif);
1240 if (protect && sdkp->protection_type == T10_PI_TYPE2_PROTECTION) {
1241 ret = sd_setup_rw32_cmnd(cmd, write, lba, nr_blocks,
1243 } else if (sdp->use_16_for_rw || (nr_blocks > 0xffff)) {
1244 ret = sd_setup_rw16_cmnd(cmd, write, lba, nr_blocks,
1246 } else if ((nr_blocks > 0xff) || (lba > 0x1fffff) ||
1247 sdp->use_10_for_rw || protect) {
1248 ret = sd_setup_rw10_cmnd(cmd, write, lba, nr_blocks,
1251 ret = sd_setup_rw6_cmnd(cmd, write, lba, nr_blocks,
1255 if (unlikely(ret != BLK_STS_OK))
1259 * We shouldn't disconnect in the middle of a sector, so with a dumb
1260 * host adapter, it's safe to assume that we can at least transfer
1261 * this many bytes between each connect / disconnect.
1263 cmd->transfersize = sdp->sector_size;
1264 cmd->underflow = nr_blocks << 9;
1265 cmd->allowed = SD_MAX_RETRIES;
1266 cmd->sdb.length = nr_blocks * sdp->sector_size;
1269 scmd_printk(KERN_INFO, cmd,
1270 "%s: block=%llu, count=%d\n", __func__,
1271 (unsigned long long)blk_rq_pos(rq),
1272 blk_rq_sectors(rq)));
1274 scmd_printk(KERN_INFO, cmd,
1275 "%s %d/%u 512 byte blocks.\n",
1276 write ? "writing" : "reading", nr_blocks,
1277 blk_rq_sectors(rq)));
1280 * This indicates that the command is ready from our end to be
1286 static blk_status_t sd_init_command(struct scsi_cmnd *cmd)
1288 struct request *rq = cmd->request;
1290 switch (req_op(rq)) {
1291 case REQ_OP_DISCARD:
1292 switch (scsi_disk(rq->rq_disk)->provisioning_mode) {
1294 return sd_setup_unmap_cmnd(cmd);
1296 return sd_setup_write_same16_cmnd(cmd, true);
1298 return sd_setup_write_same10_cmnd(cmd, true);
1300 return sd_setup_write_same10_cmnd(cmd, false);
1302 return BLK_STS_TARGET;
1304 case REQ_OP_WRITE_ZEROES:
1305 return sd_setup_write_zeroes_cmnd(cmd);
1306 case REQ_OP_WRITE_SAME:
1307 return sd_setup_write_same_cmnd(cmd);
1309 return sd_setup_flush_cmnd(cmd);
1312 case REQ_OP_ZONE_APPEND:
1313 return sd_setup_read_write_cmnd(cmd);
1314 case REQ_OP_ZONE_RESET:
1315 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
1317 case REQ_OP_ZONE_RESET_ALL:
1318 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_RESET_WRITE_POINTER,
1320 case REQ_OP_ZONE_OPEN:
1321 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_OPEN_ZONE, false);
1322 case REQ_OP_ZONE_CLOSE:
1323 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_CLOSE_ZONE, false);
1324 case REQ_OP_ZONE_FINISH:
1325 return sd_zbc_setup_zone_mgmt_cmnd(cmd, ZO_FINISH_ZONE, false);
1328 return BLK_STS_NOTSUPP;
1332 static void sd_uninit_command(struct scsi_cmnd *SCpnt)
1334 struct request *rq = SCpnt->request;
1337 if (rq->rq_flags & RQF_SPECIAL_PAYLOAD)
1338 mempool_free(rq->special_vec.bv_page, sd_page_pool);
1340 if (SCpnt->cmnd != scsi_req(rq)->cmd) {
1344 mempool_free(cmnd, sd_cdb_pool);
1349 * sd_open - open a scsi disk device
1350 * @bdev: Block device of the scsi disk to open
1351 * @mode: FMODE_* mask
1353 * Returns 0 if successful. Returns a negated errno value in case
1356 * Note: This can be called from a user context (e.g. fsck(1) )
1357 * or from within the kernel (e.g. as a result of a mount(1) ).
1358 * In the latter case @inode and @filp carry an abridged amount
1359 * of information as noted above.
1361 * Locking: called with bdev->bd_mutex held.
1363 static int sd_open(struct block_device *bdev, fmode_t mode)
1365 struct scsi_disk *sdkp = scsi_disk_get(bdev->bd_disk);
1366 struct scsi_device *sdev;
1372 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_open\n"));
1374 sdev = sdkp->device;
1377 * If the device is in error recovery, wait until it is done.
1378 * If the device is offline, then disallow any access to it.
1381 if (!scsi_block_when_processing_errors(sdev))
1384 if (sdev->removable || sdkp->write_prot)
1385 check_disk_change(bdev);
1388 * If the drive is empty, just let the open fail.
1390 retval = -ENOMEDIUM;
1391 if (sdev->removable && !sdkp->media_present && !(mode & FMODE_NDELAY))
1395 * If the device has the write protect tab set, have the open fail
1396 * if the user expects to be able to write to the thing.
1399 if (sdkp->write_prot && (mode & FMODE_WRITE))
1403 * It is possible that the disk changing stuff resulted in
1404 * the device being taken offline. If this is the case,
1405 * report this to the user, and don't pretend that the
1406 * open actually succeeded.
1409 if (!scsi_device_online(sdev))
1412 if ((atomic_inc_return(&sdkp->openers) == 1) && sdev->removable) {
1413 if (scsi_block_when_processing_errors(sdev))
1414 scsi_set_medium_removal(sdev, SCSI_REMOVAL_PREVENT);
1420 scsi_disk_put(sdkp);
1425 * sd_release - invoked when the (last) close(2) is called on this
1427 * @disk: disk to release
1428 * @mode: FMODE_* mask
1432 * Note: may block (uninterruptible) if error recovery is underway
1435 * Locking: called with bdev->bd_mutex held.
1437 static void sd_release(struct gendisk *disk, fmode_t mode)
1439 struct scsi_disk *sdkp = scsi_disk(disk);
1440 struct scsi_device *sdev = sdkp->device;
1442 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_release\n"));
1444 if (atomic_dec_return(&sdkp->openers) == 0 && sdev->removable) {
1445 if (scsi_block_when_processing_errors(sdev))
1446 scsi_set_medium_removal(sdev, SCSI_REMOVAL_ALLOW);
1449 scsi_disk_put(sdkp);
1452 static int sd_getgeo(struct block_device *bdev, struct hd_geometry *geo)
1454 struct scsi_disk *sdkp = scsi_disk(bdev->bd_disk);
1455 struct scsi_device *sdp = sdkp->device;
1456 struct Scsi_Host *host = sdp->host;
1457 sector_t capacity = logical_to_sectors(sdp, sdkp->capacity);
1460 /* default to most commonly used values */
1461 diskinfo[0] = 0x40; /* 1 << 6 */
1462 diskinfo[1] = 0x20; /* 1 << 5 */
1463 diskinfo[2] = capacity >> 11;
1465 /* override with calculated, extended default, or driver values */
1466 if (host->hostt->bios_param)
1467 host->hostt->bios_param(sdp, bdev, capacity, diskinfo);
1469 scsicam_bios_param(bdev, capacity, diskinfo);
1471 geo->heads = diskinfo[0];
1472 geo->sectors = diskinfo[1];
1473 geo->cylinders = diskinfo[2];
1478 * sd_ioctl - process an ioctl
1479 * @bdev: target block device
1480 * @mode: FMODE_* mask
1481 * @cmd: ioctl command number
1482 * @p: this is third argument given to ioctl(2) system call.
1483 * Often contains a pointer.
1485 * Returns 0 if successful (some ioctls return positive numbers on
1486 * success as well). Returns a negated errno value in case of error.
1488 * Note: most ioctls are forward onto the block subsystem or further
1489 * down in the scsi subsystem.
1491 static int sd_ioctl_common(struct block_device *bdev, fmode_t mode,
1492 unsigned int cmd, void __user *p)
1494 struct gendisk *disk = bdev->bd_disk;
1495 struct scsi_disk *sdkp = scsi_disk(disk);
1496 struct scsi_device *sdp = sdkp->device;
1499 SCSI_LOG_IOCTL(1, sd_printk(KERN_INFO, sdkp, "sd_ioctl: disk=%s, "
1500 "cmd=0x%x\n", disk->disk_name, cmd));
1502 error = scsi_verify_blk_ioctl(bdev, cmd);
1507 * If we are in the middle of error recovery, don't let anyone
1508 * else try and use this device. Also, if error recovery fails, it
1509 * may try and take the device offline, in which case all further
1510 * access to the device is prohibited.
1512 error = scsi_ioctl_block_when_processing_errors(sdp, cmd,
1513 (mode & FMODE_NDELAY) != 0);
1517 if (is_sed_ioctl(cmd))
1518 return sed_ioctl(sdkp->opal_dev, cmd, p);
1521 * Send SCSI addressing ioctls directly to mid level, send other
1522 * ioctls to block level and then onto mid level if they can't be
1526 case SCSI_IOCTL_GET_IDLUN:
1527 case SCSI_IOCTL_GET_BUS_NUMBER:
1528 error = scsi_ioctl(sdp, cmd, p);
1531 error = scsi_cmd_blk_ioctl(bdev, mode, cmd, p);
1538 static void set_media_not_present(struct scsi_disk *sdkp)
1540 if (sdkp->media_present)
1541 sdkp->device->changed = 1;
1543 if (sdkp->device->removable) {
1544 sdkp->media_present = 0;
1549 static int media_not_present(struct scsi_disk *sdkp,
1550 struct scsi_sense_hdr *sshdr)
1552 if (!scsi_sense_valid(sshdr))
1555 /* not invoked for commands that could return deferred errors */
1556 switch (sshdr->sense_key) {
1557 case UNIT_ATTENTION:
1559 /* medium not present */
1560 if (sshdr->asc == 0x3A) {
1561 set_media_not_present(sdkp);
1569 * sd_check_events - check media events
1570 * @disk: kernel device descriptor
1571 * @clearing: disk events currently being cleared
1573 * Returns mask of DISK_EVENT_*.
1575 * Note: this function is invoked from the block subsystem.
1577 static unsigned int sd_check_events(struct gendisk *disk, unsigned int clearing)
1579 struct scsi_disk *sdkp = scsi_disk_get(disk);
1580 struct scsi_device *sdp;
1587 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp, "sd_check_events\n"));
1590 * If the device is offline, don't send any commands - just pretend as
1591 * if the command failed. If the device ever comes back online, we
1592 * can deal with it then. It is only because of unrecoverable errors
1593 * that we would ever take a device offline in the first place.
1595 if (!scsi_device_online(sdp)) {
1596 set_media_not_present(sdkp);
1601 * Using TEST_UNIT_READY enables differentiation between drive with
1602 * no cartridge loaded - NOT READY, drive with changed cartridge -
1603 * UNIT ATTENTION, or with same cartridge - GOOD STATUS.
1605 * Drives that auto spin down. eg iomega jaz 1G, will be started
1606 * by sd_spinup_disk() from sd_revalidate_disk(), which happens whenever
1607 * sd_revalidate() is called.
1609 if (scsi_block_when_processing_errors(sdp)) {
1610 struct scsi_sense_hdr sshdr = { 0, };
1612 retval = scsi_test_unit_ready(sdp, SD_TIMEOUT, SD_MAX_RETRIES,
1615 /* failed to execute TUR, assume media not present */
1616 if (host_byte(retval)) {
1617 set_media_not_present(sdkp);
1621 if (media_not_present(sdkp, &sshdr))
1626 * For removable scsi disk we have to recognise the presence
1627 * of a disk in the drive.
1629 if (!sdkp->media_present)
1631 sdkp->media_present = 1;
1634 * sdp->changed is set under the following conditions:
1636 * Medium present state has changed in either direction.
1637 * Device has indicated UNIT_ATTENTION.
1639 retval = sdp->changed ? DISK_EVENT_MEDIA_CHANGE : 0;
1641 scsi_disk_put(sdkp);
1645 static int sd_sync_cache(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
1648 struct scsi_device *sdp = sdkp->device;
1649 const int timeout = sdp->request_queue->rq_timeout
1650 * SD_FLUSH_TIMEOUT_MULTIPLIER;
1651 struct scsi_sense_hdr my_sshdr;
1653 if (!scsi_device_online(sdp))
1656 /* caller might not be interested in sense, but we need it */
1660 for (retries = 3; retries > 0; --retries) {
1661 unsigned char cmd[10] = { 0 };
1663 cmd[0] = SYNCHRONIZE_CACHE;
1665 * Leave the rest of the command zero to indicate
1668 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, sshdr,
1669 timeout, SD_MAX_RETRIES, 0, RQF_PM, NULL);
1675 sd_print_result(sdkp, "Synchronize Cache(10) failed", res);
1677 if (driver_byte(res) == DRIVER_SENSE)
1678 sd_print_sense_hdr(sdkp, sshdr);
1680 /* we need to evaluate the error return */
1681 if (scsi_sense_valid(sshdr) &&
1682 (sshdr->asc == 0x3a || /* medium not present */
1683 sshdr->asc == 0x20 || /* invalid command */
1684 (sshdr->asc == 0x74 && sshdr->ascq == 0x71))) /* drive is password locked */
1685 /* this is no error here */
1688 switch (host_byte(res)) {
1689 /* ignore errors due to racing a disconnection */
1690 case DID_BAD_TARGET:
1691 case DID_NO_CONNECT:
1693 /* signal the upper layer it might try again */
1697 case DID_SOFT_ERROR:
1706 static void sd_rescan(struct device *dev)
1708 struct scsi_disk *sdkp = dev_get_drvdata(dev);
1710 revalidate_disk(sdkp->disk);
1713 static int sd_ioctl(struct block_device *bdev, fmode_t mode,
1714 unsigned int cmd, unsigned long arg)
1716 void __user *p = (void __user *)arg;
1719 ret = sd_ioctl_common(bdev, mode, cmd, p);
1723 return scsi_ioctl(scsi_disk(bdev->bd_disk)->device, cmd, p);
1726 #ifdef CONFIG_COMPAT
1727 static int sd_compat_ioctl(struct block_device *bdev, fmode_t mode,
1728 unsigned int cmd, unsigned long arg)
1730 void __user *p = compat_ptr(arg);
1733 ret = sd_ioctl_common(bdev, mode, cmd, p);
1737 return scsi_compat_ioctl(scsi_disk(bdev->bd_disk)->device, cmd, p);
1741 static char sd_pr_type(enum pr_type type)
1744 case PR_WRITE_EXCLUSIVE:
1746 case PR_EXCLUSIVE_ACCESS:
1748 case PR_WRITE_EXCLUSIVE_REG_ONLY:
1750 case PR_EXCLUSIVE_ACCESS_REG_ONLY:
1752 case PR_WRITE_EXCLUSIVE_ALL_REGS:
1754 case PR_EXCLUSIVE_ACCESS_ALL_REGS:
1761 static int sd_pr_command(struct block_device *bdev, u8 sa,
1762 u64 key, u64 sa_key, u8 type, u8 flags)
1764 struct scsi_device *sdev = scsi_disk(bdev->bd_disk)->device;
1765 struct scsi_sense_hdr sshdr;
1767 u8 cmd[16] = { 0, };
1768 u8 data[24] = { 0, };
1770 cmd[0] = PERSISTENT_RESERVE_OUT;
1773 put_unaligned_be32(sizeof(data), &cmd[5]);
1775 put_unaligned_be64(key, &data[0]);
1776 put_unaligned_be64(sa_key, &data[8]);
1779 result = scsi_execute_req(sdev, cmd, DMA_TO_DEVICE, &data, sizeof(data),
1780 &sshdr, SD_TIMEOUT, SD_MAX_RETRIES, NULL);
1782 if (driver_byte(result) == DRIVER_SENSE &&
1783 scsi_sense_valid(&sshdr)) {
1784 sdev_printk(KERN_INFO, sdev, "PR command failed: %d\n", result);
1785 scsi_print_sense_hdr(sdev, NULL, &sshdr);
1791 static int sd_pr_register(struct block_device *bdev, u64 old_key, u64 new_key,
1794 if (flags & ~PR_FL_IGNORE_KEY)
1796 return sd_pr_command(bdev, (flags & PR_FL_IGNORE_KEY) ? 0x06 : 0x00,
1797 old_key, new_key, 0,
1798 (1 << 0) /* APTPL */);
1801 static int sd_pr_reserve(struct block_device *bdev, u64 key, enum pr_type type,
1806 return sd_pr_command(bdev, 0x01, key, 0, sd_pr_type(type), 0);
1809 static int sd_pr_release(struct block_device *bdev, u64 key, enum pr_type type)
1811 return sd_pr_command(bdev, 0x02, key, 0, sd_pr_type(type), 0);
1814 static int sd_pr_preempt(struct block_device *bdev, u64 old_key, u64 new_key,
1815 enum pr_type type, bool abort)
1817 return sd_pr_command(bdev, abort ? 0x05 : 0x04, old_key, new_key,
1818 sd_pr_type(type), 0);
1821 static int sd_pr_clear(struct block_device *bdev, u64 key)
1823 return sd_pr_command(bdev, 0x03, key, 0, 0, 0);
1826 static const struct pr_ops sd_pr_ops = {
1827 .pr_register = sd_pr_register,
1828 .pr_reserve = sd_pr_reserve,
1829 .pr_release = sd_pr_release,
1830 .pr_preempt = sd_pr_preempt,
1831 .pr_clear = sd_pr_clear,
1834 static const struct block_device_operations sd_fops = {
1835 .owner = THIS_MODULE,
1837 .release = sd_release,
1839 .getgeo = sd_getgeo,
1840 #ifdef CONFIG_COMPAT
1841 .compat_ioctl = sd_compat_ioctl,
1843 .check_events = sd_check_events,
1844 .revalidate_disk = sd_revalidate_disk,
1845 .unlock_native_capacity = sd_unlock_native_capacity,
1846 .report_zones = sd_zbc_report_zones,
1847 .pr_ops = &sd_pr_ops,
1851 * sd_eh_reset - reset error handling callback
1852 * @scmd: sd-issued command that has failed
1854 * This function is called by the SCSI midlayer before starting
1855 * SCSI EH. When counting medium access failures we have to be
1856 * careful to register it only only once per device and SCSI EH run;
1857 * there might be several timed out commands which will cause the
1858 * 'max_medium_access_timeouts' counter to trigger after the first
1859 * SCSI EH run already and set the device to offline.
1860 * So this function resets the internal counter before starting SCSI EH.
1862 static void sd_eh_reset(struct scsi_cmnd *scmd)
1864 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1866 /* New SCSI EH run, reset gate variable */
1867 sdkp->ignore_medium_access_errors = false;
1871 * sd_eh_action - error handling callback
1872 * @scmd: sd-issued command that has failed
1873 * @eh_disp: The recovery disposition suggested by the midlayer
1875 * This function is called by the SCSI midlayer upon completion of an
1876 * error test command (currently TEST UNIT READY). The result of sending
1877 * the eh command is passed in eh_disp. We're looking for devices that
1878 * fail medium access commands but are OK with non access commands like
1879 * test unit ready (so wrongly see the device as having a successful
1882 static int sd_eh_action(struct scsi_cmnd *scmd, int eh_disp)
1884 struct scsi_disk *sdkp = scsi_disk(scmd->request->rq_disk);
1885 struct scsi_device *sdev = scmd->device;
1887 if (!scsi_device_online(sdev) ||
1888 !scsi_medium_access_command(scmd) ||
1889 host_byte(scmd->result) != DID_TIME_OUT ||
1894 * The device has timed out executing a medium access command.
1895 * However, the TEST UNIT READY command sent during error
1896 * handling completed successfully. Either the device is in the
1897 * process of recovering or has it suffered an internal failure
1898 * that prevents access to the storage medium.
1900 if (!sdkp->ignore_medium_access_errors) {
1901 sdkp->medium_access_timed_out++;
1902 sdkp->ignore_medium_access_errors = true;
1906 * If the device keeps failing read/write commands but TEST UNIT
1907 * READY always completes successfully we assume that medium
1908 * access is no longer possible and take the device offline.
1910 if (sdkp->medium_access_timed_out >= sdkp->max_medium_access_timeouts) {
1911 scmd_printk(KERN_ERR, scmd,
1912 "Medium access timeout failure. Offlining disk!\n");
1913 mutex_lock(&sdev->state_mutex);
1914 scsi_device_set_state(sdev, SDEV_OFFLINE);
1915 mutex_unlock(&sdev->state_mutex);
1923 static unsigned int sd_completed_bytes(struct scsi_cmnd *scmd)
1925 struct request *req = scmd->request;
1926 struct scsi_device *sdev = scmd->device;
1927 unsigned int transferred, good_bytes;
1928 u64 start_lba, end_lba, bad_lba;
1931 * Some commands have a payload smaller than the device logical
1932 * block size (e.g. INQUIRY on a 4K disk).
1934 if (scsi_bufflen(scmd) <= sdev->sector_size)
1937 /* Check if we have a 'bad_lba' information */
1938 if (!scsi_get_sense_info_fld(scmd->sense_buffer,
1939 SCSI_SENSE_BUFFERSIZE,
1944 * If the bad lba was reported incorrectly, we have no idea where
1947 start_lba = sectors_to_logical(sdev, blk_rq_pos(req));
1948 end_lba = start_lba + bytes_to_logical(sdev, scsi_bufflen(scmd));
1949 if (bad_lba < start_lba || bad_lba >= end_lba)
1953 * resid is optional but mostly filled in. When it's unused,
1954 * its value is zero, so we assume the whole buffer transferred
1956 transferred = scsi_bufflen(scmd) - scsi_get_resid(scmd);
1958 /* This computation should always be done in terms of the
1959 * resolution of the device's medium.
1961 good_bytes = logical_to_bytes(sdev, bad_lba - start_lba);
1963 return min(good_bytes, transferred);
1967 * sd_done - bottom half handler: called when the lower level
1968 * driver has completed (successfully or otherwise) a scsi command.
1969 * @SCpnt: mid-level's per command structure.
1971 * Note: potentially run from within an ISR. Must not block.
1973 static int sd_done(struct scsi_cmnd *SCpnt)
1975 int result = SCpnt->result;
1976 unsigned int good_bytes = result ? 0 : scsi_bufflen(SCpnt);
1977 unsigned int sector_size = SCpnt->device->sector_size;
1979 struct scsi_sense_hdr sshdr;
1980 struct scsi_disk *sdkp = scsi_disk(SCpnt->request->rq_disk);
1981 struct request *req = SCpnt->request;
1982 int sense_valid = 0;
1983 int sense_deferred = 0;
1985 switch (req_op(req)) {
1986 case REQ_OP_DISCARD:
1987 case REQ_OP_WRITE_ZEROES:
1988 case REQ_OP_WRITE_SAME:
1989 case REQ_OP_ZONE_RESET:
1990 case REQ_OP_ZONE_RESET_ALL:
1991 case REQ_OP_ZONE_OPEN:
1992 case REQ_OP_ZONE_CLOSE:
1993 case REQ_OP_ZONE_FINISH:
1995 good_bytes = blk_rq_bytes(req);
1996 scsi_set_resid(SCpnt, 0);
1999 scsi_set_resid(SCpnt, blk_rq_bytes(req));
2004 * In case of bogus fw or device, we could end up having
2005 * an unaligned partial completion. Check this here and force
2008 resid = scsi_get_resid(SCpnt);
2009 if (resid & (sector_size - 1)) {
2010 sd_printk(KERN_INFO, sdkp,
2011 "Unaligned partial completion (resid=%u, sector_sz=%u)\n",
2012 resid, sector_size);
2013 scsi_print_command(SCpnt);
2014 resid = min(scsi_bufflen(SCpnt),
2015 round_up(resid, sector_size));
2016 scsi_set_resid(SCpnt, resid);
2021 sense_valid = scsi_command_normalize_sense(SCpnt, &sshdr);
2023 sense_deferred = scsi_sense_is_deferred(&sshdr);
2025 sdkp->medium_access_timed_out = 0;
2027 if (driver_byte(result) != DRIVER_SENSE &&
2028 (!sense_valid || sense_deferred))
2031 switch (sshdr.sense_key) {
2032 case HARDWARE_ERROR:
2034 good_bytes = sd_completed_bytes(SCpnt);
2036 case RECOVERED_ERROR:
2037 good_bytes = scsi_bufflen(SCpnt);
2040 /* This indicates a false check condition, so ignore it. An
2041 * unknown amount of data was transferred so treat it as an
2045 memset(SCpnt->sense_buffer, 0, SCSI_SENSE_BUFFERSIZE);
2047 case ABORTED_COMMAND:
2048 if (sshdr.asc == 0x10) /* DIF: Target detected corruption */
2049 good_bytes = sd_completed_bytes(SCpnt);
2051 case ILLEGAL_REQUEST:
2052 switch (sshdr.asc) {
2053 case 0x10: /* DIX: Host detected corruption */
2054 good_bytes = sd_completed_bytes(SCpnt);
2056 case 0x20: /* INVALID COMMAND OPCODE */
2057 case 0x24: /* INVALID FIELD IN CDB */
2058 switch (SCpnt->cmnd[0]) {
2060 sd_config_discard(sdkp, SD_LBP_DISABLE);
2064 if (SCpnt->cmnd[1] & 8) { /* UNMAP */
2065 sd_config_discard(sdkp, SD_LBP_DISABLE);
2067 sdkp->device->no_write_same = 1;
2068 sd_config_write_same(sdkp);
2069 req->rq_flags |= RQF_QUIET;
2080 if (sd_is_zoned(sdkp))
2081 good_bytes = sd_zbc_complete(SCpnt, good_bytes, &sshdr);
2083 SCSI_LOG_HLCOMPLETE(1, scmd_printk(KERN_INFO, SCpnt,
2084 "sd_done: completed %d of %d bytes\n",
2085 good_bytes, scsi_bufflen(SCpnt)));
2091 * spinup disk - called only in sd_revalidate_disk()
2094 sd_spinup_disk(struct scsi_disk *sdkp)
2096 unsigned char cmd[10];
2097 unsigned long spintime_expire = 0;
2098 int retries, spintime;
2099 unsigned int the_result;
2100 struct scsi_sense_hdr sshdr;
2101 int sense_valid = 0;
2105 /* Spin up drives, as required. Only do this at boot time */
2106 /* Spinup needs to be done for module loads too. */
2111 cmd[0] = TEST_UNIT_READY;
2112 memset((void *) &cmd[1], 0, 9);
2114 the_result = scsi_execute_req(sdkp->device, cmd,
2117 SD_MAX_RETRIES, NULL);
2120 * If the drive has indicated to us that it
2121 * doesn't have any media in it, don't bother
2122 * with any more polling.
2124 if (media_not_present(sdkp, &sshdr))
2128 sense_valid = scsi_sense_valid(&sshdr);
2130 } while (retries < 3 &&
2131 (!scsi_status_is_good(the_result) ||
2132 ((driver_byte(the_result) == DRIVER_SENSE) &&
2133 sense_valid && sshdr.sense_key == UNIT_ATTENTION)));
2135 if (driver_byte(the_result) != DRIVER_SENSE) {
2136 /* no sense, TUR either succeeded or failed
2137 * with a status error */
2138 if(!spintime && !scsi_status_is_good(the_result)) {
2139 sd_print_result(sdkp, "Test Unit Ready failed",
2146 * The device does not want the automatic start to be issued.
2148 if (sdkp->device->no_start_on_add)
2151 if (sense_valid && sshdr.sense_key == NOT_READY) {
2152 if (sshdr.asc == 4 && sshdr.ascq == 3)
2153 break; /* manual intervention required */
2154 if (sshdr.asc == 4 && sshdr.ascq == 0xb)
2155 break; /* standby */
2156 if (sshdr.asc == 4 && sshdr.ascq == 0xc)
2157 break; /* unavailable */
2158 if (sshdr.asc == 4 && sshdr.ascq == 0x1b)
2159 break; /* sanitize in progress */
2161 * Issue command to spin up drive when not ready
2164 sd_printk(KERN_NOTICE, sdkp, "Spinning up disk...");
2165 cmd[0] = START_STOP;
2166 cmd[1] = 1; /* Return immediately */
2167 memset((void *) &cmd[2], 0, 8);
2168 cmd[4] = 1; /* Start spin cycle */
2169 if (sdkp->device->start_stop_pwr_cond)
2171 scsi_execute_req(sdkp->device, cmd, DMA_NONE,
2173 SD_TIMEOUT, SD_MAX_RETRIES,
2175 spintime_expire = jiffies + 100 * HZ;
2178 /* Wait 1 second for next try */
2180 printk(KERN_CONT ".");
2183 * Wait for USB flash devices with slow firmware.
2184 * Yes, this sense key/ASC combination shouldn't
2185 * occur here. It's characteristic of these devices.
2187 } else if (sense_valid &&
2188 sshdr.sense_key == UNIT_ATTENTION &&
2189 sshdr.asc == 0x28) {
2191 spintime_expire = jiffies + 5 * HZ;
2194 /* Wait 1 second for next try */
2197 /* we don't understand the sense code, so it's
2198 * probably pointless to loop */
2200 sd_printk(KERN_NOTICE, sdkp, "Unit Not Ready\n");
2201 sd_print_sense_hdr(sdkp, &sshdr);
2206 } while (spintime && time_before_eq(jiffies, spintime_expire));
2209 if (scsi_status_is_good(the_result))
2210 printk(KERN_CONT "ready\n");
2212 printk(KERN_CONT "not responding...\n");
2217 * Determine whether disk supports Data Integrity Field.
2219 static int sd_read_protection_type(struct scsi_disk *sdkp, unsigned char *buffer)
2221 struct scsi_device *sdp = sdkp->device;
2225 if (scsi_device_protection(sdp) == 0 || (buffer[12] & 1) == 0) {
2226 sdkp->protection_type = 0;
2230 type = ((buffer[12] >> 1) & 7) + 1; /* P_TYPE 0 = Type 1 */
2232 if (type > T10_PI_TYPE3_PROTECTION)
2234 else if (scsi_host_dif_capable(sdp->host, type))
2237 if (sdkp->first_scan || type != sdkp->protection_type)
2240 sd_printk(KERN_ERR, sdkp, "formatted with unsupported" \
2241 " protection type %u. Disabling disk!\n",
2245 sd_printk(KERN_NOTICE, sdkp,
2246 "Enabling DIF Type %u protection\n", type);
2249 sd_printk(KERN_NOTICE, sdkp,
2250 "Disabling DIF Type %u protection\n", type);
2254 sdkp->protection_type = type;
2259 static void read_capacity_error(struct scsi_disk *sdkp, struct scsi_device *sdp,
2260 struct scsi_sense_hdr *sshdr, int sense_valid,
2263 if (driver_byte(the_result) == DRIVER_SENSE)
2264 sd_print_sense_hdr(sdkp, sshdr);
2266 sd_printk(KERN_NOTICE, sdkp, "Sense not available.\n");
2269 * Set dirty bit for removable devices if not ready -
2270 * sometimes drives will not report this properly.
2272 if (sdp->removable &&
2273 sense_valid && sshdr->sense_key == NOT_READY)
2274 set_media_not_present(sdkp);
2277 * We used to set media_present to 0 here to indicate no media
2278 * in the drive, but some drives fail read capacity even with
2279 * media present, so we can't do that.
2281 sdkp->capacity = 0; /* unknown mapped to zero - as usual */
2285 #if RC16_LEN > SD_BUF_SIZE
2286 #error RC16_LEN must not be more than SD_BUF_SIZE
2289 #define READ_CAPACITY_RETRIES_ON_RESET 10
2291 static int read_capacity_16(struct scsi_disk *sdkp, struct scsi_device *sdp,
2292 unsigned char *buffer)
2294 unsigned char cmd[16];
2295 struct scsi_sense_hdr sshdr;
2296 int sense_valid = 0;
2298 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2299 unsigned int alignment;
2300 unsigned long long lba;
2301 unsigned sector_size;
2303 if (sdp->no_read_capacity_16)
2308 cmd[0] = SERVICE_ACTION_IN_16;
2309 cmd[1] = SAI_READ_CAPACITY_16;
2311 memset(buffer, 0, RC16_LEN);
2313 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2314 buffer, RC16_LEN, &sshdr,
2315 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2317 if (media_not_present(sdkp, &sshdr))
2321 sense_valid = scsi_sense_valid(&sshdr);
2323 sshdr.sense_key == ILLEGAL_REQUEST &&
2324 (sshdr.asc == 0x20 || sshdr.asc == 0x24) &&
2326 /* Invalid Command Operation Code or
2327 * Invalid Field in CDB, just retry
2328 * silently with RC10 */
2331 sshdr.sense_key == UNIT_ATTENTION &&
2332 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2333 /* Device reset might occur several times,
2334 * give it one more chance */
2335 if (--reset_retries > 0)
2340 } while (the_result && retries);
2343 sd_print_result(sdkp, "Read Capacity(16) failed", the_result);
2344 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2348 sector_size = get_unaligned_be32(&buffer[8]);
2349 lba = get_unaligned_be64(&buffer[0]);
2351 if (sd_read_protection_type(sdkp, buffer) < 0) {
2356 /* Logical blocks per physical block exponent */
2357 sdkp->physical_block_size = (1 << (buffer[13] & 0xf)) * sector_size;
2360 sdkp->rc_basis = (buffer[12] >> 4) & 0x3;
2362 /* Lowest aligned logical block */
2363 alignment = ((buffer[14] & 0x3f) << 8 | buffer[15]) * sector_size;
2364 blk_queue_alignment_offset(sdp->request_queue, alignment);
2365 if (alignment && sdkp->first_scan)
2366 sd_printk(KERN_NOTICE, sdkp,
2367 "physical block alignment offset: %u\n", alignment);
2369 if (buffer[14] & 0x80) { /* LBPME */
2372 if (buffer[14] & 0x40) /* LBPRZ */
2375 sd_config_discard(sdkp, SD_LBP_WS16);
2378 sdkp->capacity = lba + 1;
2382 static int read_capacity_10(struct scsi_disk *sdkp, struct scsi_device *sdp,
2383 unsigned char *buffer)
2385 unsigned char cmd[16];
2386 struct scsi_sense_hdr sshdr;
2387 int sense_valid = 0;
2389 int retries = 3, reset_retries = READ_CAPACITY_RETRIES_ON_RESET;
2391 unsigned sector_size;
2394 cmd[0] = READ_CAPACITY;
2395 memset(&cmd[1], 0, 9);
2396 memset(buffer, 0, 8);
2398 the_result = scsi_execute_req(sdp, cmd, DMA_FROM_DEVICE,
2400 SD_TIMEOUT, SD_MAX_RETRIES, NULL);
2402 if (media_not_present(sdkp, &sshdr))
2406 sense_valid = scsi_sense_valid(&sshdr);
2408 sshdr.sense_key == UNIT_ATTENTION &&
2409 sshdr.asc == 0x29 && sshdr.ascq == 0x00)
2410 /* Device reset might occur several times,
2411 * give it one more chance */
2412 if (--reset_retries > 0)
2417 } while (the_result && retries);
2420 sd_print_result(sdkp, "Read Capacity(10) failed", the_result);
2421 read_capacity_error(sdkp, sdp, &sshdr, sense_valid, the_result);
2425 sector_size = get_unaligned_be32(&buffer[4]);
2426 lba = get_unaligned_be32(&buffer[0]);
2428 if (sdp->no_read_capacity_16 && (lba == 0xffffffff)) {
2429 /* Some buggy (usb cardreader) devices return an lba of
2430 0xffffffff when the want to report a size of 0 (with
2431 which they really mean no media is present) */
2433 sdkp->physical_block_size = sector_size;
2437 sdkp->capacity = lba + 1;
2438 sdkp->physical_block_size = sector_size;
2442 static int sd_try_rc16_first(struct scsi_device *sdp)
2444 if (sdp->host->max_cmd_len < 16)
2446 if (sdp->try_rc_10_first)
2448 if (sdp->scsi_level > SCSI_SPC_2)
2450 if (scsi_device_protection(sdp))
2456 * read disk capacity
2459 sd_read_capacity(struct scsi_disk *sdkp, unsigned char *buffer)
2462 struct scsi_device *sdp = sdkp->device;
2464 if (sd_try_rc16_first(sdp)) {
2465 sector_size = read_capacity_16(sdkp, sdp, buffer);
2466 if (sector_size == -EOVERFLOW)
2468 if (sector_size == -ENODEV)
2470 if (sector_size < 0)
2471 sector_size = read_capacity_10(sdkp, sdp, buffer);
2472 if (sector_size < 0)
2475 sector_size = read_capacity_10(sdkp, sdp, buffer);
2476 if (sector_size == -EOVERFLOW)
2478 if (sector_size < 0)
2480 if ((sizeof(sdkp->capacity) > 4) &&
2481 (sdkp->capacity > 0xffffffffULL)) {
2482 int old_sector_size = sector_size;
2483 sd_printk(KERN_NOTICE, sdkp, "Very big device. "
2484 "Trying to use READ CAPACITY(16).\n");
2485 sector_size = read_capacity_16(sdkp, sdp, buffer);
2486 if (sector_size < 0) {
2487 sd_printk(KERN_NOTICE, sdkp,
2488 "Using 0xffffffff as device size\n");
2489 sdkp->capacity = 1 + (sector_t) 0xffffffff;
2490 sector_size = old_sector_size;
2493 /* Remember that READ CAPACITY(16) succeeded */
2494 sdp->try_rc_10_first = 0;
2498 /* Some devices are known to return the total number of blocks,
2499 * not the highest block number. Some devices have versions
2500 * which do this and others which do not. Some devices we might
2501 * suspect of doing this but we don't know for certain.
2503 * If we know the reported capacity is wrong, decrement it. If
2504 * we can only guess, then assume the number of blocks is even
2505 * (usually true but not always) and err on the side of lowering
2508 if (sdp->fix_capacity ||
2509 (sdp->guess_capacity && (sdkp->capacity & 0x01))) {
2510 sd_printk(KERN_INFO, sdkp, "Adjusting the sector count "
2511 "from its reported value: %llu\n",
2512 (unsigned long long) sdkp->capacity);
2517 if (sector_size == 0) {
2519 sd_printk(KERN_NOTICE, sdkp, "Sector size 0 reported, "
2523 if (sector_size != 512 &&
2524 sector_size != 1024 &&
2525 sector_size != 2048 &&
2526 sector_size != 4096) {
2527 sd_printk(KERN_NOTICE, sdkp, "Unsupported sector size %d.\n",
2530 * The user might want to re-format the drive with
2531 * a supported sectorsize. Once this happens, it
2532 * would be relatively trivial to set the thing up.
2533 * For this reason, we leave the thing in the table.
2537 * set a bogus sector size so the normal read/write
2538 * logic in the block layer will eventually refuse any
2539 * request on this device without tripping over power
2540 * of two sector size assumptions
2544 blk_queue_logical_block_size(sdp->request_queue, sector_size);
2545 blk_queue_physical_block_size(sdp->request_queue,
2546 sdkp->physical_block_size);
2547 sdkp->device->sector_size = sector_size;
2549 if (sdkp->capacity > 0xffffffff)
2550 sdp->use_16_for_rw = 1;
2555 * Print disk capacity
2558 sd_print_capacity(struct scsi_disk *sdkp,
2559 sector_t old_capacity)
2561 int sector_size = sdkp->device->sector_size;
2562 char cap_str_2[10], cap_str_10[10];
2564 if (!sdkp->first_scan && old_capacity == sdkp->capacity)
2567 string_get_size(sdkp->capacity, sector_size,
2568 STRING_UNITS_2, cap_str_2, sizeof(cap_str_2));
2569 string_get_size(sdkp->capacity, sector_size,
2570 STRING_UNITS_10, cap_str_10, sizeof(cap_str_10));
2572 sd_printk(KERN_NOTICE, sdkp,
2573 "%llu %d-byte logical blocks: (%s/%s)\n",
2574 (unsigned long long)sdkp->capacity,
2575 sector_size, cap_str_10, cap_str_2);
2577 if (sdkp->physical_block_size != sector_size)
2578 sd_printk(KERN_NOTICE, sdkp,
2579 "%u-byte physical blocks\n",
2580 sdkp->physical_block_size);
2583 /* called with buffer of length 512 */
2585 sd_do_mode_sense(struct scsi_device *sdp, int dbd, int modepage,
2586 unsigned char *buffer, int len, struct scsi_mode_data *data,
2587 struct scsi_sense_hdr *sshdr)
2589 return scsi_mode_sense(sdp, dbd, modepage, buffer, len,
2590 SD_TIMEOUT, SD_MAX_RETRIES, data,
2595 * read write protect setting, if possible - called only in sd_revalidate_disk()
2596 * called with buffer of length SD_BUF_SIZE
2599 sd_read_write_protect_flag(struct scsi_disk *sdkp, unsigned char *buffer)
2602 struct scsi_device *sdp = sdkp->device;
2603 struct scsi_mode_data data;
2604 int old_wp = sdkp->write_prot;
2606 set_disk_ro(sdkp->disk, 0);
2607 if (sdp->skip_ms_page_3f) {
2608 sd_first_printk(KERN_NOTICE, sdkp, "Assuming Write Enabled\n");
2612 if (sdp->use_192_bytes_for_3f) {
2613 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 192, &data, NULL);
2616 * First attempt: ask for all pages (0x3F), but only 4 bytes.
2617 * We have to start carefully: some devices hang if we ask
2618 * for more than is available.
2620 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 4, &data, NULL);
2623 * Second attempt: ask for page 0 When only page 0 is
2624 * implemented, a request for page 3F may return Sense Key
2625 * 5: Illegal Request, Sense Code 24: Invalid field in
2628 if (!scsi_status_is_good(res))
2629 res = sd_do_mode_sense(sdp, 0, 0, buffer, 4, &data, NULL);
2632 * Third attempt: ask 255 bytes, as we did earlier.
2634 if (!scsi_status_is_good(res))
2635 res = sd_do_mode_sense(sdp, 0, 0x3F, buffer, 255,
2639 if (!scsi_status_is_good(res)) {
2640 sd_first_printk(KERN_WARNING, sdkp,
2641 "Test WP failed, assume Write Enabled\n");
2643 sdkp->write_prot = ((data.device_specific & 0x80) != 0);
2644 set_disk_ro(sdkp->disk, sdkp->write_prot);
2645 if (sdkp->first_scan || old_wp != sdkp->write_prot) {
2646 sd_printk(KERN_NOTICE, sdkp, "Write Protect is %s\n",
2647 sdkp->write_prot ? "on" : "off");
2648 sd_printk(KERN_DEBUG, sdkp, "Mode Sense: %4ph\n", buffer);
2654 * sd_read_cache_type - called only from sd_revalidate_disk()
2655 * called with buffer of length SD_BUF_SIZE
2658 sd_read_cache_type(struct scsi_disk *sdkp, unsigned char *buffer)
2661 struct scsi_device *sdp = sdkp->device;
2666 struct scsi_mode_data data;
2667 struct scsi_sense_hdr sshdr;
2668 int old_wce = sdkp->WCE;
2669 int old_rcd = sdkp->RCD;
2670 int old_dpofua = sdkp->DPOFUA;
2673 if (sdkp->cache_override)
2677 if (sdp->skip_ms_page_8) {
2678 if (sdp->type == TYPE_RBC)
2681 if (sdp->skip_ms_page_3f)
2684 if (sdp->use_192_bytes_for_3f)
2688 } else if (sdp->type == TYPE_RBC) {
2696 /* cautiously ask */
2697 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, first_len,
2700 if (!scsi_status_is_good(res))
2703 if (!data.header_length) {
2706 sd_first_printk(KERN_ERR, sdkp,
2707 "Missing header in MODE_SENSE response\n");
2710 /* that went OK, now ask for the proper length */
2714 * We're only interested in the first three bytes, actually.
2715 * But the data cache page is defined for the first 20.
2719 else if (len > SD_BUF_SIZE) {
2720 sd_first_printk(KERN_NOTICE, sdkp, "Truncating mode parameter "
2721 "data from %d to %d bytes\n", len, SD_BUF_SIZE);
2724 if (modepage == 0x3F && sdp->use_192_bytes_for_3f)
2728 if (len > first_len)
2729 res = sd_do_mode_sense(sdp, dbd, modepage, buffer, len,
2732 if (scsi_status_is_good(res)) {
2733 int offset = data.header_length + data.block_descriptor_length;
2735 while (offset < len) {
2736 u8 page_code = buffer[offset] & 0x3F;
2737 u8 spf = buffer[offset] & 0x40;
2739 if (page_code == 8 || page_code == 6) {
2740 /* We're interested only in the first 3 bytes.
2742 if (len - offset <= 2) {
2743 sd_first_printk(KERN_ERR, sdkp,
2744 "Incomplete mode parameter "
2748 modepage = page_code;
2752 /* Go to the next page */
2753 if (spf && len - offset > 3)
2754 offset += 4 + (buffer[offset+2] << 8) +
2756 else if (!spf && len - offset > 1)
2757 offset += 2 + buffer[offset+1];
2759 sd_first_printk(KERN_ERR, sdkp,
2761 "parameter data\n");
2767 sd_first_printk(KERN_ERR, sdkp, "No Caching mode page found\n");
2771 if (modepage == 8) {
2772 sdkp->WCE = ((buffer[offset + 2] & 0x04) != 0);
2773 sdkp->RCD = ((buffer[offset + 2] & 0x01) != 0);
2775 sdkp->WCE = ((buffer[offset + 2] & 0x01) == 0);
2779 sdkp->DPOFUA = (data.device_specific & 0x10) != 0;
2780 if (sdp->broken_fua) {
2781 sd_first_printk(KERN_NOTICE, sdkp, "Disabling FUA\n");
2783 } else if (sdkp->DPOFUA && !sdkp->device->use_10_for_rw &&
2784 !sdkp->device->use_16_for_rw) {
2785 sd_first_printk(KERN_NOTICE, sdkp,
2786 "Uses READ/WRITE(6), disabling FUA\n");
2790 /* No cache flush allowed for write protected devices */
2791 if (sdkp->WCE && sdkp->write_prot)
2794 if (sdkp->first_scan || old_wce != sdkp->WCE ||
2795 old_rcd != sdkp->RCD || old_dpofua != sdkp->DPOFUA)
2796 sd_printk(KERN_NOTICE, sdkp,
2797 "Write cache: %s, read cache: %s, %s\n",
2798 sdkp->WCE ? "enabled" : "disabled",
2799 sdkp->RCD ? "disabled" : "enabled",
2800 sdkp->DPOFUA ? "supports DPO and FUA"
2801 : "doesn't support DPO or FUA");
2807 if (scsi_sense_valid(&sshdr) &&
2808 sshdr.sense_key == ILLEGAL_REQUEST &&
2809 sshdr.asc == 0x24 && sshdr.ascq == 0x0)
2810 /* Invalid field in CDB */
2811 sd_first_printk(KERN_NOTICE, sdkp, "Cache data unavailable\n");
2813 sd_first_printk(KERN_ERR, sdkp,
2814 "Asking for cache data failed\n");
2817 if (sdp->wce_default_on) {
2818 sd_first_printk(KERN_NOTICE, sdkp,
2819 "Assuming drive cache: write back\n");
2822 sd_first_printk(KERN_ERR, sdkp,
2823 "Assuming drive cache: write through\n");
2831 * The ATO bit indicates whether the DIF application tag is available
2832 * for use by the operating system.
2834 static void sd_read_app_tag_own(struct scsi_disk *sdkp, unsigned char *buffer)
2837 struct scsi_device *sdp = sdkp->device;
2838 struct scsi_mode_data data;
2839 struct scsi_sense_hdr sshdr;
2841 if (sdp->type != TYPE_DISK && sdp->type != TYPE_ZBC)
2844 if (sdkp->protection_type == 0)
2847 res = scsi_mode_sense(sdp, 1, 0x0a, buffer, 36, SD_TIMEOUT,
2848 SD_MAX_RETRIES, &data, &sshdr);
2850 if (!scsi_status_is_good(res) || !data.header_length ||
2852 sd_first_printk(KERN_WARNING, sdkp,
2853 "getting Control mode page failed, assume no ATO\n");
2855 if (scsi_sense_valid(&sshdr))
2856 sd_print_sense_hdr(sdkp, &sshdr);
2861 offset = data.header_length + data.block_descriptor_length;
2863 if ((buffer[offset] & 0x3f) != 0x0a) {
2864 sd_first_printk(KERN_ERR, sdkp, "ATO Got wrong page\n");
2868 if ((buffer[offset + 5] & 0x80) == 0)
2877 * sd_read_block_limits - Query disk device for preferred I/O sizes.
2878 * @sdkp: disk to query
2880 static void sd_read_block_limits(struct scsi_disk *sdkp)
2882 unsigned int sector_sz = sdkp->device->sector_size;
2883 const int vpd_len = 64;
2884 unsigned char *buffer = kmalloc(vpd_len, GFP_KERNEL);
2887 /* Block Limits VPD */
2888 scsi_get_vpd_page(sdkp->device, 0xb0, buffer, vpd_len))
2891 blk_queue_io_min(sdkp->disk->queue,
2892 get_unaligned_be16(&buffer[6]) * sector_sz);
2894 sdkp->max_xfer_blocks = get_unaligned_be32(&buffer[8]);
2895 sdkp->opt_xfer_blocks = get_unaligned_be32(&buffer[12]);
2897 if (buffer[3] == 0x3c) {
2898 unsigned int lba_count, desc_count;
2900 sdkp->max_ws_blocks = (u32)get_unaligned_be64(&buffer[36]);
2905 lba_count = get_unaligned_be32(&buffer[20]);
2906 desc_count = get_unaligned_be32(&buffer[24]);
2908 if (lba_count && desc_count)
2909 sdkp->max_unmap_blocks = lba_count;
2911 sdkp->unmap_granularity = get_unaligned_be32(&buffer[28]);
2913 if (buffer[32] & 0x80)
2914 sdkp->unmap_alignment =
2915 get_unaligned_be32(&buffer[32]) & ~(1 << 31);
2917 if (!sdkp->lbpvpd) { /* LBP VPD page not provided */
2919 if (sdkp->max_unmap_blocks)
2920 sd_config_discard(sdkp, SD_LBP_UNMAP);
2922 sd_config_discard(sdkp, SD_LBP_WS16);
2924 } else { /* LBP VPD page tells us what to use */
2925 if (sdkp->lbpu && sdkp->max_unmap_blocks)
2926 sd_config_discard(sdkp, SD_LBP_UNMAP);
2927 else if (sdkp->lbpws)
2928 sd_config_discard(sdkp, SD_LBP_WS16);
2929 else if (sdkp->lbpws10)
2930 sd_config_discard(sdkp, SD_LBP_WS10);
2932 sd_config_discard(sdkp, SD_LBP_DISABLE);
2941 * sd_read_block_characteristics - Query block dev. characteristics
2942 * @sdkp: disk to query
2944 static void sd_read_block_characteristics(struct scsi_disk *sdkp)
2946 struct request_queue *q = sdkp->disk->queue;
2947 unsigned char *buffer;
2949 const int vpd_len = 64;
2951 buffer = kmalloc(vpd_len, GFP_KERNEL);
2954 /* Block Device Characteristics VPD */
2955 scsi_get_vpd_page(sdkp->device, 0xb1, buffer, vpd_len))
2958 rot = get_unaligned_be16(&buffer[4]);
2961 blk_queue_flag_set(QUEUE_FLAG_NONROT, q);
2962 blk_queue_flag_clear(QUEUE_FLAG_ADD_RANDOM, q);
2965 if (sdkp->device->type == TYPE_ZBC) {
2967 q->limits.zoned = BLK_ZONED_HM;
2969 sdkp->zoned = (buffer[8] >> 4) & 3;
2970 if (sdkp->zoned == 1 && !disk_has_partitions(sdkp->disk)) {
2972 q->limits.zoned = BLK_ZONED_HA;
2975 * Treat drive-managed devices and host-aware devices
2976 * with partitions as regular block devices.
2978 q->limits.zoned = BLK_ZONED_NONE;
2979 if (sdkp->zoned == 2 && sdkp->first_scan)
2980 sd_printk(KERN_NOTICE, sdkp,
2981 "Drive-managed SMR disk\n");
2984 if (blk_queue_is_zoned(q) && sdkp->first_scan)
2985 sd_printk(KERN_NOTICE, sdkp, "Host-%s zoned block device\n",
2986 q->limits.zoned == BLK_ZONED_HM ? "managed" : "aware");
2993 * sd_read_block_provisioning - Query provisioning VPD page
2994 * @sdkp: disk to query
2996 static void sd_read_block_provisioning(struct scsi_disk *sdkp)
2998 unsigned char *buffer;
2999 const int vpd_len = 8;
3001 if (sdkp->lbpme == 0)
3004 buffer = kmalloc(vpd_len, GFP_KERNEL);
3006 if (!buffer || scsi_get_vpd_page(sdkp->device, 0xb2, buffer, vpd_len))
3010 sdkp->lbpu = (buffer[5] >> 7) & 1; /* UNMAP */
3011 sdkp->lbpws = (buffer[5] >> 6) & 1; /* WRITE SAME(16) with UNMAP */
3012 sdkp->lbpws10 = (buffer[5] >> 5) & 1; /* WRITE SAME(10) with UNMAP */
3018 static void sd_read_write_same(struct scsi_disk *sdkp, unsigned char *buffer)
3020 struct scsi_device *sdev = sdkp->device;
3022 if (sdev->host->no_write_same) {
3023 sdev->no_write_same = 1;
3028 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, INQUIRY) < 0) {
3029 /* too large values might cause issues with arcmsr */
3030 int vpd_buf_len = 64;
3032 sdev->no_report_opcodes = 1;
3034 /* Disable WRITE SAME if REPORT SUPPORTED OPERATION
3035 * CODES is unsupported and the device has an ATA
3036 * Information VPD page (SAT).
3038 if (!scsi_get_vpd_page(sdev, 0x89, buffer, vpd_buf_len))
3039 sdev->no_write_same = 1;
3042 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME_16) == 1)
3045 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE, WRITE_SAME) == 1)
3049 static void sd_read_security(struct scsi_disk *sdkp, unsigned char *buffer)
3051 struct scsi_device *sdev = sdkp->device;
3053 if (!sdev->security_supported)
3056 if (scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3057 SECURITY_PROTOCOL_IN) == 1 &&
3058 scsi_report_opcode(sdev, buffer, SD_BUF_SIZE,
3059 SECURITY_PROTOCOL_OUT) == 1)
3064 * Determine the device's preferred I/O size for reads and writes
3065 * unless the reported value is unreasonably small, large, not a
3066 * multiple of the physical block size, or simply garbage.
3068 static bool sd_validate_opt_xfer_size(struct scsi_disk *sdkp,
3069 unsigned int dev_max)
3071 struct scsi_device *sdp = sdkp->device;
3072 unsigned int opt_xfer_bytes =
3073 logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3075 if (sdkp->opt_xfer_blocks == 0)
3078 if (sdkp->opt_xfer_blocks > dev_max) {
3079 sd_first_printk(KERN_WARNING, sdkp,
3080 "Optimal transfer size %u logical blocks " \
3081 "> dev_max (%u logical blocks)\n",
3082 sdkp->opt_xfer_blocks, dev_max);
3086 if (sdkp->opt_xfer_blocks > SD_DEF_XFER_BLOCKS) {
3087 sd_first_printk(KERN_WARNING, sdkp,
3088 "Optimal transfer size %u logical blocks " \
3089 "> sd driver limit (%u logical blocks)\n",
3090 sdkp->opt_xfer_blocks, SD_DEF_XFER_BLOCKS);
3094 if (opt_xfer_bytes < PAGE_SIZE) {
3095 sd_first_printk(KERN_WARNING, sdkp,
3096 "Optimal transfer size %u bytes < " \
3097 "PAGE_SIZE (%u bytes)\n",
3098 opt_xfer_bytes, (unsigned int)PAGE_SIZE);
3102 if (opt_xfer_bytes & (sdkp->physical_block_size - 1)) {
3103 sd_first_printk(KERN_WARNING, sdkp,
3104 "Optimal transfer size %u bytes not a " \
3105 "multiple of physical block size (%u bytes)\n",
3106 opt_xfer_bytes, sdkp->physical_block_size);
3110 sd_first_printk(KERN_INFO, sdkp, "Optimal transfer size %u bytes\n",
3116 * sd_revalidate_disk - called the first time a new disk is seen,
3117 * performs disk spin up, read_capacity, etc.
3118 * @disk: struct gendisk we care about
3120 static int sd_revalidate_disk(struct gendisk *disk)
3122 struct scsi_disk *sdkp = scsi_disk(disk);
3123 struct scsi_device *sdp = sdkp->device;
3124 struct request_queue *q = sdkp->disk->queue;
3125 sector_t old_capacity = sdkp->capacity;
3126 unsigned char *buffer;
3127 unsigned int dev_max, rw_max;
3129 SCSI_LOG_HLQUEUE(3, sd_printk(KERN_INFO, sdkp,
3130 "sd_revalidate_disk\n"));
3133 * If the device is offline, don't try and read capacity or any
3134 * of the other niceties.
3136 if (!scsi_device_online(sdp))
3139 buffer = kmalloc(SD_BUF_SIZE, GFP_KERNEL);
3141 sd_printk(KERN_WARNING, sdkp, "sd_revalidate_disk: Memory "
3142 "allocation failure.\n");
3146 sd_spinup_disk(sdkp);
3149 * Without media there is no reason to ask; moreover, some devices
3150 * react badly if we do.
3152 if (sdkp->media_present) {
3153 sd_read_capacity(sdkp, buffer);
3156 * set the default to rotational. All non-rotational devices
3157 * support the block characteristics VPD page, which will
3158 * cause this to be updated correctly and any device which
3159 * doesn't support it should be treated as rotational.
3161 blk_queue_flag_clear(QUEUE_FLAG_NONROT, q);
3162 blk_queue_flag_set(QUEUE_FLAG_ADD_RANDOM, q);
3164 if (scsi_device_supports_vpd(sdp)) {
3165 sd_read_block_provisioning(sdkp);
3166 sd_read_block_limits(sdkp);
3167 sd_read_block_characteristics(sdkp);
3168 sd_zbc_read_zones(sdkp, buffer);
3171 sd_print_capacity(sdkp, old_capacity);
3173 sd_read_write_protect_flag(sdkp, buffer);
3174 sd_read_cache_type(sdkp, buffer);
3175 sd_read_app_tag_own(sdkp, buffer);
3176 sd_read_write_same(sdkp, buffer);
3177 sd_read_security(sdkp, buffer);
3181 * We now have all cache related info, determine how we deal
3182 * with flush requests.
3184 sd_set_flush_flag(sdkp);
3186 /* Initial block count limit based on CDB TRANSFER LENGTH field size. */
3187 dev_max = sdp->use_16_for_rw ? SD_MAX_XFER_BLOCKS : SD_DEF_XFER_BLOCKS;
3189 /* Some devices report a maximum block count for READ/WRITE requests. */
3190 dev_max = min_not_zero(dev_max, sdkp->max_xfer_blocks);
3191 q->limits.max_dev_sectors = logical_to_sectors(sdp, dev_max);
3193 if (sd_validate_opt_xfer_size(sdkp, dev_max)) {
3194 q->limits.io_opt = logical_to_bytes(sdp, sdkp->opt_xfer_blocks);
3195 rw_max = logical_to_sectors(sdp, sdkp->opt_xfer_blocks);
3197 q->limits.io_opt = 0;
3198 rw_max = min_not_zero(logical_to_sectors(sdp, dev_max),
3199 (sector_t)BLK_DEF_MAX_SECTORS);
3202 /* Do not exceed controller limit */
3203 rw_max = min(rw_max, queue_max_hw_sectors(q));
3206 * Only update max_sectors if previously unset or if the current value
3207 * exceeds the capabilities of the hardware.
3209 if (sdkp->first_scan ||
3210 q->limits.max_sectors > q->limits.max_dev_sectors ||
3211 q->limits.max_sectors > q->limits.max_hw_sectors)
3212 q->limits.max_sectors = rw_max;
3214 sdkp->first_scan = 0;
3216 set_capacity_revalidate_and_notify(disk,
3217 logical_to_sectors(sdp, sdkp->capacity), false);
3218 sd_config_write_same(sdkp);
3222 * For a zoned drive, revalidating the zones can be done only once
3223 * the gendisk capacity is set. So if this fails, set back the gendisk
3226 if (sd_zbc_revalidate_zones(sdkp))
3227 set_capacity_revalidate_and_notify(disk, 0, false);
3234 * sd_unlock_native_capacity - unlock native capacity
3235 * @disk: struct gendisk to set capacity for
3237 * Block layer calls this function if it detects that partitions
3238 * on @disk reach beyond the end of the device. If the SCSI host
3239 * implements ->unlock_native_capacity() method, it's invoked to
3240 * give it a chance to adjust the device capacity.
3243 * Defined by block layer. Might sleep.
3245 static void sd_unlock_native_capacity(struct gendisk *disk)
3247 struct scsi_device *sdev = scsi_disk(disk)->device;
3249 if (sdev->host->hostt->unlock_native_capacity)
3250 sdev->host->hostt->unlock_native_capacity(sdev);
3254 * sd_format_disk_name - format disk name
3255 * @prefix: name prefix - ie. "sd" for SCSI disks
3256 * @index: index of the disk to format name for
3257 * @buf: output buffer
3258 * @buflen: length of the output buffer
3260 * SCSI disk names starts at sda. The 26th device is sdz and the
3261 * 27th is sdaa. The last one for two lettered suffix is sdzz
3262 * which is followed by sdaaa.
3264 * This is basically 26 base counting with one extra 'nil' entry
3265 * at the beginning from the second digit on and can be
3266 * determined using similar method as 26 base conversion with the
3267 * index shifted -1 after each digit is computed.
3273 * 0 on success, -errno on failure.
3275 static int sd_format_disk_name(char *prefix, int index, char *buf, int buflen)
3277 const int base = 'z' - 'a' + 1;
3278 char *begin = buf + strlen(prefix);
3279 char *end = buf + buflen;
3289 *--p = 'a' + (index % unit);
3290 index = (index / unit) - 1;
3291 } while (index >= 0);
3293 memmove(begin, p, end - p);
3294 memcpy(buf, prefix, strlen(prefix));
3300 * sd_probe - called during driver initialization and whenever a
3301 * new scsi device is attached to the system. It is called once
3302 * for each scsi device (not just disks) present.
3303 * @dev: pointer to device object
3305 * Returns 0 if successful (or not interested in this scsi device
3306 * (e.g. scanner)); 1 when there is an error.
3308 * Note: this function is invoked from the scsi mid-level.
3309 * This function sets up the mapping between a given
3310 * <host,channel,id,lun> (found in sdp) and new device name
3311 * (e.g. /dev/sda). More precisely it is the block device major
3312 * and minor number that is chosen here.
3314 * Assume sd_probe is not re-entrant (for time being)
3315 * Also think about sd_probe() and sd_remove() running coincidentally.
3317 static int sd_probe(struct device *dev)
3319 struct scsi_device *sdp = to_scsi_device(dev);
3320 struct scsi_disk *sdkp;
3325 scsi_autopm_get_device(sdp);
3327 if (sdp->type != TYPE_DISK &&
3328 sdp->type != TYPE_ZBC &&
3329 sdp->type != TYPE_MOD &&
3330 sdp->type != TYPE_RBC)
3333 #ifndef CONFIG_BLK_DEV_ZONED
3334 if (sdp->type == TYPE_ZBC)
3337 SCSI_LOG_HLQUEUE(3, sdev_printk(KERN_INFO, sdp,
3341 sdkp = kzalloc(sizeof(*sdkp), GFP_KERNEL);
3345 gd = alloc_disk(SD_MINORS);
3349 index = ida_alloc(&sd_index_ida, GFP_KERNEL);
3351 sdev_printk(KERN_WARNING, sdp, "sd_probe: memory exhausted.\n");
3355 error = sd_format_disk_name("sd", index, gd->disk_name, DISK_NAME_LEN);
3357 sdev_printk(KERN_WARNING, sdp, "SCSI disk (sd) name length exceeded.\n");
3358 goto out_free_index;
3362 sdkp->driver = &sd_template;
3364 sdkp->index = index;
3365 atomic_set(&sdkp->openers, 0);
3366 atomic_set(&sdkp->device->ioerr_cnt, 0);
3368 if (!sdp->request_queue->rq_timeout) {
3369 if (sdp->type != TYPE_MOD)
3370 blk_queue_rq_timeout(sdp->request_queue, SD_TIMEOUT);
3372 blk_queue_rq_timeout(sdp->request_queue,
3376 device_initialize(&sdkp->dev);
3377 sdkp->dev.parent = dev;
3378 sdkp->dev.class = &sd_disk_class;
3379 dev_set_name(&sdkp->dev, "%s", dev_name(dev));
3381 error = device_add(&sdkp->dev);
3383 goto out_free_index;
3386 dev_set_drvdata(dev, sdkp);
3388 gd->major = sd_major((index & 0xf0) >> 4);
3389 gd->first_minor = ((index & 0xf) << 4) | (index & 0xfff00);
3391 gd->fops = &sd_fops;
3392 gd->private_data = &sdkp->driver;
3393 gd->queue = sdkp->device->request_queue;
3395 /* defaults, until the device tells us otherwise */
3396 sdp->sector_size = 512;
3398 sdkp->media_present = 1;
3399 sdkp->write_prot = 0;
3400 sdkp->cache_override = 0;
3404 sdkp->first_scan = 1;
3405 sdkp->max_medium_access_timeouts = SD_MAX_MEDIUM_TIMEOUTS;
3407 error = sd_zbc_init_disk(sdkp);
3409 goto out_free_index;
3411 sd_revalidate_disk(gd);
3413 gd->flags = GENHD_FL_EXT_DEVT;
3414 if (sdp->removable) {
3415 gd->flags |= GENHD_FL_REMOVABLE;
3416 gd->events |= DISK_EVENT_MEDIA_CHANGE;
3417 gd->event_flags = DISK_EVENT_FLAG_POLL | DISK_EVENT_FLAG_UEVENT;
3420 blk_pm_runtime_init(sdp->request_queue, dev);
3421 if (sdp->rpm_autosuspend) {
3422 pm_runtime_set_autosuspend_delay(dev,
3423 sdp->host->hostt->rpm_autosuspend_delay);
3425 device_add_disk(dev, gd, NULL);
3427 sd_dif_config_host(sdkp);
3429 sd_revalidate_disk(gd);
3431 if (sdkp->security) {
3432 sdkp->opal_dev = init_opal_dev(sdp, &sd_sec_submit);
3434 sd_printk(KERN_NOTICE, sdkp, "supports TCG Opal\n");
3437 sd_printk(KERN_NOTICE, sdkp, "Attached SCSI %sdisk\n",
3438 sdp->removable ? "removable " : "");
3439 scsi_autopm_put_device(sdp);
3444 ida_free(&sd_index_ida, index);
3448 sd_zbc_release_disk(sdkp);
3451 scsi_autopm_put_device(sdp);
3456 * sd_remove - called whenever a scsi disk (previously recognized by
3457 * sd_probe) is detached from the system. It is called (potentially
3458 * multiple times) during sd module unload.
3459 * @dev: pointer to device object
3461 * Note: this function is invoked from the scsi mid-level.
3462 * This function potentially frees up a device name (e.g. /dev/sdc)
3463 * that could be re-used by a subsequent sd_probe().
3464 * This function is not called when the built-in sd driver is "exit-ed".
3466 static int sd_remove(struct device *dev)
3468 struct scsi_disk *sdkp;
3471 sdkp = dev_get_drvdata(dev);
3472 devt = disk_devt(sdkp->disk);
3473 scsi_autopm_get_device(sdkp->device);
3475 async_synchronize_full_domain(&scsi_sd_pm_domain);
3476 device_del(&sdkp->dev);
3477 del_gendisk(sdkp->disk);
3480 free_opal_dev(sdkp->opal_dev);
3482 blk_register_region(devt, SD_MINORS, NULL,
3483 sd_default_probe, NULL, NULL);
3485 mutex_lock(&sd_ref_mutex);
3486 dev_set_drvdata(dev, NULL);
3487 put_device(&sdkp->dev);
3488 mutex_unlock(&sd_ref_mutex);
3494 * scsi_disk_release - Called to free the scsi_disk structure
3495 * @dev: pointer to embedded class device
3497 * sd_ref_mutex must be held entering this routine. Because it is
3498 * called on last put, you should always use the scsi_disk_get()
3499 * scsi_disk_put() helpers which manipulate the semaphore directly
3500 * and never do a direct put_device.
3502 static void scsi_disk_release(struct device *dev)
3504 struct scsi_disk *sdkp = to_scsi_disk(dev);
3505 struct gendisk *disk = sdkp->disk;
3506 struct request_queue *q = disk->queue;
3508 ida_free(&sd_index_ida, sdkp->index);
3511 * Wait until all requests that are in progress have completed.
3512 * This is necessary to avoid that e.g. scsi_end_request() crashes
3513 * due to clearing the disk->private_data pointer. Wait from inside
3514 * scsi_disk_release() instead of from sd_release() to avoid that
3515 * freezing and unfreezing the request queue affects user space I/O
3516 * in case multiple processes open a /dev/sd... node concurrently.
3518 blk_mq_freeze_queue(q);
3519 blk_mq_unfreeze_queue(q);
3521 disk->private_data = NULL;
3523 put_device(&sdkp->device->sdev_gendev);
3525 sd_zbc_release_disk(sdkp);
3530 static int sd_start_stop_device(struct scsi_disk *sdkp, int start)
3532 unsigned char cmd[6] = { START_STOP }; /* START_VALID */
3533 struct scsi_sense_hdr sshdr;
3534 struct scsi_device *sdp = sdkp->device;
3538 cmd[4] |= 1; /* START */
3540 if (sdp->start_stop_pwr_cond)
3541 cmd[4] |= start ? 1 << 4 : 3 << 4; /* Active or Standby */
3543 if (!scsi_device_online(sdp))
3546 res = scsi_execute(sdp, cmd, DMA_NONE, NULL, 0, NULL, &sshdr,
3547 SD_TIMEOUT, SD_MAX_RETRIES, 0, RQF_PM, NULL);
3549 sd_print_result(sdkp, "Start/Stop Unit failed", res);
3550 if (driver_byte(res) == DRIVER_SENSE)
3551 sd_print_sense_hdr(sdkp, &sshdr);
3552 if (scsi_sense_valid(&sshdr) &&
3553 /* 0x3a is medium not present */
3558 /* SCSI error codes must not go to the generic layer */
3566 * Send a SYNCHRONIZE CACHE instruction down to the device through
3567 * the normal SCSI command structure. Wait for the command to
3570 static void sd_shutdown(struct device *dev)
3572 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3575 return; /* this can happen */
3577 if (pm_runtime_suspended(dev))
3580 if (sdkp->WCE && sdkp->media_present) {
3581 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3582 sd_sync_cache(sdkp, NULL);
3585 if (system_state != SYSTEM_RESTART && sdkp->device->manage_start_stop) {
3586 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3587 sd_start_stop_device(sdkp, 0);
3591 static int sd_suspend_common(struct device *dev, bool ignore_stop_errors)
3593 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3594 struct scsi_sense_hdr sshdr;
3597 if (!sdkp) /* E.g.: runtime suspend following sd_remove() */
3600 if (sdkp->WCE && sdkp->media_present) {
3601 sd_printk(KERN_NOTICE, sdkp, "Synchronizing SCSI cache\n");
3602 ret = sd_sync_cache(sdkp, &sshdr);
3605 /* ignore OFFLINE device */
3609 if (!scsi_sense_valid(&sshdr) ||
3610 sshdr.sense_key != ILLEGAL_REQUEST)
3614 * sshdr.sense_key == ILLEGAL_REQUEST means this drive
3615 * doesn't support sync. There's not much to do and
3616 * suspend shouldn't fail.
3622 if (sdkp->device->manage_start_stop) {
3623 sd_printk(KERN_NOTICE, sdkp, "Stopping disk\n");
3624 /* an error is not worth aborting a system sleep */
3625 ret = sd_start_stop_device(sdkp, 0);
3626 if (ignore_stop_errors)
3633 static int sd_suspend_system(struct device *dev)
3635 return sd_suspend_common(dev, true);
3638 static int sd_suspend_runtime(struct device *dev)
3640 return sd_suspend_common(dev, false);
3643 static int sd_resume(struct device *dev)
3645 struct scsi_disk *sdkp = dev_get_drvdata(dev);
3648 if (!sdkp) /* E.g.: runtime resume at the start of sd_probe() */
3651 if (!sdkp->device->manage_start_stop)
3654 sd_printk(KERN_NOTICE, sdkp, "Starting disk\n");
3655 ret = sd_start_stop_device(sdkp, 1);
3657 opal_unlock_from_suspend(sdkp->opal_dev);
3662 * init_sd - entry point for this driver (both when built in or when
3665 * Note: this function registers this driver with the scsi mid-level.
3667 static int __init init_sd(void)
3669 int majors = 0, i, err;
3671 SCSI_LOG_HLQUEUE(3, printk("init_sd: sd driver entry point\n"));
3673 for (i = 0; i < SD_MAJORS; i++) {
3674 if (register_blkdev(sd_major(i), "sd") != 0)
3677 blk_register_region(sd_major(i), SD_MINORS, NULL,
3678 sd_default_probe, NULL, NULL);
3684 err = class_register(&sd_disk_class);
3688 sd_cdb_cache = kmem_cache_create("sd_ext_cdb", SD_EXT_CDB_SIZE,
3690 if (!sd_cdb_cache) {
3691 printk(KERN_ERR "sd: can't init extended cdb cache\n");
3696 sd_cdb_pool = mempool_create_slab_pool(SD_MEMPOOL_SIZE, sd_cdb_cache);
3698 printk(KERN_ERR "sd: can't init extended cdb pool\n");
3703 sd_page_pool = mempool_create_page_pool(SD_MEMPOOL_SIZE, 0);
3704 if (!sd_page_pool) {
3705 printk(KERN_ERR "sd: can't init discard page pool\n");
3710 err = scsi_register_driver(&sd_template.gendrv);
3712 goto err_out_driver;
3717 mempool_destroy(sd_page_pool);
3720 mempool_destroy(sd_cdb_pool);
3723 kmem_cache_destroy(sd_cdb_cache);
3726 class_unregister(&sd_disk_class);
3728 for (i = 0; i < SD_MAJORS; i++)
3729 unregister_blkdev(sd_major(i), "sd");
3734 * exit_sd - exit point for this driver (when it is a module).
3736 * Note: this function unregisters this driver from the scsi mid-level.
3738 static void __exit exit_sd(void)
3742 SCSI_LOG_HLQUEUE(3, printk("exit_sd: exiting sd driver\n"));
3744 scsi_unregister_driver(&sd_template.gendrv);
3745 mempool_destroy(sd_cdb_pool);
3746 mempool_destroy(sd_page_pool);
3747 kmem_cache_destroy(sd_cdb_cache);
3749 class_unregister(&sd_disk_class);
3751 for (i = 0; i < SD_MAJORS; i++) {
3752 blk_unregister_region(sd_major(i), SD_MINORS);
3753 unregister_blkdev(sd_major(i), "sd");
3757 module_init(init_sd);
3758 module_exit(exit_sd);
3760 void sd_print_sense_hdr(struct scsi_disk *sdkp, struct scsi_sense_hdr *sshdr)
3762 scsi_print_sense_hdr(sdkp->device,
3763 sdkp->disk ? sdkp->disk->disk_name : NULL, sshdr);
3766 void sd_print_result(const struct scsi_disk *sdkp, const char *msg, int result)
3768 const char *hb_string = scsi_hostbyte_string(result);
3769 const char *db_string = scsi_driverbyte_string(result);
3771 if (hb_string || db_string)
3772 sd_printk(KERN_INFO, sdkp,
3773 "%s: Result: hostbyte=%s driverbyte=%s\n", msg,
3774 hb_string ? hb_string : "invalid",
3775 db_string ? db_string : "invalid");
3777 sd_printk(KERN_INFO, sdkp,
3778 "%s: Result: hostbyte=0x%02x driverbyte=0x%02x\n",
3779 msg, host_byte(result), driver_byte(result));